@intentius/chant-lexicon-docker 0.85.0 → 0.87.0

package/dist/composites/catalog.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"catalog.d.ts","sourceRoot":"","sources":["../../src/composites/catalog.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAE/D,eAAO,MAAM,gBAAgB,EAAE,cAAc,EAsD5C,CAAC"}
+{"version":3,"file":"catalog.d.ts","sourceRoot":"","sources":["../../src/composites/catalog.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAE/D,eAAO,MAAM,gBAAgB,EAAE,cAAc,EAgH5C,CAAC"}

package/dist/composites/docker-web-service.d.ts

@@ -0,0 +1,53 @@
+/**
+ * DockerWebService composite: one HTTP service as a Compose service, built
+ * from a Dockerfile or run from an image, listening on one port, with a
+ * health check on an HTTP path.
+ *
+ * It is the shape a single web app takes when Compose runs it, and the kind a
+ * component names in its contract's `composites` when it deploys one
+ * (#2662), so `chant workspace graph --composites` can offer that component
+ * for the instance.
+ */
+export interface DockerWebServiceProps {
+    /** Build the image from a Dockerfile: the context, and the Dockerfile's path in it (default: "Dockerfile"). */
+    build?: {
+        context: string;
+        dockerfile?: string;
+    };
+    /** The image to run, or the tag to give the built one. One of `build` and `image` is required. */
+    image?: string;
+    /** The port the app listens on in the container. It is also passed to the app as `PORT`. */
+    port: number;
+    /** The port published on the host (default: `port`). */
+    hostPort?: number;
+    /** More environment variables. A `PORT` here overrides the one from `port`. */
+    environment?: Record<string, string>;
+    /** An HTTP path the health check fetches with `wget` inside the container (default: no health check). */
+    healthPath?: string;
+    /** Restart policy (default: "unless-stopped"). */
+    restart?: string;
+    /** Per-member defaults for fine-grained overrides. */
+    defaults?: {
+        service?: Partial<Record<string, unknown>>;
+    };
+}
+/**
+ * One HTTP service as a Compose service, with a published port and an HTTP
+ * health check. Returns the service, keyed by the export name plus `Service`.
+ *
+ * @example
+ * ```ts
+ * import { DockerWebService } from "@intentius/chant-lexicon-docker";
+ *
+ * export const app = DockerWebService({
+ *   build: { context: "../app" },
+ *   image: "app:local",
+ *   port: 8080,
+ *   healthPath: "/healthz",
+ * });
+ * ```
+ */
+export declare const DockerWebService: import("@intentius/chant").CompositeDefinition<DockerWebServiceProps, {
+    service: import("@intentius/chant").Declarable & Record<string, string>;
+}>;
+//# sourceMappingURL=docker-web-service.d.ts.map

package/dist/composites/docker-web-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"docker-web-service.d.ts","sourceRoot":"","sources":["../../src/composites/docker-web-service.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAKH,MAAM,WAAW,qBAAqB;IACpC,+GAA+G;IAC/G,KAAK,CAAC,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACjD,kGAAkG;IAClG,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,4FAA4F;IAC5F,IAAI,EAAE,MAAM,CAAC;IACb,wDAAwD;IACxD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,+EAA+E;IAC/E,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACrC,yGAAyG;IACzG,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,kDAAkD;IAClD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,sDAAsD;IACtD,QAAQ,CAAC,EAAE;QACT,OAAO,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;KAC5C,CAAC;CACH;AAED;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,gBAAgB;;EAuBP,CAAC"}

package/dist/composites/index.d.ts

@@ -4,4 +4,6 @@
  */
 export { DockerOtelCollector } from "./docker-otel-collector.js";
 export type { DockerOtelCollectorProps } from "./docker-otel-collector.js";
+export { DockerWebService } from "./docker-web-service.js";
+export type { DockerWebServiceProps } from "./docker-web-service.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/composites/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/composites/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAC9D,YAAY,EAAE,wBAAwB,EAAE,MAAM,yBAAyB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/composites/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAC9D,YAAY,EAAE,wBAAwB,EAAE,MAAM,yBAAyB,CAAC;AACxE,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,YAAY,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC"}

package/dist/integrity.json

@@ -1,7 +1,7 @@
 {
   "algorithm": "sha256",
   "artifacts": {
-    "manifest.json": "502441225f3db95fb32de3a99ba278b52a8caad164a58e4c275d40f315b59086",
+    "manifest.json": "556bc46b300ed91d7342dd30f1067064544d9133aaa88907f7263fca8c0c5281",
     "meta.json": "2996be8fdb14f3f935e1e1441fed8f69af7b6aeeefb14dac96301cc41eba8046",
     "types/index.d.ts": "7b2e6f784b7dbecbbe7924fa1aec7e2520ac0547069311253a006bc2267a5646",
     "rules/no-latest-tag.ts": "efd060453d8ca3d5b85c3972906c6650b6f63eb5f67cb6cdb0f16a41cad91228",
@@ -15,5 +15,5 @@
     "skills/chant-docker.md": "3ff0708e3c76e245f202948949c768464563af2b60cc9aa2ca52f494ef8357f1",
     "skills/chant-docker-patterns.md": "ad1b0196d8150b2df579a699ff107f604340c799c04f3460ebf65003e287b12a"
   },
-  "composite": "ca92d6335ac15aad75bb7962f91d9d26c723a781c6743fc87d4cd9eecf54a953"
+  "composite": "2c6ae73dbf19e794f3c0c8b018be4107d69c9d23a6301811b00318a1d184f15d"
 }

package/dist/manifest.json

@@ -1,6 +1,6 @@
 {
   "name": "docker",
-  "version": "0.85.0",
+  "version": "0.87.0",
   "chantVersion": ">=0.1.0",
   "namespace": "Docker",
   "intrinsics": [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@intentius/chant-lexicon-docker",
-  "version": "0.85.0",
+  "version": "0.87.0",
   "description": "Docker lexicon for chant — declarative IaC in TypeScript",
   "license": "Apache-2.0",
   "homepage": "https://intentius.io/chant",
@@ -70,7 +70,7 @@
     "typescript": "^5.9.3"
   },
   "peerDependencies": {
-    "@intentius/chant": "^0.85.0",
+    "@intentius/chant": "^0.87.0",
     "typescript": "^5.9.3"
   }
 }

package/src/composites/catalog.ts

@@ -56,5 +56,63 @@ export const compositeCatalog: CompositeEntry[] = [
         "description": "Per-member defaults for fine-grained overrides."
       }
     ]
+  },
+  {
+    "name": "DockerWebService",
+    "lexicon": "docker",
+    "description": "One HTTP service as a Compose service, with a published port and an HTTP health check.",
+    "bundles": [
+      "Service"
+    ],
+    "params": [
+      {
+        "name": "build",
+        "type": "{ context: string; dockerfile?: string }",
+        "required": false,
+        "description": "Build the image from a Dockerfile: the context, and the Dockerfile's path in it (default: \"Dockerfile\")."
+      },
+      {
+        "name": "image",
+        "type": "string",
+        "required": false,
+        "description": "The image to run, or the tag to give the built one."
+      },
+      {
+        "name": "port",
+        "type": "number",
+        "required": true,
+        "description": "The port the app listens on in the container."
+      },
+      {
+        "name": "hostPort",
+        "type": "number",
+        "required": false,
+        "description": "The port published on the host (default: `port`)."
+      },
+      {
+        "name": "environment",
+        "type": "Record<string, string>",
+        "required": false,
+        "description": "More environment variables."
+      },
+      {
+        "name": "healthPath",
+        "type": "string",
+        "required": false,
+        "description": "An HTTP path the health check fetches with `wget` inside the container (default: no health check)."
+      },
+      {
+        "name": "restart",
+        "type": "string",
+        "required": false,
+        "description": "Restart policy (default: \"unless-stopped\")."
+      },
+      {
+        "name": "defaults",
+        "type": "{ service?: Partial<Record<string, unknown>>; }",
+        "required": false,
+        "description": "Per-member defaults for fine-grained overrides."
+      }
+    ]
   }
 ];

package/src/composites/docker-web-service.test.ts

@@ -0,0 +1,34 @@
+import { describe, expect, test } from "vitest";
+import { expandComposite } from "@intentius/chant";
+import { DockerWebService } from "./docker-web-service";
+
+const props = (s: unknown) => (s as { props: Record<string, unknown> }).props;
+
+describe("DockerWebService", () => {
+  test("one Compose service, keyed by the export name plus Service", () => {
+    const expanded = expandComposite("app", DockerWebService({ build: { context: "../app" }, port: 8080 }));
+    expect([...expanded.keys()]).toEqual(["appService"]);
+    expect(expanded.get("appService")?.entityType).toBe("Docker::Compose::Service");
+  });
+
+  test("builds from the Dockerfile, publishes the port, passes it as PORT, and checks the health path", () => {
+    const { service } = DockerWebService({ build: { context: "../app" }, image: "app:local", port: 8080, healthPath: "/healthz" }).members;
+    expect(props(service)).toEqual({
+      build: { context: "../app", dockerfile: "Dockerfile" },
+      image: "app:local",
+      ports: ["8080:8080"],
+      environment: { PORT: "8080" },
+      restart: "unless-stopped",
+      healthcheck: { test: ["CMD", "wget", "-qO-", "http://127.0.0.1:8080/healthz"], interval: "30s", timeout: "5s", retries: 3 },
+    });
+  });
+
+  test("an image alone, another host port, extra environment, and no health check without a path", () => {
+    const { service } = DockerWebService({ image: "nginx:1", port: 80, hostPort: 8081, environment: { MODE: "prod" } }).members;
+    expect(props(service)).toEqual({ image: "nginx:1", ports: ["8081:80"], environment: { PORT: "80", MODE: "prod" }, restart: "unless-stopped" });
+  });
+
+  test("needs a build or an image", () => {
+    expect(() => DockerWebService({ port: 8080 })).toThrow(/give `build`, `image`, or both/);
+  });
+});

package/src/composites/docker-web-service.ts

@@ -0,0 +1,75 @@
+/**
+ * DockerWebService composite: one HTTP service as a Compose service, built
+ * from a Dockerfile or run from an image, listening on one port, with a
+ * health check on an HTTP path.
+ *
+ * It is the shape a single web app takes when Compose runs it, and the kind a
+ * component names in its contract's `composites` when it deploys one
+ * (#2662), so `chant workspace graph --composites` can offer that component
+ * for the instance.
+ */
+
+import { Composite, mergeDefaults } from "@intentius/chant";
+import { Service } from "../generated/index";
+
+export interface DockerWebServiceProps {
+  /** Build the image from a Dockerfile: the context, and the Dockerfile's path in it (default: "Dockerfile"). */
+  build?: { context: string; dockerfile?: string };
+  /** The image to run, or the tag to give the built one. One of `build` and `image` is required. */
+  image?: string;
+  /** The port the app listens on in the container. It is also passed to the app as `PORT`. */
+  port: number;
+  /** The port published on the host (default: `port`). */
+  hostPort?: number;
+  /** More environment variables. A `PORT` here overrides the one from `port`. */
+  environment?: Record<string, string>;
+  /** An HTTP path the health check fetches with `wget` inside the container (default: no health check). */
+  healthPath?: string;
+  /** Restart policy (default: "unless-stopped"). */
+  restart?: string;
+  /** Per-member defaults for fine-grained overrides. */
+  defaults?: {
+    service?: Partial<Record<string, unknown>>;
+  };
+}
+
+/**
+ * One HTTP service as a Compose service, with a published port and an HTTP
+ * health check. Returns the service, keyed by the export name plus `Service`.
+ *
+ * @example
+ * ```ts
+ * import { DockerWebService } from "@intentius/chant-lexicon-docker";
+ *
+ * export const app = DockerWebService({
+ *   build: { context: "../app" },
+ *   image: "app:local",
+ *   port: 8080,
+ *   healthPath: "/healthz",
+ * });
+ * ```
+ */
+export const DockerWebService = Composite((props: DockerWebServiceProps) => {
+  const { build, image, port, hostPort = port, environment, healthPath, restart = "unless-stopped", defaults: defs } = props;
+  if (!build && !image) throw new Error("DockerWebService: give `build`, `image`, or both");
+
+  const service = new Service(mergeDefaults({
+    ...(build ? { build: { context: build.context, dockerfile: build.dockerfile ?? "Dockerfile" } } : {}),
+    ...(image ? { image } : {}),
+    ports: [`${hostPort}:${port}`],
+    environment: { PORT: String(port), ...environment },
+    restart,
+    ...(healthPath
+      ? {
+          healthcheck: {
+            test: ["CMD", "wget", "-qO-", `http://127.0.0.1:${port}${healthPath}`],
+            interval: "30s",
+            timeout: "5s",
+            retries: 3,
+          },
+        }
+      : {}),
+  }, defs?.service));
+
+  return { service };
+}, "DockerWebService");

package/src/composites/index.ts

@@ -5,3 +5,5 @@
 
 export { DockerOtelCollector } from "./docker-otel-collector";
 export type { DockerOtelCollectorProps } from "./docker-otel-collector";
+export { DockerWebService } from "./docker-web-service";
+export type { DockerWebServiceProps } from "./docker-web-service";