@executor-js/plugin-openapi 0.0.2 → 0.2.1

package/dist/sdk/openapi-utils.d.ts

@@ -1,5 +1,6 @@
 import type { OpenAPIV3, OpenAPIV3_1 } from "openapi-types";
 import type { ParsedDocument } from "./parse";
+import type { ServerVariable } from "./types";
 export type ParameterObject = OpenAPIV3.ParameterObject | OpenAPIV3_1.ParameterObject;
 export type OperationObject = OpenAPIV3.OperationObject | OpenAPIV3_1.OperationObject;
 export type PathItemObject = OpenAPIV3.PathItemObject | OpenAPIV3_1.PathItemObject;
@@ -15,12 +16,12 @@ export declare class DocResolver {
 }
 /** Substitute `{var}` placeholders in a templated URL using a plain map. */
 export declare const substituteUrlVariables: (url: string, values: Record<string, string>) => string;
+export declare const OPENAPI_MAX_SERVER_VARIABLE_OPTIONS = 64;
 type ServerLike = {
     url: string;
-    variables: import("effect/Option").Option<Record<string, {
-        default: string;
-    } | string>>;
+    variables: import("effect/Option").Option<Record<string, ServerVariable | string>>;
 };
+export declare const expandServerUrlOptions: (server: ServerLike, limit?: number) => readonly string[];
 export declare const resolveBaseUrl: (servers: readonly ServerLike[]) => string;
 /**
  * Return all declared media entries in spec order. `Object.entries` on a

package/dist/sdk/parse.d.ts

@@ -14,7 +14,7 @@ declare class OpenApiExtractionErrorFromParse extends OpenApiExtractionError {
  * HttpClient so the caller chooses the transport via layer — in Cloudflare
  * Workers, `FetchHttpClient.layer` binds to the Workers-native `fetch` and
  * avoids json-schema-ref-parser's Node-polyfill http resolver, which hangs
- * in production. Bounded by a 20s timeout.
+ * in production. Bounded by a 60s timeout.
  */
 export declare const fetchSpecText: (url: string, credentials?: SpecFetchCredentials | undefined) => Effect.Effect<string, OpenApiParseError, HttpClient.HttpClient>;
 /**

package/dist/sdk/parse.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/sdk/plugin.d.ts

@@ -1,27 +1,28 @@
 import { Effect } from "effect";
-import { HttpClient } from "effect/unstable/http";
 import type { Layer } from "effect";
+import { HttpClient } from "effect/unstable/http";
 import { type StorageFailure } from "@executor-js/sdk/core";
 import { type ConfigFileSink } from "@executor-js/config";
 import { OpenApiExtractionError, OpenApiOAuthError, OpenApiParseError } from "./errors";
 import { SpecPreview } from "./preview";
-import { type OpenapiStore, type StoredSource } from "./store";
-import { OAuth2Auth, OAuth2SourceConfig, OpenApiSourceBindingInput, type OpenApiSourceBindingRef, type ConfiguredHeaderValue as ConfiguredHeaderValueValue, type HeaderValue as HeaderValueValue } from "./types";
+import { type OpenapiStore, type SourceConfig, type StoredSource } from "./store";
+import { OAuth2SourceConfig, OpenApiSourceBindingInput, OpenApiSourceBindingRef, type OpenApiCredentialInput as OpenApiCredentialInputValue, type ConfiguredHeaderValue as ConfiguredHeaderValueValue, type HeaderValue as HeaderValueValue } from "./types";
 export type HeaderValue = HeaderValueValue;
 export type ConfiguredHeaderValue = ConfiguredHeaderValueValue;
 export type OpenApiHeaderInput = HeaderValue | ConfiguredHeaderValue;
-export type OpenApiOAuthInput = OAuth2Auth | OAuth2SourceConfig;
-export interface OpenApiSpecFetchCredentials {
+export type OpenApiCredentialInput = OpenApiCredentialInputValue;
+export type OpenApiOAuthInput = OAuth2SourceConfig;
+export interface OpenApiSpecFetchCredentialsInput {
     readonly headers?: Record<string, HeaderValue>;
     readonly queryParams?: Record<string, HeaderValue>;
 }
 export interface OpenApiPreviewInput {
     readonly spec: string;
-    readonly specFetchCredentials?: OpenApiSpecFetchCredentials;
+    readonly specFetchCredentials?: OpenApiSpecFetchCredentialsInput;
 }
 export interface OpenApiSpecConfig {
     readonly spec: string;
-    readonly specFetchCredentials?: OpenApiSpecFetchCredentials;
+    readonly specFetchCredentials?: OpenApiSpecFetchCredentialsInput;
     /**
      * Executor scope id that owns this source row. Must be one of the
      * executor's configured scopes. Typical shape: an admin adds the
@@ -32,15 +33,17 @@ export interface OpenApiSpecConfig {
     readonly name?: string;
     readonly baseUrl?: string;
     readonly namespace?: string;
-    readonly headers?: Record<string, OpenApiHeaderInput>;
-    readonly queryParams?: Record<string, HeaderValue>;
+    readonly headers?: Record<string, OpenApiCredentialInput>;
+    readonly queryParams?: Record<string, OpenApiCredentialInput>;
     readonly oauth2?: OpenApiOAuthInput;
+    readonly credentialTargetScope?: string;
 }
 export interface OpenApiUpdateSourceInput {
     readonly name?: string;
     readonly baseUrl?: string;
-    readonly headers?: Record<string, OpenApiHeaderInput>;
-    readonly queryParams?: Record<string, HeaderValue>;
+    readonly headers?: Record<string, OpenApiCredentialInput>;
+    readonly queryParams?: Record<string, OpenApiCredentialInput>;
+    readonly credentialTargetScope?: string;
     /** Refresh the source's stored OAuth2 metadata after a successful
      *  re-authenticate. */
     readonly oauth2?: OpenApiOAuthInput;
@@ -75,7 +78,24 @@ export interface OpenApiPluginOptions {
      *  (best-effort — file errors are logged, not raised). */
     readonly configFile?: ConfigFileSink;
 }
-export declare const openApiPlugin: import("@executor-js/sdk/core").ConfiguredPlugin<"openapi", OpenApiPluginExtension, OpenapiStore, OpenApiPluginOptions, {
+export declare const openApiPlugin: import("@executor-js/sdk/core").ConfiguredPlugin<"openapi", {
+    previewSpec: (input: string | OpenApiPreviewInput) => Effect.Effect<SpecPreview, StorageFailure | OpenApiParseError | OpenApiExtractionError | OpenApiOAuthError, never>;
+    addSpec: (config: OpenApiSpecConfig) => Effect.Effect<{
+        sourceId: string;
+        toolCount: number;
+    }, StorageFailure | OpenApiParseError | OpenApiExtractionError | OpenApiOAuthError, never>;
+    removeSpec: (namespace: string, scope: string) => Effect.Effect<void, StorageFailure, never>;
+    getSource: (namespace: string, scope: string) => Effect.Effect<{
+        config: SourceConfig;
+        namespace: string;
+        scope: string;
+        name: string;
+    } | null, StorageFailure, never>;
+    updateSource: (namespace: string, scope: string, input: OpenApiUpdateSourceInput) => Effect.Effect<undefined, StorageFailure | OpenApiOAuthError, never>;
+    listSourceBindings: (sourceId: string, sourceScope: string) => Effect.Effect<readonly OpenApiSourceBindingRef[], StorageFailure, never>;
+    setSourceBinding: (input: OpenApiSourceBindingInput) => Effect.Effect<OpenApiSourceBindingRef, StorageFailure, never>;
+    removeSourceBinding: (sourceId: string, sourceScope: string, slot: string, scope: string) => Effect.Effect<void, StorageFailure, never>;
+}, OpenapiStore, OpenApiPluginOptions, {
     readonly openapi_source: {
         readonly fields: {
             readonly id: {
@@ -103,25 +123,35 @@ export declare const openApiPlugin: import("@executor-js/sdk/core").ConfiguredPl
                 readonly type: "string";
                 readonly required: false;
             };
-            readonly headers: {
+            readonly oauth2: {
                 readonly type: "json";
                 readonly required: false;
             };
-            readonly query_params: {
-                readonly type: "json";
-                readonly required: false;
+        };
+    };
+    readonly openapi_operation: {
+        readonly fields: {
+            readonly id: {
+                readonly type: "string";
+                readonly required: true;
             };
-            readonly oauth2: {
-                readonly type: "json";
-                readonly required: false;
+            readonly scope_id: {
+                readonly type: "string";
+                readonly required: true;
+                readonly index: true;
             };
-            readonly invocation_config: {
+            readonly source_id: {
+                readonly type: "string";
+                readonly required: true;
+                readonly index: true;
+            };
+            readonly binding: {
                 readonly type: "json";
                 readonly required: true;
             };
         };
     };
-    readonly openapi_operation: {
+    readonly openapi_source_header: {
         readonly fields: {
             readonly id: {
                 readonly type: "string";
@@ -137,50 +167,140 @@ export declare const openApiPlugin: import("@executor-js/sdk/core").ConfiguredPl
                 readonly required: true;
                 readonly index: true;
             };
-            readonly binding: {
-                readonly type: "json";
+            readonly name: {
+                readonly type: "string";
                 readonly required: true;
             };
+            readonly kind: {
+                readonly type: ["text", "binding"];
+                readonly required: true;
+            };
+            readonly text_value: {
+                readonly type: "string";
+                readonly required: false;
+            };
+            readonly slot_key: {
+                readonly type: "string";
+                readonly required: false;
+            };
+            readonly prefix: {
+                readonly type: "string";
+                readonly required: false;
+            };
         };
     };
-    readonly openapi_source_binding: {
+    readonly openapi_source_query_param: {
         readonly fields: {
             readonly id: {
                 readonly type: "string";
                 readonly required: true;
             };
+            readonly scope_id: {
+                readonly type: "string";
+                readonly required: true;
+                readonly index: true;
+            };
             readonly source_id: {
                 readonly type: "string";
                 readonly required: true;
                 readonly index: true;
             };
-            readonly source_scope_id: {
+            readonly name: {
+                readonly type: "string";
+                readonly required: true;
+            };
+            readonly kind: {
+                readonly type: ["text", "binding"];
+                readonly required: true;
+            };
+            readonly text_value: {
+                readonly type: "string";
+                readonly required: false;
+            };
+            readonly slot_key: {
+                readonly type: "string";
+                readonly required: false;
+            };
+            readonly prefix: {
+                readonly type: "string";
+                readonly required: false;
+            };
+        };
+    };
+    readonly openapi_source_spec_fetch_header: {
+        readonly fields: {
+            readonly id: {
+                readonly type: "string";
+                readonly required: true;
+            };
+            readonly scope_id: {
                 readonly type: "string";
                 readonly required: true;
                 readonly index: true;
             };
-            readonly target_scope_id: {
+            readonly source_id: {
                 readonly type: "string";
                 readonly required: true;
                 readonly index: true;
             };
-            readonly slot: {
+            readonly name: {
+                readonly type: "string";
+                readonly required: true;
+            };
+            readonly kind: {
+                readonly type: ["text", "binding"];
+                readonly required: true;
+            };
+            readonly text_value: {
+                readonly type: "string";
+                readonly required: false;
+            };
+            readonly slot_key: {
+                readonly type: "string";
+                readonly required: false;
+            };
+            readonly prefix: {
+                readonly type: "string";
+                readonly required: false;
+            };
+        };
+    };
+    readonly openapi_source_spec_fetch_query_param: {
+        readonly fields: {
+            readonly id: {
+                readonly type: "string";
+                readonly required: true;
+            };
+            readonly scope_id: {
                 readonly type: "string";
                 readonly required: true;
                 readonly index: true;
             };
-            readonly value: {
-                readonly type: "json";
+            readonly source_id: {
+                readonly type: "string";
                 readonly required: true;
+                readonly index: true;
             };
-            readonly created_at: {
-                readonly type: "date";
+            readonly name: {
+                readonly type: "string";
                 readonly required: true;
             };
-            readonly updated_at: {
-                readonly type: "date";
+            readonly kind: {
+                readonly type: ["text", "binding"];
                 readonly required: true;
             };
+            readonly text_value: {
+                readonly type: "string";
+                readonly required: false;
+            };
+            readonly slot_key: {
+                readonly type: "string";
+                readonly required: false;
+            };
+            readonly prefix: {
+                readonly type: "string";
+                readonly required: false;
+            };
         };
     };
-}>;
+}, undefined, Layer.Layer<unknown, never, never>, import("effect/unstable/httpapi/HttpApiGroup").Any>;

package/dist/sdk/store.d.ts

@@ -1,6 +1,6 @@
 import { Effect, Schema } from "effect";
 import { type StorageDeps, type StorageFailure } from "@executor-js/sdk/core";
-import { ConfiguredHeaderValue, ConfiguredHeaderBinding, HeaderValue, OAuth2Auth, OAuth2SourceConfig, OpenApiSourceBindingInput, OpenApiSourceBindingRef, OperationBinding } from "./types";
+import { ConfiguredHeaderValue, ConfiguredHeaderBinding, OAuth2SourceConfig, OperationBinding } from "./types";
 export declare const openapiSchema: {
     readonly openapi_source: {
         readonly fields: {
@@ -29,25 +29,35 @@ export declare const openapiSchema: {
                 readonly type: "string";
                 readonly required: false;
             };
-            readonly headers: {
+            readonly oauth2: {
                 readonly type: "json";
                 readonly required: false;
             };
-            readonly query_params: {
-                readonly type: "json";
-                readonly required: false;
+        };
+    };
+    readonly openapi_operation: {
+        readonly fields: {
+            readonly id: {
+                readonly type: "string";
+                readonly required: true;
             };
-            readonly oauth2: {
-                readonly type: "json";
-                readonly required: false;
+            readonly scope_id: {
+                readonly type: "string";
+                readonly required: true;
+                readonly index: true;
             };
-            readonly invocation_config: {
+            readonly source_id: {
+                readonly type: "string";
+                readonly required: true;
+                readonly index: true;
+            };
+            readonly binding: {
                 readonly type: "json";
                 readonly required: true;
             };
         };
     };
-    readonly openapi_operation: {
+    readonly openapi_source_header: {
         readonly fields: {
             readonly id: {
                 readonly type: "string";
@@ -63,50 +73,140 @@ export declare const openapiSchema: {
                 readonly required: true;
                 readonly index: true;
             };
-            readonly binding: {
-                readonly type: "json";
+            readonly name: {
+                readonly type: "string";
+                readonly required: true;
+            };
+            readonly kind: {
+                readonly type: ["text", "binding"];
                 readonly required: true;
             };
+            readonly text_value: {
+                readonly type: "string";
+                readonly required: false;
+            };
+            readonly slot_key: {
+                readonly type: "string";
+                readonly required: false;
+            };
+            readonly prefix: {
+                readonly type: "string";
+                readonly required: false;
+            };
         };
     };
-    readonly openapi_source_binding: {
+    readonly openapi_source_query_param: {
         readonly fields: {
             readonly id: {
                 readonly type: "string";
                 readonly required: true;
             };
+            readonly scope_id: {
+                readonly type: "string";
+                readonly required: true;
+                readonly index: true;
+            };
             readonly source_id: {
                 readonly type: "string";
                 readonly required: true;
                 readonly index: true;
             };
-            readonly source_scope_id: {
+            readonly name: {
+                readonly type: "string";
+                readonly required: true;
+            };
+            readonly kind: {
+                readonly type: ["text", "binding"];
+                readonly required: true;
+            };
+            readonly text_value: {
+                readonly type: "string";
+                readonly required: false;
+            };
+            readonly slot_key: {
+                readonly type: "string";
+                readonly required: false;
+            };
+            readonly prefix: {
+                readonly type: "string";
+                readonly required: false;
+            };
+        };
+    };
+    readonly openapi_source_spec_fetch_header: {
+        readonly fields: {
+            readonly id: {
+                readonly type: "string";
+                readonly required: true;
+            };
+            readonly scope_id: {
                 readonly type: "string";
                 readonly required: true;
                 readonly index: true;
             };
-            readonly target_scope_id: {
+            readonly source_id: {
                 readonly type: "string";
                 readonly required: true;
                 readonly index: true;
             };
-            readonly slot: {
+            readonly name: {
+                readonly type: "string";
+                readonly required: true;
+            };
+            readonly kind: {
+                readonly type: ["text", "binding"];
+                readonly required: true;
+            };
+            readonly text_value: {
+                readonly type: "string";
+                readonly required: false;
+            };
+            readonly slot_key: {
+                readonly type: "string";
+                readonly required: false;
+            };
+            readonly prefix: {
+                readonly type: "string";
+                readonly required: false;
+            };
+        };
+    };
+    readonly openapi_source_spec_fetch_query_param: {
+        readonly fields: {
+            readonly id: {
+                readonly type: "string";
+                readonly required: true;
+            };
+            readonly scope_id: {
                 readonly type: "string";
                 readonly required: true;
                 readonly index: true;
             };
-            readonly value: {
-                readonly type: "json";
+            readonly source_id: {
+                readonly type: "string";
                 readonly required: true;
+                readonly index: true;
             };
-            readonly created_at: {
-                readonly type: "date";
+            readonly name: {
+                readonly type: "string";
                 readonly required: true;
             };
-            readonly updated_at: {
-                readonly type: "date";
+            readonly kind: {
+                readonly type: ["text", "binding"];
                 readonly required: true;
             };
+            readonly text_value: {
+                readonly type: "string";
+                readonly required: false;
+            };
+            readonly slot_key: {
+                readonly type: "string";
+                readonly required: false;
+            };
+            readonly prefix: {
+                readonly type: "string";
+                readonly required: false;
+            };
         };
     };
 };
@@ -119,13 +219,13 @@ export interface SourceConfig {
     readonly baseUrl?: string;
     readonly namespace?: string;
     readonly headers?: Record<string, ConfiguredHeaderValue>;
-    readonly queryParams?: Record<string, HeaderValue>;
+    readonly queryParams?: Record<string, ConfiguredHeaderValue>;
     readonly specFetchCredentials?: OpenApiSpecFetchCredentials;
     readonly oauth2?: OAuth2SourceConfig;
 }
 export interface OpenApiSpecFetchCredentials {
-    readonly headers?: Record<string, HeaderValue>;
-    readonly queryParams?: Record<string, HeaderValue>;
+    readonly headers?: Record<string, ConfiguredHeaderValue>;
+    readonly queryParams?: Record<string, ConfiguredHeaderValue>;
 }
 export interface StoredSource {
     readonly namespace: string;
@@ -135,13 +235,10 @@ export interface StoredSource {
     readonly scope: string;
     readonly name: string;
     readonly config: SourceConfig;
-    readonly legacy?: {
-        readonly headers?: Record<string, HeaderValue>;
-        readonly oauth2?: OAuth2Auth;
-    };
 }
 declare const StoredSourceSchema_base: Schema.Class<StoredSourceSchema, Schema.Struct<{
     readonly namespace: Schema.String;
+    readonly scope: Schema.String;
     readonly name: Schema.String;
     readonly config: Schema.Struct<{
         readonly spec: Schema.String;
@@ -149,19 +246,10 @@ declare const StoredSourceSchema_base: Schema.Class<StoredSourceSchema, Schema.S
         readonly baseUrl: Schema.optional<Schema.String>;
         readonly namespace: Schema.optional<Schema.String>;
         readonly headers: Schema.optional<Schema.$Record<Schema.String, Schema.Union<readonly [Schema.String, typeof ConfiguredHeaderBinding]>>>;
-        readonly queryParams: Schema.optional<Schema.$Record<Schema.String, Schema.Union<readonly [Schema.String, Schema.Struct<{
-            readonly secretId: Schema.String;
-            readonly prefix: Schema.optional<Schema.String>;
-        }>]>>>;
+        readonly queryParams: Schema.optional<Schema.$Record<Schema.String, Schema.Union<readonly [Schema.String, typeof ConfiguredHeaderBinding]>>>;
         readonly specFetchCredentials: Schema.optional<Schema.Struct<{
-            readonly headers: Schema.optional<Schema.$Record<Schema.String, Schema.Union<readonly [Schema.String, Schema.Struct<{
-                readonly secretId: Schema.String;
-                readonly prefix: Schema.optional<Schema.String>;
-            }>]>>>;
-            readonly queryParams: Schema.optional<Schema.$Record<Schema.String, Schema.Union<readonly [Schema.String, Schema.Struct<{
-                readonly secretId: Schema.String;
-                readonly prefix: Schema.optional<Schema.String>;
-            }>]>>>;
+            readonly headers: Schema.optional<Schema.$Record<Schema.String, Schema.Union<readonly [Schema.String, typeof ConfiguredHeaderBinding]>>>;
+            readonly queryParams: Schema.optional<Schema.$Record<Schema.String, Schema.Union<readonly [Schema.String, typeof ConfiguredHeaderBinding]>>>;
         }>>;
         readonly oauth2: Schema.optional<typeof OAuth2SourceConfig>;
     }>;
@@ -175,6 +263,7 @@ export interface StoredOperation {
     readonly binding: OperationBinding;
 }
 export declare const headerBindingSlot: (headerName: string) => string;
+export declare const queryParamBindingSlot: (name: string) => string;
 export declare const oauth2ClientIdSlot: (securitySchemeName: string) => string;
 export declare const oauth2ClientSecretSlot: (securitySchemeName: string) => string;
 export declare const oauth2ConnectionSlot: (securitySchemeName: string) => string;
@@ -184,7 +273,7 @@ export interface OpenapiStore {
         readonly name?: string;
         readonly baseUrl?: string;
         readonly headers?: Record<string, ConfiguredHeaderValue>;
-        readonly queryParams?: Record<string, HeaderValue>;
+        readonly queryParams?: Record<string, ConfiguredHeaderValue>;
         readonly oauth2?: OAuth2SourceConfig;
     }) => Effect.Effect<void, StorageFailure>;
     readonly getSource: (namespace: string, scope: string) => Effect.Effect<StoredSource | null, StorageFailure>;
@@ -192,10 +281,6 @@ export interface OpenapiStore {
     readonly getOperationByToolId: (toolId: string, scope: string) => Effect.Effect<StoredOperation | null, StorageFailure>;
     readonly listOperationsBySource: (sourceId: string, scope: string) => Effect.Effect<readonly StoredOperation[], StorageFailure>;
     readonly removeSource: (namespace: string, scope: string) => Effect.Effect<void, StorageFailure>;
-    readonly listSourceBindings: (sourceId: string, sourceScope: string) => Effect.Effect<readonly OpenApiSourceBindingRef[], StorageFailure>;
-    readonly resolveSourceBinding: (sourceId: string, sourceScope: string, slot: string) => Effect.Effect<OpenApiSourceBindingRef | null, StorageFailure>;
-    readonly setSourceBinding: (input: OpenApiSourceBindingInput) => Effect.Effect<OpenApiSourceBindingRef, StorageFailure>;
-    readonly removeSourceBinding: (sourceId: string, sourceScope: string, slot: string, scope: string) => Effect.Effect<void, StorageFailure>;
 }
-export declare const makeDefaultOpenapiStore: ({ adapter, scopes, }: StorageDeps<OpenapiSchema>) => OpenapiStore;
+export declare const makeDefaultOpenapiStore: ({ adapter }: StorageDeps<OpenapiSchema>) => OpenapiStore;
 export {};