@heartlandone/vega 2.65.0 → 2.67.0

package/dist/collection/components/vega-input-passcode/vega-input-passcode.js

@@ -0,0 +1,513 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+  var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+  if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+  else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+  return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+import { Component, Element, Event, Prop, State, Watch } from '@stencil/core';
+import { InjectVegaGlobalSlimmer, InjectVegaSlimmer, methodPlaceholder, } from 'vega-slimmer/core';
+import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+import { sanitizeVegaComponent } from '../../utils/component';
+import { VegaInputPasscodeRenderer } from './slimmers/renderers/vega-input-passcode-renderer';
+import { VegaInputPasscodeValueController } from './slimmers/controllers/vega-input-passcode-value-controller';
+import { VegaChange, VegaComplete } from '../../helpers/event-manager/event-id/vega-event-id';
+import { createEventEmitSlimmer, } from '../../helpers/event-manager/slimmers/event-emit-slimmer';
+import { VegaInputPasscodeKeyboardController } from './slimmers/controllers/vega-input-passcode-keyboard-controller';
+import { ChildNodesEventPreventSlimmer } from '../../helpers/event-manager/slimmers/child-nodes-event-prevent-slimmer';
+import { FormFieldControllerSlimmer } from '../../helpers/slimmers/form-field-controller-slimmer';
+import { RequiredFieldRule } from '../../helpers/validator/rules/required-field-rule';
+import { ImmutableArray } from '../../helpers/immutable/immutable-array';
+/**
+ * @vegaVersion 2.66.0
+ */
+export class VegaInputPasscode {
+  constructor() {
+    this.globalSlimmers = {};
+    this.formFieldController = new FormFieldControllerSlimmer({
+      propertyRules: [
+        {
+          propertyName: 'required',
+          ruleFactory: (isRequired) => (isRequired ? new RequiredFieldRule() : null),
+        },
+      ],
+      validationRulesName: 'validationRules',
+      defaultValue: '',
+      attributeGetter: (propertyName) => this[propertyName],
+      inputContainerGetter: () => this.inputPasscodeRenderer.getInputPasscodeContainerRef(),
+      touchableAreaGetter: () => [...this.inputPasscodeRenderer.getVegaInputRefs()],
+    });
+    this.vegaComponentUsageRuntimeMetricsSlimmer = new VegaComponentUsageRuntimeMetricsSlimmer();
+    this.keyboardController = new VegaInputPasscodeKeyboardController();
+    this.valueController = new VegaInputPasscodeValueController();
+    this.inputPasscodeRenderer = new VegaInputPasscodeRenderer();
+    this.changeEventEmitter = createEventEmitSlimmer(VegaInputPasscode, VegaChange);
+    this.completeEventEmitter = createEventEmitSlimmer(VegaInputPasscode, VegaComplete);
+    this.eventPreventSlimmer = new ChildNodesEventPreventSlimmer([VegaChange], () => this.host, { useCapture: true });
+    this.vegaInputValues = new ImmutableArray(new Array(), (newArr) => {
+      this.vegaInputValues = newArr;
+    });
+    /**
+     * Specifies the label or title for the input passcode.
+     *
+     * It provides descriptive text that helps identify the
+     *    purpose or content expected in the input passcode.
+     *
+     * @vegaVersion 2.66.0
+     */
+    this.label = '';
+    /**
+     * Determines whether the input passcode is disabled.
+     *
+     * @vegaVersion 2.66.0
+     */
+    this.disabled = false;
+    /**
+     * Defines the size of the input passcode,
+     *    specifying its width or length.
+     *
+     * @vegaVersion 2.66.0
+     */
+    this.size = 'medium';
+    /**
+     * Provides a supplementary prompt message that assists users in
+     *    understanding the expected value for the input passcode.
+     *
+     * @vegaVersion 2.66.0
+     */
+    this.hint = '';
+    /**
+     * Specifies the number of input boxes to display.
+     *
+     * @vegaVersion 2.66.0
+     */
+    this.length = 4;
+    /**
+     * Specifies the input type of the input passcode
+     *    Numeric type: only 0-9 are accepted
+     *    Text type: any non-space character is accepted
+     *    Spaces are rejected for all types
+     *
+     * @vegaVersion 2.66.0
+     */
+    this.inputType = 'numeric';
+    /**
+     * Specifies the value of the input passcode.
+     *
+     * @vegaVersion 2.66.0
+     */
+    /* eslint-disable-next-line @stencil/strict-mutable */
+    this.value = '';
+    /**
+     * Determines whether the input passcode field is required.
+     *
+     * @vegaVersion 2.66.0
+     */
+    /* eslint-disable-next-line @stencil/strict-mutable */
+    this.required = false;
+    /**
+     * Defines custom validation rules for the input passcode.
+     *
+     * @vegaVersion 2.66.0
+     */
+    this.validationRules = [];
+    /**
+     * Determines whether the input passcode should undergo automatic validation
+     *    during the user's input.
+     *
+     * @vegaVersion 2.66.0
+     */
+    this.autoValidation = true;
+    /**
+     * Specifies the validation status of the input passcode.
+     *
+     * @vegaVersion 2.66.0
+     */
+    /* eslint-disable-next-line @stencil/strict-mutable */
+    this.isValid = null;
+  }
+  watchVegaInputValues() {
+    methodPlaceholder();
+  }
+  watchLengthAndInputType() {
+    methodPlaceholder();
+  }
+  watchValue() {
+    methodPlaceholder();
+  }
+  watchValidationRules() {
+    methodPlaceholder();
+  }
+  render() {
+    return sanitizeVegaComponent(this.inputPasscodeRenderer.render(), this.host);
+  }
+  static get is() { return "vega-input-passcode"; }
+  static get encapsulation() { return "shadow"; }
+  static get originalStyleUrls() { return {
+    "$": ["vega-input-passcode.scss"]
+  }; }
+  static get styleUrls() { return {
+    "$": ["vega-input-passcode.css"]
+  }; }
+  static get properties() { return {
+    "label": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "name": "vegaVersion",
+            "text": "2.66.0"
+          }],
+        "text": "Specifies the label or title for the input passcode.\n\nIt provides descriptive text that helps identify the\n   purpose or content expected in the input passcode."
+      },
+      "attribute": "label",
+      "reflect": false,
+      "defaultValue": "''"
+    },
+    "disabled": {
+      "type": "boolean",
+      "mutable": false,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "name": "vegaVersion",
+            "text": "2.66.0"
+          }],
+        "text": "Determines whether the input passcode is disabled."
+      },
+      "attribute": "disabled",
+      "reflect": true,
+      "defaultValue": "false"
+    },
+    "size": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "'medium' | 'small'",
+        "resolved": "\"medium\" | \"small\"",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "name": "vegaVersion",
+            "text": "2.66.0"
+          }],
+        "text": "Defines the size of the input passcode,\n   specifying its width or length."
+      },
+      "attribute": "size",
+      "reflect": false,
+      "defaultValue": "'medium'"
+    },
+    "hint": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "name": "vegaVersion",
+            "text": "2.66.0"
+          }],
+        "text": "Provides a supplementary prompt message that assists users in\n   understanding the expected value for the input passcode."
+      },
+      "attribute": "hint",
+      "reflect": false,
+      "defaultValue": "''"
+    },
+    "length": {
+      "type": "number",
+      "mutable": false,
+      "complexType": {
+        "original": "number",
+        "resolved": "number",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "name": "vegaVersion",
+            "text": "2.66.0"
+          }],
+        "text": "Specifies the number of input boxes to display."
+      },
+      "attribute": "length",
+      "reflect": false,
+      "defaultValue": "4"
+    },
+    "inputType": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "'numeric' | 'text'",
+        "resolved": "\"numeric\" | \"text\"",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "name": "vegaVersion",
+            "text": "2.66.0"
+          }],
+        "text": "Specifies the input type of the input passcode\n   Numeric type: only 0-9 are accepted\n   Text type: any non-space character is accepted\n   Spaces are rejected for all types"
+      },
+      "attribute": "input-type",
+      "reflect": false,
+      "defaultValue": "'numeric'"
+    },
+    "value": {
+      "type": "string",
+      "mutable": true,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "name": "vegaVersion",
+            "text": "2.66.0"
+          }],
+        "text": "Specifies the value of the input passcode."
+      },
+      "attribute": "value",
+      "reflect": true,
+      "defaultValue": "''"
+    },
+    "required": {
+      "type": "boolean",
+      "mutable": true,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "name": "vegaVersion",
+            "text": "2.66.0"
+          }],
+        "text": "Determines whether the input passcode field is required."
+      },
+      "attribute": "required",
+      "reflect": true,
+      "defaultValue": "false"
+    },
+    "validationRules": {
+      "type": "unknown",
+      "mutable": false,
+      "complexType": {
+        "original": "FormFieldValidationRule<unknown>[]",
+        "resolved": "FormFieldValidationRule<unknown>[]",
+        "references": {
+          "FormFieldValidationRule": {
+            "location": "import",
+            "path": "../../helpers/validator/rules/form-field-validation-rule"
+          }
+        }
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "name": "vegaVersion",
+            "text": "2.66.0"
+          }],
+        "text": "Defines custom validation rules for the input passcode."
+      },
+      "defaultValue": "[]"
+    },
+    "autoValidation": {
+      "type": "boolean",
+      "mutable": false,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "name": "vegaVersion",
+            "text": "2.66.0"
+          }],
+        "text": "Determines whether the input passcode should undergo automatic validation\n   during the user's input."
+      },
+      "attribute": "auto-validation",
+      "reflect": true,
+      "defaultValue": "true"
+    },
+    "isValid": {
+      "type": "boolean",
+      "mutable": true,
+      "complexType": {
+        "original": "boolean | null",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "name": "vegaVersion",
+            "text": "2.66.0"
+          }],
+        "text": "Specifies the validation status of the input passcode."
+      },
+      "attribute": "is-valid",
+      "reflect": true,
+      "defaultValue": "null"
+    }
+  }; }
+  static get states() { return {
+    "vegaInputValues": {}
+  }; }
+  static get events() { return [{
+      "method": "vegaChange",
+      "name": "vegaChange",
+      "bubbles": true,
+      "cancelable": true,
+      "composed": true,
+      "docs": {
+        "tags": [{
+            "name": "vegaVersion",
+            "text": "2.66.0"
+          }],
+        "text": "An event emitter notifying the change of the value in the input passcode,\n   whether triggered programmatically or through user interaction."
+      },
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      }
+    }, {
+      "method": "change",
+      "name": "change",
+      "bubbles": true,
+      "cancelable": true,
+      "composed": true,
+      "docs": {
+        "tags": [{
+            "name": "eventSemantics",
+            "text": "namespace:native"
+          }, {
+            "name": "vegaVersion",
+            "text": "2.66.0"
+          }],
+        "text": "An event emitter notifying the change of the value in the input passcode,\n   whether triggered programmatically or through user interaction."
+      },
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      }
+    }, {
+      "method": "vegaComplete",
+      "name": "vegaComplete",
+      "bubbles": true,
+      "cancelable": true,
+      "composed": true,
+      "docs": {
+        "tags": [{
+            "name": "vegaVersion",
+            "text": "2.66.0"
+          }],
+        "text": "An event emitter notifying the completion of all input passcode boxes.\n   whether triggered programmatically or through user interaction."
+      },
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      }
+    }, {
+      "method": "complete",
+      "name": "complete",
+      "bubbles": true,
+      "cancelable": true,
+      "composed": true,
+      "docs": {
+        "tags": [{
+            "name": "eventSemantics",
+            "text": "namespace:native"
+          }, {
+            "name": "vegaVersion",
+            "text": "2.66.0"
+          }],
+        "text": "An event emitter notifying the completion of all input passcode boxes.\n   whether triggered programmatically or through user interaction."
+      },
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      }
+    }]; }
+  static get elementRef() { return "host"; }
+  static get watchers() { return [{
+      "propName": "vegaInputValues",
+      "methodName": "watchVegaInputValues"
+    }, {
+      "propName": "length",
+      "methodName": "watchLengthAndInputType"
+    }, {
+      "propName": "inputType",
+      "methodName": "watchLengthAndInputType"
+    }, {
+      "propName": "value",
+      "methodName": "watchValue"
+    }, {
+      "propName": "validationRules",
+      "methodName": "watchValidationRules"
+    }]; }
+}
+__decorate([
+  InjectVegaGlobalSlimmer()
+], VegaInputPasscode.prototype, "globalSlimmers", void 0);
+__decorate([
+  InjectVegaSlimmer()
+], VegaInputPasscode.prototype, "formFieldController", void 0);
+__decorate([
+  InjectVegaSlimmer()
+], VegaInputPasscode.prototype, "vegaComponentUsageRuntimeMetricsSlimmer", void 0);
+__decorate([
+  InjectVegaSlimmer()
+], VegaInputPasscode.prototype, "keyboardController", void 0);
+__decorate([
+  InjectVegaSlimmer()
+], VegaInputPasscode.prototype, "valueController", void 0);
+__decorate([
+  InjectVegaSlimmer()
+], VegaInputPasscode.prototype, "inputPasscodeRenderer", void 0);
+__decorate([
+  InjectVegaSlimmer()
+], VegaInputPasscode.prototype, "changeEventEmitter", void 0);
+__decorate([
+  InjectVegaSlimmer()
+], VegaInputPasscode.prototype, "completeEventEmitter", void 0);
+__decorate([
+  InjectVegaSlimmer()
+], VegaInputPasscode.prototype, "eventPreventSlimmer", void 0);