@alienplatform/platform-api 1.4.2 → 1.7.0

package/esm/models/syncreconcileresponse.d.ts

@@ -1236,6 +1236,92 @@ export type SyncReconcileResponseEnvironmentInfoAws = {
     platform: SyncReconcileResponseCurrentPlatformAws;
 };
 export type SyncReconcileResponseEnvironmentInfoUnion = SyncReconcileResponseEnvironmentInfoGcp | SyncReconcileResponseEnvironmentInfoAzure | SyncReconcileResponseEnvironmentInfoLocal | SyncReconcileResponseEnvironmentInfoAws | SyncReconcileResponseEnvironmentInfoTest | 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 SyncReconcileResponseError = {
+    /**
+     * 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 SyncReconcileResponseErrorUnion = SyncReconcileResponseError | any;
 /**
  * Represents the target cloud platform.
  */
@@ -1251,58 +1337,6 @@ export declare const SyncReconcileResponseCurrentPlatform: {
  * Represents the target cloud platform.
  */
 export type SyncReconcileResponseCurrentPlatform = ClosedEnum<typeof SyncReconcileResponseCurrentPlatform>;
-/**
- * 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 SyncReconcileResponseDeleteScopeEnum: {
-    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 SyncReconcileResponseDeleteScopeEnum = ClosedEnum<typeof SyncReconcileResponseDeleteScopeEnum>;
-export type SyncReconcileResponseDeleteScopeUnion = SyncReconcileResponseDeleteScopeEnum | 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 SyncReconcileResponsePendingDeleteScopeEnum: {
-    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 SyncReconcileResponsePendingDeleteScopeEnum = ClosedEnum<typeof SyncReconcileResponsePendingDeleteScopeEnum>;
-export type SyncReconcileResponsePendingDeleteScopeUnion = SyncReconcileResponsePendingDeleteScopeEnum | any;
 export declare const SyncReconcileResponsePreparedStackManagementEnum: {
     readonly Auto: "auto";
 };
@@ -2419,7 +2453,6 @@ export type SyncReconcileResponsePreparedStackUnion = SyncReconcileResponsePrepa
  * Stores deployment state that needs to persist across step calls.
  */
 export type SyncReconcileResponseRuntimeMetadata = {
-    deleteScope?: SyncReconcileResponseDeleteScopeEnum | any | null | undefined;
     /**
      * Hash of the environment variables snapshot that was last synced to the vault
      *
@@ -2427,7 +2460,6 @@ export type SyncReconcileResponseRuntimeMetadata = {
      * Used to avoid redundant sync operations during incremental deployment
      */
     lastSyncedEnvVarsHash?: string | null | undefined;
-    pendingDeleteScope?: SyncReconcileResponsePendingDeleteScopeEnum | any | null | undefined;
     preparedStack?: SyncReconcileResponsePreparedStack | any | null | undefined;
     /**
      * Whether cross-account registry access has been successfully granted.
@@ -2511,7 +2543,7 @@ export type SyncReconcileResponseStackStateDependency = {
  * supporting serialization for API responses and detailed error reporting
  * in distributed systems.
  */
-export type SyncReconcileResponseError = {
+export type SyncReconcileResponseStackStateError = {
     /**
      * A unique identifier for the type of error.
      *
@@ -2585,7 +2617,7 @@ export type SyncReconcileResponseError = {
      */
     source?: any | null | undefined;
 };
-export type SyncReconcileResponseErrorUnion = SyncReconcileResponseError | any;
+export type SyncReconcileResponseStackStateErrorUnion = SyncReconcileResponseStackStateError | any;
 /**
  * Describes the lifecycle of a resource within a stack, determining how it's managed and deployed.
  */
@@ -2640,6 +2672,7 @@ export declare const SyncReconcileResponseStackStateStatus: {
     readonly UpdateFailed: "update-failed";
     readonly Deleting: "deleting";
     readonly DeleteFailed: "delete-failed";
+    readonly TeardownRequired: "teardown-required";
     readonly Deleted: "deleted";
     readonly RefreshFailed: "refresh-failed";
 };
@@ -2671,7 +2704,7 @@ export type SyncReconcileResponseStackStateResources = {
      * This preserves the full dependency information from the stack definition.
      */
     dependencies?: Array<SyncReconcileResponseStackStateDependency> | undefined;
-    error?: SyncReconcileResponseError | any | null | undefined;
+    error?: SyncReconcileResponseStackStateError | any | null | undefined;
     /**
      * Stores the controller state that failed, used for manual retry operations.
      *
@@ -2730,6 +2763,7 @@ export type SyncReconcileResponseStackStateUnion = SyncReconcileResponseStackSta
  */
 export declare const SyncReconcileResponseStatus: {
     readonly Pending: "pending";
+    readonly PreflightsFailed: "preflights-failed";
     readonly InitialSetup: "initial-setup";
     readonly InitialSetupFailed: "initial-setup-failed";
     readonly Provisioning: "provisioning";
@@ -2742,6 +2776,8 @@ export declare const SyncReconcileResponseStatus: {
     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";
 };
@@ -3890,6 +3926,7 @@ export type SyncReconcileResponseTargetReleaseUnion = SyncReconcileResponseTarge
 export type SyncReconcileResponseCurrent = {
     currentRelease?: SyncReconcileResponseCurrentRelease | any | null | undefined;
     environmentInfo?: SyncReconcileResponseEnvironmentInfoGcp | SyncReconcileResponseEnvironmentInfoAzure | SyncReconcileResponseEnvironmentInfoLocal | SyncReconcileResponseEnvironmentInfoAws | SyncReconcileResponseEnvironmentInfoTest | any | null | undefined;
+    error?: SyncReconcileResponseError | any | null | undefined;
     /**
      * Represents the target cloud platform.
      */
@@ -4092,6 +4129,81 @@ export type SyncReconcileResponseComputeBackendHorizon = {
     type: SyncReconcileResponseComputeBackendType;
 };
 export type SyncReconcileResponseComputeBackendUnion = SyncReconcileResponseComputeBackendHorizon | any;
+/**
+ * Certificate status in the certificate lifecycle
+ */
+export declare const SyncReconcileResponseAliasCertificateStatus: {
+    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 SyncReconcileResponseAliasCertificateStatus = ClosedEnum<typeof SyncReconcileResponseAliasCertificateStatus>;
+/**
+ * DNS record status in the DNS lifecycle
+ */
+export declare const SyncReconcileResponseAliasDnsStatus: {
+    readonly Pending: "pending";
+    readonly Active: "active";
+    readonly Updating: "updating";
+    readonly Deleting: "deleting";
+    readonly Failed: "failed";
+};
+/**
+ * DNS record status in the DNS lifecycle
+ */
+export type SyncReconcileResponseAliasDnsStatus = ClosedEnum<typeof SyncReconcileResponseAliasDnsStatus>;
+/**
+ * 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 SyncReconcileResponseAlias = {
+    /**
+     * 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: SyncReconcileResponseAliasCertificateStatus;
+    /**
+     * 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: SyncReconcileResponseAliasDnsStatus;
+    /**
+     * 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
  */
@@ -4126,10 +4238,15 @@ export type SyncReconcileResponseDnsStatus = ClosedEnum<typeof SyncReconcileResp
  *
  * @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 DomainMetadataTargetResources = {
+    /**
+     * Additional managed hostnames for the resource.
+     */
+    aliases?: Array<SyncReconcileResponseAlias> | undefined;
     /**
      * Full PEM certificate chain (only present if status is "issued").
      */
@@ -5732,29 +5849,16 @@ export type SyncReconcileResponseManagementConfigUnion = SyncReconcileResponseMa
  *
  * @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 SyncReconcileResponseMonitoring = {
     /**
-     * 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;
@@ -5785,6 +5889,19 @@ export type SyncReconcileResponseMonitoring = {
      * Example: "https://api.axiom.co/v1/metrics"
      */
     metricsEndpoint?: string | null | undefined;
+    /**
+     * Resource attributes attached to every OTLP signal emitted for this deployment.
+     *
+     * @remarks
+     *
+     * Platform managers use this for stable identity such as `alien.workspace_id`,
+     * `alien.project_id`, `alien.deployment_group_id`, and `alien.deployment_id`.
+     * Runtime-specific resource attributes such as `service.name` remain owned by
+     * the runtime/exporter.
+     */
+    resourceAttributes?: {
+        [k: string]: string;
+    } | undefined;
 };
 export type SyncReconcileResponseMonitoringUnion = SyncReconcileResponseMonitoring | any;
 /**
@@ -5804,6 +5921,7 @@ export type SyncReconcileResponseAwsStackSettings = {
 export type SyncReconcileResponseStackSettingsAwsUnion = SyncReconcileResponseAwsStackSettings | any;
 export type AzureTargetStackSettings = {
     keyVaultCertificateId: string;
+    keyVaultResourceId?: string | null | undefined;
 };
 export type TargetStackSettingsAzureUnion = AzureTargetStackSettings | any;
 export type GcpTargetStackSettings = {
@@ -6427,6 +6545,10 @@ export declare const SyncReconcileResponseTypeByoVnetAzure: {
 };
 export type SyncReconcileResponseTypeByoVnetAzure = ClosedEnum<typeof SyncReconcileResponseTypeByoVnetAzure>;
 export type SyncReconcileResponseNetworkByoVnetAzure = {
+    /**
+     * Name of the dedicated classic Application Gateway subnet within the VNet.
+     */
+    applicationGatewaySubnetName?: string | null | undefined;
     /**
      * Name of the private subnet within the VNet
      */
@@ -8133,17 +8255,13 @@ export declare function syncReconcileResponseEnvironmentInfoAwsFromJSON(jsonStri
 export declare const SyncReconcileResponseEnvironmentInfoUnion$inboundSchema: z.ZodType<SyncReconcileResponseEnvironmentInfoUnion, unknown>;
 export declare function syncReconcileResponseEnvironmentInfoUnionFromJSON(jsonString: string): SafeParseResult<SyncReconcileResponseEnvironmentInfoUnion, SDKValidationError>;
 /** @internal */
-export declare const SyncReconcileResponseCurrentPlatform$inboundSchema: z.ZodEnum<typeof SyncReconcileResponseCurrentPlatform>;
-/** @internal */
-export declare const SyncReconcileResponseDeleteScopeEnum$inboundSchema: z.ZodEnum<typeof SyncReconcileResponseDeleteScopeEnum>;
-/** @internal */
-export declare const SyncReconcileResponseDeleteScopeUnion$inboundSchema: z.ZodType<SyncReconcileResponseDeleteScopeUnion, unknown>;
-export declare function syncReconcileResponseDeleteScopeUnionFromJSON(jsonString: string): SafeParseResult<SyncReconcileResponseDeleteScopeUnion, SDKValidationError>;
+export declare const SyncReconcileResponseError$inboundSchema: z.ZodType<SyncReconcileResponseError, unknown>;
+export declare function syncReconcileResponseErrorFromJSON(jsonString: string): SafeParseResult<SyncReconcileResponseError, SDKValidationError>;
 /** @internal */
-export declare const SyncReconcileResponsePendingDeleteScopeEnum$inboundSchema: z.ZodEnum<typeof SyncReconcileResponsePendingDeleteScopeEnum>;
+export declare const SyncReconcileResponseErrorUnion$inboundSchema: z.ZodType<SyncReconcileResponseErrorUnion, unknown>;
+export declare function syncReconcileResponseErrorUnionFromJSON(jsonString: string): SafeParseResult<SyncReconcileResponseErrorUnion, SDKValidationError>;
 /** @internal */
-export declare const SyncReconcileResponsePendingDeleteScopeUnion$inboundSchema: z.ZodType<SyncReconcileResponsePendingDeleteScopeUnion, unknown>;
-export declare function syncReconcileResponsePendingDeleteScopeUnionFromJSON(jsonString: string): SafeParseResult<SyncReconcileResponsePendingDeleteScopeUnion, SDKValidationError>;
+export declare const SyncReconcileResponseCurrentPlatform$inboundSchema: z.ZodEnum<typeof SyncReconcileResponseCurrentPlatform>;
 /** @internal */
 export declare const SyncReconcileResponsePreparedStackManagementEnum$inboundSchema: z.ZodEnum<typeof SyncReconcileResponsePreparedStackManagementEnum>;
 /** @internal */
@@ -8401,11 +8519,11 @@ export declare function syncReconcileResponseControllerPlatformUnionFromJSON(jso
 export declare const SyncReconcileResponseStackStateDependency$inboundSchema: z.ZodType<SyncReconcileResponseStackStateDependency, unknown>;
 export declare function syncReconcileResponseStackStateDependencyFromJSON(jsonString: string): SafeParseResult<SyncReconcileResponseStackStateDependency, SDKValidationError>;
 /** @internal */
-export declare const SyncReconcileResponseError$inboundSchema: z.ZodType<SyncReconcileResponseError, unknown>;
-export declare function syncReconcileResponseErrorFromJSON(jsonString: string): SafeParseResult<SyncReconcileResponseError, SDKValidationError>;
+export declare const SyncReconcileResponseStackStateError$inboundSchema: z.ZodType<SyncReconcileResponseStackStateError, unknown>;
+export declare function syncReconcileResponseStackStateErrorFromJSON(jsonString: string): SafeParseResult<SyncReconcileResponseStackStateError, SDKValidationError>;
 /** @internal */
-export declare const SyncReconcileResponseErrorUnion$inboundSchema: z.ZodType<SyncReconcileResponseErrorUnion, unknown>;
-export declare function syncReconcileResponseErrorUnionFromJSON(jsonString: string): SafeParseResult<SyncReconcileResponseErrorUnion, SDKValidationError>;
+export declare const SyncReconcileResponseStackStateErrorUnion$inboundSchema: z.ZodType<SyncReconcileResponseStackStateErrorUnion, unknown>;
+export declare function syncReconcileResponseStackStateErrorUnionFromJSON(jsonString: string): SafeParseResult<SyncReconcileResponseStackStateErrorUnion, SDKValidationError>;
 /** @internal */
 export declare const SyncReconcileResponseStackStateLifecycleEnum$inboundSchema: z.ZodEnum<typeof SyncReconcileResponseStackStateLifecycleEnum>;
 /** @internal */
@@ -8729,6 +8847,13 @@ export declare function syncReconcileResponseComputeBackendHorizonFromJSON(jsonS
 export declare const SyncReconcileResponseComputeBackendUnion$inboundSchema: z.ZodType<SyncReconcileResponseComputeBackendUnion, unknown>;
 export declare function syncReconcileResponseComputeBackendUnionFromJSON(jsonString: string): SafeParseResult<SyncReconcileResponseComputeBackendUnion, SDKValidationError>;
 /** @internal */
+export declare const SyncReconcileResponseAliasCertificateStatus$inboundSchema: z.ZodEnum<typeof SyncReconcileResponseAliasCertificateStatus>;
+/** @internal */
+export declare const SyncReconcileResponseAliasDnsStatus$inboundSchema: z.ZodEnum<typeof SyncReconcileResponseAliasDnsStatus>;
+/** @internal */
+export declare const SyncReconcileResponseAlias$inboundSchema: z.ZodType<SyncReconcileResponseAlias, unknown>;
+export declare function syncReconcileResponseAliasFromJSON(jsonString: string): SafeParseResult<SyncReconcileResponseAlias, SDKValidationError>;
+/** @internal */
 export declare const SyncReconcileResponseCertificateStatus$inboundSchema: z.ZodEnum<typeof SyncReconcileResponseCertificateStatus>;
 /** @internal */
 export declare const SyncReconcileResponseDnsStatus$inboundSchema: z.ZodEnum<typeof SyncReconcileResponseDnsStatus>;