@es-joy/jsoe 0.24.2 → 0.25.0

package/dist/src/types.d.ts

@@ -0,0 +1,758 @@
+/**
+ *
+ * @param {string} str
+ * @returns {string}
+ */
+export function escapeRegex(str: string): string;
+export function getPropertyValueFromLegend(legend: HTMLLegendElement): string;
+export default Types;
+/**
+ * Any other possibilities than `div`?
+ */
+export type RootElement = HTMLDivElement;
+/**
+ * Utility to retrieve the type out of a type root element.
+ */
+export type GetTypeForRoot = (root: RootElement | null) => AvailableArbitraryType;
+/**
+ * Utility to get the value out of a type root element with a given
+ *   state and path.
+ */
+export type GetValueForRoot = (root: RootElement, stateObj?: StateObject | undefined, currentPath?: string | undefined) => StructuredCloneValue;
+/**
+ * Utility to get the form control (e.g., input element) for a root.
+ */
+export type GetFormControlForRoot = (root: RootElement) => null | HTMLInputElement | HTMLTextAreaElement | HTMLSelectElement | HTMLButtonElement;
+/**
+ * Utility to get the value for a root using its ancestor and state.
+ */
+export type GetValueFromRootAncestor = (selOrEl: string | HTMLElement, stateObj?: StateObject | undefined) => StructuredCloneValue;
+export type GetFormControlFromRootAncestor = (selOrEl: string | HTMLElement) => null | HTMLInputElement | HTMLTextAreaElement | HTMLSelectElement | HTMLButtonElement;
+export type Integer = number;
+export type GetOptionForType = (type: AvailableArbitraryType, schemaContent?: import("./formatAndTypeChoices.js").ZodexSchema | undefined) => [string, {
+    value: AvailableType;
+    title?: string;
+}];
+export type GetTypeOptionsForFormatAndState = (format: import("./formats.js").AvailableFormat, parserState?: string | undefined, schemaContent?: import("./formatAndTypeChoices.js").ZodexSchema | undefined, schemaOriginal?: import("./formatAndTypeChoices.js").ZodexSchema | undefined) => {
+    typeOptions: [string, {
+        value: AvailableType;
+        title?: string;
+    }][];
+    schemaObjects: import("./formats/schema.js").ZodexSchema[];
+};
+export type StateObject = {
+    typeNamespace?: string;
+    "readonly"?: boolean;
+    format?: import("./formats.js").AvailableFormat;
+    formats?: import("./formats.js").default;
+    types?: Types;
+    error?: Error;
+    rootUI?: Element;
+    schema?: string;
+    schemaParent?: import("./formats/schema.js").ZodexSchema;
+    schemaContent?: import("./formats/schema.js").ZodexSchema;
+    specificSchema?: import("./formats/schema.js").ZodexSchema;
+    specificSchemas?: import("./formats/schema.js").ZodexSchema[];
+    paths?: {
+        [currentPath: string]: {
+            referentPath: string;
+            expectArrayReferent: boolean;
+        };
+    };
+    handlingReference?: boolean;
+};
+export type GetUIForModeAndType = (cfg: {
+    readonly?: boolean;
+    resultType?: "both" | "keys" | "values";
+    typeNamespace?: string;
+    type: AvailableArbitraryType;
+    topRoot?: RootElement;
+    bringIntoFocus?: boolean | undefined;
+    buildTypeChoices?: import("./typeChoices.js").BuildTypeChoices;
+    format: import("./formats.js").AvailableFormat;
+    schemaContent?: import("./formats/schema.js").ZodexSchema;
+    specificSchemaObject?: import("./formats/schema.js").ZodexSchema;
+    value: StructuredCloneValue;
+    hasValue: boolean;
+    replaced?: StructuredCloneValue;
+    schemaFallingBack?: boolean;
+}) => HTMLElement;
+export type ValidValuesSet = (cfg: {
+    form: HTMLFormElement;
+    typeNamespace?: string;
+    keySelectClass?: string;
+}) => boolean;
+export type ValidateAllReferences = (cfg: {
+    topRoot: RootElement;
+}) => void;
+export type Validate = (cfg: {
+    type: AvailableArbitraryType;
+    root: RootElement;
+    topRoot?: RootElement;
+    avoidReport?: boolean;
+}) => boolean;
+export type SetValue = (cfg: {
+    type: AvailableArbitraryType;
+    root: RootElement;
+    value: StructuredCloneValue;
+}) => void;
+export type GetValueForString = (s: string, cfg: {
+    format: import("./formats.js").AvailableFormat;
+    state?: string;
+    endMatchTypeObjs?: TypeObject[];
+    firstRun?: boolean;
+    rootHolder?: [type: string, parent: {
+        [key: string]: any;
+    } | undefined, parentPath: string | number | undefined, path: string][];
+    parent?: {
+        [key: string]: any;
+    };
+    parentPath?: string | number;
+    schemaObject?: import("./formatAndTypeChoices.js").ZodexSchema | undefined;
+    schemaOriginal?: import("./formatAndTypeChoices.js").ZodexSchema | undefined;
+}) => [value: StructuredCloneValue, remnant: string, beginOnly: boolean, assign: boolean];
+export type CustomValidateAllReferences = (info: {
+    topRoot: HTMLDivElement;
+}) => void;
+export type StructuredCloneValue = import("./formats.js").StructuredCloneValue;
+export type JamilihArray = import("jamilih").JamilihArray;
+export type RootInfo = {
+    format: import("./formats.js").AvailableFormat;
+    match: boolean | RegExpMatchArray | null;
+    endMatchTypeObjs: TypeObject[];
+    remnant: string;
+    rootHolder: [type: string, parent: object | undefined, parentPath: string | number | undefined, path: string][];
+    parent?: object;
+    parentPath?: string | number;
+    types?: Types;
+    schemaObject?: import("./formatAndTypeChoices.js").ZodexSchema | undefined;
+};
+export type TypeObjectSetValue = (info: {
+    root: HTMLDivElement;
+    value: StructuredCloneValue;
+}) => void;
+export type ToValue = (s: string, info?: RootInfo) => {
+    value?: StructuredCloneValue;
+    remnant?: string;
+    assign?: false;
+};
+export type TypeObject = {
+    /**
+     * Creates the option HTML. May set an option `title` or `value`
+     */
+    option: [string, {
+        value?: AvailableType;
+        title?: string;
+    }?];
+    /**
+     * Private context variable. Whether or not
+     * it is an array. Do not use in other types.
+     */
+    array?: boolean | undefined;
+    /**
+     * Private context variable. Whether or not
+     * it is a `Map`. Do not use in other types.
+     */
+    map?: boolean | undefined;
+    /**
+     * Private context variable. Whether or not
+     * it is a `Set`. Do not use in other types.
+     */
+    set?: boolean | undefined;
+    /**
+     * Private context variable. Whether or not
+     * it is a `Record`. Do not use in other types.
+     */
+    record?: boolean | undefined;
+    /**
+     * Private context variable. Whether or not
+     * it is a tuple type. Do not use in other types.
+     */
+    tuple?: boolean | undefined;
+    /**
+     * Private context variable. Whether or not
+     * it is a `FileList` type. Do not use in other types.
+     */
+    filelist?: boolean | undefined;
+    /**
+     * Private context variable. Whether or not
+     * it is a sparse array. Do not use in other types.
+     */
+    sparse?: boolean | undefined;
+    /**
+     * Private context variable. Whether or not
+     * it is a valid date. Do not use in other types.
+     */
+    valid?: boolean | undefined;
+    /**
+     * Used for string parsing.
+     */
+    regexEndings?: string[] | undefined;
+    /**
+     * Used
+     * for string parsing. If not present, use `stringRegexBegin` and
+     * `stringRegexEnd`.
+     */
+    stringRegex?: RegExp | ((nonGrouping?: boolean) => RegExp) | undefined;
+    /**
+     * Used for string parsing. If not
+     * present, use `stringRegex`
+     */
+    stringRegexBegin?: RegExp | undefined;
+    /**
+     * Used for string parsing. If not
+     * present, use `stringRegex`
+     */
+    stringRegexEnd?: RegExp | undefined;
+    /**
+     * Function to check whether this type or subtype
+     * matches
+     */
+    valueMatch?: ((v: StructuredCloneValue) => boolean) | undefined;
+    /**
+     * The greater fundamental type to which
+     * the type belongs
+     */
+    superType?: string | undefined;
+    /**
+     * Converts from string to value. May use
+     * `stringRegex` to find components.
+     */
+    toValue?: ToValue | undefined;
+    /**
+     * Gets the value for the type
+     */
+    getValue: (info: {
+        root: HTMLDivElement;
+        stateObj?: StateObject;
+        currentPath?: string;
+    }) => StructuredCloneValue;
+    types?: Types | undefined;
+    /**
+     * Should set the value of the
+     * form's `getInput` element
+     */
+    setValue?: TypeObjectSetValue | undefined;
+    viewUI: (info: {
+        value?: StructuredCloneValue;
+        typeNamespace?: string;
+        type?: AvailableArbitraryType;
+        topRoot?: HTMLDivElement;
+        resultType?: "keys" | "values" | "both";
+        format: import("./formats.js").AvailableFormat;
+        specificSchemaObject?: import("./formats/schema.js").ZodexSchema;
+        types: Types;
+        bringIntoFocus?: boolean | undefined;
+        buildTypeChoices?: import("./typeChoices.js").BuildTypeChoices;
+        schemaContent?: import("./formats/schema.js").ZodexSchema;
+        replaced?: any;
+    }) => JamilihArray;
+    editUI: (info: {
+        value?: StructuredCloneValue;
+        typeNamespace?: string;
+        bringIntoFocus?: boolean;
+        format?: import("./formats.js").AvailableFormat;
+        formats?: import("./formats.js").default;
+        types: Types;
+        resultType?: "keys" | "values" | "both";
+        type?: AvailableArbitraryType;
+        forcedState?: string;
+        buildTypeChoices?: import("./typeChoices.js").BuildTypeChoices;
+        topRoot?: HTMLDivElement;
+        schemaContent?: import("./formats/schema.js").ZodexSchema;
+        specificSchemaObject?: import("./formats/schema.js").ZodexSchema;
+        schemaFallingBack?: boolean;
+    }) => JamilihArray;
+    /**
+     * Gets the form control (with `value`)
+     */
+    getInput: (info: {
+        root: HTMLDivElement;
+    }) => HTMLInputElement | HTMLTextAreaElement | HTMLSelectElement | HTMLButtonElement;
+    getSelect?: ((info: {
+        root: HTMLDivElement;
+    }) => HTMLSelectElement) | undefined;
+    /**
+     * Gets the reference. For array
+     * and object references types only
+     */
+    resolveReference?: ((path: string, value: StructuredCloneValue) => StructuredCloneValue) | undefined;
+    /**
+     * Message will be used if validity is false.
+     */
+    validate?: ((info: {
+        root: HTMLDivElement;
+        topRoot?: HTMLDivElement;
+    }) => {
+        message?: string;
+        valid: boolean;
+    }) | undefined;
+    /**
+     * For
+     * validation of array and object references only.
+     */
+    validateAll?: ((info: {
+        topRoot: HTMLDivElement;
+        types: Types;
+    }) => void) | undefined;
+    /**
+     * The type after which it should be placed and its
+     * context types
+     */
+    stateDependent?: {
+        structuredCloning: {
+            after: AvailableType;
+            contexts: string[];
+        };
+    } | undefined;
+};
+export type AvailableType = "null" | "true" | "false" | "number" | "bigint" | "bigintObject" | "string" | "arrayReference" | "objectReference" | "array" | "object" | "date" | "userObject" | "undef" | "SpecialRealNumber" | "SpecialNumber" | "regexp" | "BooleanObject" | "NumberObject" | "StringObject" | "map" | "set" | "file" | "filelist" | "blobHTML" | "buffersource" | "dataview" | "imagedata" | "imagebitmap" | "int8array" | "uint8array" | "uint8clampedarray" | "int16array" | "uint16array" | "int32array" | "uint32array" | "float32array" | "float64array" | "ValidDate" | "arrayNonindexKeys" | "error" | "errors" | "blob" | "domexception" | "domrect" | "dompoint" | "dommatrix" | "resurrectable" | "boolean" | "nan" | "tuple" | "record" | "void" | "enum" | "literal" | "never" | "catch";
+export type AvailableArbitraryType = AvailableType | "symbol" | "promise" | "function";
+export type SuperTypeObject = TypeObject & {
+    childTypes: string[];
+};
+/**
+ * Any other possibilities than `div`?
+ * @typedef {HTMLDivElement} RootElement
+ */
+/**
+ * Utility to retrieve the type out of a type root element.
+ * @callback GetTypeForRoot
+ * @param {?RootElement} root
+ * @returns {AvailableArbitraryType} Why would it not exist?
+ */
+/**
+ * Utility to get the value out of a type root element with a given
+ *   state and path.
+ * @callback GetValueForRoot
+ * @param {RootElement} root
+ * @param {StateObject} [stateObj]
+ * @param {string} [currentPath]
+ * @returns {StructuredCloneValue}
+ */
+/**
+ * Utility to get the form control (e.g., input element) for a root.
+ * @callback GetFormControlForRoot
+ * @param {RootElement} root
+ * @returns {null|
+ *   HTMLInputElement|HTMLTextAreaElement|HTMLSelectElement|HTMLButtonElement}
+ */
+/**
+ * Utility to get the value for a root using its ancestor and state.
+ * @callback GetValueFromRootAncestor
+ * @param {string|HTMLElement} selOrEl
+ * @param {StateObject} [stateObj]
+ * @returns {StructuredCloneValue}
+ */
+/**
+ * @callback GetFormControlFromRootAncestor
+ * @param {string|HTMLElement} selOrEl
+ * @returns {null|HTMLInputElement|HTMLTextAreaElement|HTMLSelectElement|
+ *   HTMLButtonElement}
+ */
+/**
+ * @typedef {number} Integer
+ */
+/**
+ * @callback GetOptionForType
+ * @param {AvailableArbitraryType} type
+ * @param {import('./formatAndTypeChoices.js').ZodexSchema|
+ *   undefined} [schemaContent]
+ * @returns {[string, {value: AvailableType, title?: string}]}
+ */
+/**
+ * @callback GetTypeOptionsForFormatAndState
+ * @param {import('./formats.js').AvailableFormat} format
+ * @param {string} [parserState]
+ * @param {import('./formatAndTypeChoices.js').ZodexSchema|
+ *   undefined} [schemaContent]
+ * @param {import('./formatAndTypeChoices.js').ZodexSchema|
+ *   undefined} [schemaOriginal]
+ * @returns {{
+ *   typeOptions: [string, {value: AvailableType, title?: string}][],
+ *   schemaObjects: import('./formats/schema.js').ZodexSchema[]
+ * }}
+ */
+/**
+* @typedef {{
+*   typeNamespace?: string,
+*   "readonly"?: boolean,
+*   format?: import('./formats.js').AvailableFormat,
+*   formats?: import('./formats.js').default,
+*   types?: Types,
+*   error?: Error,
+*   rootUI?: Element,
+*   schema?: string,
+*   schemaParent?: import('./formats/schema.js').ZodexSchema,
+*   schemaContent?: import('./formats/schema.js').ZodexSchema,
+*   specificSchema?: import('./formats/schema.js').ZodexSchema,
+*   specificSchemas?: import('./formats/schema.js').ZodexSchema[],
+*   paths?: {[currentPath: string]: {
+*     referentPath: string,
+*     expectArrayReferent: boolean
+*   }},
+*   handlingReference?: boolean
+* }} StateObject
+*/
+/**
+ * @typedef {(cfg: {
+ *   readonly?: boolean,
+ *   resultType?: "both"|"keys"|"values",
+ *   typeNamespace?: string,
+ *   type: AvailableArbitraryType,
+ *   topRoot?: RootElement,
+ *   bringIntoFocus?: boolean|undefined,
+ *   buildTypeChoices?: import('./typeChoices.js').BuildTypeChoices,
+ *   format: import('./formats.js').AvailableFormat,
+ *   schemaContent?: import('./formats/schema.js').ZodexSchema
+ *   specificSchemaObject?: import('./formats/schema.js').ZodexSchema
+ *   value: StructuredCloneValue,
+ *   hasValue: boolean,
+ *   replaced?: StructuredCloneValue,
+ *   schemaFallingBack?: boolean
+ * }) => HTMLElement} GetUIForModeAndType
+ */
+/**
+ * @typedef {(cfg: {
+ *   form: HTMLFormElement,
+ *   typeNamespace?: string,
+ *   keySelectClass?: string,
+ * }) => boolean} ValidValuesSet
+ */
+/**
+ * @typedef {(cfg: {
+ *   topRoot: RootElement
+ * }) => void} ValidateAllReferences
+ */
+/**
+ * @typedef {(cfg: {
+ *   type: AvailableArbitraryType,
+ *   root: RootElement,
+ *   topRoot?: RootElement,
+ *   avoidReport?: boolean
+ * }) => boolean} Validate
+ */
+/**
+ * @typedef {(cfg: {
+ *   type: AvailableArbitraryType,
+ *   root: RootElement,
+ *   value: StructuredCloneValue,
+ * }) => void} SetValue
+ */
+/**
+ * @typedef {(s: string, cfg: {
+ *   format: import('./formats.js').AvailableFormat,
+ *   state?: string,
+ *   endMatchTypeObjs?: TypeObject[]
+ *   firstRun?: boolean,
+ *   rootHolder?: [
+ *     type: string,
+ *     parent: {[key: string]: any}|undefined,
+ *     parentPath: string|number|undefined,
+ *     path: string
+ *   ][],
+ *   parent?: {[key: string]: any},
+ *   parentPath?: string|number,
+ *   schemaObject?: import('./formatAndTypeChoices.js').ZodexSchema|undefined
+ *   schemaOriginal?: import('./formatAndTypeChoices.js').ZodexSchema|undefined
+ * }) => [
+*   value: StructuredCloneValue,
+*   remnant: string,
+*   beginOnly: boolean,
+*   assign: boolean
+* ]} GetValueForString
+*/
+/**
+ * @typedef {(
+ *   info: {topRoot: HTMLDivElement}
+ * ) => void} CustomValidateAllReferences
+ */
+/**
+ * @typedef {import('./formats.js').StructuredCloneValue} StructuredCloneValue
+ */
+/**
+ * @typedef {import('jamilih').JamilihArray} JamilihArray
+ */
+/**
+ * @typedef {{
+ *   format: import('./formats.js').AvailableFormat,
+ *   match: boolean|RegExpMatchArray|null
+ *   endMatchTypeObjs: TypeObject[],
+ *   remnant: string,
+ *   rootHolder: [
+ *     type: string,
+ *     parent: object|undefined,
+ *     parentPath: string|number|undefined,
+ *     path: string
+ *   ][],
+ *   parent?: object,
+ *   parentPath?: string|number,
+ *   types?: Types
+ *   schemaObject?: import('./formatAndTypeChoices.js').ZodexSchema|undefined
+ * }} RootInfo
+ */
+/**
+ * @typedef {(
+ *   info: {
+ *     root: HTMLDivElement,
+ *     value: StructuredCloneValue
+ *   }
+ * ) => void} TypeObjectSetValue
+ */
+/**
+ * @typedef {(
+ *   s: string, info?: RootInfo
+ * ) => {
+ *   value?: StructuredCloneValue,
+ *   remnant?: string,
+ *   assign?: false
+ * }} ToValue
+ */
+/**
+ * @typedef {object} TypeObject
+ * @property {[
+ *   string, {value?: AvailableType, title?: string}?
+ * ]} option Creates the option HTML. May set an option `title` or `value`
+ * @property {boolean} [array] Private context variable. Whether or not
+ *   it is an array. Do not use in other types.
+ * @property {boolean} [map] Private context variable. Whether or not
+ *   it is a `Map`. Do not use in other types.
+ * @property {boolean} [set] Private context variable. Whether or not
+ *   it is a `Set`. Do not use in other types.
+ * @property {boolean} [record] Private context variable. Whether or not
+ *   it is a `Record`. Do not use in other types.
+ * @property {boolean} [tuple] Private context variable. Whether or not
+ *   it is a tuple type. Do not use in other types.
+ * @property {boolean} [filelist] Private context variable. Whether or not
+ *   it is a `FileList` type. Do not use in other types.
+ * @property {boolean} [sparse] Private context variable. Whether or not
+ *   it is a sparse array. Do not use in other types.
+ * @property {boolean} [valid] Private context variable. Whether or not
+ *   it is a valid date. Do not use in other types.
+ * @property {string[]} [regexEndings] Used for string parsing.
+ * @property {RegExp|((nonGrouping?: boolean) => RegExp)} [stringRegex] Used
+ *   for string parsing. If not present, use `stringRegexBegin` and
+ *   `stringRegexEnd`.
+ * @property {RegExp} [stringRegexBegin] Used for string parsing. If not
+ *   present, use `stringRegex`
+ * @property {RegExp} [stringRegexEnd] Used for string parsing. If not
+ *   present, use `stringRegex`
+ * @property {(
+ *   v: StructuredCloneValue
+ * ) => boolean} [valueMatch] Function to check whether this type or subtype
+ *   matches
+ * @property {string} [superType] The greater fundamental type to which
+ *   the type belongs
+ * @property {ToValue} [toValue] Converts from string to value. May use
+ *   `stringRegex` to find components.
+ * @property {(info: {
+ *   root: HTMLDivElement,
+ *   stateObj?: StateObject,
+ *   currentPath?: string
+ * }) =>
+ *  StructuredCloneValue
+ * } getValue Gets the value for the type
+ * @property {Types} [types]
+ * @property {TypeObjectSetValue} [setValue] Should set the value of the
+ *   form's `getInput` element
+ * @property {(info: {
+ *   value?: StructuredCloneValue,
+ *   typeNamespace?: string,
+ *   type?: AvailableArbitraryType,
+ *   topRoot?: HTMLDivElement,
+ *   resultType?: "keys"|"values"|"both",
+ *   format: import('./formats.js').AvailableFormat,
+ *   specificSchemaObject?: import('./formats/schema.js').ZodexSchema,
+ *   types: Types
+ *   bringIntoFocus?: boolean|undefined,
+ *   buildTypeChoices?: import('./typeChoices.js').BuildTypeChoices,
+ *   schemaContent?: import('./formats/schema.js').ZodexSchema
+ *   replaced?: any
+ * }) => JamilihArray} viewUI
+ * @property {(info: {
+ *   value?: StructuredCloneValue,
+ *   typeNamespace?: string,
+ *   bringIntoFocus?: boolean,
+ *   format?: import('./formats.js').AvailableFormat,
+ *   formats?: import('./formats.js').default,
+ *   types: Types,
+ *   resultType?: "keys"|"values"|"both",
+ *   type?: AvailableArbitraryType,
+ *   forcedState?: string,
+ *   buildTypeChoices?: import('./typeChoices.js').BuildTypeChoices,
+ *   topRoot?: HTMLDivElement
+ *   schemaContent?: import('./formats/schema.js').ZodexSchema,
+ *   specificSchemaObject?: import('./formats/schema.js').ZodexSchema,
+ *   schemaFallingBack?: boolean
+ * }) => JamilihArray} editUI
+ * @property {(info: {root: HTMLDivElement}) =>
+ *   HTMLInputElement|HTMLTextAreaElement|HTMLSelectElement|
+ *   HTMLButtonElement} getInput Gets the form control (with `value`)
+ * @property {(
+ *   info: {root: HTMLDivElement}
+ * ) => HTMLSelectElement} [getSelect]
+ * @property {(path: string, value: StructuredCloneValue) =>
+ *   StructuredCloneValue} [resolveReference] Gets the reference. For array
+ *   and object references types only
+ * @property {(info: {root: HTMLDivElement, topRoot?: HTMLDivElement}) => {
+ *   message?: string,
+ *   valid: boolean
+ * }} [validate] Message will be used if validity is false.
+ * @property {(info: {
+ *   topRoot: HTMLDivElement,
+ *   types: Types
+ * }) => void} [validateAll] For
+ *   validation of array and object references only.
+ * @property {{
+ *   structuredCloning: {
+ *     after: AvailableType,
+ *     contexts: string[]
+ *   }
+ * }} [stateDependent] The type after which it should be placed and its
+ *   context types
+ */
+/**
+ * @typedef {"null"|"true"|"false"|"number"|"bigint"|"bigintObject"|
+ *   "string"|"arrayReference"|
+ *   "objectReference"|"array"|"object"|"date"|"userObject"|"undef"|
+ *   "SpecialRealNumber"|"SpecialNumber"|"regexp"|"BooleanObject"|
+ *   "NumberObject"|"StringObject"|"map"|"set"|"file"|"filelist"|"blobHTML"|
+ *   "buffersource"|"dataview"|"imagedata"|"imagebitmap"|
+ *   "int8array"|"uint8array"|"uint8clampedarray"|"int16array"|"uint16array"|
+ *   "int32array"|"uint32array"|"float32array"|"float64array"|"ValidDate"|
+ *   "arrayNonindexKeys"|"error"|"errors"|"blob"|"domexception"|"domrect"|
+ *   "dompoint"|"dommatrix"|"resurrectable"|"boolean"|"nan"|"tuple"|
+ *   "record"|"void"|"enum"|"literal"|"never"|"catch"
+ * } AvailableType
+ */
+/**
+ * @typedef {AvailableType|"symbol"|"promise"|"function"} AvailableArbitraryType
+ */
+/**
+ * @typedef {TypeObject & {
+*   childTypes: string[]
+* }} SuperTypeObject
+*/
+/**
+ *
+ */
+declare class Types {
+    formats: Formats;
+    /** @type {CustomValidateAllReferences|undefined} */
+    customValidateAllReferences: CustomValidateAllReferences | undefined;
+    /**
+     * @type {{
+     *   [key in AvailableArbitraryType]: Partial<TypeObject>|string[]
+     * }}
+     */
+    availableTypes: { [key in AvailableArbitraryType]: Partial<TypeObject> | string[]; };
+    /**
+     * @type {{
+     *   [key: string]: {
+     *     [key: string]: {type: AvailableType, after: AvailableType}[]
+     *   }
+     * }}
+     */
+    contexts: {
+        [key: string]: {
+            [key: string]: {
+                type: AvailableType;
+                after: AvailableType;
+            }[];
+        };
+    };
+    /**
+     * @param {import('./formats.js').AvailableFormat} format
+     * @param {StructuredCloneValue} record
+     * @param {StateObject} stateObj
+     * @returns {Promise<Element>}
+     */
+    getControlsForFormatAndValue(format: import("./formats.js").AvailableFormat, record: StructuredCloneValue, stateObj: StateObject): Promise<Element>;
+    /**
+     * @param {import('./formats.js').AvailableFormat} format
+     * @param {string} context
+     * @returns {{
+     *   type: AvailableType
+     *   after: AvailableType
+     * }[]}
+     */
+    getContextInfo(format: import("./formats.js").AvailableFormat, context: string): {
+        type: AvailableType;
+        after: AvailableType;
+    }[];
+    getValueForRoot(root: RootElement, stateObj?: StateObject | undefined, currentPath?: string | undefined): StructuredCloneValue;
+    getFormControlForRoot(root: RootElement): null | HTMLInputElement | HTMLTextAreaElement | HTMLSelectElement | HTMLButtonElement;
+    getValueFromRootAncestor(selOrEl: string | HTMLElement, stateObj?: StateObject | undefined): StructuredCloneValue;
+    getFormControlFromRootAncestor(selOrEl: string | HTMLElement): null | HTMLInputElement | HTMLTextAreaElement | HTMLSelectElement | HTMLButtonElement;
+    getOptionForType(type: AvailableArbitraryType, schemaContent?: import("./formatAndTypeChoices.js").ZodexSchema | undefined): [string, {
+        value: AvailableType;
+        title?: string;
+    }];
+    getTypeOptionsForFormatAndState(format: import("./formats.js").AvailableFormat, parserState?: string | undefined, schemaContent?: import("./formatAndTypeChoices.js").ZodexSchema | undefined, schemaOriginal?: import("./formatAndTypeChoices.js").ZodexSchema | undefined): {
+        typeOptions: [string, {
+            value: AvailableType;
+            title?: string;
+        }][];
+        schemaObjects: import("./formats/schema.js").ZodexSchema[];
+    };
+    getUIForModeAndType(cfg: {
+        readonly?: boolean;
+        resultType?: "both" | "keys" | "values";
+        typeNamespace?: string;
+        type: AvailableArbitraryType;
+        topRoot?: RootElement;
+        bringIntoFocus?: boolean | undefined;
+        buildTypeChoices?: import("./typeChoices.js").BuildTypeChoices;
+        format: import("./formats.js").AvailableFormat;
+        schemaContent?: import("./formats/schema.js").ZodexSchema;
+        specificSchemaObject?: import("./formats/schema.js").ZodexSchema;
+        value: StructuredCloneValue;
+        hasValue: boolean;
+        replaced?: StructuredCloneValue;
+        schemaFallingBack?: boolean;
+    }): HTMLElement;
+    validateAllReferences(cfg: {
+        topRoot: RootElement;
+    }): void;
+    validate(cfg: {
+        type: AvailableArbitraryType;
+        root: RootElement;
+        topRoot?: RootElement;
+        avoidReport?: boolean;
+    }): boolean;
+    setValue(cfg: {
+        type: AvailableArbitraryType;
+        root: RootElement;
+        value: StructuredCloneValue;
+    }): void;
+    getValueForString(s: string, cfg: {
+        format: import("./formats.js").AvailableFormat;
+        state?: string;
+        endMatchTypeObjs?: TypeObject[];
+        firstRun?: boolean;
+        rootHolder?: [type: string, parent: {
+            [key: string]: any;
+        } | undefined, parentPath: string | number | undefined, path: string][];
+        parent?: {
+            [key: string]: any;
+        };
+        parentPath?: string | number;
+        schemaObject?: import("./formatAndTypeChoices.js").ZodexSchema | undefined;
+        schemaOriginal?: import("./formatAndTypeChoices.js").ZodexSchema | undefined;
+    }): [value: StructuredCloneValue, remnant: string, beginOnly: boolean, assign: boolean];
+    /**
+     * @param {AvailableArbitraryType} type
+     * @returns {Partial<TypeObject>|string[]}
+     */
+    getTypeObject(type: AvailableArbitraryType): Partial<TypeObject> | string[];
+}
+declare namespace Types {
+    function getTypeForRoot(root: RootElement | null): AvailableArbitraryType;
+    function validValuesSet(cfg: {
+        form: HTMLFormElement;
+        typeNamespace?: string;
+        keySelectClass?: string;
+    }): boolean;
+}
+import Formats from './formats.js';
+//# sourceMappingURL=types.d.ts.map