Merge pull request #184 from inversify/refactor/add-binding-fluent-sy…

…ntax

Add binding fluent syntax

packages/container/libraries/container/package.json

@@ -4,6 +4,11 @@
     "url": "https://github.com/inversify/monorepo/issues"
   },
   "description": "InversifyJs container",
+  "dependencies": {
+    "@inversifyjs/common": "workspace:*",
+    "@inversifyjs/core": "workspace:*",
+    "@inversifyjs/reflect-metadata-utils": "workspace:*"
+  },
   "devDependencies": {
     "@eslint/js": "9.17.0",
     "@jest/globals": "29.7.0",

packages/container/libraries/container/src/binding/actions/getBindingId.spec.ts

@@ -0,0 +1,88 @@
+import { afterAll, beforeAll, describe, expect, it, jest } from '@jest/globals';
+
+jest.mock('@inversifyjs/reflect-metadata-utils');
+
+import {
+  getReflectMetadata,
+  updateReflectMetadata,
+} from '@inversifyjs/reflect-metadata-utils';
+
+import { getBindingId } from './getBindingId';
+
+describe(getBindingId.name, () => {
+  describe('when called, and getReflectMetadata() returns undefined', () => {
+    let result: unknown;
+
+    beforeAll(() => {
+      (
+        getReflectMetadata as jest.Mock<typeof getReflectMetadata>
+      ).mockReturnValueOnce(0);
+
+      result = getBindingId();
+    });
+
+    afterAll(() => {
+      jest.clearAllMocks();
+    });
+
+    it('should call getReflectMetadata()', () => {
+      expect(getReflectMetadata).toHaveBeenCalledTimes(1);
+      expect(getReflectMetadata).toHaveBeenCalledWith(
+        Object,
+        '@inversifyjs/container/bindingId',
+      );
+    });
+
+    it('should call updateReflectMetadata()', () => {
+      expect(updateReflectMetadata).toHaveBeenCalledTimes(1);
+      expect(updateReflectMetadata).toHaveBeenCalledWith(
+        Object,
+        '@inversifyjs/container/bindingId',
+        0,
+        expect.any(Function),
+      );
+    });
+
+    it('should return default id', () => {
+      expect(result).toBe(0);
+    });
+  });
+
+  describe('when called, and getReflectMetadata() returns Number.MAX_SAFE_INTEGER', () => {
+    let result: unknown;
+
+    beforeAll(() => {
+      (
+        getReflectMetadata as jest.Mock<typeof getReflectMetadata>
+      ).mockReturnValueOnce(Number.MAX_SAFE_INTEGER);
+
+      result = getBindingId();
+    });
+
+    afterAll(() => {
+      jest.clearAllMocks();
+    });
+
+    it('should call getReflectMetadata()', () => {
+      expect(getReflectMetadata).toHaveBeenCalledTimes(1);
+      expect(getReflectMetadata).toHaveBeenCalledWith(
+        Object,
+        '@inversifyjs/container/bindingId',
+      );
+    });
+
+    it('should call updateReflectMetadata()', () => {
+      expect(updateReflectMetadata).toHaveBeenCalledTimes(1);
+      expect(updateReflectMetadata).toHaveBeenCalledWith(
+        Object,
+        '@inversifyjs/container/bindingId',
+        Number.MAX_SAFE_INTEGER,
+        expect.any(Function),
+      );
+    });
+
+    it('should return default id', () => {
+      expect(result).toBe(Number.MAX_SAFE_INTEGER);
+    });
+  });
+});

packages/container/libraries/container/src/binding/actions/getBindingId.ts

@@ -0,0 +1,29 @@
+import {
+  getReflectMetadata,
+  updateReflectMetadata,
+} from '@inversifyjs/reflect-metadata-utils';
+
+const ID_METADATA: string = '@inversifyjs/container/bindingId';
+
+export function getBindingId(): number {
+  const bindingId: number =
+    getReflectMetadata<number>(Object, ID_METADATA) ?? 0;
+
+  if (bindingId === Number.MAX_SAFE_INTEGER) {
+    updateReflectMetadata(
+      Object,
+      ID_METADATA,
+      bindingId,
+      () => Number.MIN_SAFE_INTEGER,
+    );
+  } else {
+    updateReflectMetadata(
+      Object,
+      ID_METADATA,
+      bindingId,
+      (id: number) => id + 1,
+    );
+  }
+
+  return bindingId;
+}

packages/container/libraries/container/src/common/models/Writable.ts

@@ -0,0 +1,3 @@
+export type Writable<T> = {
+  -readonly [TKey in keyof T]: T[TKey];
+};

packages/container/libraries/container/src/container/binding/models/BindingFluentSyntax.ts

@@ -0,0 +1,53 @@
+import { Newable, ServiceIdentifier } from '@inversifyjs/common';
+import {
+  BindingActivation,
+  BindingDeactivation,
+  BindingMetadata,
+  DynamicValueBuilder,
+  Factory,
+  Provider,
+  ResolutionContext,
+} from '@inversifyjs/core';
+
+export interface BindToFluentSyntax<T> {
+  to(type: Newable<T>): BindInWhenOnFluentSyntax<T>;
+  toSelf(): BindInWhenOnFluentSyntax<T>;
+  toConstantValue(value: T): BindWhenOnFluentSyntax<T>;
+  toDynamicValue(builder: DynamicValueBuilder<T>): BindInWhenOnFluentSyntax<T>;
+  toFactory(
+    factory: T extends Factory<unknown>
+      ? (context: ResolutionContext) => T
+      : never,
+  ): BindWhenOnFluentSyntax<T>;
+  toProvider(
+    provider: T extends Provider<unknown>
+      ? (context: ResolutionContext) => T
+      : never,
+  ): BindWhenOnFluentSyntax<T>;
+  toService(service: ServiceIdentifier<T>): void;
+}
+
+export interface BindInFluentSyntax<T> {
+  inSingletonScope(): BindWhenOnFluentSyntax<T>;
+  inTransientScope(): BindWhenOnFluentSyntax<T>;
+  inRequestScope(): BindWhenOnFluentSyntax<T>;
+}
+
+export interface BindInWhenOnFluentSyntax<T>
+  extends BindInFluentSyntax<T>,
+    BindWhenOnFluentSyntax<T> {}
+
+export interface BindOnFluentSyntax<T> {
+  onActivation(activation: BindingActivation<T>): BindWhenFluentSyntax<T>;
+  onDeactivation(deactivation: BindingDeactivation<T>): BindWhenFluentSyntax<T>;
+}
+
+export interface BindWhenOnFluentSyntax<T>
+  extends BindWhenFluentSyntax<T>,
+    BindOnFluentSyntax<T> {}
+
+export interface BindWhenFluentSyntax<T> {
+  when(
+    constraint: (metadata: BindingMetadata) => boolean,
+  ): BindOnFluentSyntax<T>;
+}