@sprucelabs/spruce-form-utils 12.0.21 → 12.0.22

package/build/__tests__/support/formAssert.d.ts

@@ -0,0 +1,4 @@
+declare const formAssert: {
+    valuesAreEqual(obj: any, form: any): void;
+};
+export default formAssert;

package/build/__tests__/support/formAssert.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const test_utils_1 = require("@sprucelabs/test-utils");
+const formAssert = {
+    valuesAreEqual(obj, form) {
+        test_utils_1.assert.isEqual(JSON.stringify(obj, (key, value) => {
+            return value === null ? undefined : value;
+        }, 2), JSON.stringify(form, (key, value) => {
+            return value === null ? undefined : value;
+        }, 2));
+    },
+};
+exports.default = formAssert;
+//# sourceMappingURL=formAssert.js.map

package/build/completing/FormPlayerCard.vc.d.ts

@@ -0,0 +1,48 @@
+import { AbstractViewController, FormViewController, SwipeCardViewController, ViewControllerOptions, Router } from '@sprucelabs/heartwood-view-controllers';
+import { SpruceSchemas } from '@sprucelabs/spruce-core-schemas';
+export default class FormPlayerCardViewController extends AbstractViewController<SpruceSchemas.HeartwoodViewControllers.v2021_02_11.Card> {
+    private swipeVc;
+    static id: string;
+    private onChangeHandler?;
+    private builderSource;
+    private shouldIgnoreChanges;
+    private router?;
+    constructor(options: FormPlayerCardViewControllerOptions & ViewControllerOptions);
+    private SwipeVc;
+    private handleSlideChange;
+    private renderFooter;
+    private handleClickSaveProgress;
+    private handleClickSaveAndDone;
+    private handleClickNext;
+    private renderHeader;
+    setIsBusy(isLoading: boolean): void;
+    private renderSlides;
+    private handleOnChange;
+    getHasCriticalError(): boolean;
+    getIsBusy(): boolean;
+    setCriticalError(err: SpruceSchemas.HeartwoodViewControllers.v2021_02_11.CriticalError): void;
+    getSwipeVc(): SwipeCardViewController;
+    load(options: PlayerLoadOptions): Promise<void>;
+    private updateFooter;
+    setValues(values: FormPlayerImportObject['values']): Promise<void>;
+    getValues(): Record<string, any>[];
+    getFormVcs(): FormViewController<any>[];
+    getFormVc(idx: number): FormViewController<any>;
+    getSourceBuilder(): Partial<FormPlayerImportObject>;
+    render(): SpruceSchemas.HeartwoodViewControllers.v2021_02_11.Card;
+}
+export declare type FormPlayerImportObject = SpruceSchemas.HeartwoodViewControllers.v2021_02_11.FormBuilderImportExportObject & {
+    values: Record<string, any>[];
+};
+declare type ChangeHandler = (options: {
+    values: Record<string, any>[];
+}) => Promise<void> | void;
+export declare type FormPlayerCardViewControllerOptions = Partial<FormPlayerImportObject> & {
+    onChange?: ChangeHandler;
+    isBusy?: boolean;
+    id?: string;
+};
+export declare type PlayerLoadOptions = Partial<FormPlayerImportObject> & {
+    router?: Router;
+};
+export {};

package/build/completing/FormPlayerCard.vc.js

@@ -0,0 +1,185 @@
+"use strict";
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const heartwood_view_controllers_1 = require("@sprucelabs/heartwood-view-controllers");
+const schema_1 = require("@sprucelabs/schema");
+class FormPlayerCardViewController extends heartwood_view_controllers_1.AbstractViewController {
+    constructor(options) {
+        super(options);
+        this.shouldIgnoreChanges = false;
+        const { onChange, isBusy, id } = options, builderSource = __rest(options, ["onChange", "isBusy", "id"]);
+        this.builderSource = (0, heartwood_view_controllers_1.removeUniversalViewOptions)(builderSource);
+        this.swipeVc = this.SwipeVc(id, builderSource);
+        if (!options.pages || isBusy) {
+            this.swipeVc.setIsBusy(true);
+        }
+        else if (options.values) {
+            void this.setValues(options.values);
+        }
+        this.onChangeHandler = onChange;
+    }
+    SwipeVc(id, builderSource) {
+        return this.Controller('swipeCard', {
+            id,
+            header: this.renderHeader(builderSource),
+            slides: this.renderSlides(builderSource),
+            footer: this.renderFooter(),
+            onSlideChange: this.handleSlideChange.bind(this),
+        });
+    }
+    handleSlideChange() {
+        this.updateFooter();
+    }
+    renderFooter() {
+        var _a, _b, _c, _d;
+        const totalPages = (_b = (_a = this.builderSource.pages) === null || _a === void 0 ? void 0 : _a.length) !== null && _b !== void 0 ? _b : 0;
+        const currentPage = (_d = (_c = this.swipeVc) === null || _c === void 0 ? void 0 : _c.getPresentSlide()) !== null && _d !== void 0 ? _d : 0;
+        const buttons = [
+            {
+                id: 'saveProgress',
+                label: 'Save progress',
+                onClick: this.handleClickSaveProgress.bind(this),
+            },
+        ];
+        if (totalPages === currentPage + 1) {
+            buttons.push({
+                id: 'save',
+                label: 'Save and be done',
+                type: 'primary',
+                onClick: this.handleClickSaveAndDone.bind(this),
+            });
+        }
+        else {
+            buttons.push({
+                id: 'next',
+                label: 'Next page',
+                type: 'primary',
+                onClick: this.handleClickNext.bind(this),
+            });
+        }
+        return {
+            buttons,
+        };
+    }
+    async handleClickSaveProgress() {
+        await this.alert({
+            message: `Progress saved! 💪`,
+            style: 'success',
+        });
+    }
+    async handleClickSaveAndDone() {
+        var _a;
+        await this.alert({
+            message: `Progress saved, lets get outa here! 🚀`,
+            style: 'success',
+        });
+        await ((_a = this.router) === null || _a === void 0 ? void 0 : _a.redirect('profile.root'));
+    }
+    async handleClickNext() {
+        await this.swipeVc.jumpToSlide(this.swipeVc.getPresentSlide() + 1);
+    }
+    renderHeader(options) {
+        var _a;
+        return {
+            title: (_a = options.title) !== null && _a !== void 0 ? _a : 'Loading your form...',
+            subtitle: options.subtitle,
+        };
+    }
+    setIsBusy(isLoading) {
+        this.swipeVc.setIsBusy(isLoading);
+    }
+    renderSlides(options) {
+        var _a, _b;
+        return ((_b = (_a = options.pages) === null || _a === void 0 ? void 0 : _a.map((_a) => {
+            var { title } = _a, form = __rest(_a, ["title"]);
+            return ({
+                title,
+                form: this.Controller('form', Object.assign(Object.assign({}, form), { shouldShowSubmitControls: false, onChange: async () => {
+                        await this.handleOnChange();
+                    } })).render(),
+            });
+        })) !== null && _b !== void 0 ? _b : []);
+    }
+    async handleOnChange() {
+        var _a;
+        if (!this.shouldIgnoreChanges) {
+            await ((_a = this.onChangeHandler) === null || _a === void 0 ? void 0 : _a.call(this, { values: this.getValues() }));
+        }
+    }
+    getHasCriticalError() {
+        return this.swipeVc.getHasCriticalError();
+    }
+    getIsBusy() {
+        return this.swipeVc.isBusy();
+    }
+    setCriticalError(err) {
+        this.swipeVc.setCriticalError(err);
+    }
+    getSwipeVc() {
+        return this.swipeVc;
+    }
+    async load(options) {
+        const { router } = options, source = __rest(options, ["router"]);
+        const { title, subtitle } = this.renderHeader(source);
+        this.router = router;
+        this.swipeVc.setHeaderTitle(title !== null && title !== void 0 ? title : null);
+        this.swipeVc.setHeaderSubtitle(subtitle !== null && subtitle !== void 0 ? subtitle : null);
+        this.swipeVc.setSections(this.renderSlides(source));
+        if (source.values) {
+            await this.setValues(source.values);
+        }
+        this.builderSource = source;
+        this.updateFooter();
+        this.swipeVc.setIsBusy(false);
+    }
+    updateFooter() {
+        this.swipeVc.setFooter(this.router ? this.renderFooter() : null);
+    }
+    async setValues(values) {
+        if (!Array.isArray(values)) {
+            throw new Error('values must be an array!');
+        }
+        const vcs = this.getFormVcs();
+        this.shouldIgnoreChanges = true;
+        await Promise.all(values.map(async (v, idx) => vcs[idx].setValues(v)));
+        this.shouldIgnoreChanges = false;
+        await this.handleOnChange();
+    }
+    getValues() {
+        return this.getFormVcs().map((vc) => vc.getValues());
+    }
+    getFormVcs() {
+        var _a, _b;
+        return ((_b = (_a = this.swipeVc.getSlides()) === null || _a === void 0 ? void 0 : _a.map((s) => { var _a; return (_a = s.form) === null || _a === void 0 ? void 0 : _a.controller; })) !== null && _b !== void 0 ? _b : []);
+    }
+    getFormVc(idx) {
+        const formVc = this.getFormVcs()[idx];
+        if (!formVc) {
+            throw new schema_1.SchemaError({
+                code: 'INVALID_PARAMETERS',
+                friendlyMessage: `I couldn't find a form at index ${idx}.`,
+                parameters: ['formIdx'],
+            });
+        }
+        return formVc;
+    }
+    getSourceBuilder() {
+        return this.builderSource;
+    }
+    render() {
+        return this.swipeVc.render();
+    }
+}
+exports.default = FormPlayerCardViewController;
+FormPlayerCardViewController.id = 'form-player-card';
+//# sourceMappingURL=FormPlayerCard.vc.js.map

package/build/completing/formCompletionCalculator.d.ts

@@ -0,0 +1,5 @@
+import { FormBuilderPage } from '@sprucelabs/heartwood-view-controllers';
+declare const formCompletionCalculator: {
+    calculate(pages: FormBuilderPage[], values: Record<string, any>[]): number;
+};
+export default formCompletionCalculator;

package/build/completing/formCompletionCalculator.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const schema_1 = require("@sprucelabs/schema");
+function validateOptions(pages, values) {
+    (0, schema_1.assertOptions)({
+        pages,
+        values,
+    }, ['pages', 'values']);
+    if (!Array.isArray(pages)) {
+        throw new schema_1.SchemaError({
+            code: 'INVALID_PARAMETERS',
+            parameters: ['pages'],
+            friendlyMessage: 'pages must be an array',
+        });
+    }
+    if (!Array.isArray(values)) {
+        throw new schema_1.SchemaError({
+            code: 'INVALID_PARAMETERS',
+            parameters: ['values'],
+            friendlyMessage: 'values must be an array',
+        });
+    }
+}
+const formCompletionCalculator = {
+    calculate(pages, values) {
+        var _a, _b, _c, _d;
+        validateOptions(pages, values);
+        const requiredFields = [];
+        let totalFields = 0;
+        for (const page of pages) {
+            const fields = (_a = page.schema.fields) !== null && _a !== void 0 ? _a : {};
+            for (const section of page.sections) {
+                for (const field of (_b = section.fields) !== null && _b !== void 0 ? _b : []) {
+                    const fieldKey = (_c = field.name) !== null && _c !== void 0 ? _c : field;
+                    const f = (_d = fields[fieldKey]) !== null && _d !== void 0 ? _d : {};
+                    if (f.isRequired) {
+                        totalFields++;
+                        requiredFields.push(fieldKey);
+                    }
+                }
+            }
+        }
+        if (totalFields === 0) {
+            return 1;
+        }
+        let totalAnswered = 0;
+        for (const value of values) {
+            totalAnswered += Object.keys(value !== null && value !== void 0 ? value : {}).filter((k) => {
+                return !!value[k] && requiredFields.indexOf(k) !== -1;
+            }).length;
+        }
+        return parseFloat((totalAnswered / totalFields).toFixed(2));
+    },
+};
+exports.default = formCompletionCalculator;
+//# sourceMappingURL=formCompletionCalculator.js.map

package/build/index-module.d.ts

@@ -0,0 +1,4 @@
+export { default as formAssert } from './__tests__/support/formAssert';
+export { default as formCompletionCalculator } from './completing/formCompletionCalculator';
+export { default as FormPlayerCardViewController } from './completing/FormPlayerCard.vc';
+export * from './types/types-module';

package/build/index-module.js

@@ -0,0 +1,28 @@
+"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);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FormPlayerCardViewController = exports.formCompletionCalculator = exports.formAssert = void 0;
+var formAssert_1 = require("./__tests__/support/formAssert");
+Object.defineProperty(exports, "formAssert", { enumerable: true, get: function () { return __importDefault(formAssert_1).default; } });
+var formCompletionCalculator_1 = require("./completing/formCompletionCalculator");
+Object.defineProperty(exports, "formCompletionCalculator", { enumerable: true, get: function () { return __importDefault(formCompletionCalculator_1).default; } });
+var FormPlayerCard_vc_1 = require("./completing/FormPlayerCard.vc");
+Object.defineProperty(exports, "FormPlayerCardViewController", { enumerable: true, get: function () { return __importDefault(FormPlayerCard_vc_1).default; } });
+__exportStar(require("./types/types-module"), exports);
+//# sourceMappingURL=index-module.js.map

package/build/types/types-module.d.ts

@@ -0,0 +1,21 @@
+import { Scope, SpruceSchemas, ViewController } from '@sprucelabs/heartwood-view-controllers';
+import FormPlayerCardViewController, { FormPlayerCardViewControllerOptions } from '../completing/FormPlayerCard.vc';
+declare type Card = SpruceSchemas.HeartwoodViewControllers.v2021_02_11.Card;
+export declare type UpdateForm = SpruceSchemas.Forms.v2021_07_02.UpdateForm;
+export interface RemoteFormBuilderCardLoadOptions {
+    scope: Scope;
+    formId?: string;
+}
+export interface RemoteFormBuilderCard extends ViewController<Card> {
+    load?(options: RemoteFormBuilderCardLoadOptions): Promise<void>;
+    didSaveForm?(form: UpdateForm): Promise<void>;
+}
+declare module '@sprucelabs/heartwood-view-controllers/build/types/heartwood.types' {
+    interface ViewControllerMap {
+        formPlayerCard: FormPlayerCardViewController;
+    }
+    interface ViewControllerOptionsMap {
+        formPlayerCard: FormPlayerCardViewControllerOptions;
+    }
+}
+export {};

package/build/types/types-module.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types-module.js.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sprucelabs/spruce-form-utils",
   "description": "Support for working with forms and Sprucebot. 📄",
-  "version": "12.0.21",
+  "version": "12.0.22",
   "skill": {
     "namespace": "forms"
   },