@aemforms/af-core 0.15.0

package/lib/types/Model.d.ts

@@ -0,0 +1,352 @@
+/**
+ * Defines generic interface's for form runtime model
+ */
+import { ConstraintsJson, ContainerJson, FieldJson, FieldsetJson, FormJson, Label, MetaDataJson } from './Json';
+import RuleEngine from '../rules/RuleEngine';
+import EventQueue from '../controller/EventQueue';
+import DataGroup from '../data/DataGroup';
+import { Logger } from '../Form';
+/**
+ * Generic Scriptable field interface. All non-transparent fields which support rule/events
+ * should implement this interface
+ */
+export interface ScriptableField {
+    /**
+     * Rules that modify the property of the object dynamically. The rules are evaluated whenever the dependency changes.
+     */
+    rules?: {
+        [key: string]: string;
+    };
+    /**
+     * Events is a dictionary of eventName to the actions to perform.
+     */
+    events?: {
+        [key: string]: string;
+    };
+    /**
+     * Instance of rule engine
+     * @private
+     */
+    ruleEngine: RuleEngine;
+}
+/**
+ * Generic interface which defines {@link State | form object state}.
+ * @typeparam T type of the form object (for example, {@link FieldJson | form field}
+ */
+interface WithState<T> {
+    /**
+     * {@link State | state} of the form object
+     */
+    getState: () => State<T>;
+}
+/** Generic type for a form object state */
+export declare type State<T> = T extends ContainerJson ? T & {
+    id: string;
+    items: Array<State<FieldJson | ContainerJson>>;
+} : T & {
+    id: string;
+    ':type': string;
+};
+/**
+ * @private
+ */
+export declare type Subscription = {
+    unsubscribe(): void;
+};
+/**
+ * Generic Action/Event interface.
+ * Defines common properties that each action/event should have
+ */
+export interface Action {
+    /**
+     * Name of the event.
+     */
+    type: string;
+    /**
+     * Event payload as defined by the event.
+     */
+    payload: any;
+    /**
+     * Event metadata.
+     */
+    metadata: any;
+    /**
+     * Is the event custom
+     */
+    readonly isCustomEvent: boolean;
+    /**
+     * The field element on which the event is triggered.
+     */
+    readonly target: FormModel | FieldModel | FieldsetModel;
+    /**
+     * Original event. If the event is dispatched, this refers the original event
+     */
+    readonly originalAction?: Action;
+}
+/**
+ * @private
+ */
+export declare type callbackFn = (action: Action) => void;
+/**
+ * @private
+ */
+export interface WithController {
+    /**
+     * @param callback
+     * @param eventName
+     * @private
+     */
+    subscribe(callback: callbackFn, eventName?: string): Subscription;
+    /**
+     * @param action
+     * @private
+     */
+    dispatch(action: Action): void;
+}
+/**
+ * Generic base model interface.
+ * Defines common properties that each form field should have
+ */
+export interface BaseModel extends ConstraintsJson, WithController {
+    /**
+     * Name of the form field.
+     */
+    readonly name?: string;
+    /**
+     * To map the field’s value to a property in the data model.
+     */
+    readonly dataRef?: string | null;
+    /**
+     * Unique id of the form field.
+     */
+    readonly id: string;
+    /**
+     * The index of the Field within its parent.
+     */
+    readonly index: number;
+    /**
+     * Label to be used for the field.
+     */
+    label?: Label;
+    /**
+     * Extra description to be shown to the user to aid in form filling experience. It can be rich text.
+     */
+    description?: string;
+    /**
+     * Whether the field should be readOnly to end user or not.
+     */
+    readOnly?: boolean;
+    /**
+     * Whether the field is enabled and takes part in rules, events etc.
+     */
+    enabled?: boolean;
+    /**
+     * Whether the field should be visible to author or not.
+     */
+    visible?: boolean;
+    /**
+     * The placeholder to show on the widget.
+     */
+    placeholder?: string;
+    /**
+     * The current validation state of the Field. The property is always computed after merging the Data Model with the Form
+     */
+    valid?: boolean;
+    /**
+     * Custom widget type show to the user for capturing the data.
+     */
+    readonly ':type': string;
+    /**
+     * Type of field to capture the user data.
+     */
+    readonly 'fieldType': string;
+    /**
+     * Custom properties of the form field.
+     */
+    properties: {
+        [key: string]: any;
+    };
+    /**
+     * Whether the form field is container or not
+     */
+    readonly isContainer: boolean;
+    /**
+     * The Parent Panel of the Field/Panel.
+     */
+    readonly parent: ContainerModel | null;
+    /**
+     * Array containing Fields or Panels.
+     */
+    readonly items?: Array<FieldsetModel | FieldModel>;
+    /**
+     * The current value of the Field. The property is serialized in the Data Model.
+     */
+    value: any;
+    /**
+     * Default value of the Field.
+     */
+    readonly default?: any;
+    /**
+     * Validates the given form field
+     * @returns list of {@link ValidationError | validation errors}
+     */
+    validate(): Array<ValidationError>;
+    /**
+     * Imports data to the form field
+     *  @private
+     */
+    importData(a?: DataGroup): any;
+    /**
+     * @private
+     */
+    getRuleNode(): any;
+    /**
+     * @private
+     */
+    ruleNodeReference(): any;
+    /**
+     * @private
+     */
+    _initialize(): any;
+}
+/**
+ * Generic field model interface.
+ * Defines properties that each form field should have
+ */
+export interface FieldModel extends BaseModel, ScriptableField, WithState<FieldJson> {
+    /**
+     * Parent of the current field
+     */
+    parent: ContainerModel;
+}
+/**
+ * Defines form meta data properties
+ */
+export interface FormMetaDataModel {
+    /**
+     * Version of the adaptive form specification
+     */
+    readonly version: string;
+    /**
+     * Version of the rule grammar
+     */
+    readonly grammar: string;
+    /**
+     * Form locale
+     */
+    readonly locale: string;
+}
+/**
+ * Generic container model interface.
+ * Defines properties that each container should have
+ */
+export interface ContainerModel extends BaseModel, ScriptableField {
+    /**
+     * Defines the children/items of the container
+     */
+    items: Array<FieldsetModel | FieldModel>;
+    /**
+     * Defines the parent of the container
+     */
+    parent: ContainerModel;
+    /**
+     * Returns the index of the {@link FieldModel | child item} or the {@link FieldsetModel | child container}
+     * @param f child item
+     * @returns `index` of the item
+     */
+    indexOf(f: FieldModel | FieldsetModel): number;
+}
+/**
+ * Generic field set model interface.
+ * Defines properties that each field set should have
+ */
+export interface FieldsetModel extends ContainerModel, WithState<FieldsetJson> {
+    type?: 'array' | 'object';
+}
+/**
+ * Defines the interface for form model
+ */
+export interface FormModel extends ContainerModel, WithState<FormJson> {
+    /**
+     * Id of the form.
+     */
+    readonly id: string;
+    /**
+     * Form data
+     */
+    readonly data?: any;
+    /**
+     * Form metadata
+     */
+    readonly metadata?: MetaDataJson;
+    /**
+     * Form title.
+     */
+    readonly title: string;
+    readonly logger: Logger;
+    /**
+     * Imports the given form data
+     * @param data form data
+     */
+    importData(data: any): any;
+    /**
+     * Exports the form data
+     */
+    exportData(): any;
+    /**
+     * Get form element model based on the id of the form element
+     * @param id id of the form element
+     */
+    getElement(id: string): FieldModel | FormModel | FieldsetModel;
+    /**
+     * @private
+     */
+    getUniqueId(): string;
+    /**
+     * @private
+     */
+    getEventQueue(): EventQueue;
+}
+/**
+ * Defines file object interface.
+ */
+export interface IFileObject {
+    /**
+     * Name of the file
+     */
+    name: string;
+    /**
+     * Media type of the file data
+     */
+    mediaType: string;
+    /**
+     * Data of the file attachment. It can be uri or any file interface specific to channel (in web, it is file object).
+     */
+    data?: any;
+    /**
+     * Size of the file binary as per iec specification.
+     */
+    size?: number;
+}
+/**
+ * Defines Validation Error interface.
+ */
+export interface IValidationError {
+    /**
+     * {@link FieldModel.id | name} of the field
+     */
+    fieldName: string;
+    /**
+     * List of error messages
+     */
+    errorMessages: Array<string>;
+}
+/**
+ * Implementation of {@link IValidationError | Validation Error} interface
+ */
+export declare class ValidationError implements IValidationError {
+    fieldName: string;
+    errorMessages: Array<string>;
+    constructor(fieldName?: string, errorMessages?: Array<any>);
+}
+export {};

package/lib/types/Model.js

@@ -0,0 +1,20 @@
+"use strict";
+/*
+ * Copyright 2022 Adobe, Inc.
+ *
+ * Your access and use of this software is governed by the Adobe Customer Feedback Program Terms and Conditions or other Beta License Agreement signed by your employer and Adobe, Inc.. This software is NOT open source and may not be used without one of the foregoing licenses. Even with a foregoing license, your access and use of this file is limited to the earlier of (a) 180 days, (b) general availability of the product(s) which utilize this software (i.e. AEM Forms), (c) January 1, 2023, (d) Adobe providing notice to you that you may no longer use the software or that your beta trial has otherwise ended.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL ADOBE NOR ITS THIRD PARTY PROVIDERS AND PARTNERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ValidationError = void 0;
+/**
+ * Implementation of {@link IValidationError | Validation Error} interface
+ */
+class ValidationError {
+    constructor(fieldName = '', errorMessages = []) {
+        this.errorMessages = errorMessages;
+        this.fieldName = fieldName;
+    }
+}
+exports.ValidationError = ValidationError;

package/lib/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from './Json';
+export * from './Model';

package/lib/types/index.js

@@ -0,0 +1,25 @@
+"use strict";
+/*
+ * Copyright 2022 Adobe, Inc.
+ *
+ * Your access and use of this software is governed by the Adobe Customer Feedback Program Terms and Conditions or other Beta License Agreement signed by your employer and Adobe, Inc.. This software is NOT open source and may not be used without one of the foregoing licenses. Even with a foregoing license, your access and use of this file is limited to the earlier of (a) 180 days, (b) general availability of the product(s) which utilize this software (i.e. AEM Forms), (c) January 1, 2023, (d) Adobe providing notice to you that you may no longer use the software or that your beta trial has otherwise ended.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL ADOBE NOR ITS THIRD PARTY PROVIDERS AND PARTNERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./Json"), exports);
+__exportStar(require("./Model"), exports);

package/lib/utils/DataRefParser.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Defines utilities to parse form data
+ */
+import DataGroup from '../data/DataGroup';
+import DataValue from '../data/DataValue';
+declare type TokenType = string;
+export declare const TOK_GLOBAL: TokenType;
+export declare type Token = {
+    type: TokenType;
+    value: string | number;
+    start: number;
+};
+export declare const identifier: (value: string, start: number) => {
+    type: string;
+    value: string;
+    start: number;
+};
+export declare const bracket: (value: number, start: number) => {
+    type: string;
+    value: number;
+    start: number;
+};
+export declare const global$: () => {
+    type: string;
+    start: number;
+    value: string;
+};
+export declare const tokenize: (stream: string) => Token[];
+export declare const resolveData: <T extends DataValue>(data: DataGroup, input: Token[] | string, create?: T | undefined) => DataGroup | DataValue | undefined;
+export {};

package/lib/utils/DataRefParser.js

@@ -0,0 +1,249 @@
+"use strict";
+/*
+ * Copyright 2022 Adobe, Inc.
+ *
+ * Your access and use of this software is governed by the Adobe Customer Feedback Program Terms and Conditions or other Beta License Agreement signed by your employer and Adobe, Inc.. This software is NOT open source and may not be used without one of the foregoing licenses. Even with a foregoing license, your access and use of this file is limited to the earlier of (a) 180 days, (b) general availability of the product(s) which utilize this software (i.e. AEM Forms), (c) January 1, 2023, (d) Adobe providing notice to you that you may no longer use the software or that your beta trial has otherwise ended.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL ADOBE NOR ITS THIRD PARTY PROVIDERS AND PARTNERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveData = exports.tokenize = exports.global$ = exports.bracket = exports.identifier = exports.TOK_GLOBAL = void 0;
+/**
+ * Defines utilities to parse form data
+ */
+const DataGroup_1 = __importDefault(require("../data/DataGroup"));
+const TOK_DOT = 'DOT';
+const TOK_IDENTIFIER = 'Identifier';
+exports.TOK_GLOBAL = 'Global';
+const TOK_BRACKET = 'bracket';
+const TOK_NUMBER = 'Number';
+const globalStartToken = '$';
+const identifier = (value, start) => {
+    return {
+        type: TOK_IDENTIFIER,
+        value,
+        start
+    };
+};
+exports.identifier = identifier;
+const bracket = (value, start) => {
+    return {
+        type: TOK_BRACKET,
+        value,
+        start
+    };
+};
+exports.bracket = bracket;
+const global$ = () => {
+    return {
+        type: exports.TOK_GLOBAL,
+        start: 0,
+        value: globalStartToken
+    };
+};
+exports.global$ = global$;
+const isAlphaNum = function (ch) {
+    return (ch >= 'a' && ch <= 'z')
+        || (ch >= 'A' && ch <= 'Z')
+        || (ch >= '0' && ch <= '9')
+        || ch === '_';
+};
+const isGlobal = (prev, stream, pos) => {
+    // global tokens occur only at the start of an expression
+    return prev === null && stream[pos] === globalStartToken;
+};
+const isIdentifier = (stream, pos) => {
+    const ch = stream[pos];
+    // $ is special -- it's allowed to be part of an identifier if it's the first character
+    if (ch === '$') {
+        return stream.length > pos && isAlphaNum(stream[pos + 1]);
+    }
+    // return whether character 'isAlpha'
+    return (ch >= 'a' && ch <= 'z')
+        || (ch >= 'A' && ch <= 'Z')
+        || ch === '_';
+};
+const isNum = (ch) => {
+    return (ch >= '0' && ch <= '9');
+};
+class Tokenizer {
+    constructor(stream) {
+        this.stream = stream;
+        this._tokens = [];
+        this._result_tokens = [];
+        this._current = 0;
+    }
+    _consumeGlobal() {
+        this._current += 1;
+        return (0, exports.global$)();
+    }
+    _consumeUnquotedIdentifier(stream) {
+        const start = this._current;
+        this._current += 1;
+        while (this._current < stream.length && isAlphaNum(stream[this._current])) {
+            this._current += 1;
+        }
+        return (0, exports.identifier)(stream.slice(start, this._current), start);
+    }
+    _consumeQuotedIdentifier(stream) {
+        const start = this._current;
+        this._current += 1;
+        const maxLength = stream.length;
+        while (stream[this._current] !== '"' && this._current < maxLength) {
+            // You can escape a double quote and you can escape an escape.
+            let current = this._current;
+            if (stream[current] === '\\' && (stream[current + 1] === '\\'
+                || stream[current + 1] === '"')) {
+                current += 2;
+            }
+            else {
+                current += 1;
+            }
+            this._current = current;
+        }
+        this._current += 1;
+        return (0, exports.identifier)(JSON.parse(stream.slice(start, this._current)), start);
+    }
+    _consumeNumber(stream) {
+        const start = this._current;
+        this._current += 1;
+        const maxLength = stream.length;
+        while (isNum(stream[this._current]) && this._current < maxLength) {
+            this._current += 1;
+        }
+        const n = stream.slice(start, this._current);
+        const value = parseInt(n, 10);
+        return { type: TOK_NUMBER, value, start };
+    }
+    _consumeBracket(stream) {
+        const start = this._current;
+        this._current += 1;
+        let value;
+        if (isNum(stream[this._current])) {
+            value = this._consumeNumber(stream).value;
+        }
+        else {
+            throw new Error(`unexpected exception at position ${this._current}. Must be a character`);
+        }
+        if (this._current < this.stream.length && stream[this._current] !== ']') {
+            throw new Error(`unexpected exception at position ${this._current}. Must be a character`);
+        }
+        this._current++;
+        return (0, exports.bracket)(value, start);
+    }
+    tokenize() {
+        const stream = this.stream;
+        while (this._current < stream.length) {
+            const prev = this._tokens.length ? this._tokens.slice(-1)[0] : null;
+            if (isGlobal(prev, stream, this._current)) {
+                const token = this._consumeGlobal();
+                this._tokens.push(token);
+                this._result_tokens.push(token);
+            }
+            else if (isIdentifier(stream, this._current)) {
+                const token = this._consumeUnquotedIdentifier(stream);
+                this._tokens.push(token);
+                this._result_tokens.push(token);
+            }
+            else if (stream[this._current] === '.' && prev != null && prev.type !== TOK_DOT) {
+                this._tokens.push({
+                    type: TOK_DOT,
+                    value: '.',
+                    start: this._current
+                });
+                this._current += 1;
+            }
+            else if (stream[this._current] === '[') {
+                // No need to increment this._current.  This happens
+                // in _consumeLBracket
+                const token = this._consumeBracket(stream);
+                this._tokens.push(token);
+                this._result_tokens.push(token);
+            }
+            else if (stream[this._current] === '"') {
+                const token = this._consumeQuotedIdentifier(stream);
+                this._tokens.push(token);
+                this._result_tokens.push(token);
+            }
+            else {
+                const p = Math.max(0, this._current - 2);
+                const s = Math.min(this.stream.length, this._current + 2);
+                throw new Error(`Exception at parsing stream ${this.stream.slice(p, s)}`);
+            }
+        }
+        return this._result_tokens;
+    }
+}
+const tokenize = (stream) => {
+    return new Tokenizer(stream).tokenize();
+};
+exports.tokenize = tokenize;
+const resolveData = (data, input, create) => {
+    let tokens;
+    if (typeof input === 'string') {
+        tokens = (0, exports.tokenize)(input);
+    }
+    else {
+        tokens = input;
+    }
+    let result = data;
+    let i = 0;
+    const createIntermediateNode = (token, nextToken, create) => {
+        return nextToken === null ? create :
+            (nextToken.type === TOK_BRACKET) ? new DataGroup_1.default(token.value, [], 'array') :
+                new DataGroup_1.default(token.value, {});
+    };
+    while (i < tokens.length && result != null) {
+        const token = tokens[i];
+        if (token.type === exports.TOK_GLOBAL) {
+            result = data;
+        }
+        else if (token.type === TOK_IDENTIFIER) {
+            if (result instanceof DataGroup_1.default && result.$type === 'object') {
+                //@ts-ignore
+                if (result.$containsDataNode(token.value) && result.$getDataNode(token.value).$value !== null) {
+                    result = result.$getDataNode(token.value);
+                }
+                else if (create) {
+                    const nextToken = i < tokens.length - 1 ? tokens[i + 1] : null;
+                    const toCreate = createIntermediateNode(token, nextToken, create);
+                    result.$addDataNode(token.value, toCreate);
+                    result = toCreate;
+                }
+                else {
+                    result = undefined;
+                }
+            }
+            else {
+                throw new Error(`Looking for ${token.value} in ${result.$value}`);
+            }
+        }
+        else if (token.type === TOK_BRACKET) {
+            if (result instanceof DataGroup_1.default && result.$type === 'array') {
+                const index = token.value;
+                if (index < result.$length) {
+                    //@ts-ignore
+                    result = result.$getDataNode(index);
+                }
+                else if (create) {
+                    const nextToken = i < tokens.length - 1 ? tokens[i + 1] : null;
+                    const toCreate = createIntermediateNode(token, nextToken, create);
+                    result.$addDataNode(index, toCreate);
+                    result = toCreate;
+                }
+                else {
+                    result = undefined;
+                }
+            }
+            else {
+                throw new Error(`Looking for index ${token.value} in non array${result.$value}`);
+            }
+        }
+        i += 1;
+    }
+    return result;
+};
+exports.resolveData = resolveData;

package/lib/utils/Fetch.d.ts

@@ -0,0 +1,7 @@
+export declare const request: (url: string, data?: any, options?: RequestOptions) => any;
+export declare type RequestOptions = {
+    contentType?: string;
+    method?: 'POST' | 'GET';
+    headers?: any;
+    mode?: string;
+};