@sistent/sistent 0.15.24 → 0.16.5

package/README.md

@@ -54,6 +54,19 @@ To run tests:
 make tests
 ```
 
+### Continuous Integration
+
+#### Automated Integration Testing with Meshery UI
+
+Sistent includes automated integration testing in CI to ensure changes don't break downstream applications. When you create a pull request, the CI automatically:
+
+1. **Builds Sistent** with your changes
+2. **Tests against Meshery UI** by installing your Sistent build into Meshery UI
+3. **Runs Meshery UI's build and tests** to verify compatibility
+4. **Reports results** in the PR checks
+
+This ensures that your Sistent changes are validated against real-world usage in Meshery UI before merging. The workflow runs automatically on all pull requests, providing fast feedback on integration issues.
+
 ### Using your local Sistent Fork in a Project
 
 #### Method 1: Manual Installation

package/dist/index.d.mts

@@ -11,7 +11,7 @@ import { Store as Store$1, Dispatch } from 'redux';
 import { EmotionCache } from '@emotion/react';
 import { TypographyOptions } from '@mui/material/styles/createTypography';
 import * as xstate from 'xstate';
-import { EventObject, DoneActorEvent, ErrorActorEvent, SnapshotFrom, NonReducibleUnknown, ActorLogic, AnyMachineSnapshot, AnyActorLogic, AnyEventObject } from 'xstate';
+import { EventObject, DoneActorEvent, SnapshotFrom, NonReducibleUnknown, ActorLogic, AnyMachineSnapshot, AnyActorLogic, ErrorActorEvent, AnyEventObject } from 'xstate';
 import { Store, Selector, UnknownAction } from '@reduxjs/toolkit';
 import { Api, EndpointDefinitions, QueryResultSelectorResult } from '@reduxjs/toolkit/query/react';
 import { AnyActorSystem } from 'xstate/dist/declarations/src/system';
@@ -84,79 +84,34 @@ declare const dataValidatorMachine: xstate.StateMachine<ValidationMachineContext
     src: "ValidateActor";
     logic: xstate.PromiseActorLogic<never, ValidateActorInput, EventObject>;
     id: string | undefined;
-}, xstate.Values<{
-    setReturnAddress: {
-        type: "setReturnAddress";
-        params: xstate.NonReducibleUnknown;
-    };
-    setValidationPayload: {
-        type: "setValidationPayload";
-        params: xstate.NonReducibleUnknown;
-    };
-    resetValidationPayload: {
-        type: "resetValidationPayload";
-        params: xstate.NonReducibleUnknown;
-    };
-    resetValidationResults: {
-        type: "resetValidationResults";
-        params: xstate.NonReducibleUnknown;
-    };
-    setValidationResults: {
-        type: "setValidationResults";
-        params: xstate.NonReducibleUnknown;
-    };
-}>, never, "debounceTimeout", "validatingData" | {
+}, {
+    type: "setReturnAddress";
+    params: xstate.NonReducibleUnknown;
+} | {
+    type: "setValidationPayload";
+    params: xstate.NonReducibleUnknown;
+} | {
+    type: "resetValidationPayload";
+    params: xstate.NonReducibleUnknown;
+} | {
+    type: "resetValidationResults";
+    params: xstate.NonReducibleUnknown;
+} | {
+    type: "setValidationResults";
+    params: xstate.NonReducibleUnknown;
+}, never, "debounceTimeout", "validatingData" | {
     idle: "waiting" | "debouncing";
 }, string, xstate.NonReducibleUnknown, xstate.NonReducibleUnknown, EventObject, xstate.MetaObject, {
-    readonly id: "validationMachine";
-    readonly initial: "idle";
-    readonly context: {
-        readonly validationResults: null;
-        readonly validationPayload: {};
-        readonly returnAddress: null;
-    };
-    readonly states: {
+    id: "validationMachine";
+    states: {
         readonly idle: {
-            readonly description: "when the machine is idle , i.e no process is going on and the machine the ready to accept new request";
-            readonly initial: "waiting";
-            readonly on: {
-                readonly VALIDATE_DATA: {
-                    readonly target: ".debouncing";
-                    readonly actions: readonly ["setValidationPayload", "setReturnAddress"];
-                };
-            };
-            readonly states: {
+            states: {
                 readonly waiting: {};
-                readonly debouncing: {
-                    readonly after: {
-                        readonly debounceTimeout: "#validatingData";
-                    };
-                };
+                readonly debouncing: {};
             };
         };
         readonly validatingData: {
-            readonly id: "validatingData";
-            readonly invoke: {
-                readonly src: "ValidateActor";
-                readonly input: ({ context }: {
-                    context: ValidationMachineContext;
-                }) => {
-                    validationPayload: ValidationPayload;
-                    prevValidationResults: ValidationResults;
-                };
-                readonly onDone: {
-                    readonly target: "idle";
-                    readonly actions: readonly ["setValidationResults", any];
-                };
-                readonly onError: {
-                    readonly target: "idle";
-                    readonly actions: readonly [any, ({ event }: xstate.ActionArgs<ValidationMachineContext, ErrorActorEvent<unknown, string>, ValidateDataCommand | ValidateActorDoneEvent | DataValidatedEvent | DataValidationFailedEvent>) => void, xstate.ActionFunction<ValidationMachineContext, ErrorActorEvent<unknown, string>, ValidateDataCommand | ValidateActorDoneEvent | DataValidatedEvent | DataValidationFailedEvent, undefined, {
-                        src: "ValidateActor";
-                        logic: xstate.PromiseActorLogic<never, ValidateActorInput, EventObject>;
-                        id: string | undefined;
-                    }, never, never, never, never>];
-                };
-            };
+            id: "validatingData";
         };
     };
 }>;
@@ -275,151 +230,8 @@ declare const reduxActor: xstate.StateMachine<ReduxActorContext, {
         extraArgs?: extraArgs;
     };
 }, {}, never, never, never, never, "idle", string, ReduxActorContext, xstate.NonReducibleUnknown, xstate.EventObject, xstate.MetaObject, {
-    readonly initial: "idle";
-    readonly context: ({ input }: {
-        spawn: {
-            <TSrc extends never>(logic: TSrc, ...[options]: never): xstate.ActorRefFromLogic<never>;
-            <TLogic extends xstate.AnyActorLogic>(src: TLogic, ...[options]: xstate.ConditionalRequired<[options?: ({
-                id?: never;
-                systemId?: string;
-                input?: xstate.InputFrom<TLogic> | undefined;
-                syncSnapshot?: boolean;
-            } & { [K in xstate.RequiredLogicInput<TLogic>]: unknown; }) | undefined], xstate.IsNotNever<xstate.RequiredLogicInput<TLogic>>>): xstate.ActorRefFromLogic<TLogic>;
-        };
-        input: ReduxActorContext;
-        self: xstate.ActorRef<xstate.MachineSnapshot<ReduxActorContext, {
-            type: "DISPATCH";
-            data: {
-                action: UnknownAction;
-            };
-        } | {
-            type: "SUBSCRIBE";
-        } | {
-            type: "UNSUBSCRIBE";
-        } | {
-            type: "REDUX_STATE_SNAPSHOT";
-            data: {
-                snapshot: unknown;
-            };
-        } | {
-            type: "GET_STATE";
-            returnAddress: string;
-            data: {
-                key: string;
-            };
-        } | {
-            type: "GET_STATE_FROM_SELECTOR";
-            returnAddress: string;
-            data: {
-                selector: string;
-                extraArgs?: extraArgs;
-            };
-        }, Record<string, xstate.AnyActorRef | undefined>, xstate.StateValue, string, unknown, any, any>, {
-            type: "DISPATCH";
-            data: {
-                action: UnknownAction;
-            };
-        } | {
-            type: "SUBSCRIBE";
-        } | {
-            type: "UNSUBSCRIBE";
-        } | {
-            type: "REDUX_STATE_SNAPSHOT";
-            data: {
-                snapshot: unknown;
-            };
-        } | {
-            type: "GET_STATE";
-            returnAddress: string;
-            data: {
-                key: string;
-            };
-        } | {
-            type: "GET_STATE_FROM_SELECTOR";
-            returnAddress: string;
-            data: {
-                selector: string;
-                extraArgs?: extraArgs;
-            };
-        }, xstate.AnyEventObject>;
-    }) => ReduxActorContext;
-    readonly states: {
-        readonly idle: {
-            readonly on: {
-                readonly DISPATCH: {
-                    readonly actions: readonly [({ event, context }: xstate.ActionArgs<ReduxActorContext, {
-                        type: "DISPATCH";
-                        data: {
-                            action: UnknownAction;
-                        };
-                    }, {
-                        type: "DISPATCH";
-                        data: {
-                            action: UnknownAction;
-                        };
-                    } | {
-                        type: "SUBSCRIBE";
-                    } | {
-                        type: "UNSUBSCRIBE";
-                    } | {
-                        type: "REDUX_STATE_SNAPSHOT";
-                        data: {
-                            snapshot: unknown;
-                        };
-                    } | {
-                        type: "GET_STATE";
-                        returnAddress: string;
-                        data: {
-                            key: string;
-                        };
-                    } | {
-                        type: "GET_STATE_FROM_SELECTOR";
-                        returnAddress: string;
-                        data: {
-                            selector: string;
-                            extraArgs?: extraArgs;
-                        };
-                    }>) => UnknownAction];
-                };
-                readonly GET_STATE_FROM_SELECTOR: {
-                    readonly actions: xstate.ActionFunction<ReduxActorContext, {
-                        type: "GET_STATE_FROM_SELECTOR";
-                        returnAddress: string;
-                        data: {
-                            selector: string;
-                            extraArgs?: extraArgs;
-                        };
-                    }, {
-                        type: "DISPATCH";
-                        data: {
-                            action: UnknownAction;
-                        };
-                    } | {
-                        type: "SUBSCRIBE";
-                    } | {
-                        type: "UNSUBSCRIBE";
-                    } | {
-                        type: "REDUX_STATE_SNAPSHOT";
-                        data: {
-                            snapshot: unknown;
-                        };
-                    } | {
-                        type: "GET_STATE";
-                        returnAddress: string;
-                        data: {
-                            key: string;
-                        };
-                    } | {
-                        type: "GET_STATE_FROM_SELECTOR";
-                        returnAddress: string;
-                        data: {
-                            selector: string;
-                            extraArgs?: extraArgs;
-                        };
-                    }, undefined, never, never, never, never, never>;
-                };
-            };
-        };
+    states: {
+        readonly idle: {};
     };
 }>;
 
@@ -499,81 +311,9 @@ declare const rtkQueryActor: xstate.StateMachine<RtkQueryActorContext, initiateQ
     }, InitiateQueryActorInput, EventObject>;
     id: string | undefined;
 }, never, never, never, "idle" | "querying", string, RtkQueryActorInput, xstate.NonReducibleUnknown, EventObject, xstate.MetaObject, {
-    readonly initial: "idle";
-    readonly context: ({ input }: {
-        spawn: {
-            <TSrc extends "InitiateQueryActor">(logic: TSrc, ...[options]: {
-                src: "InitiateQueryActor";
-                logic: xstate.PromiseActorLogic<{
-                    result: any;
-                    sourceEvent: initiateQueryEvent;
-                }, InitiateQueryActorInput, EventObject>;
-                id: string | undefined;
-            } extends infer T ? T extends {
-                src: "InitiateQueryActor";
-                logic: xstate.PromiseActorLogic<{
-                    result: any;
-                    sourceEvent: initiateQueryEvent;
-                }, InitiateQueryActorInput, EventObject>;
-                id: string | undefined;
-            } ? T extends {
-                src: TSrc;
-            } ? xstate.ConditionalRequired<[options?: ({
-                id?: T["id"] | undefined;
-                systemId?: string;
-                input?: xstate.InputFrom<T["logic"]> | undefined;
-                syncSnapshot?: boolean;
-            } & { [K in xstate.RequiredActorOptions<T>]: unknown; }) | undefined], xstate.IsNotNever<xstate.RequiredActorOptions<T>>> : never : never : never): xstate.ActorRefFromLogic<xstate.GetConcreteByKey<{
-                src: "InitiateQueryActor";
-                logic: xstate.PromiseActorLogic<{
-                    result: any;
-                    sourceEvent: initiateQueryEvent;
-                }, InitiateQueryActorInput, EventObject>;
-                id: string | undefined;
-            }, "src", TSrc>["logic"]>;
-            <TLogic extends xstate.AnyActorLogic>(src: TLogic, ...[options]: xstate.ConditionalRequired<[options?: ({
-                id?: never;
-                systemId?: string;
-                input?: xstate.InputFrom<TLogic> | undefined;
-                syncSnapshot?: boolean;
-            } & { [K in xstate.RequiredLogicInput<TLogic>]: unknown; }) | undefined], xstate.IsNotNever<xstate.RequiredLogicInput<TLogic>>>): xstate.ActorRefFromLogic<TLogic>;
-        };
-        input: RtkQueryActorInput;
-        self: xstate.ActorRef<xstate.MachineSnapshot<RtkQueryActorContext, initiateQueryEvent | queryDoneEvent | queryFailedEvent, Record<string, xstate.AnyActorRef | undefined>, xstate.StateValue, string, unknown, any, any>, initiateQueryEvent | queryDoneEvent | queryFailedEvent, xstate.AnyEventObject>;
-    }) => RtkQueryActorInput;
-    readonly states: {
-        readonly idle: {
-            readonly on: {
-                readonly INITIATE_QUERY: {
-                    readonly target: "querying";
-                };
-            };
-        };
-        readonly querying: {
-            readonly invoke: {
-                readonly id: "initiateQuery";
-                readonly input: ({ context, event }: {
-                    context: RtkQueryActorContext;
-                    event: initiateQueryEvent | queryDoneEvent | queryFailedEvent;
-                    self: xstate.ActorRef<xstate.MachineSnapshot<RtkQueryActorContext, initiateQueryEvent | queryDoneEvent | queryFailedEvent, Record<string, xstate.AnyActorRef>, xstate.StateValue, string, unknown, any, any>, initiateQueryEvent | queryDoneEvent | queryFailedEvent, xstate.AnyEventObject>;
-                }) => {
-                    context: RtkQueryActorContext;
-                    event: initiateQueryEvent;
-                };
-                readonly src: "InitiateQueryActor";
-                readonly onDone: {
-                    readonly actions: xstate.ActionFunction<RtkQueryActorContext, DoneActorEvent<{
-                        result: any;
-                        sourceEvent: initiateQueryEvent;
-                    }, string>, initiateQueryEvent | queryDoneEvent | queryFailedEvent, undefined, never, never, never, never, never>;
-                    readonly target: "idle";
-                };
-                readonly onError: {
-                    readonly actions: xstate.ActionFunction<RtkQueryActorContext, ErrorActorEvent<unknown, string>, initiateQueryEvent | queryDoneEvent | queryFailedEvent, undefined, never, never, never, never, never>;
-                    readonly target: "idle";
-                };
-            };
-        };
+    states: {
+        readonly idle: {};
+        readonly querying: {};
     };
 }>;
 
@@ -1534,22 +1274,22 @@ declare const createAndEditEnvironmentSchema: {
     required: string[];
     properties: {
         description: {
-            description: string;
+            description: "An environment is a collection of resources, such as connections & credentail. Provide a detailed description to clarify the purpose of this environment and the types of resources it encompasses. You can modify the description at any Time. Learn more about environments [here](https://docs.meshery.io/concepts/logical/environments).";
             format: string;
             title: string;
-            type: string;
+            type: "string";
             'x-rjsf-grid-area': string;
         };
         name: {
-            description: string;
+            description: "An environment is a collection of resources. Provide a name that meaningfully represents these resources. You can change the name of the environment even after its creation.";
             title: string;
-            type: string;
+            type: "string";
             'x-rjsf-grid-area': string;
         };
         organization: {
-            type: string;
+            type: "string";
             title: string;
-            description: string;
+            description: "Select an organization in which you want to create this new environment. Keep in mind that the organization cannot be changed after creation.";
             enum: never[];
             enumNames: never[];
             'x-rjsf-grid-area': string;
@@ -1568,21 +1308,21 @@ declare const createAndEditEnvironmentUiSchema: {
 declare const createAndEditWorkspace: {
     properties: {
         description: {
-            description: string;
+            description: "Workspaces serve as a virtual space for your team-based work, allows you to control access and more, Provide a detailed description to clarify the purpose of this workspace. Remember you can changes description of workspace after it's creations too. Learn more about workspaces [here](https://docs.meshery.io/concepts/logical/workspaces)";
             format: string;
             title: string;
-            type: string;
+            type: "string";
             'x-rjsf-grid-area': string;
         };
         name: {
-            description: string;
+            description: "Provide a name that meaningfully represents this workspace. You can change the name of the workspace even after its creation.";
             title: string;
-            type: string;
+            type: "string";
             'x-rjsf-grid-area': string;
         };
         organization: {
-            type: string;
-            description: string;
+            type: "string";
+            description: "Select an organization in which you want to create this new workspace. Keep in mind that the organization cannot be changed after creation.";
             title: string;
             enum: never[];
             enumNames: never[];
@@ -1641,18 +1381,18 @@ declare const importDesignSchema: {
     type: string;
     properties: {
         name: {
-            type: string;
+            type: "string";
             title: string;
-            default: string;
+            default: "Untitled Design";
             'x-rjsf-grid-area': string;
-            description: string;
+            description: "Provide a name for your design file. This name will help you identify the file more easily. You can also change the name of your design after importing it.";
         };
         uploadType: {
             title: string;
             enum: string[];
             default: string;
             'x-rjsf-grid-area': string;
-            description: string;
+            description: "Choose the method you prefer to upload your  design file. Select 'File Upload' if you have the file on your local system, or 'URL Import' if you have the file hosted online.";
         };
     };
     allOf: ({
@@ -1666,9 +1406,9 @@ declare const importDesignSchema: {
         then: {
             properties: {
                 file: {
-                    type: string;
-                    format: string;
-                    description: string;
+                    type: "string";
+                    format: "file";
+                    description: "Supported formats: Kubernetes Manifests, Helm Charts, Docker Compose, and Meshery Designs. See [Import Designs Documentation](https://docs.meshery.io/guides/configuration-management/importing-designs#import-designs-using-meshery-ui) for details";
                     'x-rjsf-grid-area': string;
                 };
                 url?: undefined;
@@ -1686,10 +1426,10 @@ declare const importDesignSchema: {
         then: {
             properties: {
                 url: {
-                    type: string;
-                    format: string;
+                    type: "string";
+                    format: "uri";
                     title: string;
-                    description: string;
+                    description: "Provide the URL of the file you want to import. This should be a direct URL to a single file, for example: https://raw.github.com/your-design-file.yaml. Also, ensure that design is in a supported format: Kubernetes Manifest, Helm Chart, Docker Compose, or Meshery Design. See [Import Designs Documentation](https://docs.meshery.io/guides/configuration-management/importing-designs#import-designs-using-meshery-ui) for details";
                     'x-rjsf-grid-area': string;
                 };
                 file?: undefined;
@@ -1787,13 +1527,13 @@ declare const importModelSchema: {
     required: string[];
     properties: {
         uploadType: {
-            type: string;
+            type: "string";
             title: string;
             enum: string[];
-            enumDescriptions: string[];
+            enumDescriptions: readonly ["Upload a model file (.tar, .tar.gz, .tgz) from your local system", "Import a model file using a direct URL to the source", "Upload separate CSV files for model definitions, components, and their relationships"];
             default: string;
             'x-rjsf-grid-area': string;
-            description: string;
+            description: "Choose the method you prefer to upload your model file. Select 'File Import' or 'CSV Import' if you have the file on your local system or 'URL Import' if you have the file hosted online.";
         };
     };
     allOf: ({
@@ -1807,9 +1547,9 @@ declare const importModelSchema: {
         then: {
             properties: {
                 file: {
-                    type: string | undefined;
-                    format: string | undefined;
-                    description: string | undefined;
+                    type: "string";
+                    format: "file";
+                    description: "Supported model file formats are: .tar, .tar.gz, and .tgz. See [Import Models Documentation](https://docs.meshery.io/guides/configuration-management/importing-models#import-models-using-meshery-ui) for details";
                     'x-rjsf-grid-area': string;
                 };
                 url?: undefined;
@@ -1827,10 +1567,10 @@ declare const importModelSchema: {
         then: {
             properties: {
                 url: {
-                    type: string | undefined;
-                    format: string | undefined;
+                    type: "string";
+                    format: "uri";
                     title: string;
-                    description: string | undefined;
+                    description: "A direct URL to a single model file, for example: https://raw.github.com/your-model-file.tar. Supported model file formats are: .tar, .tar.gz, and .tgz. \\n\\nFor bulk import of your model use the GitHub connection or CSV files. See [Import Models Documentation](https://docs.meshery.io/guides/configuration-management/importing-models#import-models-using-meshery-ui) for details";
                     'x-rjsf-grid-area': string;
                     disabled: boolean;
                 };