@infra-blocks/aws-dynamodb 0.72.0 → 0.73.0

package/lib/cjs/commands/inputs/delete-item.d.ts

@@ -17,7 +17,7 @@ export type DeleteItemInput<K extends KeyAttributes = KeyAttributes> = {
      */
     key: K;
     /**
-     * A condition expression for the operation.
+     * A condition expression for the operation, if any.
      */
     condition?: ConditionInput;
     /**
@@ -25,12 +25,12 @@ export type DeleteItemInput<K extends KeyAttributes = KeyAttributes> = {
      */
     returnConsumedCapacity?: DeleteItemConsumedCapacityReturnValue;
     /**
-     * The requested return value, if any.
+     * The requested return values, if any. Defaults to "NONE".
      */
     returnValues?: DeleteItemReturnValue;
     /**
      * Whether to store the item in a {@link ConditionalCheckFailureException} when one
-     * is thrown.
+     * is thrown. Defaults to "NONE".
      */
     returnValuesOnConditionCheckFailure?: ConditionCheckFailureReturnValue;
 };

package/lib/cjs/commands/inputs/put-item.d.ts

@@ -1,18 +1,36 @@
 import type { PutCommandInput } from "@aws-sdk/lib-dynamodb";
 import type { Attributes } from "../../types.js";
 import { type ConditionInput } from "../expressions/index.js";
-import type { ConditionCheckFailureReturnValue } from "./lib.js";
+import type { ConditionCheckFailureReturnValue, ConsumedCapacityReturnValue } from "./lib.js";
+export type PutItemConsumedCapacityReturnValue = ConsumedCapacityReturnValue;
 export type PutItemReturnValue = ConditionCheckFailureReturnValue;
 export type PutItemInput<T extends Attributes = Attributes> = {
+    /**
+     * The table where the item will be stored located.
+     */
     table: string;
+    /**
+     * The item in question.
+     */
     item: T;
+    /**
+     * A condition expression for the operation, if any.
+     */
     condition?: ConditionInput;
+    /**
+     * The requested consumed capacity metrics on return, if any.
+     */
+    returnConsumedCapacity?: PutItemConsumedCapacityReturnValue;
+    /**
+     * The requested return values, if any. Defaults to "NONE".
+     */
     returnValues?: PutItemReturnValue;
+    /**
+     * Whether to store the item in a {@link ConditionalCheckFailureException} when one
+     * is thrown. Defaults to "NONE".
+     */
     returnValuesOnConditionCheckFailure?: ConditionCheckFailureReturnValue;
 };
-export type PutItemResult<T extends Attributes> = {
-    item?: T;
-};
 export declare const PutItemInput: {
     encode: typeof encode;
 };

package/lib/cjs/commands/inputs/put-item.js

@@ -2,33 +2,22 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PutItemInput = void 0;
 const index_js_1 = require("../expressions/index.js");
-const lib_js_1 = require("./lib.js");
+const lib_js_1 = require("../lib.js");
+const lib_js_2 = require("./lib.js");
 exports.PutItemInput = {
     encode,
 };
 function encode(input) {
-    const result = {
+    const formatter = lib_js_2.ExpressionsFormatter.create();
+    return (0, lib_js_1.unsetUndefined)({
         TableName: input.table,
         Item: input.item,
-    };
-    if (input.returnValues != null) {
-        result.ReturnValues = input.returnValues;
-    }
-    if (input.returnValuesOnConditionCheckFailure != null) {
-        result.ReturnValuesOnConditionCheckFailure =
-            input.returnValuesOnConditionCheckFailure;
-    }
-    // Expression attribute names and values can only be specified when a condition is provided,
-    // which is optional.
-    if (input.condition == null) {
-        return result;
-    }
-    const formatter = lib_js_1.ExpressionsFormatter.create();
-    return {
-        ...result,
-        ConditionExpression: formatter.format(index_js_1.Condition.from(input.condition)),
+        ConditionExpression: (0, lib_js_1.ifDefined)(input.condition, (v) => formatter.format(index_js_1.Condition.from(v))),
         ExpressionAttributeNames: formatter.getExpressionAttributeNames(),
         ExpressionAttributeValues: formatter.getExpressionAttributeValues(),
-    };
+        ReturnConsumedCapacity: input.returnConsumedCapacity,
+        ReturnValues: input.returnValues,
+        ReturnValuesOnConditionCheckFailure: input.returnValuesOnConditionCheckFailure,
+    });
 }
 //# sourceMappingURL=put-item.js.map

package/lib/cjs/commands/inputs/put-item.js.map

@@ -1 +1 @@
-{"version":3,"file":"put-item.js","sourceRoot":"","sources":["../../../../src/commands/inputs/put-item.ts"],"names":[],"mappings":";;;AAEA,sDAAyE;AAEzE,qCAAgD;AAgBnC,QAAA,YAAY,GAAG;IAC1B,MAAM;CACP,CAAC;AAEF,SAAS,MAAM,CACb,KAAsB;IAEtB,MAAM,MAAM,GAAoB;QAC9B,SAAS,EAAE,KAAK,CAAC,KAAK;QACtB,IAAI,EAAE,KAAK,CAAC,IAAI;KACjB,CAAC;IAEF,IAAI,KAAK,CAAC,YAAY,IAAI,IAAI,EAAE,CAAC;QAC/B,MAAM,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC;IAC3C,CAAC;IAED,IAAI,KAAK,CAAC,mCAAmC,IAAI,IAAI,EAAE,CAAC;QACtD,MAAM,CAAC,mCAAmC;YACxC,KAAK,CAAC,mCAAmC,CAAC;IAC9C,CAAC;IAED,4FAA4F;IAC5F,qBAAqB;IACrB,IAAI,KAAK,CAAC,SAAS,IAAI,IAAI,EAAE,CAAC;QAC5B,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,MAAM,SAAS,GAAG,6BAAoB,CAAC,MAAM,EAAE,CAAC;IAChD,OAAO;QACL,GAAG,MAAM;QACT,mBAAmB,EAAE,SAAS,CAAC,MAAM,CAAC,oBAAS,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACtE,wBAAwB,EAAE,SAAS,CAAC,2BAA2B,EAAE;QACjE,yBAAyB,EAAE,SAAS,CAAC,4BAA4B,EAAE;KACpE,CAAC;AACJ,CAAC"}
+{"version":3,"file":"put-item.js","sourceRoot":"","sources":["../../../../src/commands/inputs/put-item.ts"],"names":[],"mappings":";;;AAEA,sDAAyE;AACzE,sCAAsD;AAKtD,qCAAgD;AAkCnC,QAAA,YAAY,GAAG;IAC1B,MAAM;CACP,CAAC;AAEF,SAAS,MAAM,CACb,KAAsB;IAEtB,MAAM,SAAS,GAAG,6BAAoB,CAAC,MAAM,EAAE,CAAC;IAChD,OAAO,IAAA,uBAAc,EAAC;QACpB,SAAS,EAAE,KAAK,CAAC,KAAK;QACtB,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,mBAAmB,EAAE,IAAA,kBAAS,EAAC,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC,EAAE,EAAE,CACpD,SAAS,CAAC,MAAM,CAAC,oBAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CACpC;QACD,wBAAwB,EAAE,SAAS,CAAC,2BAA2B,EAAE;QACjE,yBAAyB,EAAE,SAAS,CAAC,4BAA4B,EAAE;QACnE,sBAAsB,EAAE,KAAK,CAAC,sBAAsB;QACpD,YAAY,EAAE,KAAK,CAAC,YAAY;QAChC,mCAAmC,EACjC,KAAK,CAAC,mCAAmC;KAC5C,CAAC,CAAC;AACL,CAAC"}

package/lib/cjs/commands/outputs/put-item.d.ts

@@ -1,7 +1,9 @@
 import type { PutCommandOutput } from "@aws-sdk/lib-dynamodb";
 import type { Attributes } from "../../types.js";
+import { ConsumedCapacity } from "./consumed-capacity.js";
 export type PutItemOutput<T extends Attributes = Attributes> = {
     item?: T;
+    consumedCapacity?: ConsumedCapacity;
 };
 export declare const PutItemOutput: {
     decode: typeof decode;

package/lib/cjs/commands/outputs/put-item.js

@@ -3,12 +3,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PutItemOutput = void 0;
 const types_1 = require("@infra-blocks/types");
 const lib_js_1 = require("../lib.js");
+const consumed_capacity_js_1 = require("./consumed-capacity.js");
 exports.PutItemOutput = {
     decode,
 };
 function decode(output) {
     return (0, lib_js_1.unsetUndefined)({
         item: (0, lib_js_1.ifDefined)(output.Attributes, (types_1.trusted)),
+        consumedCapacity: (0, lib_js_1.ifDefined)(output.ConsumedCapacity, consumed_capacity_js_1.ConsumedCapacity.decode),
     });
 }
 //# sourceMappingURL=put-item.js.map

package/lib/cjs/commands/outputs/put-item.js.map

@@ -1 +1 @@
-{"version":3,"file":"put-item.js","sourceRoot":"","sources":["../../../../src/commands/outputs/put-item.ts"],"names":[],"mappings":";;;AACA,+CAA8C;AAE9C,sCAAsD;AAKzC,QAAA,aAAa,GAAG;IAC3B,MAAM;CACP,CAAC;AAEF,SAAS,MAAM,CACb,MAAwB;IAExB,OAAO,IAAA,uBAAc,EAAC;QACpB,IAAI,EAAE,IAAA,kBAAS,EAAC,MAAM,CAAC,UAAU,EAAE,CAAA,eAAU,CAAA,CAAC;KAC/C,CAAC,CAAC;AACL,CAAC"}
+{"version":3,"file":"put-item.js","sourceRoot":"","sources":["../../../../src/commands/outputs/put-item.ts"],"names":[],"mappings":";;;AACA,+CAA8C;AAE9C,sCAAsD;AACtD,iEAA0D;AAO7C,QAAA,aAAa,GAAG;IAC3B,MAAM;CACP,CAAC;AAEF,SAAS,MAAM,CACb,MAAwB;IAExB,OAAO,IAAA,uBAAc,EAAC;QACpB,IAAI,EAAE,IAAA,kBAAS,EAAC,MAAM,CAAC,UAAU,EAAE,CAAA,eAAU,CAAA,CAAC;QAC9C,gBAAgB,EAAE,IAAA,kBAAS,EACzB,MAAM,CAAC,gBAAgB,EACvB,uCAAgB,CAAC,MAAM,CACxB;KACF,CAAC,CAAC;AACL,CAAC"}

package/lib/esm/commands/inputs/delete-item.d.ts

@@ -17,7 +17,7 @@ export type DeleteItemInput<K extends KeyAttributes = KeyAttributes> = {
      */
     key: K;
     /**
-     * A condition expression for the operation.
+     * A condition expression for the operation, if any.
      */
     condition?: ConditionInput;
     /**
@@ -25,12 +25,12 @@ export type DeleteItemInput<K extends KeyAttributes = KeyAttributes> = {
      */
     returnConsumedCapacity?: DeleteItemConsumedCapacityReturnValue;
     /**
-     * The requested return value, if any.
+     * The requested return values, if any. Defaults to "NONE".
      */
     returnValues?: DeleteItemReturnValue;
     /**
      * Whether to store the item in a {@link ConditionalCheckFailureException} when one
-     * is thrown.
+     * is thrown. Defaults to "NONE".
      */
     returnValuesOnConditionCheckFailure?: ConditionCheckFailureReturnValue;
 };

package/lib/esm/commands/inputs/put-item.d.ts

@@ -1,18 +1,36 @@
 import type { PutCommandInput } from "@aws-sdk/lib-dynamodb";
 import type { Attributes } from "../../types.js";
 import { type ConditionInput } from "../expressions/index.js";
-import type { ConditionCheckFailureReturnValue } from "./lib.js";
+import type { ConditionCheckFailureReturnValue, ConsumedCapacityReturnValue } from "./lib.js";
+export type PutItemConsumedCapacityReturnValue = ConsumedCapacityReturnValue;
 export type PutItemReturnValue = ConditionCheckFailureReturnValue;
 export type PutItemInput<T extends Attributes = Attributes> = {
+    /**
+     * The table where the item will be stored located.
+     */
     table: string;
+    /**
+     * The item in question.
+     */
     item: T;
+    /**
+     * A condition expression for the operation, if any.
+     */
     condition?: ConditionInput;
+    /**
+     * The requested consumed capacity metrics on return, if any.
+     */
+    returnConsumedCapacity?: PutItemConsumedCapacityReturnValue;
+    /**
+     * The requested return values, if any. Defaults to "NONE".
+     */
     returnValues?: PutItemReturnValue;
+    /**
+     * Whether to store the item in a {@link ConditionalCheckFailureException} when one
+     * is thrown. Defaults to "NONE".
+     */
     returnValuesOnConditionCheckFailure?: ConditionCheckFailureReturnValue;
 };
-export type PutItemResult<T extends Attributes> = {
-    item?: T;
-};
 export declare const PutItemInput: {
     encode: typeof encode;
 };

package/lib/esm/commands/inputs/put-item.js

@@ -1,31 +1,20 @@
 import { Condition } from "../expressions/index.js";
+import { ifDefined, unsetUndefined } from "../lib.js";
 import { ExpressionsFormatter } from "./lib.js";
 export const PutItemInput = {
     encode,
 };
 function encode(input) {
-    const result = {
+    const formatter = ExpressionsFormatter.create();
+    return unsetUndefined({
         TableName: input.table,
         Item: input.item,
-    };
-    if (input.returnValues != null) {
-        result.ReturnValues = input.returnValues;
-    }
-    if (input.returnValuesOnConditionCheckFailure != null) {
-        result.ReturnValuesOnConditionCheckFailure =
-            input.returnValuesOnConditionCheckFailure;
-    }
-    // Expression attribute names and values can only be specified when a condition is provided,
-    // which is optional.
-    if (input.condition == null) {
-        return result;
-    }
-    const formatter = ExpressionsFormatter.create();
-    return {
-        ...result,
-        ConditionExpression: formatter.format(Condition.from(input.condition)),
+        ConditionExpression: ifDefined(input.condition, (v) => formatter.format(Condition.from(v))),
         ExpressionAttributeNames: formatter.getExpressionAttributeNames(),
         ExpressionAttributeValues: formatter.getExpressionAttributeValues(),
-    };
+        ReturnConsumedCapacity: input.returnConsumedCapacity,
+        ReturnValues: input.returnValues,
+        ReturnValuesOnConditionCheckFailure: input.returnValuesOnConditionCheckFailure,
+    });
 }
 //# sourceMappingURL=put-item.js.map

package/lib/esm/commands/inputs/put-item.js.map

@@ -1 +1 @@
-{"version":3,"file":"put-item.js","sourceRoot":"","sources":["../../../../src/commands/inputs/put-item.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAuB,MAAM,yBAAyB,CAAC;AAEzE,OAAO,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAgBhD,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,MAAM;CACP,CAAC;AAEF,SAAS,MAAM,CACb,KAAsB;IAEtB,MAAM,MAAM,GAAoB;QAC9B,SAAS,EAAE,KAAK,CAAC,KAAK;QACtB,IAAI,EAAE,KAAK,CAAC,IAAI;KACjB,CAAC;IAEF,IAAI,KAAK,CAAC,YAAY,IAAI,IAAI,EAAE,CAAC;QAC/B,MAAM,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC;IAC3C,CAAC;IAED,IAAI,KAAK,CAAC,mCAAmC,IAAI,IAAI,EAAE,CAAC;QACtD,MAAM,CAAC,mCAAmC;YACxC,KAAK,CAAC,mCAAmC,CAAC;IAC9C,CAAC;IAED,4FAA4F;IAC5F,qBAAqB;IACrB,IAAI,KAAK,CAAC,SAAS,IAAI,IAAI,EAAE,CAAC;QAC5B,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,MAAM,SAAS,GAAG,oBAAoB,CAAC,MAAM,EAAE,CAAC;IAChD,OAAO;QACL,GAAG,MAAM;QACT,mBAAmB,EAAE,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACtE,wBAAwB,EAAE,SAAS,CAAC,2BAA2B,EAAE;QACjE,yBAAyB,EAAE,SAAS,CAAC,4BAA4B,EAAE;KACpE,CAAC;AACJ,CAAC"}
+{"version":3,"file":"put-item.js","sourceRoot":"","sources":["../../../../src/commands/inputs/put-item.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAuB,MAAM,yBAAyB,CAAC;AACzE,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAKtD,OAAO,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAkChD,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,MAAM;CACP,CAAC;AAEF,SAAS,MAAM,CACb,KAAsB;IAEtB,MAAM,SAAS,GAAG,oBAAoB,CAAC,MAAM,EAAE,CAAC;IAChD,OAAO,cAAc,CAAC;QACpB,SAAS,EAAE,KAAK,CAAC,KAAK;QACtB,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,mBAAmB,EAAE,SAAS,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC,EAAE,EAAE,CACpD,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CACpC;QACD,wBAAwB,EAAE,SAAS,CAAC,2BAA2B,EAAE;QACjE,yBAAyB,EAAE,SAAS,CAAC,4BAA4B,EAAE;QACnE,sBAAsB,EAAE,KAAK,CAAC,sBAAsB;QACpD,YAAY,EAAE,KAAK,CAAC,YAAY;QAChC,mCAAmC,EACjC,KAAK,CAAC,mCAAmC;KAC5C,CAAC,CAAC;AACL,CAAC"}

package/lib/esm/commands/outputs/put-item.d.ts

@@ -1,7 +1,9 @@
 import type { PutCommandOutput } from "@aws-sdk/lib-dynamodb";
 import type { Attributes } from "../../types.js";
+import { ConsumedCapacity } from "./consumed-capacity.js";
 export type PutItemOutput<T extends Attributes = Attributes> = {
     item?: T;
+    consumedCapacity?: ConsumedCapacity;
 };
 export declare const PutItemOutput: {
     decode: typeof decode;

package/lib/esm/commands/outputs/put-item.js

@@ -1,11 +1,13 @@
 import { trusted } from "@infra-blocks/types";
 import { ifDefined, unsetUndefined } from "../lib.js";
+import { ConsumedCapacity } from "./consumed-capacity.js";
 export const PutItemOutput = {
     decode,
 };
 function decode(output) {
     return unsetUndefined({
         item: ifDefined(output.Attributes, (trusted)),
+        consumedCapacity: ifDefined(output.ConsumedCapacity, ConsumedCapacity.decode),
     });
 }
 //# sourceMappingURL=put-item.js.map

package/lib/esm/commands/outputs/put-item.js.map

@@ -1 +1 @@
-{"version":3,"file":"put-item.js","sourceRoot":"","sources":["../../../../src/commands/outputs/put-item.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAE9C,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAKtD,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,MAAM;CACP,CAAC;AAEF,SAAS,MAAM,CACb,MAAwB;IAExB,OAAO,cAAc,CAAC;QACpB,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC,UAAU,EAAE,CAAA,OAAU,CAAA,CAAC;KAC/C,CAAC,CAAC;AACL,CAAC"}
+{"version":3,"file":"put-item.js","sourceRoot":"","sources":["../../../../src/commands/outputs/put-item.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAE9C,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AACtD,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAO1D,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,MAAM;CACP,CAAC;AAEF,SAAS,MAAM,CACb,MAAwB;IAExB,OAAO,cAAc,CAAC;QACpB,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC,UAAU,EAAE,CAAA,OAAU,CAAA,CAAC;QAC9C,gBAAgB,EAAE,SAAS,CACzB,MAAM,CAAC,gBAAgB,EACvB,gBAAgB,CAAC,MAAM,CACxB;KACF,CAAC,CAAC;AACL,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@infra-blocks/aws-dynamodb",
-  "version": "0.72.0",
+  "version": "0.73.0",
   "description": "A convenience wrapper over @aws-sdk/client-dynamodb and @aws-sdk/lib-dynamodb.",
   "keywords": [
     "aws",