@math.gl/core 5.0.0-alpha.2 → 5.0.0-alpha.20

package/dist/expressions/function-registry.js

@@ -0,0 +1,139 @@
+// math.gl
+// SPDX-License-Identifier: MIT
+// SPDX-FileCopyrightText: Copyright (c) vis.gl contributors
+const FUNCTION_NAME_PATTERN = /^[A-Za-z_$][A-Za-z0-9_$]*$/;
+const DISALLOWED_FUNCTION_NAMES = new Set([
+    '__proto__',
+    'prototype',
+    'constructor',
+    'true',
+    'false',
+    'null',
+    'this'
+]);
+/**
+ * An isolated collection of named functions available to expression evaluators.
+ *
+ * @remarks
+ * Registries are instance scoped. Registering a function does not affect other
+ * registries or evaluators that do not receive the registry.
+ *
+ * Function names must be valid JavaScript-style identifiers so they can be
+ * called directly from JSEP expressions.
+ *
+ * @example
+ * ```ts
+ * const registry = new ExpressionFunctionRegistry()
+ *   .registerFunction('double', (value) => value * 2)
+ *   .registerFunctions(BASIC_MATH_FUNCTION_LIBRARY);
+ *
+ * const evaluate = compile('double(round(value))', {registry});
+ * evaluate({value: 2.4});
+ * ```
+ */
+export class ExpressionFunctionRegistry {
+    /**
+     * Creates a function registry.
+     *
+     * @param functionTables - Function tables to register in order.
+     * @throws If a table contains an invalid or duplicate function name.
+     */
+    constructor(functionTables = []) {
+        this.functions = Object.create(null);
+        for (const functionTable of functionTables) {
+            this.registerFunctions(functionTable);
+        }
+    }
+    /**
+     * Registers one named function.
+     *
+     * @param name - Identifier used to call the function from an expression.
+     * @param fn - JavaScript function invoked with evaluated expression arguments.
+     * @param options - Duplicate registration behavior.
+     * @returns This registry.
+     * @throws If the name is invalid, the value is not a function, or the name is
+     * already registered and replacement was not requested.
+     */
+    registerFunction(name, fn, options = {}) {
+        validateFunction(name, fn);
+        if (this.hasFunction(name) && !options.replace) {
+            throw new Error(`Expression function "${name}" is already registered.`);
+        }
+        this.functions[name] = fn;
+        return this;
+    }
+    /**
+     * Registers all entries in a function table.
+     *
+     * @param functionTable - Map from expression identifiers to JavaScript functions.
+     * @param options - Duplicate registration behavior.
+     * @returns This registry.
+     * @throws If any entry is invalid or conflicts with an existing registration.
+     *
+     * @remarks
+     * Validation is atomic: no entries are registered when any entry is invalid.
+     */
+    registerFunctions(functionTable, options = {}) {
+        const entries = Object.entries(functionTable);
+        const names = new Set();
+        for (const [name, fn] of entries) {
+            validateFunction(name, fn);
+            if (names.has(name) || (this.hasFunction(name) && !options.replace)) {
+                throw new Error(`Expression function "${name}" is already registered.`);
+            }
+            names.add(name);
+        }
+        for (const [name, fn] of entries) {
+            this.functions[name] = fn;
+        }
+        return this;
+    }
+    /**
+     * Removes a registered function.
+     *
+     * @param name - Function name to remove.
+     * @returns `true` when a function was removed.
+     */
+    unregisterFunction(name) {
+        if (!this.hasFunction(name)) {
+            return false;
+        }
+        return delete this.functions[name];
+    }
+    /**
+     * Tests whether a function is registered.
+     *
+     * @param name - Function name to inspect.
+     * @returns `true` when the registry contains the name.
+     */
+    hasFunction(name) {
+        return Object.prototype.hasOwnProperty.call(this.functions, name);
+    }
+    /**
+     * Returns a registered function.
+     *
+     * @param name - Function name to retrieve.
+     * @returns The registered function, or `undefined`.
+     */
+    getFunction(name) {
+        return this.functions[name];
+    }
+    /**
+     * Returns an immutable snapshot of all registered functions.
+     *
+     * @returns A frozen function table.
+     */
+    getFunctionTable() {
+        return Object.freeze({ ...this.functions });
+    }
+}
+/** Validates one registry entry. */
+function validateFunction(name, fn) {
+    if (!FUNCTION_NAME_PATTERN.test(name) || DISALLOWED_FUNCTION_NAMES.has(name)) {
+        throw new Error(`Invalid expression function name "${name}".`);
+    }
+    if (typeof fn !== 'function') {
+        throw new TypeError(`Expression function "${name}" must be a function.`);
+    }
+}
+//# sourceMappingURL=function-registry.js.map

package/dist/expressions/function-registry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"function-registry.js","sourceRoot":"","sources":["../../src/expressions/function-registry.ts"],"names":[],"mappings":"AAAA,UAAU;AACV,+BAA+B;AAC/B,4DAA4D;AAI5D,MAAM,qBAAqB,GAAG,4BAA4B,CAAC;AAC3D,MAAM,yBAAyB,GAAG,IAAI,GAAG,CAAC;IACxC,WAAW;IACX,WAAW;IACX,aAAa;IACb,MAAM;IACN,OAAO;IACP,MAAM;IACN,MAAM;CACP,CAAC,CAAC;AAcH;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,OAAO,0BAA0B;IAGrC;;;;;OAKG;IACH,YAAY,iBAAuD,EAAE;QARpD,cAAS,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAA8B,CAAC;QAS5E,KAAK,MAAM,aAAa,IAAI,cAAc,EAAE,CAAC;YAC3C,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;QACxC,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACH,gBAAgB,CACd,IAAY,EACZ,EAAsB,EACtB,UAAuC,EAAE;QAEzC,gBAAgB,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAC3B,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;YAC/C,MAAM,IAAI,KAAK,CAAC,wBAAwB,IAAI,0BAA0B,CAAC,CAAC;QAC1E,CAAC;QACD,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;OAUG;IACH,iBAAiB,CACf,aAAwC,EACxC,UAAuC,EAAE;QAEzC,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QAC9C,MAAM,KAAK,GAAG,IAAI,GAAG,EAAU,CAAC;QAEhC,KAAK,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,OAAO,EAAE,CAAC;YACjC,gBAAgB,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAC3B,IAAI,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;gBACpE,MAAM,IAAI,KAAK,CAAC,wBAAwB,IAAI,0BAA0B,CAAC,CAAC;YAC1E,CAAC;YACD,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAClB,CAAC;QAED,KAAK,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,OAAO,EAAE,CAAC;YACjC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;QAC5B,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,kBAAkB,CAAC,IAAY;QAC7B,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;YAC5B,OAAO,KAAK,CAAC;QACf,CAAC;QACD,OAAO,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACrC,CAAC;IAED;;;;;OAKG;IACH,WAAW,CAAC,IAAY;QACtB,OAAO,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;IACpE,CAAC;IAED;;;;;OAKG;IACH,WAAW,CAAC,IAAY;QACtB,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACH,gBAAgB;QACd,OAAO,MAAM,CAAC,MAAM,CAAC,EAAC,GAAG,IAAI,CAAC,SAAS,EAAC,CAAC,CAAC;IAC5C,CAAC;CACF;AAED,oCAAoC;AACpC,SAAS,gBAAgB,CAAC,IAAY,EAAE,EAAsB;IAC5D,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,yBAAyB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;QAC7E,MAAM,IAAI,KAAK,CAAC,qCAAqC,IAAI,IAAI,CAAC,CAAC;IACjE,CAAC;IACD,IAAI,OAAO,EAAE,KAAK,UAAU,EAAE,CAAC;QAC7B,MAAM,IAAI,SAAS,CAAC,wBAAwB,IAAI,uBAAuB,CAAC,CAAC;IAC3E,CAAC;AACH,CAAC"}

package/dist/expressions/get.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Access properties of nested containers using dot-path notation.
+ *
+ * @param container - Object from which to read a value.
+ * @param compositeKey - Dot-separated property path.
+ * @returns The nested value, or `undefined` when the path cannot be resolved.
+ */
+export declare function get(container: Record<string, unknown>, compositeKey: string): unknown;
+//# sourceMappingURL=get.d.ts.map

package/dist/expressions/get.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get.d.ts","sourceRoot":"","sources":["../../src/expressions/get.ts"],"names":[],"mappings":"AAIA;;;;;;GAMG;AACH,wBAAgB,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAQrF"}

package/dist/expressions/get.js

@@ -0,0 +1,32 @@
+// math.gl
+// SPDX-License-Identifier: MIT
+// SPDX-FileCopyrightText: Copyright (c) vis.gl contributors
+/**
+ * Access properties of nested containers using dot-path notation.
+ *
+ * @param container - Object from which to read a value.
+ * @param compositeKey - Dot-separated property path.
+ * @returns The nested value, or `undefined` when the path cannot be resolved.
+ */
+export function get(container, compositeKey) {
+    let value = container;
+    for (const key of getKeys(compositeKey)) {
+        value = isObject(value) ? value[key] : undefined;
+    }
+    return value;
+}
+/** Tests whether a value can be used for property access. */
+function isObject(value) {
+    return value !== null && typeof value === 'object';
+}
+const keyMap = Object.create(null);
+/** Returns a cached list of property names for a dot-separated path. */
+function getKeys(compositeKey) {
+    let keyList = keyMap[compositeKey];
+    if (!keyList) {
+        keyList = compositeKey.split('.');
+        keyMap[compositeKey] = keyList;
+    }
+    return keyList;
+}
+//# sourceMappingURL=get.js.map

package/dist/expressions/get.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get.js","sourceRoot":"","sources":["../../src/expressions/get.ts"],"names":[],"mappings":"AAAA,UAAU;AACV,+BAA+B;AAC/B,4DAA4D;AAE5D;;;;;;GAMG;AACH,MAAM,UAAU,GAAG,CAAC,SAAkC,EAAE,YAAoB;IAC1E,IAAI,KAAK,GAAY,SAAS,CAAC;IAE/B,KAAK,MAAM,GAAG,IAAI,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;QACxC,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACnD,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED,6DAA6D;AAC7D,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,CAAC;AACrD,CAAC;AAED,MAAM,MAAM,GAA6B,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;AAE7D,wEAAwE;AACxE,SAAS,OAAO,CAAC,YAAoB;IACnC,IAAI,OAAO,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC;IACnC,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAClC,MAAM,CAAC,YAAY,CAAC,GAAG,OAAO,CAAC;IACjC,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC"}