@infra-blocks/aws-dynamodb 0.1.0-alpha.0

package/README.md

@@ -0,0 +1,12 @@
+# ts-aws-dynamodb
+[![Build](https://github.com/infra-blocks/ts-aws-dynamodb/actions/workflows/build.yml/badge.svg)](https://github.com/infra-blocks/ts-aws-dynamodb/actions/workflows/build.yml)
+[![Release](https://github.com/infra-blocks/ts-aws-dynamodb/actions/workflows/release.yml/badge.svg)](https://github.com/infra-blocks/ts-aws-dynamodb/actions/workflows/release.yml)
+[![codecov](https://codecov.io/gh/infra-blocks/ts-aws-dynamodb/graph/badge.svg?token=4TB4Y7AINE)](https://codecov.io/gh/infra-blocks/ts-aws-dynamodb)
+
+A convenience library wrapper around [`@aws-sdk/client-dynamodb`](https://www.npmjs.com/package/@aws-sdk/client-dynamodb) and
+[`@aws-sdk/lib-dynamodb`](https://www.npmjs.com/package/@aws-sdk/lib-dynamodb). The wrapper offers:
+- More type safe interfaces (trough the use of descriptive types, such as for condition expressions).
+- More conventional field names. Input and output fields use the conventional `camelCase` JS/TS convention over the `PascalCase`
+imposed by the AWS APIs.
+- Every client error is wrapped into a error adding description about which operation triggered the error.
+- Pagination is provided for APIs that support it and exposed as `AsyncIterators`.

package/lib/cjs/client.d.ts

@@ -0,0 +1,37 @@
+import type { DynamoDBClientConfig } from "@aws-sdk/client-dynamodb";
+import { DynamoDBClient as BaseClient } from "@aws-sdk/client-dynamodb";
+import type { TranslateConfig } from "@aws-sdk/lib-dynamodb";
+import { DynamoDBDocumentClient as Client } from "@aws-sdk/lib-dynamodb";
+import type { Logger } from "@infra-blocks/logger-interface";
+import { type Retry } from "@infra-blocks/retry";
+import type { Attributes, GetItem, PutItem, Query, WriteTransaction } from "./types.js";
+export declare class DynamoDbClientError extends Error {
+    constructor(message: string, options?: {
+        cause?: unknown;
+    });
+}
+export declare class DynamoDbClient {
+    private readonly client;
+    private readonly logger;
+    private constructor();
+    ready(): Retry<void>;
+    getItem<T>(params: GetItem): Promise<T | undefined>;
+    putItem(params: PutItem): Promise<void>;
+    transactWriteItems(params: WriteTransaction): Promise<void>;
+    query<T extends Attributes = Attributes>(query: Query): AsyncGenerator<T>;
+    queryOne<T extends Attributes = Attributes>(query: Query): Promise<T | undefined>;
+    static fromBase(params: {
+        client: BaseClient;
+        document?: TranslateConfig;
+        logger?: Logger;
+    }): DynamoDbClient;
+    static from(params: {
+        client: Client;
+        logger?: Logger;
+    }): DynamoDbClient;
+    static create(params?: {
+        base?: DynamoDBClientConfig;
+        document?: TranslateConfig;
+        logger?: Logger;
+    }): DynamoDbClient;
+}

package/lib/cjs/client.js

@@ -0,0 +1,175 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DynamoDbClient = exports.DynamoDbClientError = void 0;
+const client_dynamodb_1 = require("@aws-sdk/client-dynamodb");
+const lib_dynamodb_1 = require("@aws-sdk/lib-dynamodb");
+const null_logger_1 = require("@infra-blocks/null-logger");
+const retry_1 = require("@infra-blocks/retry");
+class DynamoDbClientError extends Error {
+    constructor(message, options) {
+        super(message, options);
+        this.name = "DynamoDbClientError";
+    }
+}
+exports.DynamoDbClientError = DynamoDbClientError;
+/*
+The uniqueness constraint of an attribute, for example an email, can be enforced in DynamoDB using
+this scheme: https://aws.amazon.com/blogs/database/simulating-amazon-dynamodb-unique-constraints-using-transactions/#:~:text=Primary%20keys%20are%20guaranteed%20to,are%20not%20the%20primary%20key.
+
+This is to say, we can create items in a different table that only has a pk for this specific use case, or we could
+also use the same table. It's just going to add some sheeet to the table.
+*/
+class DynamoDbClient {
+    client;
+    logger;
+    constructor(params) {
+        const { client, logger } = params;
+        this.client = client;
+        this.logger = logger;
+    }
+    ready() {
+        return (0, retry_1.retry)(async () => {
+            await this.client.send(new client_dynamodb_1.ListTablesCommand({}));
+        }, {
+            isRetryableError: (err) => {
+                if ("code" in err) {
+                    return err.code === "ECONNRESET";
+                }
+                return false;
+            },
+        });
+    }
+    async getItem(params) {
+        try {
+            const { table, parititionKey, sortKey } = params;
+            const key = {
+                [parititionKey.name]: parititionKey.value,
+            };
+            if (sortKey != null) {
+                key[sortKey.name] = sortKey.value;
+            }
+            const response = await this.client.send(new lib_dynamodb_1.GetCommand({
+                TableName: table,
+                Key: key,
+            }));
+            return response.Item;
+        }
+        catch (err) {
+            throw new DynamoDbClientError(`error while getting item from DynamoDB: ${JSON.stringify(params)}`, {
+                cause: err,
+            });
+        }
+    }
+    async putItem(params) {
+        try {
+            await this.client.send(toPutCommand(params));
+        }
+        catch (err) {
+            this.logger.error("error while putting item in DynamoDB caused by %s", err);
+            throw new DynamoDbClientError("error while putting item in DynamoDB", {
+                cause: err,
+            });
+        }
+    }
+    async transactWriteItems(params) {
+        try {
+            const commandInput = toTransactWriteItemsCommandInput(params);
+            if (this.logger.isDebugEnabled()) {
+                this.logger.debug("executing transaction write: %s", JSON.stringify(commandInput));
+            }
+            const command = new lib_dynamodb_1.TransactWriteCommand(commandInput);
+            await this.client.send(command);
+        }
+        catch (err) {
+            throw new DynamoDbClientError("error while transactionally writing items in DynamoDB", {
+                cause: err,
+            });
+        }
+    }
+    async *query(query) {
+        try {
+            const { expression, attributeValues } = query.condition.toJson();
+            let response = await this.client.send(new lib_dynamodb_1.QueryCommand({
+                TableName: query.table,
+                IndexName: query.index,
+                KeyConditionExpression: expression,
+                ExpressionAttributeValues: attributeValues,
+            }));
+            for (const item of response.Items || []) {
+                yield item;
+            }
+            while (response.LastEvaluatedKey != null) {
+                response = await this.client.send(new lib_dynamodb_1.QueryCommand({
+                    TableName: query.table,
+                    IndexName: query.index,
+                    KeyConditionExpression: expression,
+                    ExpressionAttributeValues: attributeValues,
+                    ExclusiveStartKey: response.LastEvaluatedKey,
+                }));
+                for (const item of response.Items || []) {
+                    yield item;
+                }
+            }
+        }
+        catch (err) {
+            throw new DynamoDbClientError("error while querying DynamoDB on the lookup index", {
+                cause: err,
+            });
+        }
+    }
+    async queryOne(query) {
+        try {
+            let item;
+            for await (const queryItem of this.query(query)) {
+                if (item != null) {
+                    throw new DynamoDbClientError("expected one item in query but found at least 2");
+                }
+                item = queryItem;
+            }
+            return item;
+        }
+        catch (err) {
+            // TODO: careful here as email is PII.
+            throw new DynamoDbClientError(`error while querying one: ${JSON.stringify(query)}`, {
+                cause: err,
+            });
+        }
+    }
+    static fromBase(params) {
+        const { client, document: documentClientConfig, logger } = params;
+        const documentClient = lib_dynamodb_1.DynamoDBDocumentClient.from(client, documentClientConfig);
+        return DynamoDbClient.from({ client: documentClient, logger });
+    }
+    static from(params) {
+        const { client, logger = null_logger_1.NullLogger.create() } = params;
+        return new DynamoDbClient({ client, logger });
+    }
+    static create(params) {
+        const { base, document, logger } = params || {};
+        const baseClient = new client_dynamodb_1.DynamoDBClient(base || {});
+        return DynamoDbClient.fromBase({ client: baseClient, document, logger });
+    }
+}
+exports.DynamoDbClient = DynamoDbClient;
+// Could be associated on the PutItem type if it was an opaque type rather
+// than an interface.
+function toPutCommand(params) {
+    return new lib_dynamodb_1.PutCommand(toToPutCommandInput(params));
+}
+function toToPutCommandInput(params) {
+    const { table, item, condition } = params;
+    const conditionPayload = condition != null ? condition.toAwsInput() : {};
+    return {
+        TableName: table,
+        Item: item,
+        ...conditionPayload,
+    };
+}
+function toTransactWriteItemsCommandInput(params) {
+    return {
+        TransactItems: params.items.map((item) => ({
+            Put: toToPutCommandInput(item),
+        })),
+    };
+}
+//# sourceMappingURL=client.js.map

package/lib/cjs/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../src/client.ts"],"names":[],"mappings":";;;AACA,8DAGkC;AAMlC,wDAM+B;AAE/B,2DAAuD;AACvD,+CAAwD;AASxD,MAAa,mBAAoB,SAAQ,KAAK;IAC5C,YAAY,OAAe,EAAE,OAA6B;QACxD,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,qBAAqB,CAAC;IACpC,CAAC;CACF;AALD,kDAKC;AAED;;;;;;EAME;AACF,MAAa,cAAc;IACR,MAAM,CAAS;IACf,MAAM,CAAS;IAEhC,YAAoB,MAA0C;QAC5D,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;QAClC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,KAAK;QACH,OAAO,IAAA,aAAK,EACV,KAAK,IAAI,EAAE;YACT,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,mCAAiB,CAAC,EAAE,CAAC,CAAC,CAAC;QACpD,CAAC,EACD;YACE,gBAAgB,EAAE,CAAC,GAAU,EAAE,EAAE;gBAC/B,IAAI,MAAM,IAAI,GAAG,EAAE,CAAC;oBAClB,OAAO,GAAG,CAAC,IAAI,KAAK,YAAY,CAAC;gBACnC,CAAC;gBACD,OAAO,KAAK,CAAC;YACf,CAAC;SACF,CACF,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,OAAO,CAAI,MAAe;QAC9B,IAAI,CAAC;YACH,MAAM,EAAE,KAAK,EAAE,aAAa,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;YACjD,MAAM,GAAG,GAAG;gBACV,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,aAAa,CAAC,KAAK;aAC1C,CAAC;YACF,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;gBACpB,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC;YACpC,CAAC;YAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CACrC,IAAI,yBAAU,CAAC;gBACb,SAAS,EAAE,KAAK;gBAChB,GAAG,EAAE,GAAG;aACT,CAAC,CACH,CAAC;YAEF,OAAO,QAAQ,CAAC,IAAqB,CAAC;QACxC,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,IAAI,mBAAmB,CAC3B,2CAA2C,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,EACnE;gBACE,KAAK,EAAE,GAAG;aACX,CACF,CAAC;QACJ,CAAC;IACH,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,MAAe;QAC3B,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;QAC/C,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,mDAAmD,EACnD,GAAG,CACJ,CAAC;YACF,MAAM,IAAI,mBAAmB,CAAC,sCAAsC,EAAE;gBACpE,KAAK,EAAE,GAAG;aACX,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,MAAwB;QAC/C,IAAI,CAAC;YACH,MAAM,YAAY,GAAG,gCAAgC,CAAC,MAAM,CAAC,CAAC;YAC9D,IAAI,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,EAAE,CAAC;gBACjC,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,iCAAiC,EACjC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAC7B,CAAC;YACJ,CAAC;YACD,MAAM,OAAO,GAAG,IAAI,mCAAoB,CAAC,YAAY,CAAC,CAAC;YACvD,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAClC,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,IAAI,mBAAmB,CAC3B,uDAAuD,EACvD;gBACE,KAAK,EAAE,GAAG;aACX,CACF,CAAC;QACJ,CAAC;IACH,CAAC;IAED,KAAK,CAAC,CAAC,KAAK,CACV,KAAY;QAEZ,IAAI,CAAC;YACH,MAAM,EAAE,UAAU,EAAE,eAAe,EAAE,GAAG,KAAK,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;YACjE,IAAI,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CACnC,IAAI,2BAAY,CAAC;gBACf,SAAS,EAAE,KAAK,CAAC,KAAK;gBACtB,SAAS,EAAE,KAAK,CAAC,KAAK;gBACtB,sBAAsB,EAAE,UAAU;gBAClC,yBAAyB,EAAE,eAAe;aAC3C,CAAC,CACH,CAAC;YAEF,KAAK,MAAM,IAAI,IAAI,QAAQ,CAAC,KAAK,IAAI,EAAE,EAAE,CAAC;gBACxC,MAAM,IAAS,CAAC;YAClB,CAAC;YAED,OAAO,QAAQ,CAAC,gBAAgB,IAAI,IAAI,EAAE,CAAC;gBACzC,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAC/B,IAAI,2BAAY,CAAC;oBACf,SAAS,EAAE,KAAK,CAAC,KAAK;oBACtB,SAAS,EAAE,KAAK,CAAC,KAAK;oBACtB,sBAAsB,EAAE,UAAU;oBAClC,yBAAyB,EAAE,eAAe;oBAC1C,iBAAiB,EAAE,QAAQ,CAAC,gBAAgB;iBAC7C,CAAC,CACH,CAAC;gBAEF,KAAK,MAAM,IAAI,IAAI,QAAQ,CAAC,KAAK,IAAI,EAAE,EAAE,CAAC;oBACxC,MAAM,IAAS,CAAC;gBAClB,CAAC;YACH,CAAC;QACH,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,IAAI,mBAAmB,CAC3B,mDAAmD,EACnD;gBACE,KAAK,EAAE,GAAG;aACX,CACF,CAAC;QACJ,CAAC;IACH,CAAC;IAED,KAAK,CAAC,QAAQ,CACZ,KAAY;QAEZ,IAAI,CAAC;YACH,IAAI,IAAmB,CAAC;YACxB,IAAI,KAAK,EAAE,MAAM,SAAS,IAAI,IAAI,CAAC,KAAK,CAAI,KAAK,CAAC,EAAE,CAAC;gBACnD,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;oBACjB,MAAM,IAAI,mBAAmB,CAC3B,iDAAiD,CAClD,CAAC;gBACJ,CAAC;gBACD,IAAI,GAAG,SAAS,CAAC;YACnB,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,sCAAsC;YACtC,MAAM,IAAI,mBAAmB,CAC3B,6BAA6B,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,EACpD;gBACE,KAAK,EAAE,GAAG;aACX,CACF,CAAC;QACJ,CAAC;IACH,CAAC;IAED,MAAM,CAAC,QAAQ,CAAC,MAIf;QACC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,oBAAoB,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;QAClE,MAAM,cAAc,GAAG,qCAAM,CAAC,IAAI,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;QACjE,OAAO,cAAc,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,CAAC,CAAC;IACjE,CAAC;IAED,MAAM,CAAC,IAAI,CAAC,MAA2C;QACrD,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,wBAAU,CAAC,MAAM,EAAE,EAAE,GAAG,MAAM,CAAC;QACxD,OAAO,IAAI,cAAc,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IAChD,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,MAIb;QACC,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAChD,MAAM,UAAU,GAAG,IAAI,gCAAU,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;QAC9C,OAAO,cAAc,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;IAC3E,CAAC;CACF;AArLD,wCAqLC;AAED,0EAA0E;AAC1E,qBAAqB;AACrB,SAAS,YAAY,CAAC,MAAe;IACnC,OAAO,IAAI,yBAAU,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC,CAAC;AACrD,CAAC;AAED,SAAS,mBAAmB,CAAC,MAAe;IAC1C,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;IAC1C,MAAM,gBAAgB,GAAG,SAAS,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACzE,OAAO;QACL,SAAS,EAAE,KAAK;QAChB,IAAI,EAAE,IAAI;QACV,GAAG,gBAAgB;KACpB,CAAC;AACJ,CAAC;AAED,SAAS,gCAAgC,CACvC,MAAwB;IAExB,OAAO;QACL,aAAa,EAAE,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YACzC,GAAG,EAAE,mBAAmB,CAAC,IAAI,CAAC;SAC/B,CAAC,CAAC;KACJ,CAAC;AACJ,CAAC"}

package/lib/cjs/condition-expression.d.ts

@@ -0,0 +1,19 @@
+import type { AttributePath, AttributeType, AttributeValue } from "./types.js";
+type AttributeSubstitution = `#${string}`;
+type ValueReference = `:${string}`;
+export type ExpressionAwsInput = {
+    ConditionExpression: string;
+    ExpressionAttributeNames?: Record<AttributeSubstitution, AttributePath>;
+    ExpressionAttributeValues?: Record<ValueReference, AttributeValue>;
+};
+export declare class ConditionExpression {
+    private readonly expression;
+    private readonly substitutions?;
+    private readonly values?;
+    private constructor();
+    toAwsInput(): ExpressionAwsInput;
+    static attributeNotExists(attribute: AttributePath): ConditionExpression;
+    static attributeExists(attribute: AttributePath): ConditionExpression;
+    static attributeType(attribute: AttributePath, type: AttributeType): ConditionExpression;
+}
+export {};

package/lib/cjs/condition-expression.js

@@ -0,0 +1,117 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConditionExpression = void 0;
+/**
+ * Represents a set of attribute names used in a condition expression.
+ *
+ * The uses cases for using attribute names are:
+ * - To access an attribute whose name conflicts with a DynamoDB reserved word.
+ * - To create a placeholder for repeating occurrences of an attribute name in an expression.
+ * - To prevent special characters in an attribute name from being misinterpreted in an expression.
+ */
+class AttributeSubstitutions {
+    names;
+    constructor() {
+        this.names = new Map();
+    }
+    substitute(attribute) {
+        const existing = this.names.get(attribute);
+        if (existing != null) {
+            return existing;
+        }
+        const substitute = this.generateSubstitute(attribute);
+        this.names.set(attribute, substitute);
+        return substitute;
+    }
+    toAwsInput() {
+        const result = {};
+        for (const [attribute, substitute] of this.names.entries()) {
+            result[substitute] = attribute;
+        }
+        return result;
+    }
+    generateSubstitute(attribute) {
+        return `#${attribute}`;
+    }
+}
+class AttributeValues {
+    values;
+    counter;
+    constructor() {
+        this.values = new Map();
+        this.counter = 0;
+    }
+    referenceBy(value) {
+        const existing = this.values.get(value);
+        if (existing != null) {
+            return existing;
+        }
+        const reference = this.generateReference();
+        this.values.set(value, reference);
+        return reference;
+    }
+    toAwsInput() {
+        const result = {};
+        for (const [value, reference] of this.values.entries()) {
+            result[reference] = value;
+        }
+        return result;
+    }
+    generateReference() {
+        const reference = `:${this.counter}`;
+        this.counter += 1;
+        return reference;
+    }
+}
+class ConditionExpression {
+    expression;
+    substitutions;
+    values;
+    constructor(params) {
+        const { expression, substitutions, values } = params;
+        this.expression = expression;
+        this.substitutions = substitutions;
+        this.values = values;
+    }
+    toAwsInput() {
+        const result = {
+            ConditionExpression: this.expression,
+        };
+        if (this.substitutions != null) {
+            result.ExpressionAttributeNames = this.substitutions.toAwsInput();
+        }
+        if (this.values != null) {
+            result.ExpressionAttributeValues = this.values.toAwsInput();
+        }
+        return result;
+    }
+    static attributeNotExists(attribute) {
+        const substitutions = new AttributeSubstitutions();
+        const sub = substitutions.substitute(attribute);
+        return new ConditionExpression({
+            expression: `attribute_not_exists(${sub})`,
+            substitutions,
+        });
+    }
+    static attributeExists(attribute) {
+        const substitutions = new AttributeSubstitutions();
+        const sub = substitutions.substitute(attribute);
+        return new ConditionExpression({
+            expression: `attribute_exists(${sub})`,
+            substitutions,
+        });
+    }
+    static attributeType(attribute, type) {
+        const substitutions = new AttributeSubstitutions();
+        const sub = substitutions.substitute(attribute);
+        const values = new AttributeValues();
+        const valueRef = values.referenceBy(type);
+        return new ConditionExpression({
+            expression: `attribute_type(${sub}, ${valueRef})`,
+            substitutions,
+            values,
+        });
+    }
+}
+exports.ConditionExpression = ConditionExpression;
+//# sourceMappingURL=condition-expression.js.map

package/lib/cjs/condition-expression.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"condition-expression.js","sourceRoot":"","sources":["../../src/condition-expression.ts"],"names":[],"mappings":";;;AAIA;;;;;;;GAOG;AACH,MAAM,sBAAsB;IACT,KAAK,CAA4C;IAElE;QACE,IAAI,CAAC,KAAK,GAAG,IAAI,GAAG,EAAwC,CAAC;IAC/D,CAAC;IAED,UAAU,CAAC,SAAwB;QACjC,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAC3C,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;YACrB,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,MAAM,UAAU,GAAG,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;QACtD,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QACtC,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,UAAU;QACR,MAAM,MAAM,GAAiD,EAAE,CAAC;QAChE,KAAK,MAAM,CAAC,SAAS,EAAE,UAAU,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC;YAC3D,MAAM,CAAC,UAAU,CAAC,GAAG,SAAS,CAAC;QACjC,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,kBAAkB,CAAC,SAAwB;QACjD,OAAO,IAAI,SAAS,EAA2B,CAAC;IAClD,CAAC;CACF;AAID,MAAM,eAAe;IACF,MAAM,CAAsC;IACrD,OAAO,CAAS;IAExB;QACE,IAAI,CAAC,MAAM,GAAG,IAAI,GAAG,EAAkC,CAAC;QACxD,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC;IACnB,CAAC;IAED,WAAW,CAAC,KAAqB;QAC/B,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACxC,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;YACrB,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,MAAM,SAAS,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC3C,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QAClC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,UAAU;QACR,MAAM,MAAM,GAA2C,EAAE,CAAC;QAC1D,KAAK,MAAM,CAAC,KAAK,EAAE,SAAS,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,CAAC;YACvD,MAAM,CAAC,SAAS,CAAC,GAAG,KAAK,CAAC;QAC5B,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,iBAAiB;QACvB,MAAM,SAAS,GAAG,IAAI,IAAI,CAAC,OAAO,EAAoB,CAAC;QACvD,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC;QAClB,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AAQD,MAAa,mBAAmB;IACb,UAAU,CAAS;IACnB,aAAa,CAA0B;IACvC,MAAM,CAAmB;IAE1C,YAAoB,MAInB;QACC,MAAM,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;QACrD,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,UAAU;QACR,MAAM,MAAM,GAAuB;YACjC,mBAAmB,EAAE,IAAI,CAAC,UAAU;SACrC,CAAC;QACF,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,EAAE,CAAC;YAC/B,MAAM,CAAC,wBAAwB,GAAG,IAAI,CAAC,aAAa,CAAC,UAAU,EAAE,CAAC;QACpE,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE,CAAC;YACxB,MAAM,CAAC,yBAAyB,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;QAC9D,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,MAAM,CAAC,kBAAkB,CAAC,SAAwB;QAChD,MAAM,aAAa,GAAG,IAAI,sBAAsB,EAAE,CAAC;QACnD,MAAM,GAAG,GAAG,aAAa,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QAChD,OAAO,IAAI,mBAAmB,CAAC;YAC7B,UAAU,EAAE,wBAAwB,GAAG,GAAG;YAC1C,aAAa;SACd,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,eAAe,CAAC,SAAwB;QAC7C,MAAM,aAAa,GAAG,IAAI,sBAAsB,EAAE,CAAC;QACnD,MAAM,GAAG,GAAG,aAAa,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QAChD,OAAO,IAAI,mBAAmB,CAAC;YAC7B,UAAU,EAAE,oBAAoB,GAAG,GAAG;YACtC,aAAa;SACd,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,aAAa,CAClB,SAAwB,EACxB,IAAmB;QAEnB,MAAM,aAAa,GAAG,IAAI,sBAAsB,EAAE,CAAC;QACnD,MAAM,GAAG,GAAG,aAAa,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QAChD,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;QACrC,MAAM,QAAQ,GAAG,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QAC1C,OAAO,IAAI,mBAAmB,CAAC;YAC7B,UAAU,EAAE,kBAAkB,GAAG,KAAK,QAAQ,GAAG;YACjD,aAAa;YACb,MAAM;SACP,CAAC,CAAC;IACL,CAAC;CACF;AA7DD,kDA6DC"}

package/lib/cjs/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./client.js";
+export * from "./condition-expression.js";
+export * from "./key-condition-expression.js";
+export * from "./types.js";

package/lib/cjs/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./client.js"), exports);
+__exportStar(require("./condition-expression.js"), exports);
+__exportStar(require("./key-condition-expression.js"), exports);
+__exportStar(require("./types.js"), exports);
+//# sourceMappingURL=index.js.map

package/lib/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA4B;AAC5B,4DAA0C;AAC1C,gEAA8C;AAC9C,6CAA2B"}

package/lib/cjs/key-condition-expression.d.ts

@@ -0,0 +1,20 @@
+import type { Attributes } from "./types.js";
+export declare class KeyConditionExpression {
+    private readonly expression;
+    private readonly attributeValues;
+    private constructor();
+    toJson(): {
+        expression: string;
+        attributeValues: Attributes;
+    };
+    static partitionKeyEquals(params: {
+        attributeName: string;
+        value: string;
+        token?: string;
+    }): KeyConditionExpression;
+    static equals(params: {
+        attributeName: string;
+        value: string;
+        token: string;
+    }): KeyConditionExpression;
+}

package/lib/cjs/key-condition-expression.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KeyConditionExpression = void 0;
+class KeyConditionExpression {
+    expression;
+    attributeValues;
+    constructor(params) {
+        const { expression, attributeValues } = params;
+        this.expression = expression;
+        this.attributeValues = attributeValues;
+    }
+    toJson() {
+        return {
+            expression: this.expression,
+            attributeValues: this.attributeValues,
+        };
+    }
+    static partitionKeyEquals(params) {
+        const { attributeName, value, token = ":pk" } = params;
+        return KeyConditionExpression.equals({
+            attributeName,
+            value,
+            token,
+        });
+    }
+    static equals(params) {
+        const { attributeName, value, token } = params;
+        return new KeyConditionExpression({
+            expression: `${attributeName} = ${token}`,
+            attributeValues: { [token]: value },
+        });
+    }
+}
+exports.KeyConditionExpression = KeyConditionExpression;
+//# sourceMappingURL=key-condition-expression.js.map

package/lib/cjs/key-condition-expression.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"key-condition-expression.js","sourceRoot":"","sources":["../../src/key-condition-expression.ts"],"names":[],"mappings":";;;AAEA,MAAa,sBAAsB;IAChB,UAAU,CAAS;IACnB,eAAe,CAAa;IAE7C,YAAoB,MAGnB;QACC,MAAM,EAAE,UAAU,EAAE,eAAe,EAAE,GAAG,MAAM,CAAC;QAC/C,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;IACzC,CAAC;IAED,MAAM;QACJ,OAAO;YACL,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,eAAe,EAAE,IAAI,CAAC,eAAe;SACtC,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,kBAAkB,CAAC,MAIzB;QACC,MAAM,EAAE,aAAa,EAAE,KAAK,EAAE,KAAK,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACvD,OAAO,sBAAsB,CAAC,MAAM,CAAC;YACnC,aAAa;YACb,KAAK;YACL,KAAK;SACN,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,MAIb;QACC,MAAM,EAAE,aAAa,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC;QAE/C,OAAO,IAAI,sBAAsB,CAAC;YAChC,UAAU,EAAE,GAAG,aAAa,MAAM,KAAK,EAAE;YACzC,eAAe,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE;SACpC,CAAC,CAAC;IACL,CAAC;CACF;AA7CD,wDA6CC"}

package/lib/cjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/lib/cjs/types.d.ts

@@ -0,0 +1,30 @@
+import type { NativeAttributeValue } from "@aws-sdk/lib-dynamodb";
+import type { ConditionExpression } from "./condition-expression.js";
+import type { KeyConditionExpression } from "./key-condition-expression.js";
+export type AttributeName = string;
+export type AttributeValue = NativeAttributeValue;
+export type AttributePath = AttributeName;
+export type AttributeType = "S" | "N" | "B" | "BOOL" | "NULL" | "M" | "L" | "SS" | "NS" | "BS";
+export interface Attribute {
+    name: AttributeName;
+    value: AttributeValue;
+}
+export type Attributes = Record<AttributeName, NativeAttributeValue>;
+export interface GetItem {
+    table: string;
+    parititionKey: Attribute;
+    sortKey?: Attribute;
+}
+export interface PutItem {
+    table: string;
+    item: Attributes;
+    condition?: ConditionExpression;
+}
+export interface WriteTransaction {
+    items: PutItem[];
+}
+export interface Query {
+    table: string;
+    index?: string;
+    condition: KeyConditionExpression;
+}

package/lib/cjs/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/lib/cjs/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":""}

package/lib/esm/client.d.ts

@@ -0,0 +1,37 @@
+import type { DynamoDBClientConfig } from "@aws-sdk/client-dynamodb";
+import { DynamoDBClient as BaseClient } from "@aws-sdk/client-dynamodb";
+import type { TranslateConfig } from "@aws-sdk/lib-dynamodb";
+import { DynamoDBDocumentClient as Client } from "@aws-sdk/lib-dynamodb";
+import type { Logger } from "@infra-blocks/logger-interface";
+import { type Retry } from "@infra-blocks/retry";
+import type { Attributes, GetItem, PutItem, Query, WriteTransaction } from "./types.js";
+export declare class DynamoDbClientError extends Error {
+    constructor(message: string, options?: {
+        cause?: unknown;
+    });
+}
+export declare class DynamoDbClient {
+    private readonly client;
+    private readonly logger;
+    private constructor();
+    ready(): Retry<void>;
+    getItem<T>(params: GetItem): Promise<T | undefined>;
+    putItem(params: PutItem): Promise<void>;
+    transactWriteItems(params: WriteTransaction): Promise<void>;
+    query<T extends Attributes = Attributes>(query: Query): AsyncGenerator<T>;
+    queryOne<T extends Attributes = Attributes>(query: Query): Promise<T | undefined>;
+    static fromBase(params: {
+        client: BaseClient;
+        document?: TranslateConfig;
+        logger?: Logger;
+    }): DynamoDbClient;
+    static from(params: {
+        client: Client;
+        logger?: Logger;
+    }): DynamoDbClient;
+    static create(params?: {
+        base?: DynamoDBClientConfig;
+        document?: TranslateConfig;
+        logger?: Logger;
+    }): DynamoDbClient;
+}

package/lib/esm/client.js

@@ -0,0 +1,170 @@
+import { DynamoDBClient as BaseClient, ListTablesCommand, } from "@aws-sdk/client-dynamodb";
+import { DynamoDBDocumentClient as Client, GetCommand, PutCommand, QueryCommand, TransactWriteCommand, } from "@aws-sdk/lib-dynamodb";
+import { NullLogger } from "@infra-blocks/null-logger";
+import { retry } from "@infra-blocks/retry";
+export class DynamoDbClientError extends Error {
+    constructor(message, options) {
+        super(message, options);
+        this.name = "DynamoDbClientError";
+    }
+}
+/*
+The uniqueness constraint of an attribute, for example an email, can be enforced in DynamoDB using
+this scheme: https://aws.amazon.com/blogs/database/simulating-amazon-dynamodb-unique-constraints-using-transactions/#:~:text=Primary%20keys%20are%20guaranteed%20to,are%20not%20the%20primary%20key.
+
+This is to say, we can create items in a different table that only has a pk for this specific use case, or we could
+also use the same table. It's just going to add some sheeet to the table.
+*/
+export class DynamoDbClient {
+    client;
+    logger;
+    constructor(params) {
+        const { client, logger } = params;
+        this.client = client;
+        this.logger = logger;
+    }
+    ready() {
+        return retry(async () => {
+            await this.client.send(new ListTablesCommand({}));
+        }, {
+            isRetryableError: (err) => {
+                if ("code" in err) {
+                    return err.code === "ECONNRESET";
+                }
+                return false;
+            },
+        });
+    }
+    async getItem(params) {
+        try {
+            const { table, parititionKey, sortKey } = params;
+            const key = {
+                [parititionKey.name]: parititionKey.value,
+            };
+            if (sortKey != null) {
+                key[sortKey.name] = sortKey.value;
+            }
+            const response = await this.client.send(new GetCommand({
+                TableName: table,
+                Key: key,
+            }));
+            return response.Item;
+        }
+        catch (err) {
+            throw new DynamoDbClientError(`error while getting item from DynamoDB: ${JSON.stringify(params)}`, {
+                cause: err,
+            });
+        }
+    }
+    async putItem(params) {
+        try {
+            await this.client.send(toPutCommand(params));
+        }
+        catch (err) {
+            this.logger.error("error while putting item in DynamoDB caused by %s", err);
+            throw new DynamoDbClientError("error while putting item in DynamoDB", {
+                cause: err,
+            });
+        }
+    }
+    async transactWriteItems(params) {
+        try {
+            const commandInput = toTransactWriteItemsCommandInput(params);
+            if (this.logger.isDebugEnabled()) {
+                this.logger.debug("executing transaction write: %s", JSON.stringify(commandInput));
+            }
+            const command = new TransactWriteCommand(commandInput);
+            await this.client.send(command);
+        }
+        catch (err) {
+            throw new DynamoDbClientError("error while transactionally writing items in DynamoDB", {
+                cause: err,
+            });
+        }
+    }
+    async *query(query) {
+        try {
+            const { expression, attributeValues } = query.condition.toJson();
+            let response = await this.client.send(new QueryCommand({
+                TableName: query.table,
+                IndexName: query.index,
+                KeyConditionExpression: expression,
+                ExpressionAttributeValues: attributeValues,
+            }));
+            for (const item of response.Items || []) {
+                yield item;
+            }
+            while (response.LastEvaluatedKey != null) {
+                response = await this.client.send(new QueryCommand({
+                    TableName: query.table,
+                    IndexName: query.index,
+                    KeyConditionExpression: expression,
+                    ExpressionAttributeValues: attributeValues,
+                    ExclusiveStartKey: response.LastEvaluatedKey,
+                }));
+                for (const item of response.Items || []) {
+                    yield item;
+                }
+            }
+        }
+        catch (err) {
+            throw new DynamoDbClientError("error while querying DynamoDB on the lookup index", {
+                cause: err,
+            });
+        }
+    }
+    async queryOne(query) {
+        try {
+            let item;
+            for await (const queryItem of this.query(query)) {
+                if (item != null) {
+                    throw new DynamoDbClientError("expected one item in query but found at least 2");
+                }
+                item = queryItem;
+            }
+            return item;
+        }
+        catch (err) {
+            // TODO: careful here as email is PII.
+            throw new DynamoDbClientError(`error while querying one: ${JSON.stringify(query)}`, {
+                cause: err,
+            });
+        }
+    }
+    static fromBase(params) {
+        const { client, document: documentClientConfig, logger } = params;
+        const documentClient = Client.from(client, documentClientConfig);
+        return DynamoDbClient.from({ client: documentClient, logger });
+    }
+    static from(params) {
+        const { client, logger = NullLogger.create() } = params;
+        return new DynamoDbClient({ client, logger });
+    }
+    static create(params) {
+        const { base, document, logger } = params || {};
+        const baseClient = new BaseClient(base || {});
+        return DynamoDbClient.fromBase({ client: baseClient, document, logger });
+    }
+}
+// Could be associated on the PutItem type if it was an opaque type rather
+// than an interface.
+function toPutCommand(params) {
+    return new PutCommand(toToPutCommandInput(params));
+}
+function toToPutCommandInput(params) {
+    const { table, item, condition } = params;
+    const conditionPayload = condition != null ? condition.toAwsInput() : {};
+    return {
+        TableName: table,
+        Item: item,
+        ...conditionPayload,
+    };
+}
+function toTransactWriteItemsCommandInput(params) {
+    return {
+        TransactItems: params.items.map((item) => ({
+            Put: toToPutCommandInput(item),
+        })),
+    };
+}
+//# sourceMappingURL=client.js.map

package/lib/esm/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../src/client.ts"],"names":[],"mappings":"AACA,OAAO,EACL,cAAc,IAAI,UAAU,EAC5B,iBAAiB,GAClB,MAAM,0BAA0B,CAAC;AAMlC,OAAO,EACL,sBAAsB,IAAI,MAAM,EAChC,UAAU,EACV,UAAU,EACV,YAAY,EACZ,oBAAoB,GACrB,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACvD,OAAO,EAAc,KAAK,EAAE,MAAM,qBAAqB,CAAC;AASxD,MAAM,OAAO,mBAAoB,SAAQ,KAAK;IAC5C,YAAY,OAAe,EAAE,OAA6B;QACxD,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,qBAAqB,CAAC;IACpC,CAAC;CACF;AAED;;;;;;EAME;AACF,MAAM,OAAO,cAAc;IACR,MAAM,CAAS;IACf,MAAM,CAAS;IAEhC,YAAoB,MAA0C;QAC5D,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;QAClC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,KAAK;QACH,OAAO,KAAK,CACV,KAAK,IAAI,EAAE;YACT,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAC;QACpD,CAAC,EACD;YACE,gBAAgB,EAAE,CAAC,GAAU,EAAE,EAAE;gBAC/B,IAAI,MAAM,IAAI,GAAG,EAAE,CAAC;oBAClB,OAAO,GAAG,CAAC,IAAI,KAAK,YAAY,CAAC;gBACnC,CAAC;gBACD,OAAO,KAAK,CAAC;YACf,CAAC;SACF,CACF,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,OAAO,CAAI,MAAe;QAC9B,IAAI,CAAC;YACH,MAAM,EAAE,KAAK,EAAE,aAAa,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;YACjD,MAAM,GAAG,GAAG;gBACV,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,aAAa,CAAC,KAAK;aAC1C,CAAC;YACF,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;gBACpB,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC;YACpC,CAAC;YAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CACrC,IAAI,UAAU,CAAC;gBACb,SAAS,EAAE,KAAK;gBAChB,GAAG,EAAE,GAAG;aACT,CAAC,CACH,CAAC;YAEF,OAAO,QAAQ,CAAC,IAAqB,CAAC;QACxC,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,IAAI,mBAAmB,CAC3B,2CAA2C,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,EACnE;gBACE,KAAK,EAAE,GAAG;aACX,CACF,CAAC;QACJ,CAAC;IACH,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,MAAe;QAC3B,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;QAC/C,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,mDAAmD,EACnD,GAAG,CACJ,CAAC;YACF,MAAM,IAAI,mBAAmB,CAAC,sCAAsC,EAAE;gBACpE,KAAK,EAAE,GAAG;aACX,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,MAAwB;QAC/C,IAAI,CAAC;YACH,MAAM,YAAY,GAAG,gCAAgC,CAAC,MAAM,CAAC,CAAC;YAC9D,IAAI,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,EAAE,CAAC;gBACjC,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,iCAAiC,EACjC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAC7B,CAAC;YACJ,CAAC;YACD,MAAM,OAAO,GAAG,IAAI,oBAAoB,CAAC,YAAY,CAAC,CAAC;YACvD,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAClC,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,IAAI,mBAAmB,CAC3B,uDAAuD,EACvD;gBACE,KAAK,EAAE,GAAG;aACX,CACF,CAAC;QACJ,CAAC;IACH,CAAC;IAED,KAAK,CAAC,CAAC,KAAK,CACV,KAAY;QAEZ,IAAI,CAAC;YACH,MAAM,EAAE,UAAU,EAAE,eAAe,EAAE,GAAG,KAAK,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;YACjE,IAAI,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CACnC,IAAI,YAAY,CAAC;gBACf,SAAS,EAAE,KAAK,CAAC,KAAK;gBACtB,SAAS,EAAE,KAAK,CAAC,KAAK;gBACtB,sBAAsB,EAAE,UAAU;gBAClC,yBAAyB,EAAE,eAAe;aAC3C,CAAC,CACH,CAAC;YAEF,KAAK,MAAM,IAAI,IAAI,QAAQ,CAAC,KAAK,IAAI,EAAE,EAAE,CAAC;gBACxC,MAAM,IAAS,CAAC;YAClB,CAAC;YAED,OAAO,QAAQ,CAAC,gBAAgB,IAAI,IAAI,EAAE,CAAC;gBACzC,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAC/B,IAAI,YAAY,CAAC;oBACf,SAAS,EAAE,KAAK,CAAC,KAAK;oBACtB,SAAS,EAAE,KAAK,CAAC,KAAK;oBACtB,sBAAsB,EAAE,UAAU;oBAClC,yBAAyB,EAAE,eAAe;oBAC1C,iBAAiB,EAAE,QAAQ,CAAC,gBAAgB;iBAC7C,CAAC,CACH,CAAC;gBAEF,KAAK,MAAM,IAAI,IAAI,QAAQ,CAAC,KAAK,IAAI,EAAE,EAAE,CAAC;oBACxC,MAAM,IAAS,CAAC;gBAClB,CAAC;YACH,CAAC;QACH,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,IAAI,mBAAmB,CAC3B,mDAAmD,EACnD;gBACE,KAAK,EAAE,GAAG;aACX,CACF,CAAC;QACJ,CAAC;IACH,CAAC;IAED,KAAK,CAAC,QAAQ,CACZ,KAAY;QAEZ,IAAI,CAAC;YACH,IAAI,IAAmB,CAAC;YACxB,IAAI,KAAK,EAAE,MAAM,SAAS,IAAI,IAAI,CAAC,KAAK,CAAI,KAAK,CAAC,EAAE,CAAC;gBACnD,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;oBACjB,MAAM,IAAI,mBAAmB,CAC3B,iDAAiD,CAClD,CAAC;gBACJ,CAAC;gBACD,IAAI,GAAG,SAAS,CAAC;YACnB,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,sCAAsC;YACtC,MAAM,IAAI,mBAAmB,CAC3B,6BAA6B,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,EACpD;gBACE,KAAK,EAAE,GAAG;aACX,CACF,CAAC;QACJ,CAAC;IACH,CAAC;IAED,MAAM,CAAC,QAAQ,CAAC,MAIf;QACC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,oBAAoB,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;QAClE,MAAM,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;QACjE,OAAO,cAAc,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,CAAC,CAAC;IACjE,CAAC;IAED,MAAM,CAAC,IAAI,CAAC,MAA2C;QACrD,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,UAAU,CAAC,MAAM,EAAE,EAAE,GAAG,MAAM,CAAC;QACxD,OAAO,IAAI,cAAc,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IAChD,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,MAIb;QACC,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAChD,MAAM,UAAU,GAAG,IAAI,UAAU,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;QAC9C,OAAO,cAAc,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;IAC3E,CAAC;CACF;AAED,0EAA0E;AAC1E,qBAAqB;AACrB,SAAS,YAAY,CAAC,MAAe;IACnC,OAAO,IAAI,UAAU,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC,CAAC;AACrD,CAAC;AAED,SAAS,mBAAmB,CAAC,MAAe;IAC1C,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;IAC1C,MAAM,gBAAgB,GAAG,SAAS,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACzE,OAAO;QACL,SAAS,EAAE,KAAK;QAChB,IAAI,EAAE,IAAI;QACV,GAAG,gBAAgB;KACpB,CAAC;AACJ,CAAC;AAED,SAAS,gCAAgC,CACvC,MAAwB;IAExB,OAAO;QACL,aAAa,EAAE,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YACzC,GAAG,EAAE,mBAAmB,CAAC,IAAI,CAAC;SAC/B,CAAC,CAAC;KACJ,CAAC;AACJ,CAAC"}

package/lib/esm/condition-expression.d.ts

@@ -0,0 +1,19 @@
+import type { AttributePath, AttributeType, AttributeValue } from "./types.js";
+type AttributeSubstitution = `#${string}`;
+type ValueReference = `:${string}`;
+export type ExpressionAwsInput = {
+    ConditionExpression: string;
+    ExpressionAttributeNames?: Record<AttributeSubstitution, AttributePath>;
+    ExpressionAttributeValues?: Record<ValueReference, AttributeValue>;
+};
+export declare class ConditionExpression {
+    private readonly expression;
+    private readonly substitutions?;
+    private readonly values?;
+    private constructor();
+    toAwsInput(): ExpressionAwsInput;
+    static attributeNotExists(attribute: AttributePath): ConditionExpression;
+    static attributeExists(attribute: AttributePath): ConditionExpression;
+    static attributeType(attribute: AttributePath, type: AttributeType): ConditionExpression;
+}
+export {};

package/lib/esm/condition-expression.js

@@ -0,0 +1,113 @@
+/**
+ * Represents a set of attribute names used in a condition expression.
+ *
+ * The uses cases for using attribute names are:
+ * - To access an attribute whose name conflicts with a DynamoDB reserved word.
+ * - To create a placeholder for repeating occurrences of an attribute name in an expression.
+ * - To prevent special characters in an attribute name from being misinterpreted in an expression.
+ */
+class AttributeSubstitutions {
+    names;
+    constructor() {
+        this.names = new Map();
+    }
+    substitute(attribute) {
+        const existing = this.names.get(attribute);
+        if (existing != null) {
+            return existing;
+        }
+        const substitute = this.generateSubstitute(attribute);
+        this.names.set(attribute, substitute);
+        return substitute;
+    }
+    toAwsInput() {
+        const result = {};
+        for (const [attribute, substitute] of this.names.entries()) {
+            result[substitute] = attribute;
+        }
+        return result;
+    }
+    generateSubstitute(attribute) {
+        return `#${attribute}`;
+    }
+}
+class AttributeValues {
+    values;
+    counter;
+    constructor() {
+        this.values = new Map();
+        this.counter = 0;
+    }
+    referenceBy(value) {
+        const existing = this.values.get(value);
+        if (existing != null) {
+            return existing;
+        }
+        const reference = this.generateReference();
+        this.values.set(value, reference);
+        return reference;
+    }
+    toAwsInput() {
+        const result = {};
+        for (const [value, reference] of this.values.entries()) {
+            result[reference] = value;
+        }
+        return result;
+    }
+    generateReference() {
+        const reference = `:${this.counter}`;
+        this.counter += 1;
+        return reference;
+    }
+}
+export class ConditionExpression {
+    expression;
+    substitutions;
+    values;
+    constructor(params) {
+        const { expression, substitutions, values } = params;
+        this.expression = expression;
+        this.substitutions = substitutions;
+        this.values = values;
+    }
+    toAwsInput() {
+        const result = {
+            ConditionExpression: this.expression,
+        };
+        if (this.substitutions != null) {
+            result.ExpressionAttributeNames = this.substitutions.toAwsInput();
+        }
+        if (this.values != null) {
+            result.ExpressionAttributeValues = this.values.toAwsInput();
+        }
+        return result;
+    }
+    static attributeNotExists(attribute) {
+        const substitutions = new AttributeSubstitutions();
+        const sub = substitutions.substitute(attribute);
+        return new ConditionExpression({
+            expression: `attribute_not_exists(${sub})`,
+            substitutions,
+        });
+    }
+    static attributeExists(attribute) {
+        const substitutions = new AttributeSubstitutions();
+        const sub = substitutions.substitute(attribute);
+        return new ConditionExpression({
+            expression: `attribute_exists(${sub})`,
+            substitutions,
+        });
+    }
+    static attributeType(attribute, type) {
+        const substitutions = new AttributeSubstitutions();
+        const sub = substitutions.substitute(attribute);
+        const values = new AttributeValues();
+        const valueRef = values.referenceBy(type);
+        return new ConditionExpression({
+            expression: `attribute_type(${sub}, ${valueRef})`,
+            substitutions,
+            values,
+        });
+    }
+}
+//# sourceMappingURL=condition-expression.js.map

package/lib/esm/condition-expression.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"condition-expression.js","sourceRoot":"","sources":["../../src/condition-expression.ts"],"names":[],"mappings":"AAIA;;;;;;;GAOG;AACH,MAAM,sBAAsB;IACT,KAAK,CAA4C;IAElE;QACE,IAAI,CAAC,KAAK,GAAG,IAAI,GAAG,EAAwC,CAAC;IAC/D,CAAC;IAED,UAAU,CAAC,SAAwB;QACjC,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAC3C,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;YACrB,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,MAAM,UAAU,GAAG,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;QACtD,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;QACtC,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,UAAU;QACR,MAAM,MAAM,GAAiD,EAAE,CAAC;QAChE,KAAK,MAAM,CAAC,SAAS,EAAE,UAAU,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC;YAC3D,MAAM,CAAC,UAAU,CAAC,GAAG,SAAS,CAAC;QACjC,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,kBAAkB,CAAC,SAAwB;QACjD,OAAO,IAAI,SAAS,EAA2B,CAAC;IAClD,CAAC;CACF;AAID,MAAM,eAAe;IACF,MAAM,CAAsC;IACrD,OAAO,CAAS;IAExB;QACE,IAAI,CAAC,MAAM,GAAG,IAAI,GAAG,EAAkC,CAAC;QACxD,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC;IACnB,CAAC;IAED,WAAW,CAAC,KAAqB;QAC/B,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACxC,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;YACrB,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,MAAM,SAAS,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC3C,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QAClC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,UAAU;QACR,MAAM,MAAM,GAA2C,EAAE,CAAC;QAC1D,KAAK,MAAM,CAAC,KAAK,EAAE,SAAS,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,CAAC;YACvD,MAAM,CAAC,SAAS,CAAC,GAAG,KAAK,CAAC;QAC5B,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,iBAAiB;QACvB,MAAM,SAAS,GAAG,IAAI,IAAI,CAAC,OAAO,EAAoB,CAAC;QACvD,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC;QAClB,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AAQD,MAAM,OAAO,mBAAmB;IACb,UAAU,CAAS;IACnB,aAAa,CAA0B;IACvC,MAAM,CAAmB;IAE1C,YAAoB,MAInB;QACC,MAAM,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;QACrD,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,UAAU;QACR,MAAM,MAAM,GAAuB;YACjC,mBAAmB,EAAE,IAAI,CAAC,UAAU;SACrC,CAAC;QACF,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,EAAE,CAAC;YAC/B,MAAM,CAAC,wBAAwB,GAAG,IAAI,CAAC,aAAa,CAAC,UAAU,EAAE,CAAC;QACpE,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,EAAE,CAAC;YACxB,MAAM,CAAC,yBAAyB,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;QAC9D,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,MAAM,CAAC,kBAAkB,CAAC,SAAwB;QAChD,MAAM,aAAa,GAAG,IAAI,sBAAsB,EAAE,CAAC;QACnD,MAAM,GAAG,GAAG,aAAa,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QAChD,OAAO,IAAI,mBAAmB,CAAC;YAC7B,UAAU,EAAE,wBAAwB,GAAG,GAAG;YAC1C,aAAa;SACd,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,eAAe,CAAC,SAAwB;QAC7C,MAAM,aAAa,GAAG,IAAI,sBAAsB,EAAE,CAAC;QACnD,MAAM,GAAG,GAAG,aAAa,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QAChD,OAAO,IAAI,mBAAmB,CAAC;YAC7B,UAAU,EAAE,oBAAoB,GAAG,GAAG;YACtC,aAAa;SACd,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,aAAa,CAClB,SAAwB,EACxB,IAAmB;QAEnB,MAAM,aAAa,GAAG,IAAI,sBAAsB,EAAE,CAAC;QACnD,MAAM,GAAG,GAAG,aAAa,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QAChD,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;QACrC,MAAM,QAAQ,GAAG,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QAC1C,OAAO,IAAI,mBAAmB,CAAC;YAC7B,UAAU,EAAE,kBAAkB,GAAG,KAAK,QAAQ,GAAG;YACjD,aAAa;YACb,MAAM;SACP,CAAC,CAAC;IACL,CAAC;CACF"}

package/lib/esm/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./client.js";
+export * from "./condition-expression.js";
+export * from "./key-condition-expression.js";
+export * from "./types.js";

package/lib/esm/index.js

@@ -0,0 +1,5 @@
+export * from "./client.js";
+export * from "./condition-expression.js";
+export * from "./key-condition-expression.js";
+export * from "./types.js";
+//# sourceMappingURL=index.js.map

package/lib/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,2BAA2B,CAAC;AAC1C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,YAAY,CAAC"}

package/lib/esm/key-condition-expression.d.ts

@@ -0,0 +1,20 @@
+import type { Attributes } from "./types.js";
+export declare class KeyConditionExpression {
+    private readonly expression;
+    private readonly attributeValues;
+    private constructor();
+    toJson(): {
+        expression: string;
+        attributeValues: Attributes;
+    };
+    static partitionKeyEquals(params: {
+        attributeName: string;
+        value: string;
+        token?: string;
+    }): KeyConditionExpression;
+    static equals(params: {
+        attributeName: string;
+        value: string;
+        token: string;
+    }): KeyConditionExpression;
+}

package/lib/esm/key-condition-expression.js

@@ -0,0 +1,31 @@
+export class KeyConditionExpression {
+    expression;
+    attributeValues;
+    constructor(params) {
+        const { expression, attributeValues } = params;
+        this.expression = expression;
+        this.attributeValues = attributeValues;
+    }
+    toJson() {
+        return {
+            expression: this.expression,
+            attributeValues: this.attributeValues,
+        };
+    }
+    static partitionKeyEquals(params) {
+        const { attributeName, value, token = ":pk" } = params;
+        return KeyConditionExpression.equals({
+            attributeName,
+            value,
+            token,
+        });
+    }
+    static equals(params) {
+        const { attributeName, value, token } = params;
+        return new KeyConditionExpression({
+            expression: `${attributeName} = ${token}`,
+            attributeValues: { [token]: value },
+        });
+    }
+}
+//# sourceMappingURL=key-condition-expression.js.map

package/lib/esm/key-condition-expression.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"key-condition-expression.js","sourceRoot":"","sources":["../../src/key-condition-expression.ts"],"names":[],"mappings":"AAEA,MAAM,OAAO,sBAAsB;IAChB,UAAU,CAAS;IACnB,eAAe,CAAa;IAE7C,YAAoB,MAGnB;QACC,MAAM,EAAE,UAAU,EAAE,eAAe,EAAE,GAAG,MAAM,CAAC;QAC/C,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;IACzC,CAAC;IAED,MAAM;QACJ,OAAO;YACL,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,eAAe,EAAE,IAAI,CAAC,eAAe;SACtC,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,kBAAkB,CAAC,MAIzB;QACC,MAAM,EAAE,aAAa,EAAE,KAAK,EAAE,KAAK,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACvD,OAAO,sBAAsB,CAAC,MAAM,CAAC;YACnC,aAAa;YACb,KAAK;YACL,KAAK;SACN,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,MAIb;QACC,MAAM,EAAE,aAAa,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC;QAE/C,OAAO,IAAI,sBAAsB,CAAC;YAChC,UAAU,EAAE,GAAG,aAAa,MAAM,KAAK,EAAE;YACzC,eAAe,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE;SACpC,CAAC,CAAC;IACL,CAAC;CACF"}

package/lib/esm/types.d.ts

@@ -0,0 +1,30 @@
+import type { NativeAttributeValue } from "@aws-sdk/lib-dynamodb";
+import type { ConditionExpression } from "./condition-expression.js";
+import type { KeyConditionExpression } from "./key-condition-expression.js";
+export type AttributeName = string;
+export type AttributeValue = NativeAttributeValue;
+export type AttributePath = AttributeName;
+export type AttributeType = "S" | "N" | "B" | "BOOL" | "NULL" | "M" | "L" | "SS" | "NS" | "BS";
+export interface Attribute {
+    name: AttributeName;
+    value: AttributeValue;
+}
+export type Attributes = Record<AttributeName, NativeAttributeValue>;
+export interface GetItem {
+    table: string;
+    parititionKey: Attribute;
+    sortKey?: Attribute;
+}
+export interface PutItem {
+    table: string;
+    item: Attributes;
+    condition?: ConditionExpression;
+}
+export interface WriteTransaction {
+    items: PutItem[];
+}
+export interface Query {
+    table: string;
+    index?: string;
+    condition: KeyConditionExpression;
+}

package/lib/esm/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/lib/esm/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@infra-blocks/aws-dynamodb",
+  "version": "0.1.0-alpha.0",
+  "description": "A convenience wrapper over @aws-sdk/client-dynamodb and @aws-sdk/lib-dynamodb.",
+  "keywords": [
+    "aws",
+    "dynamodb",
+    "expression"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/infra-blocks/ts-aws-dynamodb.git"
+  },
+  "license": "ISC",
+  "author": "",
+  "type": "module",
+  "exports": {
+    "import": "./lib/esm/index.js",
+    "require": "./lib/cjs/index.js",
+    "default": "./lib/esm/index.js"
+  },
+  "files": [
+    "lib/**/*.{js,cjs,mjs,json,d.ts,map}"
+  ],
+  "scripts": {
+    "prebuild": "npm run clean",
+    "build": "tsc -b tsconfig.build.esm.json tsconfig.build.cjs.json",
+    "postbuild": "scripts/post-build.sh",
+    "clean": "rm -rf lib && rm -f infra-blocks-*.tgz",
+    "compile": "tsc",
+    "fix": "biome check --write",
+    "lint": "biome ci",
+    "prepack": "npm run build",
+    "test": "npm run test:unit && npm run test:integration",
+    "test:coverage": "c8 npm run test",
+    "test:coverage:lcov": "c8 --reporter=lcov npm run test",
+    "test:integration": "mocha --config test/integration/.mocharc.cjs 'test/integration/**/*.spec.ts'",
+    "test:unit": "mocha --config test/unit/.mocharc.cjs 'test/unit/**/*.spec.ts'"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^2.0.6",
+    "@infra-blocks/test": "^0.4.0",
+    "@types/mocha": "^10.0.10",
+    "@types/node": "^24.0.10",
+    "c8": "^10.1.3",
+    "lefthook": "^1.11.16",
+    "mocha": "^11.7.1",
+    "tsx": "^4.20.3",
+    "typescript": "^5.8.3"
+  },
+  "engines": {
+    "node": ">=24.0.0"
+  },
+  "dependencies": {
+    "@aws-sdk/client-dynamodb": "^3.840.0",
+    "@aws-sdk/lib-dynamodb": "^3.840.0",
+    "@infra-blocks/logger-interface": "^0.3.1",
+    "@infra-blocks/null-logger": "^0.1.1",
+    "@infra-blocks/retry": "^0.1.1"
+  }
+}