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

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

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/index.js CHANGED Viewed

@@ -64,6 +64,16 @@ export function createClient(options) {
         },
         branding: () => call("GET", "/branding"),
         connectors: () => call("GET", "/connectors"),
+        /** The deployment's apps and the organization's own internal apps. */
+        orgConnectors: (o) => call("GET", `${org(o)}/connectors`),
+        internalApps: (o) => call("GET", `${org(o)}/internal-apps`),
+        internalApp: (o, a) => maybe(`${org(o)}/internal-apps/${seg(a)}`),
+        saveInternalApp: (o, a, definition, by) => call("PUT", `${org(o)}/internal-apps/${seg(a)}`, {
+            definition,
+            by,
+        }),
+        deleteInternalApp: (o, a, by) => call("DELETE", `${org(o)}/internal-apps/${seg(a)}`, { by }),
+        draftInternalApp: (body) => call("POST", "/internal-apps/draft", body),
         providers: () => call("GET", "/providers"),
         providerConnections: (o) => call("GET", `${org(o)}/providers`),
         connectProvider: (o, p, body) => call("PUT", provider(o, p), body),
@@ -197,7 +207,7 @@ export function createClient(options) {
         async appStates(o, connectors, connections) {
             const apps = connectors.map((connector) => {
                 const connection = connections.find((c) => c.connectorId === connector.id) ?? null;
-                const liveSteps = chosenSteps(connector, [...connector.setup, ...connector.afterConnect], connection?.config ?? {}).filter((s) => s.live);
+                const liveSteps = chosenSteps(connector, [...connector.setup, ...connector.afterConnect], connection?.config ?? {}, connection?.capabilities ?? []).filter((s) => s.live);
                 return { connector, connection, liveSteps };
             });
             const liveSteps = apps.flatMap((a) => a.liveSteps);

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;
                 };
@@ -1249,8 +1328,8 @@ export interface components {
             };
             revoke: string;
             http?: {
-                /** Format: uri */
                 baseUrl: string;
+                allowedHosts?: string[];
                 auth: {
                     /** @constant */
                     type: "header";
@@ -1274,6 +1353,9 @@ export interface components {
                     clientId: string;
                     clientSecret: string;
                     scope?: string;
+                    /** @enum {string} */
+                    clientAuth?: "body" | "basic";
+                    audience?: string;
                 } | {
                     /** @constant */
                     type: "query";
@@ -1284,6 +1366,10 @@ export interface components {
                 headers: {
                     [key: string]: string;
                 };
+                /** @default {} */
+                fieldHeaders: {
+                    [key: string]: string;
+                };
                 tools: {
                     name: string;
                     description: string;
@@ -1336,7 +1422,6 @@ export interface components {
                 allowInsecureHttp: boolean;
             };
             soap?: {
-                /** Format: uri */
                 endpoint: string;
                 /**
                  * @default 1.1
@@ -1410,8 +1495,8 @@ export interface components {
                 allowInsecureHttp: boolean;
             };
             odata?: {
-                /** Format: uri */
                 serviceRoot: string;
+                allowedHosts?: string[];
                 /** @enum {string} */
                 version: "2" | "4";
                 auth: {
@@ -1437,6 +1522,9 @@ export interface components {
                     clientId: string;
                     clientSecret: string;
                     scope?: string;
+                    /** @enum {string} */
+                    clientAuth?: "body" | "basic";
+                    audience?: string;
                 } | {
                     /** @constant */
                     type: "query";
@@ -1690,10 +1778,7 @@ export interface components {
                     deliveryId: string[];
                     types: {
                         type: string;
-                        same?: [
-                            string,
-                            string
-                        ];
+                        since?: string;
                     }[];
                 };
             };
@@ -1822,6 +1907,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 +2565,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;