dyno-table 2.2.0 → 2.3.0

package/dist/builders/delete-builder.d.cts

@@ -1,211 +0,0 @@
-import { r as PrimaryKeyWithoutExpression, C as Condition, q as ConditionOperator } from '../conditions-CC3NDfUU.cjs';
-import { TransactionBuilder } from './transaction-builder.cjs';
-import { B as BatchBuilder } from '../batch-builder-BPoHyN_Q.cjs';
-import { D as DeleteCommandParams } from '../builder-types-BTVhQSHI.cjs';
-import { DynamoItem } from '../types.cjs';
-import '@aws-sdk/lib-dynamodb';
-
-interface DeleteOptions {
-    condition?: Condition;
-    returnValues?: "ALL_OLD";
-}
-type DeleteExecutor = (params: DeleteCommandParams) => Promise<{
-    item?: DynamoItem;
-}>;
-/**
- * Builder for creating DynamoDB delete operations.
- *
- * @example
- * ```typescript
- * // Simple delete
- * const result = await new DeleteBuilder(executor, 'dinosaurs', { id: 'TREX-001' })
- *   .execute();
- *
- * // Conditional delete with old value retrieval
- * const result = await new DeleteBuilder(executor, 'habitats', { id: 'PADDOCK-A' })
- *   .condition(op =>
- *     op.and([
- *       op.eq('status', 'DECOMMISSIONED'),
- *       op.eq('occupants', 0),
- *       op.lt('securityIncidents', 1)
- *     ])
- *   )
- *   .returnValues('ALL_OLD')
- *   .execute();
- * ```
- */
-declare class DeleteBuilder {
-    private options;
-    private readonly executor;
-    private readonly tableName;
-    private readonly key;
-    constructor(executor: DeleteExecutor, tableName: string, key: PrimaryKeyWithoutExpression);
-    /**
-     * Adds a condition that must be satisfied for the delete operation to succeed.
-     *
-     * @example
-     * ```typescript
-     * // Ensure dinosaur can be safely removed
-     * builder.condition(op =>
-     *   op.and([
-     *     op.eq('status', 'SEDATED'),
-     *     op.eq('location', 'MEDICAL_BAY'),
-     *     op.attributeExists('lastCheckup')
-     *   ])
-     * );
-     *
-     * // Verify habitat is empty
-     * builder.condition(op =>
-     *   op.and([
-     *     op.eq('occupants', 0),
-     *     op.eq('maintenanceStatus', 'COMPLETE'),
-     *     op.not(op.attributeExists('activeAlerts'))
-     *   ])
-     * );
-     * ```
-     *
-     * @param condition - Either a Condition object or a callback function that builds the condition
-     * @returns The builder instance for method chaining
-     */
-    condition<T extends DynamoItem>(condition: Condition | ((op: ConditionOperator<T>) => Condition)): DeleteBuilder;
-    /**
-     * Sets whether to return the item's attribute values before deletion.
-     *
-     * @example
-     * ```ts
-     * // Archive dinosaur data before removal
-     * const result = await builder
-     *   .returnValues('ALL_OLD')
-     *   .execute();
-     *
-     * if (result.item) {
-     *   console.log('Removed dinosaur data:', {
-     *     species: result.item.species,
-     *     age: result.item.age,
-     *     lastLocation: result.item.location
-     *   });
-     * }
-     * ```
-     *
-     * @param returnValues - Use 'ALL_OLD' to return all attributes of the deleted item
-     * @returns The builder instance for method chaining
-     */
-    returnValues(returnValues: "ALL_OLD"): DeleteBuilder;
-    /**
-     * Generate the DynamoDB command parameters
-     */
-    private toDynamoCommand;
-    /**
-     * Adds this delete operation to a transaction.
-     *
-     * @example
-     * ```ts
-     * const transaction = new TransactionBuilder();
-     *
-     * // Remove dinosaur from old habitat
-     * new DeleteBuilder(executor, 'dinosaurs', { id: 'RAPTOR-001' })
-     *   .condition(op => op.eq('status', 'SEDATED'))
-     *   .withTransaction(transaction);
-     *
-     * // Update old habitat occupancy
-     * new UpdateBuilder(executor, 'habitats', { id: 'PADDOCK-A' })
-     *   .add('occupants', -1)
-     *   .withTransaction(transaction);
-     *
-     * // Execute transfer atomically
-     * await transaction.execute();
-     * ```
-     *
-     * @param transaction - The transaction builder to add this operation to
-     */
-    withTransaction(transaction: TransactionBuilder): void;
-    /**
-     * Adds this delete operation to a batch with optional entity type information.
-     *
-     * @example Basic Usage
-     * ```ts
-     * const batch = table.batchBuilder();
-     *
-     * // Remove multiple dinosaurs in batch
-     * dinosaurRepo.delete({ id: 'old-dino-1' }).withBatch(batch);
-     * dinosaurRepo.delete({ id: 'old-dino-2' }).withBatch(batch);
-     * dinosaurRepo.delete({ id: 'old-dino-3' }).withBatch(batch);
-     *
-     * // Execute all deletions efficiently
-     * await batch.execute();
-     * ```
-     *
-     * @example Typed Usage
-     * ```ts
-     * const batch = table.batchBuilder<{
-     *   User: UserEntity;
-     *   Order: OrderEntity;
-     * }>();
-     *
-     * // Add operations with type information
-     * userRepo.delete({ id: 'user-1' }).withBatch(batch, 'User');
-     * orderRepo.delete({ id: 'order-1' }).withBatch(batch, 'Order');
-     *
-     * // Execute batch operations
-     * await batch.execute();
-     * ```
-     *
-     * @param batch - The batch builder to add this operation to
-     * @param entityType - Optional entity type key for type tracking
-     */
-    withBatch<TEntities extends Record<string, DynamoItem> = Record<string, DynamoItem>, K extends keyof TEntities = keyof TEntities>(batch: BatchBuilder<TEntities>, entityType?: K): void;
-    /**
-     * Executes the delete operation against DynamoDB.
-     *
-     * @example
-     * ```ts
-     * // Delete with condition and retrieve old values
-     * const result = await new DeleteBuilder(executor, 'myTable', { id: '123' })
-     *   .condition(op => op.eq('status', 'INACTIVE'))
-     *   .returnValues('ALL_OLD')
-     *   .execute();
-     *
-     * if (result.item) {
-     *   console.log('Deleted item:', result.item);
-     * }
-     * ```
-     *
-     * @returns A promise that resolves to an object containing the deleted item's attributes (if returnValues is 'ALL_OLD')
-     */
-    execute(): Promise<{
-        item?: DynamoItem;
-    }>;
-    /**
-     * Gets a human-readable representation of the delete command
-     * with all expression placeholders replaced by their actual values.
-     *
-     * @example
-     * ```ts
-     * const debugInfo = new DeleteBuilder(executor, 'dinosaurs', { id: 'TREX-001' })
-     *   .condition(op => op.and([
-     *     op.eq('status', 'SEDATED'),
-     *     op.eq('location', 'MEDICAL_BAY'),
-     *     op.gt('sedationLevel', 8)
-     *     op.eq('version', 1),
-     *     op.attributeExists('status')
-     *   ]))
-     *   .debug();
-     *
-     * console.log('Delete command:', debugInfo);
-     * ```
-     *
-     * @returns A readable representation of the delete command with resolved expressions
-     */
-    debug(): {
-        raw: DeleteCommandParams;
-        readable: {
-            conditionExpression?: string;
-            updateExpression?: string;
-            filterExpression?: string;
-            keyConditionExpression?: string;
-            projectionExpression?: string;
-        };
-    };
-}
-
-export { DeleteBuilder, type DeleteOptions };

package/dist/builders/delete-builder.d.ts

@@ -1,211 +0,0 @@
-import { r as PrimaryKeyWithoutExpression, C as Condition, q as ConditionOperator } from '../conditions-DD0bvyHm.js';
-import { TransactionBuilder } from './transaction-builder.js';
-import { B as BatchBuilder } from '../batch-builder-Cdo49C2r.js';
-import { D as DeleteCommandParams } from '../builder-types-CzuLR4Th.js';
-import { DynamoItem } from '../types.js';
-import '@aws-sdk/lib-dynamodb';
-
-interface DeleteOptions {
-    condition?: Condition;
-    returnValues?: "ALL_OLD";
-}
-type DeleteExecutor = (params: DeleteCommandParams) => Promise<{
-    item?: DynamoItem;
-}>;
-/**
- * Builder for creating DynamoDB delete operations.
- *
- * @example
- * ```typescript
- * // Simple delete
- * const result = await new DeleteBuilder(executor, 'dinosaurs', { id: 'TREX-001' })
- *   .execute();
- *
- * // Conditional delete with old value retrieval
- * const result = await new DeleteBuilder(executor, 'habitats', { id: 'PADDOCK-A' })
- *   .condition(op =>
- *     op.and([
- *       op.eq('status', 'DECOMMISSIONED'),
- *       op.eq('occupants', 0),
- *       op.lt('securityIncidents', 1)
- *     ])
- *   )
- *   .returnValues('ALL_OLD')
- *   .execute();
- * ```
- */
-declare class DeleteBuilder {
-    private options;
-    private readonly executor;
-    private readonly tableName;
-    private readonly key;
-    constructor(executor: DeleteExecutor, tableName: string, key: PrimaryKeyWithoutExpression);
-    /**
-     * Adds a condition that must be satisfied for the delete operation to succeed.
-     *
-     * @example
-     * ```typescript
-     * // Ensure dinosaur can be safely removed
-     * builder.condition(op =>
-     *   op.and([
-     *     op.eq('status', 'SEDATED'),
-     *     op.eq('location', 'MEDICAL_BAY'),
-     *     op.attributeExists('lastCheckup')
-     *   ])
-     * );
-     *
-     * // Verify habitat is empty
-     * builder.condition(op =>
-     *   op.and([
-     *     op.eq('occupants', 0),
-     *     op.eq('maintenanceStatus', 'COMPLETE'),
-     *     op.not(op.attributeExists('activeAlerts'))
-     *   ])
-     * );
-     * ```
-     *
-     * @param condition - Either a Condition object or a callback function that builds the condition
-     * @returns The builder instance for method chaining
-     */
-    condition<T extends DynamoItem>(condition: Condition | ((op: ConditionOperator<T>) => Condition)): DeleteBuilder;
-    /**
-     * Sets whether to return the item's attribute values before deletion.
-     *
-     * @example
-     * ```ts
-     * // Archive dinosaur data before removal
-     * const result = await builder
-     *   .returnValues('ALL_OLD')
-     *   .execute();
-     *
-     * if (result.item) {
-     *   console.log('Removed dinosaur data:', {
-     *     species: result.item.species,
-     *     age: result.item.age,
-     *     lastLocation: result.item.location
-     *   });
-     * }
-     * ```
-     *
-     * @param returnValues - Use 'ALL_OLD' to return all attributes of the deleted item
-     * @returns The builder instance for method chaining
-     */
-    returnValues(returnValues: "ALL_OLD"): DeleteBuilder;
-    /**
-     * Generate the DynamoDB command parameters
-     */
-    private toDynamoCommand;
-    /**
-     * Adds this delete operation to a transaction.
-     *
-     * @example
-     * ```ts
-     * const transaction = new TransactionBuilder();
-     *
-     * // Remove dinosaur from old habitat
-     * new DeleteBuilder(executor, 'dinosaurs', { id: 'RAPTOR-001' })
-     *   .condition(op => op.eq('status', 'SEDATED'))
-     *   .withTransaction(transaction);
-     *
-     * // Update old habitat occupancy
-     * new UpdateBuilder(executor, 'habitats', { id: 'PADDOCK-A' })
-     *   .add('occupants', -1)
-     *   .withTransaction(transaction);
-     *
-     * // Execute transfer atomically
-     * await transaction.execute();
-     * ```
-     *
-     * @param transaction - The transaction builder to add this operation to
-     */
-    withTransaction(transaction: TransactionBuilder): void;
-    /**
-     * Adds this delete operation to a batch with optional entity type information.
-     *
-     * @example Basic Usage
-     * ```ts
-     * const batch = table.batchBuilder();
-     *
-     * // Remove multiple dinosaurs in batch
-     * dinosaurRepo.delete({ id: 'old-dino-1' }).withBatch(batch);
-     * dinosaurRepo.delete({ id: 'old-dino-2' }).withBatch(batch);
-     * dinosaurRepo.delete({ id: 'old-dino-3' }).withBatch(batch);
-     *
-     * // Execute all deletions efficiently
-     * await batch.execute();
-     * ```
-     *
-     * @example Typed Usage
-     * ```ts
-     * const batch = table.batchBuilder<{
-     *   User: UserEntity;
-     *   Order: OrderEntity;
-     * }>();
-     *
-     * // Add operations with type information
-     * userRepo.delete({ id: 'user-1' }).withBatch(batch, 'User');
-     * orderRepo.delete({ id: 'order-1' }).withBatch(batch, 'Order');
-     *
-     * // Execute batch operations
-     * await batch.execute();
-     * ```
-     *
-     * @param batch - The batch builder to add this operation to
-     * @param entityType - Optional entity type key for type tracking
-     */
-    withBatch<TEntities extends Record<string, DynamoItem> = Record<string, DynamoItem>, K extends keyof TEntities = keyof TEntities>(batch: BatchBuilder<TEntities>, entityType?: K): void;
-    /**
-     * Executes the delete operation against DynamoDB.
-     *
-     * @example
-     * ```ts
-     * // Delete with condition and retrieve old values
-     * const result = await new DeleteBuilder(executor, 'myTable', { id: '123' })
-     *   .condition(op => op.eq('status', 'INACTIVE'))
-     *   .returnValues('ALL_OLD')
-     *   .execute();
-     *
-     * if (result.item) {
-     *   console.log('Deleted item:', result.item);
-     * }
-     * ```
-     *
-     * @returns A promise that resolves to an object containing the deleted item's attributes (if returnValues is 'ALL_OLD')
-     */
-    execute(): Promise<{
-        item?: DynamoItem;
-    }>;
-    /**
-     * Gets a human-readable representation of the delete command
-     * with all expression placeholders replaced by their actual values.
-     *
-     * @example
-     * ```ts
-     * const debugInfo = new DeleteBuilder(executor, 'dinosaurs', { id: 'TREX-001' })
-     *   .condition(op => op.and([
-     *     op.eq('status', 'SEDATED'),
-     *     op.eq('location', 'MEDICAL_BAY'),
-     *     op.gt('sedationLevel', 8)
-     *     op.eq('version', 1),
-     *     op.attributeExists('status')
-     *   ]))
-     *   .debug();
-     *
-     * console.log('Delete command:', debugInfo);
-     * ```
-     *
-     * @returns A readable representation of the delete command with resolved expressions
-     */
-    debug(): {
-        raw: DeleteCommandParams;
-        readable: {
-            conditionExpression?: string;
-            updateExpression?: string;
-            filterExpression?: string;
-            keyConditionExpression?: string;
-            projectionExpression?: string;
-        };
-    };
-}
-
-export { DeleteBuilder, type DeleteOptions };