@sprucelabs/heartwood-view-controllers 128.4.0 → 128.5.0

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

@@ -7,7 +7,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { areSchemaValuesValid } from '@sprucelabs/schema';
 import normalizeFormSectionFieldNamesUtil from '../utilities/normalizeFieldNames.utility.js';
 import FormViewController from './form/Form.vc.js';
 export default class BigFormViewController extends FormViewController {
@@ -19,9 +18,7 @@ export default class BigFormViewController extends FormViewController {
         const slide = this.model.sections[idx];
         if (slide) {
             const fields = normalizeFormSectionFieldNamesUtil.toNames(slide.fields);
-            return areSchemaValuesValid(this.model.schema, this.model.values, {
-                fields,
-            });
+            return this._isValidForFields(fields);
         }
         return false;
     }

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

@@ -13,6 +13,7 @@ export default class LoginCardViewController extends AbstractViewController<Card
     private _id;
     private userChallenge?;
     private cardVc;
+    private shouldRequireCheckboxForSmsOptIn;
     constructor(options: LoginCardViewControllerOptions & ViewControllerOptions);
     private CardVc;
     private renderLoginWithEmailButton;
@@ -64,6 +65,11 @@ export default class LoginCardViewController extends AbstractViewController<Card
                 label: string;
                 options: {};
             };
+            smsOptIn: {
+                type: "boolean";
+                label: string;
+                isRequired: true;
+            };
         };
     }>;
     render(): Card;
@@ -76,6 +82,7 @@ export interface LoginCardViewControllerOptions {
     smsDisclaimer?: string | null;
     shouldAllowEmailLogin?: boolean;
     shouldAllowPhoneLogin?: boolean;
+    shouldRequireCheckboxForSmsOptIn?: boolean;
 }
 declare const loginSchema: {
     id: string;
@@ -97,6 +104,11 @@ declare const loginSchema: {
             label: string;
             options: {};
         };
+        smsOptIn: {
+            type: "boolean";
+            label: string;
+            isRequired: true;
+        };
     };
 };
 type LoginSchema = typeof loginSchema;

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

@@ -16,7 +16,7 @@ import AbstractViewController from './Abstract.vc.js';
 class LoginCardViewController extends AbstractViewController {
     constructor(options) {
         super(options);
-        const { id, onLogin, onLoginFailed, smsDisclaimer, shouldAllowEmailLogin, shouldAllowPhoneLogin = true, } = options;
+        const { id, onLogin, onLoginFailed, smsDisclaimer, shouldAllowEmailLogin, shouldAllowPhoneLogin = true, shouldRequireCheckboxForSmsOptIn = false, } = options;
         this._id = id !== null && id !== void 0 ? id : `${LoginCardViewController._id}`;
         LoginCardViewController._id++;
         if (!shouldAllowPhoneLogin && !shouldAllowEmailLogin) {
@@ -25,6 +25,7 @@ class LoginCardViewController extends AbstractViewController {
                 friendlyMessage: "You have to allow phone or email login. You can't disable both.",
             });
         }
+        this.shouldRequireCheckboxForSmsOptIn = shouldRequireCheckboxForSmsOptIn;
         this.shouldAllowPhoneLogin = shouldAllowPhoneLogin;
         this.shouldAllowEmailLogin = shouldAllowEmailLogin !== null && shouldAllowEmailLogin !== void 0 ? shouldAllowEmailLogin : false;
         this.loginHandler = onLogin;
@@ -146,14 +147,20 @@ class LoginCardViewController extends AbstractViewController {
     }
     renderPhoneSection() {
         var _a;
+        const fields = [
+            {
+                name: 'phone',
+                hint: (_a = this.smsDisclaimer) !== null && _a !== void 0 ? _a : loginSchema.fields.phone.hint,
+            },
+        ];
+        if (this.shouldRequireCheckboxForSmsOptIn) {
+            fields.push({
+                name: 'smsOptIn',
+            });
+        }
         return {
             title: this.renderPhoneSlideTitle(),
-            fields: [
-                {
-                    name: 'phone',
-                    hint: (_a = this.smsDisclaimer) !== null && _a !== void 0 ? _a : loginSchema.fields.phone.hint,
-                },
-            ],
+            fields,
         };
     }
     renderPhoneSlideTitle() {
@@ -209,10 +216,20 @@ class LoginCardViewController extends AbstractViewController {
     handleOnChangeBigForm(options) {
         return __awaiter(this, void 0, void 0, function* () {
             const { values } = options;
-            const { code } = values;
+            const { code, smsOptIn } = values;
             if ((code === null || code === void 0 ? void 0 : code.length) === 4) {
                 yield this.bigFormVc.submit();
             }
+            if (this.shouldRequireCheckboxForSmsOptIn && smsOptIn === false) {
+                this.bigFormVc.setErrors([
+                    {
+                        code: 'INVALID_PARAMETER',
+                        friendlyMessage: 'You must agree to receive SMS messages.',
+                        label: 'I agree to receive SMS messages.',
+                        name: 'smsOptIn',
+                    },
+                ]);
+            }
         });
     }
     requestPin(values) {
@@ -301,5 +318,10 @@ const loginSchema = buildSchema({
             label: 'Pin',
             options: {},
         },
+        smsOptIn: {
+            type: 'boolean',
+            label: 'I agree to receive SMS messages.',
+            isRequired: true,
+        },
     },
 });

package/build/esm/viewControllers/form/Form.vc.d.ts

@@ -35,9 +35,10 @@ export default class FormViewController<S extends Schema, V extends ViewModel<S>
     private normalizeValues;
     private validateDirtyFields;
     setErrors(errors: TypedFieldError<S>[]): void;
-    setErrorsByField(errorsByField: FormErrorsByField<S>): void;
+    protected setErrorsByField(errorsByField: FormErrorsByField<S>): void;
     validate(): FormErrorsByField<S>;
     isValid(): boolean;
+    protected _isValidForFields(visibleFields: SchemaFieldNames<S>[]): boolean;
     private getVisibleFields;
     disable(): void;
     enable(): void;

package/build/esm/viewControllers/form/Form.vc.js

@@ -280,9 +280,21 @@ export default class FormViewController extends AbstractViewController {
         return errorsByField;
     }
     isValid() {
-        return areSchemaValuesValid(this.model.schema, this.model.values, {
-            fields: this.getVisibleFields(),
-        });
+        const visibleFields = this.getVisibleFields();
+        let isValid = this._isValidForFields(visibleFields);
+        return isValid;
+    }
+    _isValidForFields(visibleFields) {
+        let isValid = true;
+        if (Object.keys(this.getErrorsByField()).length > 0) {
+            isValid = false;
+        }
+        isValid =
+            isValid &&
+                areSchemaValuesValid(this.model.schema, this.model.values, {
+                    fields: visibleFields,
+                });
+        return isValid;
     }
     getVisibleFields() {
         var _a;

package/build/viewControllers/BigForm.vc.js

@@ -3,7 +3,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const schema_1 = require("@sprucelabs/schema");
 const normalizeFieldNames_utility_1 = __importDefault(require("../utilities/normalizeFieldNames.utility"));
 const Form_vc_1 = __importDefault(require("./form/Form.vc"));
 class BigFormViewController extends Form_vc_1.default {
@@ -15,9 +14,7 @@ class BigFormViewController extends Form_vc_1.default {
         const slide = this.model.sections[idx];
         if (slide) {
             const fields = normalizeFieldNames_utility_1.default.toNames(slide.fields);
-            return (0, schema_1.areSchemaValuesValid)(this.model.schema, this.model.values, {
-                fields,
-            });
+            return this._isValidForFields(fields);
         }
         return false;
     }

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

@@ -13,6 +13,7 @@ export default class LoginCardViewController extends AbstractViewController<Card
     private _id;
     private userChallenge?;
     private cardVc;
+    private shouldRequireCheckboxForSmsOptIn;
     constructor(options: LoginCardViewControllerOptions & ViewControllerOptions);
     private CardVc;
     private renderLoginWithEmailButton;
@@ -64,6 +65,11 @@ export default class LoginCardViewController extends AbstractViewController<Card
                 label: string;
                 options: {};
             };
+            smsOptIn: {
+                type: "boolean";
+                label: string;
+                isRequired: true;
+            };
         };
     }>;
     render(): Card;
@@ -76,6 +82,7 @@ export interface LoginCardViewControllerOptions {
     smsDisclaimer?: string | null;
     shouldAllowEmailLogin?: boolean;
     shouldAllowPhoneLogin?: boolean;
+    shouldRequireCheckboxForSmsOptIn?: boolean;
 }
 declare const loginSchema: {
     id: string;
@@ -97,6 +104,11 @@ declare const loginSchema: {
             label: string;
             options: {};
         };
+        smsOptIn: {
+            type: "boolean";
+            label: string;
+            isRequired: true;
+        };
     };
 };
 type LoginSchema = typeof loginSchema;

package/build/viewControllers/LoginCard.vc.js

@@ -12,7 +12,7 @@ const Abstract_vc_1 = __importDefault(require("./Abstract.vc"));
 class LoginCardViewController extends Abstract_vc_1.default {
     constructor(options) {
         super(options);
-        const { id, onLogin, onLoginFailed, smsDisclaimer, shouldAllowEmailLogin, shouldAllowPhoneLogin = true, } = options;
+        const { id, onLogin, onLoginFailed, smsDisclaimer, shouldAllowEmailLogin, shouldAllowPhoneLogin = true, shouldRequireCheckboxForSmsOptIn = false, } = options;
         this._id = id ?? `${LoginCardViewController._id}`;
         LoginCardViewController._id++;
         if (!shouldAllowPhoneLogin && !shouldAllowEmailLogin) {
@@ -21,6 +21,7 @@ class LoginCardViewController extends Abstract_vc_1.default {
                 friendlyMessage: "You have to allow phone or email login. You can't disable both.",
             });
         }
+        this.shouldRequireCheckboxForSmsOptIn = shouldRequireCheckboxForSmsOptIn;
         this.shouldAllowPhoneLogin = shouldAllowPhoneLogin;
         this.shouldAllowEmailLogin = shouldAllowEmailLogin ?? false;
         this.loginHandler = onLogin;
@@ -137,14 +138,20 @@ class LoginCardViewController extends Abstract_vc_1.default {
             : null;
     }
     renderPhoneSection() {
+        const fields = [
+            {
+                name: 'phone',
+                hint: this.smsDisclaimer ?? loginSchema.fields.phone.hint,
+            },
+        ];
+        if (this.shouldRequireCheckboxForSmsOptIn) {
+            fields.push({
+                name: 'smsOptIn',
+            });
+        }
         return {
             title: this.renderPhoneSlideTitle(),
-            fields: [
-                {
-                    name: 'phone',
-                    hint: this.smsDisclaimer ?? loginSchema.fields.phone.hint,
-                },
-            ],
+            fields,
         };
     }
     renderPhoneSlideTitle() {
@@ -197,10 +204,20 @@ class LoginCardViewController extends Abstract_vc_1.default {
     }
     async handleOnChangeBigForm(options) {
         const { values } = options;
-        const { code } = values;
+        const { code, smsOptIn } = values;
         if (code?.length === 4) {
             await this.bigFormVc.submit();
         }
+        if (this.shouldRequireCheckboxForSmsOptIn && smsOptIn === false) {
+            this.bigFormVc.setErrors([
+                {
+                    code: 'INVALID_PARAMETER',
+                    friendlyMessage: 'You must agree to receive SMS messages.',
+                    label: 'I agree to receive SMS messages.',
+                    name: 'smsOptIn',
+                },
+            ]);
+        }
     }
     async requestPin(values) {
         try {
@@ -283,5 +300,10 @@ const loginSchema = (0, schema_1.buildSchema)({
             label: 'Pin',
             options: {},
         },
+        smsOptIn: {
+            type: 'boolean',
+            label: 'I agree to receive SMS messages.',
+            isRequired: true,
+        },
     },
 });

package/build/viewControllers/form/Form.vc.d.ts

@@ -35,9 +35,10 @@ export default class FormViewController<S extends Schema, V extends ViewModel<S>
     private normalizeValues;
     private validateDirtyFields;
     setErrors(errors: TypedFieldError<S>[]): void;
-    setErrorsByField(errorsByField: FormErrorsByField<S>): void;
+    protected setErrorsByField(errorsByField: FormErrorsByField<S>): void;
     validate(): FormErrorsByField<S>;
     isValid(): boolean;
+    protected _isValidForFields(visibleFields: SchemaFieldNames<S>[]): boolean;
     private getVisibleFields;
     disable(): void;
     enable(): void;

package/build/viewControllers/form/Form.vc.js

@@ -264,9 +264,21 @@ class FormViewController extends Abstract_vc_1.default {
         return errorsByField;
     }
     isValid() {
-        return (0, schema_1.areSchemaValuesValid)(this.model.schema, this.model.values, {
-            fields: this.getVisibleFields(),
-        });
+        const visibleFields = this.getVisibleFields();
+        let isValid = this._isValidForFields(visibleFields);
+        return isValid;
+    }
+    _isValidForFields(visibleFields) {
+        let isValid = true;
+        if (Object.keys(this.getErrorsByField()).length > 0) {
+            isValid = false;
+        }
+        isValid =
+            isValid &&
+                (0, schema_1.areSchemaValuesValid)(this.model.schema, this.model.values, {
+                    fields: visibleFields,
+                });
+        return isValid;
     }
     getVisibleFields() {
         const fields = [];

package/package.json

@@ -12,7 +12,7 @@
   "sideEffects": false,
   "license": "MIT",
   "description": "All the power of Heartwood in one, convenient package.",
-  "version": "128.4.0",
+  "version": "128.5.0",
   "skill": {
     "namespace": "HeartwoodViewControllers",
     "commandOverrides": {