@jfdevelops/multi-step-form-core 1.0.0-alpha.23 → 1.0.0-alpha.25

package/dist/steps/fn-utils/update-fn.d.cts

@@ -0,0 +1,121 @@
+import { DeepKeys, DeepPartial, Expand, Relaxed, Updater, objectHelpers, stripFunctions } from "../../utils/types.cjs";
+import { path } from "../../utils/path.cjs";
+import { steps } from "../steps.cjs";
+import { HelperFn, HelperFnChosenSteps } from "./helper-fn/index.cjs";
+
+//#region src/steps/fn-utils/update-fn.d.ts
+declare namespace UpdateFn {
+  export type chosenFields<TCurrentStep extends steps.Any> = HelperFnChosenSteps.defaultStringOption | HelperFnChosenSteps.tupleNotation<DeepKeys<TCurrentStep>> | path.generateObjectConfig<TCurrentStep>;
+  type resolveAllPropertyPath<TCurrentStep extends steps.Any, TField extends chosenFields<TCurrentStep>> = TField extends HelperFnChosenSteps.defaultStringOption ? Relaxed<TCurrentStep> : never;
+  type resolveTuplePropertyPath<TCurrentStep extends steps.Any, TField extends chosenFields<TCurrentStep>, TDeepKeys extends DeepKeys<TCurrentStep> = DeepKeys<TCurrentStep>> = TField extends HelperFnChosenSteps.tupleNotation<TDeepKeys> ? TField[number] extends DeepKeys<Relaxed<TCurrentStep>> ? path.pickBy<Relaxed<TCurrentStep>, TField[number]> : never : never;
+  type resolveObjectPropertyPath<TCurrentStep extends steps.Any, TField extends chosenFields<TCurrentStep>, TDeepKeys extends DeepKeys<TCurrentStep> = DeepKeys<TCurrentStep>> = TField extends path.generateObjectConfig<TField> ? path.objectToPath<TField> extends TDeepKeys ? path.objectToPath<TField> extends DeepKeys<Relaxed<TCurrentStep>> ? path.pickBy<Relaxed<TCurrentStep>, path.objectToPath<TField>> : never : never : never;
+  type resolvePathType<TCurrentStep extends steps.Any, TField extends chosenFields<TCurrentStep>> = TField extends HelperFnChosenSteps.defaultStringOption ? 'all' : TField extends Array<infer _> ? 'tuple' : objectHelpers.isObject<TField> extends true ? 'object' : never;
+  type resolvePathMap<TCurrentStep extends steps.Any, TField extends chosenFields<TCurrentStep>> = {
+    all: resolveAllPropertyPath<TCurrentStep, TField>;
+    tuple: resolveTuplePropertyPath<TCurrentStep, TField>;
+    object: resolveObjectPropertyPath<TCurrentStep, TField>;
+  };
+  export type resolvedStep<value extends steps.instantiateSteps, targetStep extends steps.StepNumbers<value>> = stripFunctions<value[targetStep]>;
+  export type resolvedFieldValue<value extends steps.instantiateSteps, targetStep extends steps.StepNumbers<value>, field extends chosenFields<currentStep>, currentStep extends resolvedStep<value, targetStep> = resolvedStep<value, targetStep>, pathType extends resolvePathType<currentStep, field> = resolvePathType<currentStep, field>> = resolvePathMap<currentStep, field>[pathType];
+  export type mode = {
+    /**
+     * Enables strict mode for the update operation.
+     *
+     * When enabled, you won't be able to add new keys to an object. If
+     * you need to add new keys, set to `false`.
+     * @default true
+     */
+    strict: boolean;
+    /**
+     * Enables partial mode for the update operation.
+     *
+     * When enabled, you will be required to return the whole object. If
+     * you need to return a partial object, set to `false`.
+     * @default false
+     */
+    partial: boolean;
+  };
+  export type additionalUpdaterData = Record<string, unknown> | (() => Record<string, unknown>);
+  export type inferAdditionalUpdaterData<T extends additionalUpdaterData> = T extends (() => infer _) ? _ : T;
+  export type resolvedUpdaterReturnType<T, TMode extends mode, TAdditionalCtx extends additionalUpdaterData> = TMode['strict'] extends true ? TMode['partial'] extends true ? DeepPartial<T> : T : TMode['partial'] extends true ? DeepPartial<T> & TAdditionalCtx : T & TAdditionalCtx;
+  export interface DebugOptions {
+    /**
+     * Enables verbose debug logging for this update operation.
+     * Set to `true` to output helpful information for troubleshooting.
+     */
+    debug?: boolean;
+    /**
+     * Controls whether console errors should be silenced.
+     *
+     * By default, errors will be silenced when `partial: true` OR `strict: false`.
+     *
+     */
+    silentErrors?: boolean;
+  }
+  export interface BaseOptions<value extends steps.instantiateSteps, targetStep extends steps.StepNumbers<value>, fields extends chosenFields<currentStep>, currentStep extends resolvedStep<value, targetStep> = resolvedStep<value, targetStep>> extends DebugOptions {
+    /**
+     * The step to update.
+     */
+    targetStep: targetStep;
+    /**
+     * The specific fields to update.
+     *
+     * Optionally provide a value to narrow the results of the `ctx` in the
+     * updater `fn`.
+     */
+    fields?: fields;
+  }
+  export interface ModeOptions<TMode extends mode> {
+    /**
+     * Enables verbose debug logging for this update operation.
+     * Set to `true` to output helpful information for troubleshooting.
+     */
+    debug?: boolean;
+    /**
+     * Controls whether console errors should be silenced.
+     *
+     * By default, errors will be silenced when `partial: true` OR `strict: false`.
+     *
+     */
+    silentErrors?: boolean;
+    /**
+     * Enables strict mode for the update operation.
+     *
+     * When enabled, you won't be able to add new keys to an object. If
+     * you need to add new keys, set to `false`.
+     * @default true
+     */
+    strict?: TMode['strict'];
+    /**
+     * Enables partial mode for the update operation.
+     *
+     * When enabled, you will be required to return the whole object. If
+     * you need to return a partial object, set to `false`.
+     * @default false
+     */
+    partial?: TMode['partial'];
+  }
+  export interface SharedOptions<value extends steps.instantiateSteps, targetStep extends steps.StepNumbers<value>, fields extends chosenFields<currentStep>, updateMode extends mode, currentStep extends resolvedStep<value, targetStep> = resolvedStep<value, targetStep>> extends BaseOptions<value, targetStep, fields, currentStep>, ModeOptions<updateMode> {}
+  export type options<value extends steps.instantiateSteps, targetStep extends steps.StepNumbers<value>, field extends chosenFields<TCurrentStep>, strict extends boolean, partial extends boolean, additionalCtx extends Record<string, unknown>, updaterData extends additionalUpdaterData, TCurrentStep extends resolvedStep<value, targetStep> = resolvedStep<value, targetStep>, TMode extends mode = {
+    strict: strict;
+    partial: partial;
+  }> = SharedOptions<value, targetStep, field, TMode, TCurrentStep> & HelperFn.CtxDataSelector<value, [targetStep], additionalCtx> & {
+    updater: Updater<Expand<HelperFn.BaseInput<value, [targetStep], never, additionalCtx>>, resolvedUpdaterReturnType<resolvedFieldValue<value, targetStep, field, TCurrentStep>, TMode, updaterData>>;
+  };
+  export type general<value extends steps.instantiateSteps> = <targetStep extends steps.StepNumbers<value>, field extends chosenFields<resolvedStep<value, targetStep>> = 'all', strict extends boolean = true, partial extends boolean = false, additionalCtx extends Record<string, unknown> = {}, additionalUpdaterData extends Record<string, unknown> = {}>(options: options<value, targetStep, field, strict, partial, additionalCtx, additionalUpdaterData>) => void;
+  export type stepSpecific<value extends steps.instantiateSteps, targetStep extends stepNumbers, stepNumbers extends steps.StepNumbers<value> = steps.StepNumbers<value>> = <field extends chosenFields<resolvedStep<value, targetStep>> = 'all', strict extends boolean = true, partial extends boolean = false, additionalCtx extends Record<string, unknown> = {}, additionalUpdaterData extends Record<string, unknown> = {}>(options: Omit<options<value, targetStep, field, strict, partial, additionalCtx, additionalUpdaterData>, 'targetStep'>) => void;
+  export type StepSpecificHelperFn<value extends steps.instantiateSteps, chosenSteps extends HelperFnChosenSteps.main<value, steps.StepNumbers<value>>> = { [key in HelperFnChosenSteps.resolve<value, chosenSteps>]: stepSpecific<value, key> };
+  export type createHelperFnForAllSteps<value extends steps.instantiateSteps, chosenSteps extends HelperFnChosenSteps.main<value, steps.StepNumbers<value>>> = chosenSteps extends HelperFnChosenSteps.defaultStringOption ? StepSpecificHelperFn<value, chosenSteps> : never;
+  export type createHelperFnForTupleSteps<value extends steps.instantiateSteps, chosenSteps extends HelperFnChosenSteps.main<value, steps.StepNumbers<value>>> = chosenSteps extends HelperFnChosenSteps.tupleNotation<steps.StepNumbers<value>> ? StepSpecificHelperFn<value, chosenSteps> : never;
+  export type createHelperFnForObjectSteps<value extends steps.instantiateSteps, chosenSteps extends HelperFnChosenSteps.main<value, steps.StepNumbers<value>>> = chosenSteps extends HelperFnChosenSteps.objectNotation<steps.StepNumbers<value>> ? { [key in keyof chosenSteps]: key extends HelperFnChosenSteps.resolve<value, chosenSteps> ? StepSpecificHelperFn<value, chosenSteps>[key] : never } : never;
+  type HelperFnMap<value extends steps.instantiateSteps, chosenSteps extends HelperFnChosenSteps.main<value, steps.StepNumbers<value>>> = {
+    all: createHelperFnForAllSteps<value, chosenSteps>;
+    tuple: createHelperFnForTupleSteps<value, chosenSteps>;
+    object: createHelperFnForObjectSteps<value, chosenSteps>;
+  };
+  export type HelperFn<value extends steps.instantiateSteps, chosenSteps extends HelperFnChosenSteps.main<value, steps.StepNumbers<value>>> = general<value> & HelperFnMap<value, chosenSteps>[HelperFnChosenSteps.resolveType<value, chosenSteps>];
+  export {};
+}
+//#endregion
+export { UpdateFn };
+//# sourceMappingURL=update-fn.d.cts.map

package/dist/steps/fn-utils/update-fn.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-fn.d.cts","names":[],"sources":["../../../src/steps/fn-utils/update-fn.ts"],"sourcesContent":[],"mappings":";;;;;;kBAaiB,QAAA;gDAC+B,KAAA,CAAM,OAChD,mBAAA,CAAoB,sBACpB,mBAAA,CAAoB,cAAc,SAAS,iBAC3C,IAAA,CAAK,qBAAqB;EAJf,KAAA,sBAAQ,CAAA,qBAOA,KAAA,CAAM,GAPN,EAAA,eAQN,YARM,CAQO,YARP,CAAA,CAAA,GASnB,MATmB,SASJ,mBAAA,CAAoB,mBAThB,GAUnB,OAVmB,CAUX,YAVW,CAAA,GAAA,KAAA;EACuB,KAAM,wBAAA,CAAA,qBAY7B,KAAA,CAAM,GAZuB,EAAA,eAanC,YAbmC,CAatB,YAbsB,CAAA,EAAA,kBAchC,QAdgC,CAcvB,YAduB,CAAA,GAcP,QAdO,CAcE,YAdF,CAAA,CAAA,GAehD,MAfgD,SAejC,mBAAA,CAAoB,aAfa,CAeC,SAfD,CAAA,GAgBhD,MAhBgD,CAAA,MAAA,CAAA,SAgBzB,QAhByB,CAgBhB,OAhBgB,CAgBR,YAhBQ,CAAA,CAAA,GAiB9C,IAAA,CAAK,MAjByC,CAiBlC,OAjBkC,CAiB1B,YAjB0B,CAAA,EAiBX,MAjBW,CAAA,MAAA,CAAA,CAAA,GAAA,KAAA,GAAA,KAAA;EAChD,KAAA,yBAAoB,CAAA,qBAoBD,KAAA,CAAM,GApBL,EAAA,eAqBP,YArBO,CAqBM,YArBN,CAAA,EAAA,kBAsBJ,QAtBI,CAsBK,YAtBL,CAAA,GAsBqB,QAtBrB,CAsB8B,YAtB9B,CAAA,CAAA,GAuBpB,MAvBoB,SAuBL,IAAA,CAAK,oBAvBA,CAuBqB,MAvBrB,CAAA,GAwBpB,IAAA,CAAK,YAxBe,CAwBF,MAxBE,CAAA,SAwBc,SAxBd,GAyBlB,IAAA,CAAK,YAzBa,CAyBA,MAzBA,CAAA,SAyBgB,QAzBhB,CAyByB,OAzBzB,CAyBiC,YAzBjC,CAAA,CAAA,GA0BhB,IAAA,CAAK,MA1BW,CA0BJ,OA1BI,CA0BI,YA1BJ,CAAA,EA0BmB,IAAA,CAAK,YA1BxB,CA0BqC,MA1BrC,CAAA,CAAA,GAAA,KAAA,GAAA,KAAA,GAAA,KAAA;EACuB,KAAA,eAAA,CAAA,qBA8BxB,KAAA,CAAM,GA9BkB,EAAA,eA+B9B,YA/B8B,CA+BjB,YA/BiB,CAAA,CAAA,GAgC3C,MAhC2C,SAgC5B,mBAAA,CAAoB,mBAhCQ,GAAA,KAAA,GAkC3C,MAlC2C,SAkC5B,KAlC4B,CAAA,KAAA,EAAA,CAAA,GAAA,OAAA,GAoC3C,aAAA,CAAc,QApC6B,CAoCpB,MApCoB,CAAA,SAAA,IAAA,GAAA,QAAA,GAAA,KAAA;EAAT,KAAA,cAAA,CAAA,qBAwCf,KAAA,CAAM,GAxCS,EAAA,eAyCrB,YAzCqB,CAyCR,YAzCQ,CAAA,CAAA,GAAA;IAAlC,GAAA,EA2CG,sBA3CiB,CA2CM,YA3CN,EA2CoB,MA3CpB,CAAA;IACM,KAAA,EA2CrB,wBA3CqB,CA2CI,YA3CJ,EA2CkB,MA3ClB,CAAA;IAArB,MAAA,EA4CC,yBA5CD,CA4C2B,YA5C3B,EA4CyC,MA5CzC,CAAA;EAGc,CAAA;EACO,OAAA,KAAA,YAAA,CAAA,cA2Cd,KAAA,CAAM,gBA3CQ,EAAA,mBA4CT,KAAA,CAAM,WA5CG,CA4CS,KA5CT,CAAA,CAAA,GA6C1B,cA7C0B,CA6CX,KA7CW,CA6CL,UA7CK,CAAA,CAAA;EAAb,OAAA,KAAA,kBAAA,CAAA,cA+CD,KAAA,CAAM,gBA/CL,EAAA,mBAgDI,KAAA,CAAM,WAhDV,CAgDsB,KAhDtB,CAAA,EAAA,cAiDD,YAjDC,CAiDY,WAjDZ,CAAA,EAAA,oBAkDK,YAlDL,CAkDkB,KAlDlB,EAkDyB,UAlDzB,CAAA,GAkDuC,YAlDvC,CAmDb,KAnDa,EAoDb,UApDa,CAAA,EAAA,iBAsDE,eAtDF,CAsDkB,WAtDlB,EAsD+B,KAtD/B,CAAA,GAsDwC,eAtDxC,CAuDb,WAvDa,EAwDb,KAxDa,CAAA,CAAA,GA0Db,cA1Da,CA0DE,WA1DF,EA0De,KA1Df,CAAA,CA0DsB,QA1DtB,CAAA;EACb,OAAA,KAAA,IAAA,GAAA;IAAe;;;;;;;IAMC,MAAA,EAAA,OAAA;IAAkC;;;;;;;IAElB,OAAA,EAAA,OAAA;EAAT,CAAA;EACD,OAAA,KAAA,qBAAA,GAqEtB,MArEsB,CAAA,MAAA,EAAA,OAAA,CAAA,GAAA,CAAA,GAAA,GAsEf,MAtEe,CAAA,MAAA,EAAA,OAAA,CAAA,CAAA;EAAR,OAAA,KAAA,0BAAA,CAAA,UAuE+B,qBAvE/B,CAAA,GAwEhB,CAxEgB,UAAA,GAAA,GAAA,KAAA,EAAA,IAAA,CAAA,GAwEc,CAxEd;EAAuB,OAAA,KAAA,yBAAA,CAAA,CAAA,EAAA,cA2EzB,IA3EyB,EAAA,uBA4EhB,qBA5EgB,CAAA,GA6ErC,KA7EqC,CAAA,QAAA,CAAA,SAAA,IAAA,GA8ErC,KA9EqC,CAAA,SAAA,CAAA,SAAA,IAAA,GA+EnC,WA/EmC,CA+EvB,CA/EuB,CAAA,GAgFnC,CAhFmC,GAiFrC,KAjFqC,CAAA,SAAA,CAAA,SAAA,IAAA,GAkFrC,WAlFqC,CAkFzB,CAlFyB,CAAA,GAkFpB,cAlFoB,GAmFrC,CAnFqC,GAmFjC,cAnFiC;EAAnC,OAAK,UAAA,YAAA,CAAA;IAIkB;;;;IAET,KAAA,CAAA,EAAA,OAAA;IAAkC;;;;;;IAE7C,YAAA,CAAA,EAAA,OAAA;EAA6B;EACd,OAAA,UAAA,WAAA,CAAA,cA0FR,KAAA,CAAM,gBA1FE,EAAA,mBA2FH,KAAA,CAAM,WA3FH,CA2Fe,KA3Ff,CAAA,EAAA,eA4FP,YA5FO,CA4FM,WA5FN,CAAA,EAAA,oBA6FF,YA7FE,CA6FW,KA7FX,EA6FkB,UA7FlB,CAAA,GA6FgC,YA7FhC,CA8FpB,KA9FoB,EA+FpB,UA/FoB,CAAA,CAAA,SAiGd,YAjGc,CAAA;IAAb;;;IAA6B,UAAA,EAqG1B,UArG0B;IACZ;;;;;;IAME,MAAA,CAAA,EAqGnB,MArGmB;EAAb;EACb,OAAA,UAAA,WAAA,CAAA,cAuGuC,IAvGvC,CAAA,CAAA;IAAe;;;;IAIf,KAAA,CAAA,EAAc,OAAA;IAIW;;;;;;IAIK,YAAA,CAAA,EAAA,OAAA;IAAc;;;;;;;IAKrB,MAAA,CAAA,EA0GhB,KA1GgB,CAAA,QAAA,CAAA;IACR;;;;;;;IAIH,OAAA,CAAA,EA6GJ,KA7GI,CAAA,SAAA,CAAA;EACmB;EAAO,OAAA,UAAA,aAAA,CAAA,cAgH1B,KAAA,CAAM,gBAhHoB,EAAA,mBAiHrB,KAAA,CAAM,WAjHe,CAiHH,KAjHG,CAAA,EAAA,eAkHzB,YAlHyB,CAkHZ,WAlHY,CAAA,EAAA,mBAmHrB,IAnHqB,EAAA,oBAoHpB,YApHoB,CAoHP,KApHO,EAoHA,UApHA,CAAA,GAoHc,YApHd,CAqHtC,KArHsC,EAsHtC,UAtHsC,CAAA,CAAA,SAwHhC,WAxHgC,CAwHpB,KAxHoB,EAwHb,UAxHa,EAwHD,MAxHC,EAwHO,WAxHP,CAAA,EAyHtC,WAzHsC,CAyH1B,UAzH0B,CAAA,CAAA,CAApB;EAClB,OAAA,KAAA,OAAA,CAAA,cA2HY,KAAA,CAAM,gBA3HlB,EAAA,mBA4HiB,KAAA,CAAM,WA5HvB,CA4HmC,KA5HnC,CAAA,EAAA,cA6HY,YA7HZ,CA6HyB,YA7HzB,CAAA,EAAA,eAAA,OAAA,EAAA,gBAAA,OAAA,EAAA,sBAgIoB,MAhIpB,CAAA,MAAA,EAAA,OAAA,CAAA,EAAA,oBAiIkB,qBAjIlB,EAAA,qBAkImB,YAlInB,CAkIgC,KAlIhC,EAkIuC,UAlIvC,CAAA,GAkIqD,YAlIrD,CAmIA,KAnIA,EAoIA,UApIA,CAAA,EAAA,cAsIY,IAtIZ,GAAA;IACA,MAAA,EAsIQ,MAtIR;IAFoD,OAAA,EAyI3C,OAzI2C;EAIrB,CAAA,CAAA,GAuI/B,aAvI+B,CAuIjB,KAvIiB,EAuIV,UAvIU,EAuIE,KAvIF,EAuIS,KAvIT,EAuIgB,YAvIhB,CAAA,GAwIjC,QAAA,CAAS,eAxIwB,CAwIR,KAxIQ,EAAA,CAwIA,UAxIA,CAAA,EAwIa,aAxIb,CAAA,GAAA;IAAa,OAAA,EAyInC,OAzImC,CA0I1C,MA1I0C,CA0InC,QAAA,CAAS,SA1I0B,CA0IhB,KA1IgB,EAAA,CA0IR,UA1IQ,CAAA,EAAA,KAAA,EA0IY,aA1IZ,CAAA,CAAA,EA2I1C,yBA3I0C,CA4IxC,kBA5IwC,CA4IrB,KA5IqB,EA4Id,UA5Ic,EA4IF,KA5IE,EA4IK,YA5IL,CAAA,EA6IxC,KA7IwC,EA8IxC,WA9IwC,CAAA,CAAA;EAA7B,CAAA;EACf,OAAA,KAAA,OAAA,CAAA,cAiJ8B,KAAA,CAAM,gBAjJpC,CAAA,GAAA,CAAA,mBAkJiB,KAAA,CAAM,WAlJvB,CAkJmC,KAlJnC,CAAA,EAAA,cAmJY,YAnJZ,CAmJyB,YAnJzB,CAmJsC,KAnJtC,EAmJ6C,UAnJ7C,CAAA,CAAA,GAAA,KAAA,EAAA,eAAA,OAAA,GAAA,IAAA,EAAA,gBAAA,OAAA,GAAA,KAAA,EAAA,sBAsJoB,MAtJpB,CAAA,MAAA,EAAA,OAAA,CAAA,GAAA,CAAA,CAAA,EAAA,8BAuJ4B,MAvJ5B,CAAA,MAAA,EAAA,OAAA,CAAA,GAAA,CAAA,CAAA,CAAA,CAAA,OAAA,EAyJO,OAzJP,CA0JA,KA1JA,EA2JA,UA3JA,EA4JA,KA5JA,EA6JA,MA7JA,EA8JA,OA9JA,EA+JA,aA/JA,EAgKA,qBAhKA,CAAA,EAAA,GAAA,IAAA;EACA,OAAA,KAAA,YAAA,CAAA,cAoKY,KAAA,CAAM,gBApKlB,EAAA,mBAqKiB,WArKjB,EAAA,oBAsKkB,KAAA,CAAM,WAtKxB,CAsKoC,KAtKpC,CAAA,GAsK6C,KAAA,CAAM,WAtKnD,CAsK+D,KAtK/D,CAAA,CAAA,GAAA,CAAA,cAwKY,YAxKZ,CAwKyB,YAxKzB,CAwKsC,KAxKtC,EAwK6C,UAxK7C,CAAA,CAAA,GAAA,KAAA,EAAA,eAAA,OAAA,GAAA,IAAA,EAAA,gBAAA,OAAA,GAAA,KAAA,EAAA,sBA2KoB,MA3KpB,CAAA,MAAA,EAAA,OAAA,CAAA,GAAA,CAAA,CAAA,EAAA,8BA4K4B,MA5K5B,CAAA,MAAA,EAAA,OAAA,CAAA,GAAA,CAAA,CAAA,CAAA,CAAA,OAAA,EA8KO,IA9KP,CA+KA,OA/KA,CAgLE,KAhLF,EAiLE,UAjLF,EAkLE,KAlLF,EAmLE,MAnLF,EAoLE,OApLF,EAqLE,aArLF,EAsLE,qBAtLF,CAAA,EAAA,YAAA,CAAA,EAAA,GAAA,IAAA;EAFqD,OAAA,KAAA,oBAAA,CAAA,cA8LzC,KAAA,CAAM,gBA9LmC,EAAA,oBA+LnC,mBAAA,CAAoB,IA/Le,CAgMrD,KAhMqD,EAiMrD,KAAA,CAAM,WAjM+C,CAiMnC,KAjMmC,CAAA,CAAA,CAAA,GAAA,UAoM/C,mBAAA,CAAoB,OAhMX,CAgMmB,KAhMnB,EAgM0B,WAhM1B,CAAA,GAgMyC,YAhMzC,CAiMf,KAjMe,EAkMf,GAlMe,CAAA,EAAa;EAA5B,OAAA,KAAA,yBAAA,CAAA,cAsMY,KAAA,CAAM,gBAtMlB,EAAA,oBAuMkB,mBAAA,CAAoB,IAvMtC,CAwMA,KAxMA,EAyMA,KAAA,CAAM,WAzMN,CAyMkB,KAzMlB,CAAA,CAAA,CAAA,GA2MA,WA3MA,SA2MoB,mBAAA,CAAoB,mBA3MxC,GA4MA,oBA5MA,CA4MqB,KA5MrB,EA4M4B,WA5M5B,CAAA,GAAA,KAAA;EAAmC,OAAA,KAAA,2BAAA,CAAA,cA+MvB,KAAA,CAAM,gBA/MiB,EAAA,oBAgNjB,mBAAA,CAAoB,IAhNH,CAiNnC,KAjNmC,EAkNnC,KAAA,CAAM,WAlN6B,CAkNjB,KAlNiB,CAAA,CAAA,CAAA,GAoNnC,WApNmC,SAoNf,mBAAA,CAAoB,aApNL,CAqNrC,KAAA,CAAM,WArN+B,CAqNnB,KArNmB,CAAA,CAAA,GAuNnC,oBAvNmC,CAuNd,KAvNc,EAuNP,WAvNO,CAAA,GAAA,KAAA;EAqBnC,OAAA,KAAA,4BAAA,CAAA,cAqMY,KAAA,CAAM,gBArMlB,EAAA,oBAsMkB,mBAAA,CAAoB,IAtMtC,CAuMA,KAvMA,EAwMA,KAAA,CAAM,WAxMN,CAwMkB,KAxMlB,CAAA,CAAA,CAAA,GA0MA,WA1MA,SA0MoB,mBAAA,CAAoB,cA1MxC,CA2MF,KAAA,CAAM,WA3MJ,CA2MgB,KA3MhB,CAAA,CAAA,GAAA,UACO,MA6MS,WA7MT,GA6MuB,GA7MvB,SA6MmC,mBAAA,CAAoB,OA7MvD,CA8MH,KA9MG,EA+MH,WA/MG,CAAA,GAiND,oBAjNC,CAiNoB,KAjNpB,EAiN2B,WAjN3B,CAAA,CAiNwC,GAjNxC,CAAA,GAAA,KAAA,EACsC,GAAA,KAAA;EAC/C,KAAA,WAAA,CAAA,cAoNc,KAAA,CAAM,gBApNpB,EAAA,oBAqNoB,mBAAA,CAAoB,IArNxC,CAsNE,KAtNF,EAuNE,KAAA,CAAM,WAvNR,CAuNoB,KAvNpB,CAAA,CAAA,CAAA,GAAA;IAA8B,GAAA,EA0NzB,yBA1NyB,CA0NC,KA1ND,EA0NQ,WA1NR,CAAA;IAGhB,KAAA,EAwNP,2BAxNO,CAwNqB,KAxNrB,EAwN4B,WAxN5B,CAAA;IACS,MAAA,EAwNf,4BAxNe,CAwNc,KAxNd,EAwNqB,WAxNrB,CAAA;EACrB,CAAA;EACA,OAAA,KAAA,QAAA,CAAA,cAyNY,KAAA,CAAM,gBAzNlB,EAAA,oBA0NkB,mBAAA,CAAoB,IA1NtC,CA2NA,KA3NA,EA4NA,KAAA,CAAM,WA5NN,CA4NkB,KA5NlB,CAAA,CAAA,CAAA,GA8NA,OA9NA,CA8NQ,KA9NR,CAAA,GA+NF,WA/NE,CA+NU,KA/NV,EA+NiB,WA/NjB,CAAA,CA+N8B,mBAAA,CAAoB,WA/NlD,CAgOA,KAhOA,EAiOA,WAjOA,CAAA,CAAA;EACc"}

package/dist/steps/fn-utils/update-fn.d.mts

@@ -0,0 +1,121 @@
+import { DeepKeys, DeepPartial, Expand, Relaxed, Updater, objectHelpers, stripFunctions } from "../../utils/types.mjs";
+import { path } from "../../utils/path.mjs";
+import { steps } from "../steps.mjs";
+import { HelperFn, HelperFnChosenSteps } from "./helper-fn/index.mjs";
+
+//#region src/steps/fn-utils/update-fn.d.ts
+declare namespace UpdateFn {
+  export type chosenFields<TCurrentStep extends steps.Any> = HelperFnChosenSteps.defaultStringOption | HelperFnChosenSteps.tupleNotation<DeepKeys<TCurrentStep>> | path.generateObjectConfig<TCurrentStep>;
+  type resolveAllPropertyPath<TCurrentStep extends steps.Any, TField extends chosenFields<TCurrentStep>> = TField extends HelperFnChosenSteps.defaultStringOption ? Relaxed<TCurrentStep> : never;
+  type resolveTuplePropertyPath<TCurrentStep extends steps.Any, TField extends chosenFields<TCurrentStep>, TDeepKeys extends DeepKeys<TCurrentStep> = DeepKeys<TCurrentStep>> = TField extends HelperFnChosenSteps.tupleNotation<TDeepKeys> ? TField[number] extends DeepKeys<Relaxed<TCurrentStep>> ? path.pickBy<Relaxed<TCurrentStep>, TField[number]> : never : never;
+  type resolveObjectPropertyPath<TCurrentStep extends steps.Any, TField extends chosenFields<TCurrentStep>, TDeepKeys extends DeepKeys<TCurrentStep> = DeepKeys<TCurrentStep>> = TField extends path.generateObjectConfig<TField> ? path.objectToPath<TField> extends TDeepKeys ? path.objectToPath<TField> extends DeepKeys<Relaxed<TCurrentStep>> ? path.pickBy<Relaxed<TCurrentStep>, path.objectToPath<TField>> : never : never : never;
+  type resolvePathType<TCurrentStep extends steps.Any, TField extends chosenFields<TCurrentStep>> = TField extends HelperFnChosenSteps.defaultStringOption ? 'all' : TField extends Array<infer _> ? 'tuple' : objectHelpers.isObject<TField> extends true ? 'object' : never;
+  type resolvePathMap<TCurrentStep extends steps.Any, TField extends chosenFields<TCurrentStep>> = {
+    all: resolveAllPropertyPath<TCurrentStep, TField>;
+    tuple: resolveTuplePropertyPath<TCurrentStep, TField>;
+    object: resolveObjectPropertyPath<TCurrentStep, TField>;
+  };
+  export type resolvedStep<value extends steps.instantiateSteps, targetStep extends steps.StepNumbers<value>> = stripFunctions<value[targetStep]>;
+  export type resolvedFieldValue<value extends steps.instantiateSteps, targetStep extends steps.StepNumbers<value>, field extends chosenFields<currentStep>, currentStep extends resolvedStep<value, targetStep> = resolvedStep<value, targetStep>, pathType extends resolvePathType<currentStep, field> = resolvePathType<currentStep, field>> = resolvePathMap<currentStep, field>[pathType];
+  export type mode = {
+    /**
+     * Enables strict mode for the update operation.
+     *
+     * When enabled, you won't be able to add new keys to an object. If
+     * you need to add new keys, set to `false`.
+     * @default true
+     */
+    strict: boolean;
+    /**
+     * Enables partial mode for the update operation.
+     *
+     * When enabled, you will be required to return the whole object. If
+     * you need to return a partial object, set to `false`.
+     * @default false
+     */
+    partial: boolean;
+  };
+  export type additionalUpdaterData = Record<string, unknown> | (() => Record<string, unknown>);
+  export type inferAdditionalUpdaterData<T extends additionalUpdaterData> = T extends (() => infer _) ? _ : T;
+  export type resolvedUpdaterReturnType<T, TMode extends mode, TAdditionalCtx extends additionalUpdaterData> = TMode['strict'] extends true ? TMode['partial'] extends true ? DeepPartial<T> : T : TMode['partial'] extends true ? DeepPartial<T> & TAdditionalCtx : T & TAdditionalCtx;
+  export interface DebugOptions {
+    /**
+     * Enables verbose debug logging for this update operation.
+     * Set to `true` to output helpful information for troubleshooting.
+     */
+    debug?: boolean;
+    /**
+     * Controls whether console errors should be silenced.
+     *
+     * By default, errors will be silenced when `partial: true` OR `strict: false`.
+     *
+     */
+    silentErrors?: boolean;
+  }
+  export interface BaseOptions<value extends steps.instantiateSteps, targetStep extends steps.StepNumbers<value>, fields extends chosenFields<currentStep>, currentStep extends resolvedStep<value, targetStep> = resolvedStep<value, targetStep>> extends DebugOptions {
+    /**
+     * The step to update.
+     */
+    targetStep: targetStep;
+    /**
+     * The specific fields to update.
+     *
+     * Optionally provide a value to narrow the results of the `ctx` in the
+     * updater `fn`.
+     */
+    fields?: fields;
+  }
+  export interface ModeOptions<TMode extends mode> {
+    /**
+     * Enables verbose debug logging for this update operation.
+     * Set to `true` to output helpful information for troubleshooting.
+     */
+    debug?: boolean;
+    /**
+     * Controls whether console errors should be silenced.
+     *
+     * By default, errors will be silenced when `partial: true` OR `strict: false`.
+     *
+     */
+    silentErrors?: boolean;
+    /**
+     * Enables strict mode for the update operation.
+     *
+     * When enabled, you won't be able to add new keys to an object. If
+     * you need to add new keys, set to `false`.
+     * @default true
+     */
+    strict?: TMode['strict'];
+    /**
+     * Enables partial mode for the update operation.
+     *
+     * When enabled, you will be required to return the whole object. If
+     * you need to return a partial object, set to `false`.
+     * @default false
+     */
+    partial?: TMode['partial'];
+  }
+  export interface SharedOptions<value extends steps.instantiateSteps, targetStep extends steps.StepNumbers<value>, fields extends chosenFields<currentStep>, updateMode extends mode, currentStep extends resolvedStep<value, targetStep> = resolvedStep<value, targetStep>> extends BaseOptions<value, targetStep, fields, currentStep>, ModeOptions<updateMode> {}
+  export type options<value extends steps.instantiateSteps, targetStep extends steps.StepNumbers<value>, field extends chosenFields<TCurrentStep>, strict extends boolean, partial extends boolean, additionalCtx extends Record<string, unknown>, updaterData extends additionalUpdaterData, TCurrentStep extends resolvedStep<value, targetStep> = resolvedStep<value, targetStep>, TMode extends mode = {
+    strict: strict;
+    partial: partial;
+  }> = SharedOptions<value, targetStep, field, TMode, TCurrentStep> & HelperFn.CtxDataSelector<value, [targetStep], additionalCtx> & {
+    updater: Updater<Expand<HelperFn.BaseInput<value, [targetStep], never, additionalCtx>>, resolvedUpdaterReturnType<resolvedFieldValue<value, targetStep, field, TCurrentStep>, TMode, updaterData>>;
+  };
+  export type general<value extends steps.instantiateSteps> = <targetStep extends steps.StepNumbers<value>, field extends chosenFields<resolvedStep<value, targetStep>> = 'all', strict extends boolean = true, partial extends boolean = false, additionalCtx extends Record<string, unknown> = {}, additionalUpdaterData extends Record<string, unknown> = {}>(options: options<value, targetStep, field, strict, partial, additionalCtx, additionalUpdaterData>) => void;
+  export type stepSpecific<value extends steps.instantiateSteps, targetStep extends stepNumbers, stepNumbers extends steps.StepNumbers<value> = steps.StepNumbers<value>> = <field extends chosenFields<resolvedStep<value, targetStep>> = 'all', strict extends boolean = true, partial extends boolean = false, additionalCtx extends Record<string, unknown> = {}, additionalUpdaterData extends Record<string, unknown> = {}>(options: Omit<options<value, targetStep, field, strict, partial, additionalCtx, additionalUpdaterData>, 'targetStep'>) => void;
+  export type StepSpecificHelperFn<value extends steps.instantiateSteps, chosenSteps extends HelperFnChosenSteps.main<value, steps.StepNumbers<value>>> = { [key in HelperFnChosenSteps.resolve<value, chosenSteps>]: stepSpecific<value, key> };
+  export type createHelperFnForAllSteps<value extends steps.instantiateSteps, chosenSteps extends HelperFnChosenSteps.main<value, steps.StepNumbers<value>>> = chosenSteps extends HelperFnChosenSteps.defaultStringOption ? StepSpecificHelperFn<value, chosenSteps> : never;
+  export type createHelperFnForTupleSteps<value extends steps.instantiateSteps, chosenSteps extends HelperFnChosenSteps.main<value, steps.StepNumbers<value>>> = chosenSteps extends HelperFnChosenSteps.tupleNotation<steps.StepNumbers<value>> ? StepSpecificHelperFn<value, chosenSteps> : never;
+  export type createHelperFnForObjectSteps<value extends steps.instantiateSteps, chosenSteps extends HelperFnChosenSteps.main<value, steps.StepNumbers<value>>> = chosenSteps extends HelperFnChosenSteps.objectNotation<steps.StepNumbers<value>> ? { [key in keyof chosenSteps]: key extends HelperFnChosenSteps.resolve<value, chosenSteps> ? StepSpecificHelperFn<value, chosenSteps>[key] : never } : never;
+  type HelperFnMap<value extends steps.instantiateSteps, chosenSteps extends HelperFnChosenSteps.main<value, steps.StepNumbers<value>>> = {
+    all: createHelperFnForAllSteps<value, chosenSteps>;
+    tuple: createHelperFnForTupleSteps<value, chosenSteps>;
+    object: createHelperFnForObjectSteps<value, chosenSteps>;
+  };
+  export type HelperFn<value extends steps.instantiateSteps, chosenSteps extends HelperFnChosenSteps.main<value, steps.StepNumbers<value>>> = general<value> & HelperFnMap<value, chosenSteps>[HelperFnChosenSteps.resolveType<value, chosenSteps>];
+  export {};
+}
+//#endregion
+export { UpdateFn };
+//# sourceMappingURL=update-fn.d.mts.map

package/dist/steps/fn-utils/update-fn.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-fn.d.mts","names":[],"sources":["../../../src/steps/fn-utils/update-fn.ts"],"sourcesContent":[],"mappings":";;;;;;kBAaiB,QAAA;gDAC+B,KAAA,CAAM,OAChD,mBAAA,CAAoB,sBACpB,mBAAA,CAAoB,cAAc,SAAS,iBAC3C,IAAA,CAAK,qBAAqB;EAJf,KAAA,sBAAQ,CAAA,qBAOA,KAAA,CAAM,GAPN,EAAA,eAQN,YARM,CAQO,YARP,CAAA,CAAA,GASnB,MATmB,SASJ,mBAAA,CAAoB,mBAThB,GAUnB,OAVmB,CAUX,YAVW,CAAA,GAAA,KAAA;EACuB,KAAM,wBAAA,CAAA,qBAY7B,KAAA,CAAM,GAZuB,EAAA,eAanC,YAbmC,CAatB,YAbsB,CAAA,EAAA,kBAchC,QAdgC,CAcvB,YAduB,CAAA,GAcP,QAdO,CAcE,YAdF,CAAA,CAAA,GAehD,MAfgD,SAejC,mBAAA,CAAoB,aAfa,CAeC,SAfD,CAAA,GAgBhD,MAhBgD,CAAA,MAAA,CAAA,SAgBzB,QAhByB,CAgBhB,OAhBgB,CAgBR,YAhBQ,CAAA,CAAA,GAiB9C,IAAA,CAAK,MAjByC,CAiBlC,OAjBkC,CAiB1B,YAjB0B,CAAA,EAiBX,MAjBW,CAAA,MAAA,CAAA,CAAA,GAAA,KAAA,GAAA,KAAA;EAChD,KAAA,yBAAoB,CAAA,qBAoBD,KAAA,CAAM,GApBL,EAAA,eAqBP,YArBO,CAqBM,YArBN,CAAA,EAAA,kBAsBJ,QAtBI,CAsBK,YAtBL,CAAA,GAsBqB,QAtBrB,CAsB8B,YAtB9B,CAAA,CAAA,GAuBpB,MAvBoB,SAuBL,IAAA,CAAK,oBAvBA,CAuBqB,MAvBrB,CAAA,GAwBpB,IAAA,CAAK,YAxBe,CAwBF,MAxBE,CAAA,SAwBc,SAxBd,GAyBlB,IAAA,CAAK,YAzBa,CAyBA,MAzBA,CAAA,SAyBgB,QAzBhB,CAyByB,OAzBzB,CAyBiC,YAzBjC,CAAA,CAAA,GA0BhB,IAAA,CAAK,MA1BW,CA0BJ,OA1BI,CA0BI,YA1BJ,CAAA,EA0BmB,IAAA,CAAK,YA1BxB,CA0BqC,MA1BrC,CAAA,CAAA,GAAA,KAAA,GAAA,KAAA,GAAA,KAAA;EACuB,KAAA,eAAA,CAAA,qBA8BxB,KAAA,CAAM,GA9BkB,EAAA,eA+B9B,YA/B8B,CA+BjB,YA/BiB,CAAA,CAAA,GAgC3C,MAhC2C,SAgC5B,mBAAA,CAAoB,mBAhCQ,GAAA,KAAA,GAkC3C,MAlC2C,SAkC5B,KAlC4B,CAAA,KAAA,EAAA,CAAA,GAAA,OAAA,GAoC3C,aAAA,CAAc,QApC6B,CAoCpB,MApCoB,CAAA,SAAA,IAAA,GAAA,QAAA,GAAA,KAAA;EAAT,KAAA,cAAA,CAAA,qBAwCf,KAAA,CAAM,GAxCS,EAAA,eAyCrB,YAzCqB,CAyCR,YAzCQ,CAAA,CAAA,GAAA;IAAlC,GAAA,EA2CG,sBA3CiB,CA2CM,YA3CN,EA2CoB,MA3CpB,CAAA;IACM,KAAA,EA2CrB,wBA3CqB,CA2CI,YA3CJ,EA2CkB,MA3ClB,CAAA;IAArB,MAAA,EA4CC,yBA5CD,CA4C2B,YA5C3B,EA4CyC,MA5CzC,CAAA;EAGc,CAAA;EACO,OAAA,KAAA,YAAA,CAAA,cA2Cd,KAAA,CAAM,gBA3CQ,EAAA,mBA4CT,KAAA,CAAM,WA5CG,CA4CS,KA5CT,CAAA,CAAA,GA6C1B,cA7C0B,CA6CX,KA7CW,CA6CL,UA7CK,CAAA,CAAA;EAAb,OAAA,KAAA,kBAAA,CAAA,cA+CD,KAAA,CAAM,gBA/CL,EAAA,mBAgDI,KAAA,CAAM,WAhDV,CAgDsB,KAhDtB,CAAA,EAAA,cAiDD,YAjDC,CAiDY,WAjDZ,CAAA,EAAA,oBAkDK,YAlDL,CAkDkB,KAlDlB,EAkDyB,UAlDzB,CAAA,GAkDuC,YAlDvC,CAmDb,KAnDa,EAoDb,UApDa,CAAA,EAAA,iBAsDE,eAtDF,CAsDkB,WAtDlB,EAsD+B,KAtD/B,CAAA,GAsDwC,eAtDxC,CAuDb,WAvDa,EAwDb,KAxDa,CAAA,CAAA,GA0Db,cA1Da,CA0DE,WA1DF,EA0De,KA1Df,CAAA,CA0DsB,QA1DtB,CAAA;EACb,OAAA,KAAA,IAAA,GAAA;IAAe;;;;;;;IAMC,MAAA,EAAA,OAAA;IAAkC;;;;;;;IAElB,OAAA,EAAA,OAAA;EAAT,CAAA;EACD,OAAA,KAAA,qBAAA,GAqEtB,MArEsB,CAAA,MAAA,EAAA,OAAA,CAAA,GAAA,CAAA,GAAA,GAsEf,MAtEe,CAAA,MAAA,EAAA,OAAA,CAAA,CAAA;EAAR,OAAA,KAAA,0BAAA,CAAA,UAuE+B,qBAvE/B,CAAA,GAwEhB,CAxEgB,UAAA,GAAA,GAAA,KAAA,EAAA,IAAA,CAAA,GAwEc,CAxEd;EAAuB,OAAA,KAAA,yBAAA,CAAA,CAAA,EAAA,cA2EzB,IA3EyB,EAAA,uBA4EhB,qBA5EgB,CAAA,GA6ErC,KA7EqC,CAAA,QAAA,CAAA,SAAA,IAAA,GA8ErC,KA9EqC,CAAA,SAAA,CAAA,SAAA,IAAA,GA+EnC,WA/EmC,CA+EvB,CA/EuB,CAAA,GAgFnC,CAhFmC,GAiFrC,KAjFqC,CAAA,SAAA,CAAA,SAAA,IAAA,GAkFrC,WAlFqC,CAkFzB,CAlFyB,CAAA,GAkFpB,cAlFoB,GAmFrC,CAnFqC,GAmFjC,cAnFiC;EAAnC,OAAK,UAAA,YAAA,CAAA;IAIkB;;;;IAET,KAAA,CAAA,EAAA,OAAA;IAAkC;;;;;;IAE7C,YAAA,CAAA,EAAA,OAAA;EAA6B;EACd,OAAA,UAAA,WAAA,CAAA,cA0FR,KAAA,CAAM,gBA1FE,EAAA,mBA2FH,KAAA,CAAM,WA3FH,CA2Fe,KA3Ff,CAAA,EAAA,eA4FP,YA5FO,CA4FM,WA5FN,CAAA,EAAA,oBA6FF,YA7FE,CA6FW,KA7FX,EA6FkB,UA7FlB,CAAA,GA6FgC,YA7FhC,CA8FpB,KA9FoB,EA+FpB,UA/FoB,CAAA,CAAA,SAiGd,YAjGc,CAAA;IAAb;;;IAA6B,UAAA,EAqG1B,UArG0B;IACZ;;;;;;IAME,MAAA,CAAA,EAqGnB,MArGmB;EAAb;EACb,OAAA,UAAA,WAAA,CAAA,cAuGuC,IAvGvC,CAAA,CAAA;IAAe;;;;IAIf,KAAA,CAAA,EAAc,OAAA;IAIW;;;;;;IAIK,YAAA,CAAA,EAAA,OAAA;IAAc;;;;;;;IAKrB,MAAA,CAAA,EA0GhB,KA1GgB,CAAA,QAAA,CAAA;IACR;;;;;;;IAIH,OAAA,CAAA,EA6GJ,KA7GI,CAAA,SAAA,CAAA;EACmB;EAAO,OAAA,UAAA,aAAA,CAAA,cAgH1B,KAAA,CAAM,gBAhHoB,EAAA,mBAiHrB,KAAA,CAAM,WAjHe,CAiHH,KAjHG,CAAA,EAAA,eAkHzB,YAlHyB,CAkHZ,WAlHY,CAAA,EAAA,mBAmHrB,IAnHqB,EAAA,oBAoHpB,YApHoB,CAoHP,KApHO,EAoHA,UApHA,CAAA,GAoHc,YApHd,CAqHtC,KArHsC,EAsHtC,UAtHsC,CAAA,CAAA,SAwHhC,WAxHgC,CAwHpB,KAxHoB,EAwHb,UAxHa,EAwHD,MAxHC,EAwHO,WAxHP,CAAA,EAyHtC,WAzHsC,CAyH1B,UAzH0B,CAAA,CAAA,CAApB;EAClB,OAAA,KAAA,OAAA,CAAA,cA2HY,KAAA,CAAM,gBA3HlB,EAAA,mBA4HiB,KAAA,CAAM,WA5HvB,CA4HmC,KA5HnC,CAAA,EAAA,cA6HY,YA7HZ,CA6HyB,YA7HzB,CAAA,EAAA,eAAA,OAAA,EAAA,gBAAA,OAAA,EAAA,sBAgIoB,MAhIpB,CAAA,MAAA,EAAA,OAAA,CAAA,EAAA,oBAiIkB,qBAjIlB,EAAA,qBAkImB,YAlInB,CAkIgC,KAlIhC,EAkIuC,UAlIvC,CAAA,GAkIqD,YAlIrD,CAmIA,KAnIA,EAoIA,UApIA,CAAA,EAAA,cAsIY,IAtIZ,GAAA;IACA,MAAA,EAsIQ,MAtIR;IAFoD,OAAA,EAyI3C,OAzI2C;EAIrB,CAAA,CAAA,GAuI/B,aAvI+B,CAuIjB,KAvIiB,EAuIV,UAvIU,EAuIE,KAvIF,EAuIS,KAvIT,EAuIgB,YAvIhB,CAAA,GAwIjC,QAAA,CAAS,eAxIwB,CAwIR,KAxIQ,EAAA,CAwIA,UAxIA,CAAA,EAwIa,aAxIb,CAAA,GAAA;IAAa,OAAA,EAyInC,OAzImC,CA0I1C,MA1I0C,CA0InC,QAAA,CAAS,SA1I0B,CA0IhB,KA1IgB,EAAA,CA0IR,UA1IQ,CAAA,EAAA,KAAA,EA0IY,aA1IZ,CAAA,CAAA,EA2I1C,yBA3I0C,CA4IxC,kBA5IwC,CA4IrB,KA5IqB,EA4Id,UA5Ic,EA4IF,KA5IE,EA4IK,YA5IL,CAAA,EA6IxC,KA7IwC,EA8IxC,WA9IwC,CAAA,CAAA;EAA7B,CAAA;EACf,OAAA,KAAA,OAAA,CAAA,cAiJ8B,KAAA,CAAM,gBAjJpC,CAAA,GAAA,CAAA,mBAkJiB,KAAA,CAAM,WAlJvB,CAkJmC,KAlJnC,CAAA,EAAA,cAmJY,YAnJZ,CAmJyB,YAnJzB,CAmJsC,KAnJtC,EAmJ6C,UAnJ7C,CAAA,CAAA,GAAA,KAAA,EAAA,eAAA,OAAA,GAAA,IAAA,EAAA,gBAAA,OAAA,GAAA,KAAA,EAAA,sBAsJoB,MAtJpB,CAAA,MAAA,EAAA,OAAA,CAAA,GAAA,CAAA,CAAA,EAAA,8BAuJ4B,MAvJ5B,CAAA,MAAA,EAAA,OAAA,CAAA,GAAA,CAAA,CAAA,CAAA,CAAA,OAAA,EAyJO,OAzJP,CA0JA,KA1JA,EA2JA,UA3JA,EA4JA,KA5JA,EA6JA,MA7JA,EA8JA,OA9JA,EA+JA,aA/JA,EAgKA,qBAhKA,CAAA,EAAA,GAAA,IAAA;EACA,OAAA,KAAA,YAAA,CAAA,cAoKY,KAAA,CAAM,gBApKlB,EAAA,mBAqKiB,WArKjB,EAAA,oBAsKkB,KAAA,CAAM,WAtKxB,CAsKoC,KAtKpC,CAAA,GAsK6C,KAAA,CAAM,WAtKnD,CAsK+D,KAtK/D,CAAA,CAAA,GAAA,CAAA,cAwKY,YAxKZ,CAwKyB,YAxKzB,CAwKsC,KAxKtC,EAwK6C,UAxK7C,CAAA,CAAA,GAAA,KAAA,EAAA,eAAA,OAAA,GAAA,IAAA,EAAA,gBAAA,OAAA,GAAA,KAAA,EAAA,sBA2KoB,MA3KpB,CAAA,MAAA,EAAA,OAAA,CAAA,GAAA,CAAA,CAAA,EAAA,8BA4K4B,MA5K5B,CAAA,MAAA,EAAA,OAAA,CAAA,GAAA,CAAA,CAAA,CAAA,CAAA,OAAA,EA8KO,IA9KP,CA+KA,OA/KA,CAgLE,KAhLF,EAiLE,UAjLF,EAkLE,KAlLF,EAmLE,MAnLF,EAoLE,OApLF,EAqLE,aArLF,EAsLE,qBAtLF,CAAA,EAAA,YAAA,CAAA,EAAA,GAAA,IAAA;EAFqD,OAAA,KAAA,oBAAA,CAAA,cA8LzC,KAAA,CAAM,gBA9LmC,EAAA,oBA+LnC,mBAAA,CAAoB,IA/Le,CAgMrD,KAhMqD,EAiMrD,KAAA,CAAM,WAjM+C,CAiMnC,KAjMmC,CAAA,CAAA,CAAA,GAAA,UAoM/C,mBAAA,CAAoB,OAhMX,CAgMmB,KAhMnB,EAgM0B,WAhM1B,CAAA,GAgMyC,YAhMzC,CAiMf,KAjMe,EAkMf,GAlMe,CAAA,EAAa;EAA5B,OAAA,KAAA,yBAAA,CAAA,cAsMY,KAAA,CAAM,gBAtMlB,EAAA,oBAuMkB,mBAAA,CAAoB,IAvMtC,CAwMA,KAxMA,EAyMA,KAAA,CAAM,WAzMN,CAyMkB,KAzMlB,CAAA,CAAA,CAAA,GA2MA,WA3MA,SA2MoB,mBAAA,CAAoB,mBA3MxC,GA4MA,oBA5MA,CA4MqB,KA5MrB,EA4M4B,WA5M5B,CAAA,GAAA,KAAA;EAAmC,OAAA,KAAA,2BAAA,CAAA,cA+MvB,KAAA,CAAM,gBA/MiB,EAAA,oBAgNjB,mBAAA,CAAoB,IAhNH,CAiNnC,KAjNmC,EAkNnC,KAAA,CAAM,WAlN6B,CAkNjB,KAlNiB,CAAA,CAAA,CAAA,GAoNnC,WApNmC,SAoNf,mBAAA,CAAoB,aApNL,CAqNrC,KAAA,CAAM,WArN+B,CAqNnB,KArNmB,CAAA,CAAA,GAuNnC,oBAvNmC,CAuNd,KAvNc,EAuNP,WAvNO,CAAA,GAAA,KAAA;EAqBnC,OAAA,KAAA,4BAAA,CAAA,cAqMY,KAAA,CAAM,gBArMlB,EAAA,oBAsMkB,mBAAA,CAAoB,IAtMtC,CAuMA,KAvMA,EAwMA,KAAA,CAAM,WAxMN,CAwMkB,KAxMlB,CAAA,CAAA,CAAA,GA0MA,WA1MA,SA0MoB,mBAAA,CAAoB,cA1MxC,CA2MF,KAAA,CAAM,WA3MJ,CA2MgB,KA3MhB,CAAA,CAAA,GAAA,UACO,MA6MS,WA7MT,GA6MuB,GA7MvB,SA6MmC,mBAAA,CAAoB,OA7MvD,CA8MH,KA9MG,EA+MH,WA/MG,CAAA,GAiND,oBAjNC,CAiNoB,KAjNpB,EAiN2B,WAjN3B,CAAA,CAiNwC,GAjNxC,CAAA,GAAA,KAAA,EACsC,GAAA,KAAA;EAC/C,KAAA,WAAA,CAAA,cAoNc,KAAA,CAAM,gBApNpB,EAAA,oBAqNoB,mBAAA,CAAoB,IArNxC,CAsNE,KAtNF,EAuNE,KAAA,CAAM,WAvNR,CAuNoB,KAvNpB,CAAA,CAAA,CAAA,GAAA;IAA8B,GAAA,EA0NzB,yBA1NyB,CA0NC,KA1ND,EA0NQ,WA1NR,CAAA;IAGhB,KAAA,EAwNP,2BAxNO,CAwNqB,KAxNrB,EAwN4B,WAxN5B,CAAA;IACS,MAAA,EAwNf,4BAxNe,CAwNc,KAxNd,EAwNqB,WAxNrB,CAAA;EACrB,CAAA;EACA,OAAA,KAAA,QAAA,CAAA,cAyNY,KAAA,CAAM,gBAzNlB,EAAA,oBA0NkB,mBAAA,CAAoB,IA1NtC,CA2NA,KA3NA,EA4NA,KAAA,CAAM,WA5NN,CA4NkB,KA5NlB,CAAA,CAAA,CAAA,GA8NA,OA9NA,CA8NQ,KA9NR,CAAA,GA+NF,WA/NE,CA+NU,KA/NV,EA+NiB,WA/NjB,CAAA,CA+N8B,mBAAA,CAAoB,WA/NlD,CAgOA,KAhOA,EAiOA,WAjOA,CAAA,CAAA;EACc"}

package/dist/steps/index.cjs

@@ -1,4 +1,6 @@
-const require_utils = require('./utils.cjs');
+const require_index = require('./fn-utils/helper-fn/index.cjs');
 const require_fields = require('./fields.cjs');
+const require_steps = require('./steps.cjs');
+const require_utils = require('./utils.cjs');
 const require_schema = require('./schema.cjs');
-const require_types = require('./types.cjs');
+require('./fn-utils/index.cjs');

package/dist/steps/index.mjs

@@ -1,6 +1,8 @@
-import { createCtx } from "./utils.mjs";
+import { HelperFnChosenSteps } from "./fn-utils/helper-fn/index.mjs";
 import { fields } from "./fields.mjs";
-import { MultiStepFormStepSchema } from "./schema.mjs";
-import { HelperFnChosenSteps } from "./types.mjs";
+import { VALIDATED_STEP_REGEX, steps } from "./steps.mjs";
+import { createCtx } from "./utils.mjs";
+import { MultiStepFormStepSchema, createIsValidStepFn } from "./schema.mjs";
+import "./fn-utils/index.mjs";
 
 export {  };

package/dist/steps/schema.cjs

@@ -1,32 +1,39 @@
+const require_casing = require('../utils/casing.cjs');
 const require_invariant = require('../utils/invariant.cjs');
+require('../utils/index.cjs');
+const require_fields = require('./fields.cjs');
+const require_steps = require('./steps.cjs');
+const require_helpers = require('../utils/helpers.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
+const STRING_KEYS = ["string", "string.keys"];
+const NUMBER_KEYS = ["number"];
+const ARRAY_STRING_KEYS = require_helpers.addToTuple(require_helpers.mapToTuple(STRING_KEYS, (key) => `array.${key}`), "array.string.untyped");
+const ARRAY_NUMBER_KEYS = require_helpers.mapToTuple(NUMBER_KEYS, (key) => `array.${key}`);
 /**
 * Available transformation types for the step numbers.
 */
 const AS_TYPES = [
-	"string",
-	"number",
-	"array.string",
-	"array.string.untyped"
+	...STRING_KEYS,
+	...NUMBER_KEYS,
+	...ARRAY_STRING_KEYS,
+	...ARRAY_NUMBER_KEYS
 ];
-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;
+function createIsValidStepFn(stepNumbers) {
+	function isValidStep(value) {
+		require_invariant.createInvariant("[isValidStep]")(typeof value === "string" || typeof value === "number", `The value must be a string or a number, was ${typeof value}`);
+		if (typeof value === "string") {
+			if (!value.includes("step")) return false;
+			return stepNumbers.includes(Number.parseInt(value.replace("step", "")));
+		}
+		if (typeof value === "number") return stepNumbers.includes(value);
+		return false;
 	}
-	return true;
+	return isValidStep;
 }
 var MultiStepFormStepSchema = class extends require_subscribable.Subscribable {
 	/**
@@ -39,45 +46,43 @@ var MultiStepFormStepSchema = class extends require_subscribable.Subscribable {
 	value;
 	steps;
 	defaultNameTransformationCasing;
-	firstStep;
-	lastStep;
-	stepNumbers;
-	storage;
+	#stepNumbers;
+	#storage;
 	#internal;
 	constructor(config) {
 		super();
-		const { steps, nameTransformCasing, storage } = config;
+		const { steps: steps$1, 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.original = steps$1;
+		this.value = require_steps.instantiateSteps({ steps: steps$1 });
 		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.#storage = new require_storage.MultiStepFormStorage({
+			data: this.value,
+			key: storage?.key ?? require_storage.DEFAULT_STORAGE_KEY,
+			store: storage?.store,
+			throwWhenUndefined: storage?.throwWhenUndefined
+		});
+		this.#stepNumbers = Object.keys(this.value).map((key) => Number.parseInt(key.replace("step", "")));
 		this.steps = {
-			first: this.firstStep.step,
-			last: this.lastStep.step,
-			value: this.stepNumbers,
+			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}`);
+				if (asType === "string") return this.#stepNumbers.map((value) => `'${value}'`).join(" | ");
+				if (asType === "string.keys") return this.#stepNumbers.map((value) => `'step${value}'`).join(" | ");
+				if (asType === "number") return this.#stepNumbers.join(" | ");
+				if (asType.includes("array.string")) {
+					if (asType.includes("keys")) return this.#stepNumbers.map((value) => `step${value}`);
+					return this.#stepNumbers.map((value) => `${value}`);
+				}
+				if (asType.includes("array.number")) return this.#stepNumbers;
 				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)
+			isValidStep: createIsValidStepFn(this.#stepNumbers)
 		};
 		this.sync();
 	}
@@ -85,7 +90,7 @@ var MultiStepFormStepSchema = class extends require_subscribable.Subscribable {
 	* @internal
 	*/
 	__getStorage() {
-		return this.storage;
+		return this.#storage;
 	}
 	getSnapshot() {
 		return this;
@@ -113,28 +118,17 @@ var MultiStepFormStepSchema = class extends require_subscribable.Subscribable {
 	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();
 	}
+	/**
+	* Updates the step with the given options.
+	* @param options The options for updating the step.
+	* @returns The return value of the updater function.
+	*/
 	update(options) {
 		this.#internal.update(options);
 	}
@@ -149,29 +143,8 @@ var MultiStepFormStepSchema = class extends require_subscribable.Subscribable {
 	* 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
-		});
+	static hasData(value) {
+		return require_steps.steps.isValidSteps(value);
 	}
 	/**
 	* Gets the value of a given field for a given step.
@@ -181,14 +154,18 @@ var MultiStepFormStepSchema = class extends require_subscribable.Subscribable {
 	*/
 	getValue(step, field) {
 		const stepData = this.value[step];
+		const invariant$1 = require_invariant.createInvariant("[getValue]");
 		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);
+		const errorSuffix = "This shouldn't be the case, so please open an issue";
+		const createErrorMessage = (reason) => `${baseErrorMessage} because ${reason}. ${errorSuffix}`;
+		invariant$1(typeof stepData === "object" && stepData !== null, createErrorMessage("the step data is not an object"));
+		invariant$1("fields" in stepData, createErrorMessage("the step data does not have a \"fields\" property"));
+		invariant$1(typeof stepData.fields === "object", createErrorMessage("\"fields\" is not an object"));
+		return require_fields.fields.resolvedDeepPath(field, stepData.fields);
 	}
 };
 
 //#endregion
 exports.MultiStepFormStepSchema = MultiStepFormStepSchema;
+exports.createIsValidStepFn = createIsValidStepFn;
 //# sourceMappingURL=schema.cjs.map