@spacefast/common 0.0.2

package/dist/contracts/error-codes.js

@@ -0,0 +1,416 @@
+// The single error-code table (internal-docs/platform.md "Global API Conventions").
+// Every error envelope `code` the control plane emits is a member of this table, and
+// `docsUrl` is derived mechanically from the code (`https://spacefast.com/docs/errors/{code}`).
+// The conformance suite asserts the derivation rule so links never rot, and error docs
+// pages are generated from this enum. Control-plane error constructors are typed against
+// `ErrorCode`, so emitting a code that is not in the table is a typecheck (CI) failure;
+// the remaining untyped string paths (low-level serializer, superadmin Better Auth
+// passthrough) fold into the typed envelope in the F2 envelope chunk.
+// Growth is additive-only: codes are never renamed or removed. Diagnostic codes share
+// this table so every diagnostic also carries a resolvable docs link.
+import { ERROR_DOCS_BASE_URL } from "../brand.js";
+export { ERROR_DOCS_BASE_URL };
+/** `docsUrl` derivation rule: docs origin + `/{code}`. Asserted by the conformance suite. */
+export function errorDocsUrl(code) {
+    return `${ERROR_DOCS_BASE_URL}/${code}`;
+}
+export const ERROR_CODES = [
+    "abuse_report_invalid_transition",
+    "abuse_report_rate_limited",
+    "abuse_takedown",
+    "access_denied",
+    "account_suspended",
+    "ambiguous_space_slug",
+    "anonymous_expired",
+    "anonymous_pool_unavailable",
+    "anonymous_publish_rate_limited",
+    "archive_body_required",
+    "archive_too_large",
+    "auth_code_required",
+    "authorization_pending",
+    "billing_receipt_invalid",
+    "billing_receipt_not_bound_to_team",
+    "billing_store_not_configured",
+    "billing_subscription_conflict",
+    "billing_unknown_product",
+    "build_command_missing",
+    "build_execution_unavailable",
+    "build_failed",
+    "build_install_failed",
+    "build_no_index_html",
+    "build_not_created",
+    "build_oom",
+    "build_output_dir_missing",
+    "build_timeout",
+    "cache_purge_domain_required",
+    "cache_purge_path_required",
+    "channel_name_reserved",
+    "channel_pointer_moved",
+    "channel_unsupported",
+    "claim_blocked_takedown",
+    "claim_target_not_found",
+    "claimed_space_quota_exceeded",
+    "cli_upgrade_required",
+    "config_file_too_large",
+    "config_invalid",
+    "config_meta_too_long",
+    "config_templates_over_limit",
+    "credential_expired",
+    "credential_not_yet_valid",
+    "credential_retired",
+    "credential_revoked",
+    "csam_blocked",
+    "csam_policy_floor",
+    "data_location_immutable",
+    "device_authorization_failed",
+    "device_verification_rate_limited",
+    "dns_export_required",
+    "dns_field_conflict",
+    "dns_field_not_applicable",
+    "dns_import_partial_visibility",
+    "dns_provider_auth_expired",
+    "dns_provider_batch_unsupported",
+    "dns_provider_change_pending",
+    "dns_provider_conflict",
+    "dns_provider_connection_in_use",
+    "dns_provider_connection_unavailable",
+    "dns_provider_controlled_desired_state",
+    "dns_provider_credentials_expired",
+    "dns_provider_feature_descriptors",
+    "dns_provider_feature_unavailable",
+    "dns_provider_field_unsupported",
+    "dns_provider_future_authoritative_backend",
+    "dns_provider_missing_permission",
+    "dns_provider_not_connected",
+    "dns_provider_operation_failed",
+    "dns_provider_permission_denied",
+    "dns_provider_rate_limited",
+    "dns_provider_replace_all_requires_fresh_plan",
+    "dns_provider_replace_all_write_strategy",
+    "dns_provider_snapshot_stale",
+    "dns_provider_snapshot_unavailable",
+    "dns_provider_temporarily_unavailable",
+    "dns_provider_timeout",
+    "dns_provider_validation_failed",
+    "dns_provider_workflow_templates",
+    "dns_provider_zone_not_found",
+    "dns_record_conflicts_with_managed",
+    "dns_record_managed",
+    "dns_record_not_found",
+    "domain_already_exists",
+    "domain_bound",
+    "domain_facet_already_managed",
+    "domain_facet_external",
+    "domain_facet_not_applicable",
+    "domain_hostname_site_mismatch",
+    "domain_in_use",
+    "domain_lookup_rate_limited",
+    "domain_not_bound",
+    "domain_quota_exceeded",
+    "domain_registration_active",
+    "domain_registration_not_renewable",
+    "domain_reserved_suffix",
+    "domain_transfer_active",
+    "domain_wildcard_label",
+    "domain_wildcard_not_enabled",
+    "download_required",
+    "duplicate_version_path",
+    "event_payload_too_large",
+    "event_rate_limited",
+    "expired_token",
+    "export_archive_not_ready",
+    "export_version_not_found",
+    "feature_unavailable",
+    "files_mode_does_not_support_spa",
+    "forbidden",
+    "free_external_proxy_disabled",
+    "free_headers_basic_auth_disabled",
+    "idempotency_conflict_in_progress",
+    "idempotency_key_reused",
+    "immutable_version_requires_login",
+    "import_archive_not_uploaded",
+    "import_not_cancelable",
+    "import_not_waiting_for_archive",
+    "incumbent_controls_dns",
+    "inject_invalid",
+    "inject_snippet_too_large",
+    "internal_error",
+    "invalid_claim_token",
+    "invalid_data_location",
+    "invalid_device_code",
+    "invalid_domain",
+    "invalid_domain_name",
+    "invalid_file_path",
+    "invalid_grant",
+    "invalid_publish_archive",
+    "invalid_publish_path",
+    "invalid_publish_payload",
+    "invalid_request",
+    "invalid_runtime_event",
+    "invalid_space",
+    "invalid_space_mode",
+    "invalid_user_code",
+    "invalid_version_path",
+    "invalid_webhook_events",
+    "invalid_webhook_payload",
+    "invalid_webhook_signature",
+    "invalid_webhook_url",
+    "invalid_zero_realtime_event",
+    "invalid_zero_realtime_replay_query",
+    "invitation_already_exists",
+    "invitation_not_pending",
+    "ip_blocked",
+    "job_not_found",
+    "job_not_promotable",
+    "job_not_removable",
+    "job_not_retryable",
+    "last_owner",
+    "log_retention_clamped",
+    "lost_domain_control",
+    "malware_detected",
+    "managed_domain_protected",
+    "manifest_body_too_large",
+    "manifest_duplicate_path",
+    "manifest_too_many_files",
+    "member_already_exists",
+    "missing_route_param",
+    "nameserver_delegation_required",
+    "nameserver_divergence",
+    "noop_publish",
+    "not_enrolled",
+    "not_found",
+    "path_case_collision",
+    "path_too_long",
+    "plan_grant_already_active",
+    "plan_grant_already_revoked",
+    "platform_tenant_immutable_client",
+    "policy_exceeds_grantor",
+    "principal_space_mismatch",
+    "provider_error",
+    "provider_job_failed",
+    "provider_job_timeout",
+    "provider_runtime_feature_unsupported",
+    "provider_site_id_required",
+    "proxy_upstream_denied",
+    "proxy_upstream_unresolved",
+    "publish_archive_compression_ratio_exceeded",
+    "publish_archive_expanded_size_exceeded",
+    "publish_archive_file_count_exceeded",
+    "publish_archive_too_large",
+    "publish_config_unsupported",
+    "publish_failed",
+    "publish_file_missing",
+    "publish_setup_failed",
+    "publish_upload_failed",
+    "publish_verification_failed",
+    "queue_not_found",
+    "rate_limited",
+    "registration_expired",
+    "registration_expiring",
+    "routing_rules_over_plan",
+    "runtime_action_forbidden",
+    "runtime_api_not_found",
+    "runtime_callback_forbidden",
+    "runtime_engine_zip_missing",
+    "runtime_hostname_unassigned",
+    "runtime_instance_mismatch",
+    "runtime_jti_missing",
+    "runtime_jti_replayed",
+    "runtime_jwks_key_missing",
+    "runtime_logs_unavailable",
+    "runtime_management_unavailable",
+    "runtime_not_provisioned",
+    "runtime_operation_missing",
+    "runtime_scope_forbidden",
+    "runtime_token_bad_signature",
+    "runtime_token_expired",
+    "runtime_token_invalid",
+    "runtime_unauthorized",
+    "runtime_upload_operation_not_supported",
+    "runtime_upload_required",
+    "scan_pending",
+    "secret_variable_in_template",
+    "site_already_deleted",
+    "site_capacity_exceeded",
+    "site_has_live_spaces",
+    "site_not_static",
+    "site_required",
+    "site_suspended",
+    "slow_down",
+    "space_already_claimed",
+    "space_claim_unavailable",
+    "space_disabled",
+    "space_expired",
+    "space_has_active_version",
+    "space_import_archive_invalid",
+    "space_import_archive_too_large",
+    "space_import_config_only_archive",
+    "space_import_runtime_schema_unsupported",
+    "space_moving",
+    "space_no_live_version",
+    "space_not_disabled",
+    "space_not_restorable",
+    "space_ref_ambiguous",
+    "space_ref_required",
+    "space_transferring",
+    "space_unclaimed",
+    "ssl_renewal_blocked",
+    "static_control_file_not_supported",
+    "static_runtime_control_path_not_supported",
+    "static_runtime_required",
+    "storage_quota_exceeded",
+    "storage_usage_unavailable",
+    "stripe_error",
+    "superseded_by_publish",
+    "takeover_notice_window",
+    "team_ref_required",
+    "team_required",
+    "team_slug_conflict",
+    "template_file_too_large",
+    "template_not_in_version",
+    "template_variable_unresolved",
+    "tenant_id_mismatch",
+    "tenant_not_found",
+    "tenant_not_granted",
+    "tenant_past_due",
+    "tenant_selection_required",
+    "tenant_suspended",
+    "theme_value_invalid",
+    "transfer_cross_tenant_unsupported",
+    "transfer_move_failed",
+    "transfer_not_cancelable",
+    "transfer_source_changed",
+    "transfer_target_same_as_source",
+    "unauthorized",
+    "unsupported_publish_media_type",
+    "upload_hash_mismatch",
+    "upload_path_not_canonical",
+    "upload_path_not_declared",
+    "upload_session_cap_exceeded",
+    "upload_size_mismatch",
+    "user_banned",
+    "validation_error",
+    "variable_cascade_failed",
+    "verification_required",
+    "version_already_live",
+    "version_artifact_not_found",
+    "version_busy",
+    "version_canceled",
+    "version_closed",
+    "version_expired",
+    "version_failed",
+    "version_file_count_exceeded",
+    "version_file_not_found",
+    "version_file_too_large",
+    "version_files_missing",
+    "version_in_use",
+    "version_live",
+    "version_no_publishable_files",
+    "version_not_finalizable",
+    "version_not_found",
+    "version_not_prepared",
+    "version_not_promotable",
+    "version_not_ready",
+    "version_quota_exceeded",
+    "version_total_bytes_exceeded",
+    "webhook_delivery_budget_exceeded",
+    "whois_unavailable",
+    "wp_cloud_anonymous_pool_required",
+    "wp_cloud_assignment_kind_mismatch",
+    "wp_cloud_assignment_space_mismatch",
+    "wp_cloud_assignment_team_mismatch",
+    "wp_cloud_client_in_use",
+    "wp_cloud_client_not_found",
+    "wp_cloud_site_still_assigned",
+    "wp_cloud_team_shared_site_exists",
+    "wp_cloud_webhook_secret_not_configured",
+    "zero_artifact_abi_mismatch",
+    "zero_artifact_invalid",
+    "zero_artifact_malformed",
+    "zero_artifact_path_invalid",
+    "zero_artifact_unreadable",
+    "zero_auth_unavailable",
+    "zero_blob_key_invalid",
+    "zero_blob_store_full",
+    "zero_blob_too_large",
+    "zero_blob_value_invalid",
+    "zero_bootstrap_encode_failed",
+    "zero_bytecode_hash_mismatch",
+    "zero_bytecode_invalid",
+    "zero_bytecode_path_invalid",
+    "zero_bytecode_unreadable",
+    "zero_client_bundle_not_loaded",
+    "zero_db_connect_failed",
+    "zero_db_execute_failed",
+    "zero_db_host_install_failed",
+    "zero_db_operation_invalid",
+    "zero_db_operation_too_large",
+    "zero_db_param_invalid",
+    "zero_db_query_failed",
+    "zero_db_row_invalid",
+    "zero_db_sql_invalid",
+    "zero_db_too_many_params",
+    "zero_db_transaction_commit_failed",
+    "zero_db_transaction_invalid",
+    "zero_db_transaction_start_failed",
+    "zero_db_url_invalid",
+    "zero_db_url_missing",
+    "zero_dev_endpoint_failed",
+    "zero_dump_query_invalid",
+    "zero_endpoint_index_invalid",
+    "zero_endpoint_index_malformed",
+    "zero_endpoint_index_path_invalid",
+    "zero_endpoint_index_unreadable",
+    "zero_endpoint_mismatch",
+    "zero_endpoint_not_found",
+    "zero_envelope_encode_failed",
+    "zero_js_context_init_failed",
+    "zero_js_execution_failed",
+    "zero_js_execution_timeout",
+    "zero_js_globals_failed",
+    "zero_js_response_malformed",
+    "zero_js_runtime_init_failed",
+    "zero_log_query_invalid",
+    "zero_method_not_allowed",
+    "zero_query_name_missing",
+    "zero_realtime_forbidden",
+    "zero_realtime_message_invalid",
+    "zero_realtime_operation_unsupported",
+    "zero_realtime_query_invalid",
+    "zero_realtime_space_required",
+    "zero_realtime_unavailable",
+    "zero_realtime_websocket_forbidden",
+    "zero_replay_failed",
+    "zero_replay_query_invalid",
+    "zero_replay_unavailable",
+    "zero_request_body_too_large",
+    "zero_response_too_large",
+    "zero_run_operation_unsupported",
+    "zero_runner_envelope_invalid",
+    "zero_runner_failed",
+    "zero_runner_invalid_body",
+    "zero_runner_invalid_response",
+    "zero_runner_invalid_status",
+    "zero_runner_protocol_unsupported",
+    "zero_runner_response_encode_failed",
+    "zero_runner_stdin_invalid",
+    "zero_runner_stdin_too_large",
+    "zero_runner_unavailable",
+    "zero_source_compile_failed",
+    "zero_source_hash_mismatch",
+    "zero_source_invalid",
+    "zero_source_path_invalid",
+    "zero_source_unreadable",
+];
+const ERROR_CODE_SET = new Set(ERROR_CODES);
+export function isErrorCode(value) {
+    return ERROR_CODE_SET.has(value);
+}
+/**
+ * Narrow a dynamically-sourced code (diagnostic conversions, provider passthrough) into the
+ * table, degrading to `fallback` for codes outside it. Literal constructions never use this;
+ * they are typed against `ErrorCode` directly.
+ */
+export function toErrorCode(value, fallback) {
+    return value && isErrorCode(value) ? value : fallback;
+}