@executor-js/plugin-openapi 0.0.1-beta.6 → 0.0.2

package/dist/sdk/store.d.ts

@@ -0,0 +1,201 @@
+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";
+export declare const openapiSchema: {
+    readonly openapi_source: {
+        readonly fields: {
+            readonly id: {
+                readonly type: "string";
+                readonly required: true;
+            };
+            readonly scope_id: {
+                readonly type: "string";
+                readonly required: true;
+                readonly index: true;
+            };
+            readonly name: {
+                readonly type: "string";
+                readonly required: true;
+            };
+            readonly spec: {
+                readonly type: "string";
+                readonly required: true;
+            };
+            readonly source_url: {
+                readonly type: "string";
+                readonly required: false;
+            };
+            readonly base_url: {
+                readonly type: "string";
+                readonly required: false;
+            };
+            readonly headers: {
+                readonly type: "json";
+                readonly required: false;
+            };
+            readonly query_params: {
+                readonly type: "json";
+                readonly required: false;
+            };
+            readonly oauth2: {
+                readonly type: "json";
+                readonly required: false;
+            };
+            readonly invocation_config: {
+                readonly type: "json";
+                readonly required: true;
+            };
+        };
+    };
+    readonly openapi_operation: {
+        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 binding: {
+                readonly type: "json";
+                readonly required: true;
+            };
+        };
+    };
+    readonly openapi_source_binding: {
+        readonly fields: {
+            readonly id: {
+                readonly type: "string";
+                readonly required: true;
+            };
+            readonly source_id: {
+                readonly type: "string";
+                readonly required: true;
+                readonly index: true;
+            };
+            readonly source_scope_id: {
+                readonly type: "string";
+                readonly required: true;
+                readonly index: true;
+            };
+            readonly target_scope_id: {
+                readonly type: "string";
+                readonly required: true;
+                readonly index: true;
+            };
+            readonly slot: {
+                readonly type: "string";
+                readonly required: true;
+                readonly index: true;
+            };
+            readonly value: {
+                readonly type: "json";
+                readonly required: true;
+            };
+            readonly created_at: {
+                readonly type: "date";
+                readonly required: true;
+            };
+            readonly updated_at: {
+                readonly type: "date";
+                readonly required: true;
+            };
+        };
+    };
+};
+export type OpenapiSchema = typeof openapiSchema;
+export interface SourceConfig {
+    readonly spec: string;
+    /** Origin URL when the spec was fetched from http(s). Absent for
+     *  raw-text adds. Persisted so `refreshSource` can re-fetch. */
+    readonly sourceUrl?: string;
+    readonly baseUrl?: string;
+    readonly namespace?: string;
+    readonly headers?: Record<string, ConfiguredHeaderValue>;
+    readonly queryParams?: Record<string, HeaderValue>;
+    readonly specFetchCredentials?: OpenApiSpecFetchCredentials;
+    readonly oauth2?: OAuth2SourceConfig;
+}
+export interface OpenApiSpecFetchCredentials {
+    readonly headers?: Record<string, HeaderValue>;
+    readonly queryParams?: Record<string, HeaderValue>;
+}
+export interface StoredSource {
+    readonly namespace: string;
+    /** Executor scope id this source row lives in. Writes stamp this on
+     *  `scope_id`; reads return whichever scope's row the adapter's
+     *  fall-through filter sees first. */
+    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 name: Schema.String;
+    readonly config: Schema.Struct<{
+        readonly spec: Schema.String;
+        readonly sourceUrl: Schema.optional<Schema.String>;
+        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 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 oauth2: Schema.optional<typeof OAuth2SourceConfig>;
+    }>;
+}>, {}>;
+export declare class StoredSourceSchema extends StoredSourceSchema_base {
+}
+export type StoredSourceSchemaType = typeof StoredSourceSchema.Type;
+export interface StoredOperation {
+    readonly toolId: string;
+    readonly sourceId: string;
+    readonly binding: OperationBinding;
+}
+export declare const headerBindingSlot: (headerName: string) => string;
+export declare const oauth2ClientIdSlot: (securitySchemeName: string) => string;
+export declare const oauth2ClientSecretSlot: (securitySchemeName: string) => string;
+export declare const oauth2ConnectionSlot: (securitySchemeName: string) => string;
+export interface OpenapiStore {
+    readonly upsertSource: (input: StoredSource, operations: readonly StoredOperation[]) => Effect.Effect<void, StorageFailure>;
+    readonly updateSourceMeta: (namespace: string, scope: string, patch: {
+        readonly name?: string;
+        readonly baseUrl?: string;
+        readonly headers?: Record<string, ConfiguredHeaderValue>;
+        readonly queryParams?: Record<string, HeaderValue>;
+        readonly oauth2?: OAuth2SourceConfig;
+    }) => Effect.Effect<void, StorageFailure>;
+    readonly getSource: (namespace: string, scope: string) => Effect.Effect<StoredSource | null, StorageFailure>;
+    readonly listSources: () => Effect.Effect<readonly StoredSource[], StorageFailure>;
+    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 {};