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

package/lib/index.d.ts

@@ -115,6 +115,7 @@ export declare function createClient(options: ClientOptions): {
                 field: string;
                 value: string;
             };
+            capabilities?: string[];
         }[];
         afterConnect: {
             title: string;
@@ -144,6 +145,7 @@ export declare function createClient(options: ClientOptions): {
                 field: string;
                 value: string;
             };
+            capabilities?: string[];
         }[];
         fields: {
             id: string;
@@ -161,6 +163,7 @@ export declare function createClient(options: ClientOptions): {
                 field: string;
                 value: string;
             };
+            optional: boolean;
         }[];
         capabilities: {
             id: string;
@@ -244,6 +247,7 @@ export declare function createClient(options: ClientOptions): {
             path: string;
             label: string;
             show: string;
+            name?: string;
             match?: {
                 [key: string]: string | number | boolean;
             };
@@ -261,6 +265,7 @@ export declare function createClient(options: ClientOptions): {
             path: string;
             label: string;
             show: string;
+            name?: string;
             match?: {
                 [key: string]: string | number | boolean;
             };
@@ -616,7 +621,7 @@ export declare function createClient(options: ClientOptions): {
                 deliveryId: string[];
                 types: {
                     type: string;
-                    same?: [string, string];
+                    since?: string;
                 }[];
             };
         };

package/lib/index.js

@@ -197,7 +197,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

@@ -965,6 +965,9 @@ export interface components {
             label: string;
             values: string[];
             warning?: string;
+            labels?: {
+                [key: string]: string;
+            };
         };
         CheckOutcome: {
             /** @constant */
@@ -1069,6 +1072,7 @@ export interface components {
                     field: string;
                     value: string;
                 };
+                capabilities?: string[];
             }[];
             afterConnect: {
                 title: string;
@@ -1102,6 +1106,7 @@ export interface components {
                     field: string;
                     value: string;
                 };
+                capabilities?: string[];
             }[];
             fields: {
                 id: string;
@@ -1119,6 +1124,8 @@ export interface components {
                     field: string;
                     value: string;
                 };
+                /** @default false */
+                optional: boolean;
             }[];
             capabilities: {
                 id: string;
@@ -1216,6 +1223,7 @@ export interface components {
                 path: string;
                 label: string;
                 show: string;
+                name?: string;
                 match?: {
                     [key: string]: string | number | boolean;
                 };
@@ -1235,6 +1243,7 @@ export interface components {
                 path: string;
                 label: string;
                 show: string;
+                name?: string;
                 match?: {
                     [key: string]: string | number | boolean;
                 };
@@ -1690,10 +1699,7 @@ export interface components {
                     deliveryId: string[];
                     types: {
                         type: string;
-                        same?: [
-                            string,
-                            string
-                        ];
+                        since?: string;
                     }[];
                 };
             };

package/lib/steps.d.ts

@@ -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,13 +351,18 @@ export declare function newKeySetup(ticked: Connector[], providers: Provider[]):
             path: string;
             label: string;
             show: string;
+            name?: string;
             match?: {
                 [key: string]: string | number | boolean;
             };
             body?: {
                 [key: string]: unknown;
             };
-            ifEmpty?: string;
+            ifEmpty
+            /** A step whose text fills in a value saved at another step waits until it is saved: its
+             *  words would show the raw {name} and its commands would not run. */
+            ? /** A step whose text fills in a value saved at another step waits until it is saved: its
+             *  words would show the raw {name} and its commands would not run. */: string;
         } | {
             label: string;
             check: string;
@@ -357,6 +373,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 +729,7 @@ export declare function newKeySetup(ticked: Connector[], providers: Provider[]):
                 deliveryId: string[];
                 types: {
                     type: string;
-                    same?: [string, string];
+                    since?: string;
                 }[];
             };
         };
@@ -790,6 +807,7 @@ export declare function newKeySetup(ticked: Connector[], providers: Provider[]):
                 field: string;
                 value: string;
             };
+            capabilities?: string[];
         }[];
         afterConnect: {
             title: string;
@@ -819,6 +837,7 @@ export declare function newKeySetup(ticked: Connector[], providers: Provider[]):
                 field: string;
                 value: string;
             };
+            capabilities?: string[];
         }[];
         fields: {
             id: string;
@@ -836,6 +855,7 @@ export declare function newKeySetup(ticked: Connector[], providers: Provider[]):
                 field: string;
                 value: string;
             };
+            optional: boolean;
         }[];
         capabilities: {
             id: string;
@@ -919,13 +939,18 @@ export declare function newKeySetup(ticked: Connector[], providers: Provider[]):
             path: string;
             label: string;
             show: string;
+            name?: string;
             match?: {
                 [key: string]: string | number | boolean;
             };
             body?: {
                 [key: string]: unknown;
             };
-            ifEmpty?: string;
+            ifEmpty
+            /** A step whose text fills in a value saved at another step waits until it is saved: its
+             *  words would show the raw {name} and its commands would not run. */
+            ? /** A step whose text fills in a value saved at another step waits until it is saved: its
+             *  words would show the raw {name} and its commands would not run. */: string;
         } | {
             label: string;
             check: string;
@@ -936,6 +961,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 +1317,7 @@ export declare function newKeySetup(ticked: Connector[], providers: Provider[]):
                 deliveryId: string[];
                 types: {
                     type: string;
-                    same?: [string, string];
+                    since?: string;
                 }[];
             };
         };

package/lib/steps.js

@@ -37,10 +37,13 @@ export const askedFields = (fields, values) => {
     const chosen = choiceValues({ fields }, values);
     return fields.filter((f) => isChosen(f.requires, chosen));
 };
-/** The steps that apply under the chosen options (a step with `option` only while chosen). */
-export function chosenSteps(connector, steps, values) {
+/** 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 function chosenSteps(connector, steps, values, ticked) {
     const chosen = choiceValues(connector, values);
-    return steps.filter((s) => isChosen(s.option, chosen));
+    return steps.filter((s) => isChosen(s.option, chosen) &&
+        (!ticked || !s.capabilities || s.capabilities.some((c) => ticked.includes(c))));
 }
 /** 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. */
@@ -83,9 +86,15 @@ export function keysUsing(agents, connectorId) {
 }
 /** The values a connected app reported for its discover probe, e.g. Jira project keys. */
 export function discovered(connector, checks) {
+    return discoveredChoices(connector, checks).map((c) => c.value);
+}
+/** 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 function discoveredChoices(connector, checks) {
     if (!connector.discover || !checks)
         return [];
-    return checks.find((c) => c.label === connector.discover.label)?.values ?? [];
+    const check = checks.find((c) => c.label === connector.discover.label);
+    return (check?.values ?? []).map((value) => ({ value, label: check?.labels?.[value] ?? value }));
 }
 /** Parses free-typed list input ("KAN, SAM1") into values. */
 export function splitList(raw) {
@@ -505,8 +514,8 @@ const numbered = (ns) => ns.length === 1
     : `steps ${ns.slice(0, -1).join(", ")} and ${ns[ns.length - 1]}`;
 export function appSteps(input) {
     const { connector, connection, health, ceiling, marks } = input;
-    const setup = chosenSteps(connector, connector.setup, input.choices ?? {});
-    const afterConnect = chosenSteps(connector, connector.afterConnect, input.choices ?? {});
+    const setup = chosenSteps(connector, connector.setup, input.choices ?? {}, ceiling);
+    const afterConnect = chosenSteps(connector, connector.afterConnect, input.choices ?? {}, ceiling);
     const on = connection !== null;
     const changed = on && connection.capabilities.join(",") !== ceiling.join(",");
     const before = input.providerReady ? {} : { locked: true };

package/lib/types.d.ts

@@ -51,7 +51,7 @@ export type Step = Connector["setup"][number];
 export type AgentStep = Provider["addAgent"][number];
 export type Setting = NonNullable<Step["settings"]>[number];
 export type ChosenOption = NonNullable<Step["option"]>;
-/** A connect form field; a provider's may be left empty (`optional`). */
+/** A connect form field; an `optional` one may be left empty. */
 export type Field = Connector["fields"][number] & {
     optional?: boolean;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arbium/enterprise-agent-connect-client",
-  "version": "0.1.2-dev.d2aa5ca",
+  "version": "0.2.0",
   "description": "Typed client for the Agent Connect admin API (v1), and the pure logic admin pages share",
   "type": "module",
   "exports": {