effect 3.15.4 → 3.16.0

package/src/ExecutionPlan.ts

@@ -0,0 +1,302 @@
+/**
+ * @since 3.16.0
+ * @experimental
+ */
+import type { NonEmptyReadonlyArray } from "./Array.js"
+import type * as Context from "./Context.js"
+import * as Effect from "./Effect.js"
+import * as internal from "./internal/executionPlan.js"
+import * as Layer from "./Layer.js"
+import type { Pipeable } from "./Pipeable.js"
+import { pipeArguments } from "./Pipeable.js"
+import type * as Schedule from "./Schedule.js"
+
+/**
+ * @since 3.16.0
+ * @category Symbols
+ * @experimental
+ */
+export const TypeId: unique symbol = internal.TypeId
+
+/**
+ * @since 3.16.0
+ * @category Symbols
+ * @experimental
+ */
+export type TypeId = typeof TypeId
+
+/**
+ * @since 3.16.0
+ * @category Guards
+ * @experimental
+ */
+export const isExecutionPlan: (u: unknown) => u is ExecutionPlan<any> = internal.isExecutionPlan
+
+/**
+ * A `ExecutionPlan` can be used with `Effect.withExecutionPlan` or `Stream.withExecutionPlan`, allowing you to provide different resources for each step of execution until the effect succeeds or the plan is exhausted.
+ *
+ * ```ts
+ * import { type AiLanguageModel } from "@effect/ai"
+ * import type { Layer } from "effect"
+ * import { Effect, ExecutionPlan, Schedule } from "effect"
+ *
+ * declare const layerBad: Layer.Layer<AiLanguageModel.AiLanguageModel>
+ * declare const layerGood: Layer.Layer<AiLanguageModel.AiLanguageModel>
+ *
+ * const ThePlan = ExecutionPlan.make(
+ *   {
+ *     // First try with the bad layer 2 times with a 3 second delay between attempts
+ *     provide: layerBad,
+ *     attempts: 2,
+ *     schedule: Schedule.spaced(3000)
+ *   },
+ *   // Then try with the bad layer 3 times with a 1 second delay between attempts
+ *   {
+ *     provide: layerBad,
+ *     attempts: 3,
+ *     schedule: Schedule.spaced(1000)
+ *   },
+ *   // Finally try with the good layer.
+ *   //
+ *   // If `attempts` is omitted, the plan will only attempt once, unless a schedule is provided.
+ *   {
+ *     provide: layerGood
+ *   }
+ * )
+ *
+ * declare const effect: Effect.Effect<
+ *   void,
+ *   never,
+ *   AiLanguageModel.AiLanguageModel
+ * >
+ * const withPlan: Effect.Effect<void> = Effect.withExecutionPlan(effect, ThePlan)
+ * ```
+ *
+ * @since 3.16.0
+ * @category Models
+ * @experimental
+ */
+export interface ExecutionPlan<
+  Types extends {
+    provides: any
+    input: any
+    error: any
+    requirements: any
+  }
+> extends Pipeable {
+  readonly [TypeId]: TypeId
+  readonly steps: NonEmptyReadonlyArray<{
+    readonly provide:
+      | Context.Context<Types["provides"]>
+      | Layer.Layer<Types["provides"], Types["error"], Types["requirements"]>
+    readonly attempts?: number | undefined
+    readonly while?:
+      | ((input: Types["input"]) => Effect.Effect<boolean, Types["error"], Types["requirements"]>)
+      | undefined
+    readonly schedule?: Schedule.Schedule<any, Types["input"], Types["requirements"]> | undefined
+  }>
+
+  /**
+   * Returns an equivalent `ExecutionPlan` with the requirements satisfied,
+   * using the current context.
+   */
+  readonly withRequirements: Effect.Effect<
+    ExecutionPlan<{
+      provides: Types["provides"]
+      input: Types["input"]
+      error: Types["error"]
+      requirements: never
+    }>,
+    never,
+    Types["requirements"]
+  >
+}
+
+/**
+ * @since 3.16.0
+ * @experimental
+ */
+export type TypesBase = {
+  provides: any
+  input: any
+  error: any
+  requirements: any
+}
+
+/**
+ * Create an `ExecutionPlan`, which can be used with `Effect.withExecutionPlan` or `Stream.withExecutionPlan`, allowing you to provide different resources for each step of execution until the effect succeeds or the plan is exhausted.
+ *
+ * ```ts
+ * import { type AiLanguageModel } from "@effect/ai"
+ * import type { Layer } from "effect"
+ * import { Effect, ExecutionPlan, Schedule } from "effect"
+ *
+ * declare const layerBad: Layer.Layer<AiLanguageModel.AiLanguageModel>
+ * declare const layerGood: Layer.Layer<AiLanguageModel.AiLanguageModel>
+ *
+ * const ThePlan = ExecutionPlan.make(
+ *   {
+ *     // First try with the bad layer 2 times with a 3 second delay between attempts
+ *     provide: layerBad,
+ *     attempts: 2,
+ *     schedule: Schedule.spaced(3000)
+ *   },
+ *   // Then try with the bad layer 3 times with a 1 second delay between attempts
+ *   {
+ *     provide: layerBad,
+ *     attempts: 3,
+ *     schedule: Schedule.spaced(1000)
+ *   },
+ *   // Finally try with the good layer.
+ *   //
+ *   // If `attempts` is omitted, the plan will only attempt once, unless a schedule is provided.
+ *   {
+ *     provide: layerGood
+ *   }
+ * )
+ *
+ * declare const effect: Effect.Effect<
+ *   void,
+ *   never,
+ *   AiLanguageModel.AiLanguageModel
+ * >
+ * const withPlan: Effect.Effect<void> = Effect.withExecutionPlan(effect, ThePlan)
+ * ```
+ *
+ * @since 3.16.0
+ * @category Constructors
+ * @experimental
+ */
+export const make = <const Steps extends NonEmptyReadonlyArray<make.Step>>(
+  ...steps: Steps & { [K in keyof Steps]: make.Step }
+): ExecutionPlan<{
+  provides: make.StepProvides<Steps[number]>
+  input: make.StepInput<Steps>
+  error: make.StepError<Steps[number]>
+  requirements: make.StepRequirements<Steps[number]>
+}> =>
+  makeProto(steps.map((options, i) => {
+    if (options.attempts && options.attempts < 1) {
+      throw new Error(`ExecutionPlan.make: step[${i}].attempts must be greater than 0`)
+    }
+    return {
+      schedule: options.schedule,
+      attempts: options.attempts,
+      while: options.while
+        ? (input: any) =>
+          Effect.suspend(() => {
+            const result = options.while!(input)
+            return typeof result === "boolean" ? Effect.succeed(result) : result
+          })
+        : undefined,
+      provide: options.provide
+    }
+  }) as any)
+
+/**
+ * @since 3.16.0
+ * @experimental
+ */
+export declare namespace make {
+  /**
+   * @since 3.16.0
+   * @experimental
+   */
+  export type Step = {
+    readonly provide: Context.Context<any> | Context.Context<never> | Layer.Layer.Any
+    readonly attempts?: number | undefined
+    readonly while?: ((input: any) => boolean | Effect.Effect<boolean, any, any>) | undefined
+    readonly schedule?: Schedule.Schedule<any, any, any> | undefined
+  }
+
+  /**
+   * @since 3.16.0
+   * @experimental
+   */
+  export type StepProvides<S extends Step> = S["provide"] extends
+    Context.Context<infer P> | Layer.Layer<infer P, infer _E, infer _R> ? P : never
+
+  /**
+   * @since 3.16.0
+   * @experimental
+   */
+  export type StepInput<Steps extends ReadonlyArray<any>, Out = unknown> = Steps extends
+    readonly [infer Step, ...infer Rest] ? StepInput<
+      Rest,
+      & Out
+      & (
+        & (Step extends { readonly while: (input: infer I) => infer _ } ? I : unknown)
+        & (Step extends { readonly schedule: Schedule.Schedule<infer _O, infer I, infer _R> } ? I : unknown)
+      )
+    > :
+    Out
+
+  /**
+   * @since 3.16.0
+   * @experimental
+   */
+  export type PlanInput<Plans extends ReadonlyArray<any>, Out = unknown> = Plans extends
+    readonly [infer Plan, ...infer Rest] ?
+    PlanInput<Rest, Out & (Plan extends ExecutionPlan<infer T> ? T["input"] : never)> :
+    Out
+
+  /**
+   * @since 3.16.0
+   * @experimental
+   */
+  export type StepError<S extends Step> =
+    | (S["provide"] extends Context.Context<infer _P> | Layer.Layer<infer _P, infer E, infer _R> ? E : never)
+    | (S["while"] extends (input: infer _I) => Effect.Effect<infer _A, infer _E, infer _R> ? _E : never)
+
+  /**
+   * @since 3.16.0
+   * @experimental
+   */
+  export type StepRequirements<S extends Step> =
+    | (S["provide"] extends Layer.Layer<infer _A, infer _E, infer R> ? R : never)
+    | (S["while"] extends (input: infer _I) => Effect.Effect<infer _A, infer _E, infer R> ? R : never)
+    | (S["schedule"] extends Schedule.Schedule<infer _O, infer _I, infer R> ? R : never)
+}
+
+const Proto: Omit<ExecutionPlan<any>, "steps"> = {
+  [TypeId]: TypeId,
+  get withRequirements() {
+    const self = this as any as ExecutionPlan<any>
+    return Effect.contextWith((context: Context.Context<any>) =>
+      makeProto(self.steps.map((step) => ({
+        ...step,
+        provide: Layer.isLayer(step.provide) ? Layer.provide(step.provide, Layer.succeedContext(context)) : step.provide
+      })) as any)
+    )
+  },
+  pipe() {
+    return pipeArguments(this, arguments)
+  }
+}
+
+const makeProto = <Provides, In, PlanE, PlanR>(
+  steps: ExecutionPlan<{
+    provides: Provides
+    input: In
+    error: PlanE
+    requirements: PlanR
+  }>["steps"]
+) => {
+  const self = Object.create(Proto)
+  self.steps = steps
+  return self
+}
+
+/**
+ * @since 3.16.0
+ * @category Combining
+ * @experimental
+ */
+export const merge = <const Plans extends NonEmptyReadonlyArray<ExecutionPlan<any>>>(
+  ...plans: Plans
+): ExecutionPlan<{
+  provides: Plans[number] extends ExecutionPlan<infer T> ? T["provides"] : never
+  input: make.PlanInput<Plans>
+  error: Plans[number] extends ExecutionPlan<infer T> ? T["error"] : never
+  requirements: Plans[number] extends ExecutionPlan<infer T> ? T["requirements"] : never
+}> => makeProto(plans.flatMap((plan) => plan.steps) as any)

package/src/HashMap.ts

@@ -268,6 +268,62 @@ export const hasHash: {
   <K1 extends K, K, V>(self: HashMap<K, V>, key: K1, hash: number): boolean
 } = HM.hasHash
 
+/**
+ * Checks if an element matching the given predicate exists in the given `HashMap`.
+ *
+ * @example
+ * ```ts
+ * import { HashMap } from "effect"
+ *
+ * const hm = HashMap.make([1, 'a'])
+ * HashMap.hasBy(hm, (value, key) => value === 'a' && key === 1); // -> true
+ * HashMap.hasBy(hm, (value) => value === 'b'); // -> false
+ *
+ * ```
+ *
+ * @since 3.16.0
+ * @category elements
+ */
+export const hasBy: {
+  /**
+   * Checks if an element matching the given predicate exists in the given `HashMap`.
+   *
+   * @example
+   * ```ts
+   * import { HashMap } from "effect"
+   *
+   * const hm = HashMap.make([1, 'a'])
+   * HashMap.hasBy(hm, (value, key) => value === 'a' && key === 1); // -> true
+   * HashMap.hasBy(hm, (value) => value === 'b'); // -> false
+   *
+   * ```
+   *
+   * @since 3.16.0
+   * @category elements
+   */
+  <K, V>(predicate: (value: NoInfer<V>, key: NoInfer<K>) => boolean): (self: HashMap<K, V>) => boolean
+  /**
+   * Checks if an element matching the given predicate exists in the given `HashMap`.
+   *
+   * @example
+   * ```ts
+   * import { HashMap } from "effect"
+   *
+   * const hm = HashMap.make([1, 'a'])
+   * HashMap.hasBy(hm, (value, key) => value === 'a' && key === 1); // -> true
+   * HashMap.hasBy(hm, (value) => value === 'b'); // -> false
+   *
+   * ```
+   *
+   * @since 3.16.0
+   * @category elements
+   */
+  <K, V>(
+   self: HashMap<K, V>,
+   predicate: (value: NoInfer<V>, key: NoInfer<K>) => boolean
+  ): boolean
+} = HM.hasBy
+
 /**
  * Sets the specified key to the specified value using the internal hashing
  * function.

package/src/Iterable.ts

@@ -1538,3 +1538,69 @@ export const cartesian: {
   2,
   <A, B>(self: Iterable<A>, that: Iterable<B>): Iterable<[A, B]> => cartesianWith(self, that, (a, b) => [a, b])
 )
+
+/**
+ * Counts all the element of the given iterable that pass the given predicate
+ *
+ * **Example**
+ *
+ * ```ts
+ * import { Iterable } from "effect"
+ *
+ * const result = Iterable.countBy([1, 2, 3, 4, 5], n => n % 2 === 0)
+ * console.log(result) // 2
+ * ```
+ *
+ * @category folding
+ * @since 3.16.0
+ */
+export const countBy: {
+  /**
+   * Counts all the element of the given iterable that pass the given predicate
+   *
+   * **Example**
+   *
+   * ```ts
+   * import { Iterable } from "effect"
+   *
+   * const result = Iterable.countBy([1, 2, 3, 4, 5], n => n % 2 === 0)
+   * console.log(result) // 2
+   * ```
+   *
+   * @category folding
+   * @since 3.16.0
+   */
+  <A>(predicate: (a: NoInfer<A>, i: number) => boolean): (self: Iterable<A>) => number
+  /**
+   * Counts all the element of the given iterable that pass the given predicate
+   *
+   * **Example**
+   *
+   * ```ts
+   * import { Iterable } from "effect"
+   *
+   * const result = Iterable.countBy([1, 2, 3, 4, 5], n => n % 2 === 0)
+   * console.log(result) // 2
+   * ```
+   *
+   * @category folding
+   * @since 3.16.0
+   */
+  <A>(self: Iterable<A>, predicate: (a: A, i: number) => boolean): number
+} = dual(
+  2,
+  <A>(
+    self: Iterable<A>,
+    f: (a: A, i: number) => boolean
+  ): number => {
+    let count = 0
+    let i = 0
+    for (const a of self) {
+      if (f(a, i)) {
+        count++
+      }
+      i++
+    }
+    return count
+  }
+)