@meshery/schemas 1.2.0 → 1.2.2

package/README.md

@@ -48,6 +48,8 @@ Meshery schemas offer a powerful system designed for:
 
 For an explanation of Meshery's terminology regarding schemas, definitions, declarations, and instances, please see [Contributor's Guide to Models](https://docs.meshery.io/project/contributing/contributing-models).
 
+For identifier-naming rules (wire casing, DB tag separation, URL/path/query-param conventions, operationId form), see [`docs/identifier-naming-contributor-guide.md`](docs/identifier-naming-contributor-guide.md) — the canonical, reader-friendly directory for the camelCase-on-the-wire contract that this repository and every downstream consumer share.
+
 ## Contributing
 --> **For an explanation of the directory structure of this repository and how to contribute changes to Meshery's schemas, see [Contributor's Guide to Schema-Driven Development](https://docs.meshery.io/project/contributing/contributing-schemas).**
 
@@ -292,6 +294,8 @@ post:
 
 ## Naming Conventions
 
+> This section is the inline authority; for the reader-friendly directory (26-row naming table with before/after and do/don't examples), see [`docs/identifier-naming-contributor-guide.md`](docs/identifier-naming-contributor-guide.md).
+
 - Property names
   - Use camelCase for property fields (e.g., `schemaVersion`, `displayName`, `componentsCount`).
   - Identifier fields use lowerCamelCase with "Id" suffix (e.g., `modelId`, `registrantId`, `categoryId`).

package/dist/api.d.mts

@@ -1,12 +1,47 @@
 import * as _reduxjs_toolkit_query_react from '@reduxjs/toolkit/query/react';
-import { BaseQueryFn, FetchArgs, FetchBaseQueryError } from '@reduxjs/toolkit/query/react';
+import { FetchBaseQueryError, BaseQueryFn } from '@reduxjs/toolkit/query/react';
 import * as _reduxjs_toolkit_query from '@reduxjs/toolkit/query';
 
 declare const SUPPORTED_SOCIAL_ACCOUNTS: string[];
 declare const CURRENT_ORG_KEY = "Layer5-Current-Orgid";
 declare const DEFAULT_DESIGN_VERSION = "0.0.1";
 declare const MESHERY_PROD_URL = "https://playground.meshery.io/";
-declare const cloudBaseApi: _reduxjs_toolkit_query.Api<BaseQueryFn<string | FetchArgs, unknown, FetchBaseQueryError>, {}, "cloudRtkSchemasApi", never, typeof _reduxjs_toolkit_query.coreModuleName | typeof _reduxjs_toolkit_query_react.reactHooksModuleName>;
-declare const mesheryBaseApi: _reduxjs_toolkit_query.Api<BaseQueryFn<string | FetchArgs, unknown, FetchBaseQueryError, {}, _reduxjs_toolkit_query.FetchBaseQueryMeta>, {}, "mesheryRtkSchemasApi", never, typeof _reduxjs_toolkit_query.coreModuleName | typeof _reduxjs_toolkit_query_react.reactHooksModuleName>;
+/**
+ * Structured MeshKit error metadata extracted from a non-2xx JSON response body.
+ *
+ * Field names are JS-side camelCase, mapped from the server's snake_case wire
+ * fields. 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 (`probable_cause` on the wire). */
+    probableCause?: string[];
+    /** Suggested remediations to recover (`suggested_remediation` on the wire). */
+    suggestedRemediation?: string[];
+    /** Long-form description lines (`long_description` 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;
+};
+declare const cloudBaseApi: _reduxjs_toolkit_query.Api<BaseQueryFn<string | _reduxjs_toolkit_query.FetchArgs, unknown, MeshkitFetchBaseQueryError, {}, _reduxjs_toolkit_query.FetchBaseQueryMeta>, {}, "cloudRtkSchemasApi", never, typeof _reduxjs_toolkit_query.coreModuleName | typeof _reduxjs_toolkit_query_react.reactHooksModuleName>;
+declare const mesheryBaseApi: _reduxjs_toolkit_query.Api<BaseQueryFn<string | _reduxjs_toolkit_query.FetchArgs, unknown, MeshkitFetchBaseQueryError, {}, _reduxjs_toolkit_query.FetchBaseQueryMeta>, {}, "mesheryRtkSchemasApi", never, typeof _reduxjs_toolkit_query.coreModuleName | typeof _reduxjs_toolkit_query_react.reactHooksModuleName>;
 
-export { CURRENT_ORG_KEY, DEFAULT_DESIGN_VERSION, MESHERY_PROD_URL, SUPPORTED_SOCIAL_ACCOUNTS, cloudBaseApi, mesheryBaseApi };
+export { CURRENT_ORG_KEY, DEFAULT_DESIGN_VERSION, MESHERY_PROD_URL, type MeshkitError, type MeshkitFetchBaseQueryError, SUPPORTED_SOCIAL_ACCOUNTS, cloudBaseApi, mesheryBaseApi };

package/dist/api.d.ts

@@ -1,12 +1,47 @@
 import * as _reduxjs_toolkit_query_react from '@reduxjs/toolkit/query/react';
-import { BaseQueryFn, FetchArgs, FetchBaseQueryError } from '@reduxjs/toolkit/query/react';
+import { FetchBaseQueryError, BaseQueryFn } from '@reduxjs/toolkit/query/react';
 import * as _reduxjs_toolkit_query from '@reduxjs/toolkit/query';
 
 declare const SUPPORTED_SOCIAL_ACCOUNTS: string[];
 declare const CURRENT_ORG_KEY = "Layer5-Current-Orgid";
 declare const DEFAULT_DESIGN_VERSION = "0.0.1";
 declare const MESHERY_PROD_URL = "https://playground.meshery.io/";
-declare const cloudBaseApi: _reduxjs_toolkit_query.Api<BaseQueryFn<string | FetchArgs, unknown, FetchBaseQueryError>, {}, "cloudRtkSchemasApi", never, typeof _reduxjs_toolkit_query.coreModuleName | typeof _reduxjs_toolkit_query_react.reactHooksModuleName>;
-declare const mesheryBaseApi: _reduxjs_toolkit_query.Api<BaseQueryFn<string | FetchArgs, unknown, FetchBaseQueryError, {}, _reduxjs_toolkit_query.FetchBaseQueryMeta>, {}, "mesheryRtkSchemasApi", never, typeof _reduxjs_toolkit_query.coreModuleName | typeof _reduxjs_toolkit_query_react.reactHooksModuleName>;
+/**
+ * Structured MeshKit error metadata extracted from a non-2xx JSON response body.
+ *
+ * Field names are JS-side camelCase, mapped from the server's snake_case wire
+ * fields. 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 (`probable_cause` on the wire). */
+    probableCause?: string[];
+    /** Suggested remediations to recover (`suggested_remediation` on the wire). */
+    suggestedRemediation?: string[];
+    /** Long-form description lines (`long_description` 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;
+};
+declare const cloudBaseApi: _reduxjs_toolkit_query.Api<BaseQueryFn<string | _reduxjs_toolkit_query.FetchArgs, unknown, MeshkitFetchBaseQueryError, {}, _reduxjs_toolkit_query.FetchBaseQueryMeta>, {}, "cloudRtkSchemasApi", never, typeof _reduxjs_toolkit_query.coreModuleName | typeof _reduxjs_toolkit_query_react.reactHooksModuleName>;
+declare const mesheryBaseApi: _reduxjs_toolkit_query.Api<BaseQueryFn<string | _reduxjs_toolkit_query.FetchArgs, unknown, MeshkitFetchBaseQueryError, {}, _reduxjs_toolkit_query.FetchBaseQueryMeta>, {}, "mesheryRtkSchemasApi", never, typeof _reduxjs_toolkit_query.coreModuleName | typeof _reduxjs_toolkit_query_react.reactHooksModuleName>;
 
-export { CURRENT_ORG_KEY, DEFAULT_DESIGN_VERSION, MESHERY_PROD_URL, SUPPORTED_SOCIAL_ACCOUNTS, cloudBaseApi, mesheryBaseApi };
+export { CURRENT_ORG_KEY, DEFAULT_DESIGN_VERSION, MESHERY_PROD_URL, type MeshkitError, type MeshkitFetchBaseQueryError, SUPPORTED_SOCIAL_ACCOUNTS, cloudBaseApi, mesheryBaseApi };

package/dist/api.js

@@ -1,2 +1,2 @@
-'use strict';var react=require('@reduxjs/toolkit/query/react');var g=["github","google"],u="Layer5-Current-Orgid",h="0.0.1",A="https://playground.meshery.io/",o,p=(o=process.env.RTK_CLOUD_ENDPOINT_PREFIX)!=null?o:"",n,E=(n=process.env.RTK_MESHERY_ENDPOINT_PREFIX)!=null?n:"",R=react.fetchBaseQuery({baseUrl:p,credentials:"include",prepareHeaders:(t,{getState:i})=>{var s;let e=(s=i().organization)==null?void 0:s.value,r=e==null?void 0:e.id;return r&&t.set(u,r),t}}),U=react.createApi({reducerPath:"cloudRtkSchemasApi",baseQuery:R,tagTypes:[],endpoints:()=>({})}),O=react.createApi({reducerPath:"mesheryRtkSchemasApi",baseQuery:react.fetchBaseQuery({baseUrl:E,credentials:"include"}),tagTypes:[],endpoints:()=>({})});
-exports.CURRENT_ORG_KEY=u;exports.DEFAULT_DESIGN_VERSION=h;exports.MESHERY_PROD_URL=A;exports.SUPPORTED_SOCIAL_ACCOUNTS=g;exports.cloudBaseApi=U;exports.mesheryBaseApi=O;
+'use strict';var react=require('@reduxjs/toolkit/query/react');var k=["github","google"],p="Layer5-Current-Orgid",B="0.0.1",f="https://playground.meshery.io/",n,h=(n=process.env.RTK_CLOUD_ENDPOINT_PREFIX)!=null?n:"",c,y=(c=process.env.RTK_MESHERY_ENDPOINT_PREFIX)!=null?c:"";function d(o){return async(i,a,s)=>{let e=await o(i,a,s);if(e.error){let t=e.error.data;if(typeof t=="object"&&t!==null){let r=t;if(typeof r.error=="string")return {error:{...e.error,meshkit:{message:r.error,code:r.code,severity:r.severity,probableCause:r.probable_cause,suggestedRemediation:r.suggested_remediation,longDescription:r.long_description}},meta:e.meta}}return {error:e.error,meta:e.meta}}return {data:e.data,meta:e.meta}}}var E=react.fetchBaseQuery({baseUrl:h,credentials:"include",prepareHeaders:(o,{getState:i})=>{var t;let s=(t=i().organization)==null?void 0:t.value,e=s==null?void 0:s.id;return e&&o.set(p,e),o}}),l=d(E),R=d(react.fetchBaseQuery({baseUrl:y,credentials:"include"})),Q=react.createApi({reducerPath:"cloudRtkSchemasApi",baseQuery:l,tagTypes:[],endpoints:()=>({})}),S=react.createApi({reducerPath:"mesheryRtkSchemasApi",baseQuery:R,tagTypes:[],endpoints:()=>({})});
+exports.CURRENT_ORG_KEY=p;exports.DEFAULT_DESIGN_VERSION=B;exports.MESHERY_PROD_URL=f;exports.SUPPORTED_SOCIAL_ACCOUNTS=k;exports.cloudBaseApi=Q;exports.mesheryBaseApi=S;

package/dist/api.mjs

@@ -1,2 +1,2 @@
-import {fetchBaseQuery,createApi}from'@reduxjs/toolkit/query/react';var g=["github","google"],u="Layer5-Current-Orgid",h="0.0.1",A="https://playground.meshery.io/",o,p=(o=process.env.RTK_CLOUD_ENDPOINT_PREFIX)!=null?o:"",n,E=(n=process.env.RTK_MESHERY_ENDPOINT_PREFIX)!=null?n:"",R=fetchBaseQuery({baseUrl:p,credentials:"include",prepareHeaders:(t,{getState:i})=>{var s;let e=(s=i().organization)==null?void 0:s.value,r=e==null?void 0:e.id;return r&&t.set(u,r),t}}),U=createApi({reducerPath:"cloudRtkSchemasApi",baseQuery:R,tagTypes:[],endpoints:()=>({})}),O=createApi({reducerPath:"mesheryRtkSchemasApi",baseQuery:fetchBaseQuery({baseUrl:E,credentials:"include"}),tagTypes:[],endpoints:()=>({})});
-export{u as CURRENT_ORG_KEY,h as DEFAULT_DESIGN_VERSION,A as MESHERY_PROD_URL,g as SUPPORTED_SOCIAL_ACCOUNTS,U as cloudBaseApi,O as mesheryBaseApi};
+import {fetchBaseQuery,createApi}from'@reduxjs/toolkit/query/react';var k=["github","google"],p="Layer5-Current-Orgid",B="0.0.1",f="https://playground.meshery.io/",n,h=(n=process.env.RTK_CLOUD_ENDPOINT_PREFIX)!=null?n:"",c,y=(c=process.env.RTK_MESHERY_ENDPOINT_PREFIX)!=null?c:"";function d(o){return async(i,a,s)=>{let e=await o(i,a,s);if(e.error){let t=e.error.data;if(typeof t=="object"&&t!==null){let r=t;if(typeof r.error=="string")return {error:{...e.error,meshkit:{message:r.error,code:r.code,severity:r.severity,probableCause:r.probable_cause,suggestedRemediation:r.suggested_remediation,longDescription:r.long_description}},meta:e.meta}}return {error:e.error,meta:e.meta}}return {data:e.data,meta:e.meta}}}var E=fetchBaseQuery({baseUrl:h,credentials:"include",prepareHeaders:(o,{getState:i})=>{var t;let s=(t=i().organization)==null?void 0:t.value,e=s==null?void 0:s.id;return e&&o.set(p,e),o}}),l=d(E),R=d(fetchBaseQuery({baseUrl:y,credentials:"include"})),Q=createApi({reducerPath:"cloudRtkSchemasApi",baseQuery:l,tagTypes:[],endpoints:()=>({})}),S=createApi({reducerPath:"mesheryRtkSchemasApi",baseQuery:R,tagTypes:[],endpoints:()=>({})});
+export{p as CURRENT_ORG_KEY,B as DEFAULT_DESIGN_VERSION,f as MESHERY_PROD_URL,k as SUPPORTED_SOCIAL_ACCOUNTS,Q as cloudBaseApi,S as mesheryBaseApi};