Merge pull request #7503 from QwikDev/v2-split-signals

chore: split and cleanup signals files

Author: wmertens

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

@@ -335,7 +335,7 @@
       ],
       "kind": "Interface",
       "content": "A computed signal is a signal which is calculated from other signals. When the signals change, the computed signal is recalculated, and if the result changed, all tasks which are tracking the signal will be re-run and all components that read the signal will be re-rendered.\n\n\n```typescript\nexport interface ComputedSignal<T> extends ReadonlySignal<T> \n```\n**Extends:** [ReadonlySignal](#readonlysignal)<!-- -->&lt;T&gt;\n\n\n<table><thead><tr><th>\n\nMethod\n\n\n</th><th>\n\nDescription\n\n\n</th></tr></thead>\n<tbody><tr><td>\n\n[force()](#computedsignal-force)\n\n\n</td><td>\n\nUse this to force recalculation and running subscribers, for example when the calculated value mutates but remains the same object. Useful for third-party libraries.\n\n\n</td></tr>\n</tbody></table>",
-      "editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/signal/signal.public.ts",
+      "editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/reactive-primitives/signal.public.ts",
       "mdFile": "core.computedsignal.md"
     },
     {
@@ -391,7 +391,7 @@
       ],
       "kind": "Function",
       "content": "Create a computed signal which is calculated from the given QRL. A computed signal is a signal which is calculated from other signals. When the signals change, the computed signal is recalculated.\n\nThe QRL must be a function which returns the value of the signal. The function must not have side effects, and it must be synchronous.\n\nIf you need the function to be async, use `useSignal` and `useTask$` instead.\n\n\n```typescript\ncreateComputed$: <T>(qrl: () => T) => T extends Promise<any> ? never : ComputedSignal<T>\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\nqrl\n\n\n</td><td>\n\n() =&gt; T\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>\n**Returns:**\n\nT extends Promise&lt;any&gt; ? never : [ComputedSignal](#computedsignal)<!-- -->&lt;T&gt;",
-      "editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/signal/signal.public.ts",
+      "editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/reactive-primitives/signal.public.ts",
       "mdFile": "core.createcomputed_.md"
     },
     {
@@ -419,7 +419,7 @@
       ],
       "kind": "Function",
       "content": "Create a signal that holds a custom serializable value. See [useSerializer$](#useserializer_) for more details.\n\n\n```typescript\ncreateSerializer$: <T, S>(arg: SerializerArg<T, S>) => T extends Promise<any> ? never : SerializerSignal<T>\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\narg\n\n\n</td><td>\n\nSerializerArg&lt;T, S&gt;\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>\n**Returns:**\n\nT extends Promise&lt;any&gt; ? never : SerializerSignal&lt;T&gt;",
-      "editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/signal/signal.public.ts",
+      "editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/reactive-primitives/signal.public.ts",
       "mdFile": "core.createserializer_.md"
     },
     {
@@ -433,7 +433,7 @@
       ],
       "kind": "Variable",
       "content": "Creates a Signal with the given value. If no value is given, the signal is created with `undefined`<!-- -->.\n\n\n```typescript\ncreateSignal: {\n    <T>(): Signal<T | undefined>;\n    <T>(value: T): Signal<T>;\n}\n```",
-      "editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/signal/signal.public.ts",
+      "editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/reactive-primitives/signal.public.ts",
       "mdFile": "core.createsignal.md"
     },
     {
@@ -731,7 +731,7 @@
       ],
       "kind": "Function",
       "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",
+      "editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/reactive-primitives/utils.ts",
       "mdFile": "core.issignal.md"
     },
     {
@@ -1543,7 +1543,7 @@
       ],
       "kind": "Interface",
       "content": "```typescript\nexport interface ReadonlySignal<T = unknown> \n```\n\n\n<table><thead><tr><th>\n\nProperty\n\n\n</th><th>\n\nModifiers\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\n[value](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nT\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
-      "editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/signal/signal.public.ts",
+      "editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/reactive-primitives/signal.public.ts",
       "mdFile": "core.readonlysignal.md"
     },
     {
@@ -1781,7 +1781,7 @@
       ],
       "kind": "Interface",
       "content": "A signal is a reactive value which can be read and written. When the signal is written, all tasks which are tracking the signal will be re-run and all components that read the signal will be re-rendered.\n\nFurthermore, when a signal value is passed as a prop to a component, the optimizer will automatically forward the signal. This means that `return <div title={signal.value}>hi</div>` will update the `title` attribute when the signal changes without having to re-render the component.\n\n\n```typescript\nexport interface Signal<T = any> extends ReadonlySignal<T> \n```\n**Extends:** [ReadonlySignal](#readonlysignal)<!-- -->&lt;T&gt;\n\n\n<table><thead><tr><th>\n\nProperty\n\n\n</th><th>\n\nModifiers\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\n[value](#)\n\n\n</td><td>\n\n\n</td><td>\n\nT\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
-      "editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/signal/signal.public.ts",
+      "editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/reactive-primitives/signal.public.ts",
       "mdFile": "core.signal.md"
     },
     {
@@ -2089,7 +2089,7 @@
       ],
       "kind": "Function",
       "content": "Get the original object that was wrapped by the store. Useful if you want to clone a store (structuredClone, IndexedDB,...)\n\n\n```typescript\nunwrapStore: <T>(value: T) => T\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\nT\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>\n**Returns:**\n\nT",
-      "editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/signal/store.ts",
+      "editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/reactive-primitives/impl/store.ts",
       "mdFile": "core.unwrapstore.md"
     },
     {

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

@@ -383,7 +383,7 @@ Use this to force recalculation and running subscribers, for example when the ca
 </td></tr>
 </tbody></table>
 
-[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/signal/signal.public.ts)
+[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/reactive-primitives/signal.public.ts)
 
 ## ContextId
 
@@ -706,7 +706,7 @@ qrl
 
 T extends Promise&lt;any&gt; ? never : [ComputedSignal](#computedsignal)&lt;T&gt;
 
-[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/signal/signal.public.ts)
+[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/reactive-primitives/signal.public.ts)
 
 ## createContextId
 
@@ -826,7 +826,7 @@ SerializerArg&lt;T, S&gt;
 
 T extends Promise&lt;any&gt; ? never : SerializerSignal&lt;T&gt;
 
-[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/signal/signal.public.ts)
+[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/reactive-primitives/signal.public.ts)
 
 ## createSignal
 
@@ -839,7 +839,7 @@ createSignal: {
 }
 ```
 
-[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/signal/signal.public.ts)
+[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/reactive-primitives/signal.public.ts)
 
 ## CSSProperties
 
@@ -1456,7 +1456,7 @@ any
 
 value is [Signal](#signal)&lt;unknown&gt;
 
-[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/signal/signal.ts)
+[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/reactive-primitives/utils.ts)
 
 ## jsx
 
@@ -2906,7 +2906,7 @@ T
 </td></tr>
 </tbody></table>
 
-[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/signal/signal.public.ts)
+[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/reactive-primitives/signal.public.ts)
 
 ## render
 
@@ -3761,7 +3761,7 @@ T
 </td></tr>
 </tbody></table>
 
-[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/signal/signal.public.ts)
+[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/reactive-primitives/signal.public.ts)
 
 ## SkipRender
 
@@ -8415,7 +8415,7 @@ T
 
 T
 
-[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/signal/store.ts)
+[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/reactive-primitives/impl/store.ts)
 
 ## useComputed$
 

packages/qwik/src/core/client/vnode-diff.ts

@@ -91,15 +91,18 @@ import {
 import { mapApp_findIndx } from './util-mapArray';
 import { mapArray_set } from './util-mapArray';
 import { getNewElementNamespaceData } from './vnode-namespace';
-import { WrappedSignal, EffectProperty, isSignal, SubscriptionData } from '../signal/signal';
-import type { Signal } from '../signal/signal.public';
+import { isSignal } from '../reactive-primitives/utils';
+import type { Signal } from '../reactive-primitives/signal.public';
 import { executeComponent } from '../shared/component-execution';
 import { isSlotProp } from '../shared/utils/prop';
 import { escapeHTML } from '../shared/utils/character-escaping';
-import { clearAllEffects } from '../signal/signal-cleanup';
+import { clearAllEffects } from '../reactive-primitives/cleanup';
 import { serializeAttribute } from '../shared/utils/styles';
 import { QError, qError } from '../shared/error/error';
 import { getFileLocationFromJsx } from '../shared/utils/jsx-filename';
+import { EffectProperty } from '../reactive-primitives/types';
+import { SubscriptionData } from '../reactive-primitives/subscription-data';
+import { WrappedSignalImpl } from '../reactive-primitives/impl/wrapped-signal-impl';
 
 export const vnode_diff = (
   container: ClientContainer,
@@ -512,7 +515,7 @@ export const vnode_diff = (
     const constProps = jsxNode.constProps;
     if (constProps && typeof constProps == 'object' && 'name' in constProps) {
       const constValue = constProps.name;
-      if (vHost && constValue instanceof WrappedSignal) {
+      if (vHost && constValue instanceof WrappedSignalImpl) {
         return trackSignalAndAssignHost(constValue, vHost, EffectProperty.COMPONENT, container);
       }
     }

packages/qwik/src/core/client/vnode-diff.unit.tsx

@@ -4,7 +4,7 @@ import { describe, expect, it } from 'vitest';
 import { vnode_applyJournal, vnode_getFirstChild, vnode_getNode } from './vnode';
 import { vnode_diff } from './vnode-diff';
 import type { QElement } from '../shared/types';
-import { createSignal } from '../signal/signal-api';
+import { createSignal } from '../reactive-primitives/signal-api';
 import { QError, qError } from '../shared/error/error';
 
 describe('vNode-diff', () => {

packages/qwik/src/core/client/vnode.ts

@@ -175,7 +175,7 @@ import {
   vnode_getElementNamespaceFlags,
 } from './vnode-namespace';
 import { mergeMaps } from '../shared/utils/maps';
-import { _EFFECT_BACK_REF } from '../signal/flags';
+import { _EFFECT_BACK_REF } from '../reactive-primitives/types';
 
 //////////////////////////////////////////////////////////////////////////////////////////////////////
 

packages/qwik/src/core/core.api.md

@@ -238,15 +238,6 @@ export { DomContainer as _DomContainer }
 // @internal (undocumented)
 export const _EFFECT_BACK_REF: unique symbol;
 
-// @internal (undocumented)
-export class _EffectData {
-    constructor(data: NodePropData);
-    // Warning: (ae-forgotten-export) The symbol "NodePropData" needs to be exported by the entry point index.d.ts
-    //
-    // (undocumented)
-    data: NodePropData;
-}
-
 // @internal (undocumented)
 export type _ElementVNode = [
 _VNodeFlags.Element,
@@ -290,10 +281,10 @@ export type EventHandler<EV = Event, EL = Element> = {
 // @internal (undocumented)
 export const eventQrl: <T>(qrl: QRL<T>) => QRL<T>;
 
-// Warning: (ae-forgotten-export) The symbol "WrappedSignal" needs to be exported by the entry point index.d.ts
+// Warning: (ae-forgotten-export) The symbol "WrappedSignalImpl" needs to be exported by the entry point index.d.ts
 //
 // @internal (undocumented)
-export const _fnSignal: <T extends (...args: any) => any>(fn: T, args: Parameters<T>, fnStr?: string) => WrappedSignal<any>;
+export const _fnSignal: <T extends (...args: any) => any>(fn: T, args: Parameters<T>, fnStr?: string) => WrappedSignalImpl<any>;
 
 // @public (undocumented)
 export const Fragment: FunctionComponent<{
@@ -894,7 +885,7 @@ export abstract class _SharedContainer implements Container {
     // (undocumented)
     abstract setHostProp<T>(host: HostElement, name: string, value: T): void;
     // (undocumented)
-    trackSignalValue<T>(signal: Signal, subscriber: HostElement, property: string, data: _EffectData): T;
+    trackSignalValue<T>(signal: Signal, subscriber: HostElement, property: string, data: _SubscriptionData): T;
 }
 
 // @public
@@ -1011,6 +1002,15 @@ export interface StreamWriter {
 // @internal (undocumented)
 export type _Stringifiable = string | boolean | number | null;
 
+// @internal (undocumented)
+export class _SubscriptionData {
+    constructor(data: NodePropData);
+    // Warning: (ae-forgotten-export) The symbol "NodePropData" needs to be exported by the entry point index.d.ts
+    //
+    // (undocumented)
+    data: NodePropData;
+}
+
 // Warning: (ae-forgotten-export) The symbol "AriaAttributes" needs to be exported by the entry point index.d.ts
 //
 // @public

packages/qwik/src/core/debug.ts

@@ -2,9 +2,11 @@ import { isQrl } from '../server/prefetch-strategy';
 import { isJSXNode } from './shared/jsx/jsx-runtime';
 import { isTask } from './use/use-task';
 import { vnode_getProp, vnode_isVNode } from './client/vnode';
-import { ComputedSignalImpl, WrappedSignal, isSignal } from './signal/signal';
-import { isStore } from './signal/store';
+import { isSignal } from './reactive-primitives/utils';
+import { isStore } from './reactive-primitives/impl/store';
 import { DEBUG_TYPE } from './shared/types';
+import { ComputedSignalImpl } from './reactive-primitives/impl/computed-signal-impl';
+import { WrappedSignalImpl } from './reactive-primitives/impl/wrapped-signal-impl';
 
 const stringifyPath: any[] = [];
 export function qwikDebugToString(value: any): any {
@@ -36,7 +38,7 @@ export function qwikDebugToString(value: any): any {
           return value.map(qwikDebugToString);
         }
       } else if (isSignal(value)) {
-        if (value instanceof WrappedSignal) {
+        if (value instanceof WrappedSignalImpl) {
           return 'WrappedSignal';
         } else if (value instanceof ComputedSignalImpl) {
           return 'ComputedSignal';

packages/qwik/src/core/index.ts

@@ -133,16 +133,19 @@ export { useVisibleTask$ } from './use/use-visible-task-dollar';
 export { useComputed$ } from './use/use-computed';
 export { useErrorBoundary } from './use/use-error-boundary';
 export type { ErrorBoundaryStore } from './shared/error/error-handling';
-export { type ReadonlySignal, type Signal, type ComputedSignal } from './signal/signal.public';
+export {
+  type ReadonlySignal,
+  type Signal,
+  type ComputedSignal,
+} from './reactive-primitives/signal.public';
 export {
   isSignal,
   createSignal,
   createComputedQrl,
   createComputed$,
   createSerializerQrl,
   createSerializer$,
-} from './signal/signal.public';
-export { SubscriptionData as _EffectData } from './signal/signal';
+} from './reactive-primitives/signal.public';
 
 //////////////////////////////////////////////////////////////////////////////////////////
 // Developer Low-Level API

packages/qwik/src/core/internal.ts

@@ -3,7 +3,7 @@ export { _walkJSX } from './ssr/ssr-render-jsx';
 export { _SharedContainer } from './shared/shared-container';
 export { queueQRL as _run } from './client/queue-qrl';
 export { scheduleTask as _task } from './use/use-task';
-export { _wrapSignal, _wrapProp, _wrapStore } from './signal/signal-utils';
+export { _wrapSignal, _wrapProp, _wrapStore } from './reactive-primitives/internal-api';
 export { _restProps } from './shared/utils/prop';
 export { _IMMUTABLE } from './shared/utils/constants';
 export { _CONST_PROPS, _VAR_PROPS } from './shared/utils/constants';
@@ -37,4 +37,5 @@ export {
 export { EMPTY_ARRAY as _EMPTY_ARRAY } from './shared/utils/flyweight';
 export { _serialize, _deserialize } from './shared/shared-serialization';
 export { _jsxQ, _jsxC, _jsxS } from './shared/jsx/jsx-runtime';
-export { _EFFECT_BACK_REF } from './signal/flags';
+export { _EFFECT_BACK_REF } from './reactive-primitives/types';
+export { SubscriptionData as _SubscriptionData } from './reactive-primitives/subscription-data';

packages/qwik/src/core/signal/signal-cleanup.ts renamed to packages/qwik/src/core/reactive-primitives/cleanup.ts

@@ -1,15 +1,15 @@
+import { ensureMaterialized, vnode_isElementVNode, vnode_isVNode } from '../client/vnode';
+import type { Container } from '../shared/types';
+import { SignalImpl } from './impl/signal-impl';
+import { WrappedSignalImpl } from './impl/wrapped-signal-impl';
+import { StoreHandler, getStoreHandler } from './impl/store';
 import {
   EffectSubscriptionProp,
-  WrappedSignal,
-  type EffectSubscription,
-  SignalImpl,
-  type EffectProperty,
+  _EFFECT_BACK_REF,
   type Consumer,
-} from './signal';
-import { StoreHandler, getStoreHandler } from './store';
-import type { Container } from '../shared/types';
-import { ensureMaterialized, vnode_isElementVNode, vnode_isVNode } from '../client/vnode';
-import { _EFFECT_BACK_REF } from './flags';
+  type EffectProperty,
+  type EffectSubscription,
+} from './types';
 
 /** Class for back reference to the EffectSubscription */
 export abstract class BackRef {
@@ -47,7 +47,7 @@ function clearSignal(container: Container, producer: SignalImpl, effect: EffectS
     effects.delete(effect);
   }
 
-  if (producer instanceof WrappedSignal) {
+  if (producer instanceof WrappedSignalImpl) {
     producer.$hostElement$ = null;
     clearAllEffects(container, producer);
   }

packages/qwik/src/core/reactive-primitives/impl/README.md

@@ -0,0 +1,11 @@
+# Signals
+
+Signals come in two types:
+
+1. `Signal` - A storage of data
+2. `ComputedSignal` - A signal which is computed from other signals.
+
+## Why is `ComputedSignal` different?
+
+- It needs to store a function which needs to re-run.
+- It is `Readonly` because it is computed.