pg-query-sdk 1.0.0 → 1.0.1

package/dist/cjs/core/TransactionManager.js

@@ -1,9 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Manages database transactions, providing a method to execute a callback within a transaction.
+ */
 class TransactionManager {
+    /**
+     * Creates an instance of TransactionManager.
+     * @param pool - The PostgreSQL connection pool to use for transactions.
+     */
     constructor(pool) {
         this.pool = pool;
     }
+    /**
+     * Executes a given callback function within a database transaction.
+     * The transaction is committed if the callback succeeds, and rolled back if an error occurs.
+     * @param callback - The function to execute within the transaction. It receives a PoolClient instance.
+     * @returns A Promise that resolves to the result of the callback function.
+     */
     async transaction(callback) {
         const client = await this.pool.connect();
         try {

package/dist/cjs/core/UnitOfWork.d.ts

@@ -1,10 +1,29 @@
 import Repository from "../orm/Repository";
+/**
+ * Manages a list of new, dirty, and removed entities for transactional operations.
+ */
 export default class UnitOfWork {
     private newEntities;
     private dirtyEntities;
     private removedEntities;
+    /**
+     * Registers an entity as new, to be inserted on commit.
+     * @param entity - The entity to register.
+     */
     registerNew(entity: any): void;
+    /**
+     * Registers an entity as dirty, to be updated on commit.
+     * @param entity - The entity to register.
+     */
     registerDirty(entity: any): void;
+    /**
+     * Registers an entity as removed, to be deleted on commit.
+     * @param entity - The entity to register.
+     */
     registerRemoved(entity: any): void;
+    /**
+     * Commits all registered changes (insertions, updates, deletions) using the provided repository.
+     * @param repository - The repository to use for committing changes.
+     */
     commit(repository: Repository<any>): Promise<void>;
 }

package/dist/cjs/core/UnitOfWork.js

@@ -1,20 +1,39 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Manages a list of new, dirty, and removed entities for transactional operations.
+ */
 class UnitOfWork {
     constructor() {
         this.newEntities = [];
         this.dirtyEntities = [];
         this.removedEntities = [];
     }
+    /**
+     * Registers an entity as new, to be inserted on commit.
+     * @param entity - The entity to register.
+     */
     registerNew(entity) {
         this.newEntities.push(entity);
     }
+    /**
+     * Registers an entity as dirty, to be updated on commit.
+     * @param entity - The entity to register.
+     */
     registerDirty(entity) {
         this.dirtyEntities.push(entity);
     }
+    /**
+     * Registers an entity as removed, to be deleted on commit.
+     * @param entity - The entity to register.
+     */
     registerRemoved(entity) {
         this.removedEntities.push(entity);
     }
+    /**
+     * Commits all registered changes (insertions, updates, deletions) using the provided repository.
+     * @param repository - The repository to use for committing changes.
+     */
     async commit(repository) {
         for (const e of this.newEntities)
             await repository.insert(e);

package/dist/cjs/dialects/Dialect.d.ts

@@ -1,4 +1,17 @@
+/**
+ * Defines the interface for a database dialect, providing methods for placeholder generation and identifier wrapping.
+ */
 export interface Dialect {
+    /**
+     * Generates a parameter placeholder for the given index.
+     * @param index - The index of the parameter.
+     * @returns The dialect-specific parameter placeholder.
+     */
     placeholder(index: number): string;
+    /**
+     * Wraps an identifier (e.g., table name, column name) with dialect-specific quoting.
+     * @param identifier - The identifier to wrap.
+     * @returns The wrapped identifier.
+     */
     wrapIdentifier(identifier: string): string;
 }

package/dist/cjs/dialects/MysqlDialect.d.ts

@@ -1,5 +1,17 @@
 import { Dialect } from "./Dialect";
+/**
+ * Implements the Dialect interface for MySQL, providing MySQL-specific placeholder and identifier wrapping.
+ */
 export default class MysqlDialect implements Dialect {
+    /**
+     * Returns a MySQL-specific parameter placeholder '?'.
+     * @returns The string '?'.
+     */
     placeholder(): string;
+    /**
+     * Wraps a MySQL identifier with backticks.
+     * @param id - The identifier to wrap.
+     * @returns The backtick-wrapped identifier.
+     */
     wrapIdentifier(id: string): string;
 }

package/dist/cjs/dialects/MysqlDialect.js

@@ -1,9 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Implements the Dialect interface for MySQL, providing MySQL-specific placeholder and identifier wrapping.
+ */
 class MysqlDialect {
+    /**
+     * Returns a MySQL-specific parameter placeholder '?'.
+     * @returns The string '?'.
+     */
     placeholder() {
         return '?';
     }
+    /**
+     * Wraps a MySQL identifier with backticks.
+     * @param id - The identifier to wrap.
+     * @returns The backtick-wrapped identifier.
+     */
     wrapIdentifier(id) {
         return `\`${id}\``;
     }

package/dist/cjs/dialects/PostgresDialect.d.ts

@@ -1,5 +1,18 @@
 import { Dialect } from "./Dialect";
+/**
+ * Implements the Dialect interface for PostgreSQL, providing PostgreSQL-specific placeholder and identifier wrapping.
+ */
 export default class PostgresDialect implements Dialect {
+    /**
+     * Returns a PostgreSQL-specific parameter placeholder (e.g., '$1', '$2').
+     * @param index - The index of the parameter.
+     * @returns The dollar-prefixed, indexed placeholder.
+     */
     placeholder(index: number): string;
+    /**
+     * Wraps a PostgreSQL identifier with double quotes.
+     * @param id - The identifier to wrap.
+     * @returns The double-quoted identifier.
+     */
     wrapIdentifier(id: string): string;
 }

package/dist/cjs/dialects/PostgresDialect.js

@@ -1,9 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Implements the Dialect interface for PostgreSQL, providing PostgreSQL-specific placeholder and identifier wrapping.
+ */
 class PostgresDialect {
+    /**
+     * Returns a PostgreSQL-specific parameter placeholder (e.g., '$1', '$2').
+     * @param index - The index of the parameter.
+     * @returns The dollar-prefixed, indexed placeholder.
+     */
     placeholder(index) {
         return `$${index}`;
     }
+    /**
+     * Wraps a PostgreSQL identifier with double quotes.
+     * @param id - The identifier to wrap.
+     * @returns The double-quoted identifier.
+     */
     wrapIdentifier(id) {
         return `"${id}"`;
     }

package/dist/cjs/index.d.ts

@@ -1,7 +1,35 @@
+/**
+ * Re-exports the QueryExecutor class from the core module.
+ * @module QueryExecutor
+ */
 export { default as QueryExecutor } from './core/QueryExecutor';
+/**
+ * Re-exports the QueryBuilder class from the builders module.
+ * @module QueryBuilder
+ */
 export { default as QueryBuilder } from './builders/QueryBuilder';
+/**
+ * Re-exports the ConditionBuilder class from the builders module.
+ * @module ConditionBuilder
+ */
 export { default as ConditionBuilder } from './builders/ConditionBuilder';
+/**
+ * Re-exports the Database class from the core module.
+ * @module Database
+ */
 export { default as Database } from './core/Database';
+/**
+ * Re-exports the TransactionManager class from the core module.
+ * @module TransactionManager
+ */
 export { default as TransactionManager } from './core/TransactionManager';
+/**
+ * Re-exports the PostgresDialect class from the dialects module.
+ * @module PostgresDialect
+ */
 export { default as PostgresDialect } from './dialects/PostgresDialect';
+/**
+ * Re-exports the Repository class from the orm module.
+ * @module Repository
+ */
 export { default as Repository } from './orm/Repository';

package/dist/cjs/index.js

@@ -4,17 +4,45 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Repository = exports.PostgresDialect = exports.TransactionManager = exports.Database = exports.ConditionBuilder = exports.QueryBuilder = exports.QueryExecutor = void 0;
+/**
+ * Re-exports the QueryExecutor class from the core module.
+ * @module QueryExecutor
+ */
 var QueryExecutor_1 = require("./core/QueryExecutor");
 Object.defineProperty(exports, "QueryExecutor", { enumerable: true, get: function () { return __importDefault(QueryExecutor_1).default; } });
+/**
+ * Re-exports the QueryBuilder class from the builders module.
+ * @module QueryBuilder
+ */
 var QueryBuilder_1 = require("./builders/QueryBuilder");
 Object.defineProperty(exports, "QueryBuilder", { enumerable: true, get: function () { return __importDefault(QueryBuilder_1).default; } });
+/**
+ * Re-exports the ConditionBuilder class from the builders module.
+ * @module ConditionBuilder
+ */
 var ConditionBuilder_1 = require("./builders/ConditionBuilder");
 Object.defineProperty(exports, "ConditionBuilder", { enumerable: true, get: function () { return __importDefault(ConditionBuilder_1).default; } });
+/**
+ * Re-exports the Database class from the core module.
+ * @module Database
+ */
 var Database_1 = require("./core/Database");
 Object.defineProperty(exports, "Database", { enumerable: true, get: function () { return __importDefault(Database_1).default; } });
+/**
+ * Re-exports the TransactionManager class from the core module.
+ * @module TransactionManager
+ */
 var TransactionManager_1 = require("./core/TransactionManager");
 Object.defineProperty(exports, "TransactionManager", { enumerable: true, get: function () { return __importDefault(TransactionManager_1).default; } });
+/**
+ * Re-exports the PostgresDialect class from the dialects module.
+ * @module PostgresDialect
+ */
 var PostgresDialect_1 = require("./dialects/PostgresDialect");
 Object.defineProperty(exports, "PostgresDialect", { enumerable: true, get: function () { return __importDefault(PostgresDialect_1).default; } });
+/**
+ * Re-exports the Repository class from the orm module.
+ * @module Repository
+ */
 var Repository_1 = require("./orm/Repository");
 Object.defineProperty(exports, "Repository", { enumerable: true, get: function () { return __importDefault(Repository_1).default; } });

package/dist/cjs/orm/Repository.d.ts

@@ -1,13 +1,47 @@
 import { QueryBuilder, QueryExecutor } from "../index";
 import { Dialect } from "../dialects/Dialect";
+/**
+ * Abstract base class for repositories, providing common database operations.
+ * @template T The type of the entity managed by the repository.
+ */
 export default abstract class Repository<T> {
     protected table: string;
     protected executor: QueryExecutor;
     protected dialect: Dialect;
+    /**
+     * Creates an instance of Repository.
+     * @param table - The name of the database table associated with this repository.
+     * @param executor - The QueryExecutor instance for executing queries.
+     * @param dialect - The Dialect instance for database-specific syntax.
+     */
     constructor(table: string, executor: QueryExecutor, dialect: Dialect);
+    /**
+     * Returns a new QueryBuilder instance for the repository's table.
+     * @returns A QueryBuilder instance.
+     */
     qb(): QueryBuilder<T>;
+    /**
+     * Finds an entity by its ID.
+     * @param id - The ID of the entity to find.
+     * @returns A Promise that resolves to the found entity or null if not found.
+     */
     findById(id: number): Promise<T | null>;
+    /**
+     * Inserts a new entity into the database.
+     * This method should be implemented by concrete repository classes.
+     * @param data - The partial entity data to insert.
+     */
     insert(data: Partial<T>): Promise<void>;
+    /**
+     * Updates an existing entity in the database.
+     * This method should be implemented by concrete repository classes.
+     * @param data - The partial entity data to update.
+     */
     update(data: Partial<T>): Promise<void>;
+    /**
+     * Deletes an entity from the database.
+     * This method should be implemented by concrete repository classes.
+     * @param data - The partial entity data to delete (e.g., containing the ID).
+     */
     delete(data: Partial<T>): Promise<void>;
 }

package/dist/cjs/orm/Repository.js

@@ -1,15 +1,34 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const index_1 = require("../index");
+/**
+ * Abstract base class for repositories, providing common database operations.
+ * @template T The type of the entity managed by the repository.
+ */
 class Repository {
+    /**
+     * Creates an instance of Repository.
+     * @param table - The name of the database table associated with this repository.
+     * @param executor - The QueryExecutor instance for executing queries.
+     * @param dialect - The Dialect instance for database-specific syntax.
+     */
     constructor(table, executor, dialect) {
         this.table = table;
         this.executor = executor;
         this.dialect = dialect;
     }
+    /**
+     * Returns a new QueryBuilder instance for the repository's table.
+     * @returns A QueryBuilder instance.
+     */
     qb() {
         return new index_1.QueryBuilder(this.table, this.executor, this.dialect);
     }
+    /**
+     * Finds an entity by its ID.
+     * @param id - The ID of the entity to find.
+     * @returns A Promise that resolves to the found entity or null if not found.
+     */
     async findById(id) {
         const rows = await this.qb()
             .where({ id })
@@ -17,12 +36,27 @@ class Repository {
             .execute();
         return rows[0] ?? null;
     }
+    /**
+     * Inserts a new entity into the database.
+     * This method should be implemented by concrete repository classes.
+     * @param data - The partial entity data to insert.
+     */
     async insert(data) {
         // implementação insert segura
     }
+    /**
+     * Updates an existing entity in the database.
+     * This method should be implemented by concrete repository classes.
+     * @param data - The partial entity data to update.
+     */
     async update(data) {
         // implementação update segura
     }
+    /**
+     * Deletes an entity from the database.
+     * This method should be implemented by concrete repository classes.
+     * @param data - The partial entity data to delete (e.g., containing the ID).
+     */
     async delete(data) {
         // soft delete opcional
     }

package/dist/cjs/query/ConditionBuilder.d.ts

@@ -1,11 +1,44 @@
 import ParamContext from '../core/ParamContext';
+/**
+ * A builder for constructing SQL WHERE and HAVING clauses.
+ */
 export default class ConditionBuilder {
     private ctx;
     private parts;
+    /**
+     * Creates an instance of ConditionBuilder.
+     * @param ctx - The ParamContext to manage query parameters.
+     */
     constructor(ctx: ParamContext);
+    /**
+     * Adds one or more WHERE conditions based on an object.
+     * Supports direct equality, `null` checks, and custom operators.
+     * @param obj - An object where keys are column names and values are the desired values or an object with `op` and `value`.
+     * @returns The current ConditionBuilder instance.
+     */
     where(obj: Record<string, any>): this;
+    /**
+     * Adds a raw SQL expression to the conditions.
+     * @param expression - The raw SQL expression.
+     * @returns The current ConditionBuilder instance.
+     */
     raw(expression: string): this;
+    /**
+     * Adds a group of conditions connected by AND.
+     * @param cb - A callback function that receives a nested ConditionBuilder to define conditions within the group.
+     * @returns The current ConditionBuilder instance.
+     */
     andGroup(cb: (qb: ConditionBuilder) => void): this;
+    /**
+     * Adds a group of conditions connected by OR.
+     * @param cb - A callback function that receives a nested ConditionBuilder to define conditions within the group.
+     * @returns The current ConditionBuilder instance.
+     */
     orGroup(cb: (qb: ConditionBuilder) => void): this;
+    /**
+     * Builds the SQL condition string.
+     * @param prefix - The prefix for the condition (e.g., 'WHERE', 'HAVING'). Defaults to 'WHERE'.
+     * @returns The built SQL condition string, or an empty string if no conditions were added.
+     */
     build(prefix?: string): string;
 }

package/dist/cjs/query/ConditionBuilder.js

@@ -1,10 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * A builder for constructing SQL WHERE and HAVING clauses.
+ */
 class ConditionBuilder {
+    /**
+     * Creates an instance of ConditionBuilder.
+     * @param ctx - The ParamContext to manage query parameters.
+     */
     constructor(ctx) {
         this.ctx = ctx;
         this.parts = [];
     }
+    /**
+     * Adds one or more WHERE conditions based on an object.
+     * Supports direct equality, `null` checks, and custom operators.
+     * @param obj - An object where keys are column names and values are the desired values or an object with `op` and `value`.
+     * @returns The current ConditionBuilder instance.
+     */
     where(obj) {
         Object.entries(obj).forEach(([key, value]) => {
             if (value === null) {
@@ -22,10 +35,20 @@ class ConditionBuilder {
         });
         return this;
     }
+    /**
+     * Adds a raw SQL expression to the conditions.
+     * @param expression - The raw SQL expression.
+     * @returns The current ConditionBuilder instance.
+     */
     raw(expression) {
         this.parts.push(expression);
         return this;
     }
+    /**
+     * Adds a group of conditions connected by AND.
+     * @param cb - A callback function that receives a nested ConditionBuilder to define conditions within the group.
+     * @returns The current ConditionBuilder instance.
+     */
     andGroup(cb) {
         const nested = new ConditionBuilder(this.ctx);
         cb(nested);
@@ -35,6 +58,11 @@ class ConditionBuilder {
         }
         return this;
     }
+    /**
+     * Adds a group of conditions connected by OR.
+     * @param cb - A callback function that receives a nested ConditionBuilder to define conditions within the group.
+     * @returns The current ConditionBuilder instance.
+     */
     orGroup(cb) {
         const nested = new ConditionBuilder(this.ctx);
         cb(nested);
@@ -45,6 +73,11 @@ class ConditionBuilder {
         }
         return this;
     }
+    /**
+     * Builds the SQL condition string.
+     * @param prefix - The prefix for the condition (e.g., 'WHERE', 'HAVING'). Defaults to 'WHERE'.
+     * @returns The built SQL condition string, or an empty string if no conditions were added.
+     */
     build(prefix = 'WHERE') {
         if (!this.parts.length)
             return '';