@formity/system 0.1.0 → 0.2.1

package/dist/utils/entries/flow.d.ts

@@ -1,9 +1,64 @@
 import type { ItemEntries, FlowEntries } from "../../types/flow/entries";
 import type { Position } from "../../types/flow/position";
+/**
+ * Returns the value that is in the given `FlowEntries` object using the following parameters:
+ *
+ * - `path`: The path within the `FlowEntries` object that contains a `FormEntries` object.
+ * - `name`: The name of the value within the `FormEntries` object.
+ * - `keys`: The list of keys that is used to access the value within the `FormEntries` object.
+ * - `defaultValue`: The default value to return if the value is not found.
+ *
+ * @param flow The `FlowEntries` object.
+ * @param path The path within the `FlowEntries` object that contains a `FormEntries` object.
+ * @param name The name of the value within the `FormEntries` object.
+ * @param keys The list of keys that is used to access the value within the `FormEntries` object.
+ * @param defaultValue The default value to return if the value is not found.
+ * @returns The value that is in the given `FlowEntries` object or the default value if the value is not found.
+ */
 export declare function get(flow: FlowEntries, path: Position[], name: string, keys: PropertyKey[], defaultValue: unknown): unknown;
-export declare function set(flow: FlowEntries, path: Position[], name: string, keys: PropertyKey[], value: unknown): FlowEntries;
+/**
+ * Sets the value in the given `FlowEntries` object using the following parameters:
+ *
+ * - `path`: The path within the `FlowEntries` object that contains a `FormEntries` object.
+ * - `name`: The name of the value within the `FormEntries` object.
+ * - `keys`: The list of keys that is used to access the value within the `FormEntries` object.
+ * - `value`: The value to set.
+ *
+ * @param flow The `FlowEntries` object.
+ * @param path The path within the `FlowEntries` object that contains a `FormEntries` object.
+ * @param name The name of the value within the `FormEntries` object.
+ * @param keys The list of keys that is used to access the value within the `FormEntries` object.
+ * @param data The value to set.
+ * @returns The updated `FlowEntries` object.
+ */
+export declare function set(flow: FlowEntries, path: Position[], name: string, keys: PropertyKey[], data: unknown): FlowEntries;
+/**
+ * Creates a `FlowEntries` object.
+ *
+ * @returns The created `FlowEntries` object.
+ */
 export declare function create(position: Position): FlowEntries;
+/**
+ * Clones a `FlowEntries` object.
+ *
+ * @param flow A `FlowEntries` object.
+ * @returns The cloned `FlowEntries` object.
+ */
 export declare function clone(flow: FlowEntries): FlowEntries;
+/**
+ * Returns the `ItemEntries` object at the given position within the given `FlowEntries` object, or `null` if there is no item at the given position.
+ *
+ * @param flow The `FlowEntries` object.
+ * @param position The position within the `FlowEntries` object.
+ * @returns The `ItemEntries` object at the given position within the `FlowEntries` object, or `null` if there is no item at the given position.
+ */
 export declare function getItem(flow: FlowEntries, position: Position): ItemEntries | null;
+/**
+ * Sets the `ItemEntries` object at the given position within the given `FlowEntries` object.
+ *
+ * @param flow The `FlowEntries` object.
+ * @param position The position within the `FlowEntries` object.
+ * @param item The `ItemEntries` object to set.
+ */
 export declare function setItem(flow: FlowEntries, position: Position, item: ItemEntries): void;
 //# sourceMappingURL=flow.d.ts.map

package/dist/utils/entries/flow.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"flow.d.ts","sourceRoot":"","sources":["../../../src/utils/entries/flow.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,WAAW,EACX,WAAW,EAEZ,MAAM,0BAA0B,CAAC;AAElC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AAO1D,wBAAgB,GAAG,CACjB,IAAI,EAAE,WAAW,EACjB,IAAI,EAAE,QAAQ,EAAE,EAChB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,WAAW,EAAE,EACnB,YAAY,EAAE,OAAO,GACpB,OAAO,CAUT;AAED,wBAAgB,GAAG,CACjB,IAAI,EAAE,WAAW,EACjB,IAAI,EAAE,QAAQ,EAAE,EAChB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,WAAW,EAAE,EACnB,KAAK,EAAE,OAAO,GACb,WAAW,CA2Bb;AAED,wBAAgB,MAAM,CAAC,QAAQ,EAAE,QAAQ,GAAG,WAAW,CAStD;AAED,wBAAgB,KAAK,CAAC,IAAI,EAAE,WAAW,GAAG,WAAW,CASpD;AAED,wBAAgB,OAAO,CACrB,IAAI,EAAE,WAAW,EACjB,QAAQ,EAAE,QAAQ,GACjB,WAAW,GAAG,IAAI,CASpB;AAED,wBAAgB,OAAO,CACrB,IAAI,EAAE,WAAW,EACjB,QAAQ,EAAE,QAAQ,EAClB,IAAI,EAAE,WAAW,GAChB,IAAI,CASN"}
+{"version":3,"file":"flow.d.ts","sourceRoot":"","sources":["../../../src/utils/entries/flow.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,WAAW,EACX,WAAW,EAEZ,MAAM,0BAA0B,CAAC;AAElC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AAQ1D;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,GAAG,CACjB,IAAI,EAAE,WAAW,EACjB,IAAI,EAAE,QAAQ,EAAE,EAChB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,WAAW,EAAE,EACnB,YAAY,EAAE,OAAO,GACpB,OAAO,CAUT;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,GAAG,CACjB,IAAI,EAAE,WAAW,EACjB,IAAI,EAAE,QAAQ,EAAE,EAChB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,WAAW,EAAE,EACnB,IAAI,EAAE,OAAO,GACZ,WAAW,CA2Bb;AAED;;;;GAIG;AACH,wBAAgB,MAAM,CAAC,QAAQ,EAAE,QAAQ,GAAG,WAAW,CAWtD;AAED;;;;;GAKG;AACH,wBAAgB,KAAK,CAAC,IAAI,EAAE,WAAW,GAAG,WAAW,CAWpD;AAED;;;;;;GAMG;AACH,wBAAgB,OAAO,CACrB,IAAI,EAAE,WAAW,EACjB,QAAQ,EAAE,QAAQ,GACjB,WAAW,GAAG,IAAI,CAWpB;AAED;;;;;;GAMG;AACH,wBAAgB,OAAO,CACrB,IAAI,EAAE,WAAW,EACjB,QAAQ,EAAE,QAAQ,EAClB,IAAI,EAAE,WAAW,GAChB,IAAI,CAWN"}

package/dist/utils/entries/flow.list.d.ts

@@ -1,7 +1,32 @@
 import type { ItemEntries, FlowEntries, ListEntries } from "../../types/flow/entries";
 import type { Position } from "../../types/flow/position";
+/**
+ * Creates a `ListEntries` object.
+ *
+ * @returns The created `ListEntries` object.
+ */
 export declare function create(): FlowEntries;
+/**
+ * Clones a `ListEntries` object.
+ *
+ * @param flow A `ListEntries` object.
+ * @returns The cloned `ListEntries` object.
+ */
 export declare function clone(flow: ListEntries): FlowEntries;
+/**
+ * Returns the `ItemEntries` object at the given position within the given `ListEntries` object, or `null` if there is no item at the given position.
+ *
+ * @param flow The `ListEntries` object.
+ * @param position The position within the `ListEntries` object.
+ * @returns The `ItemEntries` object at the given position within the `ListEntries` object, or `null` if there is no item at the given position.
+ */
 export declare function getItem(flow: ListEntries, position: Position): ItemEntries | null;
+/**
+ * Sets the `ItemEntries` object at the given position within the given `ListEntries` object.
+ *
+ * @param flow The `ListEntries` object.
+ * @param position The position within the `ListEntries` object.
+ * @param item The `ItemEntries` object to set.
+ */
 export declare function setItem(flow: ListEntries, position: Position, item: ItemEntries): void;
 //# sourceMappingURL=flow.list.d.ts.map

package/dist/utils/entries/flow.list.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"flow.list.d.ts","sourceRoot":"","sources":["../../../src/utils/entries/flow.list.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,WAAW,EACX,WAAW,EACX,WAAW,EACZ,MAAM,0BAA0B,CAAC;AAElC,OAAO,KAAK,EAAE,QAAQ,EAAgB,MAAM,2BAA2B,CAAC;AAExE,wBAAgB,MAAM,IAAI,WAAW,CAEpC;AAED,wBAAgB,KAAK,CAAC,IAAI,EAAE,WAAW,GAAG,WAAW,CAEpD;AAED,wBAAgB,OAAO,CACrB,IAAI,EAAE,WAAW,EACjB,QAAQ,EAAE,QAAQ,GACjB,WAAW,GAAG,IAAI,CAIpB;AAED,wBAAgB,OAAO,CACrB,IAAI,EAAE,WAAW,EACjB,QAAQ,EAAE,QAAQ,EAClB,IAAI,EAAE,WAAW,GAChB,IAAI,CAGN"}
+{"version":3,"file":"flow.list.d.ts","sourceRoot":"","sources":["../../../src/utils/entries/flow.list.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,WAAW,EACX,WAAW,EACX,WAAW,EACZ,MAAM,0BAA0B,CAAC;AAElC,OAAO,KAAK,EAAE,QAAQ,EAAgB,MAAM,2BAA2B,CAAC;AAExE;;;;GAIG;AACH,wBAAgB,MAAM,IAAI,WAAW,CAEpC;AAED;;;;;GAKG;AACH,wBAAgB,KAAK,CAAC,IAAI,EAAE,WAAW,GAAG,WAAW,CAEpD;AAED;;;;;;GAMG;AACH,wBAAgB,OAAO,CACrB,IAAI,EAAE,WAAW,EACjB,QAAQ,EAAE,QAAQ,GACjB,WAAW,GAAG,IAAI,CAIpB;AAED;;;;;;GAMG;AACH,wBAAgB,OAAO,CACrB,IAAI,EAAE,WAAW,EACjB,QAAQ,EAAE,QAAQ,EAClB,IAAI,EAAE,WAAW,GAChB,IAAI,CAGN"}

package/dist/utils/entries/flow.list.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=flow.list.test.d.ts.map

package/dist/utils/entries/flow.list.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"flow.list.test.d.ts","sourceRoot":"","sources":["../../../src/utils/entries/flow.list.test.ts"],"names":[],"mappings":""}

package/dist/utils/entries/flow.loop.d.ts

@@ -1,7 +1,32 @@
 import type { ItemEntries, FlowEntries, LoopEntries } from "../../types/flow/entries";
 import type { Position } from "../../types/flow/position";
+/**
+ * Creates a `LoopEntries` object.
+ *
+ * @returns The created `LoopEntries` object.
+ */
 export declare function create(): FlowEntries;
+/**
+ * Clones a `LoopEntries` object.
+ *
+ * @param flow A `LoopEntries` object.
+ * @returns The cloned `LoopEntries` object.
+ */
 export declare function clone(flow: LoopEntries): FlowEntries;
+/**
+ * Returns the `ItemEntries` object at the given position within the given `LoopEntries` object, or `null` if there is no item at the given position.
+ *
+ * @param flow The `LoopEntries` object.
+ * @param position The position within the `LoopEntries` object.
+ * @returns The `ItemEntries` object at the given position within the `LoopEntries` object, or `null` if there is no item at the given position.
+ */
 export declare function getItem(flow: LoopEntries, position: Position): ItemEntries | null;
+/**
+ * Sets the `ItemEntries` object at the given position within the given `LoopEntries` object.
+ *
+ * @param flow The `LoopEntries` object.
+ * @param position The position within the `LoopEntries` object.
+ * @param item The `ItemEntries` object to set.
+ */
 export declare function setItem(flow: LoopEntries, position: Position, item: ItemEntries): void;
 //# sourceMappingURL=flow.loop.d.ts.map

package/dist/utils/entries/flow.loop.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"flow.loop.d.ts","sourceRoot":"","sources":["../../../src/utils/entries/flow.loop.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,WAAW,EACX,WAAW,EACX,WAAW,EACZ,MAAM,0BAA0B,CAAC;AAElC,OAAO,KAAK,EAAE,QAAQ,EAAgB,MAAM,2BAA2B,CAAC;AAExE,wBAAgB,MAAM,IAAI,WAAW,CAEpC;AAED,wBAAgB,KAAK,CAAC,IAAI,EAAE,WAAW,GAAG,WAAW,CAEpD;AAED,wBAAgB,OAAO,CACrB,IAAI,EAAE,WAAW,EACjB,QAAQ,EAAE,QAAQ,GACjB,WAAW,GAAG,IAAI,CAIpB;AAED,wBAAgB,OAAO,CACrB,IAAI,EAAE,WAAW,EACjB,QAAQ,EAAE,QAAQ,EAClB,IAAI,EAAE,WAAW,GAChB,IAAI,CAGN"}
+{"version":3,"file":"flow.loop.d.ts","sourceRoot":"","sources":["../../../src/utils/entries/flow.loop.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,WAAW,EACX,WAAW,EACX,WAAW,EACZ,MAAM,0BAA0B,CAAC;AAElC,OAAO,KAAK,EAAE,QAAQ,EAAgB,MAAM,2BAA2B,CAAC;AAExE;;;;GAIG;AACH,wBAAgB,MAAM,IAAI,WAAW,CAEpC;AAED;;;;;GAKG;AACH,wBAAgB,KAAK,CAAC,IAAI,EAAE,WAAW,GAAG,WAAW,CAEpD;AAED;;;;;;GAMG;AACH,wBAAgB,OAAO,CACrB,IAAI,EAAE,WAAW,EACjB,QAAQ,EAAE,QAAQ,GACjB,WAAW,GAAG,IAAI,CAIpB;AAED;;;;;;GAMG;AACH,wBAAgB,OAAO,CACrB,IAAI,EAAE,WAAW,EACjB,QAAQ,EAAE,QAAQ,EAClB,IAAI,EAAE,WAAW,GAChB,IAAI,CAGN"}

package/dist/utils/entries/flow.loop.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=flow.loop.test.d.ts.map

package/dist/utils/entries/flow.loop.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"flow.loop.test.d.ts","sourceRoot":"","sources":["../../../src/utils/entries/flow.loop.test.ts"],"names":[],"mappings":""}

package/dist/utils/entries/flow.switch.d.ts

@@ -0,0 +1,32 @@
+import type { ItemEntries, FlowEntries, SwitchEntries } from "../../types/flow/entries";
+import type { Position } from "../../types/flow/position";
+/**
+ * Creates a `SwitchEntries` object.
+ *
+ * @returns The created `SwitchEntries` object.
+ */
+export declare function create(): FlowEntries;
+/**
+ * Clones a `SwitchEntries` object.
+ *
+ * @param flow A `SwitchEntries` object.
+ * @returns The cloned `SwitchEntries` object.
+ */
+export declare function clone(flow: SwitchEntries): FlowEntries;
+/**
+ * Returns the `ItemEntries` object at the given position within the given `SwitchEntries` object, or `null` if there is no item at the given position.
+ *
+ * @param flow The `SwitchEntries` object.
+ * @param position The position within the `SwitchEntries` object.
+ * @returns The `ItemEntries` object at the given position within the `SwitchEntries` object, or `null` if there is no item at the given position.
+ */
+export declare function getItem(flow: SwitchEntries, position: Position): ItemEntries | null;
+/**
+ * Sets the `ItemEntries` object at the given position within the given `SwitchEntries` object.
+ *
+ * @param flow The `SwitchEntries` object.
+ * @param position The position within the `SwitchEntries` object.
+ * @param item The `ItemEntries` object to set.
+ */
+export declare function setItem(flow: SwitchEntries, position: Position, item: ItemEntries): void;
+//# sourceMappingURL=flow.switch.d.ts.map

package/dist/utils/entries/flow.switch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"flow.switch.d.ts","sourceRoot":"","sources":["../../../src/utils/entries/flow.switch.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,WAAW,EACX,WAAW,EACX,aAAa,EACd,MAAM,0BAA0B,CAAC;AAElC,OAAO,KAAK,EAAE,QAAQ,EAAkB,MAAM,2BAA2B,CAAC;AAE1E;;;;GAIG;AACH,wBAAgB,MAAM,IAAI,WAAW,CAEpC;AAED;;;;;GAKG;AACH,wBAAgB,KAAK,CAAC,IAAI,EAAE,aAAa,GAAG,WAAW,CAQtD;AAED;;;;;;GAMG;AACH,wBAAgB,OAAO,CACrB,IAAI,EAAE,aAAa,EACnB,QAAQ,EAAE,QAAQ,GACjB,WAAW,GAAG,IAAI,CAUpB;AAED;;;;;;GAMG;AACH,wBAAgB,OAAO,CACrB,IAAI,EAAE,aAAa,EACnB,QAAQ,EAAE,QAAQ,EAClB,IAAI,EAAE,WAAW,GAChB,IAAI,CAWN"}

package/dist/utils/entries/flow.switch.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=flow.switch.test.d.ts.map

package/dist/utils/entries/flow.switch.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"flow.switch.test.d.ts","sourceRoot":"","sources":["../../../src/utils/entries/flow.switch.test.ts"],"names":[],"mappings":""}

package/dist/utils/entries/flow.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=flow.test.d.ts.map

package/dist/utils/entries/flow.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"flow.test.d.ts","sourceRoot":"","sources":["../../../src/utils/entries/flow.test.ts"],"names":[],"mappings":""}

package/dist/utils/entries/form.d.ts

@@ -1,4 +1,30 @@
 import type { FormEntries } from "../../types/flow/entries";
+/**
+ * Returns the value that is in the given `FormEntries` object using the following parameters:
+ *
+ * - `name`: The name of the value within the `FormEntries` object.
+ * - `keys`: The list of keys that is used to access the value within the `FormEntries` object.
+ * - `defaultValue`: The default value to return if the value is not found.
+ *
+ * @param form The `FormEntries` object.
+ * @param name The name of the value within the `FormEntries` object.
+ * @param keys The list of keys that is used to access the value within the `FormEntries` object.
+ * @param defaultValue The default value to return if the value is not found.
+ * @returns The value that is in the given `FormEntries` object or the default value if the value is not found.
+ */
 export declare function get(form: FormEntries, name: string, keys: PropertyKey[], defaultValue: unknown): unknown;
+/**
+ * Sets the value in the given `FormEntries` object using the following parameters:
+ *
+ * - `name`: The name of the value within the `FormEntries` object.
+ * - `keys`: The list of keys that is used to access the value within the `FormEntries` object.
+ * - `data`: The value to set.
+ *
+ * @param form The `FormEntries` object.
+ * @param name The name of the value within the `FormEntries` object.
+ * @param keys The list of keys that is used to access the value within the `FormEntries` object.
+ * @param data The value to set.
+ * @returns The updated `FormEntries` object.
+ */
 export declare function set(form: FormEntries, name: string, keys: PropertyKey[], data: unknown): FormEntries;
 //# sourceMappingURL=form.d.ts.map

package/dist/utils/entries/form.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"form.d.ts","sourceRoot":"","sources":["../../../src/utils/entries/form.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAe,MAAM,0BAA0B,CAAC;AAEzE,wBAAgB,GAAG,CACjB,IAAI,EAAE,WAAW,EACjB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,WAAW,EAAE,EACnB,YAAY,EAAE,OAAO,GACpB,OAAO,CAaT;AAED,wBAAgB,GAAG,CACjB,IAAI,EAAE,WAAW,EACjB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,WAAW,EAAE,EACnB,IAAI,EAAE,OAAO,GACZ,WAAW,CAsBb"}
+{"version":3,"file":"form.d.ts","sourceRoot":"","sources":["../../../src/utils/entries/form.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAe,MAAM,0BAA0B,CAAC;AAEzE;;;;;;;;;;;;GAYG;AACH,wBAAgB,GAAG,CACjB,IAAI,EAAE,WAAW,EACjB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,WAAW,EAAE,EACnB,YAAY,EAAE,OAAO,GACpB,OAAO,CAaT;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,GAAG,CACjB,IAAI,EAAE,WAAW,EACjB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,WAAW,EAAE,EACnB,IAAI,EAAE,OAAO,GACZ,WAAW,CAsBb"}

package/dist/utils/entries/form.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=form.test.d.ts.map

package/dist/utils/entries/form.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"form.test.d.ts","sourceRoot":"","sources":["../../../src/utils/entries/form.test.ts"],"names":[],"mappings":""}

package/dist/utils/flow.d.ts

@@ -1,5 +1,13 @@
 import type { Flow } from "../types/flow/flow";
 import type { ListSchema as CustomListSchema } from "../types/schema/custom";
 import type { ListValues } from "../types/values";
+/**
+ * Returns the current state of the multi-step form after updating the values of the current form.
+ *
+ * @param flow The current state of the multi-step form.
+ * @param schema The `ListSchema` object representing the multi-step form.
+ * @param values An object containing the values of the current form.
+ * @returns The current state of the multi-step form after updating the values of the current form.
+ */
 export declare function getFlow<Render, Values extends ListValues, Inputs extends object, Params extends object>(flow: Flow, schema: CustomListSchema<Render, Values, Inputs, Params>, values: object): Flow;
 //# sourceMappingURL=flow.d.ts.map

package/dist/utils/flow.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"flow.d.ts","sourceRoot":"","sources":["../../src/utils/flow.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,KAAK,EAAE,UAAU,IAAI,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE7E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAMlD,wBAAgB,OAAO,CACrB,MAAM,EACN,MAAM,SAAS,UAAU,EACzB,MAAM,SAAS,MAAM,EACrB,MAAM,SAAS,MAAM,EAErB,IAAI,EAAE,IAAI,EACV,MAAM,EAAE,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EACxD,MAAM,EAAE,MAAM,GACb,IAAI,CAGN"}
+{"version":3,"file":"flow.d.ts","sourceRoot":"","sources":["../../src/utils/flow.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,KAAK,EAAE,UAAU,IAAI,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE7E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAMlD;;;;;;;GAOG;AACH,wBAAgB,OAAO,CACrB,MAAM,EACN,MAAM,SAAS,UAAU,EACzB,MAAM,SAAS,MAAM,EACrB,MAAM,SAAS,MAAM,EAErB,IAAI,EAAE,IAAI,EACV,MAAM,EAAE,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EACxD,MAAM,EAAE,MAAM,GACb,IAAI,CAGN"}

package/dist/utils/flow.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=flow.test.d.ts.map

package/dist/utils/flow.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"flow.test.d.ts","sourceRoot":"","sources":["../../src/utils/flow.test.ts"],"names":[],"mappings":""}

package/dist/utils/form.d.ts

@@ -2,5 +2,17 @@ import type { Flow } from "../types/flow/flow";
 import type { ListSchema as CustomListSchema } from "../types/schema/custom";
 import type { ListValues } from "../types/values";
 import type { OnNext, OnBack, GetFlow, SetFlow } from "../types/callbacks";
+/**
+ * Returns the rendered form for the current step of the multi-step form.
+ *
+ * @param flow The current state of the multi-step form.
+ * @param schema The `ListSchema` object representing the multi-step form.
+ * @param params An object containing the parameters for the form.
+ * @param onNext A callback function used to navigate to the next step of the multi-step form.
+ * @param onBack A callback function used to navigate to the previous step of the multi-step form.
+ * @param getFlow A callback function used to get the current state of the multi-step form.
+ * @param setFlow A callback function used to set the current state of the multi-step form.
+ * @returns The rendered form for the current step of the multi-step form.
+ */
 export declare function getForm<Render, Values extends ListValues, Inputs extends object, Params extends object>(flow: Flow, schema: CustomListSchema<Render, Values, Inputs, Params>, params: Params, onNext: OnNext, onBack: OnBack, getFlow: GetFlow, setFlow: SetFlow): Render;
 //# sourceMappingURL=form.d.ts.map

package/dist/utils/form.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"form.d.ts","sourceRoot":"","sources":["../../src/utils/form.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,KAAK,EAAE,UAAU,IAAI,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE7E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAK3E,wBAAgB,OAAO,CACrB,MAAM,EACN,MAAM,SAAS,UAAU,EACzB,MAAM,SAAS,MAAM,EACrB,MAAM,SAAS,MAAM,EAErB,IAAI,EAAE,IAAI,EACV,MAAM,EAAE,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EACxD,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,OAAO,GACf,MAAM,CAYR"}
+{"version":3,"file":"form.d.ts","sourceRoot":"","sources":["../../src/utils/form.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,KAAK,EAAE,UAAU,IAAI,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE7E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAK3E;;;;;;;;;;;GAWG;AACH,wBAAgB,OAAO,CACrB,MAAM,EACN,MAAM,SAAS,UAAU,EACzB,MAAM,SAAS,MAAM,EACrB,MAAM,SAAS,MAAM,EAErB,IAAI,EAAE,IAAI,EACV,MAAM,EAAE,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EACxD,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,OAAO,GACf,MAAM,CAYR"}

package/dist/utils/form.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=form.test.d.ts.map

package/dist/utils/form.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"form.test.d.ts","sourceRoot":"","sources":["../../src/utils/form.test.ts"],"names":[],"mappings":""}

package/dist/utils/navigate.d.ts

@@ -3,7 +3,48 @@ import type { ListSchema as CustomListSchema } from "../types/schema/custom";
 import type { OnYield as CustomOnYield } from "../types/callbacks/custom";
 import type { OnReturn as CustomOnReturn } from "../types/callbacks/custom";
 import type { ListValues } from "../types/values";
+/**
+ * Initializes the multi-step form and returns its initial state, including a cursor
+ * pointing to the first form step. If no form step is found, or if a return operation
+ * is encountered before reaching a form, an error is thrown.
+ *
+ * During traversal of the multi-step form, the `onYield` callback is triggered whenever
+ * a yield operation is encountered, allowing for intermediate values to be processed.
+ *
+ * @param schema The `ListSchema` object that defines the structure and behavior of the multi-step form.
+ * @param values An object containing the initial input values for the multi-step form.
+ * @param onYield A callback function triggered when the multi-step form yields values.
+ * @returns The initial state of the form as a `Flow` object.
+ *
+ * @throws An error if no form step is found or if a return operation is encountered before a form step.
+ */
 export declare function initFlow<Render, Values extends ListValues, Inputs extends object, Params extends object>(schema: CustomListSchema<Render, Values, Inputs, Params>, values: Inputs, onYield: CustomOnYield<Values>): Flow;
+/**
+ * Navigates to the next form step of the multi-step form and returns the updated state.
+ * If there is no next form step, the returned state contains the current form step.
+ *
+ * The `onYield` callback is triggered whenever a yield operation is encountered during traversal,
+ * allowing for intermediate values to be processed.
+ *
+ * The `onReturn` callback is triggered whenever a return operation is encountered during traversal,
+ * allowing for final values to be processed.
+ *
+ * @param flow The current state of the multi-step form.
+ * @param schema The `ListSchema` object representing the multi-step form.
+ * @param values An object containing the generated values within the multi-step form.
+ * @param onYield A callback function triggered when the multi-step form yields values.
+ * @param onReturn A callback function triggered when the multi-step form returns values.
+ * @returns The updated state of the multi-step form.
+ */
 export declare function nextFlow<Render, Values extends ListValues, Inputs extends object, Params extends object>(flow: Flow, schema: CustomListSchema<Render, Values, Inputs, Params>, values: object, onYield: CustomOnYield<Values>, onReturn: CustomOnReturn<Values>): Flow;
+/**
+ * Navigates to the previous form step of the multi-step form and returns the updated state.
+ * If there is no previous form step, the returned state contains the current form step.
+ *
+ * @param flow The current state of the multi-step form.
+ * @param schema The `ListSchema` object representing the multi-step form.
+ * @param values An object containing the generated values within the multi-step form.
+ * @returns The updated state of the multi-step form.
+ */
 export declare function prevFlow<Render, Values extends ListValues, Inputs extends object, Params extends object>(flow: Flow, schema: CustomListSchema<Render, Values, Inputs, Params>, values: object): Flow;
 //# sourceMappingURL=navigate.d.ts.map

package/dist/utils/navigate.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"navigate.d.ts","sourceRoot":"","sources":["../../src/utils/navigate.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAK/C,OAAO,KAAK,EAAE,UAAU,IAAI,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC7E,OAAO,KAAK,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1E,OAAO,KAAK,EAAE,QAAQ,IAAI,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAO5E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAUlD,wBAAgB,QAAQ,CACtB,MAAM,EACN,MAAM,SAAS,UAAU,EACzB,MAAM,SAAS,MAAM,EACrB,MAAM,SAAS,MAAM,EAErB,MAAM,EAAE,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EACxD,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,GAC7B,IAAI,CAKN;AA4ED,wBAAgB,QAAQ,CACtB,MAAM,EACN,MAAM,SAAS,UAAU,EACzB,MAAM,SAAS,MAAM,EACrB,MAAM,SAAS,MAAM,EAErB,IAAI,EAAE,IAAI,EACV,MAAM,EAAE,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EACxD,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,EAC9B,QAAQ,EAAE,cAAc,CAAC,MAAM,CAAC,QAMjC;AAkHD,wBAAgB,QAAQ,CACtB,MAAM,EACN,MAAM,SAAS,UAAU,EACzB,MAAM,SAAS,MAAM,EACrB,MAAM,SAAS,MAAM,EAErB,IAAI,EAAE,IAAI,EACV,MAAM,EAAE,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EACxD,MAAM,EAAE,MAAM,GACb,IAAI,CAGN"}
+{"version":3,"file":"navigate.d.ts","sourceRoot":"","sources":["../../src/utils/navigate.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAK/C,OAAO,KAAK,EAAE,UAAU,IAAI,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC7E,OAAO,KAAK,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1E,OAAO,KAAK,EAAE,QAAQ,IAAI,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAO5E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAUlD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,QAAQ,CACtB,MAAM,EACN,MAAM,SAAS,UAAU,EACzB,MAAM,SAAS,MAAM,EACrB,MAAM,SAAS,MAAM,EAErB,MAAM,EAAE,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EACxD,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,GAC7B,IAAI,CAKN;AA4ED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,QAAQ,CACtB,MAAM,EACN,MAAM,SAAS,UAAU,EACzB,MAAM,SAAS,MAAM,EACrB,MAAM,SAAS,MAAM,EAErB,IAAI,EAAE,IAAI,EACV,MAAM,EAAE,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EACxD,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,EAC9B,QAAQ,EAAE,cAAc,CAAC,MAAM,CAAC,QAMjC;AAkHD;;;;;;;;GAQG;AACH,wBAAgB,QAAQ,CACtB,MAAM,EACN,MAAM,SAAS,UAAU,EACzB,MAAM,SAAS,MAAM,EACrB,MAAM,SAAS,MAAM,EAErB,IAAI,EAAE,IAAI,EACV,MAAM,EAAE,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EACxD,MAAM,EAAE,MAAM,GACb,IAAI,CAGN"}

package/dist/utils/navigate.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=navigate.test.d.ts.map

package/dist/utils/navigate.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"navigate.test.d.ts","sourceRoot":"","sources":["../../src/utils/navigate.test.ts"],"names":[],"mappings":""}

package/dist/utils/schema/flow.cond.d.ts

@@ -1,7 +1,34 @@
 import type { ItemSchema, CondSchema } from "../../types/schema/static";
 import type { Position } from "../../types/flow/position";
+/**
+ * Type guard for `CondSchema` objects.
+ *
+ * @param schema An `ItemSchema` object.
+ * @returns A boolean indicating whether the `schema` is a `CondSchema` object.
+ */
 export declare function is(schema: ItemSchema): schema is CondSchema;
+/**
+ * Returns the initial position for the given `CondSchema` object if there is an initial position, otherwise it returns `null`.
+ *
+ * @param schema A `CondSchema` object.
+ * @param values An object containing the generated values within the multi-step form.
+ * @returns A `Position` object representing the initial position, or `null` if there is no initial position.
+ */
 export declare function into(schema: CondSchema, values: object): Position | null;
+/**
+ * Returns the next position for the given `CondSchema` object if there is a next position, otherwise it returns `null`.
+ *
+ * @param schema A `CondSchema` object.
+ * @param position A `Position` object representing the current position.
+ * @returns A `Position` object representing the next position, or `null` if there is no next position.
+ */
 export declare function next(schema: CondSchema, position: Position): Position | null;
+/**
+ * Returns the `ItemSchema` object at the given position within the given `CondSchema` object.
+ *
+ * @param schema The `CondSchema` object.
+ * @param position The position within the `CondSchema` object.
+ * @returns The `ItemSchema` object at the given position within the `CondSchema` object.
+ */
 export declare function at(schema: CondSchema, position: Position): ItemSchema;
 //# sourceMappingURL=flow.cond.d.ts.map

package/dist/utils/schema/flow.cond.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"flow.cond.d.ts","sourceRoot":"","sources":["../../../src/utils/schema/flow.cond.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACxE,OAAO,KAAK,EAAE,QAAQ,EAAgB,MAAM,2BAA2B,CAAC;AAExE,wBAAgB,EAAE,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,IAAI,UAAU,CAE3D;AAED,wBAAgB,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,GAAG,QAAQ,GAAG,IAAI,CAWxE;AAED,wBAAgB,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,QAAQ,GAAG,QAAQ,GAAG,IAAI,CAM5E;AAED,wBAAgB,EAAE,CAAC,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,QAAQ,GAAG,UAAU,CAGrE"}
+{"version":3,"file":"flow.cond.d.ts","sourceRoot":"","sources":["../../../src/utils/schema/flow.cond.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACxE,OAAO,KAAK,EAAE,QAAQ,EAAgB,MAAM,2BAA2B,CAAC;AAExE;;;;;GAKG;AACH,wBAAgB,EAAE,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,IAAI,UAAU,CAE3D;AAED;;;;;;GAMG;AACH,wBAAgB,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,GAAG,QAAQ,GAAG,IAAI,CAWxE;AAED;;;;;;GAMG;AACH,wBAAgB,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,QAAQ,GAAG,QAAQ,GAAG,IAAI,CAM5E;AAED;;;;;;GAMG;AACH,wBAAgB,EAAE,CAAC,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,QAAQ,GAAG,UAAU,CAGrE"}

package/dist/utils/schema/flow.cond.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=flow.cond.test.d.ts.map

package/dist/utils/schema/flow.cond.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"flow.cond.test.d.ts","sourceRoot":"","sources":["../../../src/utils/schema/flow.cond.test.ts"],"names":[],"mappings":""}

package/dist/utils/schema/flow.d.ts

@@ -1,8 +1,43 @@
 import type { ItemSchema, FlowSchema } from "../../types/schema/static";
 import type { Position } from "../../types/flow/position";
+/**
+ * Type guard for `FlowSchema` objects.
+ *
+ * @param schema An `ItemSchema` object.
+ * @returns A boolean indicating whether the `schema` is a `FlowSchema` object.
+ */
 export declare function is(schema: ItemSchema): schema is FlowSchema;
+/**
+ * Returns the initial position for the given `FlowSchema` object if there is an initial position, otherwise it returns `null`.
+ *
+ * @param schema A `FlowSchema` object.
+ * @param values An object containing the generated values within the multi-step form.
+ * @returns A `Position` object representing the initial position, or `null` if there is no initial position.
+ */
 export declare function into(schema: FlowSchema, values: object): Position | null;
+/**
+ * Returns the next position for the given `FlowSchema` object if there is a next position, otherwise it returns `null`.
+ *
+ * @param schema A `FlowSchema` object.
+ * @param position A `Position` object representing the current position.
+ * @param values An object containing the generated values within the multi-step form.
+ * @returns A `Position` object representing the next position, or `null` if there is no next position.
+ */
 export declare function next(schema: FlowSchema, position: Position, values: object): Position | null;
+/**
+ * Returns the `ItemSchema` object at the given position within the given `FlowSchema` object.
+ *
+ * @param schema The `FlowSchema` object.
+ * @param position The position within the `FlowSchema` object.
+ * @returns The `ItemSchema` object at the given position within the `FlowSchema` object.
+ */
 export declare function at(schema: FlowSchema, position: Position): ItemSchema;
+/**
+ * Returns the `ItemSchema` object at the given path within the given `FlowSchema` object.
+ *
+ * @param schema The `FlowSchema` object.
+ * @param path The path within the `FlowSchema` object.
+ * @returns The `ItemSchema` object at the given path within the `FlowSchema` object.
+ */
 export declare function find(schema: FlowSchema, path: Position[]): ItemSchema;
 //# sourceMappingURL=flow.d.ts.map

package/dist/utils/schema/flow.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"flow.d.ts","sourceRoot":"","sources":["../../../src/utils/schema/flow.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACxE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AAM1D,wBAAgB,EAAE,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,IAAI,UAAU,CAM3D;AAED,wBAAgB,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,GAAG,QAAQ,GAAG,IAAI,CAWxE;AAED,wBAAgB,IAAI,CAClB,MAAM,EAAE,UAAU,EAClB,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,MAAM,GACb,QAAQ,GAAG,IAAI,CAWjB;AAED,wBAAgB,EAAE,CAAC,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,QAAQ,GAAG,UAAU,CAWrE;AAED,wBAAgB,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,QAAQ,EAAE,cAOxD"}
+{"version":3,"file":"flow.d.ts","sourceRoot":"","sources":["../../../src/utils/schema/flow.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACxE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AAO1D;;;;;GAKG;AACH,wBAAgB,EAAE,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,IAAI,UAAU,CAO3D;AAED;;;;;;GAMG;AACH,wBAAgB,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,GAAG,QAAQ,GAAG,IAAI,CAcxE;AAED;;;;;;;GAOG;AACH,wBAAgB,IAAI,CAClB,MAAM,EAAE,UAAU,EAClB,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,MAAM,GACb,QAAQ,GAAG,IAAI,CAcjB;AAED;;;;;;GAMG;AACH,wBAAgB,EAAE,CAAC,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,QAAQ,GAAG,UAAU,CAcrE;AAED;;;;;;GAMG;AACH,wBAAgB,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,QAAQ,EAAE,cAOxD"}

package/dist/utils/schema/flow.list.d.ts

@@ -1,7 +1,33 @@
 import type { ItemSchema, ListSchema } from "../../types/schema/static";
 import type { Position } from "../../types/flow/position";
+/**
+ * Type guard for `ListSchema` objects.
+ *
+ * @param schema An `ItemSchema` object.
+ * @returns A boolean indicating whether the `schema` is a `ListSchema` object.
+ */
 export declare function is(schema: ItemSchema): schema is ListSchema;
+/**
+ * Returns the initial position for the given `ListSchema` object if there is an initial position, otherwise it returns `null`.
+ *
+ * @param schema A `ListSchema` object.
+ * @returns A `Position` object representing the initial position, or `null` if there is no initial position.
+ */
 export declare function into(schema: ListSchema): Position | null;
+/**
+ * Returns the next position for the given `ListSchema` object if there is a next position, otherwise it returns `null`.
+ *
+ * @param schema A `ListSchema` object.
+ * @param position A `Position` object representing the current position.
+ * @returns A `Position` object representing the next position, or `null` if there is no next position.
+ */
 export declare function next(schema: ListSchema, position: Position): Position | null;
+/**
+ * Returns the `ItemSchema` object at the given position within the given `ListSchema` object.
+ *
+ * @param schema The `ListSchema` object.
+ * @param position The position within the `ListSchema` object.
+ * @returns The `ItemSchema` object at the given position within the `ListSchema` object.
+ */
 export declare function at(schema: ListSchema, position: Position): ItemSchema;
 //# sourceMappingURL=flow.list.d.ts.map

package/dist/utils/schema/flow.list.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"flow.list.d.ts","sourceRoot":"","sources":["../../../src/utils/schema/flow.list.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACxE,OAAO,KAAK,EAAE,QAAQ,EAAgB,MAAM,2BAA2B,CAAC;AAExE,wBAAgB,EAAE,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,IAAI,UAAU,CAE3D;AAED,wBAAgB,IAAI,CAAC,MAAM,EAAE,UAAU,GAAG,QAAQ,GAAG,IAAI,CAKxD;AAED,wBAAgB,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,QAAQ,GAAG,QAAQ,GAAG,IAAI,CAM5E;AAED,wBAAgB,EAAE,CAAC,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,QAAQ,GAAG,UAAU,CAGrE"}
+{"version":3,"file":"flow.list.d.ts","sourceRoot":"","sources":["../../../src/utils/schema/flow.list.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACxE,OAAO,KAAK,EAAE,QAAQ,EAAgB,MAAM,2BAA2B,CAAC;AAExE;;;;;GAKG;AACH,wBAAgB,EAAE,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,IAAI,UAAU,CAE3D;AAED;;;;;GAKG;AACH,wBAAgB,IAAI,CAAC,MAAM,EAAE,UAAU,GAAG,QAAQ,GAAG,IAAI,CAKxD;AAED;;;;;;GAMG;AACH,wBAAgB,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,QAAQ,GAAG,QAAQ,GAAG,IAAI,CAM5E;AAED;;;;;;GAMG;AACH,wBAAgB,EAAE,CAAC,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,QAAQ,GAAG,UAAU,CAGrE"}

package/dist/utils/schema/flow.list.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=flow.list.test.d.ts.map

package/dist/utils/schema/flow.list.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"flow.list.test.d.ts","sourceRoot":"","sources":["../../../src/utils/schema/flow.list.test.ts"],"names":[],"mappings":""}

package/dist/utils/schema/flow.loop.d.ts

@@ -1,7 +1,35 @@
 import type { ItemSchema, LoopSchema } from "../../types/schema/static";
 import type { Position } from "../../types/flow/position";
+/**
+ * Type guard for `LoopSchema` objects.
+ *
+ * @param schema An `ItemSchema` object.
+ * @returns A boolean indicating whether the `schema` is a `LoopSchema` object.
+ */
 export declare function is(schema: ItemSchema): schema is LoopSchema;
+/**
+ * Returns the initial position for the given `LoopSchema` object if there is an initial position, otherwise it returns `null`.
+ *
+ * @param schema A `LoopSchema` object.
+ * @param values An object containing the generated values within the multi-step form.
+ * @returns A `Position` object representing the initial position, or `null` if there is no initial position.
+ */
 export declare function into(schema: LoopSchema, values: object): Position | null;
+/**
+ * Returns the next position for the given `LoopSchema` object if there is a next position, otherwise it returns `null`.
+ *
+ * @param schema A `LoopSchema` object.
+ * @param position A `Position` object representing the current position.
+ * @param values An object containing the generated values within the multi-step form.
+ * @returns A `Position` object representing the next position, or `null` if there is no next position.
+ */
 export declare function next(schema: LoopSchema, position: Position, values: object): Position | null;
+/**
+ * Returns the `ItemSchema` object at the given position within the given `LoopSchema` object.
+ *
+ * @param schema The `LoopSchema` object.
+ * @param position The position within the `LoopSchema` object.
+ * @returns The `ItemSchema` object at the given position within the `LoopSchema` object.
+ */
 export declare function at(schema: LoopSchema, position: Position): ItemSchema;
 //# sourceMappingURL=flow.loop.d.ts.map

package/dist/utils/schema/flow.loop.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"flow.loop.d.ts","sourceRoot":"","sources":["../../../src/utils/schema/flow.loop.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACxE,OAAO,KAAK,EAAE,QAAQ,EAAgB,MAAM,2BAA2B,CAAC;AAExE,wBAAgB,EAAE,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,IAAI,UAAU,CAE3D;AAED,wBAAgB,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,GAAG,QAAQ,GAAG,IAAI,CAOxE;AAED,wBAAgB,IAAI,CAClB,MAAM,EAAE,UAAU,EAClB,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,MAAM,GACb,QAAQ,GAAG,IAAI,CASjB;AAED,wBAAgB,EAAE,CAAC,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,QAAQ,GAAG,UAAU,CAGrE"}
+{"version":3,"file":"flow.loop.d.ts","sourceRoot":"","sources":["../../../src/utils/schema/flow.loop.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACxE,OAAO,KAAK,EAAE,QAAQ,EAAgB,MAAM,2BAA2B,CAAC;AAExE;;;;;GAKG;AACH,wBAAgB,EAAE,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,IAAI,UAAU,CAE3D;AAED;;;;;;GAMG;AACH,wBAAgB,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,GAAG,QAAQ,GAAG,IAAI,CAOxE;AAED;;;;;;;GAOG;AACH,wBAAgB,IAAI,CAClB,MAAM,EAAE,UAAU,EAClB,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,MAAM,GACb,QAAQ,GAAG,IAAI,CASjB;AAED;;;;;;GAMG;AACH,wBAAgB,EAAE,CAAC,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,QAAQ,GAAG,UAAU,CAGrE"}

package/dist/utils/schema/flow.loop.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=flow.loop.test.d.ts.map

package/dist/utils/schema/flow.loop.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"flow.loop.test.d.ts","sourceRoot":"","sources":["../../../src/utils/schema/flow.loop.test.ts"],"names":[],"mappings":""}