@zudojs/tenancy 1.0.0 → 1.1.0

package/README.md

@@ -79,6 +79,12 @@ strips and re-sets the header at the edge.
   a schema name, or a path. `tenantKey` escapes its segments as well.
 - Non-active tenants are refused during resolution. Pass `allowInactive` on
   routes that exist to serve suspended tenants.
+- A request that resolves to no tenant at all is answered `404`. Pass
+  `optional: true` to `createResolveTenantMiddleware` on routes where a tenant
+  may be absent; a tenant that _was_ named but is unknown, untrusted or
+  suspended is still refused.
+- `createPathResolver({ prefix })` only names a tenant for paths under the
+  prefix; `/health` never resolves to a tenant called `health`.
 
 ## Use Cases
 

package/dist/context/contextManager.core.d.ts

@@ -28,7 +28,7 @@ export declare function createContextManager(options: ContextManagerOptions): {
     /**
      * Get the current tenant, if any.
      */
-    getCurrentTenant(): Tenant | undefined;
+    getCurrentTenant: () => Tenant | undefined;
     /**
      * Require a current tenant — throws if missing.
      */
@@ -43,7 +43,7 @@ export declare function createContextManager(options: ContextManagerOptions): {
      * @throws {TenantUnavailableError} when the tenant is not active and
      *   `allowInactive` was not set.
      */
-    run<T>(tenant: Tenant, callback: () => T): T;
+    run: <T>(tenant: Tenant, callback: () => T) => T;
     /**
      * Run a callback in system mode (no tenant).
      */

package/dist/context/contextManager.core.js

@@ -11,6 +11,31 @@ import { assertTenantUsable } from "../security/guard.core.js";
 export function createContextManager(options) {
     const { storage } = options;
     const allowInactive = options.allowInactive ?? false;
+    // Methods close over these rather than reading `this`, so a method pulled
+    // off the manager (`const { requireCurrentTenant } = manager`) still works
+    // instead of failing with a TypeError that masks the real error.
+    function getCurrentTenant() {
+        const ctx = storage.get();
+        if (ctx?.mode === "tenant")
+            return ctx.tenant;
+        return undefined;
+    }
+    function run(tenant, callback) {
+        if (!allowInactive)
+            assertTenantUsable(tenant);
+        const context = {
+            mode: "tenant",
+            tenant,
+            context: {
+                tenantId: tenant.id,
+                source: "manual",
+                trust: "trusted",
+                resolvedAt: new Date(),
+                metadata: {},
+            },
+        };
+        return storage.run(context, callback);
+    }
     return {
         /**
          * Get the current execution context.
@@ -21,17 +46,12 @@ export function createContextManager(options) {
         /**
          * Get the current tenant, if any.
          */
-        getCurrentTenant() {
-            const ctx = storage.get();
-            if (ctx?.mode === "tenant")
-                return ctx.tenant;
-            return undefined;
-        },
+        getCurrentTenant,
         /**
          * Require a current tenant — throws if missing.
          */
         requireCurrentTenant() {
-            const tenant = this.getCurrentTenant();
+            const tenant = getCurrentTenant();
             if (!tenant)
                 throw new TenantContextMissingError();
             return tenant;
@@ -49,22 +69,7 @@ export function createContextManager(options) {
          * @throws {TenantUnavailableError} when the tenant is not active and
          *   `allowInactive` was not set.
          */
-        run(tenant, callback) {
-            if (!allowInactive)
-                assertTenantUsable(tenant);
-            const context = {
-                mode: "tenant",
-                tenant,
-                context: {
-                    tenantId: tenant.id,
-                    source: "manual",
-                    trust: "trusted",
-                    resolvedAt: new Date(),
-                    metadata: {},
-                },
-            };
-            return storage.run(context, callback);
-        },
+        run,
         /**
          * Run a callback in system mode (no tenant).
          */
@@ -76,7 +81,7 @@ export function createContextManager(options) {
          * Run a callback with a specific tenant (for switching).
          */
         runAs(tenant, callback) {
-            return this.run(tenant, callback);
+            return run(tenant, callback);
         },
     };
 }

package/dist/http/tenancyMiddleware.core.d.ts

@@ -39,6 +39,17 @@ export interface ResolveTenantMiddlewareOptions {
      * billing or reactivation.
      */
     readonly allowInactive?: boolean;
+    /**
+     * Let a request that resolves to no tenant at all continue without one.
+     * Defaults to false, which answers 404.
+     *
+     * This is what makes `createRequireTenantMiddleware({ requirement:
+     * "optional" })` reachable: without it the resolve middleware refuses every
+     * tenant-less request before the requirement is consulted. A resolution
+     * that *was* produced is still checked in full — an unknown, untrusted or
+     * suspended tenant is refused whether or not this is set.
+     */
+    readonly optional?: boolean;
     /** Reads verified token claims for the JWT resolver. */
     readonly getClaims?: (context: HttpMiddlewareContext) => TenantClaims | undefined;
     /** Custom error response for missing tenant. */

package/dist/http/tenancyMiddleware.core.js

@@ -45,6 +45,8 @@ export function createResolveTenantMiddleware(options) {
             throw error;
         }
         if (!resolution) {
+            if (options.optional)
+                return next();
             return options.notFoundResponse
                 ? {
                     status: 404,

package/dist/repository/tenantManager.core.d.ts

@@ -38,15 +38,17 @@ export declare function createTenantManager(options: TenantManagerOptions): {
     /**
      * Require a tenant by ID — throws if not found.
      */
-    require(id: TenantId): Promise<Tenant>;
+    require: (id: TenantId) => Promise<Tenant>;
     /**
      * Require a tenant that is also in an active state.
+     *
+     * Does not read `this`, so it survives being detached from the manager.
      */
     requireActive(id: TenantId): Promise<Tenant>;
     /**
      * Validate that a tenant is in an active state.
      */
-    assertActive(tenant: Tenant): void;
+    assertActive: (tenant: Tenant) => void;
     /**
      * Get the current tenant from context.
      */

package/dist/repository/tenantManager.core.js

@@ -36,6 +36,17 @@ export function createTenantManager(options) {
         }
         return tenant;
     }
+    function assertActive(tenant) {
+        if (tenant.status !== "active") {
+            throw new TenantUnavailableError(tenant.id, tenant.status);
+        }
+    }
+    async function require(id) {
+        const tenant = await loadTenant(id);
+        if (!tenant)
+            throw new TenantNotFoundError(id);
+        return tenant;
+    }
     return {
         /**
          * Resolve tenant from a resolution.
@@ -52,28 +63,21 @@ export function createTenantManager(options) {
         /**
          * Require a tenant by ID — throws if not found.
          */
-        async require(id) {
-            const tenant = await loadTenant(id);
-            if (!tenant)
-                throw new TenantNotFoundError(id);
-            return tenant;
-        },
+        require,
         /**
          * Require a tenant that is also in an active state.
+         *
+         * Does not read `this`, so it survives being detached from the manager.
          */
         async requireActive(id) {
-            const tenant = await this.require(id);
-            this.assertActive(tenant);
+            const tenant = await require(id);
+            assertActive(tenant);
             return tenant;
         },
         /**
          * Validate that a tenant is in an active state.
          */
-        assertActive(tenant) {
-            if (tenant.status !== "active") {
-                throw new TenantUnavailableError(tenant.id, tenant.status);
-            }
-        },
+        assertActive,
         /**
          * Get the current tenant from context.
          */

package/dist/resolver/resolvers/pathResolver.core.d.ts

@@ -10,7 +10,12 @@ export interface PathContext {
 }
 /** Options for the path resolver. */
 export interface PathResolverOptions {
-    /** Prefix to strip (e.g. "/tenant"). */
+    /**
+     * Prefix to strip (e.g. "/tenant").
+     *
+     * When set, only paths under the prefix name a tenant; any other path
+     * resolves to nothing.
+     */
     readonly prefix?: string;
     readonly priority?: number;
 }

package/dist/resolver/resolvers/pathResolver.core.js

@@ -21,11 +21,16 @@ export function createPathResolver(options) {
                 return undefined;
             let segments = path.split("/").filter(Boolean);
             if (prefix) {
+                // A prefix scopes this resolver to the routes mounted under it. A
+                // path outside the prefix must not name a tenant at all: otherwise
+                // `/health` resolves tenant "health" and `/admin/...` resolves
+                // whatever tenant happens to be called "admin".
                 const prefixSegments = prefix.split("/").filter(Boolean);
-                if (segments.slice(0, prefixSegments.length).join("/") ===
+                if (segments.slice(0, prefixSegments.length).join("/") !==
                     prefixSegments.join("/")) {
-                    segments = segments.slice(prefixSegments.length);
+                    return undefined;
                 }
+                segments = segments.slice(prefixSegments.length);
             }
             if (segments.length === 0)
                 return undefined;

package/package.json

@@ -1,8 +1,12 @@
 {
   "name": "@zudojs/tenancy",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Multi-tenant context and isolation with tenant resolution, AsyncLocalStorage propagation, resolver chains, trust levels, and guard middleware.",
   "license": "MIT",
+  "author": {
+    "name": "Oluwayemi Oyinlola",
+    "url": "https://github.com/oyinlola-tech"
+  },
   "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
@@ -21,11 +25,11 @@
     "!dist/.tsbuildinfo"
   ],
   "dependencies": {
-    "@zudojs/errors": "1.0.0",
-    "@zudojs/constants": "1.0.0"
+    "@zudojs/errors": "1.0.1",
+    "@zudojs/constants": "1.0.1"
   },
   "peerDependencies": {
-    "@zudojs/http": "1.0.0"
+    "@zudojs/http": "1.1.0"
   },
   "peerDependenciesMeta": {
     "@zudojs/http": {