@smartsoft001/crud-shell-nestjs 2.76.0 → 2.81.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smartsoft001/crud-shell-nestjs",
-  "version": "2.76.0",
+  "version": "2.81.0",
   "description": "Utils to crud",
   "repository": {
     "type": "git",
@@ -17,9 +17,9 @@
     "url": "https://github.com/emiljuchnikowski/smartsoft/issues"
   },
   "peerDependencies": {
-    "@smartsoft001/crud-shell-app-services": "2.76.0",
+    "@smartsoft001/crud-shell-app-services": "2.81.0",
     "@smartsoft001/crud-shell-dto": "*",
-    "@smartsoft001/domain-core": "2.76.0"
+    "@smartsoft001/domain-core": "2.81.0"
   },
   "homepage": "https://github.com/emiljuchnikowski/smartsoft#readme"
 }

package/src/lib/controllers/crud/crud.controller.d.ts

@@ -0,0 +1,39 @@
+import { Response, Request } from 'express';
+import { CreateManyMode } from '@smartsoft001/crud-domain';
+import { CrudService } from '@smartsoft001/crud-shell-app-services';
+import { IEntity } from '@smartsoft001/domain-core';
+import { IUser } from '@smartsoft001/users';
+export declare class CrudController<T extends IEntity<string>> {
+    protected readonly service: CrudService<T>;
+    constructor(service: CrudService<T>);
+    static getLink(req: Request): string;
+    create(data: T, user: IUser, res: Response): Promise<Response>;
+    createMany(data: T[], user: IUser, res: Response, mode: CreateManyMode): Promise<Response>;
+    readById(params: {
+        id: string;
+    }, user: IUser): Promise<T>;
+    read(user: IUser, req: Request, res: Response): Promise<void>;
+    update(params: {
+        id: string;
+    }, data: T, user: IUser): Promise<void>;
+    updatePartial(params: {
+        id: string;
+    }, data: Partial<T>, user: IUser): Promise<void>;
+    delete(params: {
+        id: string;
+    }, user: IUser): Promise<void>;
+    uploadAttachment(request: Request, response: Response): any;
+    downloadAttachment(id: string, request: Request, response: Response): Promise<void>;
+    deleteAttachment(id: string): Promise<void>;
+    protected getQueryObject(queryObject: any): {
+        criteria: any;
+        options: any;
+        links: any;
+    };
+    protected parseToXlsx(data: T[]): any;
+    protected parseToCsv(data: T[]): string;
+    protected getDataWithFields(data: Array<T>): {
+        res: any;
+        fields: any;
+    };
+}

package/src/lib/controllers/crud/query-to-mongo.d.ts

@@ -0,0 +1,5 @@
+export declare function q2m(query?: any, options?: any): {
+    criteria: {};
+    options: any;
+    links: (url: any, totalCount: any) => {};
+};

package/src/lib/controllers/{index.ts → index.d.ts}

@@ -1,5 +1,3 @@
 import { CrudController } from './crud/crud.controller';
-
 export * from './crud/crud.controller';
-
-export const CONTROLLERS = [CrudController];
+export declare const CONTROLLERS: (typeof CrudController)[];

package/src/lib/gateways/crud/crud.gateway.d.ts

@@ -0,0 +1,18 @@
+import { OnGatewayConnection, OnGatewayDisconnect, OnGatewayInit, WsResponse } from '@nestjs/websockets';
+import { Observable } from 'rxjs';
+import { Socket } from 'socket.io';
+import { CrudService } from '@smartsoft001/crud-shell-app-services';
+import { ItemChangedData } from '@smartsoft001/crud-shell-dtos';
+import { IEntity } from '@smartsoft001/domain-core';
+export declare class CrudGateway<T extends IEntity<string>> implements OnGatewayInit, OnGatewayConnection, OnGatewayDisconnect {
+    private service;
+    private _clientsSubscriptions;
+    constructor(service: CrudService<T>);
+    handleFilter(data: {
+        id?: string;
+    }, client: Socket): Observable<WsResponse<ItemChangedData>>;
+    afterInit(server: any): void;
+    handleDisconnect(client: any): void;
+    private clearSubscription;
+    handleConnection(client: any, ...args: any[]): void;
+}

package/src/lib/gateways/index.d.ts

@@ -0,0 +1,2 @@
+import { CrudGateway } from './crud/crud.gateway';
+export declare const GATEWAYS: (typeof CrudGateway)[];

package/src/lib/guards/auth/auth.guard.d.ts

@@ -0,0 +1,10 @@
+declare const AuthJwtGuard_base: import("@nestjs/passport").Type<import("@nestjs/passport").IAuthGuard>;
+export declare class AuthJwtGuard extends AuthJwtGuard_base {
+    private readonly logger;
+    handleRequest(err: any, user: any, info: any): any;
+}
+declare const AuthOrAnonymousJwtGuard_base: import("@nestjs/passport").Type<import("@nestjs/passport").IAuthGuard>;
+export declare class AuthOrAnonymousJwtGuard extends AuthOrAnonymousJwtGuard_base {
+    handleRequest(err: any, user: any, info: any): any;
+}
+export {};

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

@@ -0,0 +1,31 @@
+import { DynamicModule } from '@nestjs/common';
+import { SharedConfig } from '@smartsoft001/nestjs';
+export declare class CrudShellNestjsModule {
+    static forRoot<T>(options: SharedConfig & {
+        db: {
+            host: string;
+            port: number;
+            database: string;
+            username?: string;
+            password?: string;
+            collection?: string;
+            type?: T;
+        };
+    } & {
+        restApi: boolean;
+        socket: boolean;
+    }): DynamicModule;
+}
+export declare class CrudShellNestjsCoreModule {
+    static forRoot<T>(options: SharedConfig & {
+        db: {
+            host: string;
+            port: number;
+            database: string;
+            username?: string;
+            password?: string;
+            collection?: string;
+            type?: any;
+        };
+    }): DynamicModule;
+}

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/crud/shell/nestjs',
-  displayName: 'crud-shell-nestjs',
-  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,43 +0,0 @@
-{
-  "name": "crud-shell-nestjs",
-  "$schema": "../../../../node_modules/nx/schemas/project-schema.json",
-  "sourceRoot": "packages/crud/shell/nestjs/src",
-  "projectType": "library",
-  "tags": ["scope:crud", "type:shell"],
-  "generators": {},
-  "targets": {
-    "lint": {
-      "executor": "@nx/eslint:lint",
-      "outputs": ["{options.outputFile}"],
-      "options": {
-        "lintFilePatterns": [
-          "packages/crud/shell/nestjs/**/*.{ts,tsx,js,jsx}",
-          "packages/crud/shell/nestjs/package.json"
-        ],
-        "tsConfig": [
-          "packages/crud/shell/nestjs/tsconfig.lib.json",
-          "packages/crud/shell/nestjs/tsconfig.spec.json"
-        ]
-      }
-    },
-    "test": {
-      "executor": "@nx/jest:jest",
-      "options": {
-        "jestConfig": "packages/crud/shell/nestjs/jest.config.ts",
-        "passWithNoTests": true
-      },
-      "outputs": ["{workspaceRoot}/coverage/packages/crud/shell/nestjs"]
-    },
-    "build": {
-      "executor": "@nx/esbuild:esbuild",
-      "options": {
-        "outputPath": "dist/packages/crud/shell/nestjs",
-        "tsConfig": "packages/crud/shell/nestjs/tsconfig.lib.json",
-        "packageJson": "packages/crud/shell/nestjs/package.json",
-        "main": "packages/crud/shell/nestjs/src/index.ts",
-        "assets": ["packages/crud/shell/nestjs/*.md"]
-      },
-      "outputs": ["{options.outputPath}"]
-    }
-  }
-}

package/src/lib/controllers/crud/crud.controller.spec.ts

@@ -1,111 +0,0 @@
-import { Request } from 'express';
-import * as XLSX from 'xlsx';
-
-import { CrudService } from '@smartsoft001/crud-shell-app-services';
-
-import { CrudController } from './crud.controller';
-import * as q2mModule from './query-to-mongo';
-
-jest.mock('xlsx');
-jest.mock('json2csv', () => ({
-  Parser: jest.fn().mockImplementation(() => ({ parse: jest.fn(() => 'csv') })),
-}));
-
-describe('crud-nestjs: CrudController', () => {
-  let service: jest.Mocked<CrudService<any>>;
-  let controller: CrudController<any>;
-
-  beforeEach(() => {
-    service = {
-      create: jest.fn(),
-      createMany: jest.fn(),
-      readById: jest.fn(),
-      read: jest.fn(),
-      update: jest.fn(),
-      updatePartial: jest.fn(),
-      delete: jest.fn(),
-      uploadAttachment: jest.fn(),
-      getAttachmentInfo: jest.fn(),
-      getAttachmentStream: jest.fn(),
-      deleteAttachment: jest.fn(),
-    } as any;
-    controller = new CrudController(service);
-  });
-
-  describe('constructor', () => {
-    it('should assign service', () => {
-      expect(controller['service']).toBe(service);
-    });
-  });
-
-  describe('static getLink', () => {
-    it('should return correct link', () => {
-      const req = {
-        protocol: 'http',
-        headers: { host: 'localhost' },
-        url: '/api',
-      } as Request;
-      expect(CrudController.getLink(req)).toBe('http://localhost/api');
-    });
-  });
-
-  describe('getQueryObject', () => {
-    it('should call q2m and return result', () => {
-      const query = { a: 1, b: 2 };
-      const result = { criteria: {}, options: {}, links: jest.fn() };
-      jest.spyOn(q2mModule, 'q2m').mockReturnValue(result);
-      expect(controller['getQueryObject'](query)).toBe(result);
-    });
-  });
-
-  describe('parseToCsv', () => {
-    it('should return empty string for empty data', () => {
-      expect(controller['parseToCsv']([])).toBe('');
-    });
-    it('should return csv string for data', () => {
-      const data = [{ a: '1', b: '2' }];
-      jest
-        .spyOn(controller as any, 'getDataWithFields')
-        .mockReturnValue({ res: data, fields: ['a', 'b'] });
-      expect(controller['parseToCsv'](data)).toBe('csv');
-    });
-  });
-
-  describe('parseToXlsx', () => {
-    it('should return empty string for empty data', () => {
-      expect(controller['parseToXlsx']([])).toBe('');
-    });
-    it('should call XLSX utils for data', () => {
-      const data = [{ a: '1', b: '2' }];
-      jest
-        .spyOn(controller as any, 'getDataWithFields')
-        .mockReturnValue({ res: data, fields: ['a', 'b'] });
-      const jsonToSheet = jest
-        .spyOn(XLSX.utils, 'json_to_sheet')
-        .mockReturnValue({} as any);
-      const bookNew = jest
-        .spyOn(XLSX.utils, 'book_new')
-        .mockReturnValue({} as any);
-      const bookAppendSheet = jest
-        .spyOn(XLSX.utils, 'book_append_sheet')
-        .mockImplementation();
-      const write = jest.spyOn(XLSX, 'write').mockReturnValue('buffer' as any);
-      expect(controller['parseToXlsx'](data)).toBe('buffer');
-    });
-  });
-
-  describe('getDataWithFields', () => {
-    it('should flatten fields and remove html', () => {
-      const data = [{ a: '<b>1</b>', b: { c: '2' } }];
-      const result = controller['getDataWithFields'](data);
-      expect(result.fields.includes('a')).toBe(true);
-    });
-    it('should remove keys not in fields', () => {
-      const data = [{ a: '1', b: '2' }];
-      const result = controller['getDataWithFields'](data);
-      expect(
-        Object.keys(result.res[0]).every((k) => result.fields.includes(k)),
-      ).toBe(true);
-    });
-  });
-});

package/src/lib/controllers/crud/crud.controller.ts

@@ -1,355 +0,0 @@
-import {
-  Body,
-  Controller,
-  Delete,
-  Get,
-  HttpCode,
-  NotFoundException,
-  Param,
-  Patch,
-  Post,
-  Put,
-  Query,
-  Req,
-  Res,
-  UseGuards,
-} from '@nestjs/common';
-import * as Busboy from 'busboy';
-import { Response, Request } from 'express';
-import { Parser } from 'json2csv';
-import * as _ from 'lodash';
-import * as moment from 'moment-timezone';
-import * as XLSX from 'xlsx';
-
-import { CreateManyMode } from '@smartsoft001/crud-domain';
-import { CrudService } from '@smartsoft001/crud-shell-app-services';
-import { IEntity } from '@smartsoft001/domain-core';
-import { User } from '@smartsoft001/nestjs';
-import { IUser } from '@smartsoft001/users';
-import { GuidService } from '@smartsoft001/utils';
-
-import { Readable } from 'stream';
-
-import { q2m } from './query-to-mongo';
-import {
-  AuthJwtGuard,
-  AuthOrAnonymousJwtGuard,
-} from '../../guards/auth/auth.guard';
-
-@Controller('')
-export class CrudController<T extends IEntity<string>> {
-  constructor(protected readonly service: CrudService<T>) {}
-
-  static getLink(req: Request): string {
-    return req.protocol + '://' + req.headers.host + req.url;
-  }
-
-  @UseGuards(AuthJwtGuard)
-  @Post()
-  @HttpCode(200)
-  async create(
-    @Body() data: T,
-    @User() user: IUser,
-    @Res() res: Response,
-  ): Promise<Response> {
-    const id = await this.service.create(data, user);
-    res.set('Location', CrudController.getLink(res.req) + '/' + id);
-    return res.send({
-      id,
-    });
-  }
-
-  @UseGuards(AuthJwtGuard)
-  @Post('bulk')
-  async createMany(
-    @Body() data: T[],
-    @User() user: IUser,
-    @Res() res: Response,
-    @Query('mode') mode: CreateManyMode,
-  ): Promise<Response> {
-    const result = await this.service.createMany(data, user, { mode });
-    return res.send(result);
-  }
-
-  @UseGuards(AuthOrAnonymousJwtGuard)
-  @Get(':id')
-  async readById(
-    @Param() params: { id: string },
-    @User() user: IUser,
-  ): Promise<T> {
-    const result = await this.service.readById(params.id, user);
-
-    if (!result) {
-      throw new NotFoundException('Invalid id');
-    }
-
-    return result;
-  }
-
-  @UseGuards(AuthOrAnonymousJwtGuard)
-  @Get()
-  async read(
-    @User() user: IUser,
-    @Req() req: Request,
-    @Res() res: Response,
-  ): Promise<void> {
-    const object = this.getQueryObject(req.query);
-
-    const { data, totalCount } = await this.service.read(
-      object.criteria,
-      {
-        ...object.options,
-        allowDiskUse:
-          req.headers['content-type'] === 'text/csv' ||
-          req.headers['content-type'] ===
-            'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
-      },
-      user,
-    );
-
-    if (req.headers['content-type'] === 'text/csv') {
-      res.set({
-        'Content-Type': 'text/csv',
-      });
-      res.send(this.parseToCsv(data));
-    }
-
-    if (
-      req.headers['content-type'] ===
-      'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
-    ) {
-      res.set({
-        'Content-Type':
-          'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
-      });
-      res.send(this.parseToXlsx(data));
-    }
-
-    res.send({
-      data,
-      totalCount,
-      links: object.links(
-        CrudController.getLink(req).split('?')[0],
-        totalCount,
-      ),
-    });
-  }
-
-  @UseGuards(AuthJwtGuard)
-  @Put(':id')
-  async update(
-    @Param() params: { id: string },
-    @Body() data: T,
-    @User() user: IUser,
-  ): Promise<void> {
-    await this.service.update(params.id, data, user);
-  }
-
-  @UseGuards(AuthJwtGuard)
-  @Patch(':id')
-  async updatePartial(
-    @Param() params: { id: string },
-    @Body() data: Partial<T>,
-    @User() user: IUser,
-  ): Promise<void> {
-    await this.service.updatePartial(params.id, data, user);
-  }
-
-  @UseGuards(AuthJwtGuard)
-  @Delete(':id')
-  async delete(
-    @Param() params: { id: string },
-    @User() user: IUser,
-  ): Promise<void> {
-    await this.service.delete(params.id, user);
-  }
-
-  @Post('attachments')
-  uploadAttachment(@Req() request: Request, @Res() response: Response) {
-    const busboy = new Busboy({
-      headers: request.headers,
-    });
-    const id = GuidService.create();
-    const readable = new Readable();
-    // eslint-disable-next-line @typescript-eslint/no-empty-function
-    readable._read = () => {};
-
-    let fileName, encoding, mimeType;
-
-    busboy.on(
-      'file',
-      (field, file, resultFileName, resultEncoding, resultMimeType) => {
-        fileName = resultFileName;
-        encoding = resultEncoding;
-        mimeType = resultMimeType;
-
-        this.service.uploadAttachment({
-          id,
-          stream: readable,
-          fileName,
-          encoding,
-          mimeType,
-        });
-
-        file.on('data', (data) => {
-          readable.push(data);
-        });
-      },
-    );
-
-    busboy.on('finish', function () {
-      readable.push(null);
-      response.set('Location', CrudController.getLink(response.req) + '/' + id);
-      response.json({
-        id,
-        fileName,
-        contentType: mimeType,
-        length: readable.readableLength,
-      });
-      response.end();
-    });
-
-    return request.pipe(busboy);
-  }
-
-  @Get('attachments/:id')
-  async downloadAttachment(
-    @Param('id') id: string,
-    @Req() request: Request,
-    @Res() response: Response,
-  ) {
-    const fileInfo = await this.service.getAttachmentInfo(id);
-
-    if (request.headers.range) {
-      const range = request.headers.range.substr(6).split('-');
-      const start = parseInt(range[0], 10);
-      const end = parseInt(range[1], 10) || null;
-
-      const readstream = await this.service.getAttachmentStream(id, {
-        start,
-        end,
-      });
-
-      response.status(206);
-      response.set({
-        'Accept-Ranges': 'bytes',
-        'Content-Type': fileInfo.contentType,
-        'Content-Range': `bytes ${start}-${end ? end : fileInfo.length - 1}/${
-          fileInfo.length
-        }`,
-        'Content-Length': (end ? end : fileInfo.length) - start,
-        'Content-Disposition': `attachment; filename="${encodeURI(fileInfo.fileName)}"`,
-      });
-
-      response.on('close', () => {
-        readstream.destroy();
-      });
-
-      readstream.pipe(response);
-    } else {
-      const readstream = await this.service.getAttachmentStream(id);
-
-      response.on('close', () => {
-        readstream.destroy();
-      });
-
-      response.status(200);
-      response.set({
-        'Accept-Range': 'bytes',
-        'Content-Type': fileInfo.contentType,
-        'Content-Length': fileInfo.length,
-        'Content-Disposition': `attachment; filename="${encodeURI(fileInfo.fileName)}"`,
-      });
-
-      readstream.pipe(response);
-    }
-  }
-
-  @Delete('attachments/:id')
-  async deleteAttachment(@Param('id') id: string): Promise<void> {
-    await this.service.deleteAttachment(id);
-  }
-
-  protected getQueryObject(queryObject: any): { criteria; options; links } {
-    let q = '';
-
-    Object.keys(queryObject).forEach((key) => {
-      q += `&${key}=${queryObject[key]}`;
-    });
-
-    const result = q2m(q);
-
-    return result;
-  }
-
-  protected parseToXlsx(data: T[]) {
-    if (!data || !data.length) {
-      return '';
-    }
-
-    const { res } = this.getDataWithFields(data);
-
-    const ws = XLSX.utils.json_to_sheet(res);
-
-    const wb = XLSX.utils.book_new();
-    XLSX.utils.book_append_sheet(wb, ws, 'data');
-
-    return XLSX.write(wb, { bookType: 'xlsx', type: 'buffer' });
-  }
-
-  protected parseToCsv(data: T[]): string {
-    if (!data || !data.length) {
-      return '';
-    }
-
-    const { res, fields } = this.getDataWithFields(data);
-
-    return new Parser(fields).parse(data);
-  }
-
-  protected getDataWithFields(data: Array<T>): { res; fields } {
-    const fields = [];
-
-    const execute = (item, baseKey, baseItem) => {
-      Object.keys(item).forEach((key) => {
-        if (item[key] && typeof item[key] === 'string') {
-          item[key] = item[key].replace(/<[^>]*>?/gm, '');
-        }
-
-        if (item[key] && item[key] instanceof Date) {
-          item[key] = moment(item[key])
-            .tz('Europe/Warsaw')
-            .format('YYYY-MM-DD HH:mm:ss');
-        }
-
-        const val = item[key];
-
-        if (_.isArray(val)) {
-          return;
-        } else if (_.isObject(val) && Object.keys(val).length) {
-          execute(val, baseKey + key + '_', baseItem);
-        } else if (baseKey) {
-          baseItem[baseKey + key] = val;
-          if (!fields.some((f) => f === baseKey + key))
-            fields.push(baseKey + key);
-        } else {
-          if (!fields.some((f) => f === key)) fields.push(key);
-        }
-      });
-    };
-
-    data.forEach((item) => {
-      execute(item, '', item);
-    });
-
-    data.forEach((item) => {
-      Object.keys(item).forEach((key) => {
-        if (!fields.some((f) => f === key)) {
-          delete item[key];
-        }
-      });
-    });
-
-    return { res: data, fields };
-  }
-}