@daltonr/pathwrite-solid 0.13.1 → 0.14.1

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2026 Devjoy Ltd.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

package/dist/index.css

@@ -53,7 +53,12 @@
   flex-direction: column;
   gap: var(--pw-shell-gap);
   padding: var(--pw-shell-padding);
-  font-family: system-ui, -apple-system, "Segoe UI", Roboto, sans-serif;
+  font-family:
+    system-ui,
+    -apple-system,
+    "Segoe UI",
+    Roboto,
+    sans-serif;
   color: var(--pw-color-text);
 }
 
@@ -397,7 +402,9 @@
   border-radius: var(--pw-btn-radius);
   cursor: pointer;
   font-size: 14px;
-  transition: background 0.15s ease, border-color 0.15s ease;
+  transition:
+    background 0.15s ease,
+    border-color 0.15s ease;
 }
 
 .pw-shell__btn:hover:not(:disabled) {
@@ -422,7 +429,9 @@
 }
 
 @keyframes pw-spin {
-  to { transform: rotate(360deg); }
+  to {
+    transform: rotate(360deg);
+  }
 }
 
 .pw-shell__btn--next.pw-shell__btn--loading {
@@ -515,4 +524,3 @@
 .pw-shell__btn--suspend:hover:not(:disabled) {
   background: var(--pw-color-primary-light);
 }
-

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { type Component, type JSX, type Accessor } from "solid-js";
 import { PathData, PathDefinition, PathEngine, PathEvent, PathSnapshot, ProgressLayout } from "@daltonr/pathwrite-core";
-export interface UsePathOptions {
+export interface UsePathOptions<TData extends PathData = PathData> {
     /**
      * An externally-managed `PathEngine` to subscribe to — for example, the engine
      * returned by `restoreOrStart()` from `@daltonr/pathwrite-store`.
@@ -17,9 +17,9 @@ export interface UsePathOptions {
      * async `restoreOrStart()`) or is swapped is adopted — the hook
      * re-subscribes and re-seeds its snapshot from the new engine.
      */
-    engine?: PathEngine | Accessor<PathEngine | undefined>;
+    engine?: PathEngine<TData> | Accessor<PathEngine<TData> | undefined>;
     /** Called for every engine event (stateChanged, completed, cancelled, resumed). */
-    onEvent?: (event: PathEvent) => void;
+    onEvent?: (event: PathEvent<TData>) => void;
 }
 export interface UsePathReturn<TData extends PathData = PathData> {
     /**
@@ -28,9 +28,9 @@ export interface UsePathReturn<TData extends PathData = PathData> {
      */
     snapshot: Accessor<PathSnapshot<TData> | null>;
     /** Start (or restart) a path. */
-    start: (path: PathDefinition<any>, initialData?: PathData) => Promise<void>;
-    /** Push a sub-path onto the stack. Requires an active path. Pass an optional `meta` object for correlation — it is returned unchanged to the parent step's `onSubPathComplete` / `onSubPathCancel` hooks. */
-    startSubPath: (path: PathDefinition<any>, initialData?: PathData, meta?: Record<string, unknown>) => Promise<void>;
+    start: (path: PathDefinition<TData>, initialData?: Partial<TData>) => Promise<void>;
+    /** Push a sub-path onto the stack. Requires an active path. A sub-path has its own data, so any definition is accepted. Pass an optional `meta` object for correlation — it is returned unchanged to the parent step's `onSubPathComplete` / `onSubPathCancel` hooks. */
+    startSubPath: (path: PathDefinition, initialData?: PathData, meta?: Record<string, unknown>) => Promise<void>;
     /** Advance one step. Completes the path on the last step. */
     next: () => Promise<void>;
     /** Go back one step. No-op when already on the first step of a top-level path. Pops back to the parent path when on the first step of a sub-path. */
@@ -63,7 +63,7 @@ export interface UsePathReturn<TData extends PathData = PathData> {
     /** Trigger inline validation on all steps without navigating. Sets `snapshot().hasValidated`. */
     validate: () => void;
 }
-export declare function usePath<TData extends PathData = PathData>(options?: UsePathOptions): UsePathReturn<TData>;
+export declare function usePath<TData extends PathData = PathData>(options?: UsePathOptions<TData>): UsePathReturn<TData>;
 /**
  * Access the nearest `PathShell`'s path instance and optional services object.
  * Throws if used outside of a PathShell component.
@@ -92,7 +92,8 @@ export interface PathShellActions {
     suspend: () => Promise<void>;
 }
 export interface PathShellProps {
-    path: PathDefinition<any>;
+    /** The path to run. The shell is not typed over the path's data, so a definition of any data type is accepted. */
+    path: PathDefinition;
     /**
      * An externally-managed engine — for example, the engine returned by
      * `restoreOrStart()` from `@daltonr/pathwrite-store`. When supplied, `PathShell` will skip its own
@@ -175,5 +176,5 @@ export interface PathShellProps {
     completionContent?: (snapshot: PathSnapshot) => JSX.Element;
 }
 export declare const PathShell: Component<PathShellProps>;
-export type { PathData, FieldErrors, PathDefinition, PathEvent, PathSnapshot, PathStep, PathStepContext, ProgressLayout, RootProgress, SerializedPathState, } from "@daltonr/pathwrite-core";
+export type { PathData, FieldErrors, PathDefinition, PathEvent, PathSnapshot, StepStatus, PathStep, PathStepContext, ProgressLayout, RootProgress, SerializedPathState, } from "@daltonr/pathwrite-core";
 export { PathEngine } from "@daltonr/pathwrite-core";