@e22m4u/ts-rest-router 0.2.0 → 0.2.2

package/src/decorators/response-body/response-body-metadata.ts

@@ -0,0 +1,20 @@
+import {MetadataKey} from '@e22m4u/ts-reflector';
+import {DataSchema} from '@e22m4u/ts-data-schema';
+
+/**
+ * Response body metadata.
+ */
+export type ResponseBodyMetadata = {
+  schema?: DataSchema;
+};
+
+/**
+ * Response body metadata map.
+ */
+export type ResponseBodyMetadataMap = Map<string, ResponseBodyMetadata>;
+
+/**
+ * Response body metadata key.
+ */
+export const RESPONSE_BODY_METADATA_KEY =
+  new MetadataKey<ResponseBodyMetadataMap>('responseBodyMetadataKey');

package/src/decorators/response-body/response-body-reflector.spec.ts

@@ -0,0 +1,59 @@
+import {expect} from 'chai';
+import {Reflector} from '@e22m4u/ts-reflector';
+import {ResponseBodyMetadata} from './response-body-metadata.js';
+import {ResponseBodyReflector} from './response-body-reflector.js';
+import {RESPONSE_BODY_METADATA_KEY} from './response-body-metadata.js';
+
+describe('ResponseBodyReflector', function () {
+  describe('setMetadata', function () {
+    it('sets a given value as target metadata', function () {
+      class Target {}
+      const md1 = {};
+      const md2 = {};
+      ResponseBodyReflector.setMetadata(md1, Target, 'propertyKey1');
+      ResponseBodyReflector.setMetadata(md2, Target, 'propertyKey2');
+      const res = Reflector.getOwnMetadata(RESPONSE_BODY_METADATA_KEY, Target);
+      expect(res).to.be.instanceof(Map);
+      expect(res!.get('propertyKey1')).to.be.eq(md1);
+      expect(res!.get('propertyKey2')).to.be.eq(md2);
+    });
+
+    it('overrides existing metadata', function () {
+      class Target {}
+      const md1 = {};
+      const md2 = {};
+      ResponseBodyReflector.setMetadata(md1, Target, 'propertyKey');
+      const res1 = Reflector.getOwnMetadata(RESPONSE_BODY_METADATA_KEY, Target);
+      expect(res1).to.be.instanceof(Map);
+      expect(res1!.get('propertyKey')).to.be.eq(md1);
+      ResponseBodyReflector.setMetadata(md2, Target, 'propertyKey');
+      const res2 = Reflector.getOwnMetadata(RESPONSE_BODY_METADATA_KEY, Target);
+      expect(res2).to.be.instanceof(Map);
+      expect(res2!.get('propertyKey')).to.be.eq(md2);
+    });
+  });
+
+  describe('getMetadata', function () {
+    it('returns an existing metadata of the target', function () {
+      class Target {}
+      const md1 = {};
+      const md2 = {};
+      const mdMap = new Map<string, ResponseBodyMetadata>([
+        ['propertyKey1', md1],
+        ['propertyKey2', md2],
+      ]);
+      Reflector.defineMetadata(RESPONSE_BODY_METADATA_KEY, mdMap, Target);
+      const res = ResponseBodyReflector.getMetadata(Target);
+      expect(res).to.be.instanceof(Map);
+      expect(res!.get('propertyKey1')).to.be.eq(md1);
+      expect(res!.get('propertyKey2')).to.be.eq(md2);
+    });
+
+    it('returns an empty map if no metadata', function () {
+      class Target {}
+      const res = ResponseBodyReflector.getMetadata(Target);
+      expect(res).to.be.instanceof(Map);
+      expect(res).to.be.empty;
+    });
+  });
+});

package/src/decorators/response-body/response-body-reflector.ts

@@ -0,0 +1,41 @@
+import {Constructor} from '../../types.js';
+import {Reflector} from '@e22m4u/ts-reflector';
+import {ResponseBodyMetadata} from './response-body-metadata.js';
+import {ResponseBodyMetadataMap} from './response-body-metadata.js';
+import {RESPONSE_BODY_METADATA_KEY} from './response-body-metadata.js';
+
+/**
+ * Response body reflector.
+ */
+export class ResponseBodyReflector {
+  /**
+   * Set metadata.
+   *
+   * @param metadata
+   * @param target
+   * @param propertyKey
+   */
+  static setMetadata(
+    metadata: ResponseBodyMetadata,
+    target: Constructor,
+    propertyKey: string,
+  ) {
+    const oldMap = Reflector.getOwnMetadata(RESPONSE_BODY_METADATA_KEY, target);
+    const newMap = new Map(oldMap);
+    newMap.set(propertyKey, metadata);
+    Reflector.defineMetadata(RESPONSE_BODY_METADATA_KEY, newMap, target);
+  }
+
+  /**
+   * Get metadata.
+   *
+   * @param target
+   */
+  static getMetadata(target: Constructor): ResponseBodyMetadataMap {
+    const metadata = Reflector.getOwnMetadata(
+      RESPONSE_BODY_METADATA_KEY,
+      target,
+    );
+    return metadata ?? new Map();
+  }
+}

package/src/decorators/rest-action/rest-action-reflector.spec.ts

@@ -1,5 +1,4 @@
 import {expect} from 'chai';
-import {describe} from 'mocha';
 import {Reflector} from '@e22m4u/ts-reflector';
 import {HttpMethod} from '@e22m4u/js-trie-router';
 import {RestActionReflector} from './rest-action-reflector.js';

package/src/decorators/rest-controller/rest-controller-reflector.spec.ts

@@ -1,5 +1,4 @@
 import {expect} from 'chai';
-import {describe} from 'mocha';
 import {Reflector} from '@e22m4u/ts-reflector';
 import {RestControllerReflector} from './rest-controller-reflector.js';
 import {REST_CONTROLLER_METADATA_KEY} from './rest-controller-metadata.js';