betterddb 0.8.0 → 0.8.2

package/src/builders/create-builder.ts

@@ -1,97 +0,0 @@
-import {
-  type AttributeValue,
-  type Put,
-  type TransactWriteItem,
-} from "@aws-sdk/client-dynamodb";
-import { type BetterDDB } from "../betterddb.js";
-import { PutCommand, TransactWriteCommand } from "@aws-sdk/lib-dynamodb";
-
-export class CreateBuilder<T> {
-  private extraTransactItems: TransactWriteItem[] = [];
-
-  constructor(
-    private parent: BetterDDB<T>,
-    private item: T,
-  ) {}
-
-  public async execute(): Promise<T> {
-    const validated = this.parent.getSchema().parse(this.item);
-    if (this.extraTransactItems.length > 0) {
-      // Build our update transaction item.
-      const myTransactItem = this.toTransactPut();
-      // Combine with extra transaction items.
-      const allItems = [...this.extraTransactItems, myTransactItem];
-      await this.parent.getClient().send(
-        new TransactWriteCommand({
-          TransactItems: allItems,
-        }),
-      );
-      // After transaction, retrieve the updated item.
-      const result = await this.parent.get(this.item).execute();
-      if (result === null) {
-        throw new Error("Item not found after transaction create");
-      }
-      return result;
-    } else {
-      let finalItem: T = {
-        ...this.item,
-        entityType: this.parent.getEntityType(),
-      };
-      if (this.parent.getTimestamps()) {
-        const now = new Date().toISOString();
-        finalItem = { ...finalItem, createdAt: now, updatedAt: now } as T;
-      }
-
-      // Compute and merge primary key.
-      const computedKeys = this.parent.buildKey(validated as Partial<T>);
-      finalItem = { ...finalItem, ...computedKeys };
-
-      // Compute and merge index attributes.
-      const indexAttributes = this.parent.buildIndexes(validated as Partial<T>);
-      finalItem = { ...finalItem, ...indexAttributes };
-
-      await this.parent.getClient().send(
-        new PutCommand({
-          TableName: this.parent.getTableName(),
-          Item: finalItem as Record<string, AttributeValue>,
-        }),
-      );
-
-      return validated as T;
-    }
-  }
-
-  public transactWrite(ops: TransactWriteItem[] | TransactWriteItem): this {
-    if (Array.isArray(ops)) {
-      this.extraTransactItems.push(...ops);
-    } else {
-      this.extraTransactItems.push(ops);
-    }
-    return this;
-  }
-
-  public toTransactPut(): TransactWriteItem {
-    const validated = this.parent.getSchema().parse(this.item);
-    let finalItem: T = {
-      ...this.item,
-      entityType: this.parent.getEntityType(),
-    };
-    if (this.parent.getTimestamps()) {
-      const now = new Date().toISOString();
-      finalItem = { ...finalItem, createdAt: now, updatedAt: now } as T;
-    }
-
-    // Compute and merge primary key.
-    const computedKeys = this.parent.buildKey(validated as Partial<T>);
-    finalItem = { ...finalItem, ...computedKeys };
-
-    // Compute and merge index attributes.
-    const indexAttributes = this.parent.buildIndexes(validated as Partial<T>);
-    finalItem = { ...finalItem, ...indexAttributes };
-    const putItem: Put = {
-      TableName: this.parent.getTableName(),
-      Item: finalItem as Record<string, AttributeValue>,
-    };
-    return { Put: putItem };
-  }
-}

package/src/builders/delete-builder.ts

@@ -1,87 +0,0 @@
-import { type BetterDDB } from "../betterddb.js";
-import {
-  type TransactWriteItem,
-  type DeleteItemInput,
-} from "@aws-sdk/client-dynamodb";
-import {
-  type NativeAttributeValue,
-  TransactWriteCommand,
-  DeleteCommand,
-} from "@aws-sdk/lib-dynamodb";
-export class DeleteBuilder<T> {
-  private condition?: {
-    expression: string;
-    attributeValues: Record<string, NativeAttributeValue>;
-  };
-  private extraTransactItems: TransactWriteItem[] = [];
-  constructor(
-    private parent: BetterDDB<T>,
-    private key: Partial<T>,
-  ) {}
-
-  /**
-   * Specify a condition expression for the delete operation.
-   */
-  public withCondition(
-    expression: string,
-    attributeValues: Record<string, NativeAttributeValue>,
-  ): this {
-    if (this.condition) {
-      this.condition.expression += ` AND ${expression}`;
-      Object.assign(this.condition.attributeValues, attributeValues);
-    } else {
-      this.condition = { expression, attributeValues };
-    }
-    return this;
-  }
-
-  public async execute(): Promise<void> {
-    if (this.extraTransactItems.length > 0) {
-      // Build our update transaction item.
-      const myTransactItem = this.toTransactDelete();
-      // Combine with extra transaction items.
-      const allItems = [...this.extraTransactItems, myTransactItem];
-      await this.parent.getClient().send(
-        new TransactWriteCommand({
-          TransactItems: allItems,
-        }),
-      );
-      // After transaction, retrieve the updated item.
-      const result = await this.parent.get(this.key).execute();
-      if (result === null) {
-        throw new Error("Item not found after transaction delete");
-      }
-    } else {
-      const params: DeleteItemInput = {
-        TableName: this.parent.getTableName(),
-        Key: this.parent.buildKey(this.key),
-      };
-      if (this.condition) {
-        params.ConditionExpression = this.condition.expression;
-        params.ExpressionAttributeValues = this.condition.attributeValues;
-      }
-      await this.parent.getClient().send(new DeleteCommand(params));
-    }
-  }
-
-  public transactWrite(ops: TransactWriteItem[] | TransactWriteItem): this {
-    if (Array.isArray(ops)) {
-      this.extraTransactItems.push(...ops);
-    } else {
-      this.extraTransactItems.push(ops);
-    }
-    return this;
-  }
-
-  public toTransactDelete(): TransactWriteItem {
-    const deleteItem: DeleteItemInput = {
-      TableName: this.parent.getTableName(),
-      Key: this.parent.buildKey(this.key),
-    };
-    if (this.condition) {
-      deleteItem.ConditionExpression = this.condition.expression;
-      deleteItem.ExpressionAttributeValues = this.condition.attributeValues;
-    }
-    return { Delete: deleteItem };
-  }
-}

package/src/builders/get-builder.ts

@@ -1,78 +0,0 @@
-import { type BetterDDB } from "../betterddb.js";
-import { TransactGetCommand, GetCommand } from "@aws-sdk/lib-dynamodb";
-import {
-  type GetItemInput,
-  type TransactGetItem,
-} from "@aws-sdk/client-dynamodb";
-export class GetBuilder<T> {
-  private projectionExpression?: string;
-  private expressionAttributeNames: Record<string, string> = {};
-  private extraTransactItems: TransactGetItem[] = [];
-  constructor(
-    private parent: BetterDDB<T>,
-    private key: Partial<T>,
-  ) {}
-
-  /**
-   * Specify a projection by providing an array of attribute names.
-   */
-  public withProjection(attributes: (keyof T)[]): this {
-    this.projectionExpression = attributes
-      .map((attr) => `#${String(attr)}`)
-      .join(", ");
-    for (const attr of attributes) {
-      this.expressionAttributeNames[`#${String(attr)}`] = String(attr);
-    }
-    return this;
-  }
-
-  public async execute(): Promise<T | null> {
-    if (this.extraTransactItems.length > 0) {
-      // Build our update transaction item.
-      const myTransactItem = this.toTransactGet();
-      // Combine with extra transaction items.
-      const allItems = [...this.extraTransactItems, myTransactItem];
-      await this.parent.getClient().send(
-        new TransactGetCommand({
-          TransactItems: allItems,
-        }),
-      );
-      // After transaction, retrieve the updated item.
-      const result = await this.parent.get(this.key).execute();
-      return result;
-    } else {
-      const params: GetItemInput = {
-        TableName: this.parent.getTableName(),
-        Key: this.parent.buildKey(this.key),
-      };
-      if (this.projectionExpression) {
-        params.ProjectionExpression = this.projectionExpression;
-        params.ExpressionAttributeNames = this.expressionAttributeNames;
-      }
-      const result = await this.parent.getClient().send(new GetCommand(params));
-      if (!result.Item) return null;
-      return this.parent.getSchema().parse(result.Item) as T;
-    }
-  }
-
-  public transactGet(ops: TransactGetItem[] | TransactGetItem): this {
-    if (Array.isArray(ops)) {
-      this.extraTransactItems.push(...ops);
-    } else {
-      this.extraTransactItems.push(ops);
-    }
-    return this;
-  }
-
-  public toTransactGet(): TransactGetItem {
-    const getItem: GetItemInput = {
-      TableName: this.parent.getTableName(),
-      Key: this.parent.buildKey(this.key),
-    };
-    if (this.projectionExpression) {
-      getItem.ProjectionExpression = this.projectionExpression;
-      getItem.ExpressionAttributeNames = this.expressionAttributeNames;
-    }
-    return { Get: getItem };
-  }
-}

package/src/builders/query-builder.ts

@@ -1,242 +0,0 @@
-import {
-  type NativeAttributeValue,
-  QueryCommand,
-  type QueryCommandInput,
-} from "@aws-sdk/lib-dynamodb";
-import { type BetterDDB, type GSIConfig } from "../betterddb.js";
-import { getOperatorExpression, type Operator } from "../operator.js";
-import { type PaginatedResult } from "../types/paginated-result.js";
-
-export class QueryBuilder<T> {
-  private keyConditions: string[] = [];
-  private filterConditions: string[] = [];
-  private expressionAttributeNames: Record<string, string> = {};
-  private expressionAttributeValues: Record<string, NativeAttributeValue>;
-  private index?: GSIConfig<T>;
-  private limit?: number;
-  private lastKey?: Record<string, NativeAttributeValue>;
-  private ascending = true;
-
-  constructor(
-    private parent: BetterDDB<T>,
-    private key: Partial<T>,
-  ) {
-    const keys = this.parent.getKeys();
-    const pkName = keys.primary.name;
-    const builtKey = this.parent.buildKey(this.key);
-
-    this.expressionAttributeNames = {
-      "#pk": pkName,
-    };
-    this.expressionAttributeValues = {
-      ":pk_value": builtKey[pkName] as Record<string, NativeAttributeValue>,
-    };
-  }
-
-  public usingIndex(indexName: string): this {
-    if (!this.parent.getKeys().gsis) {
-      throw new Error("No global secondary indexes defined for this table");
-    }
-    if (!(indexName in this.parent.getKeys().gsis!)) {
-      throw new Error("index does not exist");
-    }
-
-    this.index = this.parent.getKeys().gsis![indexName];
-
-    if (!this.index) {
-      throw new Error("Failed to get index configuration");
-    }
-
-    const pkName = this.index.primary.name;
-    const builtKey = this.parent.buildIndexes(this.key);
-    this.expressionAttributeNames["#pk"] = pkName;
-    this.expressionAttributeValues[":pk_value"] = builtKey[pkName] as Record<
-      string,
-      NativeAttributeValue
-    >;
-
-    return this;
-  }
-
-  public sortAscending(): this {
-    this.ascending = true;
-    return this;
-  }
-
-  public sortDescending(): this {
-    this.ascending = false;
-    return this;
-  }
-
-  public where(
-    operator: Operator,
-    values: Partial<T> | [Partial<T>, Partial<T>],
-  ): this {
-    const keys = this.parent.getKeys();
-    // Determine the sort key name from either the index or the primary keys.
-    const sortKeyName = this.index ? this.index.sort?.name : keys.sort?.name;
-    if (!sortKeyName) {
-      throw new Error("Sort key is not defined for this table/index.");
-    }
-    const nameKey = "#sk";
-    this.expressionAttributeNames[nameKey] = sortKeyName;
-
-    // Enforce that a complex sort key requires an object input.
-    if (typeof values !== "object" || values === null) {
-      throw new Error(
-        `For complex sort keys, please provide an object with all necessary properties.`,
-      );
-    }
-
-    if (operator === "between") {
-      if (!Array.isArray(values) || values.length !== 2) {
-        throw new Error(
-          `For 'between' operator, values must be a tuple of two objects`,
-        );
-      }
-      const valueKeyStart = ":sk_start";
-      const valueKeyEnd = ":sk_end";
-      // Use the key definition's build function to build the key from the full object.
-      this.expressionAttributeValues[valueKeyStart] = this.index
-        ? (this.parent.buildIndexes(values[0])[sortKeyName] as Record<
-            string,
-            NativeAttributeValue
-          >)
-        : (this.parent.buildKey(values[0])[sortKeyName] as Record<
-            string,
-            NativeAttributeValue
-          >);
-      this.expressionAttributeValues[valueKeyEnd] = this.index
-        ? (this.parent.buildIndexes(values[1])[sortKeyName] as Record<
-            string,
-            NativeAttributeValue
-          >)
-        : (this.parent.buildKey(values[1])[sortKeyName] as Record<
-            string,
-            NativeAttributeValue
-          >);
-      this.keyConditions.push(
-        `${nameKey} BETWEEN ${valueKeyStart} AND ${valueKeyEnd}`,
-      );
-    } else if (operator === "begins_with") {
-      const valueKey = ":sk_value";
-      this.expressionAttributeValues[valueKey] = this.index
-        ? (this.parent.buildIndexes(values as Partial<T>)[
-            sortKeyName
-          ] as Record<string, NativeAttributeValue>)
-        : (this.parent.buildKey(values as Partial<T>)[sortKeyName] as Record<
-            string,
-            NativeAttributeValue
-          >);
-      this.keyConditions.push(`begins_with(${nameKey}, ${valueKey})`);
-    } else {
-      // For eq, lt, lte, gt, gte:
-      const valueKey = ":sk_value";
-      this.expressionAttributeValues[valueKey] = this.index
-        ? (this.parent.buildIndexes(values as Partial<T>)[
-            sortKeyName
-          ] as Record<string, NativeAttributeValue>)
-        : (this.parent.buildKey(values as Partial<T>)[sortKeyName] as Record<
-            string,
-            NativeAttributeValue
-          >);
-      const condition = getOperatorExpression(operator, nameKey, valueKey);
-      this.keyConditions.push(condition);
-    }
-    return this;
-  }
-
-  public filter(attribute: keyof T, operator: Operator, values: unknown): this {
-    const attrStr = String(attribute);
-    const randomString = Math.random().toString(36).substring(2, 15);
-    const placeholderName = `#attr_${attrStr}_${randomString}`;
-    this.expressionAttributeNames[placeholderName] = attrStr;
-    if (operator === "between") {
-      if (!Array.isArray(values) || values.length !== 2) {
-        throw new Error(
-          "For 'between' operator, values must be a tuple of two items",
-        );
-      }
-      const placeholderValueStart = `:val_start_${attrStr}_${randomString}`;
-      const placeholderValueEnd = `:val_end_${attrStr}_${randomString}`;
-      this.expressionAttributeValues[placeholderValueStart] =
-        values[0] as Record<string, NativeAttributeValue>;
-      this.expressionAttributeValues[placeholderValueEnd] = values[1] as Record<
-        string,
-        NativeAttributeValue
-      >;
-      this.filterConditions.push(
-        `${placeholderName} BETWEEN ${placeholderValueStart} AND ${placeholderValueEnd}`,
-      );
-    } else if (operator === "begins_with" || operator === "contains") {
-      const placeholderValue = `:val_${attrStr}_${randomString}`;
-      this.expressionAttributeValues[placeholderValue] = values as Record<
-        string,
-        NativeAttributeValue
-      >;
-      this.filterConditions.push(
-        `${operator}(${placeholderName}, ${placeholderValue})`,
-      );
-    } else {
-      const placeholderValue = `:val_${attrStr}_${randomString}`;
-      this.expressionAttributeValues[placeholderValue] = values as Record<
-        string,
-        NativeAttributeValue
-      >;
-      const condition = getOperatorExpression(
-        operator,
-        placeholderName,
-        placeholderValue,
-      );
-      this.filterConditions.push(condition);
-    }
-
-    return this;
-  }
-
-  public limitResults(limit: number): this {
-    this.limit = limit;
-    return this;
-  }
-
-  public startFrom(lastKey: Record<string, NativeAttributeValue>): this {
-    this.lastKey = lastKey;
-    return this;
-  }
-
-  /**
-   * Executes the query and returns a Promise that resolves with an array of items.
-   */
-  public async execute(): Promise<PaginatedResult<T>> {
-    this.keyConditions.unshift(`#pk = :pk_value`);
-    const keyConditionExpression = this.keyConditions.join(" AND ");
-
-    const params: QueryCommandInput = {
-      TableName: this.parent.getTableName(),
-      KeyConditionExpression: keyConditionExpression,
-      ExpressionAttributeNames: this.expressionAttributeNames,
-      ExpressionAttributeValues: this.expressionAttributeValues,
-      ScanIndexForward: this.ascending,
-      Limit: this.limit,
-      ExclusiveStartKey: this.lastKey,
-      IndexName: this.index?.name ?? undefined,
-    };
-
-    if (this.parent.getEntityType()) {
-      this.filterConditions.push(`#entity = :entity_value`);
-      this.expressionAttributeNames["#entity"] = "entityType";
-      this.expressionAttributeValues[":entity_value"] =
-        this.parent.getEntityType();
-    }
-    params.FilterExpression =
-      this.filterConditions.length > 0
-        ? this.filterConditions.join(" AND ")
-        : undefined;
-
-    const result = await this.parent.getClient().send(new QueryCommand(params));
-    return {
-      items: this.parent.getSchema().array().parse(result.Items) as T[],
-      lastKey: result.LastEvaluatedKey ?? undefined,
-    };
-  }
-}

package/src/builders/scan-builder.ts

@@ -1,98 +0,0 @@
-import {
-  ScanCommand,
-  type ScanCommandInput,
-  type NativeAttributeValue,
-} from "@aws-sdk/lib-dynamodb";
-import { type BetterDDB } from "../betterddb.js";
-import { getOperatorExpression, type Operator } from "../operator.js";
-import { type PaginatedResult } from "../types/paginated-result.js";
-
-export class ScanBuilder<T> {
-  private filters: string[] = [];
-  private expressionAttributeNames: Record<string, string> = {};
-  private expressionAttributeValues: Record<string, NativeAttributeValue> = {};
-  private limit?: number;
-  private lastKey?: Record<string, NativeAttributeValue>;
-
-  constructor(private parent: BetterDDB<T>) {}
-
-  public where(attribute: keyof T, operator: Operator, values: unknown): this {
-    const attrStr = String(attribute);
-    const nameKey = `#attr_${attrStr}`;
-    this.expressionAttributeNames[nameKey] = attrStr;
-    if (operator === "between") {
-      if (!Array.isArray(values) || values.length !== 2) {
-        throw new Error(
-          `For 'between' operator, values must be a tuple of two items`,
-        );
-      }
-      const valueKeyStart = `:val_start_${attrStr}`;
-      const valueKeyEnd = `:val_end_${attrStr}`;
-      this.expressionAttributeValues[valueKeyStart] = values[0] as Record<
-        string,
-        NativeAttributeValue
-      >;
-      this.expressionAttributeValues[valueKeyEnd] = values[1] as Record<
-        string,
-        NativeAttributeValue
-      >;
-      this.filters.push(
-        `${nameKey} BETWEEN ${valueKeyStart} AND ${valueKeyEnd}`,
-      );
-    } else if (operator === "begins_with" || operator === "contains") {
-      const valueKey = `:val_${attrStr}`;
-      this.expressionAttributeValues[valueKey] = values as Record<
-        string,
-        NativeAttributeValue
-      >;
-      this.filters.push(`${operator}(${nameKey}, ${valueKey})`);
-    } else {
-      const valueKey = `:val_${attrStr}`;
-      this.expressionAttributeValues[valueKey] = values as Record<
-        string,
-        NativeAttributeValue
-      >;
-      const condition = getOperatorExpression(operator, nameKey, valueKey);
-      this.filters.push(condition);
-    }
-    return this;
-  }
-
-  public limitResults(limit: number): this {
-    this.limit = limit;
-    return this;
-  }
-
-  public startFrom(lastKey: Record<string, NativeAttributeValue>): this {
-    this.lastKey = lastKey;
-    return this;
-  }
-
-  /**
-   * Executes the scan and returns a Promise that resolves with an array of items.
-   */
-  public async execute(): Promise<PaginatedResult<T>> {
-    const params: ScanCommandInput = {
-      TableName: this.parent.getTableName(),
-      ExpressionAttributeNames: this.expressionAttributeNames,
-      ExpressionAttributeValues: this.expressionAttributeValues,
-      Limit: this.limit,
-      ExclusiveStartKey: this.lastKey,
-    };
-
-    if (this.parent.getEntityType()) {
-      this.filters.push(`#entity = :entity_value`);
-      this.expressionAttributeNames["#entity"] = "entityType";
-      this.expressionAttributeValues[":entity_value"] =
-        this.parent.getEntityType();
-    }
-    params.FilterExpression = this.filters.join(" AND ");
-
-    const result = await this.parent.getClient().send(new ScanCommand(params));
-
-    return {
-      items: this.parent.getSchema().array().parse(result.Items) as T[],
-      lastKey: result.LastEvaluatedKey ?? undefined,
-    };
-  }
-}