@decaf-ts/for-couchdb 0.3.1 → 0.3.2

package/lib/constants.cjs

@@ -1,7 +1,35 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CouchDBKeys = exports.reservedAttributes = void 0;
+/**
+ * @description Regular expression to identify reserved attributes in CouchDB
+ * @summary Matches any attribute that starts with an underscore
+ * @const reservedAttributes
+ * @memberOf module:for-couchdb
+ */
 exports.reservedAttributes = /^_.*$/g;
+/**
+ * @description Key constants used in CouchDB operations
+ * @summary Collection of string constants for CouchDB document properties and operations
+ * @typedef {Object} CouchDBKeysType
+ * @property {string} SEPARATOR - Separator used for combining table name and ID
+ * @property {string} ID - CouchDB document ID field
+ * @property {string} REV - CouchDB document revision field
+ * @property {string} DELETED - CouchDB deleted document marker
+ * @property {string} TABLE - Table name marker
+ * @property {string} SEQUENCE - Sequence marker
+ * @property {string} DDOC - Design document marker
+ * @property {string} NATIVE - Native marker
+ * @property {string} INDEX - Index marker
+ * @memberOf module:for-couchdb
+ */
+/**
+ * @description Key constants used in CouchDB operations
+ * @summary Collection of string constants for CouchDB document properties and operations
+ * @const CouchDBKeys
+ * @type {CouchDBKeysType}
+ * @memberOf module:for-couchdb
+ */
 exports.CouchDBKeys = {
     SEPARATOR: "__",
     ID: "_id",
@@ -13,4 +41,4 @@ exports.CouchDBKeys = {
     NATIVE: "__native",
     INDEX: "index",
 };
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uc3RhbnRzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL2NvbnN0YW50cy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBYSxRQUFBLGtCQUFrQixHQUFHLFFBQVEsQ0FBQztBQUU5QixRQUFBLFdBQVcsR0FBRztJQUN6QixTQUFTLEVBQUUsSUFBSTtJQUNmLEVBQUUsRUFBRSxLQUFLO0lBQ1QsR0FBRyxFQUFFLE1BQU07SUFDWCxPQUFPLEVBQUUsVUFBVTtJQUNuQixLQUFLLEVBQUUsU0FBUztJQUNoQixRQUFRLEVBQUUsWUFBWTtJQUN0QixJQUFJLEVBQUUsTUFBTTtJQUNaLE1BQU0sRUFBRSxVQUFVO0lBQ2xCLEtBQUssRUFBRSxPQUFPO0NBQ2YsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbImV4cG9ydCBjb25zdCByZXNlcnZlZEF0dHJpYnV0ZXMgPSAvXl8uKiQvZztcblxuZXhwb3J0IGNvbnN0IENvdWNoREJLZXlzID0ge1xuICBTRVBBUkFUT1I6IFwiX19cIixcbiAgSUQ6IFwiX2lkXCIsXG4gIFJFVjogXCJfcmV2XCIsXG4gIERFTEVURUQ6IFwiX2RlbGV0ZWRcIixcbiAgVEFCTEU6IFwiPz90YWJsZVwiLFxuICBTRVFVRU5DRTogXCI/P3NlcXVlbmNlXCIsXG4gIERET0M6IFwiZGRvY1wiLFxuICBOQVRJVkU6IFwiX19uYXRpdmVcIixcbiAgSU5ERVg6IFwiaW5kZXhcIixcbn07XG4iXX0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uc3RhbnRzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL2NvbnN0YW50cy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQTs7Ozs7R0FLRztBQUNVLFFBQUEsa0JBQWtCLEdBQUcsUUFBUSxDQUFDO0FBRTNDOzs7Ozs7Ozs7Ozs7OztHQWNHO0FBRUg7Ozs7OztHQU1HO0FBQ1UsUUFBQSxXQUFXLEdBQUc7SUFDekIsU0FBUyxFQUFFLElBQUk7SUFDZixFQUFFLEVBQUUsS0FBSztJQUNULEdBQUcsRUFBRSxNQUFNO0lBQ1gsT0FBTyxFQUFFLFVBQVU7SUFDbkIsS0FBSyxFQUFFLFNBQVM7SUFDaEIsUUFBUSxFQUFFLFlBQVk7SUFDdEIsSUFBSSxFQUFFLE1BQU07SUFDWixNQUFNLEVBQUUsVUFBVTtJQUNsQixLQUFLLEVBQUUsT0FBTztDQUNmLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyIvKipcbiAqIEBkZXNjcmlwdGlvbiBSZWd1bGFyIGV4cHJlc3Npb24gdG8gaWRlbnRpZnkgcmVzZXJ2ZWQgYXR0cmlidXRlcyBpbiBDb3VjaERCXG4gKiBAc3VtbWFyeSBNYXRjaGVzIGFueSBhdHRyaWJ1dGUgdGhhdCBzdGFydHMgd2l0aCBhbiB1bmRlcnNjb3JlXG4gKiBAY29uc3QgcmVzZXJ2ZWRBdHRyaWJ1dGVzXG4gKiBAbWVtYmVyT2YgbW9kdWxlOmZvci1jb3VjaGRiXG4gKi9cbmV4cG9ydCBjb25zdCByZXNlcnZlZEF0dHJpYnV0ZXMgPSAvXl8uKiQvZztcblxuLyoqXG4gKiBAZGVzY3JpcHRpb24gS2V5IGNvbnN0YW50cyB1c2VkIGluIENvdWNoREIgb3BlcmF0aW9uc1xuICogQHN1bW1hcnkgQ29sbGVjdGlvbiBvZiBzdHJpbmcgY29uc3RhbnRzIGZvciBDb3VjaERCIGRvY3VtZW50IHByb3BlcnRpZXMgYW5kIG9wZXJhdGlvbnNcbiAqIEB0eXBlZGVmIHtPYmplY3R9IENvdWNoREJLZXlzVHlwZVxuICogQHByb3BlcnR5IHtzdHJpbmd9IFNFUEFSQVRPUiAtIFNlcGFyYXRvciB1c2VkIGZvciBjb21iaW5pbmcgdGFibGUgbmFtZSBhbmQgSURcbiAqIEBwcm9wZXJ0eSB7c3RyaW5nfSBJRCAtIENvdWNoREIgZG9jdW1lbnQgSUQgZmllbGRcbiAqIEBwcm9wZXJ0eSB7c3RyaW5nfSBSRVYgLSBDb3VjaERCIGRvY3VtZW50IHJldmlzaW9uIGZpZWxkXG4gKiBAcHJvcGVydHkge3N0cmluZ30gREVMRVRFRCAtIENvdWNoREIgZGVsZXRlZCBkb2N1bWVudCBtYXJrZXJcbiAqIEBwcm9wZXJ0eSB7c3RyaW5nfSBUQUJMRSAtIFRhYmxlIG5hbWUgbWFya2VyXG4gKiBAcHJvcGVydHkge3N0cmluZ30gU0VRVUVOQ0UgLSBTZXF1ZW5jZSBtYXJrZXJcbiAqIEBwcm9wZXJ0eSB7c3RyaW5nfSBERE9DIC0gRGVzaWduIGRvY3VtZW50IG1hcmtlclxuICogQHByb3BlcnR5IHtzdHJpbmd9IE5BVElWRSAtIE5hdGl2ZSBtYXJrZXJcbiAqIEBwcm9wZXJ0eSB7c3RyaW5nfSBJTkRFWCAtIEluZGV4IG1hcmtlclxuICogQG1lbWJlck9mIG1vZHVsZTpmb3ItY291Y2hkYlxuICovXG5cbi8qKlxuICogQGRlc2NyaXB0aW9uIEtleSBjb25zdGFudHMgdXNlZCBpbiBDb3VjaERCIG9wZXJhdGlvbnNcbiAqIEBzdW1tYXJ5IENvbGxlY3Rpb24gb2Ygc3RyaW5nIGNvbnN0YW50cyBmb3IgQ291Y2hEQiBkb2N1bWVudCBwcm9wZXJ0aWVzIGFuZCBvcGVyYXRpb25zXG4gKiBAY29uc3QgQ291Y2hEQktleXNcbiAqIEB0eXBlIHtDb3VjaERCS2V5c1R5cGV9XG4gKiBAbWVtYmVyT2YgbW9kdWxlOmZvci1jb3VjaGRiXG4gKi9cbmV4cG9ydCBjb25zdCBDb3VjaERCS2V5cyA9IHtcbiAgU0VQQVJBVE9SOiBcIl9fXCIsXG4gIElEOiBcIl9pZFwiLFxuICBSRVY6IFwiX3JldlwiLFxuICBERUxFVEVEOiBcIl9kZWxldGVkXCIsXG4gIFRBQkxFOiBcIj8/dGFibGVcIixcbiAgU0VRVUVOQ0U6IFwiPz9zZXF1ZW5jZVwiLFxuICBERE9DOiBcImRkb2NcIixcbiAgTkFUSVZFOiBcIl9fbmF0aXZlXCIsXG4gIElOREVYOiBcImluZGV4XCIsXG59O1xuIl19

package/lib/constants.d.ts

@@ -1,4 +1,32 @@
+/**
+ * @description Regular expression to identify reserved attributes in CouchDB
+ * @summary Matches any attribute that starts with an underscore
+ * @const reservedAttributes
+ * @memberOf module:for-couchdb
+ */
 export declare const reservedAttributes: RegExp;
+/**
+ * @description Key constants used in CouchDB operations
+ * @summary Collection of string constants for CouchDB document properties and operations
+ * @typedef {Object} CouchDBKeysType
+ * @property {string} SEPARATOR - Separator used for combining table name and ID
+ * @property {string} ID - CouchDB document ID field
+ * @property {string} REV - CouchDB document revision field
+ * @property {string} DELETED - CouchDB deleted document marker
+ * @property {string} TABLE - Table name marker
+ * @property {string} SEQUENCE - Sequence marker
+ * @property {string} DDOC - Design document marker
+ * @property {string} NATIVE - Native marker
+ * @property {string} INDEX - Index marker
+ * @memberOf module:for-couchdb
+ */
+/**
+ * @description Key constants used in CouchDB operations
+ * @summary Collection of string constants for CouchDB document properties and operations
+ * @const CouchDBKeys
+ * @type {CouchDBKeysType}
+ * @memberOf module:for-couchdb
+ */
 export declare const CouchDBKeys: {
     SEPARATOR: string;
     ID: string;

package/lib/errors.cjs

@@ -2,10 +2,27 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IndexError = void 0;
 const db_decorators_1 = require("@decaf-ts/db-decorators");
+/**
+ * @description Error thrown when there is an issue with CouchDB indexes
+ * @summary Represents an error related to CouchDB index operations
+ * @param {string|Error} msg - The error message or Error object
+ * @class
+ * @category Errors
+ * @example
+ * // Example of using IndexError
+ * try {
+ *   // Some code that might throw an index error
+ *   throw new IndexError("Index not found");
+ * } catch (error) {
+ *   if (error instanceof IndexError) {
+ *     console.error("Index error occurred:", error.message);
+ *   }
+ * }
+ */
 class IndexError extends db_decorators_1.BaseError {
     constructor(msg) {
         super(IndexError.name, msg, 404);
     }
 }
 exports.IndexError = IndexError;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZXJyb3JzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL2Vycm9ycy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQSwyREFBb0Q7QUFFcEQsTUFBYSxVQUFXLFNBQVEseUJBQVM7SUFDdkMsWUFBWSxHQUFtQjtRQUM3QixLQUFLLENBQUMsVUFBVSxDQUFDLElBQUksRUFBRSxHQUFHLEVBQUUsR0FBRyxDQUFDLENBQUM7SUFDbkMsQ0FBQztDQUNGO0FBSkQsZ0NBSUMiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBCYXNlRXJyb3IgfSBmcm9tIFwiQGRlY2FmLXRzL2RiLWRlY29yYXRvcnNcIjtcblxuZXhwb3J0IGNsYXNzIEluZGV4RXJyb3IgZXh0ZW5kcyBCYXNlRXJyb3Ige1xuICBjb25zdHJ1Y3Rvcihtc2c6IHN0cmluZyB8IEVycm9yKSB7XG4gICAgc3VwZXIoSW5kZXhFcnJvci5uYW1lLCBtc2csIDQwNCk7XG4gIH1cbn1cbiJdfQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZXJyb3JzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL2Vycm9ycy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQSwyREFBb0Q7QUFFcEQ7Ozs7Ozs7Ozs7Ozs7Ozs7R0FnQkc7QUFDSCxNQUFhLFVBQVcsU0FBUSx5QkFBUztJQUN2QyxZQUFZLEdBQW1CO1FBQzdCLEtBQUssQ0FBQyxVQUFVLENBQUMsSUFBSSxFQUFFLEdBQUcsRUFBRSxHQUFHLENBQUMsQ0FBQztJQUNuQyxDQUFDO0NBQ0Y7QUFKRCxnQ0FJQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IEJhc2VFcnJvciB9IGZyb20gXCJAZGVjYWYtdHMvZGItZGVjb3JhdG9yc1wiO1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBFcnJvciB0aHJvd24gd2hlbiB0aGVyZSBpcyBhbiBpc3N1ZSB3aXRoIENvdWNoREIgaW5kZXhlc1xuICogQHN1bW1hcnkgUmVwcmVzZW50cyBhbiBlcnJvciByZWxhdGVkIHRvIENvdWNoREIgaW5kZXggb3BlcmF0aW9uc1xuICogQHBhcmFtIHtzdHJpbmd8RXJyb3J9IG1zZyAtIFRoZSBlcnJvciBtZXNzYWdlIG9yIEVycm9yIG9iamVjdFxuICogQGNsYXNzXG4gKiBAY2F0ZWdvcnkgRXJyb3JzXG4gKiBAZXhhbXBsZVxuICogLy8gRXhhbXBsZSBvZiB1c2luZyBJbmRleEVycm9yXG4gKiB0cnkge1xuICogICAvLyBTb21lIGNvZGUgdGhhdCBtaWdodCB0aHJvdyBhbiBpbmRleCBlcnJvclxuICogICB0aHJvdyBuZXcgSW5kZXhFcnJvcihcIkluZGV4IG5vdCBmb3VuZFwiKTtcbiAqIH0gY2F0Y2ggKGVycm9yKSB7XG4gKiAgIGlmIChlcnJvciBpbnN0YW5jZW9mIEluZGV4RXJyb3IpIHtcbiAqICAgICBjb25zb2xlLmVycm9yKFwiSW5kZXggZXJyb3Igb2NjdXJyZWQ6XCIsIGVycm9yLm1lc3NhZ2UpO1xuICogICB9XG4gKiB9XG4gKi9cbmV4cG9ydCBjbGFzcyBJbmRleEVycm9yIGV4dGVuZHMgQmFzZUVycm9yIHtcbiAgY29uc3RydWN0b3IobXNnOiBzdHJpbmcgfCBFcnJvcikge1xuICAgIHN1cGVyKEluZGV4RXJyb3IubmFtZSwgbXNnLCA0MDQpO1xuICB9XG59XG4iXX0=

package/lib/errors.d.ts

@@ -1,4 +1,21 @@
 import { BaseError } from "@decaf-ts/db-decorators";
+/**
+ * @description Error thrown when there is an issue with CouchDB indexes
+ * @summary Represents an error related to CouchDB index operations
+ * @param {string|Error} msg - The error message or Error object
+ * @class
+ * @category Errors
+ * @example
+ * // Example of using IndexError
+ * try {
+ *   // Some code that might throw an index error
+ *   throw new IndexError("Index not found");
+ * } catch (error) {
+ *   if (error instanceof IndexError) {
+ *     console.error("Index error occurred:", error.message);
+ *   }
+ * }
+ */
 export declare class IndexError extends BaseError {
     constructor(msg: string | Error);
 }

package/lib/esm/adapter.d.ts

@@ -4,25 +4,259 @@ import "reflect-metadata";
 import { Constructor, Model } from "@decaf-ts/decorator-validation";
 import { MangoQuery } from "./types";
 import { CouchDBStatement } from "./query";
+/**
+ * @description Abstract adapter for CouchDB database operations
+ * @summary Provides a base implementation for CouchDB database operations, including CRUD operations, sequence management, and error handling
+ * @template Y - The scope type
+ * @template F - The repository flags type
+ * @template C - The context type
+ * @param {Y} scope - The scope for the adapter
+ * @param {string} flavour - The flavour of the adapter
+ * @param {string} [alias] - Optional alias for the adapter
+ * @class
+ * @example
+ * // Example of extending CouchDBAdapter
+ * class MyCouchDBAdapter extends CouchDBAdapter<MyScope, MyFlags, MyContext> {
+ *   constructor(scope: MyScope) {
+ *     super(scope, 'my-couchdb', 'my-alias');
+ *   }
+ *
+ *   // Implement abstract methods
+ *   async index<M extends Model>(...models: Constructor<M>[]): Promise<void> {
+ *     // Implementation
+ *   }
+ *
+ *   async raw<R>(rawInput: MangoQuery, docsOnly: boolean): Promise<R> {
+ *     // Implementation
+ *   }
+ *
+ *   async create(tableName: string, id: string | number, model: Record<string, any>, ...args: any[]): Promise<Record<string, any>> {
+ *     // Implementation
+ *   }
+ *
+ *   async read(tableName: string, id: string | number, ...args: any[]): Promise<Record<string, any>> {
+ *     // Implementation
+ *   }
+ *
+ *   async update(tableName: string, id: string | number, model: Record<string, any>, ...args: any[]): Promise<Record<string, any>> {
+ *     // Implementation
+ *   }
+ *
+ *   async delete(tableName: string, id: string | number, ...args: any[]): Promise<Record<string, any>> {
+ *     // Implementation
+ *   }
+ * }
+ */
 export declare abstract class CouchDBAdapter<Y, F extends RepositoryFlags, C extends Context<F>> extends Adapter<Y, MangoQuery, F, C> {
     protected constructor(scope: Y, 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>;
+    /**
+     * @description Creates a new CouchDB sequence
+     * @summary Factory method that creates a new CouchDBSequence instance for managing sequences
+     * @param {SequenceOptions} options - The options for the sequence
+     * @return {Promise<Sequence>} A promise that resolves to a new Sequence instance
+     */
     Sequence(options: SequenceOptions): Promise<Sequence>;
+    /**
+     * @description Initializes the adapter by creating indexes for all managed models
+     * @summary Sets up the necessary database indexes for all models managed by this adapter
+     * @return {Promise<void>} A promise that resolves when initialization is complete
+     */
     initialize(): Promise<void>;
+    /**
+     * @description Creates indexes for the given models
+     * @summary Abstract method that must be implemented to create database indexes for the specified models
+     * @template M - The model type
+     * @param {...Constructor<M>} models - The model constructors to create indexes for
+     * @return {Promise<void>} A promise that resolves when all indexes are created
+     */
     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
+     * @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
+     * @return {Promise<R>} A promise that resolves to the query result
+     */
     abstract raw<R>(rawInput: MangoQuery, docsOnly: boolean): Promise<R>;
+    /**
+     * @description Assigns metadata to a model
+     * @summary Adds revision metadata to a model as a non-enumerable property
+     * @param {Record<string, any>} model - The model to assign metadata to
+     * @param {string} rev - The revision string to assign
+     * @return {Record<string, any>} The model with metadata assigned
+     */
     protected assignMetadata(model: Record<string, any>, rev: string): Record<string, any>;
+    /**
+     * @description Assigns metadata to multiple models
+     * @summary Adds revision metadata to multiple models as non-enumerable properties
+     * @param models - The models to assign metadata to
+     * @param {string[]} revs - The revision strings to assign
+     * @return The models with metadata assigned
+     */
     protected assignMultipleMetadata(models: Record<string, any>[], revs: string[]): Record<string, any>[];
+    /**
+     * @description Prepares a record for creation
+     * @summary Adds necessary CouchDB fields to a record before creation
+     * @param {string} tableName - The name of the table
+     * @param {string|number} id - The ID of the record
+     * @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>): (string | number | Record<string, any>)[];
+    /**
+     * @description Creates a new record in the database
+     * @summary Abstract method that must be implemented to create a new record
+     * @param {string} tableName - The name of the table
+     * @param {string|number} id - The ID of the record
+     * @param {Record<string, any>} model - The model to create
+     * @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>>;
+    /**
+     * @description Prepares multiple records for creation
+     * @summary Adds necessary CouchDB fields to multiple records before creation
+     * @param {string} tableName - The name of the table
+     * @param {string[]|number[]} ids - The IDs of the records
+     * @param models - The models to prepare
+     * @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>[]): (string | string[] | number[] | Record<string, any>[])[];
+    /**
+     * @description Reads a record from the database
+     * @summary Abstract method that must be implemented to read a record
+     * @param {string} tableName - The name of the table
+     * @param {string|number} id - The ID of the record
+     * @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>>;
+    /**
+     * @description Prepares a record for update
+     * @summary Adds necessary CouchDB fields to a record before update
+     * @param {string} tableName - The name of the table
+     * @param {string|number} id - The ID of the record
+     * @param model - The model to prepare
+     * @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>): (string | number | Record<string, any>)[];
+    /**
+     * @description Updates a record in the database
+     * @summary Abstract method that must be implemented to update a record
+     * @param {string} tableName - The name of the table
+     * @param {string|number} id - The ID of the record
+     * @param {Record<string, any>} model - The model to update
+     * @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>>;
+    /**
+     * @description Prepares multiple records for update
+     * @summary Adds necessary CouchDB fields to multiple records before update
+     * @param {string} tableName - The name of the table
+     * @param {string[]|number[]} ids - The IDs of the records
+     * @param models - The models to prepare
+     * @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>[]): (string | string[] | number[] | Record<string, 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 {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>>;
+    /**
+     * @description Generates a CouchDB document ID
+     * @summary Combines the table name and ID to create a CouchDB document ID
+     * @param {string} tableName - The name of the table
+     * @param {string|number} id - The ID of the record
+     * @return {string} The generated CouchDB document ID
+     */
     protected generateId(tableName: string, id: string | number): string;
+    /**
+     * @description Parses an error and converts it to a BaseError
+     * @summary Converts various error types to appropriate BaseError subtypes
+     * @param {Error|string} err - The error to parse
+     * @param {string} [reason] - Optional reason for the error
+     * @return {BaseError} The parsed error as a BaseError
+     */
     parseError(err: Error | string, reason?: string): BaseError;
+    /**
+     * @description Checks if an attribute is reserved
+     * @summary Determines if an attribute name is reserved in CouchDB
+     * @param {string} attr - The attribute name to check
+     * @return {boolean} True if the attribute is reserved, false otherwise
+     */
     protected isReserved(attr: string): boolean;
+    /**
+     * @description Static method to parse an error and convert it to a BaseError
+     * @summary Converts various error types to appropriate BaseError subtypes based on error codes and messages
+     * @param {Error|string} err - The error to parse
+     * @param {string} [reason] - Optional reason for the error
+     * @return {BaseError} The parsed error as a BaseError
+     * @mermaid
+     * sequenceDiagram
+     *   participant Caller
+     *   participant parseError
+     *   participant ErrorTypes
+     *
+     *   Caller->>parseError: err, reason
+     *   Note over parseError: Check if err is already a BaseError
+     *   alt err is BaseError
+     *     parseError-->>Caller: return err
+     *   else err is string
+     *     Note over parseError: Extract code from string
+     *     alt code matches "already exist|update conflict"
+     *       parseError->>ErrorTypes: new ConflictError(code)
+     *       ErrorTypes-->>Caller: ConflictError
+     *     else code matches "missing|deleted"
+     *       parseError->>ErrorTypes: new NotFoundError(code)
+     *       ErrorTypes-->>Caller: NotFoundError
+     *     end
+     *   else err has code property
+     *     Note over parseError: Extract code and reason
+     *   else err has statusCode property
+     *     Note over parseError: Extract code and reason
+     *   else
+     *     Note over parseError: Use err.message as code
+     *   end
+     *
+     *   Note over parseError: Switch on code
+     *   alt code is 401, 412, or 409
+     *     parseError->>ErrorTypes: new ConflictError(reason)
+     *     ErrorTypes-->>Caller: ConflictError
+     *   else code is 404
+     *     parseError->>ErrorTypes: new NotFoundError(reason)
+     *     ErrorTypes-->>Caller: NotFoundError
+     *   else code is 400
+     *     alt code matches "No index exists"
+     *       parseError->>ErrorTypes: new IndexError(err)
+     *       ErrorTypes-->>Caller: IndexError
+     *     else
+     *       parseError->>ErrorTypes: new InternalError(err)
+     *       ErrorTypes-->>Caller: InternalError
+     *     end
+     *   else code matches "ECONNREFUSED"
+     *     parseError->>ErrorTypes: new ConnectionError(err)
+     *     ErrorTypes-->>Caller: ConnectionError
+     *   else
+     *     parseError->>ErrorTypes: new InternalError(err)
+     *     ErrorTypes-->>Caller: InternalError
+     *   end
+     */
     protected static parseError(err: Error | string, reason?: string): BaseError;
 }