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 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 | 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 4x 4x 4x 4x 4x 4x 4x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 22x 160x 160x 160x 160x 129x 129x 129x 129x 129x 129x 129x 129x 129x 129x 129x 129x 129x 129x 129x 129x 160x 31x 31x 31x 31x 160x 160x 22x 22x 22x 22x 22x 22x 4x 4x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 129x 129x 129x 129x 129x 129x 129x 129x 129x 129x 129x 129x 129x 129x 129x 129x 129x 129x 129x 129x 129x 129x 44x 44x 44x 59x 59x 59x 59x 59x 59x 59x 59x 59x 44x 44x 44x 44x 44x 44x 44x 3x 3x 44x 126x 126x 126x 41x 41x 126x 126x 126x 126x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 160x 160x 35x 35x 35x 35x 35x 160x 125x 125x 125x 160x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 59x 59x 59x 59x 59x 59x 59x 59x 83x 83x 12x 2x 12x 83x 71x 71x 71x 71x 71x 59x 59x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 106x 106x 106x 106x 106x 106x 106x 106x 106x 106x 106x 67x 57x 57x 57x 10x 10x 106x 39x 39x 39x 39x 49x 49x 49x 49x 49x 106x 9x 9x 9x 106x 40x 40x 40x 40x 49x 49x 49x 2x 2x 2x 2x 2x 2x 2x 2x 57x 41x 41x 41x 57x 57x | import { DEV } from 'esm-env';
import { source, set } from '../internal/client/reactivity/sources.js';
import { get } from '../internal/client/runtime.js';
export const NOTIFY_WITH_ALL_PARAMS = Symbol();
/**
* some `write_properties` require a custom logic to notify a change for read properties.
* for instance calling `set.add(2)` two times should not cause reactivity the second time.
* interceptor is called before the call is proxied to the actual object, so we can decide wether a change
* is actually going to happen or not.
* - if a `write_property` shouldn't increment the `version` signal return false from the interceptor. note that calling `notify_read_methods` WILL increase the `version` in all cases.
* returning false is only useful if do it before calling `notify_read_methods` like an if-guard that returns false early because no change has happened.
* - DO NOT USE INTERCEPTORS FOR READ PROPERTIES
* @template TEntityInstance
* @template {(keyof TEntityInstance)[]} TWriteProperties
* @template {(keyof TEntityInstance)[] | undefined} TReadProperties
* @typedef {Partial<Record<TWriteProperties[number], (notify_read_methods: (methods: TReadProperties, ...params: unknown[])=>void ,value: TEntityInstance, property: TWriteProperties[number], ...params: unknown[])=>boolean>>} Interceptors
*/
/**
* @template TEntityInstance
* @template {(keyof TEntityInstance)[]} TWriteProperties
* @template {(keyof TEntityInstance)[] | undefined} TReadProperties
* @typedef {object} Options
* @prop {TWriteProperties} write_properties - an array of property names on `TEntityInstance`, could cause reactivity.
* @prop {TReadProperties} [read_properties] - an array of property names on `TEntityInstance` that `write_properties` affect, typically used for methods. for instance `size` doesn't need to be here because it takes no parameters and is reactive based on the `version` signal.
* @prop {Interceptors<TEntityInstance, TWriteProperties, TReadProperties>} [interceptors={}] - an object of interceptors for `write_properties` that can customize how/when a `read_properties` should be notified of a change.
*/
/** @typedef {Map<string | symbol | number, Map<unknown, import("#client").Source<boolean>>>} ReadMethodsSignals */
/**
* @template {new (...args: any) => any} TEntity
* @template {(keyof InstanceType<TEntity>)[]} TWriteProperties
* @template {(keyof InstanceType<TEntity>)[] | undefined} TReadProperties
* @param {TEntity} Entity - the entity we want to make reactive
* @param {Options<InstanceType<TEntity>, TWriteProperties, TReadProperties>} options - configurations for how reactivity works for this entity
* @returns {TEntity}
*/
export const make_reactive = (Entity, options) => {
// we return a class so that the caller can call it with new
// @ts-ignore
return class {
/**
* @param {...unknown[]} params
*/
constructor(...params) {
/**
* each read method can be tracked like has, get, has and etc. these props might depend on a parameter. they have to reactive based on the
* parameter they depend on. for instance if you have `set.has(2)` and then call `set.add(5)` the former shouldn't get notified.
* based on that we need to store the function_name + parameter(s).
* @type {ReadMethodsSignals}
**/
const read_methods_signals = new Map();
/**
* other props that get notified based on any change listen to version
*/
const version_signal = source(false);
return new Proxy(new Entity(...params), {
get(target, property) {
const orig_property = target[property];
let result;
if (typeof orig_property === 'function') {
// bind functions directly to the `TEntity`
result = ((/** @type {unknown[]} */ ...params) => {
const notifiers = create_notifiers(
version_signal,
read_methods_signals,
property,
target,
options,
...params
);
const function_result = orig_property.bind(target)(...params);
// causing reactivity after the function is actually called and performed its changes
get_read_signals(version_signal, read_methods_signals, property, options, ...params);
notifiers.forEach((notifier) => notifier());
return function_result;
}).bind(target);
} else {
// handle getters/props
result = Reflect.get(target, property, target);
get_read_signals(version_signal, read_methods_signals, property, options, ...params);
}
return result;
},
set(target, property, value) {
const notifiers = create_notifiers(
version_signal,
read_methods_signals,
property,
target,
options,
value
);
const result = Reflect.set(target, property, value, target);
notifiers.forEach((notifier) => notifier());
return result;
},
ownKeys: (target) => {
// to make it work with $inspect
get(version_signal);
return Reflect.ownKeys(target);
}
});
}
};
};
/**
* creates an array of functions that notify other signals based on the changes, you need to run these functions to invoke reactivity
* @template {new (...args: any) => any} TEntity
* @template {(keyof TEntityInstance)[]} TWriteProperties
* @template {(keyof TEntityInstance)[] | undefined} TReadProperties
* @template {InstanceType<TEntity>} TEntityInstance
* @template {keyof TEntityInstance} TProperty
* @param {import('#client').Source<boolean>} version_signal
* @param {ReadMethodsSignals} read_methods_signals
* @param {TProperty} property
* @param {TEntityInstance} entity_instance
* @param {Options<InstanceType<TEntity>, TWriteProperties, TReadProperties>} options
* @param {unknown[]} params
* @returns {Function[]}
*/
function create_notifiers(
version_signal,
read_methods_signals,
property,
entity_instance,
options,
...params
) {
// the `version_signal_incremented` flag helps to update the `version_signal` only once
const options_with_version_flag = { ...options, is_version_signal_incremented: false };
/**
* @type {Function[]}
*/
const notifiers = [];
const interceptor =
options.interceptors &&
Object.hasOwn(options.interceptors, property) &&
options.interceptors?.[property];
if (interceptor) {
const increment_version_signal =
interceptor(
(methods, ...params) => {
notifiers.push(() => {
notify_read_methods(
options_with_version_flag,
version_signal,
read_methods_signals,
methods,
...params
);
});
},
entity_instance,
property,
...params
) === true;
if (!increment_version_signal) {
return notifiers;
}
}
notifiers.push(() => {
if (options.write_properties.some((v) => v === property)) {
increment_signal(options_with_version_flag, version_signal);
}
});
return notifiers;
}
/**
* @template {new (...args: any) => any} TEntity
* @template {(keyof TEntityInstance)[]} TWriteProperties
* @template {(keyof TEntityInstance)[] | undefined} TReadProperties
* @template {InstanceType<TEntity>} TEntityInstance
* @template {keyof TEntityInstance} TProperty
* @param {import('#client').Source<boolean>} version_signal
* @param {ReadMethodsSignals} read_methods_signals
* @param {TProperty} property
* @param {Options<InstanceType<TEntity>, TWriteProperties, TReadProperties>} options
* @param {unknown[]} params
*/
function get_read_signals(version_signal, read_methods_signals, property, options, ...params) {
if (options.read_properties?.includes(property)) {
(params.length == 0 ? [null] : params).forEach((param) => {
// read like methods that are reactive conditionally should create the signal (if not already created) so they can be reactive when notified based on their param
const sig = get_signal_for_function(read_methods_signals, property, param, true);
get(sig);
});
} else {
// other read like methods that are not reactive conditionally based their params and are just notified based on the version signal are here
get(version_signal);
}
}
/**
* @template {new (...args: any) => any} TEntity
* @template {(keyof TEntityInstance)[]} TWriteProperties
* @template {(keyof TEntityInstance)[] | undefined} TReadProperties
* @template {InstanceType<TEntity>} TEntityInstance
* @param {import('#client').Source<boolean>} version_signal
* @param {ReadMethodsSignals} read_methods_signals
* @param {Options<InstanceType<TEntity>, TWriteProperties, TReadProperties> & {is_version_signal_incremented: boolean}} options
* @param {TReadProperties} method_names
* @param {unknown[]} params - if you want to notify for all parameters pass the `NOTIFY_WITH_ALL_PARAMS` constant, for instance some methods like `clear` should notify all `something.get(x)` methods; on these cases set this flag to true
*/
function notify_read_methods(
options,
version_signal,
read_methods_signals,
method_names,
...params
) {
method_names?.forEach((name) => {
if (DEV && !options.read_properties?.includes(name)) {
throw new Error(
`when trying to notify reactions got a read method that wasn't defined in options: ${name.toString()}`
);
}
if (params.length == 1 && params[0] == NOTIFY_WITH_ALL_PARAMS) {
read_methods_signals.get(name)?.forEach((sig) => {
increment_signal(options, version_signal, sig);
});
} else {
(params.length == 0 ? [null] : params).forEach((param) => {
const sig = get_signal_for_function(read_methods_signals, name, param);
sig && increment_signal(options, version_signal, sig);
});
}
});
}
/**
* gets the signal for this function based on params. If the signal doesn't exist and `create_signal_if_doesnt_exist` is not set to true, it creates a new one and returns that
* @template {boolean} [TCreateSignalIfDoesntExist=false]
* @param {ReadMethodsSignals} signals_map
* @param {string | symbol | number} function_name
* @param {unknown} param
* @param {TCreateSignalIfDoesntExist} [create_signal_if_doesnt_exist=false]
* @returns {TCreateSignalIfDoesntExist extends true ? import("#client").Source<boolean> : import("#client").Source<boolean> | null }
*/
const get_signal_for_function = (
signals_map,
function_name,
param,
// @ts-ignore: this should be supported in jsdoc based on https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html#template but isn't?
create_signal_if_doesnt_exist = false
) => {
/**
* @type {Map<unknown, import("#client").Source<boolean>>}
*/
let params_to_signal_map;
if (!signals_map.has(function_name)) {
if (!create_signal_if_doesnt_exist) {
// @ts-ignore
return null;
}
params_to_signal_map = new Map([[param, source(false)]]);
signals_map.set(function_name, params_to_signal_map);
} else {
params_to_signal_map = /**
* @type {Map<unknown[], import("#client").Source<boolean>>}
*/ (signals_map.get(function_name));
}
/**
* @type {import("#client").Source<boolean>}
*/
let signal;
if (!params_to_signal_map.has(param)) {
if (!create_signal_if_doesnt_exist) {
// @ts-ignore
return null;
}
signal = source(false);
params_to_signal_map.set(param, signal);
} else {
signal = /**
* @type {import("#client").Source<boolean>}
*/ (params_to_signal_map.get(param));
}
// @ts-ignore
return signal;
};
/**
* toggles the signal value. this change notifies any reactions (not using number explicitly cause its not required, change from true to false or vice versa is enough).
* @param {{is_version_signal_incremented: boolean}} options - this prevents changing the version signal multiple times in a single changeset
* @param {import("#client").Source<boolean>} version_signal
* @param {import("#client").Source<boolean>} [read_method_signal]
*/
const increment_signal = (options, version_signal, read_method_signal) => {
if (!options.is_version_signal_incremented) {
options.is_version_signal_incremented = true;
set(version_signal, !version_signal.v);
}
read_method_signal && set(read_method_signal, !read_method_signal.v);
};
|