@researchdatabox/sails-ng-common 0.0.1-beta.8936

package/dist/src/config/form-override.outline.d.ts

@@ -0,0 +1,15 @@
+import { FormModesConfig } from "./shared.outline";
+import { AllFormComponentDefinitionOutlines } from "./dictionary.outline";
+import { VisitorComponentClassNamesType } from "./dictionary.model";
+import { FormOverrideModesClassConfig } from "./form-component.outline";
+/**
+ * The type that specifies the known transformations.
+ */
+export type KnownTransformsType = Partial<{
+    [key in VisitorComponentClassNamesType]: Partial<{
+        [key in VisitorComponentClassNamesType]: (source: any, formMode: FormModesConfig) => AllFormComponentDefinitionOutlines;
+    }>;
+}>;
+export type DefaultTransformsType = Partial<{
+    [key in VisitorComponentClassNamesType]: FormOverrideModesClassConfig;
+}>;

package/dist/src/config/form-override.outline.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZm9ybS1vdmVycmlkZS5vdXRsaW5lLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2NvbmZpZy9mb3JtLW92ZXJyaWRlLm91dGxpbmUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiJ9

package/dist/src/config/form-types.model.d.ts

@@ -0,0 +1,6 @@
+import { FormValidatorDefinition } from "../validation/form.model";
+/**
+ * Check if the item is a valid form validation definition.
+ * @param item The item to check.
+ */
+export declare function isTypeFormValidatorDefinition(item: unknown): item is FormValidatorDefinition;

package/dist/src/config/form-types.model.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isTypeFormValidatorDefinition = isTypeFormValidatorDefinition;
+const helpers_1 = require("./helpers");
+/**
+ * Check if the item is a valid form validation definition.
+ * @param item The item to check.
+ */
+function isTypeFormValidatorDefinition(item) {
+    if (item === undefined || item === null) {
+        return false;
+    }
+    const i = item;
+    const hasExpectedPropClass = 'class' in i && (0, helpers_1.guessType)(i.class) === 'string';
+    const hasExpectedPropClassValue = i.class?.toString()?.trim().length > 0;
+    const hasExpectedPropMessage = 'message' in i && (0, helpers_1.guessType)(i.message) === 'string';
+    const hasExpectedPropMessageValue = i.message?.toString()?.trim().length > 0;
+    const hasExpectedPropCreate = 'create' in i;
+    return hasExpectedPropClass && hasExpectedPropClassValue
+        && hasExpectedPropMessage && hasExpectedPropMessageValue
+        && hasExpectedPropCreate;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZm9ybS10eXBlcy5tb2RlbC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9jb25maWcvZm9ybS10eXBlcy5tb2RlbC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQVFBLHNFQWlCQztBQXpCRCx1Q0FBb0M7QUFJcEM7OztHQUdHO0FBQ0gsU0FBZ0IsNkJBQTZCLENBQUMsSUFBYTtJQUN2RCxJQUFJLElBQUksS0FBSyxTQUFTLElBQUksSUFBSSxLQUFLLElBQUksRUFBRSxDQUFDO1FBQ3RDLE9BQU8sS0FBSyxDQUFDO0lBQ2pCLENBQUM7SUFDRCxNQUFNLENBQUMsR0FBRyxJQUErQixDQUFDO0lBRTFDLE1BQU0sb0JBQW9CLEdBQUcsT0FBTyxJQUFJLENBQUMsSUFBSSxJQUFBLG1CQUFTLEVBQUMsQ0FBQyxDQUFDLEtBQUssQ0FBQyxLQUFLLFFBQVEsQ0FBQztJQUM3RSxNQUFNLHlCQUF5QixHQUFHLENBQUMsQ0FBQyxLQUFLLEVBQUUsUUFBUSxFQUFFLEVBQUUsSUFBSSxFQUFFLENBQUMsTUFBTSxHQUFHLENBQUMsQ0FBQztJQUV6RSxNQUFNLHNCQUFzQixHQUFHLFNBQVMsSUFBSSxDQUFDLElBQUksSUFBQSxtQkFBUyxFQUFDLENBQUMsQ0FBQyxPQUFPLENBQUMsS0FBSyxRQUFRLENBQUM7SUFDbkYsTUFBTSwyQkFBMkIsR0FBRyxDQUFDLENBQUMsT0FBTyxFQUFFLFFBQVEsRUFBRSxFQUFFLElBQUksRUFBRSxDQUFDLE1BQU0sR0FBRyxDQUFDLENBQUM7SUFFN0UsTUFBTSxxQkFBcUIsR0FBRyxRQUFRLElBQUksQ0FBQyxDQUFDO0lBRTVDLE9BQU8sb0JBQW9CLElBQUkseUJBQXlCO1dBQ2pELHNCQUFzQixJQUFJLDJCQUEyQjtXQUNyRCxxQkFBcUIsQ0FBQztBQUNqQyxDQUFDIn0=

package/dist/src/config/form-types.outline.d.ts

@@ -0,0 +1,48 @@
+import { FormComponentDefinitionFrame } from "./form-component.outline";
+import { FormConfigFrame } from "./form-config.outline";
+import { FieldDefinitionFrame } from "./field.outline";
+import { ReusableFormComponentDefinitionFrame } from "./component/reusable.outline";
+import { AvailableFormComponentDefinitionFrames } from "./dictionary.outline";
+/**
+ * Check if the item is a field definition (it has at least 'class' and optional 'config' properties).
+ * @param item The item to check.
+ */
+export declare function isTypeFieldDefinition(item: unknown): item is FieldDefinitionFrame;
+/**
+ * Check if the item is a field definition of a particular type by comparing the class name
+ * (class name is the discriminator in the type union).
+ * @param item The item to check.
+ * @param name The class name to check.
+ */
+export declare function isTypeFieldDefinitionName<T extends FieldDefinitionFrame>(item: unknown, name: string): item is T;
+/**
+ * Check if the item is a form component definition (it has at least 'name' and 'component' properties).
+ * @param item The item to check.
+ */
+export declare function isTypeFormComponentDefinition(item: unknown): item is FormComponentDefinitionFrame;
+/**
+ * Check if the item is a form definition of a particular type by comparing the component class
+ * (component class name is the discriminator in the type union).
+ * @param item The item to check.
+ * @param name The class name to check.
+ */
+export declare function isTypeFormComponentDefinitionName<T extends FormComponentDefinitionFrame>(item: unknown, name: string): item is T;
+/**
+ * Check if the item has a componentDefinitions array property.
+ * @param item The item to check.
+ */
+export declare function isTypeWithComponentDefinitions<T extends {
+    componentDefinitions: unknown[];
+}>(item: unknown): item is T;
+/**
+ * Check if the item is a FormConfig (it has a name and componentDefinitions array property).
+ * @param item The item to check.
+ */
+export declare function isTypeFormConfig<T extends FormConfigFrame>(item: unknown): item is T;
+/**
+ * Check if a form component definition specifies to use a reusable form config.
+ * @param item The form component definition.
+ * @param reusableFormDefNames The names of the available reusable form definitions.
+ * @protected
+ */
+export declare function isTypeReusableComponent(item: AvailableFormComponentDefinitionFrames, reusableFormDefNames: string[]): item is ReusableFormComponentDefinitionFrame;

package/dist/src/config/form-types.outline.js

@@ -0,0 +1,137 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isTypeFieldDefinition = isTypeFieldDefinition;
+exports.isTypeFieldDefinitionName = isTypeFieldDefinitionName;
+exports.isTypeFormComponentDefinition = isTypeFormComponentDefinition;
+exports.isTypeFormComponentDefinitionName = isTypeFormComponentDefinitionName;
+exports.isTypeWithComponentDefinitions = isTypeWithComponentDefinitions;
+exports.isTypeFormConfig = isTypeFormConfig;
+exports.isTypeReusableComponent = isTypeReusableComponent;
+const helpers_1 = require("./helpers");
+const reusable_outline_1 = require("./component/reusable.outline");
+/*
+ * The functions starting with 'isType*' use typescript narrowing to check the value
+ * see: https://www.typescriptlang.org/docs/handbook/2/narrowing.html
+ */
+/**
+ * Check if the item is a field definition (it has at least 'class' and optional 'config' properties).
+ * @param item The item to check.
+ */
+function isTypeFieldDefinition(item) {
+    if (item === undefined || item === null) {
+        return false;
+    }
+    const i = item;
+    const propClassGuessType = (0, helpers_1.guessType)(i?.class);
+    const hasExpectedPropClass = 'class' in i && propClassGuessType === 'string';
+    // 'config' can be null or object or not set
+    const propConfigGuessType = (0, helpers_1.guessType)(i.config);
+    const hasExpectedPropConfig = ('config' in i && ["object", "null"].includes(propConfigGuessType)) || i?.config === undefined;
+    const isFieldDefinition = hasExpectedPropClass && hasExpectedPropConfig;
+    if (!isFieldDefinition) {
+        console.log(`isTypeFieldDefinition propClassGuessType ${propClassGuessType} propConfigGuessType ${propConfigGuessType}`);
+    }
+    return isFieldDefinition;
+}
+/**
+ * Check if the item is a field definition of a particular type by comparing the class name
+ * (class name is the discriminator in the type union).
+ * @param item The item to check.
+ * @param name The class name to check.
+ */
+function isTypeFieldDefinitionName(item, name) {
+    if (item === undefined || item === null) {
+        return false;
+    }
+    const hasExpectedFieldDefClass = isTypeFieldDefinition(item) && item?.class === name;
+    return hasExpectedFieldDefClass;
+}
+/**
+ * Check if the item is a form component definition (it has at least 'name' and 'component' properties).
+ * @param item The item to check.
+ */
+function isTypeFormComponentDefinition(item) {
+    if (item === undefined || item === null) {
+        return false;
+    }
+    // use typescript narrowing to check the value
+    const i = item;
+    // only name and component are required
+    const hasName = 'name' in i;
+    const hasExpectedNameValue = ["null", "string"].includes((0, helpers_1.guessType)(i?.name));
+    const hasComponent = 'component' in i;
+    const isFormFieldComponent = isTypeFieldDefinition(i?.component);
+    return hasName && hasExpectedNameValue && hasComponent && isFormFieldComponent;
+}
+/**
+ * Check if the item is a form definition of a particular type by comparing the component class
+ * (component class name is the discriminator in the type union).
+ * @param item The item to check.
+ * @param name The class name to check.
+ */
+function isTypeFormComponentDefinitionName(item, name) {
+    if (item === undefined || item === null) {
+        return false;
+    }
+    const hasExpectedFormDefClass = isTypeFormComponentDefinition(item) && item?.component?.class === name;
+    return hasExpectedFormDefClass;
+}
+/**
+ * Check if the item has a componentDefinitions array property.
+ * @param item The item to check.
+ */
+function isTypeWithComponentDefinitions(item) {
+    if (item === undefined || item === null) {
+        return false;
+    }
+    // use typescript narrowing to check the value
+    const i = item;
+    const hasExpectedPropCompDefs = 'componentDefinitions' in i && (0, helpers_1.guessType)(i?.componentDefinitions) === 'array';
+    return hasExpectedPropCompDefs;
+}
+/**
+ * Check if the item is a FormConfig (it has a name and componentDefinitions array property).
+ * @param item The item to check.
+ */
+function isTypeFormConfig(item) {
+    if (item === undefined || item === null) {
+        return false;
+    }
+    const i = item;
+    const hasExpectedPropName = 'name' in i && (0, helpers_1.guessType)(i.name) === 'string';
+    const hasExpectedPropCompDefs = isTypeWithComponentDefinitions(item);
+    return hasExpectedPropName && hasExpectedPropCompDefs;
+}
+/**
+ * Check if a form component definition specifies to use a reusable form config.
+ * @param item The form component definition.
+ * @param reusableFormDefNames The names of the available reusable form definitions.
+ * @protected
+ */
+function isTypeReusableComponent(item, reusableFormDefNames) {
+    const componentClassName = item?.component?.class ?? "";
+    const itemReusableFormName = item?.overrides?.reusableFormName ?? "";
+    const isReusableComponent = componentClassName === reusable_outline_1.ReusableComponentName;
+    const hasReusableFormName = itemReusableFormName && reusableFormDefNames.includes(itemReusableFormName);
+    if (!isReusableComponent && !hasReusableFormName) {
+        return false;
+    }
+    if (hasReusableFormName && isTypeFormComponentDefinitionName(item, reusable_outline_1.ReusableComponentName)) {
+        const overrides = item?.overrides ?? {};
+        const overrideKeys = Object.keys(overrides);
+        const reusableFormNameOnly = overrideKeys.includes('reusableFormName') && overrideKeys.length === 1;
+        const noKeys = overrideKeys.length === 0;
+        if (!reusableFormNameOnly && !noKeys) {
+            throw new Error("Invalid usage of reusable form config. " +
+                `Override for component name '${item.name}' class '${item.component.class}' must contain only 'reusableFormName', ` +
+                `it cannot be combined with other properties '${JSON.stringify(overrides)}'. ` +
+                `Change the form component name by setting the 'replaceName' property for the relevant componentDefinition. ` +
+                `The 'formModeClasses' can only be changed on subcomponents.`);
+        }
+        return true;
+    }
+    throw new Error("Invalid usage of reusable form config. " +
+        `Component class '${componentClassName}' must be '${reusable_outline_1.ReusableComponentName}' ` +
+        `and reusableFormName '${itemReusableFormName}' must be one of '${reusableFormDefNames.join(', ') || '(none available)'}'.`);
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZm9ybS10eXBlcy5vdXRsaW5lLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2NvbmZpZy9mb3JtLXR5cGVzLm91dGxpbmUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFpQkEsc0RBbUJDO0FBUUQsOERBUUM7QUFNRCxzRUFhQztBQVFELDhFQVFDO0FBTUQsd0VBWUM7QUFNRCw0Q0FXQztBQVFELDBEQWdDQztBQWxLRCx1Q0FBb0M7QUFJcEMsbUVBQXlHO0FBSXpHOzs7R0FHRztBQUVIOzs7R0FHRztBQUNILFNBQWdCLHFCQUFxQixDQUFDLElBQWE7SUFDL0MsSUFBSSxJQUFJLEtBQUssU0FBUyxJQUFJLElBQUksS0FBSyxJQUFJLEVBQUUsQ0FBQztRQUN0QyxPQUFPLEtBQUssQ0FBQztJQUNqQixDQUFDO0lBQ0QsTUFBTSxDQUFDLEdBQUcsSUFBNEIsQ0FBQztJQUV2QyxNQUFNLGtCQUFrQixHQUFHLElBQUEsbUJBQVMsRUFBQyxDQUFDLEVBQUUsS0FBSyxDQUFDLENBQUM7SUFDL0MsTUFBTSxvQkFBb0IsR0FBRyxPQUFPLElBQUksQ0FBQyxJQUFJLGtCQUFrQixLQUFLLFFBQVEsQ0FBQztJQUM3RSw0Q0FBNEM7SUFDNUMsTUFBTSxtQkFBbUIsR0FBSSxJQUFBLG1CQUFTLEVBQUMsQ0FBQyxDQUFDLE1BQU0sQ0FBQyxDQUFDO0lBQ2pELE1BQU0scUJBQXFCLEdBQUcsQ0FBQyxRQUFRLElBQUksQ0FBQyxJQUFJLENBQUMsUUFBUSxFQUFFLE1BQU0sQ0FBQyxDQUFDLFFBQVEsQ0FBQyxtQkFBbUIsQ0FBQyxDQUFDLElBQUksQ0FBQyxFQUFFLE1BQU0sS0FBSyxTQUFTLENBQUM7SUFFN0gsTUFBTSxpQkFBaUIsR0FBRyxvQkFBb0IsSUFBSSxxQkFBcUIsQ0FBQztJQUN4RSxJQUFJLENBQUMsaUJBQWlCLEVBQ3RCLENBQUM7UUFDRyxPQUFPLENBQUMsR0FBRyxDQUFDLDRDQUE0QyxrQkFBa0Isd0JBQXdCLG1CQUFtQixFQUFFLENBQUMsQ0FBQztJQUM3SCxDQUFDO0lBRUQsT0FBTyxpQkFBaUIsQ0FBQztBQUM3QixDQUFDO0FBRUQ7Ozs7O0dBS0c7QUFDSCxTQUFnQix5QkFBeUIsQ0FBaUMsSUFBYSxFQUFFLElBQVk7SUFDakcsSUFBSSxJQUFJLEtBQUssU0FBUyxJQUFJLElBQUksS0FBSyxJQUFJLEVBQUUsQ0FBQztRQUN0QyxPQUFPLEtBQUssQ0FBQztJQUNqQixDQUFDO0lBRUQsTUFBTSx3QkFBd0IsR0FBRyxxQkFBcUIsQ0FBQyxJQUFJLENBQUMsSUFBSSxJQUFJLEVBQUUsS0FBSyxLQUFLLElBQUksQ0FBQztJQUVyRixPQUFPLHdCQUF3QixDQUFDO0FBQ3BDLENBQUM7QUFFRDs7O0dBR0c7QUFDSCxTQUFnQiw2QkFBNkIsQ0FBQyxJQUFhO0lBQ3ZELElBQUksSUFBSSxLQUFLLFNBQVMsSUFBSSxJQUFJLEtBQUssSUFBSSxFQUFFLENBQUM7UUFDdEMsT0FBTyxLQUFLLENBQUM7SUFDakIsQ0FBQztJQUNELDhDQUE4QztJQUM5QyxNQUFNLENBQUMsR0FBRyxJQUFvQyxDQUFDO0lBQy9DLHVDQUF1QztJQUN2QyxNQUFNLE9BQU8sR0FBRyxNQUFNLElBQUksQ0FBQyxDQUFDO0lBQzVCLE1BQU0sb0JBQW9CLEdBQUcsQ0FBQyxNQUFNLEVBQUUsUUFBUSxDQUFDLENBQUMsUUFBUSxDQUFDLElBQUEsbUJBQVMsRUFBQyxDQUFDLEVBQUUsSUFBSSxDQUFDLENBQUMsQ0FBQztJQUM3RSxNQUFNLFlBQVksR0FBRyxXQUFXLElBQUksQ0FBQyxDQUFDO0lBQ3RDLE1BQU0sb0JBQW9CLEdBQUcscUJBQXFCLENBQUMsQ0FBQyxFQUFFLFNBQVMsQ0FBQyxDQUFDO0lBRWpFLE9BQU8sT0FBTyxJQUFJLG9CQUFvQixJQUFJLFlBQVksSUFBSSxvQkFBb0IsQ0FBQztBQUNuRixDQUFDO0FBRUQ7Ozs7O0dBS0c7QUFDSCxTQUFnQixpQ0FBaUMsQ0FBeUMsSUFBYSxFQUFFLElBQVk7SUFDakgsSUFBSSxJQUFJLEtBQUssU0FBUyxJQUFJLElBQUksS0FBSyxJQUFJLEVBQUUsQ0FBQztRQUN0QyxPQUFPLEtBQUssQ0FBQztJQUNqQixDQUFDO0lBRUQsTUFBTSx1QkFBdUIsR0FBRyw2QkFBNkIsQ0FBQyxJQUFJLENBQUMsSUFBSSxJQUFJLEVBQUUsU0FBUyxFQUFFLEtBQUssS0FBSyxJQUFJLENBQUM7SUFFdkcsT0FBTyx1QkFBdUIsQ0FBQztBQUNuQyxDQUFDO0FBRUQ7OztHQUdHO0FBQ0gsU0FBZ0IsOEJBQThCLENBRTNDLElBQWE7SUFDWixJQUFJLElBQUksS0FBSyxTQUFTLElBQUksSUFBSSxLQUFLLElBQUksRUFBRSxDQUFDO1FBQ3RDLE9BQU8sS0FBSyxDQUFDO0lBQ2pCLENBQUM7SUFDRCw4Q0FBOEM7SUFDOUMsTUFBTSxDQUFDLEdBQUcsSUFBMkMsQ0FBQztJQUV0RCxNQUFNLHVCQUF1QixHQUFHLHNCQUFzQixJQUFJLENBQUMsSUFBSSxJQUFBLG1CQUFTLEVBQUMsQ0FBQyxFQUFFLG9CQUFvQixDQUFDLEtBQUssT0FBTyxDQUFDO0lBRTlHLE9BQU8sdUJBQXVCLENBQUM7QUFDbkMsQ0FBQztBQUVEOzs7R0FHRztBQUNILFNBQWdCLGdCQUFnQixDQUE0QixJQUFhO0lBQ3JFLElBQUksSUFBSSxLQUFLLFNBQVMsSUFBSSxJQUFJLEtBQUssSUFBSSxFQUFFLENBQUM7UUFDdEMsT0FBTyxLQUFLLENBQUM7SUFDakIsQ0FBQztJQUVELE1BQU0sQ0FBQyxHQUFHLElBQXVCLENBQUM7SUFFbEMsTUFBTSxtQkFBbUIsR0FBRyxNQUFNLElBQUksQ0FBQyxJQUFJLElBQUEsbUJBQVMsRUFBQyxDQUFDLENBQUMsSUFBSSxDQUFDLEtBQUssUUFBUSxDQUFDO0lBQzFFLE1BQU0sdUJBQXVCLEdBQUcsOEJBQThCLENBQWtCLElBQUksQ0FBQyxDQUFDO0lBRXRGLE9BQU8sbUJBQW1CLElBQUksdUJBQXVCLENBQUM7QUFDMUQsQ0FBQztBQUVEOzs7OztHQUtHO0FBQ0gsU0FBZ0IsdUJBQXVCLENBQ25DLElBQTRDLEVBQzVDLG9CQUE4QjtJQUU5QixNQUFNLGtCQUFrQixHQUFHLElBQUksRUFBRSxTQUFTLEVBQUUsS0FBSyxJQUFJLEVBQUUsQ0FBQztJQUN4RCxNQUFNLG9CQUFvQixHQUFHLElBQUksRUFBRSxTQUFTLEVBQUUsZ0JBQWdCLElBQUksRUFBRSxDQUFDO0lBRXJFLE1BQU0sbUJBQW1CLEdBQUcsa0JBQWtCLEtBQUssd0NBQXFCLENBQUM7SUFDekUsTUFBTSxtQkFBbUIsR0FBRyxvQkFBb0IsSUFBSSxvQkFBb0IsQ0FBQyxRQUFRLENBQUMsb0JBQW9CLENBQUMsQ0FBQztJQUV4RyxJQUFJLENBQUMsbUJBQW1CLElBQUksQ0FBQyxtQkFBbUIsRUFBRSxDQUFDO1FBQy9DLE9BQU8sS0FBSyxDQUFDO0lBQ2pCLENBQUM7SUFFRCxJQUFJLG1CQUFtQixJQUFJLGlDQUFpQyxDQUF1QyxJQUFJLEVBQUUsd0NBQXFCLENBQUMsRUFBRSxDQUFDO1FBQzlILE1BQU0sU0FBUyxHQUFHLElBQUksRUFBRSxTQUFTLElBQUksRUFBRSxDQUFDO1FBQ3hDLE1BQU0sWUFBWSxHQUFHLE1BQU0sQ0FBQyxJQUFJLENBQUMsU0FBUyxDQUFDLENBQUM7UUFDNUMsTUFBTSxvQkFBb0IsR0FBRyxZQUFZLENBQUMsUUFBUSxDQUFDLGtCQUFrQixDQUFDLElBQUksWUFBWSxDQUFDLE1BQU0sS0FBSyxDQUFDLENBQUM7UUFDcEcsTUFBTSxNQUFNLEdBQUcsWUFBWSxDQUFDLE1BQU0sS0FBSyxDQUFDLENBQUM7UUFDekMsSUFBSSxDQUFDLG9CQUFvQixJQUFJLENBQUMsTUFBTSxFQUFFLENBQUM7WUFDbkMsTUFBTSxJQUFJLEtBQUssQ0FBQyx5Q0FBeUM7Z0JBQ3JELGdDQUFnQyxJQUFJLENBQUMsSUFBSSxZQUFZLElBQUksQ0FBQyxTQUFTLENBQUMsS0FBSywwQ0FBMEM7Z0JBQ25ILGdEQUFnRCxJQUFJLENBQUMsU0FBUyxDQUFDLFNBQVMsQ0FBQyxLQUFLO2dCQUM5RSw2R0FBNkc7Z0JBQzdHLDZEQUE2RCxDQUFDLENBQUM7UUFDdkUsQ0FBQztRQUNELE9BQU8sSUFBSSxDQUFDO0lBQ2hCLENBQUM7SUFFRCxNQUFNLElBQUksS0FBSyxDQUFDLHlDQUF5QztRQUNyRCxvQkFBb0Isa0JBQWtCLGNBQWMsd0NBQXFCLElBQUk7UUFDN0UseUJBQXlCLG9CQUFvQixxQkFBcUIsb0JBQW9CLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxJQUFJLGtCQUFrQixJQUFJLENBQUMsQ0FBQztBQUNySSxDQUFDIn0=

package/dist/src/config/helpers.d.ts

@@ -0,0 +1,23 @@
+export type GuessedType = "null" | "undefined" | "boolean" | "number" | "array" | "object" | "function" | "timestamp" | "string" | "unknown";
+/**
+ * Guess the type of the value.
+ * @param value Guess the type of this value.
+ * @private
+ */
+export declare function guessType(value: unknown): GuessedType;
+/**
+ * Apply conventions to convert a value to a boolean.
+ * @param value A value to convert to boolean.
+ */
+export declare function toBoolean(value: unknown): boolean;
+/**
+ * Extract all properties of the type T that are of the type U.
+ */
+export type ExtractPropertyNamesOfType<T, U> = {
+    [K in keyof T]: T[K] extends U ? K : never;
+}[keyof T];
+/**
+ * Extract all properties from each of the types in the union type T, where the properties are of type U.
+ * This uses the distributive feature of conditional types (T extends T ? ...).
+ */
+export type ExtractPropertyNamesOfTypeFromTypeUnion<T, U> = T extends T ? ExtractPropertyNamesOfType<T, U> : never;

package/dist/src/config/helpers.js

@@ -0,0 +1,105 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.guessType = guessType;
+exports.toBoolean = toBoolean;
+const lodash_1 = require("lodash");
+const luxon_1 = require("luxon");
+/**
+ * Guess the type of the value.
+ * @param value Guess the type of this value.
+ * @private
+ */
+function guessType(value) {
+    if (value === null) {
+        return "null";
+    }
+    if (value === undefined) {
+        return "undefined";
+    }
+    if ((0, lodash_1.isBoolean)(value)) {
+        return "boolean";
+    }
+    if (Number.isFinite(value)) {
+        return "number";
+    }
+    if ((0, lodash_1.isArray)(value)) {
+        return "array";
+    }
+    if ((0, lodash_1.isPlainObject)(value)) {
+        return "object";
+    }
+    // Check for custom Object.
+    try {
+        const valueInfo = valueProtoInfo(value);
+        if (valueInfo.isObjectLike && valueInfo.isValueStringTagObject &&
+            valueInfo.isValueProtoCtorFunc && !valueInfo.isValueProtoCtorFuncObj) {
+            return "object";
+        }
+    }
+    catch (err) {
+        console.debug(`guessType custom object error with value '${value}': ${err}`);
+    }
+    if ((0, lodash_1.isFunction)(value)) {
+        return "function";
+    }
+    // check for date
+    const dateTimeFormats = [
+        luxon_1.DateTime.fromISO,
+        luxon_1.DateTime.fromRFC2822,
+        luxon_1.DateTime.fromHTTP,
+    ];
+    try {
+        for (const dateTimeFormat of dateTimeFormats) {
+            const result = dateTimeFormat(value?.toString() ?? "");
+            if (result && result.isValid) {
+                return "timestamp";
+            }
+        }
+    }
+    catch (err) {
+        console.debug(`guessType parse error with value '${value}' formats ${JSON.stringify(dateTimeFormats)}: ${err}`);
+    }
+    if ((0, lodash_1.isString)(value)) {
+        return "string";
+    }
+    console.debug(`guessType unknown type for '${value}' info ${JSON.stringify(valueProtoInfo(value))}`);
+    return "unknown";
+}
+function valueProtoInfo(value) {
+    const isObjectLike = (0, lodash_1.isObjectLike)(value);
+    const isValueStringTagObject = Object.prototype.toString.call(value) === '[object Object]';
+    const valuePrototypeCtor = Object.getPrototypeOf(value).constructor;
+    const isValueProtoCtorFunc = typeof valuePrototypeCtor === 'function';
+    const isValueProtoCtorFuncObj = Function.prototype.toString.call(valuePrototypeCtor) === Function.prototype.toString.call(Object);
+    return {
+        isObjectLike,
+        isValueStringTagObject,
+        valuePrototypeCtor,
+        isValueProtoCtorFunc,
+        isValueProtoCtorFuncObj,
+    };
+}
+/**
+ * Apply conventions to convert a value to a boolean.
+ * @param value A value to convert to boolean.
+ */
+function toBoolean(value) {
+    if (typeof value === 'boolean') {
+        return value;
+    }
+    if (typeof value === 'number') {
+        return !Number.isNaN(value) && value !== 0;
+    }
+    const normalized = String(value ?? '').trim().toLowerCase();
+    const trueValues = ["true", "t", "1", "yes", "y", "on", "enable", "enabled"];
+    return trueValues.includes(normalized);
+}
+// TODO: consider trying to type the access to the config properties.
+// type FormFieldComponentOrLayoutDefinitionConfig = FormFieldComponentOrLayoutDefinition['config'];
+// type FormFieldComponentOrLayoutStringKeys = NonNullable<ExtractPropertyNamesOfTypeFromTypeUnion<
+//   FormFieldComponentOrLayoutDefinitionConfig, string | undefined | null
+// >>;
+// type FormFieldComponentOrLayoutBooleanKeys = NonNullable<ExtractPropertyNamesOfTypeFromTypeUnion<
+//   FormFieldComponentOrLayoutDefinitionConfig, boolean | undefined | null
+// >>;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaGVscGVycy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9jb25maWcvaGVscGVycy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQTBCQSw4QkErREM7QUFxQkQsOEJBVUM7QUF4SEQsbUNBT2dCO0FBQ2hCLGlDQUErQjtBQWEvQjs7OztHQUlHO0FBQ0gsU0FBZ0IsU0FBUyxDQUFDLEtBQWM7SUFDcEMsSUFBSSxLQUFLLEtBQUssSUFBSSxFQUFFLENBQUM7UUFDakIsT0FBTyxNQUFNLENBQUM7SUFDbEIsQ0FBQztJQUNELElBQUksS0FBSyxLQUFLLFNBQVMsRUFBRSxDQUFDO1FBQ3RCLE9BQU8sV0FBVyxDQUFDO0lBQ3ZCLENBQUM7SUFFRCxJQUFJLElBQUEsa0JBQVUsRUFBQyxLQUFLLENBQUMsRUFBRSxDQUFDO1FBQ3BCLE9BQU8sU0FBUyxDQUFDO0lBQ3JCLENBQUM7SUFFRCxJQUFJLE1BQU0sQ0FBQyxRQUFRLENBQUMsS0FBSyxDQUFDLEVBQUUsQ0FBQztRQUN6QixPQUFPLFFBQVEsQ0FBQztJQUNwQixDQUFDO0lBRUQsSUFBSSxJQUFBLGdCQUFRLEVBQUMsS0FBSyxDQUFDLEVBQUUsQ0FBQztRQUNsQixPQUFPLE9BQU8sQ0FBQztJQUNuQixDQUFDO0lBRUQsSUFBSSxJQUFBLHNCQUFjLEVBQUMsS0FBSyxDQUFDLEVBQUUsQ0FBQztRQUN4QixPQUFPLFFBQVEsQ0FBQztJQUNwQixDQUFDO0lBRUQsMkJBQTJCO0lBQzNCLElBQUksQ0FBQztRQUNELE1BQU0sU0FBUyxHQUFHLGNBQWMsQ0FBQyxLQUFLLENBQUMsQ0FBQztRQUN4QyxJQUFJLFNBQVMsQ0FBQyxZQUFZLElBQUksU0FBUyxDQUFDLHNCQUFzQjtZQUMxRCxTQUFTLENBQUMsb0JBQW9CLElBQUksQ0FBQyxTQUFTLENBQUMsdUJBQXVCLEVBQUUsQ0FBQztZQUN2RSxPQUFPLFFBQVEsQ0FBQztRQUNwQixDQUFDO0lBQ0wsQ0FBQztJQUFDLE9BQU8sR0FBRyxFQUFFLENBQUM7UUFDWCxPQUFPLENBQUMsS0FBSyxDQUFDLDZDQUE2QyxLQUFLLE1BQU0sR0FBRyxFQUFFLENBQUMsQ0FBQztJQUNqRixDQUFDO0lBRUQsSUFBSSxJQUFBLG1CQUFXLEVBQUMsS0FBSyxDQUFDLEVBQUUsQ0FBQztRQUNyQixPQUFPLFVBQVUsQ0FBQztJQUN0QixDQUFDO0lBRUQsaUJBQWlCO0lBQ2pCLE1BQU0sZUFBZSxHQUFHO1FBQ3BCLGdCQUFRLENBQUMsT0FBTztRQUNoQixnQkFBUSxDQUFDLFdBQVc7UUFDcEIsZ0JBQVEsQ0FBQyxRQUFRO0tBQ3BCLENBQUM7SUFDRixJQUFJLENBQUM7UUFDRCxLQUFLLE1BQU0sY0FBYyxJQUFJLGVBQWUsRUFBRSxDQUFDO1lBQzNDLE1BQU0sTUFBTSxHQUFHLGNBQWMsQ0FBQyxLQUFLLEVBQUUsUUFBUSxFQUFFLElBQUksRUFBRSxDQUFDLENBQUM7WUFDdkQsSUFBSSxNQUFNLElBQUksTUFBTSxDQUFDLE9BQU8sRUFBRSxDQUFDO2dCQUMzQixPQUFPLFdBQVcsQ0FBQztZQUN2QixDQUFDO1FBQ0wsQ0FBQztJQUNMLENBQUM7SUFBQyxPQUFPLEdBQUcsRUFBRSxDQUFDO1FBQ1gsT0FBTyxDQUFDLEtBQUssQ0FBQyxxQ0FBcUMsS0FBSyxhQUFhLElBQUksQ0FBQyxTQUFTLENBQUMsZUFBZSxDQUFDLEtBQUssR0FBRyxFQUFFLENBQUMsQ0FBQztJQUNwSCxDQUFDO0lBRUQsSUFBSSxJQUFBLGlCQUFTLEVBQUMsS0FBSyxDQUFDLEVBQUUsQ0FBQztRQUNuQixPQUFPLFFBQVEsQ0FBQztJQUNwQixDQUFDO0lBRUQsT0FBTyxDQUFDLEtBQUssQ0FBQywrQkFBK0IsS0FBSyxVQUFVLElBQUksQ0FBQyxTQUFTLENBQUMsY0FBYyxDQUFDLEtBQUssQ0FBQyxDQUFDLEVBQUUsQ0FBQyxDQUFDO0lBRXJHLE9BQU8sU0FBUyxDQUFDO0FBQ3JCLENBQUM7QUFFRCxTQUFTLGNBQWMsQ0FBQyxLQUFVO0lBQzlCLE1BQU0sWUFBWSxHQUFHLElBQUEscUJBQWEsRUFBQyxLQUFLLENBQUMsQ0FBQztJQUMxQyxNQUFNLHNCQUFzQixHQUFHLE1BQU0sQ0FBQyxTQUFTLENBQUMsUUFBUSxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUMsS0FBSyxpQkFBaUIsQ0FBQztJQUMzRixNQUFNLGtCQUFrQixHQUFHLE1BQU0sQ0FBQyxjQUFjLENBQUMsS0FBSyxDQUFDLENBQUMsV0FBVyxDQUFDO0lBQ3BFLE1BQU0sb0JBQW9CLEdBQUcsT0FBTyxrQkFBa0IsS0FBSyxVQUFVLENBQUM7SUFDdEUsTUFBTSx1QkFBdUIsR0FBRyxRQUFRLENBQUMsU0FBUyxDQUFDLFFBQVEsQ0FBQyxJQUFJLENBQUMsa0JBQWtCLENBQUMsS0FBSyxRQUFRLENBQUMsU0FBUyxDQUFDLFFBQVEsQ0FBQyxJQUFJLENBQUMsTUFBTSxDQUFDLENBQUM7SUFDbEksT0FBTztRQUNILFlBQVk7UUFDWixzQkFBc0I7UUFDdEIsa0JBQWtCO1FBQ2xCLG9CQUFvQjtRQUNwQix1QkFBdUI7S0FDMUIsQ0FBQztBQUNOLENBQUM7QUFFRDs7O0dBR0c7QUFDSCxTQUFnQixTQUFTLENBQUMsS0FBYztJQUN0QyxJQUFJLE9BQU8sS0FBSyxLQUFLLFNBQVMsRUFBRSxDQUFDO1FBQy9CLE9BQU8sS0FBSyxDQUFDO0lBQ2YsQ0FBQztJQUNELElBQUksT0FBTyxLQUFLLEtBQUssUUFBUSxFQUFFLENBQUM7UUFDOUIsT0FBTyxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsS0FBSyxDQUFDLElBQUksS0FBSyxLQUFLLENBQUMsQ0FBQztJQUM3QyxDQUFDO0lBQ0QsTUFBTSxVQUFVLEdBQUcsTUFBTSxDQUFDLEtBQUssSUFBSSxFQUFFLENBQUMsQ0FBQyxJQUFJLEVBQUUsQ0FBQyxXQUFXLEVBQUUsQ0FBQztJQUM1RCxNQUFNLFVBQVUsR0FBRyxDQUFDLE1BQU0sRUFBRSxHQUFHLEVBQUUsR0FBRyxFQUFFLEtBQUssRUFBRSxHQUFHLEVBQUUsSUFBSSxFQUFFLFFBQVEsRUFBRSxTQUFTLENBQUMsQ0FBQztJQUM3RSxPQUFPLFVBQVUsQ0FBQyxRQUFRLENBQUMsVUFBVSxDQUFDLENBQUM7QUFDekMsQ0FBQztBQWFELHFFQUFxRTtBQUNyRSxvR0FBb0c7QUFDcEcsbUdBQW1HO0FBQ25HLDBFQUEwRTtBQUMxRSxNQUFNO0FBQ04sb0dBQW9HO0FBQ3BHLDJFQUEyRTtBQUMzRSxNQUFNIn0=

package/dist/src/config/names/naming-helpers.d.ts

@@ -0,0 +1,71 @@
+/**
+ * A lineage path is an ordered list of keys (string|number) describing a path lineage for
+ * different domains of form configuration.
+ * A string key is a property name or array index number as a string, a number key is an array index.
+ */
+export type LineagePath = (string | number)[];
+/**
+ * A collection of lineage paths that describe different relationships.
+ */
+export interface LineagePaths {
+    /**
+     * The path to the item in the form config.
+     */
+    formConfig: LineagePath;
+    /**
+     * The path to the item in the form data model.
+     */
+    dataModel: LineagePath;
+    /**
+     * The path to the item in the angular control hierarchy.
+     */
+    angularComponents: LineagePath;
+    /**
+     * The JSONPointer to the angular control.
+     */
+    angularComponentsJsonPointer?: string;
+    /**
+     * The path to the item in the layout hierarchy.
+     * Uses the component name with a "-layout" suffix.
+     */
+    layout: LineagePath;
+    /**
+     * The JSONPointer to the layout item.
+     */
+    layoutJsonPointer?: string;
+}
+/**
+ * Allow providing a partial lineage paths object.
+ * This is for adding to an existing lineage path.
+ */
+export interface LineagePathsPartial {
+    formConfig?: LineagePath;
+    dataModel?: LineagePath;
+    angularComponents?: LineagePath;
+    layout?: LineagePath;
+}
+/**
+ * Build the lineage paths from a base item, and add the entries in `more` as relative
+ * parts at the end of each lineage path. Undefined inputs default to empty arrays.
+ * This was previously an instance method of FormService.
+ */
+export declare function buildLineagePaths(base?: LineagePaths, more?: LineagePathsPartial): LineagePaths;
+/**
+ * Get a JSON Pointer string from an array of path segments.
+ *
+ * @param paths
+ * @returns JSON Pointer string
+ */
+export declare function getJSONPointerByArrayPaths(paths: (string | number)[]): string;
+/**
+ * Retrieve any object property using a JSON Pointer or an array of path segments.
+ *
+ * @param obj
+ * @param pointer
+ * @returns JSON Pointer reference: {key: 'key', val: 'object value at key', obj: 'context object, 1 level up from key'}
+ */
+export declare function getObjectWithJsonPointer(obj: any, pointer: string | string[]): any;
+/**
+ * Retrieve the last segment of a JSONPointer string
+ */
+export declare function getLastSegmentFromJSONPointer(pointer: string): string;

package/dist/src/config/names/naming-helpers.js

@@ -0,0 +1,72 @@
+"use strict";
+// Copyright (c) 2025 Queensland Cyber Infrastructure Foundation (http://www.qcif.edu.au/)
+//
+// GNU GENERAL PUBLIC LICENSE
+//    Version 2, June 1991
+//
+// This program is free software; you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation; either version 2 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License along
+// with this program; if not, write to the Free Software Foundation, Inc.,
+// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildLineagePaths = buildLineagePaths;
+exports.getJSONPointerByArrayPaths = getJSONPointerByArrayPaths;
+exports.getObjectWithJsonPointer = getObjectWithJsonPointer;
+exports.getLastSegmentFromJSONPointer = getLastSegmentFromJSONPointer;
+const json_pointer_1 = require("@jsonjoy.com/json-pointer");
+/**
+ * Build the lineage paths from a base item, and add the entries in `more` as relative
+ * parts at the end of each lineage path. Undefined inputs default to empty arrays.
+ * This was previously an instance method of FormService.
+ */
+function buildLineagePaths(base, more) {
+    const lineagePaths = {
+        formConfig: [...(base?.formConfig ?? []), ...(more?.formConfig ?? [])],
+        dataModel: [...(base?.dataModel ?? []), ...(more?.dataModel ?? [])],
+        angularComponents: [...(base?.angularComponents ?? []), ...(more?.angularComponents ?? [])],
+        layout: [...(base?.layout ?? []), ...(more?.layout ?? [])],
+    };
+    lineagePaths.angularComponentsJsonPointer = getJSONPointerByArrayPaths(lineagePaths.angularComponents);
+    lineagePaths.layoutJsonPointer = getJSONPointerByArrayPaths(lineagePaths.layout);
+    return lineagePaths;
+}
+/**
+ * Get a JSON Pointer string from an array of path segments.
+ *
+ * @param paths
+ * @returns JSON Pointer string
+ */
+function getJSONPointerByArrayPaths(paths) {
+    return (0, json_pointer_1.formatJsonPointer)(paths);
+}
+/**
+ * Retrieve any object property using a JSON Pointer or an array of path segments.
+ *
+ * @param obj
+ * @param pointer
+ * @returns JSON Pointer reference: {key: 'key', val: 'object value at key', obj: 'context object, 1 level up from key'}
+ */
+function getObjectWithJsonPointer(obj, pointer) {
+    if (Array.isArray(pointer)) {
+        return (0, json_pointer_1.find)(obj, pointer);
+    }
+    // Documentation has the order of the parameters reversed compared to the type definition.
+    return (0, json_pointer_1.findByPointer)(pointer, obj);
+}
+/**
+ * Retrieve the last segment of a JSONPointer string
+ */
+function getLastSegmentFromJSONPointer(pointer) {
+    const segments = pointer.split('/');
+    return segments[segments.length - 1];
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibmFtaW5nLWhlbHBlcnMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvY29uZmlnL25hbWVzL25hbWluZy1oZWxwZXJzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQSwwRkFBMEY7QUFDMUYsRUFBRTtBQUNGLDZCQUE2QjtBQUM3QiwwQkFBMEI7QUFDMUIsRUFBRTtBQUNGLHVFQUF1RTtBQUN2RSx1RUFBdUU7QUFDdkUsb0VBQW9FO0FBQ3BFLHNDQUFzQztBQUN0QyxFQUFFO0FBQ0Ysa0VBQWtFO0FBQ2xFLGlFQUFpRTtBQUNqRSxnRUFBZ0U7QUFDaEUsK0NBQStDO0FBQy9DLEVBQUU7QUFDRiwwRUFBMEU7QUFDMUUsMEVBQTBFO0FBQzFFLDhEQUE4RDs7QUE2RDlELDhDQVVDO0FBU0QsZ0VBRUM7QUFTRCw0REFNQztBQUtELHNFQUdDO0FBdkdELDREQUFtRjtBQXNEbkY7Ozs7R0FJRztBQUNILFNBQWdCLGlCQUFpQixDQUFDLElBQW1CLEVBQUUsSUFBMEI7SUFDN0UsTUFBTSxZQUFZLEdBQWlCO1FBQy9CLFVBQVUsRUFBRSxDQUFDLEdBQUcsQ0FBQyxJQUFJLEVBQUUsVUFBVSxJQUFJLEVBQUUsQ0FBQyxFQUFFLEdBQUcsQ0FBQyxJQUFJLEVBQUUsVUFBVSxJQUFJLEVBQUUsQ0FBQyxDQUFDO1FBQ3RFLFNBQVMsRUFBRSxDQUFDLEdBQUcsQ0FBQyxJQUFJLEVBQUUsU0FBUyxJQUFJLEVBQUUsQ0FBQyxFQUFFLEdBQUcsQ0FBQyxJQUFJLEVBQUUsU0FBUyxJQUFJLEVBQUUsQ0FBQyxDQUFDO1FBQ25FLGlCQUFpQixFQUFFLENBQUMsR0FBRyxDQUFDLElBQUksRUFBRSxpQkFBaUIsSUFBSSxFQUFFLENBQUMsRUFBRSxHQUFHLENBQUMsSUFBSSxFQUFFLGlCQUFpQixJQUFJLEVBQUUsQ0FBQyxDQUFDO1FBQzNGLE1BQU0sRUFBRSxDQUFDLEdBQUcsQ0FBQyxJQUFJLEVBQUUsTUFBTSxJQUFJLEVBQUUsQ0FBQyxFQUFFLEdBQUcsQ0FBQyxJQUFJLEVBQUUsTUFBTSxJQUFJLEVBQUUsQ0FBQyxDQUFDO0tBQzdELENBQUM7SUFDRixZQUFZLENBQUMsNEJBQTRCLEdBQUcsMEJBQTBCLENBQUMsWUFBWSxDQUFDLGlCQUFpQixDQUFDLENBQUM7SUFDdkcsWUFBWSxDQUFDLGlCQUFpQixHQUFHLDBCQUEwQixDQUFDLFlBQVksQ0FBQyxNQUFNLENBQUMsQ0FBQztJQUNqRixPQUFPLFlBQVksQ0FBQztBQUN4QixDQUFDO0FBRUQ7Ozs7O0dBS0c7QUFFSCxTQUFnQiwwQkFBMEIsQ0FBQyxLQUEwQjtJQUNqRSxPQUFPLElBQUEsZ0NBQWlCLEVBQUMsS0FBSyxDQUFDLENBQUM7QUFDcEMsQ0FBQztBQUVEOzs7Ozs7R0FNRztBQUNILFNBQWdCLHdCQUF3QixDQUFDLEdBQVEsRUFBRSxPQUEwQjtJQUN6RSxJQUFJLEtBQUssQ0FBQyxPQUFPLENBQUMsT0FBTyxDQUFDLEVBQUUsQ0FBQztRQUN6QixPQUFPLElBQUEsbUJBQUksRUFBQyxHQUFHLEVBQUUsT0FBTyxDQUFDLENBQUM7SUFDOUIsQ0FBQztJQUNELDBGQUEwRjtJQUMxRixPQUFPLElBQUEsNEJBQWEsRUFBQyxPQUFPLEVBQUUsR0FBRyxDQUFDLENBQUM7QUFDdkMsQ0FBQztBQUVEOztHQUVHO0FBQ0gsU0FBZ0IsNkJBQTZCLENBQUMsT0FBZTtJQUN6RCxNQUFNLFFBQVEsR0FBRyxPQUFPLENBQUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxDQUFDO0lBQ3BDLE9BQU8sUUFBUSxDQUFDLFFBQVEsQ0FBQyxNQUFNLEdBQUcsQ0FBQyxDQUFDLENBQUM7QUFDekMsQ0FBQyJ9

package/dist/src/config/names/query-helpers.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Helpers for querying components using JSONata.
+ *
+ * Note: these functions are intended to be generic and reusable across contexts, i.e. server and client-side. Further specialisation may be required to be more useful in the specific context.
+ */
+import { LineagePaths } from "./naming-helpers";
+/**
+ * Entry representing a property in the JSONata query source tree.  This must have no circular references, see: https://docs.jsonata.org/next/embedding-extending#expressionevaluateinput-bindings-callback
+ */
+export interface JSONataQuerySourceProperty {
+    name: string;
+    lineagePaths?: LineagePaths;
+    jsonPointer?: string;
+    children?: JSONataQuerySourceProperty[];
+}
+export type FormRequestParamValue = string | string[] | true;
+export type FormRequestParamsMap = Readonly<Record<string, FormRequestParamValue>>;
+export interface JSONataQueryRuntimeContext {
+    requestParams?: FormRequestParamsMap;
+    [key: string]: unknown;
+}
+export interface JSONataQuerySource {
+    queryOrigSource: unknown;
+    querySource: JSONataQuerySourceProperty[];
+    jsonPointerSource: unknown;
+    runtimeContext?: JSONataQueryRuntimeContext;
+}
+/**
+ * Performs a deep copy of an object, removing circular references.
+ *
+ * TODO: Consider trimming more properties that are not needed querying.
+ *
+ * @param obj
+ * @returns
+ */
+export declare function decycleObjectForJSONata(obj: any): any;
+/**
+ * Simple query function for string inputs. Not meant for integration with the form app, which requires pre-compilation.
+ *
+ * @param querySource
+ * @param query
+ */
+export declare function queryJSONata(querySource: JSONataQuerySource, query: string): Promise<any>;

package/dist/src/config/names/query-helpers.js

@@ -0,0 +1,64 @@
+"use strict";
+// Copyright (c) 2025 Queensland Cyber Infrastructure Foundation (http://www.qcif.edu.au/)
+//
+// GNU GENERAL PUBLIC LICENSE
+//    Version 2, June 1991
+//
+// This program is free software; you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation; either version 2 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License along
+// with this program; if not, write to the Free Software Foundation, Inc.,
+// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.decycleObjectForJSONata = decycleObjectForJSONata;
+exports.queryJSONata = queryJSONata;
+const jsonata_1 = __importDefault(require("jsonata"));
+/**
+ * Performs a deep copy of an object, removing circular references.
+ *
+ * TODO: Consider trimming more properties that are not needed querying.
+ *
+ * @param obj
+ * @returns
+ */
+function decycleObjectForJSONata(obj) {
+    const cache = new Set();
+    return JSON.parse(JSON.stringify(obj, (key, value) => {
+        if (typeof value === 'function') {
+            return; // Remove functions
+        }
+        if (typeof value === 'object' && value !== null) {
+            if (cache.has(value)) {
+                // Circular reference found, discard key
+                return;
+            }
+            cache.add(value);
+        }
+        return value;
+    }));
+}
+/**
+ * Simple query function for string inputs. Not meant for integration with the form app, which requires pre-compilation.
+ *
+ * @param querySource
+ * @param query
+ */
+async function queryJSONata(querySource, query) {
+    // `.querySource` should already have no circular references, but just in case...
+    const queryDoc = decycleObjectForJSONata(querySource.querySource);
+    const expression = (0, jsonata_1.default)(query);
+    const result = await expression.evaluate(queryDoc);
+    return result;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicXVlcnktaGVscGVycy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9jb25maWcvbmFtZXMvcXVlcnktaGVscGVycy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsMEZBQTBGO0FBQzFGLEVBQUU7QUFDRiw2QkFBNkI7QUFDN0IsMEJBQTBCO0FBQzFCLEVBQUU7QUFDRix1RUFBdUU7QUFDdkUsdUVBQXVFO0FBQ3ZFLG9FQUFvRTtBQUNwRSxzQ0FBc0M7QUFDdEMsRUFBRTtBQUNGLGtFQUFrRTtBQUNsRSxpRUFBaUU7QUFDakUsZ0VBQWdFO0FBQ2hFLCtDQUErQztBQUMvQyxFQUFFO0FBQ0YsMEVBQTBFO0FBQzFFLDBFQUEwRTtBQUMxRSw4REFBOEQ7Ozs7O0FBZ0Q5RCwwREFlQztBQVFELG9DQU1DO0FBbkVELHNEQUE4QjtBQThCOUI7Ozs7Ozs7R0FPRztBQUNILFNBQWdCLHVCQUF1QixDQUFDLEdBQVE7SUFDOUMsTUFBTSxLQUFLLEdBQUcsSUFBSSxHQUFHLEVBQUUsQ0FBQztJQUN4QixPQUFPLElBQUksQ0FBQyxLQUFLLENBQUMsSUFBSSxDQUFDLFNBQVMsQ0FBQyxHQUFHLEVBQUUsQ0FBQyxHQUFHLEVBQUUsS0FBSyxFQUFFLEVBQUU7UUFDbkQsSUFBSSxPQUFPLEtBQUssS0FBSyxVQUFVLEVBQUUsQ0FBQztZQUNoQyxPQUFPLENBQUMsbUJBQW1CO1FBQzdCLENBQUM7UUFDRCxJQUFJLE9BQU8sS0FBSyxLQUFLLFFBQVEsSUFBSSxLQUFLLEtBQUssSUFBSSxFQUFFLENBQUM7WUFDaEQsSUFBSSxLQUFLLENBQUMsR0FBRyxDQUFDLEtBQUssQ0FBQyxFQUFFLENBQUM7Z0JBQ3JCLHdDQUF3QztnQkFDeEMsT0FBTztZQUNULENBQUM7WUFDRCxLQUFLLENBQUMsR0FBRyxDQUFDLEtBQUssQ0FBQyxDQUFDO1FBQ25CLENBQUM7UUFDRCxPQUFPLEtBQUssQ0FBQztJQUNmLENBQUMsQ0FBQyxDQUFDLENBQUM7QUFDTixDQUFDO0FBRUQ7Ozs7O0dBS0c7QUFDSSxLQUFLLFVBQVUsWUFBWSxDQUFDLFdBQStCLEVBQUUsS0FBYTtJQUMvRSxpRkFBaUY7SUFDakYsTUFBTSxRQUFRLEdBQUcsdUJBQXVCLENBQUMsV0FBVyxDQUFDLFdBQVcsQ0FBQyxDQUFDO0lBQ2xFLE1BQU0sVUFBVSxHQUFHLElBQUEsaUJBQU8sRUFBQyxLQUFLLENBQUMsQ0FBQztJQUNsQyxNQUFNLE1BQU0sR0FBRyxNQUFNLFVBQVUsQ0FBQyxRQUFRLENBQUMsUUFBUSxDQUFDLENBQUM7SUFDbkQsT0FBTyxNQUFNLENBQUM7QUFDaEIsQ0FBQyJ9