@dataclouder/ngx-core 0.2.1 → 0.2.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dataclouder/ngx-core",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "Angular core components library for DataClouder applications, only for internal use",
   "author": {
     "name": "dataclouder",

package/types/dataclouder-ngx-core.d.ts

@@ -708,15 +708,11 @@ declare abstract class EntityCommunicationService<T> {
      * @deprecated Use createOrUpdate(payload) instead.
      */
     createOperation(payload: Partial<T>): Promise<T>;
-    query(filterConfig: FiltersConfig): Promise<IFilterQueryResponse<T>>;
     /**
-     * @deprecated Use createOrUpdate instead.
-     */
+   * @deprecated This was changed to use operation() method., refactor your code to use operation.
+   */
+    query(filterConfig: FiltersConfig): Promise<IFilterQueryResponse<T>>;
     update(id: string, update: any): Promise<T>;
-    /**
-     * @deprecated Use createOrUpdate or updateOne instead.
-     */
-    updateOneOperation(id: string, payload: any): Promise<T>;
     partialUpdate(id: string, partialUpdates: Partial<T>): Promise<T>;
     remove(id: string): Promise<void>;
     /**
@@ -725,8 +721,47 @@ declare abstract class EntityCommunicationService<T> {
     removeOperation(id: string): Promise<any>;
     clone(id: string, overrides?: Partial<T>): Promise<T>;
     getFixedQuery(): Record<string, any>;
+    /**
+     * Executes a single database operation through a flexible interface provided by the backend's `@dataclouder/nest-mongo` ecosystem.
+     * By leveraging this endpoint, clients can safely execute any common MongoDB operation by passing the appropriate configuration.
+     *
+     * @param params - The payload containing the operation details.
+     * @param params.action - The database action to perform. Valid options are:
+     *   - `'findOne'`: Fetch the first document matching `query`.
+     *   - `'find'`: Retrieve multiple documents matching `query` (supports `projection` and `options`).
+     *   - `'create'`: Insert a new document utilizing `payload`.
+     *   - `'updateOne'`: Modify the first document matching `query` using update operators in `payload`.
+     *   - `'updateMany'`: Modify all documents matching `query` using `payload`.
+     *   - `'deleteOne'`: Remove the first document matching `query`.
+     *   - `'deleteMany'`: Remove all documents matching `query`.
+     *   - `'aggregate'`: Run an aggregation pipeline provided in `payload` as an array.
+     *   - `'clone'`: Create a copy of a document identified by `query`, overriding properties with `payload`.
+     * @param params.query - The MongoDB query used to select documents (e.g., `{ status: "active" }`).
+     * @param params.payload - The data for `create`, `updateOne`, `updateMany` (update operators), or the aggregation pipeline array.
+     * @param params.projection - Specifies the fields to return for `find` or `findOne` (e.g., `{ name: 1, email: 1 }`).
+     * @param params.options - Additional options for `find` operations like `limit`, `skip`, or `sort` (e.g., `{ limit: 10 }`).
+     *
+     * @example
+     * // Find multiple documents
+     * this.operation({
+     *   action: 'find',
+     *   query: { status: 'active' },
+     *   projection: { name: 1 },
+     *   options: { limit: 10, sort: { createdAt: -1 } }
+     * });
+     *
+     * @example
+     * // Update a single document
+     * this.operation({
+     *   action: 'updateOne',
+     *   query: { _id: '123' },
+     *   payload: { $set: { status: 'inactive' } }
+     * });
+     *
+     * @returns A Promise resolving to the result of the database operation.
+     */
     operation(params: {
-        action: 'findOne' | 'find' | 'create' | 'updateOne' | 'updateMany' | 'deleteOne' | 'deleteMany' | 'aggregate' | 'count';
+        action: 'findOne' | 'find' | 'create' | 'updateOne' | 'updateMany' | 'deleteOne' | 'deleteMany' | 'aggregate' | 'clone';
         query?: any;
         payload?: any;
         projection?: any;