@stapel/search-react 0.1.0

package/src/i18n/generated/errors.gen.ts

@@ -0,0 +1,214 @@
+// AUTO-GENERATED by scripts/gen-errors.mjs — do not edit by hand.
+// Source: stapel-auth canonical errors.json (backend codegen artifact).
+// Regenerate: pnpm gen:errors   ·   Drift gate: pnpm gen:errors:check
+
+/**
+ * Remediation vocabulary (frontend-core-architecture §2.5). Declared by the
+ * backend on the error registry and consumed verbatim from its `errors.json`
+ * artifact. A host maps it to UX — retryable → "try again"; `wait_and_retry` →
+ * timer from `params.retry_after_minutes`; `verify` → the step-up seam;
+ * `fix_input` → highlight the offending field.
+ */
+export type Remediation =
+  | "retry"
+  | "wait_and_retry"
+  | "reauthenticate"
+  | "verify"
+  | "fix_input"
+  | "contact_support"
+  | "bug";
+
+export interface SearchErrorSpec {
+  /** HTTP status the backend raises this key with. */
+  readonly status: number;
+  /** `{param}` interpolation slots present in the message. */
+  readonly params: readonly string[];
+  /** Remediation hint declared by the backend (see {@link Remediation}). */
+  readonly remediation: Remediation;
+  /** English fallback (source: stapel-auth errors.json). */
+  readonly en: string;
+}
+
+/**
+ * The SEARCH_ERRORS map — every `error.*` key stapel-auth can raise, keyed by its
+ * canonical code. The single source of truth behind the en fallback bundle, the
+ * remediation lookup, and the manifest `errors` block.
+ */
+export const SEARCH_ERRORS = {
+  "error.400.bad_request": { status: 400, params: [], remediation: "fix_input", en: "Bad request" },
+  "error.400.captcha_invalid": { status: 400, params: [], remediation: "retry", en: "Captcha verification failed. Please try again." },
+  "error.400.captcha_required": { status: 400, params: [], remediation: "retry", en: "Captcha token is required." },
+  "error.400.expected_list": { status: 400, params: [], remediation: "fix_input", en: "Expected a list of items" },
+  "error.400.field.blank": { status: 400, params: ["field"], remediation: "fix_input", en: "{field} may not be blank" },
+  "error.400.field.does_not_exist": { status: 400, params: ["field"], remediation: "fix_input", en: "{field} does not exist" },
+  "error.400.field.invalid": { status: 400, params: ["field"], remediation: "fix_input", en: "{field} is invalid" },
+  "error.400.field.invalid_choice": { status: 400, params: ["field"], remediation: "fix_input", en: "{field} is not a valid choice" },
+  "error.400.field.max_length": { status: 400, params: ["field","max_length"], remediation: "fix_input", en: "{field} must be at most {max_length} characters" },
+  "error.400.field.max_value": { status: 400, params: ["field","max_value"], remediation: "fix_input", en: "{field} must be at most {max_value}" },
+  "error.400.field.min_length": { status: 400, params: ["field","min_length"], remediation: "fix_input", en: "{field} must be at least {min_length} characters" },
+  "error.400.field.min_value": { status: 400, params: ["field","min_value"], remediation: "fix_input", en: "{field} must be at least {min_value}" },
+  "error.400.field.null": { status: 400, params: ["field"], remediation: "fix_input", en: "{field} may not be null" },
+  "error.400.field.required": { status: 400, params: ["field"], remediation: "fix_input", en: "{field} is required" },
+  "error.400.field.unique": { status: 400, params: ["field"], remediation: "fix_input", en: "{field} must be unique" },
+  "error.400.invalid_ad_id": { status: 400, params: [], remediation: "fix_input", en: "Invalid advertisement ID" },
+  "error.400.search_bad_cursor": { status: 400, params: [], remediation: "fix_input", en: "The pagination cursor is not valid" },
+  "error.400.search_bad_geo": { status: 400, params: ["reason"], remediation: "fix_input", en: "Geographic filter is malformed: {reason}" },
+  "error.400.search_bad_range": { status: 400, params: ["slug","reason"], remediation: "fix_input", en: "Range filter '{slug}' is malformed: {reason}" },
+  "error.400.search_query_too_long": { status: 400, params: [], remediation: "fix_input", en: "The search text is too long" },
+  "error.400.search_sort_needs_center": { status: 400, params: [], remediation: "fix_input", en: "Sorting by distance needs lat and lon" },
+  "error.400.search_too_many_facets": { status: 400, params: ["limit"], remediation: "fix_input", en: "Too many facet filters (limit {limit})" },
+  "error.400.search_too_many_ranges": { status: 400, params: ["limit"], remediation: "fix_input", en: "Too many range filters (limit {limit})" },
+  "error.400.search_unknown_doc_type": { status: 400, params: ["doc_type"], remediation: "fix_input", en: "Unknown search type '{doc_type}'" },
+  "error.400.search_unknown_sort": { status: 400, params: ["sort"], remediation: "fix_input", en: "Unknown sort '{sort}'" },
+  "error.400.search_window_exceeded": { status: 400, params: ["window"], remediation: "fix_input", en: "This result page is beyond the maximum window of {window}. Narrow the search instead of paging deeper." },
+  "error.400.validation_error": { status: 400, params: [], remediation: "fix_input", en: "Validation error" },
+  "error.400.verification_failed": { status: 400, params: [], remediation: "verify", en: "Verification failed" },
+  "error.400.verification_invalid_factor": { status: 400, params: [], remediation: "verify", en: "This verification factor is not available" },
+  "error.401.unauthorized": { status: 401, params: [], remediation: "reauthenticate", en: "Authentication required" },
+  "error.402.payment_required": { status: 402, params: [], remediation: "retry", en: "Payment required" },
+  "error.403.forbidden": { status: 403, params: [], remediation: "retry", en: "You do not have permission to perform this action" },
+  "error.403.network_blocked": { status: 403, params: [], remediation: "contact_support", en: "Requests from this network are not allowed" },
+  "error.403.search_forbidden": { status: 403, params: [], remediation: "retry", en: "You may not manage the search index" },
+  "error.403.verification_enrollment_required": { status: 403, params: [], remediation: "verify", en: "Verification factor enrollment required" },
+  "error.403.verification_required": { status: 403, params: [], remediation: "verify", en: "Additional verification required" },
+  "error.404.ad_not_found": { status: 404, params: [], remediation: "retry", en: "Listing not found" },
+  "error.404.not_found": { status: 404, params: [], remediation: "retry", en: "Requested resource not found" },
+  "error.404.verification_challenge_not_found": { status: 404, params: [], remediation: "verify", en: "Verification challenge not found or expired" },
+  "error.405.method_not_allowed": { status: 405, params: [], remediation: "retry", en: "Method not allowed" },
+  "error.406.not_acceptable": { status: 406, params: [], remediation: "retry", en: "Not acceptable" },
+  "error.408.request_timeout": { status: 408, params: [], remediation: "retry", en: "Request timeout" },
+  "error.409.conflict": { status: 409, params: [], remediation: "fix_input", en: "Resource already exists" },
+  "error.410.gone": { status: 410, params: [], remediation: "retry", en: "Resource has been permanently removed" },
+  "error.413.payload_too_large": { status: 413, params: [], remediation: "retry", en: "Request body is too large" },
+  "error.415.unsupported_media_type": { status: 415, params: [], remediation: "retry", en: "Unsupported media type" },
+  "error.422.unprocessable_entity": { status: 422, params: [], remediation: "wait_and_retry", en: "Unprocessable entity" },
+  "error.423.locked": { status: 423, params: [], remediation: "wait_and_retry", en: "Resource is locked" },
+  "error.423.verification_locked": { status: 423, params: [], remediation: "wait_and_retry", en: "Too many failed attempts — verification locked" },
+  "error.429.rate_limit": { status: 429, params: ["retry_after_minutes"], remediation: "wait_and_retry", en: "Too many attempts. Try again in {retry_after_minutes} minutes." },
+  "error.429.too_many_requests": { status: 429, params: [], remediation: "wait_and_retry", en: "Too many requests. Please try again later." },
+  "error.500.internal": { status: 500, params: [], remediation: "contact_support", en: "Something went wrong" },
+  "error.503.mandate_unavailable": { status: 503, params: [], remediation: "retry", en: "Cannot verify workspace mandate right now" },
+  "error.503.search_backend_unavailable": { status: 503, params: [], remediation: "retry", en: "The search engine is unavailable" },
+} as const;
+
+export type SearchErrorCode = keyof typeof SEARCH_ERRORS;
+
+/** Every backend error code this module can surface, sorted. */
+export const SEARCH_ERROR_CODES: readonly SearchErrorCode[] = [
+  "error.400.bad_request",
+  "error.400.captcha_invalid",
+  "error.400.captcha_required",
+  "error.400.expected_list",
+  "error.400.field.blank",
+  "error.400.field.does_not_exist",
+  "error.400.field.invalid",
+  "error.400.field.invalid_choice",
+  "error.400.field.max_length",
+  "error.400.field.max_value",
+  "error.400.field.min_length",
+  "error.400.field.min_value",
+  "error.400.field.null",
+  "error.400.field.required",
+  "error.400.field.unique",
+  "error.400.invalid_ad_id",
+  "error.400.search_bad_cursor",
+  "error.400.search_bad_geo",
+  "error.400.search_bad_range",
+  "error.400.search_query_too_long",
+  "error.400.search_sort_needs_center",
+  "error.400.search_too_many_facets",
+  "error.400.search_too_many_ranges",
+  "error.400.search_unknown_doc_type",
+  "error.400.search_unknown_sort",
+  "error.400.search_window_exceeded",
+  "error.400.validation_error",
+  "error.400.verification_failed",
+  "error.400.verification_invalid_factor",
+  "error.401.unauthorized",
+  "error.402.payment_required",
+  "error.403.forbidden",
+  "error.403.network_blocked",
+  "error.403.search_forbidden",
+  "error.403.verification_enrollment_required",
+  "error.403.verification_required",
+  "error.404.ad_not_found",
+  "error.404.not_found",
+  "error.404.verification_challenge_not_found",
+  "error.405.method_not_allowed",
+  "error.406.not_acceptable",
+  "error.408.request_timeout",
+  "error.409.conflict",
+  "error.410.gone",
+  "error.413.payload_too_large",
+  "error.415.unsupported_media_type",
+  "error.422.unprocessable_entity",
+  "error.423.locked",
+  "error.423.verification_locked",
+  "error.429.rate_limit",
+  "error.429.too_many_requests",
+  "error.500.internal",
+  "error.503.mandate_unavailable",
+  "error.503.search_backend_unavailable",
+];
+
+/**
+ * English fallback bundle — one string per backend key, so a `StapelApiError.code`
+ * never renders as a raw key. Merged UNDER the hand-polished UI copy in
+ * {@link authI18nBundleEn} (polish wins; this guarantees coverage).
+ */
+export const searchErrorBundleEn: Record<SearchErrorCode, string> = {
+  "error.400.bad_request": "Bad request",
+  "error.400.captcha_invalid": "Captcha verification failed. Please try again.",
+  "error.400.captcha_required": "Captcha token is required.",
+  "error.400.expected_list": "Expected a list of items",
+  "error.400.field.blank": "{field} may not be blank",
+  "error.400.field.does_not_exist": "{field} does not exist",
+  "error.400.field.invalid": "{field} is invalid",
+  "error.400.field.invalid_choice": "{field} is not a valid choice",
+  "error.400.field.max_length": "{field} must be at most {max_length} characters",
+  "error.400.field.max_value": "{field} must be at most {max_value}",
+  "error.400.field.min_length": "{field} must be at least {min_length} characters",
+  "error.400.field.min_value": "{field} must be at least {min_value}",
+  "error.400.field.null": "{field} may not be null",
+  "error.400.field.required": "{field} is required",
+  "error.400.field.unique": "{field} must be unique",
+  "error.400.invalid_ad_id": "Invalid advertisement ID",
+  "error.400.search_bad_cursor": "The pagination cursor is not valid",
+  "error.400.search_bad_geo": "Geographic filter is malformed: {reason}",
+  "error.400.search_bad_range": "Range filter '{slug}' is malformed: {reason}",
+  "error.400.search_query_too_long": "The search text is too long",
+  "error.400.search_sort_needs_center": "Sorting by distance needs lat and lon",
+  "error.400.search_too_many_facets": "Too many facet filters (limit {limit})",
+  "error.400.search_too_many_ranges": "Too many range filters (limit {limit})",
+  "error.400.search_unknown_doc_type": "Unknown search type '{doc_type}'",
+  "error.400.search_unknown_sort": "Unknown sort '{sort}'",
+  "error.400.search_window_exceeded": "This result page is beyond the maximum window of {window}. Narrow the search instead of paging deeper.",
+  "error.400.validation_error": "Validation error",
+  "error.400.verification_failed": "Verification failed",
+  "error.400.verification_invalid_factor": "This verification factor is not available",
+  "error.401.unauthorized": "Authentication required",
+  "error.402.payment_required": "Payment required",
+  "error.403.forbidden": "You do not have permission to perform this action",
+  "error.403.network_blocked": "Requests from this network are not allowed",
+  "error.403.search_forbidden": "You may not manage the search index",
+  "error.403.verification_enrollment_required": "Verification factor enrollment required",
+  "error.403.verification_required": "Additional verification required",
+  "error.404.ad_not_found": "Listing not found",
+  "error.404.not_found": "Requested resource not found",
+  "error.404.verification_challenge_not_found": "Verification challenge not found or expired",
+  "error.405.method_not_allowed": "Method not allowed",
+  "error.406.not_acceptable": "Not acceptable",
+  "error.408.request_timeout": "Request timeout",
+  "error.409.conflict": "Resource already exists",
+  "error.410.gone": "Resource has been permanently removed",
+  "error.413.payload_too_large": "Request body is too large",
+  "error.415.unsupported_media_type": "Unsupported media type",
+  "error.422.unprocessable_entity": "Unprocessable entity",
+  "error.423.locked": "Resource is locked",
+  "error.423.verification_locked": "Too many failed attempts — verification locked",
+  "error.429.rate_limit": "Too many attempts. Try again in {retry_after_minutes} minutes.",
+  "error.429.too_many_requests": "Too many requests. Please try again later.",
+  "error.500.internal": "Something went wrong",
+  "error.503.mandate_unavailable": "Cannot verify workspace mandate right now",
+  "error.503.search_backend_unavailable": "The search engine is unavailable",
+};

package/src/i18n/generated/errors.json

@@ -0,0 +1,423 @@
+[
+  {
+    "code": "error.400.bad_request",
+    "status": 400,
+    "params": [],
+    "remediation": "fix_input",
+    "en": "Bad request"
+  },
+  {
+    "code": "error.400.captcha_invalid",
+    "status": 400,
+    "params": [],
+    "remediation": "retry",
+    "en": "Captcha verification failed. Please try again."
+  },
+  {
+    "code": "error.400.captcha_required",
+    "status": 400,
+    "params": [],
+    "remediation": "retry",
+    "en": "Captcha token is required."
+  },
+  {
+    "code": "error.400.expected_list",
+    "status": 400,
+    "params": [],
+    "remediation": "fix_input",
+    "en": "Expected a list of items"
+  },
+  {
+    "code": "error.400.field.blank",
+    "status": 400,
+    "params": [
+      "field"
+    ],
+    "remediation": "fix_input",
+    "en": "{field} may not be blank"
+  },
+  {
+    "code": "error.400.field.does_not_exist",
+    "status": 400,
+    "params": [
+      "field"
+    ],
+    "remediation": "fix_input",
+    "en": "{field} does not exist"
+  },
+  {
+    "code": "error.400.field.invalid",
+    "status": 400,
+    "params": [
+      "field"
+    ],
+    "remediation": "fix_input",
+    "en": "{field} is invalid"
+  },
+  {
+    "code": "error.400.field.invalid_choice",
+    "status": 400,
+    "params": [
+      "field"
+    ],
+    "remediation": "fix_input",
+    "en": "{field} is not a valid choice"
+  },
+  {
+    "code": "error.400.field.max_length",
+    "status": 400,
+    "params": [
+      "field",
+      "max_length"
+    ],
+    "remediation": "fix_input",
+    "en": "{field} must be at most {max_length} characters"
+  },
+  {
+    "code": "error.400.field.max_value",
+    "status": 400,
+    "params": [
+      "field",
+      "max_value"
+    ],
+    "remediation": "fix_input",
+    "en": "{field} must be at most {max_value}"
+  },
+  {
+    "code": "error.400.field.min_length",
+    "status": 400,
+    "params": [
+      "field",
+      "min_length"
+    ],
+    "remediation": "fix_input",
+    "en": "{field} must be at least {min_length} characters"
+  },
+  {
+    "code": "error.400.field.min_value",
+    "status": 400,
+    "params": [
+      "field",
+      "min_value"
+    ],
+    "remediation": "fix_input",
+    "en": "{field} must be at least {min_value}"
+  },
+  {
+    "code": "error.400.field.null",
+    "status": 400,
+    "params": [
+      "field"
+    ],
+    "remediation": "fix_input",
+    "en": "{field} may not be null"
+  },
+  {
+    "code": "error.400.field.required",
+    "status": 400,
+    "params": [
+      "field"
+    ],
+    "remediation": "fix_input",
+    "en": "{field} is required"
+  },
+  {
+    "code": "error.400.field.unique",
+    "status": 400,
+    "params": [
+      "field"
+    ],
+    "remediation": "fix_input",
+    "en": "{field} must be unique"
+  },
+  {
+    "code": "error.400.invalid_ad_id",
+    "status": 400,
+    "params": [],
+    "remediation": "fix_input",
+    "en": "Invalid advertisement ID"
+  },
+  {
+    "code": "error.400.search_bad_cursor",
+    "status": 400,
+    "params": [],
+    "remediation": "fix_input",
+    "en": "The pagination cursor is not valid"
+  },
+  {
+    "code": "error.400.search_bad_geo",
+    "status": 400,
+    "params": [
+      "reason"
+    ],
+    "remediation": "fix_input",
+    "en": "Geographic filter is malformed: {reason}"
+  },
+  {
+    "code": "error.400.search_bad_range",
+    "status": 400,
+    "params": [
+      "slug",
+      "reason"
+    ],
+    "remediation": "fix_input",
+    "en": "Range filter '{slug}' is malformed: {reason}"
+  },
+  {
+    "code": "error.400.search_query_too_long",
+    "status": 400,
+    "params": [],
+    "remediation": "fix_input",
+    "en": "The search text is too long"
+  },
+  {
+    "code": "error.400.search_sort_needs_center",
+    "status": 400,
+    "params": [],
+    "remediation": "fix_input",
+    "en": "Sorting by distance needs lat and lon"
+  },
+  {
+    "code": "error.400.search_too_many_facets",
+    "status": 400,
+    "params": [
+      "limit"
+    ],
+    "remediation": "fix_input",
+    "en": "Too many facet filters (limit {limit})"
+  },
+  {
+    "code": "error.400.search_too_many_ranges",
+    "status": 400,
+    "params": [
+      "limit"
+    ],
+    "remediation": "fix_input",
+    "en": "Too many range filters (limit {limit})"
+  },
+  {
+    "code": "error.400.search_unknown_doc_type",
+    "status": 400,
+    "params": [
+      "doc_type"
+    ],
+    "remediation": "fix_input",
+    "en": "Unknown search type '{doc_type}'"
+  },
+  {
+    "code": "error.400.search_unknown_sort",
+    "status": 400,
+    "params": [
+      "sort"
+    ],
+    "remediation": "fix_input",
+    "en": "Unknown sort '{sort}'"
+  },
+  {
+    "code": "error.400.search_window_exceeded",
+    "status": 400,
+    "params": [
+      "window"
+    ],
+    "remediation": "fix_input",
+    "en": "This result page is beyond the maximum window of {window}. Narrow the search instead of paging deeper."
+  },
+  {
+    "code": "error.400.validation_error",
+    "status": 400,
+    "params": [],
+    "remediation": "fix_input",
+    "en": "Validation error"
+  },
+  {
+    "code": "error.400.verification_failed",
+    "status": 400,
+    "params": [],
+    "remediation": "verify",
+    "en": "Verification failed"
+  },
+  {
+    "code": "error.400.verification_invalid_factor",
+    "status": 400,
+    "params": [],
+    "remediation": "verify",
+    "en": "This verification factor is not available"
+  },
+  {
+    "code": "error.401.unauthorized",
+    "status": 401,
+    "params": [],
+    "remediation": "reauthenticate",
+    "en": "Authentication required"
+  },
+  {
+    "code": "error.402.payment_required",
+    "status": 402,
+    "params": [],
+    "remediation": "retry",
+    "en": "Payment required"
+  },
+  {
+    "code": "error.403.forbidden",
+    "status": 403,
+    "params": [],
+    "remediation": "retry",
+    "en": "You do not have permission to perform this action"
+  },
+  {
+    "code": "error.403.network_blocked",
+    "status": 403,
+    "params": [],
+    "remediation": "contact_support",
+    "en": "Requests from this network are not allowed"
+  },
+  {
+    "code": "error.403.search_forbidden",
+    "status": 403,
+    "params": [],
+    "remediation": "retry",
+    "en": "You may not manage the search index"
+  },
+  {
+    "code": "error.403.verification_enrollment_required",
+    "status": 403,
+    "params": [],
+    "remediation": "verify",
+    "en": "Verification factor enrollment required"
+  },
+  {
+    "code": "error.403.verification_required",
+    "status": 403,
+    "params": [],
+    "remediation": "verify",
+    "en": "Additional verification required"
+  },
+  {
+    "code": "error.404.ad_not_found",
+    "status": 404,
+    "params": [],
+    "remediation": "retry",
+    "en": "Listing not found"
+  },
+  {
+    "code": "error.404.not_found",
+    "status": 404,
+    "params": [],
+    "remediation": "retry",
+    "en": "Requested resource not found"
+  },
+  {
+    "code": "error.404.verification_challenge_not_found",
+    "status": 404,
+    "params": [],
+    "remediation": "verify",
+    "en": "Verification challenge not found or expired"
+  },
+  {
+    "code": "error.405.method_not_allowed",
+    "status": 405,
+    "params": [],
+    "remediation": "retry",
+    "en": "Method not allowed"
+  },
+  {
+    "code": "error.406.not_acceptable",
+    "status": 406,
+    "params": [],
+    "remediation": "retry",
+    "en": "Not acceptable"
+  },
+  {
+    "code": "error.408.request_timeout",
+    "status": 408,
+    "params": [],
+    "remediation": "retry",
+    "en": "Request timeout"
+  },
+  {
+    "code": "error.409.conflict",
+    "status": 409,
+    "params": [],
+    "remediation": "fix_input",
+    "en": "Resource already exists"
+  },
+  {
+    "code": "error.410.gone",
+    "status": 410,
+    "params": [],
+    "remediation": "retry",
+    "en": "Resource has been permanently removed"
+  },
+  {
+    "code": "error.413.payload_too_large",
+    "status": 413,
+    "params": [],
+    "remediation": "retry",
+    "en": "Request body is too large"
+  },
+  {
+    "code": "error.415.unsupported_media_type",
+    "status": 415,
+    "params": [],
+    "remediation": "retry",
+    "en": "Unsupported media type"
+  },
+  {
+    "code": "error.422.unprocessable_entity",
+    "status": 422,
+    "params": [],
+    "remediation": "wait_and_retry",
+    "en": "Unprocessable entity"
+  },
+  {
+    "code": "error.423.locked",
+    "status": 423,
+    "params": [],
+    "remediation": "wait_and_retry",
+    "en": "Resource is locked"
+  },
+  {
+    "code": "error.423.verification_locked",
+    "status": 423,
+    "params": [],
+    "remediation": "wait_and_retry",
+    "en": "Too many failed attempts — verification locked"
+  },
+  {
+    "code": "error.429.rate_limit",
+    "status": 429,
+    "params": [
+      "retry_after_minutes"
+    ],
+    "remediation": "wait_and_retry",
+    "en": "Too many attempts. Try again in {retry_after_minutes} minutes."
+  },
+  {
+    "code": "error.429.too_many_requests",
+    "status": 429,
+    "params": [],
+    "remediation": "wait_and_retry",
+    "en": "Too many requests. Please try again later."
+  },
+  {
+    "code": "error.500.internal",
+    "status": 500,
+    "params": [],
+    "remediation": "contact_support",
+    "en": "Something went wrong"
+  },
+  {
+    "code": "error.503.mandate_unavailable",
+    "status": 503,
+    "params": [],
+    "remediation": "retry",
+    "en": "Cannot verify workspace mandate right now"
+  },
+  {
+    "code": "error.503.search_backend_unavailable",
+    "status": 503,
+    "params": [],
+    "remediation": "retry",
+    "en": "The search engine is unavailable"
+  }
+]