@aws-sdk/lib-dynamodb 3.42.0 → 3.43.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.43.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.42.0...v3.43.0) (2021-11-29)
+
+
+### Features
+
+* **lib-dynamodb:** add pagination ([#3069](https://github.com/aws/aws-sdk-js-v3/issues/3069)) ([51480df](https://github.com/aws/aws-sdk-js-v3/commit/51480df99b38d0f4893f4c6cd7020b9a6135eee9))
+
+
+
+
+
 # [3.42.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.41.0...v3.42.0) (2021-11-19)
 
 **Note:** Version bump only for package @aws-sdk/lib-dynamodb

package/dist-cjs/index.js

@@ -4,3 +4,4 @@ const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./DynamoDBDocument"), exports);
 tslib_1.__exportStar(require("./DynamoDBDocumentClient"), exports);
 tslib_1.__exportStar(require("./commands"), exports);
+tslib_1.__exportStar(require("./pagination"), exports);

package/dist-cjs/pagination/Interfaces.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist-cjs/pagination/QueryPaginator.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.paginateQuery = void 0;
+const QueryCommand_1 = require("../commands/QueryCommand");
+const DynamoDBDocument_1 = require("../DynamoDBDocument");
+const DynamoDBDocumentClient_1 = require("../DynamoDBDocumentClient");
+const makePagedClientRequest = async (client, input, ...args) => {
+    return await client.send(new QueryCommand_1.QueryCommand(input), ...args);
+};
+const makePagedRequest = async (client, input, ...args) => {
+    return await client.query(input, ...args);
+};
+async function* paginateQuery(config, input, ...additionalArguments) {
+    let token = config.startingToken || undefined;
+    let hasNext = true;
+    let page;
+    while (hasNext) {
+        input.ExclusiveStartKey = token;
+        input["Limit"] = config.pageSize;
+        if (config.client instanceof DynamoDBDocument_1.DynamoDBDocument) {
+            page = await makePagedRequest(config.client, input, ...additionalArguments);
+        }
+        else if (config.client instanceof DynamoDBDocumentClient_1.DynamoDBDocumentClient) {
+            page = await makePagedClientRequest(config.client, input, ...additionalArguments);
+        }
+        else {
+            throw new Error("Invalid client, expected DynamoDBDocument | DynamoDBDocumentClient");
+        }
+        yield page;
+        token = page.LastEvaluatedKey;
+        hasNext = !!token;
+    }
+    return undefined;
+}
+exports.paginateQuery = paginateQuery;

package/dist-cjs/pagination/ScanPaginator.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.paginateScan = void 0;
+const ScanCommand_1 = require("../commands/ScanCommand");
+const DynamoDBDocument_1 = require("../DynamoDBDocument");
+const DynamoDBDocumentClient_1 = require("../DynamoDBDocumentClient");
+const makePagedClientRequest = async (client, input, ...args) => {
+    return await client.send(new ScanCommand_1.ScanCommand(input), ...args);
+};
+const makePagedRequest = async (client, input, ...args) => {
+    return await client.scan(input, ...args);
+};
+async function* paginateScan(config, input, ...additionalArguments) {
+    let token = config.startingToken || undefined;
+    let hasNext = true;
+    let page;
+    while (hasNext) {
+        input.ExclusiveStartKey = token;
+        input["Limit"] = config.pageSize;
+        if (config.client instanceof DynamoDBDocument_1.DynamoDBDocument) {
+            page = await makePagedRequest(config.client, input, ...additionalArguments);
+        }
+        else if (config.client instanceof DynamoDBDocumentClient_1.DynamoDBDocumentClient) {
+            page = await makePagedClientRequest(config.client, input, ...additionalArguments);
+        }
+        else {
+            throw new Error("Invalid client, expected DynamoDBDocument | DynamoDBDocumentClient");
+        }
+        yield page;
+        token = page.LastEvaluatedKey;
+        hasNext = !!token;
+    }
+    return undefined;
+}
+exports.paginateScan = paginateScan;

package/dist-cjs/pagination/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./Interfaces"), exports);
+tslib_1.__exportStar(require("./QueryPaginator"), exports);
+tslib_1.__exportStar(require("./ScanPaginator"), exports);

package/dist-es/index.js

@@ -1,3 +1,4 @@
 export * from "./DynamoDBDocument";
 export * from "./DynamoDBDocumentClient";
 export * from "./commands";
+export * from "./pagination";

package/dist-es/pagination/Interfaces.js

@@ -0,0 +1 @@
+export {};

package/dist-es/pagination/QueryPaginator.js

@@ -0,0 +1,74 @@
+import { __asyncGenerator, __await, __awaiter, __generator, __read, __spreadArray } from "tslib";
+import { QueryCommand } from "../commands/QueryCommand";
+import { DynamoDBDocument } from "../DynamoDBDocument";
+import { DynamoDBDocumentClient } from "../DynamoDBDocumentClient";
+var makePagedClientRequest = function (client, input) {
+    var args = [];
+    for (var _i = 2; _i < arguments.length; _i++) {
+        args[_i - 2] = arguments[_i];
+    }
+    return __awaiter(void 0, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4, client.send.apply(client, __spreadArray([new QueryCommand(input)], __read(args)))];
+                case 1: return [2, _a.sent()];
+            }
+        });
+    });
+};
+var makePagedRequest = function (client, input) {
+    var args = [];
+    for (var _i = 2; _i < arguments.length; _i++) {
+        args[_i - 2] = arguments[_i];
+    }
+    return __awaiter(void 0, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4, client.query.apply(client, __spreadArray([input], __read(args)))];
+                case 1: return [2, _a.sent()];
+            }
+        });
+    });
+};
+export function paginateQuery(config, input) {
+    var additionalArguments = [];
+    for (var _i = 2; _i < arguments.length; _i++) {
+        additionalArguments[_i - 2] = arguments[_i];
+    }
+    return __asyncGenerator(this, arguments, function paginateQuery_1() {
+        var token, hasNext, page;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    token = config.startingToken || undefined;
+                    hasNext = true;
+                    _a.label = 1;
+                case 1:
+                    if (!hasNext) return [3, 9];
+                    input.ExclusiveStartKey = token;
+                    input["Limit"] = config.pageSize;
+                    if (!(config.client instanceof DynamoDBDocument)) return [3, 3];
+                    return [4, __await(makePagedRequest.apply(void 0, __spreadArray([config.client, input], __read(additionalArguments))))];
+                case 2:
+                    page = _a.sent();
+                    return [3, 6];
+                case 3:
+                    if (!(config.client instanceof DynamoDBDocumentClient)) return [3, 5];
+                    return [4, __await(makePagedClientRequest.apply(void 0, __spreadArray([config.client, input], __read(additionalArguments))))];
+                case 4:
+                    page = _a.sent();
+                    return [3, 6];
+                case 5: throw new Error("Invalid client, expected DynamoDBDocument | DynamoDBDocumentClient");
+                case 6: return [4, __await(page)];
+                case 7: return [4, _a.sent()];
+                case 8:
+                    _a.sent();
+                    token = page.LastEvaluatedKey;
+                    hasNext = !!token;
+                    return [3, 1];
+                case 9: return [4, __await(undefined)];
+                case 10: return [2, _a.sent()];
+            }
+        });
+    });
+}

package/dist-es/pagination/ScanPaginator.js

@@ -0,0 +1,74 @@
+import { __asyncGenerator, __await, __awaiter, __generator, __read, __spreadArray } from "tslib";
+import { ScanCommand } from "../commands/ScanCommand";
+import { DynamoDBDocument } from "../DynamoDBDocument";
+import { DynamoDBDocumentClient } from "../DynamoDBDocumentClient";
+var makePagedClientRequest = function (client, input) {
+    var args = [];
+    for (var _i = 2; _i < arguments.length; _i++) {
+        args[_i - 2] = arguments[_i];
+    }
+    return __awaiter(void 0, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4, client.send.apply(client, __spreadArray([new ScanCommand(input)], __read(args)))];
+                case 1: return [2, _a.sent()];
+            }
+        });
+    });
+};
+var makePagedRequest = function (client, input) {
+    var args = [];
+    for (var _i = 2; _i < arguments.length; _i++) {
+        args[_i - 2] = arguments[_i];
+    }
+    return __awaiter(void 0, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4, client.scan.apply(client, __spreadArray([input], __read(args)))];
+                case 1: return [2, _a.sent()];
+            }
+        });
+    });
+};
+export function paginateScan(config, input) {
+    var additionalArguments = [];
+    for (var _i = 2; _i < arguments.length; _i++) {
+        additionalArguments[_i - 2] = arguments[_i];
+    }
+    return __asyncGenerator(this, arguments, function paginateScan_1() {
+        var token, hasNext, page;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    token = config.startingToken || undefined;
+                    hasNext = true;
+                    _a.label = 1;
+                case 1:
+                    if (!hasNext) return [3, 9];
+                    input.ExclusiveStartKey = token;
+                    input["Limit"] = config.pageSize;
+                    if (!(config.client instanceof DynamoDBDocument)) return [3, 3];
+                    return [4, __await(makePagedRequest.apply(void 0, __spreadArray([config.client, input], __read(additionalArguments))))];
+                case 2:
+                    page = _a.sent();
+                    return [3, 6];
+                case 3:
+                    if (!(config.client instanceof DynamoDBDocumentClient)) return [3, 5];
+                    return [4, __await(makePagedClientRequest.apply(void 0, __spreadArray([config.client, input], __read(additionalArguments))))];
+                case 4:
+                    page = _a.sent();
+                    return [3, 6];
+                case 5: throw new Error("Invalid client, expected DynamoDBDocument | DynamoDBDocumentClient");
+                case 6: return [4, __await(page)];
+                case 7: return [4, _a.sent()];
+                case 8:
+                    _a.sent();
+                    token = page.LastEvaluatedKey;
+                    hasNext = !!token;
+                    return [3, 1];
+                case 9: return [4, __await(undefined)];
+                case 10: return [2, _a.sent()];
+            }
+        });
+    });
+}

package/dist-es/pagination/index.js

@@ -0,0 +1,3 @@
+export * from "./Interfaces";
+export * from "./QueryPaginator";
+export * from "./ScanPaginator";

package/dist-types/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./DynamoDBDocument";
 export * from "./DynamoDBDocumentClient";
 export * from "./commands";
+export * from "./pagination";

package/dist-types/pagination/Interfaces.d.ts

@@ -0,0 +1,6 @@
+import { PaginationConfiguration } from "@aws-sdk/types";
+import { DynamoDBDocument } from "../DynamoDBDocument";
+import { DynamoDBDocumentClient } from "../DynamoDBDocumentClient";
+export interface DynamoDBDocumentPaginationConfiguration extends PaginationConfiguration {
+    client: DynamoDBDocument | DynamoDBDocumentClient;
+}

package/dist-types/pagination/QueryPaginator.d.ts

@@ -0,0 +1,4 @@
+import { Paginator } from "@aws-sdk/types";
+import { QueryCommandInput, QueryCommandOutput } from "../commands/QueryCommand";
+import { DynamoDBDocumentPaginationConfiguration } from "./Interfaces";
+export declare function paginateQuery(config: DynamoDBDocumentPaginationConfiguration, input: QueryCommandInput, ...additionalArguments: any): Paginator<QueryCommandOutput>;

package/dist-types/pagination/ScanPaginator.d.ts

@@ -0,0 +1,4 @@
+import { Paginator } from "@aws-sdk/types";
+import { ScanCommandInput, ScanCommandOutput } from "../commands/ScanCommand";
+import { DynamoDBDocumentPaginationConfiguration } from "./Interfaces";
+export declare function paginateScan(config: DynamoDBDocumentPaginationConfiguration, input: ScanCommandInput, ...additionalArguments: any): Paginator<ScanCommandOutput>;

package/dist-types/pagination/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./Interfaces";
+export * from "./QueryPaginator";
+export * from "./ScanPaginator";

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

@@ -1,3 +1,4 @@
 export * from "./DynamoDBDocument";
 export * from "./DynamoDBDocumentClient";
 export * from "./commands";
+export * from "./pagination";

package/dist-types/ts3.4/pagination/Interfaces.d.ts

@@ -0,0 +1,6 @@
+import { PaginationConfiguration } from "@aws-sdk/types";
+import { DynamoDBDocument } from "../DynamoDBDocument";
+import { DynamoDBDocumentClient } from "../DynamoDBDocumentClient";
+export interface DynamoDBDocumentPaginationConfiguration extends PaginationConfiguration {
+    client: DynamoDBDocument | DynamoDBDocumentClient;
+}

package/dist-types/ts3.4/pagination/QueryPaginator.d.ts

@@ -0,0 +1,4 @@
+import { Paginator } from "@aws-sdk/types";
+import { QueryCommandInput, QueryCommandOutput } from "../commands/QueryCommand";
+import { DynamoDBDocumentPaginationConfiguration } from "./Interfaces";
+export declare function paginateQuery(config: DynamoDBDocumentPaginationConfiguration, input: QueryCommandInput, ...additionalArguments: any): Paginator<QueryCommandOutput>;

package/dist-types/ts3.4/pagination/ScanPaginator.d.ts

@@ -0,0 +1,4 @@
+import { Paginator } from "@aws-sdk/types";
+import { ScanCommandInput, ScanCommandOutput } from "../commands/ScanCommand";
+import { DynamoDBDocumentPaginationConfiguration } from "./Interfaces";
+export declare function paginateScan(config: DynamoDBDocumentPaginationConfiguration, input: ScanCommandInput, ...additionalArguments: any): Paginator<ScanCommandOutput>;

package/dist-types/ts3.4/pagination/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./Interfaces";
+export * from "./QueryPaginator";
+export * from "./ScanPaginator";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-sdk/lib-dynamodb",
-  "version": "3.42.0",
+  "version": "3.43.0",
   "description": "The document client simplifies working with items in Amazon DynamoDB by abstracting away the notion of attribute values.",
   "main": "./dist-cjs/index.js",
   "module": "./dist-es/index.js",
@@ -22,7 +22,7 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@aws-sdk/util-dynamodb": "3.42.0",
+    "@aws-sdk/util-dynamodb": "3.43.0",
     "tslib": "^2.3.0"
   },
   "peerDependencies": {
@@ -31,7 +31,7 @@
     "@aws-sdk/types": "^3.0.0"
   },
   "devDependencies": {
-    "@aws-sdk/client-dynamodb": "3.42.0",
+    "@aws-sdk/client-dynamodb": "3.43.0",
     "@aws-sdk/smithy-client": "3.41.0",
     "@aws-sdk/types": "3.40.0",
     "@types/jest": "^26.0.4",