@bajustone/fortress 1.0.0-rc.1

package/dist/plugins/tenancy.d.cts

@@ -0,0 +1,108 @@
+import { f as PluginRouteContext, F as FortressPlugin } from '../config-GtlVt6ZD.cjs';
+import '../index-CxEkfCA0.cjs';
+import '../jwt.cjs';
+import '../types-et0R8tsC.cjs';
+import '../auth-service-BcyQ2PuZ.cjs';
+
+/**
+ * Schema-per-tenant tenancy plugin for fortress (PostgreSQL only).
+ *
+ * Switches the active PostgreSQL `search_path` per request based on the
+ * resolved tenant, providing strong data isolation between tenants without
+ * touching application code. Requires a PostgreSQL-backed Drizzle adapter.
+ *
+ * The active tenant is read from the **verified** `tenantId` JWT claim (set by
+ * {@link enrichTokenClaims} from the user's default `tenant_user` membership),
+ * never from a client-supplied header — so a caller can only ever reach a
+ * tenant they belong to. Switching tenants requires {@link switchTenant} plus a
+ * token refresh.
+ *
+ * Isolation is enforced atomically: each database operation runs inside a
+ * transaction that first pins `search_path` via a bound `set_config(..., true)`
+ * call, so the schema selection and the query share one pooled connection and
+ * the path cannot leak or be discarded.
+ *
+ * HTTP endpoints are opt-in: pass `tenancy({ routes: true })` to mount the
+ * routes under `/tenancy/*`. The programmatic methods on
+ * `fortress.plugins.tenancy` are always available regardless of the flag.
+ *
+ * @module
+ */
+
+/**
+ * Callback invoked once, inside the creation transaction, after a tenant's
+ * schema is created — the hook for per-tenant table DDL / migrations.
+ */
+type OnSchemaCreated = (schemaName: string, rawQuery: <T>(sql: string, params?: unknown[]) => Promise<T[]>) => Promise<void>;
+interface TenancyConfig {
+    /**
+     * Schema prefix for tenant schemas (default: 'tenant_'). Must match
+     * `^[a-z_][a-z0-9_]*$` — validated at factory time.
+     */
+    schemaPrefix?: string;
+    /**
+     * Mount HTTP routes under `/tenancy/*`. Default `false`. The programmatic
+     * methods on `fortress.plugins.tenancy` are always available; this flag only
+     * controls HTTP mounting.
+     */
+    routes?: boolean;
+    /**
+     * Run once inside the `createTenant` transaction, right after the tenant's
+     * PostgreSQL schema is created. Use it to create the tenant's business
+     * tables (or run a migration) against the new schema. The supplied
+     * `rawQuery` is bound to the same connection/transaction as the schema
+     * creation, so statements should reference the schema explicitly (e.g.
+     * `CREATE TABLE "${schemaName}".widgets (...)`).
+     */
+    onSchemaCreated?: OnSchemaCreated;
+    /**
+     * When `true`, `deleteTenant` also issues `DROP SCHEMA IF EXISTS <schema>
+     * CASCADE`, destroying all tenant data. Default `false` — destructive drops
+     * must be opted into explicitly.
+     */
+    dropSchemaOnDelete?: boolean;
+}
+interface TenantRecord {
+    id: string;
+    name: string;
+    taxId: string;
+    description: string | null;
+    createdAt: Date;
+    updatedAt: Date;
+}
+interface TenancyMethods {
+    createTenant: (input: {
+        name: string;
+        taxId: string;
+        description?: string;
+    }, routeCtx?: PluginRouteContext) => Promise<TenantRecord>;
+    deleteTenant: (input: {
+        id: string;
+    }, routeCtx?: PluginRouteContext) => Promise<{
+        ok: true;
+    }>;
+    addUserToTenant: (userId: string, tenantId: string) => Promise<void>;
+    getUserTenants: (userId: string) => Promise<TenantRecord[]>;
+    getMyTenants: (input: {
+        userId?: string;
+    }, routeCtx?: PluginRouteContext) => Promise<{
+        tenants: TenantRecord[];
+    }>;
+    switchTenant: (input: {
+        taxId: string;
+        userId?: string;
+    }, routeCtx?: PluginRouteContext) => Promise<{
+        ok: true;
+    }>;
+}
+/**
+ * Tenancy plugin factory (PostgreSQL only). Returns a {@link FortressPlugin}
+ * that switches the active PostgreSQL `search_path` per request based on the
+ * verified `tenantId` JWT claim, providing schema-level isolation between
+ * tenants. Pass `{ routes: true }` to mount the HTTP routes under `/tenancy/*`.
+ */
+declare function tenancy(config?: TenancyConfig): FortressPlugin & {
+    readonly name: 'tenancy';
+};
+
+export { type OnSchemaCreated, type TenancyConfig, type TenancyMethods, tenancy };

package/dist/plugins/tenancy.d.ts

@@ -0,0 +1,108 @@
+import { f as PluginRouteContext, F as FortressPlugin } from '../config-B2366s_G.js';
+import '../index-CxEkfCA0.js';
+import '../jwt.js';
+import '../types-et0R8tsC.js';
+import '../auth-service-BkzZkWfH.js';
+
+/**
+ * Schema-per-tenant tenancy plugin for fortress (PostgreSQL only).
+ *
+ * Switches the active PostgreSQL `search_path` per request based on the
+ * resolved tenant, providing strong data isolation between tenants without
+ * touching application code. Requires a PostgreSQL-backed Drizzle adapter.
+ *
+ * The active tenant is read from the **verified** `tenantId` JWT claim (set by
+ * {@link enrichTokenClaims} from the user's default `tenant_user` membership),
+ * never from a client-supplied header — so a caller can only ever reach a
+ * tenant they belong to. Switching tenants requires {@link switchTenant} plus a
+ * token refresh.
+ *
+ * Isolation is enforced atomically: each database operation runs inside a
+ * transaction that first pins `search_path` via a bound `set_config(..., true)`
+ * call, so the schema selection and the query share one pooled connection and
+ * the path cannot leak or be discarded.
+ *
+ * HTTP endpoints are opt-in: pass `tenancy({ routes: true })` to mount the
+ * routes under `/tenancy/*`. The programmatic methods on
+ * `fortress.plugins.tenancy` are always available regardless of the flag.
+ *
+ * @module
+ */
+
+/**
+ * Callback invoked once, inside the creation transaction, after a tenant's
+ * schema is created — the hook for per-tenant table DDL / migrations.
+ */
+type OnSchemaCreated = (schemaName: string, rawQuery: <T>(sql: string, params?: unknown[]) => Promise<T[]>) => Promise<void>;
+interface TenancyConfig {
+    /**
+     * Schema prefix for tenant schemas (default: 'tenant_'). Must match
+     * `^[a-z_][a-z0-9_]*$` — validated at factory time.
+     */
+    schemaPrefix?: string;
+    /**
+     * Mount HTTP routes under `/tenancy/*`. Default `false`. The programmatic
+     * methods on `fortress.plugins.tenancy` are always available; this flag only
+     * controls HTTP mounting.
+     */
+    routes?: boolean;
+    /**
+     * Run once inside the `createTenant` transaction, right after the tenant's
+     * PostgreSQL schema is created. Use it to create the tenant's business
+     * tables (or run a migration) against the new schema. The supplied
+     * `rawQuery` is bound to the same connection/transaction as the schema
+     * creation, so statements should reference the schema explicitly (e.g.
+     * `CREATE TABLE "${schemaName}".widgets (...)`).
+     */
+    onSchemaCreated?: OnSchemaCreated;
+    /**
+     * When `true`, `deleteTenant` also issues `DROP SCHEMA IF EXISTS <schema>
+     * CASCADE`, destroying all tenant data. Default `false` — destructive drops
+     * must be opted into explicitly.
+     */
+    dropSchemaOnDelete?: boolean;
+}
+interface TenantRecord {
+    id: string;
+    name: string;
+    taxId: string;
+    description: string | null;
+    createdAt: Date;
+    updatedAt: Date;
+}
+interface TenancyMethods {
+    createTenant: (input: {
+        name: string;
+        taxId: string;
+        description?: string;
+    }, routeCtx?: PluginRouteContext) => Promise<TenantRecord>;
+    deleteTenant: (input: {
+        id: string;
+    }, routeCtx?: PluginRouteContext) => Promise<{
+        ok: true;
+    }>;
+    addUserToTenant: (userId: string, tenantId: string) => Promise<void>;
+    getUserTenants: (userId: string) => Promise<TenantRecord[]>;
+    getMyTenants: (input: {
+        userId?: string;
+    }, routeCtx?: PluginRouteContext) => Promise<{
+        tenants: TenantRecord[];
+    }>;
+    switchTenant: (input: {
+        taxId: string;
+        userId?: string;
+    }, routeCtx?: PluginRouteContext) => Promise<{
+        ok: true;
+    }>;
+}
+/**
+ * Tenancy plugin factory (PostgreSQL only). Returns a {@link FortressPlugin}
+ * that switches the active PostgreSQL `search_path` per request based on the
+ * verified `tenantId` JWT claim, providing schema-level isolation between
+ * tenants. Pass `{ routes: true }` to mount the HTTP routes under `/tenancy/*`.
+ */
+declare function tenancy(config?: TenancyConfig): FortressPlugin & {
+    readonly name: 'tenancy';
+};
+
+export { type OnSchemaCreated, type TenancyConfig, type TenancyMethods, tenancy };