@sqb/connect 4.14.0 → 4.15.0

package/types/orm/repository.class.d.ts

@@ -1,5 +1,5 @@
 import { LogicalOperator } from '@sqb/builder';
-import { PartialDTO, PatchDTO, StrictOmit, Type } from 'ts-gems';
+import { PartialDTO, PatchDTO, RequiredSome, StrictOmit, Type } from 'ts-gems';
 import { FieldInfoMap } from '../client/field-info-map.js';
 import { SqbClient } from '../client/sqb-client.js';
 import { SqbConnection } from '../client/sqb-connection.js';
@@ -54,6 +54,10 @@ interface RepositoryEvents {
     acquire: (connection: SqbConnection) => Promise<void>;
 }
 declare const Repository_base: Type<import("strict-typed-events").TypedEventEmitter<any, RepositoryEvents, RepositoryEvents>>;
+/**
+ * @class Repository
+ * @template T - The data type class type of the record
+ */
 export declare class Repository<T> extends Repository_base {
     private readonly _executor;
     private readonly _entity;
@@ -61,19 +65,114 @@ export declare class Repository<T> extends Repository_base {
     constructor(entityDef: EntityMetadata, executor: SqbClient | SqbConnection, schema?: string);
     get entity(): EntityMetadata;
     get type(): Type<T>;
-    create(values: PartialDTO<T>, options?: Repository.CreateOptions): Promise<PartialDTO<T>>;
-    createOnly(values: PartialDTO<T>, options?: StrictOmit<Repository.CreateOptions, keyof Projection>): Promise<void>;
-    exists(keyValue: any | Record<string, any>, options?: Repository.ExistsOptions): Promise<boolean>;
-    existsOne(options?: Repository.ExistsOptions): Promise<boolean>;
+    /**
+     * Creates a new resource
+     *
+     * @param {PartialDTO<T>} input - The input data
+     * @param {Repository.CreateOptions} [options] - The options object
+     * @returns {Promise<PartialDTO<T>>} A promise that resolves to the created resource
+     * @throws {Error} if an unknown error occurs while creating the resource
+     */
+    create(input: PartialDTO<T>, options: RequiredSome<Repository.CreateOptions, 'projection'>): Promise<PartialDTO<T>>;
+    create(input: PartialDTO<T>, options?: Repository.CreateOptions): Promise<T>;
+    /**
+     * Creates a new resource but returns nothing
+     *
+     * @param {PartialDTO<T>} input - The input data
+     * @param {Repository.CreateOptions} [options] - The options object
+     * @throws {Error} if an unknown error occurs while creating the resource
+     */
+    createOnly(input: PartialDTO<T>, options?: StrictOmit<Repository.CreateOptions, keyof Projection>): Promise<void>;
+    /**
+     * Returns the count of records based on the provided options
+     *
+     * @param {Repository.CountOptions} options - The options for the count operation.
+     * @return {Promise<number>} - A promise that resolves to the count of records
+     */
     count(options?: Repository.CountOptions): Promise<number>;
-    findById(keyValue: any | Record<string, any>, options?: Repository.FindOptions): Promise<PartialDTO<T> | undefined>;
-    findOne(options?: Repository.FindOneOptions): Promise<PartialDTO<T> | undefined>;
-    findMany(options?: Repository.FindManyOptions): Promise<PartialDTO<T>[]>;
+    /**
+     * Deletes a record from the collection.
+     *
+     * @param {any} keyValue - The ID of the resource to delete.
+     * @param {Repository.DeleteOptions} [options] - Optional delete options.
+     * @return {Promise<boolean>} - A Promise that resolves true or false. True when resource deleted.
+     */
     delete(keyValue: any | Record<string, any>, options?: Repository.DeleteOptions): Promise<boolean>;
+    /**
+     * Deletes multiple documents from the collection that meet the specified filter criteria.
+     *
+     * @param {Repository.DeleteManyOptions} options - The options for the delete operation.
+     * @return {Promise<number>} - A promise that resolves to the number of resources deleted.
+     */
     deleteMany(options?: Repository.DeleteManyOptions): Promise<number>;
-    update(keyValue: any | Record<string, any>, values: PatchDTO<T>, options?: Repository.UpdateOptions): Promise<PartialDTO<T> | undefined>;
-    updateOnly(keyValue: any | Record<string, any>, values: PatchDTO<T>, options?: Repository.UpdateOnlyOptions): Promise<boolean>;
-    updateMany(values: PartialDTO<T>, options?: Repository.UpdateManyOptions): Promise<number>;
+    /**
+     * Checks if a record with the given id exists.
+     *
+     * @param {any} keyValue - The id of the object to check.
+     * @param {Repository.ExistsOptions} [options] - The options for the query (optional).
+     * @return {Promise<boolean>} - A Promise that resolves to a boolean indicating whether the record exists or not.
+     */
+    exists(keyValue: any | Record<string, any>, options?: Repository.ExistsOptions): Promise<boolean>;
+    /**
+     * Checks if a record with the given arguments exists.
+     *
+     * @param {Repository.ExistsOptions} [options] - The options for the query (optional).
+     * @return {Promise<boolean>} - A Promise that resolves to a boolean indicating whether the record exists or not.
+     */
+    existsOne(options?: Repository.ExistsOptions): Promise<boolean>;
+    /**
+     * Finds a record by ID.
+     *
+     * @param {any} keyValue - The ID of the record.
+     * @param {Repository.FindOneOptions} [options] - The options for the find query.
+     * @return {Promise<PartialDTO<T | undefined>>} - A promise resolving to the found document, or undefined if not found.
+     */
+    findById(keyValue: any | Record<string, any>, options: RequiredSome<Repository.FindOptions, 'projection'>): Promise<PartialDTO<T> | undefined>;
+    findById(keyValue: any | Record<string, any>, options?: Repository.FindOptions): Promise<T | undefined>;
+    /**
+     * Finds a record in the collection that matches the specified options.
+     *
+     * @param {Repository.FindOneOptions} options - The options for the query.
+     * @return {Promise<PartialDTO<T> | undefined>} A promise that resolves with the found document or undefined if no document is found.
+     */
+    findOne(options: RequiredSome<Repository.FindOneOptions, 'projection'>): Promise<PartialDTO<T> | undefined>;
+    findOne(options?: Repository.FindOneOptions): Promise<T | undefined>;
+    /**
+     * Finds multiple records in collection.
+     *
+     * @param {Repository.FindManyOptions} options - The options for the find operation.
+     * @return A Promise that resolves to an array of partial outputs of type T.
+     */
+    findMany(options: RequiredSome<Repository.FindManyOptions, 'projection'>): Promise<PartialDTO<T>[]>;
+    findMany(options?: Repository.FindManyOptions): Promise<T[]>;
+    /**
+     * Updates a record with the given id in the collection.
+     *
+     * @param {any} keyValue - The id of the document to update.
+     * @param {PatchDTO<T>} input - The partial input object containing the fields to update.
+     * @param {Repository.UpdateOptions} [options] - The options for the update operation.
+     * @returns {Promise<PartialDTO<T> | undefined>} A promise that resolves to the updated document or
+     * undefined if the document was not found.
+     */
+    update(keyValue: any | Record<string, any>, input: PatchDTO<T>, options: RequiredSome<Repository.UpdateOptions, 'projection'>): Promise<PartialDTO<T> | undefined>;
+    update(keyValue: any | Record<string, any>, input: PatchDTO<T>, options?: Repository.UpdateOptions): Promise<T | undefined>;
+    /**
+     * Updates a record in the collection with the specified ID and returns updated record count
+     *
+     * @param {any} keyValue - The ID of the document to update.
+     * @param {PatchDTO<T>} input - The partial input data to update the document with.
+     * @param {Repository.UpdateOptions} options - The options for updating the document.
+     * @returns {Promise<number>} - A Promise that resolves true or false. True when resource updated.
+     */
+    updateOnly(keyValue: any | Record<string, any>, input: PatchDTO<T>, options?: Repository.UpdateOnlyOptions): Promise<boolean>;
+    /**
+     * Updates multiple records in the collection based on the specified input and options.
+     *
+     * @param {PatchDTO<T>} input - The partial input to update the documents with.
+     * @param {Repository.UpdateManyOptions} options - The options for updating the documents.
+     * @return {Promise<number>} - A promise that resolves to the number of documents matched and modified.
+     */
+    updateMany(input: PartialDTO<T>, options?: Repository.UpdateManyOptions): Promise<number>;
     protected _execute(fn: TransactionFunction, opts?: Repository.CommandOptions): Promise<any>;
     protected _create(values: PartialDTO<T>, options: Repository.CreateOptions & {
         connection: SqbConnection;

package/cjs/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "commonjs"
-}