npm - @arbium/enterprise-agent-connect-client - Versions diffs - 0.1.2-dev.d2aa5ca → 0.2.1-dev.fd7a648 - Mend

@arbium/enterprise-agent-connect-client 0.1.2-dev.d2aa5ca → 0.2.1-dev.fd7a648

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 (7) hide show

package/lib/schema.d.ts CHANGED Viewed

@@ -73,6 +73,76 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/orgs/{org}/connectors": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** The apps the organization can use: the deployment's and its own internal apps */
+        get: operations["orgConnectors"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/orgs/{org}/internal-apps": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** The organization's own apps, as saved */
+        get: operations["internalApps"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/orgs/{org}/internal-apps/{app}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** One of the organization's own apps, as saved */
+        get: operations["internalApp"];
+        /** Adds or replaces one of the organization's own apps; a replace may cut or remove its connection and agents' access */
+        put: operations["saveInternalApp"];
+        post?: never;
+        /** Removes one of the organization's own apps, its connection and every agent's access to it */
+        delete: operations["deleteInternalApp"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/internal-apps/draft": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Drafts an internal app's definition from an OpenAPI 3.x spec (JSON) */
+        post: operations["draftInternalApp"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/providers": {
         parameters: {
             query?: never;
@@ -965,6 +1035,9 @@ export interface components {
             label: string;
             values: string[];
             warning?: string;
+            labels?: {
+                [key: string]: string;
+            };
         };
         CheckOutcome: {
             /** @constant */
@@ -1069,6 +1142,7 @@ export interface components {
                     field: string;
                     value: string;
                 };
+                capabilities?: string[];
             }[];
             afterConnect: {
                 title: string;
@@ -1102,6 +1176,7 @@ export interface components {
                     field: string;
                     value: string;
                 };
+                capabilities?: string[];
             }[];
             fields: {
                 id: string;
@@ -1119,6 +1194,8 @@ export interface components {
                     field: string;
                     value: string;
                 };
+                /** @default false */
+                optional: boolean;
             }[];
             capabilities: {
                 id: string;
@@ -1216,6 +1293,7 @@ export interface components {
                 path: string;
                 label: string;
                 show: string;
+                name?: string;
                 match?: {
                     [key: string]: string | number | boolean;
                 };
@@ -1235,6 +1313,7 @@ export interface components {
                 path: string;
                 label: string;
                 show: string;
+                name?: string;
                 match?: {
                     [key: string]: string | number | boolean;
                 };
@@ -1690,10 +1769,7 @@ export interface components {
                     deliveryId: string[];
                     types: {
                         type: string;
-                        same?: [
-                            string,
-                            string
-                        ];
+                        since?: string;
                     }[];
                 };
             };
@@ -1822,6 +1898,36 @@ export interface components {
             name: string;
             detail: string | null;
         };
+        InternalApp: {
+            id: string;
+            organizationId: string;
+            /** @description A connector.json with an http, soap, odata or sql block, as written (docs/http-connector.md) */
+            definition: {
+                [key: string]: unknown;
+            };
+            problem: string | null;
+            createdBy: string;
+            /** @description ISO 8601, UTC */
+            createdAt: string;
+            updatedBy: string;
+            /** @description ISO 8601, UTC */
+            updatedAt: string;
+        };
+        InternalAppDraft: {
+            /** @description A connector.json with an http, soap, odata or sql block, as written (docs/http-connector.md) */
+            definition: {
+                [key: string]: unknown;
+            };
+            notes: string[];
+            problem: string | null;
+        };
+        InternalAppSaved: {
+            app: components["schemas"]["InternalApp"];
+            connector: components["schemas"]["Connector"];
+            created: boolean;
+            disconnected: boolean;
+            grantsRemoved: string[];
+        };
         Limits: {
             [key: string]: string[] | string | {
                 [key: string]: string;
@@ -2450,6 +2556,380 @@ export interface operations {
             };
         };
     };
+    orgConnectors: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                org: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Connector"][];
+                };
+            };
+            /** @description Refused */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+            /** @description Refused */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+            /** @description Refused */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+            /** @description Refused */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    internalApps: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                org: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["InternalApp"][];
+                };
+            };
+            /** @description Refused */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+            /** @description Refused */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+            /** @description Refused */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+            /** @description Refused */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    internalApp: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                org: string;
+                app: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["InternalApp"];
+                };
+            };
+            /** @description Refused */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+            /** @description Refused */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+            /** @description Refused */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+            /** @description Refused */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    saveInternalApp: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                org: string;
+                app: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    /** @description A connector.json with an http, soap, odata or sql block, as written (docs/http-connector.md) */
+                    definition: {
+                        [key: string]: unknown;
+                    };
+                    by: string;
+                };
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["InternalAppSaved"];
+                };
+            };
+            /** @description Refused */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+            /** @description Refused */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+            /** @description Refused */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+            /** @description Refused */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    deleteInternalApp: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                org: string;
+                app: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    by: string;
+                };
+            };
+        };
+        responses: {
+            /** @description OK */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Refused */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+            /** @description Refused */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+            /** @description Refused */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+            /** @description Refused */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
+    draftInternalApp: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    spec: {
+                        [key: string]: unknown;
+                    };
+                    id: string;
+                    operations?: string[];
+                    tags?: string[];
+                };
+            };
+        };
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["InternalAppDraft"];
+                };
+            };
+            /** @description Refused */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+            /** @description Refused */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+            /** @description Refused */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+            /** @description Refused */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Error"];
+                };
+            };
+        };
+    };
     providers: {
         parameters: {
             query?: never;

package/lib/steps.d.ts CHANGED Viewed

@@ -17,8 +17,10 @@ export declare function choiceValues(connector: {
 export declare const isChosen: (option: ChosenOption | undefined, chosen: Record<string, string>) => boolean;
 /** The choice fields shown: one that `requires` an earlier choice only while it is made. */
 export declare const askedFields: (fields: Field[], values: Record<string, string>) => Field[];
-/** The steps that apply under the chosen options (a step with `option` only while chosen). */
-export declare function chosenSteps(connector: Connector, steps: Step[], values: Record<string, string>): Step[];
+/** The steps that apply under the chosen options (a step with `option` only while chosen)
+ *  and, given `ticked`, the ticked capabilities (a step with `capabilities` only while one of
+ *  them is). */
+export declare function chosenSteps(connector: Connector, steps: Step[], values: Record<string, string>, ticked?: readonly string[]): Step[];
 /** Choices that change the permissions the setup steps ask for: made in step 1, with what
  *  agents may do, so the steps after it already show those permissions. */
 export declare function permissionChoices(connector: Connector): Field[];
@@ -39,6 +41,12 @@ export declare function keyApps(agent: Agent, connectors: Connector[]): Connecto
 export declare function keysUsing(agents: Agent[], connectorId: string): number;
 /** The values a connected app reported for its discover probe, e.g. Jira project keys. */
 export declare function discovered(connector: Connector, checks: Check[] | null): string[];
+/** The same, each with the label to show for it (the value itself when the app gave none),
+ *  e.g. a NetSuite subsidiary's name for its id. */
+export declare function discoveredChoices(connector: Connector, checks: Check[] | null): {
+    value: string;
+    label: string;
+}[];
 /** Parses free-typed list input ("KAN, SAM1") into values. */
 export declare function splitList(raw: string): string[];
 /** Shown under Click through for a step the vendor offers only as commands. */
@@ -211,6 +219,7 @@ export declare function newKeySetup(ticked: Connector[], providers: Provider[]):
                 field: string;
                 value: string;
             };
+            capabilities?: string[];
         }[];
         afterConnect: {
             title: string;
@@ -240,6 +249,7 @@ export declare function newKeySetup(ticked: Connector[], providers: Provider[]):
                 field: string;
                 value: string;
             };
+            capabilities?: string[];
         }[];
         fields: {
             id: string;
@@ -257,6 +267,7 @@ export declare function newKeySetup(ticked: Connector[], providers: Provider[]):
                 field: string;
                 value: string;
             };
+            optional: boolean;
         }[];
         capabilities: {
             id: string;
@@ -340,6 +351,7 @@ export declare function newKeySetup(ticked: Connector[], providers: Provider[]):
             path: string;
             label: string;
             show: string;
+            name?: string;
             match?: {
                 [key: string]: string | number | boolean;
             };
@@ -357,6 +369,7 @@ export declare function newKeySetup(ticked: Connector[], providers: Provider[]):
             path: string;
             label: string;
             show: string;
+            name?: string;
             match?: {
                 [key: string]: string | number | boolean;
             };
@@ -712,7 +725,7 @@ export declare function newKeySetup(ticked: Connector[], providers: Provider[]):
                 deliveryId: string[];
                 types: {
                     type: string;
-                    same?: [string, string];
+                    since?: string;
                 }[];
             };
         };
@@ -790,6 +803,7 @@ export declare function newKeySetup(ticked: Connector[], providers: Provider[]):
                 field: string;
                 value: string;
             };
+            capabilities?: string[];
         }[];
         afterConnect: {
             title: string;
@@ -819,6 +833,7 @@ export declare function newKeySetup(ticked: Connector[], providers: Provider[]):
                 field: string;
                 value: string;
             };
+            capabilities?: string[];
         }[];
         fields: {
             id: string;
@@ -836,6 +851,7 @@ export declare function newKeySetup(ticked: Connector[], providers: Provider[]):
                 field: string;
                 value: string;
             };
+            optional: boolean;
         }[];
         capabilities: {
             id: string;
@@ -919,6 +935,7 @@ export declare function newKeySetup(ticked: Connector[], providers: Provider[]):
             path: string;
             label: string;
             show: string;
+            name?: string;
             match?: {
                 [key: string]: string | number | boolean;
             };
@@ -936,6 +953,7 @@ export declare function newKeySetup(ticked: Connector[], providers: Provider[]):
             path: string;
             label: string;
             show: string;
+            name?: string;
             match?: {
                 [key: string]: string | number | boolean;
             };
@@ -1291,7 +1309,7 @@ export declare function newKeySetup(ticked: Connector[], providers: Provider[]):
                 deliveryId: string[];
                 types: {
                     type: string;
-                    same?: [string, string];
+                    since?: string;
                 }[];
             };
         };