@smartsoft001/crud-shell-nestjs 2.76.0 → 2.80.0

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

@@ -1,32 +0,0 @@
-import * as queryToMongo from './query-to-mongo';
-
-describe('crud-nestjs: query-to-mongo', () => {
-  describe('q2m', () => {
-    it('should convert query string to mongo object', () => {
-      const result = queryToMongo.q2m('a=1&b=2');
-      expect(result).toHaveProperty('criteria');
-    });
-    it('should convert query object to mongo object', () => {
-      const result = queryToMongo.q2m({ a: '1', b: '2' });
-      expect(result).toHaveProperty('criteria');
-    });
-    it('should provide links function', () => {
-      const result = queryToMongo.q2m({ a: '1', limit: '2', offset: '0' });
-      expect(typeof result.links).toBe('function');
-    });
-    it('links should return null if no limit', () => {
-      const result = queryToMongo.q2m({ a: '1' });
-      expect(result.links('url', 10)).toBeNull();
-    });
-    it('links should return prev and first if offset > 0', () => {
-      const result = queryToMongo.q2m({ a: '1', limit: '2', offset: '2' });
-      const links = result.links('url', 10);
-      expect(links).toHaveProperty('prev');
-    });
-    it('links should return next and last if more pages', () => {
-      const result = queryToMongo.q2m({ a: '1', limit: '2', offset: '0' });
-      const links = result.links('url', 10);
-      expect(links).toHaveProperty('next');
-    });
-  });
-});

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

@@ -1,295 +0,0 @@
-import * as querystring from 'querystring';
-const iso8601 =
-  /^\d{4}(-(0[1-9]|1[0-2])(-(0[1-9]|[12][0-9]|3[01]))?)?(T([01][0-9]|2[0-3]):[0-5]\d(:[0-5]\d(\.\d+)?)?(Z|[+-]\d{2}:\d{2}))?$/;
-
-// Convert comma separated list to a mongo projection.
-// for example f('field1,field2,field3') -> {field1:true,field2:true,field3:true}
-function fieldsToMongo(fields) {
-  if (!fields) return null;
-  const hash = {};
-  fields.split(',').forEach(function (field) {
-    hash[field.trim()] = 1;
-  });
-  return hash;
-}
-
-function convertRegex(val: string): string {
-  return val.toString().replace(/\*/g, '[*]');
-}
-
-// Convert comma separated list to a mongo projection which specifies fields to omit.
-// for example f('field2') -> {field2:false}
-function omitFieldsToMongo(omitFields) {
-  if (!omitFields) return null;
-  const hash = {};
-  omitFields.split(',').forEach(function (omitField) {
-    hash[omitField.trim()] = 0;
-  });
-  return hash;
-}
-
-// Convert comma separated list to mongo sort options.
-// for example f('field1,+field2,-field3') -> {field1:1,field2:1,field3:-1}
-function sortToMongo(sort) {
-  if (!sort) return null;
-  const hash = {};
-  let c;
-  sort.split(',').forEach(function (field) {
-    c = field.charAt(0);
-    if (c === '-') field = field.substr(1);
-    hash[field.trim()] = c === '-' ? -1 : 1;
-  });
-  return hash;
-}
-
-// Convert String to Number, Date, or Boolean if possible. Also strips ! prefix
-function typedValue(value) {
-  if (value[0] === '!') value = value.substr(1);
-  const regex = value.match(/^\/(.*)\/(i?)$/);
-  const quotedString = value.match(/(["'])(?:\\\1|.)*?\1/);
-
-  if (regex) {
-    return new RegExp(regex[1], regex[2]);
-  } else if (quotedString) {
-    return quotedString[0].substr(1, quotedString[0].length - 2);
-  } else if (value === 'true') {
-    return true;
-  } else if (value === 'false') {
-    return false;
-  } else if (iso8601.test(value) && value.length !== 4 && value.length !== 10) {
-    return new Date(value);
-  } else if (!isNaN(Number(value))) {
-    return Number(value);
-  }
-
-  return value;
-}
-
-// Convert a comma separated string value to an array of values.  Commas
-// in a quoted strings and regexes are ignored.  Also strips ! prefix from values.
-function typedValues(svalue) {
-  const commaSplit = /("[^"]*")|('[^']*')|(\/[^/]*\/i?)|([^,]+)/g;
-  const values = [];
-  svalue.match(commaSplit).forEach(function (value) {
-    values.push(typedValue(value));
-  });
-  return values;
-}
-
-// Convert a key/value pair split at an equals sign into a mongo comparison.
-// Converts value Strings to Numbers or Booleans when possible.
-// for example:
-// + f('key','value') => {key:'key',value:'value'}
-// + f('key>','value') => {key:'key',value:{$gte:'value'}}
-// + f('key') => {key:'key',value:{$exists: true}}
-// + f('!key') => {key:'key',value:{$exists: false}}
-// + f('key:op','value') => {key: 'key', value:{ $op: value}}
-// + f('key','op:value') => {key: 'key', value:{ $op: value}}
-function comparisonToMongo(key, value) {
-  const join = value === '' ? key : key.concat('=', value);
-  const parts = join.match(/^(!?[^><~!=:]+)(?:=?([><]=?|~?=|!?=|:.+=)(.+))?$/);
-  let op;
-  const hash = {} as any;
-  if (!parts) return null;
-
-  key = parts[1];
-  op = parts[2];
-
-  if (!op) {
-    if (key[0] !== '!') value = { $exists: true };
-    else {
-      key = key.substr(1);
-      value = { $exists: false };
-    }
-  } else if (op === '=' && parts[3] === '!') {
-    value = { $exists: false };
-  } else if (op === '=' || op === '!=') {
-    if (op === '=' && parts[3][0] === '!') op = '!=';
-    // tslint:disable-next-line:no-shadowed-variable
-    const array = typedValues(parts[3]);
-    if (array.length > 1) {
-      value = {};
-      op = op === '=' ? '$in' : '$nin';
-      value[op] = array;
-    } else if (op === '!=') {
-      value =
-        array[0] instanceof RegExp ? { $not: array[0] } : { $ne: array[0] };
-    } else if (array[0][0] === '!') {
-      const sValue = array[0].substr(1);
-      const regex = sValue.match(/^\/(.*)\/(i?)$/);
-      value = regex
-        ? { $not: new RegExp(regex[1], regex[2]) }
-        : { $ne: sValue };
-    } else {
-      value = array[0];
-    }
-  } else if (op[0] === ':' && op[op.length - 1] === '=') {
-    op = '$' + op.substr(1, op.length - 2);
-    const array = [];
-    // tslint:disable-next-line:no-shadowed-variable
-    parts[3].split(',').forEach(function (value) {
-      array.push(typedValue(value));
-    });
-    value = {};
-    value[op] = array.length === 1 ? array[0] : array;
-  } else {
-    value = typedValue(parts[3]);
-    if (op === '>') value = { $gt: value };
-    else if (op === '>=') value = { $gte: value };
-    else if (op === '<') value = { $lt: value };
-    else if (op === '<=') value = { $lte: value };
-    else if (op === '~=')
-      value = {
-        $regex: value ? convertRegex(value) : '',
-        $options: 'i',
-      };
-  }
-
-  hash.key = key;
-  hash.value = value;
-  return hash;
-}
-
-// Checks for keys that are ordinal positions, such as {'0':'one','1':'two','2':'three'}
-function hasOrdinalKeys(obj) {
-  let c = 0;
-  for (const key in obj) {
-    if (Number(key) !== c++) return false;
-  }
-  return true;
-}
-
-// Convert query parameters to a mongo query criteria.
-// for example {field1:"red","field2>2":""} becomes {field1:"red",field2:{$gt:2}}
-function queryCriteriaToMongo(query, options = null) {
-  const hash = {};
-  let deep, p;
-  options = options || {};
-
-  for (const key in query) {
-    if (
-      Object.prototype.hasOwnProperty.call(query, key) &&
-      (!options.ignore || options.ignore.indexOf(key) === -1)
-    ) {
-      deep = typeof query[key] === 'object' && !hasOrdinalKeys(query[key]);
-
-      if (deep) {
-        p = {
-          key: key,
-          value: queryCriteriaToMongo(query[key]),
-        };
-      } else {
-        p = comparisonToMongo(key, query[key]);
-      }
-
-      if (p) {
-        if (!hash[p.key]) {
-          hash[p.key] = p.value;
-        } else if (typeof p.value === 'string') {
-          hash[p.key] = Object.assign(hash[p.key], {
-            $eq: p.value,
-          });
-        } else {
-          hash[p.key] = Object.assign(hash[p.key], p.value);
-        }
-      }
-    }
-  }
-  return hash;
-}
-
-// Convert query parameters to a mongo query options.
-// for example {fields:'a,b',offset:8,limit:16} becomes {fields:{a:true,b:true},skip:8,limit:16}
-function queryOptionsToMongo(query, options) {
-  const hash = {} as any,
-    fields = fieldsToMongo(query[options.keywords.fields]),
-    omitFields = omitFieldsToMongo(query[options.keywords.omit]),
-    sort = sortToMongo(query[options.keywords.sort]),
-    maxLimit = options.maxLimit || 9007199254740992;
-
-  let limit = options.maxLimit || 0;
-
-  if (fields) hash.fields = fields;
-  // omit intentionally overwrites fields if both have been specified in the query
-  // mongo does not accept mixed true/fals field specifiers for projections
-  if (omitFields) hash.fields = omitFields;
-  if (sort) hash.sort = sort;
-
-  if (query[options.keywords.offset])
-    hash.skip = Number(query[options.keywords.offset]);
-  if (query[options.keywords.limit])
-    limit = Math.min(Number(query[options.keywords.limit]), maxLimit);
-  if (limit) {
-    hash.limit = limit;
-  } else if (options.maxLimit) {
-    hash.limit = maxLimit;
-  }
-
-  return hash;
-}
-
-export function q2m(query = null, options = null) {
-  query = query || {};
-  options = options || {};
-  options.keywords = options.keywords || {};
-
-  const defaultKeywords = {
-    fields: 'fields',
-    omit: 'omit',
-    sort: 'sort',
-    offset: 'offset',
-    limit: 'limit',
-  };
-  options.keywords = Object.assign(defaultKeywords, options.keywords);
-  const ignoreKeywords = [
-    options.keywords.fields,
-    options.keywords.omit,
-    options.keywords.sort,
-    options.keywords.offset,
-    options.keywords.limit,
-  ];
-
-  if (!options.ignore) {
-    options.ignore = [];
-  } else {
-    options.ignore =
-      typeof options.ignore === 'string' ? [options.ignore] : options.ignore;
-  }
-  options.ignore = options.ignore.concat(ignoreKeywords);
-  if (!options.parser) options.parser = querystring;
-
-  if (typeof query === 'string') query = options.parser.parse(query);
-
-  return {
-    criteria: queryCriteriaToMongo(query, options),
-    options: queryOptionsToMongo(query, options),
-
-    links: function (url, totalCount) {
-      const offset = this.options.skip || 0;
-      const limit = Math.min(this.options.limit || 0, totalCount);
-      const links = {};
-      const last = {} as any;
-
-      if (!limit) return null;
-
-      options = options || {};
-
-      if (offset > 0) {
-        query[options.keywords.offset] = Math.max(offset - limit, 0);
-        links['prev'] = url + '?' + options.parser.stringify(query);
-        query[options.keywords.offset] = 0;
-        links['first'] = url + '?' + options.parser.stringify(query);
-      }
-      if (offset + limit < totalCount) {
-        last.pages = Math.ceil(totalCount / limit);
-        last.offset = (last.pages - 1) * limit;
-
-        query[options.keywords.offset] = Math.min(offset + limit, last.offset);
-        links['next'] = url + '?' + options.parser.stringify(query);
-        query[options.keywords.offset] = last.offset;
-        links['last'] = url + '?' + options.parser.stringify(query);
-      }
-      return links;
-    },
-  };
-}

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

@@ -1,122 +0,0 @@
-import { of } from 'rxjs';
-
-import { CrudService } from '@smartsoft001/crud-shell-app-services';
-
-import { CrudGateway } from './crud.gateway';
-
-describe('crud-nestjs: CrudGateway', () => {
-  let service: jest.Mocked<CrudService<any>>;
-  let gateway: CrudGateway<any>;
-  let client: any;
-
-  beforeEach(() => {
-    service = {
-      changes: jest.fn(),
-    } as any;
-    gateway = new CrudGateway(service);
-    gateway['afterInit']({});
-    client = { id: 'client1' };
-  });
-
-  describe('afterInit', () => {
-    it('should initialize _clientsSubscriptions', () => {
-      const gw = new CrudGateway(service);
-      gw['afterInit']({});
-      expect(gw['_clientsSubscriptions']).toBeInstanceOf(Map);
-    });
-  });
-
-  describe('handleConnection', () => {
-    it('should log client connection', () => {
-      client.id = 'abc';
-      const logSpy = jest.spyOn(console, 'log').mockImplementation();
-      gateway.handleConnection(client);
-      expect(logSpy).toHaveBeenCalledWith('Client connected: abc');
-      logSpy.mockRestore();
-    });
-  });
-
-  describe('handleDisconnect', () => {
-    it('should clear subscription and log disconnect', () => {
-      const logSpy = jest.spyOn(console, 'log').mockImplementation();
-      const unsub = jest.fn();
-      gateway['_clientsSubscriptions'].set(client.id, {
-        unsubscribe: unsub,
-      } as any);
-      gateway.handleDisconnect(client);
-      expect(unsub).toHaveBeenCalled();
-      logSpy.mockRestore();
-    });
-  });
-
-  describe('clearSubscription', () => {
-    it('should unsubscribe and delete if present', () => {
-      const unsub = jest.fn();
-      gateway['_clientsSubscriptions'].set(client.id, {
-        unsubscribe: unsub,
-      } as any);
-      gateway['clearSubscription'](client);
-      expect(gateway['_clientsSubscriptions'].has(client.id)).toBe(false);
-    });
-    it('should do nothing if not present', () => {
-      expect(() => gateway['clearSubscription'](client)).not.toThrow();
-    });
-  });
-
-  describe('handleFilter', () => {
-    //TODO: testowanie observable
-    // it('should subscribe to service.changes and emit events', done => {
-    //   const res: ItemChangedData = { type: 'update', id: '1', data: {
-    //       removedFields: [],
-    //       updatedFields: {}
-    //     } };
-    //   service.changes.mockReturnValue(of(res));
-    //   const observer = gateway.handleFilter({}, client).subscribe({
-    //     next: (msg) => {
-    //       expect(msg).toEqual({ event: 'changes', data: res });
-    //       observer.unsubscribe();
-    //       done();
-    //     }
-    //   });
-    // });
-    //
-    // it('should handle errors from service.changes', done => {
-    //   service.changes.mockReturnValue(throwError(() => new Error('fail')));
-    //   const observer = gateway.handleFilter({}, client).subscribe({
-    //     error: (err) => {
-    //       expect(err).toBeInstanceOf(Error);
-    //       observer.unsubscribe();
-    //       done();
-    //     }
-    //   });
-    // });
-
-    it('should clear previous subscription before subscribing', () => {
-      const unsub = jest.fn();
-      gateway['_clientsSubscriptions'].set(client.id, {
-        unsubscribe: unsub,
-      } as any);
-      service.changes.mockReturnValue(
-        of({
-          type: 'update',
-          id: '1',
-          data: { removedFields: [], updatedFields: {} },
-        }),
-      );
-      gateway.handleFilter({}, client).subscribe().unsubscribe();
-      expect(unsub).toHaveBeenCalled();
-    });
-
-    it('should store new subscription in _clientsSubscriptions', () => {
-      service.changes.mockReturnValue(
-        of({
-          type: 'update',
-          id: '1',
-          data: { removedFields: [], updatedFields: {} },
-        }),
-      );
-      gateway.handleFilter({}, client).subscribe().unsubscribe();
-      expect(gateway['_clientsSubscriptions'].has(client.id)).toBe(true);
-    });
-  });
-});

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

@@ -1,73 +0,0 @@
-import {
-  ConnectedSocket,
-  MessageBody,
-  OnGatewayConnection,
-  OnGatewayDisconnect,
-  OnGatewayInit,
-  SubscribeMessage,
-  WebSocketGateway,
-  WsResponse,
-} from '@nestjs/websockets';
-import { Observable, Subscription } 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';
-
-@WebSocketGateway({
-  transports: ['websocket'],
-  path: '/' + process.env.URL_PREFIX + '/_socket',
-  namespace: '/' + process.env.URL_PREFIX,
-})
-export class CrudGateway<T extends IEntity<string>>
-  implements OnGatewayInit, OnGatewayConnection, OnGatewayDisconnect
-{
-  private _clientsSubscriptions: Map<string, Subscription>;
-
-  constructor(private service: CrudService<T>) {}
-
-  @SubscribeMessage('changes')
-  handleFilter(
-    @MessageBody() data: { id?: string },
-    @ConnectedSocket() client: Socket,
-  ): Observable<WsResponse<ItemChangedData>> {
-    const event = 'changes';
-
-    return new Observable<WsResponse<ItemChangedData>>((observer) => {
-      this.clearSubscription(client);
-
-      this._clientsSubscriptions.set(
-        client.id,
-        this.service.changes(data).subscribe(
-          (res) => {
-            observer.next({ event, data: res });
-          },
-          (error) => observer.error(error),
-        ),
-      );
-    });
-  }
-
-  afterInit(server: any) {
-    this._clientsSubscriptions = new Map<string, Subscription>();
-    console.log('CrudGateway Init');
-  }
-
-  handleDisconnect(client: any) {
-    this.clearSubscription(client);
-
-    console.log(`Client disconnected: ${client.id}`);
-  }
-
-  private clearSubscription(client: any) {
-    if (this._clientsSubscriptions.has(client.id)) {
-      this._clientsSubscriptions.get(client.id).unsubscribe();
-      this._clientsSubscriptions.delete(client.id);
-    }
-  }
-
-  handleConnection(client: any, ...args: any[]) {
-    console.log(`Client connected: ${client.id}`);
-  }
-}

package/src/lib/gateways/index.ts

@@ -1,3 +0,0 @@
-import { CrudGateway } from './crud/crud.gateway';
-
-export const GATEWAYS = [CrudGateway];

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

@@ -1,61 +0,0 @@
-import { UnauthorizedException, Logger } from '@nestjs/common';
-
-import { AuthJwtGuard, AuthOrAnonymousJwtGuard } from './auth.guard';
-
-describe('crud-nestjs: AuthJwtGuard', () => {
-  let guard: AuthJwtGuard;
-  let loggerWarnSpy: jest.SpyInstance;
-
-  beforeEach(() => {
-    guard = new AuthJwtGuard();
-    loggerWarnSpy = jest.spyOn(Logger.prototype, 'warn').mockImplementation();
-  });
-
-  afterEach(() => {
-    loggerWarnSpy.mockRestore();
-  });
-
-  it('should return user if no error and user exists', () => {
-    const user = { id: 1 };
-    expect(guard.handleRequest(null, user, null)).toBe(user);
-  });
-
-  it('should throw UnauthorizedException if no user and no error', () => {
-    expect(() => guard.handleRequest(null, null, { msg: 'no user' })).toThrow(
-      UnauthorizedException,
-    );
-  });
-
-  it('should throw error if error is present', () => {
-    const error = new Error('fail');
-    expect(() => guard.handleRequest(error, null, { msg: 'err' })).toThrow(
-      error,
-    );
-  });
-
-  it('should log info if no user', () => {
-    try {
-      guard.handleRequest(null, null, { msg: 'info' });
-    } catch {
-      // Intentionally left empty: exception is expected and tested below
-    }
-    expect(loggerWarnSpy).toHaveBeenCalledWith(JSON.stringify({ msg: 'info' }));
-  });
-});
-
-describe('crud-nestjs: AuthOrAnonymousJwtGuard', () => {
-  let guard: AuthOrAnonymousJwtGuard;
-
-  beforeEach(() => {
-    guard = new AuthOrAnonymousJwtGuard();
-  });
-
-  it('should return user if user exists', () => {
-    const user = { id: 2 };
-    expect(guard.handleRequest(null, user, null)).toBe(user);
-  });
-
-  it('should return undefined if user is undefined', () => {
-    expect(guard.handleRequest(null, undefined, null)).toBeUndefined();
-  });
-});

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

@@ -1,22 +0,0 @@
-import { Injectable, UnauthorizedException, Logger } from '@nestjs/common';
-import { AuthGuard } from '@nestjs/passport';
-
-@Injectable()
-export class AuthJwtGuard extends AuthGuard('jwt') {
-  private readonly logger = new Logger(AuthJwtGuard.name, { timestamp: true });
-
-  handleRequest(err: any, user: any, info: any): any {
-    if (err || !user) {
-      this.logger.warn(JSON.stringify(info));
-      throw err || new UnauthorizedException();
-    }
-    return user;
-  }
-}
-
-@Injectable()
-export class AuthOrAnonymousJwtGuard extends AuthGuard('jwt') {
-  handleRequest(err: any, user: any, info: any): any {
-    return user;
-  }
-}