summaryrefslogtreecommitdiff
path: root/apps/web/src/animation/animated-params.ts
blob: bc27b15df96a13942423b2f3403ef69251012cef (plain) (blame)
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
import { snapToStep } from "@/utils/math";
import type { ParamDefinition } from "@/params";
import type { DynamicAnimationPathValue, NumericSpec } from "./types";

export function getAnimationParamValueKind({
	param,
}: {
	param: ParamDefinition;
}): "number" | "color" | "discrete" {
	if (param.type === "number") {
		return "number";
	}

	if (param.type === "color") {
		return "color";
	}

	return "discrete";
}

export function getAnimationParamDefaultInterpolation({
	param,
}: {
	param: ParamDefinition;
}): "linear" | "hold" {
	return param.type === "number" || param.type === "color" ? "linear" : "hold";
}

export function getAnimationParamNumericRange({
	param,
}: {
	param: ParamDefinition;
}): NumericSpec | undefined {
	if (param.type !== "number") {
		return undefined;
	}

	return {
		min: param.min,
		max: param.max,
		step: param.step,
	};
}

/**
 * `coerceAnimationParamValue` accepts `unknown` rather than a narrow
 * `DynamicAnimationPathValue` because it doubles as a runtime gate for
 * untrusted inputs (persisted state, paste payloads, programmatic updates).
 * The caller does not need to pre-validate; null means "this value cannot live
 * on this param".
 */
export function coerceAnimationParamValue({
	param,
	value,
}: {
	param: ParamDefinition;
	value: unknown;
}): DynamicAnimationPathValue | null {
	if (param.type === "number") {
		if (typeof value !== "number" || Number.isNaN(value)) {
			return null;
		}

		const steppedValue = snapToStep({ value, step: param.step });
		const minValue = param.min;
		const maxValue = param.max ?? Number.POSITIVE_INFINITY;
		return Math.min(maxValue, Math.max(minValue, steppedValue));
	}

	if (param.type === "color") {
		return typeof value === "string" ? value : null;
	}

	if (param.type === "boolean") {
		return typeof value === "boolean" ? value : null;
	}

	if (typeof value !== "string") {
		return null;
	}

	return param.options.some((option) => option.value === value) ? value : null;
}