@executor-js/plugin-openapi 1.4.33 → 1.5.0

package/dist/react/atoms.d.ts

@@ -1,118 +1,67 @@
-import type { ScopeId } from "@executor-js/sdk/shared";
+import type { IntegrationSlug } from "@executor-js/sdk/shared";
 import * as Atom from "effect/unstable/reactivity/Atom";
-import * as AsyncResult from "effect/unstable/reactivity/AsyncResult";
-export declare const openApiSourceAtom: (scopeId: ScopeId, namespace: string) => Atom.Atom<AsyncResult.AsyncResult<{
-    readonly name: string;
-    readonly scope: string;
-    readonly namespace: string;
-    readonly config: {
+export declare const openApiIntegrationAtom: (slug: IntegrationSlug) => Atom.Atom<import("effect/unstable/reactivity/AsyncResult").AsyncResult<{
+    readonly slug: string & import("effect/Brand").Brand<"IntegrationSlug">;
+    readonly description: string;
+    readonly kind: string;
+    readonly canRemove: boolean;
+    readonly canRefresh: boolean;
+} | null, import("@executor-js/sdk").IntegrationAlreadyExistsError | import("@executor-js/sdk").InternalError | import("../sdk").OpenApiParseError | import("../sdk").OpenApiExtractionError | import("../sdk").OpenApiOAuthError>>;
+export declare const openApiConfigAtom: (slug: IntegrationSlug) => Atom.Atom<import("effect/unstable/reactivity/AsyncResult").AsyncResult<{
+    readonly spec: string;
+    readonly headers?: {
+        readonly [x: string]: string;
+    } | undefined;
+    readonly baseUrl?: string | undefined;
+    readonly queryParams?: {
+        readonly [x: string]: string;
+    } | undefined;
+    readonly sourceUrl?: string | undefined;
+    readonly googleDiscoveryUrls?: readonly string[] | undefined;
+    readonly authenticationTemplate?: readonly ({
+        readonly type: "apiKey";
+        readonly slug: string;
         readonly headers?: {
-            readonly [x: string]: string | {
-                readonly kind: "binding";
-                readonly slot: string;
-                readonly prefix?: string | undefined;
-            };
-        } | undefined;
-        readonly namespace?: string | undefined;
-        readonly oauth2?: {
-            readonly kind: "oauth2";
-            readonly scopes: readonly string[];
-            readonly clientSecretSlot: string | null;
-            readonly securitySchemeName: string;
-            readonly flow: "authorizationCode" | "clientCredentials";
-            readonly tokenUrl: string;
-            readonly clientIdSlot: string;
-            readonly connectionSlot: string;
-            readonly issuerUrl?: string | null | undefined;
-            readonly authorizationUrl?: string | null | undefined;
+            readonly [x: string]: string | readonly (string | {
+                readonly name: string;
+                readonly type: "variable";
+            })[];
         } | undefined;
         readonly queryParams?: {
-            readonly [x: string]: string | {
-                readonly kind: "binding";
-                readonly slot: string;
-                readonly prefix?: string | undefined;
-            };
-        } | undefined;
-        readonly baseUrl?: string | undefined;
-        readonly spec?: string | undefined;
-        readonly sourceUrl?: string | undefined;
-        readonly specFetchCredentials?: {
-            readonly headers?: {
-                readonly [x: string]: string | {
-                    readonly kind: "binding";
-                    readonly slot: string;
-                    readonly prefix?: string | undefined;
-                };
-            } | undefined;
-            readonly queryParams?: {
-                readonly [x: string]: string | {
-                    readonly kind: "binding";
-                    readonly slot: string;
-                    readonly prefix?: string | undefined;
-                };
-            } | undefined;
+            readonly [x: string]: string | readonly (string | {
+                readonly name: string;
+                readonly type: "variable";
+            })[];
         } | undefined;
-    };
-} | null, import("@executor-js/sdk").InternalError | import("../sdk").OpenApiParseError | import("../sdk").OpenApiExtractionError | import("../sdk").OpenApiOAuthError>>;
-export declare const openApiSourceBindingsAtom: (scopeId: ScopeId, namespace: string, sourceScopeId: ScopeId) => Atom.Atom<AsyncResult.AsyncResult<{
-    slot: string;
-    value: {
-        readonly text: string;
-        readonly kind: "text";
     } | {
-        readonly secretId: string & import("effect/Brand").Brand<"SecretId">;
-        readonly kind: "secret";
-        readonly secretScopeId?: (string & import("effect/Brand").Brand<"ScopeId">) | undefined;
-    } | {
-        readonly connectionId: string & import("effect/Brand").Brand<"ConnectionId">;
-        readonly kind: "connection";
-    };
-    id: string & import("effect/Brand").Brand<"CredentialBindingId">;
-    scopeId: string & import("effect/Brand").Brand<"ScopeId">;
-    createdAt: Date;
-    updatedAt: Date;
-    pluginId: string;
-    sourceId: string;
-    sourceScopeId: string & import("effect/Brand").Brand<"ScopeId">;
-    slotKey: string;
-}[], import("@executor-js/sdk").InternalError>>;
+        readonly type: "oauth";
+        readonly slug: string;
+        readonly authorizationUrl: string;
+        readonly tokenUrl: string;
+        readonly scopes: readonly string[];
+    })[] | undefined;
+} | null, import("@executor-js/sdk").IntegrationAlreadyExistsError | import("@executor-js/sdk").InternalError | import("../sdk").OpenApiParseError | import("../sdk").OpenApiExtractionError | import("../sdk").OpenApiOAuthError>>;
 export declare const previewOpenApiSpec: Atom.AtomResultFn<{
-    readonly params: {
-        readonly scopeId: string & import("effect/Brand").Brand<"ScopeId">;
-    };
     readonly payload: {
         readonly spec: string;
-        readonly specFetchCredentials?: {
-            readonly headers?: {
-                readonly [x: string]: string | {
-                    readonly secretId: string;
-                    readonly prefix?: string | undefined;
-                };
-            } | undefined;
-            readonly queryParams?: {
-                readonly [x: string]: string | {
-                    readonly secretId: string;
-                    readonly prefix?: string | undefined;
-                };
-            } | undefined;
-        } | undefined;
     };
     readonly responseMode?: "decoded-only" | undefined;
     readonly reactivityKeys?: readonly unknown[] | import("effect/Record").ReadonlyRecord<string, readonly unknown[]> | undefined;
 }, {
     readonly version: import("effect/Option").Option<string>;
     readonly operations: readonly {
-        readonly summary: import("effect/Option").Option<string>;
-        readonly method: "post" | "options" | "delete" | "get" | "put" | "head" | "patch" | "trace";
+        readonly method: "post" | "options" | "delete" | "get" | "put" | "patch" | "head" | "trace";
         readonly deprecated: boolean;
         readonly path: string;
+        readonly summary: import("effect/Option").Option<string>;
         readonly tags: readonly string[];
         readonly operationId: string;
     }[];
     readonly title: import("effect/Option").Option<string>;
+    readonly tags: readonly string[];
     readonly servers: readonly {
-        readonly url: string;
         readonly description: import("effect/Option").Option<string>;
+        readonly url: string;
         readonly variables: import("effect/Option").Option<{
             readonly [x: string]: {
                 readonly default: string;
@@ -121,29 +70,28 @@ export declare const previewOpenApiSpec: Atom.AtomResultFn<{
             };
         }>;
     }[];
-    readonly tags: readonly string[];
     readonly securitySchemes: readonly {
         readonly name: string;
         readonly type: "oauth2" | "http" | "apiKey" | "openIdConnect";
-        readonly in: import("effect/Option").Option<"query" | "header" | "cookie">;
+        readonly in: import("effect/Option").Option<"header" | "query" | "cookie">;
         readonly description: import("effect/Option").Option<string>;
-        readonly headerName: import("effect/Option").Option<string>;
         readonly scheme: import("effect/Option").Option<string>;
         readonly bearerFormat: import("effect/Option").Option<string>;
+        readonly headerName: import("effect/Option").Option<string>;
         readonly flows: import("effect/Option").Option<{
             readonly authorizationCode: import("effect/Option").Option<{
+                readonly authorizationUrl: string;
+                readonly tokenUrl: string;
                 readonly scopes: {
                     readonly [x: string]: string;
                 };
-                readonly authorizationUrl: string;
-                readonly tokenUrl: string;
                 readonly refreshUrl: import("effect/Option").Option<string>;
             }>;
             readonly clientCredentials: import("effect/Option").Option<{
+                readonly tokenUrl: string;
                 readonly scopes: {
                     readonly [x: string]: string;
                 };
-                readonly tokenUrl: string;
                 readonly refreshUrl: import("effect/Option").Option<string>;
             }>;
         }>;
@@ -153,142 +101,179 @@ export declare const previewOpenApiSpec: Atom.AtomResultFn<{
         readonly schemes: readonly string[];
     }[];
     readonly headerPresets: readonly {
+        readonly label: string;
         readonly headers: {
             readonly [x: string]: string | null;
         };
         readonly secretHeaders: readonly string[];
-        readonly label: string;
     }[];
     readonly oauth2Presets: readonly {
+        readonly label: string;
+        readonly authorizationUrl: import("effect/Option").Option<string>;
+        readonly tokenUrl: string;
         readonly scopes: {
             readonly [x: string]: string;
         };
-        readonly authorizationUrl: import("effect/Option").Option<string>;
-        readonly securitySchemeName: string;
-        readonly flow: "authorizationCode" | "clientCredentials";
-        readonly tokenUrl: string;
         readonly refreshUrl: import("effect/Option").Option<string>;
-        readonly label: string;
+        readonly flow: "authorizationCode" | "clientCredentials";
+        readonly identityScopes: false | "auto" | readonly string[];
+        readonly securitySchemeName: string;
     }[];
     readonly operationCount: number;
-}, import("@executor-js/sdk").InternalError | import("../sdk").OpenApiParseError | import("../sdk").OpenApiExtractionError | import("../sdk").OpenApiOAuthError>;
+}, import("@executor-js/sdk").IntegrationAlreadyExistsError | import("@executor-js/sdk").InternalError | import("../sdk").OpenApiParseError | import("../sdk").OpenApiExtractionError | import("../sdk").OpenApiOAuthError>;
 export declare const addOpenApiSpec: Atom.AtomResultFn<{
-    readonly params: {
-        readonly scopeId: string & import("effect/Brand").Brand<"ScopeId">;
-    };
     readonly payload: {
-        readonly name: string;
-        readonly namespace: string;
-        readonly baseUrl: string;
+        readonly slug: string;
         readonly spec: {
             readonly kind: "url";
             readonly url: string;
         } | {
             readonly value: string;
             readonly kind: "blob";
+        } | {
+            readonly kind: "googleDiscovery";
+            readonly url: string;
+        } | {
+            readonly kind: "googleDiscoveryBundle";
+            readonly urls: readonly string[];
         };
+        readonly description?: string | undefined;
         readonly headers?: {
-            readonly [x: string]: string | {
-                readonly kind: "secret";
-                readonly prefix?: string | undefined;
-            };
-        } | undefined;
-        readonly oauth2?: {
-            readonly kind: "oauth2";
-            readonly scopes: readonly string[];
-            readonly clientSecretSlot: string | null;
-            readonly securitySchemeName: string;
-            readonly flow: "authorizationCode" | "clientCredentials";
-            readonly tokenUrl: string;
-            readonly clientIdSlot: string;
-            readonly connectionSlot: string;
-            readonly issuerUrl?: string | null | undefined;
-            readonly authorizationUrl?: string | null | undefined;
+            readonly [x: string]: string;
         } | undefined;
+        readonly baseUrl?: string | undefined;
         readonly queryParams?: {
-            readonly [x: string]: string | {
-                readonly kind: "secret";
-                readonly prefix?: string | undefined;
-            };
+            readonly [x: string]: string;
         } | undefined;
-        readonly specFetchCredentials?: {
+        readonly authenticationTemplate?: readonly ({
+            readonly type: "apiKey";
+            readonly slug: string;
             readonly headers?: {
-                readonly [x: string]: string | {
-                    readonly kind: "secret";
-                    readonly prefix?: string | undefined;
-                };
+                readonly [x: string]: string | readonly (string | {
+                    readonly name: string;
+                    readonly type: "variable";
+                })[];
             } | undefined;
             readonly queryParams?: {
-                readonly [x: string]: string | {
-                    readonly kind: "secret";
-                    readonly prefix?: string | undefined;
-                };
+                readonly [x: string]: string | readonly (string | {
+                    readonly name: string;
+                    readonly type: "variable";
+                })[];
             } | undefined;
-        } | undefined;
+        } | {
+            readonly type: "oauth";
+            readonly slug: string;
+            readonly authorizationUrl: string;
+            readonly tokenUrl: string;
+            readonly scopes: readonly string[];
+        })[] | undefined;
     };
     readonly responseMode?: "decoded-only" | undefined;
     readonly reactivityKeys?: readonly unknown[] | import("effect/Record").ReadonlyRecord<string, readonly unknown[]> | undefined;
 }, {
-    readonly namespace: string;
+    readonly slug: string & import("effect/Brand").Brand<"IntegrationSlug">;
     readonly toolCount: number;
-}, import("@executor-js/sdk").InternalError | import("../sdk").OpenApiParseError | import("../sdk").OpenApiExtractionError | import("../sdk").OpenApiOAuthError>;
-export declare const addOpenApiSpecOptimistic: (arg: string & import("effect/Brand").Brand<"ScopeId">) => Atom.AtomResultFn<{
+}, import("@executor-js/sdk").IntegrationAlreadyExistsError | import("@executor-js/sdk").InternalError | import("../sdk").OpenApiParseError | import("../sdk").OpenApiExtractionError | import("../sdk").OpenApiOAuthError>;
+export declare const removeOpenApiSpec: Atom.AtomResultFn<{
     readonly params: {
-        readonly scopeId: string & import("effect/Brand").Brand<"ScopeId">;
+        readonly slug: string;
+    };
+    readonly responseMode?: "decoded-only" | undefined;
+    readonly reactivityKeys?: readonly unknown[] | import("effect/Record").ReadonlyRecord<string, readonly unknown[]> | undefined;
+}, void, import("@executor-js/sdk").IntegrationAlreadyExistsError | import("@executor-js/sdk").InternalError | import("../sdk").OpenApiParseError | import("../sdk").OpenApiExtractionError | import("../sdk").OpenApiOAuthError>;
+export declare const openapiConfigure: Atom.AtomResultFn<{
+    readonly params: {
+        readonly slug: string;
     };
     readonly payload: {
-        readonly name: string;
-        readonly namespace: string;
-        readonly baseUrl: string;
-        readonly spec: {
-            readonly kind: "url";
-            readonly url: string;
-        } | {
-            readonly value: string;
-            readonly kind: "blob";
-        };
-        readonly headers?: {
-            readonly [x: string]: string | {
-                readonly kind: "secret";
-                readonly prefix?: string | undefined;
-            };
-        } | undefined;
-        readonly oauth2?: {
-            readonly kind: "oauth2";
-            readonly scopes: readonly string[];
-            readonly clientSecretSlot: string | null;
-            readonly securitySchemeName: string;
-            readonly flow: "authorizationCode" | "clientCredentials";
-            readonly tokenUrl: string;
-            readonly clientIdSlot: string;
-            readonly connectionSlot: string;
-            readonly issuerUrl?: string | null | undefined;
-            readonly authorizationUrl?: string | null | undefined;
-        } | undefined;
-        readonly queryParams?: {
-            readonly [x: string]: string | {
-                readonly kind: "secret";
-                readonly prefix?: string | undefined;
-            };
-        } | undefined;
-        readonly specFetchCredentials?: {
+        readonly authenticationTemplate: readonly ({
+            readonly type: "apiKey";
+            readonly slug: string;
             readonly headers?: {
-                readonly [x: string]: string | {
-                    readonly kind: "secret";
-                    readonly prefix?: string | undefined;
-                };
+                readonly [x: string]: string | readonly (string | {
+                    readonly name: string;
+                    readonly type: "variable";
+                })[];
             } | undefined;
             readonly queryParams?: {
-                readonly [x: string]: string | {
-                    readonly kind: "secret";
-                    readonly prefix?: string | undefined;
-                };
+                readonly [x: string]: string | readonly (string | {
+                    readonly name: string;
+                    readonly type: "variable";
+                })[];
             } | undefined;
-        } | undefined;
+        } | {
+            readonly type: "oauth";
+            readonly slug: string;
+            readonly authorizationUrl: string;
+            readonly tokenUrl: string;
+            readonly scopes: readonly string[];
+        })[];
+        readonly mode?: "replace" | "merge" | undefined;
     };
     readonly responseMode?: "decoded-only" | undefined;
     readonly reactivityKeys?: readonly unknown[] | import("effect/Record").ReadonlyRecord<string, readonly unknown[]> | undefined;
 }, {
-    readonly namespace: string;
-    readonly toolCount: number;
-}, import("@executor-js/sdk").InternalError | import("../sdk").OpenApiParseError | import("../sdk").OpenApiExtractionError | import("../sdk").OpenApiOAuthError>;
+    readonly authenticationTemplate: readonly ({
+        readonly type: "apiKey";
+        readonly slug: string;
+        readonly headers?: {
+            readonly [x: string]: string | readonly (string | {
+                readonly name: string;
+                readonly type: "variable";
+            })[];
+        } | undefined;
+        readonly queryParams?: {
+            readonly [x: string]: string | readonly (string | {
+                readonly name: string;
+                readonly type: "variable";
+            })[];
+        } | undefined;
+    } | {
+        readonly type: "oauth";
+        readonly slug: string;
+        readonly authorizationUrl: string;
+        readonly tokenUrl: string;
+        readonly scopes: readonly string[];
+    })[];
+}, import("@executor-js/sdk").IntegrationAlreadyExistsError | import("@executor-js/sdk").InternalError | import("../sdk").OpenApiParseError | import("../sdk").OpenApiExtractionError | import("../sdk").OpenApiOAuthError>;
+export declare const openApiIntegrationFamily: (arg: string & import("effect/Brand").Brand<"IntegrationSlug">) => Atom.Atom<import("effect/unstable/reactivity/AsyncResult").AsyncResult<{
+    readonly slug: string & import("effect/Brand").Brand<"IntegrationSlug">;
+    readonly description: string;
+    readonly kind: string;
+    readonly canRemove: boolean;
+    readonly canRefresh: boolean;
+} | null, import("@executor-js/sdk").IntegrationAlreadyExistsError | import("@executor-js/sdk").InternalError | import("../sdk").OpenApiParseError | import("../sdk").OpenApiExtractionError | import("../sdk").OpenApiOAuthError>>;
+export declare const openApiConfigFamily: (arg: string & import("effect/Brand").Brand<"IntegrationSlug">) => Atom.Atom<import("effect/unstable/reactivity/AsyncResult").AsyncResult<{
+    readonly spec: string;
+    readonly headers?: {
+        readonly [x: string]: string;
+    } | undefined;
+    readonly baseUrl?: string | undefined;
+    readonly queryParams?: {
+        readonly [x: string]: string;
+    } | undefined;
+    readonly sourceUrl?: string | undefined;
+    readonly googleDiscoveryUrls?: readonly string[] | undefined;
+    readonly authenticationTemplate?: readonly ({
+        readonly type: "apiKey";
+        readonly slug: string;
+        readonly headers?: {
+            readonly [x: string]: string | readonly (string | {
+                readonly name: string;
+                readonly type: "variable";
+            })[];
+        } | undefined;
+        readonly queryParams?: {
+            readonly [x: string]: string | readonly (string | {
+                readonly name: string;
+                readonly type: "variable";
+            })[];
+        } | undefined;
+    } | {
+        readonly type: "oauth";
+        readonly slug: string;
+        readonly authorizationUrl: string;
+        readonly tokenUrl: string;
+        readonly scopes: readonly string[];
+    })[] | undefined;
+} | null, import("@executor-js/sdk").IntegrationAlreadyExistsError | import("@executor-js/sdk").InternalError | import("../sdk").OpenApiParseError | import("../sdk").OpenApiExtractionError | import("../sdk").OpenApiOAuthError>>;

package/dist/react/auth-method-config.d.ts

@@ -0,0 +1,15 @@
+import type { AuthMethod, Placement } from "@executor-js/react/lib/auth-placements";
+import type { AuthTemplateEditorValue } from "@executor-js/react/components/auth-template-editor";
+import { type APIKeyAuthentication, type Authentication } from "../sdk/types";
+export declare const placementsFromApiKey: (template: APIKeyAuthentication) => Placement[];
+/** Map each stored auth template to a generic `AuthMethod`. */
+export declare function authMethodsFromConfig(templates: readonly Authentication[]): AuthMethod[];
+/** Build an `APIKeyAuthentication` template from generic placements. When
+ *  `slug` is omitted the backend assigns a `custom_<id>` slug. */
+export declare function templateFromPlacements(placements: readonly Placement[], slug?: string): APIKeyAuthentication;
+/** Convert one stored `Authentication` template into a generic editor value. */
+export declare function editorValueFromAuthentication(template: Authentication): AuthTemplateEditorValue;
+/** Convert one generic editor value back into a stored `Authentication`, or
+ *  `null` for `none` (no method to register). The optional `slug` names the
+ *  template; when omitted the backend backfills `custom_<id>`. */
+export declare function authenticationFromEditorValue(value: AuthTemplateEditorValue, slug?: string): Authentication | null;