xcally-nest-library 0.0.35 → 0.0.37-XM3778-bae91

package/eslint.config.mjs

@@ -0,0 +1,49 @@
+// @ts-check
+import eslint from '@eslint/js';
+import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended';
+import globals from 'globals';
+import tseslint from 'typescript-eslint';
+
+export default tseslint.config(
+  {
+    ignores: ['eslint.config.mjs', '**/*.mjs'],
+  },
+  eslint.configs.recommended,
+  ...tseslint.configs.recommendedTypeChecked,
+  eslintPluginPrettierRecommended,
+  {
+    languageOptions: {
+      globals: {
+        ...globals.node,
+        ...globals.jest,
+      },
+      ecmaVersion: 5,
+      sourceType: 'module',
+      parserOptions: {
+        projectService: true,
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+  },
+  {
+    rules: {
+      '@typescript-eslint/no-explicit-any': 'off',
+      '@typescript-eslint/no-floating-promises': 'warn',
+      '@typescript-eslint/no-unsafe-argument': 'warn',
+      '@typescript-eslint/no-unsafe-assignment': 'warn',
+      '@typescript-eslint/no-unsafe-member-access': 'warn',
+      '@typescript-eslint/no-unsafe-call': 'warn',
+      '@typescript-eslint/no-unsafe-return': 'warn',
+      '@typescript-eslint/no-empty-object-type': 'warn',
+      '@typescript-eslint/no-unused-vars': [
+        'warn',
+        {
+          vars: 'all',
+          varsIgnorePattern: '^_',
+          args: 'after-used',
+          argsIgnorePattern: '^_',
+        },
+      ],
+    },
+  },
+);

package/index.ts

@@ -3,7 +3,16 @@ export * from './src/modules/logger/pino/logger.module';
 export * from './src/modules/logger/pino/logger.default';
 export * from './src/core/application/base.interface';
 export * from './src/core/application/base.service';
+export * from './src/core/application/cached-base.service';
+export * from './src/core/application/base.mongo.interface';
+export * from './src/core/application/base.mongo.service';
+export * from './src/core/application/cached-base.service';
 export * from './src/core/domain/interfaces/base.repository.interface';
+export * from './src/core/domain/interfaces/cache-configuration.interface';
 export * from './src/core/infrastracture/databases/base.entity';
 export * from './src/core/infrastracture/databases/base.entity.interface';
 export * from './src/core/infrastracture/databases/base.repository';
+export * from './src/core/infrastracture/databases/base.mongo.entity';
+export * from './src/core/infrastracture/databases/base.mongo.entity.interface';
+export * from './src/core/infrastracture/databases/base.mongo.repository';
+export * from './src/core/domain/interfaces/base.mongo.repository.interface';

package/jest.config.ts

@@ -0,0 +1,219 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
+// For a detailed explanation regarding each configuration property, visit:
+import { pathsToModuleNameMapper, JestConfigWithTsJest } from 'ts-jest';
+import { compilerOptions } from './tsconfig.json';
+const BUILD_ID = process.env.BUILD_ID || '';
+const UNIT_TEST_REPORT_NAME = `${BUILD_ID}_unit_report.html`;
+
+const jestConfig: JestConfigWithTsJest = {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after `n` failures
+  bail: 1,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "/private/var/folders/xv/43k0vp7n00jgq5zq55g1v6t40000gr/T/jest_e0",
+
+  // Automatically clear mock calls and instances between every test
+  // clearMocks: false,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  collectCoverage: true,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  // collectCoverageFrom: ['**/src/**/*.ts', '!**/node_modules/**'],
+
+  // The directory where Jest should output its coverage files
+  coverageDirectory: 'coverage/unit',
+
+  // An array of regexp pattern strings used to skip coverage collection
+  coveragePathIgnorePatterns: ['/node_modules/', 'coverage', 'integration-tests'],
+
+  // Indicates which provider should be used to instrument code for coverage
+  // coverageProvider: "v8",
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  // coverageReporters: [
+  //   "json",
+  //   "text",
+  //   "lcov",
+  //   "clover"
+  // ],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  coverageThreshold: {
+    global: {
+      branches: 80,
+      functions: 80,
+      lines: 80,
+      statements: 80,
+    },
+  },
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: undefined,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: undefined,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: undefined,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {
+  //   'ts-jest': {
+  //     // ts-jest configuration goes here
+  //   },
+  // },
+
+  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+  // maxWorkers: "50%",
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  moduleDirectories: ['node_modules', '<rootDir>'],
+
+  // An array of file extensions your modules use
+  moduleFileExtensions: ['js', 'json', 'jsx', 'ts', 'tsx', 'node'],
+
+  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+  moduleNameMapper: pathsToModuleNameMapper(compilerOptions.paths, { prefix: '<rootDir>/' }),
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  // modulePathIgnorePatterns: [],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
+  preset: 'ts-jest',
+
+  // Run tests from one or more projects
+  // projects: undefined,
+
+  // Use this configuration option to add custom reporters to Jest
+  reporters: [
+    'default',
+    [
+      'jest-html-reporters',
+      {
+        publicPath: './test-reports/unit-jest-html',
+        filename: `${UNIT_TEST_REPORT_NAME}`,
+        expand: false,
+        openReport: false,
+        includeFailureMsg: true,
+      },
+    ],
+    [
+      'jest-junit',
+      {
+        suiteName: 'jest tests',
+        outputDirectory: './test-reports/unit-junit',
+        outputName: `${BUILD_ID}_junit.xml`,
+      },
+    ],
+  ],
+
+  // Automatically reset mock state between every test
+  // resetMocks: false,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: undefined,
+
+  // Automatically restore mock state between every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: undefined,
+
+  // A list of paths to directories that Jest should use to search for files in
+  // roots: [
+  //   "<rootDir>"
+  // ],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  setupFiles: ['<rootDir>/.jest/jestEnv.js'],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  // setupFilesAfterEnv: [],
+
+  // The number of seconds after which a test is considered as slow and reported as such in the results.
+  // slowTestThreshold: 5,
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  // testEnvironment: "node",
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  testMatch: ['**/__tests__/**/*.spec.ts', '**/?(*.)+(spec).ts'],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  testPathIgnorePatterns: [
+    '/node_modules/',
+    'coverage',
+    'integration-tests',
+    '/src/integration-tests/variable/utils.ts',
+  ],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  // testRegex: "^(.+)\/__test__\/.+.spec\\.(tsx|ts)$",
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: undefined,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jasmine2",
+
+  // This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
+  // testURL: "http://localhost",
+
+  // Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
+  // timers: "real",
+
+  // A map from regular expressions to paths to transformers
+  transform: {
+    '^.+\\.ts?$': 'ts-jest',
+  },
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "/node_modules/",
+  //   "\\.pnp\\.[^\\/]+$"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  verbose: true,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
+  rootDir: '.',
+  roots: ['<rootDir>/src/'],
+};
+export default jestConfig;

package/package.json

@@ -1,20 +1,42 @@
 {
   "name": "xcally-nest-library",
-  "version": "0.0.35",
+  "version": "0.0.37-XM3778-bae91",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "author": "",
   "license": "UNLICENSED",
+  "scripts": {
+    "bump:patch": "npm version patch -m \"Bump version to %s\"",
+    "prepublishOnly": "npm run build",
+    "build": "tsc",
+    "build:watch": "rimraf dist && tsc-watch -b -v",
+    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
+    "prettier:check": "prettier --check ./**/*.{ts,js,json,*rc}",
+    "prettier:write": "prettier --write ./**/*.{ts,js,json,*rc}",
+    "start": "nest start",
+    "start:dev": "nest start --watch",
+    "start:debug": "nest start --debug --watch",
+    "start:prod": "node dist/main",
+    "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
+    "lib:link": "pnpm link --global",
+    "lib:unlink": "pnpm unlink xcally-nest-libs --global",
+    "publish:feat": "bash ./scripts/publish-feat.sh",
+    "test": "TZ=UTC jest"
+  },
   "dependencies": {
+    "@nestjs/cache-manager": "^3.0.1",
     "@nestjs/config": "^4.0.0",
+    "cache-manager": "^7.2.4",
     "class-transformer": "^0.5.1",
+    "ioredis": "^5.4.2",
+    "mongodb": "6.20.0",
+    "nestjs-cls": "^6.0.1",
     "nestjs-grpc-exceptions": "^0.2.2",
-    "nestjs-paginate": "^11.0.0",
+    "nestjs-paginate": "^11.1.1",
     "nestjs-pino": "^4.3.0",
     "pino": "^9.6.0",
-    "pino-pretty": "^13.0.0",
-    "typeorm": "^0.3.20"
+    "pino-pretty": "^13.0.0"
   },
   "devDependencies": {
     "@nestjs/cli": "^11.0.2",
@@ -22,13 +44,18 @@
     "@nestjs/core": "^11.0.9",
     "@nestjs/microservices": "^11.0.9",
     "@nestjs/schematics": "^11.0.0",
+    "@nestjs/testing": "^11.1.7",
+    "@types/jest": "^29.5.14",
     "@typescript-eslint/eslint-plugin": "^8.23.0",
     "@typescript-eslint/parser": "^8.23.0",
     "eslint": "^9.19.0",
     "eslint-config-prettier": "^10.0.1",
     "eslint-plugin-prettier": "^5.2.3",
+    "jest": "^29.7.0",
+    "jest-mock-extended": "4.0.0-beta1",
     "prettier": "^3.4.2",
     "rimraf": "^6.0.1",
+    "ts-jest": "^29.4.5",
     "ts-node": "^10.9.2",
     "tsc-watch": "^6.2.1",
     "typescript": "^5.7.3"
@@ -36,21 +63,7 @@
   "peerDependencies": {
     "@nestjs/common": "^10.0.0 || ^11.0.0",
     "@nestjs/core": "^10.0.0 || ^11.0.0",
-    "@nestjs/microservices": "^10.0.0 || ^11.0.0"
-  },
-  "scripts": {
-    "bump:patch": "npm version patch -m \"Bump version to %s\"",
-    "build": "tsc",
-    "build:watch": "rimraf dist && tsc-watch -b -v",
-    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
-    "prettier:check": "prettier --check ./**/*.{ts,js,json,*rc}",
-    "prettier:write": "prettier --write ./**/*.{ts,js,json,*rc}",
-    "start": "nest start",
-    "start:dev": "nest start --watch",
-    "start:debug": "nest start --debug --watch",
-    "start:prod": "node dist/main",
-    "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
-    "lib:link": "pnpm link --global",
-    "lib:unlink": "pnpm unlink xcally-nest-libs --global"
+    "@nestjs/microservices": "^10.0.0 || ^11.0.0",
+    "typeorm": "^0.3.20"
   }
-}
+}

package/scripts/publish-feat.sh

@@ -0,0 +1,67 @@
+#!/bin/bash
+
+# Check the number of parameters
+if [ "$#" -ne 1 ]; then
+    echo "Error: You must specify exactly one parameter."
+    echo "Specify task name without dash as parameter (e.g., XM1234 or XM12345)."
+    exit 1
+fi
+
+# Parameter validation
+REGEX="^XM[0-9]{4,5}$"
+
+if [[ ! "$1" =~ $REGEX ]]; then
+    echo "Error: The parameter '$1' is not valid."
+    echo "It must start with 'XM' followed by 4 or 5 digits (e.g., XM1234 or XM12345)."
+    exit 1
+fi
+
+task_name=$1
+
+# Abort if pending changes are present in the working area
+git_status=$(git status --porcelain)
+if [[ -n "$git_status" ]]; then
+  echo "There are pending changes in the working directory."
+  echo "Script execution will be aborted."
+  exit 1
+fi
+
+# Get the version of the package
+package_version=$(cat package.json \
+  | grep version \
+  | head -1 \
+  | awk -F: '{ print $2 }' \
+  | sed 's/[",]//g' \
+  | tr -d '[[:space:]]')
+
+# Get SemVer from package version
+sem_ver=$(echo "$package_version" | grep -o '^[^-]*')
+
+# Get commit hash
+full_commit=$(git rev-parse HEAD)
+commit=${full_commit:0:5}
+
+# Update the version of the package
+npm version $sem_ver-$task_name-$commit --no-git-tag-version
+
+# Install dependencies
+pnpm i
+
+# Publish the package
+npm publish --tag $task_name
+PUBLISH_EXIT_CODE=$?
+
+# Clean changes to package.json
+git checkout package.json
+
+# Check if publish failed
+if [ $PUBLISH_EXIT_CODE -ne 0 ]; then
+    echo ""
+    echo "Error: npm publish failed with code $PUBLISH_EXIT_CODE"
+    exit $PUBLISH_EXIT_CODE
+fi
+
+# # Print the installation command of the published packaged
+printf "\nPackage successfully published."
+printf "\nInstall it using the following command:"
+printf "\npnpm i --save-exact xcally-nest-library@$sem_ver-$task_name-$commit\n\n"