@real-router/ssr-data-plugin 0.2.0 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -15,7 +15,7 @@ const data = await loadRouteData(state.name, state.params); // manual
15
15
  // With plugin:
16
16
  router.usePlugin(ssrDataPluginFactory(loaders));
17
17
  const state = await router.start(url);
18
- const data = router.getRouteData(); // loaded automatically
18
+ const data = state.context.data; // loaded automatically
19
19
  ```
20
20
 
21
21
  ## Installation
@@ -24,7 +24,7 @@ const data = router.getRouteData(); // loaded automatically
24
24
  npm install @real-router/ssr-data-plugin
25
25
  ```
26
26
 
27
- **Peer dependency:** `@real-router/core`
27
+ **Peer dependencies:** `@real-router/core`, `@real-router/types`
28
28
 
29
29
  ## Quick Start
30
30
 
@@ -32,10 +32,11 @@ npm install @real-router/ssr-data-plugin
32
32
  import { createRouter } from "@real-router/core";
33
33
  import { cloneRouter } from "@real-router/core/api";
34
34
  import { ssrDataPluginFactory } from "@real-router/ssr-data-plugin";
35
+ import type { DataLoaderFactoryMap } from "@real-router/ssr-data-plugin";
35
36
 
36
- const loaders = {
37
- "users.profile": async (params) => fetchUser(params.id),
38
- "users.list": async () => fetchUsers(),
37
+ const loaders: DataLoaderFactoryMap = {
38
+ "users.profile": () => async (params) => fetchUser(params.id),
39
+ "users.list": () => async () => fetchUsers(),
39
40
  };
40
41
 
41
42
  // Base router — created once
@@ -46,7 +47,7 @@ const router = cloneRouter(baseRouter, { isAuthenticated: true });
46
47
  router.usePlugin(ssrDataPluginFactory(loaders));
47
48
 
48
49
  const state = await router.start(url);
49
- const data = router.getRouteData(); // data loaded by matching loader
50
+ const data = state.context.data; // data loaded by matching loader
50
51
 
51
52
  const html = renderToString(<App />);
52
53
  router.dispose();
@@ -54,39 +55,37 @@ router.dispose();
54
55
 
55
56
  ## Configuration
56
57
 
57
- Loaders are keyed by **route name** (not path). Each loader receives route `params` and returns a `Promise`:
58
+ Loaders are keyed by **route name** (not path). Each value is a **factory function** `(router, getDependency) => loaderFn` that receives the router instance and a dependency getter. The factory runs once at plugin registration; the returned loader is cached. Each loader receives route `params` and returns a `Promise`:
58
59
 
59
60
  ```typescript
60
- import type { DataLoaderMap } from "@real-router/ssr-data-plugin";
61
+ import type { DataLoaderFactoryMap } from "@real-router/ssr-data-plugin";
61
62
 
62
- const loaders: DataLoaderMap = {
63
- home: async () => ({ featured: await fetchFeatured() }),
64
- "users.profile": async (params) => ({ user: await fetchUser(params.id) }),
65
- "users.list": async () => ({ users: await fetchUsers() }),
63
+ const loaders: DataLoaderFactoryMap = {
64
+ home: () => async () => ({ featured: await fetchFeatured() }),
65
+ "users.profile": () => async (params) => ({ user: await fetchUser(params.id) }),
66
+ "users.list": () => async () => ({ users: await fetchUsers() }),
66
67
  };
67
68
  ```
68
69
 
69
- Routes without a matching loader produce no data — `getRouteData()` returns `null`.
70
+ Routes without a matching loader produce no data — `state.context.data` is `undefined`.
70
71
 
71
- ## Router Extension
72
+ ## Accessing Data
72
73
 
73
- The plugin extends the router instance with one method via [`extendRouter()`](https://github.com/greydragon888/real-router/wiki/plugin-architecture):
74
-
75
- | Method | Returns | Description |
76
- | ---------------------- | --------- | ------------------------------------------ |
77
- | `getRouteData(state?)` | `unknown` | Get loaded data for current or given state |
74
+ After `await router.start(url)`, data is available on the returned state's context:
78
75
 
79
76
  ```typescript
80
- router.getRouteData(); // data for current state
81
- router.getRouteData(state); // data for a specific state
77
+ const state = await router.start(url);
78
+ const data = state.context.data; // loaded data, or undefined if no loader matched
82
79
  ```
83
80
 
81
+ The plugin claims the `"data"` namespace on `state.context` via the [claim-based API](https://github.com/greydragon888/real-router/wiki/plugin-architecture). Module augmentation on `@real-router/types` provides type safety for `state.context.data`.
82
+
84
83
  ## SSR-Only by Design
85
84
 
86
85
  This plugin intercepts `start()` only — not `navigate()`. In SSR, the flow is:
87
86
 
88
87
  ```
89
- cloneRouter → usePlugin → start(url) → data loaded → renderToStringgetRouteData()
88
+ cloneRouter → usePlugin → start(url) → data loaded → state.context.datarenderToString
90
89
  ```
91
90
 
92
91
  Client-side navigation and data fetching is the application's responsibility (React Query, Suspense, `useEffect`, etc.).
@@ -96,7 +95,7 @@ Client-side navigation and data fetching is the application's responsibility (Re
96
95
  ```typescript
97
96
  const unsubscribe = router.usePlugin(ssrDataPluginFactory(loaders));
98
97
 
99
- // Later — removes getRouteData and stops data loading
98
+ // Later — releases "data" namespace claim and stops data loading
100
99
  unsubscribe();
101
100
  ```
102
101
 
@@ -1,18 +1,29 @@
1
- import { Params, PluginFactory, State } from "@real-router/core";
1
+ import { DefaultDependencies, Params, Router } from "@real-router/types";
2
+ import { PluginFactory } from "@real-router/core";
2
3
 
3
4
  //#region src/types.d.ts
4
5
  type DataLoaderFn = (params: Params) => Promise<unknown>;
5
- type DataLoaderMap = Record<string, DataLoaderFn>;
6
+ /**
7
+ * Factory function for creating data loaders.
8
+ * Receives the router instance and a dependency getter (same pattern as GuardFnFactory).
9
+ * Factory runs once when the plugin starts; the returned loader is cached.
10
+ *
11
+ * @template Dependencies - Router dependency map for typed `getDependency()` access.
12
+ * Defaults to `DefaultDependencies`. Pass your app's dependency interface for
13
+ * type-safe DI: `DataLoaderFnFactory<AppDependencies>`.
14
+ */
15
+ type DataLoaderFnFactory<Dependencies extends DefaultDependencies = DefaultDependencies> = (router: Router<Dependencies>, getDependency: <K extends keyof Dependencies>(key: K) => Dependencies[K]) => DataLoaderFn;
16
+ type DataLoaderFactoryMap<Dependencies extends DefaultDependencies = DefaultDependencies> = Record<string, DataLoaderFnFactory<Dependencies>>;
6
17
  //#endregion
7
18
  //#region src/factory.d.ts
8
- declare function ssrDataPluginFactory(loaders: DataLoaderMap): PluginFactory;
19
+ declare function ssrDataPluginFactory(loaders: DataLoaderFactoryMap): PluginFactory;
9
20
  //#endregion
10
21
  //#region src/index.d.ts
11
- declare module "@real-router/core" {
12
- interface Router {
13
- getRouteData: (state?: State) => unknown;
22
+ declare module "@real-router/types" {
23
+ interface StateContext {
24
+ data?: unknown;
14
25
  }
15
26
  } //# sourceMappingURL=index.d.ts.map
16
27
  //#endregion
17
- export { type DataLoaderFn, type DataLoaderMap, ssrDataPluginFactory };
28
+ export { type DataLoaderFactoryMap, type DataLoaderFn, type DataLoaderFnFactory, ssrDataPluginFactory };
18
29
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","names":[],"sources":["../../src/types.ts","../../src/factory.ts","../../src/index.ts"],"mappings":";;;KAEY,YAAA,IAAgB,MAAA,EAAQ,MAAA,KAAW,OAAA;AAAA,KAEnC,aAAA,GAAgB,MAAA,SAAe,YAAA;;;iBCG3B,oBAAA,CAAqB,OAAA,EAAS,aAAA,GAAgB,aAAA;;;;YCAlD,MAAA;IACR,YAAA,GAAe,KAAA,GAAQ,KAAA;EAAA;AAAA"}
1
+ {"version":3,"file":"index.d.ts","names":[],"sources":["../../src/types.ts","../../src/factory.ts","../../src/index.ts"],"mappings":";;;;KAEY,YAAA,IAAgB,MAAA,EAAQ,MAAA,KAAW,OAAA;;;AAA/C;;;;;;;KAWY,mBAAA,sBACW,mBAAA,GAAsB,mBAAA,KAE3C,MAAA,EAAQ,MAAA,CAAO,YAAA,GACf,aAAA,mBAAgC,YAAA,EAAc,GAAA,EAAK,CAAA,KAAM,YAAA,CAAa,CAAA,MACnE,YAAA;AAAA,KAEO,oBAAA,sBACW,mBAAA,GAAsB,mBAAA,IACzC,MAAA,SAAe,mBAAA,CAAoB,YAAA;;;iBCdvB,oBAAA,CACd,OAAA,EAAS,oBAAA,GACR,aAAA;;;;YCDS,YAAA;IACR,IAAA;EAAA;AAAA"}
package/dist/cjs/index.js CHANGED
@@ -1,2 +1,2 @@
1
- Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});let e=require(`@real-router/core/api`);const t=`[@real-router/ssr-data-plugin]`;function n(e){if(typeof e!=`object`||!e)throw TypeError(`${t} loaders must be a non-null object`);for(let[n,r]of Object.entries(e))if(typeof r!=`function`)throw TypeError(`${t} loader for route "${n}" must be a function`)}function r(t){return n(t),n=>{let r=(0,e.getPluginApi)(n),i=new WeakMap,a=r.addInterceptor(`start`,async(e,n)=>{let r=await e(n);return Object.hasOwn(t,r.name)&&i.set(r,await t[r.name](r.params)),r}),o=r.extendRouter({getRouteData(e){let t=e??n.getState();return t?i.get(t)??null:null}});return{teardown(){a(),o()}}}}exports.ssrDataPluginFactory=r;
1
+ Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});let e=require(`@real-router/core/api`);const t=`[@real-router/ssr-data-plugin]`;function n(e){if(typeof e!=`object`||!e||Array.isArray(e))throw TypeError(`${t} loaders must be a non-null object`);for(let[n,r]of Object.entries(e))if(typeof r!=`function`)throw TypeError(`${t} loader for route "${n}" must be a function`)}function r(r){return n(r),(n,i)=>{let a=(0,e.getPluginApi)(n),o=a.claimContextNamespace(`data`),s=new Map;try{for(let[e,a]of Object.entries(r)){let r=a(n,i);if(typeof r!=`function`)throw TypeError(`${t} factory for route "${e}" must return a function`);s.set(e,r)}}catch(e){throw o.release(),e}let c=a.addInterceptor(`start`,async(e,t)=>{let n=await e(t),r=s.get(n.name);return r&&o.write(n,await r(n.params)),n});return{teardown(){c(),o.release()}}}}exports.ssrDataPluginFactory=r;
2
2
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","names":[],"sources":["../../src/constants.ts","../../src/validation.ts","../../src/factory.ts"],"sourcesContent":["export const LOGGER_CONTEXT = \"ssr-data-plugin\";\n\nexport const ERROR_PREFIX = `[@real-router/${LOGGER_CONTEXT}]`;\n","import { ERROR_PREFIX } from \"./constants\";\n\nimport type { DataLoaderMap } from \"./types\";\n\nexport function validateLoaders(\n loaders: unknown,\n): asserts loaders is DataLoaderMap {\n if (loaders === null || typeof loaders !== \"object\") {\n throw new TypeError(`${ERROR_PREFIX} loaders must be a non-null object`);\n }\n\n for (const [key, value] of Object.entries(\n loaders as Record<string, unknown>,\n )) {\n if (typeof value !== \"function\") {\n throw new TypeError(\n `${ERROR_PREFIX} loader for route \"${key}\" must be a function`,\n );\n }\n }\n}\n","import { getPluginApi } from \"@real-router/core/api\";\n\nimport { validateLoaders } from \"./validation\";\n\nimport type { DataLoaderMap } from \"./types\";\nimport type { State, PluginFactory, Plugin } from \"@real-router/core\";\n\nexport function ssrDataPluginFactory(loaders: DataLoaderMap): PluginFactory {\n validateLoaders(loaders);\n\n return (router): Plugin => {\n const api = getPluginApi(router);\n const dataStore = new WeakMap<State, unknown>();\n\n const removeStartInterceptor = api.addInterceptor(\n \"start\",\n async (next, path) => {\n const state = await next(path);\n\n if (Object.hasOwn(loaders, state.name)) {\n dataStore.set(state, await loaders[state.name](state.params));\n }\n\n return state;\n },\n );\n\n const removeExtensions = api.extendRouter({\n getRouteData(state?: State): unknown {\n const routeState = state ?? router.getState();\n\n return routeState ? (dataStore.get(routeState) ?? null) : null;\n },\n });\n\n return {\n teardown() {\n removeStartInterceptor();\n removeExtensions();\n },\n };\n };\n}\n"],"mappings":"0GAAA,MAEa,EAAe,iCCE5B,SAAgB,EACd,EACkC,CAClC,GAAwB,OAAO,GAAY,WAAvC,EACF,MAAU,UAAU,GAAG,EAAa,oCAAoC,CAG1E,IAAK,GAAM,CAAC,EAAK,KAAU,OAAO,QAChC,EACD,CACC,GAAI,OAAO,GAAU,WACnB,MAAU,UACR,GAAG,EAAa,qBAAqB,EAAI,sBAC1C,CCVP,SAAgB,EAAqB,EAAuC,CAG1E,OAFA,EAAgB,EAAQ,CAEhB,GAAmB,CACzB,IAAM,GAAA,EAAA,EAAA,cAAmB,EAAO,CAC1B,EAAY,IAAI,QAEhB,EAAyB,EAAI,eACjC,QACA,MAAO,EAAM,IAAS,CACpB,IAAM,EAAQ,MAAM,EAAK,EAAK,CAM9B,OAJI,OAAO,OAAO,EAAS,EAAM,KAAK,EACpC,EAAU,IAAI,EAAO,MAAM,EAAQ,EAAM,MAAM,EAAM,OAAO,CAAC,CAGxD,GAEV,CAEK,EAAmB,EAAI,aAAa,CACxC,aAAa,EAAwB,CACnC,IAAM,EAAa,GAAS,EAAO,UAAU,CAE7C,OAAO,EAAc,EAAU,IAAI,EAAW,EAAI,KAAQ,MAE7D,CAAC,CAEF,MAAO,CACL,UAAW,CACT,GAAwB,CACxB,GAAkB,EAErB"}
1
+ {"version":3,"file":"index.js","names":[],"sources":["../../src/constants.ts","../../src/validation.ts","../../src/factory.ts"],"sourcesContent":["const LOGGER_CONTEXT = \"ssr-data-plugin\";\n\nexport const ERROR_PREFIX = `[@real-router/${LOGGER_CONTEXT}]`;\n","import { ERROR_PREFIX } from \"./constants\";\n\nimport type { DataLoaderFactoryMap } from \"./types\";\n\nexport function validateLoaders(\n loaders: unknown,\n): asserts loaders is DataLoaderFactoryMap {\n if (\n loaders === null ||\n typeof loaders !== \"object\" ||\n Array.isArray(loaders)\n ) {\n throw new TypeError(`${ERROR_PREFIX} loaders must be a non-null object`);\n }\n\n for (const [key, value] of Object.entries(\n loaders as Record<string, unknown>,\n )) {\n if (typeof value !== \"function\") {\n throw new TypeError(\n `${ERROR_PREFIX} loader for route \"${key}\" must be a function`,\n );\n }\n }\n}\n","import { getPluginApi } from \"@real-router/core/api\";\n\nimport { ERROR_PREFIX } from \"./constants\";\nimport { validateLoaders } from \"./validation\";\n\nimport type { DataLoaderFn, DataLoaderFactoryMap } from \"./types\";\nimport type { PluginFactory, Plugin } from \"@real-router/core\";\n\nexport function ssrDataPluginFactory(\n loaders: DataLoaderFactoryMap,\n): PluginFactory {\n validateLoaders(loaders);\n\n return (router, getDependency): Plugin => {\n const api = getPluginApi(router);\n const claim = api.claimContextNamespace(\"data\");\n\n const compiledLoaders = new Map<string, DataLoaderFn>();\n\n try {\n for (const [name, factory] of Object.entries(loaders)) {\n const loader = factory(router, getDependency);\n\n if (typeof loader !== \"function\") {\n throw new TypeError(\n `${ERROR_PREFIX} factory for route \"${name}\" must return a function`,\n );\n }\n\n compiledLoaders.set(name, loader);\n }\n } catch (error) {\n claim.release();\n\n throw error;\n }\n\n const removeStartInterceptor = api.addInterceptor(\n \"start\",\n async (next, path) => {\n const state = await next(path);\n const loader = compiledLoaders.get(state.name);\n\n if (loader) {\n claim.write(state, await loader(state.params));\n }\n\n return state;\n },\n );\n\n return {\n teardown() {\n removeStartInterceptor();\n claim.release();\n },\n };\n };\n}\n"],"mappings":"0GAAA,MAEa,EAAe,iCCE5B,SAAgB,EACd,EACyC,CACzC,GAEE,OAAO,GAAY,WADnB,GAEA,MAAM,QAAQ,EAAQ,CAEtB,MAAU,UAAU,GAAG,EAAa,oCAAoC,CAG1E,IAAK,GAAM,CAAC,EAAK,KAAU,OAAO,QAChC,EACD,CACC,GAAI,OAAO,GAAU,WACnB,MAAU,UACR,GAAG,EAAa,qBAAqB,EAAI,sBAC1C,CCbP,SAAgB,EACd,EACe,CAGf,OAFA,EAAgB,EAAQ,EAEhB,EAAQ,IAA0B,CACxC,IAAM,GAAA,EAAA,EAAA,cAAmB,EAAO,CAC1B,EAAQ,EAAI,sBAAsB,OAAO,CAEzC,EAAkB,IAAI,IAE5B,GAAI,CACF,IAAK,GAAM,CAAC,EAAM,KAAY,OAAO,QAAQ,EAAQ,CAAE,CACrD,IAAM,EAAS,EAAQ,EAAQ,EAAc,CAE7C,GAAI,OAAO,GAAW,WACpB,MAAU,UACR,GAAG,EAAa,sBAAsB,EAAK,0BAC5C,CAGH,EAAgB,IAAI,EAAM,EAAO,QAE5B,EAAO,CAGd,MAFA,EAAM,SAAS,CAET,EAGR,IAAM,EAAyB,EAAI,eACjC,QACA,MAAO,EAAM,IAAS,CACpB,IAAM,EAAQ,MAAM,EAAK,EAAK,CACxB,EAAS,EAAgB,IAAI,EAAM,KAAK,CAM9C,OAJI,GACF,EAAM,MAAM,EAAO,MAAM,EAAO,EAAM,OAAO,CAAC,CAGzC,GAEV,CAED,MAAO,CACL,UAAW,CACT,GAAwB,CACxB,EAAM,SAAS,EAElB"}
@@ -1,18 +1,29 @@
1
- import { Params, PluginFactory, State } from "@real-router/core";
1
+ import { DefaultDependencies, Params, Router } from "@real-router/types";
2
+ import { PluginFactory } from "@real-router/core";
2
3
 
3
4
  //#region src/types.d.ts
4
5
  type DataLoaderFn = (params: Params) => Promise<unknown>;
5
- type DataLoaderMap = Record<string, DataLoaderFn>;
6
+ /**
7
+ * Factory function for creating data loaders.
8
+ * Receives the router instance and a dependency getter (same pattern as GuardFnFactory).
9
+ * Factory runs once when the plugin starts; the returned loader is cached.
10
+ *
11
+ * @template Dependencies - Router dependency map for typed `getDependency()` access.
12
+ * Defaults to `DefaultDependencies`. Pass your app's dependency interface for
13
+ * type-safe DI: `DataLoaderFnFactory<AppDependencies>`.
14
+ */
15
+ type DataLoaderFnFactory<Dependencies extends DefaultDependencies = DefaultDependencies> = (router: Router<Dependencies>, getDependency: <K extends keyof Dependencies>(key: K) => Dependencies[K]) => DataLoaderFn;
16
+ type DataLoaderFactoryMap<Dependencies extends DefaultDependencies = DefaultDependencies> = Record<string, DataLoaderFnFactory<Dependencies>>;
6
17
  //#endregion
7
18
  //#region src/factory.d.ts
8
- declare function ssrDataPluginFactory(loaders: DataLoaderMap): PluginFactory;
19
+ declare function ssrDataPluginFactory(loaders: DataLoaderFactoryMap): PluginFactory;
9
20
  //#endregion
10
21
  //#region src/index.d.ts
11
- declare module "@real-router/core" {
12
- interface Router {
13
- getRouteData: (state?: State) => unknown;
22
+ declare module "@real-router/types" {
23
+ interface StateContext {
24
+ data?: unknown;
14
25
  }
15
26
  } //# sourceMappingURL=index.d.ts.map
16
27
  //#endregion
17
- export { type DataLoaderFn, type DataLoaderMap, ssrDataPluginFactory };
28
+ export { type DataLoaderFactoryMap, type DataLoaderFn, type DataLoaderFnFactory, ssrDataPluginFactory };
18
29
  //# sourceMappingURL=index.d.mts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.mts","names":[],"sources":["../../src/types.ts","../../src/factory.ts","../../src/index.ts"],"mappings":";;;KAEY,YAAA,IAAgB,MAAA,EAAQ,MAAA,KAAW,OAAA;AAAA,KAEnC,aAAA,GAAgB,MAAA,SAAe,YAAA;;;iBCG3B,oBAAA,CAAqB,OAAA,EAAS,aAAA,GAAgB,aAAA;;;;YCAlD,MAAA;IACR,YAAA,GAAe,KAAA,GAAQ,KAAA;EAAA;AAAA"}
1
+ {"version":3,"file":"index.d.mts","names":[],"sources":["../../src/types.ts","../../src/factory.ts","../../src/index.ts"],"mappings":";;;;KAEY,YAAA,IAAgB,MAAA,EAAQ,MAAA,KAAW,OAAA;;;AAA/C;;;;;;;KAWY,mBAAA,sBACW,mBAAA,GAAsB,mBAAA,KAE3C,MAAA,EAAQ,MAAA,CAAO,YAAA,GACf,aAAA,mBAAgC,YAAA,EAAc,GAAA,EAAK,CAAA,KAAM,YAAA,CAAa,CAAA,MACnE,YAAA;AAAA,KAEO,oBAAA,sBACW,mBAAA,GAAsB,mBAAA,IACzC,MAAA,SAAe,mBAAA,CAAoB,YAAA;;;iBCdvB,oBAAA,CACd,OAAA,EAAS,oBAAA,GACR,aAAA;;;;YCDS,YAAA;IACR,IAAA;EAAA;AAAA"}
@@ -1,2 +1,2 @@
1
- import{getPluginApi as e}from"@real-router/core/api";const t=`[@real-router/ssr-data-plugin]`;function n(e){if(typeof e!=`object`||!e)throw TypeError(`${t} loaders must be a non-null object`);for(let[n,r]of Object.entries(e))if(typeof r!=`function`)throw TypeError(`${t} loader for route "${n}" must be a function`)}function r(t){return n(t),n=>{let r=e(n),i=new WeakMap,a=r.addInterceptor(`start`,async(e,n)=>{let r=await e(n);return Object.hasOwn(t,r.name)&&i.set(r,await t[r.name](r.params)),r}),o=r.extendRouter({getRouteData(e){let t=e??n.getState();return t?i.get(t)??null:null}});return{teardown(){a(),o()}}}}export{r as ssrDataPluginFactory};
1
+ import{getPluginApi as e}from"@real-router/core/api";const t=`[@real-router/ssr-data-plugin]`;function n(e){if(typeof e!=`object`||!e||Array.isArray(e))throw TypeError(`${t} loaders must be a non-null object`);for(let[n,r]of Object.entries(e))if(typeof r!=`function`)throw TypeError(`${t} loader for route "${n}" must be a function`)}function r(r){return n(r),(n,i)=>{let a=e(n),o=a.claimContextNamespace(`data`),s=new Map;try{for(let[e,a]of Object.entries(r)){let r=a(n,i);if(typeof r!=`function`)throw TypeError(`${t} factory for route "${e}" must return a function`);s.set(e,r)}}catch(e){throw o.release(),e}let c=a.addInterceptor(`start`,async(e,t)=>{let n=await e(t),r=s.get(n.name);return r&&o.write(n,await r(n.params)),n});return{teardown(){c(),o.release()}}}}export{r as ssrDataPluginFactory};
2
2
  //# sourceMappingURL=index.mjs.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.mjs","names":[],"sources":["../../src/constants.ts","../../src/validation.ts","../../src/factory.ts"],"sourcesContent":["export const LOGGER_CONTEXT = \"ssr-data-plugin\";\n\nexport const ERROR_PREFIX = `[@real-router/${LOGGER_CONTEXT}]`;\n","import { ERROR_PREFIX } from \"./constants\";\n\nimport type { DataLoaderMap } from \"./types\";\n\nexport function validateLoaders(\n loaders: unknown,\n): asserts loaders is DataLoaderMap {\n if (loaders === null || typeof loaders !== \"object\") {\n throw new TypeError(`${ERROR_PREFIX} loaders must be a non-null object`);\n }\n\n for (const [key, value] of Object.entries(\n loaders as Record<string, unknown>,\n )) {\n if (typeof value !== \"function\") {\n throw new TypeError(\n `${ERROR_PREFIX} loader for route \"${key}\" must be a function`,\n );\n }\n }\n}\n","import { getPluginApi } from \"@real-router/core/api\";\n\nimport { validateLoaders } from \"./validation\";\n\nimport type { DataLoaderMap } from \"./types\";\nimport type { State, PluginFactory, Plugin } from \"@real-router/core\";\n\nexport function ssrDataPluginFactory(loaders: DataLoaderMap): PluginFactory {\n validateLoaders(loaders);\n\n return (router): Plugin => {\n const api = getPluginApi(router);\n const dataStore = new WeakMap<State, unknown>();\n\n const removeStartInterceptor = api.addInterceptor(\n \"start\",\n async (next, path) => {\n const state = await next(path);\n\n if (Object.hasOwn(loaders, state.name)) {\n dataStore.set(state, await loaders[state.name](state.params));\n }\n\n return state;\n },\n );\n\n const removeExtensions = api.extendRouter({\n getRouteData(state?: State): unknown {\n const routeState = state ?? router.getState();\n\n return routeState ? (dataStore.get(routeState) ?? null) : null;\n },\n });\n\n return {\n teardown() {\n removeStartInterceptor();\n removeExtensions();\n },\n };\n };\n}\n"],"mappings":"qDAAA,MAEa,EAAe,iCCE5B,SAAgB,EACd,EACkC,CAClC,GAAwB,OAAO,GAAY,WAAvC,EACF,MAAU,UAAU,GAAG,EAAa,oCAAoC,CAG1E,IAAK,GAAM,CAAC,EAAK,KAAU,OAAO,QAChC,EACD,CACC,GAAI,OAAO,GAAU,WACnB,MAAU,UACR,GAAG,EAAa,qBAAqB,EAAI,sBAC1C,CCVP,SAAgB,EAAqB,EAAuC,CAG1E,OAFA,EAAgB,EAAQ,CAEhB,GAAmB,CACzB,IAAM,EAAM,EAAa,EAAO,CAC1B,EAAY,IAAI,QAEhB,EAAyB,EAAI,eACjC,QACA,MAAO,EAAM,IAAS,CACpB,IAAM,EAAQ,MAAM,EAAK,EAAK,CAM9B,OAJI,OAAO,OAAO,EAAS,EAAM,KAAK,EACpC,EAAU,IAAI,EAAO,MAAM,EAAQ,EAAM,MAAM,EAAM,OAAO,CAAC,CAGxD,GAEV,CAEK,EAAmB,EAAI,aAAa,CACxC,aAAa,EAAwB,CACnC,IAAM,EAAa,GAAS,EAAO,UAAU,CAE7C,OAAO,EAAc,EAAU,IAAI,EAAW,EAAI,KAAQ,MAE7D,CAAC,CAEF,MAAO,CACL,UAAW,CACT,GAAwB,CACxB,GAAkB,EAErB"}
1
+ {"version":3,"file":"index.mjs","names":[],"sources":["../../src/constants.ts","../../src/validation.ts","../../src/factory.ts"],"sourcesContent":["const LOGGER_CONTEXT = \"ssr-data-plugin\";\n\nexport const ERROR_PREFIX = `[@real-router/${LOGGER_CONTEXT}]`;\n","import { ERROR_PREFIX } from \"./constants\";\n\nimport type { DataLoaderFactoryMap } from \"./types\";\n\nexport function validateLoaders(\n loaders: unknown,\n): asserts loaders is DataLoaderFactoryMap {\n if (\n loaders === null ||\n typeof loaders !== \"object\" ||\n Array.isArray(loaders)\n ) {\n throw new TypeError(`${ERROR_PREFIX} loaders must be a non-null object`);\n }\n\n for (const [key, value] of Object.entries(\n loaders as Record<string, unknown>,\n )) {\n if (typeof value !== \"function\") {\n throw new TypeError(\n `${ERROR_PREFIX} loader for route \"${key}\" must be a function`,\n );\n }\n }\n}\n","import { getPluginApi } from \"@real-router/core/api\";\n\nimport { ERROR_PREFIX } from \"./constants\";\nimport { validateLoaders } from \"./validation\";\n\nimport type { DataLoaderFn, DataLoaderFactoryMap } from \"./types\";\nimport type { PluginFactory, Plugin } from \"@real-router/core\";\n\nexport function ssrDataPluginFactory(\n loaders: DataLoaderFactoryMap,\n): PluginFactory {\n validateLoaders(loaders);\n\n return (router, getDependency): Plugin => {\n const api = getPluginApi(router);\n const claim = api.claimContextNamespace(\"data\");\n\n const compiledLoaders = new Map<string, DataLoaderFn>();\n\n try {\n for (const [name, factory] of Object.entries(loaders)) {\n const loader = factory(router, getDependency);\n\n if (typeof loader !== \"function\") {\n throw new TypeError(\n `${ERROR_PREFIX} factory for route \"${name}\" must return a function`,\n );\n }\n\n compiledLoaders.set(name, loader);\n }\n } catch (error) {\n claim.release();\n\n throw error;\n }\n\n const removeStartInterceptor = api.addInterceptor(\n \"start\",\n async (next, path) => {\n const state = await next(path);\n const loader = compiledLoaders.get(state.name);\n\n if (loader) {\n claim.write(state, await loader(state.params));\n }\n\n return state;\n },\n );\n\n return {\n teardown() {\n removeStartInterceptor();\n claim.release();\n },\n };\n };\n}\n"],"mappings":"qDAAA,MAEa,EAAe,iCCE5B,SAAgB,EACd,EACyC,CACzC,GAEE,OAAO,GAAY,WADnB,GAEA,MAAM,QAAQ,EAAQ,CAEtB,MAAU,UAAU,GAAG,EAAa,oCAAoC,CAG1E,IAAK,GAAM,CAAC,EAAK,KAAU,OAAO,QAChC,EACD,CACC,GAAI,OAAO,GAAU,WACnB,MAAU,UACR,GAAG,EAAa,qBAAqB,EAAI,sBAC1C,CCbP,SAAgB,EACd,EACe,CAGf,OAFA,EAAgB,EAAQ,EAEhB,EAAQ,IAA0B,CACxC,IAAM,EAAM,EAAa,EAAO,CAC1B,EAAQ,EAAI,sBAAsB,OAAO,CAEzC,EAAkB,IAAI,IAE5B,GAAI,CACF,IAAK,GAAM,CAAC,EAAM,KAAY,OAAO,QAAQ,EAAQ,CAAE,CACrD,IAAM,EAAS,EAAQ,EAAQ,EAAc,CAE7C,GAAI,OAAO,GAAW,WACpB,MAAU,UACR,GAAG,EAAa,sBAAsB,EAAK,0BAC5C,CAGH,EAAgB,IAAI,EAAM,EAAO,QAE5B,EAAO,CAGd,MAFA,EAAM,SAAS,CAET,EAGR,IAAM,EAAyB,EAAI,eACjC,QACA,MAAO,EAAM,IAAS,CACpB,IAAM,EAAQ,MAAM,EAAK,EAAK,CACxB,EAAS,EAAgB,IAAI,EAAM,KAAK,CAM9C,OAJI,GACF,EAAM,MAAM,EAAO,MAAM,EAAO,EAAM,OAAO,CAAC,CAGzC,GAEV,CAED,MAAO,CACL,UAAW,CACT,GAAwB,CACxB,EAAM,SAAS,EAElB"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@real-router/ssr-data-plugin",
3
- "version": "0.2.0",
3
+ "version": "0.3.0",
4
4
  "type": "commonjs",
5
5
  "description": "SSR per-route data loading plugin for Real-Router",
6
6
  "main": "./dist/cjs/index.js",
@@ -36,17 +36,20 @@
36
36
  },
37
37
  "homepage": "https://github.com/greydragon888/real-router",
38
38
  "sideEffects": false,
39
+ "dependencies": {
40
+ "@real-router/types": "^0.34.0"
41
+ },
39
42
  "peerDependencies": {
40
- "@real-router/core": "^0.47.0"
43
+ "@real-router/core": "^0.48.0"
41
44
  },
42
45
  "scripts": {
43
46
  "test": "vitest",
44
47
  "test:properties": "vitest run --config vitest.config.properties.mts",
45
48
  "test:stress": "vitest --config vitest.config.stress.mts --run",
46
- "build": "tsdown --config-loader unrun",
47
49
  "type-check": "tsc --noEmit",
48
50
  "lint": "eslint --cache --ext .ts src/ tests/ --fix --max-warnings 0",
49
51
  "lint:package": "publint",
50
- "lint:types": "attw --pack ."
52
+ "lint:types": "attw --pack .",
53
+ "bundle": "tsdown --config-loader unrun"
51
54
  }
52
55
  }
package/src/constants.ts CHANGED
@@ -1,3 +1,3 @@
1
- export const LOGGER_CONTEXT = "ssr-data-plugin";
1
+ const LOGGER_CONTEXT = "ssr-data-plugin";
2
2
 
3
3
  export const ERROR_PREFIX = `[@real-router/${LOGGER_CONTEXT}]`;
package/src/factory.ts CHANGED
@@ -1,42 +1,58 @@
1
1
  import { getPluginApi } from "@real-router/core/api";
2
2
 
3
+ import { ERROR_PREFIX } from "./constants";
3
4
  import { validateLoaders } from "./validation";
4
5
 
5
- import type { DataLoaderMap } from "./types";
6
- import type { State, PluginFactory, Plugin } from "@real-router/core";
6
+ import type { DataLoaderFn, DataLoaderFactoryMap } from "./types";
7
+ import type { PluginFactory, Plugin } from "@real-router/core";
7
8
 
8
- export function ssrDataPluginFactory(loaders: DataLoaderMap): PluginFactory {
9
+ export function ssrDataPluginFactory(
10
+ loaders: DataLoaderFactoryMap,
11
+ ): PluginFactory {
9
12
  validateLoaders(loaders);
10
13
 
11
- return (router): Plugin => {
14
+ return (router, getDependency): Plugin => {
12
15
  const api = getPluginApi(router);
13
- const dataStore = new WeakMap<State, unknown>();
16
+ const claim = api.claimContextNamespace("data");
17
+
18
+ const compiledLoaders = new Map<string, DataLoaderFn>();
19
+
20
+ try {
21
+ for (const [name, factory] of Object.entries(loaders)) {
22
+ const loader = factory(router, getDependency);
23
+
24
+ if (typeof loader !== "function") {
25
+ throw new TypeError(
26
+ `${ERROR_PREFIX} factory for route "${name}" must return a function`,
27
+ );
28
+ }
29
+
30
+ compiledLoaders.set(name, loader);
31
+ }
32
+ } catch (error) {
33
+ claim.release();
34
+
35
+ throw error;
36
+ }
14
37
 
15
38
  const removeStartInterceptor = api.addInterceptor(
16
39
  "start",
17
40
  async (next, path) => {
18
41
  const state = await next(path);
42
+ const loader = compiledLoaders.get(state.name);
19
43
 
20
- if (Object.hasOwn(loaders, state.name)) {
21
- dataStore.set(state, await loaders[state.name](state.params));
44
+ if (loader) {
45
+ claim.write(state, await loader(state.params));
22
46
  }
23
47
 
24
48
  return state;
25
49
  },
26
50
  );
27
51
 
28
- const removeExtensions = api.extendRouter({
29
- getRouteData(state?: State): unknown {
30
- const routeState = state ?? router.getState();
31
-
32
- return routeState ? (dataStore.get(routeState) ?? null) : null;
33
- },
34
- });
35
-
36
52
  return {
37
53
  teardown() {
38
54
  removeStartInterceptor();
39
- removeExtensions();
55
+ claim.release();
40
56
  },
41
57
  };
42
58
  };
package/src/index.ts CHANGED
@@ -1,11 +1,13 @@
1
- import type { State } from "@real-router/core";
2
-
3
- export type { DataLoaderMap, DataLoaderFn } from "./types";
1
+ export type {
2
+ DataLoaderFn,
3
+ DataLoaderFactoryMap,
4
+ DataLoaderFnFactory,
5
+ } from "./types";
4
6
 
5
7
  export { ssrDataPluginFactory } from "./factory";
6
8
 
7
- declare module "@real-router/core" {
8
- interface Router {
9
- getRouteData: (state?: State) => unknown;
9
+ declare module "@real-router/types" {
10
+ interface StateContext {
11
+ data?: unknown;
10
12
  }
11
13
  }
package/src/types.ts CHANGED
@@ -1,5 +1,23 @@
1
- import type { Params } from "@real-router/core";
1
+ import type { DefaultDependencies, Params, Router } from "@real-router/types";
2
2
 
3
3
  export type DataLoaderFn = (params: Params) => Promise<unknown>;
4
4
 
5
- export type DataLoaderMap = Record<string, DataLoaderFn>;
5
+ /**
6
+ * Factory function for creating data loaders.
7
+ * Receives the router instance and a dependency getter (same pattern as GuardFnFactory).
8
+ * Factory runs once when the plugin starts; the returned loader is cached.
9
+ *
10
+ * @template Dependencies - Router dependency map for typed `getDependency()` access.
11
+ * Defaults to `DefaultDependencies`. Pass your app's dependency interface for
12
+ * type-safe DI: `DataLoaderFnFactory<AppDependencies>`.
13
+ */
14
+ export type DataLoaderFnFactory<
15
+ Dependencies extends DefaultDependencies = DefaultDependencies,
16
+ > = (
17
+ router: Router<Dependencies>,
18
+ getDependency: <K extends keyof Dependencies>(key: K) => Dependencies[K],
19
+ ) => DataLoaderFn;
20
+
21
+ export type DataLoaderFactoryMap<
22
+ Dependencies extends DefaultDependencies = DefaultDependencies,
23
+ > = Record<string, DataLoaderFnFactory<Dependencies>>;
package/src/validation.ts CHANGED
@@ -1,11 +1,15 @@
1
1
  import { ERROR_PREFIX } from "./constants";
2
2
 
3
- import type { DataLoaderMap } from "./types";
3
+ import type { DataLoaderFactoryMap } from "./types";
4
4
 
5
5
  export function validateLoaders(
6
6
  loaders: unknown,
7
- ): asserts loaders is DataLoaderMap {
8
- if (loaders === null || typeof loaders !== "object") {
7
+ ): asserts loaders is DataLoaderFactoryMap {
8
+ if (
9
+ loaders === null ||
10
+ typeof loaders !== "object" ||
11
+ Array.isArray(loaders)
12
+ ) {
9
13
  throw new TypeError(`${ERROR_PREFIX} loaders must be a non-null object`);
10
14
  }
11
15