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

package/dist/otel.d.ts

@@ -1,12 +1,16 @@
-/** An attribute value carried on a span or log. */
+/**
+ * An attribute value carried on a span or log.
+ * @experimental
+ */
 type ContainerAttributeValue = boolean | number | string;
 /**
-* A `fetch` implementation — defaults to the runtime global. The exporter passes
-* an abort `signal` (for the per-request timeout) and, once the promise settles,
-* cancels the response `body` so Node/undici can release the socket for
-* keep-alive reuse instead of leaving it occupied by an unread stream. It reads
-* `ok`/`status` to detect a rejected export and nothing else from the response.
-*/
+ * A `fetch` implementation — defaults to the runtime global. The exporter passes
+ * an abort `signal` (for the per-request timeout) and, once the promise settles,
+ * cancels the response `body` so Node/undici can release the socket for
+ * keep-alive reuse instead of leaving it occupied by an unread stream. It reads
+ * `ok`/`status` to detect a rejected export and nothing else from the response.
+ * @experimental
+ */
 type OtelFetchLike = (input: string, init: {
   body: string;
   headers: Record<string, string>;
@@ -19,7 +23,10 @@ type OtelFetchLike = (input: string, init: {
   ok: boolean;
   status: number;
 }>;
-/** A single span the container process asks the exporter to record. */
+/**
+ * A single span the container process asks the exporter to record.
+ * @experimental
+ */
 interface ContainerSpanInput {
   /** Attributes attached to the span (rendered under the OTLP `attributes` list). */
   attributes?: Record<string, ContainerAttributeValue>;
@@ -35,7 +42,10 @@ interface ContainerSpanInput {
   /** Wall-clock millis when the operation started. */
   startMs: number;
 }
-/** A single log line the container process asks the exporter to record. */
+/**
+ * A single log line the container process asks the exporter to record.
+ * @experimental
+ */
 interface ContainerLogInput {
   /** Attributes attached to the log record. */
   attributes?: Record<string, ContainerAttributeValue>;
@@ -46,7 +56,10 @@ interface ContainerLogInput {
   /** Wall-clock millis the line was emitted; defaults to now. */
   ts?: number;
 }
-/** Options for {@link createContainerTelemetry}. */
+/**
+ * Options for {@link createContainerTelemetry}.
+ * @experimental
+ */
 interface ContainerTelemetryOptions {
   /** Base OTLP collector endpoint; defaults to the `LUNORA_OTLP_ENDPOINT` env var. */
   endpoint?: string;
@@ -63,30 +76,33 @@ interface ContainerTelemetryOptions {
   /** Bearer token sent as an `Authorization: Bearer` header; defaults to the `LUNORA_OTLP_TOKEN` env var. */
   token?: string;
   /**
-  * W3C `traceparent` of the Worker RPC that invoked this container; defaults to
-  * the `LUNORA_TRACEPARENT` env var. When present (and well-formed) every span
-  * inherits its trace id and hangs off its span id, so container spans stitch
-  * under the Worker's trace instead of forming a fresh, disconnected trace.
-  *
-  * `@lunora/container` stamps this trace context as the **`traceparent` request
-  * header** on every proxied fetch (`ctx.containers.&lt;name>.…`), so a container
-  * that serves many requests should read it per request and create a telemetry
-  * instance scoped to that request — the trace context differs each call, so a
-  * single process-lifetime instance can't carry it:
-  *
-  * ```ts
-  * // inside the container's request handler
-  * const telemetry = createContainerTelemetry({ traceparent: request.headers.get("traceparent") ?? undefined });
-  * await telemetry.trace("transcode", () => transcode(job));
-  * await telemetry.flush();
-  * ```
-  *
-  * The `LUNORA_TRACEPARENT` env fallback fits a one-shot container that
-  * processes a single job per start (the value is fixed for the process).
-  */
+   * W3C `traceparent` of the Worker RPC that invoked this container; defaults to
+   * the `LUNORA_TRACEPARENT` env var. When present (and well-formed) every span
+   * inherits its trace id and hangs off its span id, so container spans stitch
+   * under the Worker's trace instead of forming a fresh, disconnected trace.
+   *
+   * `@lunora/container` stamps this trace context as the **`traceparent` request
+   * header** on every proxied fetch (`ctx.containers.&lt;name>.…`), so a container
+   * that serves many requests should read it per request and create a telemetry
+   * instance scoped to that request — the trace context differs each call, so a
+   * single process-lifetime instance can't carry it:
+   *
+   * ```ts
+   * // inside the container's request handler
+   * const telemetry = createContainerTelemetry({ traceparent: request.headers.get("traceparent") ?? undefined });
+   * await telemetry.trace("transcode", () => transcode(job));
+   * await telemetry.flush();
+   * ```
+   *
+   * The `LUNORA_TRACEPARENT` env fallback fits a one-shot container that
+   * processes a single job per start (the value is fixed for the process).
+   */
   traceparent?: string;
 }
-/** The exporter handle {@link createContainerTelemetry} returns. */
+/**
+ * The exporter handle {@link createContainerTelemetry} returns.
+ * @experimental
+ */
 interface ContainerTelemetry {
   /** Record one log line (no-op when disabled). */
   emitLog: (log: ContainerLogInput) => void;
@@ -100,19 +116,20 @@ interface ContainerTelemetry {
   trace: <T>(name: string, run: () => Promise<T>, attributes?: Record<string, ContainerAttributeValue>) => Promise<T>;
 }
 /**
-* Create a zero-config OTLP exporter for the container process.
-*
-* ```ts
-* const telemetry = createContainerTelemetry(); // reads LUNORA_OTLP_ENDPOINT / _TOKEN
-* await telemetry.trace("transcode", () => transcode(job), { jobId: job.id });
-* telemetry.emitLog({ level: "info", message: "done", attributes: { jobId: job.id } });
-* await telemetry.flush(); // before the process exits
-* ```
-*
-* With no endpoint resolvable the returned exporter is disabled (`enabled ===
-* false`): `emitSpan`/`emitLog` no-op and `trace` still runs its work but records
-* nothing — so the same code runs unchanged locally and in the cloud.
-* @param options Exporter options; every field falls back to a `LUNORA_*` env var.
-*/
+ * Create a zero-config OTLP exporter for the container process.
+ *
+ * ```ts
+ * const telemetry = createContainerTelemetry(); // reads LUNORA_OTLP_ENDPOINT / _TOKEN
+ * await telemetry.trace("transcode", () => transcode(job), { jobId: job.id });
+ * telemetry.emitLog({ level: "info", message: "done", attributes: { jobId: job.id } });
+ * await telemetry.flush(); // before the process exits
+ * ```
+ *
+ * With no endpoint resolvable the returned exporter is disabled (`enabled ===
+ * false`): `emitSpan`/`emitLog` no-op and `trace` still runs its work but records
+ * nothing — so the same code runs unchanged locally and in the cloud.
+ * @param options Exporter options; every field falls back to a `LUNORA_*` env var.
+ * @experimental
+ */
 declare const createContainerTelemetry: (options?: ContainerTelemetryOptions) => ContainerTelemetry;
 export { type ContainerAttributeValue, type ContainerLogInput, type ContainerSpanInput, type ContainerTelemetry, type ContainerTelemetryOptions, type OtelFetchLike, createContainerTelemetry };

package/dist/otel.mjs

@@ -3,10 +3,14 @@ const OTLP_SEVERITY = {
   // DEBUG
   error: 17,
   // ERROR
+  fatal: 21,
+  // FATAL
   info: 9,
   // INFO
   log: 9,
   // INFO
+  trace: 1,
+  // TRACE
   warn: 13
   // WARN
 };

package/dist/packem_shared/jurisdiction.d-8oUUvrew.d.mts

@@ -0,0 +1,281 @@
+/**
+ * Public configuration types for `@lunora/container`.
+ *
+ * Everything in this module is pure data — no Cloudflare runtime imports — so
+ * it is safe to import from Node tooling (codegen, the config layer) as well
+ * as from worker code.
+ */
+/**
+ * Named instance types Cloudflare Containers provides.
+ * @experimental
+ */
+type NamedContainerInstanceType = "basic" | "lite" | "standard-1" | "standard-2" | "standard-3" | "standard-4";
+/**
+ * A custom instance type. Cloudflare's bounds at the time of writing: up to
+ * 4 vCPU, 12 GiB memory, 20 GB disk, ≥ 3 GiB memory per vCPU and ≤ 2 GB disk
+ * per GiB memory. The config-layer validator enforces the documented ranges.
+ * @experimental
+ */
+interface CustomContainerInstanceType {
+  /** Disk in MB. Cloudflare's default is 2000 (2 GB). */
+  diskMb?: number;
+  /** Memory in MiB. Cloudflare's default is 256. */
+  memoryMib?: number;
+  /** vCPU count. Cloudflare's default is 0.0625 (1/16 vCPU). */
+  vcpu?: number;
+}
+/**
+ * `ContainerInstanceType` is part of the experimental `@lunora/container` API and may change without a major version bump.
+ * @experimental
+ */
+type ContainerInstanceType = CustomContainerInstanceType | NamedContainerInstanceType;
+/**
+ * Rolling-deploy tuning for a container.
+ * @experimental
+ */
+interface ContainerRollout {
+  /** Seconds an active instance runs before it's eligible for update (wrangler `rollout_active_grace_period`). */
+  gracePeriodSeconds?: number;
+  /** Percentage of instances updated per rollout step, 1–100 (wrangler `rollout_step_percentage`). */
+  stepPercentage?: number;
+}
+/**
+ * A pre-built image pulled from a registry — the Cloudflare Registry, Docker
+ * Hub, or Amazon ECR (the registries `wrangler deploy` supports). The
+ * reference must be fully qualified, e.g. `docker.io/acme/transcoder:1.4`.
+ * @experimental
+ */
+interface RegistryImageSource {
+  registry: string;
+}
+/**
+ * A Dockerfile-less build via [Railpack](https://railpack.com): point at a
+ * source directory and `lunora deploy` builds an OCI image with Railpack
+ * (needs a BuildKit instance) and pushes it to the Cloudflare Registry before
+ * wrangler runs. Opt-in — the Dockerfile path is the zero-extra-deps default.
+ * @experimental
+ */
+interface BuildImageSource {
+  build: string;
+}
+/**
+ * Where the container image comes from. A `string` is a **local path** —
+ * either a directory containing a `Dockerfile` (normalized to
+ * `<dir>/Dockerfile` with the directory as the build context) or a path to
+ * the Dockerfile itself — while `{ registry }` is a pre-built image reference.
+ * @experimental
+ */
+type ContainerImageSource = BuildImageSource | RegistryImageSource | string;
+/**
+ * An application-level readiness probe that gates request proxying. Layered on
+ * top of the platform's own port/`pingEndpoint` health wait, it lets you hold
+ * traffic back until the app inside the container is *functionally* ready —
+ * migrations applied, caches warmed — which an open-port check can't see.
+ *
+ * Declarative on purpose: a `defineContainer` value stays pure data (no handler
+ * functions), so codegen and the config layer can read it without evaluating
+ * code. (Upstream cloudflare/containers#188 expresses the same idea as handler
+ * functions; the Lunora config is data-only, so it's modelled as descriptors.)
+ * @experimental
+ */
+interface ContainerReadinessCheck {
+  /** HTTP path probed on the container, e.g. `"/ready"` (a leading slash is optional). */
+  path: string;
+  /** Port to probe. Defaults to {@link ContainerConfig.defaultPort}. */
+  port?: number;
+  /** HTTP status that means "ready". Defaults to `200`. */
+  status?: number;
+}
+/**
+ * `ContainerConfig` is part of the experimental `@lunora/container` API and may change without a major version bump.
+ * @experimental
+ */
+interface ContainerConfig {
+  /**
+   * Hostnames the container may reach **even when {@link ContainerConfig.enableInternet}
+   * is `false`** — an egress allow-list (Cloudflare's `allowedHosts`). Glob
+   * patterns like `*.stripe.com` are supported. Pair with `enableInternet:
+   * false` to deny all egress except these hosts (the firewall pattern
+   * upstream issue cloudflare/containers#30 asked for). The interception path
+   * needs the `ContainerProxy` worker entrypoint, which codegen re-exports
+   * from the generated container file automatically; the named-instance
+   * handle's `egress` controls adjust the lists at runtime.
+   */
+  allowedHosts?: ReadonlyArray<string>;
+  /**
+   * Build-time variables for a Dockerfile/Railpack image — wrangler's
+   * `image_vars` (equivalent to `docker build --build-arg`). For *runtime*
+   * values use {@link ContainerConfig.env} / {@link ContainerConfig.secrets}.
+   * Ignored for a pre-built `{ registry }` image.
+   */
+  buildArgs?: Readonly<Record<string, string>>;
+  /**
+   * The port the container listens on. Worker → container requests target
+   * this port. Locally the Dockerfile must also `EXPOSE` it. For a
+   * multi-port container also declare {@link ContainerConfig.requiredPorts}
+   * and route per request with the handle's `.port(n)`.
+   */
+  defaultPort?: number;
+  /**
+   * Hostnames the container may **never** reach — an egress deny-list
+   * (Cloudflare's `deniedHosts`). Overrides everything else, including
+   * `enableInternet: true` and {@link ContainerConfig.allowedHosts}. Glob
+   * patterns like `*.evil.com` are supported.
+   */
+  deniedHosts?: ReadonlyArray<string>;
+  /**
+   * Whether the container may open outbound internet connections. Defaults
+   * to `true` — the platform default. Note that container egress is billed
+   * per GB by Cloudflare. Combine with {@link ContainerConfig.allowedHosts} /
+   * {@link ContainerConfig.deniedHosts} for a precise egress firewall.
+   */
+  enableInternet?: boolean;
+  /**
+   * Default command to run inside the container, overriding the image's
+   * `ENTRYPOINT`/`CMD` (Cloudflare's `entrypoint`). A per-start override is
+   * still available via the named-instance handle's `start({ entrypoint })`.
+   */
+  entrypoint?: ReadonlyArray<string>;
+  /**
+   * Static environment variables passed to the container on every start.
+   * For secret values use {@link ContainerConfig.secrets} instead so they
+   * flow through Worker Secrets rather than source code.
+   */
+  env?: Readonly<Record<string, string>>;
+  /**
+   * Hard cap on how long an instance may run, measured from start regardless
+   * of activity — a runaway-cost backstop on top of the idle
+   * {@link ContainerConfig.sleepAfter}. Same grammar as `sleepAfter`
+   * (`"30s"`, `"5m"`, `"1h"`, or a plain number of seconds). When it elapses,
+   * the `LunoraContainer.onHardTimeoutExpired` hook runs (default: `stop()`).
+   * (Upstream cloudflare/containers#85.)
+   */
+  hardTimeout?: number | string;
+  /** Image source — a local Dockerfile path/directory or a registry reference. */
+  image: ContainerImageSource;
+  /**
+   * Resource class for each instance: a named Cloudflare instance type or a
+   * custom `{ vcpu, memoryMib, diskMb }` object.
+   */
+  instanceType?: ContainerInstanceType;
+  /**
+   * Intercept the container's outbound **HTTPS** traffic so the egress
+   * allow/deny lists apply to TLS connections too (Cloudflare's
+   * `interceptHttps`). Requires the image to trust the Cloudflare CA at
+   * `/etc/cloudflare/certs/cloudflare-containers-ca.crt`. Defaults to `false`
+   * (HTTP egress is gated regardless).
+   */
+  interceptHttps?: boolean;
+  /**
+   * Key-value metadata attached to every instance for metrics/observability
+   * (Cloudflare's container `labels`), e.g. `{ tenant: "acme", env: "prod" }`.
+   * A per-start override is available via the named-instance handle's
+   * `start({ labels })`.
+   */
+  labels?: Readonly<Record<string, string>>;
+  /**
+   * Maximum number of concurrently *running* instances. Stopped (slept)
+   * containers don't count. Also the default pool size for `.any()`.
+   */
+  maxInstances?: number;
+  /**
+   * Override for the wrangler `containers[].name` identifier. Defaults to
+   * wrangler's own default (worker name + class name + environment).
+   */
+  name?: string;
+  /**
+   * HTTP path Cloudflare polls to decide an instance is healthy
+   * (Cloudflare's `pingEndpoint`). Defaults to upstream's slash-less `"ping"`;
+   * either `"ping"` or `"/healthz"`-style paths are accepted. Set this when
+   * the container exposes its readiness check under a different route.
+   */
+  pingEndpoint?: string;
+  /**
+   * Application-level readiness probes that gate request proxying: a
+   * `ctx.containers.&lt;name>` fetch waits until every probe responds with its
+   * expected status before the request reaches the container — on top of the
+   * platform's port/`pingEndpoint` health wait. All probes run in parallel.
+   * Use these for readiness an open-port check can't see (migrations applied,
+   * caches warm). (Upstream cloudflare/containers#188.)
+   */
+  readyOn?: ReadonlyArray<ContainerReadinessCheck>;
+  /**
+   * Ports the container must be listening on before it's considered ready
+   * (Cloudflare's `requiredPorts`) — for multi-port containers. Start-up
+   * waits for every listed port, and the handle's `.port(n)` routes a request
+   * to any of them; {@link ContainerConfig.defaultPort} is the target when a
+   * request doesn't pick one.
+   */
+  requiredPorts?: ReadonlyArray<number>;
+  /**
+   * Rolling-deploy tuning. `stepPercentage` is the share of instances updated
+   * per rollout step (wrangler `rollout_step_percentage`); `gracePeriodSeconds`
+   * is how long an active instance is left running before it's eligible for
+   * update (wrangler `rollout_active_grace_period`).
+   */
+  rollout?: ContainerRollout;
+  /**
+   * Names of Worker secrets (from `wrangler secret` / `.dev.vars`) forwarded
+   * into the container's environment at instance start. Each declared name
+   * must exist on the Worker `env` — a missing one fails fast with a
+   * directed error instead of starting the container without it.
+   */
+  secrets?: ReadonlyArray<string>;
+  /**
+   * Cloudflare **Secrets Store** secrets forwarded into the container's
+   * environment, as a map of *container env-var name → Worker Secrets Store
+   * binding name*. Each binding is resolved with its async `.get()` the first
+   * time the instance starts, then injected as that env var — e.g.
+   * `{ STRIPE_KEY: "STRIPE_SECRET" }` runs `env.STRIPE_SECRET.get()` and sets
+   * `STRIPE_KEY` inside the container. Unlike {@link ContainerConfig.secrets}
+   * (plain Worker text secrets), this pulls from a `secrets_store_secrets`
+   * binding. A name already used by `env`/`secrets` is rejected at authoring
+   * time; a missing binding or unreadable value fails the start. Applies
+   * to the default start (the `ctx.containers` proxy path and a bare
+   * `start()`); a per-instance `start({ envVars })` replaces the env set
+   * wholesale, as it does for `env`/`secrets`. (Upstream
+   * cloudflare/containers#96.)
+   */
+  secretsStore?: Readonly<Record<string, string>>;
+  /**
+   * Idle timeout after which the instance is put to sleep, e.g. `"5m"`,
+   * `"30s"`, or a number of seconds. Cloudflare's default is `"10m"`.
+   */
+  sleepAfter?: number | string;
+}
+/**
+ * The value `defineContainer` returns: the validated config plus a brand the
+ * codegen discovery and the generated Container DO class key on.
+ * @experimental
+ */
+interface ContainerDefinition extends ContainerConfig {
+  /** Brand marking a value as a Lunora container definition. */
+  readonly isLunoraContainer: true;
+}
+/**
+ * A normalized image source, as written into `wrangler.jsonc`.
+ * @experimental
+ */
+type NormalizedContainerImage = {
+  /** Build context directory (wrangler `image_build_context`). */
+  buildContext: string;
+  /** Path to the Dockerfile (wrangler `image`). */
+  dockerfilePath: string;
+  kind: "dockerfile";
+} | {
+  /** Railpack source directory built + pushed at deploy time. */
+  buildDir: string;
+  kind: "build";
+} | {
+  kind: "registry";
+  /** Fully-qualified image reference (wrangler `image`). */
+  reference: string;
+};
+/**
+ * Cloudflare Durable Object data-residency jurisdiction. Widening union —
+ * Cloudflare adds values over time.
+ * @see https://developers.cloudflare.com/durable-objects/reference/data-location/
+ * @experimental
+ */
+type DurableObjectJurisdiction = "eu" | "fedramp" | "us";
+export { BuildImageSource as B, ContainerConfig as C, DurableObjectJurisdiction as D, NormalizedContainerImage as N, RegistryImageSource as R, ContainerDefinition as a, ContainerImageSource as b, ContainerInstanceType as c, ContainerReadinessCheck as d, ContainerRollout as e, CustomContainerInstanceType as f, NamedContainerInstanceType as g };