@wizzard-packages/react 0.1.1 → 0.3.0

package/dist/index.d.ts

@@ -1,10 +1,41 @@
 import * as _wizzard_packages_core from '@wizzard-packages/core';
-import { IWizardConfig, IWizardContext as IWizardContext$1, Path, PathValue, IStepConfig, IWizardState, IWizardActions as IWizardActions$1 } from '@wizzard-packages/core';
+import { IWizardActions as IWizardActions$1, Path, PathValue, IWizardContext as IWizardContext$1, IWizardState, IWizardConfig, IStepConfig, IWizardStore } from '@wizzard-packages/core';
 export { IStepConfig, IValidatorAdapter, IWizardActions, IWizardConfig, IWizardContext, IWizardState, PersistenceMode, ValidationResult, WizardMiddleware, WizardStore } from '@wizzard-packages/core';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import React from 'react';
 export { loggerMiddleware } from '@wizzard-packages/middleware';
 
+/**
+ * Handle returned by components for imperative access to the wizard.
+ */
+interface IWizardHandle<T = unknown, StepId extends string = string> {
+    state: IWizardState<T, StepId>;
+    actions: IWizardActions<StepId>;
+}
+/**
+ * React-specific actions
+ */
+interface IWizardActions<StepId extends string = string> extends IWizardActions$1<StepId> {
+}
+/**
+ * Typed actions for strongly-typed paths.
+ */
+type IWizardActionsTyped<T, StepId extends string = string> = Omit<IWizardActions$1<StepId>, 'setData' | 'updateData' | 'getData'> & {
+    setData: <P extends Path<T>>(path: P, value: PathValue<T, P>, options?: {
+        debounceValidation?: number;
+    }) => void;
+    updateData: (data: Partial<T>, options?: {
+        replace?: boolean;
+        persist?: boolean;
+    }) => void;
+    getData: <P extends Path<T>>(path: P, defaultValue?: PathValue<T, P>) => PathValue<T, P>;
+};
+/**
+ * Core Wizard Context State
+ */
+interface IWizardContext<T = unknown, StepId extends string = string> extends IWizardContext$1<T, StepId> {
+}
+
 /**
  * createWizardFactory
  *
@@ -13,9 +44,10 @@ export { loggerMiddleware } from '@wizzard-packages/middleware';
  * @template TSchema The shape of your wizard's global data state
  */
 declare function createWizardFactory<TSchema extends Record<string, any>, StepId extends string = string>(): {
-    WizardProvider: ({ config, initialData, children, }: {
+    WizardProvider: ({ config, initialData, initialStepId, children, }: {
         config: IWizardConfig<TSchema, StepId>;
         initialData?: Partial<TSchema>;
+        initialStepId?: StepId;
         children: React.ReactNode;
     }) => react_jsx_runtime.JSX.Element;
     useWizard: () => IWizardContext$1<TSchema, StepId>;
@@ -23,11 +55,14 @@ declare function createWizardFactory<TSchema extends Record<string, any>, StepId
     useWizardValue: <P extends Path<TSchema>>(path: P, options?: {
         isEqual?: (a: PathValue<TSchema, P>, b: PathValue<TSchema, P>) => boolean;
     }) => PathValue<TSchema, P>;
+    useWizardField: <P extends Path<TSchema>>(path: P, options?: {
+        isEqual?: (a: PathValue<TSchema, P>, b: PathValue<TSchema, P>) => boolean;
+    }) => [PathValue<TSchema, P>, (value: PathValue<TSchema, P>) => void];
     useWizardSelector: <TSelected>(selector: (state: IWizardContext$1<TSchema, StepId>) => TSelected, options?: {
         isEqual?: (a: TSelected, b: TSelected) => boolean;
     }) => TSelected;
     useWizardError: <P extends Path<TSchema>>(path: P) => string | undefined;
-    useWizardActions: () => _wizzard_packages_core.IWizardActions<StepId>;
+    useWizardActions: () => IWizardActionsTyped<TSchema, StepId>;
     useWizardState: () => _wizzard_packages_core.IWizardState<TSchema, StepId>;
     useBreadcrumbs: () => _wizzard_packages_core.IBreadcrumb<StepId>[];
     createStep: (config: IStepConfig<TSchema, StepId>) => IStepConfig<TSchema, StepId>;
@@ -56,6 +91,12 @@ declare function useWizardState<T = unknown, StepId extends string = string>():
 declare function useWizardValue<TValue = any>(path: string, options?: {
     isEqual?: (a: TValue, b: TValue) => boolean;
 }): TValue;
+/**
+ * Returns a value and setter for a path (useState-like API).
+ */
+declare function useWizardField<T, P extends Path<T>>(path: P, options?: {
+    isEqual?: (a: PathValue<T, P>, b: PathValue<T, P>) => boolean;
+}): [PathValue<T, P>, (value: PathValue<T, P>) => void];
 /**
  * Returns the first error message for a path across all steps.
  */
@@ -74,6 +115,37 @@ declare function useWizardActions<StepId extends string = string>(): IWizardActi
  * Returns combined wizard state, actions, and derived errors.
  */
 declare function useWizardContext<T = any, StepId extends string = string>(): IWizardContext$1<T, StepId>;
+/**
+ * Returns current step config.
+ */
+declare function useWizardCurrentStep<T = any, StepId extends string = string>(): IStepConfig<T, StepId> | null;
+/**
+ * Returns active steps list.
+ */
+declare function useWizardSteps<T = any, StepId extends string = string>(): IStepConfig<T, StepId>[];
+/**
+ * Returns frequently-used meta state with shallow equality.
+ */
+declare function useWizardMeta<T = any, StepId extends string = string>(): {
+    currentStepId: "" | StepId;
+    currentStepIndex: number;
+    isFirstStep: boolean;
+    isLastStep: boolean;
+    isLoading: boolean;
+    isBusy: boolean;
+    isDirty: boolean;
+    progress: number;
+    activeStepsCount: number;
+    goToStepResult: boolean | "init" | null | undefined;
+};
+/**
+ * Returns all errors by step (shallow-equal).
+ */
+declare function useWizardAllErrors<T = any, StepId extends string = string>(): Record<StepId, Record<string, string>>;
+/**
+ * Returns flattened errors map (path -> message).
+ */
+declare function useWizardFlatErrors<T = any, StepId extends string = string>(): Record<string, string>;
 
 /**
  * Props for rendering the current step component.
@@ -91,26 +163,64 @@ interface WizardStepRendererProps {
 declare const WizardStepRenderer: React.FC<WizardStepRendererProps>;
 
 /**
- * Handle returned by components for imperative access to the wizard.
+ * Alias for useWizardContext.
  */
-interface IWizardHandle<T = unknown, StepId extends string = string> {
-    state: IWizardState<T, StepId>;
-    actions: IWizardActions<StepId>;
+declare const useWizard: <T = any, StepId extends string = string>() => IWizardContext<T, StepId>;
+
+interface CreateWizardStoreOptions<T, StepId extends string = string> {
+    config: IWizardConfig<T, StepId>;
+    initialData?: T;
+    initialStepId?: StepId;
+}
+interface WizardStoreBundle<T, StepId extends string = string> {
+    store: IWizardStore<T, StepId>;
+    actions: IWizardActionsTyped<T, StepId>;
 }
 /**
- * React-specific actions
+ * Create a standalone store + actions bundle without React Context.
  */
-interface IWizardActions<StepId extends string = string> extends IWizardActions$1<StepId> {
-}
+declare const createWizardStore: <T extends Record<string, any>, StepId extends string = string>(options: CreateWizardStoreOptions<T, StepId>) => WizardStoreBundle<T, StepId>;
 /**
- * Core Wizard Context State
+ * Hook: read the full store snapshot without React Context.
  */
-interface IWizardContext<T = unknown, StepId extends string = string> extends IWizardContext$1<T, StepId> {
-}
-
+declare const useWizardStoreState: <T, StepId extends string = string>(store: IWizardStore<T, StepId>) => IWizardState<T, StepId>;
 /**
- * Alias for useWizardContext.
+ * Hook: subscribe to a value path without React Context.
  */
-declare const useWizard: <T = any, StepId extends string = string>() => IWizardContext<T, StepId>;
+declare const useWizardStoreValue: <T, P extends Path<T>>(store: IWizardStore<T, any>, path: P, options?: {
+    isEqual?: (a: PathValue<T, P>, b: PathValue<T, P>) => boolean;
+}) => PathValue<T, P>;
+/**
+ * Hook: value + setter for a path without React Context.
+ */
+declare const useWizardStoreField: <T, P extends Path<T>>(store: IWizardStore<T, any>, setData: (path: P, value: PathValue<T, P>) => void, path: P, options?: {
+    isEqual?: (a: PathValue<T, P>, b: PathValue<T, P>) => boolean;
+}) => [PathValue<T, P>, (value: PathValue<T, P>) => void];
+/**
+ * Hook: read the first error for a path without React Context.
+ */
+declare const useWizardStoreError: (store: IWizardStore<any, any>, path: string) => string | undefined;
+/**
+ * Hook: select derived state without React Context.
+ */
+declare const useWizardStoreSelector: <TSelected>(store: IWizardStore<any, any>, selector: (state: any) => TSelected, options?: {
+    isEqual?: (a: TSelected, b: TSelected) => boolean;
+}) => TSelected;
+/**
+ * Helper: build store-bound hooks for a single store instance.
+ */
+declare const createWizardHooks: <T, StepId extends string = string>(store: IWizardStore<T, StepId>, actions?: IWizardActionsTyped<T, StepId>) => {
+    useWizardState: () => IWizardState<T, StepId>;
+    useWizardValue: <P extends Path<T>>(path: P, options?: {
+        isEqual?: (a: PathValue<T, P>, b: PathValue<T, P>) => boolean;
+    }) => PathValue<T, P>;
+    useWizardField: <P extends Path<T>>(path: P, options?: {
+        isEqual?: (a: PathValue<T, P>, b: PathValue<T, P>) => boolean;
+    }) => [PathValue<T, P>, (value: PathValue<T, P>) => void];
+    useWizardError: (path: string) => string | undefined;
+    useWizardSelector: <TSelected>(selector: (state: IWizardState<T, StepId>) => TSelected, options?: {
+        isEqual?: (a: TSelected, b: TSelected) => boolean;
+    }) => TSelected;
+};
 
-export { type IWizardHandle, WizardProvider, type WizardProviderProps, WizardStepRenderer, type WizardStepRendererProps, createWizardFactory, useWizard, useWizardActions, useWizardContext, useWizardError, useWizardSelector, useWizardState, useWizardValue };
+export { type CreateWizardStoreOptions, type IWizardActionsTyped, type IWizardHandle, WizardProvider, type WizardProviderProps, WizardStepRenderer, type WizardStepRendererProps, type WizardStoreBundle, createWizardFactory, createWizardHooks, createWizardStore, useWizard, useWizardActions, useWizardAllErrors, useWizardContext, useWizardCurrentStep, useWizardError, useWizardField, useWizardFlatErrors, useWizardMeta, useWizardSelector, useWizardState, useWizardSteps, useWizardStoreError, useWizardStoreField, useWizardStoreSelector, useWizardStoreState, useWizardStoreValue, useWizardValue };