@nexus_js/router 0.6.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/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Nexus Contributors
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 all
13
+ 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 THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,17 @@
1
+ # @nexus_js/router
2
+
3
+ Nexus file-based router with nested layouts and dynamic segments.
4
+
5
+ ## Documentation
6
+
7
+ All guides, API reference, and examples live on **[nexusjs.dev](https://nexusjs.dev)**.
8
+
9
+ ## Links
10
+
11
+ - **Website:** [https://nexusjs.dev](https://nexusjs.dev)
12
+ - **Repository:** [github.com/bierfor/nexus](https://github.com/bierfor/nexus) (see `packages/router/`)
13
+ - **Issues:** [github.com/bierfor/nexus/issues](https://github.com/bierfor/nexus/issues)
14
+
15
+ ## License
16
+
17
+ MIT © Nexus contributors
@@ -0,0 +1,34 @@
1
+ import type { RouteManifest, RouteEntry } from '@nexus_js/compiler';
2
+ export type { RouteManifest, RouteEntry };
3
+ export { extractTenant, scopeTenantKey, tenantHeaders, tenantVaryHeader, } from './tenant.js';
4
+ export type { TenantInfo, TenantConfig, TenantMode } from './tenant.js';
5
+ export interface MatchedRoute {
6
+ route: RouteEntry;
7
+ params: Record<string, string>;
8
+ layouts: RouteEntry[];
9
+ }
10
+ /**
11
+ * Scans a directory tree and builds a route manifest.
12
+ *
13
+ * File conventions:
14
+ * routes/
15
+ * ├── +layout.nx → root layout
16
+ * ├── +page.nx → /
17
+ * ├── about/
18
+ * │ └── +page.nx → /about
19
+ * ├── blog/
20
+ * │ ├── +layout.nx → nested layout for all /blog/* routes
21
+ * │ ├── +page.nx → /blog
22
+ * │ └── [slug]/
23
+ * │ └── +page.nx → /blog/:slug
24
+ * └── api/
25
+ * └── users/
26
+ * └── +server.nx → GET/POST /api/users (API route)
27
+ */
28
+ export declare function buildRouteManifest(routesDir: string): Promise<RouteManifest>;
29
+ /**
30
+ * Matches an incoming URL pathname against the route manifest.
31
+ * Returns the matched route + resolved params + layout chain.
32
+ */
33
+ export declare function matchRoute(pathname: string, manifest: RouteManifest): MatchedRoute | null;
34
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAEpE,YAAY,EAAE,aAAa,EAAE,UAAU,EAAE,CAAC;AAG1C,OAAO,EACL,aAAa,EACb,cAAc,EACd,aAAa,EACb,gBAAgB,GACjB,MAAM,aAAa,CAAC;AACrB,YAAY,EAAE,UAAU,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAExE,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,UAAU,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/B,OAAO,EAAE,UAAU,EAAE,CAAC;CACvB;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAsB,kBAAkB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAmClF;AAED;;;GAGG;AACH,wBAAgB,UAAU,CACxB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,aAAa,GACtB,YAAY,GAAG,IAAI,CAYrB"}
package/dist/index.js ADDED
@@ -0,0 +1,163 @@
1
+ import { readdir, stat } from 'node:fs/promises';
2
+ import { join, relative, extname, basename, dirname } from 'node:path';
3
+ // Re-export Multi-Tenant support
4
+ export { extractTenant, scopeTenantKey, tenantHeaders, tenantVaryHeader, } from './tenant.js';
5
+ /**
6
+ * Scans a directory tree and builds a route manifest.
7
+ *
8
+ * File conventions:
9
+ * routes/
10
+ * ├── +layout.nx → root layout
11
+ * ├── +page.nx → /
12
+ * ├── about/
13
+ * │ └── +page.nx → /about
14
+ * ├── blog/
15
+ * │ ├── +layout.nx → nested layout for all /blog/* routes
16
+ * │ ├── +page.nx → /blog
17
+ * │ └── [slug]/
18
+ * │ └── +page.nx → /blog/:slug
19
+ * └── api/
20
+ * └── users/
21
+ * └── +server.nx → GET/POST /api/users (API route)
22
+ */
23
+ export async function buildRouteManifest(routesDir) {
24
+ const files = await collectFiles(routesDir);
25
+ const routes = [];
26
+ for (const file of files) {
27
+ const rel = relative(routesDir, file);
28
+ const ext = extname(file);
29
+ const base = basename(file, ext);
30
+ if (!['.nx', '.ts', '.js'].includes(ext))
31
+ continue;
32
+ if (!base.startsWith('+'))
33
+ continue;
34
+ const isLayout = base === '+layout';
35
+ const isServerRoute = base === '+server';
36
+ const isPage = base === '+page';
37
+ if (!isLayout && !isServerRoute && !isPage)
38
+ continue;
39
+ const pattern = filePathToRoutePattern(rel, routesDir);
40
+ const params = extractParams(pattern);
41
+ routes.push({
42
+ pattern,
43
+ filepath: file,
44
+ params,
45
+ isDynamic: params.length > 0,
46
+ isLayout,
47
+ serverActions: [],
48
+ });
49
+ }
50
+ // Link layouts to their children
51
+ linkLayouts(routes);
52
+ return { routes };
53
+ }
54
+ /**
55
+ * Matches an incoming URL pathname against the route manifest.
56
+ * Returns the matched route + resolved params + layout chain.
57
+ */
58
+ export function matchRoute(pathname, manifest) {
59
+ const pageRoutes = manifest.routes.filter((r) => !r.isLayout);
60
+ for (const route of pageRoutes) {
61
+ const params = matchPattern(pathname, route.pattern);
62
+ if (params !== null) {
63
+ const layouts = resolveLayoutChain(route, manifest);
64
+ return { route, params, layouts };
65
+ }
66
+ }
67
+ return null;
68
+ }
69
+ /**
70
+ * Converts a file system path to a URL pattern.
71
+ *
72
+ * routes/blog/[slug]/+page.nx → /blog/:slug
73
+ * routes/+page.nx → /
74
+ * routes/about/+page.nx → /about
75
+ */
76
+ function filePathToRoutePattern(filepath, _routesDir) {
77
+ const parts = filepath.split('/').filter(Boolean);
78
+ const segments = [];
79
+ for (const part of parts) {
80
+ if (part.startsWith('+'))
81
+ continue; // skip +page, +layout
82
+ if (part.startsWith('[') && part.endsWith(']')) {
83
+ // Dynamic segment [slug] → :slug
84
+ segments.push(':' + part.slice(1, -1));
85
+ }
86
+ else if (part.startsWith('(') && part.endsWith(')')) {
87
+ // Route group (auth) — invisible in URL
88
+ continue;
89
+ }
90
+ else {
91
+ segments.push(part);
92
+ }
93
+ }
94
+ return '/' + segments.join('/');
95
+ }
96
+ function extractParams(pattern) {
97
+ return [...pattern.matchAll(/:(\w+)/g)].map((m) => m[1] ?? '');
98
+ }
99
+ function matchPattern(pathname, pattern) {
100
+ const patternParts = pattern.split('/').filter(Boolean);
101
+ const pathParts = pathname.split('/').filter(Boolean);
102
+ if (patternParts.length !== pathParts.length)
103
+ return null;
104
+ const params = {};
105
+ for (let i = 0; i < patternParts.length; i++) {
106
+ const pp = patternParts[i] ?? '';
107
+ const path = pathParts[i] ?? '';
108
+ if (pp.startsWith(':')) {
109
+ params[pp.slice(1)] = decodeURIComponent(path);
110
+ }
111
+ else if (pp !== path) {
112
+ return null;
113
+ }
114
+ }
115
+ return params;
116
+ }
117
+ function resolveLayoutChain(route, manifest) {
118
+ const layouts = [];
119
+ const layoutRoutes = manifest.routes.filter((r) => r.isLayout);
120
+ // Walk up the path tree to find applicable layouts
121
+ const parts = route.pattern.split('/').filter(Boolean);
122
+ const prefixes = ['/', ...parts.map((_, i) => '/' + parts.slice(0, i + 1).join('/'))];
123
+ for (const prefix of prefixes) {
124
+ const layout = layoutRoutes.find((l) => l.pattern === prefix);
125
+ if (layout)
126
+ layouts.push(layout);
127
+ }
128
+ return layouts;
129
+ }
130
+ function linkLayouts(routes) {
131
+ const layouts = routes.filter((r) => r.isLayout);
132
+ for (const route of routes) {
133
+ if (route.isLayout)
134
+ continue;
135
+ const parentDir = dirname(route.pattern);
136
+ const parentLayout = layouts.find((l) => l.pattern === parentDir);
137
+ if (parentLayout) {
138
+ route.parentLayout = parentLayout.filepath;
139
+ }
140
+ }
141
+ }
142
+ async function collectFiles(dir) {
143
+ const results = [];
144
+ let entries;
145
+ try {
146
+ entries = await readdir(dir);
147
+ }
148
+ catch {
149
+ return results;
150
+ }
151
+ for (const entry of entries) {
152
+ const fullPath = join(dir, entry);
153
+ const info = await stat(fullPath);
154
+ if (info.isDirectory()) {
155
+ results.push(...(await collectFiles(fullPath)));
156
+ }
157
+ else {
158
+ results.push(fullPath);
159
+ }
160
+ }
161
+ return results;
162
+ }
163
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAKvE,iCAAiC;AACjC,OAAO,EACL,aAAa,EACb,cAAc,EACd,aAAa,EACb,gBAAgB,GACjB,MAAM,aAAa,CAAC;AASrB;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,SAAiB;IACxD,MAAM,KAAK,GAAG,MAAM,YAAY,CAAC,SAAS,CAAC,CAAC;IAC5C,MAAM,MAAM,GAAiB,EAAE,CAAC;IAEhC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,GAAG,GAAG,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;QACtC,MAAM,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAC1B,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAEjC,IAAI,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC;YAAE,SAAS;QACnD,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;YAAE,SAAS;QAEpC,MAAM,QAAQ,GAAG,IAAI,KAAK,SAAS,CAAC;QACpC,MAAM,aAAa,GAAG,IAAI,KAAK,SAAS,CAAC;QACzC,MAAM,MAAM,GAAG,IAAI,KAAK,OAAO,CAAC;QAEhC,IAAI,CAAC,QAAQ,IAAI,CAAC,aAAa,IAAI,CAAC,MAAM;YAAE,SAAS;QAErD,MAAM,OAAO,GAAG,sBAAsB,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QACvD,MAAM,MAAM,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;QAEtC,MAAM,CAAC,IAAI,CAAC;YACV,OAAO;YACP,QAAQ,EAAE,IAAI;YACd,MAAM;YACN,SAAS,EAAE,MAAM,CAAC,MAAM,GAAG,CAAC;YAC5B,QAAQ;YACR,aAAa,EAAE,EAAE;SAClB,CAAC,CAAC;IACL,CAAC;IAED,iCAAiC;IACjC,WAAW,CAAC,MAAM,CAAC,CAAC;IAEpB,OAAO,EAAE,MAAM,EAAE,CAAC;AACpB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,UAAU,CACxB,QAAgB,EAChB,QAAuB;IAEvB,MAAM,UAAU,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;IAE9D,KAAK,MAAM,KAAK,IAAI,UAAU,EAAE,CAAC;QAC/B,MAAM,MAAM,GAAG,YAAY,CAAC,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;QACrD,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;YACpB,MAAM,OAAO,GAAG,kBAAkB,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;YACpD,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;QACpC,CAAC;IACH,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;GAMG;AACH,SAAS,sBAAsB,CAAC,QAAgB,EAAE,UAAkB;IAClE,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAClD,MAAM,QAAQ,GAAa,EAAE,CAAC;IAE9B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;YAAE,SAAS,CAAC,sBAAsB;QAC1D,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YAC/C,iCAAiC;YACjC,QAAQ,CAAC,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QACzC,CAAC;aAAM,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YACtD,wCAAwC;YACxC,SAAS;QACX,CAAC;aAAM,CAAC;YACN,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACtB,CAAC;IACH,CAAC;IAED,OAAO,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAClC,CAAC;AAED,SAAS,aAAa,CAAC,OAAe;IACpC,OAAO,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;AACjE,CAAC;AAED,SAAS,YAAY,CACnB,QAAgB,EAChB,OAAe;IAEf,MAAM,YAAY,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACxD,MAAM,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAEtD,IAAI,YAAY,CAAC,MAAM,KAAK,SAAS,CAAC,MAAM;QAAE,OAAO,IAAI,CAAC;IAE1D,MAAM,MAAM,GAA2B,EAAE,CAAC;IAC1C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,YAAY,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAC7C,MAAM,EAAE,GAAG,YAAY,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QACjC,MAAM,IAAI,GAAG,SAAS,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAChC,IAAI,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YACvB,MAAM,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,kBAAkB,CAAC,IAAI,CAAC,CAAC;QACjD,CAAC;aAAM,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC;YACvB,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,kBAAkB,CACzB,KAAiB,EACjB,QAAuB;IAEvB,MAAM,OAAO,GAAiB,EAAE,CAAC;IACjC,MAAM,YAAY,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;IAE/D,mDAAmD;IACnD,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACvD,MAAM,QAAQ,GAAG,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAEtF,KAAK,MAAM,MAAM,IAAI,QAAQ,EAAE,CAAC;QAC9B,MAAM,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,MAAM,CAAC,CAAC;QAC9D,IAAI,MAAM;YAAE,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,SAAS,WAAW,CAAC,MAAoB;IACvC,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;IACjD,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,IAAI,KAAK,CAAC,QAAQ;YAAE,SAAS;QAC7B,MAAM,SAAS,GAAG,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACzC,MAAM,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC;QAClE,IAAI,YAAY,EAAE,CAAC;YACjB,KAAK,CAAC,YAAY,GAAG,YAAY,CAAC,QAAQ,CAAC;QAC7C,CAAC;IACH,CAAC;AACH,CAAC;AAED,KAAK,UAAU,YAAY,CAAC,GAAW;IACrC,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,IAAI,OAAiB,CAAC;IAEtB,IAAI,CAAC;QACH,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC;IAC/B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;QAC5B,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAClC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,CAAC;QAClC,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YACvB,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QAClD,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACzB,CAAC;IACH,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC"}
@@ -0,0 +1,72 @@
1
+ /**
2
+ * Nexus Multi-Tenant — First-Class Tenant Isolation.
3
+ *
4
+ * Detects the tenant from the incoming request (subdomain or custom domain)
5
+ * and provides a typed TenantContext that's automatically available in every
6
+ * .nx file via $context().tenant.
7
+ *
8
+ * Modes:
9
+ * 'subdomain' → empresa-a.nexus.app → tenant.id = 'empresa-a'
10
+ * 'custom-domain' → empresa-b.com → tenant.id resolved by resolver fn
11
+ * 'path' → nexus.app/t/empresa-a/dashboard → tenant.id = 'empresa-a'
12
+ *
13
+ * The router automatically:
14
+ * - Isolates Cache-Control per tenant (x-nexus-tenant-id header)
15
+ * - Scopes Shield Cache keys: `${tenantId}:${routeKey}`
16
+ * - Passes tenant to every Server Action via ctx.tenant
17
+ * - Prevents cross-tenant data leaks by design
18
+ */
19
+ export type TenantMode = 'subdomain' | 'custom-domain' | 'path' | 'disabled';
20
+ export interface TenantInfo {
21
+ /** Unique identifier for this tenant (e.g. 'empresa-a') */
22
+ id: string;
23
+ /** Full hostname as received (empresa-a.nexus.app or empresa-b.com) */
24
+ domain: string;
25
+ /** true if tenant is using a custom domain (not the base domain) */
26
+ isCustomDomain: boolean;
27
+ /** Subdomain portion (only set in subdomain mode) */
28
+ subdomain?: string | undefined;
29
+ /** Resolved metadata from your resolver function */
30
+ meta?: Record<string, unknown> | undefined;
31
+ }
32
+ export interface TenantConfig<TMeta = Record<string, unknown>> {
33
+ mode: TenantMode;
34
+ /** Your app's base domain (e.g. 'nexus.app') */
35
+ baseDomain?: string;
36
+ /** Path prefix for path-based tenancy (e.g. '/t/') */
37
+ pathPrefix?: string;
38
+ /**
39
+ * Optional async resolver — fetch tenant metadata (name, plan, logo, etc.)
40
+ * from your DB when a tenant is identified. Result is cached per request.
41
+ */
42
+ resolve?: (tenantId: string, request: Request) => Promise<TMeta | null>;
43
+ /** Tenant to use when no tenant is detected (e.g. your main marketing site) */
44
+ fallback?: TenantInfo;
45
+ }
46
+ /**
47
+ * Extracts tenant information from a Web-standard Request.
48
+ * Returns null if the request doesn't map to any tenant
49
+ * (e.g. the root marketing site).
50
+ */
51
+ export declare function extractTenant<TMeta = Record<string, unknown>>(request: Request, config: TenantConfig<TMeta>): Promise<TenantInfo | null>;
52
+ /**
53
+ * Scopes a Shield Cache key to a specific tenant.
54
+ * Prevents data from tenant A being served to tenant B.
55
+ *
56
+ * @example
57
+ * const cacheKey = scopeTenantKey(tenant, `list:${page}`);
58
+ * // → 'empresa-a:list:1'
59
+ */
60
+ export declare function scopeTenantKey(tenant: TenantInfo | null, key: string): string;
61
+ /**
62
+ * Middleware-style helper — reads or injects the tenant into request headers.
63
+ * Useful for logging and downstream cache isolation.
64
+ */
65
+ export declare function tenantHeaders(tenant: TenantInfo | null): Record<string, string>;
66
+ /**
67
+ * Helper: builds a tenant-aware Cache-Control vary header.
68
+ * CDNs that respect Vary will automatically serve different cache entries
69
+ * per tenant when using subdomain routing.
70
+ */
71
+ export declare function tenantVaryHeader(mode: TenantMode): string;
72
+ //# sourceMappingURL=tenant.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"tenant.d.ts","sourceRoot":"","sources":["../src/tenant.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,MAAM,MAAM,UAAU,GAAG,WAAW,GAAG,eAAe,GAAG,MAAM,GAAG,UAAU,CAAC;AAE7E,MAAM,WAAW,UAAU;IACzB,2DAA2D;IAC3D,EAAE,EAAe,MAAM,CAAC;IACxB,uEAAuE;IACvE,MAAM,EAAW,MAAM,CAAC;IACxB,oEAAoE;IACpE,cAAc,EAAG,OAAO,CAAC;IACzB,qDAAqD;IACrD,SAAS,CAAC,EAAO,MAAM,GAAG,SAAS,CAAC;IACpC,oDAAoD;IACpD,IAAI,CAAC,EAAY,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;CACtD;AAED,MAAM,WAAW,YAAY,CAAC,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAC3D,IAAI,EAAQ,UAAU,CAAC;IACvB,gDAAgD;IAChD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,sDAAsD;IACtD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,OAAO,CAAC,EAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,KAAK,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC;IAC1E,+EAA+E;IAC/E,QAAQ,CAAC,EAAG,UAAU,CAAC;CACxB;AAuBD;;;;GAIG;AACH,wBAAsB,aAAa,CAAC,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACjE,OAAO,EAAE,OAAO,EAChB,MAAM,EAAE,YAAY,CAAC,KAAK,CAAC,GAC1B,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CA4D5B;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,UAAU,GAAG,IAAI,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAE7E;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,UAAU,GAAG,IAAI,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAO/E;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,CAOzD"}
package/dist/tenant.js ADDED
@@ -0,0 +1,140 @@
1
+ /**
2
+ * Nexus Multi-Tenant — First-Class Tenant Isolation.
3
+ *
4
+ * Detects the tenant from the incoming request (subdomain or custom domain)
5
+ * and provides a typed TenantContext that's automatically available in every
6
+ * .nx file via $context().tenant.
7
+ *
8
+ * Modes:
9
+ * 'subdomain' → empresa-a.nexus.app → tenant.id = 'empresa-a'
10
+ * 'custom-domain' → empresa-b.com → tenant.id resolved by resolver fn
11
+ * 'path' → nexus.app/t/empresa-a/dashboard → tenant.id = 'empresa-a'
12
+ *
13
+ * The router automatically:
14
+ * - Isolates Cache-Control per tenant (x-nexus-tenant-id header)
15
+ * - Scopes Shield Cache keys: `${tenantId}:${routeKey}`
16
+ * - Passes tenant to every Server Action via ctx.tenant
17
+ * - Prevents cross-tenant data leaks by design
18
+ */
19
+ // ── Extraction helpers ────────────────────────────────────────────────────────
20
+ function extractSubdomain(host, baseDomain) {
21
+ // empresa-a.nexus.app → empresa-a (baseDomain = 'nexus.app')
22
+ // nexus.app → null (it's the root domain)
23
+ // empresa-b.com → null (not a subdomain of baseDomain)
24
+ if (!host.endsWith(`.${baseDomain}`))
25
+ return null;
26
+ const sub = host.slice(0, host.length - baseDomain.length - 1);
27
+ return sub.length > 0 && !sub.includes('.') ? sub : null;
28
+ }
29
+ function extractPathTenant(pathname, prefix) {
30
+ // /t/empresa-a/dashboard → empresa-a (prefix = '/t/')
31
+ if (!pathname.startsWith(prefix))
32
+ return null;
33
+ const rest = pathname.slice(prefix.length);
34
+ const id = rest.split('/')[0];
35
+ return id?.length ? id : null;
36
+ }
37
+ // ── Public API ────────────────────────────────────────────────────────────────
38
+ /**
39
+ * Extracts tenant information from a Web-standard Request.
40
+ * Returns null if the request doesn't map to any tenant
41
+ * (e.g. the root marketing site).
42
+ */
43
+ export async function extractTenant(request, config) {
44
+ if (config.mode === 'disabled')
45
+ return config.fallback ?? null;
46
+ const url = new URL(request.url);
47
+ const host = request.headers.get('host') ?? url.hostname;
48
+ let tenantId = null;
49
+ let isCustomDomain = false;
50
+ let subdomain;
51
+ switch (config.mode) {
52
+ case 'subdomain': {
53
+ const base = config.baseDomain ?? url.hostname.split('.').slice(1).join('.');
54
+ subdomain = extractSubdomain(host, base) ?? undefined;
55
+ if (!subdomain)
56
+ return config.fallback ?? null;
57
+ tenantId = subdomain;
58
+ break;
59
+ }
60
+ case 'custom-domain': {
61
+ const base = config.baseDomain ?? '';
62
+ // If it matches the base domain → not a custom domain
63
+ if (base && (host === base || host.endsWith(`.${base}`))) {
64
+ subdomain = extractSubdomain(host, base) ?? undefined;
65
+ tenantId = subdomain ?? null;
66
+ }
67
+ else {
68
+ // Fully custom domain
69
+ isCustomDomain = true;
70
+ tenantId = host;
71
+ }
72
+ if (!tenantId)
73
+ return config.fallback ?? null;
74
+ break;
75
+ }
76
+ case 'path': {
77
+ const prefix = config.pathPrefix ?? '/t/';
78
+ tenantId = extractPathTenant(url.pathname, prefix);
79
+ if (!tenantId)
80
+ return config.fallback ?? null;
81
+ break;
82
+ }
83
+ }
84
+ const tenant = {
85
+ id: tenantId,
86
+ domain: host,
87
+ isCustomDomain,
88
+ subdomain,
89
+ };
90
+ // Resolve optional metadata (plan, logo, DB row, etc.)
91
+ if (config.resolve) {
92
+ try {
93
+ const meta = await config.resolve(tenantId, request);
94
+ if (meta)
95
+ tenant.meta = meta;
96
+ }
97
+ catch {
98
+ // Resolver failure → still return tenant with no meta (don't 500)
99
+ }
100
+ }
101
+ return tenant;
102
+ }
103
+ /**
104
+ * Scopes a Shield Cache key to a specific tenant.
105
+ * Prevents data from tenant A being served to tenant B.
106
+ *
107
+ * @example
108
+ * const cacheKey = scopeTenantKey(tenant, `list:${page}`);
109
+ * // → 'empresa-a:list:1'
110
+ */
111
+ export function scopeTenantKey(tenant, key) {
112
+ return tenant ? `${tenant.id}:${key}` : key;
113
+ }
114
+ /**
115
+ * Middleware-style helper — reads or injects the tenant into request headers.
116
+ * Useful for logging and downstream cache isolation.
117
+ */
118
+ export function tenantHeaders(tenant) {
119
+ if (!tenant)
120
+ return {};
121
+ return {
122
+ 'x-nexus-tenant': tenant.id,
123
+ 'x-nexus-tenant-domain': tenant.domain,
124
+ ...(tenant.isCustomDomain ? { 'x-nexus-custom-domain': '1' } : {}),
125
+ };
126
+ }
127
+ /**
128
+ * Helper: builds a tenant-aware Cache-Control vary header.
129
+ * CDNs that respect Vary will automatically serve different cache entries
130
+ * per tenant when using subdomain routing.
131
+ */
132
+ export function tenantVaryHeader(mode) {
133
+ switch (mode) {
134
+ case 'subdomain':
135
+ case 'custom-domain': return 'host';
136
+ case 'path': return 'x-nexus-tenant';
137
+ default: return '';
138
+ }
139
+ }
140
+ //# sourceMappingURL=tenant.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"tenant.js","sourceRoot":"","sources":["../src/tenant.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAgCH,iFAAiF;AAEjF,SAAS,gBAAgB,CAAC,IAAY,EAAE,UAAkB;IACxD,8DAA8D;IAC9D,0CAA0C;IAC1C,uDAAuD;IACvD,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,UAAU,EAAE,CAAC;QAAE,OAAO,IAAI,CAAC;IAClD,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAC/D,OAAO,GAAG,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC;AAC3D,CAAC;AAED,SAAS,iBAAiB,CAAC,QAAgB,EAAE,MAAc;IACzD,uDAAuD;IACvD,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC;QAAE,OAAO,IAAI,CAAC;IAC9C,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC3C,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9B,OAAO,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;AAChC,CAAC;AAED,iFAAiF;AAEjF;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,OAAgB,EAChB,MAA2B;IAE3B,IAAI,MAAM,CAAC,IAAI,KAAK,UAAU;QAAE,OAAO,MAAM,CAAC,QAAQ,IAAI,IAAI,CAAC;IAE/D,MAAM,GAAG,GAAI,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAClC,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC;IAEzD,IAAI,QAAQ,GAAkB,IAAI,CAAC;IACnC,IAAI,cAAc,GAAG,KAAK,CAAC;IAC3B,IAAI,SAA6B,CAAC;IAElC,QAAQ,MAAM,CAAC,IAAI,EAAE,CAAC;QACpB,KAAK,WAAW,CAAC,CAAC,CAAC;YACjB,MAAM,IAAI,GAAG,MAAM,CAAC,UAAU,IAAI,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC7E,SAAS,GAAG,gBAAgB,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,SAAS,CAAC;YACtD,IAAI,CAAC,SAAS;gBAAE,OAAO,MAAM,CAAC,QAAQ,IAAI,IAAI,CAAC;YAC/C,QAAQ,GAAG,SAAS,CAAC;YACrB,MAAM;QACR,CAAC;QAED,KAAK,eAAe,CAAC,CAAC,CAAC;YACrB,MAAM,IAAI,GAAG,MAAM,CAAC,UAAU,IAAI,EAAE,CAAC;YACrC,sDAAsD;YACtD,IAAI,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC;gBACzD,SAAS,GAAG,gBAAgB,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,SAAS,CAAC;gBACtD,QAAQ,GAAI,SAAS,IAAI,IAAI,CAAC;YAChC,CAAC;iBAAM,CAAC;gBACN,sBAAsB;gBACtB,cAAc,GAAG,IAAI,CAAC;gBACtB,QAAQ,GAAG,IAAI,CAAC;YAClB,CAAC;YACD,IAAI,CAAC,QAAQ;gBAAE,OAAO,MAAM,CAAC,QAAQ,IAAI,IAAI,CAAC;YAC9C,MAAM;QACR,CAAC;QAED,KAAK,MAAM,CAAC,CAAC,CAAC;YACZ,MAAM,MAAM,GAAG,MAAM,CAAC,UAAU,IAAI,KAAK,CAAC;YAC1C,QAAQ,GAAG,iBAAiB,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YACnD,IAAI,CAAC,QAAQ;gBAAE,OAAO,MAAM,CAAC,QAAQ,IAAI,IAAI,CAAC;YAC9C,MAAM;QACR,CAAC;IACH,CAAC;IAED,MAAM,MAAM,GAAe;QACzB,EAAE,EAAc,QAAS;QACzB,MAAM,EAAU,IAAI;QACpB,cAAc;QACd,SAAS;KACV,CAAC;IAEF,uDAAuD;IACvD,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACnB,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,QAAS,EAAE,OAAO,CAAC,CAAC;YACtD,IAAI,IAAI;gBAAE,MAAM,CAAC,IAAI,GAAG,IAA+B,CAAC;QAC1D,CAAC;QAAC,MAAM,CAAC;YACP,kEAAkE;QACpE,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,cAAc,CAAC,MAAyB,EAAE,GAAW;IACnE,OAAO,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;AAC9C,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,aAAa,CAAC,MAAyB;IACrD,IAAI,CAAC,MAAM;QAAE,OAAO,EAAE,CAAC;IACvB,OAAO;QACL,gBAAgB,EAAS,MAAM,CAAC,EAAE;QAClC,uBAAuB,EAAE,MAAM,CAAC,MAAM;QACtC,GAAG,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,uBAAuB,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACnE,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAAC,IAAgB;IAC/C,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,WAAW,CAAC;QACjB,KAAK,eAAe,CAAC,CAAC,OAAO,MAAM,CAAC;QACpC,KAAK,MAAM,CAAC,CAAU,OAAO,gBAAgB,CAAC;QAC9C,OAAO,CAAC,CAAc,OAAO,EAAE,CAAC;IAClC,CAAC;AACH,CAAC"}
package/package.json ADDED
@@ -0,0 +1,56 @@
1
+ {
2
+ "name": "@nexus_js/router",
3
+ "version": "0.6.0",
4
+ "description": "Nexus file-based router with nested layouts and dynamic segments",
5
+ "type": "module",
6
+ "main": "./dist/index.js",
7
+ "types": "./dist/index.d.ts",
8
+ "exports": {
9
+ ".": {
10
+ "import": "./dist/index.js",
11
+ "types": "./dist/index.d.ts"
12
+ }
13
+ },
14
+ "dependencies": {
15
+ "@nexus_js/compiler": "0.6.0"
16
+ },
17
+ "devDependencies": {
18
+ "@types/node": "^22.0.0",
19
+ "typescript": "^5.5.0",
20
+ "vitest": "^2.0.0"
21
+ },
22
+ "license": "MIT",
23
+ "homepage": "https://nexusjs.dev",
24
+ "repository": {
25
+ "type": "git",
26
+ "url": "https://github.com/bierfor/nexus.git",
27
+ "directory": "packages/router"
28
+ },
29
+ "bugs": {
30
+ "url": "https://github.com/bierfor/nexus/issues"
31
+ },
32
+ "keywords": [
33
+ "nexus",
34
+ "framework",
35
+ "full-stack",
36
+ "svelte",
37
+ "islands",
38
+ "ssr",
39
+ "vite",
40
+ "server-actions"
41
+ ],
42
+ "files": [
43
+ "dist",
44
+ "README.md"
45
+ ],
46
+ "publishConfig": {
47
+ "access": "public",
48
+ "registry": "https://registry.npmjs.org/"
49
+ },
50
+ "scripts": {
51
+ "build": "tsc -p tsconfig.json",
52
+ "dev": "tsc -p tsconfig.json --watch",
53
+ "test": "vitest run --passWithNoTests",
54
+ "clean": "rm -rf dist"
55
+ }
56
+ }