@meshery/schemas 1.3.36 → 1.3.38

package/dist/meshkitError-Dfcgbi6X.d.mts

@@ -0,0 +1,71 @@
+import { FetchBaseQueryError, BaseQueryFn } from '@reduxjs/toolkit/query/react';
+
+/**
+ * Pure MeshKit error-envelope handling, deliberately isolated from the
+ * React-coupled RTK Query runtime in {@link ./api}.
+ *
+ * `./api` value-imports `createApi`/`fetchBaseQuery` from
+ * `@reduxjs/toolkit/query/react`, whose entry point transitively requires
+ * `react-redux` (and `react`) — peer dependencies that are present in a
+ * consuming UI but not installed in this schema repo's test/CI environment.
+ * Keeping this module's only RTK dependency an `import type` (fully erased at
+ * runtime) lets {@link withMeshkitErrorTransform} be exercised under Node's
+ * native TypeScript test runner without pulling in that runtime graph. `./api`
+ * re-exports this surface so package consumers see no change.
+ */
+/**
+ * Structured MeshKit error metadata extracted from a non-2xx JSON response body.
+ *
+ * Field names are JS-side camelCase, matching the server's camelCase wire
+ * fields one-to-one. Pairs with the meshery server migration that promotes
+ * every non-2xx response from `text/plain` to `application/json` with a MeshKit
+ * error envelope.
+ */
+interface MeshkitError {
+    /** Human-readable short description (`error` on the wire). */
+    message: string;
+    /** Structured error code, e.g. `meshery-server-1033`. */
+    code?: string;
+    /** Severity level, e.g. `ERROR`, `WARNING`, `FATAL`. */
+    severity?: string;
+    /** Probable causes that produced the error (`probableCause` on the wire). */
+    probableCause?: string[];
+    /** Suggested remediations to recover (`suggestedRemediation` on the wire). */
+    suggestedRemediation?: string[];
+    /** Long-form description lines (`longDescription` on the wire). */
+    longDescription?: string[];
+}
+/**
+ * Extension of {@link FetchBaseQueryError} that carries optional MeshKit
+ * metadata on `meshkit`. The raw response body is still available on `data`
+ * for backward compatibility — `meshkit` is undefined when the response was
+ * not a MeshKit JSON envelope.
+ *
+ * Defined as an intersection rather than an `interface ... extends` because
+ * `FetchBaseQueryError` is a discriminated union (HTTP status / FETCH_ERROR /
+ * PARSING_ERROR / TIMEOUT_ERROR / CUSTOM_ERROR), and TypeScript only allows
+ * extending object types with statically known members.
+ */
+type MeshkitFetchBaseQueryError = FetchBaseQueryError & {
+    meshkit?: MeshkitError;
+};
+/**
+ * Wraps a {@link BaseQueryFn} so non-2xx responses carrying a MeshKit JSON
+ * envelope have their structured fields surfaced onto `error.meshkit`.
+ *
+ * The error type widens from {@link FetchBaseQueryError} to
+ * {@link MeshkitFetchBaseQueryError} — that propagates through `createApi`'s
+ * type inference into endpoint hooks so consumers read `error?.meshkit.*`
+ * with full IntelliSense. Non-MeshKit error bodies pass through untouched
+ * (just typed under the wider error type with `meshkit` left undefined).
+ *
+ * The structured array fields are read in camelCase (the server's actual wire
+ * form), falling back to the legacy snake_case spelling only if a deployed
+ * producer still emits it. camelCase always wins when both are present.
+ *
+ * Exported for regression testing - the failure mode is invisible (optional
+ * fields silently resolve to `undefined` when the casing is wrong).
+ */
+declare function withMeshkitErrorTransform<Args, Result, DefinitionExtraOptions, Meta>(inner: BaseQueryFn<Args, Result, FetchBaseQueryError, DefinitionExtraOptions, Meta>): BaseQueryFn<Args, Result, MeshkitFetchBaseQueryError, DefinitionExtraOptions, Meta>;
+
+export { type MeshkitFetchBaseQueryError as M, type MeshkitError as a, withMeshkitErrorTransform as w };

package/dist/meshkitError-Dfcgbi6X.d.ts

@@ -0,0 +1,71 @@
+import { FetchBaseQueryError, BaseQueryFn } from '@reduxjs/toolkit/query/react';
+
+/**
+ * Pure MeshKit error-envelope handling, deliberately isolated from the
+ * React-coupled RTK Query runtime in {@link ./api}.
+ *
+ * `./api` value-imports `createApi`/`fetchBaseQuery` from
+ * `@reduxjs/toolkit/query/react`, whose entry point transitively requires
+ * `react-redux` (and `react`) — peer dependencies that are present in a
+ * consuming UI but not installed in this schema repo's test/CI environment.
+ * Keeping this module's only RTK dependency an `import type` (fully erased at
+ * runtime) lets {@link withMeshkitErrorTransform} be exercised under Node's
+ * native TypeScript test runner without pulling in that runtime graph. `./api`
+ * re-exports this surface so package consumers see no change.
+ */
+/**
+ * Structured MeshKit error metadata extracted from a non-2xx JSON response body.
+ *
+ * Field names are JS-side camelCase, matching the server's camelCase wire
+ * fields one-to-one. Pairs with the meshery server migration that promotes
+ * every non-2xx response from `text/plain` to `application/json` with a MeshKit
+ * error envelope.
+ */
+interface MeshkitError {
+    /** Human-readable short description (`error` on the wire). */
+    message: string;
+    /** Structured error code, e.g. `meshery-server-1033`. */
+    code?: string;
+    /** Severity level, e.g. `ERROR`, `WARNING`, `FATAL`. */
+    severity?: string;
+    /** Probable causes that produced the error (`probableCause` on the wire). */
+    probableCause?: string[];
+    /** Suggested remediations to recover (`suggestedRemediation` on the wire). */
+    suggestedRemediation?: string[];
+    /** Long-form description lines (`longDescription` on the wire). */
+    longDescription?: string[];
+}
+/**
+ * Extension of {@link FetchBaseQueryError} that carries optional MeshKit
+ * metadata on `meshkit`. The raw response body is still available on `data`
+ * for backward compatibility — `meshkit` is undefined when the response was
+ * not a MeshKit JSON envelope.
+ *
+ * Defined as an intersection rather than an `interface ... extends` because
+ * `FetchBaseQueryError` is a discriminated union (HTTP status / FETCH_ERROR /
+ * PARSING_ERROR / TIMEOUT_ERROR / CUSTOM_ERROR), and TypeScript only allows
+ * extending object types with statically known members.
+ */
+type MeshkitFetchBaseQueryError = FetchBaseQueryError & {
+    meshkit?: MeshkitError;
+};
+/**
+ * Wraps a {@link BaseQueryFn} so non-2xx responses carrying a MeshKit JSON
+ * envelope have their structured fields surfaced onto `error.meshkit`.
+ *
+ * The error type widens from {@link FetchBaseQueryError} to
+ * {@link MeshkitFetchBaseQueryError} — that propagates through `createApi`'s
+ * type inference into endpoint hooks so consumers read `error?.meshkit.*`
+ * with full IntelliSense. Non-MeshKit error bodies pass through untouched
+ * (just typed under the wider error type with `meshkit` left undefined).
+ *
+ * The structured array fields are read in camelCase (the server's actual wire
+ * form), falling back to the legacy snake_case spelling only if a deployed
+ * producer still emits it. camelCase always wins when both are present.
+ *
+ * Exported for regression testing - the failure mode is invisible (optional
+ * fields silently resolve to `undefined` when the casing is wrong).
+ */
+declare function withMeshkitErrorTransform<Args, Result, DefinitionExtraOptions, Meta>(inner: BaseQueryFn<Args, Result, FetchBaseQueryError, DefinitionExtraOptions, Meta>): BaseQueryFn<Args, Result, MeshkitFetchBaseQueryError, DefinitionExtraOptions, Meta>;
+
+export { type MeshkitFetchBaseQueryError as M, type MeshkitError as a, withMeshkitErrorTransform as w };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@meshery/schemas",
-  "version": "1.3.36",
+  "version": "1.3.38",
   "description": "<p style=\"text-align:center;\" align=\"center\"><a href=\"https://meshery.io\"><picture>  <source media=\"(prefers-color-scheme: dark)\" srcset=\"https://raw.githubusercontent.com/meshery/meshery/master/.github/assets/images/readme/meshery-logo-light-text-side.svg\">  <source media=\"(prefers-color-scheme: light)\" srcset=\"https://raw.githubusercontent.com/meshery/meshery/master/.github/assets/images/readme/meshery-logo-dark-text-side.svg\"> <img src=\"https://raw.githubusercontent.com/meshery/meshery/master/.github/assets/images/readme/meshery-logo-dark-text-side.svg\" alt=\"Meshery Logo\" width=\"70%\" /></picture></a><br /><br /></p> <p align=\"center\"> <a href=\"https://hub.docker.com/r/meshery/meshery\" alt=\"Docker pulls\">   <img src=\"https://img.shields.io/docker/pulls/meshery/meshery.svg\" /></a> <a href=\"https://github.com/issues?q=is%3Aopen+is%3Aissue+archived%3Afalse+org%meshery+org%3Ameshery+org%3Aservice-mesh-performance+org%3Aservice-mesh-patterns+org%3A+label%3A%22help+wanted%22+\" alt=\"GitHub issues by-label\">   <img src=\"https://img.shields.io/github/issues/meshery/meshery/help%20wanted.svg?color=informational\" /></a> <a href=\"https://github.com/meshery/meshery/blob/master/LICENSE\" alt=\"LICENSE\">   <img src=\"https://img.shields.io/github/license/meshery/meshery?color=brightgreen\" /></a> <a href=\"https://artifacthub.io/packages/helm/meshery/meshery\" alt=\"Artifact Hub Meshery\">   <img src=\"https://img.shields.io/endpoint?color=brightgreen&label=Helm%20Chart&style=plastic&url=https%3A%2F%2Fartifacthub.io%2Fbadge%2Frepository%2Fartifact-hub\" /></a>   <a href=\"https://goreportcard.com/report/github.com/meshery/meshery\" alt=\"Go Report Card\">   <img src=\"https://goreportcard.com/badge/github.com/meshery/meshery\" /></a> <a href=\"https://github.com/meshery/meshery/actions\" alt=\"Build Status\">   <img src=\"https://img.shields.io/github/actions/workflow/status/meshery/meshery/release-drafter.yml\" /></a> <a href=\"https://bestpractices.coreinfrastructure.org/projects/3564\" alt=\"CLI Best Practices\">   <img src=\"https://bestpractices.coreinfrastructure.org/projects/3564/badge\" /></a> <a href=\"http://discuss.meshery.io\" alt=\"Discuss Users\">   <img src=\"https://img.shields.io/discourse/users?label=discuss&logo=discourse&server=https%3A%2F%2Fdiscuss.meshery.io\" /></a> <a href=\"https://slack.meshery.io\" alt=\"Join Slack\">   <img src=\"https://img.shields.io/badge/Slack-@meshery.svg?logo=slack\" /></a> <a href=\"https://twitter.com/intent/follow?screen_name=mesheryio\" alt=\"Twitter Follow\">   <img src=\"https://img.shields.io/twitter/follow/mesheryio.svg?label=Follow+Meshery&style=social\" /></a> <a href=\"https://github.com/meshery/meshery/releases\" alt=\"Meshery Downloads\">   <img src=\"https://img.shields.io/github/downloads/meshery/meshery/total\" /></a>   <!-- <a href=\"https://app.fossa.com/projects/git%2Bgithub.com%2Fmeshery%2Fmeshery?ref=badge_shield\" alt=\"License Scan Report\">   <img src=\"https://app.fossa.com/api/projects/git%2Bgithub.com%2Fmeshery%2Fmeshery.svg?type=shield\"/></a>     --> </p>",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -54,6 +54,7 @@
     "build:golang": "node ./build/generate-golang.js",
     "build:rtk": "node ./build/generate-rtk.js",
     "build:all": "node ./build/index.js all",
+    "test": "node --test \"typescript/**/*.test.ts\"",
     "test:validate-schemas": "go test ./validation/...",
     "generate:types": "node ./build/generate-typescript.js",
     "generate:permissions:ts": "node ./build/generate-permissions-ts.js",
@@ -71,7 +72,7 @@
     "csv-parse": "^6.1.0",
     "esbuild-runner": "^2.2.2",
     "glob": "^11.1.0",
-    "js-yaml": "^4.2.0",
+    "js-yaml": "^4.3.0",
     "json-schema-default": "^1.0.2",
     "json-schema-empty-strings": "^1.0.5",
     "json-schema-faker": "^0.6.2",