effect 4.0.0-beta.69 → 4.0.0-beta.70

package/src/unstable/eventlog/EventLogServerUnencrypted.ts

@@ -99,6 +99,8 @@ export const makeWrite = <Groups extends EventGroup.Any>(
 /**
  * Provides RPC handlers for the unencrypted event-log server.
  *
+ * **Details**
+ *
  * Incoming plaintext entries are authorized, mapped to a server store, checked
  * for conflicts, run through registered handlers, and persisted; change streams
  * include compacted backlog entries when compactors are registered.
@@ -330,6 +332,8 @@ export const layerStoreMappingStatic = (options: {
 /**
  * Storage service used by the unencrypted event-log server.
  *
+ * **Details**
+ *
  * It provides the server remote id, stores session authentication bindings,
  * allocates remote sequence numbers, persists entries, streams changes, and
  * exposes a transaction boundary.
@@ -455,6 +459,8 @@ const toCompactedRemoteEntries = (options: {
 /**
  * Compacts a backlog of remote entries using the registered compactors.
  *
+ * **Details**
+ *
  * Contiguous entries handled by the same compactor may be replaced with compacted
  * entries when the replacement count can be mapped back to increasing remote
  * sequence numbers; otherwise the original entries are kept.
@@ -525,6 +531,8 @@ export const compactBacklog = Effect.fnUntraced(function*(options: {
 /**
  * Creates an in-memory unencrypted server `Storage`.
  *
+ * **Details**
+ *
  * The implementation keeps per-store journals and session authentication bindings
  * in memory, publishes live changes, and serializes transactions with a
  * semaphore.

package/src/unstable/eventlog/EventLogSessionAuth.ts

@@ -241,7 +241,11 @@ const encodeRemoteIdField = (remoteId: string | Uint8Array): Uint8Array =>
     : textEncoder.encode(bytesToHex(remoteId))
 
 /**
- * Canonical payload format uses ordered big-endian length-prefixed fields:
+ * Encodes a session authentication payload into the canonical byte format.
+ *
+ * **Details**
+ *
+ * The canonical payload format uses ordered big-endian length-prefixed fields:
  *
  * 1. context (fixed: eventlog-auth-v1)
  * 2. remoteId
@@ -282,6 +286,8 @@ export const encodeSessionAuthPayload = Effect.fnUntraced(function*(payload: Ses
 /**
  * Decodes a canonical session authentication payload.
  *
+ * **Details**
+ *
  * The decoder validates the context field, UTF-8 fields, signing public key
  * length, and rejects truncated or trailing bytes.
  *
@@ -326,6 +332,8 @@ export const decodeSessionAuthPayload = Effect.fnUntraced(
  * Signs canonical session authentication payload bytes with an Ed25519 private
  * key.
  *
+ * **Details**
+ *
  * The private key must be PKCS#8-encoded bytes importable by `SubtleCrypto`.
  *
  * @category signing
@@ -371,6 +379,8 @@ export const signSessionAuthPayloadBytes = Effect.fnUntraced(function*(options:
  * Verifies an Ed25519 signature for canonical session authentication payload
  * bytes.
  *
+ * **Details**
+ *
  * The payload, signing public key, and signature lengths are validated before
  * calling `SubtleCrypto.verify`.
  *

package/src/unstable/eventlog/SqlEventJournal.ts

@@ -34,6 +34,8 @@ type WriteFromRemoteOptions = Parameters<EventJournal.EventJournal["Service"]["w
 /**
  * Creates an `EventJournal` backed by a SQL database.
  *
+ * **Details**
+ *
  * The constructor creates the entry and remote metadata tables when needed,
  * persists local and remote entries, and uses the configured `SqlClient`.
  *

package/src/unstable/eventlog/SqlEventLogServerEncrypted.ts

@@ -35,6 +35,8 @@ import * as EventLogServerEncrypted from "./EventLogServerEncrypted.ts"
 /**
  * Creates encrypted event-log server `Storage` backed by SQL.
  *
+ * **Details**
+ *
  * It persists the server remote id, session authentication bindings, and encrypted
  * entries in dialect-specific tables, creating per-identity/store entry tables as
  * needed.

package/src/unstable/eventlog/SqlEventLogServerUnencrypted.ts

@@ -35,6 +35,8 @@ import * as EventLogServerUnencrypted from "./EventLogServerUnencrypted.ts"
 /**
  * Creates unencrypted event-log server `Storage` backed by SQL.
  *
+ * **Details**
+ *
  * The implementation creates tables for the server remote id, store sequences,
  * entries, and session authentication bindings, then persists and streams
  * plaintext remote entries.

package/src/unstable/http/Cookies.ts

@@ -60,6 +60,8 @@ export interface CookiesSchema extends Schema.declare<Cookies, Record.ReadonlyRe
 /**
  * Schema for `Cookies` collections.
  *
+ * **Details**
+ *
  * JSON encoding uses `Set-Cookie` header strings, while isomorphic encoding uses
  * a readonly record of cookie values.
  *
@@ -184,6 +186,8 @@ export class CookiesErrorReason extends Data.Error<{
 /**
  * Error returned when a cookie name, value, domain, path, or max-age option is invalid.
  *
+ * **Details**
+ *
  * Inspect `reason` to determine the specific validation failure.
  *
  * @category errors
@@ -443,6 +447,8 @@ const CookieProto = {
 /**
  * Creates a cookie, validating the name, encoded value, domain, path, and finite `maxAge`.
  *
+ * **Details**
+ *
  * Returns a `CookiesError` in the `Result` failure channel when validation fails.
  *
  * @category constructors
@@ -634,6 +640,8 @@ export const get: {
 /**
  * Gets the decoded value of a cookie by name.
  *
+ * **Details**
+ *
  * Returns `Option.none()` when the cookie is not present.
  *
  * @category combinators
@@ -643,6 +651,8 @@ export const getValue: {
   /**
    * Gets the decoded value of a cookie by name.
    *
+   * **Details**
+   *
    * Returns `Option.none()` when the cookie is not present.
    *
    * @category combinators
@@ -652,6 +662,8 @@ export const getValue: {
   /**
    * Gets the decoded value of a cookie by name.
    *
+   * **Details**
+   *
    * Returns `Option.none()` when the cookie is not present.
    *
    * @category combinators
@@ -666,6 +678,8 @@ export const getValue: {
 /**
  * Creates and adds a cookie by name and value.
  *
+ * **Details**
+ *
  * The cookie fields are validated first; invalid input returns a `CookiesError` in the `Result` failure channel.
  *
  * @category combinators
@@ -675,6 +689,8 @@ export const set: {
   /**
    * Creates and adds a cookie by name and value.
    *
+   * **Details**
+   *
    * The cookie fields are validated first; invalid input returns a `CookiesError` in the `Result` failure channel.
    *
    * @category combinators
@@ -684,6 +700,8 @@ export const set: {
   /**
    * Creates and adds a cookie by name and value.
    *
+   * **Details**
+   *
    * The cookie fields are validated first; invalid input returns a `CookiesError` in the `Result` failure channel.
    *
    * @category combinators
@@ -733,6 +751,8 @@ export const setUnsafe: {
 /**
  * Adds an expired cookie with an empty value, `Max-Age=0`, and an epoch `Expires` value.
  *
+ * **Details**
+ *
  * Returns a `CookiesError` in the `Result` failure channel when the name or options are invalid.
  *
  * @category combinators
@@ -742,6 +762,8 @@ export const expireCookie: {
   /**
    * Adds an expired cookie with an empty value, `Max-Age=0`, and an epoch `Expires` value.
    *
+   * **Details**
+   *
    * Returns a `CookiesError` in the `Result` failure channel when the name or options are invalid.
    *
    * @category combinators
@@ -754,6 +776,8 @@ export const expireCookie: {
   /**
    * Adds an expired cookie with an empty value, `Max-Age=0`, and an epoch `Expires` value.
    *
+   * **Details**
+   *
    * Returns a `CookiesError` in the `Result` failure channel when the name or options are invalid.
    *
    * @category combinators
@@ -823,6 +847,8 @@ export const expireCookieUnsafe: {
 /**
  * Creates and adds multiple cookies from name/value/options tuples.
  *
+ * **Details**
+ *
  * If any tuple is invalid, returns the first `CookiesError` and leaves the original collection unchanged.
  *
  * @category combinators
@@ -832,6 +858,8 @@ export const setAll: {
   /**
    * Creates and adds multiple cookies from name/value/options tuples.
    *
+   * **Details**
+   *
    * If any tuple is invalid, returns the first `CookiesError` and leaves the original collection unchanged.
    *
    * @category combinators
@@ -843,6 +871,8 @@ export const setAll: {
   /**
    * Creates and adds multiple cookies from name/value/options tuples.
    *
+   * **Details**
+   *
    * If any tuple is invalid, returns the first `CookiesError` and leaves the original collection unchanged.
    *
    * @category combinators
@@ -907,6 +937,8 @@ export const setAllUnsafe: {
 /**
  * Serialize a cookie into a string
  *
+ * **Details**
+ *
  * Adapted from https://github.com/fastify/fastify-cookie under MIT License
  *
  * @category encoding
@@ -1034,6 +1066,8 @@ export const toSetCookieHeaders = (self: Cookies): Array<string> => Object.value
 /**
  * Parse a cookie header into a record of key-value pairs
  *
+ * **Details**
+ *
  * Adapted from https://github.com/fastify/fastify-cookie under MIT License
  *
  * @category decoding

package/src/unstable/http/Etag.ts

@@ -34,6 +34,8 @@ export type Etag = Weak | Strong
 /**
  * Weak HTTP entity tag.
  *
+ * **Details**
+ *
  * The `value` is the raw tag value without the surrounding quotes or `W/` prefix.
  *
  * @category models
@@ -47,6 +49,8 @@ export interface Weak {
 /**
  * Strong HTTP entity tag.
  *
+ * **Details**
+ *
  * The `value` is the raw tag value without the surrounding quotes.
  *
  * @category models

package/src/unstable/http/FetchHttpClient.ts

@@ -29,6 +29,8 @@ import * as HttpClientResponse from "./HttpClientResponse.ts"
 /**
  * Context reference for the `fetch` implementation used by the fetch-based HTTP client.
  *
+ * **Details**
+ *
  * Defaults to `globalThis.fetch`.
  *
  * @category tags
@@ -41,6 +43,8 @@ export const Fetch = Context.Reference<typeof globalThis.fetch>("effect/http/Fet
 /**
  * Service containing default `RequestInit` options for the fetch-based HTTP client.
  *
+ * **Details**
+ *
  * Request-specific method, headers, body, and abort signal are supplied by the client when a request is executed.
  *
  * @category tags

package/src/unstable/http/Headers.ts

@@ -59,6 +59,8 @@ export const isHeaders = (u: unknown): u is Headers => Predicate.hasProperty(u,
 /**
  * Represents an immutable HTTP header collection keyed by lowercase header name.
  *
+ * **Details**
+ *
  * `Headers` values also support redaction through the `Redactable` protocol.
  *
  * @category models
@@ -125,6 +127,8 @@ export interface HeadersSchema extends Schema.declare<Headers, { readonly [x: st
 /**
  * Schema for `Headers` values encoded as records of string header values.
  *
+ * **Details**
+ *
  * Decoding normalizes header names through `fromInput`; encoding returns a plain record.
  *
  * @category schemas
@@ -158,6 +162,8 @@ export const HeadersSchema: HeadersSchema = Schema.declare(
 /**
  * Input accepted when constructing headers.
  *
+ * **Details**
+ *
  * Records may contain string values, string arrays, or `undefined`; arrays are joined with `", "`, and `undefined` values are omitted.
  *
  * @category models
@@ -178,6 +184,8 @@ export const empty: Headers = Object.create(Proto)
 /**
  * Creates `Headers` from a record or iterable of header entries.
  *
+ * **Details**
+ *
  * Header names are normalized to lowercase. Array values in record input are joined with `", "`, and `undefined` values are omitted.
  *
  * @category constructors
@@ -207,6 +215,8 @@ export const fromInput: (input?: Input) => Headers = (input) => {
 /**
  * Unsafely treats an existing record as `Headers`.
  *
+ * **Gotchas**
+ *
  * This mutates the record's prototype and does not normalize header names; callers must provide the expected lowercase keys.
  *
  * @category constructors
@@ -218,6 +228,8 @@ export const fromRecordUnsafe = (input: Record.ReadonlyRecord<string, string>):
 /**
  * Returns `true` when a header with the given name is present.
  *
+ * **Details**
+ *
  * The lookup lowercases the provided header name.
  *
  * @category combinators
@@ -227,6 +239,8 @@ export const has: {
   /**
    * Returns `true` when a header with the given name is present.
    *
+   * **Details**
+   *
    * The lookup lowercases the provided header name.
    *
    * @category combinators
@@ -236,6 +250,8 @@ export const has: {
   /**
    * Returns `true` when a header with the given name is present.
    *
+   * **Details**
+   *
    * The lookup lowercases the provided header name.
    *
    * @category combinators
@@ -246,6 +262,8 @@ export const has: {
   /**
    * Returns `true` when a header with the given name is present.
    *
+   * **Details**
+   *
    * The lookup lowercases the provided header name.
    *
    * @category combinators
@@ -255,6 +273,8 @@ export const has: {
   /**
    * Returns `true` when a header with the given name is present.
    *
+   * **Details**
+   *
    * The lookup lowercases the provided header name.
    *
    * @category combinators
@@ -266,6 +286,8 @@ export const has: {
 /**
  * Gets a header value by name.
  *
+ * **Details**
+ *
  * The lookup lowercases the provided header name and returns `Option.none()` when absent.
  *
  * @category combinators
@@ -275,6 +297,8 @@ export const get: {
   /**
    * Gets a header value by name.
    *
+   * **Details**
+   *
    * The lookup lowercases the provided header name and returns `Option.none()` when absent.
    *
    * @category combinators
@@ -284,6 +308,8 @@ export const get: {
   /**
    * Gets a header value by name.
    *
+   * **Details**
+   *
    * The lookup lowercases the provided header name and returns `Option.none()` when absent.
    *
    * @category combinators
@@ -294,6 +320,8 @@ export const get: {
   /**
    * Gets a header value by name.
    *
+   * **Details**
+   *
    * The lookup lowercases the provided header name and returns `Option.none()` when absent.
    *
    * @category combinators
@@ -303,6 +331,8 @@ export const get: {
   /**
    * Gets a header value by name.
    *
+   * **Details**
+   *
    * The lookup lowercases the provided header name and returns `Option.none()` when absent.
    *
    * @category combinators
@@ -314,6 +344,8 @@ export const get: {
 /**
  * Returns a new `Headers` collection with the given header set.
  *
+ * **Details**
+ *
  * The header name is normalized to lowercase.
  *
  * @category combinators
@@ -323,6 +355,8 @@ export const set: {
   /**
    * Returns a new `Headers` collection with the given header set.
    *
+   * **Details**
+   *
    * The header name is normalized to lowercase.
    *
    * @category combinators
@@ -332,6 +366,8 @@ export const set: {
   /**
    * Returns a new `Headers` collection with the given header set.
    *
+   * **Details**
+   *
    * The header name is normalized to lowercase.
    *
    * @category combinators
@@ -342,6 +378,8 @@ export const set: {
   /**
    * Returns a new `Headers` collection with the given header set.
    *
+   * **Details**
+   *
    * The header name is normalized to lowercase.
    *
    * @category combinators
@@ -351,6 +389,8 @@ export const set: {
   /**
    * Returns a new `Headers` collection with the given header set.
    *
+   * **Details**
+   *
    * The header name is normalized to lowercase.
    *
    * @category combinators
@@ -366,6 +406,8 @@ export const set: {
 /**
  * Returns a new `Headers` collection with all provided headers set.
  *
+ * **Details**
+ *
  * Input headers are normalized with `fromInput` and override existing headers with the same lowercase name.
  *
  * @category combinators
@@ -375,6 +417,8 @@ export const setAll: {
   /**
    * Returns a new `Headers` collection with all provided headers set.
    *
+   * **Details**
+   *
    * Input headers are normalized with `fromInput` and override existing headers with the same lowercase name.
    *
    * @category combinators
@@ -384,6 +428,8 @@ export const setAll: {
   /**
    * Returns a new `Headers` collection with all provided headers set.
    *
+   * **Details**
+   *
    * Input headers are normalized with `fromInput` and override existing headers with the same lowercase name.
    *
    * @category combinators
@@ -394,6 +440,8 @@ export const setAll: {
   /**
    * Returns a new `Headers` collection with all provided headers set.
    *
+   * **Details**
+   *
    * Input headers are normalized with `fromInput` and override existing headers with the same lowercase name.
    *
    * @category combinators
@@ -403,6 +451,8 @@ export const setAll: {
   /**
    * Returns a new `Headers` collection with all provided headers set.
    *
+   * **Details**
+   *
    * Input headers are normalized with `fromInput` and override existing headers with the same lowercase name.
    *
    * @category combinators
@@ -418,6 +468,8 @@ export const setAll: {
 /**
  * Returns a new `Headers` collection containing headers from both collections.
  *
+ * **Details**
+ *
  * Headers from the second collection override headers from the first collection with the same name.
  *
  * @category combinators
@@ -427,6 +479,8 @@ export const merge: {
   /**
    * Returns a new `Headers` collection containing headers from both collections.
    *
+   * **Details**
+   *
    * Headers from the second collection override headers from the first collection with the same name.
    *
    * @category combinators
@@ -436,6 +490,8 @@ export const merge: {
   /**
    * Returns a new `Headers` collection containing headers from both collections.
    *
+   * **Details**
+   *
    * Headers from the second collection override headers from the first collection with the same name.
    *
    * @category combinators
@@ -446,6 +502,8 @@ export const merge: {
   /**
    * Returns a new `Headers` collection containing headers from both collections.
    *
+   * **Details**
+   *
    * Headers from the second collection override headers from the first collection with the same name.
    *
    * @category combinators
@@ -455,6 +513,8 @@ export const merge: {
   /**
    * Returns a new `Headers` collection containing headers from both collections.
    *
+   * **Details**
+   *
    * Headers from the second collection override headers from the first collection with the same name.
    *
    * @category combinators
@@ -470,6 +530,8 @@ export const merge: {
 /**
  * Returns a new `Headers` collection with the named header removed.
  *
+ * **Details**
+ *
  * The provided header name is normalized to lowercase before removal.
  *
  * @category combinators
@@ -479,6 +541,8 @@ export const remove: {
   /**
    * Returns a new `Headers` collection with the named header removed.
    *
+   * **Details**
+   *
    * The provided header name is normalized to lowercase before removal.
    *
    * @category combinators
@@ -488,6 +552,8 @@ export const remove: {
   /**
    * Returns a new `Headers` collection with the named header removed.
    *
+   * **Details**
+   *
    * The provided header name is normalized to lowercase before removal.
    *
    * @category combinators
@@ -498,6 +564,8 @@ export const remove: {
   /**
    * Returns a new `Headers` collection with the named header removed.
    *
+   * **Details**
+   *
    * The provided header name is normalized to lowercase before removal.
    *
    * @category combinators
@@ -507,6 +575,8 @@ export const remove: {
   /**
    * Returns a new `Headers` collection with the named header removed.
    *
+   * **Details**
+   *
    * The provided header name is normalized to lowercase before removal.
    *
    * @category combinators
@@ -522,6 +592,8 @@ export const remove: {
 /**
  * Returns a new `Headers` collection with each named header removed.
  *
+ * **Details**
+ *
  * Each provided header name is normalized to lowercase before removal.
  *
  * @category combinators
@@ -531,6 +603,8 @@ export const removeMany: {
   /**
    * Returns a new `Headers` collection with each named header removed.
    *
+   * **Details**
+   *
    * Each provided header name is normalized to lowercase before removal.
    *
    * @category combinators
@@ -540,6 +614,8 @@ export const removeMany: {
   /**
    * Returns a new `Headers` collection with each named header removed.
    *
+   * **Details**
+   *
    * Each provided header name is normalized to lowercase before removal.
    *
    * @category combinators
@@ -550,6 +626,8 @@ export const removeMany: {
   /**
    * Returns a new `Headers` collection with each named header removed.
    *
+   * **Details**
+   *
    * Each provided header name is normalized to lowercase before removal.
    *
    * @category combinators
@@ -559,6 +637,8 @@ export const removeMany: {
   /**
    * Returns a new `Headers` collection with each named header removed.
    *
+   * **Details**
+   *
    * Each provided header name is normalized to lowercase before removal.
    *
    * @category combinators
@@ -576,6 +656,8 @@ export const removeMany: {
 /**
  * Returns a plain record with selected header values wrapped in `Redacted`.
  *
+ * **Details**
+ *
  * String keys are normalized to lowercase before matching; regular expressions are tested against the stored header names.
  *
  * @category combinators
@@ -585,6 +667,8 @@ export const redact: {
   /**
    * Returns a plain record with selected header values wrapped in `Redacted`.
    *
+   * **Details**
+   *
    * String keys are normalized to lowercase before matching; regular expressions are tested against the stored header names.
    *
    * @category combinators
@@ -594,6 +678,8 @@ export const redact: {
   /**
    * Returns a plain record with selected header values wrapped in `Redacted`.
    *
+   * **Details**
+   *
    * String keys are normalized to lowercase before matching; regular expressions are tested against the stored header names.
    *
    * @category combinators
@@ -635,6 +721,8 @@ export const redact: {
 /**
  * Context reference listing header names or patterns that should be redacted when `Headers` are inspected or rendered.
  *
+ * **Details**
+ *
  * Defaults include `authorization`, `cookie`, `set-cookie`, and `x-api-key`.
  *
  * @category fiber refs