@reckona/mreact-router 0.0.1
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/LICENSE +21 -0
- package/README.md +101 -0
- package/dist/actions.d.ts +43 -0
- package/dist/actions.d.ts.map +1 -0
- package/dist/actions.js +577 -0
- package/dist/actions.js.map +1 -0
- package/dist/adapters/aws-lambda.d.ts +45 -0
- package/dist/adapters/aws-lambda.d.ts.map +1 -0
- package/dist/adapters/aws-lambda.js +168 -0
- package/dist/adapters/aws-lambda.js.map +1 -0
- package/dist/adapters/cloudflare.d.ts +94 -0
- package/dist/adapters/cloudflare.d.ts.map +1 -0
- package/dist/adapters/cloudflare.js +390 -0
- package/dist/adapters/cloudflare.js.map +1 -0
- package/dist/adapters/devtools.d.ts +4 -0
- package/dist/adapters/devtools.d.ts.map +1 -0
- package/dist/adapters/devtools.js +5 -0
- package/dist/adapters/devtools.js.map +1 -0
- package/dist/adapters/edge.d.ts +9 -0
- package/dist/adapters/edge.d.ts.map +1 -0
- package/dist/adapters/edge.js +53 -0
- package/dist/adapters/edge.js.map +1 -0
- package/dist/adapters/node.d.ts +26 -0
- package/dist/adapters/node.d.ts.map +1 -0
- package/dist/adapters/node.js +64 -0
- package/dist/adapters/node.js.map +1 -0
- package/dist/adapters/static.d.ts +10 -0
- package/dist/adapters/static.d.ts.map +1 -0
- package/dist/adapters/static.js +34 -0
- package/dist/adapters/static.js.map +1 -0
- package/dist/assets.d.ts +18 -0
- package/dist/assets.d.ts.map +1 -0
- package/dist/assets.js +67 -0
- package/dist/assets.js.map +1 -0
- package/dist/build.d.ts +36 -0
- package/dist/build.d.ts.map +1 -0
- package/dist/build.js +322 -0
- package/dist/build.js.map +1 -0
- package/dist/cache.d.ts +54 -0
- package/dist/cache.d.ts.map +1 -0
- package/dist/cache.js +221 -0
- package/dist/cache.js.map +1 -0
- package/dist/cli.d.ts +3 -0
- package/dist/cli.d.ts.map +1 -0
- package/dist/cli.js +37 -0
- package/dist/cli.js.map +1 -0
- package/dist/client.d.ts +105 -0
- package/dist/client.d.ts.map +1 -0
- package/dist/client.js +1268 -0
- package/dist/client.js.map +1 -0
- package/dist/config.d.ts +27 -0
- package/dist/config.d.ts.map +1 -0
- package/dist/config.js +44 -0
- package/dist/config.js.map +1 -0
- package/dist/cookies.d.ts +14 -0
- package/dist/cookies.d.ts.map +1 -0
- package/dist/cookies.js +69 -0
- package/dist/cookies.js.map +1 -0
- package/dist/csp.d.ts +6 -0
- package/dist/csp.d.ts.map +1 -0
- package/dist/csp.js +70 -0
- package/dist/csp.js.map +1 -0
- package/dist/dev-server.d.ts +16 -0
- package/dist/dev-server.d.ts.map +1 -0
- package/dist/dev-server.js +103 -0
- package/dist/dev-server.js.map +1 -0
- package/dist/http.d.ts +23 -0
- package/dist/http.d.ts.map +1 -0
- package/dist/http.js +106 -0
- package/dist/http.js.map +1 -0
- package/dist/i18n.d.ts +15 -0
- package/dist/i18n.d.ts.map +1 -0
- package/dist/i18n.js +61 -0
- package/dist/i18n.js.map +1 -0
- package/dist/import-policy.d.ts +30 -0
- package/dist/import-policy.d.ts.map +1 -0
- package/dist/import-policy.js +105 -0
- package/dist/import-policy.js.map +1 -0
- package/dist/index.d.ts +60 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +34 -0
- package/dist/index.js.map +1 -0
- package/dist/logger.d.ts +47 -0
- package/dist/logger.d.ts.map +1 -0
- package/dist/logger.js +60 -0
- package/dist/logger.js.map +1 -0
- package/dist/module-runner.d.ts +9 -0
- package/dist/module-runner.d.ts.map +1 -0
- package/dist/module-runner.js +112 -0
- package/dist/module-runner.js.map +1 -0
- package/dist/native-escape.d.ts +2 -0
- package/dist/native-escape.d.ts.map +1 -0
- package/dist/native-escape.js +43 -0
- package/dist/native-escape.js.map +1 -0
- package/dist/native-route-matcher.d.ts +5 -0
- package/dist/native-route-matcher.d.ts.map +1 -0
- package/dist/native-route-matcher.js +91 -0
- package/dist/native-route-matcher.js.map +1 -0
- package/dist/navigation.d.ts +25 -0
- package/dist/navigation.d.ts.map +1 -0
- package/dist/navigation.js +125 -0
- package/dist/navigation.js.map +1 -0
- package/dist/prerender-store.d.ts +37 -0
- package/dist/prerender-store.d.ts.map +1 -0
- package/dist/prerender-store.js +158 -0
- package/dist/prerender-store.js.map +1 -0
- package/dist/render.d.ts +26 -0
- package/dist/render.d.ts.map +1 -0
- package/dist/render.js +1688 -0
- package/dist/render.js.map +1 -0
- package/dist/route-path.d.ts +2 -0
- package/dist/route-path.d.ts.map +1 -0
- package/dist/route-path.js +5 -0
- package/dist/route-path.js.map +1 -0
- package/dist/route-source.d.ts +9 -0
- package/dist/route-source.d.ts.map +1 -0
- package/dist/route-source.js +44 -0
- package/dist/route-source.js.map +1 -0
- package/dist/routes.d.ts +38 -0
- package/dist/routes.d.ts.map +1 -0
- package/dist/routes.js +168 -0
- package/dist/routes.js.map +1 -0
- package/dist/serve.d.ts +63 -0
- package/dist/serve.d.ts.map +1 -0
- package/dist/serve.js +445 -0
- package/dist/serve.js.map +1 -0
- package/dist/session.d.ts +25 -0
- package/dist/session.d.ts.map +1 -0
- package/dist/session.js +104 -0
- package/dist/session.js.map +1 -0
- package/dist/vite-config.d.ts +8 -0
- package/dist/vite-config.d.ts.map +1 -0
- package/dist/vite-config.js +17 -0
- package/dist/vite-config.js.map +1 -0
- package/dist/vite.d.ts +25 -0
- package/dist/vite.d.ts.map +1 -0
- package/dist/vite.js +150 -0
- package/dist/vite.js.map +1 -0
- package/package.json +91 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Tatsuo Kaniwa
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
|
13
|
+
all copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
21
|
+
THE SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
# @reckona/mreact-router
|
|
2
|
+
|
|
3
|
+
`@reckona/mreact-router` is the mreact app router. It covers file-system routes,
|
|
4
|
+
loaders, metadata, server actions, prerendering, and deployment adapters.
|
|
5
|
+
|
|
6
|
+
## Basic Usage
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
import { buildApp, renderBuiltAppRequest } from "@reckona/mreact-router";
|
|
10
|
+
|
|
11
|
+
await buildApp({
|
|
12
|
+
projectRoot: process.cwd(),
|
|
13
|
+
routesDir: "src/app",
|
|
14
|
+
publicDir: "public",
|
|
15
|
+
allowedSourceDirs: ["src"],
|
|
16
|
+
outDir: ".mreact",
|
|
17
|
+
});
|
|
18
|
+
|
|
19
|
+
const response = await renderBuiltAppRequest({
|
|
20
|
+
outDir: ".mreact",
|
|
21
|
+
request: new Request("https://example.test/"),
|
|
22
|
+
});
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
For application projects, configure the router explicitly in `vite.config.ts`:
|
|
26
|
+
|
|
27
|
+
```ts
|
|
28
|
+
import { defineConfig } from "vite";
|
|
29
|
+
import { mreactRouter } from "@reckona/mreact-router/vite";
|
|
30
|
+
|
|
31
|
+
export default defineConfig({
|
|
32
|
+
plugins: [
|
|
33
|
+
mreactRouter({
|
|
34
|
+
routesDir: "src/app",
|
|
35
|
+
publicDir: "public",
|
|
36
|
+
allowedSourceDirs: ["src"],
|
|
37
|
+
}),
|
|
38
|
+
],
|
|
39
|
+
});
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
`mreact-router build` reads this config. The legacy `appDir` shortcut remains
|
|
43
|
+
available for tests and older direct programmatic usage, but it is deprecated.
|
|
44
|
+
Use `projectRoot` + `routesDir` for new code. The shortcut is planned for
|
|
45
|
+
removal after `0.1.0`.
|
|
46
|
+
|
|
47
|
+
## Route Module Exports
|
|
48
|
+
|
|
49
|
+
- `loader(context)` returns data passed to the page component.
|
|
50
|
+
- `metadata` injects title, OpenGraph, viewport, and related head tags.
|
|
51
|
+
- `generateStaticParams()` returns dynamic route params to prerender.
|
|
52
|
+
- `prerender = true` emits HTML at build time.
|
|
53
|
+
- `"use server"` modules and `<form action={...}>` provide server actions.
|
|
54
|
+
|
|
55
|
+
## Deployment Adapters
|
|
56
|
+
|
|
57
|
+
- `@reckona/mreact-router/adapters/node`: Node `http` server adapter.
|
|
58
|
+
- `@reckona/mreact-router/adapters/static`: static export adapter for prerendered routes.
|
|
59
|
+
- `@reckona/mreact-router/adapters/edge`: generic `Request` / `Response` runtime adapter.
|
|
60
|
+
- `@reckona/mreact-router/adapters/cloudflare`: Cloudflare Workers adapter.
|
|
61
|
+
- `@reckona/mreact-router/adapters/aws-lambda`: AWS Lambda HTTP API v2 adapter.
|
|
62
|
+
|
|
63
|
+
For Cloudflare Workers, combine `createCloudflareBuiltRequestHandler`,
|
|
64
|
+
`createCloudflareStaticAssetLoader`, `createCloudflarePrerenderStore`, and
|
|
65
|
+
`createCloudflareRouteModuleRenderer`. Use `collectCloudflareRouteModules()` with
|
|
66
|
+
`import.meta.glob()` to build the dynamic route registry from the server
|
|
67
|
+
manifest. Client assets are served only when they appear in the generated
|
|
68
|
+
manifest allow-list. Dynamic routes should resolve modules through a build-time
|
|
69
|
+
registry keyed by `route.file`, not by constructing module ids from request
|
|
70
|
+
input.
|
|
71
|
+
|
|
72
|
+
For AWS Lambda, use `createAwsLambdaRequestHandler()` with API Gateway HTTP API
|
|
73
|
+
v2 or Lambda Function URL payload format 2.0:
|
|
74
|
+
|
|
75
|
+
```ts
|
|
76
|
+
import { createAwsLambdaRequestHandler } from "@reckona/mreact-router/adapters/aws-lambda";
|
|
77
|
+
|
|
78
|
+
export const handler = createAwsLambdaRequestHandler({
|
|
79
|
+
outDir: ".mreact",
|
|
80
|
+
});
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
The Lambda adapter returns proxy responses with `cookies`, `headers`,
|
|
84
|
+
`statusCode`, `body`, and `isBase64Encoded`. It buffers response bodies because
|
|
85
|
+
API Gateway and Lambda Function URL proxy responses do not expose true streaming
|
|
86
|
+
SSR. Prefer S3 + CloudFront for `.mreact/client` assets on production Lambda
|
|
87
|
+
deployments.
|
|
88
|
+
|
|
89
|
+
## Related APIs
|
|
90
|
+
|
|
91
|
+
- `renderAppRequest`: development and test API for rendering a source app directory.
|
|
92
|
+
- `renderBuiltAppRequest`: production API for rendering a `.mreact/` build artifact.
|
|
93
|
+
- `startDevServer`: dev server that watches the app directory.
|
|
94
|
+
- `startServer`: helper that serves a `.mreact/` build artifact with Node.
|
|
95
|
+
|
|
96
|
+
## Sessions
|
|
97
|
+
|
|
98
|
+
Application code should import session helpers from `@reckona/mreact-auth`:
|
|
99
|
+
`createMemorySessionStore()`, `createSession()`, `getSession()`,
|
|
100
|
+
`destroySession()`, and `rotateSession()`. The router still re-exports these
|
|
101
|
+
helpers for older code, but those re-exports are deprecated.
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
import { type ServerActionHandlerOptions, type ServerActionReplayStore } from "@reckona/mreact-server";
|
|
2
|
+
import { type AppRouterCache } from "./cache.js";
|
|
3
|
+
import { type AppRouterImportPolicy } from "./import-policy.js";
|
|
4
|
+
declare class BoundedReplayStore {
|
|
5
|
+
private readonly ttlMs;
|
|
6
|
+
private readonly maxEntries;
|
|
7
|
+
private readonly entries;
|
|
8
|
+
constructor(ttlMs: number, maxEntries: number);
|
|
9
|
+
has(value: string): boolean;
|
|
10
|
+
add(value: string): void;
|
|
11
|
+
size(): number;
|
|
12
|
+
}
|
|
13
|
+
export declare function __clearDefaultReplayStore(): void;
|
|
14
|
+
export declare function __readDefaultReplayStore(): BoundedReplayStore;
|
|
15
|
+
export interface AppRouterServerActionOptions {
|
|
16
|
+
authorize?: ServerActionHandlerOptions["authorize"] | undefined;
|
|
17
|
+
replayStore?: ServerActionReplayStore | undefined;
|
|
18
|
+
}
|
|
19
|
+
export interface PreparedRouteActions {
|
|
20
|
+
actionNonce?: string;
|
|
21
|
+
code: string;
|
|
22
|
+
csrfToken?: string;
|
|
23
|
+
csrfTokenIsNew?: boolean;
|
|
24
|
+
hasFormActions: boolean;
|
|
25
|
+
}
|
|
26
|
+
export declare function prepareRouteServerActions(options: {
|
|
27
|
+
appDir: string;
|
|
28
|
+
code: string;
|
|
29
|
+
pageFile: string;
|
|
30
|
+
request?: Request | undefined;
|
|
31
|
+
}): Promise<PreparedRouteActions>;
|
|
32
|
+
export declare function dispatchServerActionRequest(options: {
|
|
33
|
+
appDir: string;
|
|
34
|
+
importPolicy?: AppRouterImportPolicy | undefined;
|
|
35
|
+
request: Request;
|
|
36
|
+
routeCache?: AppRouterCache | undefined;
|
|
37
|
+
serverActionCacheVersion?: string | undefined;
|
|
38
|
+
serverActions?: AppRouterServerActionOptions | undefined;
|
|
39
|
+
}): Promise<Response>;
|
|
40
|
+
export declare function serverActionCookie(csrfToken: string): string;
|
|
41
|
+
export declare function __clearServerActionRegistryCache(): void;
|
|
42
|
+
export {};
|
|
43
|
+
//# sourceMappingURL=actions.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"actions.d.ts","sourceRoot":"","sources":["../src/actions.ts"],"names":[],"mappings":"AAIA,OAAO,EAEL,KAAK,0BAA0B,EAE/B,KAAK,uBAAuB,EAG7B,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EAAE,KAAK,cAAc,EAAyB,MAAM,YAAY,CAAC;AAExE,OAAO,EAAqC,KAAK,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AA8CnG,cAAM,kBAAkB;IAIpB,OAAO,CAAC,QAAQ,CAAC,KAAK;IACtB,OAAO,CAAC,QAAQ,CAAC,UAAU;IAJ7B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA6B;gBAGlC,KAAK,EAAE,MAAM,EACb,UAAU,EAAE,MAAM;IAGrC,GAAG,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO;IAU3B,GAAG,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAqBxB,IAAI,IAAI,MAAM;CAGf;AAUD,wBAAgB,yBAAyB,IAAI,IAAI,CAEhD;AAED,wBAAgB,wBAAwB,IAAI,kBAAkB,CAE7D;AAED,MAAM,WAAW,4BAA4B;IAC3C,SAAS,CAAC,EAAE,0BAA0B,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC;IAChE,WAAW,CAAC,EAAE,uBAAuB,GAAG,SAAS,CAAC;CACnD;AAED,MAAM,WAAW,oBAAoB;IACnC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;IAKnB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,cAAc,EAAE,OAAO,CAAC;CACzB;AAuBD,wBAAsB,yBAAyB,CAAC,OAAO,EAAE;IACvD,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAC/B,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAoChC;AAMD,wBAAsB,2BAA2B,CAAC,OAAO,EAAE;IACzD,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,qBAAqB,GAAG,SAAS,CAAC;IACjD,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;IACxC,wBAAwB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9C,aAAa,CAAC,EAAE,4BAA4B,GAAG,SAAS,CAAC;CAC1D,GAAG,OAAO,CAAC,QAAQ,CAAC,CAMpB;AAmMD,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAc5D;AAuID,wBAAgB,gCAAgC,IAAI,IAAI,CAEvD"}
|