@globalpayments/vega 2.28.1 → 2.30.0

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

@@ -0,0 +1,606 @@
+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, Host, Prop, h, Element, Event, Watch, State } from '@stencil/core';
+import { sanitizeVegaComponent } from '../../utils/component';
+import { InjectVegaGlobalSlimmer, InjectVegaSlimmer, methodPlaceholder, } from 'vega-slimmer/core';
+import { VegaInputNumericRenderer } from './slimmers/renderers/vega-input-numeric-renderer';
+import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+import { VegaChange } from '../../helpers/event-manager/event-id/vega-event-id';
+import { ChildNodesEventPreventSlimmer } from '../../helpers/event-manager/slimmers/child-nodes-event-prevent-slimmer';
+import { createEventEmitSlimmer, } from '../../helpers/event-manager/slimmers/event-emit-slimmer';
+import { VegaInputNumericValueController } from './slimmers/controllers/vega-input-numeric-value-controller';
+import { VegaInputNumericKeyboardController } from './slimmers/controllers/vega-input-numeric-keyboard-controller';
+import { FormFieldControllerSlimmer } from '../../helpers/slimmers/form-field-controller-slimmer';
+import { RequiredFieldRule } from '../../helpers/validator/rules/required-field-rule';
+import { createSubStateNotifySlimmer } from '../../helpers/slimmers/sub-state/sub-state-notify-slimmer';
+/**
+ * @vegaVersion 2.29.0
+ */
+export class VegaInputNumeric {
+  constructor() {
+    this.globalSlimmers = {};
+    this.valueController = new VegaInputNumericValueController();
+    this.keyboardController = new VegaInputNumericKeyboardController();
+    this.renderer = new VegaInputNumericRenderer();
+    this.changeEventEmitter = createEventEmitSlimmer(VegaInputNumeric, VegaChange);
+    this.inputEventPrevent = new ChildNodesEventPreventSlimmer([VegaChange], () => this.host, { useCapture: true });
+    this.formFieldController = new FormFieldControllerSlimmer({
+      propertyRules: [
+        {
+          propertyName: 'required',
+          ruleFactory: (isRequired) => (isRequired ? new RequiredFieldRule() : null),
+        },
+      ],
+      validationRulesName: 'validationRules',
+      inputContainerGetter: () => this.renderer.getContainerRef(),
+      touchableAreaGetter: () => [this.renderer.getInputRef()],
+      defaultValue: '',
+      attributeGetter: (propertyName) => this[propertyName],
+    });
+    this.prefixTextNotifySlimmer = createSubStateNotifySlimmer(VegaInputNumeric, 'prefixText', 'watchPrefixText');
+    this.suffixTextNotifySlimmer = createSubStateNotifySlimmer(VegaInputNumeric, 'suffixText', 'watchSuffixText');
+    this.isCompactInputWidthNotifySlimmer = createSubStateNotifySlimmer(VegaInputNumeric, 'isCompactInputWidth');
+    this.vegaComponentUsageRuntimeMetricsSlimmer = new VegaComponentUsageRuntimeMetricsSlimmer();
+    this.isCompactInputWidth = true;
+    /**
+     * Defines the prefix for the input numeric field.
+     * It provides additional context or information displayed
+     *    before the numeric value, helping to
+     *    clarify its purpose or usage.
+     *
+     * @vegaVersion 2.29.0
+     */
+    this.prefixText = '';
+    /**
+     * Represents a pre-set or default value for the input numeric field.
+     *
+     * @vegaVersion 2.29.0
+     */
+    /* eslint-disable-next-line @stencil/strict-mutable */
+    this.value = '';
+    /**
+     * Defines the size of the input numeric field.
+     *
+     * @vegaVersion 2.29.0
+     */
+    this.size = 'medium';
+    /**
+     * Determines whether the numeric input field should format numbers
+     *    with thousand separators (commas) during user input.
+     *
+     * @vegaVersion 2.29.0
+     */
+    this.thousandComma = false;
+    /**
+     * Determines whether the numeric input field should restrict
+     *    input to integers only.
+     *
+     * @vegaVersion 2.29.0
+     */
+    this.integerOnly = false;
+    /**
+     * Determines whether the input numeric field is disabled.
+     *
+     * @vegaVersion 2.29.0
+     */
+    this.disabled = false;
+    /**
+     * Specifies the step value for increasing or decreasing the input
+     *    when pressing the ArrowUp or ArrowDown key.
+     *    It controls the finer adjustments in the numeric input.
+     *
+     * @vegaVersion 2.29.0
+     */
+    this.minorIncrement = 1;
+    /**
+     * Specifies the step value for increasing or decreasing the input
+     *    when pressing the ArrowUp or ArrowDown key
+     *    while holding the Shift key.
+     *    It controls larger adjustments in the numeric input.
+     *
+     * @vegaVersion 2.29.0
+     */
+    this.majorIncrement = 10;
+    /**
+     * Provides a descriptive text or string that serves
+     *    as the label or title for the input numeric.
+     *
+     * @vegaVersion 2.29.0
+     */
+    this.label = '';
+    /**
+     * Defines custom validation rules for the input numeric field.
+     *
+     * @vegaVersion 2.29.0
+     */
+    this.validationRules = [];
+    /**
+     * Specifies the validation status of the input numeric field.
+     *
+     * @vegaVersion 2.29.0
+     */
+    /* eslint-disable-next-line @stencil/strict-mutable */
+    this.isValid = null;
+    /**
+     * Determines whether the input field should undergo automatic validation
+     *    during the user's input.
+     *
+     * @vegaVersion 2.29.0
+     */
+    this.autoValidation = true;
+  }
+  watchPrefixText() {
+    methodPlaceholder();
+  }
+  watchSuffixText() {
+    methodPlaceholder();
+  }
+  watchValue() {
+    methodPlaceholder();
+  }
+  watchValidationRules() {
+    methodPlaceholder();
+  }
+  render() {
+    return sanitizeVegaComponent(h(Host, null, this.renderer.render()), this.host);
+  }
+  static get is() { return "vega-input-numeric"; }
+  static get encapsulation() { return "shadow"; }
+  static get originalStyleUrls() { return {
+    "$": ["vega-input-numeric.scss"]
+  }; }
+  static get styleUrls() { return {
+    "$": ["vega-input-numeric.css"]
+  }; }
+  static get properties() { return {
+    "prefixText": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "name": "vegaVersion",
+            "text": "2.29.0"
+          }],
+        "text": "Defines the prefix for the input numeric field.\nIt provides additional context or information displayed\n   before the numeric value, helping to\n   clarify its purpose or usage."
+      },
+      "attribute": "prefix-text",
+      "reflect": false,
+      "defaultValue": "''"
+    },
+    "suffixText": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "name": "vegaVersion",
+            "text": "2.29.0"
+          }],
+        "text": "Defines the suffix for the input numeric field.\nIt provides additional context or information displayed\n   after the numeric value, helping to\n   clarify its purpose or usage."
+      },
+      "attribute": "suffix-text",
+      "reflect": false
+    },
+    "prefixIcon": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "name": "vegaVersion",
+            "text": "2.29.0"
+          }],
+        "text": "Specifies an icon or symbol that appears before the input field,\n   providing visual context or enhancing the aesthetic appearance\n   of the input numeric."
+      },
+      "attribute": "prefix-icon",
+      "reflect": false
+    },
+    "value": {
+      "type": "string",
+      "mutable": true,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "name": "vegaVersion",
+            "text": "2.29.0"
+          }],
+        "text": "Represents a pre-set or default value for the input numeric field."
+      },
+      "attribute": "value",
+      "reflect": false,
+      "defaultValue": "''"
+    },
+    "size": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "'medium' | 'small'",
+        "resolved": "\"medium\" | \"small\"",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "name": "vegaVersion",
+            "text": "2.29.0"
+          }],
+        "text": "Defines the size of the input numeric field."
+      },
+      "attribute": "size",
+      "reflect": false,
+      "defaultValue": "'medium'"
+    },
+    "placeholder": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "name": "vegaVersion",
+            "text": "2.29.0"
+          }],
+        "text": "Specifies a placeholder string that displays as a temporary hint\n   or example inside the input numeric field."
+      },
+      "attribute": "placeholder",
+      "reflect": false
+    },
+    "thousandComma": {
+      "type": "boolean",
+      "mutable": false,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "name": "vegaVersion",
+            "text": "2.29.0"
+          }],
+        "text": "Determines whether the numeric input field should format numbers\n   with thousand separators (commas) during user input."
+      },
+      "attribute": "thousand-comma",
+      "reflect": false,
+      "defaultValue": "false"
+    },
+    "integerOnly": {
+      "type": "boolean",
+      "mutable": false,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "name": "vegaVersion",
+            "text": "2.29.0"
+          }],
+        "text": "Determines whether the numeric input field should restrict\n   input to integers only."
+      },
+      "attribute": "integer-only",
+      "reflect": false,
+      "defaultValue": "false"
+    },
+    "disabled": {
+      "type": "boolean",
+      "mutable": false,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "name": "vegaVersion",
+            "text": "2.29.0"
+          }],
+        "text": "Determines whether the input numeric field is disabled."
+      },
+      "attribute": "disabled",
+      "reflect": false,
+      "defaultValue": "false"
+    },
+    "minorIncrement": {
+      "type": "number",
+      "mutable": false,
+      "complexType": {
+        "original": "number",
+        "resolved": "number",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "name": "vegaVersion",
+            "text": "2.29.0"
+          }],
+        "text": "Specifies the step value for increasing or decreasing the input\n   when pressing the ArrowUp or ArrowDown key.\n   It controls the finer adjustments in the numeric input."
+      },
+      "attribute": "minor-increment",
+      "reflect": false,
+      "defaultValue": "1"
+    },
+    "majorIncrement": {
+      "type": "number",
+      "mutable": false,
+      "complexType": {
+        "original": "number",
+        "resolved": "number",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "name": "vegaVersion",
+            "text": "2.29.0"
+          }],
+        "text": "Specifies the step value for increasing or decreasing the input\n   when pressing the ArrowUp or ArrowDown key\n   while holding the Shift key.\n   It controls larger adjustments in the numeric input."
+      },
+      "attribute": "major-increment",
+      "reflect": false,
+      "defaultValue": "10"
+    },
+    "label": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "name": "vegaVersion",
+            "text": "2.29.0"
+          }],
+        "text": "Provides a descriptive text or string that serves\n   as the label or title for the input numeric."
+      },
+      "attribute": "label",
+      "reflect": false,
+      "defaultValue": "''"
+    },
+    "hint": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "name": "vegaVersion",
+            "text": "2.29.0"
+          }],
+        "text": "Provides a supplementary prompt message that\n   assists users in selecting the appropriate\n   value for the input numeric."
+      },
+      "attribute": "hint",
+      "reflect": false
+    },
+    "required": {
+      "type": "boolean",
+      "mutable": false,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "name": "vegaVersion",
+            "text": "2.29.0"
+          }],
+        "text": "Determines whether the input numeric field is required."
+      },
+      "attribute": "required",
+      "reflect": false
+    },
+    "validationRules": {
+      "type": "unknown",
+      "mutable": false,
+      "complexType": {
+        "original": "FormFieldValidationRule<unknown>[]",
+        "resolved": "FormFieldValidationRule<unknown>[]",
+        "references": {
+          "FormFieldValidationRule": {
+            "location": "import",
+            "path": "../../types/components.type"
+          }
+        }
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "name": "vegaVersion",
+            "text": "2.29.0"
+          }],
+        "text": "Defines custom validation rules for the input numeric field."
+      },
+      "defaultValue": "[]"
+    },
+    "isValid": {
+      "type": "boolean",
+      "mutable": true,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "name": "vegaVersion",
+            "text": "2.29.0"
+          }],
+        "text": "Specifies the validation status of the input numeric field."
+      },
+      "attribute": "is-valid",
+      "reflect": true,
+      "defaultValue": "null"
+    },
+    "autoValidation": {
+      "type": "boolean",
+      "mutable": false,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "name": "vegaVersion",
+            "text": "2.29.0"
+          }],
+        "text": "Determines whether the input field should undergo automatic validation\n   during the user's input."
+      },
+      "attribute": "auto-validation",
+      "reflect": true,
+      "defaultValue": "true"
+    }
+  }; }
+  static get states() { return {
+    "isCompactInputWidth": {}
+  }; }
+  static get events() { return [{
+      "method": "vegaChange",
+      "name": "vegaChange",
+      "bubbles": true,
+      "cancelable": true,
+      "composed": true,
+      "docs": {
+        "tags": [{
+            "name": "vegaVersion",
+            "text": "2.29.0"
+          }],
+        "text": "An event emitter notifying a value change."
+      },
+      "complexType": {
+        "original": "number",
+        "resolved": "number",
+        "references": {}
+      }
+    }, {
+      "method": "change",
+      "name": "change",
+      "bubbles": true,
+      "cancelable": true,
+      "composed": true,
+      "docs": {
+        "tags": [{
+            "name": "eventSemantics",
+            "text": "namespace:native"
+          }, {
+            "name": "vegaVersion",
+            "text": "2.29.0"
+          }],
+        "text": "An event emitter notifying a value change."
+      },
+      "complexType": {
+        "original": "number",
+        "resolved": "number",
+        "references": {}
+      }
+    }]; }
+  static get elementRef() { return "host"; }
+  static get watchers() { return [{
+      "propName": "prefixText",
+      "methodName": "watchPrefixText"
+    }, {
+      "propName": "suffixText",
+      "methodName": "watchSuffixText"
+    }, {
+      "propName": "value",
+      "methodName": "watchValue"
+    }, {
+      "propName": "validationRules",
+      "methodName": "watchValidationRules"
+    }]; }
+}
+__decorate([
+  InjectVegaGlobalSlimmer()
+], VegaInputNumeric.prototype, "globalSlimmers", void 0);
+__decorate([
+  InjectVegaSlimmer()
+], VegaInputNumeric.prototype, "valueController", void 0);
+__decorate([
+  InjectVegaSlimmer()
+], VegaInputNumeric.prototype, "keyboardController", void 0);
+__decorate([
+  InjectVegaSlimmer()
+], VegaInputNumeric.prototype, "renderer", void 0);
+__decorate([
+  InjectVegaSlimmer()
+], VegaInputNumeric.prototype, "changeEventEmitter", void 0);
+__decorate([
+  InjectVegaSlimmer()
+], VegaInputNumeric.prototype, "inputEventPrevent", void 0);
+__decorate([
+  InjectVegaSlimmer()
+], VegaInputNumeric.prototype, "formFieldController", void 0);
+__decorate([
+  InjectVegaSlimmer()
+], VegaInputNumeric.prototype, "prefixTextNotifySlimmer", void 0);
+__decorate([
+  InjectVegaSlimmer()
+], VegaInputNumeric.prototype, "suffixTextNotifySlimmer", void 0);
+__decorate([
+  InjectVegaSlimmer()
+], VegaInputNumeric.prototype, "isCompactInputWidthNotifySlimmer", void 0);
+__decorate([
+  InjectVegaSlimmer()
+], VegaInputNumeric.prototype, "vegaComponentUsageRuntimeMetricsSlimmer", void 0);

package/dist/collection/components/vega-input-select/slimmers/controllers/vega-input-select-dropdown-controller.js

@@ -6,7 +6,7 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 };
 import { MapToComponentField, VegaSlimmer } from 'vega-slimmer/core';
 import { DomNodeSubjectObserverFactory } from '../../../../helpers/change-manager/subject/dom-node-subject/dom-node-subject-observer-factory';
-import { VegaDropdownClick, VegaDropdownHide, VegaDropdownSearch, VegaDropdownShow, } from '../../../../helpers/event-manager/event-id/vega-event-id';
+import { VegaDropdownClick, VegaDropdownHide, VegaDropdownSearch, VegaDropdownShow, VegaSearchTrigger, } from '../../../../helpers/event-manager/event-id/vega-event-id';
 import { VegaInternalDropdownTemplateItemsChange } from '../../../../helpers/event-manager/event-id/vega-internal-event-id';
 /** The `VegaInputSelectDropdownController` class is a TypeScript React component that controls the behavior of a dropdown select input. */
 export class VegaInputSelectDropdownController extends VegaSlimmer {
@@ -39,6 +39,9 @@ export class VegaInputSelectDropdownController extends VegaSlimmer {
     DomNodeSubjectObserverFactory.addUniqueObserverToNode(dropdownRef, VegaDropdownSearch, (payload) => {
       this.searchEventEmitter.emit(payload.detail);
     });
+    DomNodeSubjectObserverFactory.addUniqueObserverToNode(dropdownRef, VegaSearchTrigger, (payload) => {
+      this.searchTriggerEventEmitter.emit(payload.detail);
+    });
     DomNodeSubjectObserverFactory.addUniqueObserverToNode(dropdownRef, VegaInternalDropdownTemplateItemsChange, 
     /*
      * The below method is e2e-test covered in
@@ -66,6 +69,9 @@ __decorate([
 __decorate([
   MapToComponentField()
 ], VegaInputSelectDropdownController.prototype, "searchEventEmitter", void 0);
+__decorate([
+  MapToComponentField()
+], VegaInputSelectDropdownController.prototype, "searchTriggerEventEmitter", void 0);
 __decorate([
   MapToComponentField()
 ], VegaInputSelectDropdownController.prototype, "vegaInputSelectValueController", void 0);