@lunora/container 1.0.0-alpha.11 → 1.0.0-alpha.13

package/dist/index.d.mts

@@ -1,6 +1,9 @@
-import { D as DurableObjectJurisdiction, C as ContainerConfig, a as ContainerDefinition, b as ContainerImageSource, N as NormalizedContainerImage } from "./packem_shared/jurisdiction.d-TwTGkgTg.mjs";
-export type { B as BuildImageSource, c as ContainerInstanceType, d as ContainerReadinessCheck, e as ContainerRollout, f as CustomContainerInstanceType, g as NamedContainerInstanceType, R as RegistryImageSource } from "./packem_shared/jurisdiction.d-TwTGkgTg.mjs";
-/** Options for explicitly starting an instance (mirrors `@cloudflare/containers`). */
+import { D as DurableObjectJurisdiction, C as ContainerConfig, a as ContainerDefinition, b as ContainerImageSource, N as NormalizedContainerImage } from "./packem_shared/jurisdiction.d-8oUUvrew.mjs";
+export type { B as BuildImageSource, c as ContainerInstanceType, d as ContainerReadinessCheck, e as ContainerRollout, f as CustomContainerInstanceType, g as NamedContainerInstanceType, R as RegistryImageSource } from "./packem_shared/jurisdiction.d-8oUUvrew.mjs";
+/**
+ * Options for explicitly starting an instance (mirrors `@cloudflare/containers`).
+ * @experimental
+ */
 interface ContainerStartOptions {
   /** Override outbound internet access for this start. */
   enableInternet?: boolean;
@@ -11,7 +14,10 @@ interface ContainerStartOptions {
   /** Metadata labels attached for metrics/observability. */
   labels?: Record<string, string>;
 }
-/** A container instance's runtime state, as returned by `getState()`. Structural — the platform adds fields over time. */
+/**
+ * A container instance's runtime state, as returned by `getState()`. Structural — the platform adds fields over time.
+ * @experimental
+ */
 interface ContainerInstanceState {
   [key: string]: unknown;
   /** Process exit code, present once the instance has `stopped_with_code`. */
@@ -36,63 +42,70 @@ interface ContainerStubLike {
   start?: (options?: ContainerStartOptions) => Promise<void>;
   stop?: (signal?: number | string) => Promise<void>;
 }
-/** What the client needs from a Durable Object namespace binding. */
+/**
+ * What the client needs from a Durable Object namespace binding.
+ * @experimental
+ */
 interface ContainerNamespaceLike {
   get: (id: unknown) => ContainerStubLike;
   idFromName: (name: string) => unknown;
   /**
-  * Derive a jurisdiction-restricted subnamespace. Optional because older
-  * workers-types releases (and test doubles) may not expose it.
-  */
+   * Derive a jurisdiction-restricted subnamespace. Optional because older
+   * workers-types releases (and test doubles) may not expose it.
+   */
   jurisdiction?: (jurisdiction: DurableObjectJurisdiction) => ContainerNamespaceLike;
 }
-/** A handle on one container instance (one Durable Object). */
+/**
+ * A handle on one container instance (one Durable Object).
+ * @experimental
+ */
 interface ContainerHandle {
   /**
-  * Send an HTTP (or WebSocket-upgrade) request to the container. A path
-  * string (`"/transcode"`) is resolved against a synthetic origin; a full
-  * `Request`/URL passes through unchanged.
-  */
+   * Send an HTTP (or WebSocket-upgrade) request to the container. A path
+   * string (`"/transcode"`) is resolved against a synthetic origin; a full
+   * `Request`/URL passes through unchanged.
+   */
   fetch: (input: Request | string, init?: RequestInit) => Promise<Response>;
   /**
-  * Return a handle that routes every request to `targetPort` on the
-  * container instead of the definition's `defaultPort` — for multi-port
-  * containers (declare the ports in `requiredPorts`). Sets the
-  * `cf-container-target-port` header the way `@cloudflare/containers`'
-  * `switchPort` does, so it composes with `.get()`, `.any()`, and `.pool()`:
-  * `ctx.containers.app.get("u1").port(9090).fetch("/admin")`.
-  */
+   * Return a handle that routes every request to `targetPort` on the
+   * container instead of the definition's `defaultPort` — for multi-port
+   * containers (declare the ports in `requiredPorts`). Sets the
+   * `cf-container-target-port` header the way `@cloudflare/containers`'
+   * `switchPort` does, so it composes with `.get()`, `.any()`, and `.pool()`:
+   * `ctx.containers.app.get("u1").port(9090).fetch("/admin")`.
+   */
   port: (targetPort: number) => ContainerHandle;
 }
 /**
-* A handle on a *named* instance (from `.get(name)`) — `fetch` plus explicit
-* lifecycle control. The per-entity pattern (a sandbox per user, a room per
-* game, a job runner per id) often needs to tear down or inspect the instance
-* rather than wait for `sleepAfter`, so these wrap the container DO's
-* `start`/`stop`/`destroy`/`getState`.
-*/
+ * A handle on a *named* instance (from `.get(name)`) — `fetch` plus explicit
+ * lifecycle control. The per-entity pattern (a sandbox per user, a room per
+ * game, a job runner per id) often needs to tear down or inspect the instance
+ * rather than wait for `sleepAfter`, so these wrap the container DO's
+ * `start`/`stop`/`destroy`/`getState`.
+ * @experimental
+ */
 interface ContainerInstanceHandle extends ContainerHandle {
   /** Stop and discard the instance (its ephemeral disk is lost). */
   destroy: () => Promise<void>;
   /**
-  * Adjust this instance's egress allow/deny lists at runtime — the dynamic
-  * counterpart to the static `allowedHosts`/`deniedHosts` config. Useful for
-  * per-tenant egress policy. Requires the worker to export `ContainerProxy`
-  * (codegen re-exports it from the generated container file whenever any
-  * container is defined, so the runtime controls always work).
-  */
+   * Adjust this instance's egress allow/deny lists at runtime — the dynamic
+   * counterpart to the static `allowedHosts`/`deniedHosts` config. Useful for
+   * per-tenant egress policy. Requires the worker to export `ContainerProxy`
+   * (codegen re-exports it from the generated container file whenever any
+   * container is defined, so the runtime controls always work).
+   */
   egress: ContainerEgressControls;
   /** Read the instance's current runtime state. */
   getState: () => Promise<ContainerInstanceState>;
   /**
-  * Reset the instance's `sleepAfter` idle timer. The platform renews it on
-  * each proxied request, and because `@lunora/container` proxies WebSocket
-  * frames through the Durable Object, message traffic on an open socket
-  * renews it too (the WebSocket-keepalive gap of cloudflare/containers#147 is
-  * closed in the bundled base). This manual control is the escape hatch for
-  * keeping a container awake during activity that is neither an HTTP request
-  * nor a WS message — e.g. a long out-of-band job running inside it.
-  */
+   * Reset the instance's `sleepAfter` idle timer. The platform renews it on
+   * each proxied request, and because `@lunora/container` proxies WebSocket
+   * frames through the Durable Object, message traffic on an open socket
+   * renews it too (the WebSocket-keepalive gap of cloudflare/containers#147 is
+   * closed in the bundled base). This manual control is the escape hatch for
+   * keeping a container awake during activity that is neither an HTTP request
+   * nor a WS message — e.g. a long out-of-band job running inside it.
+   */
   renewActivityTimeout: () => Promise<void>;
   /** Explicitly start the instance, optionally with per-instance env/entrypoint. */
   start: (options?: ContainerStartOptions) => Promise<void>;
@@ -100,11 +113,12 @@ interface ContainerInstanceHandle extends ContainerHandle {
   stop: (signal?: number | string) => Promise<void>;
 }
 /**
-* Runtime egress-firewall controls for a named instance (`handle.egress.*`).
-* Each maps to the corresponding `@cloudflare/containers` `Container` RPC, so
-* an app can tighten or relax a single instance's allowed/denied hosts after
-* start without redeploying.
-*/
+ * Runtime egress-firewall controls for a named instance (`handle.egress.*`).
+ * Each maps to the corresponding `@cloudflare/containers` `Container` RPC, so
+ * an app can tighten or relax a single instance's allowed/denied hosts after
+ * start without redeploying.
+ * @experimental
+ */
 interface ContainerEgressControls {
   /** Add one hostname (or glob) to the allow-list. */
   allow: (hostname: string) => Promise<void>;
@@ -119,86 +133,96 @@ interface ContainerEgressControls {
   /** Replace the entire deny-list. */
   setDenied: (hosts: ReadonlyArray<string>) => Promise<void>;
 }
-/** The per-definition accessor exposed as `ctx.containers.&lt;exportName>`. */
+/**
+ * The per-definition accessor exposed as `ctx.containers.&lt;exportName>`.
+ * @experimental
+ */
 interface ContainerAccessor {
   /**
-  * A random instance from a fixed pool of `count` (defaults to the
-  * definition's `maxInstances`, else 3 — mirroring `getRandom` from
-  * `@cloudflare/containers`). For stateless, interchangeable workloads.
-  *
-  * Like `.get()`, a path/URL-string fetch transparently retries the
-  * cold-start "instance is provisioning" transients (cloudflare/containers#45,
-  * #139); pass {@link InstanceRetryOptions} to tune or disable it.
-  */
+   * A random instance from a fixed pool of `count` (defaults to the
+   * definition's `maxInstances`, else 3 — mirroring `getRandom` from
+   * `@cloudflare/containers`). For stateless, interchangeable workloads.
+   *
+   * Like `.get()`, a path/URL-string fetch transparently retries the
+   * cold-start "instance is provisioning" transients (cloudflare/containers#45,
+   * #139); pass {@link InstanceRetryOptions} to tune or disable it.
+   */
   any: (count?: number, options?: InstanceRetryOptions) => ContainerHandle;
   /**
-  * The instance for `name` — one container per entity (user, room, job…),
-  * with lifecycle control.
-  *
-  * A path/URL-string fetch transparently retries the platform's cold-start
-  * transients — "there is no Container instance available" / "container is
-  * not listening" while an instance is still provisioning
-  * (cloudflare/containers#45, #139) — on the *same* instance with backoff,
-  * since the request never reached the app. Pass {@link InstanceRetryOptions}
-  * to tune attempts/backoff or disable it (`{ attempts: 1 }`). A pre-built
-  * `Request` (possibly a one-shot stream body) is sent once, never retried.
-  */
+   * The instance for `name` — one container per entity (user, room, job…),
+   * with lifecycle control.
+   *
+   * A path/URL-string fetch transparently retries the platform's cold-start
+   * transients — "there is no Container instance available" / "container is
+   * not listening" while an instance is still provisioning
+   * (cloudflare/containers#45, #139) — on the *same* instance with backoff,
+   * since the request never reached the app. Pass {@link InstanceRetryOptions}
+   * to tune attempts/backoff or disable it (`{ attempts: 1 }`). A pre-built
+   * `Request` (possibly a one-shot stream body) is sent once, never retried.
+   */
   get: (name: string, options?: InstanceRetryOptions) => ContainerInstanceHandle;
   /**
-  * A resilient handle over the pool: each `fetch` picks a random instance and,
-  * on a thrown error or a retryable response (5xx by default), retries on a
-  * freshly-picked instance with exponential backoff. Until Cloudflare ships
-  * native autoscaling + health-aware routing this is the recommended way to
-  * call a stateless container pool — it rides over a single cold/unhealthy
-  * instance instead of failing the whole request.
-  *
-  * Because a retry re-issues the request, pass a **replayable** body — a path
-  * string plus an `init.body` string/`ArrayBuffer` (re-created each attempt).
-  * A pre-built `Request` carrying a stream body can only be sent once, so it
-  * is not retry-safe here; use `.get()`/`.any()` for those.
-  */
+   * A resilient handle over the pool: each `fetch` picks a random instance and,
+   * on a thrown error or a retryable response (5xx by default), retries on a
+   * freshly-picked instance with exponential backoff. Until Cloudflare ships
+   * native autoscaling + health-aware routing this is the recommended way to
+   * call a stateless container pool — it rides over a single cold/unhealthy
+   * instance instead of failing the whole request.
+   *
+   * Because a retry re-issues the request, pass a **replayable** body — a path
+   * string plus an `init.body` string/`ArrayBuffer` (re-created each attempt).
+   * A pre-built `Request` carrying a stream body can only be sent once, so it
+   * is not retry-safe here; use `.get()`/`.any()` for those.
+   */
   pool: (options?: PoolOptions) => ContainerHandle;
 }
-/** Tuning for a pooled, retrying container handle. See {@link ContainerAccessor.pool}. */
+/**
+ * Tuning for a pooled, retrying container handle. See {@link ContainerAccessor.pool}.
+ * @experimental
+ */
 interface PoolOptions {
   /** Total attempts before giving up (each on a freshly-picked instance). Default 3. */
   attempts?: number;
   /** Base backoff in ms between attempts; doubles each retry (0 disables the wait). Default 100. */
   backoffMs?: number;
   /**
-  * Upper bound on a single backoff sleep, in ms. The doubling delay is clamped
-  * to this ceiling so a large `attempts` count can't produce an unboundedly
-  * long wait. Default {@link DEFAULT_MAX_BACKOFF_MS} (30s).
-  */
+   * Upper bound on a single backoff sleep, in ms. The doubling delay is clamped
+   * to this ceiling so a large `attempts` count can't produce an unboundedly
+   * long wait. Default {@link DEFAULT_MAX_BACKOFF_MS} (30s).
+   */
   maxBackoffMs?: number;
   /**
-  * Whether a *returned* response should be retried on another instance.
-  * Defaults to retrying any `5xx`. A thrown error (network/start failure) is
-  * always retried regardless of this predicate.
-  */
+   * Whether a *returned* response should be retried on another instance.
+   * Defaults to retrying any `5xx`. A thrown error (network/start failure) is
+   * always retried regardless of this predicate.
+   */
   retryOn?: (response: Response) => boolean;
   /** Pool size to spread picks across. Defaults to the definition's `maxInstances`, else 3. */
   size?: number;
 }
 /**
-* Tuning for the cold-start retry on a `.get()`/`.any()` handle. The retry fires
-* only on the platform's provisioning transients (no-instance / not-listening /
-* rate-limited — see {@link isColdStartTransient}), which is why it's safe by
-* default: those responses mean the request never reached the container.
-*/
+ * Tuning for the cold-start retry on a `.get()`/`.any()` handle. The retry fires
+ * only on the platform's provisioning transients (no-instance / not-listening /
+ * rate-limited — see {@link isColdStartTransient}), which is why it's safe by
+ * default: those responses mean the request never reached the container.
+ * @experimental
+ */
 interface InstanceRetryOptions {
   /**
-  * Total attempts on a cold-start transient before the last outcome is
-  * surfaced as-is. `1` disables the retry. Default
-  * {@link DEFAULT_COLD_START_ATTEMPTS}.
-  */
+   * Total attempts on a cold-start transient before the last outcome is
+   * surfaced as-is. `1` disables the retry. Default
+   * {@link DEFAULT_COLD_START_ATTEMPTS}.
+   */
   attempts?: number;
   /** Base backoff in ms between attempts; doubles each retry (0 disables the wait). Default {@link DEFAULT_COLD_START_BACKOFF_MS}. */
   backoffMs?: number;
   /** Upper bound on a single backoff sleep, in ms. Default {@link DEFAULT_MAX_BACKOFF_MS} (30s). */
   maxBackoffMs?: number;
 }
-/** Wiring info for one definition, emitted by codegen into the generated DO. */
+/**
+ * Wiring info for one definition, emitted by codegen into the generated DO.
+ * @experimental
+ */
 interface ContainerBindingSpec {
   /** Durable Object binding name, e.g. `CONTAINER_TRANSCODER`. */
   binding: string;
@@ -208,73 +232,90 @@ interface ContainerBindingSpec {
   maxInstances?: number;
 }
 /**
-* Build the `ctx.containers` record from the Worker `env`. Called by the
-* generated ShardDO with the specs codegen derived from `lunora/containers.ts`.
-* A missing binding doesn't throw here — only when the handle is actually used —
-* so one unprovisioned container never breaks unrelated functions.
-*
-* `traceparent` (the inbound RPC's W3C trace context, forwarded by the runtime
-* and read off the request by the DO) is stamped onto every outbound container
-* `fetch`, so the container's own spans stitch under the Worker's trace.
-*/
+ * Build the `ctx.containers` record from the Worker `env`. Called by the
+ * generated ShardDO with the specs codegen derived from `lunora/containers.ts`.
+ * A missing binding doesn't throw here — only when the handle is actually used —
+ * so one unprovisioned container never breaks unrelated functions.
+ *
+ * `traceparent` (the inbound RPC's W3C trace context, forwarded by the runtime
+ * and read off the request by the DO) is stamped onto every outbound container
+ * `fetch`, so the container's own spans stitch under the Worker's trace.
+ * @experimental
+ */
 declare const createContainerContext: (env: Record<string, unknown>, specs: ReadonlyArray<ContainerBindingSpec>, jurisdiction?: DurableObjectJurisdiction, traceparent?: string) => Record<string, ContainerAccessor>;
-/** A test handler: receives the request plus the targeted instance name. */
+/**
+ * A test handler: receives the request plus the targeted instance name.
+ * @experimental
+ */
 type ContainerTestHandler = (request: Request, instance: {
   name: string;
 }) => Promise<Response> | Response;
 /**
-* Docker-free test double for `ctx.containers`: each export name maps to a
-* fetch handler that plays the container. Mirrors the real shape exactly, so
-* action handlers under test can't tell the difference.
-*
-* ```ts
-* const containers = createContainerTestContext({
-*     transcoder: (request) => new Response("ok"),
-* });
-* ```
-*/
+ * Docker-free test double for `ctx.containers`: each export name maps to a
+ * fetch handler that plays the container. Mirrors the real shape exactly, so
+ * action handlers under test can't tell the difference.
+ *
+ * ```ts
+ * const containers = createContainerTestContext({
+ *     transcoder: (request) => new Response("ok"),
+ * });
+ * ```
+ * @experimental
+ */
 declare const createContainerTestContext: (handlers: Record<string, ContainerTestHandler>) => Record<string, ContainerAccessor>;
 /**
-* Normalize a `ContainerImageSource` into the shape wrangler wants: a
-* Dockerfile path + build context for local builds, or a fully-qualified
-* reference for pre-built images.
-*
-* A local-path string whose basename starts with `Dockerfile` (so
-* `Dockerfile.dev` also counts) is used as-is with its directory as the build
-* context; any other path is treated as the build-context directory and the
-* Dockerfile is expected at `&lt;dir>/Dockerfile`.
-*/
+ * Normalize a `ContainerImageSource` into the shape wrangler wants: a
+ * Dockerfile path + build context for local builds, or a fully-qualified
+ * reference for pre-built images.
+ *
+ * A local-path string whose basename starts with `Dockerfile` (so
+ * `Dockerfile.dev` also counts) is used as-is with its directory as the build
+ * context; any other path is treated as the build-context directory and the
+ * Dockerfile is expected at `&lt;dir>/Dockerfile`.
+ * @experimental
+ */
 declare const normalizeContainerImage: (image: ContainerImageSource) => NormalizedContainerImage;
 /**
-* The generated Container DO class name for a `lunora/containers.ts` export:
-* `transcoder` → `TranscoderContainer`. wrangler's `containers[].class_name`
-* and the Durable Object binding's `class_name` both reference it, so codegen
-* and the config layer MUST derive it identically — always via this helper.
-*/
+ * The generated Container DO class name for a `lunora/containers.ts` export:
+ * `transcoder` → `TranscoderContainer`. wrangler's `containers[].class_name`
+ * and the Durable Object binding's `class_name` both reference it, so codegen
+ * and the config layer MUST derive it identically — always via this helper.
+ * @experimental
+ */
 declare const containerClassName: (exportName: string) => string;
 /**
-* The Durable Object binding name for a container export: `transcoder` →
-* `CONTAINER_TRANSCODER`, `imageResizer` → `CONTAINER_IMAGE_RESIZER`. The
-* `CONTAINER_` prefix namespaces these away from `SHARD`/`SESSION`/`SCHEDULER`
-* so a container export can never collide with the built-in bindings.
-*/
+ * The Durable Object binding name for a container export: `transcoder` →
+ * `CONTAINER_TRANSCODER`, `imageResizer` → `CONTAINER_IMAGE_RESIZER`. The
+ * `CONTAINER_` prefix namespaces these away from `SHARD`/`SESSION`/`SCHEDULER`
+ * so a container export can never collide with the built-in bindings.
+ * @experimental
+ */
 declare const containerBindingName: (exportName: string) => string;
 /**
-* The local image tag a Railpack `{ build }` container is built and pushed
-* under: `transcoder` → `lunora-transcoder:build`. The config reconciler writes
-* it as the wrangler `containers[].image`, and `lunora deploy` builds that tag
-* with Railpack and `wrangler containers push`es it before deploying — so all
-* three derive the tag from this one helper and can never disagree.
-*/
+ * The local image tag a Railpack `{ build }` container is built and pushed
+ * under: `transcoder` → `lunora-transcoder:build`. The config reconciler writes
+ * it as the wrangler `containers[].image`, and `lunora deploy` builds that tag
+ * with Railpack and `wrangler containers push`es it before deploying — so all
+ * three derive the tag from this one helper and can never disagree.
+ * @experimental
+ */
 declare const containerBuildTag: (exportName: string) => string;
+/**
+ * `defineContainer` is part of the experimental `@lunora/container` API and may change without a major version bump.
+ * @experimental
+ */
 declare const defineContainer: (config: ContainerConfig) => ContainerDefinition;
-/** True when a value is a `defineContainer` result (the runtime brand check). */
+/**
+ * True when a value is a `defineContainer` result (the runtime brand check).
+ * @experimental
+ */
 declare const isContainerDefinition: (value: unknown) => value is ContainerDefinition;
 /**
-* The container's full environment at instance start: the static `env` block
-* plus every declared secret resolved from the Worker `env`. A declared secret
-* missing from the Worker env fails fast — starting the container without a
-* credential it was promised yields far worse errors downstream.
-*/
+ * The container's full environment at instance start: the static `env` block
+ * plus every declared secret resolved from the Worker `env`. A declared secret
+ * missing from the Worker env fails fast — starting the container without a
+ * credential it was promised yields far worse errors downstream.
+ * @experimental
+ */
 declare const resolveContainerEnvVariables: (definition: ContainerDefinition, workerEnv: Record<string, unknown>, exportName?: string) => Record<string, string>;
 export { type ContainerAccessor, type ContainerBindingSpec, type ContainerConfig, type ContainerDefinition, type ContainerEgressControls, type ContainerHandle, type ContainerImageSource, type ContainerInstanceHandle, type ContainerInstanceState, type ContainerNamespaceLike, type ContainerStartOptions, type ContainerTestHandler, type DurableObjectJurisdiction, type InstanceRetryOptions, type NormalizedContainerImage, type PoolOptions, containerBindingName, containerBuildTag, containerClassName, createContainerContext, createContainerTestContext, defineContainer, isContainerDefinition, normalizeContainerImage, resolveContainerEnvVariables as resolveContainerEnvVars };