@alienplatform/platform-api 1.5.1 → 1.7.1

package/esm/models/syncacquireresponse.d.ts

@@ -1237,6 +1237,92 @@ export type SyncAcquireResponseEnvironmentInfoAws = {
     platform: SyncAcquireResponseCurrentPlatformAws;
 };
 export type SyncAcquireResponseEnvironmentInfoUnion = SyncAcquireResponseEnvironmentInfoGcp | SyncAcquireResponseEnvironmentInfoAzure | SyncAcquireResponseEnvironmentInfoLocal | SyncAcquireResponseEnvironmentInfoAws | SyncAcquireResponseEnvironmentInfoTest | any;
+/**
+ * Canonical error container that provides a structured way to represent errors
+ *
+ * @remarks
+ * with rich metadata including error codes, human-readable messages, context,
+ * and chaining capabilities for error propagation.
+ *
+ * This struct is designed to be both machine-readable and user-friendly,
+ * supporting serialization for API responses and detailed error reporting
+ * in distributed systems.
+ */
+export type SyncAcquireResponseError = {
+    /**
+     * A unique identifier for the type of error.
+     *
+     * @remarks
+     *
+     * This should be a short, machine-readable string that can be used
+     * by clients to programmatically handle different error types.
+     * Examples: "NOT_FOUND", "VALIDATION_ERROR", "TIMEOUT"
+     */
+    code: string;
+    /**
+     * Additional diagnostic information about the error context.
+     *
+     * @remarks
+     *
+     * This optional field can contain structured data providing more details
+     * about the error, such as validation errors, request parameters that
+     * caused the issue, or other relevant context information.
+     */
+    context?: any | null | undefined;
+    /**
+     * Optional human-facing remediation hint.
+     */
+    hint?: string | null | undefined;
+    /**
+     * HTTP status code for this error.
+     *
+     * @remarks
+     *
+     * Used when converting the error to an HTTP response. If None, falls back to
+     * the error type's default status code or 500.
+     */
+    httpStatusCode?: number | null | undefined;
+    /**
+     * Indicates if this is an internal error that should not be exposed to users.
+     *
+     * @remarks
+     *
+     * When `true`, this error contains sensitive information or implementation
+     * details that should not be shown to end-users. Such errors should be
+     * logged for debugging but replaced with generic error messages in responses.
+     */
+    internal: boolean;
+    /**
+     * Human-readable error message.
+     *
+     * @remarks
+     *
+     * This message should be clear and actionable for developers or end-users,
+     * providing context about what went wrong and potentially how to fix it.
+     */
+    message: string;
+    /**
+     * Indicates whether the operation that caused the error should be retried.
+     *
+     * @remarks
+     *
+     * When `true`, the error is transient and the operation might succeed
+     * if attempted again. When `false`, retrying the same operation is
+     * unlikely to succeed without changes.
+     */
+    retryable: boolean;
+    /**
+     * The underlying error that caused this error, creating an error chain.
+     *
+     * @remarks
+     *
+     * This allows for proper error propagation and debugging by maintaining
+     * the full context of how an error occurred through multiple layers
+     * of an application.
+     */
+    source?: any | null | undefined;
+};
+export type SyncAcquireResponseErrorUnion = SyncAcquireResponseError | any;
 /**
  * Represents the target cloud platform.
  */
@@ -1252,58 +1338,6 @@ export declare const SyncAcquireResponseCurrentPlatform: {
  * Represents the target cloud platform.
  */
 export type SyncAcquireResponseCurrentPlatform = ClosedEnum<typeof SyncAcquireResponseCurrentPlatform>;
-/**
- * Scope for a delete operation.
- *
- * @remarks
- *
- * Full deletes are setup/admin owned and may remove both Frozen and Live
- * resources. Live-only deletes are used by setup handoff resources
- * (Terraform/CloudFormation) so Alien removes only the resources it owns
- * before setup tears down Frozen resources.
- */
-export declare const SyncAcquireResponseDeleteScopeEnum: {
-    readonly Full: "full";
-    readonly LiveOnly: "liveOnly";
-};
-/**
- * Scope for a delete operation.
- *
- * @remarks
- *
- * Full deletes are setup/admin owned and may remove both Frozen and Live
- * resources. Live-only deletes are used by setup handoff resources
- * (Terraform/CloudFormation) so Alien removes only the resources it owns
- * before setup tears down Frozen resources.
- */
-export type SyncAcquireResponseDeleteScopeEnum = ClosedEnum<typeof SyncAcquireResponseDeleteScopeEnum>;
-export type SyncAcquireResponseDeleteScopeUnion = SyncAcquireResponseDeleteScopeEnum | any;
-/**
- * Scope for a delete operation.
- *
- * @remarks
- *
- * Full deletes are setup/admin owned and may remove both Frozen and Live
- * resources. Live-only deletes are used by setup handoff resources
- * (Terraform/CloudFormation) so Alien removes only the resources it owns
- * before setup tears down Frozen resources.
- */
-export declare const SyncAcquireResponsePendingDeleteScopeEnum: {
-    readonly Full: "full";
-    readonly LiveOnly: "liveOnly";
-};
-/**
- * Scope for a delete operation.
- *
- * @remarks
- *
- * Full deletes are setup/admin owned and may remove both Frozen and Live
- * resources. Live-only deletes are used by setup handoff resources
- * (Terraform/CloudFormation) so Alien removes only the resources it owns
- * before setup tears down Frozen resources.
- */
-export type SyncAcquireResponsePendingDeleteScopeEnum = ClosedEnum<typeof SyncAcquireResponsePendingDeleteScopeEnum>;
-export type SyncAcquireResponsePendingDeleteScopeUnion = SyncAcquireResponsePendingDeleteScopeEnum | any;
 export declare const SyncAcquireResponsePreparedStackManagementEnum: {
     readonly Auto: "auto";
 };
@@ -2420,7 +2454,6 @@ export type SyncAcquireResponsePreparedStackUnion = SyncAcquireResponsePreparedS
  * Stores deployment state that needs to persist across step calls.
  */
 export type SyncAcquireResponseRuntimeMetadata = {
-    deleteScope?: SyncAcquireResponseDeleteScopeEnum | any | null | undefined;
     /**
      * Hash of the environment variables snapshot that was last synced to the vault
      *
@@ -2428,7 +2461,6 @@ export type SyncAcquireResponseRuntimeMetadata = {
      * Used to avoid redundant sync operations during incremental deployment
      */
     lastSyncedEnvVarsHash?: string | null | undefined;
-    pendingDeleteScope?: SyncAcquireResponsePendingDeleteScopeEnum | any | null | undefined;
     preparedStack?: SyncAcquireResponsePreparedStack | any | null | undefined;
     /**
      * Whether cross-account registry access has been successfully granted.
@@ -2512,7 +2544,7 @@ export type SyncAcquireResponseStackStateDependency = {
  * supporting serialization for API responses and detailed error reporting
  * in distributed systems.
  */
-export type SyncAcquireResponseError = {
+export type SyncAcquireResponseStackStateError = {
     /**
      * A unique identifier for the type of error.
      *
@@ -2586,7 +2618,7 @@ export type SyncAcquireResponseError = {
      */
     source?: any | null | undefined;
 };
-export type SyncAcquireResponseErrorUnion = SyncAcquireResponseError | any;
+export type SyncAcquireResponseStackStateErrorUnion = SyncAcquireResponseStackStateError | any;
 /**
  * Describes the lifecycle of a resource within a stack, determining how it's managed and deployed.
  */
@@ -2641,6 +2673,7 @@ export declare const SyncAcquireResponseStackStateStatus: {
     readonly UpdateFailed: "update-failed";
     readonly Deleting: "deleting";
     readonly DeleteFailed: "delete-failed";
+    readonly TeardownRequired: "teardown-required";
     readonly Deleted: "deleted";
     readonly RefreshFailed: "refresh-failed";
 };
@@ -2672,7 +2705,7 @@ export type SyncAcquireResponseStackStateResources = {
      * This preserves the full dependency information from the stack definition.
      */
     dependencies?: Array<SyncAcquireResponseStackStateDependency> | undefined;
-    error?: SyncAcquireResponseError | any | null | undefined;
+    error?: SyncAcquireResponseStackStateError | any | null | undefined;
     /**
      * Stores the controller state that failed, used for manual retry operations.
      *
@@ -2731,6 +2764,7 @@ export type SyncAcquireResponseStackStateUnion = SyncAcquireResponseStackState |
  */
 export declare const SyncAcquireResponseStatus: {
     readonly Pending: "pending";
+    readonly PreflightsFailed: "preflights-failed";
     readonly InitialSetup: "initial-setup";
     readonly InitialSetupFailed: "initial-setup-failed";
     readonly Provisioning: "provisioning";
@@ -2743,6 +2777,8 @@ export declare const SyncAcquireResponseStatus: {
     readonly DeletePending: "delete-pending";
     readonly Deleting: "deleting";
     readonly DeleteFailed: "delete-failed";
+    readonly TeardownRequired: "teardown-required";
+    readonly TeardownFailed: "teardown-failed";
     readonly Deleted: "deleted";
     readonly Error: "error";
 };
@@ -3891,6 +3927,7 @@ export type SyncAcquireResponseTargetReleaseUnion = SyncAcquireResponseTargetRel
 export type SyncAcquireResponseCurrent = {
     currentRelease?: SyncAcquireResponseCurrentRelease | any | null | undefined;
     environmentInfo?: SyncAcquireResponseEnvironmentInfoGcp | SyncAcquireResponseEnvironmentInfoAzure | SyncAcquireResponseEnvironmentInfoLocal | SyncAcquireResponseEnvironmentInfoAws | SyncAcquireResponseEnvironmentInfoTest | any | null | undefined;
+    error?: SyncAcquireResponseError | any | null | undefined;
     /**
      * Represents the target cloud platform.
      */
@@ -4093,6 +4130,81 @@ export type SyncAcquireResponseComputeBackendHorizon = {
     type: SyncAcquireResponseComputeBackendType;
 };
 export type SyncAcquireResponseComputeBackendUnion = SyncAcquireResponseComputeBackendHorizon | any;
+/**
+ * Certificate status in the certificate lifecycle
+ */
+export declare const SyncAcquireResponseAliasCertificateStatus: {
+    readonly Pending: "pending";
+    readonly Issued: "issued";
+    readonly Renewing: "renewing";
+    readonly RenewalFailed: "renewal-failed";
+    readonly Failed: "failed";
+    readonly Deleting: "deleting";
+};
+/**
+ * Certificate status in the certificate lifecycle
+ */
+export type SyncAcquireResponseAliasCertificateStatus = ClosedEnum<typeof SyncAcquireResponseAliasCertificateStatus>;
+/**
+ * DNS record status in the DNS lifecycle
+ */
+export declare const SyncAcquireResponseAliasDnsStatus: {
+    readonly Pending: "pending";
+    readonly Active: "active";
+    readonly Updating: "updating";
+    readonly Deleting: "deleting";
+    readonly Failed: "failed";
+};
+/**
+ * DNS record status in the DNS lifecycle
+ */
+export type SyncAcquireResponseAliasDnsStatus = ClosedEnum<typeof SyncAcquireResponseAliasDnsStatus>;
+/**
+ * Certificate and DNS metadata for a managed hostname.
+ *
+ * @remarks
+ *
+ * Includes decrypted certificate data for issued certificates.
+ * Private keys are deployment-scoped secrets (like environment variables).
+ */
+export type SyncAcquireResponseAlias = {
+    /**
+     * Full PEM certificate chain (only present if status is "issued").
+     */
+    certificateChain?: string | null | undefined;
+    /**
+     * Certificate ID (for tracking/logging).
+     */
+    certificateId: string;
+    /**
+     * Certificate status in the certificate lifecycle
+     */
+    certificateStatus: SyncAcquireResponseAliasCertificateStatus;
+    /**
+     * Last DNS error message. Present when DNS previously failed, even if status
+     *
+     * @remarks
+     * was reset to pending for retry. Used to surface actionable error context
+     * in WaitingForDns failure messages.
+     */
+    dnsError?: string | null | undefined;
+    /**
+     * DNS record status in the DNS lifecycle
+     */
+    dnsStatus: SyncAcquireResponseAliasDnsStatus;
+    /**
+     * Fully qualified domain name.
+     */
+    fqdn: string;
+    /**
+     * ISO 8601 timestamp when certificate was issued (for renewal detection).
+     */
+    issuedAt?: string | null | undefined;
+    /**
+     * Decrypted private key (only present if status is "issued").
+     */
+    privateKey?: string | null | undefined;
+};
 /**
  * Certificate status in the certificate lifecycle
  */
@@ -4127,10 +4239,15 @@ export type SyncAcquireResponseDnsStatus = ClosedEnum<typeof SyncAcquireResponse
  *
  * @remarks
  *
- * Includes decrypted certificate data for issued certificates.
- * Private keys are deployment-scoped secrets (like environment variables).
+ * The direct fields describe the primary generated hostname. `aliases`
+ * contains additional managed hostnames that route directly to the same
+ * resource.
  */
 export type SyncAcquireResponseDomainMetadataResources = {
+    /**
+     * Additional managed hostnames for the resource.
+     */
+    aliases?: Array<SyncAcquireResponseAlias> | undefined;
     /**
      * Full PEM certificate chain (only present if status is "issued").
      */
@@ -5733,29 +5850,16 @@ export type SyncAcquireResponseManagementConfigUnion = SyncAcquireResponseManage
  *
  * @remarks
  *
- * When set, all compute workloads (containers and worker VMs) export
- * their logs to the given endpoint via OTLP/HTTP.
- *
- * The `logs_auth_header` is stored as plain text in DeploymentConfig because
- * alien-runtime reads `OTEL_EXPORTER_OTLP_HEADERS` at tracing-init time,
- * before vault secrets load. For worker VMs, worker-template stamping passes
- * the monitoring configuration to the provider controller, which stores the
- * sensitive header in the cloud vault used by the worker image.
+ * When set, worker runtimes export captured application logs through the
+ * given endpoint via OTLP/HTTP. Auth headers are runtime-owned secret material:
+ * deployment code must sync them to a runtime-only secret and avoid putting
+ * them into user application environment variables.
  */
 export type SyncAcquireResponseMonitoring = {
     /**
-     * Auth header value in "key=value,..." format used for container OTLP env var injection.
+     * Auth header value in "key=value,..." format.
      *
      * @remarks
-     *
-     * `alien-deployment` injects this as the `OTEL_EXPORTER_OTLP_HEADERS` plain env var
-     * into all containers. It must be plain (not a vault secret) because alien-runtime
-     * reads `OTEL_EXPORTER_OTLP_HEADERS` at tracing-init time, before vault secrets load.
-     *
-     * Worker VMs do NOT use this field directly. The ComputeCluster infra
-     * controller writes the same value to the cloud vault used by the worker
-     * image (GCP: Secret Manager, AWS: Secrets Manager, Azure: Key Vault).
-     *
      * Example: "authorization=Bearer <write-token>"
      */
     logsAuthHeader: string;
@@ -7014,17 +7118,13 @@ export declare function syncAcquireResponseEnvironmentInfoAwsFromJSON(jsonString
 export declare const SyncAcquireResponseEnvironmentInfoUnion$inboundSchema: z.ZodType<SyncAcquireResponseEnvironmentInfoUnion, unknown>;
 export declare function syncAcquireResponseEnvironmentInfoUnionFromJSON(jsonString: string): SafeParseResult<SyncAcquireResponseEnvironmentInfoUnion, SDKValidationError>;
 /** @internal */
-export declare const SyncAcquireResponseCurrentPlatform$inboundSchema: z.ZodEnum<typeof SyncAcquireResponseCurrentPlatform>;
-/** @internal */
-export declare const SyncAcquireResponseDeleteScopeEnum$inboundSchema: z.ZodEnum<typeof SyncAcquireResponseDeleteScopeEnum>;
-/** @internal */
-export declare const SyncAcquireResponseDeleteScopeUnion$inboundSchema: z.ZodType<SyncAcquireResponseDeleteScopeUnion, unknown>;
-export declare function syncAcquireResponseDeleteScopeUnionFromJSON(jsonString: string): SafeParseResult<SyncAcquireResponseDeleteScopeUnion, SDKValidationError>;
+export declare const SyncAcquireResponseError$inboundSchema: z.ZodType<SyncAcquireResponseError, unknown>;
+export declare function syncAcquireResponseErrorFromJSON(jsonString: string): SafeParseResult<SyncAcquireResponseError, SDKValidationError>;
 /** @internal */
-export declare const SyncAcquireResponsePendingDeleteScopeEnum$inboundSchema: z.ZodEnum<typeof SyncAcquireResponsePendingDeleteScopeEnum>;
+export declare const SyncAcquireResponseErrorUnion$inboundSchema: z.ZodType<SyncAcquireResponseErrorUnion, unknown>;
+export declare function syncAcquireResponseErrorUnionFromJSON(jsonString: string): SafeParseResult<SyncAcquireResponseErrorUnion, SDKValidationError>;
 /** @internal */
-export declare const SyncAcquireResponsePendingDeleteScopeUnion$inboundSchema: z.ZodType<SyncAcquireResponsePendingDeleteScopeUnion, unknown>;
-export declare function syncAcquireResponsePendingDeleteScopeUnionFromJSON(jsonString: string): SafeParseResult<SyncAcquireResponsePendingDeleteScopeUnion, SDKValidationError>;
+export declare const SyncAcquireResponseCurrentPlatform$inboundSchema: z.ZodEnum<typeof SyncAcquireResponseCurrentPlatform>;
 /** @internal */
 export declare const SyncAcquireResponsePreparedStackManagementEnum$inboundSchema: z.ZodEnum<typeof SyncAcquireResponsePreparedStackManagementEnum>;
 /** @internal */
@@ -7282,11 +7382,11 @@ export declare function syncAcquireResponseControllerPlatformUnionFromJSON(jsonS
 export declare const SyncAcquireResponseStackStateDependency$inboundSchema: z.ZodType<SyncAcquireResponseStackStateDependency, unknown>;
 export declare function syncAcquireResponseStackStateDependencyFromJSON(jsonString: string): SafeParseResult<SyncAcquireResponseStackStateDependency, SDKValidationError>;
 /** @internal */
-export declare const SyncAcquireResponseError$inboundSchema: z.ZodType<SyncAcquireResponseError, unknown>;
-export declare function syncAcquireResponseErrorFromJSON(jsonString: string): SafeParseResult<SyncAcquireResponseError, SDKValidationError>;
+export declare const SyncAcquireResponseStackStateError$inboundSchema: z.ZodType<SyncAcquireResponseStackStateError, unknown>;
+export declare function syncAcquireResponseStackStateErrorFromJSON(jsonString: string): SafeParseResult<SyncAcquireResponseStackStateError, SDKValidationError>;
 /** @internal */
-export declare const SyncAcquireResponseErrorUnion$inboundSchema: z.ZodType<SyncAcquireResponseErrorUnion, unknown>;
-export declare function syncAcquireResponseErrorUnionFromJSON(jsonString: string): SafeParseResult<SyncAcquireResponseErrorUnion, SDKValidationError>;
+export declare const SyncAcquireResponseStackStateErrorUnion$inboundSchema: z.ZodType<SyncAcquireResponseStackStateErrorUnion, unknown>;
+export declare function syncAcquireResponseStackStateErrorUnionFromJSON(jsonString: string): SafeParseResult<SyncAcquireResponseStackStateErrorUnion, SDKValidationError>;
 /** @internal */
 export declare const SyncAcquireResponseStackStateLifecycleEnum$inboundSchema: z.ZodEnum<typeof SyncAcquireResponseStackStateLifecycleEnum>;
 /** @internal */
@@ -7610,6 +7710,13 @@ export declare function syncAcquireResponseComputeBackendHorizonFromJSON(jsonStr
 export declare const SyncAcquireResponseComputeBackendUnion$inboundSchema: z.ZodType<SyncAcquireResponseComputeBackendUnion, unknown>;
 export declare function syncAcquireResponseComputeBackendUnionFromJSON(jsonString: string): SafeParseResult<SyncAcquireResponseComputeBackendUnion, SDKValidationError>;
 /** @internal */
+export declare const SyncAcquireResponseAliasCertificateStatus$inboundSchema: z.ZodEnum<typeof SyncAcquireResponseAliasCertificateStatus>;
+/** @internal */
+export declare const SyncAcquireResponseAliasDnsStatus$inboundSchema: z.ZodEnum<typeof SyncAcquireResponseAliasDnsStatus>;
+/** @internal */
+export declare const SyncAcquireResponseAlias$inboundSchema: z.ZodType<SyncAcquireResponseAlias, unknown>;
+export declare function syncAcquireResponseAliasFromJSON(jsonString: string): SafeParseResult<SyncAcquireResponseAlias, SDKValidationError>;
+/** @internal */
 export declare const SyncAcquireResponseCertificateStatus$inboundSchema: z.ZodEnum<typeof SyncAcquireResponseCertificateStatus>;
 /** @internal */
 export declare const SyncAcquireResponseDnsStatus$inboundSchema: z.ZodEnum<typeof SyncAcquireResponseDnsStatus>;