@coast/service-common 1.0.1

package/.circleci/config.yml

@@ -0,0 +1,56 @@
+version: 2.1
+jobs:
+  build:
+    docker:
+      - image: cimg/node:20.12.0
+    steps:
+      - checkout
+      - run: sudo corepack enable
+      - run: yarn install --immutable
+      - run: yarn lint
+      - run: yarn build
+  publish:
+    docker:
+      - image: 'cimg/node:20.12.0'
+    steps:
+      - checkout
+      - setup-git
+      - run: sudo corepack enable
+      - run: yarn install --immutable
+      - run: yarn build
+      - configure-yarn-publish
+      - run: yarn version patch
+      - run: git add package.json
+      - run: git commit -m "Bump version[skip ci]"
+      - run: git push
+      - run: yarn npm publish --access public
+workflows:
+  build_and_publish:
+    jobs:
+      - build:
+          context: coast
+      - publish:
+          context: coast
+          requires:
+            - build
+          filters:
+            branches:
+              only: master
+commands:
+  configure-yarn-publish:
+    steps:
+      - run: |
+          yarn config set npmAuthToken $NPM_TOKEN
+          yarn config set npmRegistryServer https://registry.npmjs.org/
+  setup-git:
+    steps:
+      - add_ssh_keys:
+          fingerprints:
+            - 'SHA256:J9pGnIRru8syuYQ6WPwHMkMYkggR+Z4j4uUKFr++iuI'
+      - run:
+          name: add github.com to known hosts
+          command: ssh-keyscan github.com >> ~/.ssh/known_hosts
+      - run: |
+          git config --global user.email "circleci@coastapp.com"
+          git config --global user.name "CircleCI"
+          git config --global push.default current

package/.husky/pre-commit

@@ -0,0 +1,2 @@
+#!/bin/bash
+yarn lint-staged

package/.husky/prepare-commit-msg

@@ -0,0 +1,9 @@
+#!/bin/bash
+FILE=$1
+MESSAGE=$(cat $FILE)
+TICKET="[$(git rev-parse --abbrev-ref HEAD | grep -Eo 'sc-[0-9]+')]" || true
+if [[ $TICKET == "[]" || "$MESSAGE" == "$TICKET"* ]];then
+  exit 0;
+fi
+TICKET=$(echo ${TICKET} | tr [:lower:] [:upper:])
+echo "$TICKET $MESSAGE" > $FILE

package/.lintstagedrc

@@ -0,0 +1,3 @@
+{
+    "*.ts": "eslint --fix",
+}

package/.nvmrc

@@ -0,0 +1 @@
+20.12.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 coast-app
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1 @@
+# service-common

package/eslint.config.cjs

@@ -0,0 +1,45 @@
+const typescriptEslintPlugin = require('@typescript-eslint/eslint-plugin');
+const typescriptEslintParser = require('@typescript-eslint/parser');
+const eslintConfigPrettier = require('eslint-config-prettier');
+const eslintPluginPrettier = require('eslint-plugin-prettier');
+const { configs } = typescriptEslintPlugin;
+module.exports = [
+    {
+        files: ['{lib,test}/**/*.ts', '{lib,test}/**/*.tsx'],
+        languageOptions: {
+            parser: typescriptEslintParser,
+            parserOptions: {
+                project: './tsconfig.json',
+                sourceType: 'module',
+            },
+        },
+        plugins: {
+            '@typescript-eslint': typescriptEslintPlugin,
+            prettier: eslintPluginPrettier,
+        },
+        rules: {
+            ...configs.recommended.rules, // Recommended rules
+            ...configs.strict.rules,      // Strict rules
+            ...eslintConfigPrettier.rules, // Disable Prettier conflicts
+            // Custom overrides
+            '@typescript-eslint/no-explicit-any': 'error',
+            'no-console': 'warn',
+            '@typescript-eslint/no-extraneous-class': ['error', {'allowWithDecorator': true}],
+            'prettier/prettier': [
+                'error',
+                {
+                    printWidth: 130,
+                    tabWidth: 4,
+                    singleQuote: true,
+                    trailingComma: 'es5',
+                    arrowParens: 'always',
+                    jsxBracketSameLine: true,
+                },
+            ],
+        },
+        ignores: [
+            'node_modules/',
+            'dist/',
+        ],
+    },
+];

package/jest.config.js

@@ -0,0 +1,8 @@
+module.exports =  {
+    preset: 'ts-jest',
+    testEnvironment: 'node',
+    testPathIgnorePatterns: ['/node_modules/', '/dist/'],
+    testMatch: ['**/test/**/*Test.ts'],
+    setupFiles: ['dotenv/config'],
+    bail: true,
+};

package/lib/modules/logger/CoastLogger.ts

@@ -0,0 +1,9 @@
+import { LoggerService } from '@nestjs/common';
+
+export abstract class CoastLogger implements LoggerService {
+    public abstract error(message: unknown, trace?: string): void;
+    public abstract log(message: unknown): void;
+    public abstract warn(message: unknown): void;
+    public abstract debug(message: unknown): void;
+    public abstract verbose(message: unknown): void;
+}

package/lib/modules/logger/LoggerModule.ts

@@ -0,0 +1,37 @@
+import { DynamicModule, Global, Module } from '@nestjs/common';
+import { FactoryProvider, ValueProvider } from '@nestjs/common/interfaces';
+import { ConfigModule, ConfigService } from '@nestjs/config';
+import { PinoLogger } from './PinoLogger';
+import { SilentLogger } from './SilentLogger';
+import { CoastLogger } from './CoastLogger';
+
+@Module({})
+@Global()
+export class LoggerModule {
+    public static forRootAsync(): DynamicModule {
+        const coastLogger: FactoryProvider = {
+            inject: [ConfigService],
+            provide: CoastLogger,
+            useFactory: (configService: ConfigService): PinoLogger => new PinoLogger(configService),
+        };
+        return {
+            module: LoggerModule,
+            imports: [ConfigModule],
+            providers: [coastLogger],
+            exports: [coastLogger],
+        };
+    }
+
+    public static disabled(): DynamicModule {
+        const coastLogger: ValueProvider = {
+            provide: CoastLogger,
+            useValue: new SilentLogger(),
+        };
+        return {
+            module: LoggerModule,
+            imports: [ConfigModule],
+            providers: [coastLogger],
+            exports: [coastLogger],
+        };
+    }
+}

package/lib/modules/logger/PinoLogger.ts

@@ -0,0 +1,61 @@
+import { Injectable } from '@nestjs/common';
+import { ConfigService } from '@nestjs/config';
+import Pino from 'pino';
+import { CoastLogger } from './CoastLogger';
+
+@Injectable()
+export class PinoLogger extends CoastLogger {
+    private readonly instance: Pino.Logger;
+
+    public constructor(configService: ConfigService) {
+        super();
+        const level = configService.get('LOG_LEVEL');
+        const redact = [
+            'MYSQL_PASSWORD',
+            'STRIPE_SECRETKEY',
+            'JWT_SECRET',
+            'headers.authorization',
+            'user.passcode',
+            'user.lastName',
+            'user.phoneNumber',
+            'user.email',
+        ];
+        const pino = configService.get('LOG_PRETTY')
+            ? Pino({
+                  level,
+                  redact,
+                  transport: {
+                      target: 'pino-pretty',
+                      options: {
+                          colorize: true,
+                          translateTime: true,
+                      },
+                  },
+              })
+            : Pino({
+                  level,
+                  redact,
+              });
+        this.instance = pino;
+    }
+
+    public error(message: unknown, trace: string = ''): void {
+        this.instance.error(message, trace);
+    }
+
+    public log(message: unknown): void {
+        this.instance.info(message);
+    }
+
+    public warn(message: unknown): void {
+        this.instance.warn(message);
+    }
+
+    public debug(message: unknown): void {
+        this.instance.debug(message);
+    }
+
+    public verbose(message: unknown): void {
+        this.instance.trace(message);
+    }
+}

package/lib/modules/logger/SilentLogger.ts

@@ -0,0 +1,19 @@
+import { CoastLogger } from './CoastLogger';
+
+export class SilentLogger extends CoastLogger {
+    public log(): void {
+        return;
+    }
+    public error(): void {
+        return;
+    }
+    public warn(): void {
+        return;
+    }
+    public debug(): void {
+        return;
+    }
+    public verbose(): void {
+        return;
+    }
+}

package/lib/modules/trace/Trace.ts

@@ -0,0 +1,6 @@
+import { TraceId } from './TraceId';
+
+export interface Trace {
+    traceId: TraceId;
+    subtraceId?: TraceId;
+}

package/lib/modules/trace/TraceId.ts

@@ -0,0 +1,7 @@
+import { Brand } from '@paradoxical-io/types';
+
+export type TraceId = Brand<string, 'TraceId'>;
+
+export function TraceId(id: string): TraceId {
+    return id as TraceId;
+}

package/lib/modules/trace/TraceInterceptor.ts

@@ -0,0 +1,11 @@
+import { CallHandler, ExecutionContext, Inject, NestInterceptor } from '@nestjs/common';
+import { Observable } from 'rxjs';
+import { TraceManager } from './TraceManager';
+
+export class TraceInterceptor implements NestInterceptor {
+    constructor(@Inject() private readonly traceManager: TraceManager) {}
+
+    public intercept(_context: ExecutionContext, next: CallHandler): Observable<unknown> | Promise<Observable<unknown>> {
+        return this.traceManager.withNewTrace(next.handle);
+    }
+}

package/lib/modules/trace/TraceManager.ts

@@ -0,0 +1,22 @@
+import { Trace } from './Trace';
+import uuid from 'uuid';
+import { Inject, Injectable } from '@nestjs/common';
+import { AsyncLocalStorage } from 'node:async_hooks';
+import { TraceId } from './TraceId';
+
+@Injectable()
+export class TraceManager {
+    constructor(@Inject() private readonly asyncLocalStorage: AsyncLocalStorage<Trace>) {}
+
+    public getTrace(): Trace | undefined {
+        return this.asyncLocalStorage.getStore();
+    }
+
+    public withNewTrace<T>(fn: () => T, traceId?: TraceId): T {
+        const trace: Trace = {
+            traceId: traceId ?? TraceId(uuid.v4()),
+            subtraceId: TraceId(uuid.v4()),
+        };
+        return this.asyncLocalStorage.run(trace, fn);
+    }
+}

package/lib/modules/trace/TraceModule.ts

@@ -0,0 +1,11 @@
+import { Module } from '@nestjs/common';
+import { TraceManager } from './TraceManager';
+import { TraceInterceptor } from './TraceInterceptor';
+import { AsyncLocalStorage } from 'node:async_hooks';
+import { Trace } from './Trace';
+
+@Module({
+    providers: [AsyncLocalStorage<Trace>, TraceManager, TraceInterceptor],
+    exports: [TraceManager, TraceInterceptor],
+})
+export class TraceModule {}

package/lib/modules/trace/Traceable.ts

@@ -0,0 +1,3 @@
+import { TraceId } from './TraceId';
+
+export type Traceable<T> = T & { traceId?: TraceId };

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@coast/service-common",
+  "version": "1.0.1",
+  "description": "Common service package",
+  "main": "dist",
+  "types": "dist",
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "scripts": {
+    "prebuild": "rimraf dist",
+    "build": "yarn prebuild && yarn dlx @nestjs/cli build",
+    "lint": "eslint --fix"
+  },
+  "dependencies": {
+    "@paradoxical-io/types": "^1.0.7",
+    "pino": "^9.6.0",
+    "uuid": "^11.0.5"
+  },
+  "devDependencies": {
+    "@faker-js/faker": "^9.4.0",
+    "@nestjs/cli": "^10.4.4",
+    "@nestjs/common": "^10.4.1",
+    "@nestjs/config": "^3.2.3",
+    "@nestjs/schematics": "^10.1.4",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^22.5.0",
+    "@types/supertest": "^6.0.2",
+    "@typescript-eslint/eslint-plugin": "^8.3.0",
+    "@typescript-eslint/parser": "^8.3.0",
+    "dotenv": "^16.4.7",
+    "eslint": "^9.9.1",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.2.1",
+    "husky": "^9.1.7",
+    "jest": "^29.7.0",
+    "lint-staged": "^15.4.1",
+    "prettier": "^3.3.3",
+    "reflect-metadata": "^0.2.2",
+    "rimraf": "^6.0.1",
+    "rxjs": "^7.8.1",
+    "supertest": "^7.0.0",
+    "ts-jest": "^29.2.5",
+    "ts-node": "^10.9.2",
+    "tsconfig-paths": "^4.2.0",
+    "typescript": "^5",
+    "typescript-eslint": "^8.3.0"
+  },
+  "peerDependencies": {
+    "@nestjs/common": "*",
+    "@nestjs/config": "*",
+    "reflect-metadata": "*",
+    "rxjs": "*"
+  },
+  "author": "Coast Engineerring",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "packageManager": "yarn@4.5.2"
+}

package/tsconfig.json

@@ -0,0 +1,31 @@
+{
+  "compilerOptions": {
+    "outDir": "./dist",
+    "baseUrl": "./",
+    "alwaysStrict": true,
+    "strict": true,
+    "allowSyntheticDefaultImports": true,
+    "forceConsistentCasingInFileNames": true,
+    "emitDecoratorMetadata": true,
+    "esModuleInterop": true,
+    "experimentalDecorators": true,
+    "declaration": true,
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "noFallthroughCasesInSwitch": false,
+    "noImplicitAny": true,
+    "noImplicitReturns": false,
+    "noImplicitThis": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "removeComments": true,
+    "resolveJsonModule": true,
+    "rootDir": "./lib",
+    "strictNullChecks": true,
+    "skipLibCheck": true,
+    "target": "es2021"
+  },
+  "compileOnSave": true,
+  "include": ["lib/**/*.ts", "test/**/*.ts"],
+  "exclude": ["node_modules", "dist"]
+}