@phala/cloud 0.2.0 → 0.2.1-beta.2

package/dist/index.js

@@ -31,6 +31,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var index_exports = {};
 __export(index_exports, {
   AddComposeHashSchema: () => AddComposeHashSchema,
+  AllFamiliesResponseSchema: () => AllFamiliesResponseSchema,
   ApiErrorSchema: () => ApiErrorSchema,
   AuthError: () => AuthError,
   AvailableNodesSchema: () => AvailableNodesSchema,
@@ -55,6 +56,8 @@ __export(index_exports, {
   DeleteCvmRequestSchema: () => DeleteCvmRequestSchema,
   DeployAppAuthRequestSchema: () => DeployAppAuthRequestSchema,
   DeployAppAuthSchema: () => DeployAppAuthSchema,
+  FamilyGroupSchema: () => FamilyGroupSchema,
+  FamilyInstanceTypesResponseSchema: () => FamilyInstanceTypesResponseSchema,
   GetAppEnvEncryptPubKeyRequestSchema: () => GetAppEnvEncryptPubKeyRequestSchema,
   GetAppEnvEncryptPubKeySchema: () => GetAppEnvEncryptPubKeySchema,
   GetAvailableOSImagesRequestSchema: () => GetAvailableOSImagesRequestSchema,
@@ -74,7 +77,7 @@ __export(index_exports, {
   GetKmsListSchema: () => GetKmsListSchema,
   InstanceTypeSchema: () => InstanceTypeSchema,
   KmsInfoSchema: () => KmsInfoSchema,
-  ListInstanceTypesRequestSchema: () => ListInstanceTypesRequestSchema,
+  ListFamilyInstanceTypesRequestSchema: () => ListFamilyInstanceTypesRequestSchema,
   ListWorkspacesSchema: () => ListWorkspacesSchema,
   ManagedUserSchema: () => ManagedUserSchema,
   MaxRetriesExceededError: () => MaxRetriesExceededError,
@@ -82,7 +85,6 @@ __export(index_exports, {
   NextAppIdsRequestSchema: () => NextAppIdsRequestSchema,
   NextAppIdsSchema: () => NextAppIdsSchema,
   OSImageVariantSchema: () => OSImageVariantSchema,
-  PaginatedInstanceTypesSchema: () => PaginatedInstanceTypesSchema,
   PaginationMetadataSchema: () => PaginationMetadataSchema,
   PhalaCloudError: () => PhalaCloudError,
   ProvisionCvmComposeFileUpdateRequestSchema: () => ProvisionCvmComposeFileUpdateRequestSchema,
@@ -90,6 +92,7 @@ __export(index_exports, {
   ProvisionCvmRequestSchema: () => ProvisionCvmRequestSchema,
   ProvisionCvmSchema: () => ProvisionCvmSchema,
   RequestError: () => RequestError,
+  ResourceError: () => ResourceError,
   RestartCvmRequestSchema: () => RestartCvmRequestSchema,
   SUPPORTED_CHAINS: () => SUPPORTED_CHAINS,
   ServerError: () => ServerError,
@@ -134,6 +137,7 @@ __export(index_exports, {
   executeTransactionWithRetry: () => executeTransactionWithRetry,
   extractNetworkClients: () => extractNetworkClients,
   formatErrorMessage: () => formatErrorMessage,
+  formatStructuredError: () => formatStructuredError,
   formatValidationErrors: () => formatValidationErrors,
   getAppEnvEncryptPubKey: () => getAppEnvEncryptPubKey,
   getAvailableNodes: () => getAvailableNodes,
@@ -154,7 +158,8 @@ __export(index_exports, {
   getKmsList: () => getKmsList,
   getValidationFields: () => getValidationFields,
   getWorkspace: () => getWorkspace,
-  listInstanceTypes: () => listInstanceTypes,
+  listAllInstanceTypeFamilies: () => listAllInstanceTypeFamilies,
+  listFamilyInstanceTypes: () => listFamilyInstanceTypes,
   listWorkspaces: () => listWorkspaces,
   nextAppIds: () => nextAppIds,
   parseApiError: () => parseApiError,
@@ -186,7 +191,8 @@ __export(index_exports, {
   safeGetKmsInfo: () => safeGetKmsInfo,
   safeGetKmsList: () => safeGetKmsList,
   safeGetWorkspace: () => safeGetWorkspace,
-  safeListInstanceTypes: () => safeListInstanceTypes,
+  safeListAllInstanceTypeFamilies: () => safeListAllInstanceTypeFamilies,
+  safeListFamilyInstanceTypes: () => safeListFamilyInstanceTypes,
   safeListWorkspaces: () => safeListWorkspaces,
   safeNextAppIds: () => safeNextAppIds,
   safeProvisionCvm: () => safeProvisionCvm,
@@ -230,8 +236,11 @@ var ApiErrorSchema = import_zod.z.object({
       import_zod.z.object({
         msg: import_zod.z.string(),
         type: import_zod.z.string().optional(),
-        ctx: import_zod.z.record(import_zod.z.unknown()).optional()
-      })
+        ctx: import_zod.z.record(import_zod.z.unknown()).optional(),
+        loc: import_zod.z.array(import_zod.z.union([import_zod.z.string(), import_zod.z.number()])).optional(),
+        input: import_zod.z.unknown().optional()
+      }).passthrough()
+      // Allow additional fields
     ),
     import_zod.z.record(import_zod.z.unknown())
   ]).optional(),
@@ -334,6 +343,9 @@ var UnknownError = class extends PhalaCloudError {
   }
 };
 function extractFieldPath(loc) {
+  if (!loc || !Array.isArray(loc)) {
+    return "unknown";
+  }
   const filtered = loc.filter((part) => {
     if (typeof part === "string") {
       return !["body", "query", "path", "header"].includes(part);
@@ -349,12 +361,21 @@ function parseValidationErrors(detail) {
       message: typeof detail === "string" ? detail : "Validation error"
     };
   }
-  const errors = detail.map((item) => ({
-    field: extractFieldPath(item.loc),
-    message: item.msg,
-    type: item.type,
-    context: item.ctx
-  }));
+  const errors = detail.map(
+    (item, index) => {
+      const field = extractFieldPath(item.loc);
+      let displayField = field;
+      if (field === "unknown" && item.type) {
+        displayField = item.type === "missing" ? "required field" : item.type;
+      }
+      return {
+        field: displayField,
+        message: item.msg,
+        type: item.type,
+        context: item.ctx
+      };
+    }
+  );
   const count = errors.length;
   const message = count === 1 ? `Validation failed: ${errors[0].message}` : `Validation failed (${count} issue${count > 1 ? "s" : ""})`;
   return { errors, message };
@@ -397,13 +418,21 @@ function parseApiError(requestError) {
   const status = requestError.status ?? 0;
   const statusText = requestError.statusText ?? "Unknown Error";
   const detail = requestError.detail;
+  const structured = parseStructuredError(detail);
+  if (structured) {
+    return new ResourceError(structured.message, {
+      status,
+      statusText,
+      detail,
+      errorCode: structured.error_code,
+      structuredDetails: structured.details,
+      suggestions: structured.suggestions,
+      links: structured.links
+    });
+  }
   const errorType = categorizeErrorType(status);
   const message = extractPrimaryMessage(status, detail, requestError.message);
-  const commonData = {
-    status,
-    statusText,
-    detail
-  };
+  const commonData = { status, statusText, detail };
   if (errorType === "validation" && Array.isArray(detail)) {
     const { errors } = parseValidationErrors(detail);
     return new ValidationError(message, {
@@ -465,6 +494,67 @@ function getErrorMessage(error) {
   }
   return "Unknown error occurred";
 }
+var ResourceError = class extends BusinessError {
+  constructor(message, data) {
+    super(message, data);
+    this.isResourceError = true;
+    this.errorCode = data.errorCode;
+    this.structuredDetails = data.structuredDetails;
+    this.suggestions = data.suggestions;
+    this.links = data.links;
+  }
+};
+function parseStructuredError(detail) {
+  if (!detail || typeof detail !== "object") {
+    return null;
+  }
+  const obj = detail;
+  if (obj.error_code && typeof obj.error_code === "string" && obj.message && typeof obj.message === "string") {
+    return {
+      error_code: obj.error_code,
+      message: obj.message,
+      details: obj.details,
+      suggestions: obj.suggestions,
+      links: obj.links
+    };
+  }
+  return null;
+}
+function formatStructuredError(error, options) {
+  const { showErrorCode = true, showSuggestions = true, showLinks = true } = options ?? {};
+  const parts = [];
+  if (showErrorCode && error.errorCode) {
+    parts.push(`Error [${error.errorCode}]: ${error.message}`);
+  } else {
+    parts.push(error.message);
+  }
+  if (error.structuredDetails && error.structuredDetails.length > 0) {
+    parts.push("");
+    parts.push("Details:");
+    error.structuredDetails.forEach((d) => {
+      if (d.message) {
+        parts.push(`  - ${d.message}`);
+      } else if (d.field && d.value !== void 0) {
+        parts.push(`  - ${d.field}: ${d.value}`);
+      }
+    });
+  }
+  if (showSuggestions && error.suggestions && error.suggestions.length > 0) {
+    parts.push("");
+    parts.push("Suggestions:");
+    error.suggestions.forEach((s) => {
+      parts.push(`  - ${s}`);
+    });
+  }
+  if (showLinks && error.links && error.links.length > 0) {
+    parts.push("");
+    parts.push("Learn more:");
+    error.links.forEach((link) => {
+      parts.push(`  - ${link.label}: ${link.url}`);
+    });
+  }
+  return parts.join("\n");
+}
 
 // src/client.ts
 var SUPPORTED_API_VERSIONS = ["2025-05-31", "2025-10-28"];
@@ -1022,10 +1112,6 @@ var { action: getAvailableNodes, safeAction: safeGetAvailableNodes } = defineSim
 
 // src/actions/list-instance-types.ts
 var import_zod5 = require("zod");
-var ListInstanceTypesRequestSchema = import_zod5.z.object({
-  page: import_zod5.z.number().int().min(1).optional().default(1),
-  page_size: import_zod5.z.number().int().min(1).max(1e3).optional().default(100)
-}).strict();
 var InstanceTypeSchema = import_zod5.z.object({
   id: import_zod5.z.string(),
   name: import_zod5.z.string(),
@@ -1034,22 +1120,34 @@ var InstanceTypeSchema = import_zod5.z.object({
   memory_mb: import_zod5.z.number(),
   hourly_rate: import_zod5.z.string(),
   requires_gpu: import_zod5.z.boolean(),
-  public: import_zod5.z.boolean(),
-  enabled: import_zod5.z.boolean()
+  default_disk_size_gb: import_zod5.z.number().default(20),
+  family: import_zod5.z.string().nullable()
 }).passthrough();
-var PaginatedInstanceTypesSchema = import_zod5.z.object({
+var FamilyGroupSchema = import_zod5.z.object({
+  name: import_zod5.z.string(),
+  items: import_zod5.z.array(InstanceTypeSchema),
+  total: import_zod5.z.number()
+}).strict();
+var AllFamiliesResponseSchema = import_zod5.z.object({
+  result: import_zod5.z.array(FamilyGroupSchema)
+}).strict();
+var FamilyInstanceTypesResponseSchema = import_zod5.z.object({
   items: import_zod5.z.array(InstanceTypeSchema),
   total: import_zod5.z.number(),
-  page: import_zod5.z.number(),
-  page_size: import_zod5.z.number(),
-  pages: import_zod5.z.number()
+  family: import_zod5.z.string()
 }).strict();
-var { action: listInstanceTypes, safeAction: safeListInstanceTypes } = defineAction(PaginatedInstanceTypesSchema, async (client, request) => {
-  const validatedRequest = ListInstanceTypesRequestSchema.parse(request ?? {});
-  const queryParams = new URLSearchParams();
-  queryParams.append("page", validatedRequest.page.toString());
-  queryParams.append("page_size", validatedRequest.page_size.toString());
-  return await client.get(`/api/instance-types?${queryParams.toString()}`);
+var ListFamilyInstanceTypesRequestSchema = import_zod5.z.object({
+  family: import_zod5.z.string()
+}).strict();
+var { action: listAllInstanceTypeFamilies, safeAction: safeListAllInstanceTypeFamilies } = defineAction(
+  AllFamiliesResponseSchema,
+  async (client) => {
+    return await client.get("/instance-types");
+  }
+);
+var { action: listFamilyInstanceTypes, safeAction: safeListFamilyInstanceTypes } = defineAction(FamilyInstanceTypesResponseSchema, async (client, request) => {
+  const validated = ListFamilyInstanceTypesRequestSchema.parse(request);
+  return await client.get(`/instance-types/${validated.family}`);
 });
 
 // src/actions/workspaces/list_workspaces.ts
@@ -1269,6 +1367,7 @@ var ProvisionCvmSchema = import_zod10.z.object({
   fmspc: import_zod10.z.string().nullable().optional(),
   device_id: import_zod10.z.string().nullable().optional(),
   os_image_hash: import_zod10.z.string().nullable().optional(),
+  instance_type: import_zod10.z.string().nullable().optional(),
   teepod_id: import_zod10.z.number().nullable().optional(),
   // Will be transformed to node_id
   node_id: import_zod10.z.number().nullable().optional(),
@@ -1282,19 +1381,24 @@ var ProvisionCvmSchema = import_zod10.z.object({
 });
 var ProvisionCvmRequestSchema = import_zod10.z.object({
   node_id: import_zod10.z.number().optional(),
-  // recommended
+  // recommended - optional, system auto-selects if not specified
   teepod_id: import_zod10.z.number().optional(),
   // deprecated, for compatibility
+  region: import_zod10.z.string().optional(),
+  // optional - region filter for auto-selection
   name: import_zod10.z.string(),
-  image: import_zod10.z.string(),
-  vcpu: import_zod10.z.number(),
-  memory: import_zod10.z.number(),
-  disk_size: import_zod10.z.number(),
+  instance_type: import_zod10.z.string().default("tdx.small"),
+  // defaults to "tdx.small"
+  image: import_zod10.z.string().optional(),
+  vcpu: import_zod10.z.number().optional(),
+  memory: import_zod10.z.number().optional(),
+  disk_size: import_zod10.z.number().optional(),
   compose_file: import_zod10.z.object({
     allowed_envs: import_zod10.z.array(import_zod10.z.string()).optional(),
     pre_launch_script: import_zod10.z.string().optional(),
     docker_compose_file: import_zod10.z.string().optional(),
-    name: import_zod10.z.string().optional(),
+    name: import_zod10.z.string().optional().default(""),
+    // optional with default empty string
     kms_enabled: import_zod10.z.boolean().optional(),
     public_logs: import_zod10.z.boolean().optional(),
     public_sysinfo: import_zod10.z.boolean().optional(),
@@ -1304,8 +1408,11 @@ var ProvisionCvmRequestSchema = import_zod10.z.object({
     // deprecated, for compatibility
   }),
   listed: import_zod10.z.boolean().optional(),
-  instance_type: import_zod10.z.string().nullable().optional(),
   kms_id: import_zod10.z.string().optional(),
+  kms: import_zod10.z.enum(["PHALA", "ETHEREUM", "BASE"]).optional(),
+  // KMS type selection (defaults to PHALA)
+  kms_contract: import_zod10.z.string().optional(),
+  // KMS contract address for on-chain KMS
   env_keys: import_zod10.z.array(import_zod10.z.string()).optional()
 }).passthrough();
 function handleGatewayCompatibility(appCompose) {
@@ -1330,7 +1437,8 @@ function handleGatewayCompatibility(appCompose) {
   };
 }
 var { action: provisionCvm, safeAction: safeProvisionCvm } = defineAction(ProvisionCvmSchema, async (client, appCompose) => {
-  const body = handleGatewayCompatibility(appCompose);
+  const validated = ProvisionCvmRequestSchema.parse(appCompose);
+  const body = handleGatewayCompatibility(validated);
   let requestBody = { ...body };
   if (typeof body.node_id === "number") {
     requestBody = { ...body, teepod_id: body.node_id };
@@ -1374,7 +1482,7 @@ var CommitCvmProvisionSchema = import_zod11.z.object({
 var CommitCvmProvisionRequestSchema = import_zod11.z.object({
   encrypted_env: import_zod11.z.string().optional().nullable(),
   app_id: import_zod11.z.string(),
-  compose_hash: import_zod11.z.string().optional(),
+  compose_hash: import_zod11.z.string(),
   kms_id: import_zod11.z.string().optional(),
   contract_address: import_zod11.z.string().optional(),
   deployer_address: import_zod11.z.string().optional(),
@@ -1896,12 +2004,15 @@ var { action: updateOsImage, safeAction: safeUpdateOsImage } = defineAction(impo
 // src/actions/cvms/get_cvm_state.ts
 var import_zod30 = require("zod");
 var CvmStateSchema = import_zod30.z.object({
-  status: import_zod30.z.string(),
-  derived_status: import_zod30.z.string().optional(),
-  vm_uuid: import_zod30.z.string().optional(),
+  id: import_zod30.z.string().optional(),
   instance_id: import_zod30.z.string().optional(),
-  uptime: import_zod30.z.string().optional()
-  // Add other state fields as needed
+  name: import_zod30.z.string(),
+  status: import_zod30.z.string(),
+  uptime: import_zod30.z.string().optional(),
+  exited_at: import_zod30.z.string().optional(),
+  boot_progress: import_zod30.z.string().optional(),
+  boot_error: import_zod30.z.string().optional(),
+  shutdown_progress: import_zod30.z.string().optional()
 });
 var GetCvmStateRequestSchema = CvmIdSchema;
 var { action: getCvmState, safeAction: safeGetCvmState } = defineAction(CvmStateSchema, async (client, request) => {
@@ -1917,8 +2028,10 @@ function createClient2(config = {}) {
     safeGetCurrentUser,
     getAvailableNodes,
     safeGetAvailableNodes,
-    listInstanceTypes,
-    safeListInstanceTypes,
+    listAllInstanceTypeFamilies,
+    safeListAllInstanceTypeFamilies,
+    listFamilyInstanceTypes,
+    safeListFamilyInstanceTypes,
     listWorkspaces,
     safeListWorkspaces,
     getWorkspace,
@@ -3420,6 +3533,7 @@ var import_verify_env_encrypt_public_key = require("@phala/dstack-sdk/verify-env
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   AddComposeHashSchema,
+  AllFamiliesResponseSchema,
   ApiErrorSchema,
   AuthError,
   AvailableNodesSchema,
@@ -3444,6 +3558,8 @@ var import_verify_env_encrypt_public_key = require("@phala/dstack-sdk/verify-env
   DeleteCvmRequestSchema,
   DeployAppAuthRequestSchema,
   DeployAppAuthSchema,
+  FamilyGroupSchema,
+  FamilyInstanceTypesResponseSchema,
   GetAppEnvEncryptPubKeyRequestSchema,
   GetAppEnvEncryptPubKeySchema,
   GetAvailableOSImagesRequestSchema,
@@ -3463,7 +3579,7 @@ var import_verify_env_encrypt_public_key = require("@phala/dstack-sdk/verify-env
   GetKmsListSchema,
   InstanceTypeSchema,
   KmsInfoSchema,
-  ListInstanceTypesRequestSchema,
+  ListFamilyInstanceTypesRequestSchema,
   ListWorkspacesSchema,
   ManagedUserSchema,
   MaxRetriesExceededError,
@@ -3471,7 +3587,6 @@ var import_verify_env_encrypt_public_key = require("@phala/dstack-sdk/verify-env
   NextAppIdsRequestSchema,
   NextAppIdsSchema,
   OSImageVariantSchema,
-  PaginatedInstanceTypesSchema,
   PaginationMetadataSchema,
   PhalaCloudError,
   ProvisionCvmComposeFileUpdateRequestSchema,
@@ -3479,6 +3594,7 @@ var import_verify_env_encrypt_public_key = require("@phala/dstack-sdk/verify-env
   ProvisionCvmRequestSchema,
   ProvisionCvmSchema,
   RequestError,
+  ResourceError,
   RestartCvmRequestSchema,
   SUPPORTED_CHAINS,
   ServerError,
@@ -3523,6 +3639,7 @@ var import_verify_env_encrypt_public_key = require("@phala/dstack-sdk/verify-env
   executeTransactionWithRetry,
   extractNetworkClients,
   formatErrorMessage,
+  formatStructuredError,
   formatValidationErrors,
   getAppEnvEncryptPubKey,
   getAvailableNodes,
@@ -3543,7 +3660,8 @@ var import_verify_env_encrypt_public_key = require("@phala/dstack-sdk/verify-env
   getKmsList,
   getValidationFields,
   getWorkspace,
-  listInstanceTypes,
+  listAllInstanceTypeFamilies,
+  listFamilyInstanceTypes,
   listWorkspaces,
   nextAppIds,
   parseApiError,
@@ -3575,7 +3693,8 @@ var import_verify_env_encrypt_public_key = require("@phala/dstack-sdk/verify-env
   safeGetKmsInfo,
   safeGetKmsList,
   safeGetWorkspace,
-  safeListInstanceTypes,
+  safeListAllInstanceTypeFamilies,
+  safeListFamilyInstanceTypes,
   safeListWorkspaces,
   safeNextAppIds,
   safeProvisionCvm,