drizzle-multitenant 1.0.0

package/dist/types-DKVaTaIb.d.ts

@@ -0,0 +1,130 @@
+import { PoolConfig, Pool } from 'pg';
+import { NodePgDatabase } from 'drizzle-orm/node-postgres';
+
+/**
+ * Isolation strategy for multi-tenancy
+ */
+type IsolationStrategy = 'schema' | 'database' | 'row';
+/**
+ * Connection configuration
+ */
+interface ConnectionConfig {
+    /** PostgreSQL connection URL */
+    url: string;
+    /** Pool configuration options */
+    poolConfig?: Omit<PoolConfig, 'connectionString'>;
+}
+/**
+ * Isolation configuration
+ */
+interface IsolationConfig {
+    /** Isolation strategy (currently only 'schema' is supported) */
+    strategy: IsolationStrategy;
+    /** Function to generate schema name from tenant ID */
+    schemaNameTemplate: (tenantId: string) => string;
+    /** Maximum number of simultaneous pools (LRU eviction) */
+    maxPools?: number;
+    /** TTL in milliseconds before pool cleanup */
+    poolTtlMs?: number;
+}
+/**
+ * Schema definitions
+ */
+interface SchemasConfig<TTenantSchema extends Record<string, unknown> = Record<string, unknown>, TSharedSchema extends Record<string, unknown> = Record<string, unknown>> {
+    /** Schema applied per tenant */
+    tenant: TTenantSchema;
+    /** Shared schema (public) */
+    shared?: TSharedSchema;
+}
+/**
+ * Lifecycle hooks
+ */
+interface Hooks {
+    /** Called when a new pool is created */
+    onPoolCreated?: (tenantId: string) => void | Promise<void>;
+    /** Called when a pool is evicted */
+    onPoolEvicted?: (tenantId: string) => void | Promise<void>;
+    /** Called on pool error */
+    onError?: (tenantId: string, error: Error) => void | Promise<void>;
+}
+/**
+ * Metrics configuration
+ */
+interface MetricsConfig {
+    /** Enable metrics collection */
+    enabled: boolean;
+    /** Prefix for metric names */
+    prefix?: string;
+}
+/**
+ * Main configuration interface
+ */
+interface Config<TTenantSchema extends Record<string, unknown> = Record<string, unknown>, TSharedSchema extends Record<string, unknown> = Record<string, unknown>> {
+    /** Database connection settings */
+    connection: ConnectionConfig;
+    /** Tenant isolation settings */
+    isolation: IsolationConfig;
+    /** Drizzle schemas */
+    schemas: SchemasConfig<TTenantSchema, TSharedSchema>;
+    /** Lifecycle hooks */
+    hooks?: Hooks;
+    /** Metrics configuration */
+    metrics?: MetricsConfig;
+}
+/**
+ * Internal pool entry for LRU cache
+ */
+interface PoolEntry<TSchema extends Record<string, unknown> = Record<string, unknown>> {
+    /** Drizzle database instance */
+    db: NodePgDatabase<TSchema>;
+    /** PostgreSQL pool */
+    pool: Pool;
+    /** Last access timestamp */
+    lastAccess: number;
+    /** Schema name */
+    schemaName: string;
+}
+/**
+ * Type for tenant database instance
+ */
+type TenantDb<TSchema extends Record<string, unknown> = Record<string, unknown>> = NodePgDatabase<TSchema>;
+/**
+ * Type for shared database instance
+ */
+type SharedDb<TSchema extends Record<string, unknown> = Record<string, unknown>> = NodePgDatabase<TSchema>;
+/**
+ * Tenant manager interface
+ */
+interface TenantManager<TTenantSchema extends Record<string, unknown> = Record<string, unknown>, TSharedSchema extends Record<string, unknown> = Record<string, unknown>> {
+    /** Get database instance for a specific tenant */
+    getDb(tenantId: string): TenantDb<TTenantSchema>;
+    /** Get shared database instance */
+    getSharedDb(): SharedDb<TSharedSchema>;
+    /** Get the schema name for a tenant */
+    getSchemaName(tenantId: string): string;
+    /** Check if a tenant pool exists */
+    hasPool(tenantId: string): boolean;
+    /** Get active pool count */
+    getPoolCount(): number;
+    /** Get all active tenant IDs */
+    getActiveTenantIds(): string[];
+    /** Manually evict a tenant pool */
+    evictPool(tenantId: string): Promise<void>;
+    /** Dispose all pools and cleanup */
+    dispose(): Promise<void>;
+}
+/**
+ * Default configuration values
+ */
+declare const DEFAULT_CONFIG: {
+    readonly maxPools: 50;
+    readonly poolTtlMs: number;
+    readonly cleanupIntervalMs: 60000;
+    readonly poolConfig: {
+        readonly max: 10;
+        readonly idleTimeoutMillis: 30000;
+        readonly connectionTimeoutMillis: 5000;
+    };
+};
+
+export { type Config as C, DEFAULT_CONFIG as D, type Hooks as H, type IsolationConfig as I, type MetricsConfig as M, type PoolEntry as P, type SharedDb as S, type TenantManager as T, type TenantDb as a, type ConnectionConfig as b, type IsolationStrategy as c, type SchemasConfig as d };

package/package.json

@@ -0,0 +1,102 @@
+{
+  "name": "drizzle-multitenant",
+  "version": "1.0.0",
+  "description": "Multi-tenancy toolkit for Drizzle ORM with schema isolation, tenant context, and parallel migrations",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./express": {
+      "import": "./dist/integrations/express.js",
+      "types": "./dist/integrations/express.d.ts"
+    },
+    "./fastify": {
+      "import": "./dist/integrations/fastify.js",
+      "types": "./dist/integrations/fastify.d.ts"
+    },
+    "./nestjs": {
+      "import": "./dist/integrations/nestjs/index.js",
+      "types": "./dist/integrations/nestjs/index.d.ts"
+    },
+    "./hono": {
+      "import": "./dist/integrations/hono.js",
+      "types": "./dist/integrations/hono.d.ts"
+    },
+    "./migrator": {
+      "import": "./dist/migrator/index.js",
+      "types": "./dist/migrator/index.d.ts"
+    },
+    "./cross-schema": {
+      "import": "./dist/cross-schema/index.js",
+      "types": "./dist/cross-schema/index.d.ts"
+    }
+  },
+  "bin": {
+    "drizzle-multitenant": "./bin/drizzle-multitenant.js"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "test": "vitest",
+    "test:coverage": "vitest --coverage",
+    "lint": "eslint src --ext .ts",
+    "typecheck": "tsc --noEmit",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "drizzle",
+    "drizzle-orm",
+    "multi-tenant",
+    "multitenancy",
+    "postgresql",
+    "schema-isolation",
+    "saas"
+  ],
+  "author": "Mateus Florez",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mateusflorez/drizzle-multitenant.git"
+  },
+  "bugs": {
+    "url": "https://github.com/mateusflorez/drizzle-multitenant/issues"
+  },
+  "homepage": "https://github.com/mateusflorez/drizzle-multitenant#readme",
+  "dependencies": {
+    "chalk": "^5.6.2",
+    "cli-table3": "^0.6.5",
+    "commander": "^12.1.0",
+    "lru-cache": "^10.4.3",
+    "ora": "^8.2.0"
+  },
+  "peerDependencies": {
+    "drizzle-orm": ">=0.29.0",
+    "pg": ">=8.0.0"
+  },
+  "devDependencies": {
+    "@nestjs/common": "^10.4.20",
+    "@nestjs/core": "^10.4.20",
+    "@nestjs/testing": "^10.4.20",
+    "@types/express": "^5.0.6",
+    "@types/node": "^22.10.2",
+    "@types/pg": "^8.11.10",
+    "drizzle-orm": "^0.38.2",
+    "express": "^5.2.1",
+    "fastify": "^5.6.2",
+    "fastify-plugin": "^5.1.0",
+    "pg": "^8.13.1",
+    "reflect-metadata": "^0.2.2",
+    "rxjs": "^7.8.2",
+    "tsup": "^8.3.5",
+    "typescript": "^5.7.2",
+    "vitest": "^2.1.8"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}