All files / src/internal/client/reactivity props.js

97.44% Statements 267/274
93.15% Branches 68/73
94.44% Functions 17/18
97.37% Lines 260/267

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 2682x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 44x 44x 44x 44x 2x 2x 2x 2x 2x 2x 2x 6x 6x 6x 6x 2x 2x 2x 2x 2x 2x 2x 2x 918x 918x 2x 2x               2x 2x 418x 418x 418x 418x 418x 418x 418x 418x 2x 2x 362x 362x 2x 2x 246x 246x 2x 2x 2x 2x 2x 2x 2x 2x 2x 66x 66x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 1042x 1042x 1698x 1698x 1698x 1698x 2x 2x 130x 130x 190x 190x 190x 190x 2x 2x 372x 522x 522x 522x 36x 36x 2x 2x 104x 104x 104x 104x 206x 206x 600x 600x 206x 104x 104x 104x 2x 2x 2x 2x 2x 2x 2x 56x 56x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 4727x 4727x 4727x 4727x 4727x 4727x 4727x 4727x 4727x 4727x 4727x 2007x 475x 475x 475x 2007x 2007x 4727x 4727x 4727x 1913x 2x 2x 2x 2x 2x 2x 2x 2x 1911x 1911x 1913x 1913x 4725x 4725x 4727x 566x 566x 470x 470x 566x 4727x 9624x 9624x 9624x 4727x 4727x 4727x 4727x 20x 20x 4705x 4705x 4705x 4719x 270x 1424x 142x 142x 1424x 1282x 1282x 270x 270x 4435x 4435x 4435x 4435x 4435x 4435x 4435x 4435x 4435x 4435x 4435x 8707x 8707x 8707x 8707x 3778x 3778x 3778x 3778x 4929x 4929x 4929x 4435x 4435x 4719x 4435x 4435x 22707x 22707x 22707x 22707x 22707x 146x 146x 146x 146x 146x 146x 146x 146x 22707x 22707x 3850x 3770x 3770x 3770x 3770x 3850x 3850x 3850x 18857x 18857x 4435x 4435x  
import { DEV } from 'esm-env';
import {
	PROPS_IS_IMMUTABLE,
	PROPS_IS_LAZY_INITIAL,
	PROPS_IS_RUNES,
	PROPS_IS_UPDATED
} from '../../../constants.js';
import { get_descriptor, is_function } from '../utils.js';
import { mutable_source, set } from './sources.js';
import { derived } from './deriveds.js';
import { get, inspect_fn, is_signals_recorded, untrack } from '../runtime.js';
import { safe_equals } from './equality.js';
 
/**
 * @param {((value?: number) => number)} fn
 * @param {1 | -1} [d]
 * @returns {number}
 */
export function update_prop(fn, d = 1) {
	const value = fn();
	fn(value + d);
	return value;
}
 
/**
 * @param {((value?: number) => number)} fn
 * @param {1 | -1} [d]
 * @returns {number}
 */
export function update_pre_prop(fn, d = 1) {
	const value = fn() + d;
	fn(value);
	return value;
}
 
/**
 * The proxy handler for rest props (i.e. `const { x, ...rest } = $props()`).
 * Is passed the full `$$props` object and excludes the named props.
 * @type {ProxyHandler<{ props: Record<string | symbol, unknown>, exclude: Array<string | symbol>, name?: string }>}}
 */
const rest_props_handler = {
	get(target, key) {
		if (target.exclude.includes(key)) return;
		return target.props[key];
	},
	set(target, key) {
		if (DEV) {
			throw new Error(
				`Rest element properties of $props() such as ${target.name}.${String(key)} are readonly`
			);
		}

		return false;
	},
	getOwnPropertyDescriptor(target, key) {
		if (target.exclude.includes(key)) return;
		if (key in target.props) {
			return {
				enumerable: true,
				configurable: true,
				value: target.props[key]
			};
		}
	},
	has(target, key) {
		if (target.exclude.includes(key)) return false;
		return key in target.props;
	},
	ownKeys(target) {
		return Reflect.ownKeys(target.props).filter((key) => !target.exclude.includes(key));
	}
};
 
/**
 * @param {Record<string, unknown>} props
 * @param {string[]} exclude
 * @param {string} [name]
 * @returns {Record<string, unknown>}
 */
export function rest_props(props, exclude, name) {
	return new Proxy(DEV ? { props, exclude, name } : { props, exclude }, rest_props_handler);
}
 
/**
 * The proxy handler for spread props. Handles the incoming array of props
 * that looks like `() => { dynamic: props }, { static: prop }, ..` and wraps
 * them so that the whole thing is passed to the component as the `$$props` argument.
 * @template {Record<string | symbol, unknown>} T
 * @type {ProxyHandler<{ props: Array<T | (() => T)> }>}}
 */
const spread_props_handler = {
	get(target, key) {
		let i = target.props.length;
		while (i--) {
			let p = target.props[i];
			if (is_function(p)) p = p();
			if (typeof p === 'object' && p !== null && key in p) return p[key];
		}
	},
	getOwnPropertyDescriptor(target, key) {
		let i = target.props.length;
		while (i--) {
			let p = target.props[i];
			if (is_function(p)) p = p();
			if (typeof p === 'object' && p !== null && key in p) return get_descriptor(p, key);
		}
	},
	has(target, key) {
		for (let p of target.props) {
			if (is_function(p)) p = p();
			if (key in p) return true;
		}
 
		return false;
	},
	ownKeys(target) {
		/** @type {Array<string | symbol>} */
		const keys = [];
 
		for (let p of target.props) {
			if (is_function(p)) p = p();
			for (const key in p) {
				if (!keys.includes(key)) keys.push(key);
			}
		}
 
		return keys;
	}
};
 
/**
 * @param {Array<Record<string, unknown> | (() => Record<string, unknown>)>} props
 * @returns {any}
 */
export function spread_props(...props) {
	return new Proxy({ props }, spread_props_handler);
}
 
/**
 * This function is responsible for synchronizing a possibly bound prop with the inner component state.
 * It is used whenever the compiler sees that the component writes to the prop, or when it has a default prop_value.
 * @template V
 * @param {Record<string, unknown>} props
 * @param {string} key
 * @param {number} flags
 * @param {V | (() => V)} [fallback]
 * @returns {(() => V | ((arg: V) => V) | ((arg: V, mutation: boolean) => V))}
 */
export function prop(props, key, flags, fallback) {
	var immutable = (flags & PROPS_IS_IMMUTABLE) !== 0;
	var runes = (flags & PROPS_IS_RUNES) !== 0;
	var lazy = (flags & PROPS_IS_LAZY_INITIAL) !== 0;
 
	var prop_value = /** @type {V} */ (props[key]);
	var setter = get_descriptor(props, key)?.set;
 
	var fallback_value = /** @type {V} */ (fallback);
	var fallback_dirty = true;
 
	var get_fallback = () => {
		if (lazy && fallback_dirty) {
			fallback_dirty = false;
			fallback_value = untrack(/** @type {() => V} */ (fallback));
		}
 
		return fallback_value;
	};
 
	if (prop_value === undefined && fallback !== undefined) {
		if (setter && runes) {
			// TODO consolidate all these random runtime errors
			throw new Error(
				'ERR_SVELTE_BINDING_FALLBACK' +
					(DEV
						? `: Cannot pass undefined to bind:${key} because the property contains a fallback value. Pass a different value than undefined to ${key}.`
						: '')
			);
		}
 
		prop_value = get_fallback();
		if (setter) setter(prop_value);
	}
 
	var getter = runes
		? () => {
				var value = /** @type {V} */ (props[key]);
				if (value === undefined) return get_fallback();
				fallback_dirty = true;
				return value;
			}
		: () => {
				var value = /** @type {V} */ (props[key]);
				if (value !== undefined) fallback_value = /** @type {V} */ (undefined);
				return value === undefined ? fallback_value : value;
			};
 
	// easy mode — prop is never written to
	if ((flags & PROPS_IS_UPDATED) === 0) {
		return getter;
	}
 
	// intermediate mode — prop is written to, but the parent component had
	// `bind:foo` which means we can just call `$$props.foo = value` directly
	if (setter) {
		return function (/** @type {V} */ value) {
			if (arguments.length === 1) {
				/** @type {Function} */ (setter)(value);
				return value;
			} else {
				return getter();
			}
		};
	}
 
	// hard mode. this is where it gets ugly — the value in the child should
	// synchronize with the parent, but it should also be possible to temporarily
	// set the value to something else locally.
	var from_child = false;
	var was_from_child = false;
 
	// The derived returns the current value. The underlying mutable
	// source is written to from various places to persist this value.
	var inner_current_value = mutable_source(prop_value);
	var current_value = derived(() => {
		var parent_value = getter();
		var child_value = get(inner_current_value);
 
		if (from_child) {
			from_child = false;
			was_from_child = true;
			return child_value;
		}
 
		was_from_child = false;
		return (inner_current_value.v = parent_value);
	});
 
	if (!immutable) current_value.equals = safe_equals;
 
	return function (/** @type {V} */ value) {
		var current = get(current_value);
 
		// legacy nonsense — need to ensure the source is invalidated when necessary
		// also needed for when handling inspect logic so we can inspect the correct source signal
		if (is_signals_recorded || (DEV && inspect_fn)) {
			// set this so that we don't reset to the parent value if `d`
			// is invalidated because of `invalidate_inner_signals` (rather
			// than because the parent or child value changed)
			from_child = was_from_child;
			// invoke getters so that signals are picked up by `invalidate_inner_signals`
			getter();
			get(inner_current_value);
		}
 
		if (arguments.length > 0) {
			if (!current_value.equals(value)) {
				from_child = true;
				set(inner_current_value, value);
				get(current_value); // force a synchronisation immediately
			}
 
			return value;
		}
 
		return current;
	};
}