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

package/src/unstable/encoding/Ndjson.ts

@@ -32,6 +32,8 @@ const encoder = new TextEncoder()
 /**
  * Error raised when NDJSON encoding or decoding fails.
  *
+ * **Details**
+ *
  * The `kind` field identifies whether the failure happened while packing or
  * unpacking, and `cause` preserves the original error.
  *
@@ -62,6 +64,8 @@ export class NdjsonError extends Data.TaggedError("NdjsonError")<{
 /**
  * Creates a channel that encodes chunks of values as NDJSON strings.
  *
+ * **Details**
+ *
  * Each input item is `JSON.stringify`-encoded, separated by newlines, and the
  * output chunk ends with a trailing newline.
  *
@@ -104,6 +108,8 @@ export const encode = <IE = never, Done = unknown>(): Channel.Channel<
 /**
  * Creates an NDJSON byte encoder channel for values of a schema.
  *
+ * **Details**
+ *
  * Values are first encoded with the schema and then written as UTF-8
  * newline-delimited JSON.
  *
@@ -126,6 +132,8 @@ export const encodeSchema = <S extends Schema.Top>(
 /**
  * Creates an NDJSON string encoder channel for values of a schema.
  *
+ * **Details**
+ *
  * Values are first encoded with the schema and then written as newline-delimited
  * JSON strings.
  *
@@ -148,8 +156,14 @@ export const encodeSchemaString = <S extends Schema.Top>(
 /**
  * Creates a channel that parses NDJSON string chunks into values.
  *
- * Lines may span input chunks. Set `ignoreEmptyLines` to skip blank lines before
- * calling `JSON.parse`; otherwise blank lines are parsed and fail as invalid JSON.
+ * **Details**
+ *
+ * Lines may span input chunks.
+ *
+ * **Gotchas**
+ *
+ * Set `ignoreEmptyLines` to skip blank lines before calling `JSON.parse`;
+ * otherwise blank lines are parsed and fail as invalid JSON.
  *
  * @category constructors
  * @since 4.0.0
@@ -181,6 +195,8 @@ export const decodeString = <IE = never, Done = unknown>(options?: {
 /**
  * Creates a channel that decodes UTF-8 byte chunks and parses them as NDJSON.
  *
+ * **Details**
+ *
  * Lines may span input chunks, and `ignoreEmptyLines` controls whether blank
  * lines are skipped before JSON parsing.
  *
@@ -203,6 +219,8 @@ export const decode = <IE = never, Done = unknown>(options?: {
 /**
  * Creates an NDJSON byte decoder channel for values of a schema.
  *
+ * **Details**
+ *
  * The channel decodes UTF-8 bytes, parses each NDJSON line, and then decodes
  * each parsed value with the schema.
  *
@@ -227,6 +245,8 @@ export const decodeSchema = <S extends Schema.Top>(
 /**
  * Creates an NDJSON string decoder channel for values of a schema.
  *
+ * **Details**
+ *
  * The channel parses each line as JSON and then decodes each parsed value with
  * the schema.
  *
@@ -251,6 +271,8 @@ export const decodeSchemaString = <S extends Schema.Top>(
 /**
  * Wraps a bidirectional byte channel with NDJSON encoding and decoding.
  *
+ * **Details**
+ *
  * Outgoing values are written as UTF-8 NDJSON bytes, and incoming bytes are
  * parsed as NDJSON values.
  *
@@ -261,6 +283,8 @@ export const duplex: {
   /**
    * Wraps a bidirectional byte channel with NDJSON encoding and decoding.
    *
+   * **Details**
+   *
    * Outgoing values are written as UTF-8 NDJSON bytes, and incoming bytes are
    * parsed as NDJSON values.
    *
@@ -293,6 +317,8 @@ export const duplex: {
   /**
    * Wraps a bidirectional byte channel with NDJSON encoding and decoding.
    *
+   * **Details**
+   *
    * Outgoing values are written as UTF-8 NDJSON bytes, and incoming bytes are
    * parsed as NDJSON values.
    *
@@ -351,6 +377,8 @@ export const duplex: {
 /**
  * Wraps a bidirectional string channel with NDJSON encoding and decoding.
  *
+ * **Details**
+ *
  * Outgoing values are written as NDJSON strings, and incoming strings are parsed
  * as NDJSON values.
  *
@@ -361,6 +389,8 @@ export const duplexString: {
   /**
    * Wraps a bidirectional string channel with NDJSON encoding and decoding.
    *
+   * **Details**
+   *
    * Outgoing values are written as NDJSON strings, and incoming strings are parsed
    * as NDJSON values.
    *
@@ -393,6 +423,8 @@ export const duplexString: {
   /**
    * Wraps a bidirectional string channel with NDJSON encoding and decoding.
    *
+   * **Details**
+   *
    * Outgoing values are written as NDJSON strings, and incoming strings are parsed
    * as NDJSON values.
    *
@@ -452,6 +484,8 @@ export const duplexString: {
  * Wraps a bidirectional byte channel with schema-aware NDJSON encoding and
  * decoding.
  *
+ * **Details**
+ *
  * Values sent to the wrapped channel are encoded with `inputSchema`; bytes
  * received from it are parsed as NDJSON and decoded with `outputSchema`.
  *
@@ -463,6 +497,8 @@ export const duplexSchema: {
    * Wraps a bidirectional byte channel with schema-aware NDJSON encoding and
    * decoding.
    *
+   * **Details**
+   *
    * Values sent to the wrapped channel are encoded with `inputSchema`; bytes
    * received from it are parsed as NDJSON and decoded with `outputSchema`.
    *
@@ -498,6 +534,8 @@ export const duplexSchema: {
    * Wraps a bidirectional byte channel with schema-aware NDJSON encoding and
    * decoding.
    *
+   * **Details**
+   *
    * Values sent to the wrapped channel are encoded with `inputSchema`; bytes
    * received from it are parsed as NDJSON and decoded with `outputSchema`.
    *
@@ -557,6 +595,8 @@ export const duplexSchema: {
  * Wraps a bidirectional string channel with schema-aware NDJSON encoding and
  * decoding.
  *
+ * **Details**
+ *
  * Values sent to the wrapped channel are encoded with `inputSchema`; strings
  * received from it are parsed as NDJSON and decoded with `outputSchema`.
  *
@@ -568,6 +608,8 @@ export const duplexSchemaString: {
    * Wraps a bidirectional string channel with schema-aware NDJSON encoding and
    * decoding.
    *
+   * **Details**
+   *
    * Values sent to the wrapped channel are encoded with `inputSchema`; strings
    * received from it are parsed as NDJSON and decoded with `outputSchema`.
    *
@@ -603,6 +645,8 @@ export const duplexSchemaString: {
    * Wraps a bidirectional string channel with schema-aware NDJSON encoding and
    * decoding.
    *
+   * **Details**
+   *
    * Values sent to the wrapped channel are encoded with `inputSchema`; strings
    * received from it are parsed as NDJSON and decoded with `outputSchema`.
    *

package/src/unstable/encoding/Sse.ts

@@ -33,8 +33,9 @@ import * as Schema from "../../Schema.ts"
 import * as Transformation from "../../SchemaTransformation.ts"
 
 /**
- * Creates a channel that parses Server-Sent Events text chunks into `Event`
- * values.
+ * Creates a channel that parses Server-Sent Events text chunks into `Event` values.
+ *
+ * **Details**
  *
  * SSE `retry` directives are emitted as `Retry` failures so callers can
  * reconnect with the requested delay.
@@ -85,6 +86,8 @@ export const decode = <IE, Done>(): Channel.Channel<
 /**
  * Creates an SSE decoder channel that decodes each parsed event with a schema.
  *
+ * **Details**
+ *
  * The schema receives the untagged event shape containing `id`, `event`, and
  * string `data`.
  *
@@ -119,8 +122,9 @@ export const decodeSchema = <
   )
 
 /**
- * Creates an SSE decoder channel that JSON-decodes each event `data` field with
- * a schema.
+ * Creates an SSE decoder channel that JSON-decodes each event `data` field with a schema.
+ *
+ * **Details**
  *
  * The output preserves the SSE `event` name and optional `id` while replacing
  * `data` with the decoded value.
@@ -156,6 +160,8 @@ export const decodeDataSchema = <Type, DecodingServices, IE, Done>(
 /**
  * Creates a stateful Server-Sent Events parser.
  *
+ * **Details**
+ *
  * Call `feed` with text chunks to parse `Event` and `Retry` values through the
  * callback, and call `reset` to clear any buffered event state.
  *
@@ -323,6 +329,8 @@ function hasBom(buffer: string) {
 /**
  * Stateful Server-Sent Events parser returned by `makeParser`.
  *
+ * **Details**
+ *
  * `feed` accepts additional text chunks and `reset` clears buffered parser state.
  *
  * @category decoding
@@ -336,6 +344,8 @@ export interface Parser {
 /**
  * Creates a channel that encodes `Event` values as Server-Sent Events text.
  *
+ * **Details**
+ *
  * If the upstream channel fails with `Retry`, the retry directive is written and
  * the encoder completes.
  *
@@ -368,6 +378,8 @@ export const encode = <IE, Done>(): Channel.Channel<
 /**
  * Creates an SSE encoder channel for values accepted by a schema.
  *
+ * **Details**
+ *
  * Values are schema-encoded to the untagged SSE event shape, transformed to
  * `Event`, and then written as Server-Sent Events text.
  *
@@ -408,9 +420,7 @@ export interface Encoder {
 }
 
 /**
- * Tagged model for a Server-Sent Events message.
- *
- * It contains the event name, optional event ID, and string data payload.
+ * Tagged model for a Server-Sent Events message containing the event name, optional event ID, and string data payload.
  *
  * @category models
  * @since 4.0.0
@@ -423,9 +433,7 @@ export interface Event {
 }
 
 /**
- * Schema for the untagged Server-Sent Events payload shape.
- *
- * The shape contains `id`, `event`, and string `data` fields.
+ * Schema for the untagged Server-Sent Events payload shape containing `id`, `event`, and string `data` fields.
  *
  * @category models
  * @since 4.0.0
@@ -441,10 +449,7 @@ export const EventEncoded: Schema.Struct<{
 })
 
 /**
- * Schema for the tagged Server-Sent Events message model.
- *
- * The schema adds `_tag: "Event"` to the event name, optional event ID, and
- * string data payload.
+ * Schema for the tagged Server-Sent Events message model that adds `_tag: "Event"` to the event name, optional event ID, and string data payload.
  *
  * @category models
  * @since 4.0.0
@@ -488,9 +493,7 @@ export const transformEvent = Transformation.transform<{
 })
 
 /**
- * Untagged Server-Sent Events payload shape.
- *
- * It contains the event name, optional event ID, and string data payload.
+ * Untagged Server-Sent Events payload shape containing the event name, optional event ID, and string data payload.
  *
  * @category models
  * @since 4.0.0
@@ -506,6 +509,8 @@ const RetryTypeId = "~effect/encoding/Sse/Retry" as const
 /**
  * Server-Sent Events retry directive.
  *
+ * **Details**
+ *
  * Decoders surface this value as a failure to request reconnection after
  * `duration`; encoders serialize an upstream `Retry` failure as a `retry:` line.
  *
@@ -552,6 +557,8 @@ export type AnyEvent = Event | Retry
 /**
  * Default Server-Sent Events encoder.
  *
+ * **Details**
+ *
  * It renders `Event` values as `id`, `event`, and `data` lines and renders
  * `Retry` values as `retry:` directives.
  *

package/src/unstable/eventlog/Event.ts

@@ -49,6 +49,8 @@ export const isEvent = (u: unknown): u is Event<any, any, any, any> => Predicate
 /**
  * Definition of an event type that can be written to an `EventLog`.
  *
+ * **Details**
+ *
  * An event definition contains its tag, primary-key function, payload schema,
  * MessagePack payload schema, success schema, and error schema.
  *
@@ -73,6 +75,8 @@ export interface Event<
 /**
  * Marker service associated with the handler for an event tag.
  *
+ * **Details**
+ *
  * `ToService` derives this service from an `Event` so handler layers can expose
  * which events they implement.
  *
@@ -87,6 +91,8 @@ export interface EventHandler<in out Tag extends string> {
 /**
  * Type-erased event log event definition.
  *
+ * **Details**
+ *
  * It preserves the runtime tag, primary-key function, payload schema, success
  * schema, and error schema without retaining the original type parameters.
  *
@@ -216,6 +222,8 @@ export type Payload<A extends Any> = Schema.Schema.Type<PayloadSchema<A>>
 /**
  * Tagged payload value for an event definition.
  *
+ * **Details**
+ *
  * The result contains `_tag` set to the event tag and `payload` set to the
  * decoded payload value.
  *
@@ -258,6 +266,8 @@ export type Success<A extends Any> = Schema.Schema.Type<SuccessSchema<A>>
 /**
  * Schema services required by a client for an event definition.
  *
+ * **Details**
+ *
  * This includes payload encoding services plus success and error decoding
  * services.
  *
@@ -278,6 +288,8 @@ export type ServicesClient<A> = A extends Event<
 /**
  * Schema services required by a server for an event definition.
  *
+ * **Details**
+ *
  * This includes payload decoding services plus success and error encoding
  * services.
  *
@@ -375,6 +387,8 @@ const Proto = {
 /**
  * Creates an event log event definition.
  *
+ * **Details**
+ *
  * If omitted, the payload and success schemas default to `Schema.Void`, the error
  * schema defaults to `Schema.Never`, and the MessagePack payload schema is derived
  * from the payload schema.
@@ -417,6 +431,8 @@ export function make(options: {
 /**
  * Adds another error schema to an event definition.
  *
+ * **Details**
+ *
  * The returned event keeps the same tag, primary key, payload, and success schema
  * while replacing the error schema with a union of the existing and new errors.
  *

package/src/unstable/eventlog/EventGroup.ts

@@ -50,6 +50,8 @@ export const isEventGroup = (u: unknown): u is Any => Predicate.hasProperty(u, T
  * Typed collection of event definitions that represents a portion of an event log
  * domain.
  *
+ * **When to use**
+ *
  * Build groups from `empty.add(...)`, then provide implementations for the events
  * with `EventLog.group`.
  *
@@ -187,6 +189,8 @@ const makeProto = <
 /**
  * Empty event group used as the starting point for defining a group.
  *
+ * **When to use**
+ *
  * Call `.add(...)` to add event definitions and build a typed `EventGroup`.
  *
  * @category constructors

package/src/unstable/eventlog/EventJournal.ts

@@ -35,6 +35,8 @@ import type { StoreId } from "./EventLogMessage.ts"
 /**
  * Context service for storing and replaying event journal entries.
  *
+ * **Details**
+ *
  * The service writes local entries, imports entries from remote journals, exposes
  * a stream of local changes, and provides per-store locking.
  *
@@ -61,6 +63,8 @@ export class EventJournal extends Context.Service<EventJournal, {
   /**
    * Write events from a remote source to the journal.
    *
+   * **Details**
+   *
    * Effects run sequentially in compaction bracket order.
    */
   readonly writeFromRemote: (
@@ -113,6 +117,8 @@ const TypeId = "effect/eventlog/EventJournal/EventJournalError" as const
 /**
  * Error raised by event journal operations.
  *
+ * **Details**
+ *
  * The error records the journal method that failed and the underlying cause.
  *
  * @category errors
@@ -165,6 +171,8 @@ export const RemoteId = Schema.Uint8Array.pipe(Schema.brand(RemoteIdTypeId))
 /**
  * Generates a new random `RemoteId`.
  *
+ * **Gotchas**
+ *
  * This is unsafe because the generated UUID bytes are cast to the brand without
  * schema validation.
  *
@@ -226,6 +234,8 @@ export const EntryIdOrder = Order.make<EntryId>((a, b) => {
  * Generates a UUID v7 `EntryId`, optionally using the supplied millisecond
  * timestamp.
  *
+ * **Gotchas**
+ *
  * This is unsafe because the generated UUID bytes are cast to the brand without
  * schema validation.
  *
@@ -250,6 +260,8 @@ export const entryIdMillis = (entryId: EntryId): number => {
 /**
  * Schema model for a committed event journal entry.
  *
+ * **Details**
+ *
  * An entry records its ID, event tag, primary key, and MessagePack-encoded
  * payload, with helpers for array MessagePack encoding and creation timestamps.
  *
@@ -321,6 +333,8 @@ export class Entry extends Schema.Class<Entry>("effect/eventlog/EventJournal/Ent
 /**
  * Schema model for an event journal entry received from a remote source.
  *
+ * **Details**
+ *
  * It pairs the remote sequence number with the journal entry payload.
  *
  * @category entry
@@ -334,6 +348,8 @@ export class RemoteEntry extends Schema.Class<RemoteEntry>("effect/eventlog/Even
 /**
  * Creates an in-memory `EventJournal` service.
  *
+ * **Gotchas**
+ *
  * Entries, remote tracking state, and locks live only in the current process and
  * are lost when the service is discarded.
  *
@@ -472,6 +488,8 @@ export const makeMemory: Effect.Effect<EventJournal["Service"]> = Effect.gen(fun
 /**
  * Layer that provides an in-memory `EventJournal`.
  *
+ * **Gotchas**
+ *
  * All journal data is stored in process memory and is not persisted across layer
  * lifetimes.
  *
@@ -483,6 +501,8 @@ export const layerMemory: Layer.Layer<EventJournal> = Layer.effect(EventJournal,
 /**
  * Creates an `EventJournal` backed by IndexedDB.
  *
+ * **Details**
+ *
  * The journal stores entries and remote replication metadata in the configured
  * browser database, publishes local changes, and requires `Scope` so the database
  * connection can be closed when the scope ends.

package/src/unstable/eventlog/EventLog.ts

@@ -46,6 +46,8 @@ import type { EventLogRemote } from "./EventLogRemote.ts"
 /**
  * Service for writing typed event-log events through registered handlers.
  *
+ * **Details**
+ *
  * `write` encodes the event payload, runs the matching handler, commits the entry
  * only when the handler succeeds, and exposes access to the underlying journal
  * entries and destroy operation.
@@ -175,6 +177,8 @@ export const layerRegistry = Layer.effect(
 /**
  * Event-log identity containing a public key and redacted private key material.
  *
+ * **Details**
+ *
  * The identity is used by remote replication for authentication and by the
  * encryption service to derive signing and encryption keys.
  *
@@ -257,6 +261,8 @@ export const HandlersTypeId: HandlersTypeId = "~effect/eventlog/EventLog/Handler
 /**
  * Builder for the handlers associated with an `EventGroup`.
  *
+ * **Details**
+ *
  * The `Events` type parameter tracks the event tags that still need handlers, and
  * each call to `handle` records a handler while accumulating any required
  * services.
@@ -337,6 +343,8 @@ export declare namespace Handlers {
   /**
    * Validates that a handler builder returned all required handlers.
    *
+   * **Details**
+   *
    * If any event tag remains unhandled, the type evaluates to an explanatory
    * compile-time error string.
    *
@@ -402,6 +410,8 @@ export declare namespace Handlers {
  * Context reference for the store id used by event-log writes and remote
  * replication.
  *
+ * **Details**
+ *
  * Defaults to the branded store id `"default"`.
  *
  * @category models
@@ -442,6 +452,8 @@ const IdentityStringSchema = Schema.StringFromBase64Url.pipe(
 /**
  * Decodes a base64url identity string produced by `encodeIdentityString`.
  *
+ * **Gotchas**
+ *
  * Invalid input throws a schema decoding error.
  *
  * @category constructors
@@ -514,6 +526,8 @@ const makeHandlers = (options: {
 /**
  * Creates a layer that registers handlers for every event in an event group.
  *
+ * **Details**
+ *
  * The callback receives a `Handlers` builder; its return type is checked so every
  * event in the group is handled.
  *
@@ -549,6 +563,8 @@ export const group = <Events extends Event.Any, Return>(
 /**
  * Registers a compaction handler for an event group.
  *
+ * **Details**
+ *
  * During remote replay, matching entries are decoded, grouped by primary key, and
  * passed to the compaction effect, which may write replacement entries.
  *
@@ -646,6 +662,8 @@ export const groupCompaction = <Events extends Event.Any, R>(
  * Registers reactivity keys to invalidate when events from a group are written or
  * replayed.
  *
+ * **Details**
+ *
  * Pass a single key list for all events or a mapping from event tag to key list.
  *
  * @category reactivity
@@ -675,6 +693,8 @@ export const groupReactivity = <Events extends Event.Any>(
 /**
  * Builds the effect used to replay entries received from a remote event log.
  *
+ * **Details**
+ *
  * The returned handler decodes the entry and conflicts with the registered event
  * schema, runs the matching handler with the supplied identity and store id, logs
  * failures, and invalidates configured reactivity keys.
@@ -960,6 +980,8 @@ export const layer = <Groups extends EventGroup.Any, E, R>(
  * Creates a typed client function for writing events defined by an
  * `EventLogSchema`.
  *
+ * **Details**
+ *
  * The returned function delegates to the `EventLog` service and preserves each
  * event's success and error types.
  *

package/src/unstable/eventlog/EventLogMessage.ts

@@ -62,6 +62,8 @@ export const StoreId = Schema.String.pipe(Schema.brand(StoreIdTypeId))
 /**
  * Structured error returned by event-log remote RPCs.
  *
+ * **Details**
+ *
  * It records the request tag, optional identity and store information, a protocol
  * error code, and a human-readable message.
  *
@@ -94,6 +96,8 @@ export class EventLogAuthentication extends RpcMiddleware.Service<EventLogAuthen
 /**
  * Response sent by the remote server during the authentication handshake.
  *
+ * **Details**
+ *
  * It contains the server remote id and a challenge that must be signed by the
  * client.
  *
@@ -155,6 +159,8 @@ export class SingleMessage
 /**
  * Transport message for one part of a large encoded event-log payload.
  *
+ * **When to use**
+ *
  * Use `split` to divide data into chunks and `join` to reassemble all chunks with
  * the same id once every part has arrived.
  *
@@ -252,6 +258,8 @@ export class WriteChunkedRpc extends Rpc.make("EventLog.WriteChunked", {
 /**
  * Msgpack-encodable payload for writing encrypted entries to a remote store.
  *
+ * **Details**
+ *
  * It includes the client public key, target store id, AES-GCM initialization
  * vector, and encrypted entries.
  *
@@ -311,6 +319,8 @@ export class WriteSingleRpc extends Rpc.make("EventLog.WriteSingle", {
  * Authenticated streaming RPC for reading remote event-log changes for a public
  * key and store id starting at a sequence number.
  *
+ * **Details**
+ *
  * Responses are encoded as either `SingleMessage` values or `ChunkedMessage`
  * parts.
  *

package/src/unstable/eventlog/EventLogRemote.ts

@@ -53,6 +53,8 @@ import { makeGetIdentityRootSecretMaterial } from "./internal/identityRootSecret
 /**
  * Service representing a remote event-log replica.
  *
+ * **Details**
+ *
  * It can write local entries to the remote, stream remote changes from a sequence
  * number, and run effects only after the supplied identity has authenticated.
  *
@@ -138,6 +140,8 @@ export class EventLogRemoteClient extends Context.Service<
  * Creates an `EventLogRemote` from custom write encoding and change decoding
  * functions.
  *
+ * **Details**
+ *
  * The remote performs the hello/authentication handshake, retries after forbidden
  * responses by re-authenticating, chunks large writes, and registers itself with
  * the `Registry` for the current scope.

package/src/unstable/eventlog/EventLogServer.ts

@@ -48,6 +48,8 @@ import * as EventLogSessionAuth from "./EventLogSessionAuth.ts"
  * Provides RPC authentication middleware that reads the authenticated
  * `EventLog.Identity` from client annotations.
  *
+ * **Details**
+ *
  * Requests without an identity fail with a forbidden `EventLogProtocolError`.
  *
  * @category layers
@@ -71,6 +73,8 @@ export const layerAuthMiddleware: Layer.Layer<
 /**
  * Creates the shared RPC handlers for the event-log remote protocol.
  *
+ * **Details**
+ *
  * The layer manages hello challenges, verifies session authentication, reassembles
  * chunked writes, delegates write and change handling to the supplied callbacks,
  * and frames large change payloads into chunks.

package/src/unstable/eventlog/EventLogServerEncrypted.ts

@@ -41,6 +41,8 @@ import * as EventLogServer from "./EventLogServer.ts"
 /**
  * Provides RPC handlers for the encrypted event-log server.
  *
+ * **Details**
+ *
  * Incoming encrypted write payloads are decoded and persisted through `Storage`;
  * change streams read encrypted entries from storage and encode them for the
  * remote protocol.
@@ -132,6 +134,8 @@ export class PersistedEntry extends Schema.Class<PersistedEntry>(
 /**
  * Storage service used by the encrypted event-log server.
  *
+ * **Details**
+ *
  * It provides the server remote id, stores session authentication bindings,
  * persists encrypted entries, and streams encrypted changes for a public key and
  * store id.
@@ -160,6 +164,8 @@ export class Storage extends Context.Service<Storage, {
 /**
  * Creates an in-memory encrypted server `Storage`.
  *
+ * **Details**
+ *
  * Data, session authentication bindings, and streams are process-local and are
  * released with the surrounding scope.
  *