feat(document-client): expose translateConfig options to DocumentClie…

…ntV3

packages/document-client/src/classes/__tests__/document-client-v3.spec.ts

@@ -1,4 +1,5 @@
 import {DynamoDBClient} from '@aws-sdk/client-dynamodb';
+import {DEFAULT_TRANSLATE_CONFIG_V3} from '../../constants/translate-config';
 import {DocumentClient} from '../base-document-client';
 import {DocumentClientV3} from '../document-client-v3';
 
@@ -16,3 +17,44 @@ beforeEach(() => {
 test('registers a valid documentClient instance', async () => {
   expect(dc.version).toEqual(3);
 });
+
+it('uses default documentClientV3 translate config', () => {
+  const documentClientInstance = new DocumentClientV3(new DynamoDBClient({}));
+
+  expect(documentClientInstance.documentClient.config.translateConfig).toEqual(
+    DEFAULT_TRANSLATE_CONFIG_V3
+  );
+});
+
+it('overrides documentClientV3 translate config with custom values', () => {
+  const documentClientInstance = new DocumentClientV3(new DynamoDBClient({}), {
+    marshallOptions: {
+      convertEmptyValues: true,
+    },
+    unmarshallOptions: {
+      wrapNumbers: true,
+    },
+  });
+
+  expect(documentClientInstance.documentClient.config.translateConfig).toEqual({
+    marshallOptions: {
+      convertClassInstanceToMap: false,
+      convertEmptyValues: true,
+      removeUndefinedValues: false,
+    },
+    unmarshallOptions: {
+      wrapNumbers: true,
+    },
+  });
+});
+
+it('correctly merges documentClientV3 translate config with custom values when all values are not provided', () => {
+  const documentClientInstance = new DocumentClientV3(new DynamoDBClient({}), {
+    marshallOptions: {},
+    unmarshallOptions: undefined,
+  });
+
+  expect(documentClientInstance.documentClient.config.translateConfig).toEqual(
+    DEFAULT_TRANSLATE_CONFIG_V3
+  );
+});

packages/document-client/src/classes/document-client-v3.ts

@@ -33,8 +33,11 @@ import {
   ScanCommand,
   TransactGetCommand,
   TransactWriteCommand,
+  TranslateConfig,
   UpdateCommand,
 } from '@aws-sdk/lib-dynamodb';
+import {isEmptyObject} from '@typedorm/core/src/helpers/is-empty-object';
+import {DEFAULT_TRANSLATE_CONFIG_V3} from '../constants/translate-config';
 import {TransactionCancelledException} from '../exceptions';
 import {DocumentClient} from './base-document-client';
 
@@ -44,23 +47,29 @@ export class DocumentClientV3<
   readonly documentClient: DynamoDBDocumentClientType;
   readonly version = 3;
 
-  constructor(dynamoDBClient: DynamoDBClient) {
+  constructor(
+    dynamoDBClient: DynamoDBClient,
+    customTranslateConfig?: TranslateConfig
+  ) {
     super();
-    const marshallOptions = {
-      // Whether to automatically convert empty strings, blobs, and sets to `null`.
-      convertEmptyValues: false, // false, by default.
-      // Whether to remove undefined values while marshalling.
-      removeUndefinedValues: false, // false, by default.
-      // Whether to convert typeof object to map attribute.
-      convertClassInstanceToMap: false, // false, by default.
-    };
 
-    const unmarshallOptions = {
-      // Whether to return numbers as a string instead of converting them to native JavaScript numbers.
-      wrapNumbers: false, // false, by default.
+    const translateConfig = {
+      marshallOptions:
+        (customTranslateConfig &&
+          !isEmptyObject(customTranslateConfig.marshallOptions) && {
+            ...DEFAULT_TRANSLATE_CONFIG_V3.marshallOptions,
+            ...customTranslateConfig.marshallOptions,
+          }) ||
+        DEFAULT_TRANSLATE_CONFIG_V3.marshallOptions,
+      unmarshallOptions:
+        (customTranslateConfig &&
+          !isEmptyObject(customTranslateConfig.marshallOptions) && {
+            ...DEFAULT_TRANSLATE_CONFIG_V3.unmarshallOptions,
+            ...customTranslateConfig.unmarshallOptions,
+          }) ||
+        DEFAULT_TRANSLATE_CONFIG_V3.unmarshallOptions,
     };
 
-    const translateConfig = {marshallOptions, unmarshallOptions};
     this.documentClient = DynamoDBDocumentClient.from(
       dynamoDBClient,
       translateConfig

packages/document-client/src/constants/translate-config.ts

@@ -0,0 +1,14 @@
+export const DEFAULT_TRANSLATE_CONFIG_V3 = {
+  marshallOptions: {
+    // Whether to automatically convert empty strings, blobs, and sets to `null`.
+    convertEmptyValues: false, // false, by default.
+    // Whether to remove undefined values while marshalling.
+    removeUndefinedValues: false, // false, by default.
+    // Whether to convert typeof object to map attribute.
+    convertClassInstanceToMap: false, // false, by default.
+  },
+  unmarshallOptions: {
+    // Whether to return numbers as a string instead of converting them to native JavaScript numbers.
+    wrapNumbers: false, // false, by default.
+  },
+};