@digitaldefiance/node-express-suite 1.0.21 → 1.0.23

package/src/services/xor.ts

@@ -0,0 +1,34 @@
+import { randomBytes } from 'crypto';
+
+/**
+ * A simple and fast XOR cipher for obfuscating data in memory.
+ * This is not a substitute for strong cryptography but provides a lightweight way
+ * to prevent sensitive data from being stored in plaintext in memory.
+ */
+export class XorService {
+  /**
+   * Encrypts or decrypts data using a simple XOR cipher.
+   * The key is XORed with the data. The same function is used for
+   * both encryption and decryption.
+   *
+   * @param data The data to process.
+   * @param key The key to use for the XOR operation.
+   * @returns A new Buffer containing the result of the XOR operation.
+   */
+  public static xor(data: Buffer, key: Buffer): Buffer {
+    const result = Buffer.alloc(data.length);
+    for (let i = 0; i < data.length; i++) {
+      result[i] = data[i] ^ key[i % key.length];
+    }
+    return result;
+  }
+
+  /**
+   * Generates a random key of a specified length.
+   * @param length The length of the key in bytes.
+   * @returns A Buffer containing the random key.
+   */
+  public static generateKey(length: number): Buffer {
+    return randomBytes(length);
+  }
+}

package/src/types.d.ts

@@ -0,0 +1,44 @@
+import { Member } from '@digitaldefiance/node-ecies-lib';
+import { IRequestUserDTO } from '@digitaldefiance/suite-core-lib';
+import { ValidationChain } from 'express-validator';
+import { ValidatedBody } from './types';
+
+declare module 'express-serve-static-core' {
+  interface Request<
+    TRequestUserDTO extends IRequestUserDTO = IRequestUserDTO,
+    TMember extends Member = Member,
+    TValidatedBody = ValidatedBody<string>,
+  > {
+    user?: TRequestUserDTO;
+    eciesUser?: TMember;
+    validatedBody?: TValidatedBody;
+    validate?: {
+      body: (field: string) => ValidationChain;
+      param: (field: string) => ValidationChain;
+      query: (field: string) => ValidationChain;
+      header: (field: string) => ValidationChain;
+      cookie: (field: string) => ValidationChain;
+    };
+  }
+}
+
+declare global {
+  namespace Express {
+    interface Request<
+      TRequestUserDTO extends IRequestUserDTO = IRequestUserDTO,
+      TMember extends Member = Member,
+      TValidatedBody extends ValidatedBody<string> = ValidatedBody<string>,
+    > {
+      user?: TRequestUserDTO;
+      eciesUser?: TMember;
+      validatedBody?: TValidatedBody;
+      validate?: {
+        body: (field: string) => ValidationChain;
+        param: (field: string) => ValidationChain;
+        query: (field: string) => ValidationChain;
+        header: (field: string) => ValidationChain;
+        cookie: (field: string) => ValidationChain;
+      };
+    }
+  }
+}

package/src/types.ts

@@ -0,0 +1,128 @@
+import { NextFunction, RequestHandler, Response } from 'express';
+import { ValidationChain } from 'express-validator';
+import { ClientSession } from 'mongoose';
+import { IBaseDocument } from './documents';
+import {
+  IApiErrorResponse,
+  IApiExpressValidationErrorResponse,
+  IApiMessageResponse,
+  IApiMongoValidationErrorResponse,
+  IStatusCodeResponse,
+} from './interfaces';
+import { ISchema } from './interfaces/schema';
+
+/**
+ * Transaction callback type for withTransaction
+ */
+export type TransactionCallback<T> = (
+  session: ClientSession | undefined,
+  ...args: Array<unknown>
+) => Promise<T>;
+
+/**
+ * Validated body for express-validator
+ */
+export type ValidatedBody<T extends string> = {
+  [K in T]: unknown;
+};
+
+/**
+ * Schema map interface
+ */
+type ModelDocMap<TModelDocs extends Record<string, IBaseDocument<any>>> = {
+  [K in keyof TModelDocs]: TModelDocs[K];
+};
+
+export type SchemaMap<TModelDocs extends Record<string, IBaseDocument<any>>> = {
+  /**
+   * For each model name, contains the corresponding schema and model
+   */
+  [K in keyof ModelDocMap<TModelDocs>]: ISchema<ModelDocMap<TModelDocs>[K]>;
+};
+
+export type ApiRequestHandler<T extends ApiResponse> = (
+  req: Request,
+  res: Response,
+  next: NextFunction,
+) => Promise<IStatusCodeResponse<T>>;
+
+export type TypedHandlers = {
+  [key: string]: ApiRequestHandler<ApiResponse>;
+};
+
+export interface IRouteDefinition<
+  T extends TypedHandlers,
+  TLanguage extends string,
+> {
+  method: 'get' | 'post' | 'put' | 'delete' | 'patch';
+  path: string;
+  options: {
+    handlerKey: keyof T;
+    validation?: (validationLanguage: TLanguage) => ValidationChain[];
+    useAuthentication: boolean;
+    useCryptoAuthentication: boolean;
+  };
+}
+
+export type RouteHandlers = Record<string, ApiRequestHandler<ApiResponse>>;
+
+export type HttpMethod = 'get' | 'post' | 'put' | 'delete' | 'patch';
+
+export interface RouteConfig<H extends object, TLanguage extends string> {
+  method: HttpMethod;
+  path: string;
+  handlerKey: keyof H;
+  handlerArgs?: Array<unknown>;
+  useAuthentication: boolean;
+  useCryptoAuthentication: boolean;
+  middleware?: RequestHandler[];
+  validation?: FlexibleValidationChain<TLanguage>;
+  rawJsonHandler?: boolean;
+  authFailureStatusCode?: number;
+}
+
+export function routeConfig<T extends object, TLanguage extends string>(
+  method: 'get' | 'post' | 'put' | 'delete' | 'patch',
+  path: string,
+  options: {
+    handlerKey: keyof T;
+    validation?: (validationLanguage: TLanguage) => ValidationChain[];
+    useAuthentication: boolean;
+    useCryptoAuthentication: boolean;
+  },
+): RouteConfig<T, TLanguage> {
+  return {
+    method,
+    path,
+    handlerKey: options.handlerKey,
+    validation: options.validation,
+    useAuthentication: options.useAuthentication,
+    useCryptoAuthentication: options.useCryptoAuthentication,
+  };
+}
+
+export type THandlerArgs<T extends Array<unknown>> = T;
+
+export type FlexibleValidationChain<TLanguage extends string> =
+  | ValidationChain[]
+  | ((lang: TLanguage) => ValidationChain[]);
+
+export type JsonPrimitive = string | number | boolean | null | undefined;
+
+export type JsonResponse =
+  | JsonPrimitive
+  | { [key: string]: JsonResponse }
+  | JsonResponse[];
+
+export type ApiErrorResponse =
+  | IApiErrorResponse
+  | IApiExpressValidationErrorResponse
+  | IApiMongoValidationErrorResponse;
+
+export type ApiResponse = IApiMessageResponse | ApiErrorResponse | JsonResponse;
+
+export type SendFunction<T extends ApiResponse> = (
+  statusCode: number,
+  data: T,
+  res: Response<T>,
+) => void;