@fleetless/contracts 1.0.0

package/dist/errors.d.ts

@@ -0,0 +1,52 @@
+import { z } from 'zod';
+/**
+ * The one error shape of the REST and realtime APIs (spec §11.5): a stable
+ * machine-readable code plus a human message; validation errors name the
+ * field and the violated rule in `details`.
+ */
+export declare const apiError: z.ZodObject<{
+    code: z.ZodString;
+    message: z.ZodString;
+    details: z.ZodOptional<z.ZodUnknown>;
+}, z.core.$strip>;
+export type ApiError = z.infer<typeof apiError>;
+/**
+ * One violated §4.4 rule. `details` on the envelope stays `unknown` — codes
+ * are an open set, so their payloads cannot all be enumerated — but the
+ * payload of `parameter_invalid` **is** pinned here, because otherwise every
+ * consumer guesses: the cloud emits one shape, the SDK sniffs for two, the
+ * console renders a third, and each is right in its own tests.
+ *
+ * `field` is the **flat key exactly as the caller sent it** — the same string
+ * as the `parameterSpec.name` it violated. That is the entire justification
+ * for the flat parameter form: a refusal has to name something the caller can
+ * find in what they typed, and a console can attach the error to that one
+ * input rather than to the form.
+ */
+export declare const parameterViolation: z.ZodObject<{
+    field: z.ZodString;
+    rule: z.ZodString;
+    message: z.ZodString;
+}, z.core.$strip>;
+export type ParameterViolation = z.infer<typeof parameterViolation>;
+/**
+ * The `details` of a `parameter_invalid` refusal. Always at least one
+ * violation: a refusal that names none would leave the caller with nothing to
+ * fix. All violations are reported at once, not just the first — a caller
+ * fixing parameters one round-trip at a time is a caller who gives up.
+ */
+export declare const parameterInvalidDetails: z.ZodObject<{
+    violations: z.ZodArray<z.ZodObject<{
+        field: z.ZodString;
+        rule: z.ZodString;
+        message: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type ParameterInvalidDetails = z.infer<typeof parameterInvalidDetails>;
+/**
+ * The codes in use as of W2. The wire deliberately allows any string — this
+ * list is the shared vocabulary, not a closed set, so a new refusal never
+ * needs a contracts release before it can be reported honestly.
+ */
+export declare const ERROR_CODES: readonly ["not_found", "validation_error", "bad_request", "unknown_datapoint", "invalid_token", "protocol_mismatch", "invalid_frame", "duplicate_slug", "reserved_slug", "unknown_slug", "unknown_field_path", "unknown_type", "unknown_topic", "invalid_rate", "invalid_range", "config_conflict", "no_data", "robot_offline", "bridge_timeout", "unauthorized", "forbidden", "invalid_credentials", "token_expired", "token_revoked", "email_taken", "identifier_taken", "weak_password", "account_blocked", "busy", "parameter_invalid", "job_lost", "publisher_busy", "unknown_command", "not_subscribable", "camera_offline", "no_snapshot_yet", "live_unavailable", "wrong_kind", "not_recorded", "not_aggregatable", "quota_exceeded", "credential_in_use", "goal_timeout", "robot_in_use", "robot_deletion_partial", "job_queue_full", "invalid_uuid", "rate_limited", "tier_required", "token_spent", "service_timeout", "asset_missing", "asset_too_large", "dynamic_registration_disabled", "client_limit_reached", "idp_unavailable", "mcp_disabled", "tool_not_available", "capability_required", "last_owner", "target_state_conflict", "signup_closed", "draft_not_a_document", "internal_error", "not_cancellable", "unsupported_media_type", "wrong_browser", "invalid_yaml", "unstorable_yaml", "registration_closed", "domain_not_allowed", "email_unverified", "origin_not_allowed", "template_invalid", "provider_disabled", "provider_misconfigured", "invalid_redirect_uri", "interaction_expired"];
+export type ErrorCode = (typeof ERROR_CODES)[number];