@smartsoft001/mongo 2.76.0 → 2.81.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smartsoft001/mongo",
-  "version": "2.76.0",
+  "version": "2.81.0",
   "description": "Utils to mongo",
   "repository": {
     "type": "git",
@@ -16,5 +16,25 @@
   "bugs": {
     "url": "https://github.com/emiljuchnikowski/smartsoft/issues"
   },
-  "homepage": "https://github.com/emiljuchnikowski/smartsoft#readme"
-}
+  "homepage": "https://github.com/emiljuchnikowski/smartsoft#readme",
+  "dependencies": {
+    "@angular/core": "20.1.0",
+    "@jest/globals": "29.7.0",
+    "@nestjs/common": "^11.1.5",
+    "flatted": "3.3.3",
+    "guid-typescript": "^1.0.9",
+    "lodash": "4.17.21",
+    "md5": "^2.3.0",
+    "mongodb": "^5.9.2",
+    "reflect-metadata": "^0.2.1",
+    "rxjs": "^7.8.1",
+    "tslib": "^2.3.0"
+  },
+  "resolutions": {
+    "paypal-rest-sdk": "1.8.1",
+    "tslib": "^2.3.0",
+    "zone.js": "~0.15.0"
+  },
+  "main": "./index.cjs",
+  "type": "commonjs"
+}

package/src/lib/mongo.config.d.ts

@@ -0,0 +1,10 @@
+export declare class MongoConfig {
+    host?: string;
+    port?: number;
+    database: string;
+    username?: string;
+    password?: string;
+    collection?: string;
+    url?: string;
+    type?: any;
+}

package/src/lib/mongo.module.d.ts

@@ -0,0 +1,7 @@
+import { DynamicModule } from '@nestjs/common';
+import { MongoConfig } from './mongo.config';
+export declare class MongoModule {
+    static forRoot(config: MongoConfig): DynamicModule;
+}
+export { MongoConfig } from './mongo.config';
+export { MongoItemRepository } from './repositories/item.repository';

package/src/lib/mongo.unitofwork.d.ts

@@ -0,0 +1,12 @@
+import { ClientSession } from 'mongodb';
+import { ITransaction, IUnitOfWork } from '@smartsoft001/domain-core';
+import { MongoConfig } from './mongo.module';
+export interface IMongoTransaction extends ITransaction {
+    session: ClientSession;
+}
+export declare class MongoUnitOfWork extends IUnitOfWork {
+    private config;
+    constructor(config: MongoConfig);
+    scope(definition: (transaction: ITransaction) => Promise<void>): Promise<void>;
+    private getUrl;
+}

package/src/lib/mongo.utils.d.ts

@@ -0,0 +1,2 @@
+import { MongoConfig } from './mongo.module';
+export declare function getMongoUrl(config: MongoConfig): string;

package/src/lib/repositories/attachment.repository.d.ts

@@ -0,0 +1,27 @@
+import { IEntity, IAttachmentRepository } from '@smartsoft001/domain-core';
+import { Readable, Stream } from 'stream';
+import { MongoConfig } from '../mongo.module';
+export declare class MongoAttachmentRepository<T extends IEntity<string>> extends IAttachmentRepository<T> {
+    private config;
+    constructor(config: MongoConfig);
+    upload(data: {
+        id: string;
+        fileName: string;
+        stream: Stream;
+        mimeType: string;
+        encoding: string;
+    }, options?: {
+        streamCallback?: (r: any) => void;
+    }): Promise<void>;
+    getInfo(id: string): Promise<{
+        fileName: string;
+        contentType: string;
+        length: number;
+    }>;
+    getStream(id: string, options: {
+        start: number;
+        end: number;
+    } | undefined): Promise<Readable>;
+    delete(id: string): Promise<void>;
+    private getUrl;
+}

package/src/lib/repositories/interfaces.d.ts

@@ -0,0 +1,21 @@
+export interface IItemCreateData {
+    id: string;
+    type: 'create';
+    data: any;
+}
+export interface IItemUpdateData {
+    id: string;
+    type: 'update';
+    data: {
+        removedFields: Array<string>;
+        updatedFields: {
+            [key: string]: any;
+        };
+    };
+}
+export interface IItemDeleteData {
+    id: string;
+    type: 'delete';
+}
+export type ItemChangedData = IItemCreateData | IItemUpdateData | IItemDeleteData;
+export type ItemChangedDataType = 'create' | 'update' | 'delete';

package/src/lib/repositories/item.repository.d.ts

@@ -0,0 +1,51 @@
+import { Collection, Db } from 'mongodb';
+import { Observable } from 'rxjs';
+import { IEntity, IItemRepository, IItemRepositoryOptions, ISpecification } from '@smartsoft001/domain-core';
+import { IUser } from '@smartsoft001/users';
+import { MongoConfig } from '../mongo.module';
+import { ItemChangedData } from './interfaces';
+export declare class MongoItemRepository<T extends IEntity<string>> extends IItemRepository<T> {
+    protected config: MongoConfig;
+    constructor(config: MongoConfig);
+    create(item: T, user: IUser, repoOptions?: IItemRepositoryOptions): Promise<void>;
+    clear(user: IUser, repoOptions?: IItemRepositoryOptions): Promise<void>;
+    createMany(list: T[], user: IUser, repoOptions?: IItemRepositoryOptions): Promise<void>;
+    update(item: T, user: IUser, repoOptions?: IItemRepositoryOptions): Promise<void>;
+    updatePartial(item: Partial<T> & {
+        id: string;
+    }, user: IUser, repoOptions?: IItemRepositoryOptions): Promise<void>;
+    updatePartialManyByCriteria(criteria: any, set: Partial<T>, user: IUser, repoOptions?: IItemRepositoryOptions): Promise<void>;
+    updatePartialManyBySpecification(spec: ISpecification, set: Partial<T>, user: IUser, repoOptions?: IItemRepositoryOptions): Promise<void>;
+    delete(id: string, user: IUser, repoOptions?: IItemRepositoryOptions): Promise<void>;
+    getById(id: string, repoOptions?: IItemRepositoryOptions): Promise<T>;
+    getByCriteria(criteria: any, options?: any): Promise<{
+        data: T[];
+        totalCount: number;
+    }>;
+    getBySpecification(spec: ISpecification, options?: any): Promise<{
+        data: T[];
+        totalCount: number;
+    }>;
+    countByCriteria(criteria: any): Promise<number>;
+    countBySpecification(spec: ISpecification): Promise<number>;
+    changesByCriteria(criteria: {
+        id?: string;
+    }): Observable<ItemChangedData>;
+    protected getContext<TResult>(handler: (db: Db) => Promise<TResult>): Promise<TResult>;
+    protected getCount(criteria: any, collection: any): Promise<any>;
+    protected getInfo(id: string, collection: Collection<any>): Promise<any>;
+    protected getModelToCreate(item: T, user: IUser): T;
+    protected mapChangeType(dbType: string): any;
+    protected getModelToUpdate(item: {
+        id: string;
+    }, user: IUser, info: any): {
+        id: string;
+    };
+    protected getModelToResult(item: T): T;
+    protected getUrl(): string;
+    protected logChange(type: any, item: any, options: any, user: any, error: any): Promise<void>;
+    protected generateSearch(criteria: any): void;
+    protected convertIdInCriteria(criteria: any): void;
+    protected convertRegex(val: string): string;
+    protected collectionContext<T>(callback: (collection: Collection) => Promise<any>, repoOptions?: IItemRepositoryOptions): Promise<any>;
+}

package/.eslintrc

@@ -1,13 +0,0 @@
-{
-  "extends": "../../../.eslintrc",
-  "rules": {
-
-  },
-  "ignorePatterns": ["!**/*"],
-  "overrides": [
-    {
-      "files": ["*.json"],
-      "parser": "jsonc-eslint-parser"
-    }
-  ]
-}

package/jest.config.ts

@@ -1,27 +0,0 @@
-/* eslint-disable */
-export default {
-  globals: {},
-  transform: {
-    '^.+\\.[tj]sx?$': [
-      'ts-jest',
-      {
-        tsconfig: '<rootDir>/tsconfig.spec.json',
-      },
-    ],
-  },
-  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx'],
-  coverageDirectory: '../../../coverage/packages/shared/mongo',
-  displayName: 'shared-mongo',
-  testEnvironment: 'node',
-  preset: '../../../jest.preset.js',
-  /* TODO: Update to latest Jest snapshotFormat
-   * By default Nx has kept the older style of Jest Snapshot formats
-   * to prevent breaking of any existing tests with snapshots.
-   * It's recommend you update to the latest format.
-   * You can do this by removing snapshotFormat property
-   * and running tests with --update-snapshot flag.
-   * Example: From within the project directory, run "nx test --update-snapshot"
-   * More info: https://jestjs.io/docs/upgrading-to-jest29#snapshot-format
-   */
-  snapshotFormat: { escapeString: true, printBasicPrototype: true },
-};

package/project.json

@@ -1,48 +0,0 @@
-{
-  "name": "shared-mongo",
-  "$schema": "../../../node_modules/nx/schemas/project-schema.json",
-  "sourceRoot": "packages/shared/mongo/src",
-  "projectType": "library",
-  "tags": ["scope:shared", "type:util"],
-  "generators": {},
-  "targets": {
-    "lint": {
-      "executor": "@nx/eslint:lint",
-      "outputs": ["{options.outputFile}"],
-      "options": {
-        "lintFilePatterns": [
-          "packages/shared/mongo/**/*.{ts,tsx,js,jsx}",
-          "packages/shared/mongo/package.json"
-        ]
-      }
-    },
-    "test": {
-      "executor": "@nx/jest:jest",
-      "options": {
-        "jestConfig": "packages/shared/mongo/jest.config.ts"
-      },
-      "outputs": ["{workspaceRoot}/coverage/packages/shared/mongo"]
-    },
-    "build": {
-      "executor": "@nx/esbuild:esbuild",
-      "outputs": ["{options.outputPath}"],
-      "options": {
-        "outputPath": "dist/packages/shared/mongo",
-        "tsConfig": "packages/shared/mongo/tsconfig.lib.json",
-        "packageJson": "packages/shared/mongo/package.json",
-        "main": "packages/shared/mongo/src/index.ts",
-        "assets": ["packages/shared/mongo/*.md"],
-        "generatePackageJson": true,
-        "format": ["cjs"]
-      }
-    },
-    "deploy": {
-      "executor": "ngx-deploy-npm:deploy",
-      "options": {
-        "access": "public",
-        "distFolderPath": "dist/packages/shared/mongo"
-      },
-      "dependsOn": ["build"]
-    }
-  }
-}

package/src/lib/mongo.config.ts

@@ -1,10 +0,0 @@
-export class MongoConfig {
-  host?: string;
-  port?: number;
-  database: string;
-  username?: string;
-  password?: string;
-  collection?: string;
-  url?: string;
-  type?: any;
-}

package/src/lib/mongo.module.ts

@@ -1,32 +0,0 @@
-import { DynamicModule } from '@nestjs/common';
-
-import {
-  IAttachmentRepository,
-  IItemRepository,
-  IUnitOfWork,
-} from '@smartsoft001/domain-core';
-
-import { MongoConfig } from './mongo.config';
-import { MongoUnitOfWork } from './mongo.unitofwork';
-import { MongoAttachmentRepository } from './repositories/attachment.repository';
-import { MongoItemRepository } from './repositories/item.repository';
-
-export class MongoModule {
-  static forRoot(config: MongoConfig): DynamicModule {
-    const providers = [
-      { provide: MongoConfig, useValue: config },
-      { provide: IItemRepository, useClass: MongoItemRepository },
-      { provide: IAttachmentRepository, useClass: MongoAttachmentRepository },
-      { provide: IUnitOfWork, useClass: MongoUnitOfWork },
-    ];
-
-    return {
-      module: MongoModule,
-      providers: providers,
-      exports: providers,
-    };
-  }
-}
-
-export { MongoConfig } from './mongo.config';
-export { MongoItemRepository } from './repositories/item.repository';

package/src/lib/mongo.unitofwork.spec.ts

@@ -1,84 +0,0 @@
-import { jest } from '@jest/globals';
-import { MongoClient, ClientSession, TransactionOptions } from 'mongodb';
-
-import { MongoConfig } from './mongo.config';
-import { IMongoTransaction, MongoUnitOfWork } from './mongo.unitofwork';
-
-const mockData: {
-  config: MongoConfig;
-  url: string;
-} = {
-  config: {
-    host: 'host',
-    port: 4200,
-    database: 'db-string',
-  },
-  url: 'mongodb://host:4200?authSource=db-string',
-};
-
-describe('shared-mongo: MongoUnitOfWork scope function', () => {
-  let mockClient: Partial<MongoClient>;
-  let mockSession: Partial<ClientSession>;
-  let model: MongoUnitOfWork;
-
-  beforeEach(() => {
-    model = new MongoUnitOfWork(mockData.config);
-
-    mockSession = {
-      withTransaction: jest.fn(
-        async <T>(
-          callback: (session: ClientSession) => Promise<T>,
-          options: TransactionOptions,
-        ): Promise<T> => {
-          return callback(mockSession as ClientSession); // Pass the mocked session
-        },
-      ) as ClientSession['withTransaction'],
-      endSession: jest.fn(() => Promise.resolve()),
-    };
-
-    mockClient = {
-      startSession: jest.fn(() => mockSession as ClientSession),
-      close: jest.fn(() => Promise.resolve()),
-    };
-
-    jest
-      .spyOn(MongoClient, 'connect')
-      .mockResolvedValue(mockClient as MongoClient);
-  });
-
-  afterEach(() => {
-    jest.restoreAllMocks();
-  });
-
-  it('should execute the definition within a transaction', async () => {
-    const mockDefinition = jest.fn(async (transaction: IMongoTransaction) => {
-      expect(transaction.session).toBe(mockSession);
-      expect(transaction.connection).toBe(mockClient);
-    });
-
-    await expect(model.scope(mockDefinition)).resolves.not.toThrow();
-
-    expect(MongoClient.connect).toHaveBeenCalledWith(mockData.url);
-    expect(mockClient.startSession).toHaveBeenCalled();
-    expect(mockSession.withTransaction).toHaveBeenCalled();
-    expect(mockDefinition).toHaveBeenCalled();
-    expect(mockSession.endSession).toHaveBeenCalled();
-    expect(mockClient.close).toHaveBeenCalled();
-  });
-
-  it('should throw an error if the definition throws an error', async () => {
-    const mockError = new Error('Test error');
-    const mockDefinition = jest.fn(async () => {
-      throw mockError;
-    });
-
-    await expect(model.scope(mockDefinition)).rejects.toThrow(mockError);
-
-    expect(MongoClient.connect).toHaveBeenCalledWith(mockData.url);
-    expect(mockClient.startSession).toHaveBeenCalled();
-    expect(mockSession.withTransaction).toHaveBeenCalled();
-    expect(mockDefinition).toHaveBeenCalled();
-    expect(mockSession.endSession).toHaveBeenCalled();
-    expect(mockClient.close).toHaveBeenCalled();
-  });
-});

package/src/lib/mongo.unitofwork.ts

@@ -1,58 +0,0 @@
-import { Injectable } from '@nestjs/common';
-import { ClientSession, MongoClient, TransactionOptions } from 'mongodb';
-
-import { ITransaction, IUnitOfWork } from '@smartsoft001/domain-core';
-
-import { MongoConfig } from './mongo.module';
-import { getMongoUrl } from './mongo.utils';
-
-export interface IMongoTransaction extends ITransaction {
-  session: ClientSession;
-}
-
-@Injectable()
-export class MongoUnitOfWork extends IUnitOfWork {
-  constructor(private config: MongoConfig) {
-    super();
-  }
-
-  async scope(
-    definition: (transaction: ITransaction) => Promise<void>,
-  ): Promise<void> {
-    const client = await MongoClient.connect(this.getUrl());
-
-    // Step 1: Start a Client Session
-    const session = client.startSession();
-
-    // Step 2: Optional. Define options to use for the transaction
-    const transactionOptions: TransactionOptions = {
-      readPreference: 'primary',
-      readConcern: { level: 'local' },
-      writeConcern: { w: 'majority' },
-    };
-
-    // Step 3: Use withTransaction to start a transaction, execute the callback, and commit (or abort on error)
-    // Note: The callback for withTransaction MUST be async and/or return a Promise.
-
-    let error = null;
-    try {
-      await session.withTransaction(async () => {
-        await definition({
-          session,
-          connection: client,
-        } as IMongoTransaction);
-      }, transactionOptions);
-    } catch (e) {
-      error = e;
-    } finally {
-      await session.endSession();
-      await client.close();
-    }
-
-    if (error) throw error;
-  }
-
-  private getUrl(): string {
-    return getMongoUrl(this.config);
-  }
-}

package/src/lib/mongo.utils.spec.ts

@@ -1,53 +0,0 @@
-import { MongoConfig } from './mongo.module';
-import { getMongoUrl } from './mongo.utils';
-
-const mockData: (MongoConfig & { result: string; testName: string })[] = [
-  {
-    host: 'host',
-    port: 4200,
-    database: 'db-string',
-    result: 'mongodb://host:4200?authSource=db-string',
-    testName: 'Basic',
-  },
-  {
-    host: 'ondigitalocean.com',
-    port: 4200,
-    database: 'db-string',
-    result:
-      'mongodb+srv://ondigitalocean.com:4200?authSource=db-string&tls=true',
-    testName: 'Specific host',
-  },
-  {
-    host: 'host',
-    port: 4200,
-    database: 'db-string',
-    result: 'mongodb://host:4200?authSource=db-string',
-    testName: 'Only username',
-    username: 'username',
-  },
-  {
-    host: 'host',
-    port: 4200,
-    database: 'db-string',
-    result: 'mongodb://host:4200?authSource=db-string',
-    testName: 'Only password',
-    password: 'password',
-  },
-  {
-    host: 'host',
-    port: 4200,
-    database: 'db-string',
-    result: 'mongodb://username:password@host:4200?authSource=db-string',
-    testName: 'Username and Password',
-    username: 'username',
-    password: 'password',
-  },
-];
-
-describe('shared-mongo: utils getMongoUrl function', () => {
-  for (const data of mockData) {
-    it(data.testName, () => {
-      expect(getMongoUrl(data)).toBe(data.result);
-    });
-  }
-});

package/src/lib/mongo.utils.ts

@@ -1,17 +0,0 @@
-import { MongoConfig } from './mongo.module';
-
-export function getMongoUrl(config: MongoConfig): string {
-  let url;
-  if (config.username && config.password)
-    url = `mongodb://${config.username}:${config.password}@${config.host}:${config.port}`;
-  else url = `mongodb://${config.host}:${config.port}`;
-
-  url = url + '?authSource=' + config.database;
-
-  if (config.host.indexOf('ondigitalocean.com') > -1) {
-    url = url.replace('mongodb://', 'mongodb+srv://');
-    url = url + '&tls=true';
-  }
-
-  return url;
-}