node-server-engine 1.1.1 → 1.1.3

package/src/entities/SocketClient/SocketClient.types.ts

@@ -1,62 +1,62 @@
-import { SocketClient } from './SocketClient';
-import { MessageHandler } from 'entities/MessageHandler';
-
-export type SocketClientCallback = (
-  client: SocketClient
-) => void | Promise<void>;
-
-/** SocketClient creation option */
-export interface SocketClientOptions {
-  /** List of message handlers that are registered with the client */
-  handlers: Array<MessageHandler>;
-  /** Callback function that are called when the client is created */
-  initCallbacks?: SocketClientCallback | Array<SocketClientCallback>;
-  /** Callback function that are called when the client successfully authenticates */
-  authCallbacks?: SocketClientCallback | Array<SocketClientCallback>;
-  /** Callback function that are called when the client connection is terminated */
-  shutdownCallbacks?: SocketClientCallback | Array<SocketClientCallback>;
-}
-
-/** Socket Message abstract typing */
-export interface SocketMessage<T = unknown> {
-  /** A string that identifies the message type */
-  type: string;
-  /** Free-form data payload of the message */
-  payload: T;
-}
-
-/** SocketMessage used by client for authentication */
-export interface SocketAuthenticationMessage extends SocketMessage {
-  /** Sting that identifies the message type */
-  type: 'authenticate';
-  /** Data payload of the message */
-  payload: {
-    /** Authentication token */
-    token: string;
-  };
-}
-
-/** Options for sending a message with the client */
-export interface SocketClientSendMessageOptions {
-  /** Send message event if the user is not authenticated */
-  noAuth?: boolean;
-  /** Audience that the authenticated user must have on his token to continue */
-  audience?: string;
-}
-
-/** Map of socket clients connected to the server */
-export interface SocketClientList {
-  [id: string]: SocketClient;
-}
-
-/** User that authenticated though his socket */
-export interface SocketUser {
-  /** ID od the user */
-  userId: string;
-  /** ID of the device */
-  deviceId: string;
-  /** ID of the token used */
-  tokenId: string;
-  /** Audience included in the token */
-  audience: Array<string>;
-}
+import { SocketClient } from './SocketClient';
+import { MessageHandler } from 'entities/MessageHandler';
+
+export type SocketClientCallback = (
+  client: SocketClient
+) => void | Promise<void>;
+
+/** SocketClient creation option */
+export interface SocketClientOptions {
+  /** List of message handlers that are registered with the client */
+  handlers: Array<MessageHandler>;
+  /** Callback function that are called when the client is created */
+  initCallbacks?: SocketClientCallback | Array<SocketClientCallback>;
+  /** Callback function that are called when the client successfully authenticates */
+  authCallbacks?: SocketClientCallback | Array<SocketClientCallback>;
+  /** Callback function that are called when the client connection is terminated */
+  shutdownCallbacks?: SocketClientCallback | Array<SocketClientCallback>;
+}
+
+/** Socket Message abstract typing */
+export interface SocketMessage<T = unknown> {
+  /** A string that identifies the message type */
+  type: string;
+  /** Free-form data payload of the message */
+  payload: T;
+}
+
+/** SocketMessage used by client for authentication */
+export interface SocketAuthenticationMessage extends SocketMessage {
+  /** Sting that identifies the message type */
+  type: 'authenticate';
+  /** Data payload of the message */
+  payload: {
+    /** Authentication token */
+    token: string;
+  };
+}
+
+/** Options for sending a message with the client */
+export interface SocketClientSendMessageOptions {
+  /** Send message event if the user is not authenticated */
+  noAuth?: boolean;
+  /** Audience that the authenticated user must have on his token to continue */
+  audience?: string;
+}
+
+/** Map of socket clients connected to the server */
+export interface SocketClientList {
+  [id: string]: SocketClient;
+}
+
+/** User that authenticated though his socket */
+export interface SocketUser {
+  /** ID od the user */
+  userId: string;
+  /** ID of the device */
+  deviceId: string;
+  /** ID of the token used */
+  tokenId: string;
+  /** Audience included in the token */
+  audience: Array<string>;
+}

package/src/entities/SocketClient/index.ts

@@ -1,2 +1,2 @@
-export * from './SocketClient';
-export * from './SocketClient.types';
+export * from './SocketClient';
+export * from './SocketClient.types';

package/src/entities/SocketClient/parseMessage/index.ts

@@ -1 +1 @@
-export * from './parseMessage';
+export * from './parseMessage';

package/src/entities/SocketClient/parseMessage/parseMessage.test.ts

@@ -1,20 +1,20 @@
-import { expect } from 'chai';
-import { faker } from '@faker-js/faker';
-import { parseMessage } from './parseMessage';
-
-describe('Entities - Socket Client - Utils - Parse Message', () => {
-  it('should transform a JSON string into an object', () => {
-    const object = { [faker.lorem.word()]: faker.lorem.word() };
-    const result = parseMessage(JSON.stringify(object));
-    expect(result).to.deep.equal(object);
-  });
-
-  it('should throw an error if the input is not parsable', () => {
-    const object = faker.lorem.word();
-    expect(() => parseMessage(JSON.stringify(object))).to.throw;
-  });
-
-  it('should throw an error if the input is not an object when parsed', () => {
-    expect(() => parseMessage(JSON.stringify([faker.lorem.word()]))).to.throw;
-  });
-});
+import { expect } from 'chai';
+import { faker } from '@faker-js/faker';
+import { parseMessage } from './parseMessage';
+
+describe('Entities - Socket Client - Utils - Parse Message', () => {
+  it('should transform a JSON string into an object', () => {
+    const object = { [faker.lorem.word()]: faker.lorem.word() };
+    const result = parseMessage(JSON.stringify(object));
+    expect(result).to.deep.equal(object);
+  });
+
+  it('should throw an error if the input is not parsable', () => {
+    const object = faker.lorem.word();
+    expect(() => parseMessage(JSON.stringify(object))).to.throw;
+  });
+
+  it('should throw an error if the input is not an object when parsed', () => {
+    expect(() => parseMessage(JSON.stringify([faker.lorem.word()]))).to.throw;
+  });
+});

package/src/entities/SocketClient/parseMessage/parseMessage.ts

@@ -1,26 +1,26 @@
-import { SocketMessage } from '../SocketClient.types';
-import { WebError } from 'entities/WebError';
-
-/**
- * Parse an incoming message into a JSON object
- */
-export function parseMessage(data: string): SocketMessage {
-  try {
-    const message = JSON.parse(data) as SocketMessage;
-    if (message.constructor.name !== 'Object')
-      throw new WebError({
-        statusCode: 400,
-        errorCode: 'non-json',
-        message: 'Received message is not an object',
-        data: { data }
-      });
-    return message;
-  } catch {
-    throw new WebError({
-      statusCode: 400,
-      errorCode: 'non-json',
-      message: 'Received message is not valid JSON',
-      data: { data }
-    });
-  }
-}
+import { SocketMessage } from '../SocketClient.types';
+import { WebError } from 'entities/WebError';
+
+/**
+ * Parse an incoming message into a JSON object
+ */
+export function parseMessage(data: string): SocketMessage {
+  try {
+    const message = JSON.parse(data) as SocketMessage;
+    if (message.constructor.name !== 'Object')
+      throw new WebError({
+        statusCode: 400,
+        errorCode: 'non-json',
+        message: 'Received message is not an object',
+        data: { data }
+      });
+    return message;
+  } catch {
+    throw new WebError({
+      statusCode: 400,
+      errorCode: 'non-json',
+      message: 'Received message is not valid JSON',
+      data: { data }
+    });
+  }
+}

package/src/entities/Storage/Storage.test.ts

@@ -1,58 +1,58 @@
-import { expect } from 'chai';
-import { faker } from '@faker-js/faker';
-import validator from 'validator';
-import { Storage } from './Storage';
-
-describe('Storage', function () {
-  it('should generate path info for a regular file', function () {
-    const path = Storage.generateFileDestination();
-    // eslint-disable-next-line import/no-named-as-default-member
-    expect(validator.isUUID(path)).to.be.true;
-  });
-
-  it('should add a path to a file', function () {
-    const directory = `${faker.lorem.word()}`;
-    const path = Storage.generateFileDestination({
-      directory
-    });
-
-    expect(path.startsWith(directory)).to.be.true;
-  });
-
-  it('should add a path to a file but remove appended slash', function () {
-    const directory = `${faker.lorem.word()}`;
-    const path = Storage.generateFileDestination({
-      directory: '/' + directory
-    });
-    expect(path.startsWith(directory)).to.be.true;
-  });
-
-  it('should not append an extension if specified', function () {
-    const directory = `${faker.lorem.word()}`;
-    const mimeType = 'image/png';
-    const path = Storage.generateFileDestination({
-      directory,
-      mime: mimeType,
-      noExtension: true
-    });
-
-    const resultExt = path.split('.')[1];
-
-    expect(path.startsWith(directory)).to.be.true;
-    expect(resultExt).to.be.undefined;
-  });
-
-  it('should append an extension if specified', function () {
-    const directory = `${faker.lorem.word()}`;
-    const mimeType = 'image/png';
-    const path = Storage.generateFileDestination({
-      directory,
-      mime: mimeType
-    });
-
-    const resultExt = path.split('.')[1];
-
-    expect(path.startsWith(directory)).to.be.true;
-    expect(resultExt).to.equal('png');
-  });
-});
+import { expect } from 'chai';
+import { faker } from '@faker-js/faker';
+import validator from 'validator';
+import { Storage } from './Storage';
+
+describe('Storage', function () {
+  it('should generate path info for a regular file', function () {
+    const path = Storage.generateFileDestination();
+    // eslint-disable-next-line import/no-named-as-default-member
+    expect(validator.isUUID(path)).to.be.true;
+  });
+
+  it('should add a path to a file', function () {
+    const directory = `${faker.lorem.word()}`;
+    const path = Storage.generateFileDestination({
+      directory
+    });
+
+    expect(path.startsWith(directory)).to.be.true;
+  });
+
+  it('should add a path to a file but remove appended slash', function () {
+    const directory = `${faker.lorem.word()}`;
+    const path = Storage.generateFileDestination({
+      directory: '/' + directory
+    });
+    expect(path.startsWith(directory)).to.be.true;
+  });
+
+  it('should not append an extension if specified', function () {
+    const directory = `${faker.lorem.word()}`;
+    const mimeType = 'image/png';
+    const path = Storage.generateFileDestination({
+      directory,
+      mime: mimeType,
+      noExtension: true
+    });
+
+    const resultExt = path.split('.')[1];
+
+    expect(path.startsWith(directory)).to.be.true;
+    expect(resultExt).to.be.undefined;
+  });
+
+  it('should append an extension if specified', function () {
+    const directory = `${faker.lorem.word()}`;
+    const mimeType = 'image/png';
+    const path = Storage.generateFileDestination({
+      directory,
+      mime: mimeType
+    });
+
+    const resultExt = path.split('.')[1];
+
+    expect(path.startsWith(directory)).to.be.true;
+    expect(resultExt).to.equal('png');
+  });
+});