fix(atoms): make Signal passable to functions accepting ZeduxNode (#341)

Author: bowheart

packages/atoms/src/classes/Ecosystem.ts

@@ -1012,7 +1012,9 @@ export class Ecosystem<Context extends Record<string, any> | undefined = any>
 
     const signal = new Signal<{
       Events: EventMap
+      Params: undefined
       State: State
+      Template: undefined
     }>(this, id, state)
 
     this.n.set(id, signal)

packages/atoms/src/classes/MappedSignal.ts

@@ -1,8 +1,8 @@
 import {
   AnyNodeGenerics,
-  AtomGenerics,
   InternalEvaluationReason,
   Mutatable,
+  NodeGenerics,
   SendableEvents,
   Settable,
   Transaction,
@@ -29,12 +29,11 @@ const getRelevantEvents = (events?: Record<string, any>) => {
 export type SignalMap = Record<string, Signal<AnyNodeGenerics> | unknown>
 
 export class MappedSignal<
-  G extends Pick<AtomGenerics, 'Events' | 'State'> & {
-    Params?: any
-    Template?: any
-  } = {
+  G extends NodeGenerics = {
     Events: any
+    Params: undefined
     State: any
+    Template: undefined
   }
 > extends Signal<G> {
   /**

packages/atoms/src/classes/Signal.ts

@@ -1,5 +1,4 @@
 import {
-  AtomGenerics,
   GraphEdge,
   Mutatable,
   NodeGenerics,
@@ -21,7 +20,7 @@ import { recursivelyMutate, recursivelyProxy } from './proxies'
 import { getEvaluationContext } from '../utils/evaluationContext'
 import { schedulerPost, schedulerPre } from '../utils/ecosystem'
 
-export const doMutate = <G extends Pick<NodeGenerics, 'State' | 'Events'>>(
+export const doMutate = <G extends NodeGenerics>(
   node: Signal<G>,
   isWrapperSignal: boolean,
   mutatable: Mutatable<G['State']>,
@@ -89,19 +88,13 @@ export const doMutate = <G extends Pick<NodeGenerics, 'State' | 'Events'>>(
 }
 
 export class Signal<
-  G extends Pick<AtomGenerics, 'Events' | 'State'> & {
-    Params?: any
-    Template?: any
-  } = {
+  G extends NodeGenerics = {
     Events: any
+    Params: undefined
     State: any
+    Template: undefined
   }
-> extends ZeduxNode<
-  G & {
-    Params: G extends { Params: infer P } ? P : undefined
-    Template: G extends { Template: infer T } ? T : undefined
-  }
-> {
+> extends ZeduxNode<G> {
   /**
    * @see ZeduxNode.o
    */

packages/atoms/src/classes/templates/AtomTemplate.ts

@@ -7,7 +7,7 @@ import {
 import { AtomInstance } from '../instances/AtomInstance'
 import { Ecosystem } from '../Ecosystem'
 import { AtomTemplateBase } from './AtomTemplateBase'
-import { Signal } from '../Signal'
+import { AnySignal } from '@zedux/atoms/types/index'
 
 export type AtomInstanceRecursive<
   G extends Omit<AtomGenerics, 'Node' | 'Template'>
@@ -44,7 +44,7 @@ export class AtomTemplate<
   public override(
     newValue: AtomValueOrFactory<
       G & {
-        Signal: Signal<{ State: G['State']; Events: G['Events'] }> | undefined
+        Signal: AnySignal<{ State: G['State']; Events: G['Events'] }> | undefined
       }
     >
   ): AtomTemplate<G> {

packages/atoms/src/classes/templates/AtomTemplateBase.ts

@@ -7,7 +7,7 @@ import {
 } from '@zedux/atoms/types/index'
 import { prefix } from '@zedux/atoms/utils/general'
 import { Ecosystem } from '../Ecosystem'
-import { Signal } from '../Signal'
+import { AnySignal } from '@zedux/atoms/types/index'
 import { getScopeString } from '@zedux/atoms/utils/graph'
 
 export abstract class AtomTemplateBase<
@@ -44,7 +44,7 @@ export abstract class AtomTemplateBase<
      */
     public readonly v: AtomValueOrFactory<
       G & {
-        Signal: Signal<{ State: G['State']; Events: G['Events'] }> | undefined
+        Signal: AnySignal<{ State: G['State']; Events: G['Events'] }> | undefined
       }
     >,
 

packages/atoms/src/factories/api.ts

@@ -1,5 +1,11 @@
 import { AtomApi } from '../classes/AtomApi'
-import { AtomApiPromise, None, ResolvedStateOf, StateOf } from '../types/index'
+import {
+  AnySignal,
+  AtomApiPromise,
+  None,
+  ResolvedStateOf,
+  StateOf,
+} from '../types/index'
 import { Signal } from '../classes/Signal'
 
 /**
@@ -90,7 +96,7 @@ export const api: {
     State = undefined,
     Exports extends Record<string, any> = None,
     SignalType extends
-      | Signal<{ Events: any; State: State }>
+      | AnySignal<{ State: State }>
       | undefined = undefined
   >(
     value: State
@@ -104,7 +110,7 @@ export const api: {
   State = undefined,
   Exports extends Record<string, any> = None,
   SignalType extends
-    | Signal<{ Events: any; State: State }>
+    | AnySignal<{ State: State }>
     | undefined = undefined,
   PromiseType extends AtomApiPromise = undefined
 >(

packages/atoms/src/injectors/injectMappedSignal.ts

@@ -87,7 +87,9 @@ export function injectMappedSignal<
   config?: InjectSignalConfig<EventMap>
 ): MappedSignal<{
   Events: Prettify<EventsOf<S> & EventMap>
+  Params: undefined
   State: StateOf<S>
+  Template: undefined
 }>
 
 export function injectMappedSignal<
@@ -98,7 +100,9 @@ export function injectMappedSignal<
   config?: InjectSignalConfig<EventMap>
 ): MappedSignal<{
   Events: Prettify<MapAll<M> & EventMap>
+  Params: undefined
   State: { [K in keyof M]: M[K] extends Signal<any> ? StateOf<M[K]> : M[K] }
+  Template: undefined
 }>
 
 export function injectMappedSignal(

packages/atoms/src/injectors/injectPromise.ts

@@ -34,8 +34,10 @@ export interface InjectPromiseAtomApi<
 > extends AtomApi<G> {
   dataSignal: Signal<{
     Events: EventMap
+    Params: undefined
     ResolvedState: Data
     State: Data | undefined
+    Template: undefined
   }>
 
   addExports<NewExports extends Record<string, any>>(
@@ -155,7 +157,9 @@ export const injectPromise: {
       Promise: Promise<Data>
       Signal: MappedSignal<{
         Events: EventMap
+        Params: undefined
         State: Omit<PromiseState<Data>, 'data'> & { data: Data }
+        Template: undefined
       }>
       State: Omit<PromiseState<Data>, 'data'> & { data: Data }
     },
@@ -176,8 +180,10 @@ export const injectPromise: {
       Promise: Promise<Data>
       Signal: MappedSignal<{
         Events: EventMap
+        Params: undefined
         ResolvedState: Omit<PromiseState<Data>, 'data'> & { data: Data }
         State: PromiseState<Data>
+        Template: undefined
       }>
       State: PromiseState<Data>
     },
@@ -204,16 +210,20 @@ export const injectPromise: {
 
   const dataSignal = injectSignal(initialData, signalConfig) as Signal<{
     Events: EventMap
+    Params: undefined
     ResolvedState: Data
     State: Data | undefined
+    Template: undefined
   }>
 
   const signal = injectMappedSignal({
     ...getInitialPromiseState<Data>(),
     data: dataSignal,
   }) as MappedSignal<{
     Events: EventMap
+    Params: undefined
     State: PromiseState<Data>
+    Template: undefined
   }>
 
   if (
@@ -290,7 +300,9 @@ export const injectPromise: {
       Promise: Promise<Data>
       Signal: MappedSignal<{
         Events: EventMap
+        Params: undefined
         State: PromiseState<Data>
+        Template: undefined
       }>
       State: PromiseState<Data>
     },

packages/atoms/src/injectors/injectSignal.ts

@@ -50,7 +50,9 @@ export const injectSignal = <
 
     const signal = new Signal<{
       Events: EventMap
+      Params: undefined
       State: State
+      Template: undefined
     }>(
       instance.e,
       id,

packages/atoms/src/types/atoms.ts

@@ -53,6 +53,17 @@ export type AnyAtomTemplate<G extends Partial<AtomGenerics> | 'any' = 'any'> =
       : any
   >
 
+export type AnySignal<G extends Partial<NodeGenerics> | 'any' = 'any'> = Signal<
+  G extends Partial<NodeGenerics>
+    ? {
+        Events: G extends { Events: infer E } ? E : any
+        Params: G extends { Params: infer P } ? P : any
+        State: G extends { State: infer S } ? S : any
+        Template: G extends { Template: infer T } ? T : any
+      }
+    : any
+>
+
 export type AnyNodeGenerics<
   G extends Partial<NodeGenerics> = { [K in keyof NodeGenerics]: any }
 > = {
@@ -69,7 +80,7 @@ export type AtomApiGenerics = Pick<
 export type AtomGenericsToAtomApiGenerics<
   G extends Pick<AtomGenerics, 'Events' | 'Exports' | 'Promise' | 'State'>
 > = Pick<G, 'Exports' | 'Promise' | 'State'> & {
-  Signal: Signal<Pick<G, 'Events' | 'State'>> | undefined
+  Signal: AnySignal<Pick<G, 'Events' | 'State'>> | undefined
 }
 
 export interface AtomGenerics {