Merge pull request #44 from inversify/feat/add-reflect-metadata-utils…

…-package

Add reflect metadata utils package

.changeset/eight-carrots-hope.md

@@ -0,0 +1,5 @@
+---
+"@inversifyjs/reflect-metadata-utils": minor
+---
+
+Added `getReflectMetadata`.

.changeset/perfect-geese-happen.md

@@ -0,0 +1,5 @@
+---
+"@inversifyjs/reflect-metadata-utils": minor
+---
+
+Added `updateReflectMetadata`.

.github/workflows/build.yaml

@@ -45,6 +45,7 @@ jobs:
         with:
           path: |
             ./packages/container/libraries/*
+            ./packages/foundation/libraries/*
             ./packages/foundation/tools/*
           key: ts-build-${{ steps.get-git-commit-hash.outputs.gitCommitHash }}
           restore-keys: |
@@ -77,6 +78,7 @@ jobs:
         with:
           path: |
             ./packages/container/libraries/*
+            ./packages/foundation/libraries/*
             ./packages/foundation/tools/*
           key: ts-build-${{ steps.get-git-commit-hash.outputs.gitCommitHash }}
           restore-keys: |

.github/workflows/collect-coverage.yaml

@@ -51,6 +51,7 @@ jobs:
         with:
           path: |
             ./packages/container/libraries/*
+            ./packages/foundation/libraries/*
             ./packages/foundation/tools/*
           key: ts-build-${{ steps.get-git-commit-hash.outputs.gitCommitHash }}
           restore-keys: |

.vscode/settings.json

@@ -1,6 +1,7 @@
 {
   "eslint.workingDirectories": [
     { "pattern": "./packages/container/libraries/*" },
+    { "pattern": "./packages/foundation/libraries/*" },
     { "pattern": "./packages/foundation/tools/*" }
   ]
 }

codecov.yml

@@ -5,8 +5,13 @@ coverage:
       '@inversifyjs/common':
         flags:
           - '@inversifyjs/common'
-
+      '@inversifyjs/reflect-metadata-utils':
+        flags:
+          - '@inversifyjs/reflect-metadata-utils'
 flags:
   '@inversifyjs/common':
     paths:
       - packages/container/libraries/common/
+  '@inversifyjs/reflect-metadata-utils':
+    paths:
+      - packages/foundation/libraries/reflect-metadata-utils

packages/foundation/libraries/reflect-metadata-utils/.gitignore

@@ -0,0 +1,19 @@
+# Typescript compiled files
+/lib/**
+
+/tsconfig.tsbuildinfo
+/tsconfig.cjs.tsbuildinfo
+/tsconfig.esm.tsbuildinfo
+
+# Test coverage report
+/coverage
+
+# Test mutation report
+/reports
+
+# node modules
+/node_modules/
+
+# Turborepo files
+.turbo/
+

packages/foundation/libraries/reflect-metadata-utils/.lintstagedrc.json

@@ -0,0 +1,9 @@
+{
+  "*.js": [
+    "prettier --write"
+  ],
+  "*.ts": [
+    "prettier --write",
+    "eslint"
+  ]
+}

packages/foundation/libraries/reflect-metadata-utils/.npmignore

@@ -0,0 +1,18 @@
+**/*.spec.js
+**/*.spec.js.map
+**/*.ts
+!lib/**/*.d.ts
+lib/**/*.spec.d.ts
+
+.lintstagedrc.json
+eslint.config.mjs
+jest.config.mjs
+jest.config.stryker.mjs
+jest.js.config.mjs
+prettier.config.mjs
+stryker.config.mjs
+tsconfig.json
+tsconfig.cjs.json
+tsconfig.esm.json
+tsconfig.cjs.tsbuildinfo
+tsconfig.esm.tsbuildinfo

packages/foundation/libraries/reflect-metadata-utils/README.md

@@ -0,0 +1,6 @@
+[![Test coverage](https://codecov.io/gh/inversify/monorepo/branch/main/graph/badge.svg?flag=%40inversifyjs%2Freflect-metadata-utils)](https://codecov.io/gh/inversify/monorepo/branch/main/graph/badge.svg?flag=%40inversifyjs%2Freflect-metadata-utils)
+[![npm version](https://img.shields.io/github/package-json/v/inversify/monorepo?filename=packages%2Ffoundation%2Flibraries%2Freflect-metadata-utils%2Fpackage.json&style=plastic)](https://www.npmjs.com/package/@inversifyjs/reflect-metadata-utils)
+
+# @inversifyjs/reflect-metadata-utils
+
+Inversify reflect metadata utils package.

packages/foundation/libraries/reflect-metadata-utils/eslint.config.mjs

@@ -0,0 +1,3 @@
+import myconfig from '@inversifyjs/foundation-eslint-config';
+
+export default [...myconfig];

packages/foundation/libraries/reflect-metadata-utils/jest.config.mjs

@@ -0,0 +1,3 @@
+import { tsGlobalConfig } from '@inversifyjs/foundation-jest-config';
+
+export default tsGlobalConfig;

packages/foundation/libraries/reflect-metadata-utils/jest.config.stryker.mjs

@@ -0,0 +1,9 @@
+import { getJestTsProjectConfig } from '@inversifyjs/foundation-jest-config';
+
+const tsGlobalConfig = getJestTsProjectConfig(
+  'All',
+  ['/node_modules', '.int.spec.ts'],
+  '.spec.ts',
+);
+
+export default tsGlobalConfig;

packages/foundation/libraries/reflect-metadata-utils/jest.js.config.mjs

@@ -0,0 +1,3 @@
+import { jsGlobalConfig } from '@inversifyjs/foundation-jest-config';
+
+export default jsGlobalConfig;

packages/foundation/libraries/reflect-metadata-utils/package.json

@@ -0,0 +1,81 @@
+{
+  "name": "@inversifyjs/reflect-metadata-utils",
+  "version": "0.1.0",
+  "description": "Reflect metadata utils",
+  "main": "lib/cjs/index.js",
+  "module": "lib/esm/index.js",
+  "exports": {
+    ".": {
+      "import": "./lib/esm/index.js",
+      "require": "./lib/cjs/index.js"
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/inversify/monorepo.git"
+  },
+  "keywords": [
+    "dependency injection",
+    "dependency inversion",
+    "di",
+    "inversion of control container",
+    "ioc",
+    "javascript",
+    "node",
+    "reflect-metadata",
+    "typescript"
+  ],
+  "author": "Roberto Pintos López",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/inversify/monorepo/issues"
+  },
+  "devDependencies": {
+    "@eslint/js": "9.13.0",
+    "@jest/globals": "29.7.0",
+    "@stryker-mutator/core": "8.6.0",
+    "@stryker-mutator/jest-runner": "8.6.0",
+    "@stryker-mutator/typescript-checker": "8.6.0",
+    "@types/node": "20.17.0",
+    "@typescript-eslint/eslint-plugin": "8.11.0",
+    "@typescript-eslint/parser": "8.11.0",
+    "jest": "29.7.0",
+    "prettier": "3.3.3",
+    "rimraf": "6.0.1",
+    "ts-jest": "29.2.5",
+    "ts-node": "10.9.2",
+    "typescript": "5.6.3"
+  },
+  "devEngines": {
+    "node": "^20.18.0",
+    "pnpm": "^9.12.1"
+  },
+  "homepage": "https://inversify.io",
+  "os": [
+    "darwin",
+    "linux"
+  ],
+  "peerDependencies": {
+    "reflect-metadata": "0.2.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "pnpm run build:cjs && pnpm run build:esm",
+    "build:cjs": "tsc --build tsconfig.cjs.json && pnpm exec foundation-ts-package-cjs ./lib/cjs",
+    "build:esm": "tsc --build tsconfig.esm.json && pnpm exec foundation-ts-package-esm ./lib/esm",
+    "build:clean": "rimraf lib",
+    "format": "prettier --write ./src/**/*.ts",
+    "lint": "eslint ./src",
+    "prebuild": "pnpm run build:clean",
+    "test": "jest --config=jest.config.mjs --runInBand",
+    "test:integration:js": "pnpm run test:js --selectProjects Integration",
+    "test:js": "jest --config=jest.js.config.mjs --runInBand",
+    "test:js:coverage": "pnpm run test:unit:js --coverage",
+    "test:mutation": "stryker run",
+    "test:uncommitted": "pnpm run test --changedSince=HEAD",
+    "test:unit:js": "pnpm run test:js --selectProjects Unit"
+  },
+  "sideEffects": false
+}

packages/foundation/libraries/reflect-metadata-utils/prettier.config.mjs

@@ -0,0 +1,3 @@
+import config from '@inversifyjs/foundation-prettier-config';
+
+export default config;

packages/foundation/libraries/reflect-metadata-utils/src/index.ts

@@ -0,0 +1,4 @@
+import { getReflectMetadata } from './reflectMetadata/utils/getReflectMetadata';
+import { updateReflectMetadata } from './reflectMetadata/utils/updateReflectMetadata';
+
+export { getReflectMetadata, updateReflectMetadata };

packages/foundation/libraries/reflect-metadata-utils/src/reflectMetadata/utils/getReflectMetadata.spec.ts

@@ -0,0 +1,45 @@
+import { beforeAll, describe, expect, it } from '@jest/globals';
+
+import 'reflect-metadata';
+
+import { getReflectMetadata } from './getReflectMetadata';
+
+describe(getReflectMetadata.name, () => {
+  describe('when called, and no metadata is registered', () => {
+    let result: unknown;
+
+    beforeAll(() => {
+      result = getReflectMetadata(class {}, 'sample-key');
+    });
+
+    it('should return undefined', () => {
+      expect(result).toBeUndefined();
+    });
+  });
+
+  describe('when called, and metadata is registered', () => {
+    let result: unknown;
+
+    let metadataFixture: unknown;
+
+    beforeAll(() => {
+      metadataFixture = 'sample-metadata';
+
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
+      const targetFixture: Function = class {};
+      const metadataKeyFixture: unknown = 'sample-key';
+
+      Reflect.defineMetadata(
+        metadataKeyFixture,
+        metadataFixture,
+        targetFixture,
+      );
+
+      result = getReflectMetadata(targetFixture, metadataKeyFixture);
+    });
+
+    it('should return metadata', () => {
+      expect(result).toBe(metadataFixture);
+    });
+  });
+});

packages/foundation/libraries/reflect-metadata-utils/src/reflectMetadata/utils/getReflectMetadata.ts

@@ -0,0 +1,7 @@
+// eslint-disable-next-line @typescript-eslint/no-unnecessary-type-parameters
+export function getReflectMetadata<TMetadata>(
+  target: object,
+  metadataKey: unknown,
+): TMetadata | undefined {
+  return Reflect.getMetadata(metadataKey, target) as TMetadata | undefined;
+}