@api-client/ui 0.5.58 → 0.6.1

package/build/src/modeling/lib/formula_parser.d.ts

@@ -0,0 +1,57 @@
+import { type ValidationResult } from '@pawel-up/jexl';
+import type { DomainProperty } from '@api-client/core/modeling/DomainProperty.js';
+export interface FormulaTestRunResult {
+    /**
+     * Indicates if the formula evaluation was successful.
+     * If false, the `message` property will contain the error message.
+     */
+    error: boolean;
+    /**
+     * An error message if the evaluation failed.
+     */
+    message?: string;
+    /**
+     * The result of the formula evaluation.
+     * This can be a string, number, boolean, Date, or null.
+     */
+    value: string | number | boolean | Date | null | undefined;
+}
+/**
+ * A class to parse and validate formulas from the calculated fields.
+ */
+export declare class FormulaParser {
+    formula: string;
+    property: DomainProperty;
+    /**
+     * A map of properties available in the entity.
+     * The keys are property keys, and the values are DomainProperty objects.
+     * This allows for quick lookup of properties by their keys.
+     */
+    protected properties: Map<string, DomainProperty>;
+    constructor(formula: string, property: DomainProperty, properties?: DomainProperty[]);
+    /**
+     * Parses the formula and returns the validation result.
+     */
+    validate(): ValidationResult;
+    test(dependencies?: string[]): Promise<FormulaTestRunResult | null>;
+    private getJexlExpression;
+    /**
+     * Builds a test context for evaluating the formula.
+     * This context includes the values of the properties that are dependencies of the formula.
+     * @param dependencies The list of property keys that are dependencies in the formula.
+     * @returns An object containing the property values for testing.
+     */
+    buildTestContext(dependencies: string[] | undefined): Record<string, unknown>;
+    /**
+     * Registers appropriate Jexl functions based on the data type.
+     * @param jexl The Jexl instance to register functions on.
+     */
+    private registerFunctions;
+    /**
+     * Extracts property dependencies from the formula.
+     * This method looks for {{field_name}} patterns in the original formula string.
+     * @returns The list of unique dependency keys.
+     */
+    extractDependencies(): string[];
+}
+//# sourceMappingURL=formula_parser.d.ts.map

package/build/src/modeling/lib/formula_parser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"formula_parser.d.ts","sourceRoot":"","sources":["../../../../src/modeling/lib/formula_parser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,KAAK,gBAAgB,EAA6C,MAAM,gBAAgB,CAAA;AAMlH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,6CAA6C,CAAA;AASjF,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,KAAK,EAAE,OAAO,CAAA;IACd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;OAGG;IACH,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,IAAI,GAAG,SAAS,CAAA;CAC3D;AAED;;GAEG;AACH,qBAAa,aAAa;IASf,OAAO,EAAE,MAAM;IACf,QAAQ,EAAE,cAAc;IATjC;;;;OAIG;IACH,SAAS,CAAC,UAAU,EAAE,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;gBAGxC,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,cAAc,EAC/B,UAAU,GAAE,cAAc,EAAO;IAKnC;;OAEG;IACI,QAAQ,IAAI,gBAAgB;IAyBtB,IAAI,CAAC,YAAY,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,oBAAoB,GAAG,IAAI,CAAC;IAuChF,OAAO,CAAC,iBAAiB;IAezB;;;;;OAKG;IACH,gBAAgB,CAAC,YAAY,EAAE,MAAM,EAAE,GAAG,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAkB7E;;;OAGG;IACH,OAAO,CAAC,iBAAiB;IAQzB;;;;OAIG;IACI,mBAAmB,IAAI,MAAM,EAAE;CAYvC"}

package/build/src/modeling/lib/formula_parser.js

@@ -0,0 +1,162 @@
+import { Validator, Jexl, ValidationSeverity } from '@pawel-up/jexl';
+import * as stringFunctions from '@pawel-up/jexl/string.js';
+import * as mathFunctions from '@pawel-up/jexl/math.js';
+import * as dateFunctions from '@pawel-up/jexl/date.js';
+import * as arrayFunctions from '@pawel-up/jexl/array.js';
+import * as operatorFunctions from '@pawel-up/jexl/operators.js';
+function addModule(jexl, module, prefix = '') {
+    Object.keys(module).forEach((key) => {
+        const functionName = prefix ? `${prefix}.${key}` : key;
+        jexl.addFunction(functionName, module[key]);
+    });
+}
+/**
+ * A class to parse and validate formulas from the calculated fields.
+ */
+export class FormulaParser {
+    formula;
+    property;
+    /**
+     * A map of properties available in the entity.
+     * The keys are property keys, and the values are DomainProperty objects.
+     * This allows for quick lookup of properties by their keys.
+     */
+    properties;
+    constructor(formula, property, properties = []) {
+        this.formula = formula;
+        this.property = property;
+        this.properties = new Map(properties.map((p) => [p.key, p]));
+    }
+    /**
+     * Parses the formula and returns the validation result.
+     */
+    validate() {
+        const defaultValue = { valid: true, errors: [], info: [], issues: [], warnings: [] };
+        if (!this.formula.trim()) {
+            return defaultValue;
+        }
+        const expression = this.getJexlExpression();
+        const jexl = new Jexl();
+        // Register appropriate functions for the data type
+        this.registerFunctions(jexl);
+        const validator = new Validator(jexl.grammar);
+        try {
+            // TODO: we need to extract variables from the text field and (possibly) add a context.
+            return validator.validate(expression, undefined, { allowUndefinedContext: true });
+        }
+        catch (e) {
+            defaultValue.valid = false;
+            defaultValue.errors.push({
+                message: e.message,
+                severity: ValidationSeverity.ERROR,
+            });
+            return defaultValue;
+        }
+    }
+    async test(dependencies) {
+        if (!this.formula.trim()) {
+            return {
+                error: true,
+                value: undefined,
+                message: 'Formula is empty.',
+            };
+        }
+        const expression = this.getJexlExpression();
+        const context = this.buildTestContext(dependencies);
+        const jexl = new Jexl();
+        // Register appropriate functions for the data type
+        this.registerFunctions(jexl);
+        const result = { error: false, value: undefined };
+        // TODO: evaluate array and enum values.
+        // For arrays, we return the results as it would be evaluated normally,
+        // but we ensure the result is an array.
+        // For enums, we render value if the resulting value is one of the defined values,
+        // or otherwise we render error.
+        const dataType = this.property.type;
+        try {
+            if (dataType === 'string') {
+                result.value = await jexl.evalAsString(expression, context);
+            }
+            else if (dataType === 'number') {
+                result.value = await jexl.evalAsNumber(expression, context);
+            }
+            else if (dataType === 'boolean') {
+                result.value = await jexl.evalAsBoolean(expression, context);
+            }
+            else {
+                result.value = await jexl.eval(expression, context);
+            }
+        }
+        catch (e) {
+            result.error = true;
+            result.message = e.message;
+        }
+        return result;
+    }
+    getJexlExpression() {
+        // For all types, we treat the input as a direct Jexl expression.
+        // The user is responsible for providing a valid Jexl expression, including quoting string literals.
+        // We just need to replace the mention syntax `{{field_name}}` with the Jexl identifier `property_key`.
+        return this.formula.replace(/\{\{([^}]+)\}\}/g, (match, id) => {
+            const prop = this.properties.get(id);
+            if (prop) {
+                // we use column names as identifiers in Jexl expressions
+                // the key is for fallback if the name is not set
+                return prop.info.name || prop.key;
+            }
+            return match;
+        });
+    }
+    /**
+     * Builds a test context for evaluating the formula.
+     * This context includes the values of the properties that are dependencies of the formula.
+     * @param dependencies The list of property keys that are dependencies in the formula.
+     * @returns An object containing the property values for testing.
+     */
+    buildTestContext(dependencies) {
+        const context = {};
+        if (!dependencies || !dependencies.length) {
+            return context;
+        }
+        for (const dep of dependencies || []) {
+            const prop = this.properties.get(dep);
+            if (prop) {
+                context[prop.info.name || prop.key] = prop.toExample('application/json', {
+                    renderExamples: true,
+                    renderOptional: true,
+                    renderMocked: true,
+                });
+            }
+        }
+        return context;
+    }
+    /**
+     * Registers appropriate Jexl functions based on the data type.
+     * @param jexl The Jexl instance to register functions on.
+     */
+    registerFunctions(jexl) {
+        addModule(jexl, stringFunctions);
+        addModule(jexl, mathFunctions);
+        addModule(jexl, dateFunctions);
+        addModule(jexl, arrayFunctions);
+        addModule(jexl, operatorFunctions);
+    }
+    /**
+     * Extracts property dependencies from the formula.
+     * This method looks for {{field_name}} patterns in the original formula string.
+     * @returns The list of unique dependency keys.
+     */
+    extractDependencies() {
+        const dependencies = new Set();
+        const mentionPattern = /\{\{([^}]+)\}\}/g;
+        let match;
+        while ((match = mentionPattern.exec(this.formula)) !== null) {
+            const fieldKey = match[1];
+            if (this.properties.has(fieldKey)) {
+                dependencies.add(fieldKey);
+            }
+        }
+        return Array.from(dependencies);
+    }
+}
+//# sourceMappingURL=formula_parser.js.map

package/build/src/modeling/lib/formula_parser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"formula_parser.js","sourceRoot":"","sources":["../../../../src/modeling/lib/formula_parser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,IAAI,EAAyB,kBAAkB,EAAyB,MAAM,gBAAgB,CAAA;AAClH,OAAO,KAAK,eAAe,MAAM,0BAA0B,CAAA;AAC3D,OAAO,KAAK,aAAa,MAAM,wBAAwB,CAAA;AACvD,OAAO,KAAK,aAAa,MAAM,wBAAwB,CAAA;AACvD,OAAO,KAAK,cAAc,MAAM,yBAAyB,CAAA;AACzD,OAAO,KAAK,iBAAiB,MAAM,6BAA6B,CAAA;AAGhE,SAAS,SAAS,CAAC,IAAU,EAAE,MAAwC,EAAE,MAAM,GAAG,EAAE;IAClF,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;QAClC,MAAM,YAAY,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAA;QACtD,IAAI,CAAC,WAAW,CAAC,YAAY,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAA;IAC7C,CAAC,CAAC,CAAA;AACJ,CAAC;AAmBD;;GAEG;AACH,MAAM,OAAO,aAAa;IASf;IACA;IATT;;;;OAIG;IACO,UAAU,CAA6B;IAEjD,YACS,OAAe,EACf,QAAwB,EAC/B,aAA+B,EAAE;QAF1B,YAAO,GAAP,OAAO,CAAQ;QACf,aAAQ,GAAR,QAAQ,CAAgB;QAG/B,IAAI,CAAC,UAAU,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;IAC9D,CAAC;IAED;;OAEG;IACI,QAAQ;QACb,MAAM,YAAY,GAAqB,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAA;QACtG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC;YACzB,OAAO,YAAY,CAAA;QACrB,CAAC;QACD,MAAM,UAAU,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAA;QAC3C,MAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAA;QAEvB,mDAAmD;QACnD,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAA;QAE5B,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QAC7C,IAAI,CAAC;YACH,uFAAuF;YACvF,OAAO,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,SAAS,EAAE,EAAE,qBAAqB,EAAE,IAAI,EAAE,CAAC,CAAA;QACnF,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,YAAY,CAAC,KAAK,GAAG,KAAK,CAAA;YAC1B,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC;gBACvB,OAAO,EAAG,CAAW,CAAC,OAAO;gBAC7B,QAAQ,EAAE,kBAAkB,CAAC,KAAK;aACnC,CAAC,CAAA;YACF,OAAO,YAAY,CAAA;QACrB,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,IAAI,CAAC,YAAuB;QACvC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC;YACzB,OAAO;gBACL,KAAK,EAAE,IAAI;gBACX,KAAK,EAAE,SAAS;gBAChB,OAAO,EAAE,mBAAmB;aAC7B,CAAA;QACH,CAAC;QACD,MAAM,UAAU,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAA;QAC3C,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAA;QACnD,MAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAA;QAEvB,mDAAmD;QACnD,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAA;QAE5B,MAAM,MAAM,GAAyB,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,CAAA;QACvE,wCAAwC;QACxC,uEAAuE;QACvE,wCAAwC;QACxC,kFAAkF;QAClF,gCAAgC;QAChC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAA;QACnC,IAAI,CAAC;YACH,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;gBAC1B,MAAM,CAAC,KAAK,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,OAAO,CAAC,CAAA;YAC7D,CAAC;iBAAM,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;gBACjC,MAAM,CAAC,KAAK,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,OAAO,CAAC,CAAA;YAC7D,CAAC;iBAAM,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;gBAClC,MAAM,CAAC,KAAK,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,UAAU,EAAE,OAAO,CAAC,CAAA;YAC9D,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,KAAK,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,CAAA;YACrD,CAAC;QACH,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,CAAC,KAAK,GAAG,IAAI,CAAA;YACnB,MAAM,CAAC,OAAO,GAAI,CAAW,CAAC,OAAO,CAAA;QACvC,CAAC;QACD,OAAO,MAAM,CAAA;IACf,CAAC;IAEO,iBAAiB;QACvB,iEAAiE;QACjE,oGAAoG;QACpG,uGAAuG;QACvG,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,kBAAkB,EAAE,CAAC,KAAK,EAAE,EAAE,EAAE,EAAE;YAC5D,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;YACpC,IAAI,IAAI,EAAE,CAAC;gBACT,yDAAyD;gBACzD,iDAAiD;gBACjD,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,GAAG,CAAA;YACnC,CAAC;YACD,OAAO,KAAK,CAAA;QACd,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;OAKG;IACH,gBAAgB,CAAC,YAAkC;QACjD,MAAM,OAAO,GAA4B,EAAE,CAAA;QAC3C,IAAI,CAAC,YAAY,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;YAC1C,OAAO,OAAO,CAAA;QAChB,CAAC;QACD,KAAK,MAAM,GAAG,IAAI,YAAY,IAAI,EAAE,EAAE,CAAC;YACrC,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;YACrC,IAAI,IAAI,EAAE,CAAC;gBACT,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,kBAAkB,EAAE;oBACvE,cAAc,EAAE,IAAI;oBACpB,cAAc,EAAE,IAAI;oBACpB,YAAY,EAAE,IAAI;iBACnB,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;QACD,OAAO,OAAO,CAAA;IAChB,CAAC;IAED;;;OAGG;IACK,iBAAiB,CAAC,IAAU;QAClC,SAAS,CAAC,IAAI,EAAE,eAAe,CAAC,CAAA;QAChC,SAAS,CAAC,IAAI,EAAE,aAAa,CAAC,CAAA;QAC9B,SAAS,CAAC,IAAI,EAAE,aAAa,CAAC,CAAA;QAC9B,SAAS,CAAC,IAAI,EAAE,cAAc,CAAC,CAAA;QAC/B,SAAS,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAA;IACpC,CAAC;IAED;;;;OAIG;IACI,mBAAmB;QACxB,MAAM,YAAY,GAAG,IAAI,GAAG,EAAU,CAAA;QACtC,MAAM,cAAc,GAAG,kBAAkB,CAAA;QACzC,IAAI,KAAK,CAAA;QACT,OAAO,CAAC,KAAK,GAAG,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;YAC5D,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,CAAC,CAAA;YACzB,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAClC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;YAC5B,CAAC;QACH,CAAC;QACD,OAAO,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;IACjC,CAAC;CACF","sourcesContent":["import { Validator, Jexl, type ValidationResult, ValidationSeverity, type FunctionFunction } from '@pawel-up/jexl'\nimport * as stringFunctions from '@pawel-up/jexl/string.js'\nimport * as mathFunctions from '@pawel-up/jexl/math.js'\nimport * as dateFunctions from '@pawel-up/jexl/date.js'\nimport * as arrayFunctions from '@pawel-up/jexl/array.js'\nimport * as operatorFunctions from '@pawel-up/jexl/operators.js'\nimport type { DomainProperty } from '@api-client/core/modeling/DomainProperty.js'\n\nfunction addModule(jexl: Jexl, module: Record<string, FunctionFunction>, prefix = '') {\n  Object.keys(module).forEach((key) => {\n    const functionName = prefix ? `${prefix}.${key}` : key\n    jexl.addFunction(functionName, module[key])\n  })\n}\n\nexport interface FormulaTestRunResult {\n  /**\n   * Indicates if the formula evaluation was successful.\n   * If false, the `message` property will contain the error message.\n   */\n  error: boolean\n  /**\n   * An error message if the evaluation failed.\n   */\n  message?: string\n  /**\n   * The result of the formula evaluation.\n   * This can be a string, number, boolean, Date, or null.\n   */\n  value: string | number | boolean | Date | null | undefined\n}\n\n/**\n * A class to parse and validate formulas from the calculated fields.\n */\nexport class FormulaParser {\n  /**\n   * A map of properties available in the entity.\n   * The keys are property keys, and the values are DomainProperty objects.\n   * This allows for quick lookup of properties by their keys.\n   */\n  protected properties: Map<string, DomainProperty>\n\n  constructor(\n    public formula: string,\n    public property: DomainProperty,\n    properties: DomainProperty[] = []\n  ) {\n    this.properties = new Map(properties.map((p) => [p.key, p]))\n  }\n\n  /**\n   * Parses the formula and returns the validation result.\n   */\n  public validate(): ValidationResult {\n    const defaultValue: ValidationResult = { valid: true, errors: [], info: [], issues: [], warnings: [] }\n    if (!this.formula.trim()) {\n      return defaultValue\n    }\n    const expression = this.getJexlExpression()\n    const jexl = new Jexl()\n\n    // Register appropriate functions for the data type\n    this.registerFunctions(jexl)\n\n    const validator = new Validator(jexl.grammar)\n    try {\n      // TODO: we need to extract variables from the text field and (possibly) add a context.\n      return validator.validate(expression, undefined, { allowUndefinedContext: true })\n    } catch (e) {\n      defaultValue.valid = false\n      defaultValue.errors.push({\n        message: (e as Error).message,\n        severity: ValidationSeverity.ERROR,\n      })\n      return defaultValue\n    }\n  }\n\n  public async test(dependencies?: string[]): Promise<FormulaTestRunResult | null> {\n    if (!this.formula.trim()) {\n      return {\n        error: true,\n        value: undefined,\n        message: 'Formula is empty.',\n      }\n    }\n    const expression = this.getJexlExpression()\n    const context = this.buildTestContext(dependencies)\n    const jexl = new Jexl()\n\n    // Register appropriate functions for the data type\n    this.registerFunctions(jexl)\n\n    const result: FormulaTestRunResult = { error: false, value: undefined }\n    // TODO: evaluate array and enum values.\n    // For arrays, we return the results as it would be evaluated normally,\n    // but we ensure the result is an array.\n    // For enums, we render value if the resulting value is one of the defined values,\n    // or otherwise we render error.\n    const dataType = this.property.type\n    try {\n      if (dataType === 'string') {\n        result.value = await jexl.evalAsString(expression, context)\n      } else if (dataType === 'number') {\n        result.value = await jexl.evalAsNumber(expression, context)\n      } else if (dataType === 'boolean') {\n        result.value = await jexl.evalAsBoolean(expression, context)\n      } else {\n        result.value = await jexl.eval(expression, context)\n      }\n    } catch (e) {\n      result.error = true\n      result.message = (e as Error).message\n    }\n    return result\n  }\n\n  private getJexlExpression(): string {\n    // For all types, we treat the input as a direct Jexl expression.\n    // The user is responsible for providing a valid Jexl expression, including quoting string literals.\n    // We just need to replace the mention syntax `{{field_name}}` with the Jexl identifier `property_key`.\n    return this.formula.replace(/\\{\\{([^}]+)\\}\\}/g, (match, id) => {\n      const prop = this.properties.get(id)\n      if (prop) {\n        // we use column names as identifiers in Jexl expressions\n        // the key is for fallback if the name is not set\n        return prop.info.name || prop.key\n      }\n      return match\n    })\n  }\n\n  /**\n   * Builds a test context for evaluating the formula.\n   * This context includes the values of the properties that are dependencies of the formula.\n   * @param dependencies The list of property keys that are dependencies in the formula.\n   * @returns An object containing the property values for testing.\n   */\n  buildTestContext(dependencies: string[] | undefined): Record<string, unknown> {\n    const context: Record<string, unknown> = {}\n    if (!dependencies || !dependencies.length) {\n      return context\n    }\n    for (const dep of dependencies || []) {\n      const prop = this.properties.get(dep)\n      if (prop) {\n        context[prop.info.name || prop.key] = prop.toExample('application/json', {\n          renderExamples: true,\n          renderOptional: true,\n          renderMocked: true,\n        })\n      }\n    }\n    return context\n  }\n\n  /**\n   * Registers appropriate Jexl functions based on the data type.\n   * @param jexl The Jexl instance to register functions on.\n   */\n  private registerFunctions(jexl: Jexl): void {\n    addModule(jexl, stringFunctions)\n    addModule(jexl, mathFunctions)\n    addModule(jexl, dateFunctions)\n    addModule(jexl, arrayFunctions)\n    addModule(jexl, operatorFunctions)\n  }\n\n  /**\n   * Extracts property dependencies from the formula.\n   * This method looks for {{field_name}} patterns in the original formula string.\n   * @returns The list of unique dependency keys.\n   */\n  public extractDependencies(): string[] {\n    const dependencies = new Set<string>()\n    const mentionPattern = /\\{\\{([^}]+)\\}\\}/g\n    let match\n    while ((match = mentionPattern.exec(this.formula)) !== null) {\n      const fieldKey = match[1]\n      if (this.properties.has(fieldKey)) {\n        dependencies.add(fieldKey)\n      }\n    }\n    return Array.from(dependencies)\n  }\n}\n"]}

package/build/src/modeling/lib/ui_mapping.d.ts

@@ -0,0 +1,60 @@
+import type { DomainAssociation } from '@api-client/core/modeling/DomainAssociation.js';
+import type { DomainPropertyInputConfig } from '../types.js';
+import type { IconType } from '../../md/icons/Icons.js';
+import type { DomainProperty } from '@api-client/core/modeling/DomainProperty.js';
+import type { DomainPropertyFormat } from '@api-client/core/modeling/DataFormat.js';
+/**
+ * Returns the icon to use for the given field (DomainProperty or DomainAssociation).
+ * This is used to render the icon in the UI.
+ *
+ * @param p The field to get the icon for.
+ * @returns The icon to use.
+ */
+export declare function getFieldIcon(p: DomainAssociation | DomainProperty): IconType;
+/**
+ * Returns the label to use for the given field (DomainProperty or DomainAssociation).
+ * @param p The field to get the label for.
+ * @returns The label to use in the data type label.
+ */
+export declare function getFieldDataTypeLabel(p: DomainAssociation | DomainProperty): string;
+/**
+ * Generates an icon name for the DomainProperty that illustrate its primary purpose.
+ */
+export declare function getPropertyIcon(p: DomainProperty): IconType;
+/**
+ * @returns The type label to use when rendering the DomainProperty in the UI
+ */
+export declare function getPropertyTypeLabel(p: DomainProperty): string;
+/**
+ * Gathers information about the HTML input's requirements for the given DomainProperty.
+ *
+ * @param model The data property model to gather HTML input's configuration for.
+ * @returns Input attributes to set.
+ */
+export declare function getPropertyInputOptions(model: DomainProperty): DomainPropertyInputConfig;
+export declare function getFormatInfo(format: DomainPropertyFormat): {
+    label: string;
+    help: string;
+};
+export declare function getDomainLabel(kind: string, options?: {
+    capitalize?: boolean;
+}): string;
+/**
+ * Gets the icon type for a given item kind.
+ * @param kind - The kind of the item.
+ * @returns The icon type.
+ */
+export declare function getDomainIconType(kind: string): IconType;
+/**
+ * Maps an API Action kind to a user-friendly label.
+ * @param kind The API Action kind.
+ * @returns The label to render with the UI that correspond to the action.
+ */
+export declare function apiActionKindToLabel(kind: string): string;
+/**
+ * Maps an API Action kind to an icon name.
+ * @param kind The API Action kind.
+ * @returns The icon name to use for the action kind.
+ */
+export declare function apiActionKindToIcon(kind: string): string;
+//# sourceMappingURL=ui_mapping.d.ts.map

package/build/src/modeling/lib/ui_mapping.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ui_mapping.d.ts","sourceRoot":"","sources":["../../../../src/modeling/lib/ui_mapping.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gDAAgD,CAAA;AACvF,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAA;AAC5D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAA;AACvD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,6CAA6C,CAAA;AAQjF,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,yCAAyC,CAAA;AAEnF;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,iBAAiB,GAAG,cAAc,GAAG,QAAQ,CAK5E;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,CAAC,EAAE,iBAAiB,GAAG,cAAc,GAAG,MAAM,CAKnF;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,cAAc,GAAG,QAAQ,CAqB3D;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,CAAC,EAAE,cAAc,GAAG,MAAM,CAyB9D;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,cAAc,GAAG,yBAAyB,CAmDxF;AAED,wBAAgB,aAAa,CAAC,MAAM,EAAE,oBAAoB,GAAG;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAoB3F;AAED,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE;IAAE,UAAU,CAAC,EAAE,OAAO,CAAA;CAAO,GAAG,MAAM,CAkB3F;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,CAQxD;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAiBzD;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAiBxD"}

package/build/src/modeling/lib/ui_mapping.js

@@ -0,0 +1,244 @@
+import { DomainAssociationKind, DomainEntityKind, DomainModelKind, DomainNamespaceKind, DomainPropertyKind, } from '@api-client/core/models/kinds.js';
+/**
+ * Returns the icon to use for the given field (DomainProperty or DomainAssociation).
+ * This is used to render the icon in the UI.
+ *
+ * @param p The field to get the icon for.
+ * @returns The icon to use.
+ */
+export function getFieldIcon(p) {
+    if (p.kind === DomainAssociationKind) {
+        return 'link';
+    }
+    return getPropertyIcon(p);
+}
+/**
+ * Returns the label to use for the given field (DomainProperty or DomainAssociation).
+ * @param p The field to get the label for.
+ * @returns The label to use in the data type label.
+ */
+export function getFieldDataTypeLabel(p) {
+    if (p.kind === DomainAssociationKind) {
+        return 'Reference';
+    }
+    return getPropertyTypeLabel(p);
+}
+/**
+ * Generates an icon name for the DomainProperty that illustrate its primary purpose.
+ */
+export function getPropertyIcon(p) {
+    if (p.primary) {
+        return 'key';
+    }
+    switch (p.type) {
+        // case 'integer':
+        case 'number':
+            return 'number';
+        case 'date':
+            return 'calendarToday';
+        case 'time':
+            return 'schedule';
+        case 'datetime':
+            return 'event';
+        case 'boolean':
+            return 'checkCircle';
+        case 'binary':
+            return 'draft';
+        default:
+            return 'textFields';
+    }
+}
+/**
+ * @returns The type label to use when rendering the DomainProperty in the UI
+ */
+export function getPropertyTypeLabel(p) {
+    switch (p.type) {
+        case 'string':
+            return 'String';
+        case 'number':
+            return 'Number';
+        // case 'integer':
+        //   return 'Integer'
+        // case 'nil':
+        //   return 'Nil'
+        case 'boolean':
+            return 'Boolean';
+        case 'date':
+            return 'Date';
+        case 'datetime':
+            return 'Date and time';
+        case 'time':
+            return 'Time';
+        // case 'any':
+        //   return 'Any'
+        case 'binary':
+            return 'Binary';
+        default:
+            return 'Unknown';
+    }
+}
+/**
+ * Gathers information about the HTML input's requirements for the given DomainProperty.
+ *
+ * @param model The data property model to gather HTML input's configuration for.
+ * @returns Input attributes to set.
+ */
+export function getPropertyInputOptions(model) {
+    const result = { type: 'text' };
+    if (model.type === 'date') {
+        result.type = 'date';
+        result.help = 'Date in YYYY-MM-DD format';
+        return result;
+    }
+    if (model.type === 'datetime') {
+        result.type = 'datetime-local';
+        result.help = 'Date and time in YYYY-MM-DDTHH:mm format';
+        return result;
+    }
+    if (model.type === 'time') {
+        result.type = 'time';
+        result.help = 'Time in HH:mm format';
+        return result;
+    }
+    if (model.type !== 'number') {
+        return result;
+    }
+    const schema = model.schema || {};
+    const wb = model.getWebBinding();
+    if (!wb) {
+        return result;
+    }
+    const format = wb.format;
+    if (format === 'float') {
+        result.type = 'number';
+        result.step = schema.multipleOf ?? 0.000001;
+        result.help = '32-bit number with decimals';
+        return result;
+    }
+    if (format === 'double') {
+        result.type = 'number';
+        result.step = schema.multipleOf ?? 0.000001;
+        result.help = '64-bit number with decimals';
+        return result;
+    }
+    else if (format === 'int32') {
+        result.type = 'number';
+        result.step = schema.multipleOf ?? 1;
+        result.help = '-2,147,483,648…+2,147,483,647 (32 bit)';
+        result.min = -2147483648;
+        result.max = 2147483647;
+        return result;
+    }
+    else if (format === 'int64') {
+        result.type = 'number';
+        result.step = schema.multipleOf ?? 1;
+        result.help = 'Negative or positive 64-bit integer';
+        return result;
+    }
+    return result;
+}
+export function getFormatInfo(format) {
+    if (format === 'float') {
+        return { label: 'Float', help: '32-bit number with decimals' };
+    }
+    if (format === 'double') {
+        return { label: 'Double', help: '64-bit number with decimals' };
+    }
+    if (format === 'int32') {
+        return { label: 'Integer (32-bit)', help: '-2,147,483,648…+2,147,483,647' };
+    }
+    if (format === 'int64') {
+        return { label: 'Integer (64-bit)', help: 'Negative or positive 64-bit integer' };
+    }
+    if (format === 'hex') {
+        return { label: 'Hex', help: 'Hex-encoded binary data' };
+    }
+    if (format === 'base64') {
+        return { label: 'Base64', help: 'Base64-encoded binary data' };
+    }
+    return { label: 'Unknown', help: 'An error occurred...' };
+}
+export function getDomainLabel(kind, options = {}) {
+    const { capitalize = false } = options;
+    let result = kind;
+    if (result === DomainNamespaceKind) {
+        result = 'namespace';
+    }
+    else if (result === DomainModelKind) {
+        result = 'model';
+    }
+    else if (result === DomainEntityKind) {
+        result = 'entity';
+    }
+    else if (result === DomainPropertyKind) {
+        result = 'property';
+    }
+    else if (result === DomainAssociationKind) {
+        result = 'association';
+    }
+    if (!result) {
+        return result;
+    }
+    return capitalize ? result.charAt(0).toUpperCase() + result.slice(1) : result;
+}
+/**
+ * Gets the icon type for a given item kind.
+ * @param kind - The kind of the item.
+ * @returns The icon type.
+ */
+export function getDomainIconType(kind) {
+    if (kind === DomainModelKind) {
+        return 'schemaModel';
+    }
+    if (kind === DomainNamespaceKind) {
+        return 'schemaNamespace';
+    }
+    return 'schemaEntity';
+}
+/**
+ * Maps an API Action kind to a user-friendly label.
+ * @param kind The API Action kind.
+ * @returns The label to render with the UI that correspond to the action.
+ */
+export function apiActionKindToLabel(kind) {
+    switch (kind) {
+        case 'list':
+            return 'List';
+        case 'create':
+            return 'Create';
+        case 'read':
+            return 'Read';
+        case 'update':
+            return 'Update';
+        case 'delete':
+            return 'Delete';
+        case 'search':
+            return 'Search';
+        default:
+            return 'Unknown';
+    }
+}
+/**
+ * Maps an API Action kind to an icon name.
+ * @param kind The API Action kind.
+ * @returns The icon name to use for the action kind.
+ */
+export function apiActionKindToIcon(kind) {
+    switch (kind) {
+        case 'list':
+            return 'list';
+        case 'create':
+            return 'add_box';
+        case 'read':
+            return 'get_app';
+        case 'update':
+            return 'edit';
+        case 'delete':
+            return 'delete';
+        case 'search':
+            return 'search';
+        default:
+            return 'help_circle';
+    }
+}
+//# sourceMappingURL=ui_mapping.js.map

package/build/src/modeling/lib/ui_mapping.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ui_mapping.js","sourceRoot":"","sources":["../../../../src/modeling/lib/ui_mapping.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,qBAAqB,EACrB,gBAAgB,EAChB,eAAe,EACf,mBAAmB,EACnB,kBAAkB,GACnB,MAAM,kCAAkC,CAAA;AAGzC;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAAC,CAAqC;IAChE,IAAI,CAAC,CAAC,IAAI,KAAK,qBAAqB,EAAE,CAAC;QACrC,OAAO,MAAM,CAAA;IACf,CAAC;IACD,OAAO,eAAe,CAAC,CAAmB,CAAC,CAAA;AAC7C,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,qBAAqB,CAAC,CAAqC;IACzE,IAAI,CAAC,CAAC,IAAI,KAAK,qBAAqB,EAAE,CAAC;QACrC,OAAO,WAAW,CAAA;IACpB,CAAC;IACD,OAAO,oBAAoB,CAAC,CAAmB,CAAC,CAAA;AAClD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,eAAe,CAAC,CAAiB;IAC/C,IAAI,CAAC,CAAC,OAAO,EAAE,CAAC;QACd,OAAO,KAAK,CAAA;IACd,CAAC;IACD,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC;QACf,kBAAkB;QAClB,KAAK,QAAQ;YACX,OAAO,QAAQ,CAAA;QACjB,KAAK,MAAM;YACT,OAAO,eAAe,CAAA;QACxB,KAAK,MAAM;YACT,OAAO,UAAU,CAAA;QACnB,KAAK,UAAU;YACb,OAAO,OAAO,CAAA;QAChB,KAAK,SAAS;YACZ,OAAO,aAAa,CAAA;QACtB,KAAK,QAAQ;YACX,OAAO,OAAO,CAAA;QAChB;YACE,OAAO,YAAY,CAAA;IACvB,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,oBAAoB,CAAC,CAAiB;IACpD,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC;QACf,KAAK,QAAQ;YACX,OAAO,QAAQ,CAAA;QACjB,KAAK,QAAQ;YACX,OAAO,QAAQ,CAAA;QACjB,kBAAkB;QAClB,qBAAqB;QACrB,cAAc;QACd,iBAAiB;QACjB,KAAK,SAAS;YACZ,OAAO,SAAS,CAAA;QAClB,KAAK,MAAM;YACT,OAAO,MAAM,CAAA;QACf,KAAK,UAAU;YACb,OAAO,eAAe,CAAA;QACxB,KAAK,MAAM;YACT,OAAO,MAAM,CAAA;QACf,cAAc;QACd,iBAAiB;QACjB,KAAK,QAAQ;YACX,OAAO,QAAQ,CAAA;QACjB;YACE,OAAO,SAAS,CAAA;IACpB,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,uBAAuB,CAAC,KAAqB;IAC3D,MAAM,MAAM,GAA8B,EAAE,IAAI,EAAE,MAAM,EAAE,CAAA;IAC1D,IAAI,KAAK,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;QAC1B,MAAM,CAAC,IAAI,GAAG,MAAM,CAAA;QACpB,MAAM,CAAC,IAAI,GAAG,2BAA2B,CAAA;QACzC,OAAO,MAAM,CAAA;IACf,CAAC;IACD,IAAI,KAAK,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;QAC9B,MAAM,CAAC,IAAI,GAAG,gBAAgB,CAAA;QAC9B,MAAM,CAAC,IAAI,GAAG,0CAA0C,CAAA;QACxD,OAAO,MAAM,CAAA;IACf,CAAC;IACD,IAAI,KAAK,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;QAC1B,MAAM,CAAC,IAAI,GAAG,MAAM,CAAA;QACpB,MAAM,CAAC,IAAI,GAAG,sBAAsB,CAAA;QACpC,OAAO,MAAM,CAAA;IACf,CAAC;IACD,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC5B,OAAO,MAAM,CAAA;IACf,CAAC;IACD,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,IAAI,EAAE,CAAA;IACjC,MAAM,EAAE,GAAG,KAAK,CAAC,aAAa,EAAE,CAAA;IAChC,IAAI,CAAC,EAAE,EAAE,CAAC;QACR,OAAO,MAAM,CAAA;IACf,CAAC;IACD,MAAM,MAAM,GAAG,EAAE,CAAC,MAAM,CAAA;IACxB,IAAI,MAAM,KAAK,OAAO,EAAE,CAAC;QACvB,MAAM,CAAC,IAAI,GAAG,QAAQ,CAAA;QACtB,MAAM,CAAC,IAAI,GAAG,MAAM,CAAC,UAAU,IAAI,QAAQ,CAAA;QAC3C,MAAM,CAAC,IAAI,GAAG,6BAA6B,CAAA;QAC3C,OAAO,MAAM,CAAA;IACf,CAAC;IACD,IAAI,MAAM,KAAK,QAAQ,EAAE,CAAC;QACxB,MAAM,CAAC,IAAI,GAAG,QAAQ,CAAA;QACtB,MAAM,CAAC,IAAI,GAAG,MAAM,CAAC,UAAU,IAAI,QAAQ,CAAA;QAC3C,MAAM,CAAC,IAAI,GAAG,6BAA6B,CAAA;QAC3C,OAAO,MAAM,CAAA;IACf,CAAC;SAAM,IAAI,MAAM,KAAK,OAAO,EAAE,CAAC;QAC9B,MAAM,CAAC,IAAI,GAAG,QAAQ,CAAA;QACtB,MAAM,CAAC,IAAI,GAAG,MAAM,CAAC,UAAU,IAAI,CAAC,CAAA;QACpC,MAAM,CAAC,IAAI,GAAG,wCAAwC,CAAA;QACtD,MAAM,CAAC,GAAG,GAAG,CAAC,UAAU,CAAA;QACxB,MAAM,CAAC,GAAG,GAAG,UAAU,CAAA;QACvB,OAAO,MAAM,CAAA;IACf,CAAC;SAAM,IAAI,MAAM,KAAK,OAAO,EAAE,CAAC;QAC9B,MAAM,CAAC,IAAI,GAAG,QAAQ,CAAA;QACtB,MAAM,CAAC,IAAI,GAAG,MAAM,CAAC,UAAU,IAAI,CAAC,CAAA;QACpC,MAAM,CAAC,IAAI,GAAG,qCAAqC,CAAA;QACnD,OAAO,MAAM,CAAA;IACf,CAAC;IACD,OAAO,MAAM,CAAA;AACf,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,MAA4B;IACxD,IAAI,MAAM,KAAK,OAAO,EAAE,CAAC;QACvB,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,6BAA6B,EAAE,CAAA;IAChE,CAAC;IACD,IAAI,MAAM,KAAK,QAAQ,EAAE,CAAC;QACxB,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,6BAA6B,EAAE,CAAA;IACjE,CAAC;IACD,IAAI,MAAM,KAAK,OAAO,EAAE,CAAC;QACvB,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,IAAI,EAAE,+BAA+B,EAAE,CAAA;IAC7E,CAAC;IACD,IAAI,MAAM,KAAK,OAAO,EAAE,CAAC;QACvB,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,IAAI,EAAE,qCAAqC,EAAE,CAAA;IACnF,CAAC;IACD,IAAI,MAAM,KAAK,KAAK,EAAE,CAAC;QACrB,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,yBAAyB,EAAE,CAAA;IAC1D,CAAC;IACD,IAAI,MAAM,KAAK,QAAQ,EAAE,CAAC;QACxB,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,4BAA4B,EAAE,CAAA;IAChE,CAAC;IACD,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,sBAAsB,EAAE,CAAA;AAC3D,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,IAAY,EAAE,UAAoC,EAAE;IACjF,MAAM,EAAE,UAAU,GAAG,KAAK,EAAE,GAAG,OAAO,CAAA;IACtC,IAAI,MAAM,GAAG,IAAI,CAAA;IACjB,IAAI,MAAM,KAAK,mBAAmB,EAAE,CAAC;QACnC,MAAM,GAAG,WAAW,CAAA;IACtB,CAAC;SAAM,IAAI,MAAM,KAAK,eAAe,EAAE,CAAC;QACtC,MAAM,GAAG,OAAO,CAAA;IAClB,CAAC;SAAM,IAAI,MAAM,KAAK,gBAAgB,EAAE,CAAC;QACvC,MAAM,GAAG,QAAQ,CAAA;IACnB,CAAC;SAAM,IAAI,MAAM,KAAK,kBAAkB,EAAE,CAAC;QACzC,MAAM,GAAG,UAAU,CAAA;IACrB,CAAC;SAAM,IAAI,MAAM,KAAK,qBAAqB,EAAE,CAAC;QAC5C,MAAM,GAAG,aAAa,CAAA;IACxB,CAAC;IACD,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,MAAM,CAAA;IACf,CAAC;IACD,OAAO,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAA;AAC/E,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAAC,IAAY;IAC5C,IAAI,IAAI,KAAK,eAAe,EAAE,CAAC;QAC7B,OAAO,aAAa,CAAA;IACtB,CAAC;IACD,IAAI,IAAI,KAAK,mBAAmB,EAAE,CAAC;QACjC,OAAO,iBAAiB,CAAA;IAC1B,CAAC;IACD,OAAO,cAAc,CAAA;AACvB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,oBAAoB,CAAC,IAAY;IAC/C,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,MAAM;YACT,OAAO,MAAM,CAAA;QACf,KAAK,QAAQ;YACX,OAAO,QAAQ,CAAA;QACjB,KAAK,MAAM;YACT,OAAO,MAAM,CAAA;QACf,KAAK,QAAQ;YACX,OAAO,QAAQ,CAAA;QACjB,KAAK,QAAQ;YACX,OAAO,QAAQ,CAAA;QACjB,KAAK,QAAQ;YACX,OAAO,QAAQ,CAAA;QACjB;YACE,OAAO,SAAS,CAAA;IACpB,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CAAC,IAAY;IAC9C,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,MAAM;YACT,OAAO,MAAM,CAAA;QACf,KAAK,QAAQ;YACX,OAAO,SAAS,CAAA;QAClB,KAAK,MAAM;YACT,OAAO,SAAS,CAAA;QAClB,KAAK,QAAQ;YACX,OAAO,MAAM,CAAA;QACf,KAAK,QAAQ;YACX,OAAO,QAAQ,CAAA;QACjB,KAAK,QAAQ;YACX,OAAO,QAAQ,CAAA;QACjB;YACE,OAAO,aAAa,CAAA;IACxB,CAAC;AACH,CAAC","sourcesContent":["import type { DomainAssociation } from '@api-client/core/modeling/DomainAssociation.js'\nimport type { DomainPropertyInputConfig } from '../types.js'\nimport type { IconType } from '../../md/icons/Icons.js'\nimport type { DomainProperty } from '@api-client/core/modeling/DomainProperty.js'\nimport {\n  DomainAssociationKind,\n  DomainEntityKind,\n  DomainModelKind,\n  DomainNamespaceKind,\n  DomainPropertyKind,\n} from '@api-client/core/models/kinds.js'\nimport type { DomainPropertyFormat } from '@api-client/core/modeling/DataFormat.js'\n\n/**\n * Returns the icon to use for the given field (DomainProperty or DomainAssociation).\n * This is used to render the icon in the UI.\n *\n * @param p The field to get the icon for.\n * @returns The icon to use.\n */\nexport function getFieldIcon(p: DomainAssociation | DomainProperty): IconType {\n  if (p.kind === DomainAssociationKind) {\n    return 'link'\n  }\n  return getPropertyIcon(p as DomainProperty)\n}\n\n/**\n * Returns the label to use for the given field (DomainProperty or DomainAssociation).\n * @param p The field to get the label for.\n * @returns The label to use in the data type label.\n */\nexport function getFieldDataTypeLabel(p: DomainAssociation | DomainProperty): string {\n  if (p.kind === DomainAssociationKind) {\n    return 'Reference'\n  }\n  return getPropertyTypeLabel(p as DomainProperty)\n}\n\n/**\n * Generates an icon name for the DomainProperty that illustrate its primary purpose.\n */\nexport function getPropertyIcon(p: DomainProperty): IconType {\n  if (p.primary) {\n    return 'key'\n  }\n  switch (p.type) {\n    // case 'integer':\n    case 'number':\n      return 'number'\n    case 'date':\n      return 'calendarToday'\n    case 'time':\n      return 'schedule'\n    case 'datetime':\n      return 'event'\n    case 'boolean':\n      return 'checkCircle'\n    case 'binary':\n      return 'draft'\n    default:\n      return 'textFields'\n  }\n}\n\n/**\n * @returns The type label to use when rendering the DomainProperty in the UI\n */\nexport function getPropertyTypeLabel(p: DomainProperty): string {\n  switch (p.type) {\n    case 'string':\n      return 'String'\n    case 'number':\n      return 'Number'\n    // case 'integer':\n    //   return 'Integer'\n    // case 'nil':\n    //   return 'Nil'\n    case 'boolean':\n      return 'Boolean'\n    case 'date':\n      return 'Date'\n    case 'datetime':\n      return 'Date and time'\n    case 'time':\n      return 'Time'\n    // case 'any':\n    //   return 'Any'\n    case 'binary':\n      return 'Binary'\n    default:\n      return 'Unknown'\n  }\n}\n\n/**\n * Gathers information about the HTML input's requirements for the given DomainProperty.\n *\n * @param model The data property model to gather HTML input's configuration for.\n * @returns Input attributes to set.\n */\nexport function getPropertyInputOptions(model: DomainProperty): DomainPropertyInputConfig {\n  const result: DomainPropertyInputConfig = { type: 'text' }\n  if (model.type === 'date') {\n    result.type = 'date'\n    result.help = 'Date in YYYY-MM-DD format'\n    return result\n  }\n  if (model.type === 'datetime') {\n    result.type = 'datetime-local'\n    result.help = 'Date and time in YYYY-MM-DDTHH:mm format'\n    return result\n  }\n  if (model.type === 'time') {\n    result.type = 'time'\n    result.help = 'Time in HH:mm format'\n    return result\n  }\n  if (model.type !== 'number') {\n    return result\n  }\n  const schema = model.schema || {}\n  const wb = model.getWebBinding()\n  if (!wb) {\n    return result\n  }\n  const format = wb.format\n  if (format === 'float') {\n    result.type = 'number'\n    result.step = schema.multipleOf ?? 0.000001\n    result.help = '32-bit number with decimals'\n    return result\n  }\n  if (format === 'double') {\n    result.type = 'number'\n    result.step = schema.multipleOf ?? 0.000001\n    result.help = '64-bit number with decimals'\n    return result\n  } else if (format === 'int32') {\n    result.type = 'number'\n    result.step = schema.multipleOf ?? 1\n    result.help = '-2,147,483,648…+2,147,483,647 (32 bit)'\n    result.min = -2147483648\n    result.max = 2147483647\n    return result\n  } else if (format === 'int64') {\n    result.type = 'number'\n    result.step = schema.multipleOf ?? 1\n    result.help = 'Negative or positive 64-bit integer'\n    return result\n  }\n  return result\n}\n\nexport function getFormatInfo(format: DomainPropertyFormat): { label: string; help: string } {\n  if (format === 'float') {\n    return { label: 'Float', help: '32-bit number with decimals' }\n  }\n  if (format === 'double') {\n    return { label: 'Double', help: '64-bit number with decimals' }\n  }\n  if (format === 'int32') {\n    return { label: 'Integer (32-bit)', help: '-2,147,483,648…+2,147,483,647' }\n  }\n  if (format === 'int64') {\n    return { label: 'Integer (64-bit)', help: 'Negative or positive 64-bit integer' }\n  }\n  if (format === 'hex') {\n    return { label: 'Hex', help: 'Hex-encoded binary data' }\n  }\n  if (format === 'base64') {\n    return { label: 'Base64', help: 'Base64-encoded binary data' }\n  }\n  return { label: 'Unknown', help: 'An error occurred...' }\n}\n\nexport function getDomainLabel(kind: string, options: { capitalize?: boolean } = {}): string {\n  const { capitalize = false } = options\n  let result = kind\n  if (result === DomainNamespaceKind) {\n    result = 'namespace'\n  } else if (result === DomainModelKind) {\n    result = 'model'\n  } else if (result === DomainEntityKind) {\n    result = 'entity'\n  } else if (result === DomainPropertyKind) {\n    result = 'property'\n  } else if (result === DomainAssociationKind) {\n    result = 'association'\n  }\n  if (!result) {\n    return result\n  }\n  return capitalize ? result.charAt(0).toUpperCase() + result.slice(1) : result\n}\n\n/**\n * Gets the icon type for a given item kind.\n * @param kind - The kind of the item.\n * @returns The icon type.\n */\nexport function getDomainIconType(kind: string): IconType {\n  if (kind === DomainModelKind) {\n    return 'schemaModel'\n  }\n  if (kind === DomainNamespaceKind) {\n    return 'schemaNamespace'\n  }\n  return 'schemaEntity'\n}\n\n/**\n * Maps an API Action kind to a user-friendly label.\n * @param kind The API Action kind.\n * @returns The label to render with the UI that correspond to the action.\n */\nexport function apiActionKindToLabel(kind: string): string {\n  switch (kind) {\n    case 'list':\n      return 'List'\n    case 'create':\n      return 'Create'\n    case 'read':\n      return 'Read'\n    case 'update':\n      return 'Update'\n    case 'delete':\n      return 'Delete'\n    case 'search':\n      return 'Search'\n    default:\n      return 'Unknown'\n  }\n}\n\n/**\n * Maps an API Action kind to an icon name.\n * @param kind The API Action kind.\n * @returns The icon name to use for the action kind.\n */\nexport function apiActionKindToIcon(kind: string): string {\n  switch (kind) {\n    case 'list':\n      return 'list'\n    case 'create':\n      return 'add_box'\n    case 'read':\n      return 'get_app'\n    case 'update':\n      return 'edit'\n    case 'delete':\n      return 'delete'\n    case 'search':\n      return 'search'\n    default:\n      return 'help_circle'\n  }\n}\n"]}

package/build/src/modeling/lib/validators.d.ts

@@ -0,0 +1,15 @@
+import type { AccessRule } from '@api-client/core/modeling/types.js';
+import type { ApiModelAccessTarget, ApiModelOperationName } from '../types.js';
+/**
+ * Check if the given value is a valid operation name.
+ */
+export declare function isValidOperationName(value?: string): value is ApiModelOperationName;
+/**
+ * Check if the given value is a valid access target.
+ */
+export declare function isValidAccessTarget(value?: string): value is ApiModelAccessTarget;
+/**
+ * Check if the given value is a valid access rule type.
+ */
+export declare function isValidAccessRuleType(value?: string): value is AccessRule['type'];
+//# sourceMappingURL=validators.d.ts.map

package/build/src/modeling/lib/validators.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validators.d.ts","sourceRoot":"","sources":["../../../../src/modeling/lib/validators.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oCAAoC,CAAA;AACpE,OAAO,KAAK,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAE9E;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,SAAK,GAAG,KAAK,IAAI,qBAAqB,CAE/E;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,SAAK,GAAG,KAAK,IAAI,oBAAoB,CAE7E;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,SAAK,GAAG,KAAK,IAAI,UAAU,CAAC,MAAM,CAAC,CAS7E"}

package/build/src/modeling/lib/validators.js

@@ -0,0 +1,26 @@
+/**
+ * Check if the given value is a valid operation name.
+ */
+export function isValidOperationName(value = '') {
+    return ['list', 'read', 'create', 'update', 'delete', 'search'].includes(value);
+}
+/**
+ * Check if the given value is a valid access target.
+ */
+export function isValidAccessTarget(value = '') {
+    return ['api', 'action', 'endpoint'].includes(value);
+}
+/**
+ * Check if the given value is a valid access rule type.
+ */
+export function isValidAccessRuleType(value = '') {
+    return [
+        'public',
+        'authenticated',
+        'resourceOwner',
+        'matchUserRole',
+        'matchUserProperty',
+        'matchEmailDomain',
+    ].includes(value);
+}
+//# sourceMappingURL=validators.js.map

package/build/src/modeling/lib/validators.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validators.js","sourceRoot":"","sources":["../../../../src/modeling/lib/validators.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,MAAM,UAAU,oBAAoB,CAAC,KAAK,GAAG,EAAE;IAC7C,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;AACjF,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,mBAAmB,CAAC,KAAK,GAAG,EAAE;IAC5C,OAAO,CAAC,KAAK,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;AACtD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,qBAAqB,CAAC,KAAK,GAAG,EAAE;IAC9C,OAAO;QACL,QAAQ;QACR,eAAe;QACf,eAAe;QACf,eAAe;QACf,mBAAmB;QACnB,kBAAkB;KACnB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;AACnB,CAAC","sourcesContent":["import type { AccessRule } from '@api-client/core/modeling/types.js'\nimport type { ApiModelAccessTarget, ApiModelOperationName } from '../types.js'\n\n/**\n * Check if the given value is a valid operation name.\n */\nexport function isValidOperationName(value = ''): value is ApiModelOperationName {\n  return ['list', 'read', 'create', 'update', 'delete', 'search'].includes(value)\n}\n\n/**\n * Check if the given value is a valid access target.\n */\nexport function isValidAccessTarget(value = ''): value is ApiModelAccessTarget {\n  return ['api', 'action', 'endpoint'].includes(value)\n}\n\n/**\n * Check if the given value is a valid access rule type.\n */\nexport function isValidAccessRuleType(value = ''): value is AccessRule['type'] {\n  return [\n    'public',\n    'authenticated',\n    'resourceOwner',\n    'matchUserRole',\n    'matchUserProperty',\n    'matchEmailDomain',\n  ].includes(value)\n}\n"]}