@decaf-ts/for-couchdb 0.4.3 → 0.4.5

package/lib/adapter.d.ts

@@ -1,9 +1,12 @@
 import { Adapter, Sequence, type SequenceOptions } from "@decaf-ts/core";
-import { BaseError, Context, RepositoryFlags } from "@decaf-ts/db-decorators";
+import { BaseError } from "@decaf-ts/db-decorators";
+import type { Context, PrimaryKeyType } from "@decaf-ts/db-decorators";
 import { Model } from "@decaf-ts/decorator-validation";
-import { MangoQuery } from "./types";
+import { type MangoQuery } from "./types";
 import { CouchDBStatement } from "./query";
-import { Constructor } from "@decaf-ts/decoration";
+import { MaybeContextualArg } from "@decaf-ts/core";
+import type { Constructor } from "@decaf-ts/decoration";
+import { Repository } from "@decaf-ts/core";
 /**
  * @description Abstract adapter for CouchDB database operations
  * @summary Provides a base implementation for CouchDB database operations, including CRUD operations, sequence management, and error handling
@@ -47,15 +50,15 @@ import { Constructor } from "@decaf-ts/decoration";
  *   }
  * }
  */
-export declare abstract class CouchDBAdapter<Y, CONN, F extends RepositoryFlags, C extends Context<F>> extends Adapter<Y, CONN, MangoQuery, F, C> {
-    protected constructor(scope: Y, flavour: string, alias?: string);
+export declare abstract class CouchDBAdapter<CONF, CONN, C extends Context<any>> extends Adapter<CONF, CONN, MangoQuery, C> {
+    protected constructor(scope: CONF, flavour: string, alias?: string);
     /**
      * @description Creates a new CouchDB statement for querying
      * @summary Factory method that creates a new CouchDBStatement instance for building queries
      * @template M - The model type
      * @return {CouchDBStatement<M, any>} A new CouchDBStatement instance
      */
-    Statement<M extends Model>(): CouchDBStatement<M, any>;
+    Statement<M extends Model>(): CouchDBStatement<M, Adapter<CONF, CONN, MangoQuery, C>, any>;
     /**
      * @description Creates a new CouchDB sequence
      * @summary Factory method that creates a new CouchDBSequence instance for managing sequences
@@ -69,6 +72,7 @@ export declare abstract class CouchDBAdapter<Y, CONN, F extends RepositoryFlags,
      * @return {Promise<void>} A promise that resolves when initialization is complete
      */
     initialize(): Promise<void>;
+    repository<R extends Repository<any, Adapter<CONF, CONN, MangoQuery, C>>>(): Constructor<R>;
     /**
      * @description Creates indexes for the given models
      * @summary Abstract method that must be implemented to create database indexes for the specified models
@@ -79,13 +83,14 @@ export declare abstract class CouchDBAdapter<Y, CONN, F extends RepositoryFlags,
     protected abstract index<M extends Model>(...models: Constructor<M>[]): Promise<void>;
     /**
      * @description Executes a raw Mango query against the database
-     * @summary Abstract method that must be implemented to execute raw Mango queries
+     * @summary Abstract method that must be implemented to execute raw Mango queries. Implementations may treat the first
+     * additional argument as a boolean `docsOnly` flag before the contextual arguments provided by repositories.
      * @template R - The result type
      * @param {MangoQuery} rawInput - The raw Mango query to execute
-     * @param {boolean} docsOnly - Whether to return only the documents or the full response
+     * @param {...MaybeContextualArg<C>} args - Optional `docsOnly` flag followed by contextual arguments
      * @return {Promise<R>} A promise that resolves to the query result
      */
-    abstract raw<R>(rawInput: MangoQuery, docsOnly: boolean, ...args: any[]): Promise<R>;
+    abstract raw<R>(rawInput: MangoQuery, ...args: MaybeContextualArg<C>): Promise<R>;
     /**
      * @description Assigns metadata to a model
      * @summary Adds revision metadata to a model as a non-enumerable property
@@ -110,7 +115,7 @@ export declare abstract class CouchDBAdapter<Y, CONN, F extends RepositoryFlags,
      * @param {Record<string, any>} model - The model to prepare
      * @return A tuple containing the tableName, id, and prepared record
      */
-    protected createPrefix(tableName: string, id: string | number, model: Record<string, any>, ...args: any[]): (string | number | Record<string, any>)[];
+    protected createPrefix<M extends Model>(clazz: Constructor<M>, id: PrimaryKeyType, model: Record<string, any>, ...args: MaybeContextualArg<C>): [Constructor<M>, PrimaryKeyType, Record<string, any>, ...any[], Context];
     /**
      * @description Creates a new record in the database
      * @summary Abstract method that must be implemented to create a new record
@@ -120,7 +125,7 @@ export declare abstract class CouchDBAdapter<Y, CONN, F extends RepositoryFlags,
      * @param {...any[]} args - Additional arguments
      * @return {Promise<Record<string, any>>} A promise that resolves to the created record
      */
-    abstract create(tableName: string, id: string | number, model: Record<string, any>, ...args: any[]): Promise<Record<string, any>>;
+    abstract create<M extends Model>(tableName: Constructor<M>, id: PrimaryKeyType, model: Record<string, any>, ...args: MaybeContextualArg<C>): Promise<Record<string, any>>;
     /**
      * @description Prepares multiple records for creation
      * @summary Adds necessary CouchDB fields to multiple records before creation
@@ -130,7 +135,7 @@ export declare abstract class CouchDBAdapter<Y, CONN, F extends RepositoryFlags,
      * @return A tuple containing the tableName, ids, and prepared records
      * @throws {InternalError} If ids and models arrays have different lengths
      */
-    protected createAllPrefix(tableName: string, ids: string[] | number[], models: Record<string, any>[], ...args: any[]): (string | string[] | number[] | Record<string, any>[])[];
+    protected createAllPrefix<M extends Model>(clazz: Constructor<M>, ids: string[] | number[], models: Record<string, any>[], ...args: MaybeContextualArg<C>): any[];
     /**
      * @description Reads a record from the database
      * @summary Abstract method that must be implemented to read a record
@@ -139,7 +144,7 @@ export declare abstract class CouchDBAdapter<Y, CONN, F extends RepositoryFlags,
      * @param {...any[]} args - Additional arguments
      * @return {Promise<Record<string, any>>} A promise that resolves to the read record
      */
-    abstract read(tableName: string, id: string | number, ...args: any[]): Promise<Record<string, any>>;
+    abstract read<M extends Model>(tableName: Constructor<M>, id: PrimaryKeyType, ...args: MaybeContextualArg<C>): Promise<Record<string, any>>;
     /**
      * @description Prepares a record for update
      * @summary Adds necessary CouchDB fields to a record before update
@@ -150,7 +155,7 @@ export declare abstract class CouchDBAdapter<Y, CONN, F extends RepositoryFlags,
      * @return A tuple containing the tableName, id, and prepared record
      * @throws {InternalError} If no revision number is found in the model
      */
-    updatePrefix(tableName: string, id: string | number, model: Record<string, any>, ...args: any[]): (string | number | Record<string, any>)[];
+    updatePrefix<M extends Model>(clazz: Constructor<M>, id: PrimaryKeyType, model: Record<string, any>, ...args: MaybeContextualArg<C>): any[];
     /**
      * @description Updates a record in the database
      * @summary Abstract method that must be implemented to update a record
@@ -160,7 +165,7 @@ export declare abstract class CouchDBAdapter<Y, CONN, F extends RepositoryFlags,
      * @param {any[]} args - Additional arguments
      * @return A promise that resolves to the updated record
      */
-    abstract update(tableName: string, id: string | number, model: Record<string, any>, ...args: any[]): Promise<Record<string, any>>;
+    abstract update<M extends Model>(tableName: Constructor<M>, id: PrimaryKeyType, model: Record<string, any>, ...args: MaybeContextualArg<C>): Promise<Record<string, any>>;
     /**
      * @description Prepares multiple records for update
      * @summary Adds necessary CouchDB fields to multiple records before update
@@ -170,16 +175,16 @@ export declare abstract class CouchDBAdapter<Y, CONN, F extends RepositoryFlags,
      * @return A tuple containing the tableName, ids, and prepared records
      * @throws {InternalError} If ids and models arrays have different lengths or if no revision number is found in a model
      */
-    protected updateAllPrefix(tableName: string, ids: string[] | number[], models: Record<string, any>[], ...args: any[]): (string | string[] | number[] | Record<string, any>[])[];
+    protected updateAllPrefix<M extends Model>(clazz: Constructor<M>, ids: PrimaryKeyType[], models: Record<string, any>[], ...args: MaybeContextualArg<C>): any[];
     /**
      * @description Deletes a record from the database
      * @summary Abstract method that must be implemented to delete a record
-     * @param {string} tableName - The name of the table
-     * @param {string|number} id - The ID of the record
+     * @param {Constructor<M>} tableName - The name of the table
+     * @param {PrimaryKeyType} id - The ID of the record
      * @param {any[]} args - Additional arguments
      * @return A promise that resolves to the deleted record
      */
-    abstract delete(tableName: string, id: string | number, ...args: any[]): Promise<Record<string, any>>;
+    abstract delete<M extends Model>(tableName: Constructor<M>, id: PrimaryKeyType, ...args: MaybeContextualArg<C>): Promise<Record<string, any>>;
     /**
      * @description Generates a CouchDB document ID
      * @summary Combines the table name and ID to create a CouchDB document ID
@@ -187,7 +192,7 @@ export declare abstract class CouchDBAdapter<Y, CONN, F extends RepositoryFlags,
      * @param {string|number} id - The ID of the record
      * @return {string} The generated CouchDB document ID
      */
-    protected generateId(tableName: string, id: string | number): string;
+    protected generateId(tableName: string, id: PrimaryKeyType): string;
     /**
      * @description Parses an error and converts it to a BaseError
      * @summary Converts various error types to appropriate BaseError subtypes
@@ -195,7 +200,7 @@ export declare abstract class CouchDBAdapter<Y, CONN, F extends RepositoryFlags,
      * @param {string} [reason] - Optional reason for the error
      * @return {BaseError} The parsed error as a BaseError
      */
-    parseError(err: Error | string, reason?: string): BaseError;
+    parseError<E extends BaseError>(err: Error | string, reason?: string): E;
     /**
      * @description Checks if an attribute is reserved
      * @summary Determines if an attribute name is reserved in CouchDB
@@ -259,5 +264,28 @@ export declare abstract class CouchDBAdapter<Y, CONN, F extends RepositoryFlags,
      *     ErrorTypes-->>Caller: InternalError
      *   end
      */
-    protected static parseError(err: Error | string, reason?: string): BaseError;
+    protected static parseError<E extends BaseError>(err: Error | string, reason?: string): E;
+    /**
+     * @description Sets metadata on a model instance.
+     * @summary Attaches metadata to a model instance using a non-enumerable property.
+     * @template M - The model type that extends Model.
+     * @param {M} model - The model instance.
+     * @param {any} metadata - The metadata to attach to the model.
+     */
+    static setMetadata<M extends Model>(model: M, metadata: any): void;
+    /**
+     * @description Gets metadata from a model instance.
+     * @summary Retrieves previously attached metadata from a model instance.
+     * @template M - The model type that extends Model.
+     * @param {M} model - The model instance.
+     * @return {any} The metadata or undefined if not found.
+     */
+    static getMetadata<M extends Model>(model: M): any;
+    /**
+     * @description Removes metadata from a model instance.
+     * @summary Deletes the metadata property from a model instance.
+     * @template M - The model type that extends Model.
+     * @param {M} model - The model instance.
+     */
+    static removeMetadata<M extends Model>(model: M): void;
 }

package/lib/adapter.js.map

@@ -1 +1 @@
-{"version":3,"file":"adapter.js","sourceRoot":"","sources":["../src/adapter.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yCAOwB;AACxB,+CAA8D;AAC9D,2DAQiC;AACjC,uDAAuD;AAEvD,yCAAsC;AAEtC,6CAA2C;AAC3C,yCAAuC;AAGvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,MAAsB,cAKpB,SAAQ,cAAkC;IAC1C,YAAsB,KAAQ,EAAE,OAAe,EAAE,KAAc;QAC7D,KAAK,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QAC7B,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YACvE,MAAM,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC;YACpB,IAAA,4BAAY,EAAC,IAAI,EAAE,CAAC,EAAG,IAAY,CAAC,IAAI,GAAG,QAAQ,CAAC,CAAC,CAAC;QACxD,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IAEH,SAAS;QACP,OAAO,IAAI,wBAAgB,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;IAED;;;;;OAKG;IAEG,AAAN,KAAK,CAAC,QAAQ,CAAC,OAAwB;QACrC,OAAO,IAAI,0BAAe,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAC5C,CAAC;IAED;;;;OAIG;IACM,KAAK,CAAC,UAAU;QACvB,MAAM,aAAa,GAAG,cAAO,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnD,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,aAAa,CAAC,CAAC;IACtC,CAAC;IA2BD;;;;;;OAMG;IAEO,cAAc,CACtB,KAA0B,EAC1B,GAAW;QAEX,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,sBAAe,CAAC,QAAQ,EAAE;YACrD,UAAU,EAAE,KAAK;YACjB,YAAY,EAAE,KAAK;YACnB,QAAQ,EAAE,KAAK;YACf,KAAK,EAAE,GAAG;SACX,CAAC,CAAC;QACH,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;OAMG;IAEO,sBAAsB,CAC9B,MAA6B,EAC7B,IAAc;QAEd,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;YACtB,iBAAU,CAAC,WAAW,CAAC,CAAQ,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YAC1C,OAAO,CAAC,CAAC;QACX,CAAC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;OAOG;IAEO,YAAY,CACpB,SAAiB,EACjB,EAAmB,EACnB,KAA0B;IAC1B,6DAA6D;IAC7D,GAAG,IAAW;QAEd,MAAM,MAAM,GAAwB,EAAE,CAAC;QACvC,MAAM,CAAC,uBAAW,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC;QACtC,MAAM,CAAC,uBAAW,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;QACxD,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAC7B,OAAO,CAAC,SAAS,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;IACjC,CAAC;IAkBD;;;;;;;;OAQG;IAEO,eAAe,CACvB,SAAiB,EACjB,GAAwB,EACxB,MAA6B;IAC7B,6DAA6D;IAC7D,GAAG,IAAW;QAEd,IAAI,GAAG,CAAC,MAAM,KAAK,MAAM,CAAC,MAAM;YAC9B,MAAM,IAAI,6BAAa,CAAC,0CAA0C,CAAC,CAAC;QAEtE,MAAM,OAAO,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,KAAK,EAAE,EAAE;YACpC,MAAM,MAAM,GAAwB,EAAE,CAAC;YACvC,MAAM,CAAC,uBAAW,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC;YACtC,MAAM,CAAC,uBAAW,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;YACxD,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YACrC,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC,CAAC;QACH,OAAO,CAAC,SAAS,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;IACnC,CAAC;IAgBD;;;;;;;;;OASG;IAEH,YAAY,CACV,SAAiB,EACjB,EAAmB,EACnB,KAA0B;IAC1B,6DAA6D;IAC7D,GAAG,IAAW;QAEd,MAAM,MAAM,GAAwB,EAAE,CAAC;QACvC,MAAM,CAAC,uBAAW,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC;QACtC,MAAM,CAAC,uBAAW,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;QACxD,MAAM,GAAG,GAAG,KAAK,CAAC,sBAAe,CAAC,QAAQ,CAAC,CAAC;QAC5C,IAAI,CAAC,GAAG;YACN,MAAM,IAAI,6BAAa,CACrB,+CAA+C,EAAE,EAAE,CACpD,CAAC;QACJ,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAC7B,MAAM,CAAC,uBAAW,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;QAC9B,OAAO,CAAC,SAAS,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;IACjC,CAAC;IAkBD;;;;;;;;OAQG;IAEO,eAAe,CACvB,SAAiB,EACjB,GAAwB,EACxB,MAA6B;IAC7B,6DAA6D;IAC7D,GAAG,IAAW;QAEd,IAAI,GAAG,CAAC,MAAM,KAAK,MAAM,CAAC,MAAM;YAC9B,MAAM,IAAI,6BAAa,CAAC,0CAA0C,CAAC,CAAC;QAEtE,MAAM,OAAO,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,KAAK,EAAE,EAAE;YACpC,MAAM,MAAM,GAAwB,EAAE,CAAC;YACvC,MAAM,CAAC,uBAAW,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC;YACtC,MAAM,CAAC,uBAAW,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;YACxD,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,sBAAe,CAAC,QAAQ,CAAC,CAAC;YACpD,IAAI,CAAC,GAAG;gBACN,MAAM,IAAI,6BAAa,CACrB,+CAA+C,EAAE,EAAE,CACpD,CAAC;YACJ,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YACrC,MAAM,CAAC,uBAAW,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;YAC9B,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC,CAAC;QACH,OAAO,CAAC,SAAS,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;IACnC,CAAC;IAgBD;;;;;;OAMG;IACO,UAAU,CAAC,SAAiB,EAAE,EAAmB;QACzD,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,uBAAW,CAAC,SAAS,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;OAMG;IACH,UAAU,CAAC,GAAmB,EAAE,MAAe;QAC7C,OAAO,cAAc,CAAC,UAAU,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IAChD,CAAC;IAED;;;;;OAKG;IACgB,UAAU,CAAC,IAAY;QACxC,OAAO,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,8BAAkB,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuDG;IACO,MAAM,CAAC,UAAU,CAAC,GAAmB,EAAE,MAAe;QAC9D,IAAI,GAAG,YAAY,yBAAS;YAAE,OAAO,GAAU,CAAC;QAChD,IAAI,IAAI,GAAW,EAAE,CAAC;QACtB,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;YAC5B,IAAI,GAAG,GAAG,CAAC;YACX,IAAI,IAAI,CAAC,KAAK,CAAC,gCAAgC,CAAC;gBAC9C,OAAO,IAAI,6BAAa,CAAC,IAAI,CAAC,CAAC;YACjC,IAAI,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC;gBAAE,OAAO,IAAI,6BAAa,CAAC,IAAI,CAAC,CAAC;QACrE,CAAC;aAAM,IAAK,GAAW,CAAC,IAAI,EAAE,CAAC;YAC7B,IAAI,GAAI,GAAW,CAAC,IAAI,CAAC;YACzB,MAAM,GAAG,MAAM,IAAI,GAAG,CAAC,OAAO,CAAC;QACjC,CAAC;aAAM,IAAK,GAAW,CAAC,UAAU,EAAE,CAAC;YACnC,IAAI,GAAI,GAAW,CAAC,UAAU,CAAC;YAC/B,MAAM,GAAG,MAAM,IAAI,GAAG,CAAC,OAAO,CAAC;QACjC,CAAC;aAAM,CAAC;YACN,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC;QACrB,CAAC;QAED,QAAQ,IAAI,CAAC,QAAQ,EAAE,EAAE,CAAC;YACxB,KAAK,KAAK,CAAC;YACX,KAAK,KAAK,CAAC;YACX,KAAK,KAAK;gBACR,OAAO,IAAI,6BAAa,CAAC,MAAgB,CAAC,CAAC;YAC7C,KAAK,KAAK;gBACR,OAAO,IAAI,6BAAa,CAAC,MAAgB,CAAC,CAAC;YAC7C,KAAK,KAAK;gBACR,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,oBAAoB,CAAC;oBAC7C,OAAO,IAAI,mBAAU,CAAC,GAAG,CAAC,CAAC;gBAC7B,OAAO,IAAI,6BAAa,CAAC,GAAG,CAAC,CAAC;YAChC;gBACE,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,eAAe,CAAC;oBACxC,OAAO,IAAI,sBAAe,CAAC,GAAG,CAAC,CAAC;gBAClC,OAAO,IAAI,6BAAa,CAAC,GAAG,CAAC,CAAC;QAClC,CAAC;IACH,CAAC;CACF;AA9ZD,wCA8ZC;AAzYC;IADC,IAAA,YAAK,GAAE;;;oCACsB,wBAAgB;+CAE7C;AASK;IADL,IAAA,YAAK,GAAE;;;;8CAGP;AA6CS;IADT,IAAA,YAAK,GAAE;;;;oDAYP;AAUS;IADT,IAAA,YAAK,GAAE;;;;4DAUP;AAWS;IADT,IAAA,YAAK,GAAE;;;;kDAaP;AA4BS;IADT,IAAA,YAAK,GAAE;;;;qDAmBP;AA2BD;IADC,IAAA,YAAK,GAAE;;;;kDAmBP;AA4BS;IADT,IAAA,YAAK,GAAE;;;;qDAyBP"}
+{"version":3,"file":"adapter.js","sourceRoot":"","sources":["../src/adapter.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yCAMwB;AACxB,+CAA8D;AAC9D,2DAMiC;AAEjC,uDAAuD;AACvD,yEAAuD;AACvD,yCAAsC;AAEtC,6CAA2C;AAG3C,+CAA0C;AAC1C,iDAAiD;AAGjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,MAAsB,cAIpB,SAAQ,cAAkC;IAC1C,YAAsB,KAAW,EAAE,OAAe,EAAE,KAAc;QAChE,KAAK,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QAC7B,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YACvE,MAAM,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC;YACpB,IAAA,4BAAY,EAAC,IAAI,EAAE,CAAC,EAAG,IAAY,CAAC,IAAI,GAAG,QAAQ,CAAC,CAAC,CAAC;QACxD,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IAEH,SAAS;QAKP,OAAO,IAAI,wBAAgB,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;IAED;;;;;OAKG;IAEG,AAAN,KAAK,CAAC,QAAQ,CAAC,OAAwB;QACrC,OAAO,IAAI,0BAAe,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAC5C,CAAC;IAED;;;;OAIG;IACM,KAAK,CAAC,UAAU;QACvB,MAAM,aAAa,GAAG,cAAO,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnD,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,aAAa,CAAC,CAAC;IACtC,CAAC;IAEQ,UAAU;QAGjB,OAAO,8BAA8C,CAAC;IACxD,CAAC;IA2BD;;;;;;OAMG;IAEO,cAAc,CACtB,KAA0B,EAC1B,GAAW;QAEX,IAAI,CAAC,GAAG;YAAE,OAAO,KAAK,CAAC;QACvB,cAAc,CAAC,WAAW,CAAC,KAAY,EAAE,GAAG,CAAC,CAAC;QAC9C,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;OAMG;IAEO,sBAAsB,CAC9B,MAA6B,EAC7B,IAAc;QAEd,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;YACtB,cAAc,CAAC,WAAW,CAAC,CAAQ,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YAC9C,OAAO,CAAC,CAAC;QACX,CAAC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;OAOG;IAEO,YAAY,CACpB,KAAqB,EACrB,EAAkB,EAClB,KAA0B,EAC1B,GAAG,IAA2B;QAE9B,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QACzD,MAAM,SAAS,GAAG,4BAAK,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACzC,MAAM,MAAM,GAAwB,EAAE,CAAC;QACvC,MAAM,CAAC,uBAAW,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC;QACtC,MAAM,CAAC,uBAAW,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,EAAS,CAAC,CAAC;QAC/D,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAC7B,OAAO,CAAC,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,CAAC;IACzC,CAAC;IAkBD;;;;;;;;OAQG;IAEO,eAAe,CACvB,KAAqB,EACrB,GAAwB,EACxB,MAA6B,EAC7B,GAAG,IAA2B;QAE9B,MAAM,SAAS,GAAG,4BAAK,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACzC,IAAI,GAAG,CAAC,MAAM,KAAK,MAAM,CAAC,MAAM;YAC9B,MAAM,IAAI,6BAAa,CAAC,0CAA0C,CAAC,CAAC;QACtE,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;QAC5D,MAAM,OAAO,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,KAAK,EAAE,EAAE;YACpC,MAAM,MAAM,GAAwB,EAAE,CAAC;YACvC,MAAM,CAAC,uBAAW,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC;YACtC,MAAM,CAAC,uBAAW,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;YACxD,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YACrC,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC,CAAC;QACH,OAAO,CAAC,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,CAAC;IAC3C,CAAC;IAgBD;;;;;;;;;OASG;IAEH,YAAY,CACV,KAAqB,EACrB,EAAkB,EAClB,KAA0B,EAC1B,GAAG,IAA2B;QAE9B,MAAM,SAAS,GAAG,4BAAK,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACzC,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QACzD,MAAM,MAAM,GAAwB,EAAE,CAAC;QACvC,MAAM,CAAC,uBAAW,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC;QACtC,MAAM,CAAC,uBAAW,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;QACxD,MAAM,GAAG,GAAG,KAAK,CAAC,sBAAe,CAAC,QAAQ,CAAC,CAAC;QAC5C,IAAI,CAAC,GAAG;YACN,MAAM,IAAI,6BAAa,CACrB,+CAA+C,EAAE,EAAE,CACpD,CAAC;QACJ,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAC7B,MAAM,CAAC,uBAAW,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;QAC9B,OAAO,CAAC,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,CAAC;IACzC,CAAC;IAkBD;;;;;;;;OAQG;IAEO,eAAe,CACvB,KAAqB,EACrB,GAAqB,EACrB,MAA6B,EAC7B,GAAG,IAA2B;QAE9B,MAAM,SAAS,GAAG,4BAAK,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACzC,IAAI,GAAG,CAAC,MAAM,KAAK,MAAM,CAAC,MAAM;YAC9B,MAAM,IAAI,6BAAa,CAAC,0CAA0C,CAAC,CAAC;QACtE,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;QAC5D,MAAM,OAAO,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,KAAK,EAAE,EAAE;YACpC,MAAM,MAAM,GAAwB,EAAE,CAAC;YACvC,MAAM,CAAC,uBAAW,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC;YACtC,MAAM,CAAC,uBAAW,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;YACxD,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,sBAAe,CAAC,QAAQ,CAAC,CAAC;YACpD,IAAI,CAAC,GAAG;gBACN,MAAM,IAAI,6BAAa,CACrB,+CAA+C,EAAE,EAAE,CACpD,CAAC;YACJ,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YACrC,MAAM,CAAC,uBAAW,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;YAC9B,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC,CAAC;QACH,OAAO,CAAC,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,CAAC;IAC3C,CAAC;IAgBD;;;;;;OAMG;IACO,UAAU,CAAC,SAAiB,EAAE,EAAkB;QACxD,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,uBAAW,CAAC,SAAS,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;OAMG;IACH,UAAU,CAAsB,GAAmB,EAAE,MAAe;QAClE,OAAO,cAAc,CAAC,UAAU,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IAChD,CAAC;IAED;;;;;OAKG;IACgB,UAAU,CAAC,IAAY;QACxC,OAAO,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,8BAAkB,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuDG;IACO,MAAM,CAAC,UAAU,CACzB,GAAmB,EACnB,MAAe;QAEf,IAAI,GAAG,YAAY,yBAAS;YAAE,OAAO,GAAU,CAAC;QAChD,IAAI,IAAI,GAAW,EAAE,CAAC;QACtB,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;YAC5B,IAAI,GAAG,GAAG,CAAC;YACX,IAAI,IAAI,CAAC,KAAK,CAAC,gCAAgC,CAAC;gBAC9C,OAAO,IAAI,6BAAa,CAAC,IAAI,CAAM,CAAC;YACtC,IAAI,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC;gBAAE,OAAO,IAAI,6BAAa,CAAC,IAAI,CAAM,CAAC;QAC1E,CAAC;aAAM,IAAK,GAAW,CAAC,IAAI,EAAE,CAAC;YAC7B,IAAI,GAAI,GAAW,CAAC,IAAI,CAAC;YACzB,MAAM,GAAG,MAAM,IAAI,GAAG,CAAC,OAAO,CAAC;QACjC,CAAC;aAAM,IAAK,GAAW,CAAC,UAAU,EAAE,CAAC;YACnC,IAAI,GAAI,GAAW,CAAC,UAAU,CAAC;YAC/B,MAAM,GAAG,MAAM,IAAI,GAAG,CAAC,OAAO,CAAC;QACjC,CAAC;aAAM,CAAC;YACN,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC;QACrB,CAAC;QAED,QAAQ,IAAI,CAAC,QAAQ,EAAE,EAAE,CAAC;YACxB,KAAK,KAAK,CAAC;YACX,KAAK,KAAK,CAAC;YACX,KAAK,KAAK;gBACR,OAAO,IAAI,6BAAa,CAAC,MAAgB,CAAM,CAAC;YAClD,KAAK,KAAK;gBACR,OAAO,IAAI,6BAAa,CAAC,MAAgB,CAAM,CAAC;YAClD,KAAK,KAAK;gBACR,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,oBAAoB,CAAC;oBAC7C,OAAO,IAAI,mBAAU,CAAC,GAAG,CAAM,CAAC;gBAClC,OAAO,IAAI,6BAAa,CAAC,GAAG,CAAM,CAAC;YACrC;gBACE,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,eAAe,CAAC;oBACxC,OAAO,IAAI,sBAAe,CAAC,GAAG,CAAM,CAAC;gBACvC,OAAO,IAAI,6BAAa,CAAC,GAAG,CAAM,CAAC;QACvC,CAAC;IACH,CAAC;IAED,4BAA4B;IAC5B;;;;;;OAMG;IACH,MAAM,CAAC,WAAW,CAAkB,KAAQ,EAAE,QAAa;QACzD,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,sBAAe,CAAC,QAAQ,EAAE;YACrD,UAAU,EAAE,KAAK;YACjB,YAAY,EAAE,IAAI;YAClB,QAAQ,EAAE,IAAI;YACd,KAAK,EAAE,QAAQ;SAChB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,WAAW,CAAkB,KAAQ;QAC1C,MAAM,UAAU,GAAG,MAAM,CAAC,wBAAwB,CAChD,KAAK,EACL,sBAAe,CAAC,QAAQ,CACzB,CAAC;QACF,OAAO,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;IACnD,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,cAAc,CAAkB,KAAQ;QAC7C,MAAM,UAAU,GAAG,MAAM,CAAC,wBAAwB,CAChD,KAAK,EACL,sBAAe,CAAC,QAAQ,CACzB,CAAC;QACF,IAAI,UAAU;YAAE,OAAQ,KAAa,CAAC,sBAAe,CAAC,QAAQ,CAAC,CAAC;IAClE,CAAC;CACF;AAtdD,wCAsdC;AAlcC;IADC,IAAA,eAAK,GAAE;;;oCACsB,wBAAgB;+CAM7C;AASK;IADL,IAAA,eAAK,GAAE;;;;8CAGP;AAmDS;IADT,IAAA,eAAK,GAAE;;;;oDAQP;AAUS;IADT,IAAA,eAAK,GAAE;;;;4DAUP;AAWS;IADT,IAAA,eAAK,GAAE;;;;kDAcP;AA4BS;IADT,IAAA,eAAK,GAAE;;;;qDAmBP;AA2BD;IADC,IAAA,eAAK,GAAE;;;;kDAoBP;AA4BS;IADT,IAAA,eAAK,GAAE;;;;qDAyBP"}

package/lib/esm/adapter.d.ts

@@ -1,9 +1,12 @@
 import { Adapter, Sequence, type SequenceOptions } from "@decaf-ts/core";
-import { BaseError, Context, RepositoryFlags } from "@decaf-ts/db-decorators";
+import { BaseError } from "@decaf-ts/db-decorators";
+import type { Context, PrimaryKeyType } from "@decaf-ts/db-decorators";
 import { Model } from "@decaf-ts/decorator-validation";
-import { MangoQuery } from "./types";
+import { type MangoQuery } from "./types";
 import { CouchDBStatement } from "./query";
-import { Constructor } from "@decaf-ts/decoration";
+import { MaybeContextualArg } from "@decaf-ts/core";
+import type { Constructor } from "@decaf-ts/decoration";
+import { Repository } from "@decaf-ts/core";
 /**
  * @description Abstract adapter for CouchDB database operations
  * @summary Provides a base implementation for CouchDB database operations, including CRUD operations, sequence management, and error handling
@@ -47,15 +50,15 @@ import { Constructor } from "@decaf-ts/decoration";
  *   }
  * }
  */
-export declare abstract class CouchDBAdapter<Y, CONN, F extends RepositoryFlags, C extends Context<F>> extends Adapter<Y, CONN, MangoQuery, F, C> {
-    protected constructor(scope: Y, flavour: string, alias?: string);
+export declare abstract class CouchDBAdapter<CONF, CONN, C extends Context<any>> extends Adapter<CONF, CONN, MangoQuery, C> {
+    protected constructor(scope: CONF, flavour: string, alias?: string);
     /**
      * @description Creates a new CouchDB statement for querying
      * @summary Factory method that creates a new CouchDBStatement instance for building queries
      * @template M - The model type
      * @return {CouchDBStatement<M, any>} A new CouchDBStatement instance
      */
-    Statement<M extends Model>(): CouchDBStatement<M, any>;
+    Statement<M extends Model>(): CouchDBStatement<M, Adapter<CONF, CONN, MangoQuery, C>, any>;
     /**
      * @description Creates a new CouchDB sequence
      * @summary Factory method that creates a new CouchDBSequence instance for managing sequences
@@ -69,6 +72,7 @@ export declare abstract class CouchDBAdapter<Y, CONN, F extends RepositoryFlags,
      * @return {Promise<void>} A promise that resolves when initialization is complete
      */
     initialize(): Promise<void>;
+    repository<R extends Repository<any, Adapter<CONF, CONN, MangoQuery, C>>>(): Constructor<R>;
     /**
      * @description Creates indexes for the given models
      * @summary Abstract method that must be implemented to create database indexes for the specified models
@@ -79,13 +83,14 @@ export declare abstract class CouchDBAdapter<Y, CONN, F extends RepositoryFlags,
     protected abstract index<M extends Model>(...models: Constructor<M>[]): Promise<void>;
     /**
      * @description Executes a raw Mango query against the database
-     * @summary Abstract method that must be implemented to execute raw Mango queries
+     * @summary Abstract method that must be implemented to execute raw Mango queries. Implementations may treat the first
+     * additional argument as a boolean `docsOnly` flag before the contextual arguments provided by repositories.
      * @template R - The result type
      * @param {MangoQuery} rawInput - The raw Mango query to execute
-     * @param {boolean} docsOnly - Whether to return only the documents or the full response
+     * @param {...MaybeContextualArg<C>} args - Optional `docsOnly` flag followed by contextual arguments
      * @return {Promise<R>} A promise that resolves to the query result
      */
-    abstract raw<R>(rawInput: MangoQuery, docsOnly: boolean, ...args: any[]): Promise<R>;
+    abstract raw<R>(rawInput: MangoQuery, ...args: MaybeContextualArg<C>): Promise<R>;
     /**
      * @description Assigns metadata to a model
      * @summary Adds revision metadata to a model as a non-enumerable property
@@ -110,7 +115,7 @@ export declare abstract class CouchDBAdapter<Y, CONN, F extends RepositoryFlags,
      * @param {Record<string, any>} model - The model to prepare
      * @return A tuple containing the tableName, id, and prepared record
      */
-    protected createPrefix(tableName: string, id: string | number, model: Record<string, any>, ...args: any[]): (string | number | Record<string, any>)[];
+    protected createPrefix<M extends Model>(clazz: Constructor<M>, id: PrimaryKeyType, model: Record<string, any>, ...args: MaybeContextualArg<C>): [Constructor<M>, PrimaryKeyType, Record<string, any>, ...any[], Context];
     /**
      * @description Creates a new record in the database
      * @summary Abstract method that must be implemented to create a new record
@@ -120,7 +125,7 @@ export declare abstract class CouchDBAdapter<Y, CONN, F extends RepositoryFlags,
      * @param {...any[]} args - Additional arguments
      * @return {Promise<Record<string, any>>} A promise that resolves to the created record
      */
-    abstract create(tableName: string, id: string | number, model: Record<string, any>, ...args: any[]): Promise<Record<string, any>>;
+    abstract create<M extends Model>(tableName: Constructor<M>, id: PrimaryKeyType, model: Record<string, any>, ...args: MaybeContextualArg<C>): Promise<Record<string, any>>;
     /**
      * @description Prepares multiple records for creation
      * @summary Adds necessary CouchDB fields to multiple records before creation
@@ -130,7 +135,7 @@ export declare abstract class CouchDBAdapter<Y, CONN, F extends RepositoryFlags,
      * @return A tuple containing the tableName, ids, and prepared records
      * @throws {InternalError} If ids and models arrays have different lengths
      */
-    protected createAllPrefix(tableName: string, ids: string[] | number[], models: Record<string, any>[], ...args: any[]): (string | string[] | number[] | Record<string, any>[])[];
+    protected createAllPrefix<M extends Model>(clazz: Constructor<M>, ids: string[] | number[], models: Record<string, any>[], ...args: MaybeContextualArg<C>): any[];
     /**
      * @description Reads a record from the database
      * @summary Abstract method that must be implemented to read a record
@@ -139,7 +144,7 @@ export declare abstract class CouchDBAdapter<Y, CONN, F extends RepositoryFlags,
      * @param {...any[]} args - Additional arguments
      * @return {Promise<Record<string, any>>} A promise that resolves to the read record
      */
-    abstract read(tableName: string, id: string | number, ...args: any[]): Promise<Record<string, any>>;
+    abstract read<M extends Model>(tableName: Constructor<M>, id: PrimaryKeyType, ...args: MaybeContextualArg<C>): Promise<Record<string, any>>;
     /**
      * @description Prepares a record for update
      * @summary Adds necessary CouchDB fields to a record before update
@@ -150,7 +155,7 @@ export declare abstract class CouchDBAdapter<Y, CONN, F extends RepositoryFlags,
      * @return A tuple containing the tableName, id, and prepared record
      * @throws {InternalError} If no revision number is found in the model
      */
-    updatePrefix(tableName: string, id: string | number, model: Record<string, any>, ...args: any[]): (string | number | Record<string, any>)[];
+    updatePrefix<M extends Model>(clazz: Constructor<M>, id: PrimaryKeyType, model: Record<string, any>, ...args: MaybeContextualArg<C>): any[];
     /**
      * @description Updates a record in the database
      * @summary Abstract method that must be implemented to update a record
@@ -160,7 +165,7 @@ export declare abstract class CouchDBAdapter<Y, CONN, F extends RepositoryFlags,
      * @param {any[]} args - Additional arguments
      * @return A promise that resolves to the updated record
      */
-    abstract update(tableName: string, id: string | number, model: Record<string, any>, ...args: any[]): Promise<Record<string, any>>;
+    abstract update<M extends Model>(tableName: Constructor<M>, id: PrimaryKeyType, model: Record<string, any>, ...args: MaybeContextualArg<C>): Promise<Record<string, any>>;
     /**
      * @description Prepares multiple records for update
      * @summary Adds necessary CouchDB fields to multiple records before update
@@ -170,16 +175,16 @@ export declare abstract class CouchDBAdapter<Y, CONN, F extends RepositoryFlags,
      * @return A tuple containing the tableName, ids, and prepared records
      * @throws {InternalError} If ids and models arrays have different lengths or if no revision number is found in a model
      */
-    protected updateAllPrefix(tableName: string, ids: string[] | number[], models: Record<string, any>[], ...args: any[]): (string | string[] | number[] | Record<string, any>[])[];
+    protected updateAllPrefix<M extends Model>(clazz: Constructor<M>, ids: PrimaryKeyType[], models: Record<string, any>[], ...args: MaybeContextualArg<C>): any[];
     /**
      * @description Deletes a record from the database
      * @summary Abstract method that must be implemented to delete a record
-     * @param {string} tableName - The name of the table
-     * @param {string|number} id - The ID of the record
+     * @param {Constructor<M>} tableName - The name of the table
+     * @param {PrimaryKeyType} id - The ID of the record
      * @param {any[]} args - Additional arguments
      * @return A promise that resolves to the deleted record
      */
-    abstract delete(tableName: string, id: string | number, ...args: any[]): Promise<Record<string, any>>;
+    abstract delete<M extends Model>(tableName: Constructor<M>, id: PrimaryKeyType, ...args: MaybeContextualArg<C>): Promise<Record<string, any>>;
     /**
      * @description Generates a CouchDB document ID
      * @summary Combines the table name and ID to create a CouchDB document ID
@@ -187,7 +192,7 @@ export declare abstract class CouchDBAdapter<Y, CONN, F extends RepositoryFlags,
      * @param {string|number} id - The ID of the record
      * @return {string} The generated CouchDB document ID
      */
-    protected generateId(tableName: string, id: string | number): string;
+    protected generateId(tableName: string, id: PrimaryKeyType): string;
     /**
      * @description Parses an error and converts it to a BaseError
      * @summary Converts various error types to appropriate BaseError subtypes
@@ -195,7 +200,7 @@ export declare abstract class CouchDBAdapter<Y, CONN, F extends RepositoryFlags,
      * @param {string} [reason] - Optional reason for the error
      * @return {BaseError} The parsed error as a BaseError
      */
-    parseError(err: Error | string, reason?: string): BaseError;
+    parseError<E extends BaseError>(err: Error | string, reason?: string): E;
     /**
      * @description Checks if an attribute is reserved
      * @summary Determines if an attribute name is reserved in CouchDB
@@ -259,5 +264,28 @@ export declare abstract class CouchDBAdapter<Y, CONN, F extends RepositoryFlags,
      *     ErrorTypes-->>Caller: InternalError
      *   end
      */
-    protected static parseError(err: Error | string, reason?: string): BaseError;
+    protected static parseError<E extends BaseError>(err: Error | string, reason?: string): E;
+    /**
+     * @description Sets metadata on a model instance.
+     * @summary Attaches metadata to a model instance using a non-enumerable property.
+     * @template M - The model type that extends Model.
+     * @param {M} model - The model instance.
+     * @param {any} metadata - The metadata to attach to the model.
+     */
+    static setMetadata<M extends Model>(model: M, metadata: any): void;
+    /**
+     * @description Gets metadata from a model instance.
+     * @summary Retrieves previously attached metadata from a model instance.
+     * @template M - The model type that extends Model.
+     * @param {M} model - The model instance.
+     * @return {any} The metadata or undefined if not found.
+     */
+    static getMetadata<M extends Model>(model: M): any;
+    /**
+     * @description Removes metadata from a model instance.
+     * @summary Deletes the metadata property from a model instance.
+     * @template M - The model type that extends Model.
+     * @param {M} model - The model instance.
+     */
+    static removeMetadata<M extends Model>(model: M): void;
 }

package/lib/esm/adapter.js

@@ -7,13 +7,15 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
-import { Adapter, PersistenceKeys, ConnectionError, Repository, } from "@decaf-ts/core";
+import { Adapter, PersistenceKeys, ConnectionError, } from "@decaf-ts/core";
 import { CouchDBKeys, reservedAttributes } from "./constants.js";
 import { BaseError, ConflictError, InternalError, NotFoundError, prefixMethod, } from "@decaf-ts/db-decorators";
 import { CouchDBSequence } from "./sequences/Sequence.js";
+import { Model } from "@decaf-ts/decorator-validation";
 import { IndexError } from "./errors.js";
 import { CouchDBStatement } from "./query/index.js";
-import { final } from "@decaf-ts/core";
+import { final } from "@decaf-ts/logging";
+import { CouchDBRepository } from "./repository.js";
 /**
  * @description Abstract adapter for CouchDB database operations
  * @summary Provides a base implementation for CouchDB database operations, including CRUD operations, sequence management, and error handling
@@ -92,6 +94,9 @@ export class CouchDBAdapter extends Adapter {
         const managedModels = Adapter.models(this.flavour);
         return this.index(...managedModels);
     }
+    repository() {
+        return CouchDBRepository;
+    }
     /**
      * @description Assigns metadata to a model
      * @summary Adds revision metadata to a model as a non-enumerable property
@@ -100,12 +105,9 @@ export class CouchDBAdapter extends Adapter {
      * @return {Record<string, any>} The model with metadata assigned
      */
     assignMetadata(model, rev) {
-        Object.defineProperty(model, PersistenceKeys.METADATA, {
-            enumerable: false,
-            configurable: false,
-            writable: false,
-            value: rev,
-        });
+        if (!rev)
+            return model;
+        CouchDBAdapter.setMetadata(model, rev);
         return model;
     }
     /**
@@ -117,7 +119,7 @@ export class CouchDBAdapter extends Adapter {
      */
     assignMultipleMetadata(models, revs) {
         models.forEach((m, i) => {
-            Repository.setMetadata(m, revs[i]);
+            CouchDBAdapter.setMetadata(m, revs[i]);
             return m;
         });
         return models;
@@ -130,14 +132,14 @@ export class CouchDBAdapter extends Adapter {
      * @param {Record<string, any>} model - The model to prepare
      * @return A tuple containing the tableName, id, and prepared record
      */
-    createPrefix(tableName, id, model, 
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    ...args) {
+    createPrefix(clazz, id, model, ...args) {
+        const { ctxArgs } = this.logCtx(args, this.createPrefix);
+        const tableName = Model.tableName(clazz);
         const record = {};
         record[CouchDBKeys.TABLE] = tableName;
         record[CouchDBKeys.ID] = this.generateId(tableName, id);
         Object.assign(record, model);
-        return [tableName, id, record];
+        return [clazz, id, record, ...ctxArgs];
     }
     /**
      * @description Prepares multiple records for creation
@@ -148,11 +150,11 @@ export class CouchDBAdapter extends Adapter {
      * @return A tuple containing the tableName, ids, and prepared records
      * @throws {InternalError} If ids and models arrays have different lengths
      */
-    createAllPrefix(tableName, ids, models, 
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    ...args) {
+    createAllPrefix(clazz, ids, models, ...args) {
+        const tableName = Model.tableName(clazz);
         if (ids.length !== models.length)
             throw new InternalError("Ids and models must have the same length");
+        const { ctxArgs } = this.logCtx(args, this.createAllPrefix);
         const records = ids.map((id, count) => {
             const record = {};
             record[CouchDBKeys.TABLE] = tableName;
@@ -160,7 +162,7 @@ export class CouchDBAdapter extends Adapter {
             Object.assign(record, models[count]);
             return record;
         });
-        return [tableName, ids, records];
+        return [clazz, ids, records, ...ctxArgs];
     }
     /**
      * @description Prepares a record for update
@@ -172,9 +174,9 @@ export class CouchDBAdapter extends Adapter {
      * @return A tuple containing the tableName, id, and prepared record
      * @throws {InternalError} If no revision number is found in the model
      */
-    updatePrefix(tableName, id, model, 
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    ...args) {
+    updatePrefix(clazz, id, model, ...args) {
+        const tableName = Model.tableName(clazz);
+        const { ctxArgs } = this.logCtx(args, this.updatePrefix);
         const record = {};
         record[CouchDBKeys.TABLE] = tableName;
         record[CouchDBKeys.ID] = this.generateId(tableName, id);
@@ -183,7 +185,7 @@ export class CouchDBAdapter extends Adapter {
             throw new InternalError(`No revision number found for record with id ${id}`);
         Object.assign(record, model);
         record[CouchDBKeys.REV] = rev;
-        return [tableName, id, record];
+        return [clazz, id, record, ...ctxArgs];
     }
     /**
      * @description Prepares multiple records for update
@@ -194,11 +196,11 @@ export class CouchDBAdapter extends Adapter {
      * @return A tuple containing the tableName, ids, and prepared records
      * @throws {InternalError} If ids and models arrays have different lengths or if no revision number is found in a model
      */
-    updateAllPrefix(tableName, ids, models, 
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    ...args) {
+    updateAllPrefix(clazz, ids, models, ...args) {
+        const tableName = Model.tableName(clazz);
         if (ids.length !== models.length)
             throw new InternalError("Ids and models must have the same length");
+        const { ctxArgs } = this.logCtx(args, this.updateAllPrefix);
         const records = ids.map((id, count) => {
             const record = {};
             record[CouchDBKeys.TABLE] = tableName;
@@ -210,7 +212,7 @@ export class CouchDBAdapter extends Adapter {
             record[CouchDBKeys.REV] = rev;
             return record;
         });
-        return [tableName, ids, records];
+        return [clazz, ids, records, ...ctxArgs];
     }
     /**
      * @description Generates a CouchDB document ID
@@ -336,6 +338,44 @@ export class CouchDBAdapter extends Adapter {
                 return new InternalError(err);
         }
     }
+    // TODO why do we need this?
+    /**
+     * @description Sets metadata on a model instance.
+     * @summary Attaches metadata to a model instance using a non-enumerable property.
+     * @template M - The model type that extends Model.
+     * @param {M} model - The model instance.
+     * @param {any} metadata - The metadata to attach to the model.
+     */
+    static setMetadata(model, metadata) {
+        Object.defineProperty(model, PersistenceKeys.METADATA, {
+            enumerable: false,
+            configurable: true,
+            writable: true,
+            value: metadata,
+        });
+    }
+    /**
+     * @description Gets metadata from a model instance.
+     * @summary Retrieves previously attached metadata from a model instance.
+     * @template M - The model type that extends Model.
+     * @param {M} model - The model instance.
+     * @return {any} The metadata or undefined if not found.
+     */
+    static getMetadata(model) {
+        const descriptor = Object.getOwnPropertyDescriptor(model, PersistenceKeys.METADATA);
+        return descriptor ? descriptor.value : undefined;
+    }
+    /**
+     * @description Removes metadata from a model instance.
+     * @summary Deletes the metadata property from a model instance.
+     * @template M - The model type that extends Model.
+     * @param {M} model - The model instance.
+     */
+    static removeMetadata(model) {
+        const descriptor = Object.getOwnPropertyDescriptor(model, PersistenceKeys.METADATA);
+        if (descriptor)
+            delete model[PersistenceKeys.METADATA];
+    }
 }
 __decorate([
     final(),
@@ -364,25 +404,25 @@ __decorate([
 __decorate([
     final(),
     __metadata("design:type", Function),
-    __metadata("design:paramtypes", [String, Object, Object, Object]),
-    __metadata("design:returntype", void 0)
+    __metadata("design:paramtypes", [Object, Object, Object, Object]),
+    __metadata("design:returntype", Array)
 ], CouchDBAdapter.prototype, "createPrefix", null);
 __decorate([
     final(),
     __metadata("design:type", Function),
-    __metadata("design:paramtypes", [String, Array, Array, Object]),
+    __metadata("design:paramtypes", [Object, Array, Array, Object]),
     __metadata("design:returntype", void 0)
 ], CouchDBAdapter.prototype, "createAllPrefix", null);
 __decorate([
     final(),
     __metadata("design:type", Function),
-    __metadata("design:paramtypes", [String, Object, Object, Object]),
+    __metadata("design:paramtypes", [Object, Object, Object, Object]),
     __metadata("design:returntype", void 0)
 ], CouchDBAdapter.prototype, "updatePrefix", null);
 __decorate([
     final(),
     __metadata("design:type", Function),
-    __metadata("design:paramtypes", [String, Array, Array, Object]),
+    __metadata("design:paramtypes", [Object, Array, Array, Object]),
     __metadata("design:returntype", void 0)
 ], CouchDBAdapter.prototype, "updateAllPrefix", null);
 //# sourceMappingURL=adapter.js.map