@real-router/hash-plugin 0.2.11 → 0.2.12

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@real-router/hash-plugin",
-  "version": "0.2.11",
+  "version": "0.2.12",
   "type": "commonjs",
   "description": "Hash-based routing plugin for Real-Router",
   "main": "./dist/cjs/index.js",
@@ -18,8 +18,7 @@
     }
   },
   "files": [
-    "dist",
-    "src"
+    "dist"
   ],
   "repository": {
     "type": "git",
@@ -43,7 +42,7 @@
   },
   "sideEffects": false,
   "dependencies": {
-    "@real-router/core": "^0.45.0"
+    "@real-router/core": "^0.45.1"
   },
   "devDependencies": {
     "@testing-library/jest-dom": "6.9.1",
@@ -57,7 +56,7 @@
     "build": "tsdown --config-loader unrun",
     "type-check": "tsc --noEmit",
     "lint": "eslint --cache --ext .ts src/ tests/ --fix --max-warnings 0",
-    "lint:package": "publint",
+    "lint:package": "bash ../../scripts/publint-filter.sh",
     "lint:types": "attw --pack .",
     "build:dist-only": "tsdown --config-loader unrun"
   }

package/src/constants.ts

@@ -1,16 +0,0 @@
-// packages/hash-plugin/src/constants.ts
-
-import type { HashPluginOptions } from "./types";
-
-export const defaultOptions: Required<HashPluginOptions> = {
-  hashPrefix: "",
-  base: "",
-  forceDeactivate: true,
-};
-
-/**
- * Source identifier for transitions triggered by browser events.
- */
-export const source = "popstate";
-
-export const LOGGER_CONTEXT = "hash-plugin";

package/src/factory.ts

@@ -1,59 +0,0 @@
-import { getPluginApi } from "@real-router/core/api";
-import {
-  createSafeBrowser,
-  normalizeBase,
-  safelyEncodePath,
-} from "browser-env";
-
-import { defaultOptions, source } from "./constants";
-import { createHashPrefixRegex, extractHashPath } from "./hash-utils";
-import { HashPlugin } from "./plugin";
-import { validateOptions } from "./validation";
-
-import type { HashPluginOptions } from "./types";
-import type { PluginFactory, Router } from "@real-router/core";
-import type { Browser, SharedFactoryState } from "browser-env";
-
-export function hashPluginFactory(
-  opts?: Partial<HashPluginOptions>,
-  browser?: Browser,
-): PluginFactory {
-  validateOptions(opts);
-
-  const options: Required<HashPluginOptions> = { ...defaultOptions, ...opts };
-
-  options.base = normalizeBase(options.base);
-
-  const prefixRegex = createHashPrefixRegex(options.hashPrefix);
-  const resolvedBrowser =
-    browser ??
-    createSafeBrowser(
-      () =>
-        safelyEncodePath(
-          extractHashPath(globalThis.location.hash, prefixRegex),
-        ) + globalThis.location.search,
-      "hash-plugin",
-    );
-
-  const transitionOptions = {
-    forceDeactivate: options.forceDeactivate,
-    source,
-    replace: true as const,
-  };
-
-  const shared: SharedFactoryState = { removePopStateListener: undefined };
-
-  return function hashPlugin(routerBase) {
-    const plugin = new HashPlugin(
-      routerBase as Router,
-      getPluginApi(routerBase),
-      options,
-      resolvedBrowser,
-      prefixRegex,
-      transitionOptions,
-      shared,
-    );
-
-    return plugin.getPlugin();
-  };
-}

package/src/hash-utils.ts

@@ -1,44 +0,0 @@
-// packages/hash-plugin/src/hash-utils.ts
-
-import { safeParseUrl } from "browser-env";
-
-import { LOGGER_CONTEXT } from "./constants";
-
-function escapeRegExp(str: string): string {
-  return str.replaceAll(/[$()*+.?[\\\]^{|}-]/g, String.raw`\$&`);
-}
-
-export function createHashPrefixRegex(hashPrefix: string): RegExp | null {
-  if (!hashPrefix) {
-    return null;
-  }
-
-  return new RegExp(`^#${escapeRegExp(hashPrefix)}`);
-}
-
-/**
- * Extract path from URL hash, stripping hash prefix.
- *
- * @param hash - URL hash (e.g., "#/path" or "#!/path")
- * @param prefixRegex - Pre-compiled regex for prefix stripping (null if no prefix)
- * @returns Extracted path (e.g., "/path")
- */
-export function extractHashPath(
-  hash: string,
-  prefixRegex: RegExp | null,
-): string {
-  const path = prefixRegex ? hash.replace(prefixRegex, "") : hash.slice(1);
-
-  return path || "/";
-}
-
-export function hashUrlToPath(
-  url: string,
-  prefixRegex: RegExp | null,
-): string | null {
-  const parsedUrl = safeParseUrl(url, LOGGER_CONTEXT);
-
-  return parsedUrl
-    ? extractHashPath(parsedUrl.hash, prefixRegex) + parsedUrl.search
-    : null;
-}

package/src/index.ts

@@ -1,48 +0,0 @@
-// packages/hash-plugin/src/index.ts
-/* eslint-disable @typescript-eslint/method-signature-style -- method syntax required for declaration merging overload (property syntax causes TS2717) */
-// Public API exports for hash-plugin
-
-import type { Params, State } from "@real-router/core";
-
-// Main plugin factory
-export { hashPluginFactory } from "./factory";
-
-// Types
-export type { HashPluginOptions } from "./types";
-
-export type { Browser } from "browser-env";
-
-// Type guards
-export { isStateStrict as isState } from "type-guards";
-
-/**
- * Module augmentation for real-router.
- * Extends Router interface with hash plugin methods.
- */
-declare module "@real-router/core" {
-  interface Router {
-    /**
-     * Builds full URL for a route with base path and hash prefix.
-     * Added by hash plugin.
-     */
-    buildUrl: (name: string, params?: Params) => string;
-
-    /**
-     * Matches URL and returns corresponding state.
-     * Added by hash plugin.
-     */
-    matchUrl: (url: string) => State | undefined;
-
-    /**
-     * Replaces current history state without triggering navigation.
-     * Added by hash plugin.
-     */
-    replaceHistoryState: (
-      name: string,
-      params?: Params,
-      title?: string,
-    ) => void;
-
-    start(path?: string): Promise<State>;
-  }
-}

package/src/plugin.ts

@@ -1,110 +0,0 @@
-import {
-  createPopstateHandler,
-  createPopstateLifecycle,
-  createStartInterceptor,
-  createReplaceHistoryState,
-  shouldReplaceHistory,
-  updateBrowserState,
-} from "browser-env";
-
-import { hashUrlToPath } from "./hash-utils";
-
-import type { HashPluginOptions } from "./types";
-import type {
-  NavigationOptions,
-  Params,
-  Router,
-  State,
-  Plugin,
-} from "@real-router/core";
-import type { PluginApi } from "@real-router/core/api";
-import type { Browser, SharedFactoryState } from "browser-env";
-
-export class HashPlugin {
-  readonly #router: Router;
-  readonly #browser: Browser;
-  readonly #removeStartInterceptor: () => void;
-  readonly #removeExtensions: () => void;
-  readonly #lifecycle: Pick<Plugin, "onStart" | "onStop" | "teardown">;
-
-  constructor(
-    router: Router,
-    api: PluginApi,
-    options: Required<HashPluginOptions>,
-    browser: Browser,
-    prefixRegex: RegExp | null,
-    transitionOptions: {
-      source: string;
-      replace: true;
-      forceDeactivate?: boolean;
-    },
-    shared: SharedFactoryState,
-  ) {
-    this.#router = router;
-    this.#browser = browser;
-
-    this.#removeStartInterceptor = createStartInterceptor(api, browser);
-
-    const urlPrefix = `${options.base}#${options.hashPrefix}`;
-    const pluginBuildUrl = (route: string, params?: Params) =>
-      urlPrefix + router.buildPath(route, params);
-
-    this.#removeExtensions = api.extendRouter({
-      buildUrl: pluginBuildUrl,
-      matchUrl: (url: string) => {
-        const path = hashUrlToPath(url, prefixRegex);
-
-        return path ? api.matchPath(path) : undefined;
-      },
-      replaceHistoryState: createReplaceHistoryState(
-        api,
-        router,
-        browser,
-        pluginBuildUrl,
-      ),
-    });
-
-    const handler = createPopstateHandler({
-      router,
-      api,
-      browser,
-      allowNotFound: api.getOptions().allowNotFound,
-      transitionOptions,
-      loggerContext: "hash-plugin",
-      buildUrl: (name: string, params?: Params) =>
-        router.buildUrl(name, params),
-    });
-
-    this.#lifecycle = createPopstateLifecycle({
-      browser,
-      shared,
-      handler,
-      cleanup: () => {
-        this.#removeStartInterceptor();
-        this.#removeExtensions();
-      },
-    });
-  }
-
-  getPlugin(): Plugin {
-    return {
-      ...this.#lifecycle,
-
-      onTransitionSuccess: (
-        toState: State,
-        fromState: State | undefined,
-        navOptions: NavigationOptions,
-      ) => {
-        const replaceHistory = shouldReplaceHistory(
-          navOptions,
-          toState,
-          fromState,
-        );
-
-        const url = this.#router.buildUrl(toState.name, toState.params);
-
-        updateBrowserState(toState, url, replaceHistory, this.#browser);
-      },
-    };
-  }
-}

package/src/types.ts

@@ -1,28 +0,0 @@
-// packages/hash-plugin/src/types.ts
-
-/**
- * Hash-based routing plugin configuration.
- * Uses URL hash fragment for navigation (e.g., example.com/#/path).
- */
-export interface HashPluginOptions {
-  /**
-   * Prefix for hash (e.g., "!" for "#!/path").
-   *
-   * @default ""
-   */
-  hashPrefix?: string;
-
-  /**
-   * Base path prepended before hash (e.g., "/app" → "/app#/path").
-   *
-   * @default ""
-   */
-  base?: string;
-
-  /**
-   * Force deactivation of current route even if canDeactivate returns false.
-   *
-   * @default true
-   */
-  forceDeactivate?: boolean;
-}

package/src/validation.ts

@@ -1,10 +0,0 @@
-import { createOptionsValidator } from "browser-env";
-
-import { LOGGER_CONTEXT, defaultOptions } from "./constants";
-
-import type { HashPluginOptions } from "./types";
-
-export const validateOptions = createOptionsValidator<HashPluginOptions>(
-  defaultOptions,
-  LOGGER_CONTEXT,
-);