napbox 0.0.0-stage → 0.1.0

package/dist/protocol.d.ts

@@ -0,0 +1,508 @@
+import { z } from "zod";
+/** 错误码，napboxd 原样给什么这里就是什么 */
+export declare const errorCodes: readonly ["daemon_unavailable", "bad_request", "unknown_method", "protocol_error", "usage_error", "internal_error", "compose_not_found", "compose_invalid", "compose_unsupported", "not_in_repository", "port_unavailable", "state_corrupted", "environment_not_found", "runtime_unavailable", "image_unavailable", "image_build_failed", "service_failed", "service_not_found", "volume_not_found", "healthcheck_timeout", "address_unavailable", "name_taken", "owner_mismatch"];
+export type ErrorCode = (typeof errorCodes)[number];
+export declare const methods: {
+    readonly status: "status";
+    readonly up: "up";
+    readonly down: "down";
+    readonly sleep: "sleep";
+    readonly egress: "egress";
+    readonly environment: "environment";
+    readonly logs: "logs";
+    readonly exec: "exec";
+    readonly subscribe: "subscribe";
+    readonly run: "run";
+    readonly reset: "reset";
+    readonly imageImport: "image.import";
+    readonly create: "create";
+    readonly wake: "wake";
+    readonly runs: "runs";
+};
+export declare const NapboxErrorBody: z.ZodObject<{
+    code: z.ZodString;
+    message: z.ZodString;
+}, z.core.$strip>;
+export declare const EnvironmentState: z.ZodEnum<{
+    running: "running";
+    sleeping: "sleeping";
+}>;
+export declare const EgressMode: z.ZodEnum<{
+    none: "none";
+    open: "open";
+}>;
+export declare const ServiceExitRestart: z.ZodEnum<{
+    gave_up: "gave_up";
+    none: "none";
+    restarting: "restarting";
+}>;
+export declare const RunPurpose: z.ZodEnum<{
+    reset: "reset";
+    restart: "restart";
+    up: "up";
+    wake: "wake";
+}>;
+export declare const Readiness: z.ZodEnum<{
+    healthcheck: "healthcheck";
+    port: "port";
+    process: "process";
+}>;
+export declare const OutputStream: z.ZodEnum<{
+    stderr: "stderr";
+    stdout: "stdout";
+}>;
+export declare const EventKind: z.ZodEnum<{
+    destroyed: "destroyed";
+    service_exited: "service_exited";
+    slept: "slept";
+    start_failed: "start_failed";
+    started: "started";
+}>;
+export declare const SleepReason: z.ZodEnum<{
+    host_address: "host_address";
+    idle: "idle";
+    request: "request";
+    shutdown: "shutdown";
+    vm_lost: "vm_lost";
+}>;
+export declare const PortInfo: z.ZodObject<{
+    service: z.ZodString;
+    containerPort: z.ZodInt;
+    hostPort: z.ZodInt;
+    variable: z.ZodString;
+}, z.core.$strip>;
+export declare const ServiceExit: z.ZodObject<{
+    service: z.ZodString;
+    exitCode: z.ZodInt;
+    at: z.ZodISODateTime;
+    restart: z.ZodEnum<{
+        gave_up: "gave_up";
+        none: "none";
+        restarting: "restarting";
+    }>;
+}, z.core.$strip>;
+export declare const EnvironmentInfo: z.ZodObject<{
+    name: z.ZodString;
+    owner: z.ZodOptional<z.ZodString>;
+    state: z.ZodEnum<{
+        running: "running";
+        sleeping: "sleeping";
+    }>;
+    worktree: z.ZodString;
+    ports: z.ZodArray<z.ZodObject<{
+        service: z.ZodString;
+        containerPort: z.ZodInt;
+        hostPort: z.ZodInt;
+        variable: z.ZodString;
+    }, z.core.$strip>>;
+    egress: z.ZodEnum<{
+        none: "none";
+        open: "open";
+    }>;
+    variables: z.ZodRecord<z.ZodString, z.ZodString>;
+    unsetVariables: z.ZodArray<z.ZodString>;
+    lastError: z.ZodOptional<z.ZodString>;
+    watchError: z.ZodOptional<z.ZodString>;
+    serviceExits: z.ZodArray<z.ZodObject<{
+        service: z.ZodString;
+        exitCode: z.ZodInt;
+        at: z.ZodISODateTime;
+        restart: z.ZodEnum<{
+            gave_up: "gave_up";
+            none: "none";
+            restarting: "restarting";
+        }>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export declare const StatusResult: z.ZodObject<{
+    version: z.ZodString;
+    pid: z.ZodInt;
+    startedAt: z.ZodISODateTime;
+    environments: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        owner: z.ZodOptional<z.ZodString>;
+        state: z.ZodEnum<{
+            running: "running";
+            sleeping: "sleeping";
+        }>;
+        worktree: z.ZodString;
+        ports: z.ZodArray<z.ZodObject<{
+            service: z.ZodString;
+            containerPort: z.ZodInt;
+            hostPort: z.ZodInt;
+            variable: z.ZodString;
+        }, z.core.$strip>>;
+        egress: z.ZodEnum<{
+            none: "none";
+            open: "open";
+        }>;
+        variables: z.ZodRecord<z.ZodString, z.ZodString>;
+        unsetVariables: z.ZodArray<z.ZodString>;
+        lastError: z.ZodOptional<z.ZodString>;
+        watchError: z.ZodOptional<z.ZodString>;
+        serviceExits: z.ZodArray<z.ZodObject<{
+            service: z.ZodString;
+            exitCode: z.ZodInt;
+            at: z.ZodISODateTime;
+            restart: z.ZodEnum<{
+                gave_up: "gave_up";
+                none: "none";
+                restarting: "restarting";
+            }>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/** 操作哪个环境：worktree 持有的写 `{ cwd }`（它的临时环境再带上 `temp`），调用方持有的写 `{ name, owner }` */
+export declare const EnvironmentTarget: z.ZodUnion<readonly [z.ZodObject<{
+    cwd: z.ZodString;
+    temp: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>, z.ZodObject<{
+    name: z.ZodString;
+    owner: z.ZodString;
+}, z.core.$strip>]>;
+export declare const UpParams: z.ZodObject<{
+    cwd: z.ZodString;
+    files: z.ZodArray<z.ZodString>;
+    profiles: z.ZodArray<z.ZodString>;
+    environment: z.ZodRecord<z.ZodString, z.ZodString>;
+    build: z.ZodBoolean;
+    temp: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export declare const RunParams: z.ZodObject<{
+    cwd: z.ZodString;
+    files: z.ZodArray<z.ZodString>;
+    profiles: z.ZodArray<z.ZodString>;
+    environment: z.ZodRecord<z.ZodString, z.ZodString>;
+    build: z.ZodBoolean;
+    egress: z.ZodOptional<z.ZodEnum<{
+        none: "none";
+        open: "open";
+    }>>;
+    service: z.ZodString;
+    command: z.ZodArray<z.ZodString>;
+    noDeps: z.ZodBoolean;
+}, z.core.$strip>;
+export declare const EnvironmentParams: z.ZodObject<{
+    target: z.ZodUnion<readonly [z.ZodObject<{
+        cwd: z.ZodString;
+        temp: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>, z.ZodObject<{
+        name: z.ZodString;
+        owner: z.ZodString;
+    }, z.core.$strip>]>;
+}, z.core.$strip>;
+export declare const CreateParams: z.ZodObject<{
+    name: z.ZodString;
+    owner: z.ZodString;
+    directory: z.ZodString;
+    files: z.ZodArray<z.ZodString>;
+    profiles: z.ZodArray<z.ZodString>;
+    environment: z.ZodRecord<z.ZodString, z.ZodString>;
+    egress: z.ZodOptional<z.ZodEnum<{
+        none: "none";
+        open: "open";
+    }>>;
+}, z.core.$strip>;
+export declare const ResetParams: z.ZodObject<{
+    target: z.ZodUnion<readonly [z.ZodObject<{
+        cwd: z.ZodString;
+        temp: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>, z.ZodObject<{
+        name: z.ZodString;
+        owner: z.ZodString;
+    }, z.core.$strip>]>;
+    volume: z.ZodString;
+}, z.core.$strip>;
+export declare const EgressParams: z.ZodObject<{
+    target: z.ZodUnion<readonly [z.ZodObject<{
+        cwd: z.ZodString;
+        temp: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>, z.ZodObject<{
+        name: z.ZodString;
+        owner: z.ZodString;
+    }, z.core.$strip>]>;
+    mode: z.ZodEnum<{
+        none: "none";
+        open: "open";
+    }>;
+}, z.core.$strip>;
+export declare const DownResult: z.ZodObject<{
+    name: z.ZodString;
+    releasedPorts: z.ZodArray<z.ZodInt>;
+    keptDataAt: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export declare const ImageImportParams: z.ZodObject<{
+    reference: z.ZodString;
+}, z.core.$strip>;
+export declare const ImageImportResult: z.ZodObject<{
+    reference: z.ZodString;
+    digest: z.ZodString;
+}, z.core.$strip>;
+export declare const StreamOutput: z.ZodObject<{
+    stream: z.ZodEnum<{
+        stderr: "stderr";
+        stdout: "stdout";
+    }>;
+    data: z.ZodBase64;
+}, z.core.$strip>;
+export declare const StdinMessage: z.ZodObject<{
+    data: z.ZodOptional<z.ZodBase64>;
+    end: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+export declare const LogsParams: z.ZodObject<{
+    target: z.ZodUnion<readonly [z.ZodObject<{
+        cwd: z.ZodString;
+        temp: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>, z.ZodObject<{
+        name: z.ZodString;
+        owner: z.ZodString;
+    }, z.core.$strip>]>;
+    service: z.ZodString;
+    tail: z.ZodOptional<z.ZodInt>;
+    follow: z.ZodBoolean;
+}, z.core.$strip>;
+export declare const LogsResult: z.ZodObject<{
+    ended: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export declare const ExecParams: z.ZodObject<{
+    target: z.ZodUnion<readonly [z.ZodObject<{
+        cwd: z.ZodString;
+        temp: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>, z.ZodObject<{
+        name: z.ZodString;
+        owner: z.ZodString;
+    }, z.core.$strip>]>;
+    service: z.ZodString;
+    command: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+export declare const ExecResult: z.ZodObject<{
+    exitCode: z.ZodInt;
+}, z.core.$strip>;
+export declare const ServiceRun: z.ZodObject<{
+    service: z.ZodString;
+    image: z.ZodString;
+    digest: z.ZodString;
+    platformDigest: z.ZodString;
+    skipped: z.ZodBoolean;
+    startedAt: z.ZodOptional<z.ZodISODateTime>;
+    readyAt: z.ZodOptional<z.ZodISODateTime>;
+    readiness: z.ZodOptional<z.ZodEnum<{
+        healthcheck: "healthcheck";
+        port: "port";
+        process: "process";
+    }>>;
+}, z.core.$strip>;
+export declare const RunRecord: z.ZodObject<{
+    id: z.ZodString;
+    environment: z.ZodString;
+    purpose: z.ZodEnum<{
+        reset: "reset";
+        restart: "restart";
+        up: "up";
+        wake: "wake";
+    }>;
+    startedAt: z.ZodISODateTime;
+    finishedAt: z.ZodISODateTime;
+    error: z.ZodOptional<z.ZodObject<{
+        code: z.ZodString;
+        message: z.ZodString;
+    }, z.core.$strip>>;
+    definitionDigest: z.ZodString;
+    egress: z.ZodEnum<{
+        none: "none";
+        open: "open";
+    }>;
+    ports: z.ZodArray<z.ZodObject<{
+        service: z.ZodString;
+        containerPort: z.ZodInt;
+        hostPort: z.ZodInt;
+        variable: z.ZodString;
+    }, z.core.$strip>>;
+    services: z.ZodArray<z.ZodObject<{
+        service: z.ZodString;
+        image: z.ZodString;
+        digest: z.ZodString;
+        platformDigest: z.ZodString;
+        skipped: z.ZodBoolean;
+        startedAt: z.ZodOptional<z.ZodISODateTime>;
+        readyAt: z.ZodOptional<z.ZodISODateTime>;
+        readiness: z.ZodOptional<z.ZodEnum<{
+            healthcheck: "healthcheck";
+            port: "port";
+            process: "process";
+        }>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export declare const RunsResult: z.ZodObject<{
+    runs: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        environment: z.ZodString;
+        purpose: z.ZodEnum<{
+            reset: "reset";
+            restart: "restart";
+            up: "up";
+            wake: "wake";
+        }>;
+        startedAt: z.ZodISODateTime;
+        finishedAt: z.ZodISODateTime;
+        error: z.ZodOptional<z.ZodObject<{
+            code: z.ZodString;
+            message: z.ZodString;
+        }, z.core.$strip>>;
+        definitionDigest: z.ZodString;
+        egress: z.ZodEnum<{
+            none: "none";
+            open: "open";
+        }>;
+        ports: z.ZodArray<z.ZodObject<{
+            service: z.ZodString;
+            containerPort: z.ZodInt;
+            hostPort: z.ZodInt;
+            variable: z.ZodString;
+        }, z.core.$strip>>;
+        services: z.ZodArray<z.ZodObject<{
+            service: z.ZodString;
+            image: z.ZodString;
+            digest: z.ZodString;
+            platformDigest: z.ZodString;
+            skipped: z.ZodBoolean;
+            startedAt: z.ZodOptional<z.ZodISODateTime>;
+            readyAt: z.ZodOptional<z.ZodISODateTime>;
+            readiness: z.ZodOptional<z.ZodEnum<{
+                healthcheck: "healthcheck";
+                port: "port";
+                process: "process";
+            }>>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export declare const SubscribeParams: z.ZodObject<{
+    owner: z.ZodOptional<z.ZodString>;
+    names: z.ZodOptional<z.ZodArray<z.ZodString>>;
+}, z.core.$strip>;
+export declare const EnvironmentEvent: z.ZodObject<{
+    at: z.ZodISODateTime;
+    environment: z.ZodString;
+    owner: z.ZodOptional<z.ZodString>;
+    type: z.ZodEnum<{
+        destroyed: "destroyed";
+        service_exited: "service_exited";
+        slept: "slept";
+        start_failed: "start_failed";
+        started: "started";
+    }>;
+    purpose: z.ZodOptional<z.ZodEnum<{
+        reset: "reset";
+        restart: "restart";
+        up: "up";
+        wake: "wake";
+    }>>;
+    runId: z.ZodOptional<z.ZodString>;
+    error: z.ZodOptional<z.ZodObject<{
+        code: z.ZodString;
+        message: z.ZodString;
+    }, z.core.$strip>>;
+    sleepReason: z.ZodOptional<z.ZodEnum<{
+        host_address: "host_address";
+        idle: "idle";
+        request: "request";
+        shutdown: "shutdown";
+        vm_lost: "vm_lost";
+    }>>;
+    reason: z.ZodOptional<z.ZodString>;
+    service: z.ZodOptional<z.ZodString>;
+    exitCode: z.ZodOptional<z.ZodInt>;
+    restart: z.ZodOptional<z.ZodEnum<{
+        gave_up: "gave_up";
+        none: "none";
+        restarting: "restarting";
+    }>>;
+}, z.core.$strip>;
+/** subscribe 正常结束时的结果（调用方先断开写端才会有，这个客户端不这样断开） */
+export declare const EmptyResult: z.ZodObject<{}, z.core.$strip>;
+export declare const Request: z.ZodObject<{
+    id: z.ZodInt;
+    method: z.ZodString;
+    params: z.ZodOptional<z.ZodUnknown>;
+}, z.core.$strip>;
+export declare const Response: z.ZodObject<{
+    id: z.ZodInt;
+    result: z.ZodOptional<z.ZodUnknown>;
+    error: z.ZodOptional<z.ZodObject<{
+        code: z.ZodString;
+        message: z.ZodString;
+    }, z.core.$strip>>;
+    output: z.ZodOptional<z.ZodObject<{
+        stream: z.ZodEnum<{
+            stderr: "stderr";
+            stdout: "stdout";
+        }>;
+        data: z.ZodBase64;
+    }, z.core.$strip>>;
+    subscribed: z.ZodOptional<z.ZodBoolean>;
+    event: z.ZodOptional<z.ZodObject<{
+        at: z.ZodISODateTime;
+        environment: z.ZodString;
+        owner: z.ZodOptional<z.ZodString>;
+        type: z.ZodEnum<{
+            destroyed: "destroyed";
+            service_exited: "service_exited";
+            slept: "slept";
+            start_failed: "start_failed";
+            started: "started";
+        }>;
+        purpose: z.ZodOptional<z.ZodEnum<{
+            reset: "reset";
+            restart: "restart";
+            up: "up";
+            wake: "wake";
+        }>>;
+        runId: z.ZodOptional<z.ZodString>;
+        error: z.ZodOptional<z.ZodObject<{
+            code: z.ZodString;
+            message: z.ZodString;
+        }, z.core.$strip>>;
+        sleepReason: z.ZodOptional<z.ZodEnum<{
+            host_address: "host_address";
+            idle: "idle";
+            request: "request";
+            shutdown: "shutdown";
+            vm_lost: "vm_lost";
+        }>>;
+        reason: z.ZodOptional<z.ZodString>;
+        service: z.ZodOptional<z.ZodString>;
+        exitCode: z.ZodOptional<z.ZodInt>;
+        restart: z.ZodOptional<z.ZodEnum<{
+            gave_up: "gave_up";
+            none: "none";
+            restarting: "restarting";
+        }>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type Response = z.infer<typeof Response>;
+export type EnvironmentState = z.infer<typeof EnvironmentState>;
+export type EgressMode = z.infer<typeof EgressMode>;
+export type ServiceExitRestart = z.infer<typeof ServiceExitRestart>;
+export type RunPurpose = z.infer<typeof RunPurpose>;
+export type Readiness = z.infer<typeof Readiness>;
+export type OutputStream = z.infer<typeof OutputStream>;
+export type EventKind = z.infer<typeof EventKind>;
+export type SleepReason = z.infer<typeof SleepReason>;
+export type NapboxErrorBody = z.infer<typeof NapboxErrorBody>;
+export type PortInfo = z.infer<typeof PortInfo>;
+export type ServiceExit = z.infer<typeof ServiceExit>;
+export type EnvironmentInfo = z.infer<typeof EnvironmentInfo>;
+export type StatusResult = z.infer<typeof StatusResult>;
+export type EnvironmentTarget = z.infer<typeof EnvironmentTarget>;
+export type UpParams = z.infer<typeof UpParams>;
+export type RunParams = z.infer<typeof RunParams>;
+export type CreateParams = z.infer<typeof CreateParams>;
+export type DownResult = z.infer<typeof DownResult>;
+export type ImageImportResult = z.infer<typeof ImageImportResult>;
+export type LogsResult = z.infer<typeof LogsResult>;
+export type ExecResult = z.infer<typeof ExecResult>;
+export type ServiceRun = z.infer<typeof ServiceRun>;
+export type RunRecord = z.infer<typeof RunRecord>;
+export type RunsResult = z.infer<typeof RunsResult>;
+export type SubscribeParams = z.infer<typeof SubscribeParams>;
+export type EnvironmentEvent = z.infer<typeof EnvironmentEvent>;