@intentius/chant-lexicon-docker 0.124.22 → 0.124.23

package/src/codegen/generate.ts

@@ -11,7 +11,7 @@ import { generateComposePipeline } from "./generate-compose";
 import { generateDockerfilePipeline } from "./generate-dockerfile";
 import { entityTypeToTsName } from "./naming";
 import { PER_KIND_ORDER } from "../dockerfile-order";
-import type { ComposeParseResult } from "../spec/parse-compose";
+import { COMPOSE_STRING, type ComposeParseResult } from "../spec/parse-compose";
 import type { DockerfileParseResult, DockerfileInstruction } from "../spec/parse-engine";
 
 export interface DockerGenerateResult {
@@ -90,23 +90,23 @@ function generateTypesDTS(compose: ComposeParseResult[], dockerfile: DockerfileP
     "// Code generated by chant generate. DO NOT EDIT.",
     'import type { Declarable } from "@intentius/chant/declarable";',
     "",
+    // This file is type-checked on its own (validate's types-compile), so it
+    // can't import the interpolation module; an env() value is matched by shape.
+    "/** An `env()` interpolation, as returned by the lexicon's `env`. */",
+    "interface EnvIntrinsic { toJSON(): string; toString(): string; }",
+    "",
   ];
 
+  lines.push(...composeTypeLines(compose));
   for (const c of compose) {
     const tsName = entityTypeToTsName(c.typeName);
-    lines.push(`export interface ${tsName}Props {`);
-    for (const p of c.properties) {
-      const opt = p.required ? "" : "?";
-      lines.push(`  ${p.name}${opt}: ${p.type};`);
-    }
-    lines.push(`}`);
-    lines.push(`export declare const ${tsName}: new (props?: ${tsName}Props) => Declarable;`);
-    lines.push("");
+    lines.push(`export declare const ${tsName}: new (props?: ${tsName}Props, attributes?: Record<string, unknown>) => Declarable;`);
   }
+  lines.push("");
 
   const dfName = entityTypeToTsName(dockerfile.typeName);
   lines.push(...dockerfileTypeLines(dockerfile));
-  lines.push(`export declare const ${dfName}: new (props?: DockerfileProps) => Declarable;`);
+  lines.push(`export declare const ${dfName}: new (props?: DockerfileProps, attributes?: Record<string, unknown>) => Declarable;`);
   lines.push("");
 
   return lines.join("\n");
@@ -116,27 +116,66 @@ function generateIndexTS(compose: ComposeParseResult[], dockerfile: DockerfilePa
   const lines: string[] = [
     "// Code generated by chant generate. DO NOT EDIT.",
     'import { createResource } from "./runtime";',
+    'import type { Declarable } from "@intentius/chant/declarable";',
+    'import type { EnvIntrinsic } from "../interpolation";',
+    "",
+    // createResource returns a constructor with untyped props. Each constructor
+    // below is cast to one that takes its props type, so a misspelled key or a
+    // wrong field type is a compile error where the resource is written, and
+    // the editor completes the fields (#3934).
+    "/** A docker resource constructor whose props are type-checked. */",
+    "export type DockerResourceConstructor<P> = new (props?: P, attributes?: Record<string, unknown>) => InstanceType<ReturnType<typeof createResource>>;",
     "",
   ];
 
+  lines.push(...composeTypeLines(compose));
   for (const c of compose) {
     const tsName = entityTypeToTsName(c.typeName);
-    lines.push(`export const ${tsName} = createResource("${c.typeName}", "docker", {});`);
+    lines.push(
+      `export const ${tsName} = createResource("${c.typeName}", "docker", {}) as unknown as DockerResourceConstructor<${tsName}Props>;`,
+    );
   }
 
-  lines.push("");
-  const dfName = entityTypeToTsName(dockerfile.typeName);
-  lines.push(`export const ${dfName} = createResource("${dockerfile.typeName}", "docker", {});`);
   lines.push("");
   // The Dockerfile prop types are exported from here too (not only from
   // index.d.ts, which index.ts shadows) so a module can type a shared stage
   // or step list: `export const install: DockerfileStep[] = [...]`.
   lines.push(...dockerfileTypeLines(dockerfile));
   lines.push("");
+  const dfName = entityTypeToTsName(dockerfile.typeName);
+  lines.push(
+    `export const ${dfName} = createResource("${dockerfile.typeName}", "docker", {}) as unknown as DockerResourceConstructor<DockerfileProps>;`,
+  );
+  lines.push("");
 
   return lines.join("\n");
 }
 
+/** One props interface per Compose entity. */
+function composeTypeLines(compose: ComposeParseResult[]): string[] {
+  const lines: string[] = [
+    "/**",
+    " * A Compose string value: a string, an `env()` interpolation, or an entity",
+    " * (service, network, volume, config, secret or Dockerfile), which is written as its name.",
+    " */",
+    `export type ${COMPOSE_STRING} = string | EnvIntrinsic | Declarable;`,
+    "",
+  ];
+  for (const c of compose) {
+    const tsName = entityTypeToTsName(c.typeName);
+    if (c.description) lines.push(`/** ${c.description} */`);
+    lines.push(`export interface ${tsName}Props {`);
+    for (const p of c.properties) {
+      const opt = p.required ? "" : "?";
+      if (p.description) lines.push(`  /** ${p.description} */`);
+      lines.push(`  ${p.name}${opt}: ${p.type};`);
+    }
+    lines.push(`}`);
+    lines.push("");
+  }
+  return lines;
+}
+
 /**
  * The Dockerfile prop types: one `DockerfileStep` variant per instruction,
  * the stage, and the props. The per-kind fields keep the instructions they

package/src/codegen/okf.test.ts

@@ -25,7 +25,7 @@ describe("docker OKF bundle", () => {
     expect(front.type).toBe("resource-type");
     expect(front.resource_type).toBe("Docker::Compose::Service");
     // Registry-carried property description reaches the concept body.
-    expect(service.body).toContain("- `image` (`string`): Container image to use");
+    expect(service.body).toContain("- `image` (`ComposeString`): Specify the image to start the container from.");
     // The no-latest-tag rule governs Service…
     expect(service.body).toContain("[DKRS001](/rules/DKRS001.md)");
     // …and points back at it.

package/src/generated/index.d.ts

@@ -1,60 +1,282 @@
 // Code generated by chant generate. DO NOT EDIT.
 import type { Declarable } from "@intentius/chant/declarable";
 
+/** An `env()` interpolation, as returned by the lexicon's `env`. */
+interface EnvIntrinsic { toJSON(): string; toString(): string; }
+
+/**
+ * A Compose string value: a string, an `env()` interpolation, or an entity
+ * (service, network, volume, config, secret or Dockerfile), which is written as its name.
+ */
+export type ComposeString = string | EnvIntrinsic | Declarable;
+
+/** A containerized service definition in Docker Compose */
 export interface ServiceProps {
-  image?: string;
-  build?: object;
-  command?: string | string[];
-  entrypoint?: string | string[];
-  environment?: Record<string, string>;
-  ports?: string[];
-  volumes?: string[];
-  networks?: string[];
-  depends_on?: string[] | Record<string, { condition: "service_started" | "service_healthy" | "service_completed_successfully"; restart?: boolean; required?: boolean }>;
-  restart?: string;
-  labels?: Record<string, string>;
-  healthcheck?: object;
-  deploy?: object;
-  secrets?: string[];
-  configs?: Array<string | { source: string | Declarable; target?: string; uid?: string; gid?: string; mode?: number }>;
+  develop?: { watch?: Array<{ ignore?: ComposeString | Array<ComposeString>; include?: ComposeString | Array<ComposeString>; path: ComposeString; action: "rebuild" | "sync" | "restart" | "sync+restart" | "sync+exec"; target?: ComposeString; exec?: { command: null | ComposeString | Array<ComposeString>; user?: ComposeString; privileged?: boolean | ComposeString; working_dir?: ComposeString; environment?: Record<string, ComposeString | number | boolean | null> | Array<ComposeString>; [key: `x-${string}`]: unknown }; initial_sync?: boolean; [key: `x-${string}`]: unknown }>; [key: `x-${string}`]: unknown } | null;
+  deploy?: { mode?: ComposeString; endpoint_mode?: ComposeString; replicas?: number | ComposeString; labels?: Record<string, ComposeString | number | boolean | null> | Array<ComposeString>; rollback_config?: { parallelism?: number | ComposeString; delay?: ComposeString; failure_action?: ComposeString; monitor?: ComposeString; max_failure_ratio?: number | ComposeString; order?: "start-first" | "stop-first"; [key: `x-${string}`]: unknown }; update_config?: { parallelism?: number | ComposeString; delay?: ComposeString; failure_action?: ComposeString; monitor?: ComposeString; max_failure_ratio?: number | ComposeString; order?: "start-first" | "stop-first"; [key: `x-${string}`]: unknown }; resources?: { limits?: { cpus?: number | ComposeString; memory?: ComposeString; pids?: number | ComposeString; [key: `x-${string}`]: unknown }; reservations?: { cpus?: number | ComposeString; memory?: ComposeString; generic_resources?: Array<{ discrete_resource_spec?: { kind?: ComposeString; value?: number | ComposeString; [key: `x-${string}`]: unknown }; [key: `x-${string}`]: unknown }>; devices?: Array<{ capabilities: Array<ComposeString>; count?: ComposeString | number; device_ids?: Array<ComposeString>; driver?: ComposeString; options?: Record<string, ComposeString | number | boolean | null> | Array<ComposeString>; [key: `x-${string}`]: unknown }>; [key: `x-${string}`]: unknown }; [key: `x-${string}`]: unknown }; restart_policy?: { condition?: ComposeString; delay?: ComposeString; max_attempts?: number | ComposeString; window?: ComposeString; [key: `x-${string}`]: unknown }; placement?: { constraints?: Array<ComposeString>; preferences?: Array<{ spread?: ComposeString; [key: `x-${string}`]: unknown }>; max_replicas_per_node?: number | ComposeString; [key: `x-${string}`]: unknown }; [key: `x-${string}`]: unknown } | null;
+  annotations?: Record<string, ComposeString | number | boolean | null> | Array<ComposeString>;
+  attach?: boolean | ComposeString;
+  /** Configuration options for building the service's image. */
+  build?: ComposeString | { context?: ComposeString; dockerfile?: ComposeString; dockerfile_inline?: ComposeString; entitlements?: Array<ComposeString>; args?: Record<string, ComposeString | number | boolean | null> | Array<ComposeString>; ssh?: Record<string, ComposeString | number | boolean | null> | Array<ComposeString>; labels?: Record<string, ComposeString | number | boolean | null> | Array<ComposeString>; cache_from?: Array<ComposeString>; cache_to?: Array<ComposeString>; no_cache?: boolean | ComposeString; no_cache_filter?: ComposeString | Array<ComposeString>; additional_contexts?: Record<string, ComposeString | number | boolean | null> | Array<ComposeString>; network?: ComposeString; provenance?: ComposeString | boolean; sbom?: ComposeString | boolean; pull?: boolean | ComposeString; target?: ComposeString; shm_size?: number | ComposeString; extra_hosts?: Record<string, ComposeString | Array<ComposeString>> | Array<ComposeString>; isolation?: ComposeString; privileged?: boolean | ComposeString; secrets?: Array<ComposeString | { source?: ComposeString; target?: ComposeString; uid?: ComposeString; gid?: ComposeString; mode?: number | ComposeString; [key: `x-${string}`]: unknown }>; tags?: Array<ComposeString>; ulimits?: Record<string, number | ComposeString | { hard: number | ComposeString; soft: number | ComposeString; [key: `x-${string}`]: unknown }>; platforms?: Array<ComposeString>; [key: `x-${string}`]: unknown };
+  /** Block IO configuration for the service. */
+  blkio_config?: { device_read_bps?: Array<{ path?: ComposeString; rate?: number | ComposeString }>; device_read_iops?: Array<{ path?: ComposeString; rate?: number | ComposeString }>; device_write_bps?: Array<{ path?: ComposeString; rate?: number | ComposeString }>; device_write_iops?: Array<{ path?: ComposeString; rate?: number | ComposeString }>; weight?: number | ComposeString; weight_device?: Array<{ path?: ComposeString; weight?: number | ComposeString }> };
+  /** Add Linux capabilities. For example, 'CAP_SYS_ADMIN', 'SYS_ADMIN', or 'NET_ADMIN'. */
+  cap_add?: Array<ComposeString>;
+  /** Drop Linux capabilities. For example, 'CAP_SYS_ADMIN', 'SYS_ADMIN', or 'NET_ADMIN'. */
+  cap_drop?: Array<ComposeString>;
+  /** Specify the cgroup namespace to join. Use 'host' to use the host's cgroup namespace, or 'private' to use a private cgroup namespace. */
+  cgroup?: "host" | "private";
+  /** Specify an optional parent cgroup for the container. */
+  cgroup_parent?: ComposeString;
+  /** Override the default command declared by the container image, for example 'CMD' in Dockerfile. */
+  command?: null | ComposeString | Array<ComposeString>;
+  /** Grant access to Configs on a per-service basis. */
+  configs?: Array<ComposeString | { source?: ComposeString; target?: ComposeString; uid?: ComposeString; gid?: ComposeString; mode?: number | ComposeString; [key: `x-${string}`]: unknown }>;
+  /** Specify a custom container name, rather than a generated default name. */
+  container_name?: ComposeString;
+  /** Number of usable CPUs. */
+  cpu_count?: ComposeString | number;
+  /** Percentage of CPU resources to use. */
+  cpu_percent?: ComposeString | number;
+  /** CPU shares (relative weight) for the container. */
+  cpu_shares?: number | ComposeString;
+  /** Limit the CPU CFS (Completely Fair Scheduler) quota. */
+  cpu_quota?: number | ComposeString;
+  /** Limit the CPU CFS (Completely Fair Scheduler) period. */
+  cpu_period?: number | ComposeString;
+  /** Limit the CPU real-time period in microseconds or a duration. */
+  cpu_rt_period?: number | ComposeString;
+  /** Limit the CPU real-time runtime in microseconds or a duration. */
+  cpu_rt_runtime?: number | ComposeString;
+  /** Number of CPUs to use. A floating-point value is supported to request partial CPUs. */
+  cpus?: number | ComposeString;
+  /** CPUs in which to allow execution (0-3, 0,1). */
+  cpuset?: ComposeString;
+  /** Configure the credential spec for managed service account. */
+  credential_spec?: { config?: ComposeString; file?: ComposeString; registry?: ComposeString; [key: `x-${string}`]: unknown };
+  /** Express dependency between services. Service dependencies cause services to be started in dependency order. The dependent service will wait for the dependency to be ready before starting. */
+  depends_on?: Array<ComposeString> | Record<string, { restart?: boolean | ComposeString; required?: boolean; condition: "service_started" | "service_healthy" | "service_completed_successfully"; [key: `x-${string}`]: unknown }>;
+  /** Add rules to the cgroup allowed devices list. */
+  device_cgroup_rules?: Array<ComposeString>;
+  /** List of device mappings for the container. */
+  devices?: Array<ComposeString | { source: ComposeString; target?: ComposeString; permissions?: ComposeString; [key: `x-${string}`]: unknown }>;
+  /** Custom DNS servers to set for the service container. */
+  dns?: ComposeString | Array<ComposeString>;
+  /** Custom DNS options to be passed to the container's DNS resolver. */
+  dns_opt?: Array<ComposeString>;
+  /** Custom DNS search domains to set on the service container. */
+  dns_search?: ComposeString | Array<ComposeString>;
+  /** Custom domain name to use for the service container. */
+  domainname?: ComposeString;
+  /** Override the default entrypoint declared by the container image, for example 'ENTRYPOINT' in Dockerfile. */
+  entrypoint?: null | ComposeString | Array<ComposeString>;
+  /** Add environment variables from a file or multiple files. Can be a single file path or a list of file paths. */
+  env_file?: ComposeString | Array<ComposeString | { path: ComposeString; format?: ComposeString; required?: boolean | ComposeString }>;
+  /** Add metadata to containers using files containing Docker labels. */
+  label_file?: ComposeString | Array<ComposeString>;
+  /** Add environment variables. You can use either an array or a list of KEY=VAL pairs. */
+  environment?: Record<string, ComposeString | number | boolean | null> | Array<ComposeString>;
+  /** Expose ports without publishing them to the host machine - they'll only be accessible to linked services. */
+  expose?: Array<ComposeString | number>;
+  /** Extend another service, in the current file or another file. */
+  extends?: ComposeString | { service: ComposeString; file?: ComposeString };
+  /** Specify a service which will not be manage by Compose directly, and delegate its management to an external provider. */
+  provider?: { type: ComposeString; options?: Record<string, ComposeString | number | boolean | Array<ComposeString | number | boolean>>; [key: `x-${string}`]: unknown };
+  /** Link to services started outside this Compose application. Specify services as <service_name>:<alias>. */
+  external_links?: Array<ComposeString>;
+  /** Add hostname mappings to the container network interface configuration. */
+  extra_hosts?: Record<string, ComposeString | Array<ComposeString>> | Array<ComposeString>;
+  /** Define GPU devices to use. Can be set to 'all' to use all GPUs, or a list of specific GPU devices. */
+  gpus?: "all" | Array<{ capabilities?: Array<ComposeString>; count?: ComposeString | number; device_ids?: Array<ComposeString>; driver?: ComposeString; options?: Record<string, ComposeString | number | boolean | null> | Array<ComposeString> }>;
+  /** Add additional groups which user inside the container should be member of. */
+  group_add?: Array<ComposeString | number>;
+  /** Configure a health check for the container to monitor its health status. */
+  healthcheck?: { disable?: boolean | ComposeString; interval?: ComposeString; retries?: number | ComposeString; test?: ComposeString | Array<ComposeString>; timeout?: ComposeString; start_period?: ComposeString; start_interval?: ComposeString; [key: `x-${string}`]: unknown };
+  /** Define a custom hostname for the service container. */
+  hostname?: ComposeString;
+  /** Specify the image to start the container from. Can be a repository/tag, a digest, or a local image ID. */
+  image?: ComposeString;
+  /** Run as an init process inside the container that forwards signals and reaps processes. */
+  init?: boolean | ComposeString;
+  /** IPC sharing mode for the service container. Use 'host' to share the host's IPC namespace, 'service:[service_name]' to share with another service, or 'shareable' to allow other services to share this service's IPC namespace. */
+  ipc?: ComposeString;
+  /** Container isolation technology to use. Supported values are platform-specific. */
+  isolation?: ComposeString;
+  /** Add metadata to containers using Docker labels. You can use either an array or a list. */
+  labels?: Record<string, ComposeString | number | boolean | null> | Array<ComposeString>;
+  /** Link to containers in another service. Either specify both the service name and a link alias (SERVICE:ALIAS), or just the service name. */
+  links?: Array<ComposeString>;
+  /** Logging configuration for the service. */
+  logging?: { driver?: ComposeString; options?: Record<string, ComposeString | number | null>; [key: `x-${string}`]: unknown };
+  /** Container MAC address to set. */
+  mac_address?: ComposeString;
+  /** Memory limit for the container. A string value can use suffix like '2g' for 2 gigabytes. */
+  mem_limit?: number | ComposeString;
+  /** Memory reservation for the container. */
+  mem_reservation?: ComposeString | number;
+  /** Container memory swappiness as percentage (0 to 100). */
+  mem_swappiness?: number | ComposeString;
+  /** Amount of memory the container is allowed to swap to disk. Set to -1 to enable unlimited swap. */
+  memswap_limit?: number | ComposeString;
+  /** Network mode. Values can be 'bridge', 'host', 'none', 'service:[service name]', or 'container:[container name]'. */
+  network_mode?: ComposeString;
+  /** AI Models to use, referencing entries under the top-level models key. */
+  models?: Array<ComposeString> | Record<string, { endpoint_var?: ComposeString; model_var?: ComposeString; [key: `x-${string}`]: unknown } | null>;
+  /** Networks to join, referencing entries under the top-level networks key. Can be a list of network names or a mapping of network name to network configuration. */
+  networks?: Array<ComposeString> | Record<string, { aliases?: Array<ComposeString>; interface_name?: ComposeString; ipv4_address?: ComposeString; ipv6_address?: ComposeString; link_local_ips?: Array<ComposeString>; mac_address?: ComposeString; driver_opts?: Record<string, ComposeString | number>; priority?: number; gw_priority?: number; [key: `x-${string}`]: unknown } | null>;
+  /** Disable OOM Killer for the container. */
+  oom_kill_disable?: boolean | ComposeString;
+  /** Tune host's OOM preferences for the container (accepts -1000 to 1000). */
+  oom_score_adj?: ComposeString | number;
+  /** PID mode for container. */
+  pid?: ComposeString | null;
+  /** Tune a container's PIDs limit. Set to -1 for unlimited PIDs. */
+  pids_limit?: number | ComposeString;
+  /** Target platform to run on, e.g., 'linux/amd64', 'linux/arm64', or 'windows/amd64'. */
+  platform?: ComposeString;
+  /** Expose container ports. Short format ([HOST:]CONTAINER[/PROTOCOL]). */
+  ports?: Array<number | ComposeString | { name?: ComposeString; mode?: ComposeString; host_ip?: ComposeString; target?: number | ComposeString; published?: ComposeString | number; protocol?: ComposeString; app_protocol?: ComposeString; [key: `x-${string}`]: unknown }>;
+  /** Init containers to run to completion before the service container is started. Each step runs in its own ephemeral container, in declared order; a non-zero exit fails the bring-up of the service and its dependents. */
+  pre_start?: Array<{ command?: null | ComposeString | Array<ComposeString>; image?: ComposeString; user?: ComposeString; privileged?: boolean | ComposeString; working_dir?: ComposeString; environment?: Record<string, ComposeString | number | boolean | null> | Array<ComposeString>; per_replica?: boolean | ComposeString; [key: `x-${string}`]: unknown }>;
+  /** Commands to run after the container starts. If any command fails, the container stops. */
+  post_start?: Array<{ command: null | ComposeString | Array<ComposeString>; user?: ComposeString; privileged?: boolean | ComposeString; working_dir?: ComposeString; environment?: Record<string, ComposeString | number | boolean | null> | Array<ComposeString>; [key: `x-${string}`]: unknown }>;
+  /** Commands to run before the container stops. If any command fails, the container stop is aborted. */
+  pre_stop?: Array<{ command: null | ComposeString | Array<ComposeString>; user?: ComposeString; privileged?: boolean | ComposeString; working_dir?: ComposeString; environment?: Record<string, ComposeString | number | boolean | null> | Array<ComposeString>; [key: `x-${string}`]: unknown }>;
+  /** Give extended privileges to the service container. */
+  privileged?: boolean | ComposeString;
+  /** List of profiles for this service. When profiles are specified, services are only started when the profile is activated. */
+  profiles?: Array<ComposeString>;
+  /** Policy for pulling images. Options include: 'always', 'never', 'if_not_present', 'missing', 'build', or time-based refresh policies. */
+  pull_policy?: ComposeString;
+  /** Time after which to refresh the image. Used with pull_policy=refresh. */
+  pull_refresh_after?: ComposeString;
+  /** Mount the container's filesystem as read only. */
+  read_only?: boolean | ComposeString;
+  /** Restart policy for the service container. Options include: 'no', 'always', 'on-failure', and 'unless-stopped'. */
+  restart?: ComposeString;
+  /** Runtime to use for this container, e.g., 'runc'. */
+  runtime?: ComposeString;
+  /** Number of containers to deploy for this service. */
+  scale?: number | ComposeString;
+  /** Override the default labeling scheme for each container. */
+  security_opt?: Array<ComposeString>;
+  /** Size of /dev/shm. A string value can use suffix like '2g' for 2 gigabytes. */
+  shm_size?: number | ComposeString;
+  /** Grant access to Secrets on a per-service basis. */
+  secrets?: Array<ComposeString | { source?: ComposeString; target?: ComposeString; uid?: ComposeString; gid?: ComposeString; mode?: number | ComposeString; [key: `x-${string}`]: unknown }>;
+  /** Kernel parameters to set in the container. You can use either an array or a list. */
+  sysctls?: Record<string, ComposeString | number | boolean | null> | Array<ComposeString>;
+  /** Keep STDIN open even if not attached. */
+  stdin_open?: boolean | ComposeString;
+  /** Time to wait for the container to stop gracefully before sending SIGKILL (e.g., '1s', '1m30s'). */
+  stop_grace_period?: ComposeString;
+  /** Signal to stop the container (e.g., 'SIGTERM', 'SIGINT'). */
+  stop_signal?: ComposeString;
+  /** Storage driver options for the container. */
+  storage_opt?: Record<string, unknown>;
+  /** Mount a temporary filesystem (tmpfs) into the container. Can be a single value or a list. */
+  tmpfs?: ComposeString | Array<ComposeString>;
+  /** Allocate a pseudo-TTY to service container. */
+  tty?: boolean | ComposeString;
+  /** Override the default ulimits for a container. */
+  ulimits?: Record<string, number | ComposeString | { hard: number | ComposeString; soft: number | ComposeString; [key: `x-${string}`]: unknown }>;
+  /** Bind mount Docker API socket and required auth. */
+  use_api_socket?: boolean;
+  /** Username or UID to run the container process as. */
+  user?: ComposeString;
+  /** UTS namespace to use. 'host' shares the host's UTS namespace. */
+  uts?: ComposeString;
+  /** User namespace to use. 'host' shares the host's user namespace. */
+  userns_mode?: ComposeString;
+  /** Mount host paths or named volumes accessible to the container. Short syntax (VOLUME:CONTAINER_PATH[:MODE]) */
+  volumes?: Array<ComposeString | { type: "bind" | "volume" | "tmpfs" | "cluster" | "npipe" | "image"; source?: ComposeString; target?: ComposeString; read_only?: boolean | ComposeString; consistency?: ComposeString; bind?: { propagation?: ComposeString; create_host_path?: boolean | ComposeString; recursive?: "enabled" | "disabled" | "writable" | "readonly"; selinux?: "z" | "Z"; [key: `x-${string}`]: unknown }; volume?: { labels?: Record<string, ComposeString | number | boolean | null> | Array<ComposeString>; nocopy?: boolean | ComposeString; subpath?: ComposeString; [key: `x-${string}`]: unknown }; tmpfs?: { size?: number | ComposeString; mode?: number | ComposeString; [key: `x-${string}`]: unknown }; image?: { subpath?: ComposeString; [key: `x-${string}`]: unknown }; [key: `x-${string}`]: unknown }>;
+  /** Mount volumes from another service or container. Optionally specify read-only access (ro) or read-write (rw). */
+  volumes_from?: Array<ComposeString>;
+  /** The working directory in which the entrypoint or command will be run */
+  working_dir?: ComposeString;
 }
-export declare const Service: new (props?: ServiceProps) => Declarable;
 
+/** A named volume definition in Docker Compose */
 export interface VolumeProps {
-  driver?: string;
-  driver_opts?: Record<string, string>;
-  external?: boolean;
-  labels?: Record<string, string>;
-  name?: string;
+  /** Custom name for this volume. */
+  name?: ComposeString;
+  /** Specify which volume driver should be used for this volume. */
+  driver?: ComposeString;
+  /** Specify driver-specific options. */
+  driver_opts?: Record<string, ComposeString | number>;
+  /** Specifies that this volume already exists and was created outside of Compose. */
+  external?: boolean | ComposeString | { name?: ComposeString; [key: `x-${string}`]: unknown };
+  /** Add metadata to the volume using labels. */
+  labels?: Record<string, ComposeString | number | boolean | null> | Array<ComposeString>;
 }
-export declare const Volume: new (props?: VolumeProps) => Declarable;
 
+/** A network definition in Docker Compose */
 export interface NetworkProps {
-  driver?: string;
-  driver_opts?: Record<string, string>;
-  external?: boolean;
-  labels?: Record<string, string>;
-  internal?: boolean;
-  ipam?: object;
+  /** Custom name for this network. */
+  name?: ComposeString;
+  /** Specify which driver should be used for this network. Default is 'bridge'. */
+  driver?: ComposeString;
+  /** Specify driver-specific options defined as key/value pairs. */
+  driver_opts?: Record<string, ComposeString | number>;
+  /** Custom IP Address Management configuration for this network. */
+  ipam?: { driver?: ComposeString; config?: Array<{ subnet?: ComposeString; ip_range?: ComposeString; gateway?: ComposeString; aux_addresses?: Record<string, ComposeString>; [key: `x-${string}`]: unknown }>; options?: Record<string, ComposeString>; [key: `x-${string}`]: unknown };
+  /** Specifies that this network already exists and was created outside of Compose. */
+  external?: boolean | ComposeString | { name?: ComposeString; [key: `x-${string}`]: unknown };
+  /** Create an externally isolated network. */
+  internal?: boolean | ComposeString;
+  /** Enable IPv4 networking. */
+  enable_ipv4?: boolean | ComposeString;
+  /** Enable IPv6 networking. */
+  enable_ipv6?: boolean | ComposeString;
+  /** If true, standalone containers can attach to this network. */
+  attachable?: boolean | ComposeString;
+  /** Add metadata to the network using labels. */
+  labels?: Record<string, ComposeString | number | boolean | null> | Array<ComposeString>;
 }
-export declare const Network: new (props?: NetworkProps) => Declarable;
 
+/** A config definition in Docker Compose */
 export interface DockerConfigProps {
-  file?: string;
-  content?: string;
-  external?: boolean;
-  labels?: Record<string, string>;
-  name?: string;
+  /** Custom name for this config. */
+  name?: ComposeString;
+  /** Inline content of the config. */
+  content?: ComposeString;
+  /** Name of an environment variable from which to get the config value. */
+  environment?: ComposeString;
+  /** Path to a file containing the config value. */
+  file?: ComposeString;
+  /** Specifies that this config already exists and was created outside of Compose. */
+  external?: boolean | ComposeString | { name?: ComposeString };
+  /** Add metadata to the config using labels. */
+  labels?: Record<string, ComposeString | number | boolean | null> | Array<ComposeString>;
+  /** Driver to use for templating the config's value. */
+  template_driver?: ComposeString;
 }
-export declare const DockerConfig: new (props?: DockerConfigProps) => Declarable;
 
+/** A secret definition in Docker Compose */
 export interface DockerSecretProps {
-  file?: string;
-  external?: boolean;
-  labels?: Record<string, string>;
-  name?: string;
+  /** Custom name for this secret. */
+  name?: ComposeString;
+  /** Name of an environment variable from which to get the secret value. */
+  environment?: ComposeString;
+  /** Path to a file containing the secret value. */
+  file?: ComposeString;
+  /** Specifies that this secret already exists and was created outside of Compose. */
+  external?: boolean | ComposeString | { name?: ComposeString };
+  /** Add metadata to the secret using labels. */
+  labels?: Record<string, ComposeString | number | boolean | null> | Array<ComposeString>;
+  /** Specify which secret driver should be used for this secret. */
+  driver?: ComposeString;
+  /** Specify driver-specific options. */
+  driver_opts?: Record<string, ComposeString | number>;
+  /** Driver to use for templating the secret's value. */
+  template_driver?: ComposeString;
 }
-export declare const DockerSecret: new (props?: DockerSecretProps) => Declarable;
+
+export declare const Service: new (props?: ServiceProps, attributes?: Record<string, unknown>) => Declarable;
+export declare const Volume: new (props?: VolumeProps, attributes?: Record<string, unknown>) => Declarable;
+export declare const Network: new (props?: NetworkProps, attributes?: Record<string, unknown>) => Declarable;
+export declare const DockerConfig: new (props?: DockerConfigProps, attributes?: Record<string, unknown>) => Declarable;
+export declare const DockerSecret: new (props?: DockerSecretProps, attributes?: Record<string, unknown>) => Declarable;
 
 /** The Dockerfile instructions a step can name. FROM is the stage's own `from` field. */
 export type DockerfileInstructionName = "arg" | "env" | "run" | "copy" | "add" | "workdir" | "user" | "expose" | "volume" | "label" | "entrypoint" | "cmd" | "healthcheck" | "shell" | "stopsignal" | "onbuild";
@@ -172,4 +394,4 @@ export interface DockerfileProps {
   /** HEALTHCHECK as a per-kind field, written in the fixed order. Use `steps` to choose the order. */
   healthcheck?: string;
 }
-export declare const Dockerfile: new (props?: DockerfileProps) => Declarable;
+export declare const Dockerfile: new (props?: DockerfileProps, attributes?: Record<string, unknown>) => Declarable;