@aws-sdk/util-dynamodb 3.427.0 → 3.428.0

package/dist-cjs/marshall.js

@@ -8,7 +8,7 @@ function marshall(data, options) {
     switch (key) {
         case "M":
         case "L":
-            return value;
+            return (options === null || options === void 0 ? void 0 : options.convertTopLevelContainer) ? attributeValue : value;
         case "SS":
         case "NS":
         case "BS":

package/dist-cjs/unmarshall.js

@@ -2,5 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.unmarshall = void 0;
 const convertToNative_1 = require("./convertToNative");
-const unmarshall = (data, options) => (0, convertToNative_1.convertToNative)({ M: data }, options);
+const unmarshall = (data, options) => {
+    if (options === null || options === void 0 ? void 0 : options.convertWithoutMapWrapper) {
+        return (0, convertToNative_1.convertToNative)(data, options);
+    }
+    return (0, convertToNative_1.convertToNative)({ M: data }, options);
+};
 exports.unmarshall = unmarshall;

package/dist-es/marshall.js

@@ -5,7 +5,7 @@ export function marshall(data, options) {
     switch (key) {
         case "M":
         case "L":
-            return value;
+            return options?.convertTopLevelContainer ? attributeValue : value;
         case "SS":
         case "NS":
         case "BS":

package/dist-es/unmarshall.js

@@ -1,2 +1,7 @@
 import { convertToNative } from "./convertToNative";
-export const unmarshall = (data, options) => convertToNative({ M: data }, options);
+export const unmarshall = (data, options) => {
+    if (options?.convertWithoutMapWrapper) {
+        return convertToNative(data, options);
+    }
+    return convertToNative({ M: data }, options);
+};

package/dist-types/convertToAttr.d.ts

@@ -2,9 +2,9 @@ import { AttributeValue } from "@aws-sdk/client-dynamodb";
 import { marshallOptions } from "./marshall";
 import { NativeAttributeValue } from "./models";
 /**
- * Convert a JavaScript value to its equivalent DynamoDB AttributeValue type
+ * Convert a JavaScript value to its equivalent DynamoDB AttributeValue type.
  *
- * @param {NativeAttributeValue} data - The data to convert to a DynamoDB AttributeValue
- * @param {marshallOptions} options - An optional configuration object for `convertToAttr`
+ * @param data - The data to convert to a DynamoDB AttributeValue.
+ * @param options - An optional configuration object for `convertToAttr`.
  */
 export declare const convertToAttr: (data: NativeAttributeValue, options?: marshallOptions) => AttributeValue;

package/dist-types/convertToNative.d.ts

@@ -4,7 +4,7 @@ import { unmarshallOptions } from "./unmarshall";
 /**
  * Convert a DynamoDB AttributeValue object to its equivalent JavaScript type.
  *
- * @param {AttributeValue} data - The DynamoDB record to convert to JavaScript type.
- * @param {unmarshallOptions} options - An optional configuration object for `convertToNative`.
+ * @param data - The DynamoDB record to convert to JavaScript type.
+ * @param options - An optional configuration object for `convertToNative`.
  */
 export declare const convertToNative: (data: AttributeValue, options?: unmarshallOptions) => NativeAttributeValue;

package/dist-types/marshall.d.ts

@@ -16,12 +16,20 @@ export interface marshallOptions {
      * Whether to convert typeof object to map attribute.
      */
     convertClassInstanceToMap?: boolean;
+    /**
+     * Whether to convert the top level container
+     * if it is a map or list.
+     *
+     * Default is true when using the DynamoDBDocumentClient,
+     * but false if directly using the marshall function (backwards compatibility).
+     */
+    convertTopLevelContainer?: boolean;
 }
 /**
  * Convert a JavaScript object into a DynamoDB record.
  *
- * @param {any} data - The data to convert to a DynamoDB record
- * @param {marshallOptions} options - An optional configuration object for `marshall`
+ * @param data - The data to convert to a DynamoDB record
+ * @param options - An optional configuration object for `marshall`
  *
  */
 export declare function marshall(data: Set<string>, options?: marshallOptions): AttributeValue.SSMember;

package/dist-types/ts3.4/marshall.d.ts

@@ -4,6 +4,7 @@ export interface marshallOptions {
   convertEmptyValues?: boolean;
   removeUndefinedValues?: boolean;
   convertClassInstanceToMap?: boolean;
+  convertTopLevelContainer?: boolean;
 }
 export declare function marshall(
   data: Set<string>,

package/dist-types/ts3.4/unmarshall.d.ts

@@ -2,8 +2,9 @@ import { AttributeValue } from "@aws-sdk/client-dynamodb";
 import { NativeAttributeValue } from "./models";
 export interface unmarshallOptions {
   wrapNumbers?: boolean;
+  convertWithoutMapWrapper?: boolean;
 }
 export declare const unmarshall: (
-  data: Record<string, AttributeValue>,
+  data: Record<string, AttributeValue> | AttributeValue,
   options?: unmarshallOptions
 ) => Record<string, NativeAttributeValue>;

package/dist-types/unmarshall.d.ts

@@ -9,11 +9,18 @@ export interface unmarshallOptions {
      * This allows for the safe round-trip transport of numbers of arbitrary size.
      */
     wrapNumbers?: boolean;
+    /**
+     * When true, skip wrapping the data in `{ M: data }` before converting.
+     *
+     * Default is true when using the DynamoDBDocumentClient,
+     * but false if directly using the unmarshall function (backwards compatibility).
+     */
+    convertWithoutMapWrapper?: boolean;
 }
 /**
  * Convert a DynamoDB record into a JavaScript object.
  *
- * @param {any} data - The DynamoDB record
- * @param {unmarshallOptions} options - An optional configuration object for `unmarshall`
+ * @param data - The DynamoDB record
+ * @param options - An optional configuration object for `unmarshall`
  */
-export declare const unmarshall: (data: Record<string, AttributeValue>, options?: unmarshallOptions) => Record<string, NativeAttributeValue>;
+export declare const unmarshall: (data: Record<string, AttributeValue> | AttributeValue, options?: unmarshallOptions) => Record<string, NativeAttributeValue>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-sdk/util-dynamodb",
-  "version": "3.427.0",
+  "version": "3.428.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -24,7 +24,7 @@
     "tslib": "^2.5.0"
   },
   "devDependencies": {
-    "@aws-sdk/client-dynamodb": "3.427.0",
+    "@aws-sdk/client-dynamodb": "3.428.0",
     "@tsconfig/recommended": "1.0.1",
     "concurrently": "7.0.0",
     "downlevel-dts": "0.10.1",