@real-router/memory-plugin 0.1.1 → 0.1.3

package/dist/cjs/index.d.ts

@@ -17,7 +17,7 @@ declare module "@real-router/core" {
     canGoBack: () => boolean;
     canGoForward: () => boolean;
   }
-}
+} //# sourceMappingURL=index.d.ts.map
 //#endregion
 export { type MemoryPluginOptions, memoryPluginFactory };
 //# sourceMappingURL=index.d.ts.map

package/dist/cjs/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../../src/types.ts","../../src/factory.ts","../../src/index.ts"],"mappings":";;;UAEiB,mBAAA;EACf,gBAAA;AAAA;;;iBCIc,mBAAA,CACd,OAAA,GAAS,mBAAA,GACR,aAAA;;;;YCJS,MAAA;IACR,IAAA;IACA,OAAA;IACA,EAAA,GAAK,KAAA;IACL,SAAA;IACA,YAAA;EAAA;AAAA"}

package/dist/esm/index.d.mts

@@ -17,7 +17,7 @@ declare module "@real-router/core" {
     canGoBack: () => boolean;
     canGoForward: () => boolean;
   }
-}
+} //# sourceMappingURL=index.d.ts.map
 //#endregion
 export { type MemoryPluginOptions, memoryPluginFactory };
 //# sourceMappingURL=index.d.mts.map

package/dist/esm/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../../src/types.ts","../../src/factory.ts","../../src/index.ts"],"mappings":";;;UAEiB,mBAAA;EACf,gBAAA;AAAA;;;iBCIc,mBAAA,CACd,OAAA,GAAS,mBAAA,GACR,aAAA;;;;YCJS,MAAA;IACR,IAAA;IACA,OAAA;IACA,EAAA,GAAK,KAAA;IACL,SAAA;IACA,YAAA;EAAA;AAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@real-router/memory-plugin",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "type": "commonjs",
   "description": "In-memory history engine for Real-Router — non-browser environments and benchmarks",
   "main": "./dist/cjs/index.js",
@@ -8,7 +8,6 @@
   "types": "./dist/esm/index.d.mts",
   "exports": {
     ".": {
-      "development": "./src/index.ts",
       "types": {
         "import": "./dist/esm/index.d.mts",
         "require": "./dist/cjs/index.d.ts"
@@ -18,7 +17,8 @@
     }
   },
   "files": [
-    "dist"
+    "dist",
+    "src"
   ],
   "repository": {
     "type": "git",
@@ -44,7 +44,7 @@
   "homepage": "https://github.com/greydragon888/real-router",
   "sideEffects": false,
   "dependencies": {
-    "@real-router/core": "^0.45.1"
+    "@real-router/core": "^0.46.0"
   },
   "scripts": {
     "test": "vitest",
@@ -52,7 +52,7 @@
     "build": "tsdown --config-loader unrun",
     "type-check": "tsc --noEmit",
     "lint": "eslint --cache --ext .ts src/ tests/ --fix --max-warnings 0",
-    "lint:package": "bash ../../scripts/publint-filter.sh",
+    "lint:package": "publint",
     "lint:types": "attw --pack .",
     "build:dist-only": "tsdown --config-loader unrun"
   }

package/src/factory.ts

@@ -0,0 +1,29 @@
+import { getPluginApi } from "@real-router/core/api";
+
+import { MemoryPlugin } from "./plugin";
+
+import type { MemoryPluginOptions } from "./types";
+import type { PluginFactory, Plugin, Router } from "@real-router/core";
+
+export function memoryPluginFactory(
+  options: MemoryPluginOptions = {},
+): PluginFactory {
+  if (
+    options.maxHistoryLength !== undefined &&
+    (typeof options.maxHistoryLength !== "number" ||
+      options.maxHistoryLength < 0)
+  ) {
+    throw new TypeError(
+      `[memory-plugin] Invalid maxHistoryLength: expected non-negative number, got ${String(options.maxHistoryLength)}.`,
+    );
+  }
+
+  const frozenOptions: MemoryPluginOptions = Object.freeze({ ...options });
+
+  return (router): Plugin => {
+    const api = getPluginApi(router);
+    const plugin = new MemoryPlugin(router as Router, api, frozenOptions);
+
+    return plugin.getPlugin();
+  };
+}

package/src/index.ts

@@ -0,0 +1,13 @@
+export { memoryPluginFactory } from "./factory";
+
+export type { MemoryPluginOptions } from "./types";
+
+declare module "@real-router/core" {
+  interface Router {
+    back: () => void;
+    forward: () => void;
+    go: (delta: number) => void;
+    canGoBack: () => boolean;
+    canGoForward: () => boolean;
+  }
+}

package/src/plugin.ts

@@ -0,0 +1,128 @@
+import type { HistoryEntry, MemoryPluginOptions } from "./types";
+import type {
+  NavigationOptions,
+  Plugin,
+  Router,
+  State,
+} from "@real-router/core";
+import type { PluginApi } from "@real-router/core/api";
+
+const DEFAULT_MAX_HISTORY = 1000;
+
+export class MemoryPlugin {
+  readonly #router: Router;
+  readonly #maxHistory: number;
+  readonly #entries: HistoryEntry[] = [];
+  readonly #removeExtensions: () => void;
+  #index = -1;
+  #navigatingFromHistory = false;
+  #goGeneration = 0;
+
+  constructor(router: Router, api: PluginApi, options: MemoryPluginOptions) {
+    this.#router = router;
+    this.#maxHistory = options.maxHistoryLength ?? DEFAULT_MAX_HISTORY;
+
+    this.#removeExtensions = api.extendRouter({
+      back: () => {
+        this.#go(-1);
+      },
+      forward: () => {
+        this.#go(1);
+      },
+      go: (delta: number) => {
+        this.#go(delta);
+      },
+      canGoBack: () => this.#index > 0,
+      canGoForward: () => this.#index < this.#entries.length - 1,
+    });
+  }
+
+  getPlugin(): Plugin {
+    return {
+      onTransitionSuccess: (
+        toState: State,
+        _fromState: State | undefined,
+        opts: NavigationOptions,
+      ) => {
+        if (this.#navigatingFromHistory) {
+          return;
+        }
+
+        const entry: HistoryEntry = {
+          name: toState.name,
+          params: toState.params,
+          path: toState.path,
+        };
+
+        if (opts.replace && this.#index >= 0) {
+          this.#entries[this.#index] = entry;
+        } else {
+          this.#entries.splice(this.#index + 1);
+          this.#entries.push(entry);
+          this.#index = this.#entries.length - 1;
+
+          if (this.#maxHistory > 0 && this.#entries.length > this.#maxHistory) {
+            const overflow = this.#entries.length - this.#maxHistory;
+
+            this.#entries.splice(0, overflow);
+            this.#index = Math.max(0, this.#index - overflow);
+          }
+        }
+      },
+
+      onStop: () => {
+        this.#clear();
+      },
+
+      teardown: () => {
+        this.#removeExtensions();
+        this.#clear();
+      },
+    };
+  }
+
+  #go(delta: number): void {
+    if (delta === 0) {
+      return;
+    }
+
+    const targetIndex = this.#index + delta;
+
+    if (targetIndex < 0 || targetIndex >= this.#entries.length) {
+      return;
+    }
+
+    const entry = this.#entries[targetIndex];
+    const currentState = this.#router.getState();
+
+    if (entry.path === currentState?.path) {
+      this.#index = targetIndex;
+
+      return;
+    }
+
+    const previousIndex = this.#index;
+    const generation = ++this.#goGeneration;
+
+    this.#navigatingFromHistory = true;
+    this.#index = targetIndex;
+
+    void this.#router
+      .navigate(entry.name, entry.params, { replace: true })
+      .catch(() => {
+        if (this.#goGeneration === generation) {
+          this.#index = previousIndex;
+        }
+      })
+      .finally(() => {
+        if (this.#goGeneration === generation) {
+          this.#navigatingFromHistory = false;
+        }
+      });
+  }
+
+  #clear(): void {
+    this.#entries.length = 0;
+    this.#index = -1;
+  }
+}

package/src/types.ts

@@ -0,0 +1,11 @@
+import type { Params } from "@real-router/core";
+
+export interface MemoryPluginOptions {
+  maxHistoryLength?: number;
+}
+
+export interface HistoryEntry {
+  readonly name: string;
+  readonly params: Params;
+  readonly path: string;
+}