Open History to see the last commit
1import { computed, untracked } from '@angular/core'
2import type { Signal } from '@angular/core'
3β
4type SignalProxy<
5 TInput extends Record<string | symbol, any>,
6 TMethodsToPassThrough extends keyof TInput,
7 TAttributesToTransformToSignals extends keyof TInput,
8 TMethodsToTrack extends keyof TInput,
9 TMethodsToTransformToSignals extends keyof TInput,
10> = {
11 [K in TMethodsToPassThrough]: TInput[K]
12} & {
13 [K in TAttributesToTransformToSignals]: Signal<TInput[K]>
14} & {
15 [K in TMethodsToTrack]: TInput[K]
16} & {
17 [K in TMethodsToTransformToSignals]: Signal<ReturnType<TInput[K]>>
18}
19β
20export function signalProxy<
21 TInput extends Record<string | symbol, any>,
22 TMethodsToPassThrough extends keyof TInput,
23 TAttributesToTransformToSignals extends keyof TInput,
24 TMethodsToTrack extends keyof TInput,
25 TMethodsToTransformToSignals extends keyof TInput,
26>(
27 inputSignal: Signal<TInput>,
28 methodsToPassThrough: Array<TMethodsToPassThrough>,
29 attributesToTransformToSignals: Array<TAttributesToTransformToSignals>,
30 methodsToTrack: Array<TMethodsToTrack>,
31 methodsToTransformToSignals: Array<TMethodsToTransformToSignals>,
32): SignalProxy<
33 TInput,
34 TMethodsToPassThrough,
35 TAttributesToTransformToSignals,
36 TMethodsToTrack,
37 TMethodsToTransformToSignals
38> {
39 // Type needed to proxy with the apply handler
40 const callableTarget = (() => inputSignal()) as (() => TInput) &
41 Record<PropertyKey, unknown>
42β
43 return new Proxy(callableTarget, {
44 apply() {
45 return inputSignal()
46 },
47 get(target, property) {
48 const fieldValue = target[property as keyof typeof callableTarget]
49 if (fieldValue !== undefined) return fieldValue
50β
51 // Methods that pass through: call on the instance without tracking the signal read
52 if (methodsToPassThrough.includes(property as TMethodsToPassThrough)) {
53 return (target[property] = (
54 ...args: Parameters<TInput[typeof property]>
55 ) => untracked(inputSignal)[property as keyof TInput](...args))
56 }
57β
58 // Zero-arg methods exposed as computed signals
59 if (
60 methodsToTransformToSignals.includes(
61 property as TMethodsToTransformToSignals,
62 )
63 ) {
64 return (target[property] = computed(() =>
65 (inputSignal()[property as keyof TInput] as () => unknown)(),
66 ))
67 }
68β
69 // Methods that need to be tracked, track instance changes and call the method
70 if (methodsToTrack.includes(property as TMethodsToTrack)) {
71 return (target[property] = (
72 ...args: Parameters<TInput[typeof property]>
73 ) => inputSignal()[property as keyof TInput](...args))
74 }
75β
76 // Other values that are tracked as signals
77 if (
78 attributesToTransformToSignals.includes(
79 property as TAttributesToTransformToSignals,
80 )
81 ) {
82 return (target[property] = computed(
83 () => inputSignal()[property as keyof TInput],
84 ))
85 }
86β
87 // All other fields. Any field that is not handled above will fail if the signal includes
88 // input or model signals from a component and this is accessed before initialization.
89 return untracked(inputSignal)[property as keyof TInput]
90 },
91 has(_, property: PropertyKey) {
92 return property in untracked(inputSignal)
93 },
94 ownKeys() {
95 return Reflect.ownKeys(untracked(inputSignal))
96 },
97 getOwnPropertyDescriptor() {
98 return {
99 enumerable: true,
100 configurable: true,
101 }
102 },
103 }) as SignalProxy<
104 TInput,
105 TMethodsToPassThrough,
106 TAttributesToTransformToSignals,
107 TMethodsToTrack,
108 TMethodsToTransformToSignals
109 >
110}