@smart-wizard/extension-url-hash 0.0.0-stage → 1.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Dipu Rajendran
+
+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/README.md

@@ -1,3 +1,41 @@
-# Temporary Holding Version
+# @smart-wizard/extension-url-hash
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+**Official URL hash and browser history navigation extension for SmartWizard.**  
+Synchronizes active steps with `window.location.hash` and integrates with browser back/forward buttons.
+
+> This package is part of the **[SmartWizard](https://github.com/techlab/smart-wizard)** project, the next-generation continuation of the popular jQuery SmartWizard.
+
+---
+
+## 📖 Documentation & Links
+
+* 📚 **Full Documentation & Guides**: [GitHub Readme](https://github.com/techlab/smart-wizard#-extension-system)
+* 🌐 **Official Website & Demos**: [techlaboratory.net/smart-wizard](https://techlaboratory.net/smart-wizard)
+* 🐙 **Repository**: [github.com/techlab/smart-wizard](https://github.com/techlab/smart-wizard)
+* 🐛 **Issue Tracker**: [github.com/techlab/smart-wizard/issues](https://github.com/techlab/smart-wizard/issues)
+
+---
+
+## 📥 Installation
+
+```bash
+npm install @smart-wizard/extension-url-hash @smart-wizard/core
+```
+
+---
+
+## ⚡ Quick Example
+
+```typescript
+import { SmartWizard } from '@smart-wizard/core';
+import { createUrlHashExtension } from '@smart-wizard/extension-url-hash';
+
+const wizard = new SmartWizard('#wizard', options)
+  .extend(createUrlHashExtension({ supportHistory: true })); // pushState vs location.hash
+```
+
+---
+
+## 📝 License
+
+Dual-licensed under [MIT](https://github.com/techlab/smart-wizard/blob/main/LICENSE) (open-source) and [Commercial License](https://techlaboratory.net/smart-wizard#license).

package/dist/index.d.mts

@@ -0,0 +1,29 @@
+import { WizardExtension } from '@smart-wizard/core';
+
+interface UrlHashOptions {
+    /**
+     * Push step changes to browser history so back/forward buttons work.
+     * Set to `false` to use `location.hash` (replaces history instead).
+     * @default true
+     */
+    supportHistory?: boolean;
+}
+/**
+ * URL Hash Extension for SmartWizard.
+ *
+ * - Reads `window.location.hash` on load and navigates to the matching step.
+ * - Updates the URL hash after every step change.
+ * - Listens to `hashchange` so the browser back/forward buttons work.
+ *
+ * @example
+ * ```ts
+ * import { SmartWizard } from '@smart-wizard/core';
+ * import { createUrlHashExtension } from '@smart-wizard/extension-url-hash';
+ *
+ * const wizard = new SmartWizard('#wizard', options)
+ *   .extend(createUrlHashExtension({ supportHistory: true }));
+ * ```
+ */
+declare function createUrlHashExtension(options?: UrlHashOptions): WizardExtension;
+
+export { type UrlHashOptions, createUrlHashExtension };

package/dist/index.d.ts

@@ -0,0 +1,29 @@
+import { WizardExtension } from '@smart-wizard/core';
+
+interface UrlHashOptions {
+    /**
+     * Push step changes to browser history so back/forward buttons work.
+     * Set to `false` to use `location.hash` (replaces history instead).
+     * @default true
+     */
+    supportHistory?: boolean;
+}
+/**
+ * URL Hash Extension for SmartWizard.
+ *
+ * - Reads `window.location.hash` on load and navigates to the matching step.
+ * - Updates the URL hash after every step change.
+ * - Listens to `hashchange` so the browser back/forward buttons work.
+ *
+ * @example
+ * ```ts
+ * import { SmartWizard } from '@smart-wizard/core';
+ * import { createUrlHashExtension } from '@smart-wizard/extension-url-hash';
+ *
+ * const wizard = new SmartWizard('#wizard', options)
+ *   .extend(createUrlHashExtension({ supportHistory: true }));
+ * ```
+ */
+declare function createUrlHashExtension(options?: UrlHashOptions): WizardExtension;
+
+export { type UrlHashOptions, createUrlHashExtension };

package/dist/index.js

@@ -0,0 +1,81 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  createUrlHashExtension: () => createUrlHashExtension
+});
+module.exports = __toCommonJS(index_exports);
+function createUrlHashExtension(options = {}) {
+  const { supportHistory = true } = options;
+  let hashChangeHandler = null;
+  function findStepByHash(wizard, hash) {
+    for (let i = 0; i < wizard.stepItems.length; i++) {
+      if (wizard.stepItems[i].step.getAttribute("href") === hash) return i;
+    }
+    return null;
+  }
+  function updateUrl(wizard, stepIdx) {
+    const href = wizard.stepItems[stepIdx]?.step.getAttribute("href");
+    if (!href) return;
+    if (supportHistory && window.history?.pushState) {
+      window.history.pushState(null, "", href);
+    } else {
+      window.location.replace(
+        window.location.pathname + window.location.search + href
+      );
+    }
+  }
+  return {
+    name: "url-hash",
+    onLoad(wizard) {
+      const hash = window.location.hash;
+      if (hash) {
+        const idx = findStepByHash(wizard, hash);
+        if (idx !== null && idx !== wizard.activeIndex) {
+          wizard.goTo(idx);
+        }
+      }
+      if (hashChangeHandler) return;
+      hashChangeHandler = () => {
+        const h = window.location.hash;
+        if (!h) return;
+        const i = findStepByHash(wizard, h);
+        if (i !== null && i !== wizard.activeIndex) {
+          wizard.goTo(i);
+        }
+      };
+      window.addEventListener("hashchange", hashChangeHandler);
+    },
+    onAfterShow(wizard, { stepIdx }) {
+      updateUrl(wizard, stepIdx);
+    },
+    onDestroy() {
+      if (hashChangeHandler) {
+        window.removeEventListener("hashchange", hashChangeHandler);
+        hashChangeHandler = null;
+      }
+    }
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createUrlHashExtension
+});

package/dist/index.mjs

@@ -0,0 +1,56 @@
+// src/index.ts
+function createUrlHashExtension(options = {}) {
+  const { supportHistory = true } = options;
+  let hashChangeHandler = null;
+  function findStepByHash(wizard, hash) {
+    for (let i = 0; i < wizard.stepItems.length; i++) {
+      if (wizard.stepItems[i].step.getAttribute("href") === hash) return i;
+    }
+    return null;
+  }
+  function updateUrl(wizard, stepIdx) {
+    const href = wizard.stepItems[stepIdx]?.step.getAttribute("href");
+    if (!href) return;
+    if (supportHistory && window.history?.pushState) {
+      window.history.pushState(null, "", href);
+    } else {
+      window.location.replace(
+        window.location.pathname + window.location.search + href
+      );
+    }
+  }
+  return {
+    name: "url-hash",
+    onLoad(wizard) {
+      const hash = window.location.hash;
+      if (hash) {
+        const idx = findStepByHash(wizard, hash);
+        if (idx !== null && idx !== wizard.activeIndex) {
+          wizard.goTo(idx);
+        }
+      }
+      if (hashChangeHandler) return;
+      hashChangeHandler = () => {
+        const h = window.location.hash;
+        if (!h) return;
+        const i = findStepByHash(wizard, h);
+        if (i !== null && i !== wizard.activeIndex) {
+          wizard.goTo(i);
+        }
+      };
+      window.addEventListener("hashchange", hashChangeHandler);
+    },
+    onAfterShow(wizard, { stepIdx }) {
+      updateUrl(wizard, stepIdx);
+    },
+    onDestroy() {
+      if (hashChangeHandler) {
+        window.removeEventListener("hashchange", hashChangeHandler);
+        hashChangeHandler = null;
+      }
+    }
+  };
+}
+export {
+  createUrlHashExtension
+};

package/package.json

@@ -1,6 +1,57 @@
 {
   "name": "@smart-wizard/extension-url-hash",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "1.0.1",
+  "description": "URL hash + browser history navigation extension for SmartWizard",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "keywords": [
+    "extension",
+    "history",
+    "smartwizard",
+    "url-hash",
+    "wizard"
+  ],
+  "license": "MIT",
+  "peerDependencies": {
+    "@smart-wizard/core": ">=1.0.1"
+  },
+  "devDependencies": {
+    "tsup": "^8.0.0",
+    "typescript": "^5.0.0",
+    "@smart-wizard/core": "1.0.1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/techlab/smart-wizard.git",
+    "directory": "packages/extensions/url-hash"
+  },
+  "homepage": "https://github.com/techlab/smart-wizard#readme",
+  "bugs": {
+    "url": "https://github.com/techlab/smart-wizard/issues"
+  },
+  "author": {
+    "name": "Dipu Rajendran",
+    "email": "hello.techlab@gmail.com",
+    "url": "https://github.com/techlab"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts --external @smart-wizard/core",
+    "dev": "tsup src/index.ts --format cjs,esm --dts --watch --external @smart-wizard/core"
+  }
 }