@meshery/schemas 1.3.116 → 1.3.118

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (66) hide show
  1. package/README.md +10 -0
  2. package/dist/api.d.mts +9 -1
  3. package/dist/api.d.ts +9 -1
  4. package/dist/api.js +2 -2
  5. package/dist/api.mjs +2 -2
  6. package/dist/cloudApi.d.mts +739 -20
  7. package/dist/cloudApi.d.ts +739 -20
  8. package/dist/cloudApi.js +1 -1
  9. package/dist/cloudApi.mjs +1 -1
  10. package/dist/constructs/v1alpha1/controllers_config/ControllersConfig.d.ts +37 -1392
  11. package/dist/constructs/v1alpha1/controllers_config/ControllersConfigSchema.js +1 -1
  12. package/dist/constructs/v1alpha1/controllers_config/ControllersConfigSchema.mjs +1 -1
  13. package/dist/constructs/v1beta1/component/ComponentSchema.js +1 -1
  14. package/dist/constructs/v1beta1/component/ComponentSchema.mjs +1 -1
  15. package/dist/constructs/v1beta1/evaluation/EvaluationSchema.js +4 -4
  16. package/dist/constructs/v1beta1/evaluation/EvaluationSchema.mjs +4 -4
  17. package/dist/constructs/v1beta1/model/ModelSchema.js +3 -3
  18. package/dist/constructs/v1beta1/model/ModelSchema.mjs +3 -3
  19. package/dist/constructs/v1beta1/pattern/PatternSchema.js +12 -12
  20. package/dist/constructs/v1beta1/pattern/PatternSchema.mjs +12 -12
  21. package/dist/constructs/v1beta1/registry/RegistrySchema.js +18 -18
  22. package/dist/constructs/v1beta1/registry/RegistrySchema.mjs +18 -18
  23. package/dist/constructs/v1beta1/user/User.d.ts +9 -0
  24. package/dist/constructs/v1beta1/user/UserSchema.js +1 -1
  25. package/dist/constructs/v1beta1/user/UserSchema.mjs +1 -1
  26. package/dist/constructs/v1beta1/workspace/WorkspaceSchema.js +2 -2
  27. package/dist/constructs/v1beta1/workspace/WorkspaceSchema.mjs +2 -2
  28. package/dist/constructs/v1beta2/component/ComponentSchema.js +1 -1
  29. package/dist/constructs/v1beta2/component/ComponentSchema.mjs +1 -1
  30. package/dist/constructs/v1beta2/design/DesignSchema.js +12 -12
  31. package/dist/constructs/v1beta2/design/DesignSchema.mjs +12 -12
  32. package/dist/constructs/v1beta2/model/ModelSchema.js +3 -3
  33. package/dist/constructs/v1beta2/model/ModelSchema.mjs +3 -3
  34. package/dist/constructs/v1beta2/user/User.d.ts +28 -1
  35. package/dist/constructs/v1beta2/user/UserSchema.js +1 -1
  36. package/dist/constructs/v1beta2/user/UserSchema.mjs +1 -1
  37. package/dist/constructs/v1beta2/view/View.d.ts +226 -22
  38. package/dist/constructs/v1beta2/view/ViewSchema.js +4 -4
  39. package/dist/constructs/v1beta2/view/ViewSchema.mjs +4 -4
  40. package/dist/constructs/v1beta3/component/ComponentSchema.js +1 -1
  41. package/dist/constructs/v1beta3/component/ComponentSchema.mjs +1 -1
  42. package/dist/constructs/v1beta3/connection/Connection.d.ts +17 -5
  43. package/dist/constructs/v1beta3/connection/ConnectionSchema.js +3 -3
  44. package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +3 -3
  45. package/dist/constructs/v1beta3/content_item/ContentItem.d.ts +2 -2
  46. package/dist/constructs/v1beta3/content_item/ContentItemSchema.js +11 -11
  47. package/dist/constructs/v1beta3/content_item/ContentItemSchema.mjs +11 -11
  48. package/dist/constructs/v1beta3/design/DesignSchema.js +1 -1
  49. package/dist/constructs/v1beta3/design/DesignSchema.mjs +1 -1
  50. package/dist/constructs/v1beta3/event/Event.d.ts +111 -10
  51. package/dist/constructs/v1beta3/event/EventSchema.js +7 -3
  52. package/dist/constructs/v1beta3/event/EventSchema.mjs +7 -3
  53. package/dist/constructs/v1beta3/schedule/Schedule.d.ts +390 -1
  54. package/dist/constructs/v1beta3/schedule/ScheduleSchema.js +35 -15
  55. package/dist/constructs/v1beta3/schedule/ScheduleSchema.mjs +35 -15
  56. package/dist/constructs/v1beta3/workspace/WorkspaceSchema.js +2 -2
  57. package/dist/constructs/v1beta3/workspace/WorkspaceSchema.mjs +2 -2
  58. package/dist/index.d.mts +13 -7
  59. package/dist/index.d.ts +13 -7
  60. package/dist/index.js +31 -31
  61. package/dist/index.mjs +31 -31
  62. package/dist/mesheryApi.d.mts +466 -833
  63. package/dist/mesheryApi.d.ts +466 -833
  64. package/dist/mesheryApi.js +1 -1
  65. package/dist/mesheryApi.mjs +1 -1
  66. package/package.json +2 -2
package/README.md CHANGED
@@ -784,6 +784,16 @@ export const store = configureStore({
784
784
  setupListeners(store.dispatch);
785
785
  ```
786
786
 
787
+ ### Organization Scope
788
+
789
+ The Cloud client sends the `X-Current-Orgid` header on every request, taken from `state.organization.value.id` in your store. An endpoint that declares the header as an argument (`registerConnection`, `deregisterDesktopConnection`, `getProviderCapabilities`) sends the value you pass instead, for example `all` to deregister an install from every organization:
790
+
791
+ ```javascript
792
+ deregisterDesktopConnection({ installationId, "X-Current-Orgid": "all" });
793
+ ```
794
+
795
+ Omit the argument to use the selected organization. With no organization selected and no argument, the header is not sent.
796
+
787
797
  ## Using API Hooks
788
798
 
789
799
  After configuring your store, you can import and use the generated hooks:
package/dist/api.d.mts CHANGED
@@ -3,8 +3,16 @@ import { M as MeshkitFetchBaseQueryError } from './meshkitError-Dfcgbi6X.mjs';
3
3
  export { a as MeshkitError, w as withMeshkitErrorTransform } from './meshkitError-Dfcgbi6X.mjs';
4
4
  import * as _reduxjs_toolkit_query from '@reduxjs/toolkit/query';
5
5
 
6
- declare const SUPPORTED_SOCIAL_ACCOUNTS: string[];
6
+ /**
7
+ * The `X-Current-Orgid` header the Cloud base query sends, kept apart from
8
+ * {@link ./api} for the same reason as `./meshkitError`: `./api` value-imports
9
+ * the React-coupled RTK runtime, and this logic must run under Node's native
10
+ * TypeScript test runner.
11
+ */
7
12
  declare const CURRENT_ORG_KEY = "X-Current-Orgid";
13
+
14
+ declare const SUPPORTED_SOCIAL_ACCOUNTS: string[];
15
+
8
16
  declare const DEFAULT_DESIGN_VERSION = "0.0.1";
9
17
  declare const MESHERY_PROD_URL = "https://playground.meshery.io/";
10
18
  declare const cloudBaseApi: _reduxjs_toolkit_query.Api<_reduxjs_toolkit_query.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>;
package/dist/api.d.ts CHANGED
@@ -3,8 +3,16 @@ import { M as MeshkitFetchBaseQueryError } from './meshkitError-Dfcgbi6X.js';
3
3
  export { a as MeshkitError, w as withMeshkitErrorTransform } from './meshkitError-Dfcgbi6X.js';
4
4
  import * as _reduxjs_toolkit_query from '@reduxjs/toolkit/query';
5
5
 
6
- declare const SUPPORTED_SOCIAL_ACCOUNTS: string[];
6
+ /**
7
+ * The `X-Current-Orgid` header the Cloud base query sends, kept apart from
8
+ * {@link ./api} for the same reason as `./meshkitError`: `./api` value-imports
9
+ * the React-coupled RTK runtime, and this logic must run under Node's native
10
+ * TypeScript test runner.
11
+ */
7
12
  declare const CURRENT_ORG_KEY = "X-Current-Orgid";
13
+
14
+ declare const SUPPORTED_SOCIAL_ACCOUNTS: string[];
15
+
8
16
  declare const DEFAULT_DESIGN_VERSION = "0.0.1";
9
17
  declare const MESHERY_PROD_URL = "https://playground.meshery.io/";
10
18
  declare const cloudBaseApi: _reduxjs_toolkit_query.Api<_reduxjs_toolkit_query.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>;
package/dist/api.js CHANGED
@@ -1,2 +1,2 @@
1
- 'use strict';var react=require('@reduxjs/toolkit/query/react');function i(o){return async(a,c,t)=>{var s,u,g;let e=await o(a,c,t);if(e.error){let n=e.error.data;if(typeof n=="object"&&n!==null){let r=n;if(typeof r.error=="string")return {error:{...e.error,meshkit:{message:r.error,code:r.code,severity:r.severity,probableCause:(s=r.probableCause)!=null?s:r.probable_cause,suggestedRemediation:(u=r.suggestedRemediation)!=null?u:r.suggested_remediation,longDescription:(g=r.longDescription)!=null?g:r.long_description}},meta:e.meta}}return {error:e.error,meta:e.meta}}return {data:e.data,meta:e.meta}}}var Q=["github","google"],l="X-Current-Orgid",D="0.0.1",S="https://playground.meshery.io/",p,E=(p=process.env.RTK_CLOUD_ENDPOINT_PREFIX)!=null?p:"",h,m=(h=process.env.RTK_MESHERY_ENDPOINT_PREFIX)!=null?h:"",R=react.fetchBaseQuery({baseUrl:E,credentials:"include",prepareHeaders:(o,{getState:a})=>{var s;let t=(s=a().organization)==null?void 0:s.value,e=t==null?void 0:t.id;return e&&o.set(l,e),o}}),M=i(R),_=i(react.fetchBaseQuery({baseUrl:m,credentials:"include"})),x=react.createApi({reducerPath:"cloudRtkSchemasApi",baseQuery:M,tagTypes:[],endpoints:()=>({})}),F=react.createApi({reducerPath:"mesheryRtkSchemasApi",baseQuery:_,tagTypes:[],endpoints:()=>({})});
2
- exports.CURRENT_ORG_KEY=l;exports.DEFAULT_DESIGN_VERSION=D;exports.MESHERY_PROD_URL=S;exports.SUPPORTED_SOCIAL_ACCOUNTS=Q;exports.cloudBaseApi=x;exports.mesheryBaseApi=F;exports.withMeshkitErrorTransform=i;
1
+ 'use strict';var react=require('@reduxjs/toolkit/query/react');function i(t){return async(n,s,o)=>{var c,p,g;let e=await t(n,s,o);if(e.error){let a=e.error.data;if(typeof a=="object"&&a!==null){let r=a;if(typeof r.error=="string")return {error:{...e.error,meshkit:{message:r.error,code:r.code,severity:r.severity,probableCause:(c=r.probableCause)!=null?c:r.probable_cause,suggestedRemediation:(p=r.suggestedRemediation)!=null?p:r.suggested_remediation,longDescription:(g=r.longDescription)!=null?g:r.long_description}},meta:e.meta}}return {error:e.error,meta:e.meta}}return {data:e.data,meta:e.meta}}}var u="X-Current-Orgid";function d(t,{getState:n}){var o,e;if(t.has(u))return t;let s=(e=(o=n().organization)==null?void 0:o.value)==null?void 0:e.id;return s&&t.set(u,s),t}var Q=["github","google"],D="0.0.1",S="https://playground.meshery.io/",h,m=(h=process.env.RTK_CLOUD_ENDPOINT_PREFIX)!=null?h:"",l,R=(l=process.env.RTK_MESHERY_ENDPOINT_PREFIX)!=null?l:"",_=react.fetchBaseQuery({baseUrl:m,credentials:"include",prepareHeaders:d}),f=i(_),M=i(react.fetchBaseQuery({baseUrl:R,credentials:"include"})),F=react.createApi({reducerPath:"cloudRtkSchemasApi",baseQuery:f,tagTypes:[],endpoints:()=>({})}),T=react.createApi({reducerPath:"mesheryRtkSchemasApi",baseQuery:M,tagTypes:[],endpoints:()=>({})});
2
+ exports.CURRENT_ORG_KEY=u;exports.DEFAULT_DESIGN_VERSION=D;exports.MESHERY_PROD_URL=S;exports.SUPPORTED_SOCIAL_ACCOUNTS=Q;exports.cloudBaseApi=F;exports.mesheryBaseApi=T;exports.withMeshkitErrorTransform=i;
package/dist/api.mjs CHANGED
@@ -1,2 +1,2 @@
1
- import {fetchBaseQuery,createApi}from'@reduxjs/toolkit/query/react';function i(o){return async(a,c,t)=>{var s,u,g;let e=await o(a,c,t);if(e.error){let n=e.error.data;if(typeof n=="object"&&n!==null){let r=n;if(typeof r.error=="string")return {error:{...e.error,meshkit:{message:r.error,code:r.code,severity:r.severity,probableCause:(s=r.probableCause)!=null?s:r.probable_cause,suggestedRemediation:(u=r.suggestedRemediation)!=null?u:r.suggested_remediation,longDescription:(g=r.longDescription)!=null?g:r.long_description}},meta:e.meta}}return {error:e.error,meta:e.meta}}return {data:e.data,meta:e.meta}}}var Q=["github","google"],l="X-Current-Orgid",D="0.0.1",S="https://playground.meshery.io/",p,E=(p=process.env.RTK_CLOUD_ENDPOINT_PREFIX)!=null?p:"",h,m=(h=process.env.RTK_MESHERY_ENDPOINT_PREFIX)!=null?h:"",R=fetchBaseQuery({baseUrl:E,credentials:"include",prepareHeaders:(o,{getState:a})=>{var s;let t=(s=a().organization)==null?void 0:s.value,e=t==null?void 0:t.id;return e&&o.set(l,e),o}}),M=i(R),_=i(fetchBaseQuery({baseUrl:m,credentials:"include"})),x=createApi({reducerPath:"cloudRtkSchemasApi",baseQuery:M,tagTypes:[],endpoints:()=>({})}),F=createApi({reducerPath:"mesheryRtkSchemasApi",baseQuery:_,tagTypes:[],endpoints:()=>({})});
2
- export{l as CURRENT_ORG_KEY,D as DEFAULT_DESIGN_VERSION,S as MESHERY_PROD_URL,Q as SUPPORTED_SOCIAL_ACCOUNTS,x as cloudBaseApi,F as mesheryBaseApi,i as withMeshkitErrorTransform};
1
+ import {fetchBaseQuery,createApi}from'@reduxjs/toolkit/query/react';function i(t){return async(n,s,o)=>{var c,p,g;let e=await t(n,s,o);if(e.error){let a=e.error.data;if(typeof a=="object"&&a!==null){let r=a;if(typeof r.error=="string")return {error:{...e.error,meshkit:{message:r.error,code:r.code,severity:r.severity,probableCause:(c=r.probableCause)!=null?c:r.probable_cause,suggestedRemediation:(p=r.suggestedRemediation)!=null?p:r.suggested_remediation,longDescription:(g=r.longDescription)!=null?g:r.long_description}},meta:e.meta}}return {error:e.error,meta:e.meta}}return {data:e.data,meta:e.meta}}}var u="X-Current-Orgid";function d(t,{getState:n}){var o,e;if(t.has(u))return t;let s=(e=(o=n().organization)==null?void 0:o.value)==null?void 0:e.id;return s&&t.set(u,s),t}var Q=["github","google"],D="0.0.1",S="https://playground.meshery.io/",h,m=(h=process.env.RTK_CLOUD_ENDPOINT_PREFIX)!=null?h:"",l,R=(l=process.env.RTK_MESHERY_ENDPOINT_PREFIX)!=null?l:"",_=fetchBaseQuery({baseUrl:m,credentials:"include",prepareHeaders:d}),f=i(_),M=i(fetchBaseQuery({baseUrl:R,credentials:"include"})),F=createApi({reducerPath:"cloudRtkSchemasApi",baseQuery:f,tagTypes:[],endpoints:()=>({})}),T=createApi({reducerPath:"mesheryRtkSchemasApi",baseQuery:M,tagTypes:[],endpoints:()=>({})});
2
+ export{u as CURRENT_ORG_KEY,D as DEFAULT_DESIGN_VERSION,S as MESHERY_PROD_URL,Q as SUPPORTED_SOCIAL_ACCOUNTS,F as cloudBaseApi,T as mesheryBaseApi,i as withMeshkitErrorTransform};