@jfdevelops/multi-step-form-core 1.0.0-alpha.17 → 1.0.0-alpha.18

package/dist/schema.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.mts","names":[],"sources":["../src/schema.ts"],"sourcesContent":[],"mappings":";;;;;;;;UAoBiB,yCACD,KAAK,0BACH,gDAER,8BAA8B,OAAO,SAAS;KAC5C,0CACI,KAAK,0BACH,iDAEP,2BAA2B,OAAO,SAAS;cAEzC,iCACE,KAAK,wBACH,aAAa,oCACP,aAAa,MAAM,UAAU,aAAa,MAAM,6BACjD,YAAY,gBAAgB,YAAY,2CAChC,2BACpB,aAAa,4BAA4B,MAAM,QAAQ;EAjBhD,SAAA,+BAA0B,EAkBC,MAlBD;EACtB,SAAA,UAAA,EAkBE,uBAlBF,CAmBjB,IAnBiB,EAoBjB,MApBiB,EAqBjB,YArBiB,EAsBjB,WAtBiB,EAuBjB,UAvBiB,CAAA;EAAL,OAAA,EAyBL,oBAzBK,CAyBgB,YAzBhB,EAyB8B,UAzB9B,CAAA;EACE,QAAA,UAAA;EAEsB,WAAA,CAAA,OAAA,EA0B3B,0BA1B2B,CA2BlC,IA3BkC,EA6BlC,SA7BkC,CA6BxB,MA7BwB,EA6BhB,UA7BgB,CAAA,EA8BlC,UA9BkC,CAAA;EAAO,WAAA,CAAA,CAAA,EAAA,IAAA;EAAS,KAAA,CAAA,CAAA,EAAA,GAAA,GAAA,IAAA;EAA9C,OAAA,CAAA,CAAA,EAAA,IAAA;EAA6B,SAAA,CAAA,CAAA,EAAA,OAAA;EAC3B,UAAA,OAAA,CAAA,CAAA,EAAA,IAAA;EACS,UAAA,SAAA,CAAA,CAAA,EAAA,IAAA;EAAL,UAAA,MAAA,CAAA,CAAA,EAAA,IAAA;;AAGsB,iBAiGtB,yBAjGsB,CAAA,aAkGvB,IAlGuB,CAkGlB,MAlGkB,CAAA,EAAA,eAmGrB,UAnGqB,GAmGR,aAnGQ,EAAA,qBAoGf,YApGe,CAoGF,IApGE,EAoGI,MApGJ,CAAA,GAoGc,YApGd,CAoG2B,IApG3B,EAoGiC,MApGjC,CAAA,EAAA,oBAqGhB,WArGgB,CAqGJ,YArGI,CAAA,GAqGY,WArGZ,CAqGwB,YArGxB,CAAA,EAAA,mBAAA,MAAA,GAsGR,iBAtGQ,CAAA,CAAA,OAAA,EAwG3B,0BAxG2B,CAyGlC,IAzGkC,EA2GlC,SA3GkC,CA2GxB,MA3GwB,EA2GhB,UA3GgB,CAAA,EA4GlC,UA5GkC,CAAA,CAAA,EA6GnC,mBA7GmC,CA6GnC,IA7GmC,EA6GnC,MA7GmC,EA6GnC,YA7GmC,EA6GnC,WA7GmC,EA6GnC,UA7GmC,CAAA"}

package/dist/schema.mjs

@@ -0,0 +1,67 @@
+import { setCasingType } from "./utils/casing.mjs";
+import { DEFAULT_STORAGE_KEY, MultiStepFormStorage } from "./storage.mjs";
+import { Subscribable } from "./subscribable.mjs";
+import { MultiStepFormStepSchema } from "./steps/schema.mjs";
+import "./steps/index.mjs";
+
+//#region src/schema.ts
+var MultiStepFormSchema = class extends Subscribable {
+	defaultNameTransformationCasing;
+	stepSchema;
+	storage;
+	mountCount = 0;
+	constructor(options) {
+		super();
+		const { steps, nameTransformCasing, storage } = options;
+		this.defaultNameTransformationCasing = setCasingType(nameTransformCasing);
+		this.stepSchema = new MultiStepFormStepSchema({
+			steps,
+			nameTransformCasing: this.defaultNameTransformationCasing
+		});
+		this.storage = new MultiStepFormStorage({
+			key: storage?.key ?? DEFAULT_STORAGE_KEY,
+			data: this.stepSchema.value,
+			store: storage?.store,
+			throwWhenUndefined: storage?.throwWhenUndefined ?? false
+		});
+		this.stepSchema.subscribe(() => {
+			this.notify();
+		});
+	}
+	getSnapshot() {
+		return this;
+	}
+	mount() {
+		this.mountCount++;
+		if (this.mountCount === 1) this.onMount();
+		return () => {
+			this.unmount();
+		};
+	}
+	unmount() {
+		this.mountCount = Math.max(0, this.mountCount - 1);
+		if (this.mountCount === 0) this.onUnmount();
+	}
+	isMounted() {
+		return this.mountCount > 0;
+	}
+	onMount() {}
+	onUnmount() {}
+	notify() {
+		for (const listener of this.listeners) listener({
+			nameTransformCasing: this.defaultNameTransformationCasing,
+			storage: {
+				key: this.storage.key,
+				store: this.storage.store
+			},
+			steps: this.stepSchema.original
+		});
+	}
+};
+function createMultiStepFormSchema(options) {
+	return new MultiStepFormSchema(options);
+}
+
+//#endregion
+export { MultiStepFormSchema, createMultiStepFormSchema };
+//# sourceMappingURL=schema.mjs.map

package/dist/schema.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.mjs","names":[],"sources":["../src/schema.ts"],"sourcesContent":["import {\n  MultiStepFormStepSchema,\n  type MultiStepFormSchemaStepConfig,\n  type ResolvedStep,\n  type Step,\n  type StepNumbers,\n} from '@/steps';\nimport {\n  setCasingType,\n  type CasingType,\n  type Constrain,\n  type DefaultCasing,\n} from '@/utils';\nimport {\n  DEFAULT_STORAGE_KEY,\n  MultiStepFormStorage,\n  type DefaultStorageKey,\n} from './storage.js';\nimport { Subscribable } from './subscribable.js';\n\nexport interface MultiStepFormSchemaOptions<\n  TStep extends Step<TCasing>,\n  TCasing extends CasingType,\n  TStorageKey extends string\n> extends MultiStepFormSchemaStepConfig<TStep, TCasing, TStorageKey> {}\nexport type MultiStepFormSchemaListener<\n  TStep extends Step<TCasing>,\n  TCasing extends CasingType,\n  TStorageKey extends string\n> = (data: MultiStepFormSchemaOptions<TStep, TCasing, TStorageKey>) => void;\n\nexport class MultiStepFormSchema<\n  step extends Step<casing>,\n  casing extends CasingType = DefaultCasing,\n  resolvedStep extends ResolvedStep<step, casing> = ResolvedStep<step, casing>,\n  stepNumbers extends StepNumbers<resolvedStep> = StepNumbers<resolvedStep>,\n  storageKey extends string = DefaultStorageKey\n> extends Subscribable<MultiStepFormSchemaListener<step, casing, storageKey>> {\n  readonly defaultNameTransformationCasing: casing;\n  readonly stepSchema: MultiStepFormStepSchema<\n    step,\n    casing,\n    resolvedStep,\n    stepNumbers,\n    storageKey\n  >;\n  storage: MultiStepFormStorage<resolvedStep, storageKey>;\n  private mountCount = 0;\n\n  constructor(\n    options: MultiStepFormSchemaOptions<\n      step,\n      // Allows full autocomplete\n      Constrain<casing, CasingType>,\n      storageKey\n    >\n  ) {\n    super();\n\n    const { steps, nameTransformCasing, storage } = options;\n\n    this.defaultNameTransformationCasing = setCasingType(\n      nameTransformCasing\n    ) as casing;\n    // @ts-ignore Type instantiation is excessively deep and possibly infinite\n    this.stepSchema = new MultiStepFormStepSchema({\n      steps,\n      nameTransformCasing: this.defaultNameTransformationCasing,\n    });\n    this.storage = new MultiStepFormStorage<resolvedStep, storageKey>({\n      key: (storage?.key ?? DEFAULT_STORAGE_KEY) as storageKey,\n      data: this.stepSchema.value as never,\n      store: storage?.store,\n      throwWhenUndefined: storage?.throwWhenUndefined ?? false,\n    });\n\n    this.stepSchema.subscribe(() => {\n      this.notify();\n    });\n  }\n\n  getSnapshot() {\n    return this;\n  }\n\n  mount() {\n    this.mountCount++;\n\n    if (this.mountCount === 1) {\n      this.onMount();\n    }\n\n    return () => {\n      this.unmount();\n    };\n  }\n\n  unmount() {\n    this.mountCount = Math.max(0, this.mountCount - 1);\n\n    if (this.mountCount === 0) {\n      this.onUnmount();\n    }\n  }\n\n  isMounted() {\n    return this.mountCount > 0;\n  }\n\n  protected onMount() {}\n  protected onUnmount() {}\n\n  protected notify() {\n    for (const listener of this.listeners) {\n      listener({\n        nameTransformCasing: this.defaultNameTransformationCasing,\n        storage: {\n          key: this.storage.key,\n          store: this.storage.store,\n        },\n        steps: this.stepSchema.original,\n      });\n    }\n  }\n}\n\nexport function createMultiStepFormSchema<\n  step extends Step<casing>,\n  casing extends CasingType = DefaultCasing,\n  resolvedStep extends ResolvedStep<step, casing> = ResolvedStep<step, casing>,\n  stepNumbers extends StepNumbers<resolvedStep> = StepNumbers<resolvedStep>,\n  storageKey extends string = DefaultStorageKey\n>(\n  options: MultiStepFormSchemaOptions<\n    step,\n    // Allows full autocomplete\n    Constrain<casing, CasingType>,\n    storageKey\n  >\n) {\n  return new MultiStepFormSchema<\n    step,\n    casing,\n    resolvedStep,\n    stepNumbers,\n    storageKey\n  >(options);\n}\n"],"mappings":";;;;;;;AA+BA,IAAa,sBAAb,cAMU,aAAoE;CAC5E,AAAS;CACT,AAAS;CAOT;CACA,AAAQ,aAAa;CAErB,YACE,SAMA;AACA,SAAO;EAEP,MAAM,EAAE,OAAO,qBAAqB,YAAY;AAEhD,OAAK,kCAAkC,cACrC,oBACD;AAED,OAAK,aAAa,IAAI,wBAAwB;GAC5C;GACA,qBAAqB,KAAK;GAC3B,CAAC;AACF,OAAK,UAAU,IAAI,qBAA+C;GAChE,KAAM,SAAS,OAAO;GACtB,MAAM,KAAK,WAAW;GACtB,OAAO,SAAS;GAChB,oBAAoB,SAAS,sBAAsB;GACpD,CAAC;AAEF,OAAK,WAAW,gBAAgB;AAC9B,QAAK,QAAQ;IACb;;CAGJ,cAAc;AACZ,SAAO;;CAGT,QAAQ;AACN,OAAK;AAEL,MAAI,KAAK,eAAe,EACtB,MAAK,SAAS;AAGhB,eAAa;AACX,QAAK,SAAS;;;CAIlB,UAAU;AACR,OAAK,aAAa,KAAK,IAAI,GAAG,KAAK,aAAa,EAAE;AAElD,MAAI,KAAK,eAAe,EACtB,MAAK,WAAW;;CAIpB,YAAY;AACV,SAAO,KAAK,aAAa;;CAG3B,AAAU,UAAU;CACpB,AAAU,YAAY;CAEtB,AAAU,SAAS;AACjB,OAAK,MAAM,YAAY,KAAK,UAC1B,UAAS;GACP,qBAAqB,KAAK;GAC1B,SAAS;IACP,KAAK,KAAK,QAAQ;IAClB,OAAO,KAAK,QAAQ;IACrB;GACD,OAAO,KAAK,WAAW;GACxB,CAAC;;;AAKR,SAAgB,0BAOd,SAMA;AACA,QAAO,IAAI,oBAMT,QAAQ"}

package/dist/steps/fields.cjs

@@ -0,0 +1,23 @@
+const require_path = require('../utils/path.cjs');
+require('../_internals.cjs');
+
+//#region src/steps/fields.ts
+let fields;
+(function(_fields) {
+	function resolvedDeepPath(fieldPath, fields$1, filler = "defaultValue") {
+		const [parent, ...children] = fieldPath.split(".");
+		const shared = `${parent}.${filler}`;
+		const fullPath = children.length === 0 ? shared : `${shared}.${children.join(".")}`;
+		return require_path.path.pickBy(fields$1, fullPath);
+	}
+	_fields.resolvedDeepPath = resolvedDeepPath;
+})(fields || (fields = {}));
+
+//#endregion
+Object.defineProperty(exports, 'fields', {
+  enumerable: true,
+  get: function () {
+    return fields;
+  }
+});
+//# sourceMappingURL=fields.cjs.map

package/dist/steps/fields.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"fields.cjs","names":["path","fields"],"sources":["../../src/steps/fields.ts"],"sourcesContent":["import { path } from '@/internals';\nimport type { DeepKeys, Join, Split } from '@/utils';\nimport type { AnyResolvedStep, GetFieldsForStep } from './types';\n\nexport namespace fields {\n  type GetDeepFields<TFields> = [keyof TFields] extends [never]\n    ? never\n    : {\n        [_ in keyof TFields]: TFields[_] extends Record<\n          'defaultValue',\n          infer value\n        >\n          ? keyof value extends never\n            ? TFields\n            : DeepKeys<{ [field in _]: TFields[_]['defaultValue'] }>\n          : never;\n      }[keyof TFields];\n  export type get<\n    TResolvedStep extends AnyResolvedStep,\n    TStep extends keyof TResolvedStep,\n    TFields extends GetFieldsForStep<TResolvedStep, TStep> = GetFieldsForStep<\n      TResolvedStep,\n      TStep\n    >\n  > = TFields;\n  export type removeParentPath<T extends string> = Split<T, '.'> extends [\n    infer _,\n    ...infer rest\n  ]\n    ? rest extends string[]\n      ? Join<rest, '.'>\n      : never\n    : never;\n  export type getDeep<\n    TResolvedStep extends AnyResolvedStep,\n    TStep extends keyof TResolvedStep\n  > = GetDeepFields<\n    get<TResolvedStep, TStep>\n  > extends infer value extends string\n    ? value\n    : never;\n  export type parentOf<T extends string> = Split<T, '.'>[0];\n  export type resolveDeepPath<\n    TResolvedStep extends AnyResolvedStep,\n    TTargetStep extends keyof TResolvedStep,\n    TField extends getDeep<TResolvedStep, TTargetStep>,\n    TParent extends parentOf<TField> = parentOf<TField>,\n    TDefaultValue = get<TResolvedStep, TTargetStep>[TParent]['defaultValue']\n  > = removeParentPath<TField> extends never\n    ? TDefaultValue\n    : path.pickBy<TDefaultValue, removeParentPath<TField>>;\n\n  // TODO add field validation\n  export function resolvedDeepPath<\n    resolvedStep extends AnyResolvedStep,\n    targetStep extends keyof resolvedStep,\n    fields extends get<resolvedStep, targetStep>,\n    fieldPath extends getDeep<resolvedStep, targetStep>\n  >(fieldPath: fieldPath, fields: fields, filler = 'defaultValue') {\n    const [parent, ...children] = fieldPath.split('.');\n    const shared = `${parent}.${filler}`;\n    const fullPath = (\n      children.length === 0 ? shared : `${shared}.${children.join('.')}`\n    ) as DeepKeys<fields>;\n\n    const resolvedValue = path.pickBy(fields, fullPath) as resolveDeepPath<\n      resolvedStep,\n      targetStep,\n      fieldPath\n    >;\n\n    return resolvedValue;\n  }\n}\n"],"mappings":";;;;;;CAqDS,SAAS,iBAKd,WAAsB,UAAgB,SAAS,gBAAgB;EAC/D,MAAM,CAAC,QAAQ,GAAG,YAAY,UAAU,MAAM,IAAI;EAClD,MAAM,SAAS,GAAG,OAAO,GAAG;EAC5B,MAAM,WACJ,SAAS,WAAW,IAAI,SAAS,GAAG,OAAO,GAAG,SAAS,KAAK,IAAI;AASlE,SANsBA,kBAAK,OAAOC,UAAQ,SAAS"}

package/dist/steps/fields.d.cts

@@ -0,0 +1,18 @@
+import { DeepKeys, Join, Split } from "../utils/types.cjs";
+import { path } from "../utils/path.cjs";
+import { AnyResolvedStep, GetFieldsForStep } from "./types.cjs";
+
+//#region src/steps/fields.d.ts
+declare namespace fields {
+  type GetDeepFields<TFields> = [keyof TFields] extends [never] ? never : { [_ in keyof TFields]: TFields[_] extends Record<'defaultValue', infer value> ? keyof value extends never ? TFields : DeepKeys<{ [field in _]: TFields[_]['defaultValue'] }> : never }[keyof TFields];
+  export type get<TResolvedStep extends AnyResolvedStep, TStep extends keyof TResolvedStep, TFields extends GetFieldsForStep<TResolvedStep, TStep> = GetFieldsForStep<TResolvedStep, TStep>> = TFields;
+  export type removeParentPath<T extends string> = Split<T, '.'> extends [infer _, ...infer rest] ? rest extends string[] ? Join<rest, '.'> : never : never;
+  export type getDeep<TResolvedStep extends AnyResolvedStep, TStep extends keyof TResolvedStep> = GetDeepFields<get<TResolvedStep, TStep>> extends infer value extends string ? value : never;
+  export type parentOf<T extends string> = Split<T, '.'>[0];
+  export type resolveDeepPath<TResolvedStep extends AnyResolvedStep, TTargetStep extends keyof TResolvedStep, TField extends getDeep<TResolvedStep, TTargetStep>, TParent extends parentOf<TField> = parentOf<TField>, TDefaultValue = get<TResolvedStep, TTargetStep>[TParent]['defaultValue']> = removeParentPath<TField> extends never ? TDefaultValue : path.pickBy<TDefaultValue, removeParentPath<TField>>;
+  export function resolvedDeepPath<resolvedStep extends AnyResolvedStep, targetStep extends keyof resolvedStep, fields$1 extends get<resolvedStep, targetStep>, fieldPath extends getDeep<resolvedStep, targetStep>>(fieldPath: fieldPath, fields: fields$1, filler?: string): resolveDeepPath<resolvedStep, targetStep, fieldPath, parentOf<fieldPath>, GetFieldsForStep<resolvedStep, targetStep>[parentOf<fieldPath>]["defaultValue"]>;
+  export {};
+}
+//#endregion
+export { fields };
+//# sourceMappingURL=fields.d.cts.map

package/dist/steps/fields.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fields.d.cts","names":[],"sources":["../../src/steps/fields.ts"],"sourcesContent":[],"mappings":";;;;;kBAIiB,MAAA;uCACsB,2CADhB,MAIH,OAJG,GAIO,OAJP,CAIe,CAJf,CAAA,SAI0B,MAJ1B,CAAA,cAAA,EAAA,KAAA,MAAA,CAAA,GAAA,MAQL,KARK,SAAA,KAAA,GAST,OATS,GAUT,QAVS,CAAA,YAUY,CATI,GASA,OATA,CASQ,CATR,CAAA,CAAA,cAAA,CAAA,EAGnB,CAAA,GAAA,KAAA,EAAU,CAAA,MAQhB,OARgB,CAAA;EAAQ,OAAA,KAAA,GAAA,CAAA,sBAUZ,eAVY,EAAA,cAAA,MAWd,aAXc,EAAA,gBAYlB,gBAZkB,CAYD,aAZC,EAYc,KAZd,CAAA,GAYuB,gBAZvB,CAahC,aAbgC,EAchC,KAdgC,CAAA,CAAA,GAgBhC,OAhBgC;EAAW,OAAA,KAAA,gBAAA,CAAA,UAAA,MAAA,CAAA,GAiBE,KAjBF,CAiBQ,CAjBR,EAAA,GAAA,CAAA,SAAA,CAI/B,KAAA,EAAA,EACJ,GAAA,KAAA,KAAA,CACqB,GAAA,IAAA,SAAA,MAAA,EAAA,GAgB3B,IAhB2B,CAgBtB,IAhBsB,EAAA,GAAA,CAAA,GAAA,KAAA,GAAA,KAAA;EAAI,OAAA,KAAA,OAAA,CAAA,sBAoBb,eApBa,EAAA,cAAA,MAqBf,aArBe,CAAA,GAsBjC,aAtBiC,CAuBnC,GAvBmC,CAuB/B,aAvB+B,EAuBhB,KAvBgB,CAAA,CAAA,SAAA,KAAA,eAAA,MAAA,GAAA,KAAA,GAAA,KAAA;EAAQ,OAAA,KAAA,QAAA,CAAA,UAAA,MAAA,CAAA,GA2BJ,KA3BI,CA2BE,CA3BF,EAAA,GAAA,CAAA,CAAA,CAAA,CAAA;EAAjC,OAAA,KAAA,eAAA,CAAA,sBA6BY,eA7BZ,EAAA,oBAAA,MA8BgB,aA9BhB,EAAA,eA+BK,OA/BL,CA+Ba,aA/Bb,EA+B4B,WA/B5B,CAAA,EAAA,gBAgCM,QAhCN,CAgCe,MAhCf,CAAA,GAgCyB,QAhCzB,CAgCkC,MAhClC,CAAA,EAAA,gBAiCM,GAjCN,CAiCU,aAjCV,EAiCyB,WAjCzB,CAAA,CAiCsC,OAjCtC,CAAA,CAAA,cAAA,CAAA,CAAA,GAkCR,gBAlCQ,CAkCS,MAlCT,CAAA,SAAA,KAAA,GAmCR,aAnCQ,GAoCR,IAAA,CAAK,MApCG,CAoCI,aApCJ,EAoCmB,gBApCnB,CAoCoC,MApCpC,CAAA,CAAA;EAEA,OAAA,SAAA,gBAAA,CAAA,qBAsCW,eAtCX,EAAA,mBAAA,MAuCe,YAvCf,EAAA,iBAwCK,GAxCL,CAwCS,YAxCT,EAwCuB,UAxCvB,CAAA,EAAA,kBAyCQ,OAzCR,CAyCgB,YAzChB,EAyC8B,UAzC9B,CAAA,CAAA,CAAA,SAAA,EA0CC,SA1CD,EAAA,MAAA,EA0CoB,QA1CpB,EAAA,MAAA,CAAA,EAAA,MAAA,CAAA,EA0CmD,eA1CnD,CA0CmD,YA1CnD,EA0CmD,UA1CnD,EA0CmD,SA1CnD,EA0CmD,QA1CnD,CA0CmD,SA1CnD,CAAA,EA0CmD,gBA1CnD,CA0CmD,YA1CnD,EA0CmD,UA1CnD,CAAA,CA0CmD,QA1CnD,CA0CmD,SA1CnD,CAAA,CAAA,CAAA,cAAA,CAAA,CAAA;EAEY"}

package/dist/steps/fields.d.mts

@@ -0,0 +1,18 @@
+import { DeepKeys, Join, Split } from "../utils/types.mjs";
+import { path } from "../utils/path.mjs";
+import { AnyResolvedStep, GetFieldsForStep } from "./types.mjs";
+
+//#region src/steps/fields.d.ts
+declare namespace fields {
+  type GetDeepFields<TFields> = [keyof TFields] extends [never] ? never : { [_ in keyof TFields]: TFields[_] extends Record<'defaultValue', infer value> ? keyof value extends never ? TFields : DeepKeys<{ [field in _]: TFields[_]['defaultValue'] }> : never }[keyof TFields];
+  export type get<TResolvedStep extends AnyResolvedStep, TStep extends keyof TResolvedStep, TFields extends GetFieldsForStep<TResolvedStep, TStep> = GetFieldsForStep<TResolvedStep, TStep>> = TFields;
+  export type removeParentPath<T extends string> = Split<T, '.'> extends [infer _, ...infer rest] ? rest extends string[] ? Join<rest, '.'> : never : never;
+  export type getDeep<TResolvedStep extends AnyResolvedStep, TStep extends keyof TResolvedStep> = GetDeepFields<get<TResolvedStep, TStep>> extends infer value extends string ? value : never;
+  export type parentOf<T extends string> = Split<T, '.'>[0];
+  export type resolveDeepPath<TResolvedStep extends AnyResolvedStep, TTargetStep extends keyof TResolvedStep, TField extends getDeep<TResolvedStep, TTargetStep>, TParent extends parentOf<TField> = parentOf<TField>, TDefaultValue = get<TResolvedStep, TTargetStep>[TParent]['defaultValue']> = removeParentPath<TField> extends never ? TDefaultValue : path.pickBy<TDefaultValue, removeParentPath<TField>>;
+  export function resolvedDeepPath<resolvedStep extends AnyResolvedStep, targetStep extends keyof resolvedStep, fields$1 extends get<resolvedStep, targetStep>, fieldPath extends getDeep<resolvedStep, targetStep>>(fieldPath: fieldPath, fields: fields$1, filler?: string): resolveDeepPath<resolvedStep, targetStep, fieldPath, parentOf<fieldPath>, GetFieldsForStep<resolvedStep, targetStep>[parentOf<fieldPath>]["defaultValue"]>;
+  export {};
+}
+//#endregion
+export { fields };
+//# sourceMappingURL=fields.d.mts.map

package/dist/steps/fields.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fields.d.mts","names":[],"sources":["../../src/steps/fields.ts"],"sourcesContent":[],"mappings":";;;;;kBAIiB,MAAA;uCACsB,2CADhB,MAIH,OAJG,GAIO,OAJP,CAIe,CAJf,CAAA,SAI0B,MAJ1B,CAAA,cAAA,EAAA,KAAA,MAAA,CAAA,GAAA,MAQL,KARK,SAAA,KAAA,GAST,OATS,GAUT,QAVS,CAAA,YAUY,CATI,GASA,OATA,CASQ,CATR,CAAA,CAAA,cAAA,CAAA,EAGnB,CAAA,GAAA,KAAA,EAAU,CAAA,MAQhB,OARgB,CAAA;EAAQ,OAAA,KAAA,GAAA,CAAA,sBAUZ,eAVY,EAAA,cAAA,MAWd,aAXc,EAAA,gBAYlB,gBAZkB,CAYD,aAZC,EAYc,KAZd,CAAA,GAYuB,gBAZvB,CAahC,aAbgC,EAchC,KAdgC,CAAA,CAAA,GAgBhC,OAhBgC;EAAW,OAAA,KAAA,gBAAA,CAAA,UAAA,MAAA,CAAA,GAiBE,KAjBF,CAiBQ,CAjBR,EAAA,GAAA,CAAA,SAAA,CAI/B,KAAA,EAAA,EACJ,GAAA,KAAA,KAAA,CACqB,GAAA,IAAA,SAAA,MAAA,EAAA,GAgB3B,IAhB2B,CAgBtB,IAhBsB,EAAA,GAAA,CAAA,GAAA,KAAA,GAAA,KAAA;EAAI,OAAA,KAAA,OAAA,CAAA,sBAoBb,eApBa,EAAA,cAAA,MAqBf,aArBe,CAAA,GAsBjC,aAtBiC,CAuBnC,GAvBmC,CAuB/B,aAvB+B,EAuBhB,KAvBgB,CAAA,CAAA,SAAA,KAAA,eAAA,MAAA,GAAA,KAAA,GAAA,KAAA;EAAQ,OAAA,KAAA,QAAA,CAAA,UAAA,MAAA,CAAA,GA2BJ,KA3BI,CA2BE,CA3BF,EAAA,GAAA,CAAA,CAAA,CAAA,CAAA;EAAjC,OAAA,KAAA,eAAA,CAAA,sBA6BY,eA7BZ,EAAA,oBAAA,MA8BgB,aA9BhB,EAAA,eA+BK,OA/BL,CA+Ba,aA/Bb,EA+B4B,WA/B5B,CAAA,EAAA,gBAgCM,QAhCN,CAgCe,MAhCf,CAAA,GAgCyB,QAhCzB,CAgCkC,MAhClC,CAAA,EAAA,gBAiCM,GAjCN,CAiCU,aAjCV,EAiCyB,WAjCzB,CAAA,CAiCsC,OAjCtC,CAAA,CAAA,cAAA,CAAA,CAAA,GAkCR,gBAlCQ,CAkCS,MAlCT,CAAA,SAAA,KAAA,GAmCR,aAnCQ,GAoCR,IAAA,CAAK,MApCG,CAoCI,aApCJ,EAoCmB,gBApCnB,CAoCoC,MApCpC,CAAA,CAAA;EAEA,OAAA,SAAA,gBAAA,CAAA,qBAsCW,eAtCX,EAAA,mBAAA,MAuCe,YAvCf,EAAA,iBAwCK,GAxCL,CAwCS,YAxCT,EAwCuB,UAxCvB,CAAA,EAAA,kBAyCQ,OAzCR,CAyCgB,YAzChB,EAyC8B,UAzC9B,CAAA,CAAA,CAAA,SAAA,EA0CC,SA1CD,EAAA,MAAA,EA0CoB,QA1CpB,EAAA,MAAA,CAAA,EAAA,MAAA,CAAA,EA0CmD,eA1CnD,CA0CmD,YA1CnD,EA0CmD,UA1CnD,EA0CmD,SA1CnD,EA0CmD,QA1CnD,CA0CmD,SA1CnD,CAAA,EA0CmD,gBA1CnD,CA0CmD,YA1CnD,EA0CmD,UA1CnD,CAAA,CA0CmD,QA1CnD,CA0CmD,SA1CnD,CAAA,CAAA,CAAA,cAAA,CAAA,CAAA;EAEY"}

package/dist/steps/fields.mjs

@@ -0,0 +1,18 @@
+import { path } from "../utils/path.mjs";
+import "../_internals.mjs";
+
+//#region src/steps/fields.ts
+let fields;
+(function(_fields) {
+	function resolvedDeepPath(fieldPath, fields$1, filler = "defaultValue") {
+		const [parent, ...children] = fieldPath.split(".");
+		const shared = `${parent}.${filler}`;
+		const fullPath = children.length === 0 ? shared : `${shared}.${children.join(".")}`;
+		return path.pickBy(fields$1, fullPath);
+	}
+	_fields.resolvedDeepPath = resolvedDeepPath;
+})(fields || (fields = {}));
+
+//#endregion
+export { fields };
+//# sourceMappingURL=fields.mjs.map

package/dist/steps/fields.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"fields.mjs","names":["fields"],"sources":["../../src/steps/fields.ts"],"sourcesContent":["import { path } from '@/internals';\nimport type { DeepKeys, Join, Split } from '@/utils';\nimport type { AnyResolvedStep, GetFieldsForStep } from './types';\n\nexport namespace fields {\n  type GetDeepFields<TFields> = [keyof TFields] extends [never]\n    ? never\n    : {\n        [_ in keyof TFields]: TFields[_] extends Record<\n          'defaultValue',\n          infer value\n        >\n          ? keyof value extends never\n            ? TFields\n            : DeepKeys<{ [field in _]: TFields[_]['defaultValue'] }>\n          : never;\n      }[keyof TFields];\n  export type get<\n    TResolvedStep extends AnyResolvedStep,\n    TStep extends keyof TResolvedStep,\n    TFields extends GetFieldsForStep<TResolvedStep, TStep> = GetFieldsForStep<\n      TResolvedStep,\n      TStep\n    >\n  > = TFields;\n  export type removeParentPath<T extends string> = Split<T, '.'> extends [\n    infer _,\n    ...infer rest\n  ]\n    ? rest extends string[]\n      ? Join<rest, '.'>\n      : never\n    : never;\n  export type getDeep<\n    TResolvedStep extends AnyResolvedStep,\n    TStep extends keyof TResolvedStep\n  > = GetDeepFields<\n    get<TResolvedStep, TStep>\n  > extends infer value extends string\n    ? value\n    : never;\n  export type parentOf<T extends string> = Split<T, '.'>[0];\n  export type resolveDeepPath<\n    TResolvedStep extends AnyResolvedStep,\n    TTargetStep extends keyof TResolvedStep,\n    TField extends getDeep<TResolvedStep, TTargetStep>,\n    TParent extends parentOf<TField> = parentOf<TField>,\n    TDefaultValue = get<TResolvedStep, TTargetStep>[TParent]['defaultValue']\n  > = removeParentPath<TField> extends never\n    ? TDefaultValue\n    : path.pickBy<TDefaultValue, removeParentPath<TField>>;\n\n  // TODO add field validation\n  export function resolvedDeepPath<\n    resolvedStep extends AnyResolvedStep,\n    targetStep extends keyof resolvedStep,\n    fields extends get<resolvedStep, targetStep>,\n    fieldPath extends getDeep<resolvedStep, targetStep>\n  >(fieldPath: fieldPath, fields: fields, filler = 'defaultValue') {\n    const [parent, ...children] = fieldPath.split('.');\n    const shared = `${parent}.${filler}`;\n    const fullPath = (\n      children.length === 0 ? shared : `${shared}.${children.join('.')}`\n    ) as DeepKeys<fields>;\n\n    const resolvedValue = path.pickBy(fields, fullPath) as resolveDeepPath<\n      resolvedStep,\n      targetStep,\n      fieldPath\n    >;\n\n    return resolvedValue;\n  }\n}\n"],"mappings":";;;;;;CAqDS,SAAS,iBAKd,WAAsB,UAAgB,SAAS,gBAAgB;EAC/D,MAAM,CAAC,QAAQ,GAAG,YAAY,UAAU,MAAM,IAAI;EAClD,MAAM,SAAS,GAAG,OAAO,GAAG;EAC5B,MAAM,WACJ,SAAS,WAAW,IAAI,SAAS,GAAG,OAAO,GAAG,SAAS,KAAK,IAAI;AASlE,SANsB,KAAK,OAAOA,UAAQ,SAAS"}

package/dist/steps/index.cjs

@@ -0,0 +1,4 @@
+const require_utils = require('./utils.cjs');
+const require_fields = require('./fields.cjs');
+const require_schema = require('./schema.cjs');
+const require_types = require('./types.cjs');

package/dist/steps/index.mjs

@@ -0,0 +1,6 @@
+import { createCtx } from "./utils.mjs";
+import { fields } from "./fields.mjs";
+import { MultiStepFormStepSchema } from "./schema.mjs";
+import { HelperFnChosenSteps } from "./types.mjs";
+
+export {  };

package/dist/steps/schema.cjs

@@ -0,0 +1,194 @@
+const require_invariant = require('../utils/invariant.cjs');
+const require_utils = require('./utils.cjs');
+const require_casing = require('../utils/casing.cjs');
+const require_field_types = require('../utils/field-types.cjs');
+const require_utils$1 = require('../internals/utils.cjs');
+const require_step_schema = require('../internals/step-schema.cjs');
+const require_storage = require('../storage.cjs');
+const require_subscribable = require('../subscribable.cjs');
+const require_fields = require('./fields.cjs');
+
+//#region src/steps/schema.ts
+/**
+* Available transformation types for the step numbers.
+*/
+const AS_TYPES = [
+	"string",
+	"number",
+	"array.string",
+	"array.string.untyped"
+];
+function assertObjectFields(obj, checks) {
+	if (typeof obj !== "object" || obj === null) return false;
+	for (const key of Object.keys(checks)) {
+		if (!(key in obj)) return false;
+		const checkFn = checks[key];
+		const value = obj[key];
+		if (!checkFn(value)) return false;
+	}
+	return true;
+}
+var MultiStepFormStepSchema = class extends require_subscribable.Subscribable {
+	/**
+	* The original config before any validation or transformations have been applied.
+	*/
+	original;
+	/**
+	* The resolved step values.
+	*/
+	value;
+	steps;
+	defaultNameTransformationCasing;
+	firstStep;
+	lastStep;
+	stepNumbers;
+	storage;
+	#internal;
+	constructor(config) {
+		super();
+		const { steps, nameTransformCasing, storage } = config;
+		this.defaultNameTransformationCasing = require_casing.setCasingType(nameTransformCasing);
+		this.original = steps;
+		this.value = require_utils$1.createStep(this.original);
+		this.storage = new require_storage.MultiStepFormStorage({
+			data: this.value,
+			key: storage?.key ?? require_storage.DEFAULT_STORAGE_KEY,
+			store: storage?.store,
+			throwWhenUndefined: storage?.throwWhenUndefined ?? false
+		});
+		this.#internal = new require_step_schema.MultiStepFormStepSchemaInternal({
+			originalValue: this.original,
+			getValue: () => this.value,
+			setValue: (next) => this.handlePostUpdate(next)
+		});
+		this.value = this.#internal.enrichValues(this.value);
+		this.stepNumbers = Object.keys(this.value).map((key) => Number.parseInt(key.replace("step", "")));
+		this.firstStep = this.first();
+		this.lastStep = this.last();
+		this.steps = {
+			first: this.firstStep.step,
+			last: this.lastStep.step,
+			value: this.stepNumbers,
+			as: (asType) => {
+				require_invariant.invariant(typeof asType === "string", `The type of the target transformation type must be a string, was ${typeof asType}`);
+				if (asType === "string") return this.stepNumbers.map((value) => `'${value}'`).join(" | ");
+				if (asType === "number") return this.stepNumbers.join(" | ");
+				if (asType.includes("array.string")) return this.stepNumbers.map((value) => `${value}`);
+				throw new Error(`Transformation type "${asType}" is not supported. Available transformations include: ${AS_TYPES.map((value) => `"${value}"`).join(", ")}`);
+			},
+			isValidStepNumber: (stepNumber) => this.stepNumbers.includes(stepNumber),
+			isValidStepKey: (value) => require_utils$1.isValidStepKey(this.value, value)
+		};
+		this.sync();
+	}
+	/**
+	* @internal
+	*/
+	__getStorage() {
+		return this.storage;
+	}
+	getSnapshot() {
+		return this;
+	}
+	/**
+	* Syncs the values from storage to {@linkcode value}.
+	*/
+	sync() {
+		const storageValues = this.__getStorage().get();
+		if (storageValues) this.value = { ...this.#internal.enrichValues(storageValues) };
+	}
+	notify() {
+		for (const listener of this.listeners) listener({
+			defaultNameTransformationCasing: this.defaultNameTransformationCasing,
+			original: this.original,
+			steps: this.steps,
+			value: this.value
+		});
+	}
+	/**
+	* Gets the data for a specific step.
+	* @param options The options for getting the step data.
+	* @returns The step data for the target step.
+	*/
+	get(options) {
+		return require_utils.getStep(this.value)(options);
+	}
+	/**
+	* Gets the data for the first step.
+	* @returns The data for the first step.
+	*/
+	first() {
+		const firstStep = Math.min(...this.stepNumbers);
+		return this.get({ step: firstStep });
+	}
+	/**
+	* Gets the data for the last step.
+	* @returns The data for the last step.
+	*/
+	last() {
+		const lastStep = Math.max(...this.stepNumbers);
+		return this.get({ step: lastStep });
+	}
+	handlePostUpdate(next) {
+		this.value = { ...next };
+		this.__getStorage().add(this.value);
+		this.sync();
+		this.notify();
+	}
+	update(options) {
+		this.#internal.update(options);
+	}
+	reset(options) {
+		this.#internal.reset(options);
+	}
+	createHelperFn(options, fn) {
+		const { stepData, ...rest } = options;
+		return this.#internal.createStepHelperFn(stepData)(rest, fn);
+	}
+	/**
+	* Validates that a given object is the proper shape for step data.
+	* @param value
+	*/
+	static hasData(value, options) {
+		if (value === null || typeof value !== "object") return false;
+		return assertObjectFields(value, {
+			title: (v) => typeof v === "string",
+			fields: (v) => {
+				if (v === null || typeof v !== "object") return false;
+				for (const key of Object.keys(v)) {
+					if (typeof key !== "string" || !(key in v)) return false;
+					const current = v[key];
+					if (current === null || typeof current !== "object") return false;
+					if (!assertObjectFields(current, {
+						defaultValue: (v$1) => v$1 !== "undefined" && v$1 !== null,
+						label: (v$1) => typeof v$1 === "string" || typeof v$1 === "boolean" && !v$1,
+						nameTransformCasing: require_casing.isCasingValid,
+						type: require_field_types.isFieldType
+					})) return false;
+				}
+				return true;
+			},
+			createHelperFn: (v) => typeof v === "function",
+			nameTransformCasing: require_casing.isCasingValid,
+			...options?.optionalKeysToCheck
+		});
+	}
+	/**
+	* Gets the value of a given field for a given step.
+	* @param step The step to get the value from.
+	* @param field The field to get the value from.
+	* @returns The value of the {@linkcode field}.
+	*/
+	getValue(step, field) {
+		const stepData = this.value[step];
+		const baseErrorMessage = `Unable to get the value for "${String(step)}.fields.${String(field)}"`;
+		require_invariant.invariant("fields" in stepData, baseErrorMessage);
+		require_invariant.invariant(typeof stepData.fields === "object", `${baseErrorMessage} because "fields" is not an object. This shouldn't be the case, so please open an issue`);
+		const fields$1 = stepData.fields;
+		return require_fields.fields.resolvedDeepPath(field, fields$1);
+	}
+};
+
+//#endregion
+exports.MultiStepFormStepSchema = MultiStepFormStepSchema;
+//# sourceMappingURL=schema.cjs.map

package/dist/steps/schema.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.cjs","names":["Subscribable","#internal","setCasingType","createStep","MultiStepFormStorage","DEFAULT_STORAGE_KEY","MultiStepFormStepSchemaInternal","isValidStepKey","getStep","v","isCasingValid","isFieldType","fields","fieldsUtils"],"sources":["../../src/steps/schema.ts"],"sourcesContent":["import { MultiStepFormStepSchemaInternal } from '@/internals/step-schema';\nimport {\n  DEFAULT_STORAGE_KEY,\n  DefaultStorageKey,\n  MultiStepFormStorage,\n} from '@/storage';\nimport {\n  isCasingValid,\n  isFieldType,\n  setCasingType,\n  type CasingType,\n  type Constrain,\n  type DefaultCasing,\n  type Expand,\n  type Join,\n} from '@/utils';\nimport { invariant } from '@/utils/invariant';\nimport { Subscribable } from '../subscribable';\nimport { fields as fieldsUtils } from './fields';\nimport {\n  AnyResolvedStep,\n  AnyStepField,\n  AnyStepFieldOption,\n  CreateHelperFunctionOptionsWithCustomCtxOptions,\n  CreateHelperFunctionOptionsWithValidator,\n  CreateHelperFunctionOptionsWithoutValidator,\n  CreateStepHelperFn,\n  CreatedHelperFnWithInput,\n  CreatedHelperFnWithoutInput,\n  ExtractStepFromKey,\n  FirstStep,\n  GetCurrentStep,\n  HelperFnChosenSteps,\n  HelperFnWithValidator,\n  HelperFnWithoutValidator,\n  InferStepOptions,\n  LastStep,\n  MultiStepFormSchemaStepConfig,\n  ResolvedFields,\n  ResolvedStep,\n  Step,\n  StepData,\n  StepNumbers,\n  StepOptions,\n  UnionToTuple,\n  UpdateFn,\n  ValidStepKey,\n  type ResetFn,\n} from './types';\nimport { getStep, type GetStepOptions } from './utils';\nimport { createStep, isValidStepKey } from '@/internals/utils';\n\nexport interface MultiStepFormStepSchemaFunctions<\n  TResolvedStep extends AnyResolvedStep,\n  TStepNumbers extends StepNumbers<TResolvedStep>\n> {\n  update: UpdateFn.general<TResolvedStep, TStepNumbers>;\n  createHelperFn: CreateStepHelperFn<TResolvedStep, TStepNumbers>;\n}\nexport type AsType = (typeof AS_TYPES)[number];\ntype Quote<T extends string[]> = {\n  [K in keyof T]: T[K] extends string ? `'${T[K]}'` : never;\n};\nexport type AsTypeMap<\n  resolvedStep extends AnyResolvedStep,\n  stepNumbers extends ExtractStepFromKey<Constrain<keyof resolvedStep, string>>\n> = {\n  // Exclude is needed due to all the Constrains\n  string: Exclude<\n    Join<\n      Constrain<\n        Quote<Constrain<UnionToTuple<`${stepNumbers}`>, string[]>>,\n        string[]\n      >,\n      ' | '\n    >,\n    ''\n  >;\n  number: Exclude<\n    Join<Constrain<UnionToTuple<`${stepNumbers}`>, string[]>, ' | '>,\n    ''\n  >;\n  'array.string': UnionToTuple<`${stepNumbers}`>;\n  'array.string.untyped': string[];\n};\nexport type AsFunctionReturn<\n  resolvedStep extends AnyResolvedStep,\n  stepNumbers extends ExtractStepFromKey<Constrain<keyof resolvedStep, string>>,\n  asType extends AsType\n> = AsTypeMap<resolvedStep, stepNumbers>[asType];\nexport type AsFunction<\n  resolvedStep extends AnyResolvedStep,\n  stepNumbers extends ExtractStepFromKey<Constrain<keyof resolvedStep, string>>\n> = <asType extends AsType>(\n  asType: asType\n) => AsFunctionReturn<resolvedStep, stepNumbers, asType>;\nexport type MultiStepFormStepStepsConfig<\n  TStep extends Step<TCasing>,\n  TCasing extends CasingType,\n  TResolvedStep extends ResolvedStep<TStep, TCasing> = ResolvedStep<\n    TStep,\n    TCasing\n  >,\n  TStepNumbers extends StepNumbers<TResolvedStep> = StepNumbers<TResolvedStep>\n> = {\n  first: FirstStep<TResolvedStep>;\n  last: LastStep<TResolvedStep>;\n  value: ReadonlyArray<TStepNumbers>;\n  as: AsFunction<TResolvedStep, TStepNumbers>;\n  isValidStepNumber: (stepNumber: number) => stepNumber is TStepNumbers;\n  isValidStepKey: (\n    value: string\n  ) => value is Constrain<keyof TResolvedStep, string>;\n};\nexport type MultiStepFormStepSchemaListener<\n  TStep extends Step<TCasing>,\n  TCasing extends CasingType\n> = (data: {\n  original: InferStepOptions<TStep>;\n  value: ResolvedStep<TStep, TCasing>;\n  steps: MultiStepFormStepStepsConfig<TStep, TCasing>;\n  defaultNameTransformationCasing: TCasing;\n}) => void;\n\n/**\n * Available transformation types for the step numbers.\n */\nconst AS_TYPES = [\n  'string',\n  'number',\n  'array.string',\n  'array.string.untyped',\n] as const;\n\ntype ValueCheck<T> = (v: unknown) => v is T;\n\ntype FieldChecks<T extends object> = {\n  [K in keyof T]: ValueCheck<T[K]>;\n};\n\nfunction assertObjectFields<T extends object>(\n  obj: unknown,\n  checks: FieldChecks<T>\n): obj is T {\n  if (typeof obj !== 'object' || obj === null) return false;\n\n  for (const key of Object.keys(checks) as (keyof T)[]) {\n    // Check that the property exists\n    if (!(key in obj)) return false;\n\n    // Now check the type\n    const checkFn = checks[key];\n    const value = (obj as any)[key];\n    if (!checkFn(value)) return false;\n  }\n\n  return true;\n}\n\nexport class MultiStepFormStepSchema<\n    step extends Step<casing>,\n    casing extends CasingType = DefaultCasing,\n    resolvedStep extends ResolvedStep<step, casing> = ResolvedStep<\n      step,\n      casing\n    >,\n    stepNumbers extends StepNumbers<resolvedStep> = StepNumbers<resolvedStep>,\n    storageKey extends string = DefaultStorageKey\n  >\n  extends Subscribable<MultiStepFormStepSchemaListener<step, casing>>\n  implements MultiStepFormStepSchemaFunctions<resolvedStep, stepNumbers>\n{\n  /**\n   * The original config before any validation or transformations have been applied.\n   */\n  readonly original: InferStepOptions<step>;\n  /**\n   * The resolved step values.\n   */\n  value: resolvedStep;\n  readonly steps: MultiStepFormStepStepsConfig<step, casing>;\n  readonly defaultNameTransformationCasing: casing;\n  //@ts-ignore\n  private readonly firstStep: StepData<resolvedStep, FirstStep<resolvedStep>>;\n  private readonly lastStep: StepData<resolvedStep, LastStep<resolvedStep>>;\n  private readonly stepNumbers: Array<number>;\n  private readonly storage: MultiStepFormStorage<resolvedStep, storageKey>;\n  readonly #internal: MultiStepFormStepSchemaInternal<\n    step,\n    casing,\n    resolvedStep,\n    stepNumbers\n  >;\n\n  constructor(\n    config: MultiStepFormSchemaStepConfig<\n      step,\n      Constrain<casing, CasingType>,\n      storageKey\n    >\n  ) {\n    super();\n\n    const { steps, nameTransformCasing, storage } = config;\n\n    this.defaultNameTransformationCasing = setCasingType(\n      nameTransformCasing\n    ) as casing;\n\n    this.original = steps;\n\n    this.value = createStep<step, casing>(this.original) as resolvedStep;\n    this.storage = new MultiStepFormStorage<resolvedStep, storageKey>({\n      data: this.value,\n      key: (storage?.key ?? DEFAULT_STORAGE_KEY) as storageKey,\n      store: storage?.store,\n      throwWhenUndefined: storage?.throwWhenUndefined ?? false,\n    });\n    this.#internal = new MultiStepFormStepSchemaInternal<\n      step,\n      casing,\n      resolvedStep,\n      stepNumbers\n    >({\n      originalValue: this.original,\n      getValue: () => this.value,\n      setValue: (next) => this.handlePostUpdate(next),\n    });\n\n    this.value = this.#internal.enrichValues(this.value);\n    this.stepNumbers = Object.keys(this.value).map((key) =>\n      Number.parseInt(key.replace('step', ''))\n    );\n\n    this.firstStep = this.first();\n    this.lastStep = this.last();\n    this.steps = {\n      first: this.firstStep.step,\n      last: this.lastStep.step,\n      value: this.stepNumbers as unknown as ReadonlyArray<stepNumbers>,\n      as: (asType): any => {\n        invariant(\n          typeof asType === 'string',\n          `The type of the target transformation type must be a string, was ${typeof asType}`\n        );\n\n        if (asType === 'string') {\n          return this.stepNumbers.map((value) => `'${value}'`).join(' | ');\n        }\n\n        if (asType === 'number') {\n          return this.stepNumbers.join(' | ');\n        }\n\n        if (asType.includes('array.string')) {\n          return this.stepNumbers.map((value) => `${value}`);\n        }\n\n        throw new Error(\n          `Transformation type \"${asType}\" is not supported. Available transformations include: ${AS_TYPES.map(\n            (value) => `\"${value}\"`\n          ).join(', ')}`\n        );\n      },\n      isValidStepNumber: (stepNumber): stepNumber is stepNumbers =>\n        this.stepNumbers.includes(stepNumber),\n      isValidStepKey: (value) =>\n        isValidStepKey<resolvedStep>(this.value, value),\n    };\n\n    this.sync();\n  }\n\n  /**\n   * @internal\n   */\n  __getStorage() {\n    return this.storage;\n  }\n\n  getSnapshot() {\n    return this;\n  }\n\n  /**\n   * Syncs the values from storage to {@linkcode value}.\n   */\n  sync() {\n    // TODO add \"syncOptions\" so caller can chose where to sync from ('storage' | 'instance')\n    const storageValues = this.__getStorage().get();\n\n    if (storageValues) {\n      const enrichedValues = this.#internal.enrichValues(storageValues);\n\n      this.value = { ...enrichedValues };\n    }\n  }\n\n  protected notify() {\n    for (const listener of this.listeners) {\n      listener({\n        defaultNameTransformationCasing: this.defaultNameTransformationCasing,\n        original: this.original,\n        steps: this.steps,\n        value: this.value,\n      });\n    }\n  }\n\n  /**\n   * Gets the data for a specific step.\n   * @param options The options for getting the step data.\n   * @returns The step data for the target step.\n   */\n  get<stepNumber extends stepNumbers>(\n    options: GetStepOptions<resolvedStep, stepNumbers, stepNumber>\n  ) {\n    return getStep(this.value)(options);\n  }\n\n  /**\n   * Gets the data for the first step.\n   * @returns The data for the first step.\n   */\n  first() {\n    const firstStep = Math.min(...this.stepNumbers) as FirstStep<resolvedStep>;\n\n    return this.get({ step: firstStep });\n  }\n\n  /**\n   * Gets the data for the last step.\n   * @returns The data for the last step.\n   */\n  last() {\n    const lastStep = Math.max(...this.stepNumbers);\n\n    return this.get<LastStep<resolvedStep>>({ step: lastStep as never });\n  }\n\n  protected handlePostUpdate(next: resolvedStep) {\n    this.value = { ...next };\n\n    this.__getStorage().add(this.value);\n    this.sync();\n    this.notify();\n  }\n\n  update<\n    targetStep extends ValidStepKey<stepNumbers>,\n    field extends UpdateFn.chosenFields<\n      UpdateFn.resolvedStep<resolvedStep, stepNumbers, targetStep>\n    > = 'all',\n    strict extends boolean = true,\n    partial extends boolean = false,\n    additionalCtx extends Record<string, unknown> = {},\n    additionalUpdaterData extends UpdateFn.additionalUpdaterData = never\n  >(\n    options: UpdateFn.options<\n      resolvedStep,\n      stepNumbers,\n      targetStep,\n      field,\n      strict,\n      partial,\n      additionalCtx,\n      additionalUpdaterData\n    >\n  ) {\n    this.#internal.update(options);\n  }\n\n  reset<\n    targetStep extends ValidStepKey<stepNumbers>,\n    fields extends UpdateFn.chosenFields<currentStep>,\n    currentStep extends UpdateFn.resolvedStep<\n      resolvedStep,\n      stepNumbers,\n      targetStep\n    >\n  >(\n    options: ResetFn.Options<\n      resolvedStep,\n      stepNumbers,\n      targetStep,\n      fields,\n      currentStep\n    >\n  ) {\n    this.#internal.reset(options);\n  }\n\n  /**\n   * Create a helper function with validated input.\n   */\n  createHelperFn<\n    const chosenSteps extends HelperFnChosenSteps<resolvedStep, stepNumbers>,\n    validator,\n    additionalCtx extends Record<string, unknown>,\n    response\n  >(\n    options: CreateHelperFunctionOptionsWithValidator<\n      resolvedStep,\n      stepNumbers,\n      chosenSteps,\n      validator,\n      additionalCtx\n    >,\n    fn: HelperFnWithValidator<\n      resolvedStep,\n      stepNumbers,\n      chosenSteps,\n      validator,\n      additionalCtx,\n      response\n    >\n  ): CreatedHelperFnWithInput<validator, response>;\n  /**\n   * Create a helper function without input.\n   */\n  createHelperFn<\n    const chosenSteps extends HelperFnChosenSteps<resolvedStep, stepNumbers>,\n    additionalCtx extends Record<string, unknown>,\n    response\n  >(\n    options: CreateHelperFunctionOptionsWithoutValidator<\n      resolvedStep,\n      stepNumbers,\n      chosenSteps\n    > &\n      CreateHelperFunctionOptionsWithCustomCtxOptions<\n        resolvedStep,\n        stepNumbers,\n        chosenSteps,\n        additionalCtx\n      >,\n    fn: HelperFnWithoutValidator<\n      resolvedStep,\n      stepNumbers,\n      chosenSteps,\n      additionalCtx,\n      response\n    >\n  ): CreatedHelperFnWithoutInput<response>;\n  // Implementation\n  createHelperFn<\n    const chosenSteps extends HelperFnChosenSteps<resolvedStep, stepNumbers>,\n    response,\n    additionalCtx extends Record<string, unknown>,\n    validator = never\n  >(\n    options:\n      | CreateHelperFunctionOptionsWithValidator<\n          resolvedStep,\n          stepNumbers,\n          chosenSteps,\n          validator,\n          additionalCtx\n        >\n      | CreateHelperFunctionOptionsWithoutValidator<\n          resolvedStep,\n          stepNumbers,\n          chosenSteps\n        >,\n    fn:\n      | HelperFnWithValidator<\n          resolvedStep,\n          stepNumbers,\n          chosenSteps,\n          validator,\n          additionalCtx,\n          response\n        >\n      | HelperFnWithoutValidator<\n          resolvedStep,\n          stepNumbers,\n          chosenSteps,\n          additionalCtx,\n          response\n        >\n  ) {\n    const { stepData, ...rest } = options;\n\n    return this.#internal.createStepHelperFn(stepData)(rest, fn);\n  }\n\n  /**\n   * Validates that a given object is the proper shape for step data.\n   * @param value\n   */\n  static hasData<\n    step extends Step<casing>,\n    resolvedStep extends ResolvedStep<step, casing>,\n    stepNumbers extends StepNumbers<resolvedStep>,\n    casing extends CasingType = DefaultCasing\n  >(\n    value: unknown,\n    options?: {\n      optionalKeysToCheck?: FieldChecks<\n        Pick<StepOptions, 'description' | 'validateFields'>\n      >;\n    }\n  ): value is GetCurrentStep<resolvedStep, stepNumbers> {\n    if (value === null || typeof value !== 'object') {\n      return false;\n    }\n\n    return assertObjectFields<\n      | GetCurrentStep<resolvedStep, stepNumbers>\n      | (Omit<StepOptions, 'fields'> & {\n          fields: Expand<\n            ResolvedFields<InferStepOptions<step>, keyof InferStepOptions<step>>\n          >;\n        })\n    >(value, {\n      title: (v) => typeof v === 'string',\n      fields: (\n        v\n      ): v is Expand<\n        ResolvedFields<InferStepOptions<step>, keyof InferStepOptions<step>>\n      > => {\n        if (v === null || typeof v !== 'object') {\n          return false;\n        }\n\n        for (const key of Object.keys(v)) {\n          if (typeof key !== 'string' || !(key in v)) {\n            return false;\n          }\n\n          const current = (v as Record<string, unknown>)[key];\n\n          if (current === null || typeof current !== 'object') {\n            return false;\n          }\n\n          const hasField = assertObjectFields<AnyStepFieldOption>(current, {\n            defaultValue: (v): v is {} => v !== 'undefined' && v !== null,\n            label: (v) =>\n              typeof v === 'string' || (typeof v === 'boolean' && !v),\n            nameTransformCasing: isCasingValid,\n            type: isFieldType,\n          });\n\n          if (!hasField) {\n            return false;\n          }\n        }\n\n        return true;\n      },\n      createHelperFn: (\n        v\n      ): v is GetCurrentStep<resolvedStep, stepNumbers>['createHelperFn'] =>\n        typeof v === 'function',\n      // update: (v): v is GetCurrentStep<resolvedStep, stepNumbers>['update'] =>\n      //   typeof v === 'function',\n      nameTransformCasing: isCasingValid,\n      ...options?.optionalKeysToCheck,\n    });\n  }\n\n  /**\n   * Gets the value of a given field for a given step.\n   * @param step The step to get the value from.\n   * @param field The field to get the value from.\n   * @returns The value of the {@linkcode field}.\n   */\n  getValue<\n    step extends keyof resolvedStep,\n    field extends fieldsUtils.getDeep<resolvedStep, step>\n  >(step: step, field: field) {\n    const stepData = this.value[step];\n    const baseErrorMessage = `Unable to get the value for \"${String(\n      step\n    )}.fields.${String(field)}\"`;\n\n    invariant('fields' in stepData, baseErrorMessage);\n    invariant(\n      typeof stepData.fields === 'object',\n      `${baseErrorMessage} because \"fields\" is not an object. This shouldn't be the case, so please open an issue`\n    );\n\n    const fields = stepData.fields as AnyStepField;\n\n    const defaultValue = fieldsUtils.resolvedDeepPath<\n      resolvedStep,\n      step,\n      fieldsUtils.get<resolvedStep, step>,\n      field\n    >(field, fields as fieldsUtils.get<resolvedStep, step>);\n\n    return defaultValue;\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;AA+HA,MAAM,WAAW;CACf;CACA;CACA;CACA;CACD;AAQD,SAAS,mBACP,KACA,QACU;AACV,KAAI,OAAO,QAAQ,YAAY,QAAQ,KAAM,QAAO;AAEpD,MAAK,MAAM,OAAO,OAAO,KAAK,OAAO,EAAiB;AAEpD,MAAI,EAAE,OAAO,KAAM,QAAO;EAG1B,MAAM,UAAU,OAAO;EACvB,MAAM,QAAS,IAAY;AAC3B,MAAI,CAAC,QAAQ,MAAM,CAAE,QAAO;;AAG9B,QAAO;;AAGT,IAAa,0BAAb,cAUUA,kCAEV;;;;CAIE,AAAS;;;;CAIT;CACA,AAAS;CACT,AAAS;CAET,AAAiB;CACjB,AAAiB;CACjB,AAAiB;CACjB,AAAiB;CACjB,CAASC;CAOT,YACE,QAKA;AACA,SAAO;EAEP,MAAM,EAAE,OAAO,qBAAqB,YAAY;AAEhD,OAAK,kCAAkCC,6BACrC,oBACD;AAED,OAAK,WAAW;AAEhB,OAAK,QAAQC,2BAAyB,KAAK,SAAS;AACpD,OAAK,UAAU,IAAIC,qCAA+C;GAChE,MAAM,KAAK;GACX,KAAM,SAAS,OAAOC;GACtB,OAAO,SAAS;GAChB,oBAAoB,SAAS,sBAAsB;GACpD,CAAC;AACF,QAAKJ,WAAY,IAAIK,oDAKnB;GACA,eAAe,KAAK;GACpB,gBAAgB,KAAK;GACrB,WAAW,SAAS,KAAK,iBAAiB,KAAK;GAChD,CAAC;AAEF,OAAK,QAAQ,MAAKL,SAAU,aAAa,KAAK,MAAM;AACpD,OAAK,cAAc,OAAO,KAAK,KAAK,MAAM,CAAC,KAAK,QAC9C,OAAO,SAAS,IAAI,QAAQ,QAAQ,GAAG,CAAC,CACzC;AAED,OAAK,YAAY,KAAK,OAAO;AAC7B,OAAK,WAAW,KAAK,MAAM;AAC3B,OAAK,QAAQ;GACX,OAAO,KAAK,UAAU;GACtB,MAAM,KAAK,SAAS;GACpB,OAAO,KAAK;GACZ,KAAK,WAAgB;AACnB,gCACE,OAAO,WAAW,UAClB,oEAAoE,OAAO,SAC5E;AAED,QAAI,WAAW,SACb,QAAO,KAAK,YAAY,KAAK,UAAU,IAAI,MAAM,GAAG,CAAC,KAAK,MAAM;AAGlE,QAAI,WAAW,SACb,QAAO,KAAK,YAAY,KAAK,MAAM;AAGrC,QAAI,OAAO,SAAS,eAAe,CACjC,QAAO,KAAK,YAAY,KAAK,UAAU,GAAG,QAAQ;AAGpD,UAAM,IAAI,MACR,wBAAwB,OAAO,yDAAyD,SAAS,KAC9F,UAAU,IAAI,MAAM,GACtB,CAAC,KAAK,KAAK,GACb;;GAEH,oBAAoB,eAClB,KAAK,YAAY,SAAS,WAAW;GACvC,iBAAiB,UACfM,+BAA6B,KAAK,OAAO,MAAM;GAClD;AAED,OAAK,MAAM;;;;;CAMb,eAAe;AACb,SAAO,KAAK;;CAGd,cAAc;AACZ,SAAO;;;;;CAMT,OAAO;EAEL,MAAM,gBAAgB,KAAK,cAAc,CAAC,KAAK;AAE/C,MAAI,cAGF,MAAK,QAAQ,EAAE,GAFQ,MAAKN,SAAU,aAAa,cAAc,EAE/B;;CAItC,AAAU,SAAS;AACjB,OAAK,MAAM,YAAY,KAAK,UAC1B,UAAS;GACP,iCAAiC,KAAK;GACtC,UAAU,KAAK;GACf,OAAO,KAAK;GACZ,OAAO,KAAK;GACb,CAAC;;;;;;;CASN,IACE,SACA;AACA,SAAOO,sBAAQ,KAAK,MAAM,CAAC,QAAQ;;;;;;CAOrC,QAAQ;EACN,MAAM,YAAY,KAAK,IAAI,GAAG,KAAK,YAAY;AAE/C,SAAO,KAAK,IAAI,EAAE,MAAM,WAAW,CAAC;;;;;;CAOtC,OAAO;EACL,MAAM,WAAW,KAAK,IAAI,GAAG,KAAK,YAAY;AAE9C,SAAO,KAAK,IAA4B,EAAE,MAAM,UAAmB,CAAC;;CAGtE,AAAU,iBAAiB,MAAoB;AAC7C,OAAK,QAAQ,EAAE,GAAG,MAAM;AAExB,OAAK,cAAc,CAAC,IAAI,KAAK,MAAM;AACnC,OAAK,MAAM;AACX,OAAK,QAAQ;;CAGf,OAUE,SAUA;AACA,QAAKP,SAAU,OAAO,QAAQ;;CAGhC,MASE,SAOA;AACA,QAAKA,SAAU,MAAM,QAAQ;;CAwD/B,eAME,SAaA,IAgBA;EACA,MAAM,EAAE,UAAU,GAAG,SAAS;AAE9B,SAAO,MAAKA,SAAU,mBAAmB,SAAS,CAAC,MAAM,GAAG;;;;;;CAO9D,OAAO,QAML,OACA,SAKoD;AACpD,MAAI,UAAU,QAAQ,OAAO,UAAU,SACrC,QAAO;AAGT,SAAO,mBAOL,OAAO;GACP,QAAQ,MAAM,OAAO,MAAM;GAC3B,SACE,MAGG;AACH,QAAI,MAAM,QAAQ,OAAO,MAAM,SAC7B,QAAO;AAGT,SAAK,MAAM,OAAO,OAAO,KAAK,EAAE,EAAE;AAChC,SAAI,OAAO,QAAQ,YAAY,EAAE,OAAO,GACtC,QAAO;KAGT,MAAM,UAAW,EAA8B;AAE/C,SAAI,YAAY,QAAQ,OAAO,YAAY,SACzC,QAAO;AAWT,SAAI,CARa,mBAAuC,SAAS;MAC/D,eAAe,QAAeQ,QAAM,eAAeA,QAAM;MACzD,QAAQ,QACN,OAAOA,QAAM,YAAa,OAAOA,QAAM,aAAa,CAACA;MACvD,qBAAqBC;MACrB,MAAMC;MACP,CAAC,CAGA,QAAO;;AAIX,WAAO;;GAET,iBACE,MAEA,OAAO,MAAM;GAGf,qBAAqBD;GACrB,GAAG,SAAS;GACb,CAAC;;;;;;;;CASJ,SAGE,MAAY,OAAc;EAC1B,MAAM,WAAW,KAAK,MAAM;EAC5B,MAAM,mBAAmB,gCAAgC,OACvD,KACD,CAAC,UAAU,OAAO,MAAM,CAAC;AAE1B,8BAAU,YAAY,UAAU,iBAAiB;AACjD,8BACE,OAAO,SAAS,WAAW,UAC3B,GAAG,iBAAiB,yFACrB;EAED,MAAME,WAAS,SAAS;AASxB,SAPqBC,sBAAY,iBAK/B,OAAOD,SAA8C"}

package/dist/steps/schema.d.cts

@@ -0,0 +1,124 @@
+import { DefaultStorageKey, MultiStepFormStorage } from "../storage.cjs";
+import { Constrain, Join } from "../utils/types.cjs";
+import { CasingType, DefaultCasing } from "../utils/casing.cjs";
+import { AnyResolvedStep, CreateHelperFunctionOptionsWithCustomCtxOptions, CreateHelperFunctionOptionsWithValidator, CreateHelperFunctionOptionsWithoutValidator, CreateStepHelperFn, CreatedHelperFnWithInput, CreatedHelperFnWithoutInput, ExtractStepFromKey, FirstStep, GetCurrentStep, GetFieldsForStep, HelperFnChosenSteps, HelperFnWithValidator, HelperFnWithoutValidator, InferStepOptions, LastStep, MultiStepFormSchemaStepConfig, ResetFn, ResolvedStep, Step, StepNumbers, StepOptions, UnionToTuple, UpdateFn, ValidStepKey } from "./types.cjs";
+import { Subscribable } from "../subscribable.cjs";
+import { fields } from "./fields.cjs";
+import { GetStepOptions } from "./utils.cjs";
+
+//#region src/steps/schema.d.ts
+interface MultiStepFormStepSchemaFunctions<TResolvedStep extends AnyResolvedStep, TStepNumbers extends StepNumbers<TResolvedStep>> {
+  update: UpdateFn.general<TResolvedStep, TStepNumbers>;
+  createHelperFn: CreateStepHelperFn<TResolvedStep, TStepNumbers>;
+}
+type AsType = (typeof AS_TYPES)[number];
+type Quote<T extends string[]> = { [K in keyof T]: T[K] extends string ? `'${T[K]}'` : never };
+type AsTypeMap<resolvedStep extends AnyResolvedStep, stepNumbers extends ExtractStepFromKey<Constrain<keyof resolvedStep, string>>> = {
+  string: Exclude<Join<Constrain<Quote<Constrain<UnionToTuple<`${stepNumbers}`>, string[]>>, string[]>, ' | '>, ''>;
+  number: Exclude<Join<Constrain<UnionToTuple<`${stepNumbers}`>, string[]>, ' | '>, ''>;
+  'array.string': UnionToTuple<`${stepNumbers}`>;
+  'array.string.untyped': string[];
+};
+type AsFunctionReturn<resolvedStep extends AnyResolvedStep, stepNumbers extends ExtractStepFromKey<Constrain<keyof resolvedStep, string>>, asType extends AsType> = AsTypeMap<resolvedStep, stepNumbers>[asType];
+type AsFunction<resolvedStep extends AnyResolvedStep, stepNumbers extends ExtractStepFromKey<Constrain<keyof resolvedStep, string>>> = <asType extends AsType>(asType: asType) => AsFunctionReturn<resolvedStep, stepNumbers, asType>;
+type MultiStepFormStepStepsConfig<TStep extends Step<TCasing>, TCasing extends CasingType, TResolvedStep extends ResolvedStep<TStep, TCasing> = ResolvedStep<TStep, TCasing>, TStepNumbers extends StepNumbers<TResolvedStep> = StepNumbers<TResolvedStep>> = {
+  first: FirstStep<TResolvedStep>;
+  last: LastStep<TResolvedStep>;
+  value: ReadonlyArray<TStepNumbers>;
+  as: AsFunction<TResolvedStep, TStepNumbers>;
+  isValidStepNumber: (stepNumber: number) => stepNumber is TStepNumbers;
+  isValidStepKey: (value: string) => value is Constrain<keyof TResolvedStep, string>;
+};
+type MultiStepFormStepSchemaListener<TStep extends Step<TCasing>, TCasing extends CasingType> = (data: {
+  original: InferStepOptions<TStep>;
+  value: ResolvedStep<TStep, TCasing>;
+  steps: MultiStepFormStepStepsConfig<TStep, TCasing>;
+  defaultNameTransformationCasing: TCasing;
+}) => void;
+/**
+ * Available transformation types for the step numbers.
+ */
+declare const AS_TYPES: readonly ["string", "number", "array.string", "array.string.untyped"];
+type ValueCheck<T> = (v: unknown) => v is T;
+type FieldChecks<T extends object> = { [K in keyof T]: ValueCheck<T[K]> };
+declare class MultiStepFormStepSchema<step extends Step<casing>, casing extends CasingType = DefaultCasing, resolvedStep extends ResolvedStep<step, casing> = ResolvedStep<step, casing>, stepNumbers extends StepNumbers<resolvedStep> = StepNumbers<resolvedStep>, storageKey extends string = DefaultStorageKey> extends Subscribable<MultiStepFormStepSchemaListener<step, casing>> implements MultiStepFormStepSchemaFunctions<resolvedStep, stepNumbers> {
+  #private;
+  /**
+   * The original config before any validation or transformations have been applied.
+   */
+  readonly original: InferStepOptions<step>;
+  /**
+   * The resolved step values.
+   */
+  value: resolvedStep;
+  readonly steps: MultiStepFormStepStepsConfig<step, casing>;
+  readonly defaultNameTransformationCasing: casing;
+  private readonly firstStep;
+  private readonly lastStep;
+  private readonly stepNumbers;
+  private readonly storage;
+  constructor(config: MultiStepFormSchemaStepConfig<step, Constrain<casing, CasingType>, storageKey>);
+  /**
+   * @internal
+   */
+  __getStorage(): MultiStepFormStorage<resolvedStep, storageKey>;
+  getSnapshot(): this;
+  /**
+   * Syncs the values from storage to {@linkcode value}.
+   */
+  sync(): void;
+  protected notify(): void;
+  /**
+   * Gets the data for a specific step.
+   * @param options The options for getting the step data.
+   * @returns The step data for the target step.
+   */
+  get<stepNumber extends stepNumbers>(options: GetStepOptions<resolvedStep, stepNumbers, stepNumber>): {
+    step: stepNumber;
+    data: GetCurrentStep<resolvedStep, stepNumber>;
+  };
+  /**
+   * Gets the data for the first step.
+   * @returns The data for the first step.
+   */
+  first(): {
+    step: FirstStep<resolvedStep>;
+    data: GetCurrentStep<resolvedStep, FirstStep<resolvedStep>>;
+  };
+  /**
+   * Gets the data for the last step.
+   * @returns The data for the last step.
+   */
+  last(): {
+    step: LastStep<resolvedStep>;
+    data: GetCurrentStep<resolvedStep, LastStep<resolvedStep>>;
+  };
+  protected handlePostUpdate(next: resolvedStep): void;
+  update<targetStep extends ValidStepKey<stepNumbers>, field extends UpdateFn.chosenFields<UpdateFn.resolvedStep<resolvedStep, stepNumbers, targetStep>> = 'all', strict extends boolean = true, partial extends boolean = false, additionalCtx extends Record<string, unknown> = {}, additionalUpdaterData extends UpdateFn.additionalUpdaterData = never>(options: UpdateFn.options<resolvedStep, stepNumbers, targetStep, field, strict, partial, additionalCtx, additionalUpdaterData>): void;
+  reset<targetStep extends ValidStepKey<stepNumbers>, fields$1 extends UpdateFn.chosenFields<currentStep>, currentStep extends UpdateFn.resolvedStep<resolvedStep, stepNumbers, targetStep>>(options: ResetFn.Options<resolvedStep, stepNumbers, targetStep, fields$1, currentStep>): void;
+  /**
+   * Create a helper function with validated input.
+   */
+  createHelperFn<const chosenSteps extends HelperFnChosenSteps<resolvedStep, stepNumbers>, validator, additionalCtx extends Record<string, unknown>, response>(options: CreateHelperFunctionOptionsWithValidator<resolvedStep, stepNumbers, chosenSteps, validator, additionalCtx>, fn: HelperFnWithValidator<resolvedStep, stepNumbers, chosenSteps, validator, additionalCtx, response>): CreatedHelperFnWithInput<validator, response>;
+  /**
+   * Create a helper function without input.
+   */
+  createHelperFn<const chosenSteps extends HelperFnChosenSteps<resolvedStep, stepNumbers>, additionalCtx extends Record<string, unknown>, response>(options: CreateHelperFunctionOptionsWithoutValidator<resolvedStep, stepNumbers, chosenSteps> & CreateHelperFunctionOptionsWithCustomCtxOptions<resolvedStep, stepNumbers, chosenSteps, additionalCtx>, fn: HelperFnWithoutValidator<resolvedStep, stepNumbers, chosenSteps, additionalCtx, response>): CreatedHelperFnWithoutInput<response>;
+  /**
+   * Validates that a given object is the proper shape for step data.
+   * @param value
+   */
+  static hasData<step extends Step<casing>, resolvedStep extends ResolvedStep<step, casing>, stepNumbers extends StepNumbers<resolvedStep>, casing extends CasingType = DefaultCasing>(value: unknown, options?: {
+    optionalKeysToCheck?: FieldChecks<Pick<StepOptions, 'description' | 'validateFields'>>;
+  }): value is GetCurrentStep<resolvedStep, stepNumbers>;
+  /**
+   * Gets the value of a given field for a given step.
+   * @param step The step to get the value from.
+   * @param field The field to get the value from.
+   * @returns The value of the {@linkcode field}.
+   */
+  getValue<step extends keyof resolvedStep, field extends fields.getDeep<resolvedStep, step>>(step: step, field: field): fields.resolveDeepPath<resolvedStep, step, field, fields.parentOf<field>, GetFieldsForStep<resolvedStep, step>[fields.parentOf<field>]["defaultValue"]>;
+}
+//#endregion
+export { AsFunction, AsFunctionReturn, AsType, AsTypeMap, MultiStepFormStepSchema, MultiStepFormStepSchemaFunctions, MultiStepFormStepSchemaListener, MultiStepFormStepStepsConfig };
+//# sourceMappingURL=schema.d.cts.map

package/dist/steps/schema.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.cts","names":[],"sources":["../../src/steps/schema.ts"],"sourcesContent":[],"mappings":";;;;;;;;;UAoDiB,uDACO,sCACD,YAAY;UAEzB,QAAA,CAAS,QAAQ,eAAe;kBACxB,mBAAmB,eAAe;AALpD;AACwB,KAMZ,MAAA,GANY,CAAA,OAMK,QANL,CAAA,CAAA,MAAA,CAAA;KAOnB,KAN8B,CAAA,UAAA,MAAA,EAAA,CAAA,GAAA,QAAZ,MAOT,CAPS,GAOL,CAPK,CAOH,CAPG,CAAA,SAAA,MAAA,GAAA,IAOqB,CAPrB,CAOuB,CAPvB,CAAA,GAAA,GAAA,KAAA,EAEI;AAAe,KAO9B,SAP8B,CAAA,qBAQnB,eARmB,EAAA,oBASpB,kBAToB,CASD,SATC,CAAA,MASe,YATf,EAAA,MAAA,CAAA,CAAA,CAAA,GAAA;EAAhC,MAAS,EAYT,OAZS,CAaf,IAbe,CAcb,SAda,CAeX,KAfW,CAeL,SAfK,CAeK,YAfL,CAAA,GAeqB,WAfrB,EAAA,CAAA,EAAA,MAAA,EAAA,CAAA,CAAA,EAAA,MAAA,EAAA,CAAA,EAAA,KAAA,CAAA,EAAA,EAAA,CAAA;EACkB,MAAA,EAqB3B,OArB2B,CAsBjC,IAtBiC,CAsB5B,SAtB4B,CAsBlB,YAtBkB,CAAA,GAsBF,WAtBE,EAAA,CAAA,EAAA,MAAA,EAAA,CAAA,EAAA,KAAA,CAAA,EAAA,EAAA,CAAA;EAAe,cAAA,EAyBlC,YAzBkC,CAAA,GAyBlB,WAzBkB,EAAA,CAAA;EAAlC,sBAAA,EAAA,MAAA,EAAA;CAAkB;AAExB,KA0BA,gBA1BiB,CAAA,qBA2BN,eA3Bc,EAAA,oBA4Bf,kBA5Be,CA4BI,SA5BJ,CAAA,MA4BoB,YA5BpB,EAAA,MAAA,CAAA,CAAA,EAAA,eA6BpB,MA7BoB,CAAA,GA8BjC,SA9BiC,CA8BvB,YA9BuB,EA8BT,WA9BS,CAAA,CA8BI,MA9BJ,CAAA;AAChC,KA8BO,UA9BF,CAAA,qBA+Ba,eA/Bb,EAAA,oBAgCY,kBAhCZ,CAgC+B,SAhC/B,CAAA,MAgC+C,YAhC/C,EAAA,MAAA,CAAA,CAAA,CAAA,GAAA,CAAA,eAiCU,MAjCV,CAAA,CAAA,MAAA,EAkCA,MAlCA,EAAA,GAmCL,gBAnCK,CAmCY,YAnCZ,EAmC0B,WAnC1B,EAmCuC,MAnCvC,CAAA;AACI,KAmCF,4BAnCE,CAAA,cAoCE,IApCF,CAoCO,OApCP,CAAA,EAAA,gBAqCI,UArCJ,EAAA,sBAsCU,YAtCV,CAsCuB,KAtCvB,EAsC8B,OAtC9B,CAAA,GAsCyC,YAtCzC,CAuCV,KAvCU,EAwCV,OAxCU,CAAA,EAAA,qBA0CS,WA1CT,CA0CqB,aA1CrB,CAAA,GA0CsC,WA1CtC,CA0CkD,aA1ClD,CAAA,CAAA,GAAA;EAAI,KAAA,EA4CT,SA5CS,CA4CC,aA5CD,CAAA;EAAE,IAAA,EA6CZ,QA7CY,CA6CH,aA7CG,CAAA;EAAwB,KAAA,EA8CnC,aA9CmC,CA8CrB,YA9CqB,CAAA;EAAE,EAAA,EA+CxC,UA/CwC,CA+C7B,aA/C6B,EA+Cd,YA/Cc,CAAA;EAAC,iBAAA,EAAA,CAAA,UAAA,EAAA,MAAA,EAAA,GAAA,UAAA,IAgDY,YAhDZ;EAEnC,cAAS,EAAA,CAAA,KAAA,EAAA,MAAA,EAAA,GAAA,KAAA,IAiDL,SAjDK,CAAA,MAiDW,aAjDX,EAAA,MAAA,CAAA;CACE;AACkC,KAiD7C,+BAjD6C,CAAA,cAkDzC,IAlDyC,CAkDpC,OAlDoC,CAAA,EAAA,gBAmDvC,UAnDuC,CAAA,GAAA,CAAA,IAAA,EAAA;EAAhB,QAAA,EAqD7B,gBArD6B,CAqDZ,KArDY,CAAA;EAAnB,KAAA,EAsDb,YAtDa,CAsDA,KAtDA,EAsDO,OAtDP,CAAA;EAMkB,KAAA,EAiD/B,4BAjD+B,CAiDF,KAjDE,EAiDK,OAjDL,CAAA;EAAhB,+BAAA,EAkDW,OAlDX;CAAV,EAAA,GAAA,IAAA;;;;cAwDR,QA3DI,EAAA,SAAA,CAAA,QAAA,EAAA,QAAA,EAAA,cAAA,EAAA,sBAAA,CAAA;KAkEL,UAvD8B,CAAA,CAAA,CAAA,GAAA,CAAA,CAAA,EAAA,OAAA,EAAA,GAAA,CAAA,IAuDO,CAvDP;KAyD9B,WAzDc,CAAA,UAAA,MAAA,CAAA,GAAA,QAAV,MA0DK,CA1DL,GA0DS,UA1DT,CA0DoB,CA1DpB,CA0DsB,CA1DtB,CAAA,CAAA,EAAL;AADM,cAiFG,uBAjFH,CAAA,aAkFO,IAlFP,CAkFY,MAlFZ,CAAA,EAAA,eAmFS,UAnFT,GAmFsB,aAnFtB,EAAA,qBAoFe,YApFf,CAoF4B,IApF5B,EAoFkC,MApFlC,CAAA,GAoF4C,YApF5C,CAqFJ,IArFI,EAsFJ,MAtFI,CAAA,EAAA,oBAwFc,WAxFd,CAwF0B,YAxF1B,CAAA,GAwF0C,WAxF1C,CAwFsD,YAxFtD,CAAA,EAAA,mBAAA,MAAA,GAyFsB,iBAzFtB,CAAA,SA2FA,YA3FA,CA2Fa,+BA3Fb,CA2F6C,IA3F7C,EA2FmD,MA3FnD,CAAA,CAAA,YA4FG,gCA5FH,CA4FoC,YA5FpC,EA4FkD,WA5FlD,CAAA,CAAA;EAIwB,CAAA,OAAA;EAAhB;;AAGlB;EACuB,SAAA,QAAA,EAyFF,gBAzFE,CAyFe,IAzFf,CAAA;EACkC;;;EACxC,KAAA,EA2FR,YA3FQ;EACH,SAAA,KAAA,EA2FI,4BA3FJ,CA2FiC,IA3FjC,EA2FuC,MA3FvC,CAAA;EAAc,SAAA,+BAAA,EA4FgB,MA5FhB;EAAxB,iBAAA,SAAA;EAAqC,iBAAA,QAAA;EAAM,iBAAA,WAAA;EACnC,iBAAU,OAAA;EACC,WAAA,CAAA,MAAA,EAwGX,6BAxGW,CAyGjB,IAzGiB,EA0GjB,SA1GiB,CA0GP,MA1GO,EA0GC,UA1GD,CAAA,EA2GjB,UA3GiB,CAAA;EACkC;;;EACrC,YAAA,CAAA,CAAA,EAuLN,oBAvLM,CAuLN,YAvLM,EAuLN,UAvLM,CAAA;EACV,WAAA,CAAA,CAAA,EAAA,IAAA;EACY;;;EAAjB,IAAA,CAAA,CAAA,EAAA,IAAA;EAAgB,UAAA,MAAA,CAAA,CAAA,EAAA,IAAA;EACT;;;;;EAGgC,GAAA,CAAA,mBAuNnB,WAvNmB,CAAA,CAAA,OAAA,EAwN/B,cAxN+B,CAwNhB,YAxNgB,EAwNF,WAxNE,EAwNW,UAxNX,CAAA,CAAA,EAAA;IAApB,IAAA,YAAA;IACpB,IAAA,gBAAA,aAAA,YAAA,CAAA;EACA,CAAA;EAFmD;;;;EAIH,KAAA,CAAA,CAAA,EAAA;IAEjC,IAAA,WAAA,aAAA,CAAA;IAAV,IAAA,gBAAA,aAAA,WAAA,aAAA,CAAA,CAAA;EACQ,CAAA;EAAT;;;;EAEwB,IAAA,CAAA,CAAA,EAAA;IAA1B,IAAA,UAAA,aAAA,CAAA;IACqD,IAAA,gBAAA,aAAA,UAAA,aAAA,CAAA,CAAA;EAG3B,CAAA;EAAhB,UAAA,gBAAA,CAAA,IAAA,EAoOmB,YApOnB,CAAA,EAAA,IAAA;EAAS,MAAA,CAAA,mBA6OF,YA7OE,CA6OW,WA7OX,CAAA,EAAA,cA8OP,QAAA,CAAS,YA9OF,CA+OnB,QAAA,CAAS,YA/OU,CA+OG,YA/OH,EA+OiB,WA/OjB,EA+O8B,UA/O9B,CAAA,CAAA,GAAA,KAAA,EAAA,eAAA,OAAA,GAAA,IAAA,EAAA,gBAAA,OAAA,GAAA,KAAA,EAAA,sBAmPC,MAnPD,CAAA,MAAA,EAAA,OAAA,CAAA,GAAA,CAAA,CAAA,EAAA,8BAoPS,QAAA,CAAS,qBApPlB,GAAA,KAAA,CAAA,CAAA,OAAA,EAsPZ,QAAA,CAAS,OAtPG,CAuPnB,YAvPmB,EAwPnB,WAxPmB,EAyPnB,UAzPmB,EA0PnB,KA1PmB,EA2PnB,MA3PmB,EA4PnB,OA5PmB,EA6PnB,aA7PmB,EA8PnB,qBA9PmB,CAAA,CAAA,EAAA,IAAA;EAEb,KAAA,CAAA,mBAmQW,YAnQoB,CAmQP,WAnQO,CAAA,EAAA,iBAoQxB,QAAA,CAAS,YApQe,CAoQF,WApQE,CAAA,EAAA,oBAqQnB,QAAA,CAAS,YArQU,CAsQrC,YAtQqC,EAuQrC,WAvQqC,EAwQrC,UAxQqC,CAAA,CAAA,CAAA,OAAA,EA2Q9B,OAAA,CAAQ,OA3QsB,CA4QrC,YA5QqC,EA6QrC,WA7QqC,EA8QrC,UA9QqC,EA+QrC,QA/QqC,EAgRrC,WAhRqC,CAAA,CAAA,EAAA,IAAA;EACtB;;;EAGQ,cAAA,CAAA,0BAsRC,mBAtRD,CAsRqB,YAtRrB,EAsRmC,WAtRnC,CAAA,EAAA,SAAA,EAAA,sBAwRH,MAxRG,CAAA,MAAA,EAAA,OAAA,CAAA,EAAA,QAAA,CAAA,CAAA,OAAA,EA2RhB,wCA3RgB,CA4RvB,YA5RuB,EA6RvB,WA7RuB,EA8RvB,WA9RuB,EA+RvB,SA/RuB,EAgSvB,aAhSuB,CAAA,EAAA,EAAA,EAkSrB,qBAlSqB,CAmSvB,YAnSuB,EAoSvB,WApSuB,EAqSvB,WArSuB,EAsSvB,SAtSuB,EAuSvB,aAvSuB,EAwSvB,QAxSuB,CAAA,CAAA,EA0SxB,wBA1SwB,CA0SC,SA1SD,EA0SY,QA1SZ,CAAA;EAAjB;;;EACH,cAAA,CAAA,0BA8SqB,mBA9SrB,CA8SyC,YA9SzC,EA8SuD,WA9SvD,CAAA,EAAA,sBA+SiB,MA/SjB,CAAA,MAAA,EAAA,OAAA,CAAA,EAAA,QAAA,CAAA,CAAA,OAAA,EAkTI,2CAlTJ,CAmTH,YAnTG,EAoTH,WApTG,EAqTH,WArTG,CAAA,GAuTH,+CAvTG,CAwTD,YAxTC,EAyTD,WAzTC,EA0TD,WA1TC,EA2TD,aA3TC,CAAA,EAAA,EAAA,EA6TD,wBA7TC,CA8TH,YA9TG,EA+TH,WA/TG,EAgUH,WAhUG,EAiUH,aAjUG,EAkUH,QAlUG,CAAA,CAAA,EAoUJ,2BApUI,CAoUwB,QApUxB,CAAA;EAC6B;;;;EACI,OAAA,OAAA,CAAA,aAkXzB,IAlXyB,CAkXpB,MAlXoB,CAAA,EAAA,qBAmXjB,YAnXiB,CAmXJ,IAnXI,EAmXE,MAnXF,CAAA,EAAA,oBAoXlB,WApXkB,CAoXN,YApXM,CAAA,EAAA,eAqXvB,UArXuB,GAqXV,aArXU,CAAA,CAAA,KAAA,EAAA,OAAA,EAAA,OAarC,CAbqC,EAAA;IAMpC,mBAKI,CAAA,EA8WkB,WA9WlB,CA+WF,IA/WE,CA+WG,WA/WH,EAAA,aAAA,GAAA,gBAAA,CAAA,CAAA;EAEL,CAAA,CAAA,EAAA,KAAA,IAgXS,cAhX4B,CAgXb,YAhXc,EAgXA,WAhXA,CAAA;EAEtC;;;;;;EAuBQ,QAAA,CAAA,aAAA,MA0ZU,YA1Za,EAAA,cA2ZlB,MAAA,CAAY,OA3ZM,CA2ZE,YA3ZF,EA2ZgB,IA3ZhB,CAAA,CAAA,CAAA,IAAA,EA4Z1B,IA5Z0B,EAAA,KAAA,EA4Zb,KA5Za,CAAA,EA4ZR,MAAA,CAAA,eA5ZQ,CA4ZR,YA5ZQ,EA4ZR,IA5ZQ,EA4ZR,KA5ZQ,EA4ZR,MAAA,CAAA,QA5ZQ,CA4ZR,KA5ZQ,CAAA,EA4ZR,gBA5ZQ,CA4ZR,YA5ZQ,EA4ZR,IA5ZQ,CAAA,CA4ZR,MAAA,CAAA,QA5ZQ,CA4ZR,KA5ZQ,CAAA,CAAA,CAAA,cAAA,CAAA,CAAA"}