@elysiumjs/mnemosyne 0.1.0 → 0.1.2

package/dist/index.d.ts

@@ -1,17 +0,0 @@
-import type { TenancyConfig } from './tenancy';
-export type { ColumnMetadata, DatabaseCacheConfig, DatabaseCacheStrategy, DatabaseDriver, IdType, ModelAdapter, ModelClass, RepositoryClass, RepositoryInterface, TenancyStrategy } from './interfaces';
-export { AbstractDatabase, createDatabaseCacheStorage } from './database';
-export { createSchemaFromModel, AbstractModel } from './model';
-export { AbstractRepository } from './repository';
-export { getConfig as getTenancyConfig, getCurrentTenant, withTenant, registerTenancyStrategy, getTenancyStrategy, TenantMiddleware, SimpleTenantMiddleware, StrictTenantMiddleware } from './tenancy';
-export type { TenancyConfig, TenancyMode, ModelTenancyConfig } from './tenancy';
-export { Cache } from './cache';
-export type { CacheInterface } from './cache';
-export { KeyvRedis } from './keyv-redis';
-export interface MnemosyneConfig<TConnectionConfig = unknown> {
-    database?: {
-        default: string;
-        connections: Record<string, TConnectionConfig>;
-    };
-    tenancy?: TenancyConfig;
-}

package/dist/index.js

@@ -1,2 +0,0 @@
-// @bun
-import{Application as P,Service as G}from"@elysiumjs/core";import{createCache as E}from"cache-manager";import{KeyvCacheableMemory as N}from"cacheable";import{Keyv as F}from"keyv";import{alphabetical as A}from"radash";import{EventEmitter as K}from"events";import{Event as C,Redis as w}from"@elysiumjs/core";class J extends K{#D;#g;#L="::";#I=1000;#R=!0;#O=!1;#W;constructor(g){super();C.once("elysium:app:launched",()=>{this.#D=w.getConnection(g.connection)}),this.#W=g.connection,this.#g=g.namespace,this.#L=g.keyPrefixSeparator??"::",this.#I=g.clearBatchSize??1000,this.#R=g.useUnlink??!0,this.#O=g.noNamespaceAffectsAll??!1,this.on("error",(L)=>{C.emit("elysium:error",L)})}get client(){return this.#D}get opts(){return{namespace:this.#g,keyPrefixSeparator:this.#L,clearBatchSize:this.#I,noNamespaceAffectsAll:this.#O,dialect:"redis",url:this.#W}}get namespace(){return this.#g}set namespace(g){this.#g=g}async get(g){g=this.createKeyPrefix(g,this.#g);let L=await this.client.get(g);return L===null?void 0:L}async set(g,L,D){if(g=this.createKeyPrefix(g,this.#g),D)await this.client.set(g,L,"PX",D);else await this.client.set(g,L)}async setMany(g){let L=[];for(let{key:D,value:O,ttl:R}of g){let I=this.createKeyPrefix(D,this.#g);if(R)L.push(this.client.set(I,O,"PX",R));else L.push(this.client.set(I,O))}await Promise.all(L)}async delete(g){return g=this.createKeyPrefix(g,this.#g),await(this.#R?this.client.send("UNLINK",[g]):this.client.del(g))>0}async clear(){try{if(!this.#g&&this.#O){await this.client.send("FLUSHDB",[]);return}let g="0",L=this.#I,D=this.#g?`${this.#g}${this.#L}*`:"*",O=[];do{let R=await this.client.send("SCAN",[g,"MATCH",D,"COUNT",L.toString(),"TYPE","string"]),[I,Y]=R;if(g=I.toString(),Y.length===0)continue;if(!this.#g)Y=Y.filter((q)=>!q.includes(this.#L));O.push(Y.map((q)=>this.client.del(q)))}while(g!=="0");await Promise.all(O)}catch(g){this.emit("error",g)}}async has(g){return g=this.createKeyPrefix(g,this.#g),this.client.exists(g)}async hasMany(g){let L=[];for(let D of g){let O=this.createKeyPrefix(D,this.#g);L.push(this.client.exists(O))}return Promise.all(L)}async getMany(g){if(g.length===0)return[];return g=g.map((D)=>this.createKeyPrefix(D,this.#g)),await this.client.mget(...g)}async disconnect(){this.client.close()}async deleteMany(g){let L=!1,D=[];for(let R of g){let I=this.createKeyPrefix(R,this.#g);if(this.#R)D.push(this.client.send("UNLINK",[I]));else D.push(this.client.del(I))}let O=await Promise.all(D);for(let R of O)if(typeof R==="number"&&R>0)L=!0;return L}async*iterator(g){let L=g?`${g}${this.#L}*`:"*",D="0";do{let O=await this.client.send("SCAN",[D,"MATCH",L,"TYPE","string"]),[R,I]=O;if(D=R.toString(),!g&&!this.#O)I=I.filter((Y)=>!Y.includes(this.#L));if(I.length>0){let Y=await this.client.mget(...I);for(let q of I.keys()){let j=this.getKeyWithoutPrefix(I[q],g),f=Y[q];yield[j,f]}}}while(D!=="0")}createKeyPrefix(g,L){return L?`${L}${this.#L}${g}`:g}getKeyWithoutPrefix(g,L){return L?g.replace(`${L}${this.#L}`,""):g}}var U=(g)=>{let L=E({stores:[new F({store:g,namespace:"cache"})]}),D=new Map;return{...L,tags(...O){let R=`cache__${A(O,(Y)=>Y).join("__")}`,I=D.get(R);if(!I)I=E({stores:[new F({store:g,namespace:R})]}),D.set(R,I);return I}}};class V{static#D;static#g;static weak=Object.seal({map:new WeakMap,get(g){if(!this.map.has(g))this.map.set(g,{});return this.map.get(g)},del(g){this.map.delete(g)}});static get redis(){if(!V.#D)V.#D=U(new J({connection:"cache"}));return V.#D}static get memory(){if(!V.#g)V.#g=U(new N({ttl:60000,lruSize:5000}));return V.#g}}var S=(g)=>{return V[g.storage??"redis"].tags("database")};class B{getConnectionName(g){return`db.connection.${g}`}getConnection(g="default"){if(g==="default"){let D=P.context.getStore()?.get("db:tx");if(D)return D}let L=this.getConnectionName(g);if(!G.exists(L))console.error(`No connection with name ${g} found. Please make sure to register the connection before using it.`),process.exit(1);return G.get(L)}registerConnection(g,L){let D=this.getConnectionName(g);if(G.exists(D))console.error(`A connection with the name ${g} has already been registered.`),process.exit(1);let O=this.driver.createConnection(L);return G.instance(D,O)}connectionExists(g){return G.exists(this.getConnectionName(g))}getDefaultConnection(){return this.getConnection("default")}setDefaultConnection(g){let L=this.getConnectionName("default");return G.remove(L),G.instance(L,this.getConnection(g))}getRawClient(g="default"){return this.driver.getRawClient(this.getConnection(g))}}import{Application as M}from"@elysiumjs/core";import{t as W}from"elysia";import{Application as H,Middleware as b}from"@elysiumjs/core";var _=null,x=()=>{let g=H.instance;if(!g)return{mode:"schema"};return g.getConfig("elysium:mnemosyne")?.tenancy??{mode:"schema"}},v=(g)=>{_=g},Z=()=>{return _},$=()=>{if(!H.instance||!H.context.getStore)return null;return H.context.getStore()?.get("tenant")??null},d=(g,L)=>{let D=H.context.getStore(),O=new Map(D);return O.set("tenant",g),H.context.run(O,L)};class Q extends b{header="x-tenant-id";allowPublic=!0;connectionName="default";async validateTenant(g){return!0}async onTenantResolved(g,L){}onTenantError(g,L){if(g==="missing")throw Error("Tenant ID required");else throw Error("Invalid tenant")}async onRequest(g){let L=g.request.headers.get(this.header);if(!L||L==="public"){if(this.allowPublic){g.tenant="public";return}return this.onTenantError("missing",g)}if(!await this.validateTenant(L))return this.onTenantError("invalid",g);g.tenant=L,await this.onTenantResolved(L,g)}}class T extends Q{}class z extends Q{allowPublic=!1}var X=(g,{mode:L="select"}={})=>{if(g===void 0||g.length===0)return W.Object({});let D={};for(let O of g){if(["create","update"].includes(L)&&O.isPrimaryKey)continue;if(D[O.name]=h(O),O.nullable)D[O.name]=W.Nullable(D[O.name]);if(L==="update"||O.hasDefault||O.nullable)D[O.name]=W.Optional(D[O.name])}return W.Object(D)},h=(g)=>{switch(g.dataType){case"string":return W.String();case"uuid":return W.String({format:"uuid"});case"number":return W.Number();case"boolean":return W.Boolean();case"array":return W.Array(W.Any());case"json":return W.Object({});case"date":return W.Transform(W.String({format:"date"})).Decode((L)=>new Date(L)).Encode((L)=>L.toISOString());case"datetime":return W.Transform(W.String({format:"date-time"})).Decode((L)=>new Date(L)).Encode((L)=>L.toISOString());case"bigint":return W.BigInt();case"buffer":return W.File();default:return W.Never()}},i=(g,L,D,O)=>{let R=D.getColumns(O);class I{static $inferSelect=void 0;static $inferInsert=void 0;static $inferUpdate=void 0;static get table(){if(!M.instance||!M.context.getStore)return O;if(this.supportTenancy){let Y=$()??"public";if(Y!=="public"){let q=Z();if(q)return q.resolveTable(O,Y);return D.createTenantTable(O,Y)}}return O}static tableName=g;static columns=L;static insertSchema=X(R,{mode:"create"});static updateSchema=X(R,{mode:"update"});static selectSchema=X(R,{mode:"select"});static supportTenancy=!1}return I};var u=(g,L)=>{class D{static Model=g;static connection="default";get db(){return L.getConnection(this.constructor.connection)}}return D};export{d as withTenant,v as registerTenancyStrategy,Z as getTenancyStrategy,x as getTenancyConfig,$ as getCurrentTenant,X as createSchemaFromModel,S as createDatabaseCacheStorage,Q as TenantMiddleware,z as StrictTenantMiddleware,T as SimpleTenantMiddleware,J as KeyvRedis,V as Cache,u as AbstractRepository,i as AbstractModel,B as AbstractDatabase};

package/dist/interfaces.d.ts

@@ -1,350 +0,0 @@
-import type { TSchema } from 'elysia';
-/**
- * Contract for ORM drivers.
- *
- * A database driver is responsible for creating connections, managing
- * transactions, and exposing the raw underlying client.
- *
- * @author Axel Nana <axel.nana@workbud.com>
- * @template TConnection The connection type managed by the driver.
- * @template TConnectionConfig The configuration used to create a connection.
- */
-export interface DatabaseDriver<TConnection = unknown, TConnectionConfig = unknown> {
-    /**
-     * Creates a new database connection from the given configuration.
-     * @param config The connection configuration.
-     * @returns A new database connection.
-     */
-    createConnection(config: TConnectionConfig): TConnection;
-    /**
-     * Executes a callback within a database transaction.
-     * @param connection The connection to use for the transaction.
-     * @param callback The function to execute within the transaction.
-     * @returns The return value of the callback.
-     */
-    withTransaction<T>(connection: TConnection, callback: (tx: TConnection) => Promise<T>): Promise<T>;
-    /**
-     * Returns the raw underlying client from a connection.
-     * @param connection The connection to extract the raw client from.
-     * @returns The raw client instance.
-     */
-    getRawClient(connection: TConnection): unknown;
-}
-/**
- * Normalized column metadata for a table.
- *
- * Provides an ORM-agnostic description of a column's name, type,
- * nullability, default status, and primary key status.
- *
- * @author Axel Nana <axel.nana@workbud.com>
- */
-export interface ColumnMetadata {
-    /**
-     * The column name.
-     */
-    name: string;
-    /**
-     * The normalized data type of the column.
-     */
-    dataType: 'string' | 'number' | 'boolean' | 'date' | 'datetime' | 'json' | 'array' | 'bigint' | 'buffer' | 'uuid';
-    /**
-     * Whether the column allows `NULL` values.
-     */
-    nullable: boolean;
-    /**
-     * Whether the column has a default value.
-     */
-    hasDefault: boolean;
-    /**
-     * Whether the column is a primary key.
-     */
-    isPrimaryKey: boolean;
-}
-/**
- * Bridges ORM-specific table schemas to framework metadata.
- *
- * A model adapter translates between the ORM's internal table
- * representation and the normalized metadata used by the framework.
- *
- * @author Axel Nana <axel.nana@workbud.com>
- * @template TTable The ORM-specific table type.
- */
-export interface ModelAdapter<TTable = unknown> {
-    /**
-     * Returns the name of the given table.
-     * @param table The table to get the name of.
-     * @returns The table name.
-     */
-    getTableName(table: TTable): string;
-    /**
-     * Returns the normalized column metadata for the given table.
-     * @param table The table to extract columns from.
-     * @returns An array of column metadata.
-     */
-    getColumns(table: TTable): ColumnMetadata[];
-    /**
-     * Creates a tenant-scoped copy of the given table.
-     * @param table The original table.
-     * @param tenant The tenant identifier.
-     * @returns A new table scoped to the given tenant.
-     */
-    createTenantTable(table: TTable, tenant: string): TTable;
-}
-/**
- * Contract for tenancy strategies.
- *
- * A tenancy strategy determines how tables and connections are
- * scoped to a specific tenant.
- *
- * @author Axel Nana <axel.nana@workbud.com>
- * @template TTable The ORM-specific table type.
- * @template TConnection The connection type used by the strategy.
- */
-export interface TenancyStrategy<TTable = unknown, TConnection = unknown> {
-    /**
-     * The tenancy mode identifier (e.g. `'schema'`, `'rls'`).
-     */
-    readonly mode: string;
-    /**
-     * Resolves a table to its tenant-scoped equivalent.
-     * @param table The original table.
-     * @param tenant The tenant identifier.
-     * @returns The tenant-scoped table.
-     */
-    resolveTable(table: TTable, tenant: string): TTable;
-    /**
-     * Executes a callback with tenant-level isolation applied to the connection.
-     * @param connection The database connection.
-     * @param tenant The tenant identifier.
-     * @param callback The function to execute within the isolated context.
-     * @returns The return value of the callback.
-     */
-    withIsolation<T>(connection: TConnection, tenant: string, callback: () => Promise<T>): Promise<T>;
-}
-/**
- * Contract for database query cache strategies.
- *
- * Implementations are responsible for storing, retrieving, and
- * invalidating cached query results.
- *
- * @author Axel Nana <axel.nana@workbud.com>
- */
-export interface DatabaseCacheStrategy {
-    /**
-     * Retrieves a cached query result by key.
-     * @param key The cache key.
-     * @returns The cached result, or `undefined` if not found.
-     */
-    get(key: string): Promise<unknown[] | undefined>;
-    /**
-     * Stores a query result in the cache.
-     * @param key The cache key.
-     * @param response The query result to cache.
-     * @param tables The tables involved in the query.
-     * @param config Optional cache configuration.
-     */
-    put(key: string, response: unknown[], tables: string[], config?: {
-        ttl?: number;
-    }): Promise<void>;
-    /**
-     * Invalidates cached entries affected by a mutation.
-     * @param params The tables and/or tags affected by the mutation.
-     */
-    onMutate(params: {
-        tables?: string[];
-        tags?: string[];
-    }): Promise<void>;
-}
-/**
- * Configuration for database query caching.
- * @author Axel Nana <axel.nana@workbud.com>
- */
-export interface DatabaseCacheConfig {
-    /**
-     * Whether caching is enabled.
-     */
-    enabled?: boolean;
-    /**
-     * The default TTL for cached data, in seconds.
-     */
-    ttl?: number;
-    /**
-     * The caching strategy.
-     * - `'explicit'`: Only cache queries that explicitly opt in.
-     * - `'all'`: Cache all queries automatically.
-     */
-    strategy?: 'explicit' | 'all';
-    /**
-     * The storage engine to use for the cache.
-     */
-    storage?: 'redis' | 'memory';
-}
-/**
- * Database primary column type.
- * @author Axel Nana <axel.nana@workbud.com>
- */
-export type IdType = number | string;
-/**
- * ORM-agnostic CRUD repository contract.
- *
- * Provides a standard interface for common database operations
- * regardless of the underlying ORM implementation.
- *
- * @author Axel Nana <axel.nana@workbud.com>
- * @template TSelect The type returned by select queries.
- * @template TInsert The type needed by insert queries.
- * @template TUpdate The type needed by update queries.
- * @template TId The primary key type.
- */
-export interface RepositoryInterface<TSelect, TInsert, TUpdate, TId extends IdType = string> {
-    /**
-     * Retrieves all the records in the database.
-     * @returns All the records in the database.
-     */
-    all(): Promise<TSelect[]>;
-    /**
-     * Retrieves a paginated subset of the records in the database.
-     * @param count The number of records per page.
-     * @param page The page number to retrieve.
-     * @returns A paginated response containing the records and the total count.
-     */
-    paginate(count: number, page: number): Promise<{
-        page: number;
-        data: TSelect[];
-        total: number;
-    }>;
-    /**
-     * Retrieves a record by its id.
-     * @param id The id of the record to retrieve.
-     * @returns The record with the given id, or `null` if not found.
-     */
-    find(id: TId): Promise<TSelect | null>;
-    /**
-     * Finds the first record with a column matching the given value.
-     * @param column The column to filter by.
-     * @param value The value the column should match.
-     * @returns The first record with a column matching the given value, or `null`.
-     */
-    findBy<TKey extends keyof TSelect>(column: TKey, value: TSelect[TKey]): Promise<TSelect | null>;
-    /**
-     * Inserts a new record in the database.
-     * @param data The data to insert.
-     * @returns The inserted record.
-     */
-    insert(data: TInsert): Promise<TSelect>;
-    /**
-     * Updates a record in the database.
-     * @param id The id of the record to update.
-     * @param data The data to update.
-     * @returns The updated record.
-     */
-    update(id: TId, data: TUpdate): Promise<TSelect>;
-    /**
-     * Updates all the records in the database.
-     * @param data The data to update.
-     * @returns The updated records.
-     */
-    updateAll(data: TUpdate): Promise<TSelect[]>;
-    /**
-     * Deletes a record from the database.
-     * @param id The ID of the record to delete.
-     * @returns The deleted record.
-     */
-    delete(id: TId): Promise<TSelect>;
-    /**
-     * Deletes all the records from the database.
-     * @returns All the deleted records.
-     */
-    deleteAll(): Promise<TSelect[]>;
-    /**
-     * Checks if a record exists in the database.
-     * @param id The ID of the record to check.
-     * @returns `true` if the record exists, `false` otherwise.
-     */
-    exists(id: TId): Promise<boolean>;
-}
-/**
- * Shape of a model class.
- *
- * Describes the static interface that a model class must expose,
- * including inferred types, table metadata, and validation schemas.
- *
- * @author Axel Nana <axel.nana@workbud.com>
- * @template TSelect The type returned by select queries.
- * @template TInsert The type needed by insert queries.
- * @template TUpdate The type needed by update queries.
- * @template TTable The ORM-specific table type.
- */
-export type ModelClass<TSelect = unknown, TInsert = unknown, TUpdate = unknown, TTable = unknown> = {
-    /**
-     * The data type returned by select queries.
-     */
-    readonly $inferSelect: TSelect;
-    /**
-     * The data type needed by insert queries.
-     */
-    readonly $inferInsert: TInsert;
-    /**
-     * The data type needed by update queries.
-     */
-    readonly $inferUpdate: TUpdate;
-    /**
-     * The ORM-specific table schema wrapped by this model.
-     */
-    readonly table: TTable;
-    /**
-     * The name of the table wrapped by the model.
-     */
-    readonly tableName: string;
-    /**
-     * The table columns configuration.
-     */
-    readonly columns: Record<string, unknown>;
-    /**
-     * The validation schema for creating records.
-     */
-    readonly insertSchema: TSchema;
-    /**
-     * The validation schema for updating records.
-     */
-    readonly updateSchema: TSchema;
-    /**
-     * The validation schema for selecting records.
-     */
-    readonly selectSchema: TSchema;
-    /**
-     * Whether the model supports tenancy.
-     */
-    readonly supportTenancy: boolean;
-    /**
-     * Creates a new instance of the model.
-     * @param args The arguments to pass to the constructor.
-     * @returns A new instance of the model.
-     */
-    new (...args: unknown[]): unknown;
-};
-/**
- * Shape of a repository class.
- *
- * Describes the static interface that a repository class must expose,
- * including the associated model and connection name.
- *
- * @author Axel Nana <axel.nana@workbud.com>
- * @template TModel The model class type wrapped by the repository.
- */
-export type RepositoryClass<TModel extends ModelClass = ModelClass> = {
-    /**
-     * The model class wrapped by this repository.
-     */
-    readonly Model: TModel;
-    /**
-     * The database connection name to use in the repository.
-     */
-    readonly connection: string;
-    /**
-     * Creates a new instance of the repository.
-     * @param args The arguments to pass to the constructor.
-     * @returns A new repository instance.
-     */
-    new (...args: unknown[]): RepositoryInterface<TModel['$inferSelect'], TModel['$inferInsert'], TModel['$inferUpdate']>;
-};

package/dist/keyv-redis.d.ts

@@ -1,84 +0,0 @@
-import type { KeyvStoreAdapter } from 'cacheable';
-import type { KeyvEntry, StoredData } from 'keyv';
-import { EventEmitter } from 'node:events';
-/**
- * Keyv adapter for redis. This adapter is based on the Bun's Redis client.
- * @author Axel Nana <axel.nana@workbud.com>
- */
-export declare class KeyvRedis extends EventEmitter implements KeyvStoreAdapter {
-    #private;
-    constructor(props: {
-        /**
-         * The Redis connection to use.
-         */
-        connection: string;
-        /**
-         * Namespace for the connection.
-         */
-        namespace?: string;
-        /**
-         * Separator to use between namespace and key.
-         */
-        keyPrefixSeparator?: string;
-        /**
-         * Number of keys to delete in a single batch.
-         */
-        clearBatchSize?: number;
-        /**
-         * Enable Unlink instead of using Del for clearing keys. This is more performant but may not be supported by all Redis versions.
-         */
-        useUnlink?: boolean;
-        /**
-         * Whether to allow clearing all keys when no namespace is set.
-         * If set to true and no namespace is set, iterate() will return all keys.
-         * Defaults to `false`.
-         */
-        noNamespaceAffectsAll?: boolean;
-    });
-    get client(): Bun.RedisClient;
-    /**
-     * Get the options for the adapter.
-     */
-    get opts(): {
-        namespace: string | undefined;
-        keyPrefixSeparator: string;
-        clearBatchSize: number;
-        noNamespaceAffectsAll: boolean;
-        dialect: string;
-        url: string;
-    };
-    /**
-     * Gets the namespace for the adapter. If undefined, it will not use a namespace including keyPrefixing.
-     * @default undefined
-     */
-    get namespace(): string | undefined;
-    /**
-     * Sets the namespace for the adapter. If undefined, it will not use a namespace including keyPrefixing.
-     */
-    set namespace(value: string | undefined);
-    get<Value>(key: string): Promise<StoredData<Value> | undefined>;
-    set(key: string, value: any, ttl?: number): Promise<void>;
-    setMany(values: Array<KeyvEntry>): Promise<void>;
-    delete(key: string): Promise<boolean>;
-    clear(): Promise<void>;
-    has(key: string): Promise<boolean>;
-    hasMany(keys: string[]): Promise<boolean[]>;
-    getMany<Value>(keys: string[]): Promise<Array<StoredData<Value | undefined>>>;
-    disconnect(): Promise<void>;
-    deleteMany(keys: string[]): Promise<boolean>;
-    iterator<Value>(namespace?: string): AsyncGenerator<Array<string | Awaited<Value> | undefined>, void>;
-    /**
-     * Helper function to create a key with a namespace.
-     * @param key The key to prefix.
-     * @param namespace The namespace to prefix the key with.
-     * @returns The key with the namespace such as 'namespace::key'.
-     */
-    createKeyPrefix(key: string, namespace?: string): string;
-    /**
-     * Helper function to remove the namespace from a key.
-     * @param key The key to remove the namespace from.
-     * @param namespace The namespace to remove from the key.
-     * @returns The key without the namespace.
-     */
-    getKeyWithoutPrefix(key: string, namespace?: string): string;
-}

package/dist/model.d.ts

@@ -1,68 +0,0 @@
-import type { ColumnMetadata, ModelAdapter } from './interfaces';
-/**
- * Creates a validation schema from normalized column metadata.
- * @author Axel Nana <axel.nana@workbud.com>
- * @param columns The column metadata to create the schema from.
- * @param options The schema generation options.
- * @returns A validation schema based on the given columns.
- */
-export declare const createSchemaFromModel: (columns: ColumnMetadata[], { mode }?: {
-    mode?: "create" | "update" | "select";
-}) => import("@sinclair/typebox").TObject<{}>;
-/**
- * Mixin used to create a new abstract model class.
- * @author Axel Nana <axel.nana@workbud.com>
- * @template TTable The ORM-specific table type.
- * @template TColumns The table columns configuration type.
- * @param tableName The name of the table.
- * @param columns The table columns configuration.
- * @param adapter The model adapter for the ORM.
- * @param baseTable The base ORM table instance.
- */
-export declare const AbstractModel: <TTable, TColumns extends Record<string, unknown>>(tableName: string, columns: TColumns, adapter: ModelAdapter<TTable>, baseTable: TTable) => {
-    new (): {};
-    /**
-     * The data type returned by the select queries.
-     */
-    readonly $inferSelect: unknown;
-    /**
-     * The data type needed by the insert queries.
-     */
-    readonly $inferInsert: unknown;
-    /**
-     * The data type needed by the update queries.
-     */
-    readonly $inferUpdate: unknown;
-    /**
-     * The ORM-specific table schema wrapped by this model.
-     * Will be automatically resolved to a tenant-scoped table when tenancy is active.
-     */
-    get table(): TTable;
-    /**
-     * The name of the table wrapped by the model.
-     */
-    readonly tableName: string;
-    /**
-     * The table columns configuration.
-     */
-    readonly columns: TColumns;
-    /**
-     * The validation schema for creating records.
-     */
-    readonly insertSchema: import("@sinclair/typebox").TObject<{}>;
-    /**
-     * The validation schema for updating records.
-     */
-    readonly updateSchema: import("@sinclair/typebox").TObject<{}>;
-    /**
-     * The validation schema for selecting records.
-     */
-    readonly selectSchema: import("@sinclair/typebox").TObject<{}>;
-    /**
-     * Whether the model supports tenancy.
-     *
-     * Set it to `true` if the model supports tenancy. This means that the model will be
-     * wrapped by the tenancy strategy when the current tenant is not `public`.
-     */
-    readonly supportTenancy: boolean;
-};

package/dist/repository.d.ts

@@ -1,96 +0,0 @@
-import type { AbstractDatabase } from './database';
-import type { IdType, ModelClass } from './interfaces';
-/**
- * Mixin used to create a new abstract repository class over a model.
- *
- * All CRUD methods are abstract and must be implemented by driver-specific
- * subclasses.
- *
- * @author Axel Nana <axel.nana@workbud.com>
- * @template TModel The type of the model class wrapped by the repository.
- * @template TConnection The database connection type.
- * @param model The model class wrapped by the repository.
- * @param database The database manager instance.
- */
-export declare const AbstractRepository: <TModel extends ModelClass, TConnection>(model: TModel, database: AbstractDatabase<TConnection, unknown>) => (abstract new () => {
-    /**
-     * The database connection used by this repository.
-     */
-    get db(): TConnection;
-    /**
-     * Retrieves all the records in the database.
-     * @returns All the records in the database.
-     */
-    all(): Promise<TModel["$inferSelect"][]>;
-    /**
-     * Get a paginated subset of the records in the database.
-     * @param count The number of records to retrieve per page.
-     * @param page The page number to retrieve.
-     * @returns A paginated response containing the records and the total number of records.
-     */
-    paginate(count: number, page?: number): Promise<{
-        page: number;
-        data: TModel["$inferSelect"][];
-        total: number;
-    }>;
-    /**
-     * Retrieves a record by its id.
-     * @param id The id of the record to retrieve.
-     * @returns The record with the given id, or `null` if not found.
-     */
-    find(id: IdType): Promise<TModel["$inferSelect"] | null>;
-    /**
-     * Finds the first record with a column matching the given value.
-     * @param column The column to filter by.
-     * @param value The value the column should match.
-     * @returns The first record with a column matching the given value.
-     */
-    findBy<TKey extends keyof TModel["$inferSelect"]>(column: TKey, value: TModel["$inferSelect"][TKey]): Promise<TModel["$inferSelect"] | null>;
-    /**
-     * Inserts a new record in the database.
-     * @param data The data to insert.
-     * @returns The inserted record.
-     */
-    insert(data: TModel["$inferInsert"]): Promise<TModel["$inferSelect"]>;
-    /**
-     * Updates a record in the database.
-     * @param id The id of the record to update.
-     * @param data The data to update.
-     * @returns The updated record.
-     */
-    update(id: IdType, data: TModel["$inferUpdate"]): Promise<TModel["$inferSelect"]>;
-    /**
-     * Updates all the records in the database.
-     * @param data The data to update.
-     * @returns The updated records.
-     */
-    updateAll(data: TModel["$inferUpdate"]): Promise<TModel["$inferSelect"][]>;
-    /**
-     * Deletes a record from the database.
-     * @param id The ID of the record to delete.
-     * @returns The deleted record.
-     */
-    delete(id: IdType): Promise<TModel["$inferSelect"]>;
-    /**
-     * Deletes all the records from the database.
-     * @returns All the deleted records.
-     */
-    deleteAll(): Promise<TModel["$inferSelect"][]>;
-    /**
-     * Checks if a record exists in the database.
-     * @param id The ID of the record to check.
-     * @returns True if the record exists, false otherwise.
-     */
-    exists(id: IdType): Promise<boolean>;
-}) & {
-    /**
-     * The model class wrapped by this repository.
-     */
-    readonly Model: TModel;
-    /**
-     * The database connection name to use.
-     *
-     * Update this value to change the database connection used by this repository.
-     */
-    readonly connection: string;
-};