feat: Add initial working code

.github/workflows/publish.yml

@@ -0,0 +1,26 @@
+name: Publish
+
+on:
+  workflow_dispatch:
+    inputs:
+      npm-tag:
+        description: 'NPM tag to publish the package (e.g., latest, beta, etc.)'
+        required: false
+        default: 'latest'
+        type: string
+      dry-run:
+        description: 'Perform a dry run (true/false)'
+        required: false
+        default: false
+        type: boolean
+
+jobs:
+  publish:
+    uses: WJSoftware/cicd/.github/workflows/npm-publish.yml@main
+    with:
+      node-version: 24
+      build-script: build
+      test-script: "test:ci"
+      npm-tag: ${{ inputs.npm-tag || 'latest' }}
+      dry-run: ${{ inputs.dry-run || false }}
+    secrets: inherit

.github/workflows/test.yml

@@ -0,0 +1,14 @@
+name: Test
+
+on:
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    uses: WJSoftware/cicd/.github/workflows/npm-test.yml@main
+    with:
+      node-version: 24
+      build-script: build
+      test-script: "test:ci"
+      build: false

.gitignore

@@ -1,139 +1,24 @@
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-lerna-debug.log*
-
-# Diagnostic reports (https://nodejs.org/api/report.html)
-report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
-
-# Runtime data
-pids
-*.pid
-*.seed
-*.pid.lock
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-*.lcov
-
-# nyc test coverage
-.nyc_output
-
-# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# Bower dependency directory (https://bower.io/)
-bower_components
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (https://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directories
-node_modules/
-jspm_packages/
-
-# Snowpack dependency directory (https://snowpack.dev/)
-web_modules/
-
-# TypeScript cache
-*.tsbuildinfo
-
-# Optional npm cache directory
-.npm
-
-# Optional eslint cache
-.eslintcache
-
-# Optional stylelint cache
-.stylelintcache
-
-# Optional REPL history
-.node_repl_history
-
-# Output of 'npm pack'
-*.tgz
-
-# Yarn Integrity file
-.yarn-integrity
-
-# dotenv environment variable files
+node_modules
+
+# Output
+.output
+.vercel
+.netlify
+.wrangler
+/.svelte-kit
+/build
+/dist
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Env
 .env
 .env.*
 !.env.example
+!.env.test
 
-# parcel-bundler cache (https://parceljs.org/)
-.cache
-.parcel-cache
-
-# Next.js build output
-.next
-out
-
-# Nuxt.js build / generate output
-.nuxt
-dist
-
-# Gatsby files
-.cache/
-# Comment in the public line in if your project uses Gatsby and not Next.js
-# https://nextjs.org/blog/next-9-1#public-directory-support
-# public
-
-# vuepress build output
-.vuepress/dist
-
-# vuepress v2.x temp and cache directory
-.temp
-.cache
-
-# Sveltekit cache directory
-.svelte-kit/
-
-# vitepress build output
-**/.vitepress/dist
-
-# vitepress cache directory
-**/.vitepress/cache
-
-# Docusaurus cache and generated files
-.docusaurus
-
-# Serverless directories
-.serverless/
-
-# FuseBox cache
-.fusebox/
-
-# DynamoDB Local files
-.dynamodb/
-
-# Firebase cache directory
-.firebase/
-
-# TernJS port file
-.tern-port
-
-# Stores VSCode versions used for testing VSCode extensions
-.vscode-test
-
-# yarn v3
-.pnp.*
-.yarn/*
-!.yarn/patches
-!.yarn/plugins
-!.yarn/releases
-!.yarn/sdks
-!.yarn/versions
-
-# Vite logs files
+# Vite
 vite.config.js.timestamp-*
 vite.config.ts.timestamp-*

.npmrc

@@ -0,0 +1 @@
+engine-strict=true

README.md

@@ -1,2 +1,48 @@
-# wjfe-n-savant-sk
-The official extension package of @wjfe/n-savant for Sveltekit
+# @wjfe/n-savant-sk
+
+> Hash router for Sveltekit projects
+
+This is an extension package of the [@wjfe/n-savant](https://github.com/WJSoftware/wjfe-n-savant) SPA router, and enables the use of the router in hash mode in Sveltekit projects.
+
+## Why Would I Need This?
+
+Sveltekit has an excellent file-based router.  You should always stick to the built-in router for routing your application.  However, as with every other router in existence, you can only do path routing or hash routing, but not both.
+
+The `@wjfe/n-savant` router was born to break this barrier:  This SPA router can do path and hash routing simultaneously.  However, this is a router for SPA's and PWA's that render on the client.  It was not designed for SSR scenarios.  After all, Sveltekit has routing capabilities included.
+
+But what if you wanted to do hash routing on top of Sveltekit's path routing?  You can, with this router extension.
+
+### Useful Scenarios
+
+1. You could show a complex dialog box that is driven by hash routing.
+2. You could mount a micro-frontend that routes with a path in the hash.
+
+## Quickstart
+
+1. Install the package
+    ```bash
+    npm install @wjfe/n-savant-sk # This also installs the @wjfe/n-savant main package
+    ```
+2. Initialize the library.  Ideally, in the root `+layout.svelte` component:
+    ```svelte
+    <script lang="ts">
+        import { init } from "@wjfe/n-savant-sk";
+
+        init(/* options */);
+    </script>
+    ```
+3. Add routers, routes and links for hash navigation as you please.
+
+> **⚡ Attention!**
+> 
+> Early testing has revealed what may or may not be a bug in Svelte or Sveltekit.  The situation:  Just importing `init` from `@wjfe/n-savant-sk` triggers error `rune_outside_svelte` on the `trace.svelte.js` file in the `@wjfe/n-savant` package.  To overcome this, just add `{ ssr: { noExternal: ["@wjfe/n-savant", "@wjfe/n-savant-sk"] }}` to Vite's configuration.
+>
+> Hopefully, I'll be able to figure more about this problem in the coming weeks.
+
+## Limitations
+
+1. Path routing is disallowed.
+
+---
+
+Generally speaking, you need to understand the `@wjfe/n-savant` router, so have handy its [online documentation](https://wjfe-n-savant.hashnode.space/).

demo/.gitignore

@@ -0,0 +1,23 @@
+node_modules
+
+# Output
+.output
+.vercel
+.netlify
+.wrangler
+/.svelte-kit
+/build
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Env
+.env
+.env.*
+!.env.example
+!.env.test
+
+# Vite
+vite.config.js.timestamp-*
+vite.config.ts.timestamp-*

demo/.npmrc

@@ -0,0 +1 @@
+engine-strict=true

demo/README.md

@@ -0,0 +1,38 @@
+# sv
+
+Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli).
+
+## Creating a project
+
+If you're seeing this, you've probably already done this step. Congrats!
+
+```sh
+# create a new project in the current directory
+npx sv create
+
+# create a new project in my-app
+npx sv create my-app
+```
+
+## Developing
+
+Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
+
+```sh
+npm run dev
+
+# or start the server and open the app in a new browser tab
+npm run dev -- --open
+```
+
+## Building
+
+To create a production version of your app:
+
+```sh
+npm run build
+```
+
+You can preview the production build with `npm run preview`.
+
+> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment.