@es-joy/jsoe 0.16.0 → 0.17.0

package/.ncurc.cjs

@@ -1,9 +1,8 @@
 'use strict';
 
 module.exports = {
-    reject: [
-        // Todo: Try again after some time as caused number of tests to fail
-        //        for typeson-registry, whether in Node 18 or 20
-        'jsdom'
-    ]
+  reject: [
+    // todo[engine:node@>=20]: Can remove
+    'rimraf'
+  ]
 };

package/CHANGES.md

@@ -1,5 +1,9 @@
 # CHANGES TO `@es-joy/jsoe`
 
+## 0.17.0
+
+- feat: Zodex schema support
+
 ## 0.16.0
 
 - feat(regexp): support v flag

package/README.md

@@ -1,8 +1,10 @@
+[![Licenses badge](https://raw.githubusercontent.com/brettz9/integrity-matters/master/badges/licenses-badge.svg?sanitize=true)](badges/licenses-badge.svg)
+
 # @es-joy/jsoe
 
 JavaScript Object Editor.
 
-Editing of arbitrary JavaScript objects.
+Editing and viewing of arbitrary JavaScript objects.
 
 See a [demo](https://es-joy.github.io/jsoe/demo/) of this tool or
 [a demo](https://brettz9.github.io/idb-manager/index-pages.html) of an
@@ -14,6 +16,7 @@ Formats are a collection of allowed types.
 
 Supported formats include:
 
+- Schemas (using [zodex](https://github.com/commonbaseapp/zodex) serialization of [Zod](https://github.com/colinhacks/zod))
 - Structured Cloning (using [typeson](https://github.com/dfahlander/typeson)) (e.g., IndexedDB values)
 - JSON
 - IndexedDB keys
@@ -27,6 +30,7 @@ Supported types include:
 - Array reference (for cyclic arrays)
 - Array
 - `BigInt`
+- `bigintObject`
 - `Blob`
 - `Boolean` object
 - `Date`
@@ -50,6 +54,21 @@ Supported types include:
 - string
 - `undefined`
 
+There are also the following fundamental (Zodex) schema types:
+
+- `boolean` (using in place of true/false when schema specifies)
+- `catch`
+- `enum`
+- `function` (not structured cloning)
+- `literal`
+- `nan` (standalone in Zodex)
+- `nativeEnum`
+- `promise` (not structured cloning)
+- `record`
+- `symbol` (not structured cloning)
+- `tuple`
+- `void` (preferred in Zodex when specified as such)
+
 ## Subtypes
 
 These map to a subset of JavaScript language structures. Note that false and true were common and limited enough in number to justify their own subtype for the sake of having a quick pull-down entry.
@@ -84,12 +103,17 @@ Supported supertypes include:
 - Certain cyclical structures may have issues
 - `typeson-registry`'s structured cloning should throw on more objects, so
    bad data doesn't end up stored
+- Currently requires `SpecialRealNumber` for `Infinity`/`-Infinity` despite
+    Zodex number type supporting a `finite` schema property.
+- Currently doesn't support using `isNullable`; instead just use `null` with
+    a `union`.
 - Lacks support for certain Structured Cloning types. See to-dos below.
+- Excessive use of `reportValidity` (e.g., in BufferSource, as seen by
+    index-instrumented demo) causing focus of element; should only be triggered by
+    event (and only if not auto-triggered event)
 
 ## To-dos
 
-1. Add tests of demo (lower priority as have tests in `idb-manager`)
-1. Support Schemas based on a JSON serialization of Zod
 1. Expand fundamental types
     1. Not in typeson-registry
         1. Structured Cloning

package/badges/licenses-badge.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="300" height="44"><defs><style>text{font-size:11px;font-family:Verdana,DejaVu Sans,Geneva,sans-serif}text.shadow{fill:#010101;fill-opacity:.3}text.high{fill:#fff}</style><linearGradient id="smooth" x2="0" y2="100%"><stop offset="0" stop-color="#aaa" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><mask id="round"><rect width="100%" height="100%" rx="3" fill="#fff"/></mask></defs><g id="bg" mask="url(#round)"><path fill="navy" d="M0 0h227v44H0z"/><path fill="green" d="M227 0h73v44h-73z"/><path fill="url(#smooth)" d="M0 0h300v44H0z"/></g><g id="fg"><text class="shadow" x="5.5" y="15">License types</text><text class="high" x="5" y="14">License types</text><text class="shadow" x="5.5" y="27">(project, deps, and bundled devDeps)</text><text class="high" x="5" y="26">(project, deps, and bundled devDeps)</text><text class="shadow" x="232.5" y="15">Permissive</text><text class="high" x="232" y="14">Permissive</text><text class="shadow" x="232.5" y="39">1. MIT</text><text class="high" x="232" y="38">1. MIT</text></g></svg>

package/dist/formatAndTypeChoices.d.ts

@@ -4,11 +4,15 @@
  * @param {import('./types.js').StateObject} stateObj
  * @returns {Promise<void>}
  */
+/**
+ * @typedef {import('./formats/schema.js').ZodexSchema} ZodexSchema
+ */
 /**
  * Builds a selector and container for types.
  * @param {object} cfg
- * @param {string} [cfg.schema] The schema name (NOT IN USE)
- * @param {object} [cfg.schemaContent] The schema content (NOT IN USE)
+ * @param {string[]} [cfg.schemas] The schema names
+ * @param {(schema: string) => Promise<ZodexSchema>} [cfg.getSchemaContent] The
+ *    schema content retriever
  * @param {boolean} [cfg.hasValue] Set to `true` if you are supplying
  *   your own value. If `false` and `hasKeyPath` is `true`,
  *   will initialize with an object.
@@ -20,9 +24,10 @@
  *   plain object).
  * @param {string} [cfg.typeNamespace] Used to prevent conflicts with other
  *   instances of typeChoices on the page
+ * @param {string} [cfg.selectedSchema]
  * @param {import('./formats.js').default} [cfg.formats]
  * @param {import('./types.js').default} [cfg.types]
- * @returns {{
+ * @returns {Promise<{
  *   formatChoices: FormatChoices,
  *   typesHolder: TypesHolder,
  *   domArray: [formatChoices: FormatChoices, typesHolder: TypesHolder],
@@ -33,40 +38,55 @@
  *   setValue: SetValue,
  *   formats: import('./formats.js').default,
  *   types: import('./types.js').default
- * }} The selector for types and the container for them. Both should be
+ * }>} The selector for types and the container for them. Both should be
  *   added to the page.
  */
-export function formatAndTypeChoices({ schema, schemaContent, hasValue, singleValue, hasKeyPath, typeNamespace, formats, types }: {
-    schema?: string | undefined;
-    schemaContent?: object | undefined;
+export function formatAndTypeChoices({ schemas, getSchemaContent, hasValue, singleValue, hasKeyPath, typeNamespace, selectedSchema, formats, types }: {
+    schemas?: string[] | undefined;
+    getSchemaContent?: ((schema: string) => Promise<ZodexSchema>) | undefined;
     hasValue?: boolean | undefined;
     singleValue?: boolean | undefined;
     hasKeyPath?: boolean | undefined;
     typeNamespace?: string | undefined;
+    selectedSchema?: string | undefined;
     formats?: Formats | undefined;
     types?: Types | undefined;
-}): {
+}): Promise<{
     formatChoices: HTMLSelectElement & {
-        $setFormat: (valueFormat: string) => void;
-        $buildTypeChoices: () => void;
+        $setFormat: (this: HTMLSelectElement & {
+            $buildTypeChoices: (this: HTMLSelectElement & {
+                $buildTypeChoices: any;
+            }) => Promise<void>;
+        }, valueFormat: string) => Promise<void>;
+        $buildTypeChoices: (this: HTMLSelectElement & {
+            $buildTypeChoices: any;
+        }) => Promise<void>;
     };
     typesHolder: HTMLDivElement;
     domArray: [formatChoices: HTMLSelectElement & {
-        $setFormat: (valueFormat: string) => void;
-        $buildTypeChoices: () => void;
+        $setFormat: (this: HTMLSelectElement & {
+            $buildTypeChoices: (this: HTMLSelectElement & {
+                $buildTypeChoices: any;
+            }) => Promise<void>;
+        }, valueFormat: string) => Promise<void>;
+        $buildTypeChoices: (this: HTMLSelectElement & {
+            $buildTypeChoices: any;
+        }) => Promise<void>;
     }, typesHolder: HTMLDivElement];
-    getValue: (stateObj: import('./types.js').StateObject, currentPath: string) => import('./formats.js').StructuredCloneValue;
+    getValue: (stateObj: import("./types.js").StateObject, currentPath: string) => import("./formats.js").StructuredCloneValue;
     getType: () => string;
     validValuesSet: () => boolean;
     setValue: SetValue;
-    formats: import('./formats.js').default;
-    types: import('./types.js').default;
-};
-export function getFormatAndSchemaChoices({ schema, hasKeyPath }?: {
-    schema?: string | undefined;
+    formats: import("./formats.js").default;
+    types: import("./types.js").default;
+}>;
+export function getFormatAndSchemaChoices({ schemas, selectedSchema, hasKeyPath }?: {
+    schemas?: string[] | undefined;
+    selectedSchema?: string | undefined;
     hasKeyPath?: boolean | undefined;
 }): DocumentFragment;
-export type SetValue = (value: import('./formats.js').StructuredCloneValue, stateObj: import('./types.js').StateObject) => Promise<void>;
+export type SetValue = (value: import("./formats.js").StructuredCloneValue, stateObj: import("./types.js").StateObject) => Promise<void>;
+export type ZodexSchema = import("./formats/schema.js").ZodexSchema;
 export type TypeRootGetter = () => HTMLDivElement | null;
 import Formats from './formats.js';
 import Types from './types.js';

package/dist/formatAndTypeChoices.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"formatAndTypeChoices.d.ts","sourceRoot":"","sources":["../src/formatAndTypeChoices.js"],"names":[],"mappings":"AAqEA;;;;;GAKG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH;IA7BwB,MAAM;IACN,aAAa;IACZ,QAAQ;IAGR,WAAW;IACX,UAAU;IAKX,aAAa;IAEW,OAAO;IACT,KAAK;;;kCAkClC,MAAM,KACJ,IAAI;iCAMJ,IAAI;;;;kCAPN,MAAM,KACJ,IAAI;iCAMJ,IAAI;;yBApCG,OAAO,YAAY,EAAE,WAAW,eACtC,MAAM,KAAK,OAAO,cAAc,EAAE,oBAAoB;aAC5D,MAAM,MAAM;oBACL,MAAM,OAAO;cACnB,QAAQ;aACT,OAAO,cAAc,EAAE,OAAO;WAChC,OAAO,YAAY,EAAE,OAAO;EAyMvC;AA5RM;IANiB,MAAM;IACL,UAAU;IAGtB,gBAAgB,CAgD5B;+BAIU,OAAO,cAAc,EAAE,oBAAoB,YAC3C,OAAO,YAAY,EAAE,WAAW,KAC9B,QAAQ,IAAI,CAAC;mCAjEb,cAAc,GAAC,IAAI;oBALZ,cAAc;kBADhB,YAAY"}
+{"version":3,"file":"formatAndTypeChoices.d.ts","sourceRoot":"","sources":["../src/formatAndTypeChoices.js"],"names":[],"mappings":"AAuDA;;;;;GAKG;AAEH;;GAEG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,sJA/BG;IAAuB,OAAO;IACyB,gBAAgB,aAAtD,MAAM,KAAK,OAAO,CAAC,WAAW,CAAC;IAE1B,QAAQ;IAGR,WAAW;IACX,UAAU;IAKX,aAAa;IAEb,cAAc;IACU,OAAO;IACT,KAAK;CAChD,GAAU,OAAO,CAAC;IACpB,aAAiB;;;;kBA8CC,OAAO,CAAC,IAAI,CAAC;wBAbf,MAAM,KAIJ,OAAO,CAAC,IAAI,CAAC;;;cASb,OAAO,CAAC,IAAI,CAAC;MA9CE;IACjC,WAAe,iBAAc;IAC7B,QAAY,EAAE,CAAC,aAAa;;;;kBA4CV,OAAO,CAAC,IAAI,CAAC;wBAbf,MAAM,KAIJ,OAAO,CAAC,IAAI,CAAC;;;cASb,OAAO,CAAC,IAAI,CAAC;KA5CY,EAAE,WAAW,gBAAa,CAAC,CAAC;IACvE,QAAY,EAAE,CAAC,QAAQ,EAAE,OAAO,YAAY,EAAE,WAAW,EACnD,WAAW,EAAE,MAAM,KAAK,OAAO,cAAc,EAAE,oBAAoB,CAAC;IAC1E,OAAW,EAAE,MAAM,MAAM,CAAC;IAC1B,cAAkB,EAAE,MAAM,OAAO,CAAC;IAClC,QAAY,EAAE,QAAQ,CAAC;IACvB,OAAW,EAAE,OAAO,cAAc,EAAE,OAAO,CAAC;IAC5C,KAAS,EAAE,OAAO,YAAY,EAAE,OAAO,CAAA;CACpC,CAAC,CA8NJ;AAzSM,oFAPJ;IAAuB,OAAO;IACT,cAAc;IACb,UAAU;CAGhC,GAAU,gBAAgB,CAiC5B;+BAIU,OAAO,cAAc,EAAE,oBAAoB,YAC3C,OAAO,YAAY,EAAE,WAAW,KAC9B,OAAO,CAAC,IAAI,CAAC;0BAIb,OAAO,qBAAqB,EAAE,WAAW;mCAvDzC,cAAc,GAAC,IAAI;oBALZ,cAAc;kBADhB,YAAY"}

package/dist/formats/indexedDBKey.d.ts

@@ -1,4 +1,4 @@
 export default indexedDBKey;
 /** @type {import('../formats.js').Format} */
-declare const indexedDBKey: import('../formats.js').Format;
+declare const indexedDBKey: import("../formats.js").Format;
 //# sourceMappingURL=indexedDBKey.d.ts.map

package/dist/formats/indexedDBKey.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"indexedDBKey.d.ts","sourceRoot":"","sources":["../../src/formats/indexedDBKey.js"],"names":[],"mappings":";AAEA,6CAA6C;AAC7C,4BADW,OAAO,eAAe,EAAE,MAAM,CAwCvC"}
+{"version":3,"file":"indexedDBKey.d.ts","sourceRoot":"","sources":["../../src/formats/indexedDBKey.js"],"names":[],"mappings":";AAEA,6CAA6C;AAC7C,4BADW,OAAO,eAAe,EAAE,MAAM,CA6CvC"}

package/dist/formats/json.d.ts

@@ -1,4 +1,4 @@
 export default json;
 /** @type {import('../formats.js').Format} */
-declare const json: import('../formats.js').Format;
+declare const json: import("../formats.js").Format;
 //# sourceMappingURL=json.d.ts.map

package/dist/formats/json.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"json.d.ts","sourceRoot":"","sources":["../../src/formats/json.js"],"names":[],"mappings":";AAWA,6CAA6C;AAC7C,oBADW,OAAO,eAAe,EAAE,MAAM,CAwCvC"}
+{"version":3,"file":"json.d.ts","sourceRoot":"","sources":["../../src/formats/json.js"],"names":[],"mappings":";AAWA,6CAA6C;AAC7C,oBADW,OAAO,eAAe,EAAE,MAAM,CA2CvC"}

package/dist/formats/schema.d.ts

@@ -0,0 +1,11 @@
+export default schema;
+export type ZodexSchema = import("zodex").SzType;
+export type NestedObject = import("../utils/objects.js").NestedObject;
+/**
+ * <T>
+ */
+export type ValueOf<T> = T[keyof T];
+export type AvailableZodexType = ValueOf<Pick<import("zodex").SzType, "type">>;
+/** @type {import('../formats.js').Format} */
+declare const schema: import("../formats.js").Format;
+//# sourceMappingURL=schema.d.ts.map

package/dist/formats/schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../src/formats/schema.js"],"names":[],"mappings":";0BA2Da,OAAO,OAAO,EAAE,MAAM;2BAGtB,OAAO,qBAAqB,EAAE,YAAY;;;;oBAnD1C,CAAC,IADD,CAAC,CAAC,MAAM,CAAC,CAAC;iCAMV,OAAO,CAChB,IAAI,CAAC,OAAO,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,CACrC;AAsiBH,6CAA6C;AAC7C,sBADW,OAAO,eAAe,EAAE,MAAM,CAyMvC"}

package/dist/formats/structuredCloning.d.ts

@@ -1,21 +1,19 @@
 export default structuredCloning;
+/**
+ * Delegates data-based UI building to method for adding child elements (a
+ *   method which is housed in the array type object).
+ */
 export type AddAndSetArrayElement = (info: {
     propName: string;
-    type: import('../types.js').AvailableType;
-    value: import('../formats.js').StructuredCloneValue;
+    type: import("../types.js").AvailableType;
+    value: import("../formats.js").StructuredCloneValue;
     bringIntoFocus?: boolean;
     setAValue?: boolean;
-    schemaContent?: object;
-    schemaState?: import('../types.js').GetPossibleSchemasForPathAndType;
+    schemaContent?: import("../formats/schema.js").ZodexSchema;
+    mustBeOptional?: boolean;
+    schemaIdx?: number;
 }) => HTMLElement | null;
-export type EncapsulateObserver = import('typeson-registry').EncapsulateObserver;
-export type FormatIterator = (records: import('../formats.js').StructuredCloneValue, stateObj: import('../types.js').StateObject) => Promise<Element>;
-/**
- * @callback FormatIterator
- * @param {import('../formats.js').StructuredCloneValue} records
- * @param {import('../types.js').StateObject} stateObj
- * @returns {Promise<Element>}
- */
+export type EncapsulateObserver = import("typeson-registry").EncapsulateObserver;
 /** @type {import('../formats.js').Format} */
-declare const structuredCloning: import('../formats.js').Format;
+declare const structuredCloning: import("../formats.js").Format;
 //# sourceMappingURL=structuredCloning.d.ts.map

package/dist/formats/structuredCloning.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"structuredCloning.d.ts","sourceRoot":"","sources":["../../src/formats/structuredCloning.js"],"names":[],"mappings":";2CAsBoB;IACnB,QAAY,EAAE,MAAM,CAAC;IACrB,IAAQ,EAAE,OAAO,aAAa,EAAE,aAAa,CAAC;IAC9C,KAAS,EAAE,OAAO,eAAe,EAAE,oBAAoB,CAAC;IACxD,cAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,SAAa,CAAC,EAAE,OAAO,CAAC;IACxB,aAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,WAAe,CAAC,EAAE,OAAO,aAAa,EAAE,gCAAgC,CAAA;CACrE,KAAK,WAAW,GAAC,IAAI;kCAIZ,OAAO,kBAAkB,EAAE,mBAAmB;uCA2WhD,OAAO,eAAe,EAAE,oBAAoB,YAC5C,OAAO,aAAa,EAAE,WAAW,KAC/B,QAAQ,OAAO,CAAC;AAJ7B;;;;;GAKG;AAEH,6CAA6C;AAC7C,iCADW,OAAO,eAAe,EAAE,MAAM,CAwHvC"}
+{"version":3,"file":"structuredCloning.d.ts","sourceRoot":"","sources":["../../src/formats/structuredCloning.js"],"names":[],"mappings":";;;;;oCAwBa,CAAC,IAAI,EAAE;IACnB,QAAY,EAAE,MAAM,CAAC;IACrB,IAAQ,EAAE,OAAO,aAAa,EAAE,aAAa,CAAC;IAC9C,KAAS,EAAE,OAAO,eAAe,EAAE,oBAAoB,CAAC;IACxD,cAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,SAAa,CAAC,EAAE,OAAO,CAAC;IACxB,aAAiB,CAAC,EAAE,OAAO,sBAAsB,EAAE,WAAW,CAAC;IAC/D,cAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,SAAa,CAAC,EAAE,MAAM,CAAA;CACnB,KAAK,WAAW,GAAC,IAAI;kCAIZ,OAAO,kBAAkB,EAAE,mBAAmB;AA+b3D,6CAA6C;AAC7C,iCADW,OAAO,eAAe,EAAE,MAAM,CA2IvC"}

package/dist/formats.d.ts

@@ -3,45 +3,106 @@ export default Formats;
  * An arbitrary Structured Clone, JSON, etc. value.
  */
 export type StructuredCloneValue = any;
-export type GetTypesForFormatAndState = (types: import('./types.js').default, format: AvailableFormat, state?: string | undefined) => import('./types.js').AvailableType[] | undefined;
-export type AvailableFormat = "indexedDBKey" | "json" | "structuredCloning";
+export type GetTypesAndSchemasForFormatAndState = (types: import("./types.js").default, format: AvailableFormat, state?: string | undefined, schemaObject?: import("./formatAndTypeChoices.js").ZodexSchema | undefined, schemaOriginal?: import("./formatAndTypeChoices.js").ZodexSchema | undefined) => TypesAndSchemaObjects | undefined;
+export type AvailableFormat = "indexedDBKey" | "json" | "structuredCloning" | "schema";
+export type TypesAndSchemaObjects = {
+    types: (import("./types.js").AvailableType)[];
+    schemaObjects: import("./formats/schema.js").ZodexSchema[];
+};
+/**
+ * Responsible for traversing over data (along with state information) to build
+ *   and return a relevant UI element.
+ */
+export type FormatIterator = (records: StructuredCloneValue, stateObj: import("./types.js").StateObject) => Promise<Required<import("./types.js").StateObject>>;
 export type Format = {
-    types: () => (import('./types.js').AvailableType)[];
+    /**
+     * Returns list
+     * of types generally available to structured cloning. See
+     * {@link getTypesAndSchemasForState} for context-dependent method.
+     */
+    types: () => (import("./types.js").AvailableType)[];
+    /**
+     * Traverses over data to build and return
+     * a relevant UI element.
+     */
+    iterate: FormatIterator;
+    /**
+     * Gets the
+     * specific types (and schemas) relevant to a given state.
+     */
+    getTypesAndSchemasForState: (types: import("./types.js").default, state?: string, schemaObject?: import("./formatAndTypeChoices.js").ZodexSchema | undefined, schemaOriginal?: import("./formatAndTypeChoices.js").ZodexSchema | undefined) => TypesAndSchemaObjects | undefined;
     testInvalid?: ((newType: string, value: Date | Array<StructuredCloneValue>) => boolean | undefined) | undefined;
-    convertFromTypeson?: ((typesonType: import('./types.js').AvailableType) => import('./types.js').AvailableType | undefined) | undefined;
-    iterate: import('./formats/structuredCloning.js').FormatIterator;
-    getTypesForState: (types: import('./types.js').default, state?: string) => undefined | (import('./types.js').AvailableType)[];
+    convertFromTypeson?: ((typesonType: import("./types.js").AvailableType, types: import("./types.js").default, v?: import("./formats.js").StructuredCloneValue, arrayOrObjectPropertyName?: string, parentSchema?: [import("zodex").SzType, number | undefined] | undefined, stateObj?: import("./types.js").StateObject) => {
+        type: import("./types.js").AvailableType | undefined;
+        schema?: import("zodex").SzType | undefined;
+        mustBeOptional?: boolean;
+        schemaIdx?: number;
+    }) | undefined;
 };
 /**
  * An arbitrary Structured Clone, JSON, etc. value.
  * @typedef {any} StructuredCloneValue
  */
 /**
- * @callback GetTypesForFormatAndState
+ * @callback GetTypesAndSchemasForFormatAndState
  * @param {import('./types.js').default} types
  * @param {AvailableFormat} format
  * @param {string} [state]
- * @returns {import('./types.js').AvailableType[]|undefined}
+ * @param {import('./formatAndTypeChoices.js').ZodexSchema|
+ *   undefined} [schemaObject]
+ * @param {import('./formatAndTypeChoices.js').ZodexSchema|
+ *   undefined} [schemaOriginal]
+ * @returns {TypesAndSchemaObjects|undefined}
  */
 /**
- * @typedef {"indexedDBKey"|"json"|"structuredCloning"} AvailableFormat
+ * @typedef {"indexedDBKey"|"json"|"structuredCloning"|"schema"} AvailableFormat
  */
 /**
  * @typedef {{
- *   types: () => (import('./types.js').AvailableType)[],
- *   testInvalid?: (
+ *   types: (import('./types.js').AvailableType)[],
+ *   schemaObjects: import('./formats/schema.js').ZodexSchema[]
+ * }} TypesAndSchemaObjects
+ */
+/**
+ * Responsible for traversing over data (along with state information) to build
+ *   and return a relevant UI element.
+ * @callback FormatIterator
+ * @param {StructuredCloneValue} records
+ * @param {import('./types.js').StateObject} stateObj
+ * @returns {Promise<Required<import('./types.js').StateObject>>}
+ */
+/**
+ * @typedef {object} Format
+ * @property {() => (import('./types.js').AvailableType)[]} types Returns list
+ *   of types generally available to structured cloning. See
+ *   {@link getTypesAndSchemasForState} for context-dependent method.
+ * @property {FormatIterator} iterate Traverses over data to build and return
+ *   a relevant UI element.
+ * @property {(
+ *   types: import('./types.js').default,
+ *   state?: string,
+ *   schemaObject?: import('./formatAndTypeChoices.js').ZodexSchema|
+ *     undefined,
+ *   schemaOriginal?: import('./formatAndTypeChoices.js').ZodexSchema|
+ *     undefined
+ * ) => TypesAndSchemaObjects|undefined} getTypesAndSchemasForState Gets the
+ *   specific types (and schemas) relevant to a given state.
+ * @property {(
  *     newType: string, value: Date|Array<StructuredCloneValue>
- *   ) => boolean|undefined,
- *   convertFromTypeson?: (
- *     typesonType: import('./types.js').AvailableType
- *   ) => import('./types.js').AvailableType|undefined,
- *   iterate: import('./formats/structuredCloning.js').FormatIterator,
- *   getTypesForState: (
- *     types: import('./types.js').default,
- *     state?: string
- *   ) => undefined|
- *     (import('./types.js').AvailableType)[]
- * }} Format
+ *   ) => boolean|undefined} [testInvalid]
+ * @property {(
+ *   typesonType: import('./types.js').AvailableType,
+ *   types: import('./types.js').default,
+ *   v?: import('./formats.js').StructuredCloneValue,
+ *   arrayOrObjectPropertyName?: string,
+ *   parentSchema?: [import('zodex').SzType, number|undefined]|undefined,
+ *   stateObj?: import('./types.js').StateObject,
+ * ) => {
+ *   type: import('./types.js').AvailableType|undefined
+ *   schema?: import('zodex').SzType|undefined,
+ *   mustBeOptional?: boolean,
+ *   schemaIdx?: number
+ * }} [convertFromTypeson]
  */
 /**
  * Class for processing multiple formats.
@@ -55,10 +116,10 @@ declare class Formats {
      * @param {AvailableFormat} format
      * @param {StructuredCloneValue} record
      * @param {import('./types.js').StateObject} stateObj
-     * @returns {Promise<Element>}
+     * @returns {Promise<Required<import('./types.js').StateObject>>}
      */
-    getControlsForFormatAndValue(types: import('./types.js').default, format: AvailableFormat, record: StructuredCloneValue, stateObj: import('./types.js').StateObject): Promise<Element>;
-    getTypesForFormatAndState(types: import('./types.js').default, format: AvailableFormat, state?: string | undefined): import('./types.js').AvailableType[] | undefined;
+    getControlsForFormatAndValue(types: import("./types.js").default, format: AvailableFormat, record: StructuredCloneValue, stateObj: import("./types.js").StateObject): Promise<Required<import("./types.js").StateObject>>;
+    getTypesAndSchemasForFormatAndState(types: import("./types.js").default, format: AvailableFormat, state?: string | undefined, schemaObject?: import("./formatAndTypeChoices.js").ZodexSchema | undefined, schemaOriginal?: import("./formatAndTypeChoices.js").ZodexSchema | undefined): TypesAndSchemaObjects | undefined;
     /**
      * @param {AvailableFormat} format
      * @returns {Format}

package/dist/formats.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"formats.d.ts","sourceRoot":"","sources":["../src/formats.js"],"names":[],"mappings":";;;;mCAMa,GAAG;gDAKL,OAAO,YAAY,EAAE,OAAO,UAC5B,eAAe,iCAEb,OAAO,YAAY,EAAE,aAAa,EAAE,GAAC,SAAS;8BAa9C,cAAc,GAAC,MAAM,GAAC,mBAAmB;;WAK1C,MAAM,CAAC,OAAO,YAAY,EAAE,aAAa,CAAC,EAAE;6BAExC,MAAM,SAAS,IAAI,GAAC,MAAM,oBAAoB,CAAC,KACrD,OAAO,GAAC,SAAS;wCAEP,OAAO,YAAY,EAAE,aAAa,KAC5C,OAAO,YAAY,EAAE,aAAa,GAAC,SAAS;aACxC,OAAO,gCAAgC,EAAE,cAAc;8BAEvD,OAAO,YAAY,EAAE,OAAO,UAC3B,MAAM,KACX,SAAS,GAClB,CAAO,OAAO,YAAY,EAAE,aAAa,CAAC,EAAE;;AAxC7C;;;GAGG;AAEH;;;;;;GAMG;AAWH;;GAEG;AAEH;;;;;;;;;;;;;;;;GAgBG;AAEH;;GAEG;AACH;IA4BI;;MASE;IAGJ;;;;;;OAMG;IACH,oCANW,OAAO,YAAY,EAAE,OAAO,UAC5B,eAAe,UACf,oBAAoB,YACpB,OAAO,YAAY,EAAE,WAAW,GAC9B,QAAQ,OAAO,CAAC,CAY5B;IAlGA,iCACQ,OAAO,YAAY,EAAE,OAAO,UAC5B,eAAe,+BAEb,OAAO,YAAY,EAAE,aAAa,EAAE,GAAC,SAAS,CAC1D;IAwGC;;;OAGG;IACH,2BAHW,eAAe,GACb,MAAM,CAIlB;CACF"}
+{"version":3,"file":"formats.d.ts","sourceRoot":"","sources":["../src/formats.js"],"names":[],"mappings":";;;;mCAOa,GAAG;0DAKL,OAAO,YAAY,EAAE,OAAO,UAC5B,eAAe,6CAEf,OAAO,2BAA2B,EAAE,WAAW,GACzD,SAAa,mBACH,OAAO,2BAA2B,EAAE,WAAW,GACzD,SAAa,KACD,qBAAqB,GAAC,SAAS;8BAa/B,cAAc,GAAC,MAAM,GAAC,mBAAmB,GAAC,QAAQ;oCAIlD;IACZ,KAAS,EAAE,CAAC,OAAO,YAAY,EAAE,aAAa,CAAC,EAAE,CAAC;IAClD,aAAiB,EAAE,OAAO,qBAAqB,EAAE,WAAW,EAAE,CAAA;CAC3D;;;;;uCAOO,oBAAoB,YACpB,OAAO,YAAY,EAAE,WAAW,KAC9B,OAAO,CAAC,QAAQ,CAAC,OAAO,YAAY,EAAE,WAAW,CAAC,CAAC;;;;;;;WAKlD,MAAM,CAAC,OAAO,YAAY,EAAE,aAAa,CAAC,EAAE;;;;;aAG5C,cAAc;;;;;gCAEd,CACT,KAAK,EAAE,OAAO,YAAY,EAAE,OAAO,EACnC,KAAK,CAAC,EAAE,MAAM,EACd,YAAY,CAAC,EAAE,OAAO,2BAA2B,EAAE,WAAW,GAClE,SAAe,EACX,cAAc,CAAC,EAAE,OAAO,2BAA2B,EAAE,WAAW,GACpE,SAAe,KACR,qBAAqB,GAAC,SAAS;6BAGvB,MAAM,SAAS,IAAI,GAAC,KAAK,CAAC,oBAAoB,CAAC,KACrD,OAAO,GAAC,SAAS;wCAET,OAAO,YAAY,EAAE,aAAa,SACxC,OAAO,YAAY,EAAE,OAAO,MAC/B,OAAO,cAAc,EAAE,oBAAoB,8BACnB,MAAM,iBACnB,CAAC,OAAO,OAAO,EAAE,MAAM,EAAE,MAAM,GAAC,SAAS,CAAC,GAAC,SAAS,aACxD,OAAO,YAAY,EAAE,WAAW,KACxC;QACP,IAAQ,EAAE,OAAO,YAAY,EAAE,aAAa,GAAC,SAAS,CAAA;QACtD,MAAU,CAAC,EAAE,OAAO,OAAO,EAAE,MAAM,GAAC,SAAS,CAAC;QAC9C,cAAkB,CAAC,EAAE,OAAO,CAAC;QAC7B,SAAa,CAAC,EAAE,MAAM,CAAA;KACnB;;AA7EJ;;;GAGG;AAEH;;;;;;;;;;GAUG;AAWH;;GAEG;AAEH;;;;;GAKG;AAEH;;;;;;;GAOG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AAEH;;GAEG;AACH;IA4BI;;MAKE;IAGJ;;;;;;OAMG;IACH,oCANW,OAAO,YAAY,EAAE,OAAO,UAC5B,eAAe,UACf,oBAAoB,YACpB,OAAO,YAAY,EAAE,WAAW,GAC9B,OAAO,CAAC,QAAQ,CAAC,OAAO,YAAY,EAAE,WAAW,CAAC,CAAC,CAY/D;IAlIA,2CACQ,OAAO,YAAY,EAAE,OAAO,UAC5B,eAAe,6CAEf,OAAO,2BAA2B,EAAE,WAAW,GACzD,SAAa,mBACH,OAAO,2BAA2B,EAAE,WAAW,GACzD,SAAa,GACD,qBAAqB,GAAC,SAAS,CAC3C;IAsIC;;;OAGG;IACH,2BAHW,eAAe,GACb,MAAM,CAIlB;CACF"}

package/dist/fundamentalTypes/BooleanObjectType.d.ts

@@ -2,7 +2,7 @@ export default BooleanObjectType;
 /**
  * @type {import('../types.js').TypeObject & {ct: number}}
  */
-declare const BooleanObjectType: import('../types.js').TypeObject & {
+declare const BooleanObjectType: import("../types.js").TypeObject & {
     ct: number;
 };
 //# sourceMappingURL=BooleanObjectType.d.ts.map

package/dist/fundamentalTypes/BooleanObjectType.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BooleanObjectType.d.ts","sourceRoot":"","sources":["../../src/fundamentalTypes/BooleanObjectType.js"],"names":[],"mappings":";AAEA;;GAEG;AACH,iCAFU,OAAO,aAAa,EAAE,UAAU,GAAG;IAAC,EAAE,EAAE,MAAM,CAAA;CAAC,CAqDvD"}
+{"version":3,"file":"BooleanObjectType.d.ts","sourceRoot":"","sources":["../../src/fundamentalTypes/BooleanObjectType.js"],"names":[],"mappings":";AAGA;;GAEG;AACH,iCAFU,OAAO,aAAa,EAAE,UAAU,GAAG;IAAC,EAAE,EAAE,MAAM,CAAA;CAAC,CAgEvD"}

package/dist/fundamentalTypes/NumberObjectType.d.ts

@@ -2,5 +2,5 @@ export default NumberObjectType;
 /**
  * @type {import('../types.js').TypeObject}
  */
-declare const NumberObjectType: import('../types.js').TypeObject;
+declare const NumberObjectType: import("../types.js").TypeObject;
 //# sourceMappingURL=NumberObjectType.d.ts.map

package/dist/fundamentalTypes/NumberObjectType.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"NumberObjectType.d.ts","sourceRoot":"","sources":["../../src/fundamentalTypes/NumberObjectType.js"],"names":[],"mappings":";AAGA;;GAEG;AACH,gCAFU,OAAO,aAAa,EAAE,UAAU,CAsCxC"}
+{"version":3,"file":"NumberObjectType.d.ts","sourceRoot":"","sources":["../../src/fundamentalTypes/NumberObjectType.js"],"names":[],"mappings":";AAIA;;GAEG;AACH,gCAFU,OAAO,aAAa,EAAE,UAAU,CAkDxC"}

package/dist/fundamentalTypes/StringObjectType.d.ts

@@ -2,5 +2,5 @@ export default StringObjectType;
 /**
  * @type {import('../types.js').TypeObject}
  */
-declare const StringObjectType: import('../types.js').TypeObject;
+declare const StringObjectType: import("../types.js").TypeObject;
 //# sourceMappingURL=StringObjectType.d.ts.map

package/dist/fundamentalTypes/StringObjectType.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"StringObjectType.d.ts","sourceRoot":"","sources":["../../src/fundamentalTypes/StringObjectType.js"],"names":[],"mappings":";AAEA;;GAEG;AACH,gCAFU,OAAO,aAAa,EAAE,UAAU,CAiCxC"}
+{"version":3,"file":"StringObjectType.d.ts","sourceRoot":"","sources":["../../src/fundamentalTypes/StringObjectType.js"],"names":[],"mappings":";AAGA;;GAEG;AACH,gCAFU,OAAO,aAAa,EAAE,UAAU,CA4CxC"}

package/dist/fundamentalTypes/arrayReferenceType.d.ts

@@ -2,7 +2,7 @@ export default arrayReferenceType;
 /**
  * @type {import('../types.js').TypeObject & {type: "array"}}
  */
-declare const arrayReferenceType: import('../types.js').TypeObject & {
+declare const arrayReferenceType: import("../types.js").TypeObject & {
     type: "array";
 };
 //# sourceMappingURL=arrayReferenceType.d.ts.map

package/dist/fundamentalTypes/arrayType.d.ts

@@ -1,9 +1,9 @@
 export default arrayType;
 export type Integer = number;
-export type ParseInt = () => any;
+export type ParseInt = (this: HTMLInputElement) => false | Integer;
 export type InputsExceedingLength = () => HTMLInputElement[];
 export type GetMapKeySelects = () => (HTMLSelectElement & {
-    $getValue: import('../typeChoices.js').GetValue;
+    $getValue: import("../typeChoices.js").GetValue;
 })[];
 export type ValidateMapKey = () => void;
 export type GetPropertyInputs = () => HTMLInputElement[];
@@ -23,7 +23,7 @@ export type AnyValue = any;
 /**
  * @type {import('../types.js').TypeObject & {sparse?: boolean|undefined}}
  */
-declare const arrayType: import('../types.js').TypeObject & {
+declare const arrayType: import("../types.js").TypeObject & {
     sparse?: boolean | undefined;
 };
 //# sourceMappingURL=arrayType.d.ts.map

package/dist/fundamentalTypes/arrayType.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"arrayType.d.ts","sourceRoot":"","sources":["../../src/fundamentalTypes/arrayType.js"],"names":[],"mappings":";sBAWa,MAAM;;oCAQN,MAAM,gBAAgB,EAAE;+BAGxB,MAAM,CAAC,iBAAiB,GAAG;IACvC,SAAa,EAAE,OAAO,mBAAmB,EAAE,QAAQ,CAAA;CAChD,CAAC,EAAE;6BAGM,MAAM,IAAI;sCAIV,gBAAgB,EAAE;qCAKlB,IAAI;4BAGJ,MAAM,cAAc,GAAG;IACnC,sBAA0B,EAAE,qBAAqB,CAAC;IAClD,kBAAsB,EAAE,iBAAiB,CAAC;IAC1C,iBAAqB,EAAE,gBAAgB,CAAC;IACxC,iBAAqB,EAAE,gBAAgB,CAAA;CACpC;uBAGS,MAAM,QAAQ,IAAI,CAAC;2BAKrB;IAAC,WAAW,CAAC,EAAE,IAAI,CAAA;CAAC,KAClB,IAAI;+BAIJ,MAAM,gBAAgB,GAAC,SAAS;uBAIhC,GAAG;AAmBhB;;GAEG;AACH,yBAFU,OAAO,aAAa,EAAE,UAAU,GAAG;IAAC,MAAM,CAAC,EAAE,OAAO,GAAC,SAAS,CAAA;CAAC,CA6pDvE"}
+{"version":3,"file":"arrayType.d.ts","sourceRoot":"","sources":["../../src/fundamentalTypes/arrayType.js"],"names":[],"mappings":";sBAaa,MAAM;mDAKN,KAAK,GAAC,OAAO;oCAGb,MAAM,gBAAgB,EAAE;+BAGxB,MAAM,CAAC,iBAAiB,GAAG;IACvC,SAAa,EAAE,OAAO,mBAAmB,EAAE,QAAQ,CAAA;CAChD,CAAC,EAAE;6BAGM,MAAM,IAAI;sCAIV,gBAAgB,EAAE;qCAKlB,IAAI;4BAGJ,MAAM,cAAc,GAAG;IACnC,sBAA0B,EAAE,qBAAqB,CAAC;IAClD,kBAAsB,EAAE,iBAAiB,CAAC;IAC1C,iBAAqB,EAAE,gBAAgB,CAAC;IACxC,iBAAqB,EAAE,gBAAgB,CAAA;CACpC;uBAGS,MAAM,OAAO,CAAC,IAAI,CAAC;2BAKrB;IAAC,WAAW,CAAC,EAAE,IAAI,CAAA;CAAC,KAClB,IAAI;+BAIJ,MAAM,gBAAgB,GAAC,SAAS;uBAIhC,GAAG;AAmBhB;;GAEG;AACH,yBAFU,OAAO,aAAa,EAAE,UAAU,GAAG;IAAC,MAAM,CAAC,EAAE,OAAO,GAAC,SAAS,CAAA;CAAC,CA+1EvE"}

package/dist/fundamentalTypes/bigintObjectType.d.ts

@@ -0,0 +1,6 @@
+export default bigintObjectType;
+/**
+ * @type {import('../types.js').TypeObject}
+ */
+declare const bigintObjectType: import("../types.js").TypeObject;
+//# sourceMappingURL=bigintObjectType.d.ts.map

package/dist/fundamentalTypes/bigintObjectType.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bigintObjectType.d.ts","sourceRoot":"","sources":["../../src/fundamentalTypes/bigintObjectType.js"],"names":[],"mappings":";AAGA;;GAEG;AACH,gCAFU,OAAO,aAAa,EAAE,UAAU,CAyDxC"}

package/dist/fundamentalTypes/bigintType.d.ts

@@ -2,5 +2,5 @@ export default bigintType;
 /**
  * @type {import('../types.js').TypeObject}
  */
-declare const bigintType: import('../types.js').TypeObject;
+declare const bigintType: import("../types.js").TypeObject;
 //# sourceMappingURL=bigintType.d.ts.map

package/dist/fundamentalTypes/bigintType.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"bigintType.d.ts","sourceRoot":"","sources":["../../src/fundamentalTypes/bigintType.js"],"names":[],"mappings":";AAEA;;GAEG;AACH,0BAFU,OAAO,aAAa,EAAE,UAAU,CA+CxC"}
+{"version":3,"file":"bigintType.d.ts","sourceRoot":"","sources":["../../src/fundamentalTypes/bigintType.js"],"names":[],"mappings":";AAEA;;GAEG;AACH,0BAFU,OAAO,aAAa,EAAE,UAAU,CAyExC"}

package/dist/fundamentalTypes/blobType.d.ts

@@ -7,5 +7,5 @@ export type SetValue = (blob: BlobInfo) => void;
 /**
  * @type {import('../types.js').TypeObject}
  */
-declare const blobType: import('../types.js').TypeObject;
+declare const blobType: import("../types.js").TypeObject;
 //# sourceMappingURL=blobType.d.ts.map

package/dist/fundamentalTypes/blobType.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"blobType.d.ts","sourceRoot":"","sources":["../../src/fundamentalTypes/blobType.js"],"names":[],"mappings":";uBAMa,IAAI,GAAC;IACjB,IAAQ,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAC3B;8BAIgB,QAAQ,KAAK,IAAI;AAkIrC;;GAEG;AACH,wBAFU,OAAO,aAAa,EAAE,UAAU,CA21BxC"}
+{"version":3,"file":"blobType.d.ts","sourceRoot":"","sources":["../../src/fundamentalTypes/blobType.js"],"names":[],"mappings":";uBAMa,IAAI,GAAC;IACjB,IAAQ,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAC3B;uBAIS,CAAC,IAAI,EAAE,QAAQ,KAAK,IAAI;AAsIrC;;GAEG;AACH,wBAFU,OAAO,aAAa,EAAE,UAAU,CAk2BxC"}

package/dist/fundamentalTypes/booleanType.d.ts

@@ -0,0 +1,8 @@
+export default booleanType;
+/**
+ * @type {import('../types.js').TypeObject & {ct: number}}
+ */
+declare const booleanType: import("../types.js").TypeObject & {
+    ct: number;
+};
+//# sourceMappingURL=booleanType.d.ts.map

package/dist/fundamentalTypes/booleanType.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"booleanType.d.ts","sourceRoot":"","sources":["../../src/fundamentalTypes/booleanType.js"],"names":[],"mappings":";AAEA;;GAEG;AACH,2BAFU,OAAO,aAAa,EAAE,UAAU,GAAG;IAAC,EAAE,EAAE,MAAM,CAAA;CAAC,CAyDvD"}

package/dist/fundamentalTypes/catchType.d.ts

@@ -0,0 +1,6 @@
+export default catchType;
+/**
+ * @type {import('../types.js').TypeObject}
+ */
+declare const catchType: import("../types.js").TypeObject;
+//# sourceMappingURL=catchType.d.ts.map

package/dist/fundamentalTypes/catchType.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"catchType.d.ts","sourceRoot":"","sources":["../../src/fundamentalTypes/catchType.js"],"names":[],"mappings":";AAEA;;GAEG;AACH,yBAFU,OAAO,aAAa,EAAE,UAAU,CAsIxC"}

package/dist/fundamentalTypes/dateType.d.ts

@@ -1,8 +1,8 @@
 export default dateType;
-export type SetValidity = (legitimateInvalid?: true | undefined) => void;
+export type SetValidity = (legitimateInvalid?: boolean | undefined) => void;
 /**
  * @typedef {(
- *   legitimateInvalid?: true|undefined
+ *   legitimateInvalid?: boolean|undefined
  * ) => void} SetValidity
  */
 /**
@@ -20,7 +20,7 @@ declare const dateType: import("../types.js").TypeObject & {
     isInvalid: (cfg: {
         root: HTMLDivElement;
     }) => boolean;
-    isValueInvalid: (value: import('../formats.js').StructuredCloneValue) => boolean;
-    valid?: true | undefined;
+    isValueInvalid: (value: import("../formats.js").StructuredCloneValue) => boolean;
+    valid?: true;
 };
 //# sourceMappingURL=dateType.d.ts.map