@nikovirtala/typesafe-dynamodb 0.0.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,333 @@
+# typesafe-dynamodb
+
+[![npm version](https://badge.fury.io/js/typesafe-dynamodb.svg)](https://badge.fury.io/js/typesafe-dynamodb)
+
+`typesafe-dynamodb` is a type-only library which replaces the type signatures of the AWS SDK's DynamoDB client. It substitutes `getItem`, `putItem`, `deleteItem` and `query` API methods with type-safe alternatives that are aware of the data in your tables and also adaptive to the semantics of the API request, e.g. by validating `ExpressionAttributeNames` and `ExpressionAttributeValues` contain all the values used in a `ConditionExpression` string, or by understanding the effect of a `ProjectionExpression` on the returned data type.
+
+The end goal is to provide types that have total understanding of the AWS DynamoDB API and enable full utilization of the TypeScript type system for modeling complex DynamoDB tables, such as the application of union types and template string literals for single-table designs.
+
+![typesafe putItem ConditionExpression](img/put-item-expression.gif)
+
+## Installation
+
+```
+npm install --save-dev typesafe-dynamodb
+```
+
+## Usage
+
+This library contains type definitions for both AWS SDK v2 (`aws-sdk`) and AWS SDK v3 (`@aws-sdk/client-dynamodb`);
+
+### AWS SDK v2
+
+To use `typesafe-dynamodb` with the AWS SDK v2, there is no need to change anything about your existing runtime code. It is purely type definitions, so you only need to cast an instance of `AWS.DynamoDB` to the `TypeSafeDynamoDBv2<T, HashKey, RangeKey>` interface and use the client as normal, except now you can enjoy a dynamic, type-safe experience in your IDE instead.
+
+```ts
+import { DynamoDB } from "aws-sdk";
+
+const client = new DynamoDB();
+```
+
+Start by declaring a standard TypeScript interface which describes the structure of data in your DynamoDB Table:
+
+```ts
+interface Record {
+  key: string;
+  sort: number;
+  attribute: string;
+  // all types are allowed, such as recursive nested types
+  records?: Record[];
+}
+```
+
+Then, cast the `DynamoDB` client instance to `TypeSafeDynamoDB`;
+
+```ts
+import { TypeSafeDynamoDBv2 } from "typesafe-dynamodb/lib/client-v2";
+
+const typesafeClient: TypeSafeDynamoDBv2<Record, "key", "sort"> = client;
+```
+
+`"key"` is the name of the Hash Key attribute, and `"sort"` is the name of the Range Key attribute.
+
+Finally, use the client as you normally would, except now with intelligent type hints and validations.
+
+### AWS SDK v3
+
+#### Option 1 - DynamoDB (similar to SDK v2)
+
+`DynamoDB` is an almost identical implementation to the AWS SDK v2, except with minor changes such as returning a `Promise` by default. It is a convenient way of using the DynamoDB API, except it is not optimized for tree-shaking (for that, see Option 2).
+
+To override the types, follow a similar method to v2, except by importing TypeSafeDynamoDBv3 (instead of v2):
+
+```ts
+import { DynamoDB } from "@aws-sdk/client-dynamodb";
+import { TypeSafeDynamoDBv3 } from "typesafe-dynamodb/lib/client-v3";
+
+const client = new DynamoDB({..});
+const typesafeClient: TypeSafeDynamoDBv3<Record, "key", "sort"> = client;
+```
+
+#### Option 2 - DynamoDBClient (a Command-Response interface optimized for tree-shaking)
+
+`DynamoDBClient` is a generic interface with a single method, `send`. To invoke an API, call `send` with an instance of the API's corresponding `Command`.
+
+This option is designed for optimal tree-shaking when bundling code, ensuring that the bundle only includes code for the APIs your application uses.
+
+For this option, type-safety is achieved by declaring your own commands and then calling the standard `DynamoDBClient`:
+
+```ts
+interface MyType {
+  key: string;
+  sort: number;
+  list: string[];
+}
+
+const client = new DynamoDBClient({});
+
+const GetMyTypeCommand = TypeSafeGetItemCommand<MyType, "key", "sort">();
+
+await client.send(
+  new GetMyTypeCommand({
+    ..
+  })
+);
+```
+
+### Document Client
+
+Both the AWS SDK v2 and v3 provide a javascript-friendly interface called the `DocumentClient`. Instead of using the AttributeValue format, such as `{ S: "hello" }` or `{ N: "123" }`, the `DocumentClient` enables you to use native javascript types, e.g. `"hello"` or `123`.
+
+#### AWS SDK V2
+
+For the SDK V2 client, cast it to `TypeSafeDocumentClientV2`.
+
+See: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB/DocumentClient.html
+
+```ts
+import { DynamoDB } from "aws-sdk";
+import { TypeSafeDocumentClientV2 } from "typesafe-dynamodb/lib/document-client-v2";
+
+const table = new DynamoDB.DocumentClient() as TypeSafeDocumentClientV2<
+  MyItem,
+  "pk",
+  "sk"
+>;
+```
+
+#### AWS SDK V3
+
+When defining your Command types, use the corresponding `TypeSafe*DocumentCommand` type, for example `TypeSafeGetDocumentCommand` instead of `TypeSafeGetItemCommand`:
+
+- GetItem - `TypeSafeGetDocumentCommand`
+- PutItem - `TypeSafePutDocumentCommand`
+- DeleteItem - `TypeSafeDeleteDocumentCommand`
+- UpdateItem - `TypeSafeUpdateDocumentCommand`
+- Query - `TypeSafeQueryDocumentCommand`
+- Scan - `TypeSafeScanDocumentCommand`
+
+See: https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/modules/_aws_sdk_lib_dynamodb.html
+
+```ts
+import { JsonFormat } from "typesafe-dynamodb";
+import { TypeSafeGetDocumentCommand } from "typesafe-dynamodb/lib/get-document-command";
+
+const MyGetItemCommand = TypeSafeGetDocumentCommand<MyType, "key", "sort">();
+```
+
+For the SDK V3 client, cast it to `TypeSafeDynamoDBv3`.
+
+```ts
+import { DynamoDBClient } from "@aws-sdk/client-dynamodb";
+import { DynamoDBDocumentClient, PutCommand } from "@aws-sdk/lib-dynamodb";
+import { TypeSafeDocumentClientV3 } from "typesafe-dynamodb/lib/document-client-v3";
+
+const client = new DynamoDBClient({});
+
+const docClient = DynamoDBDocumentClient.from(
+  client
+) as TypeSafeDocumentClientV3<MyType, "key", "sort">;
+```
+
+And then call `.send` with an instance of your TypeSafe Command:
+
+```ts
+docClient.send(new MyGetItemCommand({
+  ..
+}));
+```
+
+## Features
+
+### Type-aware Input and Output
+
+The type of the `Key` is derived from the `Record` type.
+
+![typesafe GetItem Key](img/get-item.gif)
+
+Same for the `Item` in the response:
+
+![typesafe GetItemOutput Item](img/get-item-response.gif)
+
+### Single Table Design
+
+Below are two `interface` declarations, representing two types of data stored in a single DynamoDB table - `User` and `Order`. Single table design in DynamoDB is achieved by creating "composite keys", e.g. `USER#${UserID}`. In TypeScript, we use template literal types to encode this in the Type System.
+
+```ts
+interface User<UserID extends string = string> {
+  PK: `USER#${UserID}`;
+  SK: `#PROFILE#${UserID}`;
+  Username: string;
+  FullName: string;
+  Email: string;
+  CreatedAt: Date;
+  Address: string;
+}
+
+interface Order<
+  UserID extends string = string,
+  OrderID extends string = string
+> {
+  PK: `USER#${UserID}`;
+  SK: `ORDER#${OrderID}`;
+  Username: string;
+  OrderID: string;
+  Status: "PLACED" | "SHIPPED";
+  CreatedAt: Date;
+  Address: string;
+}
+```
+
+With these two types defined, you can now use a union type to declare a `TypeSafeDynamoDB` instance aware of the two types of data in your tables:
+
+```ts
+const client: TypeSafeDynamoDB<User | Order, "PK", "SK">;
+```
+
+When making calls such as `getItem`, TypeScript will narrow the returned data type to the corresponding type based on the structure of the `Key` in your request:
+
+![narrowed getItem](img/get-order.png)
+
+### Type-Safe DynamoDBStreamEvent
+
+Leverage your data types in Lambda Functions attached to the DynamoDB Table Stream:
+
+```ts
+import { DynamoDBStreamEvent } from "typesafe-dynamodb/lib/stream-event";
+
+export async function handle(
+  event: DynamoDBStreamEvent<User | Order, "PK", "SK", "KEYS_ONLY">
+) {
+  ..
+}
+```
+
+The event's type is derived from the data type and the the `StreamViewType`, e.g. `"NEW_IMAGE" | "OLD_IMAGE" | "KEYS_ONLY" | "NEW_AND_OLD_IMAGES"`.
+
+### Filter result with ProjectionExpression
+
+The `ProjectionExpression` field is parsed and applied to filter the returned type of `getItem` and `query`.
+
+![typesafe ProjectionExpression](img/get-item-projection.gif)
+
+### Filter with AttributesToGet
+
+If you specify `AttributesToGet`, then the returned type only contains those properties.
+
+![typesafe AttributesToGet](img/get-item-attributes.gif)
+
+### Validate ExpressionAttributeNames and ExpressionAttributeValues
+
+If you add a `ConditionExpression` in `putItem`, you will be prompted for any `#name` or `:valu` placeholders:
+
+![typesafe putItem ConditionExpression](img/put-item-expression.gif)
+
+Same is true for a `query`:
+
+![typesafe query KeyConditionExpression and Filter](img/query-expression.gif)
+
+### Marshall a JS Object to an AttributeMap
+
+A better type definition `@aws-sdk/util-dynamodb`'s `marshall` function is provided which maintains the typing information of the value passed to it and also adapts the output type based on the input `marshallOptions`
+
+Given an object literal:
+
+```ts
+const myObject = {
+  key: "key",
+  sort: 123,
+  binary: new Uint16Array([1]),
+  buffer: Buffer.from("buffer", "utf8"),
+  optional: 456,
+  list: ["hello", "world"],
+  record: {
+    key: "nested key",
+    sort: 789,
+  },
+} as const;
+```
+
+Call the `marshall` function to convert it to an AttributeMap which maintains the exact structure in the type system:
+
+```ts
+import { marshall } from "typesafe-dynamodb/lib/marshall";
+// marshall the above JS object to its corresponding AttributeMap
+const marshalled = marshall(myObject)
+
+// typing information is carried across exactly, including literal types
+const marshalled: {
+  readonly key: S<"key">;
+  readonly sort: N<123>;
+  readonly binary: B;
+  readonly buffer: B;
+  readonly optional: N<456>;
+  readonly list: L<readonly [S<"hello">, S<"world">]>;
+  readonly record: M<...>;
+}
+```
+
+### Unmarshall an AttributeMap back to a JS Object
+
+A better type definition `@aws-sdk/util-dynamodb`'s `unmarshall` function is provided which maintains the typing information of the value passed to it and also adapts the output type based on the input `unmarshallOptions`.
+
+```ts
+import { unmarshall } from "typesafe-dynamodb/lib/marshall";
+
+// unmarshall the AttributeMap back into the original object
+const unmarshalled = unmarshall(marshalled);
+
+// it maintains the literal typing information (as much as possible)
+const unmarshalled: {
+  readonly key: "key";
+  readonly sort: 123;
+  readonly binary: NativeBinaryAttribute;
+  readonly buffer: NativeBinaryAttribute;
+  readonly optional: 456;
+  readonly list: readonly [...];
+  readonly record: Unmarshall<...>;
+}
+```
+
+If you specify `{wrapNumbers: true}`, then all `number` types will be wrapped as `{ value: string }`:
+
+```ts
+const unmarshalled = unmarshall(marshalled, {
+  wrapNumbers: true,
+});
+
+// numbers are wrapped in { value: string } because of `wrappedNumbers: true`
+unmarshalled.sort.value; // string
+
+// it maintains the literal typing information (as much as possible)
+const unmarshalled: {
+  readonly key: "key";
+  // notice how the number is wrapped in the `NumberValue` type?
+  // this is because `wrapNumbers: true`
+  readonly sort: NumberValue<123>;
+  readonly binary: NativeBinaryAttribute;
+  readonly buffer: NativeBinaryAttribute;
+  readonly optional: NumberValue<...>;
+  readonly list: readonly [...];
+  readonly record: Unmarshall<...>;
+};
+```

package/lib/attribute-value.d.ts

@@ -0,0 +1,43 @@
+export type AttributeValue = undefined | S | N | B | BOOL | NULL | L<ArrayLike<AttributeValue>> | M<Record<string, AttributeValue>>;
+export type AttributeMap = Record<string, AttributeValue>;
+export type NativeBinaryAttribute = ArrayBuffer | BigInt64Array | BigUint64Array | Buffer | DataView | Float32Array | Float64Array | Int16Array | Int32Array | Int8Array | Uint16Array | Uint32Array | Uint8Array | Uint8ClampedArray;
+export type DocumentValue = undefined | null | boolean | number | string | DocumentValue[] | NativeBinaryAttribute | {
+    [key: string]: DocumentValue;
+};
+export type ToAttributeMap<T extends object> = ToAttributeValue<T>["M"];
+/**
+ * Computes the JSON representation of an object, {@link T}.
+ */
+export type ToAttributeValue<T> = T extends undefined ? undefined : T extends null ? NULL : T extends boolean ? BOOL<T> : T extends string ? S<T> : T extends number ? N<T> : T extends Date ? N<number> : T extends NativeBinaryAttribute ? B : T extends ArrayLike<unknown> ? L<{
+    [i in keyof T]: i extends "length" ? T[i] : ToAttributeValue<T[i]>;
+}> : M<{
+    [prop in keyof T]: ToAttributeValue<T[prop]>;
+}>;
+export declare function isS(a: any): a is S;
+export interface S<T extends string = string> {
+    S: T;
+}
+export declare function isB(a: any): a is B;
+export interface B {
+    B: Buffer;
+}
+export declare function isBOOL(a: any): a is BOOL;
+export interface BOOL<T = boolean> {
+    BOOL: T;
+}
+export declare function isM(a: any): a is M;
+export interface M<T extends Record<string, AttributeValue> = Record<string, AttributeValue>> {
+    M: T;
+}
+export declare function isN(a: any): a is N;
+export interface N<T extends number = number> {
+    N: `${T}`;
+}
+export declare function isNULL(a: any): a is NULL;
+export interface NULL {
+    NULL: boolean;
+}
+export declare function isL(a: any): a is L;
+export interface L<T extends ArrayLike<AttributeValue> = ArrayLike<AttributeValue>> {
+    L: T;
+}

package/lib/attribute-value.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isS = isS;
+exports.isB = isB;
+exports.isBOOL = isBOOL;
+exports.isM = isM;
+exports.isN = isN;
+exports.isNULL = isNULL;
+exports.isL = isL;
+function isS(a) {
+    return a !== undefined && "S" in a;
+}
+function isB(a) {
+    return a !== undefined && "B" in a;
+}
+function isBOOL(a) {
+    return a !== undefined && "BOOL" in a;
+}
+function isM(a) {
+    return a !== undefined && "M" in a;
+}
+function isN(a) {
+    return a !== undefined && "N" in a;
+}
+function isNULL(a) {
+    return a !== undefined && "NULL" in a;
+}
+function isL(a) {
+    return a !== undefined && "L" in a;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXR0cmlidXRlLXZhbHVlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL2F0dHJpYnV0ZS12YWx1ZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQXdFQSxrQkFFQztBQU1ELGtCQUVDO0FBTUQsd0JBRUM7QUFNRCxrQkFFQztBQVFELGtCQUVDO0FBTUQsd0JBRUM7QUFNRCxrQkFFQztBQXBERCxTQUFnQixHQUFHLENBQUMsQ0FBTTtJQUN4QixPQUFPLENBQUMsS0FBSyxTQUFTLElBQUksR0FBRyxJQUFJLENBQUMsQ0FBQztBQUNyQyxDQUFDO0FBTUQsU0FBZ0IsR0FBRyxDQUFDLENBQU07SUFDeEIsT0FBTyxDQUFDLEtBQUssU0FBUyxJQUFJLEdBQUcsSUFBSSxDQUFDLENBQUM7QUFDckMsQ0FBQztBQU1ELFNBQWdCLE1BQU0sQ0FBQyxDQUFNO0lBQzNCLE9BQU8sQ0FBQyxLQUFLLFNBQVMsSUFBSSxNQUFNLElBQUksQ0FBQyxDQUFDO0FBQ3hDLENBQUM7QUFNRCxTQUFnQixHQUFHLENBQUMsQ0FBTTtJQUN4QixPQUFPLENBQUMsS0FBSyxTQUFTLElBQUksR0FBRyxJQUFJLENBQUMsQ0FBQztBQUNyQyxDQUFDO0FBUUQsU0FBZ0IsR0FBRyxDQUFDLENBQU07SUFDeEIsT0FBTyxDQUFDLEtBQUssU0FBUyxJQUFJLEdBQUcsSUFBSSxDQUFDLENBQUM7QUFDckMsQ0FBQztBQU1ELFNBQWdCLE1BQU0sQ0FBQyxDQUFNO0lBQzNCLE9BQU8sQ0FBQyxLQUFLLFNBQVMsSUFBSSxNQUFNLElBQUksQ0FBQyxDQUFDO0FBQ3hDLENBQUM7QUFNRCxTQUFnQixHQUFHLENBQUMsQ0FBTTtJQUN4QixPQUFPLENBQUMsS0FBSyxTQUFTLElBQUksR0FBRyxJQUFJLENBQUMsQ0FBQztBQUNyQyxDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiZXhwb3J0IHR5cGUgQXR0cmlidXRlVmFsdWUgPVxuICB8IHVuZGVmaW5lZFxuICB8IFNcbiAgfCBOXG4gIHwgQlxuICB8IEJPT0xcbiAgfCBOVUxMXG4gIHwgTDxBcnJheUxpa2U8QXR0cmlidXRlVmFsdWU+PlxuICB8IE08UmVjb3JkPHN0cmluZywgQXR0cmlidXRlVmFsdWU+PjtcblxuZXhwb3J0IHR5cGUgQXR0cmlidXRlTWFwID0gUmVjb3JkPHN0cmluZywgQXR0cmlidXRlVmFsdWU+O1xuXG5leHBvcnQgdHlwZSBOYXRpdmVCaW5hcnlBdHRyaWJ1dGUgPVxuICB8IEFycmF5QnVmZmVyXG4gIHwgQmlnSW50NjRBcnJheVxuICB8IEJpZ1VpbnQ2NEFycmF5XG4gIHwgQnVmZmVyXG4gIHwgRGF0YVZpZXdcbiAgfCBGbG9hdDMyQXJyYXlcbiAgfCBGbG9hdDY0QXJyYXlcbiAgfCBJbnQxNkFycmF5XG4gIHwgSW50MzJBcnJheVxuICB8IEludDhBcnJheVxuICB8IFVpbnQxNkFycmF5XG4gIHwgVWludDMyQXJyYXlcbiAgfCBVaW50OEFycmF5XG4gIHwgVWludDhDbGFtcGVkQXJyYXk7XG5cbmV4cG9ydCB0eXBlIERvY3VtZW50VmFsdWUgPVxuICB8IHVuZGVmaW5lZFxuICB8IG51bGxcbiAgfCBib29sZWFuXG4gIHwgbnVtYmVyXG4gIHwgc3RyaW5nXG4gIHwgRG9jdW1lbnRWYWx1ZVtdXG4gIHwgTmF0aXZlQmluYXJ5QXR0cmlidXRlXG4gIHwge1xuICAgICAgW2tleTogc3RyaW5nXTogRG9jdW1lbnRWYWx1ZTtcbiAgICB9O1xuXG4vLyBAdHMtaWdub3JlXG5leHBvcnQgdHlwZSBUb0F0dHJpYnV0ZU1hcDxUIGV4dGVuZHMgb2JqZWN0PiA9IFRvQXR0cmlidXRlVmFsdWU8VD5bXCJNXCJdO1xuXG4vKipcbiAqIENvbXB1dGVzIHRoZSBKU09OIHJlcHJlc2VudGF0aW9uIG9mIGFuIG9iamVjdCwge0BsaW5rIFR9LlxuICovXG5leHBvcnQgdHlwZSBUb0F0dHJpYnV0ZVZhbHVlPFQ+ID0gVCBleHRlbmRzIHVuZGVmaW5lZFxuICA/IHVuZGVmaW5lZFxuICA6IFQgZXh0ZW5kcyBudWxsXG4gICAgPyBOVUxMXG4gICAgOiBUIGV4dGVuZHMgYm9vbGVhblxuICAgICAgPyBCT09MPFQ+XG4gICAgICA6IFQgZXh0ZW5kcyBzdHJpbmdcbiAgICAgICAgPyBTPFQ+XG4gICAgICAgIDogVCBleHRlbmRzIG51bWJlclxuICAgICAgICAgID8gTjxUPlxuICAgICAgICAgIDogLy8gdGhpcyBiZWhhdmlvciBpcyBub3QgZGVmaW5lZCBieSBodHRwczovL2RvY3MuYXdzLmFtYXpvbi5jb20vQVdTSmF2YVNjcmlwdFNESy9sYXRlc3QvQVdTL0R5bmFtb0RCL0RvY3VtZW50Q2xpZW50Lmh0bWxcbiAgICAgICAgICAgIC8vIHNob3VsZCBpdCBiZSBhIG51bWJlciBvZiBzdHJpbmc/XG4gICAgICAgICAgICBUIGV4dGVuZHMgRGF0ZVxuICAgICAgICAgICAgPyBOPG51bWJlcj5cbiAgICAgICAgICAgIDogVCBleHRlbmRzIE5hdGl2ZUJpbmFyeUF0dHJpYnV0ZVxuICAgICAgICAgICAgICA/IEJcbiAgICAgICAgICAgICAgOiBUIGV4dGVuZHMgQXJyYXlMaWtlPHVua25vd24+XG4gICAgICAgICAgICAgICAgPyBMPHtcbiAgICAgICAgICAgICAgICAgICAgW2kgaW4ga2V5b2YgVF06IGkgZXh0ZW5kcyBcImxlbmd0aFwiXG4gICAgICAgICAgICAgICAgICAgICAgPyBUW2ldXG4gICAgICAgICAgICAgICAgICAgICAgOiBUb0F0dHJpYnV0ZVZhbHVlPFRbaV0+O1xuICAgICAgICAgICAgICAgICAgfT5cbiAgICAgICAgICAgICAgICA6IE08e1xuICAgICAgICAgICAgICAgICAgICBbcHJvcCBpbiBrZXlvZiBUXTogVG9BdHRyaWJ1dGVWYWx1ZTxUW3Byb3BdPjtcbiAgICAgICAgICAgICAgICAgIH0+O1xuXG5leHBvcnQgZnVuY3Rpb24gaXNTKGE6IGFueSk6IGEgaXMgUyB7XG4gIHJldHVybiBhICE9PSB1bmRlZmluZWQgJiYgXCJTXCIgaW4gYTtcbn1cblxuZXhwb3J0IGludGVyZmFjZSBTPFQgZXh0ZW5kcyBzdHJpbmcgPSBzdHJpbmc+IHtcbiAgUzogVDtcbn1cblxuZXhwb3J0IGZ1bmN0aW9uIGlzQihhOiBhbnkpOiBhIGlzIEIge1xuICByZXR1cm4gYSAhPT0gdW5kZWZpbmVkICYmIFwiQlwiIGluIGE7XG59XG5cbmV4cG9ydCBpbnRlcmZhY2UgQiB7XG4gIEI6IEJ1ZmZlcjtcbn1cblxuZXhwb3J0IGZ1bmN0aW9uIGlzQk9PTChhOiBhbnkpOiBhIGlzIEJPT0wge1xuICByZXR1cm4gYSAhPT0gdW5kZWZpbmVkICYmIFwiQk9PTFwiIGluIGE7XG59XG5cbmV4cG9ydCBpbnRlcmZhY2UgQk9PTDxUID0gYm9vbGVhbj4ge1xuICBCT09MOiBUO1xufVxuXG5leHBvcnQgZnVuY3Rpb24gaXNNKGE6IGFueSk6IGEgaXMgTSB7XG4gIHJldHVybiBhICE9PSB1bmRlZmluZWQgJiYgXCJNXCIgaW4gYTtcbn1cblxuZXhwb3J0IGludGVyZmFjZSBNPFxuICBUIGV4dGVuZHMgUmVjb3JkPHN0cmluZywgQXR0cmlidXRlVmFsdWU+ID0gUmVjb3JkPHN0cmluZywgQXR0cmlidXRlVmFsdWU+LFxuPiB7XG4gIE06IFQ7XG59XG5cbmV4cG9ydCBmdW5jdGlvbiBpc04oYTogYW55KTogYSBpcyBOIHtcbiAgcmV0dXJuIGEgIT09IHVuZGVmaW5lZCAmJiBcIk5cIiBpbiBhO1xufVxuXG5leHBvcnQgaW50ZXJmYWNlIE48VCBleHRlbmRzIG51bWJlciA9IG51bWJlcj4ge1xuICBOOiBgJHtUfWA7XG59XG5cbmV4cG9ydCBmdW5jdGlvbiBpc05VTEwoYTogYW55KTogYSBpcyBOVUxMIHtcbiAgcmV0dXJuIGEgIT09IHVuZGVmaW5lZCAmJiBcIk5VTExcIiBpbiBhO1xufVxuXG5leHBvcnQgaW50ZXJmYWNlIE5VTEwge1xuICBOVUxMOiBib29sZWFuO1xufVxuXG5leHBvcnQgZnVuY3Rpb24gaXNMKGE6IGFueSk6IGEgaXMgTCB7XG4gIHJldHVybiBhICE9PSB1bmRlZmluZWQgJiYgXCJMXCIgaW4gYTtcbn1cblxuZXhwb3J0IGludGVyZmFjZSBMPFxuICBUIGV4dGVuZHMgQXJyYXlMaWtlPEF0dHJpYnV0ZVZhbHVlPiA9IEFycmF5TGlrZTxBdHRyaWJ1dGVWYWx1ZT4sXG4+IHtcbiAgTDogVDtcbn1cbiJdfQ==

package/lib/callback.d.ts

@@ -0,0 +1,2 @@
+import type { AWSError } from "aws-sdk";
+export type Callback<Data, Err = AWSError> = (err: Err, data: Data) => void;

package/lib/callback.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2FsbGJhY2suanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvY2FsbGJhY2sudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB0eXBlIHsgQVdTRXJyb3IgfSBmcm9tIFwiYXdzLXNka1wiO1xuXG5leHBvcnQgdHlwZSBDYWxsYmFjazxEYXRhLCBFcnIgPSBBV1NFcnJvcj4gPSAoZXJyOiBFcnIsIGRhdGE6IERhdGEpID0+IHZvaWQ7XG4iXX0=

package/lib/client-v2.d.ts

@@ -0,0 +1,18 @@
+import type { AWSError, DynamoDB, Request } from "aws-sdk";
+import { Callback } from "./callback";
+import { DeleteItemInput, DeleteItemOutput } from "./delete-item";
+import { GetItemInput, GetItemOutput } from "./get-item";
+import { JsonFormat } from "./json-format";
+import { TableKey } from "./key";
+import { PutItemInput, PutItemOutput } from "./put-item";
+import { QueryInput, QueryOutput } from "./query";
+import { ScanInput, ScanOutput } from "./scan";
+import { UpdateItemInput, UpdateItemOutput } from "./update-item";
+export interface TypeSafeDynamoDBv2<Item extends object, PartitionKey extends keyof Item, RangeKey extends keyof Item | undefined = undefined> extends Omit<DynamoDB, "getItem" | "deleteItem" | "putItem" | "query" | "scan" | "updateItem"> {
+    getItem<Key extends TableKey<Item, PartitionKey, RangeKey, JsonFormat.AttributeValue>, AttributesToGet extends keyof Item | undefined = undefined, ProjectionExpression extends string | undefined = undefined>(params: GetItemInput<Item, PartitionKey, RangeKey, Key, AttributesToGet, ProjectionExpression, JsonFormat.AttributeValue>, callback?: Callback<GetItemOutput<Item, PartitionKey, RangeKey, Key, AttributesToGet, ProjectionExpression, JsonFormat.AttributeValue>, AWSError>): Request<GetItemOutput<Item, PartitionKey, RangeKey, Key, AttributesToGet, ProjectionExpression, JsonFormat.AttributeValue>, AWSError>;
+    deleteItem<Key extends TableKey<Item, PartitionKey, RangeKey, JsonFormat.AttributeValue>, ConditionExpression extends string | undefined, ReturnValue extends DynamoDB.ReturnValue = "NONE">(params: DeleteItemInput<Item, PartitionKey, RangeKey, Key, ConditionExpression, ReturnValue, JsonFormat.AttributeValue>, callback?: Callback<DeleteItemOutput<Item, ReturnValue, JsonFormat.AttributeValue>, AWSError>): Request<DeleteItemOutput<Item, ReturnValue, JsonFormat.AttributeValue>, AWSError>;
+    putItem<ConditionExpression extends string | undefined, ReturnValue extends DynamoDB.ReturnValue = "NONE">(params: PutItemInput<Item, ConditionExpression, ReturnValue, JsonFormat.AttributeValue>, callback?: Callback<PutItemOutput<Item, ReturnValue, JsonFormat.AttributeValue>, AWSError>): Request<PutItemOutput<Item, ReturnValue, JsonFormat.AttributeValue>, AWSError>;
+    updateItem<Key extends TableKey<Item, PartitionKey, RangeKey, JsonFormat.AttributeValue>, UpdateExpression extends string, ConditionExpression extends string | undefined, ReturnValue extends DynamoDB.ReturnValue = "NONE">(params: UpdateItemInput<Item, PartitionKey, RangeKey, Key, UpdateExpression, ConditionExpression, ReturnValue, JsonFormat.AttributeValue>, callback?: Callback<UpdateItemOutput<Item, PartitionKey, RangeKey, Key, ReturnValue, JsonFormat.AttributeValue>, AWSError>): Request<UpdateItemOutput<Item, PartitionKey, RangeKey, Key, ReturnValue, JsonFormat.AttributeValue>, AWSError>;
+    query<KeyConditionExpression extends string | undefined = undefined, FilterExpression extends string | undefined = undefined, ProjectionExpression extends string | undefined = undefined, AttributesToGet extends keyof Item | undefined = undefined>(params: QueryInput<Item, KeyConditionExpression, FilterExpression, ProjectionExpression, AttributesToGet, JsonFormat.AttributeValue>, callback?: Callback<QueryOutput<Item, AttributesToGet, JsonFormat.AttributeValue>, AWSError>): Request<QueryOutput<Item, AttributesToGet, JsonFormat.AttributeValue>, AWSError>;
+    scan<FilterExpression extends string | undefined = undefined, ProjectionExpression extends string | undefined = undefined, AttributesToGet extends keyof Item | undefined = undefined>(params: ScanInput<Item, FilterExpression, ProjectionExpression, AttributesToGet, JsonFormat.AttributeValue>, callback?: Callback<ScanOutput<Item, AttributesToGet, JsonFormat.AttributeValue>, AWSError>): Request<ScanOutput<Item, AttributesToGet, JsonFormat.AttributeValue>, AWSError>;
+}