dynamo-document-builder 0.6.0 → 0.7.0

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

@@ -1,17 +1,63 @@
 import { DynamoEntity } from '../core/entity.js';
-import { BaseConfig, BaseResult, BaseCommand } from './base-command.js';
+import { BaseConfig, BaseResult, BaseCommand, GetTransactable } from './index.js';
 import { ZodObject } from 'zod/v4';
-import { EntitySchema } from '../core/core-types.js';
+import { EntitySchema } from '../core/index.js';
 
+/**
+ * Configuration for the TransactGet command.
+ *
+ * @template Schema - The Zod schema defining the structure of the entity.
+ */
 type TransactGetConfig<Schema extends ZodObject> = BaseConfig & {
     keys: Array<Partial<EntitySchema<Schema>>>;
 };
+/**
+ * Result of the TransactGet command.
+ *
+ * @template Schema - The Zod schema defining the structure of the entity.
+ */
 type TransactGetResult<Schema extends ZodObject> = BaseResult & {
     items: Array<EntitySchema<Schema> | undefined>;
 };
-declare class TransactGet<Schema extends ZodObject> implements BaseCommand<TransactGetResult<Schema>, Schema> {
+/**
+ * Command to perform a transactional read of multiple items (all-or-nothing, strongly consistent).
+ *
+ * @template Schema - The Zod schema defining the structure of the entity.
+ *
+ * @example
+ * ```typescript
+ * import { DynamoTable, DynamoEntity, key, TransactGet } 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 transactGetCommand = new TransactGet({
+ *   keys: [
+ *     { userId: 'user1' },
+ *     { userId: 'user2' },
+ *   ],
+ * });
+ *
+ * const { items } = await userEntity.send(transactGetCommand);
+ * // items array has same order as keys, undefined if not found
+ * ```
+ */
+declare class TransactGet<Schema extends ZodObject> implements BaseCommand<TransactGetResult<Schema>, Schema>, GetTransactable<Schema> {
     #private;
     constructor(config: TransactGetConfig<Schema>);
+    get keys(): Array<Partial<EntitySchema<Schema>>>;
     execute(entity: DynamoEntity<Schema>): Promise<TransactGetResult<Schema>>;
 }
 

package/dist/commands/transact-get.mjs

@@ -1,14 +1,52 @@
-import { __classPrivateFieldSet, __awaiter, __classPrivateFieldGet } from '../node_modules/tslib/tslib.es6.mjs';
+import { __classPrivateFieldSet, __classPrivateFieldGet, __awaiter } from '../node_modules/tslib/tslib.es6.mjs';
 import { TransactGetCommand } from '@aws-sdk/lib-dynamodb';
 import { TRANSACTION_GET_VALIDATION_CONCURRENCY } from '../internal-constants.mjs';
 import pMap from 'p-map';
 
 var _TransactGet_config;
+/**
+ * Command to perform a transactional read of multiple items (all-or-nothing, strongly consistent).
+ *
+ * @template Schema - The Zod schema defining the structure of the entity.
+ *
+ * @example
+ * ```typescript
+ * import { DynamoTable, DynamoEntity, key, TransactGet } 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 transactGetCommand = new TransactGet({
+ *   keys: [
+ *     { userId: 'user1' },
+ *     { userId: 'user2' },
+ *   ],
+ * });
+ *
+ * const { items } = await userEntity.send(transactGetCommand);
+ * // items array has same order as keys, undefined if not found
+ * ```
+ */
 class TransactGet {
     constructor(config) {
         _TransactGet_config.set(this, void 0);
         __classPrivateFieldSet(this, _TransactGet_config, config, "f");
     }
+    get keys() {
+        return __classPrivateFieldGet(this, _TransactGet_config, "f").keys;
+    }
     execute(entity) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d;

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

@@ -1 +1 @@
-{"version":3,"file":"transact-get.mjs","sources":["../../src/commands/transact-get.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;MAgBa,WAAW,CAAA;AAKtB,IAAA,WAAA,CAAY,MAAiC,EAAA;QAF7C,mBAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;AAGE,QAAA,sBAAA,CAAA,IAAI,EAAA,mBAAA,EAAW,MAAM,EAAA,GAAA,CAAA;IACvB;AAEa,IAAA,OAAO,CAAC,MAA4B,EAAA;;;AAC/C,YAAA,MAAM,aAAa,GAAG,sBAAA,CAAA,IAAI,2BAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK;AAClD,gBAAA,GAAG,EAAE;AACH,oBAAA,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,SAAS;AACjC,oBAAA,GAAG,EAAE,MAAM,CAAC,eAAe,CAAC,GAAG,CAAC;AACjC,iBAAA;AACF,aAAA,CAAC,CAAC;AAEH,YAAA,MAAM,WAAW,GAAG,IAAI,kBAAkB,CAAC;AACzC,gBAAA,aAAa,EAAE,aAAa;AAC5B,gBAAA,sBAAsB,EAAE,sBAAA,CAAA,IAAI,EAAA,mBAAA,EAAA,GAAA,CAAQ,CAAC,sBAAsB;AAC5D,aAAA,CAAC;AAEF,YAAA,MAAM,iBAAiB,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,EAAE;gBAC5E,WAAW,EAAE,MAAA,sBAAA,CAAA,IAAI,2BAAQ,CAAC,eAAe,0CAAE,MAAM;AACjD,gBAAA,cAAc,EAAE,sBAAA,CAAA,IAAI,EAAA,mBAAA,EAAA,GAAA,CAAQ,CAAC,SAAS;AACvC,aAAA,CAAC;YAEF,MAAM,QAAQ,GAAG,CAAA,EAAA,GAAA,iBAAiB,CAAC,SAAS,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,EAAA,GAAI,EAAE;YAClD,IAAI,KAAK,GAA4C,EAAE;AACvD,YAAA,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;AACvB,gBAAA,IAAI,uBAAA,IAAI,EAAA,mBAAA,EAAA,GAAA,CAAQ,CAAC,cAAc,EAAE;AAC/B,oBAAA,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,QAAQ,IAAI,QAAQ,CAAC,IAAwC,CAAC;gBACrF;qBAAO;oBACL,KAAK,GAAG,MAAM,IAAI,CAChB,QAAQ,EACR,CAAM,QAAQ,KAAG,SAAA,CAAA,IAAA,EAAA,MAAA,EAAA,MAAA,EAAA,aAAA;AACf,wBAAA,IAAI,QAAQ,CAAC,IAAI,EAAE;4BACjB,OAAO,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC;wBAChD;AACA,wBAAA,OAAO,SAAS;AAClB,oBAAA,CAAC,CAAA,EACD;AACE,wBAAA,WAAW,EAAE,sCAAsC;wBACnD,MAAM,EAAE,MAAA,sBAAA,CAAA,IAAI,2BAAQ,CAAC,eAAe,0CAAE,MAAM;AAC7C,qBAAA,CACF;gBACH;YACF;YAEA,OAAO;gBACL,KAAK;gBACL,gBAAgB,EAAE,iBAAiB,CAAC,SAAS;AAC7C,gBAAA,gBAAgB,EAAE,CAAA,EAAA,GAAA,iBAAiB,CAAC,gBAAgB,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,MAAA,GAAA,EAAA,CAAG,CAAC,CAAC;aAC1D;QACH,CAAC,CAAA;AAAA,IAAA;AACF;;;;;"}
+{"version":3,"file":"transact-get.mjs","sources":["../../src/commands/transact-get.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;AA0BA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkCG;MACU,WAAW,CAAA;AAKtB,IAAA,WAAA,CAAY,MAAiC,EAAA;QAF7C,mBAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;AAGE,QAAA,sBAAA,CAAA,IAAI,EAAA,mBAAA,EAAW,MAAM,EAAA,GAAA,CAAA;IACvB;AAEA,IAAA,IAAW,IAAI,GAAA;AACb,QAAA,OAAO,sBAAA,CAAA,IAAI,EAAA,mBAAA,EAAA,GAAA,CAAQ,CAAC,IAAI;IAC1B;AAEa,IAAA,OAAO,CAAC,MAA4B,EAAA;;;AAC/C,YAAA,MAAM,aAAa,GAAG,sBAAA,CAAA,IAAI,2BAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK;AAClD,gBAAA,GAAG,EAAE;AACH,oBAAA,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,SAAS;AACjC,oBAAA,GAAG,EAAE,MAAM,CAAC,eAAe,CAAC,GAAG,CAAC;AACjC,iBAAA;AACF,aAAA,CAAC,CAAC;AAEH,YAAA,MAAM,WAAW,GAAG,IAAI,kBAAkB,CAAC;AACzC,gBAAA,aAAa,EAAE,aAAa;AAC5B,gBAAA,sBAAsB,EAAE,sBAAA,CAAA,IAAI,EAAA,mBAAA,EAAA,GAAA,CAAQ,CAAC,sBAAsB;AAC5D,aAAA,CAAC;AAEF,YAAA,MAAM,iBAAiB,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,EAAE;gBAC5E,WAAW,EAAE,MAAA,sBAAA,CAAA,IAAI,2BAAQ,CAAC,eAAe,0CAAE,MAAM;AACjD,gBAAA,cAAc,EAAE,sBAAA,CAAA,IAAI,EAAA,mBAAA,EAAA,GAAA,CAAQ,CAAC,SAAS;AACvC,aAAA,CAAC;YAEF,MAAM,QAAQ,GAAG,CAAA,EAAA,GAAA,iBAAiB,CAAC,SAAS,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,EAAA,GAAI,EAAE;YAClD,IAAI,KAAK,GAA4C,EAAE;AACvD,YAAA,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;AACvB,gBAAA,IAAI,uBAAA,IAAI,EAAA,mBAAA,EAAA,GAAA,CAAQ,CAAC,cAAc,EAAE;AAC/B,oBAAA,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,QAAQ,IAAI,QAAQ,CAAC,IAAwC,CAAC;gBACrF;qBAAO;oBACL,KAAK,GAAG,MAAM,IAAI,CAChB,QAAQ,EACR,CAAM,QAAQ,KAAG,SAAA,CAAA,IAAA,EAAA,MAAA,EAAA,MAAA,EAAA,aAAA;AACf,wBAAA,IAAI,QAAQ,CAAC,IAAI,EAAE;4BACjB,OAAO,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC;wBAChD;AACA,wBAAA,OAAO,SAAS;AAClB,oBAAA,CAAC,CAAA,EACD;AACE,wBAAA,WAAW,EAAE,sCAAsC;wBACnD,MAAM,EAAE,MAAA,sBAAA,CAAA,IAAI,2BAAQ,CAAC,eAAe,0CAAE,MAAM;AAC7C,qBAAA,CACF;gBACH;YACF;YAEA,OAAO;gBACL,KAAK;gBACL,gBAAgB,EAAE,iBAAiB,CAAC,SAAS;AAC7C,gBAAA,gBAAgB,EAAE,CAAA,EAAA,GAAA,iBAAiB,CAAC,gBAAgB,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,MAAA,GAAA,EAAA,CAAG,CAAC,CAAC;aAC1D;QACH,CAAC,CAAA;AAAA,IAAA;AACF;;;;;"}

package/dist/commands/transact-write.cjs

@@ -6,6 +6,43 @@ var libDynamodb = require('@aws-sdk/lib-dynamodb');
 var pMap = require('p-map');
 
 var _TransactWrite_config;
+/**
+ * Command to perform an atomic multi-item write transaction (all-or-nothing).
+ *
+ * @template Schema - The Zod schema defining the structure of the entity.
+ *
+ * @example
+ * ```typescript
+ * import { DynamoTable, DynamoEntity, key, TransactWrite, Put, Update, 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(),
+ *     balance: z.number(),
+ *   }),
+ *   partitionKey: user => key('USER', user.userId),
+ *   sortKey: () => 'METADATA',
+ * });
+ *
+ * const transactWriteCommand = new TransactWrite({
+ *   writes: [
+ *     new Put({ item: { userId: 'user1', name: 'John', balance: 100 } }),
+ *     new Update({ key: { userId: 'user2' }, update: { balance: add(50) } }),
+ *     new Delete({ key: { userId: 'user3' } }),
+ *   ],
+ *   idempotencyToken: 'unique-token',
+ * });
+ *
+ * await userEntity.send(transactWriteCommand);
+ * ```
+ */
 class TransactWrite {
     constructor(config) {
         _TransactWrite_config.set(this, void 0);

package/dist/commands/transact-write.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"transact-write.cjs","sources":["../../src/commands/transact-write.ts"],"sourcesContent":[null],"names":["__classPrivateFieldSet","__classPrivateFieldGet","TRANSACTION_WRITE_VALIDATION_CONCURRENCY","TransactWriteCommand"],"mappings":";;;;;;;;MAyBa,aAAa,CAAA;AAKxB,IAAA,WAAA,CAAY,MAAmC,EAAA;QAF/C,qBAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;AAGE,QAAAA,gCAAA,CAAA,IAAI,EAAA,qBAAA,EAAW,MAAM,EAAA,GAAA,CAAA;IACvB;AAEa,IAAA,OAAO,CAAC,MAA4B,EAAA;;;YAC/C,MAAM,aAAa,GAAG,MAAM,IAAI,CAC9BC,gCAAA,CAAA,IAAI,6BAAQ,CAAC,MAAM,EACnB,KAAK,IAAI,KAAK,CAAC,uBAAuB,CAAC,MAAM,CAAC,EAC9C;AACE,gBAAA,WAAW,EAAEC,0DAAwC;gBACrD,MAAM,EAAE,MAAAD,gCAAA,CAAA,IAAI,6BAAQ,CAAC,eAAe,0CAAE,MAAM;AAC7C,aAAA,CACF;AACD,YAAA,MAAM,gBAAgB,GAAG,IAAIE,gCAAoB,CAAC;AAChD,gBAAA,aAAa,EAAE,aAAa;AAC5B,gBAAA,sBAAsB,EAAEF,gCAAA,CAAA,IAAI,EAAA,qBAAA,EAAA,GAAA,CAAQ,CAAC,sBAAsB;AAC3D,gBAAA,2BAA2B,EAAEA,gCAAA,CAAA,IAAI,EAAA,qBAAA,EAAA,GAAA,CAAQ,CAAC,2BAA2B;AACrE,gBAAA,kBAAkB,EAAEA,gCAAA,CAAA,IAAI,EAAA,qBAAA,EAAA,GAAA,CAAQ,CAAC,gBAAgB;AAClD,aAAA,CAAC;AACF,YAAA,MAAM,sBAAsB,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,gBAAgB,EAAE;gBACtF,WAAW,EAAE,MAAAA,gCAAA,CAAA,IAAI,6BAAQ,CAAC,eAAe,0CAAE,MAAM;AACjD,gBAAA,cAAc,EAAEA,gCAAA,CAAA,IAAI,EAAA,qBAAA,EAAA,GAAA,CAAQ,CAAC,SAAS;AACvC,aAAA,CAAC;YACF,OAAO;gBACL,gBAAgB,EAAE,sBAAsB,CAAC,SAAS;gBAClD,gBAAgB,EAAE,sBAAsB,CAAC,gBAAgB;gBACzD,qBAAqB,EAAE,sBAAsB,CAAC,qBAAqB;aACpE;QACH,CAAC,CAAA;AAAA,IAAA;AACF;;;;;"}
+{"version":3,"file":"transact-write.cjs","sources":["../../src/commands/transact-write.ts"],"sourcesContent":[null],"names":["__classPrivateFieldSet","__classPrivateFieldGet","TRANSACTION_WRITE_VALIDATION_CONCURRENCY","TransactWriteCommand"],"mappings":";;;;;;;;AAiCA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoCG;MACU,aAAa,CAAA;AAKxB,IAAA,WAAA,CAAY,MAAmC,EAAA;QAF/C,qBAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;AAGE,QAAAA,gCAAA,CAAA,IAAI,EAAA,qBAAA,EAAW,MAAM,EAAA,GAAA,CAAA;IACvB;AAEa,IAAA,OAAO,CAAC,MAA4B,EAAA;;;YAC/C,MAAM,aAAa,GAAG,MAAM,IAAI,CAC9BC,gCAAA,CAAA,IAAI,6BAAQ,CAAC,MAAM,EACnB,KAAK,IAAI,KAAK,CAAC,uBAAuB,CAAC,MAAM,CAAC,EAC9C;AACE,gBAAA,WAAW,EAAEC,0DAAwC;gBACrD,MAAM,EAAE,MAAAD,gCAAA,CAAA,IAAI,6BAAQ,CAAC,eAAe,0CAAE,MAAM;AAC7C,aAAA,CACF;AACD,YAAA,MAAM,gBAAgB,GAAG,IAAIE,gCAAoB,CAAC;AAChD,gBAAA,aAAa,EAAE,aAAa;AAC5B,gBAAA,sBAAsB,EAAEF,gCAAA,CAAA,IAAI,EAAA,qBAAA,EAAA,GAAA,CAAQ,CAAC,sBAAsB;AAC3D,gBAAA,2BAA2B,EAAEA,gCAAA,CAAA,IAAI,EAAA,qBAAA,EAAA,GAAA,CAAQ,CAAC,2BAA2B;AACrE,gBAAA,kBAAkB,EAAEA,gCAAA,CAAA,IAAI,EAAA,qBAAA,EAAA,GAAA,CAAQ,CAAC,gBAAgB;AAClD,aAAA,CAAC;AACF,YAAA,MAAM,sBAAsB,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,gBAAgB,EAAE;gBACtF,WAAW,EAAE,MAAAA,gCAAA,CAAA,IAAI,6BAAQ,CAAC,eAAe,0CAAE,MAAM;AACjD,gBAAA,cAAc,EAAEA,gCAAA,CAAA,IAAI,EAAA,qBAAA,EAAA,GAAA,CAAQ,CAAC,SAAS;AACvC,aAAA,CAAC;YACF,OAAO;gBACL,gBAAgB,EAAE,sBAAsB,CAAC,SAAS;gBAClD,gBAAgB,EAAE,sBAAsB,CAAC,gBAAgB;gBACzD,qBAAqB,EAAE,sBAAsB,CAAC,qBAAqB;aACpE;QACH,CAAC,CAAA;AAAA,IAAA;AACF;;;;;"}

package/dist/commands/transact-write.d.ts

@@ -1,19 +1,64 @@
-import { BaseConfig, WriteTransactable, BaseCommand } from './base-command.js';
+import { BaseConfig, WriteTransactable, BaseCommand } from './index.js';
 import { ReturnItemCollectionMetrics, ConsumedCapacity, ItemCollectionMetrics } from '@aws-sdk/client-dynamodb';
 import { DynamoEntity } from '../core/entity.js';
 import { ResponseMetadata } from '@aws-sdk/types';
 import { ZodObject } from 'zod/v4';
 
+/**
+ * Configuration for the TransactWrite command.
+ *
+ * @template Schema - The Zod schema defining the structure of the entity.
+ */
 type TransactWriteConfig<Schema extends ZodObject> = BaseConfig & {
     writes: WriteTransactable<Schema>[];
     idempotencyToken?: string;
     returnItemCollectionMetrics?: ReturnItemCollectionMetrics;
 };
+/**
+ * Result of the TransactWrite command.
+ */
 type TransactWriteResult = {
     responseMetadata?: ResponseMetadata;
     consumedCapacity?: ConsumedCapacity[] | undefined;
     itemCollectionMetrics?: ItemCollectionMetrics;
 };
+/**
+ * Command to perform an atomic multi-item write transaction (all-or-nothing).
+ *
+ * @template Schema - The Zod schema defining the structure of the entity.
+ *
+ * @example
+ * ```typescript
+ * import { DynamoTable, DynamoEntity, key, TransactWrite, Put, Update, 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(),
+ *     balance: z.number(),
+ *   }),
+ *   partitionKey: user => key('USER', user.userId),
+ *   sortKey: () => 'METADATA',
+ * });
+ *
+ * const transactWriteCommand = new TransactWrite({
+ *   writes: [
+ *     new Put({ item: { userId: 'user1', name: 'John', balance: 100 } }),
+ *     new Update({ key: { userId: 'user2' }, update: { balance: add(50) } }),
+ *     new Delete({ key: { userId: 'user3' } }),
+ *   ],
+ *   idempotencyToken: 'unique-token',
+ * });
+ *
+ * await userEntity.send(transactWriteCommand);
+ * ```
+ */
 declare class TransactWrite<Schema extends ZodObject> implements BaseCommand<TransactWriteResult, Schema> {
     #private;
     constructor(config: TransactWriteConfig<Schema>);

package/dist/commands/transact-write.mjs

@@ -4,6 +4,43 @@ import { TransactWriteCommand } from '@aws-sdk/lib-dynamodb';
 import pMap from 'p-map';
 
 var _TransactWrite_config;
+/**
+ * Command to perform an atomic multi-item write transaction (all-or-nothing).
+ *
+ * @template Schema - The Zod schema defining the structure of the entity.
+ *
+ * @example
+ * ```typescript
+ * import { DynamoTable, DynamoEntity, key, TransactWrite, Put, Update, 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(),
+ *     balance: z.number(),
+ *   }),
+ *   partitionKey: user => key('USER', user.userId),
+ *   sortKey: () => 'METADATA',
+ * });
+ *
+ * const transactWriteCommand = new TransactWrite({
+ *   writes: [
+ *     new Put({ item: { userId: 'user1', name: 'John', balance: 100 } }),
+ *     new Update({ key: { userId: 'user2' }, update: { balance: add(50) } }),
+ *     new Delete({ key: { userId: 'user3' } }),
+ *   ],
+ *   idempotencyToken: 'unique-token',
+ * });
+ *
+ * await userEntity.send(transactWriteCommand);
+ * ```
+ */
 class TransactWrite {
     constructor(config) {
         _TransactWrite_config.set(this, void 0);

package/dist/commands/transact-write.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"transact-write.mjs","sources":["../../src/commands/transact-write.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;MAyBa,aAAa,CAAA;AAKxB,IAAA,WAAA,CAAY,MAAmC,EAAA;QAF/C,qBAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;AAGE,QAAA,sBAAA,CAAA,IAAI,EAAA,qBAAA,EAAW,MAAM,EAAA,GAAA,CAAA;IACvB;AAEa,IAAA,OAAO,CAAC,MAA4B,EAAA;;;YAC/C,MAAM,aAAa,GAAG,MAAM,IAAI,CAC9B,sBAAA,CAAA,IAAI,6BAAQ,CAAC,MAAM,EACnB,KAAK,IAAI,KAAK,CAAC,uBAAuB,CAAC,MAAM,CAAC,EAC9C;AACE,gBAAA,WAAW,EAAE,wCAAwC;gBACrD,MAAM,EAAE,MAAA,sBAAA,CAAA,IAAI,6BAAQ,CAAC,eAAe,0CAAE,MAAM;AAC7C,aAAA,CACF;AACD,YAAA,MAAM,gBAAgB,GAAG,IAAI,oBAAoB,CAAC;AAChD,gBAAA,aAAa,EAAE,aAAa;AAC5B,gBAAA,sBAAsB,EAAE,sBAAA,CAAA,IAAI,EAAA,qBAAA,EAAA,GAAA,CAAQ,CAAC,sBAAsB;AAC3D,gBAAA,2BAA2B,EAAE,sBAAA,CAAA,IAAI,EAAA,qBAAA,EAAA,GAAA,CAAQ,CAAC,2BAA2B;AACrE,gBAAA,kBAAkB,EAAE,sBAAA,CAAA,IAAI,EAAA,qBAAA,EAAA,GAAA,CAAQ,CAAC,gBAAgB;AAClD,aAAA,CAAC;AACF,YAAA,MAAM,sBAAsB,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,gBAAgB,EAAE;gBACtF,WAAW,EAAE,MAAA,sBAAA,CAAA,IAAI,6BAAQ,CAAC,eAAe,0CAAE,MAAM;AACjD,gBAAA,cAAc,EAAE,sBAAA,CAAA,IAAI,EAAA,qBAAA,EAAA,GAAA,CAAQ,CAAC,SAAS;AACvC,aAAA,CAAC;YACF,OAAO;gBACL,gBAAgB,EAAE,sBAAsB,CAAC,SAAS;gBAClD,gBAAgB,EAAE,sBAAsB,CAAC,gBAAgB;gBACzD,qBAAqB,EAAE,sBAAsB,CAAC,qBAAqB;aACpE;QACH,CAAC,CAAA;AAAA,IAAA;AACF;;;;;"}
+{"version":3,"file":"transact-write.mjs","sources":["../../src/commands/transact-write.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;;AAiCA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoCG;MACU,aAAa,CAAA;AAKxB,IAAA,WAAA,CAAY,MAAmC,EAAA;QAF/C,qBAAA,CAAA,GAAA,CAAA,IAAA,EAAA,MAAA,CAAA;AAGE,QAAA,sBAAA,CAAA,IAAI,EAAA,qBAAA,EAAW,MAAM,EAAA,GAAA,CAAA;IACvB;AAEa,IAAA,OAAO,CAAC,MAA4B,EAAA;;;YAC/C,MAAM,aAAa,GAAG,MAAM,IAAI,CAC9B,sBAAA,CAAA,IAAI,6BAAQ,CAAC,MAAM,EACnB,KAAK,IAAI,KAAK,CAAC,uBAAuB,CAAC,MAAM,CAAC,EAC9C;AACE,gBAAA,WAAW,EAAE,wCAAwC;gBACrD,MAAM,EAAE,MAAA,sBAAA,CAAA,IAAI,6BAAQ,CAAC,eAAe,0CAAE,MAAM;AAC7C,aAAA,CACF;AACD,YAAA,MAAM,gBAAgB,GAAG,IAAI,oBAAoB,CAAC;AAChD,gBAAA,aAAa,EAAE,aAAa;AAC5B,gBAAA,sBAAsB,EAAE,sBAAA,CAAA,IAAI,EAAA,qBAAA,EAAA,GAAA,CAAQ,CAAC,sBAAsB;AAC3D,gBAAA,2BAA2B,EAAE,sBAAA,CAAA,IAAI,EAAA,qBAAA,EAAA,GAAA,CAAQ,CAAC,2BAA2B;AACrE,gBAAA,kBAAkB,EAAE,sBAAA,CAAA,IAAI,EAAA,qBAAA,EAAA,GAAA,CAAQ,CAAC,gBAAgB;AAClD,aAAA,CAAC;AACF,YAAA,MAAM,sBAAsB,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,gBAAgB,EAAE;gBACtF,WAAW,EAAE,MAAA,sBAAA,CAAA,IAAI,6BAAQ,CAAC,eAAe,0CAAE,MAAM;AACjD,gBAAA,cAAc,EAAE,sBAAA,CAAA,IAAI,EAAA,qBAAA,EAAA,GAAA,CAAQ,CAAC,SAAS;AACvC,aAAA,CAAC;YACF,OAAO;gBACL,gBAAgB,EAAE,sBAAsB,CAAC,SAAS;gBAClD,gBAAgB,EAAE,sBAAsB,CAAC,gBAAgB;gBACzD,qBAAqB,EAAE,sBAAsB,CAAC,qBAAqB;aACpE;QACH,CAAC,CAAA;AAAA,IAAA;AACF;;;;;"}

package/dist/commands/update.cjs

@@ -5,6 +5,43 @@ var libDynamodb = require('@aws-sdk/lib-dynamodb');
 var updates_updateParser = require('../updates/update-parser.cjs');
 
 var _Update_config;
+/**
+ * Command to modify existing item attributes in a DynamoDB table.
+ *
+ * @template Schema - The Zod schema defining the structure of the entity.
+ *
+ * @example
+ * ```typescript
+ * import { DynamoTable, DynamoEntity, key, Update, add } 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(),
+ *     loginCount: z.number(),
+ *   }),
+ *   partitionKey: user => key('USER', user.userId),
+ *   sortKey: () => 'METADATA',
+ * });
+ *
+ * const updateCommand = new Update({
+ *   key: { userId: 'user123' },
+ *   update: {
+ *     name: 'Jane Doe',
+ *     loginCount: add(1),
+ *   },
+ *   returnValues: 'ALL_NEW',
+ * });
+ *
+ * const { updatedItem } = await userEntity.send(updateCommand);
+ * ```
+ */
 class Update {
     constructor(config) {
         _Update_config.set(this, void 0);

package/dist/commands/update.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"update.cjs","sources":["../../src/commands/update.ts"],"sourcesContent":[null],"names":["__classPrivateFieldSet","parseUpdate","__classPrivateFieldGet","UpdateCommand"],"mappings":";;;;;;;MA8Ba,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,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,GAAGC,gCAAW,CAACC,gCAAA,CAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,MAAM,CAAC;YAErF,MAAM,UAAU,GAAG,IAAIC,yBAAa,CAAA,MAAA,CAAA,MAAA,CAAA,MAAA,CAAA,MAAA,CAAA,EAClC,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,SAAS,EACjC,GAAG,EAAE,MAAM,CAAC,eAAe,CAACD,gCAAA,CAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,GAAG,CAAC,EAC7C,gBAAgB,EAAE,gBAAgB,EAAA,EAC/B,sBAAsB,CAAC,2BAA2B,EAAE,CAAA,EAAA,EACvD,YAAY,EAAEA,gCAAA,CAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,YAAY,EACvC,2BAA2B,EAAEA,gCAAA,CAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,2BAA2B,EACrE,sBAAsB,EAAEA,gCAAA,CAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,sBAAsB,EAAA,CAAA,CAC3D;AAEF,YAAA,MAAM,YAAY,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,EAAE;gBACtE,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;;AAE5B,YAAA,MAAM,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,GAAGD,gCAAW,CAACC,gCAAA,CAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,MAAM,CAAC;YACrF,OAAO;AACL,gBAAA,MAAM,EAAA,MAAA,CAAA,MAAA,CAAA,EACJ,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,SAAS,EACjC,GAAG,EAAE,MAAM,CAAC,eAAe,CAACA,gCAAA,CAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,GAAG,CAAC,EAC7C,gBAAgB,EAAE,gBAAgB,EAAA,EAC/B,sBAAsB,CAAC,2BAA2B,EAAE,CACxD;aACF;QACH,CAAC,CAAA;AAAA,IAAA;AACF;;;;;"}
+{"version":3,"file":"update.cjs","sources":["../../src/commands/update.ts"],"sourcesContent":[null],"names":["__classPrivateFieldSet","parseUpdate","__classPrivateFieldGet","UpdateCommand"],"mappings":";;;;;;;AAmCA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoCG;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,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,GAAGC,gCAAW,CAACC,gCAAA,CAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,MAAM,CAAC;YAErF,MAAM,UAAU,GAAG,IAAIC,yBAAa,CAAA,MAAA,CAAA,MAAA,CAAA,MAAA,CAAA,MAAA,CAAA,EAClC,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,SAAS,EACjC,GAAG,EAAE,MAAM,CAAC,eAAe,CAACD,gCAAA,CAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,GAAG,CAAC,EAC7C,gBAAgB,EAAE,gBAAgB,EAAA,EAC/B,sBAAsB,CAAC,2BAA2B,EAAE,CAAA,EAAA,EACvD,YAAY,EAAEA,gCAAA,CAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,YAAY,EACvC,2BAA2B,EAAEA,gCAAA,CAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,2BAA2B,EACrE,sBAAsB,EAAEA,gCAAA,CAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,sBAAsB,EAAA,CAAA,CAC3D;AAEF,YAAA,MAAM,YAAY,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,EAAE;gBACtE,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;;AAE5B,YAAA,MAAM,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,GAAGD,gCAAW,CAACC,gCAAA,CAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,MAAM,CAAC;YACrF,OAAO;AACL,gBAAA,MAAM,EAAA,MAAA,CAAA,MAAA,CAAA,EACJ,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,SAAS,EACjC,GAAG,EAAE,MAAM,CAAC,eAAe,CAACA,gCAAA,CAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,GAAG,CAAC,EAC7C,gBAAgB,EAAE,gBAAgB,EAAA,EAC/B,sBAAsB,CAAC,2BAA2B,EAAE,CACxD;aACF;QACH,CAAC,CAAA;AAAA,IAAA;AACF;;;;;"}

package/dist/commands/update.d.ts

@@ -1,20 +1,67 @@
 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 { UpdateValues } from '../updates/update-types.js';
+import { UpdateValues } from '../updates/index.js';
 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 Update command.
+ *
+ * @template Schema - The Zod schema defining the structure of the entity.
+ */
 type UpdateConfig<Schema extends ZodObject> = BaseConfig & {
     key: Partial<EntitySchema<Schema>>;
     update: UpdateValues;
     returnValues?: ReturnValue;
     returnItemCollectionMetrics?: ReturnItemCollectionMetrics;
 };
+/**
+ * Result of the Update command.
+ *
+ * @template Schema - The Zod schema defining the structure of the entity.
+ */
 type UpdateResult<Schema extends ZodObject> = BaseResult & {
     updatedItem?: Partial<EntitySchema<Schema>> | undefined;
     itemCollectionMetrics?: ItemCollectionMetrics;
 };
+/**
+ * Command to modify existing item attributes in a DynamoDB table.
+ *
+ * @template Schema - The Zod schema defining the structure of the entity.
+ *
+ * @example
+ * ```typescript
+ * import { DynamoTable, DynamoEntity, key, Update, add } 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(),
+ *     loginCount: z.number(),
+ *   }),
+ *   partitionKey: user => key('USER', user.userId),
+ *   sortKey: () => 'METADATA',
+ * });
+ *
+ * const updateCommand = new Update({
+ *   key: { userId: 'user123' },
+ *   update: {
+ *     name: 'Jane Doe',
+ *     loginCount: add(1),
+ *   },
+ *   returnValues: 'ALL_NEW',
+ * });
+ *
+ * const { updatedItem } = await userEntity.send(updateCommand);
+ * ```
+ */
 declare class Update<Schema extends ZodObject> implements BaseCommand<UpdateResult<Schema>, Schema>, WriteTransactable<Schema> {
     #private;
     constructor(config: UpdateConfig<Schema>);

package/dist/commands/update.mjs

@@ -3,6 +3,43 @@ import { UpdateCommand } from '@aws-sdk/lib-dynamodb';
 import { parseUpdate } from '../updates/update-parser.mjs';
 
 var _Update_config;
+/**
+ * Command to modify existing item attributes in a DynamoDB table.
+ *
+ * @template Schema - The Zod schema defining the structure of the entity.
+ *
+ * @example
+ * ```typescript
+ * import { DynamoTable, DynamoEntity, key, Update, add } 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(),
+ *     loginCount: z.number(),
+ *   }),
+ *   partitionKey: user => key('USER', user.userId),
+ *   sortKey: () => 'METADATA',
+ * });
+ *
+ * const updateCommand = new Update({
+ *   key: { userId: 'user123' },
+ *   update: {
+ *     name: 'Jane Doe',
+ *     loginCount: add(1),
+ *   },
+ *   returnValues: 'ALL_NEW',
+ * });
+ *
+ * const { updatedItem } = await userEntity.send(updateCommand);
+ * ```
+ */
 class Update {
     constructor(config) {
         _Update_config.set(this, void 0);

package/dist/commands/update.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"update.mjs","sources":["../../src/commands/update.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;MA8Ba,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,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,GAAG,WAAW,CAAC,sBAAA,CAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,MAAM,CAAC;YAErF,MAAM,UAAU,GAAG,IAAI,aAAa,CAAA,MAAA,CAAA,MAAA,CAAA,MAAA,CAAA,MAAA,CAAA,EAClC,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,SAAS,EACjC,GAAG,EAAE,MAAM,CAAC,eAAe,CAAC,sBAAA,CAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,GAAG,CAAC,EAC7C,gBAAgB,EAAE,gBAAgB,EAAA,EAC/B,sBAAsB,CAAC,2BAA2B,EAAE,CAAA,EAAA,EACvD,YAAY,EAAE,sBAAA,CAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,YAAY,EACvC,2BAA2B,EAAE,sBAAA,CAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,2BAA2B,EACrE,sBAAsB,EAAE,sBAAA,CAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,sBAAsB,EAAA,CAAA,CAC3D;AAEF,YAAA,MAAM,YAAY,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,EAAE;gBACtE,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;;AAE5B,YAAA,MAAM,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,GAAG,WAAW,CAAC,sBAAA,CAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,MAAM,CAAC;YACrF,OAAO;AACL,gBAAA,MAAM,EAAA,MAAA,CAAA,MAAA,CAAA,EACJ,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,SAAS,EACjC,GAAG,EAAE,MAAM,CAAC,eAAe,CAAC,sBAAA,CAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,GAAG,CAAC,EAC7C,gBAAgB,EAAE,gBAAgB,EAAA,EAC/B,sBAAsB,CAAC,2BAA2B,EAAE,CACxD;aACF;QACH,CAAC,CAAA;AAAA,IAAA;AACF;;;;;"}
+{"version":3,"file":"update.mjs","sources":["../../src/commands/update.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;AAmCA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoCG;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,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,GAAG,WAAW,CAAC,sBAAA,CAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,MAAM,CAAC;YAErF,MAAM,UAAU,GAAG,IAAI,aAAa,CAAA,MAAA,CAAA,MAAA,CAAA,MAAA,CAAA,MAAA,CAAA,EAClC,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,SAAS,EACjC,GAAG,EAAE,MAAM,CAAC,eAAe,CAAC,sBAAA,CAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,GAAG,CAAC,EAC7C,gBAAgB,EAAE,gBAAgB,EAAA,EAC/B,sBAAsB,CAAC,2BAA2B,EAAE,CAAA,EAAA,EACvD,YAAY,EAAE,sBAAA,CAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,YAAY,EACvC,2BAA2B,EAAE,sBAAA,CAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,2BAA2B,EACrE,sBAAsB,EAAE,sBAAA,CAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,sBAAsB,EAAA,CAAA,CAC3D;AAEF,YAAA,MAAM,YAAY,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,EAAE;gBACtE,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;;AAE5B,YAAA,MAAM,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,GAAG,WAAW,CAAC,sBAAA,CAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,MAAM,CAAC;YACrF,OAAO;AACL,gBAAA,MAAM,EAAA,MAAA,CAAA,MAAA,CAAA,EACJ,SAAS,EAAE,MAAM,CAAC,KAAK,CAAC,SAAS,EACjC,GAAG,EAAE,MAAM,CAAC,eAAe,CAAC,sBAAA,CAAA,IAAI,EAAA,cAAA,EAAA,GAAA,CAAQ,CAAC,GAAG,CAAC,EAC7C,gBAAgB,EAAE,gBAAgB,EAAA,EAC/B,sBAAsB,CAAC,2BAA2B,EAAE,CACxD;aACF;QACH,CAAC,CAAA;AAAA,IAAA;AACF;;;;;"}

package/dist/conditions/and.cjs

@@ -2,6 +2,9 @@
 
 var conditions_conditionSymbols = require('./condition-symbols.cjs');
 
+/**
+ * Combines multiple condition expressions using the logical AND operator.
+ */
 function and(firstCondition, secondCondition, ...additionalConditions) {
     return {
         type: conditions_conditionSymbols.$logical,

package/dist/conditions/and.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"and.cjs","sources":["../../src/conditions/and.ts"],"sourcesContent":[null],"names":["$logical"],"mappings":";;;;AAGM,SAAU,GAAG,CACjB,cAA2C,EAC3C,eAA4C,EAC5C,GAAG,oBAAmD,EAAA;IAEtD,OAAO;AACL,QAAA,IAAI,EAAEA,oCAAQ;AACd,QAAA,QAAQ,EAAE,KAAK;QACf,aAAa,EAAE,CAAC,cAAc,EAAE,eAAe,EAAE,GAAG,oBAAoB,CAAC;KAC1E;AACH;;;;"}
+{"version":3,"file":"and.cjs","sources":["../../src/conditions/and.ts"],"sourcesContent":[null],"names":["$logical"],"mappings":";;;;AAGA;;AAEG;AACG,SAAU,GAAG,CACjB,cAA2C,EAC3C,eAA4C,EAC5C,GAAG,oBAAmD,EAAA;IAEtD,OAAO;AACL,QAAA,IAAI,EAAEA,oCAAQ;AACd,QAAA,QAAQ,EAAE,KAAK;QACf,aAAa,EAAE,CAAC,cAAc,EAAE,eAAe,EAAE,GAAG,oBAAoB,CAAC;KAC1E;AACH;;;;"}

package/dist/conditions/and.d.ts

@@ -1,5 +1,8 @@
-import { ConditionExpressionTemplate, LogicalExpression } from './condition-types.js';
+import { ConditionExpressionTemplate, LogicalExpression } from './index.js';
 
+/**
+ * Combines multiple condition expressions using the logical AND operator.
+ */
 declare function and(firstCondition: ConditionExpressionTemplate, secondCondition: ConditionExpressionTemplate, ...additionalConditions: ConditionExpressionTemplate[]): LogicalExpression;
 
 export { and };

package/dist/conditions/and.mjs

@@ -1,5 +1,8 @@
 import { $logical } from './condition-symbols.mjs';
 
+/**
+ * Combines multiple condition expressions using the logical AND operator.
+ */
 function and(firstCondition, secondCondition, ...additionalConditions) {
     return {
         type: $logical,

package/dist/conditions/and.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"and.mjs","sources":["../../src/conditions/and.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAGM,SAAU,GAAG,CACjB,cAA2C,EAC3C,eAA4C,EAC5C,GAAG,oBAAmD,EAAA;IAEtD,OAAO;AACL,QAAA,IAAI,EAAE,QAAQ;AACd,QAAA,QAAQ,EAAE,KAAK;QACf,aAAa,EAAE,CAAC,cAAc,EAAE,eAAe,EAAE,GAAG,oBAAoB,CAAC;KAC1E;AACH;;;;"}
+{"version":3,"file":"and.mjs","sources":["../../src/conditions/and.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAGA;;AAEG;AACG,SAAU,GAAG,CACjB,cAA2C,EAC3C,eAA4C,EAC5C,GAAG,oBAAmD,EAAA;IAEtD,OAAO;AACL,QAAA,IAAI,EAAE,QAAQ;AACd,QAAA,QAAQ,EAAE,KAAK;QACf,aAAa,EAAE,CAAC,cAAc,EAAE,eAAe,EAAE,GAAG,oBAAoB,CAAC;KAC1E;AACH;;;;"}

package/dist/conditions/begins-with.cjs

@@ -2,6 +2,9 @@
 
 var conditions_conditionSymbols = require('./condition-symbols.cjs');
 
+/**
+ * Creates a BEGINS WITH expression template.
+ */
 function beginsWith(prefix) {
     return {
         type: conditions_conditionSymbols.$beginsWith,

package/dist/conditions/begins-with.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"begins-with.cjs","sources":["../../src/conditions/begins-with.ts"],"sourcesContent":[null],"names":["$beginsWith"],"mappings":";;;;AAGM,SAAU,UAAU,CAAC,MAAc,EAAA;IACvC,OAAO;AACL,QAAA,IAAI,EAAEA,uCAAW;QACjB,MAAM;KACP;AACH;;;;"}
+{"version":3,"file":"begins-with.cjs","sources":["../../src/conditions/begins-with.ts"],"sourcesContent":[null],"names":["$beginsWith"],"mappings":";;;;AAGA;;AAEG;AACG,SAAU,UAAU,CAAC,MAAc,EAAA;IACvC,OAAO;AACL,QAAA,IAAI,EAAEA,uCAAW;QACjB,MAAM;KACP;AACH;;;;"}

package/dist/conditions/begins-with.d.ts

@@ -1,5 +1,8 @@
-import { BeginsWithExpressionTemplate } from './condition-types.js';
+import { BeginsWithExpressionTemplate } from './index.js';
 
+/**
+ * Creates a BEGINS WITH expression template.
+ */
 declare function beginsWith(prefix: string): BeginsWithExpressionTemplate;
 
 export { beginsWith };

package/dist/conditions/begins-with.mjs

@@ -1,5 +1,8 @@
 import { $beginsWith } from './condition-symbols.mjs';
 
+/**
+ * Creates a BEGINS WITH expression template.
+ */
 function beginsWith(prefix) {
     return {
         type: $beginsWith,

package/dist/conditions/begins-with.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"begins-with.mjs","sources":["../../src/conditions/begins-with.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAGM,SAAU,UAAU,CAAC,MAAc,EAAA;IACvC,OAAO;AACL,QAAA,IAAI,EAAE,WAAW;QACjB,MAAM;KACP;AACH;;;;"}
+{"version":3,"file":"begins-with.mjs","sources":["../../src/conditions/begins-with.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAGA;;AAEG;AACG,SAAU,UAAU,CAAC,MAAc,EAAA;IACvC,OAAO;AACL,QAAA,IAAI,EAAE,WAAW;QACjB,MAAM;KACP;AACH;;;;"}

package/dist/conditions/between.cjs

@@ -2,6 +2,9 @@
 
 var conditions_conditionSymbols = require('./condition-symbols.cjs');
 
+/**
+ * Creates a BETWEEN expression template. Lower and upper bounds are *inclusive*.
+ */
 function between(lowerBound, upperBound) {
     return {
         type: conditions_conditionSymbols.$between,

package/dist/conditions/between.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"between.cjs","sources":["../../src/conditions/between.ts"],"sourcesContent":[null],"names":["$between"],"mappings":";;;;AAGM,SAAU,OAAO,CACrB,UAA2B,EAC3B,UAA2B,EAAA;IAE3B,OAAO;AACL,QAAA,IAAI,EAAEA,oCAAQ;AACd,QAAA,UAAU,EAAE,UAAU;AACtB,QAAA,UAAU,EAAE,UAAU;KACvB;AACH;;;;"}
+{"version":3,"file":"between.cjs","sources":["../../src/conditions/between.ts"],"sourcesContent":[null],"names":["$between"],"mappings":";;;;AAGA;;AAEG;AACG,SAAU,OAAO,CACrB,UAA2B,EAC3B,UAA2B,EAAA;IAE3B,OAAO;AACL,QAAA,IAAI,EAAEA,oCAAQ;AACd,QAAA,UAAU,EAAE,UAAU;AACtB,QAAA,UAAU,EAAE,UAAU;KACvB;AACH;;;;"}

package/dist/conditions/between.d.ts

@@ -1,5 +1,8 @@
-import { ValueExpression, BetweenExpressionTemplate } from './condition-types.js';
+import { ValueExpression, BetweenExpressionTemplate } from './index.js';
 
+/**
+ * Creates a BETWEEN expression template. Lower and upper bounds are *inclusive*.
+ */
 declare function between(lowerBound: ValueExpression, upperBound: ValueExpression): BetweenExpressionTemplate;
 
 export { between };

package/dist/conditions/between.mjs

@@ -1,5 +1,8 @@
 import { $between } from './condition-symbols.mjs';
 
+/**
+ * Creates a BETWEEN expression template. Lower and upper bounds are *inclusive*.
+ */
 function between(lowerBound, upperBound) {
     return {
         type: $between,

package/dist/conditions/between.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"between.mjs","sources":["../../src/conditions/between.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAGM,SAAU,OAAO,CACrB,UAA2B,EAC3B,UAA2B,EAAA;IAE3B,OAAO;AACL,QAAA,IAAI,EAAE,QAAQ;AACd,QAAA,UAAU,EAAE,UAAU;AACtB,QAAA,UAAU,EAAE,UAAU;KACvB;AACH;;;;"}
+{"version":3,"file":"between.mjs","sources":["../../src/conditions/between.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAGA;;AAEG;AACG,SAAU,OAAO,CACrB,UAA2B,EAC3B,UAA2B,EAAA;IAE3B,OAAO;AACL,QAAA,IAAI,EAAE,QAAQ;AACd,QAAA,UAAU,EAAE,UAAU;AACtB,QAAA,UAAU,EAAE,UAAU;KACvB;AACH;;;;"}

package/dist/conditions/condition-parser.d.ts

@@ -1,4 +1,4 @@
-import { Condition } from './condition-types.js';
+import { Condition } from './index.js';
 import { AttributeExpressionMap } from '../attributes/attribute-map.js';
 
 type ConditionParserResult = {

package/dist/conditions/contains.cjs

@@ -2,6 +2,9 @@
 
 var conditions_conditionSymbols = require('./condition-symbols.cjs');
 
+/**
+ * Creates a CONTAINS expression template.
+ */
 function contains(substringOrElement) {
     return {
         type: conditions_conditionSymbols.$contains,

package/dist/conditions/contains.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"contains.cjs","sources":["../../src/conditions/contains.ts"],"sourcesContent":[null],"names":["$contains"],"mappings":";;;;AAIM,SAAU,QAAQ,CAAC,kBAAwC,EAAA;IAC/D,OAAO;AACL,QAAA,IAAI,EAAEA,qCAAS;QACf,kBAAkB;KACnB;AACH;;;;"}
+{"version":3,"file":"contains.cjs","sources":["../../src/conditions/contains.ts"],"sourcesContent":[null],"names":["$contains"],"mappings":";;;;AAIA;;AAEG;AACG,SAAU,QAAQ,CAAC,kBAAwC,EAAA;IAC/D,OAAO;AACL,QAAA,IAAI,EAAEA,qCAAS;QACf,kBAAkB;KACnB;AACH;;;;"}