@infra-blocks/aws-dynamodb 0.73.0 → 0.74.0

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

@@ -2,14 +2,42 @@ import type { UpdateCommandInput as NativeUpdateCommandInput } from "@aws-sdk/li
 import type { WithRequired } from "@infra-blocks/types";
 import type { KeyAttributes } from "../../types.js";
 import { type ConditionInput, type UpdateInput } from "../expressions/index.js";
-import type { ConditionCheckFailureReturnValue } from "./lib.js";
+import type { ConditionCheckFailureReturnValue, ConsumedCapacityReturnValue } from "./lib.js";
+export type UpdateItemConsumedCapacityReturnValue = ConsumedCapacityReturnValue;
 export type UpdateItemReturnValue = "NONE" | "ALL_OLD" | "UPDATED_OLD" | "ALL_NEW" | "UPDATED_NEW";
+export declare const UPDATE_ITEM_RETURN_VALUES: ReadonlyArray<UpdateItemReturnValue>;
 export interface UpdateItemInput<K extends KeyAttributes = KeyAttributes> {
+    /**
+     * The table name of the updated item.
+     */
     table: string;
+    /**
+     * The primary key values of the item to update.
+     *
+     * This should always include at least the partition key, and the sort key if one
+     * is part of the table's primary key. No more than 2 fields are expected here.
+     */
     key: K;
+    /**
+     * The update expression of the operation.
+     */
     update: UpdateInput;
+    /**
+     * A condition expression for the operation, if any.
+     */
     condition?: ConditionInput;
+    /**
+     * The requested consumed capacity metrics on return. Defaults to "NONE".
+     */
+    returnConsumedCapacity?: UpdateItemConsumedCapacityReturnValue;
+    /**
+     * The requested return values. Defaults to "NONE".
+     */
     returnValues?: UpdateItemReturnValue;
+    /**
+     * The values to store the item in a {@link ConditionalCheckFailureException} when one
+     * is thrown. Defaults to "NONE".
+     */
     returnValuesOnConditionCheckFailure?: ConditionCheckFailureReturnValue;
 }
 export declare const UpdateItemInput: {

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

@@ -1,30 +1,31 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UpdateItemInput = void 0;
+exports.UpdateItemInput = exports.UPDATE_ITEM_RETURN_VALUES = 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.UPDATE_ITEM_RETURN_VALUES = [
+    "NONE",
+    "ALL_OLD",
+    "UPDATED_OLD",
+    "ALL_NEW",
+    "UPDATED_NEW",
+];
 exports.UpdateItemInput = {
     encode,
 };
 function encode(input) {
-    const formatter = lib_js_1.ExpressionsFormatter.create();
-    const result = {
+    const formatter = lib_js_2.ExpressionsFormatter.create();
+    return (0, lib_js_1.unsetUndefined)({
         TableName: input.table,
         Key: input.key,
         UpdateExpression: formatter.format(index_js_1.Update.from(input.update)),
-    };
-    if (input.returnValues != null) {
-        result.ReturnValues = input.returnValues;
-    }
-    if (input.returnValuesOnConditionCheckFailure != null) {
-        result.ReturnValuesOnConditionCheckFailure =
-            input.returnValuesOnConditionCheckFailure;
-    }
-    if (input.condition != null) {
-        result.ConditionExpression = formatter.format(index_js_1.Condition.from(input.condition));
-    }
-    result.ExpressionAttributeNames = formatter.getExpressionAttributeNames();
-    result.ExpressionAttributeValues = formatter.getExpressionAttributeValues();
-    return result;
+        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=update-item.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"update-item.js","sourceRoot":"","sources":["../../../../src/commands/inputs/update-item.ts"],"names":[],"mappings":";;;AAGA,sDAKiC;AAEjC,qCAAgD;AAmBnC,QAAA,eAAe,GAAG;IAC7B,MAAM;CACP,CAAC;AAEF,SAAS,MAAM,CACb,KAAyB;IAEzB,MAAM,SAAS,GAAG,6BAAoB,CAAC,MAAM,EAAE,CAAC;IAChD,MAAM,MAAM,GAAuB;QACjC,SAAS,EAAE,KAAK,CAAC,KAAK;QACtB,GAAG,EAAE,KAAK,CAAC,GAAG;QACd,gBAAgB,EAAE,SAAS,CAAC,MAAM,CAAC,iBAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;KAC9D,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,IAAI,KAAK,CAAC,SAAS,IAAI,IAAI,EAAE,CAAC;QAC5B,MAAM,CAAC,mBAAmB,GAAG,SAAS,CAAC,MAAM,CAC3C,oBAAS,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAChC,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,wBAAwB,GAAG,SAAS,CAAC,2BAA2B,EAAE,CAAC;IAC1E,MAAM,CAAC,yBAAyB,GAAG,SAAS,CAAC,4BAA4B,EAAE,CAAC;IAC5E,OAAO,MAAM,CAAC;AAChB,CAAC"}
+{"version":3,"file":"update-item.js","sourceRoot":"","sources":["../../../../src/commands/inputs/update-item.ts"],"names":[],"mappings":";;;AAGA,sDAKiC;AACjC,sCAAsD;AAKtD,qCAAgD;AAWnC,QAAA,yBAAyB,GAAyC;IAC7E,MAAM;IACN,SAAS;IACT,aAAa;IACb,SAAS;IACT,aAAa;CACd,CAAC;AAqCW,QAAA,eAAe,GAAG;IAC7B,MAAM;CACP,CAAC;AAEF,SAAS,MAAM,CACb,KAAyB;IAEzB,MAAM,SAAS,GAAG,6BAAoB,CAAC,MAAM,EAAE,CAAC;IAChD,OAAO,IAAA,uBAAc,EAAC;QACpB,SAAS,EAAE,KAAK,CAAC,KAAK;QACtB,GAAG,EAAE,KAAK,CAAC,GAAG;QACd,gBAAgB,EAAE,SAAS,CAAC,MAAM,CAAC,iBAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC7D,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/update-item.d.ts

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

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

@@ -3,12 +3,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.UpdateItemOutput = 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.UpdateItemOutput = {
     decode,
 };
 function decode(output) {
     return (0, lib_js_1.unsetUndefined)({
         attributes: (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=update-item.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"update-item.js","sourceRoot":"","sources":["../../../../src/commands/outputs/update-item.ts"],"names":[],"mappings":";;;AACA,+CAA8C;AAE9C,sCAAsD;AAMzC,QAAA,gBAAgB,GAAG;IAC9B,MAAM;CACP,CAAC;AAEF,SAAS,MAAM,CACb,MAA2B;IAE3B,OAAO,IAAA,uBAAc,EAAC;QACpB,UAAU,EAAE,IAAA,kBAAS,EAAC,MAAM,CAAC,UAAU,EAAE,CAAA,eAAU,CAAA,CAAC;KACrD,CAAC,CAAC;AACL,CAAC"}
+{"version":3,"file":"update-item.js","sourceRoot":"","sources":["../../../../src/commands/outputs/update-item.ts"],"names":[],"mappings":";;;AACA,+CAA8C;AAE9C,sCAAsD;AACtD,iEAA0D;AAO7C,QAAA,gBAAgB,GAAG;IAC9B,MAAM;CACP,CAAC;AAEF,SAAS,MAAM,CACb,MAA2B;IAE3B,OAAO,IAAA,uBAAc,EAAC;QACpB,UAAU,EAAE,IAAA,kBAAS,EAAC,MAAM,CAAC,UAAU,EAAE,CAAA,eAAU,CAAA,CAAC;QACpD,gBAAgB,EAAE,IAAA,kBAAS,EACzB,MAAM,CAAC,gBAAgB,EACvB,uCAAgB,CAAC,MAAM,CACxB;KACF,CAAC,CAAC;AACL,CAAC"}

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

@@ -2,14 +2,42 @@ import type { UpdateCommandInput as NativeUpdateCommandInput } from "@aws-sdk/li
 import type { WithRequired } from "@infra-blocks/types";
 import type { KeyAttributes } from "../../types.js";
 import { type ConditionInput, type UpdateInput } from "../expressions/index.js";
-import type { ConditionCheckFailureReturnValue } from "./lib.js";
+import type { ConditionCheckFailureReturnValue, ConsumedCapacityReturnValue } from "./lib.js";
+export type UpdateItemConsumedCapacityReturnValue = ConsumedCapacityReturnValue;
 export type UpdateItemReturnValue = "NONE" | "ALL_OLD" | "UPDATED_OLD" | "ALL_NEW" | "UPDATED_NEW";
+export declare const UPDATE_ITEM_RETURN_VALUES: ReadonlyArray<UpdateItemReturnValue>;
 export interface UpdateItemInput<K extends KeyAttributes = KeyAttributes> {
+    /**
+     * The table name of the updated item.
+     */
     table: string;
+    /**
+     * The primary key values of the item to update.
+     *
+     * This should always include at least the partition key, and the sort key if one
+     * is part of the table's primary key. No more than 2 fields are expected here.
+     */
     key: K;
+    /**
+     * The update expression of the operation.
+     */
     update: UpdateInput;
+    /**
+     * A condition expression for the operation, if any.
+     */
     condition?: ConditionInput;
+    /**
+     * The requested consumed capacity metrics on return. Defaults to "NONE".
+     */
+    returnConsumedCapacity?: UpdateItemConsumedCapacityReturnValue;
+    /**
+     * The requested return values. Defaults to "NONE".
+     */
     returnValues?: UpdateItemReturnValue;
+    /**
+     * The values to store the item in a {@link ConditionalCheckFailureException} when one
+     * is thrown. Defaults to "NONE".
+     */
     returnValuesOnConditionCheckFailure?: ConditionCheckFailureReturnValue;
 }
 export declare const UpdateItemInput: {

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

@@ -1,27 +1,28 @@
 import { Condition, Update, } from "../expressions/index.js";
+import { ifDefined, unsetUndefined } from "../lib.js";
 import { ExpressionsFormatter } from "./lib.js";
+export const UPDATE_ITEM_RETURN_VALUES = [
+    "NONE",
+    "ALL_OLD",
+    "UPDATED_OLD",
+    "ALL_NEW",
+    "UPDATED_NEW",
+];
 export const UpdateItemInput = {
     encode,
 };
 function encode(input) {
     const formatter = ExpressionsFormatter.create();
-    const result = {
+    return unsetUndefined({
         TableName: input.table,
         Key: input.key,
         UpdateExpression: formatter.format(Update.from(input.update)),
-    };
-    if (input.returnValues != null) {
-        result.ReturnValues = input.returnValues;
-    }
-    if (input.returnValuesOnConditionCheckFailure != null) {
-        result.ReturnValuesOnConditionCheckFailure =
-            input.returnValuesOnConditionCheckFailure;
-    }
-    if (input.condition != null) {
-        result.ConditionExpression = formatter.format(Condition.from(input.condition));
-    }
-    result.ExpressionAttributeNames = formatter.getExpressionAttributeNames();
-    result.ExpressionAttributeValues = formatter.getExpressionAttributeValues();
-    return result;
+        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=update-item.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"update-item.js","sourceRoot":"","sources":["../../../../src/commands/inputs/update-item.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,SAAS,EAET,MAAM,GAEP,MAAM,yBAAyB,CAAC;AAEjC,OAAO,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAmBhD,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,MAAM;CACP,CAAC;AAEF,SAAS,MAAM,CACb,KAAyB;IAEzB,MAAM,SAAS,GAAG,oBAAoB,CAAC,MAAM,EAAE,CAAC;IAChD,MAAM,MAAM,GAAuB;QACjC,SAAS,EAAE,KAAK,CAAC,KAAK;QACtB,GAAG,EAAE,KAAK,CAAC,GAAG;QACd,gBAAgB,EAAE,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;KAC9D,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,IAAI,KAAK,CAAC,SAAS,IAAI,IAAI,EAAE,CAAC;QAC5B,MAAM,CAAC,mBAAmB,GAAG,SAAS,CAAC,MAAM,CAC3C,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAChC,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,wBAAwB,GAAG,SAAS,CAAC,2BAA2B,EAAE,CAAC;IAC1E,MAAM,CAAC,yBAAyB,GAAG,SAAS,CAAC,4BAA4B,EAAE,CAAC;IAC5E,OAAO,MAAM,CAAC;AAChB,CAAC"}
+{"version":3,"file":"update-item.js","sourceRoot":"","sources":["../../../../src/commands/inputs/update-item.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,SAAS,EAET,MAAM,GAEP,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAKtD,OAAO,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAWhD,MAAM,CAAC,MAAM,yBAAyB,GAAyC;IAC7E,MAAM;IACN,SAAS;IACT,aAAa;IACb,SAAS;IACT,aAAa;CACd,CAAC;AAqCF,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,MAAM;CACP,CAAC;AAEF,SAAS,MAAM,CACb,KAAyB;IAEzB,MAAM,SAAS,GAAG,oBAAoB,CAAC,MAAM,EAAE,CAAC;IAChD,OAAO,cAAc,CAAC;QACpB,SAAS,EAAE,KAAK,CAAC,KAAK;QACtB,GAAG,EAAE,KAAK,CAAC,GAAG;QACd,gBAAgB,EAAE,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC7D,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/update-item.d.ts

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

package/lib/esm/commands/outputs/update-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 UpdateItemOutput = {
     decode,
 };
 function decode(output) {
     return unsetUndefined({
         attributes: ifDefined(output.Attributes, (trusted)),
+        consumedCapacity: ifDefined(output.ConsumedCapacity, ConsumedCapacity.decode),
     });
 }
 //# sourceMappingURL=update-item.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"update-item.js","sourceRoot":"","sources":["../../../../src/commands/outputs/update-item.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAE9C,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAMtD,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,MAAM;CACP,CAAC;AAEF,SAAS,MAAM,CACb,MAA2B;IAE3B,OAAO,cAAc,CAAC;QACpB,UAAU,EAAE,SAAS,CAAC,MAAM,CAAC,UAAU,EAAE,CAAA,OAAU,CAAA,CAAC;KACrD,CAAC,CAAC;AACL,CAAC"}
+{"version":3,"file":"update-item.js","sourceRoot":"","sources":["../../../../src/commands/outputs/update-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,gBAAgB,GAAG;IAC9B,MAAM;CACP,CAAC;AAEF,SAAS,MAAM,CACb,MAA2B;IAE3B,OAAO,cAAc,CAAC;QACpB,UAAU,EAAE,SAAS,CAAC,MAAM,CAAC,UAAU,EAAE,CAAA,OAAU,CAAA,CAAC;QACpD,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.73.0",
+  "version": "0.74.0",
   "description": "A convenience wrapper over @aws-sdk/client-dynamodb and @aws-sdk/lib-dynamodb.",
   "keywords": [
     "aws",