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

package/src/configs/app.config.ts

@@ -1,185 +0,0 @@
-import { Inject } from '@nestjs/common';
-import { getConfigToken, registerAs } from '@nestjs/config';
-import { Type } from 'class-transformer';
-import {
-    IsEnum, IsNumber, IsOptional, IsString,
-} from 'class-validator';
-
-import { AppEnv } from '../enums/app-env.enum.js';
-import { AppMode } from '../enums/app-mode.enum.js';
-import { validateEnv } from '../tools/env.js';
-
-/**
- * NestJS injection token for app config
- */
-export const APP_CONFIG_TOKEN = 'APP_CONFIG_TOKEN';
-
-export const InjectAppConfig = () => Inject(getConfigToken(APP_CONFIG_TOKEN));
-
-/**
- * Application config environment variables
- */
-export class AppConfigEnvironmentVariables {
-  /**
-   * Application port
-   * @example
-   * ```yaml
-   * PORT: 3000
-   * ```
-   */
-  @Type(() => Number)
-  @IsNumber()
-  PORT = 3000;
-
-  /**
-   * Application host
-   * @example
-   * ```yaml
-   * APP_HOST: 'https://app-api.example.com'
-   * # or
-   * APP_HOST: 'http://localhost:3000'
-   * ```
-   */
-  @IsOptional()
-  @IsString()
-  APP_HOST!: string;
-
-  /**
-   * Application UI host
-   * @example
-   * ```yaml
-   * APP_UI_HOST: 'https://app.example.com'
-   * # or
-   * APP_UI_HOST: 'http://localhost:4200'
-   * ```
-   */
-  @IsOptional()
-  @IsString()
-  APP_UI_HOST!: string;
-
-  /**
-   * Application environment. Can be 'local', 'development', 'stage', 'production'
-   * @example
-   * ```yaml
-   * APP_ENV: 'local'
-   * ```
-   */
-  @IsEnum(AppEnv)
-  APP_ENV!: AppEnv;
-
-  /**
-   * Application service account id (user with type SA in users table)
-   * @example
-   * ```yaml
-   * APP_SERVICE_ACCOUNT_ID: 'hcu:xxxxxxxxxxx'
-   * ```
-   */
-  @IsOptional()
-  @IsString()
-  APP_SERVICE_ACCOUNT_ID?: string;
-
-  /**
-   * Application fallback language
-   * @example
-   * ```yaml
-   * FALLBACK_LANGUAGE: 'es'
-   * ```
-   */
-  @IsOptional()
-  @IsString()
-  FALLBACK_LANGUAGE = 'en';
-}
-
-export interface AppConfigType {
-  /**
-   * Application environment
-   * @example 'local', 'development', 'stage', 'production'
-   */
-  env: AppEnv;
-
-  /**
-   * Application name
-   * @example 'Jetstream'
-   */
-  name: string;
-
-  /**
-   * Application shortname
-   * @example 'js'
-   */
-  shortname: string;
-
-  /**
-   * Application port
-   * @example 3000
-   */
-  port: number;
-
-  /**
-   * Application mode
-   * @example 'standalone'
-   */
-  mode: AppMode;
-
-  /**
-   * Application host
-   * @example 'https://app-api.example.com or http://localhost:3000'
-   */
-  host?: string;
-
-  /**
-   * Application UI host
-   * @example 'https://app.example.com or http://localhost:8080'
-   */
-  uiHost?: string;
-
-  /**
-   * Application fallback language
-   * @example 'en'
-   */
-  fallbackLanguage: string;
-
-  /**
-   * Application service account id (user with type SA in users table)
-   * @example 'hcu:xxxxxxxxxxx'
-   */
-  appServiceAccountId?: string;
-}
-
-export interface AppConfigOptions {
-  name: string;
-  shortname: string;
-  mode?: AppMode;
-}
-
-/**
- * Create Main Application Config
- * @example
- * ```ts
- * // src/config/index.ts
- *
- * import { createAppConfig } from '#/dist/configs';
- *
- * export const appConfig = createAppConfig({
- *  name: 'Jetstream',
- *  shortname: 'js',
- * });
- * ```
- */
-export const createAppConfig = (opts: AppConfigOptions) => {
-  return registerAs(APP_CONFIG_TOKEN, (): AppConfigType => {
-    const env = validateEnv(AppConfigEnvironmentVariables);
-
-    return {
-      env: env.APP_ENV,
-      name: opts.name,
-      shortname: opts.shortname,
-      port: env.PORT,
-      host: env.APP_HOST,
-      mode: opts.mode || AppMode.STANDALONE,
-      uiHost: env.APP_UI_HOST,
-      appServiceAccountId: env.APP_SERVICE_ACCOUNT_ID,
-      fallbackLanguage: env.FALLBACK_LANGUAGE,
-    };
-  });
-};

package/src/configs/db.config.ts

@@ -1,122 +0,0 @@
-import { Inject } from '@nestjs/common';
-import { getConfigToken, registerAs } from '@nestjs/config';
-import { Type } from 'class-transformer';
-import {
-  IsBoolean,
-  IsNumber, IsOptional, IsString,
-} from 'class-validator';
-import { PostgresConnectionOptions } from 'typeorm/driver/postgres/PostgresConnectionOptions.js';
-
-import { SnakeNamingStrategy } from '#/db/snake-naming.strategy';
-import { validateEnv } from '#/tools/env';
-import fg from 'fast-glob';
-
-/**
- * NestJS injection token for postgres db config
- */
-export const DB_CONFIG_TOKEN = 'DB_CONFIG_TOKEN';
-
-export const InjectDbConfig = () => Inject(getConfigToken(DB_CONFIG_TOKEN));
-
-/**
- * Postgres db config environment variables
- */
-class DbConfigEnvironmentVariables {
-  /**
-   * Postgres host
-   * @example
-   * ```yaml
-   * POSTGRES_HOST: 'localhost'
-   * ```
-   */
-  @IsString()
-  POSTGRES_HOST!: string;
-
-  /**
-   * Postgres port
-   * @example
-   * ```yaml
-   * POSTGRES_PORT: 5432
-   * ```
-   */
-  @Type(() => Number)
-  @IsNumber()
-  POSTGRES_PORT!: number;
-
-  /**
-   * Postgres user
-   * @example
-   * ```yaml
-   * POSTGRES_USER: 'app'
-   * ```
-   */
-  @IsString()
-  POSTGRES_USER!: string;
-
-  /**
-   * Postgres password
-   * @example
-   * ```yaml
-   * POSTGRES_PASS: 'qwerty'
-   * ```
-   */
-  @IsString()
-  POSTGRES_PASS!: string;
-
-  /**
-   * Postgres database name
-   * @example
-   * ```yaml
-   * POSTGRES_DB: 'jetstream'
-   * ```
-   */
-  @IsString()
-  POSTGRES_DB!: string;
-
-  /**
-   * Enable postgres logging
-   * @example
-   * ```yaml
-   * POSTGRES_IS_LOGGING_ENABLED: "true"
-   * ```
-   */
-  @Type(() => Boolean)
-  @IsOptional()
-  @IsBoolean()
-  POSTGRES_IS_LOGGING_ENABLED?: boolean;
-}
-
-/**
- * Postgres Database Config
- */
-export const createDbConfig = (opts?: Partial<PostgresConnectionOptions>) => {
-  return registerAs(DB_CONFIG_TOKEN, (): PostgresConnectionOptions => {
-    const env = validateEnv(DbConfigEnvironmentVariables);
-
-    const baseEntities = [
-      'dist/**/*.entity.js',
-      'node_modules/@deep/nest-kit/dist/modules/**/*.entity.js',
-    ];
-
-    const entities = [
-      ...(opts?.entities as string[] ?? baseEntities),
-    ];
-
-    return {
-      type: 'postgres',
-      logging: env.POSTGRES_IS_LOGGING_ENABLED,
-      host: env.POSTGRES_HOST,
-      port: env.POSTGRES_PORT,
-      username: env.POSTGRES_USER,
-      password: env.POSTGRES_PASS,
-      database: env.POSTGRES_DB,
-      synchronize: false,
-      migrations: ['dist/migrations/*.js'],
-      subscribers: ['dist/**/*.entity-subscriber.js'],
-      migrationsRun: true,
-      namingStrategy: new SnakeNamingStrategy(),
-      ...opts,
-      entities: fg.sync(entities),
-    };
-  });
-};

package/src/configs/index.ts

@@ -1,4 +0,0 @@
-export * from './app.config.js';
-export * from './db.config.js';
-export * from './logger.config.js';
-

package/src/configs/logger.config.ts

@@ -1,62 +0,0 @@
-import { Inject } from '@nestjs/common';
-import { getConfigToken, registerAs } from '@nestjs/config';
-import * as winston from 'winston';
-
-import { nestLikeConsoleFormat } from '#/logger';
-
-/**
- * NestJS injection token for Logger config
- */
-export const LOGGER_CONFIG_TOKEN = 'LOGGER_CONFIG_TOKEN';
-
-export const InjectLoggerConfig = () => Inject(getConfigToken(LOGGER_CONFIG_TOKEN));
-
-export interface CreateLoggerConfigOptions {
-  appName: string;
-  useConsole?: boolean;
-  consoleLevel?: winston.LoggerOptions['level'];
-  transports?: winston.transport[];
-}
-/**
- * Create NestJS Logger config
- * @example
- * ```ts
- * // src/config/index.ts
- *
- * import { createLoggerConfig } from '#/dist/configs';
- *
- * export const LoggerConfig = createLoggerConfig();
- * ```
- */
-export const createLoggerConfig = (opts: CreateLoggerConfigOptions) => {
-  return registerAs(LOGGER_CONFIG_TOKEN, () => {
-    const format = [
-      winston.format.splat(),
-      winston.format.timestamp(),
-      nestLikeConsoleFormat(opts.appName),
-    ];
-
-    const winstonOptions: winston.LoggerOptions = {
-      transports: [],
-    };
-
-    if (!Array.isArray(winstonOptions.transports)) {
-      return winstonOptions;
-    }
-
-    if (opts.useConsole) {
-      winstonOptions.transports.push(
-        new winston.transports.Console({
-          level: opts.consoleLevel ?? 'debug',
-          format: winston.format.combine(...format),
-        }),
-      );
-    }
-
-    if (opts.transports) {
-      winstonOptions.transports.push(...opts.transports);
-    }
-
-    return winstonOptions;
-  });
-};

package/src/context/action-context.ts

@@ -1,34 +0,0 @@
-import { ActionScopes, ActionScopesArray } from '@pcg/auth';
-import { CurrentUser } from './current-user.js';
-
-/**
- * GraphQL base action context
- * Used for mutations and queries
- */
-export interface IBaseActionContext {
-  /**
-   * Request ID
-   * Used for logging to track request
-   */
-  requestId: string;
-
-  /**
-   * Current user who executes action
-   */
-  user: CurrentUser;
-
-  /**
-   * Check if current user from context has permission
-   * @param action - action string
-   * @param actionScopes - scopes where action was executed
-   */
-  isGranted(action: string, actionScopes?: ActionScopes | ActionScopesArray): boolean;
-
-  /**
-   * Check permission and throw AccessDenied error if user doesn't have permission
-   * @param action - action string
-   * @param scopes - scopes where action was executed
-   * @throws AccessDenied error if the user doesn't have the permission
-   */
-  validateAccess(action: string, scopes?: ActionScopes | ActionScopesArray): void;
-}

package/src/context/current-user.ts

@@ -1,49 +0,0 @@
-import { IUser } from '@pcg/auth';
-
-export interface CurrentUser extends IUser {
-  /**
-   * User email address
-   * @example
-   * ```ts
-   * 'john.doe@example.com'
-   * ```
-   */
-  email: string;
-
-  /**
-   * User's first name
-   * @example
-   * ```ts
-   * 'John'
-   * ```
-   */
-  firstName: string;
-
-  /**
-   * User's last name
-   * @example
-   * ```ts
-   * 'Doe'
-   * ```
-   */
-  lastName: string;
-
-  /**
-   * User's full name
-   * @example
-   * ```ts
-   * 'John Doe'
-   * ```
-   */
-  fullName: string;
-
-  /**
-   * Indicates who logged in as this user
-   * @example
-   * ```ts
-   * 'hcu:78thsjvx24hrx' // ID of user who impersonated this user
-   * ```
-   */
-  impersonatedByUserId?: string | null;
-
-}

package/src/context/index.ts

@@ -1,5 +0,0 @@
-export * from './action-context.js';
-export * from './current-user.js';
-export * from './platform-method-context.js';
-export * from './service-method-context.js';
-

package/src/context/platform-method-context.ts

@@ -1,5 +0,0 @@
-import { BaseServiceMethodContext } from './service-method-context.js';
-
-export interface BasePlatformMethodContext extends BaseServiceMethodContext {
-  organizationId: string;
-}

package/src/context/service-method-context.ts

@@ -1,47 +0,0 @@
-import { ActionScopes, ActionScopesArray } from '@pcg/auth';
-import { EntityManager } from 'typeorm';
-import { CurrentUser } from './current-user.js';
-
-/**
- * Context object for base service methods.
- */
-export interface BaseServiceMethodContext {
-  /**
-   * The current user making the request.
-   */
-  user: CurrentUser;
-
-  /**
-   * An optional request ID.
-   */
-  requestId?: string;
-
-  /**
-   * Make the request silent, meaning no notifications and actions will be sent.
-   */
-  isSilent?: boolean;
-
-  /**
-   * Checks if the user has permission to perform the specified action.
-   * @param action The action to check permission for.
-   * @param actionScopes Optional scopes to check permission against.
-   * @returns True if the user has permission, false otherwise.
-   */
-  isGranted(action: string, actionScopes?: ActionScopes | ActionScopesArray): boolean;
-
-  /**
-   * Check permission and throw AccessDenied error if user doesn't have permission
-   * @param action - action string
-   * @param scopes - scopes where action was executed
-   * @throws AccessDenied error if the user doesn't have the permission
-   */
-  validateAccess(action: string, scopes?: ActionScopes | ActionScopesArray): void;
-
-  /**
-   * Check permission and throw AccessDenied error if user doesn't have permission
-   * @param action - action string
-   * @param actionScopes - scopes where action was executed
-   * @throws AccessDenied error if the user doesn't have the permission
-   */
-  transaction?: EntityManager;
-}