@lunora/container 0.0.0 → 1.0.0-alpha.1

package/dist/packem_shared/types.d-D2l2SYol.d.ts

@@ -0,0 +1,140 @@
+/**
+* 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. */
+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.
+*/
+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;
+}
+type ContainerInstanceType = CustomContainerInstanceType | NamedContainerInstanceType;
+/** Rolling-deploy tuning for a container. */
+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`.
+*/
+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.
+*/
+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.
+*/
+type ContainerImageSource = BuildImageSource | RegistryImageSource | string;
+interface ContainerConfig {
+  /**
+  * 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.
+  */
+  defaultPort?: number;
+  /**
+  * Whether the container may open outbound internet connections. Defaults
+  * to `true` — the platform default. Note that container egress is billed
+  * per GB by Cloudflare.
+  */
+  enableInternet?: boolean;
+  /**
+  * 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>>;
+  /** 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;
+  /**
+  * 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;
+  /**
+  * 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>;
+  /**
+  * 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.
+*/
+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`. */
+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;
+};
+export { BuildImageSource as B, ContainerDefinition as C, NormalizedContainerImage as N, RegistryImageSource as R, ContainerConfig as a, ContainerImageSource as b, ContainerInstanceType as c, ContainerRollout as d, CustomContainerInstanceType as e, NamedContainerInstanceType as f };

package/package.json

@@ -1,29 +1,60 @@
 {
   "name": "@lunora/container",
-  "version": "0.0.0",
+  "version": "1.0.0-alpha.1",
   "description": "Cloudflare Containers for Lunora: defineContainer, generated Container DO classes, and the ctx.containers action surface",
-  "license": "FSL-1.1-Apache-2.0",
+  "keywords": [
+    "cloudflare",
+    "containers",
+    "docker",
+    "durable-objects",
+    "lunora",
+    "workers"
+  ],
   "homepage": "https://lunora.sh",
+  "bugs": "https://github.com/anolilab/lunora/issues",
+  "license": "FSL-1.1-Apache-2.0",
+  "author": {
+    "name": "Daniel Bannert",
+    "email": "d.bannert@anolilab.de"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/anolilab/lunora.git",
     "directory": "packages/container"
   },
-  "bugs": {
-    "url": "https://github.com/anolilab/lunora/issues"
-  },
-  "keywords": [
-    "lunora",
-    "cloudflare",
-    "workers",
-    "containers",
-    "docker",
-    "durable-objects"
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE.md",
+    "__assets__"
   ],
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/index.mjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs"
+    },
+    "./do": {
+      "types": "./dist/do/index.d.ts",
+      "import": "./dist/do/index.mjs"
+    },
+    "./bridge": {
+      "types": "./dist/bridge.d.ts",
+      "import": "./dist/bridge.mjs"
+    },
+    "./package.json": "./package.json"
+  },
   "publishConfig": {
     "access": "public"
   },
-  "files": [
-    "README.md"
-  ]
+  "dependencies": {
+    "@cloudflare/containers": "^0.3.7"
+  },
+  "engines": {
+    "node": "^22.15.0 || >=24.11.0"
+  }
 }