@xyo-network/react-form-group 2.81.10 → 2.83.0

package/dist/neutral/control/accessor/FormControlStatus.d.ts

@@ -1,6 +0,0 @@
-export declare const VALID: "VALID";
-export declare const INVALID: "INVALID";
-export declare const PENDING: "PENDING";
-export declare const DISABLED: "DISABLED";
-export type FormControlStatus = typeof VALID | typeof INVALID | typeof PENDING | typeof DISABLED;
-//# sourceMappingURL=FormControlStatus.d.ts.map

package/dist/neutral/control/accessor/FormControlStatus.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"FormControlStatus.d.ts","sourceRoot":"","sources":["../../../../src/control/accessor/FormControlStatus.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,KAAK,SAAmB,CAAA;AAKrC,eAAO,MAAM,OAAO,WAAqB,CAAA;AAMzC,eAAO,MAAM,OAAO,WAAqB,CAAA;AAMzC,eAAO,MAAM,QAAQ,YAAsB,CAAA;AAe3C,MAAM,MAAM,iBAAiB,GAAG,OAAO,KAAK,GAAG,OAAO,OAAO,GAAG,OAAO,OAAO,GAAG,OAAO,QAAQ,CAAA"}

package/dist/neutral/control/accessor/ValidControlValue.d.cts

@@ -1,2 +0,0 @@
-export type ValidControlValue = string | undefined;
-//# sourceMappingURL=ValidControlValue.d.ts.map

package/dist/neutral/control/accessor/ValidControlValue.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ValidControlValue.d.ts","sourceRoot":"","sources":["../../../../src/control/accessor/ValidControlValue.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,SAAS,CAAA"}

package/dist/neutral/control/accessor/ValidControlValue.d.mts

@@ -1,2 +0,0 @@
-export type ValidControlValue = string | undefined;
-//# sourceMappingURL=ValidControlValue.d.ts.map

package/dist/neutral/control/accessor/ValidControlValue.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ValidControlValue.d.ts","sourceRoot":"","sources":["../../../../src/control/accessor/ValidControlValue.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,SAAS,CAAA"}

package/dist/neutral/control/accessor/ValidControlValue.d.ts

@@ -1,2 +0,0 @@
-export type ValidControlValue = string | undefined;
-//# sourceMappingURL=ValidControlValue.d.ts.map

package/dist/neutral/control/accessor/ValidControlValue.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ValidControlValue.d.ts","sourceRoot":"","sources":["../../../../src/control/accessor/ValidControlValue.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,SAAS,CAAA"}

package/dist/neutral/control/accessor/index.d.cts

@@ -1,5 +0,0 @@
-export * from './ControlValueAccessor.js';
-export * from './ControlValueAccessorBase.js';
-export * from './FormControlStatus.js';
-export * from './ValidControlValue.js';
-//# sourceMappingURL=index.d.ts.map

package/dist/neutral/control/accessor/index.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/control/accessor/index.ts"],"names":[],"mappings":"AAAA,cAAc,2BAA2B,CAAA;AACzC,cAAc,+BAA+B,CAAA;AAC7C,cAAc,wBAAwB,CAAA;AACtC,cAAc,wBAAwB,CAAA"}

package/dist/neutral/control/accessor/index.d.mts

@@ -1,5 +0,0 @@
-export * from './ControlValueAccessor.js';
-export * from './ControlValueAccessorBase.js';
-export * from './FormControlStatus.js';
-export * from './ValidControlValue.js';
-//# sourceMappingURL=index.d.ts.map

package/dist/neutral/control/accessor/index.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/control/accessor/index.ts"],"names":[],"mappings":"AAAA,cAAc,2BAA2B,CAAA;AACzC,cAAc,+BAA+B,CAAA;AAC7C,cAAc,wBAAwB,CAAA;AACtC,cAAc,wBAAwB,CAAA"}

package/dist/neutral/control/accessor/index.d.ts

@@ -1,5 +0,0 @@
-export * from './ControlValueAccessor.js';
-export * from './ControlValueAccessorBase.js';
-export * from './FormControlStatus.js';
-export * from './ValidControlValue.js';
-//# sourceMappingURL=index.d.ts.map

package/dist/neutral/control/accessor/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/control/accessor/index.ts"],"names":[],"mappings":"AAAA,cAAc,2BAA2B,CAAA;AACzC,cAAc,+BAA+B,CAAA;AAC7C,cAAc,wBAAwB,CAAA;AACtC,cAAc,wBAAwB,CAAA"}

package/dist/neutral/control/index.d.cts

@@ -1,5 +0,0 @@
-export * from './AbstractControl.js';
-export * from './accessor/index.js';
-export * from './FormControl.js';
-export * from './FormControlBase.js';
-//# sourceMappingURL=index.d.ts.map

package/dist/neutral/control/index.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/control/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAA;AACpC,cAAc,qBAAqB,CAAA;AACnC,cAAc,kBAAkB,CAAA;AAChC,cAAc,sBAAsB,CAAA"}

package/dist/neutral/control/index.d.mts

@@ -1,5 +0,0 @@
-export * from './AbstractControl.js';
-export * from './accessor/index.js';
-export * from './FormControl.js';
-export * from './FormControlBase.js';
-//# sourceMappingURL=index.d.ts.map

package/dist/neutral/control/index.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/control/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAA;AACpC,cAAc,qBAAqB,CAAA;AACnC,cAAc,kBAAkB,CAAA;AAChC,cAAc,sBAAsB,CAAA"}

package/dist/neutral/control/index.d.ts

@@ -1,5 +0,0 @@
-export * from './AbstractControl.js';
-export * from './accessor/index.js';
-export * from './FormControl.js';
-export * from './FormControlBase.js';
-//# sourceMappingURL=index.d.ts.map

package/dist/neutral/control/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/control/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAA;AACpC,cAAc,qBAAqB,CAAA;AACnC,cAAc,kBAAkB,CAAA;AAChC,cAAc,sBAAsB,CAAA"}

package/dist/neutral/index.cjs

@@ -1,517 +0,0 @@
-"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/index.ts
-var src_exports = {};
-__export(src_exports, {
-  AbstractControl: () => AbstractControl,
-  ArchivistFormGroupStorage: () => ArchivistFormGroupStorage,
-  ControlValueAccessorBase: () => ControlValueAccessorBase,
-  DISABLED: () => DISABLED,
-  DefaultSetOptions: () => DefaultSetOptions,
-  FormControlBase: () => FormControlBase,
-  FormGroup: () => FormGroup,
-  FormGroupBaseContext: () => FormGroupBaseContext,
-  FormGroupPayloadProvider: () => FormGroupPayloadProvider,
-  INVALID: () => INVALID,
-  PENDING: () => PENDING,
-  VALID: () => VALID,
-  useFormGroup: () => useFormGroup
-});
-module.exports = __toCommonJS(src_exports);
-
-// src/context/Context.ts
-var import_react_shared = require("@xyo-network/react-shared");
-var FormGroupBaseContext = (0, import_react_shared.createContextEx)();
-
-// src/context/Provider.tsx
-var import_react = require("react");
-
-// src/FormGroup.ts
-var import_forget3 = require("@xylabs/forget");
-
-// src/control/AbstractControl.ts
-var import_forget2 = require("@xylabs/forget");
-
-// src/control/accessor/ControlValueAccessorBase.ts
-var import_forget = require("@xylabs/forget");
-var import_module_abstract = require("@xyo-network/module-abstract");
-var DefaultSetOptions = { disableEmit: false };
-var ControlValueAccessorBase = class extends import_module_abstract.BaseEmitter {
-  constructor(config) {
-    super({});
-    this.config = config;
-  }
-  _error = "";
-  _previousValue = void 0;
-  _serializeSettings = { sensitive: false, serializable: false };
-  _touched = false;
-  _value = void 0;
-  /**
-   * The error message for the control.
-   */
-  get error() {
-    return this._error;
-  }
-  /**
-   * The "previous value" of the input element.
-   */
-  get previousValue() {
-    return this._previousValue;
-  }
-  /**
-   * The serialize settings of the input element.
-   */
-  get serializeSettings() {
-    return this._serializeSettings;
-  }
-  /**
-   * The "touched" state of the input element.
-   */
-  get touched() {
-    return this._touched;
-  }
-  /**
-   * The current value of the input element.
-   */
-  get value() {
-    return this._value;
-  }
-  /**
-   * The registered callback function called when a change or input event occurs on the input
-   * element.
-   */
-  onChange = (_) => {
-  };
-  /**
-   * Registers a function called when the control error changes.
-   */
-  onErrorChange = () => {
-  };
-  /**
-   * The registered callback function called when a blur event occurs on the input element.
-   */
-  onTouched = (_isTouched) => {
-  };
-  /**
-   * Registers a function called when the control value changes.
-   * @param  {(_value:ValidControlValue)=>void} fn
-   * @returns void
-   */
-  registerOnChange(fn) {
-    this.onChange = fn;
-  }
-  /**
-   * Registers a function called when the control error changes.
-   * @param  {(error:string)=>void} fn
-   */
-  registerOnErrorChange(fn) {
-    this.onErrorChange = fn;
-  }
-  /**
-   * Registers a function called when the control is touched.
-   * @param  {(isTouched:boolean)=>void} fn
-   * @returns void
-   */
-  registerOnTouched(fn) {
-    this.onTouched = fn;
-  }
-  /**
-   * Sets the "touched" state of the input element.
-   * @param  {boolean} isTouched
-   */
-  setTouched(isTouched) {
-    if (this.touched !== isTouched) {
-      this._touched = isTouched;
-      this.onTouched(isTouched);
-      if (this.config.disableEvents) return;
-      const emit = async () => await this.emit("touchChanged", { touched: isTouched });
-      (0, import_forget.forget)(emit());
-    }
-  }
-  /**
-   * Sets the "value" property on the input element.
-   * @param  {ValidControlValue} value
-   * @returns void
-   */
-  setValue(value, options = DefaultSetOptions) {
-    this._previousValue = this._value;
-    const normalizedValue = value == null ? "" : value;
-    if (this.value !== normalizedValue) {
-      this._value = normalizedValue;
-      this.onChange(normalizedValue);
-      if (this.config.disableEvents || options.disableEmit) return;
-      const emit = async () => await this.emit("valueChanged", { value: normalizedValue });
-      (0, import_forget.forget)(emit());
-    }
-  }
-  /**
-   * Set the error message for the control.
-   * @param  {string} error
-   */
-  setError(error) {
-    if (this.error !== error) {
-      this._error = error;
-      this.onErrorChange(error);
-      if (this.config.disableEvents) return;
-      const emit = async () => await this.emit("errorChanged", { error });
-      (0, import_forget.forget)(emit());
-    }
-  }
-  /**
-   * Sets the "previous value" of the input element.
-   * @param  {ValidControlValue} value
-   * @returns void
-   */
-  setPreviousValue(value) {
-    this._previousValue = value;
-  }
-  /**
-   * Sets the serialize settings  of the input element.
-   * @param  {ControlSerializeSettings} settings
-   */
-  setSerializeSettings(settings) {
-    this._serializeSettings = settings;
-  }
-};
-
-// src/control/accessor/FormControlStatus.ts
-var VALID = "VALID";
-var INVALID = "INVALID";
-var PENDING = "PENDING";
-var DISABLED = "DISABLED";
-
-// src/control/AbstractControl.ts
-var AbstractControl = class extends ControlValueAccessorBase {
-  _status = void 0;
-  constructor() {
-    super({});
-  }
-  /**
-   * A control is `disabled` when its `status` is `DISABLED`.
-   *
-   * Disabled controls are exempt from validation checks and
-   * are not included in the aggregate value of their ancestor
-   * controls.
-   *
-   * @returns True if the control is disabled, false otherwise.
-   */
-  /** @deprecated - disabled functionality not implemented */
-  get disabled() {
-    return this.status === DISABLED;
-  }
-  /**
-   * A control is `enabled` as long as its `status` is not `DISABLED`.
-   *
-   * @returns True if the control has any status other than 'DISABLED',
-   * false if the status is 'DISABLED'.
-   */
-  get enabled() {
-    return this.status !== DISABLED;
-  }
-  /**
-   * A control is `invalid` when its `status` is `INVALID`.
-   
-   *
-   * @returns True if this control has failed one or more of its validation checks,
-   * false otherwise.
-   */
-  get invalid() {
-    return this.status === INVALID;
-  }
-  /**
-   * A control is `pending` when its `status` is `PENDING`.
-   *
-   * @returns True if this control is in the process of conducting a validation check,
-   * false otherwise.
-   */
-  get pending() {
-    return this.status == PENDING;
-  }
-  /**
-   * The raw value of the control.
-   */
-  get rawValue() {
-    return this.value;
-  }
-  /**
-   * The current status of the control.
-   */
-  get status() {
-    return this._status;
-  }
-  /**
-   * A control is `valid` when its `status` is `VALID`.
-   *
-   * @returns True if the control has passed all of its validation tests,
-   * false otherwise.
-   */
-  get valid() {
-    return this.status === VALID;
-  }
-  setErrorAndValidity(error, status) {
-    this.setError(error);
-    this.setStatus(status);
-  }
-  setStatus(status) {
-    if (this._status === status) return;
-    this._status = status;
-    const emit = async () => await this.emit("statusChanged", { status });
-    (0, import_forget2.forget)(emit());
-  }
-  validate() {
-    return true;
-  }
-};
-
-// src/control/FormControlBase.ts
-var AllowAllRegex = /^.*$/s;
-var FormControlBase = class extends AbstractControl {
-  /**
-   * The current and previous cursor position of the input element.
-   */
-  cursorPosition = { current: void 0, previous: void 0 };
-  invalidMessage = "Invalid input";
-  pattern = AllowAllRegex;
-  patternStrict = AllowAllRegex;
-  props = {};
-  required = false;
-  _name = void 0;
-  constructor() {
-    super();
-  }
-  get name() {
-    return this._name;
-  }
-  get rawValue() {
-    return this.unmask && this.value ? this.unmask(this.value) : this.value;
-  }
-  onCursorChange = () => {
-  };
-  setValue(value = "", setOptions) {
-    if (this.unmask && this.pattern) {
-      const unmasked = this.unmask(value);
-      const match = unmasked.match(this.pattern);
-      super.setValue(this.mask ? this.mask(unmasked) : unmasked, setOptions);
-      if (match) {
-        if (this.getCursorPosition) {
-          const newCursor = this.getCursorPosition();
-          this.onCursorChange(newCursor);
-        }
-      } else {
-        this.setValue(this.previousValue, setOptions);
-        this.onCursorChange?.(this.cursorPosition.previous);
-      }
-    } else {
-      super.setValue(value, setOptions);
-    }
-    this.changeError?.(value);
-  }
-  // For FormControls, validate is the same as running one of the error checking functions
-  validate() {
-    const normalizedValue = this.value ?? "";
-    this.blurError ? this.blurError(normalizedValue) : this.changeError?.(normalizedValue);
-    return !this.error;
-  }
-  setName(name) {
-    this._name = name;
-  }
-};
-
-// src/FormGroup.ts
-var FormGroup = class extends AbstractControl {
-  constructor(fgParams) {
-    super();
-    this.fgParams = fgParams;
-  }
-  _controls = {};
-  serializeListeners = {};
-  serializedSensitiveState = {};
-  serializedState = {};
-  get errorSummary() {
-    const errorSummary = {
-      errorMessage: "",
-      invalidFields: []
-    };
-    for (const [key, value] of Object.entries(this.errors)) {
-      if (value) {
-        errorSummary.errorMessage = `${errorSummary.errorMessage}, ${value}`;
-        errorSummary.invalidFields.push(key);
-      }
-    }
-    return errorSummary;
-  }
-  get errors() {
-    const value = {};
-    for (const key in this._controls) {
-      const castKey = key;
-      value[castKey] = this._controls[castKey].error;
-    }
-    return value;
-  }
-  get nonSensitiveStorage() {
-    return this.fgParams?.storage?.storage;
-  }
-  get sensitiveStorage() {
-    return this.fgParams?.storage?.sensitive;
-  }
-  get touched() {
-    return Object.values(this._controls).some((control) => control.touched);
-  }
-  get valid() {
-    return Object.values(this._controls).every((control) => control.valid);
-  }
-  get values() {
-    const value = {};
-    for (const key in this._controls) {
-      const castKey = key;
-      value[castKey] = this._controls[castKey].rawValue;
-    }
-    return value;
-  }
-  getControl(name) {
-    return this._controls[name];
-  }
-  async getSerializedValue(name, sensitive = false) {
-    const storage = sensitive ? this.sensitiveStorage : this.nonSensitiveStorage;
-    if (storage) {
-      if (!storage) {
-        console.warn(`Cannot return value for ${name}. No storage set`);
-        return;
-      }
-      const savedState = await storage.get();
-      if (savedState && name in savedState) {
-        const savedValue = savedState[name];
-        const savedStateWithTimestamp = savedState;
-        if (savedStateWithTimestamp.timestamp && this.fgParams?.ttlStorage) {
-          const expirationDate = savedStateWithTimestamp.timestamp + (this.fgParams?.ttlStorage ?? 0);
-          const now = Date.now();
-          return now > expirationDate ? void 0 : savedValue;
-        }
-        return savedValue;
-      }
-    }
-  }
-  registerControl(name, control) {
-    if (this._controls[name]) console.error(`Replacing Control with name ${name} since it already exists!`);
-    this._controls[name] = control;
-    this.serializeControlValue(name, control);
-  }
-  resetControls() {
-    for (const key in this._controls) {
-      this.unregisterControl(key);
-    }
-  }
-  resetValues() {
-    for (const control of Object.values(this._controls)) {
-      control.setValue("");
-    }
-  }
-  unregisterControl(name) {
-    const control = this._controls[name];
-    if (control) {
-      const listener = this.serializeListeners[name];
-      control.off("valueChanged", listener);
-      delete this.serializeListeners[name];
-      delete this._controls[name];
-    }
-  }
-  validateFields(requiredFields) {
-    const castRequiredFields = requiredFields;
-    for (const key in this._controls) {
-      const castKey = key;
-      if (castRequiredFields === void 0 || castRequiredFields.includes(castKey)) {
-        const control = this._controls[castKey];
-        control.validate();
-      }
-    }
-  }
-  serializeControlValue(name, control) {
-    const shouldSerialize = this.fgParams?.serialize;
-    const sensitiveStorage = this.sensitiveStorage;
-    const storage = this.nonSensitiveStorage;
-    if (!shouldSerialize && (storage || sensitiveStorage)) console.warn("storage medium set but serialize is not enabled");
-    if (shouldSerialize && control.serializeSettings.serializable) {
-      this.setStateValueFromStorage(name, control);
-      const listener = ({ value }) => {
-        if (control.serializeSettings.serializable) {
-          const targetStorage = control.serializeSettings.sensitive ? sensitiveStorage : storage;
-          const targetState = control.serializeSettings.sensitive ? this.serializedSensitiveState : this.serializedState;
-          targetState[name] = value ?? "";
-          const payloadWithTimestamp = targetState;
-          payloadWithTimestamp.timestamp = Date.now();
-          this.serializeValues(targetStorage, targetState);
-        }
-      };
-      control.on("valueChanged", listener);
-      this.serializeListeners[name] = listener;
-    }
-  }
-  serializeValues(storage, values) {
-    if (storage && values) {
-      const write = async () => await storage.insert(values);
-      const clear = async () => await storage.clear();
-      (0, import_forget3.forget)(clear());
-      (0, import_forget3.forget)(write());
-    }
-  }
-  setStateValueFromStorage(name, control) {
-    const read = async () => {
-      const savedValue = await this.getSerializedValue(name, control.serializeSettings.sensitive);
-      if (savedValue) {
-        const targetState = control.serializeSettings.sensitive ? this.serializedSensitiveState : this.serializedState;
-        targetState[name] = savedValue;
-        control.setValue(savedValue, { disableEmit: true });
-      }
-    };
-    (0, import_forget3.forget)(read());
-  }
-};
-
-// src/context/Provider.tsx
-var import_jsx_runtime = require("react/jsx-runtime");
-var FormGroupPayloadProvider = ({ children, params, ...props }) => {
-  const formGroup = (0, import_react.useMemo)(() => {
-    const formGroup2 = new FormGroup(params);
-    return formGroup2;
-  }, [params]);
-  return /* @__PURE__ */ (0, import_jsx_runtime.jsx)(FormGroupBaseContext.Provider, { value: { formGroup, provided: true }, ...props, children });
-};
-
-// src/context/use.tsx
-var import_react_shared2 = require("@xyo-network/react-shared");
-var useFormGroup = (required = false) => (0, import_react_shared2.useContextEx)(FormGroupBaseContext, "FormGroup", required);
-
-// src/storage/ArchivistFormGroupStorage.ts
-var ArchivistFormGroupStorage = class {
-  constructor(archivist) {
-    this.archivist = archivist;
-  }
-  async clear() {
-    await this.archivist.clear?.();
-  }
-  async get() {
-    const all = await this.archivist.all?.();
-    return all.at(-1);
-  }
-  async insert(value) {
-    await this.archivist.insert?.([value]);
-  }
-};
-//# sourceMappingURL=index.cjs.map