fix: rename convertTypeofObject to convertClassInstanceToMap

Reason: we already convert null, binary, array, sets, pure JavaScript objects
which also belong to Object.Prototype inheritance chain. This configuration
converts other objects, aka different constructor.

Author: trivikr

packages/util-dynamodb/src/convertToAttr.spec.ts

@@ -7,8 +7,8 @@ import { NativeAttributeValue } from "./models";
 describe("convertToAttr", () => {
   describe("null", () => {
     it(`returns for null`, () => {
-      [false, true].forEach((convertTypeofObject) => {
-        expect(convertToAttr(null, { convertTypeofObject })).toEqual({ NULL: true });
+      [false, true].forEach((convertClassInstanceToMap) => {
+        expect(convertToAttr(null, { convertClassInstanceToMap })).toEqual({ NULL: true });
       });
     });
   });
@@ -119,15 +119,15 @@ describe("convertToAttr", () => {
       new BigUint64Array(arr.map(BigInt)),
     ].forEach((data) => {
       it(`returns for binary: ${data.constructor.name}`, () => {
-        [false, true].forEach((convertTypeofObject) => {
-          expect(convertToAttr(data, { convertTypeofObject })).toEqual({ B: data });
+        [false, true].forEach((convertClassInstanceToMap) => {
+          expect(convertToAttr(data, { convertClassInstanceToMap })).toEqual({ B: data });
         });
       });
     });
 
     it("returns null for Binary when options.convertEmptyValues=true", () => {
-      [false, true].forEach((convertTypeofObject) => {
-        expect(convertToAttr(new Uint8Array(), { convertTypeofObject, convertEmptyValues: true })).toEqual({
+      [false, true].forEach((convertClassInstanceToMap) => {
+        expect(convertToAttr(new Uint8Array(), { convertClassInstanceToMap, convertEmptyValues: true })).toEqual({
           NULL: true,
         });
       });
@@ -399,13 +399,13 @@ describe("convertToAttr", () => {
         }).toThrowError(
           `Unsupported type passed: ${String(
             data
-          )}. Pass options.convertTypeofObject=true to marshall typeof object as map attribute.`
+          )}. Pass options.convertClassInstanceToMap=true to marshall typeof object as map attribute.`
         );
       });
     });
   });
 
-  describe("typeof object with options.convertTypeofObject=true", () => {
+  describe("typeof object with options.convertClassInstanceToMap=true", () => {
     it("returns map for class", () => {
       class FooClass {
         constructor(
@@ -437,7 +437,7 @@ describe("convertToAttr", () => {
             }
           ),
           {
-            convertTypeofObject: true,
+            convertClassInstanceToMap: true,
           }
         )
       ).toEqual({
@@ -457,7 +457,7 @@ describe("convertToAttr", () => {
     });
 
     it("returns empty for Date object", () => {
-      expect(convertToAttr(new Date(), { convertTypeofObject: true })).toEqual({ M: {} });
+      expect(convertToAttr(new Date(), { convertClassInstanceToMap: true })).toEqual({ M: {} });
     });
   });
 });

packages/util-dynamodb/src/convertToAttr.ts

@@ -27,7 +27,7 @@ export const convertToAttr = (data: NativeAttributeValue, options?: marshallOpti
     // Do not alter binary data passed https://github.com/aws/aws-sdk-js-v3/issues/1530
     // @ts-expect-error Type '{ B: NativeAttributeBinary; }' is not assignable to type 'AttributeValue'
     return convertToBinaryAttr(data);
-  } else if (options?.convertTypeofObject && typeof data === "object") {
+  } else if (options?.convertClassInstanceToMap && typeof data === "object") {
     return convertToMapAttr(data as { [key: string]: NativeAttributeValue }, options);
   } else {
     return convertToScalarAttr(data as NativeScalarAttributeValue, options);
@@ -121,7 +121,7 @@ const convertToScalarAttr = (data: NativeScalarAttributeValue, options?: marshal
     return convertToStringAttr(data);
   }
   throw new Error(
-    `Unsupported type passed: ${data}. Pass options.convertTypeofObject=true to marshall typeof object as map attribute.`
+    `Unsupported type passed: ${data}. Pass options.convertClassInstanceToMap=true to marshall typeof object as map attribute.`
   );
 };
 

packages/util-dynamodb/src/marshall.ts

@@ -18,7 +18,7 @@ export interface marshallOptions {
   /**
    * Whether to convert typeof object to map attribute.
    */
-  convertTypeofObject?: boolean;
+  convertClassInstanceToMap?: boolean;
 }
 
 /**

packages/util-dynamodb/src/models.ts

@@ -15,7 +15,7 @@ export type NativeAttributeValue =
   | { [key: string]: NativeAttributeValue }
   | NativeAttributeValue[]
   | Set<number | bigint | NumberValue | string | NativeAttributeBinary | undefined>
-  | InstanceType<{ new (...args: any[]): any }>; // accepts any class instance with options.convertTypeofObject
+  | InstanceType<{ new (...args: any[]): any }>; // accepts any class instance with options.convertClassInstanceToMap
 
 export type NativeScalarAttributeValue =
   | null