@nascentdigital/funnel-core 4.4.4

package/dist/forms/FormModel.js

@@ -0,0 +1,149 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FormModel = void 0;
+const services_1 = require("../services");
+const ui_1 = require("../ui");
+// class
+class FormModel {
+    constructor(args) {
+        var _a;
+        // initialize instance variables
+        this._eventBus = new services_1.EventBus();
+        this._state = 'initializing';
+        this._service = args.service;
+        this.schema = args.schema;
+        // create fields from schema
+        const { editableFields, consentFields } = this.schema;
+        this.fields = Object.entries(editableFields)
+            .map(([id, schema]) => ui_1.FieldSerializer.deserializeField({
+            id,
+            eventBus: this._eventBus,
+            schema,
+            content: undefined,
+            snapshot: undefined
+        }));
+        // create consent fields from schema (if they exist)
+        if (consentFields) {
+            this.consentFields = Object.entries(consentFields)
+                .map(([id, schema]) => ui_1.FieldSerializer.deserializeField({
+                id,
+                eventBus: this._eventBus,
+                schema,
+                content: undefined,
+                snapshot: undefined
+            }));
+        }
+        // save all fields
+        this._allFields = [...this.fields, ...((_a = this.consentFields) !== null && _a !== void 0 ? _a : [])];
+    }
+    get events$() {
+        return this._eventBus.events$;
+    }
+    get valid() {
+        return this._allFields.every(field => field.valid);
+    }
+    get canSubmit() {
+        return this._state !== 'initializing' && this._state !== 'submitting';
+    }
+    get submitting() {
+        return this._state === 'submitting';
+    }
+    get submitted() {
+        return this._state === 'submitted';
+    }
+    get submitFailed() {
+        // if in a failed state, return that state
+        if (this._state === 'submitFailedValidation' || this._state === 'submitFailedServer') {
+            return this._state;
+        }
+        // otherwise return undefined
+        return undefined;
+    }
+    getField(id) {
+        // try to find field (throw if cannot)
+        const field = this._allFields.find(field => field.id === id);
+        if (!field) {
+            throw new Error(`cannot find field with id "${id}"`);
+        }
+        // return
+        return field;
+    }
+    reset() {
+        // reset all fields
+        this._allFields.every(field => field.reset());
+        // set state back to ready
+        this.updateState('ready');
+    }
+    async initialize() {
+        // initialize service
+        await this._service.initialize();
+        // mark as ready
+        this.updateState('ready');
+    }
+    async submit() {
+        // try to submit
+        try {
+            // mark as submitting
+            this.updateState('submitting');
+            // bail if not valid
+            if (!this.valid) {
+                this.updateState('submitFailedValidation');
+                return;
+            }
+            // submit with service
+            const data = this.getData();
+            await this._service.submit(data);
+            // notify success
+            this.updateState('submitted');
+        }
+        // handle error
+        catch (e) {
+            console.error('[FormModel] save failed', e);
+            // complete with an error
+            this.updateState('submitFailedServer');
+            // forward error
+            throw e;
+        }
+    }
+    getData() {
+        // reduce fields to data
+        return this._allFields.reduce((data, field) => {
+            var _a;
+            // get raw value from field
+            let value;
+            if (field instanceof ui_1.Field) {
+                value = (_a = field.value) === null || _a === void 0 ? void 0 : _a.value;
+            }
+            // only use value of field if defined
+            if (value !== undefined) {
+                data[field.id] = value;
+            }
+            // return data so far
+            return data;
+        }, {});
+    }
+    updateState(state) {
+        // update state
+        this._state = state;
+        // raise event
+        this.raiseEvent(state);
+    }
+    raiseEvent(type) {
+        this._eventBus.publish(FormModel.Event.create({ type }));
+    }
+}
+exports.FormModel = FormModel;
+// extension
+(function (FormModel) {
+    let Event;
+    (function (Event) {
+        function filter(event) {
+            return event.domain === 'Form';
+        }
+        Event.filter = filter;
+        function create(event) {
+            return services_1.EventBus.createEvent(Object.assign({ domain: 'Form' }, event));
+        }
+        Event.create = create;
+    })(Event = FormModel.Event || (FormModel.Event = {}));
+})(FormModel || (exports.FormModel = FormModel = {}));

package/dist/forms/Forms.d.ts

@@ -0,0 +1,15 @@
+import { Form } from '../schema';
+import { IFormService } from './IFormService';
+export type Forms<TConfigs extends Forms.Configs = Forms.Configs> = {
+    readonly configs: TConfigs;
+};
+export declare namespace Forms {
+    type Config = {
+        schema: Form;
+        service: IFormService;
+    };
+    type Configs = Record<string, Config>;
+    function initialize(configs: Configs): void;
+    function current<TConfigs extends Forms.Configs = Forms.Configs>(): Forms<TConfigs>;
+    function getConfig<TConfigs extends Forms.Configs = Forms.Configs, TKey extends keyof TConfigs = keyof TConfigs>(id: TKey): TConfigs[TKey];
+}

package/dist/forms/Forms.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Forms = void 0;
+const errors_1 = require("../errors");
+var Forms;
+(function (Forms) {
+    // methods
+    function initialize(configs) {
+        console.debug('[Forms] initializing');
+        // bind instance
+        _forms = { configs };
+    }
+    Forms.initialize = initialize;
+    function current() {
+        // throw if not initialized
+        if (!_forms) {
+            throw new errors_1.IllegalStateError('Attempt to access forms before initialize()');
+        }
+        // return instance
+        return _forms;
+    }
+    Forms.current = current;
+    function getConfig(id) {
+        // try to find config
+        const config = current().configs[id];
+        if (!config) {
+            throw new errors_1.NotFoundError(`Cannot find form config with id "${id.toString()}"`);
+        }
+        // return config
+        return config;
+    }
+    Forms.getConfig = getConfig;
+})(Forms || (exports.Forms = Forms = {}));
+// storage
+let _forms = undefined;

package/dist/forms/IFormService.d.ts

@@ -0,0 +1,6 @@
+import { Fields } from '../schema';
+import { FormModel } from './FormModel';
+export interface IFormService<TFields extends Fields = Fields> {
+    initialize(): Promise<void>;
+    submit(data: FormModel.Data<TFields>): Promise<void>;
+}

package/dist/forms/IFormService.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/forms/TranslateSchema.d.ts

@@ -0,0 +1,8 @@
+import { AssetField, BooleanField, CollectionField, DateField, EnumField, Field, LinkField, ObjectField, Optional, PageField, TextField, TimestampField } from '../schema';
+import { Field as UIField, ObjectField as UIObjectField } from '../ui';
+export declare namespace TranslateSchema {
+    type Field<T extends Field.Type> = T extends TextField ? UIField<TextField> : T extends EnumField ? UIField<EnumField> : T extends BooleanField ? UIField<BooleanField> : T extends DateField ? UIField<DateField> : T extends TimestampField ? UIField<TimestampField> : T extends LinkField ? UIField<LinkField> : T extends AssetField ? UIField<AssetField> : T extends CollectionField ? UIField<CollectionField> : T extends PageField ? UIField<PageField> : T extends ObjectField<infer C> ? UIObjectField : never;
+    type Fields<TFields extends Record<string, Optional.Maybe<Field.Type>>> = {
+        [TKey in keyof TFields]: Field<Optional.InnerType<TFields[TKey]>>;
+    };
+}

package/dist/forms/TranslateSchema.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/forms/index.d.ts

@@ -0,0 +1,4 @@
+export * from './Forms';
+export * from './FormModel';
+export * from './IFormService';
+export * from './TranslateSchema';

package/dist/forms/index.js

@@ -0,0 +1,20 @@
+"use strict";
+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("./Forms"), exports);
+__exportStar(require("./FormModel"), exports);
+__exportStar(require("./IFormService"), exports);
+__exportStar(require("./TranslateSchema"), exports);

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+export * from './app';
+export * from './consent';
+export * from './forms';
+export * from './errors';
+export * from './regionalization';
+export * as Schema from './schema';
+export * from './services';
+export * from './types';
+export * from './ui';
+export * from './utils';

package/dist/index.js

@@ -0,0 +1,49 @@
+"use strict";
+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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+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);
+};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Schema = void 0;
+__exportStar(require("./app"), exports);
+__exportStar(require("./consent"), exports);
+__exportStar(require("./forms"), exports);
+__exportStar(require("./errors"), exports);
+__exportStar(require("./regionalization"), exports);
+exports.Schema = __importStar(require("./schema"));
+__exportStar(require("./services"), exports);
+__exportStar(require("./types"), exports);
+__exportStar(require("./ui"), exports);
+__exportStar(require("./utils"), exports);

package/dist/regionalization/Country.d.ts

@@ -0,0 +1,266 @@
+export type Country = keyof (typeof Country.map);
+export declare namespace Country {
+    type Param<TRegion extends Country = Country> = {
+        region: TRegion;
+    };
+    const map: {
+        af: string;
+        ax: string;
+        al: string;
+        dz: string;
+        as: string;
+        ad: string;
+        ao: string;
+        ai: string;
+        aq: string;
+        ag: string;
+        ar: string;
+        am: string;
+        aw: string;
+        au: string;
+        at: string;
+        az: string;
+        bs: string;
+        bh: string;
+        bd: string;
+        bb: string;
+        by: string;
+        be: string;
+        bz: string;
+        bj: string;
+        bm: string;
+        bt: string;
+        bo: string;
+        bq: string;
+        ba: string;
+        bw: string;
+        bv: string;
+        br: string;
+        io: string;
+        bn: string;
+        bg: string;
+        bf: string;
+        bi: string;
+        kh: string;
+        cm: string;
+        ca: string;
+        cv: string;
+        ky: string;
+        cf: string;
+        td: string;
+        cl: string;
+        cn: string;
+        cx: string;
+        cc: string;
+        co: string;
+        km: string;
+        cg: string;
+        cd: string;
+        ck: string;
+        cr: string;
+        ci: string;
+        hr: string;
+        cu: string;
+        cw: string;
+        cy: string;
+        cz: string;
+        dk: string;
+        dj: string;
+        dm: string;
+        do: string;
+        ec: string;
+        eg: string;
+        sv: string;
+        gq: string;
+        er: string;
+        ee: string;
+        et: string;
+        fk: string;
+        fo: string;
+        fj: string;
+        fi: string;
+        fr: string;
+        gf: string;
+        pf: string;
+        tf: string;
+        ga: string;
+        gm: string;
+        ge: string;
+        de: string;
+        gh: string;
+        gi: string;
+        gr: string;
+        gl: string;
+        gd: string;
+        gp: string;
+        gu: string;
+        gt: string;
+        gg: string;
+        gn: string;
+        gw: string;
+        gy: string;
+        ht: string;
+        hm: string;
+        va: string;
+        hn: string;
+        hk: string;
+        hu: string;
+        is: string;
+        in: string;
+        id: string;
+        ir: string;
+        iq: string;
+        ie: string;
+        im: string;
+        il: string;
+        it: string;
+        jm: string;
+        jp: string;
+        je: string;
+        jo: string;
+        kz: string;
+        ke: string;
+        ki: string;
+        xk: string;
+        kp: string;
+        kr: string;
+        kw: string;
+        kg: string;
+        la: string;
+        lv: string;
+        lb: string;
+        ls: string;
+        lr: string;
+        ly: string;
+        li: string;
+        lt: string;
+        lu: string;
+        mo: string;
+        mk: string;
+        mg: string;
+        mw: string;
+        my: string;
+        mv: string;
+        ml: string;
+        mt: string;
+        mh: string;
+        mq: string;
+        mr: string;
+        mu: string;
+        yt: string;
+        mx: string;
+        fm: string;
+        md: string;
+        mc: string;
+        mn: string;
+        me: string;
+        ms: string;
+        ma: string;
+        mz: string;
+        mm: string;
+        na: string;
+        nr: string;
+        np: string;
+        nl: string;
+        an: string;
+        nc: string;
+        nz: string;
+        ni: string;
+        ne: string;
+        ng: string;
+        nu: string;
+        nf: string;
+        mp: string;
+        no: string;
+        om: string;
+        pk: string;
+        pw: string;
+        ps: string;
+        pa: string;
+        pg: string;
+        py: string;
+        pe: string;
+        ph: string;
+        pn: string;
+        pl: string;
+        pt: string;
+        pr: string;
+        qa: string;
+        re: string;
+        ro: string;
+        ru: string;
+        rw: string;
+        bl: string;
+        sh: string;
+        kn: string;
+        lc: string;
+        mf: string;
+        pm: string;
+        vc: string;
+        ws: string;
+        sm: string;
+        st: string;
+        sa: string;
+        sn: string;
+        rs: string;
+        sc: string;
+        sl: string;
+        sg: string;
+        sx: string;
+        sk: string;
+        si: string;
+        sb: string;
+        so: string;
+        za: string;
+        gs: string;
+        ss: string;
+        es: string;
+        lk: string;
+        sd: string;
+        sr: string;
+        sj: string;
+        sz: string;
+        se: string;
+        ch: string;
+        sy: string;
+        tw: string;
+        tj: string;
+        tz: string;
+        th: string;
+        tl: string;
+        tg: string;
+        tk: string;
+        to: string;
+        tt: string;
+        tn: string;
+        tr: string;
+        tm: string;
+        tc: string;
+        tv: string;
+        ug: string;
+        ua: string;
+        ae: string;
+        gb: string;
+        us: string;
+        um: string;
+        uy: string;
+        uz: string;
+        vu: string;
+        ve: string;
+        vn: string;
+        vg: string;
+        vi: string;
+        wf: string;
+        eh: string;
+        ye: string;
+        zm: string;
+        zw: string;
+    };
+    const values: ReadonlyArray<Country>;
+    const fallback: Country;
+    function filter(value: any): value is Country;
+    function guard(value: any): value is Country | never;
+    function tryParse(value: string | undefined): Country | undefined;
+    function parse(value: string | undefined): Country;
+    function gdpr(region: Country): boolean;
+}