@phala/cloud 0.2.1-beta.4 → 0.2.1

package/dist/actions/cvms/update_docker_compose.d.ts

@@ -0,0 +1,420 @@
+import { z } from "zod";
+import { type Client } from "../../client";
+/**
+ * Update CVM Docker Compose file
+ *
+ * Updates the Docker Compose configuration for a CVM. Supports two scenarios:
+ * 1. Legacy/offchain KMS: Direct update without compose hash verification
+ * 2. Contract-owned KMS (ETHEREUM/BASE): Requires compose hash verification (two-phase)
+ *
+ * When using contract-owned KMS and compose_hash/transaction_hash are not provided,
+ * the API returns HTTP 465 with the compose hash to sign.
+ * The client should then register the compose hash on-chain and retry the request
+ * with both compose_hash and transaction_hash.
+ *
+ * @example
+ * ```typescript
+ * import { createClient, updateDockerCompose } from '@phala/cloud'
+ *
+ * const client = createClient({ apiKey: 'your-api-key' })
+ *
+ * const composeYaml = `
+ * version: '3'
+ * services:
+ *   web:
+ *     image: nginx:latest
+ *     ports:
+ *       - "80:80"
+ * `
+ *
+ * // Phase 1: Initial update (may return precondition_required for contract-owned KMS)
+ * const result = await updateDockerCompose(client, {
+ *   id: 'cvm-123',
+ *   docker_compose_file: composeYaml
+ * })
+ *
+ * if (result.status === 'precondition_required') {
+ *   // Register compose hash on-chain and get transaction hash
+ *   const txHash = await registerComposeHashOnChain(
+ *     result.compose_hash,
+ *     result.kms_info
+ *   )
+ *
+ *   // Phase 2: Retry with compose hash and transaction hash
+ *   const finalResult = await updateDockerCompose(client, {
+ *     id: 'cvm-123',
+ *     docker_compose_file: composeYaml,
+ *     compose_hash: result.compose_hash,
+ *     transaction_hash: txHash
+ *   })
+ *
+ *   if (finalResult.status === 'in_progress') {
+ *     console.log(`Update started: ${finalResult.correlation_id}`)
+ *   }
+ * }
+ * ```
+ *
+ * ## Returns
+ *
+ * `UpdateDockerComposeResult | unknown`
+ *
+ * Returns either:
+ * - `{ status: "in_progress", ... }` - Update initiated successfully
+ * - `{ status: "precondition_required", compose_hash: "...", ... }` - Compose hash verification required
+ *
+ * Return type depends on schema parameter.
+ *
+ * ## Parameters
+ *
+ * ### request (required)
+ * - **Type:** `UpdateDockerComposeRequest`
+ *
+ * Request parameters containing CVM ID, docker_compose_file content, and optional compose_hash/transaction_hash.
+ *
+ * ### parameters (optional)
+ * - **Type:** `UpdateDockerComposeParameters`
+ *
+ * Optional behavior parameters for schema validation.
+ *
+ * ```typescript
+ * // Use default schema
+ * const result = await updateDockerCompose(client, {
+ *   id: 'cvm-123',
+ *   docker_compose_file: composeYaml
+ * })
+ *
+ * // Return raw data without validation
+ * const raw = await updateDockerCompose(client, request, { schema: false })
+ *
+ * // Use custom schema
+ * const customSchema = z.object({ status: z.string() })
+ * const custom = await updateDockerCompose(client, request, { schema: customSchema })
+ * ```
+ *
+ * ## Safe Version
+ *
+ * Use `safeUpdateDockerCompose` for error handling without exceptions:
+ *
+ * ```typescript
+ * import { safeUpdateDockerCompose } from '@phala/cloud'
+ *
+ * const result = await safeUpdateDockerCompose(client, {
+ *   id: 'cvm-123',
+ *   docker_compose_file: composeYaml
+ * })
+ *
+ * if (result.success) {
+ *   if (result.data.status === 'precondition_required') {
+ *     console.log(`Compose hash: ${result.data.compose_hash}`)
+ *     console.log(`App ID: ${result.data.app_id}`)
+ *     // Register on-chain and retry with transaction_hash
+ *   } else {
+ *     console.log(`Update started: ${result.data.correlation_id}`)
+ *   }
+ * } else {
+ *   if ("isRequestError" in result.error) {
+ *     console.error(`HTTP ${result.error.status}: ${result.error.message}`)
+ *   } else {
+ *     console.error(`Validation error: ${result.error.issues}`)
+ *   }
+ * }
+ * ```
+ */
+export declare const UpdateDockerComposeRequestSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
+    id: z.ZodOptional<z.ZodString>;
+    uuid: z.ZodOptional<z.ZodString>;
+    app_id: z.ZodOptional<z.ZodString>;
+    instance_id: z.ZodOptional<z.ZodString>;
+    name: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+} & {
+    docker_compose_file: z.ZodString;
+    compose_hash: z.ZodOptional<z.ZodString>;
+    transaction_hash: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    docker_compose_file: string;
+    name?: string | undefined;
+    id?: string | undefined;
+    app_id?: string | undefined;
+    instance_id?: string | undefined;
+    compose_hash?: string | undefined;
+    uuid?: string | undefined;
+    transaction_hash?: string | undefined;
+}, {
+    docker_compose_file: string;
+    name?: string | undefined;
+    id?: string | undefined;
+    app_id?: string | undefined;
+    instance_id?: string | undefined;
+    compose_hash?: string | undefined;
+    uuid?: string | undefined;
+    transaction_hash?: string | undefined;
+}>, any, any>, {
+    cvmId: any;
+    request: {
+        docker_compose_file: any;
+        compose_hash: any;
+        transaction_hash: any;
+    };
+    _raw: any;
+}, any>;
+declare const UpdateDockerComposeInProgressSchema: z.ZodObject<{
+    status: z.ZodLiteral<"in_progress">;
+    message: z.ZodString;
+    correlation_id: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    status: "in_progress";
+    message: string;
+    correlation_id: string;
+}, {
+    status: "in_progress";
+    message: string;
+    correlation_id: string;
+}>;
+declare const UpdateDockerComposePreconditionRequiredSchema: z.ZodObject<{
+    status: z.ZodLiteral<"precondition_required">;
+    message: z.ZodString;
+    compose_hash: z.ZodString;
+    app_id: z.ZodString;
+    device_id: z.ZodString;
+    kms_info: z.ZodEffects<z.ZodObject<{
+        id: z.ZodString;
+        slug: z.ZodNullable<z.ZodString>;
+        url: z.ZodString;
+        version: z.ZodString;
+        chain_id: z.ZodNullable<z.ZodNumber>;
+        kms_contract_address: z.ZodEffects<z.ZodNullable<z.ZodString>, `0x${string}`, string | null>;
+        gateway_app_id: z.ZodEffects<z.ZodNullable<z.ZodString>, `0x${string}`, string | null>;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        id: z.ZodString;
+        slug: z.ZodNullable<z.ZodString>;
+        url: z.ZodString;
+        version: z.ZodString;
+        chain_id: z.ZodNullable<z.ZodNumber>;
+        kms_contract_address: z.ZodEffects<z.ZodNullable<z.ZodString>, `0x${string}`, string | null>;
+        gateway_app_id: z.ZodEffects<z.ZodNullable<z.ZodString>, `0x${string}`, string | null>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        id: z.ZodString;
+        slug: z.ZodNullable<z.ZodString>;
+        url: z.ZodString;
+        version: z.ZodString;
+        chain_id: z.ZodNullable<z.ZodNumber>;
+        kms_contract_address: z.ZodEffects<z.ZodNullable<z.ZodString>, `0x${string}`, string | null>;
+        gateway_app_id: z.ZodEffects<z.ZodNullable<z.ZodString>, `0x${string}`, string | null>;
+    }, z.ZodTypeAny, "passthrough">>, z.objectOutputType<{
+        id: z.ZodString;
+        slug: z.ZodNullable<z.ZodString>;
+        url: z.ZodString;
+        version: z.ZodString;
+        chain_id: z.ZodNullable<z.ZodNumber>;
+        kms_contract_address: z.ZodEffects<z.ZodNullable<z.ZodString>, `0x${string}`, string | null>;
+        gateway_app_id: z.ZodEffects<z.ZodNullable<z.ZodString>, `0x${string}`, string | null>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        id: z.ZodString;
+        slug: z.ZodNullable<z.ZodString>;
+        url: z.ZodString;
+        version: z.ZodString;
+        chain_id: z.ZodNullable<z.ZodNumber>;
+        kms_contract_address: z.ZodEffects<z.ZodNullable<z.ZodString>, `0x${string}`, string | null>;
+        gateway_app_id: z.ZodEffects<z.ZodNullable<z.ZodString>, `0x${string}`, string | null>;
+    }, z.ZodTypeAny, "passthrough">>;
+}, "strip", z.ZodTypeAny, {
+    status: "precondition_required";
+    message: string;
+    app_id: string;
+    kms_info: {
+        version: string;
+        id: string;
+        slug: string | null;
+        url: string;
+        chain_id: number | null;
+        kms_contract_address: `0x${string}`;
+        gateway_app_id: `0x${string}`;
+    } & {
+        [k: string]: unknown;
+    };
+    device_id: string;
+    compose_hash: string;
+}, {
+    status: "precondition_required";
+    message: string;
+    app_id: string;
+    kms_info: {
+        version: string;
+        id: string;
+        slug: string | null;
+        url: string;
+        chain_id: number | null;
+        kms_contract_address: string | null;
+        gateway_app_id: string | null;
+    } & {
+        [k: string]: unknown;
+    };
+    device_id: string;
+    compose_hash: string;
+}>;
+export declare const UpdateDockerComposeResultSchema: z.ZodUnion<[z.ZodObject<{
+    status: z.ZodLiteral<"in_progress">;
+    message: z.ZodString;
+    correlation_id: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    status: "in_progress";
+    message: string;
+    correlation_id: string;
+}, {
+    status: "in_progress";
+    message: string;
+    correlation_id: string;
+}>, z.ZodObject<{
+    status: z.ZodLiteral<"precondition_required">;
+    message: z.ZodString;
+    compose_hash: z.ZodString;
+    app_id: z.ZodString;
+    device_id: z.ZodString;
+    kms_info: z.ZodEffects<z.ZodObject<{
+        id: z.ZodString;
+        slug: z.ZodNullable<z.ZodString>;
+        url: z.ZodString;
+        version: z.ZodString;
+        chain_id: z.ZodNullable<z.ZodNumber>;
+        kms_contract_address: z.ZodEffects<z.ZodNullable<z.ZodString>, `0x${string}`, string | null>;
+        gateway_app_id: z.ZodEffects<z.ZodNullable<z.ZodString>, `0x${string}`, string | null>;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        id: z.ZodString;
+        slug: z.ZodNullable<z.ZodString>;
+        url: z.ZodString;
+        version: z.ZodString;
+        chain_id: z.ZodNullable<z.ZodNumber>;
+        kms_contract_address: z.ZodEffects<z.ZodNullable<z.ZodString>, `0x${string}`, string | null>;
+        gateway_app_id: z.ZodEffects<z.ZodNullable<z.ZodString>, `0x${string}`, string | null>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        id: z.ZodString;
+        slug: z.ZodNullable<z.ZodString>;
+        url: z.ZodString;
+        version: z.ZodString;
+        chain_id: z.ZodNullable<z.ZodNumber>;
+        kms_contract_address: z.ZodEffects<z.ZodNullable<z.ZodString>, `0x${string}`, string | null>;
+        gateway_app_id: z.ZodEffects<z.ZodNullable<z.ZodString>, `0x${string}`, string | null>;
+    }, z.ZodTypeAny, "passthrough">>, z.objectOutputType<{
+        id: z.ZodString;
+        slug: z.ZodNullable<z.ZodString>;
+        url: z.ZodString;
+        version: z.ZodString;
+        chain_id: z.ZodNullable<z.ZodNumber>;
+        kms_contract_address: z.ZodEffects<z.ZodNullable<z.ZodString>, `0x${string}`, string | null>;
+        gateway_app_id: z.ZodEffects<z.ZodNullable<z.ZodString>, `0x${string}`, string | null>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        id: z.ZodString;
+        slug: z.ZodNullable<z.ZodString>;
+        url: z.ZodString;
+        version: z.ZodString;
+        chain_id: z.ZodNullable<z.ZodNumber>;
+        kms_contract_address: z.ZodEffects<z.ZodNullable<z.ZodString>, `0x${string}`, string | null>;
+        gateway_app_id: z.ZodEffects<z.ZodNullable<z.ZodString>, `0x${string}`, string | null>;
+    }, z.ZodTypeAny, "passthrough">>;
+}, "strip", z.ZodTypeAny, {
+    status: "precondition_required";
+    message: string;
+    app_id: string;
+    kms_info: {
+        version: string;
+        id: string;
+        slug: string | null;
+        url: string;
+        chain_id: number | null;
+        kms_contract_address: `0x${string}`;
+        gateway_app_id: `0x${string}`;
+    } & {
+        [k: string]: unknown;
+    };
+    device_id: string;
+    compose_hash: string;
+}, {
+    status: "precondition_required";
+    message: string;
+    app_id: string;
+    kms_info: {
+        version: string;
+        id: string;
+        slug: string | null;
+        url: string;
+        chain_id: number | null;
+        kms_contract_address: string | null;
+        gateway_app_id: string | null;
+    } & {
+        [k: string]: unknown;
+    };
+    device_id: string;
+    compose_hash: string;
+}>]>;
+export type UpdateDockerComposeRequest = z.input<typeof UpdateDockerComposeRequestSchema>;
+export type UpdateDockerComposeResult = z.infer<typeof UpdateDockerComposeResultSchema>;
+export type UpdateDockerComposeInProgress = z.infer<typeof UpdateDockerComposeInProgressSchema>;
+export type UpdateDockerComposePreconditionRequired = z.infer<typeof UpdateDockerComposePreconditionRequiredSchema>;
+/**
+ * Update CVM Docker Compose file
+ *
+ * @param client - The API client
+ * @param request - Request parameters containing CVM ID and Docker Compose content
+ * @param parameters - Optional behavior parameters
+ * @returns Update result (either in_progress or precondition_required)
+ */
+declare const updateDockerCompose: {
+    (client: Client<import("../..").ApiVersion>, params?: any): Promise<{
+        status: "in_progress";
+        message: string;
+        correlation_id: string;
+    } | {
+        status: "precondition_required";
+        message: string;
+        app_id: string;
+        kms_info: {
+            version: string;
+            id: string;
+            slug: string | null;
+            url: string;
+            chain_id: number | null;
+            kms_contract_address: `0x${string}`;
+            gateway_app_id: `0x${string}`;
+        } & {
+            [k: string]: unknown;
+        };
+        device_id: string;
+        compose_hash: string;
+    }>;
+    <T extends z.ZodTypeAny>(client: Client<import("../..").ApiVersion>, params?: any, parameters?: {
+        schema: T;
+    } | undefined): Promise<z.TypeOf<T>>;
+    (client: Client<import("../..").ApiVersion>, params?: any, parameters?: {
+        schema: false;
+    } | undefined): Promise<unknown>;
+}, safeUpdateDockerCompose: {
+    (client: Client<import("../..").ApiVersion>, params?: any): Promise<import("../..").SafeResult<{
+        status: "in_progress";
+        message: string;
+        correlation_id: string;
+    } | {
+        status: "precondition_required";
+        message: string;
+        app_id: string;
+        kms_info: {
+            version: string;
+            id: string;
+            slug: string | null;
+            url: string;
+            chain_id: number | null;
+            kms_contract_address: `0x${string}`;
+            gateway_app_id: `0x${string}`;
+        } & {
+            [k: string]: unknown;
+        };
+        device_id: string;
+        compose_hash: string;
+    }>>;
+    <T extends z.ZodTypeAny>(client: Client<import("../..").ApiVersion>, params?: any, parameters?: {
+        schema: T;
+    } | undefined): Promise<import("../..").SafeResult<z.TypeOf<T>>>;
+    (client: Client<import("../..").ApiVersion>, params?: any, parameters?: {
+        schema: false;
+    } | undefined): Promise<import("../..").SafeResult<unknown>>;
+};
+export { updateDockerCompose, safeUpdateDockerCompose };

package/dist/actions/cvms/update_os_image.d.ts

@@ -25,16 +25,19 @@ export declare const UpdateOsImageRequestSchema: z.ZodEffects<z.ZodObject<{
     uuid: z.ZodOptional<z.ZodString>;
     app_id: z.ZodOptional<z.ZodString>;
     instance_id: z.ZodOptional<z.ZodString>;
+    name: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
 } & {
     os_image_name: z.ZodString;
 }, "strip", z.ZodTypeAny, {
     os_image_name: string;
+    name?: string | undefined;
     id?: string | undefined;
     app_id?: string | undefined;
     instance_id?: string | undefined;
     uuid?: string | undefined;
 }, {
     os_image_name: string;
+    name?: string | undefined;
     id?: string | undefined;
     app_id?: string | undefined;
     instance_id?: string | undefined;
@@ -42,19 +45,19 @@ export declare const UpdateOsImageRequestSchema: z.ZodEffects<z.ZodObject<{
 }>, any, any>;
 export type UpdateOsImageRequest = z.infer<typeof UpdateOsImageRequestSchema>;
 declare const updateOsImage: {
-    (client: import("../..").BaseClient, params?: any): Promise<void>;
-    <T extends z.ZodTypeAny>(client: import("../..").BaseClient, params?: any, parameters?: {
+    (client: import("../..").BaseClient<import("../..").ApiVersion>, params?: any): Promise<void>;
+    <T extends z.ZodTypeAny>(client: import("../..").BaseClient<import("../..").ApiVersion>, params?: any, parameters?: {
         schema: T;
     } | undefined): Promise<z.TypeOf<T>>;
-    (client: import("../..").BaseClient, params?: any, parameters?: {
+    (client: import("../..").BaseClient<import("../..").ApiVersion>, params?: any, parameters?: {
         schema: false;
     } | undefined): Promise<unknown>;
 }, safeUpdateOsImage: {
-    (client: import("../..").BaseClient, params?: any): Promise<import("../..").SafeResult<void>>;
-    <T extends z.ZodTypeAny>(client: import("../..").BaseClient, params?: any, parameters?: {
+    (client: import("../..").BaseClient<import("../..").ApiVersion>, params?: any): Promise<import("../..").SafeResult<void>>;
+    <T extends z.ZodTypeAny>(client: import("../..").BaseClient<import("../..").ApiVersion>, params?: any, parameters?: {
         schema: T;
     } | undefined): Promise<import("../..").SafeResult<z.TypeOf<T>>>;
-    (client: import("../..").BaseClient, params?: any, parameters?: {
+    (client: import("../..").BaseClient<import("../..").ApiVersion>, params?: any, parameters?: {
         schema: false;
     } | undefined): Promise<import("../..").SafeResult<unknown>>;
 };