@zag-js/pin-input 0.2.5 → 0.2.7

package/dist/pin-input.machine.js

@@ -0,0 +1,460 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/pin-input.machine.ts
+var pin_input_machine_exports = {};
+__export(pin_input_machine_exports, {
+  machine: () => machine
+});
+module.exports = __toCommonJS(pin_input_machine_exports);
+var import_core = require("@zag-js/core");
+
+// ../../utilities/core/src/guard.ts
+var isArray = (v) => Array.isArray(v);
+var isObject = (v) => !(v == null || typeof v !== "object" || isArray(v));
+
+// ../../utilities/core/src/object.ts
+function compact(obj) {
+  if (obj === void 0)
+    return obj;
+  return Object.fromEntries(
+    Object.entries(obj).filter(([, value]) => value !== void 0).map(([key, value]) => [key, isObject(value) ? compact(value) : value])
+  );
+}
+
+// ../../utilities/dom/src/query.ts
+function isDocument(el) {
+  return el.nodeType === Node.DOCUMENT_NODE;
+}
+function isWindow(value) {
+  return (value == null ? void 0 : value.toString()) === "[object Window]";
+}
+function getDocument(el) {
+  var _a;
+  if (isWindow(el))
+    return el.document;
+  if (isDocument(el))
+    return el;
+  return (_a = el == null ? void 0 : el.ownerDocument) != null ? _a : document;
+}
+function getWindow(el) {
+  var _a;
+  return (_a = el == null ? void 0 : el.ownerDocument.defaultView) != null ? _a : window;
+}
+function defineDomHelpers(helpers) {
+  const dom2 = {
+    getRootNode: (ctx) => {
+      var _a, _b;
+      return (_b = (_a = ctx.getRootNode) == null ? void 0 : _a.call(ctx)) != null ? _b : document;
+    },
+    getDoc: (ctx) => getDocument(dom2.getRootNode(ctx)),
+    getWin: (ctx) => {
+      var _a;
+      return (_a = dom2.getDoc(ctx).defaultView) != null ? _a : window;
+    },
+    getActiveElement: (ctx) => dom2.getDoc(ctx).activeElement,
+    getById: (ctx, id) => dom2.getRootNode(ctx).getElementById(id),
+    createEmitter: (ctx, target) => {
+      const win = dom2.getWin(ctx);
+      return function emit(evt, detail, options) {
+        const { bubbles = true, cancelable, composed = true } = options != null ? options : {};
+        const eventName = `zag:${evt}`;
+        const init = { bubbles, cancelable, composed, detail };
+        const event = new win.CustomEvent(eventName, init);
+        target.dispatchEvent(event);
+      };
+    },
+    createListener: (target) => {
+      return function listen(evt, handler) {
+        const eventName = `zag:${evt}`;
+        const listener = (e) => handler(e);
+        target.addEventListener(eventName, listener);
+        return () => target.removeEventListener(eventName, listener);
+      };
+    }
+  };
+  return {
+    ...dom2,
+    ...helpers
+  };
+}
+
+// ../../utilities/dom/src/next-tick.ts
+function raf(fn) {
+  const id = globalThis.requestAnimationFrame(fn);
+  return function cleanup() {
+    globalThis.cancelAnimationFrame(id);
+  };
+}
+
+// ../../utilities/dom/src/nodelist.ts
+function queryAll(root, selector) {
+  var _a;
+  return Array.from((_a = root == null ? void 0 : root.querySelectorAll(selector)) != null ? _a : []);
+}
+
+// ../../utilities/form-utils/src/input-event.ts
+function getDescriptor(el, options) {
+  var _a;
+  const { type, property = "value" } = options;
+  const proto = getWindow(el)[type].prototype;
+  return (_a = Object.getOwnPropertyDescriptor(proto, property)) != null ? _a : {};
+}
+function dispatchInputValueEvent(el, value) {
+  var _a;
+  if (!el)
+    return;
+  const win = getWindow(el);
+  if (!(el instanceof win.HTMLInputElement))
+    return;
+  const desc = getDescriptor(el, { type: "HTMLInputElement", property: "value" });
+  (_a = desc.set) == null ? void 0 : _a.call(el, value);
+  const event = new win.Event("input", { bubbles: true });
+  el.dispatchEvent(event);
+}
+
+// src/pin-input.dom.ts
+var dom = defineDomHelpers({
+  getRootId: (ctx) => {
+    var _a, _b;
+    return (_b = (_a = ctx.ids) == null ? void 0 : _a.root) != null ? _b : `pin-input:${ctx.id}`;
+  },
+  getInputId: (ctx, id) => {
+    var _a, _b, _c;
+    return (_c = (_b = (_a = ctx.ids) == null ? void 0 : _a.input) == null ? void 0 : _b.call(_a, id)) != null ? _c : `pin-input:${ctx.id}:${id}`;
+  },
+  getHiddenInputId: (ctx) => {
+    var _a, _b;
+    return (_b = (_a = ctx.ids) == null ? void 0 : _a.hiddenInput) != null ? _b : `pin-input:${ctx.id}:hidden`;
+  },
+  getLabelId: (ctx) => {
+    var _a, _b;
+    return (_b = (_a = ctx.ids) == null ? void 0 : _a.label) != null ? _b : `pin-input:${ctx.id}:label`;
+  },
+  getControlId: (ctx) => {
+    var _a, _b;
+    return (_b = (_a = ctx.ids) == null ? void 0 : _a.control) != null ? _b : `pin-input:${ctx.id}:control`;
+  },
+  getRootEl: (ctx) => dom.getById(ctx, dom.getRootId(ctx)),
+  getElements: (ctx) => {
+    const ownerId = CSS.escape(dom.getRootId(ctx));
+    const selector = `input[data-ownedby=${ownerId}]`;
+    return queryAll(dom.getRootEl(ctx), selector);
+  },
+  getFocusedEl: (ctx) => dom.getElements(ctx)[ctx.focusedIndex],
+  getFirstInputEl: (ctx) => dom.getElements(ctx)[0],
+  getHiddenInputEl: (ctx) => dom.getById(ctx, dom.getHiddenInputId(ctx))
+});
+
+// src/pin-input.machine.ts
+var { and, not } = import_core.guards;
+function machine(userContext) {
+  const ctx = compact(userContext);
+  return (0, import_core.createMachine)(
+    {
+      id: "pin-input",
+      initial: "unknown",
+      context: {
+        value: [],
+        focusedIndex: -1,
+        placeholder: "\u25CB",
+        otp: false,
+        type: "numeric",
+        ...ctx,
+        translations: {
+          inputLabel: (index, length) => `pin code ${index + 1} of ${length}`,
+          ...ctx.translations
+        }
+      },
+      computed: {
+        valueLength: (ctx2) => ctx2.value.length,
+        filledValueLength: (ctx2) => ctx2.value.filter((v) => (v == null ? void 0 : v.trim()) !== "").length,
+        isValueComplete: (ctx2) => ctx2.valueLength === ctx2.filledValueLength,
+        valueAsString: (ctx2) => ctx2.value.join(""),
+        focusedValue: (ctx2) => ctx2.value[ctx2.focusedIndex]
+      },
+      watch: {
+        focusedIndex: ["focusInput", "setInputSelection"],
+        value: ["dispatchInputEvent"],
+        isValueComplete: ["invokeOnComplete", "blurFocusedInputIfNeeded"]
+      },
+      on: {
+        SET_VALUE: [
+          {
+            guard: "hasIndex",
+            actions: ["setValueAtIndex", "invokeOnChange"]
+          },
+          { actions: ["setValue", "invokeOnChange"] }
+        ],
+        CLEAR_VALUE: [
+          {
+            guard: "isDisabled",
+            actions: ["clearValue", "invokeOnChange"]
+          },
+          {
+            actions: ["clearValue", "invokeOnChange", "setFocusIndexToFirst"]
+          }
+        ]
+      },
+      states: {
+        unknown: {
+          on: {
+            SETUP: [
+              {
+                guard: "autoFocus",
+                target: "focused",
+                actions: ["setupValue", "setFocusIndexToFirst"]
+              },
+              {
+                target: "idle",
+                actions: "setupValue"
+              }
+            ]
+          }
+        },
+        idle: {
+          on: {
+            FOCUS: {
+              target: "focused",
+              actions: "setFocusedIndex"
+            }
+          }
+        },
+        focused: {
+          on: {
+            INPUT: [
+              {
+                guard: and("isFinalValue", "isValidValue"),
+                actions: ["setFocusedValue", "invokeOnChange", "dispatchInputEventIfNeeded"]
+              },
+              {
+                guard: "isValidValue",
+                actions: ["setFocusedValue", "invokeOnChange", "setNextFocusedIndex", "dispatchInputEventIfNeeded"]
+              }
+            ],
+            PASTE: [
+              {
+                guard: "isValidValue",
+                actions: ["setPastedValue", "invokeOnChange", "setLastValueFocusIndex"]
+              },
+              { actions: ["resetFocusedValue", "invokeOnChange"] }
+            ],
+            BLUR: {
+              target: "idle",
+              actions: "clearFocusedIndex"
+            },
+            DELETE: {
+              guard: "hasValue",
+              actions: ["clearFocusedValue", "invokeOnChange"]
+            },
+            ARROW_LEFT: {
+              actions: "setPrevFocusedIndex"
+            },
+            ARROW_RIGHT: {
+              actions: "setNextFocusedIndex"
+            },
+            BACKSPACE: [
+              {
+                guard: "hasValue",
+                actions: ["clearFocusedValue", "invokeOnChange"]
+              },
+              {
+                actions: ["setPrevFocusedIndex", "clearFocusedValue", "invokeOnChange"]
+              }
+            ],
+            ENTER: {
+              guard: "isValueComplete",
+              actions: "requestFormSubmit"
+            },
+            KEY_DOWN: {
+              guard: not("isValidValue"),
+              actions: ["preventDefault", "invokeOnInvalid"]
+            }
+          }
+        }
+      }
+    },
+    {
+      guards: {
+        autoFocus: (ctx2) => !!ctx2.autoFocus,
+        isValueEmpty: (_ctx, evt) => evt.value === "",
+        hasValue: (ctx2) => ctx2.value[ctx2.focusedIndex] !== "",
+        isValueComplete: (ctx2) => ctx2.isValueComplete,
+        isValidValue: (ctx2, evt) => {
+          if (!ctx2.pattern)
+            return isValidType(evt.value, ctx2.type);
+          const regex = new RegExp(ctx2.pattern, "g");
+          return regex.test(evt.value);
+        },
+        isFinalValue: (ctx2) => {
+          return ctx2.filledValueLength + 1 === ctx2.valueLength && ctx2.value.findIndex((v) => v.trim() === "") === ctx2.focusedIndex;
+        },
+        isLastInputFocused: (ctx2) => ctx2.focusedIndex === ctx2.valueLength - 1,
+        hasIndex: (_ctx, evt) => evt.index !== void 0,
+        isDisabled: (ctx2) => !!ctx2.disabled
+      },
+      actions: {
+        setupValue: (ctx2) => {
+          const inputs = dom.getElements(ctx2);
+          const empty = Array.from({ length: inputs.length }).map(() => "");
+          ctx2.value = Object.assign(empty, ctx2.value);
+        },
+        focusInput: (ctx2) => {
+          raf(() => {
+            var _a;
+            if (ctx2.focusedIndex === -1)
+              return;
+            (_a = dom.getFocusedEl(ctx2)) == null ? void 0 : _a.focus();
+          });
+        },
+        setInputSelection: (ctx2) => {
+          raf(() => {
+            if (ctx2.focusedIndex === -1)
+              return;
+            const input = dom.getFocusedEl(ctx2);
+            const length = input.value.length;
+            input.selectionStart = ctx2.selectOnFocus ? 0 : length;
+            input.selectionEnd = length;
+          });
+        },
+        invokeOnComplete: (ctx2) => {
+          var _a;
+          if (!ctx2.isValueComplete)
+            return;
+          (_a = ctx2.onComplete) == null ? void 0 : _a.call(ctx2, { value: Array.from(ctx2.value), valueAsString: ctx2.valueAsString });
+        },
+        invokeOnChange: (ctx2, evt) => {
+          var _a;
+          if (evt.type === "SETUP")
+            return;
+          (_a = ctx2.onChange) == null ? void 0 : _a.call(ctx2, { value: Array.from(ctx2.value) });
+        },
+        dispatchInputEvent: (ctx2, evt) => {
+          if (evt.type === "SETUP")
+            return;
+          dispatchInputValueEvent(dom.getHiddenInputEl(ctx2), ctx2.valueAsString);
+          const inputs = dom.getElements(ctx2);
+          ctx2.value.forEach((val, index) => {
+            const input = inputs[index];
+            input.value = val || "";
+          });
+        },
+        invokeOnInvalid: (ctx2, evt) => {
+          var _a;
+          (_a = ctx2.onInvalid) == null ? void 0 : _a.call(ctx2, { value: evt.value, index: ctx2.focusedIndex });
+        },
+        clearFocusedIndex: (ctx2) => {
+          ctx2.focusedIndex = -1;
+        },
+        setValue: (ctx2, evt) => {
+          assign(ctx2, evt.value);
+        },
+        setFocusedIndex: (ctx2, evt) => {
+          ctx2.focusedIndex = evt.index;
+        },
+        setFocusedValue: (ctx2, evt) => {
+          ctx2.value[ctx2.focusedIndex] = lastChar(evt.value);
+        },
+        dispatchInputEventIfNeeded: (ctx2, evt) => {
+          const valueIsChanged = lastChar(evt.value) !== ctx2.focusedValue;
+          if (evt.value.length <= 1 || valueIsChanged)
+            return;
+          const inputs = dom.getElements(ctx2);
+          const input = inputs[ctx2.focusedIndex];
+          input.value = lastChar(evt.value);
+        },
+        setPastedValue(ctx2, evt) {
+          raf(() => {
+            const startIndex = ctx2.focusedValue ? 1 : 0;
+            const value = evt.value.substring(startIndex, ctx2.valueLength);
+            assign(ctx2, value);
+          });
+        },
+        setValueAtIndex: (ctx2, evt) => {
+          ctx2.value[evt.index] = lastChar(evt.value);
+        },
+        clearValue: (ctx2) => {
+          ctx2.value = ctx2.value.map(() => "");
+        },
+        clearFocusedValue: (ctx2) => {
+          ctx2.value[ctx2.focusedIndex] = "";
+        },
+        resetFocusedValue: (ctx2) => {
+          const input = dom.getFocusedEl(ctx2);
+          input.value = ctx2.focusedValue;
+        },
+        setFocusIndexToFirst: (ctx2) => {
+          ctx2.focusedIndex = 0;
+        },
+        setNextFocusedIndex: (ctx2) => {
+          ctx2.focusedIndex = Math.min(ctx2.focusedIndex + 1, ctx2.valueLength - 1);
+        },
+        setPrevFocusedIndex: (ctx2) => {
+          ctx2.focusedIndex = Math.max(ctx2.focusedIndex - 1, 0);
+        },
+        setLastValueFocusIndex: (ctx2) => {
+          raf(() => {
+            ctx2.focusedIndex = Math.min(ctx2.filledValueLength, ctx2.valueLength - 1);
+          });
+        },
+        preventDefault(_, evt) {
+          evt.preventDefault();
+        },
+        blurFocusedInputIfNeeded(ctx2) {
+          if (!ctx2.blurOnComplete)
+            return;
+          raf(() => {
+            var _a;
+            (_a = dom.getFocusedEl(ctx2)) == null ? void 0 : _a.blur();
+          });
+        },
+        requestFormSubmit(ctx2) {
+          var _a;
+          if (!ctx2.name)
+            return;
+          const input = dom.getHiddenInputEl(ctx2);
+          (_a = input == null ? void 0 : input.form) == null ? void 0 : _a.requestSubmit();
+        }
+      }
+    }
+  );
+}
+var REGEX = {
+  numeric: /^[0-9]+$/,
+  alphabetic: /^[A-Za-z]+$/,
+  alphanumeric: /^[a-zA-Z0-9]+$/i
+};
+function isValidType(value, type) {
+  var _a;
+  if (!type)
+    return true;
+  return !!((_a = REGEX[type]) == null ? void 0 : _a.test(value));
+}
+function assign(ctx, value) {
+  const valueArr = Array.isArray(value) ? value : value.split("").filter(Boolean);
+  const valueObj = Object.assign({}, ctx.value, valueArr);
+  ctx.value = Object.values(valueObj);
+}
+function lastChar(value) {
+  return value.charAt(value.length - 1);
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  machine
+});

package/dist/pin-input.machine.mjs

@@ -0,0 +1,8 @@
+import {
+  machine
+} from "./chunk-6HKN4SOY.mjs";
+import "./chunk-NT4W6JYX.mjs";
+import "./chunk-OI3DK2PT.mjs";
+export {
+  machine
+};

package/dist/pin-input.types.d.ts

@@ -0,0 +1,133 @@
+import { StateMachine } from '@zag-js/core';
+import { RequiredBy, DirectionProperty, CommonProperties, Context } from '@zag-js/types';
+
+type IntlTranslations = {
+    inputLabel: (index: number, length: number) => string;
+};
+type ElementIds = Partial<{
+    root: string;
+    hiddenInput: string;
+    label: string;
+    control: string;
+    input(id: string): string;
+}>;
+type PublicContext = DirectionProperty & CommonProperties & {
+    /**
+     * The name of the input element. Useful for form submission.
+     */
+    name?: string;
+    /**
+     * The associate form of the underlying input element.
+     */
+    form?: string;
+    /**
+     * The regular expression that the user-entered input value is checked against.
+     */
+    pattern?: string;
+    /**
+     * The ids of the elements in the pin input. Useful for composition.
+     */
+    ids?: ElementIds;
+    /**
+     * Whether the inputs are disabled
+     */
+    disabled?: boolean;
+    /**
+     * The placeholder text for the input
+     */
+    placeholder?: string;
+    /**
+     * Whether to auto-focus the first input.
+     */
+    autoFocus?: boolean;
+    /**
+     * Whether the pin input is in the invalid state
+     */
+    invalid?: boolean;
+    /**
+     * If `true`, the pin input component signals to its fields that they should
+     * use `autocomplete="one-time-code"`.
+     */
+    otp?: boolean;
+    /**
+     * The value of the the pin input.
+     */
+    value: string[];
+    /**
+     * The type of value the pin-input should allow
+     */
+    type?: "alphanumeric" | "numeric" | "alphabetic";
+    /**
+     * Function called when all inputs have valid values
+     */
+    onComplete?: (details: {
+        value: string[];
+        valueAsString: string;
+    }) => void;
+    /**
+     * Function called on input change
+     */
+    onChange?: (details: {
+        value: string[];
+    }) => void;
+    /**
+     * Function called when an invalid value is entered
+     */
+    onInvalid?: (details: {
+        value: string;
+        index: number;
+    }) => void;
+    /**
+     * If `true`, the input's value will be masked just like `type=password`
+     */
+    mask?: boolean;
+    /**
+     * Whether to blur the input when the value is complete
+     */
+    blurOnComplete?: boolean;
+    /**
+     * Whether to select input value when input is focused
+     */
+    selectOnFocus?: boolean;
+    /**
+     * Specifies the localized strings that identifies the accessibility elements and their states
+     */
+    translations: IntlTranslations;
+};
+type UserDefinedContext = RequiredBy<PublicContext, "id">;
+type ComputedContext = Readonly<{
+    /**
+     * @computed
+     * The number of inputs
+     */
+    valueLength: number;
+    /**
+     * @computed
+     * The number of inputs that are not empty
+     */
+    filledValueLength: number;
+    /**
+     * @computed
+     * Whether all input values are valid
+     */
+    isValueComplete: boolean;
+    /**
+     * @computed
+     * The string representation of the input values
+     */
+    valueAsString: string;
+    /**
+     * @computed
+     * The value at focused index
+     */
+    focusedValue: string;
+}>;
+type PrivateContext = Context<{}>;
+type MachineContext = PublicContext & PrivateContext & ComputedContext;
+type MachineState = {
+    value: "unknown" | "idle" | "focused";
+};
+type State = StateMachine.State<MachineContext, MachineState>;
+type Send = StateMachine.Send<StateMachine.AnyEventObject>;
+
+export { MachineContext, MachineState, Send, State, UserDefinedContext };

package/dist/pin-input.types.js

@@ -0,0 +1,18 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/pin-input.types.ts
+var pin_input_types_exports = {};
+module.exports = __toCommonJS(pin_input_types_exports);

package/package.json

@@ -1,10 +1,7 @@
 {
   "name": "@zag-js/pin-input",
-  "version": "0.2.5",
+  "version": "0.2.7",
   "description": "Core logic for the pin-input widget implemented as a state machine",
-  "main": "dist/index.js",
-  "module": "dist/index.mjs",
-  "types": "dist/index.d.ts",
   "keywords": [
     "js",
     "machine",
@@ -29,19 +26,32 @@
     "url": "https://github.com/chakra-ui/zag/issues"
   },
   "dependencies": {
-    "@zag-js/anatomy": "0.1.1",
-    "@zag-js/core": "0.2.3",
-    "@zag-js/types": "0.3.1"
+    "@zag-js/anatomy": "0.1.3",
+    "@zag-js/core": "0.2.4",
+    "@zag-js/types": "0.3.2"
   },
   "devDependencies": {
-    "@zag-js/dom-utils": "0.2.1",
-    "@zag-js/form-utils": "0.2.2",
-    "@zag-js/utils": "0.3.1"
+    "clean-package": "2.2.0",
+    "@zag-js/dom-utils": "0.2.2",
+    "@zag-js/form-utils": "0.2.3",
+    "@zag-js/utils": "0.3.2"
+  },
+  "clean-package": "../../../clean-package.config.json",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
   },
   "scripts": {
-    "build-fast": "tsup src/index.ts --format=esm,cjs",
+    "build-fast": "tsup src",
     "start": "pnpm build --watch",
-    "build": "tsup src/index.ts --format=esm,cjs --dts",
+    "build": "tsup src --dts",
     "test": "jest --config ../../../jest.config.js --rootDir . --passWithNoTests",
     "lint": "eslint src --ext .ts,.tsx",
     "test-ci": "pnpm test --ci --runInBand",