@infra-blocks/aws-dynamodb 0.63.0 → 0.64.0-alpha.1

package/lib/cjs/commands/expressions/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./condition/index.js";
 export * from "./key-condition.js";
 export * from "./operands/index.js";
+export * from "./projection.js";
 export * from "./update/index.js";

package/lib/cjs/commands/expressions/index.js

@@ -17,5 +17,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./condition/index.js"), exports);
 __exportStar(require("./key-condition.js"), exports);
 __exportStar(require("./operands/index.js"), exports);
+__exportStar(require("./projection.js"), exports);
 __exportStar(require("./update/index.js"), exports);
 //# sourceMappingURL=index.js.map

package/lib/cjs/commands/expressions/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/commands/expressions/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uDAAqC;AACrC,qDAAmC;AACnC,sDAAoC;AACpC,oDAAkC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/commands/expressions/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uDAAqC;AACrC,qDAAmC;AACnC,sDAAoC;AACpC,kDAAgC;AAChC,oDAAkC"}

package/lib/cjs/commands/expressions/projection.d.ts

@@ -0,0 +1,21 @@
+import type { AttributeNames } from "../attributes/names.js";
+import { type RawPath } from "./operands/index.js";
+export type ProjectionExpressionParams = ReadonlyArray<RawPath>;
+export type ProjectionExpression = {
+    stringify(params: {
+        names: AttributeNames;
+    }): string;
+};
+export declare const ProjectionExpression: {
+    /**
+     * Constructs a {@link ProjectionExpression} from the provided {@link ProjectionExpressionParams}.
+     *
+     * Note that an empty expression is an invalid value for the DynamoDB API. To catch this
+     * mistake earlier, this function will throw if the provided list of paths is empty.
+     *
+     * @param expressionParams - The list of paths to include in the projection expression.
+     *
+     * @returns The {@link ProjectionExpression} corresponding to the provided {@link ProjectionExpressionParams}.
+     */
+    from(expressionParams: ProjectionExpressionParams): ProjectionExpression;
+};

package/lib/cjs/commands/expressions/projection.js

@@ -0,0 +1,34 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProjectionExpression = void 0;
+const node_assert_1 = __importDefault(require("node:assert"));
+const index_js_1 = require("./operands/index.js");
+exports.ProjectionExpression = {
+    /**
+     * Constructs a {@link ProjectionExpression} from the provided {@link ProjectionExpressionParams}.
+     *
+     * Note that an empty expression is an invalid value for the DynamoDB API. To catch this
+     * mistake earlier, this function will throw if the provided list of paths is empty.
+     *
+     * @param expressionParams - The list of paths to include in the projection expression.
+     *
+     * @returns The {@link ProjectionExpression} corresponding to the provided {@link ProjectionExpressionParams}.
+     */
+    from(expressionParams) {
+        (0, node_assert_1.default)(expressionParams.length > 0, "expression params cannot be empty");
+        return {
+            stringify(stringifyParams) {
+                const { names } = stringifyParams;
+                const substitutions = [];
+                for (const path of expressionParams) {
+                    substitutions.push(index_js_1.Path.normalize(path).substitute({ names }));
+                }
+                return substitutions.join(",");
+            },
+        };
+    },
+};
+//# sourceMappingURL=projection.js.map

package/lib/cjs/commands/expressions/projection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"projection.js","sourceRoot":"","sources":["../../../../src/commands/expressions/projection.ts"],"names":[],"mappings":";;;;;;AAAA,8DAAiC;AAEjC,kDAAyD;AAQ5C,QAAA,oBAAoB,GAAG;IAClC;;;;;;;;;OASG;IACH,IAAI,CAAC,gBAA4C;QAC/C,IAAA,qBAAM,EAAC,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE,mCAAmC,CAAC,CAAC;QAEzE,OAAO;YACL,SAAS,CAAC,eAAe;gBACvB,MAAM,EAAE,KAAK,EAAE,GAAG,eAAe,CAAC;gBAClC,MAAM,aAAa,GAAG,EAAE,CAAC;gBACzB,KAAK,MAAM,IAAI,IAAI,gBAAgB,EAAE,CAAC;oBACpC,aAAa,CAAC,IAAI,CAAC,eAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;gBACjE,CAAC;gBACD,OAAO,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACjC,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC"}

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

@@ -1,5 +1,6 @@
 import type { GetCommandInput } from "@aws-sdk/lib-dynamodb";
 import type { KeyAttributes } from "../../types.js";
+import { type ProjectionExpressionParams } from "../expressions/projection.js";
 /**
  * The input required to call the GetItem API.
  */
@@ -15,6 +16,10 @@ export interface GetItemInput<K extends KeyAttributes = KeyAttributes> {
      * is part of the table's primary key. No more than 2 fields are expected here.
      */
     key: K;
+    /**
+     * The projection applied to the return item, if any.
+     */
+    projection?: ProjectionExpressionParams;
 }
 export declare const GetItemInput: {
     encode: typeof encode;

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

@@ -1,14 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GetItemInput = void 0;
+const names_js_1 = require("../attributes/names.js");
+const projection_js_1 = require("../expressions/projection.js");
 exports.GetItemInput = {
     encode,
 };
 function encode(input) {
-    const key = input.key;
-    return {
+    const result = {
         TableName: input.table,
-        Key: key,
+        Key: input.key,
     };
+    if (input.projection != null) {
+        // There should be no values.
+        const names = names_js_1.AttributeNames.create();
+        const expression = projection_js_1.ProjectionExpression.from(input.projection).stringify({
+            names,
+        });
+        result.ProjectionExpression = expression;
+        result.ExpressionAttributeNames = names.getSubstitutions();
+    }
+    return result;
 }
 //# sourceMappingURL=get-item.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"get-item.js","sourceRoot":"","sources":["../../../../src/commands/inputs/get-item.ts"],"names":[],"mappings":";;;AAoBa,QAAA,YAAY,GAAG;IAC1B,MAAM;CACP,CAAC;AAEF,SAAS,MAAM,CACb,KAAsB;IAEtB,MAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC;IACtB,OAAO;QACL,SAAS,EAAE,KAAK,CAAC,KAAK;QACtB,GAAG,EAAE,GAAG;KACT,CAAC;AACJ,CAAC"}
+{"version":3,"file":"get-item.js","sourceRoot":"","sources":["../../../../src/commands/inputs/get-item.ts"],"names":[],"mappings":";;;AAEA,qDAAwD;AACxD,gEAGsC;AAuBzB,QAAA,YAAY,GAAG;IAC1B,MAAM;CACP,CAAC;AAEF,SAAS,MAAM,CACb,KAAsB;IAEtB,MAAM,MAAM,GAAoB;QAC9B,SAAS,EAAE,KAAK,CAAC,KAAK;QACtB,GAAG,EAAE,KAAK,CAAC,GAAG;KACf,CAAC;IAEF,IAAI,KAAK,CAAC,UAAU,IAAI,IAAI,EAAE,CAAC;QAC7B,6BAA6B;QAC7B,MAAM,KAAK,GAAG,yBAAc,CAAC,MAAM,EAAE,CAAC;QACtC,MAAM,UAAU,GAAG,oCAAoB,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,SAAS,CAAC;YACvE,KAAK;SACN,CAAC,CAAC;QACH,MAAM,CAAC,oBAAoB,GAAG,UAAU,CAAC;QACzC,MAAM,CAAC,wBAAwB,GAAG,KAAK,CAAC,gBAAgB,EAAE,CAAC;IAC7D,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/lib/esm/commands/expressions/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./condition/index.js";
 export * from "./key-condition.js";
 export * from "./operands/index.js";
+export * from "./projection.js";
 export * from "./update/index.js";

package/lib/esm/commands/expressions/index.js

@@ -1,5 +1,6 @@
 export * from "./condition/index.js";
 export * from "./key-condition.js";
 export * from "./operands/index.js";
+export * from "./projection.js";
 export * from "./update/index.js";
 //# sourceMappingURL=index.js.map

package/lib/esm/commands/expressions/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/commands/expressions/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,mBAAmB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/commands/expressions/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC"}

package/lib/esm/commands/expressions/projection.d.ts

@@ -0,0 +1,21 @@
+import type { AttributeNames } from "../attributes/names.js";
+import { type RawPath } from "./operands/index.js";
+export type ProjectionExpressionParams = ReadonlyArray<RawPath>;
+export type ProjectionExpression = {
+    stringify(params: {
+        names: AttributeNames;
+    }): string;
+};
+export declare const ProjectionExpression: {
+    /**
+     * Constructs a {@link ProjectionExpression} from the provided {@link ProjectionExpressionParams}.
+     *
+     * Note that an empty expression is an invalid value for the DynamoDB API. To catch this
+     * mistake earlier, this function will throw if the provided list of paths is empty.
+     *
+     * @param expressionParams - The list of paths to include in the projection expression.
+     *
+     * @returns The {@link ProjectionExpression} corresponding to the provided {@link ProjectionExpressionParams}.
+     */
+    from(expressionParams: ProjectionExpressionParams): ProjectionExpression;
+};

package/lib/esm/commands/expressions/projection.js

@@ -0,0 +1,28 @@
+import assert from "node:assert";
+import { Path } from "./operands/index.js";
+export const ProjectionExpression = {
+    /**
+     * Constructs a {@link ProjectionExpression} from the provided {@link ProjectionExpressionParams}.
+     *
+     * Note that an empty expression is an invalid value for the DynamoDB API. To catch this
+     * mistake earlier, this function will throw if the provided list of paths is empty.
+     *
+     * @param expressionParams - The list of paths to include in the projection expression.
+     *
+     * @returns The {@link ProjectionExpression} corresponding to the provided {@link ProjectionExpressionParams}.
+     */
+    from(expressionParams) {
+        assert(expressionParams.length > 0, "expression params cannot be empty");
+        return {
+            stringify(stringifyParams) {
+                const { names } = stringifyParams;
+                const substitutions = [];
+                for (const path of expressionParams) {
+                    substitutions.push(Path.normalize(path).substitute({ names }));
+                }
+                return substitutions.join(",");
+            },
+        };
+    },
+};
+//# sourceMappingURL=projection.js.map

package/lib/esm/commands/expressions/projection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"projection.js","sourceRoot":"","sources":["../../../../src/commands/expressions/projection.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,aAAa,CAAC;AAEjC,OAAO,EAAE,IAAI,EAAgB,MAAM,qBAAqB,CAAC;AAQzD,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC;;;;;;;;;OASG;IACH,IAAI,CAAC,gBAA4C;QAC/C,MAAM,CAAC,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE,mCAAmC,CAAC,CAAC;QAEzE,OAAO;YACL,SAAS,CAAC,eAAe;gBACvB,MAAM,EAAE,KAAK,EAAE,GAAG,eAAe,CAAC;gBAClC,MAAM,aAAa,GAAG,EAAE,CAAC;gBACzB,KAAK,MAAM,IAAI,IAAI,gBAAgB,EAAE,CAAC;oBACpC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;gBACjE,CAAC;gBACD,OAAO,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACjC,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC"}

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

@@ -1,5 +1,6 @@
 import type { GetCommandInput } from "@aws-sdk/lib-dynamodb";
 import type { KeyAttributes } from "../../types.js";
+import { type ProjectionExpressionParams } from "../expressions/projection.js";
 /**
  * The input required to call the GetItem API.
  */
@@ -15,6 +16,10 @@ export interface GetItemInput<K extends KeyAttributes = KeyAttributes> {
      * is part of the table's primary key. No more than 2 fields are expected here.
      */
     key: K;
+    /**
+     * The projection applied to the return item, if any.
+     */
+    projection?: ProjectionExpressionParams;
 }
 export declare const GetItemInput: {
     encode: typeof encode;

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

@@ -1,11 +1,22 @@
+import { AttributeNames } from "../attributes/names.js";
+import { ProjectionExpression, } from "../expressions/projection.js";
 export const GetItemInput = {
     encode,
 };
 function encode(input) {
-    const key = input.key;
-    return {
+    const result = {
         TableName: input.table,
-        Key: key,
+        Key: input.key,
     };
+    if (input.projection != null) {
+        // There should be no values.
+        const names = AttributeNames.create();
+        const expression = ProjectionExpression.from(input.projection).stringify({
+            names,
+        });
+        result.ProjectionExpression = expression;
+        result.ExpressionAttributeNames = names.getSubstitutions();
+    }
+    return result;
 }
 //# sourceMappingURL=get-item.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"get-item.js","sourceRoot":"","sources":["../../../../src/commands/inputs/get-item.ts"],"names":[],"mappings":"AAoBA,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,MAAM;CACP,CAAC;AAEF,SAAS,MAAM,CACb,KAAsB;IAEtB,MAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC;IACtB,OAAO;QACL,SAAS,EAAE,KAAK,CAAC,KAAK;QACtB,GAAG,EAAE,GAAG;KACT,CAAC;AACJ,CAAC"}
+{"version":3,"file":"get-item.js","sourceRoot":"","sources":["../../../../src/commands/inputs/get-item.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EACL,oBAAoB,GAErB,MAAM,8BAA8B,CAAC;AAuBtC,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,GAAG,EAAE,KAAK,CAAC,GAAG;KACf,CAAC;IAEF,IAAI,KAAK,CAAC,UAAU,IAAI,IAAI,EAAE,CAAC;QAC7B,6BAA6B;QAC7B,MAAM,KAAK,GAAG,cAAc,CAAC,MAAM,EAAE,CAAC;QACtC,MAAM,UAAU,GAAG,oBAAoB,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,SAAS,CAAC;YACvE,KAAK;SACN,CAAC,CAAC;QACH,MAAM,CAAC,oBAAoB,GAAG,UAAU,CAAC;QACzC,MAAM,CAAC,wBAAwB,GAAG,KAAK,CAAC,gBAAgB,EAAE,CAAC;IAC7D,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@infra-blocks/aws-dynamodb",
-  "version": "0.63.0",
+  "version": "0.64.0-alpha.1",
   "description": "A convenience wrapper over @aws-sdk/client-dynamodb and @aws-sdk/lib-dynamodb.",
   "keywords": [
     "aws",
@@ -41,6 +41,7 @@
     "test:unit": "mocha --config test/unit/.mocharc.cjs 'test/unit/**/*.spec.ts'"
   },
   "devDependencies": {
+    "@aws-sdk/util-dynamodb": "^3.995.0",
     "@biomejs/biome": "^2.1.2",
     "@infra-blocks/iter": "^0.2.7",
     "@infra-blocks/node-console-logger": "^0.3.1",