@zerotal/tenancy 1.6.3 → 1.7.0

package/api-surface.md

@@ -0,0 +1,305 @@
+# @zerotal/tenancy — public API surface
+
+<!-- AUTO-GENERATED by scripts/api-surface.ts. Do not edit by hand.
+     Run `bun run api:surface` to regenerate after an intentional API change. -->
+
+## .  `(./src/index.ts)`
+
+class AuthResolver = {
+  new (opts?: AuthResolverOptions): AuthResolver
+  readonly trusted: true
+  resolve: (http: HttpContext) => TenantResolverResult | null
+}
+
+class EnsureTenancyMiddleware = {
+  new (): EnsureTenancyMiddleware
+  static with: <T extends new (...args: any[]) => BaseMiddleware<any>, Opts = T extends new (...args: any[]) => BaseMiddleware<infer U> ? U : object>(this: T, options: DeepPartial<NoInfer<Opts>>) => new () => InstanceType<T>
+  afterResponse?: (ctx: HttpContext) => Promise<void>
+  handle: (_http: HttpContext, next: NextFn) => Promise<Response | void>
+  onError?: (ctx: HttpContext, error: Error) => Promise<void>
+}
+
+class HeaderResolver = {
+  new (header: string): HeaderResolver
+  resolve: (http: HttpContext) => TenantResolverResult | null
+}
+
+class NoActiveTenantError = {
+  new (message?: string): NoActiveTenantError
+  readonly code: string
+  readonly context?: Record<string, unknown> | undefined
+  readonly status: number
+}
+
+class PathResolver = {
+  new (opts?: PathResolverOptions): PathResolver
+  resolve: (http: HttpContext) => TenantResolverResult | null
+}
+
+class RouteParamResolver = {
+  new (opts?: RouteParamResolverOptions): RouteParamResolver
+  resolve: (http: HttpContext) => TenantResolverResult | null
+}
+
+class SubdomainResolver = {
+  new (domain: string): SubdomainResolver
+  resolve: (http: HttpContext) => TenantResolverResult | null
+}
+
+class Tenancy = {
+  new (): Tenancy
+  addMember: (userId: number, opts?: {    admin?: boolean;}) => Promise<void>
+  all: () => Promise<TenantModel[]>
+  check: () => boolean
+  create: (data: Partial<Tenant> & {    slug: string;    name: string;}) => Promise<TenantModel>
+  current: () => Tenant | null
+  delete: () => Promise<void>
+  demote: (userId: number) => Promise<void>
+  exists: (slug: string) => Promise<boolean>
+  find: (slug: string) => Promise<TenantModel | null>
+  findById: (id: number) => Promise<TenantModel | null>
+  forId: <T>(id: number, cb: () => T | Promise<T>) => Promise<T>
+  forceDelete: () => Promise<void>
+  forceUpdate: (data: Partial<Tenant>) => Promise<TenantModel>
+  id: () => number | null
+  isMember: (userId?: number | null) => Promise<boolean>
+  isMemberAdmin: (userId?: number | null) => Promise<boolean>
+  member: <T = BaseModel>() => Promise<T | null>
+  memberCount: () => Promise<number>
+  members: <T = BaseModel>() => Promise<T[]>
+  onTenantDeleted: (hook: TenantDeletedHook) => void
+  promote: (userId: number) => Promise<void>
+  removeMember: (userId: number) => Promise<void>
+  run: <T>(tenant: Tenant, cb: () => T) => T
+  slug: () => string | null
+  update: (data: Partial<Tenant>) => Promise<TenantModel>
+}
+
+class TenancyConfigError = {
+  new (message: string): TenancyConfigError
+  readonly code: string
+  readonly context?: Record<string, unknown> | undefined
+  readonly status: number
+}
+
+class TenancyNotConfiguredError = {
+  new (message?: string): TenancyNotConfiguredError
+  headers?: Record<string, string>
+  readonly code: string
+  readonly context?: Record<string, unknown> | undefined
+  readonly status: number
+}
+
+class TenancyProvider = {
+  new (app: Application): TenancyProvider
+  static dependsOn?: (new (app: Application) => ServiceProvider)[]
+  static environments: AppEnvironment[]
+  static priority?: number
+  static provides: readonly ['tenancy']
+  static withConfig: (config: TenancyConfigShape) => typeof TenancyProvider
+  devProcesses: () => DevProcessDefinition[]
+  doctorChecks: () => DoctorCheck[]
+  onBooted: () => Promise<void>
+  onBooting: () => Promise<void>
+  onRegister: () => void
+  onRequestProcessed: (_ctx: HttpContext) => Promise<void>
+  onRequestReceived: (_ctx: HttpContext) => Promise<void>
+  onResponseSent: (_ctx: HttpContext) => Promise<void>
+  onStarted: () => Promise<void>
+  onStarting: () => Promise<void>
+  onStopped: () => Promise<void>
+  onStopping: () => Promise<void>
+  replContext: () => Record<string, unknown>
+}
+
+class TenantContext = {
+  new (): TenantContext
+  static get: () => Tenant
+  static id: () => number | null
+  static run: <T>(tenant: Tenant, callback: () => T) => T
+  static slug: () => string | null
+  static tryGet: () => Tenant | undefined
+}
+
+class TenantForbiddenError = {
+  new (message?: string): TenantForbiddenError
+  headers?: Record<string, string>
+  readonly code: string
+  readonly context?: Record<string, unknown> | undefined
+  readonly status: number
+}
+
+class TenantInactiveError = {
+  new (message?: string): TenantInactiveError
+  headers?: Record<string, string>
+  readonly code: string
+  readonly context?: Record<string, unknown> | undefined
+  readonly status: number
+}
+
+class TenantManager = {
+  new (opts: TenantManagerOptions): TenantManager
+  closeAll: () => void
+  connection: () => SQLInstance
+  connectionFor: (tenant: MultiDbTenant) => SQLInstance
+  evict: (tenant: Tenant) => void
+  warmUp: (tenant: MultiDbTenant) => void
+}
+
+class TenantModel = {
+  new (): TenantModel
+  static _isFillable: (key: string) => boolean
+  static _unscopedQuery: <T extends BaseModel>(this: typeof BaseModel & (new () => T)) => ModelQueryBuilder<T>
+  static addGlobalScope: <T extends BaseModel>(this: typeof BaseModel & (new () => T), name: string, callback: GlobalScopeCallback) => void
+  static all: <T extends BaseModel>(this: typeof BaseModel & (new () => T)) => Promise<T[]>
+  static appends: string[]
+  static bulkInsert: <T extends BaseModel>(this: typeof BaseModel & (new () => T), records: InsertPayload<T>[]) => Promise<number>
+  static casts?: Record<string, 'boolean' | 'date' | 'datetime' | 'array' | 'integer' | 'json' | 'float' | 'enum' | 'immutable_datetime' | 'encrypted' | 'encrypted:json' | `decimal:${number}` | {    get?: (dbValue: unknown) => unknown;    set?: (jsValue: unknown) => unknown;} | CastContract<unknown> | undefined>
+  static connection?: string
+  static count: <T extends BaseModel>(this: typeof BaseModel & (new () => T)) => Promise<number>
+  static create: <T extends BaseModel, F extends string = string>(this: (typeof BaseModel & (new () => T)) & {    fillable?: readonly F[] | undefined;}, data: FillablePayload<T, F>) => Promise<T>
+  static createMany: <T extends BaseModel>(this: typeof BaseModel & (new () => T), records: InsertPayload<T>[]) => Promise<T[]>
+  static dispatchesEvents?: Record<string, new (model: unknown) => object>
+  static encryptable?: string[]
+  static fillable?: readonly string[]
+  static find: <T extends BaseModel>(this: typeof BaseModel & (new () => T), id: number | string) => Promise<T | null>
+  static findBy: <T extends BaseModel>(this: typeof BaseModel & (new () => T), column: string, value: unknown) => Promise<T | null>
+  static findMany: <T extends BaseModel>(this: typeof BaseModel & (new () => T), ids: (number | string)[]) => Promise<T[]>
+  static findOrFail: <T extends BaseModel>(this: typeof BaseModel & (new () => T), id: number | string) => Promise<T>
+  static findOrNew: <T extends BaseModel>(this: typeof BaseModel & (new () => T), id: number | string) => Promise<T>
+  static first: <T extends BaseModel>(this: typeof BaseModel & (new () => T)) => Promise<T | null>
+  static firstOrCreate: <T extends BaseModel>(this: typeof BaseModel & (new () => T), search: UpdatePayload<T>, create?: UpdatePayload<T>) => Promise<T>
+  static firstOrFail: <T extends BaseModel>(this: typeof BaseModel & (new () => T)) => Promise<T>
+  static firstOrNew: <T extends BaseModel>(this: typeof BaseModel & (new () => T), search: UpdatePayload<T>, values?: UpdatePayload<T>) => Promise<T>
+  static forceCreate: <T extends BaseModel>(this: typeof BaseModel & (new () => T), data: Record<string, unknown>) => Promise<T>
+  static fromRow: (row: Record<string, unknown>) => BaseModel
+  static guarded?: readonly string[]
+  static hashable?: string[]
+  static hidden: string[]
+  static implicitBinding?: boolean
+  static implicitBindingKey?: string
+  static latest: <T extends BaseModel>(this: typeof BaseModel & (new () => T), column?: string) => ModelQueryBuilder<T>
+  static loadCount: <T extends BaseModel>(this: typeof BaseModel, models: T[], relations: string | string[]) => Promise<T[]>
+  static massPrune: boolean
+  static observe: <T extends BaseModel>(this: typeof BaseModel & (new () => T), ObserverClass: new () => ModelObserver<T>) => void
+  static oldest: <T extends BaseModel>(this: typeof BaseModel & (new () => T), column?: string) => ModelQueryBuilder<T>
+  static orderBy: <T extends BaseModel>(this: typeof BaseModel & (new () => T), column: string, direction?: OrderDirection) => ModelQueryBuilder<T>
+  static paginate: <T extends BaseModel>(this: typeof BaseModel & (new () => T), perPage?: number, page?: number, pageName?: string) => Promise<PaginateResult<T>>
+  static primaryKey: string
+  static prunable?: <T extends BaseModel>(this: typeof BaseModel & (new () => T)) => ModelQueryBuilder<T>
+  static prune: <T extends BaseModel>(this: typeof BaseModel & (new () => T), chunkSize?: number) => Promise<number>
+  static query: <T extends BaseModel>(this: typeof BaseModel & (new () => T)) => ModelQueryBuilder<T>
+  static reactiveCasts: boolean
+  static registerConnection: (name: string, conn: SQLInstance, dialect?: Dialect) => void
+  static reguard: () => void
+  static removeGlobalScope: <T extends BaseModel>(this: typeof BaseModel & (new () => T), name: string) => void
+  static saveMany: <T extends BaseModel>(this: typeof BaseModel & (new () => T), models: T[]) => Promise<T[]>
+  static scope: <Args extends unknown[]>(fn: (query: QueryBuilder, ...args: Args) => void) => (...args: Args) => ScopeApplicator
+  static softDeletes: boolean
+  static table: string
+  static timestamps: boolean
+  static unguard: () => void
+  static unguarded: boolean
+  static updateOrCreate: <T extends BaseModel>(this: typeof BaseModel & (new () => T), search: UpdatePayload<T>, values?: UpdatePayload<T>) => Promise<T>
+  static upsert: <T extends BaseModel>(this: typeof BaseModel & (new () => T), data: InsertPayload<T>, conflictKeys: (keyof T & string)[], updateCols?: (keyof T & string)[]) => Promise<void>
+  static using: Compose
+  static visible: string[]
+  static where: {    <T extends BaseModel>(this: typeof BaseModel & (new () => T), column: string, value: unknown): ModelQueryBuilder<T>;    <T extends BaseModel>(this: typeof BaseModel & (new () => T), column: string, operator: WhereOperator, value: unknown): ModelQueryBuilder<T>;}
+  static whereIn: <T extends BaseModel>(this: typeof BaseModel & (new () => T), column: string, values: unknown[]) => ModelQueryBuilder<T>
+  static withoutGuard: <T>(callback: () => T | Promise<T>) => Promise<T>
+  static withoutTimestamps: <R>(callback: () => Promise<R> | R) => Promise<R>
+  $dirty: () => Record<string, unknown>
+  append: (...keys: string[]) => TenantModel
+  associate: (relation: string, model: BaseModel) => TenantModel
+  createdAt?: Date
+  database?: string | null
+  decrement: (column: 'id' | 'name' | 'createdAt' | 'updatedAt' | '__isZerotalModel' | 'fill' | 'forceFill' | 'save' | 'delete' | 'load' | 'loadMissing' | 'fresh' | 'refresh' | 'replicate' | 'touch' | 'is' | 'isNot' | 'increment' | 'decrement' | 'loadCount' | 'loadSum' | 'loadAvg' | 'loadMin' | 'loadMax' | 'makeHidden' | 'makeVisible' | 'append' | 'associate' | 'dissociate' | 'isDirty' | '$dirty' | 'markDirty' | 'toJSON' | 'database' | 'slug' | 'isActive', amount?: number) => Promise<TenantModel>
+  delete: () => Promise<void>
+  dissociate: (relation: string) => TenantModel
+  fill: (data: Partial<InsertPayload<TenantModel>>) => TenantModel
+  forceFill: (data: Record<string, unknown>) => TenantModel
+  fresh: () => Promise<TenantModel>
+  id: number
+  increment: (column: 'id' | 'name' | 'createdAt' | 'updatedAt' | '__isZerotalModel' | 'fill' | 'forceFill' | 'save' | 'delete' | 'load' | 'loadMissing' | 'fresh' | 'refresh' | 'replicate' | 'touch' | 'is' | 'isNot' | 'increment' | 'decrement' | 'loadCount' | 'loadSum' | 'loadAvg' | 'loadMin' | 'loadMax' | 'makeHidden' | 'makeVisible' | 'append' | 'associate' | 'dissociate' | 'isDirty' | '$dirty' | 'markDirty' | 'toJSON' | 'database' | 'slug' | 'isActive', amount?: number) => Promise<TenantModel>
+  is: (other: BaseModel | null | undefined) => boolean
+  isActive: boolean
+  isDirty: (column?: string) => boolean
+  isNot: (other: BaseModel | null | undefined) => boolean
+  load: (relations: string[]) => Promise<TenantModel>
+  loadAvg: (relation: string, column: string) => Promise<TenantModel>
+  loadCount: (relations: string | string[]) => Promise<TenantModel>
+  loadMax: (relation: string, column: string) => Promise<TenantModel>
+  loadMin: (relation: string, column: string) => Promise<TenantModel>
+  loadMissing: (relations: string[]) => Promise<TenantModel>
+  loadSum: (relation: string, column: string) => Promise<TenantModel>
+  makeHidden: (...keys: string[]) => TenantModel
+  makeVisible: (...keys: string[]) => TenantModel
+  markDirty: (property: keyof TenantModel) => TenantModel
+  name: string
+  readonly __isZerotalModel: true
+  refresh: () => Promise<TenantModel>
+  replicate: (except?: string[]) => TenantModel
+  save: () => Promise<TenantModel>
+  slug: string
+  toJSON: () => Record<string, unknown>
+  touch: () => Promise<TenantModel>
+  updatedAt?: Date
+}
+
+class TenantNotFoundError = {
+  new (message?: string): TenantNotFoundError
+  headers?: Record<string, string>
+  readonly code: string
+  readonly context?: Record<string, unknown> | undefined
+  readonly status: number
+}
+
+class TenantStoragePathError = {
+  new (path: string, slug: string): TenantStoragePathError
+  readonly code: string
+  readonly context?: Record<string, unknown> | undefined
+  readonly status: number
+}
+
+function TenancyConfig = (config: Partial<TenancyConfigShape> & Pick<TenancyConfigShape, 'resolvers'>) => TenancyConfigShape
+
+function Tenantable = <TBase extends Constructor>(Base: TBase) => {    new (...args: any[]): cls;    prototype: Tenantable<any>.cls;    tenantColumn: string;} & TBase
+
+function tenantCache = (store?: string, cacheResolver?: CacheResolverLike) => CacheManagerLike
+
+function tenantDisk = (disk?: string, storageManager?: StorageManagerLike) => StorageDriver
+
+interface MultiDbTenant = {
+  database: string
+  id: number
+  isActive: boolean
+  name: string
+  slug: string
+}
+
+interface TenancyConfigShape = {
+  connect?: (tenant: MultiDbTenant) => SQLInstance
+  resolvers: TenantResolver[]
+  strategy: TenancyStrategy
+  tenantColumn?: string
+}
+
+interface TenantManagerOptions = {
+  connect: (tenant: MultiDbTenant) => SQLInstance
+}
+
+interface TenantResolver = {
+  readonly trusted?: boolean
+  resolve: (http: HttpContext) => TenantResolverResult | null
+}
+
+interface TenantResolverResult = {
+  by?: 'id' | 'slug'
+  identifier: string | number
+}
+
+type TenancyStrategy = 'single-database' | 'multi-database'
+
+type Tenant = TenantRecord
+
+type TenantDeletedHook = (tenant: Tenant) => void | Promise<void>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zerotal/tenancy",
-  "version": "1.6.3",
+  "version": "1.7.0",
   "license": "MIT",
   "maturity": "stable",
   "private": false,
@@ -12,6 +12,7 @@
   },
   "files": [
     "CHANGELOG.md",
+    "api-surface.md",
     "src",
     "!src/**/*.test.ts",
     "!src/**/*.test.tsx",
@@ -29,8 +30,8 @@
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@zerotal/core": "1.6.3",
-    "@zerotal/orm": "1.6.3"
+    "@zerotal/core": "1.7.0",
+    "@zerotal/orm": "1.7.0"
   },
   "devDependencies": {
     "typescript": "^5.8.0"