@pcg/core 1.0.0-alpha.1 → 1.0.0-alpha.2

package/src/db/snake-naming.strategy.ts

@@ -1,277 +0,0 @@
-import {
-    pluralToSingular,
-    singularToPlural,
-    snakeCase,
-} from '@pcg/text-kit';
-import {
-    DefaultNamingStrategy, NamingStrategyInterface, Table,
-} from 'typeorm';
-
-/**
- * Snake case naming strategy for typeorm.
- * Determines table and column names from class and property names.
- */
-export class SnakeNamingStrategy
-  extends DefaultNamingStrategy
-  implements NamingStrategyInterface {
-  /**
-   * Create a table name from a class name.
-   * @param className - The class name of the entity
-   * @param customName - The custom table name
-   * @returns The table name
-   * @example Create table name from class name
-   * ```ts
-   * @Entity()
-   * class User {}
-   * // returns 'users'
-   *
-   * @Entity('custom_table_name')
-   * class User {}
-   * // returns 'custom_table_name'
-   *
-   *```
-   */
-  tableName(className: string, customName?: string): string {
-    if (customName) {
-      return customName;
-    }
-
-    const snakeClassName = snakeCase(className);
-
-    // if many-to-many table, use the table name as is
-    if (snakeClassName.includes('_to_')) {
-      return snakeClassName;
-    }
-
-    const parts = snakeClassName.split('_');
-    if (parts.length === 1) {
-      return singularToPlural(snakeClassName);
-    }
-
-    return parts
-      .map((name, i) => (i === 0 ? name : singularToPlural(name)))
-      .join('_');
-  }
-
-  /**
-   * Create a column name from a property name.
-   * @param propertyName - The property name of the entity
-   * @param customName - The custom column name
-   * @param embeddedPrefixes - The embedded prefixes
-   * @returns The table column name
-   * @example Create column name from property name
-   * ```ts
-   * @Entity()
-   * class User {
-   *  @Column()
-   *  firstName: string; // returns 'first_name'
-   *
-   *  @Column('custom_last_name')
-   *  lastName: string; // returns 'custom_last_name'
-   * }
-   * ```
-   */
-  columnName(
-    propertyName: string,
-    customName?: string,
-    embeddedPrefixes: string[] = [],
-  ): string {
-    return (
-      snakeCase(embeddedPrefixes.concat('').join('_')) +
-      (customName ? customName : snakeCase(propertyName))
-    );
-  }
-
-  // ???
-  relationName(propertyName: string): string {
-    return snakeCase(propertyName);
-  }
-
-  // ???
-  joinColumnName(relationName: string, referencedColumnName: string): string {
-    return snakeCase(relationName + '_' + referencedColumnName);
-  }
-
-  /**
-   * Create join table name for many-to-many relations.
-   * @returns join table name
-   * @example
-   * ```ts
-   * @Entity()
-   * class Post {
-   *  @ManyToMany(() => Theme) // post_to_theme
-   *  themes: Theme[];
-   * }
-   *
-   */
-  joinTableName(firstTableName: string, secondTableName: string): string {
-    return snakeCase(
-      pluralToSingular(firstTableName) +
-        '_to_' +
-        pluralToSingular(secondTableName),
-    );
-  }
-
-  // ???
-  joinTableColumnName(
-    tableName: string,
-    propertyName: string,
-    columnName?: string,
-  ): string {
-    return snakeCase(
-      pluralToSingular(tableName) + '_' + (columnName ? columnName : propertyName),
-    );
-  }
-
-  eagerJoinRelationAlias(alias: string, propertyPath: string): string {
-    return alias + '__' + propertyPath.replace('.', '_');
-  }
-
-  /**
-   * Create a primary key name.
-   * @param tableOrName - The table or table name
-   * @param columnNames - The column names
-   * @returns The primary key name
-   * @example
-   * ```ts
-   * @Entity()
-   * class User {
-   *  @PrimaryColumn()
-   *  id: string;
-   * }
-   *
-   * // returns 'pk_users__id'
-   */
-  primaryKeyName(tableOrName: Table | string, columnNames: string[]): string {
-    tableOrName =
-      typeof tableOrName === 'string' ? tableOrName : tableOrName.name;
-
-    let name = tableOrName;
-    for (const column of columnNames) {
-      name += `__${column}`;
-    }
-
-    name = this.simplifyName(name);
-
-    return `pk_${name}`;
-  }
-
-  /**
-   * Create a foreign key name.
-   * @param tableOrName - The table or table name
-   * @param columnNames - The column names
-   * @returns The foreign key name
-   * @example
-   * ```ts
-   * @Entity()
-   * class User {
-   *  @PrimaryColumn()
-   *  id: string;
-   * }
-   * @Entity()
-   * class Post {
-   *  @PrimaryColumn()
-   *  id: string;
-   *
-   *  @ManyToOne(() => User, user => user.posts)
-   *  user: User;
-   * }
-   *
-   * // returns 'fk_posts__user_id__users__id'
-   * ```
-   */
-  foreignKeyName(tableOrName: Table | string, columnNames: string[]): string {
-    tableOrName =
-      typeof tableOrName === 'string' ? tableOrName : tableOrName.name;
-
-    let name = tableOrName;
-    for (const column of columnNames) {
-      name += `__${column}`;
-    }
-
-    name = this.simplifyName(name);
-
-    return `fk_${name}`;
-  }
-
-  /**
-   * Create an index name.
-   * @param tableOrName - The table or table name
-   * @param columnNames - The column names
-   * @returns The index name
-   * @example
-   * ```ts
-   * @Entity()
-   * class User {
-   *  @Index()
-   *  @Column()
-   *  email: string;
-   * }
-   * // returns 'idx_users__email'
-   * ```
-   */
-  indexName(tableOrName: Table | string, columnNames: string[]): string {
-    tableOrName =
-      typeof tableOrName === 'string' ? tableOrName : tableOrName.name;
-
-    let name = tableOrName;
-    for (const column of columnNames) {
-      name += `__${column}`;
-    }
-
-    name = this.simplifyName(name);
-
-    return `idx_${name}`;
-  }
-
-  /**
-   * Create a unique constraint name.
-   * @param tableOrName - The table or table name
-   * @param columnNames - The column names
-   * @returns The unique constraint name
-   * @example
-   * ```ts
-   * @Entity()
-   * class User {
-   *  @Unique()
-   *  @Column()
-   *  email: string;
-   * }
-   * // returns 'uq_users__email'
-   * ```
-   */
-  uniqueConstraintName(
-    tableOrName: Table | string,
-    columnNames: string[],
-  ): string {
-    tableOrName =
-      typeof tableOrName === 'string' ? tableOrName : tableOrName.name;
-
-    let name = tableOrName;
-    for (const column of columnNames) {
-      name += `__${column}`;
-    }
-
-    name = this.simplifyName(name);
-
-    return `uq_${name}`;
-  }
-
-  private simplifyName(name: string): string {
-    if (name.length > 50) {
-      const pieces = name.split('__');
-
-      const simplified = pieces.map((piece) => {
-        if (piece.includes('_to_')) {
-          return piece.split('_').map((p) => p[0]).join('');
-        }
-
-        return piece;
-      });
-
-      return simplified.join('__');
-    }
-
-    return name;
-  }
-}

package/src/enums/app-env.enum.ts

@@ -1,36 +0,0 @@
-/**
- * Application environment enum
- */
-export enum AppEnv {
-  /**
-   * Local environment.
-   * Used for local development on your machine.
-   */
-  LOCAL = 'local',
-
-  /**
-   * Test environment.
-   * Used when running tests.
-   */
-  TEST = 'test',
-
-  /**
-   * Development environment.
-   * Used when deploying to a development server.
-   * Development server provide early access to new features.
-   */
-  DEVELOPMENT = 'development',
-
-  /**
-   * Stage environment.
-   * Used when deploying to a stage server.
-   * Stage is a pre-production environment.
-   */
-  STAGE = 'stage',
-
-  /**
-   * Production environment.
-   * Used when deploying to a production server.
-   */
-  PRODUCTION = 'production',
-}

package/src/enums/app-mode.enum.ts

@@ -1,5 +0,0 @@
-export enum AppMode {
-  STANDALONE = 'standalone',
-  PARENT = 'parent',
-  CHILD = 'child',
-}

package/src/enums/app-server.enum.ts

@@ -1,39 +0,0 @@
-/**
- * Enum for the NestJS server mode
- */
-export enum AppServer {
-  /**
-   * NestJS HTTP server with GraphQL
-   */
-  HTTP = 'http',
-
-  /**
-   * NestJS gRPC server
-   */
-  GRPC = 'grpc',
-
-  /**
-   * NestJS WebSocket server
-   */
-  WS = 'ws',
-
-  /**
-   * Run as a worker
-   */
-  WORKER = 'worker',
-
-  /**
-   * Run as an agent
-   */
-  AGENT = 'agent',
-
-  /**
-   * Run as an bot (e.g. Slack bot)
-   */
-  BOT = 'bot',
-
-  /**
-   * Run as Cloud Run job
-   */
-  CLOUDRUN_JOB = 'cloudrun-job',
-}

package/src/enums/index.ts

@@ -1,4 +0,0 @@
-export * from './app-env.enum.js';
-export * from './app-mode.enum.js';
-export * from './app-server.enum.js';
-export * from './worker-mode.enum.js';

package/src/enums/worker-mode.enum.ts

@@ -1,11 +0,0 @@
-export enum WorkerMode {
-  /**
-   * Run jobs in loop
-   */
-  LOOP = 'loop',
-
-  /**
-   * Run one job and exit
-   */
-  ONE_JOB = 'one-job',
-}

package/src/errors/access-denied.error.ts

@@ -1,18 +0,0 @@
-import { ForbiddenError } from './forbidden.error.js';
-
-export interface AccessDeniedErrorOptions {
-  action: string;
-  context: Record<string, unknown>;
-  message?: string;
-}
-
-export class AccessDeniedError extends ForbiddenError {
-  constructor(opts: AccessDeniedErrorOptions) {
-    super({
-      key: 'AUTH_ACCESS_DENIED',
-      message: opts.message || `Access denied: you don't have permission to perform "${opts.action}" action`,
-      context: opts.context,
-    });
-    this.name = 'AccessDeniedError';
-  }
-}

package/src/errors/bad-request.error.ts

@@ -1,9 +0,0 @@
-import { NestError, NestErrorOptions } from './nest-error.js';
-
-export class BadRequestError extends NestError {
-  constructor(opts: NestErrorOptions) {
-    super(opts);
-    this.name = 'BadRequestError';
-    this.httpStatusCode = 400;
-  }
-}

package/src/errors/forbidden.error.ts

@@ -1,9 +0,0 @@
-import { NestError, NestErrorOptions } from './nest-error.js';
-
-export class ForbiddenError extends NestError {
-  constructor(opts: NestErrorOptions) {
-    super(opts);
-    this.name = 'ForbiddenError';
-    this.httpStatusCode = 403;
-  }
-}

package/src/errors/index.ts

@@ -1,8 +0,0 @@
-export * from './access-denied.error.js';
-export * from './bad-request.error.js';
-export * from './forbidden.error.js';
-export * from './input-validation.error.js';
-export * from './nest-error.js';
-export * from './not-found.error.js';
-export * from './unauthorized.error.js';
-

package/src/errors/input-validation.error.ts

@@ -1,16 +0,0 @@
-import { ValidationError } from '@nestjs/common';
-import { NestError } from './nest-error.js';
-
-export class InputValidationError extends NestError {
-  constructor(errors?: ValidationError[]) {
-    super({
-      message: 'Input validation failed',
-      key: 'NST_INPUT_VALIDATION_ERROR',
-      context: errors ? {
-        errors,
-      } : undefined,
-    });
-    this.name = 'InputValidationError';
-    this.httpStatusCode = 400;
-  }
-}

package/src/errors/nest-error.filter.ts

@@ -1,70 +0,0 @@
-;
-
-import {
-    ArgumentsHost, Catch, HttpServer,
-} from '@nestjs/common';
-import { GqlArgumentsHost } from '@nestjs/graphql/dist/services/gql-arguments-host';
-
-import {
-    Logger, LoggerContext, LoggerFactory,
-} from '#/logger';
-import { NestError } from './nest-error.js';
-
-type ContextType = 'http' | 'ws' | 'rpc' | 'graphql';
-
-/**
- * Http exception filter for NestJS
- * It is used to correctly log all http exceptions
- * @example
- * ```ts
- * // main.ts
- * const { httpAdapter } = app.get(HttpAdapterHost);
- * const loggerFactory = app.get(WINSTON_MODULE_FACTORY_PROVIDER);
- * app.useGlobalFilters(new NestErrorFilter(httpAdapter, loggerFactory));
- * ```
- */
-@Catch(NestError)
-export class NestErrorFilter {
-  private readonly logger: Logger;
-
-  constructor(
-    protected readonly applicationRef: HttpServer,
-    private readonly loggerFactory: LoggerFactory,
-  ) {
-    this.logger = this.loggerFactory.create({
-      scope: NestErrorFilter.name,
-    });
-  }
-
-  catch(error: NestError, host: ArgumentsHost) {
-    const gqlHost = GqlArgumentsHost.create(host);
-    const type = gqlHost.getType<ContextType>();
-
-    if (!error.silent) {
-      this.logger.error(error);
-    }
-
-    if (type !== 'http') {
-      return error;
-    }
-
-    /**
-     * If request is http, then we need to send response to client
-     */
-    const body: {
-      message: string;
-      key?: string;
-      stack?: string;
-      context?: LoggerContext;
-      statusCode: number;
-    } = {
-      message: error.message,
-      key: error.key,
-      stack: error.stack,
-      context: error.context,
-      statusCode: error.httpStatusCode,
-    };
-
-    this.applicationRef.reply(host.getArgByIndex(1), body, error.httpStatusCode);
-  }
-}

package/src/errors/nest-error.ts

@@ -1,63 +0,0 @@
-import { HttpStatus } from '@nestjs/common';
-
-/**
- * Configuration options for creating a NestError instance.
- *
- * @interface NestErrorOptions
- */
-export interface NestErrorOptions {
-  /** The human-readable error message describing what went wrong */
-  message: string;
-
-  /**
-   * A unique identifier or error code for categorizing and handling the error
-   * @example
-   * 'AUTH_USER_NOT_FOUND'
-   * */
-  key: string;
-
-  /** The underlying error that caused this error, if any */
-  cause?: unknown;
-
-  /** Additional contextual information related to the error occurrence */
-  context?: Record<string, unknown>;
-
-  /**
-   * Whether the error should be silenced (i.e., not logged or reported)
-   */
-  silent?: boolean;
-}
-
-/**
- * Custom error class for NestJS applications that extends the native Error class.
- *
- * This error class provides additional context and structured error handling
- * capabilities beyond the standard Error object.
- *
- * @example
- * ```typescript
- * throw new NestError({
- *   key: 'AUTH_USER_NOT_FOUND',
- *   message: 'User with the specified ID was not found',
- *   context: { userId: '123' },
- *   cause: originalError
- * });
- * ```
- */
-export class NestError extends Error {
-  key!: string;
-  context?: Record<string, unknown>;
-  httpStatusCode = HttpStatus.INTERNAL_SERVER_ERROR;
-  silent!: boolean;
-
-  constructor(opts: NestErrorOptions) {
-    super(opts.message, opts.cause instanceof Error ? {
-      cause: opts.cause,
-    } : undefined);
-
-    this.name = 'NestError';
-    this.key = opts.key;
-    this.context = opts.context;
-    this.silent = opts.silent ?? false;
-  }
-}

package/src/errors/not-found.error.ts

@@ -1,9 +0,0 @@
-import { NestError, NestErrorOptions } from './nest-error.js';
-
-export class NotFoundError extends NestError {
-  constructor(opts: NestErrorOptions) {
-    super(opts);
-    this.name = 'NotFoundError';
-    this.httpStatusCode = 404;
-  }
-}

package/src/errors/unauthorized.error.ts

@@ -1,9 +0,0 @@
-import { NestError, NestErrorOptions } from './nest-error.js';
-
-export class UnauthorizedError extends NestError {
-  constructor(opts: NestErrorOptions) {
-    super(opts);
-    this.name = 'UnauthorizedError';
-    this.httpStatusCode = 401;
-  }
-}

package/src/exceptions/http-exception-response.ts

@@ -1,34 +0,0 @@
-import { LoggerContext } from '#/logger';
-
-/**
- * NestJS HttpException response object
- * @example
- * exception.getResponse()
- */
-export interface HttpExceptionResponse {
-  /**
-   * Error message text
-   */
-  message: string;
-
-  /**
-   * Error key from 'enum'
-   */
-  key: string;
-
-  /**
-   * Error object
-   */
-  error?: Error;
-
-  /**
-   * Error context (additional data)
-   */
-  context: LoggerContext;
-
-  /**
-   * Don't log error
-   */
-  silent?: boolean;
-}
-