ontheway-sdk 0.1.0

package/dist/react.d.ts

@@ -0,0 +1,68 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+import { OnTheWay } from './index.js';
+
+/** Context value exposed by the OnTheWay provider */
+interface OnTheWayContextValue {
+    /** SDK instance, null before initialisation */
+    otw: OnTheWay | null;
+    /** Whether the SDK has finished loading */
+    ready: boolean;
+    /** Start a tour by slug or ID */
+    start: (slugOrId: string) => void;
+    /** Reset a specific task */
+    reset: (slugOrId: string) => void;
+    /** Reset all tasks */
+    resetAll: () => void;
+    /**
+     * Register a condition function for conditional triggers.
+     * The function is evaluated during auto-start when the task trigger is `'condition'`.
+     */
+    registerCondition: (slug: string, fn: () => boolean) => void;
+    /**
+     * Re-evaluate conditions and start eligible tours.
+     * Call after state changes that might satisfy a condition.
+     */
+    checkConditions: () => void;
+    /** Check whether a given task has been completed */
+    isTaskCompleted: (slugOrId: string) => boolean;
+}
+/** Props for the OnTheWayProvider component */
+interface OnTheWayProviderProps {
+    projectId: string;
+    apiUrl?: string;
+    onComplete?: (taskId: string) => void;
+    onSkip?: (taskId: string, stepIndex: number) => void;
+    children: ReactNode;
+}
+/**
+ * Provides the OnTheWay SDK to descendant components.
+ *
+ * Wrap your application (or a subtree) with this provider so that
+ * `useOnTheWay()` returns the SDK instance.
+ *
+ * On mount the provider also checks for any pending cross-page tour
+ * (persisted in `sessionStorage`) and resumes it automatically.
+ *
+ * @example
+ * ```tsx
+ * <OnTheWayProvider projectId="proj_abc">
+ *   <App />
+ * </OnTheWayProvider>
+ * ```
+ */
+declare function OnTheWayProvider({ projectId, apiUrl, onComplete, onSkip, children, }: OnTheWayProviderProps): react_jsx_runtime.JSX.Element;
+/**
+ * Access the OnTheWay SDK from any component wrapped by `<OnTheWayProvider>`.
+ *
+ * @example
+ * ```tsx
+ * function HelpButton() {
+ *   const { start } = useOnTheWay()
+ *   return <button onClick={() => start('welcome')}>Help</button>
+ * }
+ * ```
+ */
+declare function useOnTheWay(): OnTheWayContextValue;
+
+export { type OnTheWayContextValue, OnTheWayProvider, type OnTheWayProviderProps, useOnTheWay };

package/dist/react.js

@@ -0,0 +1,5 @@
+export { OnTheWayProvider, useOnTheWay } from './chunk-RNQLNLNI.js';
+import './chunk-OKJ5GEH3.js';
+import './chunk-DDAAVRWG.js';
+//# sourceMappingURL=react.js.map
+//# sourceMappingURL=react.js.map

package/dist/react.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"react.js"}

package/package.json

@@ -0,0 +1,93 @@
+{
+  "name": "ontheway-sdk",
+  "version": "0.1.0",
+  "description": "Lightweight onboarding SDK based on Driver.js",
+  "license": "MIT",
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./react": {
+      "import": {
+        "types": "./dist/react.d.ts",
+        "default": "./dist/react.js"
+      },
+      "require": {
+        "types": "./dist/react.d.cts",
+        "default": "./dist/react.cjs"
+      }
+    },
+    "./components": {
+      "import": {
+        "types": "./dist/components.d.ts",
+        "default": "./dist/components.js"
+      },
+      "require": {
+        "types": "./dist/components.d.cts",
+        "default": "./dist/components.cjs"
+      }
+    },
+    "./checklist": {
+      "import": {
+        "types": "./dist/checklist.d.ts",
+        "default": "./dist/checklist.js"
+      },
+      "require": {
+        "types": "./dist/checklist.d.cts",
+        "default": "./dist/checklist.cjs"
+      }
+    },
+    "./devtools": {
+      "import": {
+        "types": "./dist/devtools.d.ts",
+        "default": "./dist/devtools.js"
+      },
+      "require": {
+        "types": "./dist/devtools.d.cts",
+        "default": "./dist/devtools.cjs"
+      }
+    }
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit"
+  },
+  "peerDependencies": {
+    "driver.js": "^1.3.0",
+    "react": ">=18.0.0",
+    "react-dom": ">=18.0.0"
+  },
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    },
+    "react-dom": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "driver.js": "^1.3.1",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "@types/react": "^19.0.0",
+    "@types/react-dom": "^19.0.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.7.0"
+  }
+}