@sprucelabs/spruce-form-utils 18.1.3 → 18.1.4

package/build/esm/index-module.d.ts

@@ -7,6 +7,8 @@ export * from './viewControllers/FormCard.vc';
 export { default as SpyFormCardViewController } from './__tests__/support/SpyFormCard';
 export { default as formCardAssert } from './__tests__/implementation/FormCard/formCardAssert';
 export * from './types/types-module';
+export { default as RemoteFormCardViewController } from './viewControllers/RemoteFormCard.vc';
+export * from './viewControllers/RemoteFormCard.vc';
 declare module '@sprucelabs/heartwood-view-controllers/build/types/heartwood.types' {
     interface ViewControllerMap {
         'forms.card': FormCardViewController;

package/build/esm/index-module.js

@@ -6,3 +6,5 @@ export * from './viewControllers/FormCard.vc.js';
 export { default as SpyFormCardViewController } from './__tests__/support/SpyFormCard.js';
 export { default as formCardAssert } from './__tests__/implementation/FormCard/formCardAssert.js';
 export * from './types/types-module.js';
+export { default as RemoteFormCardViewController } from './viewControllers/RemoteFormCard.vc.js';
+export * from './viewControllers/RemoteFormCard.vc.js';

package/build/esm/viewControllers/RemoteFormCard.vc.d.ts

@@ -0,0 +1,35 @@
+import { AbstractViewController, ViewControllerOptions, Card, Router, SpruceSchemas, ViewController } from '@sprucelabs/heartwood-view-controllers';
+import FormPlayerCardViewController from '../completing/FormPlayerCard.vc';
+export default class RemoteFormCardViewController extends AbstractViewController<Card> {
+    static id: string;
+    protected playerVc: FormPlayerCardViewController;
+    private router;
+    private formId;
+    private organizationId;
+    private completedFormId?;
+    private saveDebounceTimeout?;
+    private onDoneHandler;
+    private onErrorHandler;
+    constructor(options: ViewControllerOptions & RemoteFormCardViewControllerOptions);
+    private FormPlayerCard;
+    load(options: RemoteFormCardLoadOptions): Promise<Pick<import("@sprucelabs/schema").SchemaStaticValues<SpruceSchemas.Forms.v2021_07_02.GetFormResponsePayloadSchema, false, import("@sprucelabs/schema").SchemaOptionalFieldNames<SpruceSchemas.Forms.v2021_07_02.GetFormResponsePayloadSchema>, import("@sprucelabs/schema").StaticSchemaAllValues<SpruceSchemas.Forms.v2021_07_02.GetFormResponsePayloadSchema, false>>, "values" | "id" | "target" | "form" | "typeSlug" | "shouldRenderNav" | "roleToAddWhenCompleting" | "whereToSendOnCompletion" | "canEditCompletedForm" | "canCompleteMultipleTimes" | "roles" | "percentComplete"> | null>;
+    private loadForm;
+    protected handleSaveAndBeDone(): Promise<void>;
+    private handlePlayerChange;
+    render(): SpruceSchemas.HeartwoodViewControllers.v2021_02_11.Card;
+}
+export interface RemoteFormCardViewControllerOptions {
+    onDone: OnDoneHandler;
+    onError: OnErrorHandler;
+}
+type OnDoneHandler = () => void | Promise<void>;
+type OnErrorHandler = (error: Error) => void | Promise<void>;
+export interface RemoteFormCardLoadOptions {
+    router: Router;
+    formId: string;
+    organizationId: string;
+}
+export interface RemoteFormCard extends ViewController<Card> {
+    load(options: RemoteFormCardLoadOptions): Promise<SpruceSchemas.Forms.v2021_07_02.GetFormResponsePayload | null>;
+}
+export {};

package/build/esm/viewControllers/RemoteFormCard.vc.js

@@ -0,0 +1,100 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { AbstractViewController, } from '@sprucelabs/heartwood-view-controllers';
+class RemoteFormCardViewController extends AbstractViewController {
+    constructor(options) {
+        super(options);
+        const { onDone, onError } = options;
+        this.onDoneHandler = onDone;
+        this.onErrorHandler = onError;
+        this.playerVc = this.FormPlayerCard();
+    }
+    FormPlayerCard() {
+        return this.Controller('forms.form-player-card', {
+            onChange: this.handlePlayerChange.bind(this),
+            onSaveAndBeDone: this.handleSaveAndBeDone.bind(this),
+        });
+    }
+    load(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { router, formId, organizationId } = options;
+            this.router = router;
+            this.formId = formId;
+            this.organizationId = organizationId;
+            return yield this.loadForm();
+        });
+    }
+    loadForm() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const client = yield this.connectToApi();
+                const [results] = yield client.emitAndFlattenResponses('forms.get-form::v2021_07_02', {
+                    target: {
+                        formId: this.formId,
+                        organizationId: this.organizationId,
+                    },
+                });
+                const { target, values, form } = results;
+                this.organizationId = target.organizationId;
+                yield this.playerVc.load(Object.assign(Object.assign({}, form), { values: values !== null && values !== void 0 ? values : [], router: this.router }));
+                return results;
+            }
+            catch (err) {
+                yield this.onErrorHandler(err);
+            }
+            return null;
+        });
+    }
+    handleSaveAndBeDone() {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.playerVc.setIsBusy(true);
+            if (this.completedFormId) {
+                const client = yield this.connectToApi();
+                yield client.emitAndFlattenResponses('forms.done::v2021_07_02', {
+                    target: {
+                        completedFormId: this.completedFormId,
+                        organizationId: this.organizationId,
+                    },
+                });
+            }
+            yield this.onDoneHandler();
+        });
+    }
+    handlePlayerChange() {
+        return __awaiter(this, void 0, void 0, function* () {
+            clearTimeout(this.saveDebounceTimeout);
+            this.saveDebounceTimeout = setTimeout(() => __awaiter(this, void 0, void 0, function* () {
+                var _a;
+                try {
+                    const client = yield this.connectToApi();
+                    const [{ completedFormId }] = yield client.emitAndFlattenResponses('forms.update-completed-form::v2021_07_02', {
+                        payload: {
+                            sourceFormId: this.formId,
+                            values: this.playerVc.getValues(),
+                        },
+                        target: {
+                            completedFormId: this.completedFormId,
+                            organizationId: (_a = this.organizationId) !== null && _a !== void 0 ? _a : 'NO ORG',
+                        },
+                    });
+                    this.completedFormId = completedFormId;
+                }
+                catch (err) {
+                    this.log.error(err);
+                }
+            }), 100);
+        });
+    }
+    render() {
+        return this.playerVc.render();
+    }
+}
+RemoteFormCardViewController.id = 'remote-form-card';
+export default RemoteFormCardViewController;

package/build/index-module.d.ts

@@ -7,6 +7,8 @@ export * from './viewControllers/FormCard.vc';
 export { default as SpyFormCardViewController } from './__tests__/support/SpyFormCard';
 export { default as formCardAssert } from './__tests__/implementation/FormCard/formCardAssert';
 export * from './types/types-module';
+export { default as RemoteFormCardViewController } from './viewControllers/RemoteFormCard.vc';
+export * from './viewControllers/RemoteFormCard.vc';
 declare module '@sprucelabs/heartwood-view-controllers/build/types/heartwood.types' {
     interface ViewControllerMap {
         'forms.card': FormCardViewController;

package/build/index-module.js

@@ -17,7 +17,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.formCardAssert = exports.SpyFormCardViewController = exports.FormCardViewController = exports.FormPlayerCardViewController = exports.formCompletionCalculator = exports.formAssert = void 0;
+exports.RemoteFormCardViewController = exports.formCardAssert = exports.SpyFormCardViewController = exports.FormCardViewController = 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");
@@ -32,3 +32,6 @@ Object.defineProperty(exports, "SpyFormCardViewController", { enumerable: true,
 var formCardAssert_1 = require("./__tests__/implementation/FormCard/formCardAssert");
 Object.defineProperty(exports, "formCardAssert", { enumerable: true, get: function () { return __importDefault(formCardAssert_1).default; } });
 __exportStar(require("./types/types-module"), exports);
+var RemoteFormCard_vc_1 = require("./viewControllers/RemoteFormCard.vc");
+Object.defineProperty(exports, "RemoteFormCardViewController", { enumerable: true, get: function () { return __importDefault(RemoteFormCard_vc_1).default; } });
+__exportStar(require("./viewControllers/RemoteFormCard.vc"), exports);

package/build/viewControllers/RemoteFormCard.vc.d.ts

@@ -0,0 +1,35 @@
+import { AbstractViewController, ViewControllerOptions, Card, Router, SpruceSchemas, ViewController } from '@sprucelabs/heartwood-view-controllers';
+import FormPlayerCardViewController from '../completing/FormPlayerCard.vc';
+export default class RemoteFormCardViewController extends AbstractViewController<Card> {
+    static id: string;
+    protected playerVc: FormPlayerCardViewController;
+    private router;
+    private formId;
+    private organizationId;
+    private completedFormId?;
+    private saveDebounceTimeout?;
+    private onDoneHandler;
+    private onErrorHandler;
+    constructor(options: ViewControllerOptions & RemoteFormCardViewControllerOptions);
+    private FormPlayerCard;
+    load(options: RemoteFormCardLoadOptions): Promise<Pick<import("@sprucelabs/schema").SchemaStaticValues<SpruceSchemas.Forms.v2021_07_02.GetFormResponsePayloadSchema, false, import("@sprucelabs/schema").SchemaOptionalFieldNames<SpruceSchemas.Forms.v2021_07_02.GetFormResponsePayloadSchema>, import("@sprucelabs/schema").StaticSchemaAllValues<SpruceSchemas.Forms.v2021_07_02.GetFormResponsePayloadSchema, false>>, "values" | "id" | "target" | "form" | "typeSlug" | "shouldRenderNav" | "roleToAddWhenCompleting" | "whereToSendOnCompletion" | "canEditCompletedForm" | "canCompleteMultipleTimes" | "roles" | "percentComplete"> | null>;
+    private loadForm;
+    protected handleSaveAndBeDone(): Promise<void>;
+    private handlePlayerChange;
+    render(): SpruceSchemas.HeartwoodViewControllers.v2021_02_11.Card;
+}
+export interface RemoteFormCardViewControllerOptions {
+    onDone: OnDoneHandler;
+    onError: OnErrorHandler;
+}
+type OnDoneHandler = () => void | Promise<void>;
+type OnErrorHandler = (error: Error) => void | Promise<void>;
+export interface RemoteFormCardLoadOptions {
+    router: Router;
+    formId: string;
+    organizationId: string;
+}
+export interface RemoteFormCard extends ViewController<Card> {
+    load(options: RemoteFormCardLoadOptions): Promise<SpruceSchemas.Forms.v2021_07_02.GetFormResponsePayload | null>;
+}
+export {};

package/build/viewControllers/RemoteFormCard.vc.js

@@ -0,0 +1,89 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const heartwood_view_controllers_1 = require("@sprucelabs/heartwood-view-controllers");
+class RemoteFormCardViewController extends heartwood_view_controllers_1.AbstractViewController {
+    constructor(options) {
+        super(options);
+        const { onDone, onError } = options;
+        this.onDoneHandler = onDone;
+        this.onErrorHandler = onError;
+        this.playerVc = this.FormPlayerCard();
+    }
+    FormPlayerCard() {
+        return this.Controller('forms.form-player-card', {
+            onChange: this.handlePlayerChange.bind(this),
+            onSaveAndBeDone: this.handleSaveAndBeDone.bind(this),
+        });
+    }
+    async load(options) {
+        const { router, formId, organizationId } = options;
+        this.router = router;
+        this.formId = formId;
+        this.organizationId = organizationId;
+        return await this.loadForm();
+    }
+    async loadForm() {
+        try {
+            const client = await this.connectToApi();
+            const [results] = await client.emitAndFlattenResponses('forms.get-form::v2021_07_02', {
+                target: {
+                    formId: this.formId,
+                    organizationId: this.organizationId,
+                },
+            });
+            const { target, values, form } = results;
+            this.organizationId = target.organizationId;
+            await this.playerVc.load({
+                ...form,
+                values: values !== null && values !== void 0 ? values : [],
+                router: this.router,
+            });
+            return results;
+        }
+        catch (err) {
+            await this.onErrorHandler(err);
+        }
+        return null;
+    }
+    async handleSaveAndBeDone() {
+        this.playerVc.setIsBusy(true);
+        if (this.completedFormId) {
+            const client = await this.connectToApi();
+            await client.emitAndFlattenResponses('forms.done::v2021_07_02', {
+                target: {
+                    completedFormId: this.completedFormId,
+                    organizationId: this.organizationId,
+                },
+            });
+        }
+        await this.onDoneHandler();
+    }
+    async handlePlayerChange() {
+        clearTimeout(this.saveDebounceTimeout);
+        this.saveDebounceTimeout = setTimeout(async () => {
+            var _a;
+            try {
+                const client = await this.connectToApi();
+                const [{ completedFormId }] = await client.emitAndFlattenResponses('forms.update-completed-form::v2021_07_02', {
+                    payload: {
+                        sourceFormId: this.formId,
+                        values: this.playerVc.getValues(),
+                    },
+                    target: {
+                        completedFormId: this.completedFormId,
+                        organizationId: (_a = this.organizationId) !== null && _a !== void 0 ? _a : 'NO ORG',
+                    },
+                });
+                this.completedFormId = completedFormId;
+            }
+            catch (err) {
+                this.log.error(err);
+            }
+        }, 100);
+    }
+    render() {
+        return this.playerVc.render();
+    }
+}
+RemoteFormCardViewController.id = 'remote-form-card';
+exports.default = RemoteFormCardViewController;

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@sprucelabs/spruce-form-utils",
 	"description": "Support for working with forms and Sprucebot. 📄",
-	"version": "18.1.3",
+	"version": "18.1.4",
 	"skill": {
 		"namespace": "forms"
 	},
@@ -45,7 +45,11 @@
 		"build/viewControllers/FormCard.vc.js",
 		"build/viewControllers/FormCard.vc.d.ts",
 		"build/esm/viewControllers/FormCard.vc.js",
-		"build/esm/viewControllers/FormCard.vc.d.ts"
+		"build/esm/viewControllers/FormCard.vc.d.ts",
+		"build/viewControllers/RemoteFormCard.vc.js",
+		"build/viewControllers/RemoteFormCard.vc.d.ts",
+		"build/esm/viewControllers/RemoteFormCard.vc.js",
+		"build/esm/viewControllers/RemoteFormCard.vc.d.ts"
 	],
 	"keywords": [],
 	"scripts": {