@aurios/mizzle 1.1.2 → 1.1.3

package/src/builders/update.ts

@@ -1,5 +1,5 @@
 import { UpdateCommand } from "@aws-sdk/lib-dynamodb";
-import { ENTITY_SYMBOLS } from "@mizzle/shared";
+import { ENTITY_SYMBOLS } from "@repo/shared";
 import { Entity, type InferInsertModel } from "../core/table";
 import { Column } from "../core/column";
 import { type Expression } from "../expressions/operators";
@@ -9,209 +9,214 @@ import { calculateItemSize } from "../core/validation";
 import { ItemSizeExceededError } from "../core/errors";
 import { buildExpression } from "../expressions/builder";
 import { UpdateAction } from "../expressions/actions";
-import { 
-    createUpdateState, 
-    partitionUpdateValues, 
-    buildUpdateExpressionString 
+import {
+  createUpdateState,
+  partitionUpdateValues,
+  buildUpdateExpressionString,
 } from "../expressions/update-builder";
 
-export class UpdateBuilder<
-    TEntity extends Entity,
-    TResult = unknown,
-> extends BaseBuilder<TEntity, TResult> {
-    static readonly [ENTITY_SYMBOLS.ENTITY_KIND]: string = "UpdateBuilder";
-
-    private _state = createUpdateState();
-    private _whereClause?: Expression;
-    private _returnValues?: "NONE" | "ALL_OLD" | "UPDATED_OLD" | "ALL_NEW" | "UPDATED_NEW";
-    private _explicitKey?: Record<string, unknown>;
-
-    constructor(
-        entity: TEntity,
-        client: IMizzleClient,
-    ) {
-        super(entity, client);
+export class UpdateBuilder<TEntity extends Entity, TResult = unknown> extends BaseBuilder<
+  TEntity,
+  TResult
+> {
+  static readonly [ENTITY_SYMBOLS.ENTITY_KIND]: string = "UpdateBuilder";
+
+  private _state = createUpdateState();
+  private _whereClause?: Expression;
+  private _returnValues?: "NONE" | "ALL_OLD" | "UPDATED_OLD" | "ALL_NEW" | "UPDATED_NEW";
+  private _explicitKey?: Record<string, unknown>;
+
+  constructor(entity: TEntity, client: IMizzleClient) {
+    super(entity, client);
+  }
+
+  /**
+   * Manually specifies the primary key for the update operation.
+   *
+   * @param keyObject The raw DynamoDB key object (e.g., { pk: "USER#1", sk: "METADATA" }).
+   * @returns The current builder instance for chaining.
+   */
+  key(keyObject: Record<string, unknown>): this {
+    this._explicitKey = keyObject;
+    return this;
+  }
+
+  /**
+   * Sets specific attributes to new values.
+   * Translates to a `SET` action in the DynamoDB UpdateExpression.
+   *
+   * @example
+   * ```ts
+   * await db.update(users)
+   *   .set({ name: "Bob", age: 25 })
+   *   .where(eq(users.id, "1"))
+   *   .execute();
+   * ```
+   *
+   * @param values Object containing the fields and values to set.
+   * @returns The current builder instance for chaining.
+   */
+  set(
+    values: Partial<{
+      [K in keyof InferInsertModel<TEntity>]: InferInsertModel<TEntity>[K] | UpdateAction;
+    }>,
+  ): this {
+    partitionUpdateValues(
+      values as Record<string, unknown | UpdateAction>,
+      this._state,
+      this.entity[ENTITY_SYMBOLS.COLUMNS] as unknown as Record<string, Column>,
+    );
+    return this;
+  }
+
+  /**
+   * Adds a value to a numeric attribute or elements to a set.
+   * Translates to an `ADD` action in the DynamoDB UpdateExpression.
+   *
+   * @param values Object containing fields and values to add.
+   * @returns The current builder instance for chaining.
+   */
+  add(values: Partial<InferInsertModel<TEntity>>): this {
+    const columns = this.entity[ENTITY_SYMBOLS.COLUMNS] as unknown as Record<string, Column>;
+    for (const [key, val] of Object.entries(values)) {
+      const col = columns[key] as unknown as { mapToDynamoValue?: (v: unknown) => unknown };
+      this._state.add[key] =
+        col && typeof col.mapToDynamoValue === "function" ? col.mapToDynamoValue(val) : val;
     }
-
-    /**
-     * Manually specifies the primary key for the update operation.
-     * 
-     * @param keyObject The raw DynamoDB key object (e.g., { pk: "USER#1", sk: "METADATA" }).
-     * @returns The current builder instance for chaining.
-     */
-    key(keyObject: Record<string, unknown>): this {
-        this._explicitKey = keyObject;
-        return this;
+    return this;
+  }
+
+  /**
+   * Removes one or more attributes from the item.
+   * Translates to a `REMOVE` action in the DynamoDB UpdateExpression.
+   *
+   * @param fields The names of the fields to remove.
+   * @returns The current builder instance for chaining.
+   */
+  remove(...fields: (keyof InferInsertModel<TEntity> | (string & {}))[]): this {
+    this._state.remove.push(...(fields as string[]));
+    return this;
+  }
+
+  /**
+   * Deletes elements from a set.
+   * Translates to a `DELETE` action in the DynamoDB UpdateExpression.
+   *
+   * @param values Object containing fields and the values to delete from the set.
+   * @returns The current builder instance for chaining.
+   */
+  delete(values: Partial<InferInsertModel<TEntity>>): this {
+    const columns = this.entity[ENTITY_SYMBOLS.COLUMNS] as unknown as Record<string, Column>;
+    for (const [key, val] of Object.entries(values)) {
+      const col = columns[key] as unknown as { mapToDynamoValue?: (v: unknown) => unknown };
+      this._state.delete[key] =
+        col && typeof col.mapToDynamoValue === "function" ? col.mapToDynamoValue(val) : val;
     }
-
-    /**
-     * Sets specific attributes to new values. 
-     * Translates to a `SET` action in the DynamoDB UpdateExpression.
-     * 
-     * @example
-     * ```ts
-     * await db.update(users)
-     *   .set({ name: "Bob", age: 25 })
-     *   .where(eq(users.id, "1"))
-     *   .execute();
-     * ```
-     * 
-     * @param values Object containing the fields and values to set.
-     * @returns The current builder instance for chaining.
-     */
-    set(values: Partial<{ [K in keyof InferInsertModel<TEntity>]: InferInsertModel<TEntity>[K] | UpdateAction }>): this {
-        partitionUpdateValues(values as Record<string, unknown | UpdateAction>, this._state, this.entity[ENTITY_SYMBOLS.COLUMNS] as unknown as Record<string, Column>);
-        return this;
+    return this;
+  }
+
+  /**
+   * Adds a condition to the update operation.
+   *
+   * @param expression The condition expression.
+   * @returns The current builder instance for chaining.
+   */
+  where(expression: Expression): this {
+    this._whereClause = expression;
+    return this;
+  }
+
+  /**
+   * Configures what values should be returned after the update.
+   *
+   * @param value One of: "NONE", "ALL_OLD", "UPDATED_OLD", "ALL_NEW", "UPDATED_NEW".
+   * @returns The current builder instance for chaining.
+   */
+  returning(value: "NONE" | "ALL_OLD" | "UPDATED_OLD" | "ALL_NEW" | "UPDATED_NEW"): this {
+    this._returnValues = value;
+    return this;
+  }
+
+  /** @internal */
+  get state() {
+    return this._state;
+  }
+
+  /** @internal */
+  get whereClause() {
+    return this._whereClause;
+  }
+
+  /** @internal */
+  public override createExpressionContext(prefix = "") {
+    return super.createExpressionContext(prefix);
+  }
+
+  /**
+   * Executes the update operation.
+   *
+   * @returns A promise that resolves to the requested attributes (based on `.returning()`).
+   * @throws {ItemSizeExceededError} if the update exceeds 400KB.
+   */
+  public override async execute(): Promise<TResult> {
+    const columns = this.entity[ENTITY_SYMBOLS.COLUMNS] as unknown as Record<string, Column>;
+    for (const [key, col] of Object.entries(columns)) {
+      const column = col as unknown as {
+        onUpdateFn?: () => unknown;
+        mapToDynamoValue?: (v: unknown) => unknown;
+      };
+      if (column.onUpdateFn && !this._state.set[key] && !this._state.remove.includes(key)) {
+        const val = column.onUpdateFn();
+        this._state.set[key] = {
+          value: typeof column.mapToDynamoValue === "function" ? column.mapToDynamoValue(val) : val,
+        };
+      }
     }
 
-    /**
-     * Adds a value to a numeric attribute or elements to a set.
-     * Translates to an `ADD` action in the DynamoDB UpdateExpression.
-     * 
-     * @param values Object containing fields and values to add.
-     * @returns The current builder instance for chaining.
-     */
-    add(values: Partial<InferInsertModel<TEntity>>): this {
-        const columns = this.entity[ENTITY_SYMBOLS.COLUMNS] as unknown as Record<string, Column>;
-        for (const [key, val] of Object.entries(values)) {
-            const col = columns[key] as unknown as { mapToDynamoValue?: (v: unknown) => unknown };
-            this._state.add[key] = (col && typeof col.mapToDynamoValue === "function") 
-                ? col.mapToDynamoValue(val) 
-                : val;
-        }
-        return this;
-    }
+    const keys = this.resolveUpdateKeys();
 
-    /**
-     * Removes one or more attributes from the item.
-     * Translates to a `REMOVE` action in the DynamoDB UpdateExpression.
-     * 
-     * @param fields The names of the fields to remove.
-     * @returns The current builder instance for chaining.
-     */
-    remove(...fields: (keyof InferInsertModel<TEntity> | (string & {}))[]): this {
-        this._state.remove.push(...(fields as string[]));
-        return this;
-    }
+    const { expressionAttributeNames, expressionAttributeValues, addName, addValue } =
+      this.createExpressionContext("up_");
 
-    /**
-     * Deletes elements from a set.
-     * Translates to a `DELETE` action in the DynamoDB UpdateExpression.
-     * 
-     * @param values Object containing fields and the values to delete from the set.
-     * @returns The current builder instance for chaining.
-     */
-    delete(values: Partial<InferInsertModel<TEntity>>): this {
-        const columns = this.entity[ENTITY_SYMBOLS.COLUMNS] as unknown as Record<string, Column>;
-        for (const [key, val] of Object.entries(values)) {
-            const col = columns[key] as unknown as { mapToDynamoValue?: (v: unknown) => unknown };
-            this._state.delete[key] = (col && typeof col.mapToDynamoValue === "function") 
-                ? col.mapToDynamoValue(val) 
-                : val;
-        }
-        return this;
-    }
-
-    /**
-     * Adds a condition to the update operation.
-     * 
-     * @param expression The condition expression.
-     * @returns The current builder instance for chaining.
-     */
-    where(expression: Expression): this {
-        this._whereClause = expression;
-        return this;
-    }
+    const updateExpression = buildUpdateExpressionString(this._state, addName, addValue);
 
-    /**
-     * Configures what values should be returned after the update.
-     * 
-     * @param value One of: "NONE", "ALL_OLD", "UPDATED_OLD", "ALL_NEW", "UPDATED_NEW".
-     * @returns The current builder instance for chaining.
-     */
-    returning(value: "NONE" | "ALL_OLD" | "UPDATED_OLD" | "ALL_NEW" | "UPDATED_NEW"): this {
-        this._returnValues = value;
-        return this;
+    let conditionExpression: string | undefined;
+    if (this._whereClause) {
+      conditionExpression = buildExpression(this._whereClause, addName, addValue);
     }
 
-    /** @internal */
-    get state() {
-        return this._state;
+    // Estimate size for Update
+    // Update size is basically keys + attribute values.
+    const size = calculateItemSize({ ...keys, ...expressionAttributeValues });
+    if (size > 400 * 1024) {
+      throw new ItemSizeExceededError(
+        `Estimated update size of ${Math.round(size / 1024)}KB exceeds the 400KB limit.`,
+      );
     }
 
-    /** @internal */
-    get whereClause() {
-        return this._whereClause;
+    const command = new UpdateCommand({
+      TableName: this.tableName,
+      Key: keys,
+      UpdateExpression: updateExpression,
+      ConditionExpression: conditionExpression,
+      ExpressionAttributeNames:
+        Object.keys(expressionAttributeNames).length > 0 ? expressionAttributeNames : undefined,
+      ExpressionAttributeValues:
+        Object.keys(expressionAttributeValues).length > 0 ? expressionAttributeValues : undefined,
+      ReturnValues: this._returnValues,
+    });
+
+    const response = (await this.client.send(command)) as any;
+    return response.Attributes as TResult;
+  }
+
+  /** @internal */
+  public resolveUpdateKeys(): Record<string, unknown> {
+    if (this._explicitKey) {
+      return this._explicitKey;
     }
 
-    /** @internal */
-    public override createExpressionContext(prefix = "") {
-        return super.createExpressionContext(prefix);
-    }
-
-    /**
-     * Executes the update operation.
-     * 
-     * @returns A promise that resolves to the requested attributes (based on `.returning()`).
-     * @throws {ItemSizeExceededError} if the update exceeds 400KB.
-     */
-    public override async execute(): Promise<TResult> {
-        const columns = this.entity[ENTITY_SYMBOLS.COLUMNS] as unknown as Record<string, Column>;
-        for (const [key, col] of Object.entries(columns)) {
-            const column = col as unknown as { onUpdateFn?: () => unknown, mapToDynamoValue?: (v: unknown) => unknown };
-            if (column.onUpdateFn && !this._state.set[key] && !this._state.remove.includes(key)) {
-                const val = column.onUpdateFn();
-                this._state.set[key] = { 
-                    value: typeof column.mapToDynamoValue === "function" ? column.mapToDynamoValue(val) : val 
-                };
-            }
-        }
-
-        const keys = this.resolveUpdateKeys();
-
-        const { expressionAttributeNames, expressionAttributeValues, addName, addValue } = this.createExpressionContext("up_");
-
-        const updateExpression = buildUpdateExpressionString(this._state, addName, addValue);
-        
-        let conditionExpression: string | undefined;
-        if (this._whereClause) {
-            conditionExpression = buildExpression(this._whereClause, addName, addValue);
-        }
-
-        // Estimate size for Update
-        // Update size is basically keys + attribute values.
-        const size = calculateItemSize({ ...keys, ...expressionAttributeValues });
-        if (size > 400 * 1024) {
-            throw new ItemSizeExceededError(`Estimated update size of ${Math.round(size / 1024)}KB exceeds the 400KB limit.`);
-        }
-
-        const command = new UpdateCommand({
-            TableName: this.tableName,
-            Key: keys,
-            UpdateExpression: updateExpression,
-            ConditionExpression: conditionExpression,
-            ExpressionAttributeNames:
-                Object.keys(expressionAttributeNames).length > 0
-                    ? expressionAttributeNames
-                    : undefined,
-            ExpressionAttributeValues:
-                Object.keys(expressionAttributeValues).length > 0
-                    ? expressionAttributeValues
-                    : undefined,
-            ReturnValues: this._returnValues,
-        });
-
-        const response = await this.client.send(command) as any;
-        return response.Attributes as TResult;
-    }
-
-    /** @internal */
-    public resolveUpdateKeys(): Record<string, unknown> {
-        if (this._explicitKey) {
-            return this._explicitKey;
-        }
-
-        const resolved = this.resolveKeys(this._whereClause);
-        return resolved.keys;
-    }
-}
+    const resolved = this.resolveKeys(this._whereClause);
+    return resolved.keys;
+  }
+}

package/src/columns/binary-set.ts

@@ -1,64 +1,55 @@
+import { Column, type ColumnBaseConfig } from "../core/column";
 import {
-    Column,
-    type ColumnBaseConfig,
-} from "../core/column";
-import {
-    ColumnBuider,
-    type ColumnBuilderBaseConfig,
-    type MakeColumnConfig,
+  ColumnBuider,
+  type ColumnBuilderBaseConfig,
+  type MakeColumnConfig,
 } from "../core/column-builder";
 import type { AnyTable } from "../core/table";
 
-export type BinarySetColumnInitial<TName extends string> =
-    BinarySetColumnBuilder<{
-        name: TName;
-        dataType: "binarySet";
-        columnType: "BS";
-        data: Set<Uint8Array>;
-    }>;
+export type BinarySetColumnInitial<TName extends string> = BinarySetColumnBuilder<{
+  name: TName;
+  dataType: "binarySet";
+  columnType: "BS";
+  data: Set<Uint8Array>;
+}>;
 
 export class BinarySetColumnBuilder<
-    T extends ColumnBuilderBaseConfig<"binarySet", "BS">,
+  T extends ColumnBuilderBaseConfig<"binarySet", "BS">,
 > extends ColumnBuider<T> {
-    constructor(name: T["name"]) {
-        super(name, "binarySet", "BS");
-    }
+  constructor(name: T["name"]) {
+    super(name, "binarySet", "BS");
+  }
 
-    override build<TTableName extends string>(
-        table: AnyTable,
-    ): BinarySetColumn<MakeColumnConfig<T, TTableName>> {
-        return new BinarySetColumn<MakeColumnConfig<T, TTableName>>(
-            table,
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            this.config as any,
-        );
-    }
+  override build<TTableName extends string>(
+    table: AnyTable,
+  ): BinarySetColumn<MakeColumnConfig<T, TTableName>> {
+    return new BinarySetColumn<MakeColumnConfig<T, TTableName>>(
+      table,
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      this.config as any,
+    );
+  }
 }
 
-export class BinarySetColumn<
-    T extends ColumnBaseConfig<"binarySet", "BS">,
-> extends Column<T> {
-}
+export class BinarySetColumn<T extends ColumnBaseConfig<"binarySet", "BS">> extends Column<T> {}
 
 export function binarySet(): BinarySetColumnInitial<"">;
-export function binarySet<TName extends string>(
-    name: TName,
-): BinarySetColumnInitial<TName>;
+export function binarySet<TName extends string>(name: TName): BinarySetColumnInitial<TName>;
 /**
  * Defines a Binary Set column ("BS") in DynamoDB.
- * 
+ *
  * Represents a set of unique binary blobs (Uint8Array/Buffer).
- * 
+ *
  * @example
  * ```ts
  * const data = defineTable("data", {
  *   hashes: binarySet("hashes"),
  * });
  * ```
- * 
+ *
  * @param name The name of the attribute in DynamoDB. If omitted, it will use the property name in the definition object.
  * @returns A BinarySetColumnBuilder instance.
  */
 export function binarySet(name?: string) {
-    return new BinarySetColumnBuilder(name ?? "");
+  return new BinarySetColumnBuilder(name ?? "");
 }

package/src/columns/binary.ts

@@ -1,64 +1,54 @@
+import { Column, type ColumnBaseConfig } from "../core/column";
 import {
-    Column,
-    type ColumnBaseConfig,
-} from "../core/column";
-import {
-    ColumnBuider,
-    type ColumnBuilderBaseConfig,
-    type MakeColumnConfig,
+  ColumnBuider,
+  type ColumnBuilderBaseConfig,
+  type MakeColumnConfig,
 } from "../core/column-builder";
 import type { AnyTable } from "../core/table";
 
 export type BinaryBuilderInitial<TName extends string> = BinaryColumnBuilder<{
-    name: TName;
-    dataType: "binary";
-    columnType: "B";
-    data: Buffer;
+  name: TName;
+  dataType: "binary";
+  columnType: "B";
+  data: Buffer;
 }>;
 
 export class BinaryColumnBuilder<
-    T extends ColumnBuilderBaseConfig<"binary", "B">,
+  T extends ColumnBuilderBaseConfig<"binary", "B">,
 > extends ColumnBuider<T> {
-    constructor(name: T["name"]) {
-        super(name, "binary", "B");
-    }
+  constructor(name: T["name"]) {
+    super(name, "binary", "B");
+  }
 
-    build<TTableName extends string>(
-        table: AnyTable,
-    ): BinaryColumn<MakeColumnConfig<T, TTableName>> {
-        return new BinaryColumn<MakeColumnConfig<T, TTableName>>(
-            table,
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            this.config as any,
-        );
-    }
+  build<TTableName extends string>(table: AnyTable): BinaryColumn<MakeColumnConfig<T, TTableName>> {
+    return new BinaryColumn<MakeColumnConfig<T, TTableName>>(
+      table,
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      this.config as any,
+    );
+  }
 }
 
-export class BinaryColumn<
-    T extends ColumnBaseConfig<"binary", "B">,
-> extends Column<T> {
-}
+export class BinaryColumn<T extends ColumnBaseConfig<"binary", "B">> extends Column<T> {}
 
 export function binary(): BinaryBuilderInitial<"">;
-export function binary<TName extends string>(
-    name: TName,
-): BinaryBuilderInitial<TName>;
+export function binary<TName extends string>(name: TName): BinaryBuilderInitial<TName>;
 /**
  * Defines a Binary column ("B") in DynamoDB.
- * 
+ *
  * Used for storing arbitrary binary data, such as images, compressed files, or raw bytes.
  * Mizzle handles `Uint8Array` or `Buffer` (in Node) for this type.
- * 
+ *
  * @example
  * ```ts
  * const files = defineTable("files", {
  *   content: binary("content"),
  * });
  * ```
- * 
+ *
  * @param name The name of the attribute in DynamoDB. If omitted, it will use the property name in the definition object.
  * @returns A BinaryColumnBuilder instance.
  */
 export function binary(name?: string) {
-    return new BinaryColumnBuilder(name ?? "");
+  return new BinaryColumnBuilder(name ?? "");
 }