effect 4.0.0-beta.101 → 4.0.0-beta.103

package/src/unstable/sql/SqlModel.ts

@@ -27,7 +27,7 @@ import * as SqlSchema from "./SqlSchema.ts"
  * supplied, reads ignore soft-deleted rows and delete updates that column
  * instead of removing the row.
  *
- * @category repository
+ * @category constructors
  * @since 4.0.0
  */
 export const makeRepository = <
@@ -224,7 +224,7 @@ select * from ${sql(options.tableName)} where ${withSoftDeleteFilter(sql`${sql(i
  * Creates batched request resolvers for a schema model's insert, insert-void,
  * find-by-id, and delete operations, honoring the optional soft-delete column.
  *
- * @category repository
+ * @category constructors
  * @since 4.0.0
  */
 export const makeResolvers = <

package/src/unstable/sql/SqlResolver.ts

@@ -29,7 +29,7 @@ import { ResultLengthMismatch } from "./SqlError.ts"
  * Request type used by SQL request resolvers, carrying the input payload
  * together with the resolver's result, error, and environment types.
  *
- * @category requests
+ * @category models
  * @since 4.0.0
  */
 export interface SqlRequest<In, A, E, R> extends Request.Request<A, E | Schema.SchemaError, R> {
@@ -53,7 +53,7 @@ const SqlRequestProto = {
  * Runs a payload as a `SqlRequest` through a request resolver, either directly
  * with a payload and resolver or curried by resolver.
  *
- * @category requests
+ * @category running
  * @since 4.0.0
  */
 export const request: {
@@ -61,7 +61,7 @@ export const request: {
    * Runs a payload as a `SqlRequest` through a request resolver, either directly
    * with a payload and resolver or curried by resolver.
    *
-   * @category requests
+   * @category running
    * @since 4.0.0
    */
   <In, A, E, R>(resolver: RequestResolver.RequestResolver<SqlRequest<In, A, E, R>>): (payload: In) => Effect.Effect<A, E | Schema.SchemaError, R>
@@ -69,7 +69,7 @@ export const request: {
    * Runs a payload as a `SqlRequest` through a request resolver, either directly
    * with a payload and resolver or curried by resolver.
    *
-   * @category requests
+   * @category running
    * @since 4.0.0
    */
   <In, A, E, R>(
@@ -88,7 +88,7 @@ export const request: {
  * Constructs a `SqlRequest` from a payload. Equality and hashing are based on
  * the payload so equal requests can be batched and deduplicated.
  *
- * @category requests
+ * @category constructors
  * @since 4.0.0
  */
 export const SqlRequest = <In, A, E, R>(payload: In): SqlRequest<In, A, E, R> => {

package/src/unstable/sql/Statement.ts

@@ -17,6 +17,7 @@ import * as Effectable from "../../Effectable.ts"
 import type * as Fiber from "../../Fiber.ts"
 import { constUndefined } from "../../Function.ts"
 import * as internalEffect from "../../internal/effect.ts"
+import * as InternalRecord from "../../internal/record.ts"
 import { hasProperty } from "../../Predicate.ts"
 import { TracerTimingEnabled } from "../../References.ts"
 import * as Stream from "../../Stream.ts"
@@ -98,7 +99,7 @@ export type Transformer = (
  * Context reference for an optional current SQL statement transformer applied
  * before statement execution.
  *
- * @category transformer
+ * @category services
  * @since 4.0.0
  */
 export const CurrentTransformer = Context.Reference<Transformer | undefined>("effect/sql/CurrentTransformer", {
@@ -751,7 +752,7 @@ const emptyFragment = fragment([literal("")])
  * Dialect-specific compiler that converts a SQL `Fragment` into SQL text and
  * bind parameters, with a no-transform variant.
  *
- * @category compiler
+ * @category models
  * @since 4.0.0
  */
 export interface Compiler {
@@ -767,7 +768,7 @@ export interface Compiler {
  * Callbacks used by `makeCompiler` to render dialect placeholders,
  * identifiers, insert helpers, update helpers, and custom SQL segments.
  *
- * @category compiler
+ * @category models
  * @since 4.0.0
  */
 export type CompilerOptions<C extends Custom<any, any, any, any> = any> = {
@@ -802,7 +803,7 @@ export type CompilerOptions<C extends Custom<any, any, any, any> = any> = {
 /**
  * Creates a dialect-specific SQL `Compiler` from rendering callbacks.
  *
- * @category compiler
+ * @category constructors
  * @since 4.0.0
  */
 export const makeCompiler = <C extends Custom<any, any, any, any> = any>(
@@ -1062,7 +1063,7 @@ const CompilerProto = {
  * Creates a SQLite compiler that uses `?` placeholders and quoted identifiers,
  * optionally transforming identifier names before escaping.
  *
- * @category compiler
+ * @category constructors
  * @since 4.0.0
  */
 export const makeCompilerSqlite = (transform?: ((_: string) => string) | undefined): Compiler =>
@@ -1105,7 +1106,7 @@ export function defaultEscape(c: string) {
  * Classifies a JavaScript value as a SQL primitive kind, treating `undefined`
  * as `null` and defaulting unrecognized objects to `string`.
  *
- * @category predicates
+ * @category converting
  * @since 4.0.0
  */
 export const primitiveKind = (value: unknown): PrimitiveKind => {
@@ -1160,8 +1161,8 @@ export const defaultTransforms = (
 
   const transformObject = (obj: Record<string, any>): any => {
     const newObj: Record<string, any> = {}
-    for (const key in obj) {
-      newObj[transformer(key)] = transformValue(obj[key])
+    for (const key of Object.keys(obj)) {
+      InternalRecord.assignProperty(newObj, transformer(key), transformValue(obj[key]))
     }
     return newObj
   }
@@ -1176,8 +1177,8 @@ export const defaultTransforms = (
         newRows[i] = transformArrayNested(row) as any
       } else {
         const obj: any = {}
-        for (const key in row) {
-          obj[transformer(key)] = transformValue(row[key])
+        for (const [key, value] of Object.entries(row)) {
+          InternalRecord.assignProperty(obj, transformer(key), transformValue(value))
         }
         newRows[i] = obj
       }
@@ -1195,8 +1196,8 @@ export const defaultTransforms = (
         newRows[i] = transformArray(row) as any
       } else {
         const obj: any = {}
-        for (const key in row) {
-          obj[transformer(key)] = row[key]
+        for (const [key, value] of Object.entries(row)) {
+          InternalRecord.assignProperty(obj, transformer(key), value)
         }
         newRows[i] = obj
       }
@@ -1267,23 +1268,6 @@ const StatementProto: Omit<
   StatementImpl<any>,
   "segments" | "acquirer" | "compiler" | "spanAttributes" | "transformRows"
 > = {
-  ...Effectable.Prototype<StatementImpl<any>>({
-    label: "Statement",
-    evaluate(fiber) {
-      const span = internalEffect.makeSpanUnsafe(fiber, "sql.execute", { kind: "client" })
-      const clock = fiber.getRef(Clock)
-      const timingEnabled = fiber.getRef(TracerTimingEnabled)
-      return Effect.onExit(
-        this.withConnectionSpan(
-          "execute",
-          (connection, sql, params) => connection.execute(sql, params, this.transformRows),
-          false,
-          span
-        ),
-        (exit) => internalEffect.endSpan(span, exit, clock, timingEnabled)
-      )
-    }
-  }),
   [FragmentTypeId]: FragmentTypeId,
   withConnection<XA, E>(
     this: StatementImpl<any>,
@@ -1387,6 +1371,24 @@ const StatementProto: Omit<
     )
   },
 
+  ...Effectable.Prototype<StatementImpl<any>>({
+    label: "Statement",
+    evaluate(fiber) {
+      const span = internalEffect.makeSpanUnsafe(fiber, "sql.execute", { kind: "client" })
+      const clock = fiber.getRef(Clock)
+      const timingEnabled = fiber.getRef(TracerTimingEnabled)
+      return Effect.onExit(
+        this.withConnectionSpan(
+          "execute",
+          (connection, sql, params) => connection.execute(sql, params, this.transformRows),
+          false,
+          span
+        ),
+        (exit) => internalEffect.endSpan(span, exit, clock, timingEnabled)
+      )
+    }
+  }),
+
   compile(
     this: StatementImpl<any>,
     withoutTransform?: boolean | undefined

package/src/unstable/workers/Transferable.ts

@@ -20,7 +20,7 @@ import * as SchemaGetter from "../../SchemaGetter.ts"
  * Service for collecting `Transferable` objects while encoding worker messages
  * so they can be passed to `postMessage` transfer lists.
  *
- * @category models
+ * @category services
  * @since 4.0.0
  */
 export class Collector extends Context.Service<Collector, {

package/src/unstable/workers/Worker.ts

@@ -23,7 +23,7 @@ import { WorkerError, WorkerSendError } from "./WorkerError.ts"
  * Service that spawns effect `Worker` instances for numeric worker ids using
  * the configured `Spawner`.
  *
- * @category models
+ * @category services
  * @since 4.0.0
  */
 export class WorkerPlatform extends Context.Service<WorkerPlatform, {
@@ -60,7 +60,7 @@ export interface Worker<O = unknown, I = unknown> {
  * platform ready/data messages and running the optional `onSpawn` effect when
  * the worker reports readiness.
  *
- * @category models
+ * @category constructors
  * @since 4.0.0
  */
 export const makeUnsafe = (options: {

package/src/unstable/workers/WorkerError.ts

@@ -31,7 +31,7 @@ export const isWorkerError = (u: unknown): u is WorkerError => hasProperty(u, Ty
 /**
  * Worker error reason for failures while spawning or setting up a worker.
  *
- * @category models
+ * @category errors
  * @since 4.0.0
  */
 export class WorkerSpawnError extends Schema.ErrorClass<WorkerSpawnError>(
@@ -45,7 +45,7 @@ export class WorkerSpawnError extends Schema.ErrorClass<WorkerSpawnError>(
 /**
  * Worker error reason for failures while sending a message to a worker.
  *
- * @category models
+ * @category errors
  * @since 4.0.0
  */
 export class WorkerSendError extends Schema.ErrorClass<WorkerSendError>(
@@ -60,7 +60,7 @@ export class WorkerSendError extends Schema.ErrorClass<WorkerSendError>(
  * Worker error reason for failures while receiving or handling a message from a
  * worker.
  *
- * @category models
+ * @category errors
  * @since 4.0.0
  */
 export class WorkerReceiveError extends Schema.ErrorClass<WorkerReceiveError>(
@@ -74,7 +74,7 @@ export class WorkerReceiveError extends Schema.ErrorClass<WorkerReceiveError>(
 /**
  * Worker error reason for an unclassified worker failure.
  *
- * @category models
+ * @category errors
  * @since 4.0.0
  */
 export class WorkerUnknownError extends Schema.ErrorClass<WorkerUnknownError>(
@@ -88,7 +88,7 @@ export class WorkerUnknownError extends Schema.ErrorClass<WorkerUnknownError>(
 /**
  * Union of the specific failure reasons that can be wrapped by a `WorkerError`.
  *
- * @category models
+ * @category errors
  * @since 4.0.0
  */
 export type WorkerErrorReason =
@@ -100,7 +100,7 @@ export type WorkerErrorReason =
 /**
  * Schema for decoding and encoding all supported worker error reason variants.
  *
- * @category models
+ * @category schemas
  * @since 4.0.0
  */
 export const WorkerErrorReason: Schema.Union<[
@@ -119,7 +119,7 @@ export const WorkerErrorReason: Schema.Union<[
  * Error raised by worker APIs, wrapping a specific `WorkerErrorReason` and
  * exposing its message and cause.
  *
- * @category models
+ * @category errors
  * @since 4.0.0
  */
 export class WorkerError extends Schema.ErrorClass<WorkerError>(TypeId)({

package/src/unstable/workers/WorkerRunner.ts

@@ -49,7 +49,7 @@ export type PlatformMessage<I> = readonly [request: 0, I] | readonly [close: 1]
 /**
  * Context service that starts a platform-specific `WorkerRunner`.
  *
- * @category models
+ * @category services
  * @since 4.0.0
  */
 export class WorkerRunnerPlatform extends Context.Service<WorkerRunnerPlatform, {

package/src/unstable/workflow/Activity.ts

@@ -237,7 +237,7 @@ export const retry: {
  * Context reference containing the current activity retry attempt, defaulting
  * to `1`.
  *
- * @category Attempts
+ * @category services
  * @since 4.0.0
  */
 export const CurrentAttempt = Context.Reference<number>(
@@ -249,7 +249,7 @@ export const CurrentAttempt = Context.Reference<number>(
  * Computes a deterministic activity idempotency key from the current workflow
  * execution ID, the supplied name, and optionally the current attempt.
  *
- * @category Idempotency
+ * @category idempotency
  * @since 4.0.0
  */
 export const idempotencyKey: (

package/src/unstable/workflow/DurableClock.ts

@@ -64,7 +64,7 @@ const InstanceTag = Context.Service<
  * Waits inside a workflow, using an in-memory activity for durations at or
  * below the threshold and scheduling a durable clock for longer durations.
  *
- * @category sleeping
+ * @category delays & timeouts
  * @since 4.0.0
  */
 export const sleep: (

package/src/unstable/workflow/DurableDeferred.ts

@@ -321,7 +321,7 @@ export type TokenTypeId = typeof TokenTypeId
  * Branded string token identifying a durable deferred for a workflow
  * execution.
  *
- * @category token
+ * @category models
  * @since 4.0.0
  */
 export type Token = Brand.Branded<string, TokenTypeId>
@@ -329,7 +329,7 @@ export type Token = Brand.Branded<string, TokenTypeId>
 /**
  * Schema for branded durable deferred tokens.
  *
- * @category token
+ * @category schemas
  * @since 4.0.0
  */
 export const Token: Schema.brand<Schema.String, TokenTypeId> = Schema.String.pipe(Schema.brand(TokenTypeId))
@@ -338,7 +338,7 @@ export const Token: Schema.brand<Schema.String, TokenTypeId> = Schema.String.pip
  * Schema for a decoded durable deferred token containing the workflow
  * name, execution ID, and deferred name.
  *
- * @category token
+ * @category schemas
  * @since 4.0.0
  */
 export class TokenParsed extends Schema.Class<TokenParsed>(
@@ -413,7 +413,7 @@ export class TokenParsed extends Schema.Class<TokenParsed>(
  * Creates a token for a durable deferred using the current workflow instance's
  * workflow name and execution ID.
  *
- * @category token
+ * @category constructors
  * @since 4.0.0
  */
 export const token: <Success extends Schema.Constraint, Error extends Schema.Constraint>(
@@ -431,7 +431,7 @@ export const token: <Success extends Schema.Constraint, Error extends Schema.Con
  * Creates a durable deferred token from an explicit workflow, execution ID,
  * and deferred name.
  *
- * @category token
+ * @category constructors
  * @since 4.0.0
  */
 export const tokenFromExecutionId: {
@@ -439,7 +439,7 @@ export const tokenFromExecutionId: {
    * Creates a durable deferred token from an explicit workflow, execution ID,
    * and deferred name.
    *
-   * @category token
+   * @category constructors
    * @since 4.0.0
    */
   (
@@ -454,7 +454,7 @@ export const tokenFromExecutionId: {
    * Creates a durable deferred token from an explicit workflow, execution ID,
    * and deferred name.
    *
-   * @category token
+   * @category constructors
    * @since 4.0.0
    */
   <Success extends Schema.Constraint, Error extends Schema.Constraint>(
@@ -481,7 +481,7 @@ export const tokenFromExecutionId: {
  * Creates a durable deferred token by deriving the workflow execution ID from
  * the supplied workflow payload.
  *
- * @category token
+ * @category constructors
  * @since 4.0.0
  */
 export const tokenFromPayload: {
@@ -489,7 +489,7 @@ export const tokenFromPayload: {
    * Creates a durable deferred token by deriving the workflow execution ID from
    * the supplied workflow payload.
    *
-   * @category token
+   * @category constructors
    * @since 4.0.0
    */
   <W extends Workflow.Any>(
@@ -504,7 +504,7 @@ export const tokenFromPayload: {
    * Creates a durable deferred token by deriving the workflow execution ID from
    * the supplied workflow payload.
    *
-   * @category token
+   * @category constructors
    * @since 4.0.0
    */
   <

package/src/unstable/workflow/DurableQueue.ts

@@ -61,8 +61,8 @@ export interface DurableQueue<
  *
  * **Example** (Defining a durable queue with workers)
  *
- * ```ts
- * import { Effect, Schema } from "effect"
+ * ```ts import.meta.vitest
+ * import { Effect, Layer, Schema } from "effect"
  * import { DurableQueue, Workflow } from "effect/unstable/workflow"
  *
  * // Define a DurableQueue that can be used to derive workers and offer items for
@@ -88,25 +88,27 @@ export interface DurableQueue<
  *
  * const MyWorkflowLayer = MyWorkflow.toLayer(
  *   Effect.fnUntraced(function*() {
- *     // Add an item to the DurableQueue defined above.
- *     //
- *     // When the worker has finished processing the item, the workflow will
- *     // resume.
- *     //
+ *     // The workflow suspends until a worker completes this queue item.
  *     yield* DurableQueue.process(ApiQueue, { id: "api-call-1" })
- *
- *     yield* Effect.log("Workflow succeeded!")
+ *     return "Workflow succeeded!"
  *   })
  * )
  *
- * // Define a worker layer that can process items from the DurableQueue.
- * const ApiWorker = DurableQueue.worker(
- *   ApiQueue,
- *   Effect.fnUntraced(function*({ id }) {
- *     yield* Effect.log(`Worker processing API call with id: ${id}`)
- *   }),
- *   { concurrency: 5 } // Process up to 5 items concurrently
- * )
+ * const processed: Array<string> = []
+ * const processApiCall = ({ id }: { readonly id: string }) => Effect.sync(() => processed.push(id))
+ *
+ * // Construct the worker layer without starting background workers in this example.
+ * const ApiWorker = DurableQueue.worker(ApiQueue, processApiCall, {
+ *   concurrency: 5
+ * })
+ *
+ * const program = Effect.gen(function*() {
+ *   // Exercise the finite handler directly instead of running a queue worker.
+ *   yield* processApiCall({ id: "api-call-1" })
+ *   return [Layer.isLayer(MyWorkflowLayer), Layer.isLayer(ApiWorker), processed] as const
+ * })
+ *
+ * await Effect.runPromise(program) // => [true, true, ["api-call-1"]]
  * ```
  *
  * @category constructors
@@ -170,7 +172,7 @@ const getQueueSchema = <Payload extends Schema.Top>(
 /**
  * Adds an item to the queue and wait for a worker to process it.
  *
- * @category Processing
+ * @category running
  * @since 4.0.0
  */
 export const process: <
@@ -247,7 +249,7 @@ const defaultRetrySchedule = Schedule.min([
 /**
  * Create a worker effect that processes items from the durable queue.
  *
- * @category Worker
+ * @category workers
  * @since 4.0.0
  */
 export const makeWorker: <
@@ -334,7 +336,7 @@ export const makeWorker: <
 /**
  * Create a layer that runs workers for the durable queue.
  *
- * @category Worker
+ * @category workers
  * @since 4.0.0
  */
 export const worker: <