@spine-event-engine/delivery-client 2.0.0-snapshot.2

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,133 @@
+# Client for the Spine Delivery server
+
+Use this Node client when an application node must coordinate delivery work with
+a Delivery server on a trusted network. Start with the local server while
+developing; use the same client to connect separate application nodes to a
+remote Delivery server.
+
+The [reference](REFERENCE.md) records the complete protocol, retry, and limit
+contract, including API detail for coding agents.
+
+## 💡 Why use it?
+
+- ✅ Connects a Node process to a local or remote Delivery server.
+- ✅ Reads inbox work and current shard assignments.
+- ✅ Observes later shard changes without polling.
+- ✅ Adapts remote inbox and shard services to `DeliveryBuilder`.
+
+## 🚀 Connect and read
+
+Connect to an absolute HTTP(S) origin whose path is `/`. The client manages this
+connection and `close()` ends its active reads and streams.
+
+```ts
+// docs-snippet-path: packages/delivery-client/src/client/client.ts
+import { DeliveryClient } from "@spine-event-engine/delivery-client";
+
+const client = DeliveryClient.connectTo("http://127.0.0.1:8484", { pageSize: 100 });
+const shards = await client.shardSnapshot();
+client.close();
+void shards;
+```
+
+Read operations can use the configured bounded retry policy. Mutations never
+retry automatically: a lost mutation response means the remote outcome is
+unknown and must be reconciled before any later action.
+
+```ts
+// docs-snippet-path: packages/delivery-client/src/client/client.ts
+import { DeliveryOutcomeUnknownError } from "@spine-event-engine/delivery-client";
+
+try {
+  // await client.writeOne(message);
+} catch (error) {
+  if (error instanceof DeliveryOutcomeUnknownError) {
+    // Read the fact named by error.reconciliation; do not repeat the mutation.
+  }
+}
+```
+
+## 👀 Observe shards
+
+Use a snapshot to establish current facts and an observation stream for later
+hints. Cancel the stream when it is no longer needed.
+
+```ts
+// docs-snippet-path: packages/delivery-client/src/client/client.ts
+import { DeliveryClient } from "@spine-event-engine/delivery-client";
+
+declare const client: DeliveryClient;
+const updates = client.observeShardUpdates({ timeoutMs: 5_000 });
+for await (const update of updates) {
+  console.log(update.shard, update.status);
+  updates.cancel();
+}
+```
+
+Here `timeoutMs` bounds setup through the first acknowledgement only; it never
+ends an acknowledged observation stream.
+
+`RemoteInbox` and `RemoteWorkRegistry` adapt a client to a server
+`DeliveryBuilder`. The authoritative delivery state is the remote Inbox row and
+the current shard lease; the client keeps no local removal record. A delivered
+row is the deduplication fact, but a handler effect and its acknowledgement are
+not one transaction. If an acknowledgement is lost, delivery can happen again
+after restart, so make downstream effects idempotent.
+
+```ts
+// docs-snippet-path: packages/delivery-client/src/remote/adapters.ts
+import {
+  DeliveryClient,
+  RemoteInbox,
+  RemoteWorkRegistry,
+} from "@spine-event-engine/delivery-client";
+import { DeliveryBuilder } from "@spine-event-engine/server";
+
+const client = DeliveryClient.connectTo("http://127.0.0.1:8484");
+const delivery = new DeliveryBuilder()
+  .withNode("orders-worker")
+  .withInbox(new RemoteInbox(client))
+  .withWorkRegistry(new RemoteWorkRegistry(client))
+  .build();
+client.close();
+void delivery;
+```
+
+For server assembly, pass one `RemoteDelivery` to the environment instead of
+manually wiring adapters. Each attached environment gets a bounded Admin
+snapshot and later shard-update hints; after a stream loss or bounded-buffer
+overflow it takes a fresh snapshot before resuming updates. Inbox rows and the
+exclusive shard session remain authoritative, so notifications are best-effort
+wake-ups. `open()` runs before the first attachment/listener admission. A
+failed bounded readiness check closes its fresh client and can be retried.
+
+When identically configured application nodes share a Delivery server, every
+node observes and attempts each reported shard. The remote registry admits one
+owner for a shard at a time; updates are only hints recovered through a bounded
+snapshot, and the facility makes no ordering promise across different shards.
+The winning owner repeats finite Inbox drains until no deliverable rows remain,
+including rows that arrive while a drain is active, before it releases the
+shard. A pre-commit ownership probe fences known stale owners, but it is not a
+linearizable distributed transaction with Entity storage.
+
+```ts
+// docs-snippet-path: packages/delivery-client/src/remote/remote-delivery.ts
+import { RemoteDelivery } from "@spine-event-engine/delivery-client";
+
+const delivery = RemoteDelivery.connectTo({ endpoint: "https://delivery.example.test" });
+void delivery;
+```
+
+## ⚠️ Design for redelivery
+
+Read operations may use the configured bounded retry policy. Mutations do not
+retry automatically: if a response is lost, first read the named fact and
+decide what happened. The protocol is unauthenticated and offers no durable
+client state, exactly-once effects, or renewable fencing. It does not persist
+attempt history or quarantine records.
+
+## 🔗 Learn more
+
+- [Delivery server](../delivery-server/README.md)
+- [Server delivery APIs](../server/README.md#delivery-and-environment)
+- [Detailed delivery reference](REFERENCE.md)

package/REFERENCE.md

@@ -0,0 +1,89 @@
+# @spine-event-engine/delivery-client reference
+
+This reference gives the exact public Node Delivery client contract. Read the
+[package guide](README.md) first for the local-to-remote delivery path.
+
+## Construction and lifecycle
+
+`DeliveryClient.connectTo(origin, options?)` accepts an absolute HTTP(S) origin
+with pathname `/`, validates options before opening a Connect HTTP/2
+session, and returns a client. `usingTransport(transport, options?)` is the
+advanced form for a Connect transport supplied by the caller; closing that client does not
+close the supplied transport. `close()` is synchronous and idempotent. It
+aborts active reads and observation streams and closes its session once.
+
+Options default to page size 100, no read retry, no retry backoff, no observation
+reconnect, no reconnect backoff, observation buffer 100, and operation timeout
+30000 ms. Page size is 1–1000; retry/reconnect counts are 0–5; backoffs are
+0–10000 ms; observation buffers are 1–1000; finite-operation and observation-setup timeouts are
+1–120000 ms.
+
+Worker `nodeId` and `value` must be non-blank and together at most 128 UTF-8
+bytes. Decoded payloads must be Command or Event envelopes. The client rejects
+payloads above 1 MiB, RPC request/response bodies above 4 MiB, batches above
+100, and pages above 1000.
+
+## Operations and unknown outcomes
+
+`findOne`, `readPage`, `newestPending`, and `shardSnapshot` are safe reads and
+can use bounded retries. `writeOne`, `writeMany`, `removeOne`, `removeMany`,
+`pickUp`, `release`, and `releaseExpired` are single-attempt mutations. A lost
+mutation response raises `DeliveryOutcomeUnknownError`; inspect its
+`reconciliation` instruction, read the remote fact, and do not blindly repeat
+the mutation.
+
+`readPage` uses the frozen timestamp-only continuation. If a full timestamp
+boundary cannot continue without loss, it throws `DeliveryPagingError`.
+Protocol-invalid data throws `DeliveryProtocolError`.
+
+## Observation and topology
+
+`observeShardUpdates()` requires one acknowledgement, has a bounded queue, and
+reconnects only within configured limits. A slow consumer can receive
+`ShardObservationOverflowError`; an unrecoverable stream ends with
+`DeliveryShardObservationError`. Its setup timeout never limits an acknowledged active stream. Observation is a hint: reconcile a known
+mutation with `shardSnapshot()` before a later action.
+
+The remote protocol has no renewable lease fence or separate per-pickup-time
+fence. Release is conditional on the supplied worker matching the current
+owner, so a stale worker cannot release a newer worker's session. A `PICKED`
+observation does not clear uncertainty; only `NOT_PICKED` invalidates a stale
+local session and permits a new pickup. Do not release a stale session.
+
+`RemoteInbox` and `RemoteWorkRegistry` satisfy the server delivery-builder
+ports. `RemoteInbox` rereads the exact pending remote row before acknowledgement
+and calls the authoritative removal operation directly. It creates no local
+attempt history, receipt, fingerprint, or quarantine record. Shard ownership excludes concurrent
+delivery and delivered rows are the deduplication fact. Handler effects and the
+delivered transition are not transactional: a lost acknowledgement can
+redeliver after restart, so downstream handling must be idempotent. This
+package does not add authentication, authorization, durability, exactly-once
+effects, or a production topology.
+
+## Remote delivery in an environment
+
+`RemoteDelivery.connectTo({ endpoint, clientOptions? })` creates one lazy
+`ServerEnvironmentDelivery`. Its `open()` creates one client plus one remote
+inbox and work registry, then completes the client's bounded `shardSnapshot()`
+readiness call before publishing those generic ports and its Admin source.
+Every attached environment supervisor takes bounded snapshots, consumes later
+updates as wake-up hints, and takes a fresh snapshot after a watch failure or
+bounded observation overflow before consuming updates again. Durable Inbox rows
+and exclusive shard pickup remain authoritative. Concurrent opens share an
+attempt. A failed attempt closes only its client, and a later open creates a
+fresh client.
+
+Every identically configured node observes and attempts every reported shard.
+The remote registry admits exactly one current owner per shard; notifications
+are best-effort hints and snapshot recovery is the convergent source after a
+stream break or bounded overflow. The winning owner repeats finite drains until
+no deliverable Inbox row remains, including rows arriving during an active
+drain, before release. There is no ordering guarantee across shards. The
+immediate pre-commit ownership probe fences a detected stale owner, but cannot
+make remote ownership and Entity storage one linearizable distributed
+transaction.
+
+Environment shutdown closes the client's HTTP/2 session. Concurrent/repeated
+close calls share work; a failed phase is the only phase retried. This adds no
+health route, provider selector, worker, or
+delivery-server mode.

package/dist/client/client.d.ts

@@ -0,0 +1,143 @@
+import { type Transport } from "@connectrpc/connect";
+import type { InboxMessage, InboxMessageId } from "@spine-event-engine/server";
+import { ShardIndex } from "@spine-event-engine/server";
+import { type DeliveryClientOptions, type DeliveryFindOneOptions, type DeliveryMutationOptions, type DeliveryReadPageOptions, type DeliveryShardObservationStream, type DeliveryWorkerId, type ReleasedShardSession, type RemoteShardObservation, type RemoteShardSession } from "./types.js";
+export { DeliveryOutcomeUnknownError, DeliveryPagingError, DeliveryProtocolError, DeliveryShardObservationError, ShardObservationOverflowError, MAX_DELIVERY_BATCH_MESSAGES, MAX_INBOX_PAYLOAD_BYTES, MAX_DELIVERY_RPC_BYTES, } from "./types.js";
+export type { DeliveryClientOptions, DeliveryFindOneOptions, DeliveryMutationOptions, DeliveryReadPageOptions, DeliveryShardObservationStream, DeliveryWorkerId, ReleasedShardSession, RemoteShardObservation, RemoteShardSession, } from "./types.js";
+/**
+ * Provides a Node client for the frozen delivery-server gRPC API.
+ */
+export declare class DeliveryClient {
+    #private;
+    private constructor();
+    /**
+     * Gets the bounded page size configured for this client.
+     * @returns The maximum number of messages requested by default.
+     */
+    get pageSize(): number;
+    /**
+     * Creates a client over a caller-owned standard Connect transport.
+     * @param transport Sends requests to the remote delivery service.
+     * @param options Configures bounded reads and observations.
+     * @returns A client that never closes the supplied transport.
+     */
+    static usingTransport(transport: Transport, options?: DeliveryClientOptions): DeliveryClient;
+    /**
+     * Connects to a JVM delivery server with a client-owned HTTP/2 gRPC session.
+     *
+     * The URL and options are validated before opening the session. `close()` is
+     * synchronous: it aborts active calls and the owned session immediately; it
+     * does not wait for remote stream cleanup. Use {@link usingTransport} when
+     * the caller owns the transport lifecycle.
+     * @param baseUrl Supplies the absolute HTTP(S) delivery-server origin.
+     * @param options Configures bounded reads and observations.
+     * @returns A client that aborts its owned session when closed.
+     */
+    static connectTo(baseUrl: string, options?: DeliveryClientOptions): DeliveryClient;
+    /**
+     * Reads validated detached Admin observations.
+     * @param options Bounds or cancels the read.
+     * @returns Detached observations that callers may safely mutate.
+     */
+    shardSnapshot(options?: DeliveryFindOneOptions): Promise<readonly RemoteShardObservation[]>;
+    /**
+     * Starts an ACK-gated Admin shard-update observation stream.
+     * @param options Bounds stream setup and cancels its lifetime.
+     * @returns A cancellable stream of detached shard observations.
+     */
+    observeShardUpdates(options?: DeliveryFindOneOptions): DeliveryShardObservationStream;
+    /**
+     * Finds and decodes one inbox message.
+     * @param id Identifies the inbox message and its shard.
+     * @param options Bounds or cancels the safe read.
+     * @returns The detached message, or `undefined` when absent.
+     */
+    findOne(id: InboxMessageId, options?: DeliveryFindOneOptions): Promise<InboxMessage | undefined>;
+    /**
+     * Reads and decodes the first bounded ordered page for one shard.
+     *
+     * A server rejects an encoded response above 4 MiB with `RESOURCE_EXHAUSTED`;
+     * retry this safe read with a smaller `pageSize`.
+     * @param shardIndex Identifies the shard to read.
+     * @param options Supplies page continuation, size, and read bounds.
+     * @returns Detached messages in remote timestamp order.
+     */
+    readPage(shardIndex: ShardIndex, options?: DeliveryReadPageOptions): Promise<readonly InboxMessage[]>;
+    /**
+     * Finds and decodes the newest pending message in a shard.
+     * @param shardIndex Identifies the shard to inspect.
+     * @param options Bounds or cancels the safe read.
+     * @returns The detached newest message, or `undefined` when absent.
+     */
+    newestPending(shardIndex: ShardIndex, options?: DeliveryFindOneOptions): Promise<InboxMessage | undefined>;
+    /**
+     * Writes one message with exactly one delivery-server RPC attempt.
+     * @param message Supplies the message to write.
+     * @param options Bounds or cancels the mutation.
+     * @returns A promise that completes after the delivery server accepts the message.
+     */
+    writeOne(message: InboxMessage, options?: DeliveryMutationOptions): Promise<void>;
+    /**
+     * Removes one message with exactly one delivery-server RPC attempt.
+     * @param message Supplies the message to remove.
+     * @param options Bounds or cancels the mutation.
+     * @returns A promise that completes after the delivery server removes the message.
+     */
+    removeOne(message: InboxMessage, options?: DeliveryMutationOptions): Promise<void>;
+    /**
+     * Writes one bounded same-shard batch with exactly one delivery-server RPC attempt.
+     * @param messages Supplies the messages to write.
+     * @param options Bounds or cancels the mutation.
+     * @returns A promise that completes after the delivery server accepts the batch.
+     */
+    writeMany(messages: readonly InboxMessage[], options?: DeliveryMutationOptions): Promise<void>;
+    /**
+     * Removes one bounded same-shard batch with exactly one delivery-server RPC attempt.
+     * @param messages Supplies the messages to remove.
+     * @param options Bounds or cancels the mutation.
+     * @returns A promise that completes after the delivery server removes the batch.
+     */
+    removeMany(messages: readonly InboxMessage[], options?: DeliveryMutationOptions): Promise<void>;
+    /**
+     * Acquires a shard once.
+     * @param shardIndex Identifies the shard to acquire.
+     * @param workerId Identifies the worker requesting exclusive ownership.
+     * @param options Bounds or cancels the mutation.
+     * @returns A detached exclusive session, or `undefined` when held elsewhere.
+     */
+    pickUp(shardIndex: ShardIndex, workerId: DeliveryWorkerId, options?: DeliveryMutationOptions): Promise<RemoteShardSession | undefined>;
+    /**
+     * Performs one exclusive shard-session release.
+     * @param value Supplies the session to release.
+     * @param options Bounds or cancels the mutation.
+     * @returns A promise that completes after the delivery server releases the session.
+     */
+    release(value: RemoteShardSession, options?: DeliveryMutationOptions): Promise<void>;
+    /**
+     * Performs releases for sessions inactive for a positive duration.
+     * @param inactivityMs Supplies the minimum inactivity in milliseconds.
+     * @param options Bounds or cancels the mutation.
+     * @returns Detached sessions released by the remote service.
+     */
+    releaseExpired(inactivityMs: number, options?: DeliveryMutationOptions): Promise<readonly ReleasedShardSession[]>;
+    /**
+     * Closes this client by permanently aborting active reads and streams. This synchronous, idempotent
+     * method also aborts an owned HTTP/2 session, but never closes injected transport.
+     */
+    close(): void;
+}
+type RemoteShardProbe = Readonly<{
+    readonly kind: "PICKED";
+    readonly session: RemoteShardSession;
+}> | Readonly<{
+    readonly kind: "ALREADY_PICKED";
+    readonly session: RemoteShardSession;
+}>;
+/**
+ * Provides package-internal frozen-wire ownership probes without extending the public client API.
+ */
+export declare const deliveryClientAccess: Readonly<{
+    probePickUp: (client: DeliveryClient, shardIndex: ShardIndex, workerId: DeliveryWorkerId, options: DeliveryMutationOptions) => Promise<RemoteShardProbe>;
+    observeOnce: (client: DeliveryClient, options?: DeliveryFindOneOptions) => DeliveryShardObservationStream;
+}>;
+//# sourceMappingURL=client.d.ts.map

package/dist/client/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/client/client.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAoC,KAAK,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAGvF,OAAO,KAAK,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC/E,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAoBxD,OAAO,EAIL,KAAK,qBAAqB,EAC1B,KAAK,sBAAsB,EAC3B,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC5B,KAAK,8BAA8B,EACnC,KAAK,gBAAgB,EACrB,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC3B,KAAK,kBAAkB,EACxB,MAAM,YAAY,CAAC;AAIpB,OAAO,EACL,2BAA2B,EAC3B,mBAAmB,EACnB,qBAAqB,EACrB,6BAA6B,EAC7B,6BAA6B,EAC7B,2BAA2B,EAC3B,uBAAuB,EACvB,sBAAsB,GACvB,MAAM,YAAY,CAAC;AACpB,YAAY,EACV,qBAAqB,EACrB,sBAAsB,EACtB,uBAAuB,EACvB,uBAAuB,EACvB,8BAA8B,EAC9B,gBAAgB,EAChB,oBAAoB,EACpB,sBAAsB,EACtB,kBAAkB,GACnB,MAAM,YAAY,CAAC;AAEpB;;GAEG;AACH,qBAAa,cAAc;;IAczB,OAAO;IA4BP;;;OAGG;IACH,IAAI,QAAQ,IAAI,MAAM,CAErB;IAED;;;;;OAKG;IACH,MAAM,CAAC,cAAc,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,GAAE,qBAA0B,GAAG,cAAc;IAIhG;;;;;;;;;;OAUG;IACH,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,qBAA0B,GAAG,cAAc;IAkBtF;;;;OAIG;IACG,aAAa,CACjB,OAAO,GAAE,sBAA2B,GACnC,OAAO,CAAC,SAAS,sBAAsB,EAAE,CAAC;IAa7C;;;;OAIG;IACH,mBAAmB,CAAC,OAAO,GAAE,sBAA2B,GAAG,8BAA8B;IA0CzF;;;;;OAKG;IACG,OAAO,CACX,EAAE,EAAE,cAAc,EAClB,OAAO,GAAE,sBAA2B,GACnC,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC;IAepC;;;;;;;;OAQG;IACG,QAAQ,CACZ,UAAU,EAAE,UAAU,EACtB,OAAO,GAAE,uBAA4B,GACpC,OAAO,CAAC,SAAS,YAAY,EAAE,CAAC;IAyBnC;;;;;OAKG;IACG,aAAa,CACjB,UAAU,EAAE,UAAU,EACtB,OAAO,GAAE,sBAA2B,GACnC,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC;IAYpC;;;;;OAKG;IACG,QAAQ,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,GAAE,uBAA4B,GAAG,OAAO,CAAC,IAAI,CAAC;IAS3F;;;;;OAKG;IACG,SAAS,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,GAAE,uBAA4B,GAAG,OAAO,CAAC,IAAI,CAAC;IAS5F;;;;;OAKG;IACG,SAAS,CACb,QAAQ,EAAE,SAAS,YAAY,EAAE,EACjC,OAAO,GAAE,uBAA4B,GACpC,OAAO,CAAC,IAAI,CAAC;IAShB;;;;;OAKG;IACG,UAAU,CACd,QAAQ,EAAE,SAAS,YAAY,EAAE,EACjC,OAAO,GAAE,uBAA4B,GACpC,OAAO,CAAC,IAAI,CAAC;IAShB;;;;;;OAMG;IACG,MAAM,CACV,UAAU,EAAE,UAAU,EACtB,QAAQ,EAAE,gBAAgB,EAC1B,OAAO,GAAE,uBAA4B,GACpC,OAAO,CAAC,kBAAkB,GAAG,SAAS,CAAC;IAwD1C;;;;;OAKG;IACG,OAAO,CAAC,KAAK,EAAE,kBAAkB,EAAE,OAAO,GAAE,uBAA4B,GAAG,OAAO,CAAC,IAAI,CAAC;IAoB9F;;;;;OAKG;IACG,cAAc,CAClB,YAAY,EAAE,MAAM,EACpB,OAAO,GAAE,uBAA4B,GACpC,OAAO,CAAC,SAAS,oBAAoB,EAAE,CAAC;IAyB3C;;;OAGG;IACH,KAAK,IAAI,IAAI;CAuFd;AAED,KAAK,gBAAgB,GACjB,QAAQ,CAAC;IAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IAAC,QAAQ,CAAC,OAAO,EAAE,kBAAkB,CAAA;CAAE,CAAC,GAC3E,QAAQ,CAAC;IAAE,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC;IAAC,QAAQ,CAAC,OAAO,EAAE,kBAAkB,CAAA;CAAE,CAAC,CAAC;AAgBxF;;GAEG;AACH,eAAO,MAAM,oBAAoB,EAAE,QAAQ,CAAC;IAC1C,WAAW,EAAE,CACX,MAAM,EAAE,cAAc,EACtB,UAAU,EAAE,UAAU,EACtB,QAAQ,EAAE,gBAAgB,EAC1B,OAAO,EAAE,uBAAuB,KAC7B,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAC/B,WAAW,EAAE,CACX,MAAM,EAAE,cAAc,EACtB,OAAO,CAAC,EAAE,sBAAsB,KAC7B,8BAA8B,CAAC;CACrC,CAoBC,CAAC"}