sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ DynamoDB/ PutItem.ts

import * as DynamoDB from "@distilled.cloud/aws/dynamodb";
import * as Binding from "alchemy/Binding";
import * as Effect from "effect/Effect";
import type { Table } from "./Table.ts";

export interface PutItemRequest extends Omit<DynamoDB.PutItemInput, "TableName"> {}

/**
 * Runtime binding for `dynamodb:PutItem`.
 *
 * Bind this operation to a `Table` inside a function runtime to get a callable
 * that writes a single item, automatically injecting the table name and
 * granting the host `dynamodb:PutItem` on the table. Provide the `PutItemHttp`
 * layer on the Function to satisfy the binding.
 * ### Writing Data
 * **Example:** Write a Single Item
 * ```typescript
 * // inside the Function's Effect.gen, with Effect.provide(DynamoDB.PutItemHttp)
 * const putItem = yield* AWS.DynamoDB.PutItem(table);
 *
 * yield* putItem({
 *   Item: {
 *     pk: { S: "user#123" },
 *     sk: { S: "profile" },
 *     name: { S: "Alice" },
 *   },
 * });
 * ```
 *
 * @binding
 */
export interface PutItem extends Binding.Service<
  PutItem,
  "AWS.DynamoDB.PutItem",
  <T extends Table>(
    table: T,
  ) => Effect.Effect<
    (request: PutItemRequest) => Effect.Effect<DynamoDB.PutItemOutput, DynamoDB.PutItemError>
  >
> {}

export const PutItem = Binding.Service<PutItem>("AWS.DynamoDB.PutItem");