dynamo-document-builder 0.0.0 → 0.1.0

package/README.md

@@ -1,2 +1,79 @@
-# dynamo-document-builder
-Type-safe utilities designed to make working with DynamoDB easier ✨
+# Dynamo Document Builder
+
+DynamoDB single table design and data validation made easy using TypeScript and Zod ⚡️
+
+Full documentation can be found at [dynamodocumentbuilder.com](https://dynamodocumentbuilder.com).
+
+## Features
+
+- Data integraty using [Zod](https://zod.dev/) for schema validation
+- Follows [Single Table Design](https://www.alexdebrie.com/posts/dynamodb-single-table) principles
+- Easy ergonomic API for a better DynamoDB developer experience
+- Built from the group up to be type-safe
+- Completely tree-shakable for minimal bundle sizes
+- Extensively documented with guides, example code, and complete API reference
+
+## Installation
+
+```bash
+npm i dynamo-document-builder zod @aws-sdk/client-dynamodb @aws-sdk/lib-dynamodb
+```
+
+## Getting Started
+
+```typescript
+import { DynamoDBClient } from '@aws-sdk/client-dynamodb';
+import { DynamoDBDocumentClient } from '@aws-sdk/lib-dynamodb';
+import { DynamoTable, DynamoEntity, type Entity, Put, Get } from 'dynamo-document-builder';
+import { z } from 'zod';
+
+// Define you DynamoDB clients
+const dynamoDbClient = new DynamoDBClient();
+const docClient = DynamoDBDocumentClient.from(dynamoDbClient);
+
+// Define your table
+const myTable = new DynamoTable({
+  tableName: 'MyDynamoTable',
+  documentClient: docClient,
+  keyNames: {
+    partitionKey: 'PK',
+    sortKey: 'SK',
+  },
+});
+
+// Define an entity that belongs to the table
+const userEntity = new DynamoEntity({
+  table: myTable,
+  schema: z.object({
+    id: z.string(),
+    name: z.string(),
+    email: z.string().email(),
+  }),
+  partitionKey: user => `USER#${user.id}`,
+  sortKey: user => `EMAIL#${user.email}`,
+});
+
+// Infer the TypeScript type of the entity from the schema
+type User = Entity<typeof userEntity>;
+
+// Create a new item
+const newUser: User = {
+  id: '123',
+  name: 'John Doe',
+  email: 'johndoe@example.com',
+};
+
+// Put the item to DynamoDB
+await userEntity.send(new Put({
+  item: newUser, // Validated against the Zod schema
+}))
+
+// Get the item back from DynamoDB
+const retrievedUser = await userEntity.send(new Get({
+  // PK and SK auto-built from the key functions in the Entity
+  key: {
+    id: '123',
+    email: 'johndoe@example.com',
+  },
+}));
+```

package/dist/attributes/attribute-map.cjs

@@ -0,0 +1,114 @@
+'use strict';
+
+class AttributeExpressionMap {
+    constructor() {
+        Object.defineProperty(this, "attributeNames", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "reverseLookupNames", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "names", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "attributeValues", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "reverseLookupValues", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "values", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.attributeNames = {};
+        this.reverseLookupNames = {};
+        this.names = new Set();
+        this.attributeValues = {};
+        this.reverseLookupValues = new Map();
+        this.values = new Set();
+    }
+    addName(name) {
+        if (this.names.has(name)) {
+            return this.reverseLookupNames[name];
+        }
+        const placeholder = `#${name}`;
+        this.attributeNames[placeholder] = name;
+        this.reverseLookupNames[name] = placeholder;
+        this.names.add(name);
+        return placeholder;
+    }
+    addValue(value) {
+        if (this.values.has(value)) {
+            return this.reverseLookupValues.get(value);
+        }
+        const valuePlaceholder = `:v${this.values.size + 1}`;
+        this.attributeValues[valuePlaceholder] = value;
+        this.reverseLookupValues.set(value, valuePlaceholder);
+        this.values.add(value);
+        return valuePlaceholder;
+    }
+    add(name, value) {
+        return [this.addName(name), this.addValue(value)];
+    }
+    toDynamoAttributeNames() {
+        return this.attributeNames;
+    }
+    toDynamoAttributeValues() {
+        return this.attributeValues;
+    }
+    toDynamoAttributeExpression() {
+        const expression = {};
+        if (this.names.size > 0) {
+            expression.ExpressionAttributeNames = this.attributeNames;
+        }
+        if (this.values.size > 0) {
+            expression.ExpressionAttributeValues = this.attributeValues;
+        }
+        return expression;
+    }
+    hasName(name) {
+        return this.names.has(name);
+    }
+    hasValue(value) {
+        return this.values.has(value);
+    }
+    getPlaceholderFromName(name) {
+        return this.reverseLookupNames[name];
+    }
+    getPlaceholderFromValue(value) {
+        return this.reverseLookupValues.get(value);
+    }
+    getNameFromPlaceholder(placeholder) {
+        return this.attributeNames[placeholder];
+    }
+    getValueFromPlaceholder(placeholder) {
+        return this.attributeValues[placeholder];
+    }
+    getNameCount() {
+        return this.names.size;
+    }
+    getValueCount() {
+        return this.values.size;
+    }
+}
+
+exports.AttributeExpressionMap = AttributeExpressionMap;
+//# sourceMappingURL=attribute-map.cjs.map

package/dist/attributes/attribute-map.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"attribute-map.cjs","sources":["../../src/attributes/attribute-map.ts"],"sourcesContent":[null],"names":[],"mappings":";;MAaa,sBAAsB,CAAA;AASjC,IAAA,WAAA,GAAA;AARQ,QAAA,MAAA,CAAA,cAAA,CAAA,IAAA,EAAA,gBAAA,EAAA;;;;;AAAwD,SAAA,CAAA;AACxD,QAAA,MAAA,CAAA,cAAA,CAAA,IAAA,EAAA,oBAAA,EAAA;;;;;AAA4D,SAAA,CAAA;AAC5D,QAAA,MAAA,CAAA,cAAA,CAAA,IAAA,EAAA,OAAA,EAAA;;;;;AAAkB,SAAA,CAAA;AAElB,QAAA,MAAA,CAAA,cAAA,CAAA,IAAA,EAAA,iBAAA,EAAA;;;;;AAAwE,SAAA,CAAA;AACxE,QAAA,MAAA,CAAA,cAAA,CAAA,IAAA,EAAA,qBAAA,EAAA;;;;;AAAyE,SAAA,CAAA;AACzE,QAAA,MAAA,CAAA,cAAA,CAAA,IAAA,EAAA,QAAA,EAAA;;;;;AAAmB,SAAA,CAAA;AAGzB,QAAA,IAAI,CAAC,cAAc,GAAG,EAAE;AACxB,QAAA,IAAI,CAAC,kBAAkB,GAAG,EAAE;AAC5B,QAAA,IAAI,CAAC,KAAK,GAAG,IAAI,GAAG,EAAU;AAC9B,QAAA,IAAI,CAAC,eAAe,GAAG,EAAE;AACzB,QAAA,IAAI,CAAC,mBAAmB,GAAG,IAAI,GAAG,EAAmD;AACrF,QAAA,IAAI,CAAC,MAAM,GAAG,IAAI,GAAG,EAAU;IACjC;AAEO,IAAA,OAAO,CAAC,IAAY,EAAA;QACzB,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;AACxB,YAAA,OAAO,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAE;QACvC;AACA,QAAA,MAAM,WAAW,GAA6B,CAAA,CAAA,EAAI,IAAI,EAAE;AACxD,QAAA,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,GAAG,IAAI;AACvC,QAAA,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,GAAG,WAAW;AAC3C,QAAA,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC;AACpB,QAAA,OAAO,WAAW;IACpB;AAEO,IAAA,QAAQ,CAAC,KAA2B,EAAA;QACzC,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,KAAK,CAAE;QAC7C;QACA,MAAM,gBAAgB,GAA8B,CAAA,EAAA,EAAK,IAAI,CAAC,MAAM,CAAC,IAAI,GAAG,CAAC,CAAA,CAAE;AAC/E,QAAA,IAAI,CAAC,eAAe,CAAC,gBAAgB,CAAC,GAAG,KAAK;QAC9C,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,KAAK,EAAE,gBAAgB,CAAC;AACrD,QAAA,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC;AACtB,QAAA,OAAO,gBAAgB;IACzB;IAEO,GAAG,CACR,IAAY,EACZ,KAA2B,EAAA;AAE3B,QAAA,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACnD;IAEO,sBAAsB,GAAA;QAC3B,OAAO,IAAI,CAAC,cAAc;IAC5B;IAEO,uBAAuB,GAAA;QAC5B,OAAO,IAAI,CAAC,eAAe;IAC7B;IAEO,2BAA2B,GAAA;QAChC,MAAM,UAAU,GAA8B,EAAE;QAChD,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC,EAAE;AACvB,YAAA,UAAU,CAAC,wBAAwB,GAAG,IAAI,CAAC,cAAc;QAC3D;QACA,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,GAAG,CAAC,EAAE;AACxB,YAAA,UAAU,CAAC,yBAAyB,GAAG,IAAI,CAAC,eAAe;QAC7D;AACA,QAAA,OAAO,UAAU;IACnB;AAEO,IAAA,OAAO,CAAC,IAAY,EAAA;QACzB,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC;IAC7B;AAEO,IAAA,QAAQ,CAAC,KAA2B,EAAA;QACzC,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC;IAC/B;AAEO,IAAA,sBAAsB,CAAC,IAAY,EAAA;AACxC,QAAA,OAAO,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC;IACtC;AAEO,IAAA,uBAAuB,CAC5B,KAA2B,EAAA;QAE3B,OAAO,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,KAAK,CAAC;IAC5C;AAEO,IAAA,sBAAsB,CAAC,WAAqC,EAAA;AACjE,QAAA,OAAO,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC;IACzC;AAEO,IAAA,uBAAuB,CAC5B,WAAsC,EAAA;AAEtC,QAAA,OAAO,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC;IAC1C;IAEO,YAAY,GAAA;AACjB,QAAA,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI;IACxB;IAEO,aAAa,GAAA;AAClB,QAAA,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI;IACzB;AACD;;;;"}

package/dist/attributes/attribute-map.d.ts

@@ -0,0 +1,32 @@
+import type { NativeAttributeValue } from '@aws-sdk/lib-dynamodb';
+export type AttributeValues = Record<string, NativeAttributeValue>;
+export type AttributeNames = Record<string, string>;
+export type DynamoAttributeExpression = {
+    ExpressionAttributeValues?: AttributeValues | undefined;
+    ExpressionAttributeNames?: AttributeNames | undefined;
+};
+export type AttributeValuePlaceholder = `:${string}`;
+export type AttributeNamePlaceholder = `#${string}`;
+export declare class AttributeExpressionMap {
+    private attributeNames;
+    private reverseLookupNames;
+    private names;
+    private attributeValues;
+    private reverseLookupValues;
+    private values;
+    constructor();
+    addName(name: string): AttributeNamePlaceholder;
+    addValue(value: NativeAttributeValue): AttributeValuePlaceholder;
+    add(name: string, value: NativeAttributeValue): [AttributeNamePlaceholder, AttributeValuePlaceholder];
+    toDynamoAttributeNames(): AttributeNames;
+    toDynamoAttributeValues(): AttributeValues;
+    toDynamoAttributeExpression(): DynamoAttributeExpression;
+    hasName(name: string): boolean;
+    hasValue(value: NativeAttributeValue): boolean;
+    getPlaceholderFromName(name: string): AttributeNamePlaceholder | undefined;
+    getPlaceholderFromValue(value: NativeAttributeValue): AttributeValuePlaceholder | undefined;
+    getNameFromPlaceholder(placeholder: AttributeNamePlaceholder): string | undefined;
+    getValueFromPlaceholder(placeholder: AttributeValuePlaceholder): NativeAttributeValue | undefined;
+    getNameCount(): number;
+    getValueCount(): number;
+}

package/dist/attributes/attribute-map.mjs

@@ -0,0 +1,112 @@
+class AttributeExpressionMap {
+    constructor() {
+        Object.defineProperty(this, "attributeNames", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "reverseLookupNames", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "names", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "attributeValues", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "reverseLookupValues", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "values", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.attributeNames = {};
+        this.reverseLookupNames = {};
+        this.names = new Set();
+        this.attributeValues = {};
+        this.reverseLookupValues = new Map();
+        this.values = new Set();
+    }
+    addName(name) {
+        if (this.names.has(name)) {
+            return this.reverseLookupNames[name];
+        }
+        const placeholder = `#${name}`;
+        this.attributeNames[placeholder] = name;
+        this.reverseLookupNames[name] = placeholder;
+        this.names.add(name);
+        return placeholder;
+    }
+    addValue(value) {
+        if (this.values.has(value)) {
+            return this.reverseLookupValues.get(value);
+        }
+        const valuePlaceholder = `:v${this.values.size + 1}`;
+        this.attributeValues[valuePlaceholder] = value;
+        this.reverseLookupValues.set(value, valuePlaceholder);
+        this.values.add(value);
+        return valuePlaceholder;
+    }
+    add(name, value) {
+        return [this.addName(name), this.addValue(value)];
+    }
+    toDynamoAttributeNames() {
+        return this.attributeNames;
+    }
+    toDynamoAttributeValues() {
+        return this.attributeValues;
+    }
+    toDynamoAttributeExpression() {
+        const expression = {};
+        if (this.names.size > 0) {
+            expression.ExpressionAttributeNames = this.attributeNames;
+        }
+        if (this.values.size > 0) {
+            expression.ExpressionAttributeValues = this.attributeValues;
+        }
+        return expression;
+    }
+    hasName(name) {
+        return this.names.has(name);
+    }
+    hasValue(value) {
+        return this.values.has(value);
+    }
+    getPlaceholderFromName(name) {
+        return this.reverseLookupNames[name];
+    }
+    getPlaceholderFromValue(value) {
+        return this.reverseLookupValues.get(value);
+    }
+    getNameFromPlaceholder(placeholder) {
+        return this.attributeNames[placeholder];
+    }
+    getValueFromPlaceholder(placeholder) {
+        return this.attributeValues[placeholder];
+    }
+    getNameCount() {
+        return this.names.size;
+    }
+    getValueCount() {
+        return this.values.size;
+    }
+}
+
+export { AttributeExpressionMap };
+//# sourceMappingURL=attribute-map.mjs.map

package/dist/attributes/attribute-map.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"attribute-map.mjs","sources":["../../src/attributes/attribute-map.ts"],"sourcesContent":[null],"names":[],"mappings":"MAaa,sBAAsB,CAAA;AASjC,IAAA,WAAA,GAAA;AARQ,QAAA,MAAA,CAAA,cAAA,CAAA,IAAA,EAAA,gBAAA,EAAA;;;;;AAAwD,SAAA,CAAA;AACxD,QAAA,MAAA,CAAA,cAAA,CAAA,IAAA,EAAA,oBAAA,EAAA;;;;;AAA4D,SAAA,CAAA;AAC5D,QAAA,MAAA,CAAA,cAAA,CAAA,IAAA,EAAA,OAAA,EAAA;;;;;AAAkB,SAAA,CAAA;AAElB,QAAA,MAAA,CAAA,cAAA,CAAA,IAAA,EAAA,iBAAA,EAAA;;;;;AAAwE,SAAA,CAAA;AACxE,QAAA,MAAA,CAAA,cAAA,CAAA,IAAA,EAAA,qBAAA,EAAA;;;;;AAAyE,SAAA,CAAA;AACzE,QAAA,MAAA,CAAA,cAAA,CAAA,IAAA,EAAA,QAAA,EAAA;;;;;AAAmB,SAAA,CAAA;AAGzB,QAAA,IAAI,CAAC,cAAc,GAAG,EAAE;AACxB,QAAA,IAAI,CAAC,kBAAkB,GAAG,EAAE;AAC5B,QAAA,IAAI,CAAC,KAAK,GAAG,IAAI,GAAG,EAAU;AAC9B,QAAA,IAAI,CAAC,eAAe,GAAG,EAAE;AACzB,QAAA,IAAI,CAAC,mBAAmB,GAAG,IAAI,GAAG,EAAmD;AACrF,QAAA,IAAI,CAAC,MAAM,GAAG,IAAI,GAAG,EAAU;IACjC;AAEO,IAAA,OAAO,CAAC,IAAY,EAAA;QACzB,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;AACxB,YAAA,OAAO,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAE;QACvC;AACA,QAAA,MAAM,WAAW,GAA6B,CAAA,CAAA,EAAI,IAAI,EAAE;AACxD,QAAA,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,GAAG,IAAI;AACvC,QAAA,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,GAAG,WAAW;AAC3C,QAAA,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC;AACpB,QAAA,OAAO,WAAW;IACpB;AAEO,IAAA,QAAQ,CAAC,KAA2B,EAAA;QACzC,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;YAC1B,OAAO,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,KAAK,CAAE;QAC7C;QACA,MAAM,gBAAgB,GAA8B,CAAA,EAAA,EAAK,IAAI,CAAC,MAAM,CAAC,IAAI,GAAG,CAAC,CAAA,CAAE;AAC/E,QAAA,IAAI,CAAC,eAAe,CAAC,gBAAgB,CAAC,GAAG,KAAK;QAC9C,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,KAAK,EAAE,gBAAgB,CAAC;AACrD,QAAA,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC;AACtB,QAAA,OAAO,gBAAgB;IACzB;IAEO,GAAG,CACR,IAAY,EACZ,KAA2B,EAAA;AAE3B,QAAA,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACnD;IAEO,sBAAsB,GAAA;QAC3B,OAAO,IAAI,CAAC,cAAc;IAC5B;IAEO,uBAAuB,GAAA;QAC5B,OAAO,IAAI,CAAC,eAAe;IAC7B;IAEO,2BAA2B,GAAA;QAChC,MAAM,UAAU,GAA8B,EAAE;QAChD,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC,EAAE;AACvB,YAAA,UAAU,CAAC,wBAAwB,GAAG,IAAI,CAAC,cAAc;QAC3D;QACA,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,GAAG,CAAC,EAAE;AACxB,YAAA,UAAU,CAAC,yBAAyB,GAAG,IAAI,CAAC,eAAe;QAC7D;AACA,QAAA,OAAO,UAAU;IACnB;AAEO,IAAA,OAAO,CAAC,IAAY,EAAA;QACzB,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC;IAC7B;AAEO,IAAA,QAAQ,CAAC,KAA2B,EAAA;QACzC,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC;IAC/B;AAEO,IAAA,sBAAsB,CAAC,IAAY,EAAA;AACxC,QAAA,OAAO,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC;IACtC;AAEO,IAAA,uBAAuB,CAC5B,KAA2B,EAAA;QAE3B,OAAO,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,KAAK,CAAC;IAC5C;AAEO,IAAA,sBAAsB,CAAC,WAAqC,EAAA;AACjE,QAAA,OAAO,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC;IACzC;AAEO,IAAA,uBAAuB,CAC5B,WAAsC,EAAA;AAEtC,QAAA,OAAO,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC;IAC1C;IAEO,YAAY,GAAA;AACjB,QAAA,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI;IACxB;IAEO,aAAa,GAAA;AAClB,QAAA,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI;IACzB;AACD;;;;"}

package/dist/attributes/index.cjs

@@ -0,0 +1,8 @@
+'use strict';
+
+var attributes_attributeMap = require('./attribute-map.cjs');
+
+
+
+exports.AttributeExpressionMap = attributes_attributeMap.AttributeExpressionMap;
+//# sourceMappingURL=index.cjs.map

package/dist/attributes/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;"}

package/dist/attributes/index.d.ts

@@ -0,0 +1 @@
+export * from './attribute-map';

package/dist/attributes/index.mjs

@@ -0,0 +1,2 @@
+export { AttributeExpressionMap } from './attribute-map.mjs';
+//# sourceMappingURL=index.mjs.map

package/dist/attributes/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/dist/commands/base-command.cjs

@@ -0,0 +1,3 @@
+'use strict';
+
+//# sourceMappingURL=base-command.cjs.map

package/dist/commands/base-command.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-command.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;"}

package/dist/commands/base-command.d.ts

@@ -0,0 +1,24 @@
+import type { TransactWriteOperation } from '@/core/core-types';
+import type { DynamoEntity } from '@/core/entity';
+import type { ConsumedCapacity, ReturnConsumedCapacity } from '@aws-sdk/client-dynamodb';
+import type { ResponseMetadata } from '@aws-sdk/types';
+import type { ZodObject } from 'zod/v4';
+export type BaseCommand<Output, Schema extends ZodObject> = {
+    execute(entity: DynamoEntity<Schema>): Promise<Output>;
+};
+export type BasePaginatable<Output, Schema extends ZodObject> = {
+    executePaginated(entity: DynamoEntity<Schema>): AsyncGenerator<Output, void, unknown>;
+};
+export type WriteTransactable<Schema extends ZodObject> = {
+    prepareWriteTransaction(entity: DynamoEntity<Schema>): Promise<TransactWriteOperation>;
+};
+export type BaseConfig = {
+    skipValidation?: boolean;
+    returnConsumedCapacity?: ReturnConsumedCapacity;
+    abortController?: AbortController;
+    timeoutMs?: number;
+};
+export type BaseResult = {
+    responseMetadata?: ResponseMetadata;
+    consumedCapacity?: ConsumedCapacity | undefined;
+};

package/dist/commands/base-command.mjs

@@ -0,0 +1,2 @@
+
+//# sourceMappingURL=base-command.mjs.map

package/dist/commands/base-command.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-command.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/dist/commands/batch-get.cjs

@@ -0,0 +1,55 @@
+'use strict';
+
+var tslib_es6 = require('../node_modules/tslib/tslib.es6.cjs');
+var internalConstants = require('../internal-constants.cjs');
+var libDynamodb = require('@aws-sdk/lib-dynamodb');
+var pMap = require('p-map');
+
+var _BatchGet_config;
+class BatchGet {
+    constructor(config) {
+        _BatchGet_config.set(this, void 0);
+        tslib_es6.__classPrivateFieldSet(this, _BatchGet_config, config, "f");
+    }
+    execute(entity) {
+        return tslib_es6.__awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            const batchGet = new libDynamodb.BatchGetCommand({
+                RequestItems: {
+                    [entity.table.tableName]: {
+                        Keys: tslib_es6.__classPrivateFieldGet(this, _BatchGet_config, "f").keys.map(key => entity.buildPrimaryKey(key)),
+                        ConsistentRead: (_a = tslib_es6.__classPrivateFieldGet(this, _BatchGet_config, "f").consistent) !== null && _a !== void 0 ? _a : false,
+                    },
+                },
+                ReturnConsumedCapacity: tslib_es6.__classPrivateFieldGet(this, _BatchGet_config, "f").returnConsumedCapacity,
+            });
+            const batchGetResult = yield entity.table.documentClient.send(batchGet, {
+                abortSignal: (_b = tslib_es6.__classPrivateFieldGet(this, _BatchGet_config, "f").abortController) === null || _b === void 0 ? void 0 : _b.signal,
+                requestTimeout: tslib_es6.__classPrivateFieldGet(this, _BatchGet_config, "f").timeoutMs,
+            });
+            const rawItems = (_d = (_c = batchGetResult.Responses) === null || _c === void 0 ? void 0 : _c[entity.table.tableName]) !== null && _d !== void 0 ? _d : [];
+            let items = [];
+            if (rawItems.length > 0) {
+                if (tslib_es6.__classPrivateFieldGet(this, _BatchGet_config, "f").skipValidation) {
+                    items = rawItems;
+                }
+                else {
+                    items = yield pMap(rawItems, item => entity.schema.parseAsync(item), {
+                        concurrency: internalConstants.BATCH_GET_VALIDATION_CONCURRENCY,
+                        signal: (_e = tslib_es6.__classPrivateFieldGet(this, _BatchGet_config, "f").abortController) === null || _e === void 0 ? void 0 : _e.signal,
+                    });
+                }
+            }
+            return {
+                items,
+                unprocessedKeys: (_g = (_f = batchGetResult.UnprocessedKeys) === null || _f === void 0 ? void 0 : _f[entity.table.tableName]) === null || _g === void 0 ? void 0 : _g.Keys,
+                responseMetadata: batchGetResult.$metadata,
+                consumedCapacity: (_h = batchGetResult.ConsumedCapacity) === null || _h === void 0 ? void 0 : _h[0],
+            };
+        });
+    }
+}
+_BatchGet_config = new WeakMap();
+
+exports.BatchGet = BatchGet;
+//# sourceMappingURL=batch-get.cjs.map

package/dist/commands/batch-get.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"batch-get.cjs","sources":["../../src/commands/batch-get.ts"],"sourcesContent":[null],"names":["__classPrivateFieldSet","BatchGetCommand","__classPrivateFieldGet","BATCH_GET_VALIDATION_CONCURRENCY"],"mappings":";;;;;;;;MAkBa,QAAQ,CAAA;AAKnB,IAAA,WAAA,CAAY,MAA8B,EAAA;QAF1C,gBAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;AAGE,QAAAA,gCAAA,CAAA,IAAI,EAAA,gBAAA,EAAW,MAAM,EAAA,GAAA,CAAA;IACvB;AAEa,IAAA,OAAO,CAAC,MAA4B,EAAA;;;AAC/C,YAAA,MAAM,QAAQ,GAAG,IAAIC,2BAAe,CAAC;AACnC,gBAAA,YAAY,EAAE;AACZ,oBAAA,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,GAAG;AACxB,wBAAA,IAAI,EAAEC,gCAAA,CAAA,IAAI,wBAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,MAAM,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;wBAC/D,cAAc,EAAE,MAAAA,gCAAA,CAAA,IAAI,wBAAQ,CAAC,UAAU,mCAAI,KAAK;AACjD,qBAAA;AACF,iBAAA;AACD,gBAAA,sBAAsB,EAAEA,gCAAA,CAAA,IAAI,EAAA,gBAAA,EAAA,GAAA,CAAQ,CAAC,sBAAsB;AAC5D,aAAA,CAAC;AAEF,YAAA,MAAM,cAAc,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE;gBACtE,WAAW,EAAE,MAAAA,gCAAA,CAAA,IAAI,wBAAQ,CAAC,eAAe,0CAAE,MAAM;AACjD,gBAAA,cAAc,EAAEA,gCAAA,CAAA,IAAI,EAAA,gBAAA,EAAA,GAAA,CAAQ,CAAC,SAAS;AACvC,aAAA,CAAC;AAEF,YAAA,MAAM,QAAQ,GAAG,CAAA,EAAA,GAAA,CAAA,EAAA,GAAA,cAAc,CAAC,SAAS,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,MAAA,GAAA,EAAA,CAAG,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,EAAA,GAAI,EAAE;YACzE,IAAI,KAAK,GAAgC,EAAE;AAE3C,YAAA,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;AACvB,gBAAA,IAAIA,iCAAA,IAAI,EAAA,gBAAA,EAAA,GAAA,CAAQ,CAAC,cAAc,EAAE;oBAC/B,KAAK,GAAG,QAAuC;gBACjD;qBAAO;AACL,oBAAA,KAAK,GAAG,MAAM,IAAI,CAAC,QAAQ,EAAE,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;AACnE,wBAAA,WAAW,EAAEC,kDAAgC;wBAC7C,MAAM,EAAE,MAAAD,gCAAA,CAAA,IAAI,wBAAQ,CAAC,eAAe,0CAAE,MAAM;AAC7C,qBAAA,CAAC;gBACJ;YACF;YAEA,OAAO;gBACL,KAAK;AACL,gBAAA,eAAe,EAAE,CAAA,EAAA,GAAA,CAAA,EAAA,GAAA,cAAc,CAAC,eAAe,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,MAAA,GAAA,EAAA,CAAG,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,0CAAE,IAE9D;gBACb,gBAAgB,EAAE,cAAc,CAAC,SAAS;AAC1C,gBAAA,gBAAgB,EAAE,CAAA,EAAA,GAAA,cAAc,CAAC,gBAAgB,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,MAAA,GAAA,EAAA,CAAG,CAAC,CAAC;aACvD;QACH,CAAC,CAAA;AAAA,IAAA;AACF;;;;;"}

package/dist/commands/batch-get.d.ts

@@ -0,0 +1,17 @@
+import type { BaseConfig, BaseCommand, BaseResult } from '@/commands/base-command';
+import type { DynamoEntity } from '@/core/entity';
+import type { EntitySchema } from '@/core/core-types';
+import type { ZodObject } from 'zod/v4';
+export type BatchGetConfig<Schema extends ZodObject> = BaseConfig & {
+    keys: Array<Partial<EntitySchema<Schema>>>;
+    consistent?: boolean;
+};
+export type BatchGetResult<Schema extends ZodObject> = BaseResult & {
+    items: Array<EntitySchema<Schema>>;
+    unprocessedKeys?: Array<Partial<EntitySchema<Schema>>>;
+};
+export declare class BatchGet<Schema extends ZodObject> implements BaseCommand<BatchGetResult<Schema>, Schema> {
+    #private;
+    constructor(config: BatchGetConfig<Schema>);
+    execute(entity: DynamoEntity<Schema>): Promise<BatchGetResult<Schema>>;
+}

package/dist/commands/batch-get.mjs

@@ -0,0 +1,53 @@
+import { __classPrivateFieldSet, __awaiter, __classPrivateFieldGet } from '../node_modules/tslib/tslib.es6.mjs';
+import { BATCH_GET_VALIDATION_CONCURRENCY } from '../internal-constants.mjs';
+import { BatchGetCommand } from '@aws-sdk/lib-dynamodb';
+import pMap from 'p-map';
+
+var _BatchGet_config;
+class BatchGet {
+    constructor(config) {
+        _BatchGet_config.set(this, void 0);
+        __classPrivateFieldSet(this, _BatchGet_config, config, "f");
+    }
+    execute(entity) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            const batchGet = new BatchGetCommand({
+                RequestItems: {
+                    [entity.table.tableName]: {
+                        Keys: __classPrivateFieldGet(this, _BatchGet_config, "f").keys.map(key => entity.buildPrimaryKey(key)),
+                        ConsistentRead: (_a = __classPrivateFieldGet(this, _BatchGet_config, "f").consistent) !== null && _a !== void 0 ? _a : false,
+                    },
+                },
+                ReturnConsumedCapacity: __classPrivateFieldGet(this, _BatchGet_config, "f").returnConsumedCapacity,
+            });
+            const batchGetResult = yield entity.table.documentClient.send(batchGet, {
+                abortSignal: (_b = __classPrivateFieldGet(this, _BatchGet_config, "f").abortController) === null || _b === void 0 ? void 0 : _b.signal,
+                requestTimeout: __classPrivateFieldGet(this, _BatchGet_config, "f").timeoutMs,
+            });
+            const rawItems = (_d = (_c = batchGetResult.Responses) === null || _c === void 0 ? void 0 : _c[entity.table.tableName]) !== null && _d !== void 0 ? _d : [];
+            let items = [];
+            if (rawItems.length > 0) {
+                if (__classPrivateFieldGet(this, _BatchGet_config, "f").skipValidation) {
+                    items = rawItems;
+                }
+                else {
+                    items = yield pMap(rawItems, item => entity.schema.parseAsync(item), {
+                        concurrency: BATCH_GET_VALIDATION_CONCURRENCY,
+                        signal: (_e = __classPrivateFieldGet(this, _BatchGet_config, "f").abortController) === null || _e === void 0 ? void 0 : _e.signal,
+                    });
+                }
+            }
+            return {
+                items,
+                unprocessedKeys: (_g = (_f = batchGetResult.UnprocessedKeys) === null || _f === void 0 ? void 0 : _f[entity.table.tableName]) === null || _g === void 0 ? void 0 : _g.Keys,
+                responseMetadata: batchGetResult.$metadata,
+                consumedCapacity: (_h = batchGetResult.ConsumedCapacity) === null || _h === void 0 ? void 0 : _h[0],
+            };
+        });
+    }
+}
+_BatchGet_config = new WeakMap();
+
+export { BatchGet };
+//# sourceMappingURL=batch-get.mjs.map

package/dist/commands/batch-get.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"batch-get.mjs","sources":["../../src/commands/batch-get.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;MAkBa,QAAQ,CAAA;AAKnB,IAAA,WAAA,CAAY,MAA8B,EAAA;QAF1C,gBAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;AAGE,QAAA,sBAAA,CAAA,IAAI,EAAA,gBAAA,EAAW,MAAM,EAAA,GAAA,CAAA;IACvB;AAEa,IAAA,OAAO,CAAC,MAA4B,EAAA;;;AAC/C,YAAA,MAAM,QAAQ,GAAG,IAAI,eAAe,CAAC;AACnC,gBAAA,YAAY,EAAE;AACZ,oBAAA,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,GAAG;AACxB,wBAAA,IAAI,EAAE,sBAAA,CAAA,IAAI,wBAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,MAAM,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;wBAC/D,cAAc,EAAE,MAAA,sBAAA,CAAA,IAAI,wBAAQ,CAAC,UAAU,mCAAI,KAAK;AACjD,qBAAA;AACF,iBAAA;AACD,gBAAA,sBAAsB,EAAE,sBAAA,CAAA,IAAI,EAAA,gBAAA,EAAA,GAAA,CAAQ,CAAC,sBAAsB;AAC5D,aAAA,CAAC;AAEF,YAAA,MAAM,cAAc,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE;gBACtE,WAAW,EAAE,MAAA,sBAAA,CAAA,IAAI,wBAAQ,CAAC,eAAe,0CAAE,MAAM;AACjD,gBAAA,cAAc,EAAE,sBAAA,CAAA,IAAI,EAAA,gBAAA,EAAA,GAAA,CAAQ,CAAC,SAAS;AACvC,aAAA,CAAC;AAEF,YAAA,MAAM,QAAQ,GAAG,CAAA,EAAA,GAAA,CAAA,EAAA,GAAA,cAAc,CAAC,SAAS,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,MAAA,GAAA,EAAA,CAAG,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,EAAA,GAAI,EAAE;YACzE,IAAI,KAAK,GAAgC,EAAE;AAE3C,YAAA,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;AACvB,gBAAA,IAAI,uBAAA,IAAI,EAAA,gBAAA,EAAA,GAAA,CAAQ,CAAC,cAAc,EAAE;oBAC/B,KAAK,GAAG,QAAuC;gBACjD;qBAAO;AACL,oBAAA,KAAK,GAAG,MAAM,IAAI,CAAC,QAAQ,EAAE,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;AACnE,wBAAA,WAAW,EAAE,gCAAgC;wBAC7C,MAAM,EAAE,MAAA,sBAAA,CAAA,IAAI,wBAAQ,CAAC,eAAe,0CAAE,MAAM;AAC7C,qBAAA,CAAC;gBACJ;YACF;YAEA,OAAO;gBACL,KAAK;AACL,gBAAA,eAAe,EAAE,CAAA,EAAA,GAAA,CAAA,EAAA,GAAA,cAAc,CAAC,eAAe,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,MAAA,GAAA,EAAA,CAAG,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,0CAAE,IAE9D;gBACb,gBAAgB,EAAE,cAAc,CAAC,SAAS;AAC1C,gBAAA,gBAAgB,EAAE,CAAA,EAAA,GAAA,cAAc,CAAC,gBAAgB,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,MAAA,GAAA,EAAA,CAAG,CAAC,CAAC;aACvD;QACH,CAAC,CAAA;AAAA,IAAA;AACF;;;;;"}

package/dist/commands/batch-write.cjs

@@ -0,0 +1,94 @@
+'use strict';
+
+var tslib_es6 = require('../node_modules/tslib/tslib.es6.cjs');
+var internalConstants = require('../internal-constants.cjs');
+var libDynamodb = require('@aws-sdk/lib-dynamodb');
+var pMap = require('p-map');
+
+var _BatchWrite_config;
+class BatchWrite {
+    constructor(config) {
+        _BatchWrite_config.set(this, void 0);
+        tslib_es6.__classPrivateFieldSet(this, _BatchWrite_config, config, "f");
+    }
+    buildPutRequests(entity) {
+        return tslib_es6.__awaiter(this, void 0, void 0, function* () {
+            var _a;
+            if (!tslib_es6.__classPrivateFieldGet(this, _BatchWrite_config, "f").items || tslib_es6.__classPrivateFieldGet(this, _BatchWrite_config, "f").items.length === 0) {
+                return [];
+            }
+            if (tslib_es6.__classPrivateFieldGet(this, _BatchWrite_config, "f").skipValidation) {
+                return tslib_es6.__classPrivateFieldGet(this, _BatchWrite_config, "f").items.map(item => ({
+                    PutRequest: {
+                        Item: Object.assign(Object.assign({}, item), entity.buildAllKeys(item)),
+                    },
+                }));
+            }
+            return pMap(tslib_es6.__classPrivateFieldGet(this, _BatchWrite_config, "f").items, (item) => tslib_es6.__awaiter(this, void 0, void 0, function* () {
+                const encodedData = yield entity.schema.encodeAsync(item);
+                return {
+                    PutRequest: {
+                        Item: Object.assign(Object.assign({}, encodedData), entity.buildAllKeys(item)),
+                    },
+                };
+            }), {
+                concurrency: internalConstants.BATCH_WRITE_VALIDATION_CONCURRENCY,
+                signal: (_a = tslib_es6.__classPrivateFieldGet(this, _BatchWrite_config, "f").abortController) === null || _a === void 0 ? void 0 : _a.signal,
+            });
+        });
+    }
+    buildDeleteRequests(entity) {
+        return tslib_es6.__awaiter(this, void 0, void 0, function* () {
+            if (!tslib_es6.__classPrivateFieldGet(this, _BatchWrite_config, "f").deletes || tslib_es6.__classPrivateFieldGet(this, _BatchWrite_config, "f").deletes.length === 0) {
+                return [];
+            }
+            return tslib_es6.__classPrivateFieldGet(this, _BatchWrite_config, "f").deletes.map(key => ({
+                DeleteRequest: {
+                    Key: entity.buildPrimaryKey(key),
+                },
+            }));
+        });
+    }
+    execute(entity) {
+        return tslib_es6.__awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d;
+            const [putRequests, deleteRequests] = yield Promise.all([
+                this.buildPutRequests(entity),
+                this.buildDeleteRequests(entity),
+            ]);
+            const batchWrite = new libDynamodb.BatchWriteCommand({
+                RequestItems: {
+                    [entity.table.tableName]: [...putRequests, ...deleteRequests],
+                },
+                ReturnConsumedCapacity: tslib_es6.__classPrivateFieldGet(this, _BatchWrite_config, "f").returnConsumedCapacity,
+                ReturnItemCollectionMetrics: tslib_es6.__classPrivateFieldGet(this, _BatchWrite_config, "f").returnItemCollectionMetrics,
+            });
+            const batchWriteResult = yield entity.table.documentClient.send(batchWrite, {
+                abortSignal: (_a = tslib_es6.__classPrivateFieldGet(this, _BatchWrite_config, "f").abortController) === null || _a === void 0 ? void 0 : _a.signal,
+                requestTimeout: tslib_es6.__classPrivateFieldGet(this, _BatchWrite_config, "f").timeoutMs,
+            });
+            const unprocessedItems = (_c = (_b = batchWriteResult.UnprocessedItems) === null || _b === void 0 ? void 0 : _b[entity.table.tableName]) !== null && _c !== void 0 ? _c : [];
+            const unprocessedPuts = [];
+            const unprocessedDeletes = [];
+            for (const unprocessedItem of unprocessedItems) {
+                if (unprocessedItem.PutRequest) {
+                    unprocessedPuts.push(unprocessedItem.PutRequest.Item);
+                }
+                else if (unprocessedItem.DeleteRequest) {
+                    unprocessedDeletes.push(unprocessedItem.DeleteRequest.Key);
+                }
+            }
+            return {
+                unprocessedPuts: unprocessedPuts.length > 0 ? unprocessedPuts : undefined,
+                unprocessedDeletes: unprocessedDeletes.length > 0 ? unprocessedDeletes : undefined,
+                responseMetadata: batchWriteResult.$metadata,
+                consumedCapacity: (_d = batchWriteResult.ConsumedCapacity) === null || _d === void 0 ? void 0 : _d[0],
+                itemColectionMetrics: batchWriteResult.ItemCollectionMetrics,
+            };
+        });
+    }
+}
+_BatchWrite_config = new WeakMap();
+
+exports.BatchWrite = BatchWrite;
+//# sourceMappingURL=batch-write.cjs.map