@real-router/lifecycle-plugin 0.1.2 → 0.1.4

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":";;;;;AAMA;;KAAY,aAAA,IACV,OAAA,EAAS,KAAA,EACT,SAAA,EAAW,KAAA;;;iBCoCG,sBAAA,CAAA,GAA0B,aAAA;;;;ADtC1C;;;;YEGY,KAAA;IFFV;IEIE,OAAA,GAAU,aAAA;IFHZ;IEKE,MAAA,GAAS,aAAA;IFLiB;IEO1B,OAAA,GAAU,aAAA;EAAA;AAAA"}

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":";;;;;AAMA;;KAAY,aAAA,IACV,OAAA,EAAS,KAAA,EACT,SAAA,EAAW,KAAA;;;iBCoCG,sBAAA,CAAA,GAA0B,aAAA;;;;ADtC1C;;;;YEGY,KAAA;IFFV;IEIE,OAAA,GAAU,aAAA;IFHZ;IEKE,MAAA,GAAS,aAAA;IFLiB;IEO1B,OAAA,GAAU,aAAA;EAAA;AAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@real-router/lifecycle-plugin",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "type": "commonjs",
   "description": "Route-level lifecycle hooks: onEnter, onStay, onLeave",
   "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,14 +44,16 @@
   "homepage": "https://github.com/greydragon888/real-router",
   "sideEffects": false,
   "dependencies": {
-    "@real-router/core": "^0.45.1"
+    "@real-router/core": "^0.46.0"
   },
   "scripts": {
     "build": "tsdown --config-loader unrun",
     "test": "vitest run",
+    "test:properties": "vitest run --config vitest.config.properties.mts",
+    "test:stress": "vitest --config vitest.config.stress.mts --run",
     "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,47 @@
+import { getPluginApi } from "@real-router/core/api";
+
+import type { LifecycleHook } from "./types";
+import type { PluginFactory, State } from "@real-router/core";
+import type { PluginApi } from "@real-router/core/api";
+
+function createInvokeHook(api: PluginApi) {
+  return (
+    hookName: "onEnter" | "onStay" | "onLeave",
+    routeName: string,
+    toState: State,
+    fromState: State | undefined,
+  ): void => {
+    const hook = api.getRouteConfig(routeName)?.[hookName];
+
+    if (typeof hook === "function") {
+      (hook as LifecycleHook)(toState, fromState);
+    }
+  };
+}
+
+function createPlugin(router: Parameters<PluginFactory>[0]) {
+  const invokeHook = createInvokeHook(getPluginApi(router));
+
+  return {
+    onTransitionLeaveApprove: (
+      toState: State,
+      fromState: State | undefined,
+    ) => {
+      if (fromState && toState.name !== fromState.name) {
+        invokeHook("onLeave", fromState.name, toState, fromState);
+      }
+    },
+
+    onTransitionSuccess: (toState: State, fromState: State | undefined) => {
+      if (toState.name === fromState?.name) {
+        invokeHook("onStay", toState.name, toState, fromState);
+      } else {
+        invokeHook("onEnter", toState.name, toState, fromState);
+      }
+    },
+  };
+}
+
+export function lifecyclePluginFactory(): PluginFactory {
+  return createPlugin;
+}

package/src/index.ts

@@ -0,0 +1,20 @@
+import type { LifecycleHook } from "./types";
+
+export { lifecyclePluginFactory } from "./factory";
+
+/**
+ * Module augmentation for real-router.
+ * Extends Route interface with lifecycle hooks.
+ */
+declare module "@real-router/core" {
+  interface Route {
+    /** Called when this route segment is newly activated (entered). */
+    onEnter?: LifecycleHook;
+    /** Called when this route segment stays active but params changed. */
+    onStay?: LifecycleHook;
+    /** Called when this route segment is deactivated (left). */
+    onLeave?: LifecycleHook;
+  }
+}
+
+export type { LifecycleHook } from "./types";

package/src/types.ts

@@ -0,0 +1,10 @@
+import type { State } from "@real-router/core";
+
+/**
+ * Lifecycle hook callback for route transitions.
+ * Fire-and-forget: return values are ignored, errors are caught and warned.
+ */
+export type LifecycleHook = (
+  toState: State,
+  fromState: State | undefined,
+) => void;