dynamo-document-builder 0.6.0 → 0.7.0

package/dist/commands/conditional-update.d.ts

@@ -1,19 +1,64 @@
-import { Condition } from '../conditions/condition-types.js';
+import { Condition } from '../conditions/index.js';
 import { DynamoEntity } from '../core/entity.js';
-import { EntitySchema, TransactWriteOperation } from '../core/core-types.js';
+import { EntitySchema, TransactWriteOperation } from '../core/index.js';
 import { ReturnValuesOnConditionCheckFailure, ItemCollectionMetrics } from '@aws-sdk/client-dynamodb';
 import { UpdateConfig } from './update.js';
 import { ZodObject } from 'zod/v4';
-import { BaseResult, BaseCommand, WriteTransactable } from './base-command.js';
+import { BaseResult, BaseCommand, WriteTransactable } from './index.js';
 
+/**
+ * Configuration for the ConditionalUpdate command.
+ *
+ * @template Schema - The Zod schema defining the structure of the entity.
+ */
 type ConditionalUpdateConfig<Schema extends ZodObject> = UpdateConfig<Schema> & {
     condition: Condition;
     returnValuesOnConditionCheckFailure?: ReturnValuesOnConditionCheckFailure;
 };
+/**
+ * Result of the ConditionalUpdate command.
+ *
+ * @template Schema - The Zod schema defining the structure of the entity.
+ */
 type ConditionalUpdateResult<Schema extends ZodObject> = BaseResult & {
     updatedItem?: EntitySchema<Schema> | undefined;
     itemCollectionMetrics?: ItemCollectionMetrics;
 };
+/**
+ * Command to modify existing item attributes with a condition expression.
+ *
+ * @template Schema - The Zod schema defining the structure of the entity.
+ *
+ * @example
+ * ```typescript
+ * import { DynamoTable, DynamoEntity, key, ConditionalUpdate, add } from 'dynamo-document-builder';
+ *
+ * const table = new DynamoTable({
+ *   tableName: 'ExampleTable',
+ *   documentClient,
+ * });
+ *
+ * const userEntity = new DynamoEntity({
+ *   table,
+ *   schema: z.object({
+ *     userId: z.string(),
+ *     balance: z.number(),
+ *     status: z.string(),
+ *   }),
+ *   partitionKey: user => key('USER', user.userId),
+ *   sortKey: () => 'METADATA',
+ * });
+ *
+ * const conditionalUpdateCommand = new ConditionalUpdate({
+ *   key: { userId: 'user123' },
+ *   update: { balance: add(50) },
+ *   condition: { status: 'active' },
+ *   returnValues: 'ALL_NEW',
+ * });
+ *
+ * const { updatedItem } = await userEntity.send(conditionalUpdateCommand);
+ * ```
+ */
 declare class ConditionalUpdate<Schema extends ZodObject> implements BaseCommand<ConditionalUpdateResult<Schema>, Schema>, WriteTransactable<Schema> {
     #private;
     constructor(config: ConditionalUpdateConfig<Schema>);

package/dist/commands/conditional-update.mjs

@@ -5,6 +5,41 @@ import { parseCondition } from '../conditions/condition-parser.mjs';
 import { parseUpdate } from '../updates/update-parser.mjs';
 
 var _ConditionalUpdate_config;
+/**
+ * Command to modify existing item attributes with a condition expression.
+ *
+ * @template Schema - The Zod schema defining the structure of the entity.
+ *
+ * @example
+ * ```typescript
+ * import { DynamoTable, DynamoEntity, key, ConditionalUpdate, add } from 'dynamo-document-builder';
+ *
+ * const table = new DynamoTable({
+ *   tableName: 'ExampleTable',
+ *   documentClient,
+ * });
+ *
+ * const userEntity = new DynamoEntity({
+ *   table,
+ *   schema: z.object({
+ *     userId: z.string(),
+ *     balance: z.number(),
+ *     status: z.string(),
+ *   }),
+ *   partitionKey: user => key('USER', user.userId),
+ *   sortKey: () => 'METADATA',
+ * });
+ *
+ * const conditionalUpdateCommand = new ConditionalUpdate({
+ *   key: { userId: 'user123' },
+ *   update: { balance: add(50) },
+ *   condition: { status: 'active' },
+ *   returnValues: 'ALL_NEW',
+ * });
+ *
+ * const { updatedItem } = await userEntity.send(conditionalUpdateCommand);
+ * ```
+ */
 class ConditionalUpdate {
     constructor(config) {
         _ConditionalUpdate_config.set(this, void 0);

package/dist/commands/conditional-update.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"conditional-update.mjs","sources":["../../src/commands/conditional-update.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;;MAyBa,iBAAiB,CAAA;AAK5B,IAAA,WAAA,CAAY,MAAuC,EAAA;QAFnD,yBAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;AAGE,QAAA,sBAAA,CAAA,IAAI,EAAA,yBAAA,EAAW,MAAM,EAAA,GAAA,CAAA;IACvB;AAEa,IAAA,OAAO,CAAC,MAA4B,EAAA;;;AAC/C,YAAA,MAAM,sBAAsB,GAAG,IAAI,sBAAsB,EAAE;AAE3D,YAAA,MAAM,EAAE,gBAAgB,EAAE,GAAG,WAAW,CAAC,sBAAA,CAAA,IAAI,EAAA,yBAAA,EAAA,GAAA,CAAQ,CAAC,MAAM,EAAE,sBAAsB,CAAC;AACrF,YAAA,MAAM,EAAE,mBAAmB,EAAE,GAAG,cAAc,CAAC,sBAAA,CAAA,IAAI,EAAA,yBAAA,EAAA,GAAA,CAAQ,CAAC,SAAS,EAAE,sBAAsB,CAAC;AAE9F,YAAA,MAAM,UAAU,GAAG,IAAI,aAAa,+BAClC,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,SAAS,EACjC,GAAG,EAAE,MAAM,CAAC,eAAe,CAAC,sBAAA,CAAA,IAAI,EAAA,yBAAA,EAAA,GAAA,CAAQ,CAAC,GAAG,CAAC,EAC7C,gBAAgB,EAAE,gBAAgB,EAClC,mBAAmB,EAAE,mBAAmB,EAAA,EACrC,sBAAsB,CAAC,2BAA2B,EAAE,CAAA,EAAA,EACvD,YAAY,EAAE,uBAAA,IAAI,EAAA,yBAAA,EAAA,GAAA,CAAQ,CAAC,YAAY,EACvC,2BAA2B,EAAE,sBAAA,CAAA,IAAI,iCAAQ,CAAC,2BAA2B,EACrE,sBAAsB,EAAE,sBAAA,CAAA,IAAI,EAAA,yBAAA,EAAA,GAAA,CAAQ,CAAC,sBAAsB,EAC3D,mCAAmC,EAAE,uBAAA,IAAI,EAAA,yBAAA,EAAA,GAAA,CAAQ,CAAC,mCAAmC,IACrF;AAEF,YAAA,MAAM,YAAY,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,EAAE;gBACtE,WAAW,EAAE,MAAA,sBAAA,CAAA,IAAI,iCAAQ,CAAC,eAAe,0CAAE,MAAM;AACjD,gBAAA,cAAc,EAAE,sBAAA,CAAA,IAAI,EAAA,yBAAA,EAAA,GAAA,CAAQ,CAAC,SAAS;AACvC,aAAA,CAAC;AAEF,YAAA,IAAI,WAA6C;AACjD,YAAA,IAAI,YAAY,CAAC,UAAU,EAAE;AAC3B,gBAAA,IAAI,uBAAA,IAAI,EAAA,yBAAA,EAAA,GAAA,CAAQ,CAAC,cAAc,EAAE;AAC/B,oBAAA,WAAW,GAAG,YAAY,CAAC,UAAkC;gBAC/D;qBAAO;AACL,oBAAA,WAAW,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,YAAY,CAAC,UAAU,CAAC;gBACvE;YACF;YAEA,OAAO;gBACL,WAAW;gBACX,gBAAgB,EAAE,YAAY,CAAC,SAAS;gBACxC,gBAAgB,EAAE,YAAY,CAAC,gBAAgB;gBAC/C,qBAAqB,EAAE,YAAY,CAAC,qBAAqB;aAC1D;QACH,CAAC,CAAA;AAAA,IAAA;AAEY,IAAA,uBAAuB,CAClC,MAA4B,EAAA;;AAE5B,YAAA,MAAM,sBAAsB,GAAG,IAAI,sBAAsB,EAAE;AAC3D,YAAA,MAAM,EAAE,gBAAgB,EAAE,GAAG,WAAW,CAAC,sBAAA,CAAA,IAAI,EAAA,yBAAA,EAAA,GAAA,CAAQ,CAAC,MAAM,EAAE,sBAAsB,CAAC;AACrF,YAAA,MAAM,EAAE,mBAAmB,EAAE,GAAG,cAAc,CAAC,sBAAA,CAAA,IAAI,EAAA,yBAAA,EAAA,GAAA,CAAQ,CAAC,SAAS,EAAE,sBAAsB,CAAC;YAC9F,OAAO;AACL,gBAAA,MAAM,gCACJ,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,SAAS,EACjC,GAAG,EAAE,MAAM,CAAC,eAAe,CAAC,uBAAA,IAAI,EAAA,yBAAA,EAAA,GAAA,CAAQ,CAAC,GAAG,CAAC,EAC7C,gBAAgB,EAAE,gBAAgB,EAClC,mBAAmB,EAAE,mBAAmB,IACrC,sBAAsB,CAAC,2BAA2B,EAAE,CAAA,EAAA,EACvD,mCAAmC,EAAE,sBAAA,CAAA,IAAI,EAAA,yBAAA,EAAA,GAAA,CAAQ,CAAC,mCAAmC,EAAA,CACtF;aACF;QACH,CAAC,CAAA;AAAA,IAAA;AACF;;;;;"}
+{"version":3,"file":"conditional-update.mjs","sources":["../../src/commands/conditional-update.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;;AAmCA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkCG;MACU,iBAAiB,CAAA;AAK5B,IAAA,WAAA,CAAY,MAAuC,EAAA;QAFnD,yBAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;AAGE,QAAA,sBAAA,CAAA,IAAI,EAAA,yBAAA,EAAW,MAAM,EAAA,GAAA,CAAA;IACvB;AAEa,IAAA,OAAO,CAAC,MAA4B,EAAA;;;AAC/C,YAAA,MAAM,sBAAsB,GAAG,IAAI,sBAAsB,EAAE;AAE3D,YAAA,MAAM,EAAE,gBAAgB,EAAE,GAAG,WAAW,CAAC,sBAAA,CAAA,IAAI,EAAA,yBAAA,EAAA,GAAA,CAAQ,CAAC,MAAM,EAAE,sBAAsB,CAAC;AACrF,YAAA,MAAM,EAAE,mBAAmB,EAAE,GAAG,cAAc,CAAC,sBAAA,CAAA,IAAI,EAAA,yBAAA,EAAA,GAAA,CAAQ,CAAC,SAAS,EAAE,sBAAsB,CAAC;AAE9F,YAAA,MAAM,UAAU,GAAG,IAAI,aAAa,+BAClC,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,SAAS,EACjC,GAAG,EAAE,MAAM,CAAC,eAAe,CAAC,sBAAA,CAAA,IAAI,EAAA,yBAAA,EAAA,GAAA,CAAQ,CAAC,GAAG,CAAC,EAC7C,gBAAgB,EAAE,gBAAgB,EAClC,mBAAmB,EAAE,mBAAmB,EAAA,EACrC,sBAAsB,CAAC,2BAA2B,EAAE,CAAA,EAAA,EACvD,YAAY,EAAE,uBAAA,IAAI,EAAA,yBAAA,EAAA,GAAA,CAAQ,CAAC,YAAY,EACvC,2BAA2B,EAAE,sBAAA,CAAA,IAAI,iCAAQ,CAAC,2BAA2B,EACrE,sBAAsB,EAAE,sBAAA,CAAA,IAAI,EAAA,yBAAA,EAAA,GAAA,CAAQ,CAAC,sBAAsB,EAC3D,mCAAmC,EAAE,uBAAA,IAAI,EAAA,yBAAA,EAAA,GAAA,CAAQ,CAAC,mCAAmC,IACrF;AAEF,YAAA,MAAM,YAAY,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,EAAE;gBACtE,WAAW,EAAE,MAAA,sBAAA,CAAA,IAAI,iCAAQ,CAAC,eAAe,0CAAE,MAAM;AACjD,gBAAA,cAAc,EAAE,sBAAA,CAAA,IAAI,EAAA,yBAAA,EAAA,GAAA,CAAQ,CAAC,SAAS;AACvC,aAAA,CAAC;AAEF,YAAA,IAAI,WAA6C;AACjD,YAAA,IAAI,YAAY,CAAC,UAAU,EAAE;AAC3B,gBAAA,IAAI,uBAAA,IAAI,EAAA,yBAAA,EAAA,GAAA,CAAQ,CAAC,cAAc,EAAE;AAC/B,oBAAA,WAAW,GAAG,YAAY,CAAC,UAAkC;gBAC/D;qBAAO;AACL,oBAAA,WAAW,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,YAAY,CAAC,UAAU,CAAC;gBACvE;YACF;YAEA,OAAO;gBACL,WAAW;gBACX,gBAAgB,EAAE,YAAY,CAAC,SAAS;gBACxC,gBAAgB,EAAE,YAAY,CAAC,gBAAgB;gBAC/C,qBAAqB,EAAE,YAAY,CAAC,qBAAqB;aAC1D;QACH,CAAC,CAAA;AAAA,IAAA;AAEY,IAAA,uBAAuB,CAClC,MAA4B,EAAA;;AAE5B,YAAA,MAAM,sBAAsB,GAAG,IAAI,sBAAsB,EAAE;AAC3D,YAAA,MAAM,EAAE,gBAAgB,EAAE,GAAG,WAAW,CAAC,sBAAA,CAAA,IAAI,EAAA,yBAAA,EAAA,GAAA,CAAQ,CAAC,MAAM,EAAE,sBAAsB,CAAC;AACrF,YAAA,MAAM,EAAE,mBAAmB,EAAE,GAAG,cAAc,CAAC,sBAAA,CAAA,IAAI,EAAA,yBAAA,EAAA,GAAA,CAAQ,CAAC,SAAS,EAAE,sBAAsB,CAAC;YAC9F,OAAO;AACL,gBAAA,MAAM,gCACJ,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,SAAS,EACjC,GAAG,EAAE,MAAM,CAAC,eAAe,CAAC,uBAAA,IAAI,EAAA,yBAAA,EAAA,GAAA,CAAQ,CAAC,GAAG,CAAC,EAC7C,gBAAgB,EAAE,gBAAgB,EAClC,mBAAmB,EAAE,mBAAmB,IACrC,sBAAsB,CAAC,2BAA2B,EAAE,CAAA,EAAA,EACvD,mCAAmC,EAAE,sBAAA,CAAA,IAAI,EAAA,yBAAA,EAAA,GAAA,CAAQ,CAAC,mCAAmC,EAAA,CACtF;aACF;QACH,CAAC,CAAA;AAAA,IAAA;AACF;;;;;"}

package/dist/commands/delete.cjs

@@ -4,6 +4,38 @@ var tslib_es6 = require('../node_modules/tslib/tslib.es6.cjs');
 var libDynamodb = require('@aws-sdk/lib-dynamodb');
 
 var _Delete_config;
+/**
+ * Command to remove an item from a DynamoDB table.
+ *
+ * @template Schema - The Zod schema defining the structure of the entity.
+ *
+ * @example
+ * ```typescript
+ * import { DynamoTable, DynamoEntity, key, Delete } from 'dynamo-document-builder';
+ *
+ * const table = new DynamoTable({
+ *   tableName: 'ExampleTable',
+ *   documentClient,
+ * });
+ *
+ * const userEntity = new DynamoEntity({
+ *   table,
+ *   schema: z.object({
+ *     userId: z.string(),
+ *     name: z.string(),
+ *   }),
+ *   partitionKey: user => key('USER', user.userId),
+ *   sortKey: () => 'METADATA',
+ * });
+ *
+ * const deleteCommand = new Delete({
+ *   key: { userId: 'user123' },
+ *   returnValues: 'ALL_OLD',
+ * });
+ *
+ * const { deletedItem } = await userEntity.send(deleteCommand);
+ * ```
+ */
 class Delete {
     constructor(config) {
         _Delete_config.set(this, void 0);

package/dist/commands/delete.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"delete.cjs","sources":["../../src/commands/delete.ts"],"sourcesContent":[null],"names":["__classPrivateFieldSet","DeleteCommand","__classPrivateFieldGet"],"mappings":";;;;;;MA2Ba,MAAM,CAAA;AAKjB,IAAA,WAAA,CAAY,MAA4B,EAAA;QAFxC,cAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;AAGE,QAAAA,gCAAA,CAAA,IAAI,EAAA,cAAA,EAAW,MAAM,EAAA,GAAA,CAAA;IACvB;AAEa,IAAA,OAAO,CAAC,MAA4B,EAAA;;;AAC/C,YAAA,MAAM,SAAS,GAAG,IAAIC,yBAAa,CAAC;AAClC,gBAAA,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,SAAS;gBACjC,GAAG,EAAE,MAAM,CAAC,eAAe,CAACC,iCAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,GAAG,CAAC;AAC7C,gBAAA,YAAY,EAAEA,gCAAA,CAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,YAAY;AACvC,gBAAA,sBAAsB,EAAEA,gCAAA,CAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,sBAAsB;AAC3D,gBAAA,2BAA2B,EAAEA,gCAAA,CAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,2BAA2B;AACtE,aAAA,CAAC;AAEF,YAAA,MAAM,YAAY,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,SAAS,EAAE;gBACrE,WAAW,EAAE,MAAAA,gCAAA,CAAA,IAAI,sBAAQ,CAAC,eAAe,0CAAE,MAAM;AACjD,gBAAA,cAAc,EAAEA,gCAAA,CAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,SAAS;AACvC,aAAA,CAAC;AAEF,YAAA,IAAI,WAAsD;AAC1D,YAAA,IAAI,YAAY,CAAC,UAAU,EAAE;AAC3B,gBAAA,IAAIA,iCAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,cAAc,EAAE;AAC/B,oBAAA,WAAW,GAAG,YAAY,CAAC,UAA2C;gBACxE;qBAAO;AACL,oBAAA,WAAW,IAAI,MAAM,MAAM,CAAC;AACzB,yBAAA,OAAO;AACP,yBAAA,UAAU,CAAC,YAAY,CAAC,UAAU,CAAC,CAAkC;gBAC1E;YACF;YAEA,OAAO;gBACL,WAAW;gBACX,gBAAgB,EAAE,YAAY,CAAC,SAAS;gBACxC,gBAAgB,EAAE,YAAY,CAAC,gBAAgB;gBAC/C,qBAAqB,EAAE,YAAY,CAAC,qBAAqB;aAC1D;QACH,CAAC,CAAA;AAAA,IAAA;AAEY,IAAA,uBAAuB,CAClC,MAA4B,EAAA;;YAE5B,OAAO;AACL,gBAAA,MAAM,EAAE;AACN,oBAAA,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,SAAS;oBACjC,GAAG,EAAE,MAAM,CAAC,eAAe,CAACA,iCAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,GAAG,CAAC;AAC9C,iBAAA;aACF;QACH,CAAC,CAAA;AAAA,IAAA;AACF;;;;;"}
+{"version":3,"file":"delete.cjs","sources":["../../src/commands/delete.ts"],"sourcesContent":[null],"names":["__classPrivateFieldSet","DeleteCommand","__classPrivateFieldGet"],"mappings":";;;;;;AAgCA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BG;MACU,MAAM,CAAA;AAKjB,IAAA,WAAA,CAAY,MAA4B,EAAA;QAFxC,cAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;AAGE,QAAAA,gCAAA,CAAA,IAAI,EAAA,cAAA,EAAW,MAAM,EAAA,GAAA,CAAA;IACvB;AAEa,IAAA,OAAO,CAAC,MAA4B,EAAA;;;AAC/C,YAAA,MAAM,SAAS,GAAG,IAAIC,yBAAa,CAAC;AAClC,gBAAA,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,SAAS;gBACjC,GAAG,EAAE,MAAM,CAAC,eAAe,CAACC,iCAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,GAAG,CAAC;AAC7C,gBAAA,YAAY,EAAEA,gCAAA,CAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,YAAY;AACvC,gBAAA,sBAAsB,EAAEA,gCAAA,CAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,sBAAsB;AAC3D,gBAAA,2BAA2B,EAAEA,gCAAA,CAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,2BAA2B;AACtE,aAAA,CAAC;AAEF,YAAA,MAAM,YAAY,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,SAAS,EAAE;gBACrE,WAAW,EAAE,MAAAA,gCAAA,CAAA,IAAI,sBAAQ,CAAC,eAAe,0CAAE,MAAM;AACjD,gBAAA,cAAc,EAAEA,gCAAA,CAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,SAAS;AACvC,aAAA,CAAC;AAEF,YAAA,IAAI,WAAsD;AAC1D,YAAA,IAAI,YAAY,CAAC,UAAU,EAAE;AAC3B,gBAAA,IAAIA,iCAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,cAAc,EAAE;AAC/B,oBAAA,WAAW,GAAG,YAAY,CAAC,UAA2C;gBACxE;qBAAO;AACL,oBAAA,WAAW,IAAI,MAAM,MAAM,CAAC;AACzB,yBAAA,OAAO;AACP,yBAAA,UAAU,CAAC,YAAY,CAAC,UAAU,CAAC,CAAkC;gBAC1E;YACF;YAEA,OAAO;gBACL,WAAW;gBACX,gBAAgB,EAAE,YAAY,CAAC,SAAS;gBACxC,gBAAgB,EAAE,YAAY,CAAC,gBAAgB;gBAC/C,qBAAqB,EAAE,YAAY,CAAC,qBAAqB;aAC1D;QACH,CAAC,CAAA;AAAA,IAAA;AAEY,IAAA,uBAAuB,CAClC,MAA4B,EAAA;;YAE5B,OAAO;AACL,gBAAA,MAAM,EAAE;AACN,oBAAA,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,SAAS;oBACjC,GAAG,EAAE,MAAM,CAAC,eAAe,CAACA,iCAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,GAAG,CAAC;AAC9C,iBAAA;aACF;QACH,CAAC,CAAA;AAAA,IAAA;AACF;;;;;"}

package/dist/commands/delete.d.ts

@@ -1,18 +1,60 @@
 import { DynamoEntity } from '../core/entity.js';
-import { EntitySchema, TransactWriteOperation } from '../core/core-types.js';
+import { EntitySchema, TransactWriteOperation } from '../core/index.js';
 import { ReturnValue, ReturnItemCollectionMetrics, ItemCollectionMetrics } from '@aws-sdk/client-dynamodb';
 import { ZodObject } from 'zod/v4';
-import { BaseConfig, BaseResult, BaseCommand, WriteTransactable } from './base-command.js';
+import { BaseConfig, BaseResult, BaseCommand, WriteTransactable } from './index.js';
 
+/**
+ * Configuration for the Delete command.
+ *
+ * @template Schema - The Zod schema defining the structure of the entity.
+ */
 type DeleteConfig<Schema extends ZodObject> = BaseConfig & {
     key: Partial<EntitySchema<Schema>>;
     returnValues?: ReturnValue;
     returnItemCollectionMetrics?: ReturnItemCollectionMetrics;
 };
+/**
+ * Result of the Delete command.
+ *
+ * @template Schema - The Zod schema defining the structure of the entity.
+ */
 type DeleteResult<Schema extends ZodObject> = BaseResult & {
     deletedItem?: Partial<EntitySchema<Schema>> | undefined;
     itemCollectionMetrics?: ItemCollectionMetrics;
 };
+/**
+ * Command to remove an item from a DynamoDB table.
+ *
+ * @template Schema - The Zod schema defining the structure of the entity.
+ *
+ * @example
+ * ```typescript
+ * import { DynamoTable, DynamoEntity, key, Delete } from 'dynamo-document-builder';
+ *
+ * const table = new DynamoTable({
+ *   tableName: 'ExampleTable',
+ *   documentClient,
+ * });
+ *
+ * const userEntity = new DynamoEntity({
+ *   table,
+ *   schema: z.object({
+ *     userId: z.string(),
+ *     name: z.string(),
+ *   }),
+ *   partitionKey: user => key('USER', user.userId),
+ *   sortKey: () => 'METADATA',
+ * });
+ *
+ * const deleteCommand = new Delete({
+ *   key: { userId: 'user123' },
+ *   returnValues: 'ALL_OLD',
+ * });
+ *
+ * const { deletedItem } = await userEntity.send(deleteCommand);
+ * ```
+ */
 declare class Delete<Schema extends ZodObject> implements BaseCommand<DeleteResult<Schema>, Schema>, WriteTransactable<Schema> {
     #private;
     constructor(config: DeleteConfig<Schema>);

package/dist/commands/delete.mjs

@@ -2,6 +2,38 @@ import { __classPrivateFieldSet, __awaiter, __classPrivateFieldGet } from '../no
 import { DeleteCommand } from '@aws-sdk/lib-dynamodb';
 
 var _Delete_config;
+/**
+ * Command to remove an item from a DynamoDB table.
+ *
+ * @template Schema - The Zod schema defining the structure of the entity.
+ *
+ * @example
+ * ```typescript
+ * import { DynamoTable, DynamoEntity, key, Delete } from 'dynamo-document-builder';
+ *
+ * const table = new DynamoTable({
+ *   tableName: 'ExampleTable',
+ *   documentClient,
+ * });
+ *
+ * const userEntity = new DynamoEntity({
+ *   table,
+ *   schema: z.object({
+ *     userId: z.string(),
+ *     name: z.string(),
+ *   }),
+ *   partitionKey: user => key('USER', user.userId),
+ *   sortKey: () => 'METADATA',
+ * });
+ *
+ * const deleteCommand = new Delete({
+ *   key: { userId: 'user123' },
+ *   returnValues: 'ALL_OLD',
+ * });
+ *
+ * const { deletedItem } = await userEntity.send(deleteCommand);
+ * ```
+ */
 class Delete {
     constructor(config) {
         _Delete_config.set(this, void 0);

package/dist/commands/delete.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"delete.mjs","sources":["../../src/commands/delete.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;MA2Ba,MAAM,CAAA;AAKjB,IAAA,WAAA,CAAY,MAA4B,EAAA;QAFxC,cAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;AAGE,QAAA,sBAAA,CAAA,IAAI,EAAA,cAAA,EAAW,MAAM,EAAA,GAAA,CAAA;IACvB;AAEa,IAAA,OAAO,CAAC,MAA4B,EAAA;;;AAC/C,YAAA,MAAM,SAAS,GAAG,IAAI,aAAa,CAAC;AAClC,gBAAA,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,SAAS;gBACjC,GAAG,EAAE,MAAM,CAAC,eAAe,CAAC,uBAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,GAAG,CAAC;AAC7C,gBAAA,YAAY,EAAE,sBAAA,CAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,YAAY;AACvC,gBAAA,sBAAsB,EAAE,sBAAA,CAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,sBAAsB;AAC3D,gBAAA,2BAA2B,EAAE,sBAAA,CAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,2BAA2B;AACtE,aAAA,CAAC;AAEF,YAAA,MAAM,YAAY,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,SAAS,EAAE;gBACrE,WAAW,EAAE,MAAA,sBAAA,CAAA,IAAI,sBAAQ,CAAC,eAAe,0CAAE,MAAM;AACjD,gBAAA,cAAc,EAAE,sBAAA,CAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,SAAS;AACvC,aAAA,CAAC;AAEF,YAAA,IAAI,WAAsD;AAC1D,YAAA,IAAI,YAAY,CAAC,UAAU,EAAE;AAC3B,gBAAA,IAAI,uBAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,cAAc,EAAE;AAC/B,oBAAA,WAAW,GAAG,YAAY,CAAC,UAA2C;gBACxE;qBAAO;AACL,oBAAA,WAAW,IAAI,MAAM,MAAM,CAAC;AACzB,yBAAA,OAAO;AACP,yBAAA,UAAU,CAAC,YAAY,CAAC,UAAU,CAAC,CAAkC;gBAC1E;YACF;YAEA,OAAO;gBACL,WAAW;gBACX,gBAAgB,EAAE,YAAY,CAAC,SAAS;gBACxC,gBAAgB,EAAE,YAAY,CAAC,gBAAgB;gBAC/C,qBAAqB,EAAE,YAAY,CAAC,qBAAqB;aAC1D;QACH,CAAC,CAAA;AAAA,IAAA;AAEY,IAAA,uBAAuB,CAClC,MAA4B,EAAA;;YAE5B,OAAO;AACL,gBAAA,MAAM,EAAE;AACN,oBAAA,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,SAAS;oBACjC,GAAG,EAAE,MAAM,CAAC,eAAe,CAAC,uBAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,GAAG,CAAC;AAC9C,iBAAA;aACF;QACH,CAAC,CAAA;AAAA,IAAA;AACF;;;;;"}
+{"version":3,"file":"delete.mjs","sources":["../../src/commands/delete.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;AAgCA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BG;MACU,MAAM,CAAA;AAKjB,IAAA,WAAA,CAAY,MAA4B,EAAA;QAFxC,cAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;AAGE,QAAA,sBAAA,CAAA,IAAI,EAAA,cAAA,EAAW,MAAM,EAAA,GAAA,CAAA;IACvB;AAEa,IAAA,OAAO,CAAC,MAA4B,EAAA;;;AAC/C,YAAA,MAAM,SAAS,GAAG,IAAI,aAAa,CAAC;AAClC,gBAAA,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,SAAS;gBACjC,GAAG,EAAE,MAAM,CAAC,eAAe,CAAC,uBAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,GAAG,CAAC;AAC7C,gBAAA,YAAY,EAAE,sBAAA,CAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,YAAY;AACvC,gBAAA,sBAAsB,EAAE,sBAAA,CAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,sBAAsB;AAC3D,gBAAA,2BAA2B,EAAE,sBAAA,CAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,2BAA2B;AACtE,aAAA,CAAC;AAEF,YAAA,MAAM,YAAY,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,SAAS,EAAE;gBACrE,WAAW,EAAE,MAAA,sBAAA,CAAA,IAAI,sBAAQ,CAAC,eAAe,0CAAE,MAAM;AACjD,gBAAA,cAAc,EAAE,sBAAA,CAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,SAAS;AACvC,aAAA,CAAC;AAEF,YAAA,IAAI,WAAsD;AAC1D,YAAA,IAAI,YAAY,CAAC,UAAU,EAAE;AAC3B,gBAAA,IAAI,uBAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,cAAc,EAAE;AAC/B,oBAAA,WAAW,GAAG,YAAY,CAAC,UAA2C;gBACxE;qBAAO;AACL,oBAAA,WAAW,IAAI,MAAM,MAAM,CAAC;AACzB,yBAAA,OAAO;AACP,yBAAA,UAAU,CAAC,YAAY,CAAC,UAAU,CAAC,CAAkC;gBAC1E;YACF;YAEA,OAAO;gBACL,WAAW;gBACX,gBAAgB,EAAE,YAAY,CAAC,SAAS;gBACxC,gBAAgB,EAAE,YAAY,CAAC,gBAAgB;gBAC/C,qBAAqB,EAAE,YAAY,CAAC,qBAAqB;aAC1D;QACH,CAAC,CAAA;AAAA,IAAA;AAEY,IAAA,uBAAuB,CAClC,MAA4B,EAAA;;YAE5B,OAAO;AACL,gBAAA,MAAM,EAAE;AACN,oBAAA,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,SAAS;oBACjC,GAAG,EAAE,MAAM,CAAC,eAAe,CAAC,uBAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,GAAG,CAAC;AAC9C,iBAAA;aACF;QACH,CAAC,CAAA;AAAA,IAAA;AACF;;;;;"}

package/dist/commands/get.cjs

@@ -4,6 +4,39 @@ var tslib_es6 = require('../node_modules/tslib/tslib.es6.cjs');
 var libDynamodb = require('@aws-sdk/lib-dynamodb');
 
 var _Get_config;
+/**
+ * Command to retrieve a single item by primary key from a DynamoDB table.
+ *
+ * @template Schema - The Zod schema defining the structure of the entity.
+ *
+ * @example
+ * ```typescript
+ * import { DynamoTable, DynamoEntity, key, Get } from 'dynamo-document-builder';
+ *
+ * const table = new DynamoTable({
+ *   tableName: 'ExampleTable',
+ *   documentClient,
+ * });
+ *
+ * const userEntity = new DynamoEntity({
+ *   table,
+ *   schema: z.object({
+ *     userId: z.string(),
+ *     name: z.string(),
+ *     email: z.string(),
+ *   }),
+ *   partitionKey: user => key('USER', user.userId),
+ *   sortKey: () => 'METADATA',
+ * });
+ *
+ * const getCommand = new Get({
+ *   key: { userId: 'user123' },
+ *   consistent: true,
+ * });
+ *
+ * const { item } = await userEntity.send(getCommand);
+ * ```
+ */
 class Get {
     constructor(config) {
         _Get_config.set(this, void 0);

package/dist/commands/get.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"get.cjs","sources":["../../src/commands/get.ts"],"sourcesContent":[null],"names":["__classPrivateFieldSet","GetCommand","__classPrivateFieldGet"],"mappings":";;;;;;MAea,GAAG,CAAA;AAGd,IAAA,WAAA,CAAY,MAAyB,EAAA;QAFrC,WAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;AAGE,QAAAA,gCAAA,CAAA,IAAI,EAAA,WAAA,EAAW,MAAM,EAAA,GAAA,CAAA;IACvB;AAEa,IAAA,OAAO,CAAC,MAA4B,EAAA;;;AAC/C,YAAA,MAAM,OAAO,GAAG,IAAIC,sBAAU,CAAC;AAC7B,gBAAA,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,SAAS;gBACjC,GAAG,EAAE,MAAM,CAAC,eAAe,CAACC,iCAAA,IAAI,EAAA,WAAA,EAAA,GAAA,CAAQ,CAAC,GAAG,CAAC;gBAC7C,cAAc,EAAE,MAAAA,gCAAA,CAAA,IAAI,mBAAQ,CAAC,UAAU,mCAAI,KAAK;AAChD,gBAAA,sBAAsB,EAAEA,gCAAA,CAAA,IAAI,EAAA,WAAA,EAAA,GAAA,CAAQ,CAAC,sBAAsB;AAC5D,aAAA,CAAC;AAEF,YAAA,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE;gBAChE,WAAW,EAAE,MAAAA,gCAAA,CAAA,IAAI,mBAAQ,CAAC,eAAe,0CAAE,MAAM;AACjD,gBAAA,cAAc,EAAEA,gCAAA,CAAA,IAAI,EAAA,WAAA,EAAA,GAAA,CAAQ,CAAC,SAAS;AACvC,aAAA,CAAC;AAEF,YAAA,IAAI,SAAS,CAAC,IAAI,EAAE;AAClB,gBAAA,MAAM,IAAI,GAAGA,gCAAA,CAAA,IAAI,EAAA,WAAA,EAAA,GAAA,CAAQ,CAAC;sBACrB,SAAS,CAAC;AACb,sBAAE,MAAM,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC;gBAElD,OAAO;oBACL,IAAI;oBACJ,gBAAgB,EAAE,SAAS,CAAC,SAAS;oBACrC,gBAAgB,EAAE,SAAS,CAAC,gBAAgB;iBAC7C;YACH;YAEA,OAAO;AACL,gBAAA,IAAI,EAAE,SAAS;gBACf,gBAAgB,EAAE,SAAS,CAAC,SAAS;gBACrC,gBAAgB,EAAE,SAAS,CAAC,gBAAgB;aAC7C;QACH,CAAC,CAAA;AAAA,IAAA;AACF;;;;;"}
+{"version":3,"file":"get.cjs","sources":["../../src/commands/get.ts"],"sourcesContent":[null],"names":["__classPrivateFieldSet","GetCommand","__classPrivateFieldGet"],"mappings":";;;;;;AAyBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgCG;MACU,GAAG,CAAA;AAGd,IAAA,WAAA,CAAY,MAAyB,EAAA;QAFrC,WAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;AAGE,QAAAA,gCAAA,CAAA,IAAI,EAAA,WAAA,EAAW,MAAM,EAAA,GAAA,CAAA;IACvB;AAEa,IAAA,OAAO,CAAC,MAA4B,EAAA;;;AAC/C,YAAA,MAAM,OAAO,GAAG,IAAIC,sBAAU,CAAC;AAC7B,gBAAA,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,SAAS;gBACjC,GAAG,EAAE,MAAM,CAAC,eAAe,CAACC,iCAAA,IAAI,EAAA,WAAA,EAAA,GAAA,CAAQ,CAAC,GAAG,CAAC;gBAC7C,cAAc,EAAE,MAAAA,gCAAA,CAAA,IAAI,mBAAQ,CAAC,UAAU,mCAAI,KAAK;AAChD,gBAAA,sBAAsB,EAAEA,gCAAA,CAAA,IAAI,EAAA,WAAA,EAAA,GAAA,CAAQ,CAAC,sBAAsB;AAC5D,aAAA,CAAC;AAEF,YAAA,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE;gBAChE,WAAW,EAAE,MAAAA,gCAAA,CAAA,IAAI,mBAAQ,CAAC,eAAe,0CAAE,MAAM;AACjD,gBAAA,cAAc,EAAEA,gCAAA,CAAA,IAAI,EAAA,WAAA,EAAA,GAAA,CAAQ,CAAC,SAAS;AACvC,aAAA,CAAC;AAEF,YAAA,IAAI,SAAS,CAAC,IAAI,EAAE;AAClB,gBAAA,MAAM,IAAI,GAAGA,gCAAA,CAAA,IAAI,EAAA,WAAA,EAAA,GAAA,CAAQ,CAAC;sBACrB,SAAS,CAAC;AACb,sBAAE,MAAM,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC;gBAElD,OAAO;oBACL,IAAI;oBACJ,gBAAgB,EAAE,SAAS,CAAC,SAAS;oBACrC,gBAAgB,EAAE,SAAS,CAAC,gBAAgB;iBAC7C;YACH;YAEA,OAAO;AACL,gBAAA,IAAI,EAAE,SAAS;gBACf,gBAAgB,EAAE,SAAS,CAAC,SAAS;gBACrC,gBAAgB,EAAE,SAAS,CAAC,gBAAgB;aAC7C;QACH,CAAC,CAAA;AAAA,IAAA;AACF;;;;;"}

package/dist/commands/get.d.ts

@@ -1,15 +1,58 @@
 import { DynamoEntity } from '../core/entity.js';
-import { BaseConfig, BaseResult, BaseCommand } from './base-command.js';
+import { BaseConfig, BaseResult, BaseCommand } from './index.js';
 import { ZodObject } from 'zod/v4';
-import { EntitySchema } from '../core/core-types.js';
+import { EntitySchema } from '../core/index.js';
 
+/**
+ * Configuration for the Get command.
+ *
+ * @template Schema - The Zod schema defining the structure of the entity.
+ */
 type GetConfig<Schema extends ZodObject> = BaseConfig & {
     key: Partial<EntitySchema<Schema>>;
     consistent?: boolean;
 };
+/**
+ * Result of the Get command.
+ *
+ * @template Schema - The Zod schema defining the structure of the entity.
+ */
 type GetResult<Schema extends ZodObject> = BaseResult & {
     item: EntitySchema<Schema> | undefined;
 };
+/**
+ * Command to retrieve a single item by primary key from a DynamoDB table.
+ *
+ * @template Schema - The Zod schema defining the structure of the entity.
+ *
+ * @example
+ * ```typescript
+ * import { DynamoTable, DynamoEntity, key, Get } from 'dynamo-document-builder';
+ *
+ * const table = new DynamoTable({
+ *   tableName: 'ExampleTable',
+ *   documentClient,
+ * });
+ *
+ * const userEntity = new DynamoEntity({
+ *   table,
+ *   schema: z.object({
+ *     userId: z.string(),
+ *     name: z.string(),
+ *     email: z.string(),
+ *   }),
+ *   partitionKey: user => key('USER', user.userId),
+ *   sortKey: () => 'METADATA',
+ * });
+ *
+ * const getCommand = new Get({
+ *   key: { userId: 'user123' },
+ *   consistent: true,
+ * });
+ *
+ * const { item } = await userEntity.send(getCommand);
+ * ```
+ */
 declare class Get<Schema extends ZodObject> implements BaseCommand<GetResult<Schema>, Schema> {
     #private;
     constructor(config: GetConfig<Schema>);

package/dist/commands/get.mjs

@@ -2,6 +2,39 @@ import { __classPrivateFieldSet, __awaiter, __classPrivateFieldGet } from '../no
 import { GetCommand } from '@aws-sdk/lib-dynamodb';
 
 var _Get_config;
+/**
+ * Command to retrieve a single item by primary key from a DynamoDB table.
+ *
+ * @template Schema - The Zod schema defining the structure of the entity.
+ *
+ * @example
+ * ```typescript
+ * import { DynamoTable, DynamoEntity, key, Get } from 'dynamo-document-builder';
+ *
+ * const table = new DynamoTable({
+ *   tableName: 'ExampleTable',
+ *   documentClient,
+ * });
+ *
+ * const userEntity = new DynamoEntity({
+ *   table,
+ *   schema: z.object({
+ *     userId: z.string(),
+ *     name: z.string(),
+ *     email: z.string(),
+ *   }),
+ *   partitionKey: user => key('USER', user.userId),
+ *   sortKey: () => 'METADATA',
+ * });
+ *
+ * const getCommand = new Get({
+ *   key: { userId: 'user123' },
+ *   consistent: true,
+ * });
+ *
+ * const { item } = await userEntity.send(getCommand);
+ * ```
+ */
 class Get {
     constructor(config) {
         _Get_config.set(this, void 0);

package/dist/commands/get.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"get.mjs","sources":["../../src/commands/get.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;MAea,GAAG,CAAA;AAGd,IAAA,WAAA,CAAY,MAAyB,EAAA;QAFrC,WAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;AAGE,QAAA,sBAAA,CAAA,IAAI,EAAA,WAAA,EAAW,MAAM,EAAA,GAAA,CAAA;IACvB;AAEa,IAAA,OAAO,CAAC,MAA4B,EAAA;;;AAC/C,YAAA,MAAM,OAAO,GAAG,IAAI,UAAU,CAAC;AAC7B,gBAAA,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,SAAS;gBACjC,GAAG,EAAE,MAAM,CAAC,eAAe,CAAC,uBAAA,IAAI,EAAA,WAAA,EAAA,GAAA,CAAQ,CAAC,GAAG,CAAC;gBAC7C,cAAc,EAAE,MAAA,sBAAA,CAAA,IAAI,mBAAQ,CAAC,UAAU,mCAAI,KAAK;AAChD,gBAAA,sBAAsB,EAAE,sBAAA,CAAA,IAAI,EAAA,WAAA,EAAA,GAAA,CAAQ,CAAC,sBAAsB;AAC5D,aAAA,CAAC;AAEF,YAAA,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE;gBAChE,WAAW,EAAE,MAAA,sBAAA,CAAA,IAAI,mBAAQ,CAAC,eAAe,0CAAE,MAAM;AACjD,gBAAA,cAAc,EAAE,sBAAA,CAAA,IAAI,EAAA,WAAA,EAAA,GAAA,CAAQ,CAAC,SAAS;AACvC,aAAA,CAAC;AAEF,YAAA,IAAI,SAAS,CAAC,IAAI,EAAE;AAClB,gBAAA,MAAM,IAAI,GAAG,sBAAA,CAAA,IAAI,EAAA,WAAA,EAAA,GAAA,CAAQ,CAAC;sBACrB,SAAS,CAAC;AACb,sBAAE,MAAM,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC;gBAElD,OAAO;oBACL,IAAI;oBACJ,gBAAgB,EAAE,SAAS,CAAC,SAAS;oBACrC,gBAAgB,EAAE,SAAS,CAAC,gBAAgB;iBAC7C;YACH;YAEA,OAAO;AACL,gBAAA,IAAI,EAAE,SAAS;gBACf,gBAAgB,EAAE,SAAS,CAAC,SAAS;gBACrC,gBAAgB,EAAE,SAAS,CAAC,gBAAgB;aAC7C;QACH,CAAC,CAAA;AAAA,IAAA;AACF;;;;;"}
+{"version":3,"file":"get.mjs","sources":["../../src/commands/get.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;AAyBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgCG;MACU,GAAG,CAAA;AAGd,IAAA,WAAA,CAAY,MAAyB,EAAA;QAFrC,WAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;AAGE,QAAA,sBAAA,CAAA,IAAI,EAAA,WAAA,EAAW,MAAM,EAAA,GAAA,CAAA;IACvB;AAEa,IAAA,OAAO,CAAC,MAA4B,EAAA;;;AAC/C,YAAA,MAAM,OAAO,GAAG,IAAI,UAAU,CAAC;AAC7B,gBAAA,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,SAAS;gBACjC,GAAG,EAAE,MAAM,CAAC,eAAe,CAAC,uBAAA,IAAI,EAAA,WAAA,EAAA,GAAA,CAAQ,CAAC,GAAG,CAAC;gBAC7C,cAAc,EAAE,MAAA,sBAAA,CAAA,IAAI,mBAAQ,CAAC,UAAU,mCAAI,KAAK;AAChD,gBAAA,sBAAsB,EAAE,sBAAA,CAAA,IAAI,EAAA,WAAA,EAAA,GAAA,CAAQ,CAAC,sBAAsB;AAC5D,aAAA,CAAC;AAEF,YAAA,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE;gBAChE,WAAW,EAAE,MAAA,sBAAA,CAAA,IAAI,mBAAQ,CAAC,eAAe,0CAAE,MAAM;AACjD,gBAAA,cAAc,EAAE,sBAAA,CAAA,IAAI,EAAA,WAAA,EAAA,GAAA,CAAQ,CAAC,SAAS;AACvC,aAAA,CAAC;AAEF,YAAA,IAAI,SAAS,CAAC,IAAI,EAAE;AAClB,gBAAA,MAAM,IAAI,GAAG,sBAAA,CAAA,IAAI,EAAA,WAAA,EAAA,GAAA,CAAQ,CAAC;sBACrB,SAAS,CAAC;AACb,sBAAE,MAAM,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC;gBAElD,OAAO;oBACL,IAAI;oBACJ,gBAAgB,EAAE,SAAS,CAAC,SAAS;oBACrC,gBAAgB,EAAE,SAAS,CAAC,gBAAgB;iBAC7C;YACH;YAEA,OAAO;AACL,gBAAA,IAAI,EAAE,SAAS;gBACf,gBAAgB,EAAE,SAAS,CAAC,SAAS;gBACrC,gBAAgB,EAAE,SAAS,CAAC,gBAAgB;aAC7C;QACH,CAAC,CAAA;AAAA,IAAA;AACF;;;;;"}

package/dist/commands/index.cjs

@@ -17,6 +17,10 @@ var commands_conditionalUpdate = require('./conditional-update.cjs');
 var commands_conditionalDelete = require('./conditional-delete.cjs');
 var commands_batchWrite = require('./batch-write.cjs');
 var commands_transactWrite = require('./transact-write.cjs');
+var commands_tableTransactWrite = require('./table-transact-write.cjs');
+var commands_tableBatchWrite = require('./table-batch-write.cjs');
+var commands_tableTransactGet = require('./table-transact-get.cjs');
+var commands_tableBatchGet = require('./table-batch-get.cjs');
 var commands_conditionCheck = require('./condition-check.cjs');
 
 
@@ -38,5 +42,9 @@ exports.ConditionalUpdate = commands_conditionalUpdate.ConditionalUpdate;
 exports.ConditionalDelete = commands_conditionalDelete.ConditionalDelete;
 exports.BatchWrite = commands_batchWrite.BatchWrite;
 exports.TransactWrite = commands_transactWrite.TransactWrite;
+exports.TableTransactWrite = commands_tableTransactWrite.TableTransactWrite;
+exports.TableBatchWrite = commands_tableBatchWrite.TableBatchWrite;
+exports.TableTransactGet = commands_tableTransactGet.TableTransactGet;
+exports.TableBatchGet = commands_tableBatchGet.TableBatchGet;
 exports.ConditionCheck = commands_conditionCheck.ConditionCheck;
 //# sourceMappingURL=index.cjs.map

package/dist/commands/index.cjs.map

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

package/dist/commands/index.d.ts

@@ -1,4 +1,10 @@
-export { BaseCommand, BaseConfig, BasePaginatable, BaseResult, WriteTransactable } from './base-command.js';
+import { TransactWriteOperation, EntitySchema } from '../core/index.js';
+import { DynamoEntity } from '../core/entity.js';
+import { DynamoTable } from '../core/table.js';
+import { DynamoKey } from '../core/key.js';
+import { ReturnConsumedCapacity, ConsumedCapacity } from '@aws-sdk/client-dynamodb';
+import { ResponseMetadata } from '@aws-sdk/types';
+import { ZodObject } from 'zod/v4';
 export { Get, GetConfig, GetResult } from './get.js';
 export { Query, QueryConfig, QueryResult } from './query.js';
 export { Scan, ScanConfig, ScanResult } from './scan.js';
@@ -16,4 +22,157 @@ export { ConditionalUpdate, ConditionalUpdateConfig, ConditionalUpdateResult } f
 export { ConditionalDelete, ConditionalDeleteConfig, ConditionalDeleteResult } from './conditional-delete.js';
 export { BatchWrite, BatchWriteConfig, BatchWriteResult } from './batch-write.js';
 export { TransactWrite, TransactWriteConfig, TransactWriteResult } from './transact-write.js';
+export { TableTransactWrite, TableTransactWriteConfig, TableTransactWriteResult } from './table-transact-write.js';
+export { TableBatchWrite, TableBatchWriteConfig, TableBatchWriteResult } from './table-batch-write.js';
+export { TableTransactGet, TableTransactGetConfig, TableTransactGetResult } from './table-transact-get.js';
+export { TableBatchGet, TableBatchGetConfig, TableBatchGetResult } from './table-batch-get.js';
 export { ConditionCheck, ConditionCheckConfig } from './condition-check.js';
+
+/**
+ * Interface for commands that can be prepared for use in a table-level batch write.
+ *
+ * @template Schema The Zod schema type associated with the DynamoEntity.
+ */
+type BatchWritePreparable<Schema extends ZodObject> = {
+    readonly items?: Array<EntitySchema<Schema>>;
+    readonly deletes?: Array<Partial<EntitySchema<Schema>>>;
+};
+/**
+ * Interface for commands that can be prepared for use in a table-level batch get.
+ *
+ * @template Schema The Zod schema type associated with the DynamoEntity.
+ */
+type BatchGetPreparable<Schema extends ZodObject> = {
+    readonly keys: Array<Partial<EntitySchema<Schema>>>;
+    readonly consistent?: boolean;
+};
+/**
+ * Interface-like type for command classes to extend from that defines the execute method.
+ *
+ * This is what enables the command-based pattern for DynamoDB operations that makes tree-shaking possible.
+ *
+ * @template Output The output type of the command's execute method.
+ * @template Schema The Zod schema type associated with the DynamoEntity.
+ */
+type BaseCommand<Output, Schema extends ZodObject> = {
+    execute(entity: DynamoEntity<Schema>): Promise<Output>;
+};
+/**
+ * Interface-like type for paginatable command classes to extend from that defines the executePaginated method.
+ *
+ * Commands should only implement this interface if they support pagination.
+ *
+ * @template Output The output type of the command's executePaginated method.
+ * @template Schema The Zod schema type associated with the DynamoEntity.
+ */
+type BasePaginatable<Output, Schema extends ZodObject> = {
+    executePaginated(entity: DynamoEntity<Schema>): AsyncGenerator<Output, void, unknown>;
+};
+/**
+ * Interface-like type for get commands that can be included in a table-level get transaction.
+ *
+ * @template Schema The Zod schema type associated with the DynamoEntity.
+ */
+type GetTransactable<Schema extends ZodObject> = {
+    readonly keys: Array<Partial<EntitySchema<Schema>>>;
+};
+/**
+ * Interface-like type for write commands that can be included in a write transaction.
+ *
+ * @template Schema The Zod schema type associated with the DynamoEntity.
+ */
+type WriteTransactable<Schema extends ZodObject> = {
+    prepareWriteTransaction(entity: DynamoEntity<Schema>): Promise<TransactWriteOperation>;
+};
+/**
+ * Interface-like type for table-level commands that execute directly against a DynamoTable.
+ *
+ * @template Output The output type of the command's execute method.
+ */
+type TableCommand<Output> = {
+    execute(table: DynamoTable): Promise<Output>;
+};
+/**
+ * Represents a set of write operations bound to a specific entity, ready to be included
+ * in a table-level TransactWrite command.
+ *
+ * @template Schema The Zod schema type associated with the DynamoEntity.
+ */
+type PreparedWriteTransaction<Schema extends ZodObject> = {
+    entity: DynamoEntity<Schema>;
+    writes: WriteTransactable<Schema>[];
+};
+/**
+ * Represents a TransactGet command bound to a specific entity, ready to be included
+ * in a table-level TransactGet command.
+ *
+ * @template Schema The Zod schema type associated with the DynamoEntity.
+ */
+type PreparedGetTransaction<Schema extends ZodObject> = {
+    entity: DynamoEntity<Schema>;
+    keys: Array<{
+        TableName: string;
+        Key: DynamoKey;
+    }>;
+    parseResults(items: unknown[], skipValidation: boolean): Promise<Array<EntitySchema<Schema> | undefined>>;
+};
+/**
+ * Represents a BatchWrite command bound to a specific entity, ready to be included
+ * in a table-level TableBatchWrite command.
+ *
+ * @template Schema The Zod schema type associated with the DynamoEntity.
+ */
+type PreparedBatchWrite<Schema extends ZodObject> = {
+    entity: DynamoEntity<Schema>;
+    buildRequests(skipValidation: boolean, abortSignal?: AbortSignal): Promise<Array<{
+        PutRequest: {
+            Item: Record<string, unknown>;
+        };
+    } | {
+        DeleteRequest: {
+            Key: DynamoKey;
+        };
+    }>>;
+    matchUnprocessedPut(item: Record<string, unknown>): EntitySchema<Schema> | undefined;
+    matchUnprocessedDelete(key: DynamoKey): Partial<EntitySchema<Schema>> | undefined;
+};
+/**
+ * Represents a BatchGet command bound to a specific entity, ready to be included
+ * in a table-level TableBatchGet command.
+ *
+ * @template Schema The Zod schema type associated with the DynamoEntity.
+ */
+type PreparedBatchGet<Schema extends ZodObject> = {
+    entity: DynamoEntity<Schema>;
+    keys: Array<DynamoKey>;
+    consistent: boolean;
+    matchItem(item: Record<string, unknown>): boolean;
+    parseResults(items: unknown[], skipValidation: boolean): Promise<Array<EntitySchema<Schema>>>;
+    matchUnprocessedKey(key: DynamoKey): Partial<EntitySchema<Schema>> | undefined;
+};
+/**
+ * Base configuration options for DynamoDB commands.
+ *
+ * @property skipValidation - If true, skips schema validation of the returned item(s).
+ * @property returnConsumedCapacity - Specifies the level of detail about provisioned throughput consumption that is returned in the response.
+ * @property abortController - An AbortController to allow cancellation of the operation.
+ * @property timeoutMs - The maximum time in milliseconds to wait for the operation to complete.
+ */
+type BaseConfig = {
+    skipValidation?: boolean;
+    returnConsumedCapacity?: ReturnConsumedCapacity;
+    abortController?: AbortController;
+    timeoutMs?: number;
+};
+/**
+ * Base result type for DynamoDB commands.
+ *
+ * @property responseMetadata - Metadata about the response from DynamoDB.
+ * @property consumedCapacity - Information about the capacity units consumed by the operation.
+ */
+type BaseResult = {
+    responseMetadata?: ResponseMetadata;
+    consumedCapacity?: ConsumedCapacity | undefined;
+};
+
+export type { BaseCommand, BaseConfig, BasePaginatable, BaseResult, BatchGetPreparable, BatchWritePreparable, GetTransactable, PreparedBatchGet, PreparedBatchWrite, PreparedGetTransaction, PreparedWriteTransaction, TableCommand, WriteTransactable };

package/dist/commands/index.mjs

@@ -15,5 +15,9 @@ export { ConditionalUpdate } from './conditional-update.mjs';
 export { ConditionalDelete } from './conditional-delete.mjs';
 export { BatchWrite } from './batch-write.mjs';
 export { TransactWrite } from './transact-write.mjs';
+export { TableTransactWrite } from './table-transact-write.mjs';
+export { TableBatchWrite } from './table-batch-write.mjs';
+export { TableTransactGet } from './table-transact-get.mjs';
+export { TableBatchGet } from './table-batch-get.mjs';
 export { ConditionCheck } from './condition-check.mjs';
 //# sourceMappingURL=index.mjs.map

package/dist/commands/index.mjs.map

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