@jfdevelops/react-multi-step-form 1.0.0-alpha.3 → 1.0.0-alpha.30

package/dist/field.d.cts

@@ -0,0 +1,68 @@
+import { SelectorFn } from "./hooks/use-selector.cjs";
+import { AnyResolvedStep, Expand, HelperFnChosenSteps, HelperFnCtx, Override, StepNumbers, UpdateFn, Updater, fields } from "@jfdevelops/multi-step-form-core";
+import * as react0 from "react";
+import { ReactNode } from "react";
+
+//#region src/field.d.ts
+declare namespace field {
+  type sharedProps<TField extends string> = {
+    /**
+     * The name of the field.
+     */
+    name: TField;
+  };
+  type getDeep<TResolvedStep extends AnyResolvedStep, TSteps extends StepNumbers<TResolvedStep>, TChosenSteps extends HelperFnChosenSteps<TResolvedStep, TSteps>> = fields.getDeep<TResolvedStep, HelperFnChosenSteps.resolve<TResolvedStep, TSteps, TChosenSteps>>;
+  type resolveDeepPath<TResolvedStep extends AnyResolvedStep, TSteps extends StepNumbers<TResolvedStep>, TChosenSteps extends HelperFnChosenSteps<TResolvedStep, TSteps>, TField extends getDeep<TResolvedStep, TSteps, TChosenSteps>> = fields.resolveDeepPath<TResolvedStep, HelperFnChosenSteps.resolve<TResolvedStep, TSteps, TChosenSteps>, TField>;
+  type get<TResolvedStep extends AnyResolvedStep, TSteps extends StepNumbers<TResolvedStep>, TChosenSteps extends HelperFnChosenSteps<TResolvedStep, TSteps>> = fields.get<TResolvedStep, HelperFnChosenSteps.resolve<TResolvedStep, TSteps, TChosenSteps>>;
+  export type onInputChangeOptions<TStrict extends boolean, TPartial extends boolean> = UpdateFn.ModeOptions<{
+    strict: TStrict;
+    partial: TPartial;
+  }> & UpdateFn.DebugOptions;
+  export type childrenProps<TResolvedStep extends AnyResolvedStep, TSteps extends StepNumbers<TResolvedStep>, TChosenSteps extends HelperFnChosenSteps<TResolvedStep, TSteps>, TField extends getDeep<TResolvedStep, TSteps, TChosenSteps>, TValue extends resolveDeepPath<TResolvedStep, TSteps, TChosenSteps, TField> = resolveDeepPath<TResolvedStep, TSteps, TChosenSteps, TField>> = sharedProps<TField> & Override<get<TResolvedStep, TSteps, TChosenSteps>[fields.parentOf<TField>], 'defaultValue', TValue> & {
+    /**
+     * A useful wrapper around `update` to update the specific field.
+     * @param value The new value for the field.
+     * @param options The options for the update operation.
+     */
+    onInputChange: <strict extends boolean = true, partial extends boolean = false>(value: Updater<UpdateFn.resolvedUpdaterReturnType<TValue, {
+      strict: strict;
+      partial: partial;
+    }, {}>>, options?: onInputChangeOptions<strict, partial>) => void;
+    /**
+     * Resets the field's value to the original value that was
+     * defined in the config.
+     */
+    reset: (options?: UpdateFn.DebugOptions) => void;
+  };
+  export type childrenPropsWithSelected<TResolvedStep extends AnyResolvedStep, TSteps extends StepNumbers<TResolvedStep>, TChosenSteps extends HelperFnChosenSteps<TResolvedStep, TSteps>, TField extends getDeep<TResolvedStep, TSteps, TChosenSteps>, TSelected> = childrenProps<TResolvedStep, TSteps, TChosenSteps, TField> & {
+    selected: {
+      /**
+       * The result of the `selectorFn`.
+       */
+      value: TSelected;
+    };
+  };
+  export type props<TResolvedStep extends AnyResolvedStep, TSteps extends StepNumbers<TResolvedStep>, TChosenSteps extends HelperFnChosenSteps<TResolvedStep, TSteps>, TField extends getDeep<TResolvedStep, TSteps, TChosenSteps>, TSelected> = sharedProps<TField> & {
+    selectorFn?: SelectorFn<TResolvedStep, TSteps, TChosenSteps, TSelected>;
+    children: (props: [TSelected] extends [never] ? childrenProps<TResolvedStep, TSteps, TChosenSteps, TField> : childrenPropsWithSelected<TResolvedStep, TSteps, TChosenSteps, TField, TSelected>) => ReactNode;
+  };
+  export type component<TResolvedStep extends AnyResolvedStep, TSteps extends StepNumbers<TResolvedStep>, TChosenSteps extends HelperFnChosenSteps<TResolvedStep, TSteps>> = <field$1 extends fields.getDeep<TResolvedStep, HelperFnChosenSteps.resolve<TResolvedStep, TSteps, TChosenSteps>>, selected = never>(props: props<TResolvedStep, TSteps, TChosenSteps, field$1, selected>) => ReactNode;
+  export type createOptions<TResolvedStep extends AnyResolvedStep, TSteps extends StepNumbers<TResolvedStep>, TChosenSteps extends HelperFnChosenSteps<TResolvedStep, TSteps>> = {
+    propsCreator: <TField extends getDeep<TResolvedStep, TSteps, TChosenSteps>>(name: TField) => field$1.childrenProps<TResolvedStep, TSteps, TChosenSteps, TField>;
+    subscribe?: (listener: () => void) => () => void;
+    getValue?: <TField extends getDeep<TResolvedStep, TSteps, TChosenSteps>>(name: TField) => resolveDeepPath<TResolvedStep, TSteps, TChosenSteps, TField>;
+    selectorCtx: Expand<HelperFnCtx<TResolvedStep, TSteps, TChosenSteps>>;
+  };
+  /**
+   * Create a field.
+   * @param propsCreator
+   * @param subscribe - Optional subscription function for reactivity
+   * @param getValue - Optional function to get the current field value reactively
+   * @returns
+   */
+  export function create<TResolvedStep extends AnyResolvedStep, TSteps extends StepNumbers<TResolvedStep>, TChosenSteps extends HelperFnChosenSteps<TResolvedStep, TSteps>>(options: createOptions<TResolvedStep, TSteps, TChosenSteps>): react0.MemoExoticComponent<component<TResolvedStep, TSteps, TChosenSteps>>;
+  export {};
+}
+//#endregion
+export { field };
+//# sourceMappingURL=field.d.cts.map

package/dist/field.d.mts

@@ -0,0 +1,68 @@
+import { SelectorFn } from "./hooks/use-selector.mjs";
+import { AnyResolvedStep, Expand, HelperFnChosenSteps, HelperFnCtx, Override, StepNumbers, UpdateFn, Updater, fields } from "@jfdevelops/multi-step-form-core";
+import * as react0 from "react";
+import { ReactNode } from "react";
+
+//#region src/field.d.ts
+declare namespace field {
+  type sharedProps<TField extends string> = {
+    /**
+     * The name of the field.
+     */
+    name: TField;
+  };
+  type getDeep<TResolvedStep extends AnyResolvedStep, TSteps extends StepNumbers<TResolvedStep>, TChosenSteps extends HelperFnChosenSteps<TResolvedStep, TSteps>> = fields.getDeep<TResolvedStep, HelperFnChosenSteps.resolve<TResolvedStep, TSteps, TChosenSteps>>;
+  type resolveDeepPath<TResolvedStep extends AnyResolvedStep, TSteps extends StepNumbers<TResolvedStep>, TChosenSteps extends HelperFnChosenSteps<TResolvedStep, TSteps>, TField extends getDeep<TResolvedStep, TSteps, TChosenSteps>> = fields.resolveDeepPath<TResolvedStep, HelperFnChosenSteps.resolve<TResolvedStep, TSteps, TChosenSteps>, TField>;
+  type get<TResolvedStep extends AnyResolvedStep, TSteps extends StepNumbers<TResolvedStep>, TChosenSteps extends HelperFnChosenSteps<TResolvedStep, TSteps>> = fields.get<TResolvedStep, HelperFnChosenSteps.resolve<TResolvedStep, TSteps, TChosenSteps>>;
+  export type onInputChangeOptions<TStrict extends boolean, TPartial extends boolean> = UpdateFn.ModeOptions<{
+    strict: TStrict;
+    partial: TPartial;
+  }> & UpdateFn.DebugOptions;
+  export type childrenProps<TResolvedStep extends AnyResolvedStep, TSteps extends StepNumbers<TResolvedStep>, TChosenSteps extends HelperFnChosenSteps<TResolvedStep, TSteps>, TField extends getDeep<TResolvedStep, TSteps, TChosenSteps>, TValue extends resolveDeepPath<TResolvedStep, TSteps, TChosenSteps, TField> = resolveDeepPath<TResolvedStep, TSteps, TChosenSteps, TField>> = sharedProps<TField> & Override<get<TResolvedStep, TSteps, TChosenSteps>[fields.parentOf<TField>], 'defaultValue', TValue> & {
+    /**
+     * A useful wrapper around `update` to update the specific field.
+     * @param value The new value for the field.
+     * @param options The options for the update operation.
+     */
+    onInputChange: <strict extends boolean = true, partial extends boolean = false>(value: Updater<UpdateFn.resolvedUpdaterReturnType<TValue, {
+      strict: strict;
+      partial: partial;
+    }, {}>>, options?: onInputChangeOptions<strict, partial>) => void;
+    /**
+     * Resets the field's value to the original value that was
+     * defined in the config.
+     */
+    reset: (options?: UpdateFn.DebugOptions) => void;
+  };
+  export type childrenPropsWithSelected<TResolvedStep extends AnyResolvedStep, TSteps extends StepNumbers<TResolvedStep>, TChosenSteps extends HelperFnChosenSteps<TResolvedStep, TSteps>, TField extends getDeep<TResolvedStep, TSteps, TChosenSteps>, TSelected> = childrenProps<TResolvedStep, TSteps, TChosenSteps, TField> & {
+    selected: {
+      /**
+       * The result of the `selectorFn`.
+       */
+      value: TSelected;
+    };
+  };
+  export type props<TResolvedStep extends AnyResolvedStep, TSteps extends StepNumbers<TResolvedStep>, TChosenSteps extends HelperFnChosenSteps<TResolvedStep, TSteps>, TField extends getDeep<TResolvedStep, TSteps, TChosenSteps>, TSelected> = sharedProps<TField> & {
+    selectorFn?: SelectorFn<TResolvedStep, TSteps, TChosenSteps, TSelected>;
+    children: (props: [TSelected] extends [never] ? childrenProps<TResolvedStep, TSteps, TChosenSteps, TField> : childrenPropsWithSelected<TResolvedStep, TSteps, TChosenSteps, TField, TSelected>) => ReactNode;
+  };
+  export type component<TResolvedStep extends AnyResolvedStep, TSteps extends StepNumbers<TResolvedStep>, TChosenSteps extends HelperFnChosenSteps<TResolvedStep, TSteps>> = <field$1 extends fields.getDeep<TResolvedStep, HelperFnChosenSteps.resolve<TResolvedStep, TSteps, TChosenSteps>>, selected = never>(props: props<TResolvedStep, TSteps, TChosenSteps, field$1, selected>) => ReactNode;
+  export type createOptions<TResolvedStep extends AnyResolvedStep, TSteps extends StepNumbers<TResolvedStep>, TChosenSteps extends HelperFnChosenSteps<TResolvedStep, TSteps>> = {
+    propsCreator: <TField extends getDeep<TResolvedStep, TSteps, TChosenSteps>>(name: TField) => field$1.childrenProps<TResolvedStep, TSteps, TChosenSteps, TField>;
+    subscribe?: (listener: () => void) => () => void;
+    getValue?: <TField extends getDeep<TResolvedStep, TSteps, TChosenSteps>>(name: TField) => resolveDeepPath<TResolvedStep, TSteps, TChosenSteps, TField>;
+    selectorCtx: Expand<HelperFnCtx<TResolvedStep, TSteps, TChosenSteps>>;
+  };
+  /**
+   * Create a field.
+   * @param propsCreator
+   * @param subscribe - Optional subscription function for reactivity
+   * @param getValue - Optional function to get the current field value reactively
+   * @returns
+   */
+  export function create<TResolvedStep extends AnyResolvedStep, TSteps extends StepNumbers<TResolvedStep>, TChosenSteps extends HelperFnChosenSteps<TResolvedStep, TSteps>>(options: createOptions<TResolvedStep, TSteps, TChosenSteps>): react0.MemoExoticComponent<component<TResolvedStep, TSteps, TChosenSteps>>;
+  export {};
+}
+//#endregion
+export { field };
+//# sourceMappingURL=field.d.mts.map

package/dist/field.mjs

@@ -0,0 +1,36 @@
+import { selector } from "./selector.mjs";
+import { memo, useSyncExternalStore } from "react";
+import { jsx } from "react/jsx-runtime";
+
+//#region src/field.tsx
+let field;
+(function(_field) {
+	function create(options) {
+		const { propsCreator, subscribe, getValue, selectorCtx } = options;
+		const Field = (props) => {
+			const { name, children, selectorFn } = props;
+			const subscribeFn = subscribe || (() => () => {});
+			const getValueFn = getValue || (() => void 0);
+			const currentValue = useSyncExternalStore(subscribeFn, () => getValueFn(name), () => getValueFn(name));
+			let createdProps = propsCreator(name);
+			if (getValue) createdProps = {
+				...createdProps,
+				defaultValue: currentValue
+			};
+			if (selectorFn) return /* @__PURE__ */ jsx(selector.create(() => selectorCtx, subscribeFn), {
+				selector: selectorFn,
+				children: (value) => children({
+					...createdProps,
+					selected: { value }
+				})
+			});
+			return children(createdProps);
+		};
+		return memo(Field);
+	}
+	_field.create = create;
+})(field || (field = {}));
+
+//#endregion
+export { field };
+//# sourceMappingURL=field.mjs.map

package/dist/field.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"field.mjs","names":["Field: field.component<TResolvedStep, TSteps, TChosenSteps>"],"sources":["../src/field.tsx"],"sourcesContent":["import type {\n  AnyResolvedStep,\n  Expand,\n  fields,\n  HelperFnChosenSteps,\n  HelperFnCtx,\n  Override,\n  StepNumbers,\n  UpdateFn,\n  Updater,\n} from '@jfdevelops/multi-step-form-core';\nimport type { ReactNode } from 'react';\nimport { memo, useSyncExternalStore } from 'react';\nimport type { SelectorFn } from './hooks/use-selector';\nimport { selector } from './selector';\n\nexport namespace field {\n  type sharedProps<TField extends string> = {\n    /**\n     * The name of the field.\n     */\n    name: TField;\n  };\n\n  // aliases for types in `fields` namespace\n  type getDeep<\n    TResolvedStep extends AnyResolvedStep,\n    TSteps extends StepNumbers<TResolvedStep>,\n    TChosenSteps extends HelperFnChosenSteps<TResolvedStep, TSteps>\n  > = fields.getDeep<\n    TResolvedStep,\n    HelperFnChosenSteps.resolve<TResolvedStep, TSteps, TChosenSteps>\n  >;\n  type resolveDeepPath<\n    TResolvedStep extends AnyResolvedStep,\n    TSteps extends StepNumbers<TResolvedStep>,\n    TChosenSteps extends HelperFnChosenSteps<TResolvedStep, TSteps>,\n    TField extends getDeep<TResolvedStep, TSteps, TChosenSteps>\n  > = fields.resolveDeepPath<\n    TResolvedStep,\n    HelperFnChosenSteps.resolve<TResolvedStep, TSteps, TChosenSteps>,\n    TField\n  >;\n  type get<\n    TResolvedStep extends AnyResolvedStep,\n    TSteps extends StepNumbers<TResolvedStep>,\n    TChosenSteps extends HelperFnChosenSteps<TResolvedStep, TSteps>\n  > = fields.get<\n    TResolvedStep,\n    HelperFnChosenSteps.resolve<TResolvedStep, TSteps, TChosenSteps>\n  >;\n  export type onInputChangeOptions<\n    TStrict extends boolean,\n    TPartial extends boolean\n  > = UpdateFn.ModeOptions<{\n    strict: TStrict;\n    partial: TPartial;\n  }> &\n    UpdateFn.DebugOptions;\n\n  export type childrenProps<\n    TResolvedStep extends AnyResolvedStep,\n    TSteps extends StepNumbers<TResolvedStep>,\n    TChosenSteps extends HelperFnChosenSteps<TResolvedStep, TSteps>,\n    TField extends getDeep<TResolvedStep, TSteps, TChosenSteps>,\n    TValue extends resolveDeepPath<\n      TResolvedStep,\n      TSteps,\n      TChosenSteps,\n      TField\n    > = resolveDeepPath<TResolvedStep, TSteps, TChosenSteps, TField>\n  > = sharedProps<TField> &\n    Override<\n      get<TResolvedStep, TSteps, TChosenSteps>[fields.parentOf<TField>],\n      'defaultValue',\n      TValue\n    > & {\n      /**\n       * A useful wrapper around `update` to update the specific field.\n       * @param value The new value for the field.\n       * @param options The options for the update operation.\n       */\n      onInputChange: <\n        strict extends boolean = true,\n        partial extends boolean = false\n      >(\n        value: Updater<\n          UpdateFn.resolvedUpdaterReturnType<\n            TValue,\n            { strict: strict; partial: partial },\n            {}\n          >\n        >,\n        options?: onInputChangeOptions<strict, partial>\n      ) => void;\n      /**\n       * Resets the field's value to the original value that was\n       * defined in the config.\n       */\n      reset: (options?: UpdateFn.DebugOptions) => void;\n    };\n\n  export type childrenPropsWithSelected<\n    TResolvedStep extends AnyResolvedStep,\n    TSteps extends StepNumbers<TResolvedStep>,\n    TChosenSteps extends HelperFnChosenSteps<TResolvedStep, TSteps>,\n    TField extends getDeep<TResolvedStep, TSteps, TChosenSteps>,\n    TSelected\n  > = childrenProps<TResolvedStep, TSteps, TChosenSteps, TField> & {\n    selected: {\n      /**\n       * The result of the `selectorFn`.\n       */\n      value: TSelected;\n    };\n  };\n  export type props<\n    TResolvedStep extends AnyResolvedStep,\n    TSteps extends StepNumbers<TResolvedStep>,\n    TChosenSteps extends HelperFnChosenSteps<TResolvedStep, TSteps>,\n    TField extends getDeep<TResolvedStep, TSteps, TChosenSteps>,\n    TSelected\n  > = sharedProps<TField> & {\n    selectorFn?: SelectorFn<TResolvedStep, TSteps, TChosenSteps, TSelected>;\n    children: (\n      props: [TSelected] extends [never]\n        ? childrenProps<TResolvedStep, TSteps, TChosenSteps, TField>\n        : childrenPropsWithSelected<\n          TResolvedStep,\n          TSteps,\n          TChosenSteps,\n          TField,\n          TSelected\n        >\n    ) => ReactNode;\n  };\n  export type component<\n    TResolvedStep extends AnyResolvedStep,\n    TSteps extends StepNumbers<TResolvedStep>,\n    TChosenSteps extends HelperFnChosenSteps<TResolvedStep, TSteps>\n  > = <\n    field extends fields.getDeep<\n      TResolvedStep,\n      HelperFnChosenSteps.resolve<TResolvedStep, TSteps, TChosenSteps>\n    >,\n    selected = never\n  >(\n    props: props<TResolvedStep, TSteps, TChosenSteps, field, selected>\n  ) => ReactNode;\n\n  export type createOptions<\n    TResolvedStep extends AnyResolvedStep,\n    TSteps extends StepNumbers<TResolvedStep>,\n    TChosenSteps extends HelperFnChosenSteps<TResolvedStep, TSteps>\n  > = {\n    propsCreator: <TField extends getDeep<TResolvedStep, TSteps, TChosenSteps>>(\n      name: TField\n    ) => field.childrenProps<TResolvedStep, TSteps, TChosenSteps, TField>;\n    subscribe?: (listener: () => void) => () => void;\n    getValue?: <TField extends getDeep<TResolvedStep, TSteps, TChosenSteps>>(\n      name: TField\n    ) => resolveDeepPath<TResolvedStep, TSteps, TChosenSteps, TField>;\n    selectorCtx: Expand<HelperFnCtx<TResolvedStep, TSteps, TChosenSteps>>;\n  };\n\n  /**\n   * Create a field.\n   * @param propsCreator\n   * @param subscribe - Optional subscription function for reactivity\n   * @param getValue - Optional function to get the current field value reactively\n   * @returns\n   */\n  export function create<\n    TResolvedStep extends AnyResolvedStep,\n    TSteps extends StepNumbers<TResolvedStep>,\n    TChosenSteps extends HelperFnChosenSteps<TResolvedStep, TSteps>\n  >(options: createOptions<TResolvedStep, TSteps, TChosenSteps>) {\n    const { propsCreator, subscribe, getValue, selectorCtx } = options;\n\n    const Field: field.component<TResolvedStep, TSteps, TChosenSteps> = (\n      props\n    ) => {\n      const { name, children, selectorFn } = props;\n\n      // Always call the hook, but use no-op functions if subscribe/getValue aren't provided\n      const subscribeFn = subscribe || (() => () => { });\n      const getValueFn = getValue || (() => undefined);\n\n      // Subscribe to changes to trigger rerenders\n      const currentValue = useSyncExternalStore(\n        subscribeFn,\n        () => getValueFn(name),\n        () => getValueFn(name)\n      );\n\n      let createdProps = propsCreator(name);\n\n      // If getValue is provided, override defaultValue with the reactive value\n      if (getValue) {\n        createdProps = {\n          ...createdProps,\n          defaultValue: currentValue,\n        } as typeof createdProps;\n      }\n\n      if (selectorFn) {\n        const Selector = selector.create<TResolvedStep, TSteps, TChosenSteps>(\n          () => selectorCtx,\n          subscribeFn\n        );\n\n        return (\n          <Selector selector={selectorFn}>\n            {(value) =>\n              children({\n                ...createdProps,\n                selected: { value: value as never },\n              })\n            }\n          </Selector>\n        );\n      }\n\n      return children(createdProps as never);\n    };\n\n    return memo(Field);\n  }\n}"],"mappings":";;;;;;;CA4KS,SAAS,OAId,SAA6D;EAC7D,MAAM,EAAE,cAAc,WAAW,UAAU,gBAAgB;EAE3D,MAAMA,SACJ,UACG;GACH,MAAM,EAAE,MAAM,UAAU,eAAe;GAGvC,MAAM,cAAc,0BAA0B;GAC9C,MAAM,aAAa,mBAAmB;GAGtC,MAAM,eAAe,qBACnB,mBACM,WAAW,KAAK,QAChB,WAAW,KAAK,CACvB;GAED,IAAI,eAAe,aAAa,KAAK;AAGrC,OAAI,SACF,gBAAe;IACb,GAAG;IACH,cAAc;IACf;AAGH,OAAI,WAMF,QACE,oBANe,SAAS,aAClB,aACN,YACD;IAGW,UAAU;eAChB,UACA,SAAS;KACP,GAAG;KACH,UAAU,EAAS,OAAgB;KACpC,CAAC;KAEK;AAIf,UAAO,SAAS,aAAsB;;AAGxC,SAAO,KAAK,MAAM"}

package/dist/form-config.cjs

@@ -0,0 +1,32 @@
+let react_jsx_runtime = require("react/jsx-runtime");
+
+//#region src/form-config.tsx
+let MultiStepFormSchemaConfig;
+(function(_MultiStepFormSchemaConfig) {
+	_MultiStepFormSchemaConfig.DEFAULT_FORM_ALIAS = "Form";
+	function isFormAvailable(target, enabledFor) {
+		if (Array.isArray(target)) {
+			if (enabledFor === "all") return true;
+			if (typeof enabledFor === "object" && !Array.isArray(enabledFor)) return Object.keys(enabledFor).some((key) => target.includes(key));
+			if (Array.isArray(enabledFor)) return enabledFor.some((key) => target.includes(key));
+		}
+		return false;
+	}
+	_MultiStepFormSchemaConfig.isFormAvailable = isFormAvailable;
+	function createDefaultForm(id) {
+		return (props) => /* @__PURE__ */ (0, react_jsx_runtime.jsx)("form", {
+			id,
+			...props
+		});
+	}
+	_MultiStepFormSchemaConfig.createDefaultForm = createDefaultForm;
+})(MultiStepFormSchemaConfig || (MultiStepFormSchemaConfig = {}));
+
+//#endregion
+Object.defineProperty(exports, 'MultiStepFormSchemaConfig', {
+  enumerable: true,
+  get: function () {
+    return MultiStepFormSchemaConfig;
+  }
+});
+//# sourceMappingURL=form-config.cjs.map

package/dist/form-config.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"form-config.cjs","names":[],"sources":["../src/form-config.tsx"],"sourcesContent":["import type {\n  Expand,\n  HelperFnChosenSteps,\n  StepNumbers,\n  ValidStepKey,\n} from '@jfdevelops/multi-step-form-core';\nimport type { ComponentPropsWithRef, JSX } from 'react';\nimport type {\n  AnyResolvedStep,\n  CreatedMultiStepFormComponent,\n} from './step-schema';\n\nexport namespace MultiStepFormSchemaConfig {\n  export const DEFAULT_FORM_ALIAS = 'Form';\n  export type defaultEnabledFor = HelperFnChosenSteps.defaultStringOption;\n  export type defaultFormAlias = typeof DEFAULT_FORM_ALIAS;\n  export type formEnabledFor<TResolvedStep extends AnyResolvedStep> =\n    HelperFnChosenSteps<TResolvedStep, StepNumbers<TResolvedStep>>;\n  type strippedResolvedSteps<T extends AnyResolvedStep> = {\n    [_ in keyof T]: Expand<Omit<T[_], 'createComponent' | 'createHelperFn'>>;\n  };\n  export type AvailableStepForForm<\n    TResolvedStep extends AnyResolvedStep,\n    TEnabledFor extends formEnabledFor<TResolvedStep>\n  > = TEnabledFor extends defaultEnabledFor\n    ? strippedResolvedSteps<TResolvedStep>\n    : TEnabledFor extends [\n        ValidStepKey<StepNumbers<TResolvedStep>>,\n        ...ValidStepKey<StepNumbers<TResolvedStep>>[]\n      ]\n    ? TEnabledFor[number] extends keyof TResolvedStep\n      ? Pick<strippedResolvedSteps<TResolvedStep>, TEnabledFor[number]>\n      : never\n    : keyof TEnabledFor extends keyof TResolvedStep\n    ? Expand<\n        Pick<\n          strippedResolvedSteps<TResolvedStep>,\n          Extract<keyof TResolvedStep, keyof TEnabledFor>\n        >\n      >\n    : never;\n  export type formCtx<TAlias extends string, TProps> = {\n    [_ in TAlias]: CreatedMultiStepFormComponent<TProps>;\n  };\n  export type renderFnData<\n    TResolvedStep extends AnyResolvedStep,\n    TEnabledFor extends formEnabledFor<TResolvedStep>\n  > = {\n    /**\n     * The id for the form, either a custom one or the default one.\n     */\n    id: string;\n    /**\n     * The chosen steps that are available.\n     */\n    steps: Expand<AvailableStepForForm<TResolvedStep, TEnabledFor>>;\n  };\n\n  /**\n   * The configuration options for the `form` option.\n   */\n  export interface FormConfig<\n    TResolvedStep extends AnyResolvedStep,\n    TAlias extends string,\n    TFormEnabledFor extends formEnabledFor<TResolvedStep>,\n    TCustomFormProps extends object\n  > {\n    /**\n     * The `id` for the form component.\n     *\n     * If there is no value provided, the default id will the **current step key**.\n     *\n     * @default `${currentStep}`\n     */\n    id?: string;\n    /**\n     * The \"name\" of the form component.\n     * @default 'Form'\n     * @example\n     * ```tsx\n     * const schema = createMultiStepFormSchema({\n     *  steps: {\n     *    step1: {\n     *      title: 'Step 1',\n     *      fields: {\n     *        firstName: {\n     *          defaultValue: ''\n     *       }\n     *     }\n     *   },\n     *   form: {\n     *    alias: 'MyCustomForm',\n     *    render() {\n     *      // return custom form component here\n     *     }\n     *   }\n     *  }\n     * })\n     *\n     * const Step1 = schema.stepSchema.step1.createComponent(\n     *  ({ ctx, MyCustomForm }, props: { children: ReactNode }) =>\n     *     // Notice how the form is available with its alias\n     *     <MyCustomFormName>{children}</MyCustomFormName>\n     *  )\n     * ```\n     */\n    alias?: TAlias;\n    /**\n     * If the form component should be accessible for each step when calling `createComponent`.\n     *\n     * If no value is given, the form will be accessible for all the steps.\n     */\n    enabledForSteps?: TFormEnabledFor;\n    /**\n     *\n     * @param data The data that is available for creating the custom form.\n     * @param props Props that can be used for the custom form.\n     * @returns An {@see JSX.Element} that is the custom form.\n     * @example\n     * ### With custom props\n     * ```tsx\n     * type CustomProps = {\n     *   title: string;\n     *   description?: string;\n     *   children: ReactNode;\n     * };\n     *\n     * const schema = createMultiStepFormSchema({\n     *  steps: {\n     *    step1: {\n     *      title: 'Step 1',\n     *      fields: {\n     *        firstName: {\n     *          defaultValue: ''\n     *       }\n     *     }\n     *   },\n     *   form: {\n     *    alias: 'MyCustomForm',\n     *    render(data, props: CustomProps) {\n     *      return (\n     *         <div>\n     *          <h1>{props.title}</h1>\n     *          <p>{props.description}</p>\n     *          <form>{props.children}</form>\n     *         </div>\n     *       );\n     *     }\n     *   }\n     *  }\n     * })\n     * ```\n     * ### Without custom props\n     * ```tsx\n     * const schema = createMultiStepFormSchema({\n     *  steps: {\n     *    step1: {\n     *      title: 'Step 1',\n     *      fields: {\n     *        firstName: {\n     *          defaultValue: ''\n     *       }\n     *     }\n     *   },\n     *   form: {\n     *    alias: 'MyCustomForm',\n     *    render(data, props) {\n     *      // The default type for `props` will be `ComponentPropsWithRef<'form'>`\n     *      // return custom form component here\n     *     }\n     *   }\n     *  }\n     * })\n     * ```\n     */\n    render: (\n      data: renderFnData<TResolvedStep, TFormEnabledFor>,\n      props: TCustomFormProps\n    ) => JSX.Element;\n  }\n\n  export interface Form<\n    TResolvedStep extends AnyResolvedStep,\n    TAlias extends string,\n    TFormEnabledFor extends formEnabledFor<TResolvedStep>,\n    TCustomFormProps extends object\n  > {\n    form?: FormConfig<TResolvedStep, TAlias, TFormEnabledFor, TCustomFormProps>;\n  }\n\n  /**\n   * Compares {@linkcode enabledFor} to the {@linkcode target} to determine if the form\n   * should be available.\n   * @param target The target steps the form _should_ be available for.\n   * @param enabledFor The steps that the form _is_ enabled for.\n   * @returns A boolean representing if the form should be available.\n   */\n  // Note: the implementation is specific to `MultiStepFormStepSchema.createComponentForStep`\n  // because the `target` will always be an `Array` in `MultiStepFormStepSchema.createComponentForStep`.\n  // TODO add validation to keys\n  export function isFormAvailable<\n    TResolvedStep extends AnyResolvedStep,\n    TTarget extends HelperFnChosenSteps<\n      TResolvedStep,\n      StepNumbers<TResolvedStep>\n    >,\n    TEnabledFor extends formEnabledFor<TResolvedStep>\n  >(target: TTarget, enabledFor: TEnabledFor) {\n    if (Array.isArray(target)) {\n      if (enabledFor === 'all') {\n        return true;\n      }\n\n      if (typeof enabledFor === 'object' && !Array.isArray(enabledFor)) {\n        return Object.keys(enabledFor).some((key) =>\n          target.includes(key as `step${StepNumbers<TResolvedStep>}`)\n        );\n      }\n\n      if (Array.isArray(enabledFor)) {\n        return enabledFor.some((key) => target.includes(key));\n      }\n    }\n\n    return false;\n  }\n\n  /**\n   * Creates a form component with a default id.\n   * @param id The default id for the form.\n   * @returns A form component with a default {@linkcode id}.\n   */\n  export function createDefaultForm(id: string) {\n    return (props: Omit<ComponentPropsWithRef<'form'>, 'id'>) => (\n      <form id={id} {...props} />\n    );\n  }\n}\n"],"mappings":";;;;;iDAaoC;CA2L3B,SAAS,gBAOd,QAAiB,YAAyB;AAC1C,MAAI,MAAM,QAAQ,OAAO,EAAE;AACzB,OAAI,eAAe,MACjB,QAAO;AAGT,OAAI,OAAO,eAAe,YAAY,CAAC,MAAM,QAAQ,WAAW,CAC9D,QAAO,OAAO,KAAK,WAAW,CAAC,MAAM,QACnC,OAAO,SAAS,IAA2C,CAC5D;AAGH,OAAI,MAAM,QAAQ,WAAW,CAC3B,QAAO,WAAW,MAAM,QAAQ,OAAO,SAAS,IAAI,CAAC;;AAIzD,SAAO;;;CAQF,SAAS,kBAAkB,IAAY;AAC5C,UAAQ,UACN,2CAAC;GAAS;GAAI,GAAI;IAAS"}

package/dist/form-config.d.cts

@@ -0,0 +1,160 @@
+import { AnyResolvedStep as AnyResolvedStep$1, CreatedMultiStepFormComponent } from "./step-schema.cjs";
+import { Expand, HelperFnChosenSteps, StepNumbers, ValidStepKey } from "@jfdevelops/multi-step-form-core";
+import { ComponentPropsWithRef, JSX } from "react";
+import * as react_jsx_runtime0 from "react/jsx-runtime";
+
+//#region src/form-config.d.ts
+declare namespace MultiStepFormSchemaConfig {
+  export const DEFAULT_FORM_ALIAS = "Form";
+  export type defaultEnabledFor = HelperFnChosenSteps.defaultStringOption;
+  export type defaultFormAlias = typeof DEFAULT_FORM_ALIAS;
+  export type formEnabledFor<TResolvedStep extends AnyResolvedStep$1> = HelperFnChosenSteps<TResolvedStep, StepNumbers<TResolvedStep>>;
+  type strippedResolvedSteps<T extends AnyResolvedStep$1> = { [_ in keyof T]: Expand<Omit<T[_], 'createComponent' | 'createHelperFn'>> };
+  export type AvailableStepForForm<TResolvedStep extends AnyResolvedStep$1, TEnabledFor extends formEnabledFor<TResolvedStep>> = TEnabledFor extends defaultEnabledFor ? strippedResolvedSteps<TResolvedStep> : TEnabledFor extends [ValidStepKey<StepNumbers<TResolvedStep>>, ...ValidStepKey<StepNumbers<TResolvedStep>>[]] ? TEnabledFor[number] extends keyof TResolvedStep ? Pick<strippedResolvedSteps<TResolvedStep>, TEnabledFor[number]> : never : keyof TEnabledFor extends keyof TResolvedStep ? Expand<Pick<strippedResolvedSteps<TResolvedStep>, Extract<keyof TResolvedStep, keyof TEnabledFor>>> : never;
+  export type formCtx<TAlias extends string, TProps> = { [_ in TAlias]: CreatedMultiStepFormComponent<TProps> };
+  export type renderFnData<TResolvedStep extends AnyResolvedStep$1, TEnabledFor extends formEnabledFor<TResolvedStep>> = {
+    /**
+     * The id for the form, either a custom one or the default one.
+     */
+    id: string;
+    /**
+     * The chosen steps that are available.
+     */
+    steps: Expand<AvailableStepForForm<TResolvedStep, TEnabledFor>>;
+  };
+  /**
+   * The configuration options for the `form` option.
+   */
+  export interface FormConfig<TResolvedStep extends AnyResolvedStep$1, TAlias extends string, TFormEnabledFor extends formEnabledFor<TResolvedStep>, TCustomFormProps extends object> {
+    /**
+     * The `id` for the form component.
+     *
+     * If there is no value provided, the default id will the **current step key**.
+     *
+     * @default `${currentStep}`
+     */
+    id?: string;
+    /**
+     * The "name" of the form component.
+     * @default 'Form'
+     * @example
+     * ```tsx
+     * const schema = createMultiStepFormSchema({
+     *  steps: {
+     *    step1: {
+     *      title: 'Step 1',
+     *      fields: {
+     *        firstName: {
+     *          defaultValue: ''
+     *       }
+     *     }
+     *   },
+     *   form: {
+     *    alias: 'MyCustomForm',
+     *    render() {
+     *      // return custom form component here
+     *     }
+     *   }
+     *  }
+     * })
+     *
+     * const Step1 = schema.stepSchema.step1.createComponent(
+     *  ({ ctx, MyCustomForm }, props: { children: ReactNode }) =>
+     *     // Notice how the form is available with its alias
+     *     <MyCustomFormName>{children}</MyCustomFormName>
+     *  )
+     * ```
+     */
+    alias?: TAlias;
+    /**
+     * If the form component should be accessible for each step when calling `createComponent`.
+     *
+     * If no value is given, the form will be accessible for all the steps.
+     */
+    enabledForSteps?: TFormEnabledFor;
+    /**
+     *
+     * @param data The data that is available for creating the custom form.
+     * @param props Props that can be used for the custom form.
+     * @returns An {@see JSX.Element} that is the custom form.
+     * @example
+     * ### With custom props
+     * ```tsx
+     * type CustomProps = {
+     *   title: string;
+     *   description?: string;
+     *   children: ReactNode;
+     * };
+     *
+     * const schema = createMultiStepFormSchema({
+     *  steps: {
+     *    step1: {
+     *      title: 'Step 1',
+     *      fields: {
+     *        firstName: {
+     *          defaultValue: ''
+     *       }
+     *     }
+     *   },
+     *   form: {
+     *    alias: 'MyCustomForm',
+     *    render(data, props: CustomProps) {
+     *      return (
+     *         <div>
+     *          <h1>{props.title}</h1>
+     *          <p>{props.description}</p>
+     *          <form>{props.children}</form>
+     *         </div>
+     *       );
+     *     }
+     *   }
+     *  }
+     * })
+     * ```
+     * ### Without custom props
+     * ```tsx
+     * const schema = createMultiStepFormSchema({
+     *  steps: {
+     *    step1: {
+     *      title: 'Step 1',
+     *      fields: {
+     *        firstName: {
+     *          defaultValue: ''
+     *       }
+     *     }
+     *   },
+     *   form: {
+     *    alias: 'MyCustomForm',
+     *    render(data, props) {
+     *      // The default type for `props` will be `ComponentPropsWithRef<'form'>`
+     *      // return custom form component here
+     *     }
+     *   }
+     *  }
+     * })
+     * ```
+     */
+    render: (data: renderFnData<TResolvedStep, TFormEnabledFor>, props: TCustomFormProps) => JSX.Element;
+  }
+  export interface Form<TResolvedStep extends AnyResolvedStep$1, TAlias extends string, TFormEnabledFor extends formEnabledFor<TResolvedStep>, TCustomFormProps extends object> {
+    form?: FormConfig<TResolvedStep, TAlias, TFormEnabledFor, TCustomFormProps>;
+  }
+  /**
+   * Compares {@linkcode enabledFor} to the {@linkcode target} to determine if the form
+   * should be available.
+   * @param target The target steps the form _should_ be available for.
+   * @param enabledFor The steps that the form _is_ enabled for.
+   * @returns A boolean representing if the form should be available.
+   */
+  export function isFormAvailable<TResolvedStep extends AnyResolvedStep$1, TTarget extends HelperFnChosenSteps<TResolvedStep, StepNumbers<TResolvedStep>>, TEnabledFor extends formEnabledFor<TResolvedStep>>(target: TTarget, enabledFor: TEnabledFor): boolean;
+  /**
+   * Creates a form component with a default id.
+   * @param id The default id for the form.
+   * @returns A form component with a default {@linkcode id}.
+   */
+  export function createDefaultForm(id: string): (props: Omit<ComponentPropsWithRef<"form">, "id">) => react_jsx_runtime0.JSX.Element;
+  export {};
+}
+//#endregion
+export { MultiStepFormSchemaConfig };
+//# sourceMappingURL=form-config.d.cts.map

package/dist/form-config.d.mts

@@ -0,0 +1,160 @@
+import { AnyResolvedStep as AnyResolvedStep$1, CreatedMultiStepFormComponent } from "./step-schema.mjs";
+import { Expand, HelperFnChosenSteps, StepNumbers, ValidStepKey } from "@jfdevelops/multi-step-form-core";
+import { ComponentPropsWithRef, JSX } from "react";
+import * as react_jsx_runtime0 from "react/jsx-runtime";
+
+//#region src/form-config.d.ts
+declare namespace MultiStepFormSchemaConfig {
+  export const DEFAULT_FORM_ALIAS = "Form";
+  export type defaultEnabledFor = HelperFnChosenSteps.defaultStringOption;
+  export type defaultFormAlias = typeof DEFAULT_FORM_ALIAS;
+  export type formEnabledFor<TResolvedStep extends AnyResolvedStep$1> = HelperFnChosenSteps<TResolvedStep, StepNumbers<TResolvedStep>>;
+  type strippedResolvedSteps<T extends AnyResolvedStep$1> = { [_ in keyof T]: Expand<Omit<T[_], 'createComponent' | 'createHelperFn'>> };
+  export type AvailableStepForForm<TResolvedStep extends AnyResolvedStep$1, TEnabledFor extends formEnabledFor<TResolvedStep>> = TEnabledFor extends defaultEnabledFor ? strippedResolvedSteps<TResolvedStep> : TEnabledFor extends [ValidStepKey<StepNumbers<TResolvedStep>>, ...ValidStepKey<StepNumbers<TResolvedStep>>[]] ? TEnabledFor[number] extends keyof TResolvedStep ? Pick<strippedResolvedSteps<TResolvedStep>, TEnabledFor[number]> : never : keyof TEnabledFor extends keyof TResolvedStep ? Expand<Pick<strippedResolvedSteps<TResolvedStep>, Extract<keyof TResolvedStep, keyof TEnabledFor>>> : never;
+  export type formCtx<TAlias extends string, TProps> = { [_ in TAlias]: CreatedMultiStepFormComponent<TProps> };
+  export type renderFnData<TResolvedStep extends AnyResolvedStep$1, TEnabledFor extends formEnabledFor<TResolvedStep>> = {
+    /**
+     * The id for the form, either a custom one or the default one.
+     */
+    id: string;
+    /**
+     * The chosen steps that are available.
+     */
+    steps: Expand<AvailableStepForForm<TResolvedStep, TEnabledFor>>;
+  };
+  /**
+   * The configuration options for the `form` option.
+   */
+  export interface FormConfig<TResolvedStep extends AnyResolvedStep$1, TAlias extends string, TFormEnabledFor extends formEnabledFor<TResolvedStep>, TCustomFormProps extends object> {
+    /**
+     * The `id` for the form component.
+     *
+     * If there is no value provided, the default id will the **current step key**.
+     *
+     * @default `${currentStep}`
+     */
+    id?: string;
+    /**
+     * The "name" of the form component.
+     * @default 'Form'
+     * @example
+     * ```tsx
+     * const schema = createMultiStepFormSchema({
+     *  steps: {
+     *    step1: {
+     *      title: 'Step 1',
+     *      fields: {
+     *        firstName: {
+     *          defaultValue: ''
+     *       }
+     *     }
+     *   },
+     *   form: {
+     *    alias: 'MyCustomForm',
+     *    render() {
+     *      // return custom form component here
+     *     }
+     *   }
+     *  }
+     * })
+     *
+     * const Step1 = schema.stepSchema.step1.createComponent(
+     *  ({ ctx, MyCustomForm }, props: { children: ReactNode }) =>
+     *     // Notice how the form is available with its alias
+     *     <MyCustomFormName>{children}</MyCustomFormName>
+     *  )
+     * ```
+     */
+    alias?: TAlias;
+    /**
+     * If the form component should be accessible for each step when calling `createComponent`.
+     *
+     * If no value is given, the form will be accessible for all the steps.
+     */
+    enabledForSteps?: TFormEnabledFor;
+    /**
+     *
+     * @param data The data that is available for creating the custom form.
+     * @param props Props that can be used for the custom form.
+     * @returns An {@see JSX.Element} that is the custom form.
+     * @example
+     * ### With custom props
+     * ```tsx
+     * type CustomProps = {
+     *   title: string;
+     *   description?: string;
+     *   children: ReactNode;
+     * };
+     *
+     * const schema = createMultiStepFormSchema({
+     *  steps: {
+     *    step1: {
+     *      title: 'Step 1',
+     *      fields: {
+     *        firstName: {
+     *          defaultValue: ''
+     *       }
+     *     }
+     *   },
+     *   form: {
+     *    alias: 'MyCustomForm',
+     *    render(data, props: CustomProps) {
+     *      return (
+     *         <div>
+     *          <h1>{props.title}</h1>
+     *          <p>{props.description}</p>
+     *          <form>{props.children}</form>
+     *         </div>
+     *       );
+     *     }
+     *   }
+     *  }
+     * })
+     * ```
+     * ### Without custom props
+     * ```tsx
+     * const schema = createMultiStepFormSchema({
+     *  steps: {
+     *    step1: {
+     *      title: 'Step 1',
+     *      fields: {
+     *        firstName: {
+     *          defaultValue: ''
+     *       }
+     *     }
+     *   },
+     *   form: {
+     *    alias: 'MyCustomForm',
+     *    render(data, props) {
+     *      // The default type for `props` will be `ComponentPropsWithRef<'form'>`
+     *      // return custom form component here
+     *     }
+     *   }
+     *  }
+     * })
+     * ```
+     */
+    render: (data: renderFnData<TResolvedStep, TFormEnabledFor>, props: TCustomFormProps) => JSX.Element;
+  }
+  export interface Form<TResolvedStep extends AnyResolvedStep$1, TAlias extends string, TFormEnabledFor extends formEnabledFor<TResolvedStep>, TCustomFormProps extends object> {
+    form?: FormConfig<TResolvedStep, TAlias, TFormEnabledFor, TCustomFormProps>;
+  }
+  /**
+   * Compares {@linkcode enabledFor} to the {@linkcode target} to determine if the form
+   * should be available.
+   * @param target The target steps the form _should_ be available for.
+   * @param enabledFor The steps that the form _is_ enabled for.
+   * @returns A boolean representing if the form should be available.
+   */
+  export function isFormAvailable<TResolvedStep extends AnyResolvedStep$1, TTarget extends HelperFnChosenSteps<TResolvedStep, StepNumbers<TResolvedStep>>, TEnabledFor extends formEnabledFor<TResolvedStep>>(target: TTarget, enabledFor: TEnabledFor): boolean;
+  /**
+   * Creates a form component with a default id.
+   * @param id The default id for the form.
+   * @returns A form component with a default {@linkcode id}.
+   */
+  export function createDefaultForm(id: string): (props: Omit<ComponentPropsWithRef<"form">, "id">) => react_jsx_runtime0.JSX.Element;
+  export {};
+}
+//#endregion
+export { MultiStepFormSchemaConfig };
+//# sourceMappingURL=form-config.d.mts.map

package/dist/form-config.mjs

@@ -0,0 +1,27 @@
+import { jsx } from "react/jsx-runtime";
+
+//#region src/form-config.tsx
+let MultiStepFormSchemaConfig;
+(function(_MultiStepFormSchemaConfig) {
+	_MultiStepFormSchemaConfig.DEFAULT_FORM_ALIAS = "Form";
+	function isFormAvailable(target, enabledFor) {
+		if (Array.isArray(target)) {
+			if (enabledFor === "all") return true;
+			if (typeof enabledFor === "object" && !Array.isArray(enabledFor)) return Object.keys(enabledFor).some((key) => target.includes(key));
+			if (Array.isArray(enabledFor)) return enabledFor.some((key) => target.includes(key));
+		}
+		return false;
+	}
+	_MultiStepFormSchemaConfig.isFormAvailable = isFormAvailable;
+	function createDefaultForm(id) {
+		return (props) => /* @__PURE__ */ jsx("form", {
+			id,
+			...props
+		});
+	}
+	_MultiStepFormSchemaConfig.createDefaultForm = createDefaultForm;
+})(MultiStepFormSchemaConfig || (MultiStepFormSchemaConfig = {}));
+
+//#endregion
+export { MultiStepFormSchemaConfig };
+//# sourceMappingURL=form-config.mjs.map

package/dist/form-config.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"form-config.mjs","names":[],"sources":["../src/form-config.tsx"],"sourcesContent":["import type {\n  Expand,\n  HelperFnChosenSteps,\n  StepNumbers,\n  ValidStepKey,\n} from '@jfdevelops/multi-step-form-core';\nimport type { ComponentPropsWithRef, JSX } from 'react';\nimport type {\n  AnyResolvedStep,\n  CreatedMultiStepFormComponent,\n} from './step-schema';\n\nexport namespace MultiStepFormSchemaConfig {\n  export const DEFAULT_FORM_ALIAS = 'Form';\n  export type defaultEnabledFor = HelperFnChosenSteps.defaultStringOption;\n  export type defaultFormAlias = typeof DEFAULT_FORM_ALIAS;\n  export type formEnabledFor<TResolvedStep extends AnyResolvedStep> =\n    HelperFnChosenSteps<TResolvedStep, StepNumbers<TResolvedStep>>;\n  type strippedResolvedSteps<T extends AnyResolvedStep> = {\n    [_ in keyof T]: Expand<Omit<T[_], 'createComponent' | 'createHelperFn'>>;\n  };\n  export type AvailableStepForForm<\n    TResolvedStep extends AnyResolvedStep,\n    TEnabledFor extends formEnabledFor<TResolvedStep>\n  > = TEnabledFor extends defaultEnabledFor\n    ? strippedResolvedSteps<TResolvedStep>\n    : TEnabledFor extends [\n        ValidStepKey<StepNumbers<TResolvedStep>>,\n        ...ValidStepKey<StepNumbers<TResolvedStep>>[]\n      ]\n    ? TEnabledFor[number] extends keyof TResolvedStep\n      ? Pick<strippedResolvedSteps<TResolvedStep>, TEnabledFor[number]>\n      : never\n    : keyof TEnabledFor extends keyof TResolvedStep\n    ? Expand<\n        Pick<\n          strippedResolvedSteps<TResolvedStep>,\n          Extract<keyof TResolvedStep, keyof TEnabledFor>\n        >\n      >\n    : never;\n  export type formCtx<TAlias extends string, TProps> = {\n    [_ in TAlias]: CreatedMultiStepFormComponent<TProps>;\n  };\n  export type renderFnData<\n    TResolvedStep extends AnyResolvedStep,\n    TEnabledFor extends formEnabledFor<TResolvedStep>\n  > = {\n    /**\n     * The id for the form, either a custom one or the default one.\n     */\n    id: string;\n    /**\n     * The chosen steps that are available.\n     */\n    steps: Expand<AvailableStepForForm<TResolvedStep, TEnabledFor>>;\n  };\n\n  /**\n   * The configuration options for the `form` option.\n   */\n  export interface FormConfig<\n    TResolvedStep extends AnyResolvedStep,\n    TAlias extends string,\n    TFormEnabledFor extends formEnabledFor<TResolvedStep>,\n    TCustomFormProps extends object\n  > {\n    /**\n     * The `id` for the form component.\n     *\n     * If there is no value provided, the default id will the **current step key**.\n     *\n     * @default `${currentStep}`\n     */\n    id?: string;\n    /**\n     * The \"name\" of the form component.\n     * @default 'Form'\n     * @example\n     * ```tsx\n     * const schema = createMultiStepFormSchema({\n     *  steps: {\n     *    step1: {\n     *      title: 'Step 1',\n     *      fields: {\n     *        firstName: {\n     *          defaultValue: ''\n     *       }\n     *     }\n     *   },\n     *   form: {\n     *    alias: 'MyCustomForm',\n     *    render() {\n     *      // return custom form component here\n     *     }\n     *   }\n     *  }\n     * })\n     *\n     * const Step1 = schema.stepSchema.step1.createComponent(\n     *  ({ ctx, MyCustomForm }, props: { children: ReactNode }) =>\n     *     // Notice how the form is available with its alias\n     *     <MyCustomFormName>{children}</MyCustomFormName>\n     *  )\n     * ```\n     */\n    alias?: TAlias;\n    /**\n     * If the form component should be accessible for each step when calling `createComponent`.\n     *\n     * If no value is given, the form will be accessible for all the steps.\n     */\n    enabledForSteps?: TFormEnabledFor;\n    /**\n     *\n     * @param data The data that is available for creating the custom form.\n     * @param props Props that can be used for the custom form.\n     * @returns An {@see JSX.Element} that is the custom form.\n     * @example\n     * ### With custom props\n     * ```tsx\n     * type CustomProps = {\n     *   title: string;\n     *   description?: string;\n     *   children: ReactNode;\n     * };\n     *\n     * const schema = createMultiStepFormSchema({\n     *  steps: {\n     *    step1: {\n     *      title: 'Step 1',\n     *      fields: {\n     *        firstName: {\n     *          defaultValue: ''\n     *       }\n     *     }\n     *   },\n     *   form: {\n     *    alias: 'MyCustomForm',\n     *    render(data, props: CustomProps) {\n     *      return (\n     *         <div>\n     *          <h1>{props.title}</h1>\n     *          <p>{props.description}</p>\n     *          <form>{props.children}</form>\n     *         </div>\n     *       );\n     *     }\n     *   }\n     *  }\n     * })\n     * ```\n     * ### Without custom props\n     * ```tsx\n     * const schema = createMultiStepFormSchema({\n     *  steps: {\n     *    step1: {\n     *      title: 'Step 1',\n     *      fields: {\n     *        firstName: {\n     *          defaultValue: ''\n     *       }\n     *     }\n     *   },\n     *   form: {\n     *    alias: 'MyCustomForm',\n     *    render(data, props) {\n     *      // The default type for `props` will be `ComponentPropsWithRef<'form'>`\n     *      // return custom form component here\n     *     }\n     *   }\n     *  }\n     * })\n     * ```\n     */\n    render: (\n      data: renderFnData<TResolvedStep, TFormEnabledFor>,\n      props: TCustomFormProps\n    ) => JSX.Element;\n  }\n\n  export interface Form<\n    TResolvedStep extends AnyResolvedStep,\n    TAlias extends string,\n    TFormEnabledFor extends formEnabledFor<TResolvedStep>,\n    TCustomFormProps extends object\n  > {\n    form?: FormConfig<TResolvedStep, TAlias, TFormEnabledFor, TCustomFormProps>;\n  }\n\n  /**\n   * Compares {@linkcode enabledFor} to the {@linkcode target} to determine if the form\n   * should be available.\n   * @param target The target steps the form _should_ be available for.\n   * @param enabledFor The steps that the form _is_ enabled for.\n   * @returns A boolean representing if the form should be available.\n   */\n  // Note: the implementation is specific to `MultiStepFormStepSchema.createComponentForStep`\n  // because the `target` will always be an `Array` in `MultiStepFormStepSchema.createComponentForStep`.\n  // TODO add validation to keys\n  export function isFormAvailable<\n    TResolvedStep extends AnyResolvedStep,\n    TTarget extends HelperFnChosenSteps<\n      TResolvedStep,\n      StepNumbers<TResolvedStep>\n    >,\n    TEnabledFor extends formEnabledFor<TResolvedStep>\n  >(target: TTarget, enabledFor: TEnabledFor) {\n    if (Array.isArray(target)) {\n      if (enabledFor === 'all') {\n        return true;\n      }\n\n      if (typeof enabledFor === 'object' && !Array.isArray(enabledFor)) {\n        return Object.keys(enabledFor).some((key) =>\n          target.includes(key as `step${StepNumbers<TResolvedStep>}`)\n        );\n      }\n\n      if (Array.isArray(enabledFor)) {\n        return enabledFor.some((key) => target.includes(key));\n      }\n    }\n\n    return false;\n  }\n\n  /**\n   * Creates a form component with a default id.\n   * @param id The default id for the form.\n   * @returns A form component with a default {@linkcode id}.\n   */\n  export function createDefaultForm(id: string) {\n    return (props: Omit<ComponentPropsWithRef<'form'>, 'id'>) => (\n      <form id={id} {...props} />\n    );\n  }\n}\n"],"mappings":";;;;;iDAaoC;CA2L3B,SAAS,gBAOd,QAAiB,YAAyB;AAC1C,MAAI,MAAM,QAAQ,OAAO,EAAE;AACzB,OAAI,eAAe,MACjB,QAAO;AAGT,OAAI,OAAO,eAAe,YAAY,CAAC,MAAM,QAAQ,WAAW,CAC9D,QAAO,OAAO,KAAK,WAAW,CAAC,MAAM,QACnC,OAAO,SAAS,IAA2C,CAC5D;AAGH,OAAI,MAAM,QAAQ,WAAW,CAC3B,QAAO,WAAW,MAAM,QAAQ,OAAO,SAAS,IAAI,CAAC;;AAIzD,SAAO;;;CAQF,SAAS,kBAAkB,IAAY;AAC5C,UAAQ,UACN,oBAAC;GAAS;GAAI,GAAI;IAAS"}