@lafken/dynamo 0.10.6 → 0.11.0

package/lib/service/query-builder/query-builder.types.d.ts

@@ -222,6 +222,20 @@ export interface UpdateProps<E extends Function> extends UpsertProps<E> {
      * }
      */
     removeValues?: ObjectToBoolean<Item<E>>;
+    /**
+     * Specifies what DynamoDB should return after the update operation completes.
+     *
+     * - `'all_new'` — Returns all attributes of the item as they appear after the update.
+     * - `'updated_new'` — Returns only the attributes that were updated, with their new values.
+     * - `'all_old'` — Returns all attributes of the item as they appeared before the update.
+     * - `'none'` — Does not return any attribute values.
+     *
+     * @example
+     * {
+     *   returnValue: 'all_new'
+     * }
+     */
+    returnValue?: 'all_new' | 'updated_new' | 'all_old' | 'none';
 }
 export interface UpsertProps<E extends Function> {
     /**

package/lib/service/query-builder/update/update.d.ts

@@ -1,13 +1,14 @@
 import { type UpdateItemCommandInput } from '@aws-sdk/client-dynamodb';
 import type { ClassResource } from '@lafken/common';
 import { QueryBuilderBase } from '../base/base';
+import type { Item } from '../query-builder.types';
 import type { UpdateBuilderProps } from './update.types';
 export declare class UpdateBuilder<E extends ClassResource> extends QueryBuilderBase<E> {
     protected queryOptions: UpdateBuilderProps<E>;
     protected command: UpdateItemCommandInput;
     constructor(queryOptions: UpdateBuilderProps<E>);
     getCommand(): UpdateItemCommandInput;
-    then<T>(resolve: (value: boolean) => T, reject: (reason: any) => T): Promise<T>;
+    then<T>(resolve: (value: Partial<Item<E>> | undefined) => Item<E>, reject: (reason: any) => T): Promise<T>;
     private exec;
     protected prepare(): void;
     private setValues;

package/lib/service/query-builder/update/update.js

@@ -21,8 +21,12 @@ class UpdateBuilder extends base_1.QueryBuilderBase {
     }
     async exec() {
         const command = new client_dynamodb_1.UpdateItemCommand(this.command);
-        await this.queryOptions.client.send(command);
-        return true;
+        const response = await this.queryOptions.client.send(command);
+        if (!response?.Attributes ||
+            ['none', undefined].includes(this.queryOptions.inputProps.returnValue)) {
+            return undefined;
+        }
+        return (0, util_dynamodb_1.unmarshall)(response?.Attributes);
     }
     prepare() {
         const { removeValues = {}, replaceValues = {}, setValues = {}, condition, } = this.queryOptions.inputProps;
@@ -43,6 +47,9 @@ class UpdateBuilder extends base_1.QueryBuilderBase {
             UpdateExpression: `${setExpression ? `SET ${setExpression}` : ''} ${removeExpression ? `REMOVE ${removeExpression}` : ''}`.trim(),
             ...this.getAttributesAndNames(),
             ConditionExpression: condition ? this.getFilterExpression(condition) : undefined,
+            ReturnValues: this.queryOptions.inputProps.returnValue
+                ? this.queryOptions.inputProps.returnValue.toUpperCase()
+                : undefined,
         };
     }
     setValues(values, isDeepReplace, names = [], counter = 0) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lafken/dynamo",
-  "version": "0.10.6",
+  "version": "0.11.0",
   "private": false,
   "description": "Define DynamoDB tables using TypeScript decorators - type-safe, declarative infrastructure with Lafken",
   "keywords": [
@@ -60,7 +60,7 @@
     "@aws-sdk/util-dynamodb": "^3.996.2",
     "aws-xray-sdk": "^3.12.0",
     "reflect-metadata": "^0.2.2",
-    "@lafken/resolver": "0.10.6"
+    "@lafken/resolver": "0.11.0"
   },
   "devDependencies": {
     "@cdktn/provider-aws": "^23.5.0",
@@ -75,13 +75,13 @@
     "typescript": "6.0.2",
     "unplugin-swc": "^1.5.9",
     "vitest": "^4.1.2",
-    "@lafken/common": "0.10.6"
+    "@lafken/common": "0.11.0"
   },
   "peerDependencies": {
     "@cdktn/provider-aws": ">=23.0.0",
     "cdktn": ">=0.22.0",
     "constructs": "^10.4.5",
-    "@lafken/common": "0.10.6"
+    "@lafken/common": "0.11.0"
   },
   "engines": {
     "node": ">=20.19"