Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 | 1x 1x 1x 1x 12x 12x 12x 12x 12x 12x 12x 12x 1x 17x 17x 1x 2x 1x 1x 1x 23x 4x 4x 23x 4x 4x 23x 23x 37x 37x 29x 37x 3x 37x 12x 12x 14x 37x 23x 7x 7x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 7x 1x 7x 4x 5x 1x 1x 6x 7x 23x 2x 2x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 2x 23x 23x 23x 1x 4x 4x 7x 7x 4x 1x 1x 4x 2x 2x 2x 2x 4x 4x 1x 4x 4x 7x 7x 4x 1x 1x 4x 2x 2x 2x 2x 4x 4x | import { captureStack, closure, getObserver, isBrowser, isMutableRef, untrack } from '@anchorlib/core';
import { isBinding } from './binding.js';
import type { BindableProps, ComponentProps } from './types.js';
const PROPS_SYMBOL = Symbol('setup-props');
/**
* Executes a function with provided props temporarily set in the current context.
*
* This function sets the given props in the current closure context and executes
* the provided function. After execution, it restores the previous props value.
* This is useful for providing contextual data to child components in a scoped manner.
*
* @template P - The type of props being set
* @template R - The return type of the executed function
* @param props - The props to temporarily set in the context
* @param fn - The function to execute with the provided props
* @returns The result of executing the provided function
*/
export function withProps<P, R>(props: P, fn: () => R) {
const prevProps = closure.get<BindableProps>(PROPS_SYMBOL);
closure.set(PROPS_SYMBOL, props);
try {
return fn();
} finally {
closure.set(PROPS_SYMBOL, prevProps);
}
}
/**
* Retrieves the props from the current context.
*
* This function gets the props that were previously set using withProps().
* It accesses the props from a shared closure context using a symbol key.
*
* @template P - The expected type of the props
* @returns The props from the current context
*/
export function getProps<P>(): P {
return closure.get(PROPS_SYMBOL) as P;
}
/**
* Conditionally returns a callback function based on the environment.
*
* In non-browser environments, returns undefined to prevent execution
* of client-side callbacks during server-side rendering.
*
* @template T - The function type
* @param fn - The callback function
* @returns The function if in browser environment, undefined otherwise
*/
export function callback<T>(fn: T): T {
if (!isBrowser()) return undefined as never;
return fn;
}
/**
* Creates a proxy for props that handles binding references and read-only properties.
*
* This function creates a proxy that:
* - Resolves binding references to their actual values on get operations
* - Prevents assignment to event handler properties (those starting with "on")
* - Properly handles setting values on binding references
*
* @template P - The props type
* @param props - The props object to wrap
* @returns A proxy wrapping the props object
*/
export function setupProps<P>(props: P): ComponentProps<P> {
const omit = (keys: Array<keyof P>) => {
return omitProps(props, newProps, keys ?? []);
};
const pick = (keys: Array<keyof P>) => {
return pickProps(props, newProps, keys ?? []);
};
const newProps = new Proxy(props as ComponentProps<P>, {
get(target, key, receiver) {
if (key === '$omit') return omit;
if (key === '$pick') return pick;
const bindingRef = Reflect.get(target, key, receiver);
if (isBinding(bindingRef)) {
return (bindingRef.source as Record<string, unknown>)[bindingRef.key];
} else if (isMutableRef(bindingRef)) {
return bindingRef.value;
}
return bindingRef;
},
set(target, key, value, receiver) {
const bindingRef = untrack(() => Reflect.get(target, key, receiver));
if (typeof key === 'string' && key.startsWith('on')) {
const error = new Error(`Property '${key}' is read-only.`);
captureStack.violation.general(
'Read-only property assignment',
`Cannot assign to read-only property '${key}'. Event handlers can only be specified in parent component.`,
error,
[
'Event handler properties (starting with "on") are read-only.',
'- Define event handlers in the parent component.',
'- Only mutate properties meant for two-way data binding.',
]
);
return true;
}
if (isBinding(bindingRef)) {
(bindingRef.source as Record<string, unknown>)[bindingRef.key] = value;
} else if (isMutableRef(bindingRef)) {
bindingRef.value = value;
} else {
Reflect.set(target, key, value, receiver);
}
return true;
},
ownKeys(target: BindableProps): ArrayLike<string | symbol> {
const observer = getObserver();
if (observer) {
const error = new Error('Rest props are not allowed.');
captureStack.violation.general(
'Rest props usage detected.',
'Using rest props in a reactive boundary is not allowed.',
error,
[
'Rest props ({ ...rest }) are not allowed in a reactive boundary.',
'- Use the props.$omit() method to exclude specific props.',
'- Use the props.$pick() method to include specific props.',
],
this.ownKeys
);
return [];
}
return Object.keys(target);
},
});
return newProps as ComponentProps<P>;
}
/**
* Creates a new object excluding specified properties from the original object.
*
* This function returns a proxy that filters out specified keys when enumerating
* the object's properties. The returned object behaves like the original but
* omits the excluded properties from enumeration and spreading operations.
*
* @template T - The type of the original object
* @template K - The type of keys to exclude
* @param source - The original object to create a proxy for
* @param props - The proxied object to omit properties from
* @param excludes - An array of keys to exclude from the object (default: empty array)
* @returns A new object with specified properties omitted
*/
export function omitProps<T, K extends keyof T>(source: T, props: T, excludes: Array<K> = []): Omit<T, K> {
return new Proxy(source as Record<string, unknown>, {
get(_target, key, receiver) {
return Reflect.get(props as Record<string, unknown>, key, receiver);
},
set(_target, key, value, receiver) {
return Reflect.set(props as Record<string, unknown>, key, value, receiver);
},
ownKeys(target: Record<string, unknown>): ArrayLike<string | symbol> {
return untrack(() => {
return Object.keys(target as Record<string, unknown>).filter((k) => !excludes.includes(k as never));
});
},
}) as never;
}
/**
* Creates a new object including only specified properties from the original object.
*
* This function returns a proxy that includes only specified keys when enumerating
* the object's properties. The returned object behaves like the original but
* only contains the included properties during enumeration and spreading operations.
*
* @template T - The type of the original object
* @template K - The type of keys to include
* @param source - The original object to create a proxy for
* @param props - The original object to pick properties from
* @param includes - An array of keys to include in the object (default: empty array)
* @returns A new object with only specified properties included
*/
export function pickProps<T, K extends keyof T>(source: T, props: T, includes: Array<K> = []): Pick<T, K> {
return new Proxy(source as Record<string, unknown>, {
get(_target, key, receiver) {
return Reflect.get(props as Record<string, unknown>, key, receiver);
},
set(_target, key, value, receiver) {
return Reflect.set(props as Record<string, unknown>, key, value, receiver);
},
ownKeys(target: Record<string, unknown>): ArrayLike<string | symbol> {
return untrack(() => {
return Object.keys(target as Record<string, unknown>).filter((k) => includes.includes(k as never));
});
},
}) as never;
}
|