chore: rename the Signal class to SignalImpl

Author: wmertens

packages/docs/src/routes/api/qwik/api.json

@@ -730,7 +730,7 @@
         }
       ],
       "kind": "Function",
-      "content": "```typescript\nisSignal: (value: any) => value is ISignal<unknown>\n```\n\n\n<table><thead><tr><th>\n\nParameter\n\n\n</th><th>\n\nType\n\n\n</th><th>\n\nDescription\n\n\n</th></tr></thead>\n<tbody><tr><td>\n\nvalue\n\n\n</td><td>\n\nany\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>\n**Returns:**\n\nvalue is [ISignal](#signal)<!-- -->&lt;unknown&gt;",
+      "content": "```typescript\nisSignal: (value: any) => value is Signal<unknown>\n```\n\n\n<table><thead><tr><th>\n\nParameter\n\n\n</th><th>\n\nType\n\n\n</th><th>\n\nDescription\n\n\n</th></tr></thead>\n<tbody><tr><td>\n\nvalue\n\n\n</td><td>\n\nany\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>\n**Returns:**\n\nvalue is [Signal](#signal)<!-- -->&lt;unknown&gt;",
       "editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/signal/signal.ts",
       "mdFile": "core.issignal.md"
     },

packages/docs/src/routes/api/qwik/index.md

@@ -1424,7 +1424,7 @@ interface IntrinsicElements extends LenientQwikElements
 ## isSignal
 
 ```typescript
-isSignal: (value: any) => value is ISignal<unknown>
+isSignal: (value: any) => value is Signal<unknown>
 ```
 
 <table><thead><tr><th>
@@ -1454,7 +1454,7 @@ any
 </tbody></table>
 **Returns:**
 
-value is [ISignal](#signal)&lt;unknown&gt;
+value is [Signal](#signal)&lt;unknown&gt;
 
 [Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/signal/signal.ts)
 

packages/qwik/src/core/shared/shared-serialization.ts

@@ -14,7 +14,7 @@ import {
   type EffectSubscription,
   EffectSubscriptionProp,
   SerializerSignalImpl,
-  Signal,
+  SignalImpl,
   SubscriptionData,
   WrappedSignal,
   isSerializerObj,
@@ -263,7 +263,7 @@ const inflate = (
       break;
     }
     case TypeIds.Signal: {
-      const signal = target as Signal<unknown>;
+      const signal = target as SignalImpl<unknown>;
       const d = data as [unknown, ...EffectSubscription[]];
       signal.$untrackedValue$ = d[0];
       signal.$effects$ = new Set(d.slice(1) as EffectSubscription[]);
@@ -488,7 +488,7 @@ const allocate = (container: DeserializeContainer, typeId: number, value: unknow
     case TypeIds.Component:
       return componentQrl(null!);
     case TypeIds.Signal:
-      return new Signal(container as any, 0);
+      return new SignalImpl(container as any, 0);
     case TypeIds.WrappedSignal:
       return new WrappedSignal(container as any, null!, null!, null!);
     case TypeIds.ComputedSignal:
@@ -836,7 +836,7 @@ export const createSerializationContext = (
         obj.forEach((v, k) => {
           discoveredValues.push(k, v);
         });
-      } else if (obj instanceof Signal) {
+      } else if (obj instanceof SignalImpl) {
         /**
          * ComputedSignal can be left un-calculated if invalid.
          *
@@ -1221,7 +1221,7 @@ function serialize(serializationContext: SerializationContext): void {
     } else if ($isDomRef$(value)) {
       value.$ssrNode$.vnodeData[0] |= VNodeDataFlag.SERIALIZE;
       output(TypeIds.RefVNode, value.$ssrNode$.id);
-    } else if (value instanceof Signal) {
+    } else if (value instanceof SignalImpl) {
       /**
        * Special case: when a Signal value is an SSRNode, it always needs to be a DOM ref instead.
        * It can never be meant to become a vNode, because vNodes are internal only.
@@ -1604,7 +1604,7 @@ const frameworkType = (obj: any) => {
   return (
     (typeof obj === 'object' &&
       obj !== null &&
-      (obj instanceof Signal || obj instanceof Task || isJSXNode(obj))) ||
+      (obj instanceof SignalImpl || obj instanceof Task || isJSXNode(obj))) ||
     isQrl(obj)
   );
 };

packages/qwik/src/core/shared/shared-serialization.unit.ts

@@ -1,7 +1,7 @@
 import { $, component$, noSerialize } from '@qwik.dev/core';
 import { describe, expect, it, vi } from 'vitest';
 import { _fnSignal, _wrapProp } from '../internal';
-import { SubscriptionData, type Signal } from '../signal/signal';
+import { SubscriptionData, type SignalImpl } from '../signal/signal';
 import {
   createComputed$,
   createSerializer$,
@@ -581,8 +581,8 @@ describe('shared-serialization', () => {
     it(title(TypeIds.Promise), async () => {
       const objs = await serialize(Promise.resolve(shared1), Promise.reject(shared1), shared1);
       const [p1, p2, shared] = deserialize(objs);
-      expect(p1).resolves.toBe(shared);
-      expect(p2).rejects.toBe(shared);
+      await expect(p1).resolves.toBe(shared);
+      await expect(p2).rejects.toBe(shared);
     });
     it(title(TypeIds.Set), async () => {
       const objs = await serialize(shared1, new Set([shared1, ['hi']]));
@@ -658,7 +658,7 @@ describe('shared-serialization', () => {
     it.todo(title(TypeIds.Component));
     it(title(TypeIds.Signal), async () => {
       const objs = await serialize(createSignal('hi'));
-      const signal = deserialize(objs)[0] as Signal;
+      const signal = deserialize(objs)[0] as SignalImpl;
       expect(isSignal(signal)).toBeTruthy();
       expect(signal.value).toBe('hi');
     });

packages/qwik/src/core/signal/signal-api.ts

@@ -3,7 +3,7 @@ import type { QRL } from '../shared/qrl/qrl.public';
 import {
   ComputedSignalImpl,
   SerializerSignalImpl,
-  Signal as SignalImpl,
+  SignalImpl,
   throwIfQRLNotResolved,
   type SerializerArg,
 } from './signal';

packages/qwik/src/core/signal/signal-cleanup.ts

@@ -2,7 +2,7 @@ import {
   EffectSubscriptionProp,
   WrappedSignal,
   type EffectSubscription,
-  Signal,
+  SignalImpl,
   type EffectProperty,
   type Consumer,
 } from './signal';
@@ -30,7 +30,7 @@ export function clearAllEffects(container: Container, consumer: Consumer): void
       return;
     }
     for (const producer of backRefs) {
-      if (producer instanceof Signal) {
+      if (producer instanceof SignalImpl) {
         clearSignal(container, producer, effect);
       } else if (container.$storeProxyMap$.has(producer)) {
         const target = container.$storeProxyMap$.get(producer)!;
@@ -41,7 +41,7 @@ export function clearAllEffects(container: Container, consumer: Consumer): void
   }
 }
 
-function clearSignal(container: Container, producer: Signal, effect: EffectSubscription) {
+function clearSignal(container: Container, producer: SignalImpl, effect: EffectSubscription) {
   const effects = producer.$effects$;
   if (effects) {
     effects.delete(effect);

packages/qwik/src/core/signal/signal.ts

@@ -32,7 +32,7 @@ import { trackSignal, tryGetInvokeContext } from '../use/use-core';
 import { Task, TaskFlags, isTask } from '../use/use-task';
 import { NEEDS_COMPUTATION, _EFFECT_BACK_REF } from './flags';
 import { type BackRef } from './signal-cleanup';
-import type { Signal as ISignal, ReadonlySignal } from './signal.public';
+import type { Signal, ReadonlySignal } from './signal.public';
 import type { TargetType } from './store';
 import { getSubscriber } from './subscriber';
 
@@ -74,8 +74,8 @@ export const throwIfQRLNotResolved = (qrl: QRL) => {
 };
 
 /** @public */
-export const isSignal = (value: any): value is ISignal<unknown> => {
-  return value instanceof Signal;
+export const isSignal = (value: any): value is Signal<unknown> => {
+  return value instanceof SignalImpl;
 };
 
 /**
@@ -87,7 +87,7 @@ export const isSignal = (value: any): value is ISignal<unknown> => {
  * - `VNode` and `ISsrNode`: Either a component or `<Signal>`
  * - `Signal2`: A derived signal which contains a computation function.
  */
-export type Consumer = Task | VNode | ISsrNode | Signal;
+export type Consumer = Task | VNode | ISsrNode | SignalImpl;
 
 /** @internal */
 export class SubscriptionData {
@@ -137,7 +137,7 @@ export class SubscriptionData {
 export type EffectSubscription = [
   Consumer, // EffectSubscriptionProp.CONSUMER
   EffectProperty | string, // EffectSubscriptionProp.PROPERTY or string for attributes
-  Set<Signal | TargetType> | null, // EffectSubscriptionProp.BACK_REF
+  Set<SignalImpl | TargetType> | null, // EffectSubscriptionProp.BACK_REF
   SubscriptionData | null, // EffectSubscriptionProp.DATA
 ];
 
@@ -153,7 +153,7 @@ export const enum EffectProperty {
   VNODE = '.',
 }
 
-export class Signal<T = any> implements ISignal<T> {
+export class SignalImpl<T = any> implements Signal<T> {
   $untrackedValue$: T;
 
   /** Store a list of effects which are dependent on this signal. */
@@ -273,7 +273,7 @@ export const addQrlToSerializationCtx = (
 
 export const triggerEffects = (
   container: Container | null,
-  signal: Signal | TargetType,
+  signal: SignalImpl | TargetType,
   effects: Set<EffectSubscription> | null
 ) => {
   const isBrowser = isDomContainer(container);
@@ -290,7 +290,7 @@ export const triggerEffects = (
           choreType = ChoreType.VISIBLE;
         }
         container.$scheduler$(choreType, consumer);
-      } else if (consumer instanceof Signal) {
+      } else if (consumer instanceof SignalImpl) {
         // we don't schedule ComputedSignal/DerivedSignal directly, instead we invalidate it and
         // and schedule the signals effects (recursively)
         if (consumer instanceof ComputedSignalImpl) {
@@ -311,15 +311,15 @@ export const triggerEffects = (
       } else if (isBrowser) {
         if (property === EffectProperty.VNODE) {
           const host: HostElement = consumer;
-          container.$scheduler$(ChoreType.NODE_DIFF, host, host, signal as Signal);
+          container.$scheduler$(ChoreType.NODE_DIFF, host, host, signal as SignalImpl);
         } else {
           const host: HostElement = consumer;
           const effectData = effectSubscription[EffectSubscriptionProp.DATA];
           if (effectData instanceof SubscriptionData) {
             const data = effectData.data;
             const payload: NodePropPayload = {
               ...data,
-              $value$: signal as Signal,
+              $value$: signal as SignalImpl,
             };
             container.$scheduler$(ChoreType.NODE_PROP, host, property, payload);
           }
@@ -341,7 +341,7 @@ type ComputeQRL<T> = QRLInternal<() => T>;
  *
  * The value is available synchronously, but the computation is done lazily.
  */
-export class ComputedSignalImpl<T> extends Signal<T> implements BackRef {
+export class ComputedSignalImpl<T> extends SignalImpl<T> implements BackRef {
   /**
    * The compute function is stored here.
    *
@@ -435,7 +435,7 @@ export class ComputedSignalImpl<T> extends Signal<T> implements BackRef {
   }
 }
 
-export class WrappedSignal<T> extends Signal<T> implements BackRef {
+export class WrappedSignal<T> extends SignalImpl<T> implements BackRef {
   $args$: any[];
   $func$: (...args: any[]) => T;
   $funcStr$: string | null;