@arbor-css/functions 0.0.51
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.md +7 -0
- package/dist/index.d.ts +54 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +72 -0
- package/dist/index.js.map +1 -0
- package/dist/index.test.d.ts +2 -0
- package/dist/index.test.d.ts.map +1 -0
- package/dist/index.test.js +136 -0
- package/dist/index.test.js.map +1 -0
- package/package.json +38 -0
package/LICENSE.md
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
Copyright 2026 Grant Forrest
|
|
2
|
+
|
|
3
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
4
|
+
|
|
5
|
+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
|
6
|
+
|
|
7
|
+
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
import { CalcInterpolation, CalcOperations, Css, type Equation } from '@arbor-css/calc';
|
|
2
|
+
export declare const FUNCTION_PREFIX = "--x-fn-";
|
|
3
|
+
export type ParameterSchema = {
|
|
4
|
+
name: string;
|
|
5
|
+
/**
|
|
6
|
+
* The CSS type for this parameter. Defaults to '*' (any).
|
|
7
|
+
* Used in the @function parameter list as <type>.
|
|
8
|
+
*/
|
|
9
|
+
type?: string;
|
|
10
|
+
};
|
|
11
|
+
declare const FUNCTION_BRAND = "@@FUNCTION@@";
|
|
12
|
+
type CssProperty = `--${string}`;
|
|
13
|
+
type FunctionParams = readonly CssProperty[];
|
|
14
|
+
type ParamsAsInterpolations<TParams extends FunctionParams> = {
|
|
15
|
+
[K in keyof TParams]: CalcInterpolation;
|
|
16
|
+
};
|
|
17
|
+
/**
|
|
18
|
+
* Creates a CSS custom function definition with runtime compute capability.
|
|
19
|
+
*
|
|
20
|
+
* @example
|
|
21
|
+
* const spacing = createFunction('spacing-scale', {
|
|
22
|
+
* description: 'Scales a base spacing value by a multiplier',
|
|
23
|
+
* parameters: [
|
|
24
|
+
* createToken('base', { name: 'base', type: 'length' }),
|
|
25
|
+
* createToken('scale', { name: 'scale', type: 'number' }),
|
|
26
|
+
* ],
|
|
27
|
+
* definition: (base, scale) => $.multiply(base, scale),
|
|
28
|
+
* });
|
|
29
|
+
*
|
|
30
|
+
* spacing.definition // @function --spacing-scale(--base <length>, --scale <number>) { result: (var(--base) * var(--scale)); }
|
|
31
|
+
* spacing.compute({ base: '8px', scale: 2 }) // 'calc(var(--base) * 2)' or '16px'
|
|
32
|
+
*/
|
|
33
|
+
export declare function createFunctionFactory({ tokenPrefix, }?: {
|
|
34
|
+
tokenPrefix?: string;
|
|
35
|
+
}): <TParams extends FunctionParams>(name: string, { description, parameters, definition, }: {
|
|
36
|
+
description?: string;
|
|
37
|
+
parameters: TParams;
|
|
38
|
+
definition: (css: Css & CalcOperations, ...params: CalcInterpolation[]) => Equation;
|
|
39
|
+
}) => ArborFunction<TParams>;
|
|
40
|
+
export type CreateFunction = ReturnType<typeof createFunctionFactory>;
|
|
41
|
+
export type ArborFunction<TParams extends FunctionParams = FunctionParams> = {
|
|
42
|
+
[FUNCTION_BRAND]: true;
|
|
43
|
+
name: string;
|
|
44
|
+
description?: string;
|
|
45
|
+
parameters: TParams;
|
|
46
|
+
equation: Equation;
|
|
47
|
+
definition: string;
|
|
48
|
+
inline: (...params: ParamsAsInterpolations<TParams>) => Equation;
|
|
49
|
+
compute: (params: Record<string, string | number>) => string;
|
|
50
|
+
};
|
|
51
|
+
export type PresetFunctions = Record<string, ArborFunction<any>>;
|
|
52
|
+
export declare function isFunction(value: unknown): value is ArborFunction;
|
|
53
|
+
export {};
|
|
54
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAEN,iBAAiB,EACjB,cAAc,EAGd,GAAG,EACH,KAAK,QAAQ,EAGb,MAAM,iBAAiB,CAAC;AAGzB,eAAO,MAAM,eAAe,YAA+B,CAAC;AAE5D,MAAM,MAAM,eAAe,GAAG;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,QAAA,MAAM,cAAc,iBAAiB,CAAC;AAEtC,KAAK,WAAW,GAAG,KAAK,MAAM,EAAE,CAAC;AACjC,KAAK,cAAc,GAAG,SAAS,WAAW,EAAE,CAAC;AAC7C,KAAK,sBAAsB,CAAC,OAAO,SAAS,cAAc,IAAI;KAC5D,CAAC,IAAI,MAAM,OAAO,GAAG,iBAAiB;CACvC,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,qBAAqB,CAAC,EACrC,WAAkC,GAClC,GAAE;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;CAChB,IAG0B,OAAO,SAAS,cAAc,EAC5D,MAAM,MAAM,EACZ,0CAIG;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,CACX,GAAG,EAAE,GAAG,GAAG,cAAc,EACzB,GAAG,MAAM,EAAE,iBAAiB,EAAE,KAC1B,QAAQ,CAAC;CACd,KACC,aAAa,CAAC,OAAO,CAAC,CAuDzB;AAED,MAAM,MAAM,cAAc,GAAG,UAAU,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAEtE,MAAM,MAAM,aAAa,CAAC,OAAO,SAAS,cAAc,GAAG,cAAc,IAAI;IAC5E,CAAC,cAAc,CAAC,EAAE,IAAI,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,OAAO,CAAC;IACpB,QAAQ,EAAE,QAAQ,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,CAAC,GAAG,MAAM,EAAE,sBAAsB,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC;IACjE,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,KAAK,MAAM,CAAC;CAC7D,CAAC;AACF,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC;AAEjE,wBAAgB,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,aAAa,CAEjE"}
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
import { $, computeEquation, css, printComputationResult, printEquation, } from '@arbor-css/calc';
|
|
2
|
+
import { DEFAULT_TOKEN_PREFIX, isToken } from '@arbor-css/tokens';
|
|
3
|
+
export const FUNCTION_PREFIX = `${DEFAULT_TOKEN_PREFIX}fn-`;
|
|
4
|
+
const FUNCTION_BRAND = '@@FUNCTION@@';
|
|
5
|
+
/**
|
|
6
|
+
* Creates a CSS custom function definition with runtime compute capability.
|
|
7
|
+
*
|
|
8
|
+
* @example
|
|
9
|
+
* const spacing = createFunction('spacing-scale', {
|
|
10
|
+
* description: 'Scales a base spacing value by a multiplier',
|
|
11
|
+
* parameters: [
|
|
12
|
+
* createToken('base', { name: 'base', type: 'length' }),
|
|
13
|
+
* createToken('scale', { name: 'scale', type: 'number' }),
|
|
14
|
+
* ],
|
|
15
|
+
* definition: (base, scale) => $.multiply(base, scale),
|
|
16
|
+
* });
|
|
17
|
+
*
|
|
18
|
+
* spacing.definition // @function --spacing-scale(--base <length>, --scale <number>) { result: (var(--base) * var(--scale)); }
|
|
19
|
+
* spacing.compute({ base: '8px', scale: 2 }) // 'calc(var(--base) * 2)' or '16px'
|
|
20
|
+
*/
|
|
21
|
+
export function createFunctionFactory({ tokenPrefix = DEFAULT_TOKEN_PREFIX, } = {}) {
|
|
22
|
+
const functionPrefix = `${tokenPrefix}fn-`;
|
|
23
|
+
return function createFunction(name, { description, parameters, definition, }) {
|
|
24
|
+
const cssName = `${functionPrefix}${name}`;
|
|
25
|
+
const definitionTools = Object.assign(css, $);
|
|
26
|
+
const parameterNames = parameters.map((parameter) => isToken(parameter) ? parameter.name : parameter);
|
|
27
|
+
const paramsList = parameters
|
|
28
|
+
.map((p) => {
|
|
29
|
+
if (isToken(p)) {
|
|
30
|
+
const type = p.type ?? '*';
|
|
31
|
+
const typeAnnotation = type === '*' ? '' : ` <${type}>`;
|
|
32
|
+
return `${p.name}${typeAnnotation}`;
|
|
33
|
+
}
|
|
34
|
+
return p;
|
|
35
|
+
})
|
|
36
|
+
.join(', ');
|
|
37
|
+
const equation = definition(definitionTools, ...parameterNames.map((parameter) => $.val(`var(${parameter})`)));
|
|
38
|
+
const body = printEquation(equation);
|
|
39
|
+
const cssDefinition = `@function ${cssName}(${paramsList}) { result: ${body}; }`;
|
|
40
|
+
return {
|
|
41
|
+
[FUNCTION_BRAND]: true,
|
|
42
|
+
name: cssName,
|
|
43
|
+
description,
|
|
44
|
+
parameters,
|
|
45
|
+
equation,
|
|
46
|
+
definition: cssDefinition,
|
|
47
|
+
inline: (...params) => definition(definitionTools, ...params),
|
|
48
|
+
compute(params) {
|
|
49
|
+
const propertyValues = {};
|
|
50
|
+
for (let index = 0; index < parameters.length; index++) {
|
|
51
|
+
const parameter = parameters[index];
|
|
52
|
+
const cssParameterName = parameterNames[index];
|
|
53
|
+
const logicalName = isToken(parameter) && cssParameterName.startsWith(tokenPrefix) ?
|
|
54
|
+
cssParameterName.slice(tokenPrefix.length)
|
|
55
|
+
: cssParameterName.replace(/^--/, '');
|
|
56
|
+
if (logicalName in params) {
|
|
57
|
+
propertyValues[cssParameterName] = String(params[logicalName]);
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
const result = computeEquation(equation, {
|
|
61
|
+
propertyValues,
|
|
62
|
+
skipBaking: false,
|
|
63
|
+
});
|
|
64
|
+
return printComputationResult(result);
|
|
65
|
+
},
|
|
66
|
+
};
|
|
67
|
+
};
|
|
68
|
+
}
|
|
69
|
+
export function isFunction(value) {
|
|
70
|
+
return typeof value === 'object' && value !== null && FUNCTION_BRAND in value;
|
|
71
|
+
}
|
|
72
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,CAAC,EAGD,eAAe,EACf,GAAG,EAGH,sBAAsB,EACtB,aAAa,GACb,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,oBAAoB,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAElE,MAAM,CAAC,MAAM,eAAe,GAAG,GAAG,oBAAoB,KAAK,CAAC;AAW5D,MAAM,cAAc,GAAG,cAAc,CAAC;AAQtC;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,qBAAqB,CAAC,EACrC,WAAW,GAAG,oBAAoB,MAG/B,EAAE;IACL,MAAM,cAAc,GAAG,GAAG,WAAW,KAAK,CAAC;IAE3C,OAAO,SAAS,cAAc,CAC7B,IAAY,EACZ,EACC,WAAW,EACX,UAAU,EACV,UAAU,GAQV;QAED,MAAM,OAAO,GAAG,GAAG,cAAc,GAAG,IAAI,EAAE,CAAC;QAC3C,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAyB,CAAC;QACtE,MAAM,cAAc,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CACnD,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAC/C,CAAC;QAEF,MAAM,UAAU,GAAG,UAAU;aAC3B,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;YACV,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;gBAChB,MAAM,IAAI,GAAG,CAAC,CAAC,IAAI,IAAI,GAAG,CAAC;gBAC3B,MAAM,cAAc,GAAG,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,GAAG,CAAC;gBACxD,OAAO,GAAG,CAAC,CAAC,IAAI,GAAG,cAAc,EAAE,CAAC;YACrC,CAAC;YACD,OAAO,CAAC,CAAC;QACV,CAAC,CAAC;aACD,IAAI,CAAC,IAAI,CAAC,CAAC;QAEb,MAAM,QAAQ,GAAG,UAAU,CAC1B,eAAe,EACf,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,SAAS,GAAG,CAAC,CAAC,CAChE,CAAC;QACF,MAAM,IAAI,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC;QACrC,MAAM,aAAa,GAAG,aAAa,OAAO,IAAI,UAAU,eAAe,IAAI,KAAK,CAAC;QAEjF,OAAO;YACN,CAAC,cAAc,CAAC,EAAE,IAAa;YAC/B,IAAI,EAAE,OAAO;YACb,WAAW;YACX,UAAU;YACV,QAAQ;YACR,UAAU,EAAE,aAAa;YACzB,MAAM,EAAE,CAAC,GAAG,MAAuC,EAAE,EAAE,CACtD,UAAU,CAAC,eAAe,EAAE,GAAG,MAAM,CAAC;YACvC,OAAO,CAAC,MAAuC;gBAC9C,MAAM,cAAc,GAA2B,EAAE,CAAC;gBAClD,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,UAAU,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC;oBACxD,MAAM,SAAS,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;oBACpC,MAAM,gBAAgB,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC;oBAC/C,MAAM,WAAW,GAChB,OAAO,CAAC,SAAS,CAAC,IAAI,gBAAgB,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC;wBAC/D,gBAAgB,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC;wBAC3C,CAAC,CAAC,gBAAgB,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;oBACvC,IAAI,WAAW,IAAI,MAAM,EAAE,CAAC;wBAC3B,cAAc,CAAC,gBAAgB,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC;oBAChE,CAAC;gBACF,CAAC;gBACD,MAAM,MAAM,GAAG,eAAe,CAAC,QAAQ,EAAE;oBACxC,cAAc;oBACd,UAAU,EAAE,KAAK;iBACjB,CAAC,CAAC;gBACH,OAAO,sBAAsB,CAAC,MAAM,CAAC,CAAC;YACvC,CAAC;SACD,CAAC;IACH,CAAC,CAAC;AACH,CAAC;AAgBD,MAAM,UAAU,UAAU,CAAC,KAAc;IACxC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,cAAc,IAAI,KAAK,CAAC;AAC/E,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.test.d.ts","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,136 @@
|
|
|
1
|
+
import { printEquation } from '@arbor-css/calc';
|
|
2
|
+
import { createToken } from '@arbor-css/tokens';
|
|
3
|
+
import { describe, expect, it } from 'vitest';
|
|
4
|
+
import { createFunction, isFunction } from './index.js';
|
|
5
|
+
describe('createFunction', () => {
|
|
6
|
+
it('sets the CSS name with -- prefix', () => {
|
|
7
|
+
const fn = createFunction('my-func', {
|
|
8
|
+
parameters: [],
|
|
9
|
+
definition: ($) => $.val(0),
|
|
10
|
+
});
|
|
11
|
+
expect(fn.name).toBe('--my-func');
|
|
12
|
+
});
|
|
13
|
+
it('stores description and parameters', () => {
|
|
14
|
+
const fn = createFunction('scale', {
|
|
15
|
+
description: 'Scales a value',
|
|
16
|
+
parameters: [
|
|
17
|
+
createToken('base', { type: 'length' }),
|
|
18
|
+
createToken('factor', { type: 'number' }),
|
|
19
|
+
],
|
|
20
|
+
definition: ($, base, factor) => $.multiply(base, factor),
|
|
21
|
+
});
|
|
22
|
+
expect(fn.description).toBe('Scales a value');
|
|
23
|
+
expect(fn.parameters).toHaveLength(2);
|
|
24
|
+
});
|
|
25
|
+
describe('definition (CSS @function)', () => {
|
|
26
|
+
it('generates @function with typed parameters', () => {
|
|
27
|
+
const fn = createFunction('scale', {
|
|
28
|
+
parameters: [
|
|
29
|
+
createToken('base', { type: 'length' }),
|
|
30
|
+
createToken('factor', { type: 'number' }),
|
|
31
|
+
],
|
|
32
|
+
definition: ($, base, factor) => $.multiply(base, factor),
|
|
33
|
+
});
|
|
34
|
+
expect(fn.definition).toBe('@function --scale(--base <length>, --factor <number>) { result: (var(--base) * var(--factor)); }');
|
|
35
|
+
});
|
|
36
|
+
it('omits type annotation for * (wildcard) type', () => {
|
|
37
|
+
const fn = createFunction('passthrough', {
|
|
38
|
+
parameters: [createToken('value')],
|
|
39
|
+
definition: (_, value) => value,
|
|
40
|
+
});
|
|
41
|
+
expect(fn.definition).toBe('@function --passthrough(--value) { result: var(--value); }');
|
|
42
|
+
});
|
|
43
|
+
it('omits type annotation when type is not provided (defaults to *)', () => {
|
|
44
|
+
const fn = createFunction('passthrough', {
|
|
45
|
+
parameters: [createToken('value')],
|
|
46
|
+
definition: (_, value) => value,
|
|
47
|
+
});
|
|
48
|
+
expect(fn.definition).toBe('@function --passthrough(--value) { result: var(--value); }');
|
|
49
|
+
});
|
|
50
|
+
it('generates @function with no parameters', () => {
|
|
51
|
+
const fn = createFunction('pi', {
|
|
52
|
+
parameters: [],
|
|
53
|
+
definition: ($) => $.val('PI'),
|
|
54
|
+
});
|
|
55
|
+
expect(fn.definition).toBe('@function --pi() { result: PI; }');
|
|
56
|
+
});
|
|
57
|
+
it('generates @function with clamp equation', () => {
|
|
58
|
+
const fn = createFunction('clamped', {
|
|
59
|
+
parameters: [
|
|
60
|
+
createToken('value', { type: 'number' }),
|
|
61
|
+
createToken('min', { type: 'number' }),
|
|
62
|
+
createToken('max', { type: 'number' }),
|
|
63
|
+
],
|
|
64
|
+
definition: ($, value, min, max) => $.clamp(value, min, max),
|
|
65
|
+
});
|
|
66
|
+
expect(fn.definition).toBe('@function --clamped(--value <number>, --min <number>, --max <number>) { result: clamp(var(--min), var(--value), var(--max)); }');
|
|
67
|
+
});
|
|
68
|
+
});
|
|
69
|
+
describe('compute', () => {
|
|
70
|
+
it('computes a simple multiply with numeric values', () => {
|
|
71
|
+
const fn = createFunction('scale', {
|
|
72
|
+
parameters: [
|
|
73
|
+
createToken('base', { type: 'number' }),
|
|
74
|
+
createToken('factor', { type: 'number' }),
|
|
75
|
+
],
|
|
76
|
+
definition: ($, base, factor) => $.multiply(base, factor),
|
|
77
|
+
});
|
|
78
|
+
expect(fn.compute({ base: 4, factor: 3 })).toBe('12');
|
|
79
|
+
});
|
|
80
|
+
it('computes an add expression', () => {
|
|
81
|
+
const fn = createFunction('add', {
|
|
82
|
+
parameters: [
|
|
83
|
+
createToken('a', { type: 'number' }),
|
|
84
|
+
createToken('b', { type: 'number' }),
|
|
85
|
+
],
|
|
86
|
+
definition: ($, a, b) => $.add(a, b),
|
|
87
|
+
});
|
|
88
|
+
expect(fn.compute({ a: 10, b: 5 })).toBe('15');
|
|
89
|
+
});
|
|
90
|
+
it('computes with string values that cannot be resolved numerically', () => {
|
|
91
|
+
const fn = createFunction('scale-length', {
|
|
92
|
+
parameters: [
|
|
93
|
+
createToken('base', { type: 'length' }),
|
|
94
|
+
createToken('factor', { type: 'number' }),
|
|
95
|
+
],
|
|
96
|
+
definition: ($, base, factor) => $.multiply(base, factor),
|
|
97
|
+
});
|
|
98
|
+
// '8px' is not a plain number so calc falls through to a calc() string
|
|
99
|
+
const result = fn.compute({ base: '8px', factor: 2 });
|
|
100
|
+
expect(result).toMatch(/8px/);
|
|
101
|
+
expect(result).toMatch(/2/);
|
|
102
|
+
});
|
|
103
|
+
it('resolves a constant equation with no params', () => {
|
|
104
|
+
const fn = createFunction('answer', {
|
|
105
|
+
parameters: [],
|
|
106
|
+
definition: ($) => $.multiply($.val(6), $.val(7)),
|
|
107
|
+
});
|
|
108
|
+
expect(fn.compute({})).toBe('42');
|
|
109
|
+
});
|
|
110
|
+
});
|
|
111
|
+
describe('equation property', () => {
|
|
112
|
+
it('equation can be printed independently', () => {
|
|
113
|
+
const fn = createFunction('test', {
|
|
114
|
+
parameters: [createToken('x')],
|
|
115
|
+
definition: ($, x) => $.multiply(x, $.val(2)),
|
|
116
|
+
});
|
|
117
|
+
expect(printEquation(fn.equation)).toBe('(var(--x) * 2)');
|
|
118
|
+
});
|
|
119
|
+
});
|
|
120
|
+
});
|
|
121
|
+
describe('isFunction', () => {
|
|
122
|
+
it('returns true for a created function', () => {
|
|
123
|
+
const fn = createFunction('test', {
|
|
124
|
+
parameters: [],
|
|
125
|
+
definition: ($) => $.val(0),
|
|
126
|
+
});
|
|
127
|
+
expect(isFunction(fn)).toBe(true);
|
|
128
|
+
});
|
|
129
|
+
it('returns false for non-function values', () => {
|
|
130
|
+
expect(isFunction(null)).toBe(false);
|
|
131
|
+
expect(isFunction(undefined)).toBe(false);
|
|
132
|
+
expect(isFunction(42)).toBe(false);
|
|
133
|
+
expect(isFunction({ name: '--test' })).toBe(false);
|
|
134
|
+
});
|
|
135
|
+
});
|
|
136
|
+
//# sourceMappingURL=index.test.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.test.js","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAExD,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;IAC/B,EAAE,CAAC,kCAAkC,EAAE,GAAG,EAAE;QAC3C,MAAM,EAAE,GAAG,cAAc,CAAC,SAAS,EAAE;YACpC,UAAU,EAAE,EAAE;YACd,UAAU,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;SAC3B,CAAC,CAAC;QACH,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACnC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;QAC5C,MAAM,EAAE,GAAG,cAAc,CAAC,OAAO,EAAE;YAClC,WAAW,EAAE,gBAAgB;YAC7B,UAAU,EAAE;gBACX,WAAW,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;gBACvC,WAAW,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;aACzC;YACD,UAAU,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;SACzD,CAAC,CAAC;QACH,MAAM,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC9C,MAAM,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,4BAA4B,EAAE,GAAG,EAAE;QAC3C,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;YACpD,MAAM,EAAE,GAAG,cAAc,CAAC,OAAO,EAAE;gBAClC,UAAU,EAAE;oBACX,WAAW,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;oBACvC,WAAW,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;iBACzC;gBACD,UAAU,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;aACzD,CAAC,CAAC;YACH,MAAM,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,IAAI,CACzB,kGAAkG,CAClG,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;YACtD,MAAM,EAAE,GAAG,cAAc,CAAC,aAAa,EAAE;gBACxC,UAAU,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;gBAClC,UAAU,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK;aAC/B,CAAC,CAAC;YACH,MAAM,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,IAAI,CACzB,4DAA4D,CAC5D,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iEAAiE,EAAE,GAAG,EAAE;YAC1E,MAAM,EAAE,GAAG,cAAc,CAAC,aAAa,EAAE;gBACxC,UAAU,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;gBAClC,UAAU,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK;aAC/B,CAAC,CAAC;YACH,MAAM,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,IAAI,CACzB,4DAA4D,CAC5D,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;YACjD,MAAM,EAAE,GAAG,cAAc,CAAC,IAAI,EAAE;gBAC/B,UAAU,EAAE,EAAE;gBACd,UAAU,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC;aAC9B,CAAC,CAAC;YACH,MAAM,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,kCAAkC,CAAC,CAAC;QAChE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;YAClD,MAAM,EAAE,GAAG,cAAc,CAAC,SAAS,EAAE;gBACpC,UAAU,EAAE;oBACX,WAAW,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;oBACxC,WAAW,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;oBACtC,WAAW,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;iBACtC;gBACD,UAAU,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,CAAC;aAC5D,CAAC,CAAC;YACH,MAAM,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,IAAI,CACzB,gIAAgI,CAChI,CAAC;QACH,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;QACxB,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;YACzD,MAAM,EAAE,GAAG,cAAc,CAAC,OAAO,EAAE;gBAClC,UAAU,EAAE;oBACX,WAAW,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;oBACvC,WAAW,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;iBACzC;gBACD,UAAU,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;aACzD,CAAC,CAAC;YACH,MAAM,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4BAA4B,EAAE,GAAG,EAAE;YACrC,MAAM,EAAE,GAAG,cAAc,CAAC,KAAK,EAAE;gBAChC,UAAU,EAAE;oBACX,WAAW,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;oBACpC,WAAW,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;iBACpC;gBACD,UAAU,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC;aACpC,CAAC,CAAC;YACH,MAAM,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iEAAiE,EAAE,GAAG,EAAE;YAC1E,MAAM,EAAE,GAAG,cAAc,CAAC,cAAc,EAAE;gBACzC,UAAU,EAAE;oBACX,WAAW,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;oBACvC,WAAW,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;iBACzC;gBACD,UAAU,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;aACzD,CAAC,CAAC;YACH,uEAAuE;YACvE,MAAM,MAAM,GAAG,EAAE,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC;YACtD,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAC9B,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC7B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;YACtD,MAAM,EAAE,GAAG,cAAc,CAAC,QAAQ,EAAE;gBACnC,UAAU,EAAE,EAAE;gBACd,UAAU,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;aACjD,CAAC,CAAC;YACH,MAAM,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;QAClC,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;YAChD,MAAM,EAAE,GAAG,cAAc,CAAC,MAAM,EAAE;gBACjC,UAAU,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;gBAC9B,UAAU,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;aAC7C,CAAC,CAAC;YACH,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC3D,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;IAC3B,EAAE,CAAC,qCAAqC,EAAE,GAAG,EAAE;QAC9C,MAAM,EAAE,GAAG,cAAc,CAAC,MAAM,EAAE;YACjC,UAAU,EAAE,EAAE;YACd,UAAU,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;SAC3B,CAAC,CAAC;QACH,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;QAChD,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACrC,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC1C,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACnC,MAAM,CAAC,UAAU,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC"}
|
package/package.json
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@arbor-css/functions",
|
|
3
|
+
"version": "0.0.51",
|
|
4
|
+
"type": "module",
|
|
5
|
+
"publishConfig": {
|
|
6
|
+
"access": "public"
|
|
7
|
+
},
|
|
8
|
+
"repository": {
|
|
9
|
+
"url": "https://github.com/a-type/arbor"
|
|
10
|
+
},
|
|
11
|
+
"files": [
|
|
12
|
+
"dist"
|
|
13
|
+
],
|
|
14
|
+
"exports": {
|
|
15
|
+
".": {
|
|
16
|
+
"import": "./dist/index.js",
|
|
17
|
+
"node": "./dist/index.js",
|
|
18
|
+
"types": "./dist/index.d.ts",
|
|
19
|
+
"default": "./dist/index.js"
|
|
20
|
+
}
|
|
21
|
+
},
|
|
22
|
+
"sideEffects": false,
|
|
23
|
+
"devDependencies": {
|
|
24
|
+
"typescript": "^6.0.3",
|
|
25
|
+
"vitest": "^4.1.5",
|
|
26
|
+
"vite": "^8.0.10"
|
|
27
|
+
},
|
|
28
|
+
"dependencies": {
|
|
29
|
+
"@arbor-css/tokens": "0.0.51",
|
|
30
|
+
"@arbor-css/calc": "0.0.51"
|
|
31
|
+
},
|
|
32
|
+
"scripts": {
|
|
33
|
+
"build": "tsc",
|
|
34
|
+
"dev": "tsc -w --preserveWatchOutput",
|
|
35
|
+
"test": "vitest",
|
|
36
|
+
"test:ci": "vitest --run"
|
|
37
|
+
}
|
|
38
|
+
}
|