@rafads/plugin-openapi 1.5.38
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.
- package/README.md +83 -0
- package/dist/AddOpenApiIntegration-JPAEXE56.js +512 -0
- package/dist/AddOpenApiIntegration-JPAEXE56.js.map +1 -0
- package/dist/OpenApiAccountsPanel-GZFDSTAU.js +106 -0
- package/dist/OpenApiAccountsPanel-GZFDSTAU.js.map +1 -0
- package/dist/UpdateSpecSection-KUSNI44Q.js +106 -0
- package/dist/UpdateSpecSection-KUSNI44Q.js.map +1 -0
- package/dist/api/group.d.ts +239 -0
- package/dist/api/handlers.d.ts +7 -0
- package/dist/api/index.d.ts +237 -0
- package/dist/chunk-6V45G2XQ.js +199 -0
- package/dist/chunk-6V45G2XQ.js.map +1 -0
- package/dist/chunk-CURJJXB3.js +132 -0
- package/dist/chunk-CURJJXB3.js.map +1 -0
- package/dist/chunk-CXFO6TLJ.js +39 -0
- package/dist/chunk-CXFO6TLJ.js.map +1 -0
- package/dist/chunk-HTHEUUJA.js +2873 -0
- package/dist/chunk-HTHEUUJA.js.map +1 -0
- package/dist/chunk-IG6QTTZB.js +79 -0
- package/dist/chunk-IG6QTTZB.js.map +1 -0
- package/dist/chunk-O2LMSZ2Z.js +120 -0
- package/dist/chunk-O2LMSZ2Z.js.map +1 -0
- package/dist/chunk-OR27BCXQ.js +956 -0
- package/dist/chunk-OR27BCXQ.js.map +1 -0
- package/dist/chunk-R7TVM3XD.js +275 -0
- package/dist/chunk-R7TVM3XD.js.map +1 -0
- package/dist/client.js +38 -0
- package/dist/client.js.map +1 -0
- package/dist/core.js +331 -0
- package/dist/core.js.map +1 -0
- package/dist/index.js +19 -0
- package/dist/index.js.map +1 -0
- package/dist/providers/google/config.d.ts +34 -0
- package/dist/providers/google/discovery.d.ts +49 -0
- package/dist/providers/google/discovery.test.d.ts +1 -0
- package/dist/providers/google/index.d.ts +5 -0
- package/dist/providers/google/oauth-scopes.d.ts +3 -0
- package/dist/providers/google/oauth-scopes.test.d.ts +1 -0
- package/dist/providers/google/openapi-ownership-migration.d.ts +7 -0
- package/dist/providers/google/openapi-ownership-migration.test.d.ts +1 -0
- package/dist/providers/google/presets.d.ts +31 -0
- package/dist/providers/google/presets.test.d.ts +1 -0
- package/dist/providers/google/spec-format-adapter.d.ts +3 -0
- package/dist/providers/google/spec-format-adapter.test.d.ts +1 -0
- package/dist/providers/google.js +1446 -0
- package/dist/providers/google.js.map +1 -0
- package/dist/providers/microsoft/graph.d.ts +76 -0
- package/dist/providers/microsoft/graph.test.d.ts +1 -0
- package/dist/providers/microsoft/index.d.ts +3 -0
- package/dist/providers/microsoft/presets.d.ts +46 -0
- package/dist/providers/microsoft/presets.test.d.ts +1 -0
- package/dist/providers/microsoft/spec-format-adapter.d.ts +2 -0
- package/dist/providers/microsoft/spec-format-adapter.test.d.ts +1 -0
- package/dist/providers/microsoft.js +1056 -0
- package/dist/providers/microsoft.js.map +1 -0
- package/dist/react/AddOpenApiIntegration.d.ts +22 -0
- package/dist/react/AddOpenApiIntegration.test.d.ts +1 -0
- package/dist/react/OpenApiAccountsPanel.d.ts +6 -0
- package/dist/react/OpenApiIntegrationDetailsFields.d.ts +25 -0
- package/dist/react/UpdateSpecSection.d.ts +2 -0
- package/dist/react/atoms.d.ts +317 -0
- package/dist/react/auth-method-config.d.ts +18 -0
- package/dist/react/auth-method-config.test.d.ts +1 -0
- package/dist/react/client.d.ts +233 -0
- package/dist/react/index.d.ts +5 -0
- package/dist/react/integration-plugin.d.ts +6 -0
- package/dist/react/plugin-client.d.ts +2 -0
- package/dist/sdk/backing.d.ts +188 -0
- package/dist/sdk/client-credentials-oauth.test.d.ts +1 -0
- package/dist/sdk/compiled-spec-cache.test.d.ts +1 -0
- package/dist/sdk/config.d.ts +81 -0
- package/dist/sdk/configure.test.d.ts +1 -0
- package/dist/sdk/definitions.d.ts +57 -0
- package/dist/sdk/derive-auth.d.ts +11 -0
- package/dist/sdk/describe-auth-methods.test.d.ts +1 -0
- package/dist/sdk/errors.d.ts +45 -0
- package/dist/sdk/extract.d.ts +157 -0
- package/dist/sdk/extract.test.d.ts +1 -0
- package/dist/sdk/form-urlencoded-body.test.d.ts +1 -0
- package/dist/sdk/index.d.ts +19 -0
- package/dist/sdk/index.test.d.ts +1 -0
- package/dist/sdk/invoke.d.ts +150 -0
- package/dist/sdk/migrate-config.d.ts +4 -0
- package/dist/sdk/migrate-config.test.d.ts +1 -0
- package/dist/sdk/multi-scope-bearer.test.d.ts +1 -0
- package/dist/sdk/multi-scope-oauth.test.d.ts +1 -0
- package/dist/sdk/ndjson-output-migration.d.ts +13 -0
- package/dist/sdk/ndjson-output-migration.test.d.ts +1 -0
- package/dist/sdk/non-json-body.test.d.ts +1 -0
- package/dist/sdk/oauth-refresh.test.d.ts +1 -0
- package/dist/sdk/openapi-utils.d.ts +65 -0
- package/dist/sdk/output-schema-migration.d.ts +21 -0
- package/dist/sdk/output-schema-migration.test.d.ts +1 -0
- package/dist/sdk/parse.d.ts +33 -0
- package/dist/sdk/parse.test.d.ts +1 -0
- package/dist/sdk/plugin.d.ts +109 -0
- package/dist/sdk/plugin.test.d.ts +1 -0
- package/dist/sdk/presets.d.ts +15 -0
- package/dist/sdk/preview-oauth2.test.d.ts +1 -0
- package/dist/sdk/preview.d.ts +514 -0
- package/dist/sdk/query-serialization.test.d.ts +1 -0
- package/dist/sdk/real-specs.test.d.ts +1 -0
- package/dist/sdk/request-user-agent.test.d.ts +1 -0
- package/dist/sdk/response-headers-timeout.test.d.ts +1 -0
- package/dist/sdk/server-url-resolution.test.d.ts +1 -0
- package/dist/sdk/spec-blob-migration.d.ts +7 -0
- package/dist/sdk/spec-blob.test.d.ts +1 -0
- package/dist/sdk/spec-format.d.ts +36 -0
- package/dist/sdk/spec-format.test.d.ts +1 -0
- package/dist/sdk/split.d.ts +84 -0
- package/dist/sdk/store.d.ts +49 -0
- package/dist/sdk/store.test.d.ts +1 -0
- package/dist/sdk/streaming-response.test.d.ts +1 -0
- package/dist/sdk/tool-row-projection.test.d.ts +1 -0
- package/dist/sdk/types.d.ts +352 -0
- package/dist/sdk/upstream-failures.test.d.ts +1 -0
- package/dist/sdk/usage-scope-isolation.test.d.ts +1 -0
- package/dist/testing/index.d.ts +177 -0
- package/dist/testing.js +454 -0
- package/dist/testing.js.map +1 -0
- package/dist/testing.test.d.ts +1 -0
- package/package.json +103 -0
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
import { Effect, Schema } from "effect";
|
|
2
|
+
import type { Layer } from "effect";
|
|
3
|
+
import { HttpClient } from "effect/unstable/http";
|
|
4
|
+
import { IntegrationAlreadyExistsError, IntegrationNotFoundError, IntegrationSlug, HealthCheckSpec, type AuthMethodDescriptor, type Integration, type IntegrationRecord, type StorageFailure } from "@rafads/sdk/core";
|
|
5
|
+
import { type OpenApiIntegrationConfig } from "./config";
|
|
6
|
+
import { OpenApiExtractionError, OpenApiOAuthError, OpenApiParseError } from "./errors";
|
|
7
|
+
import { type SpecPreview } from "./preview";
|
|
8
|
+
import { type OpenApiPreset } from "./presets";
|
|
9
|
+
import { type OpenapiStore } from "./store";
|
|
10
|
+
import { type SpecFormatAdapter } from "./spec-format";
|
|
11
|
+
import type { Authentication } from "./types";
|
|
12
|
+
import { type AuthenticationInput } from "./types";
|
|
13
|
+
import type { InvokeOptions } from "./invoke";
|
|
14
|
+
export type OpenApiSpecInput = typeof OpenApiSpecInputSchema.Type;
|
|
15
|
+
export interface OpenApiPreviewInput {
|
|
16
|
+
readonly spec: string;
|
|
17
|
+
readonly specFormat?: string;
|
|
18
|
+
}
|
|
19
|
+
/** Add an OpenAPI integration to the catalog. The integration is the API
|
|
20
|
+
* surface; connections (the credentials) are attached separately and resolve
|
|
21
|
+
* their value through the declared `authenticationTemplate`. */
|
|
22
|
+
export interface OpenApiSpecConfig {
|
|
23
|
+
readonly spec: OpenApiSpecInput;
|
|
24
|
+
/** The catalog slug for the new integration (the `<integration>` segment). */
|
|
25
|
+
readonly slug?: string;
|
|
26
|
+
/** Display name (defaults to the spec title). */
|
|
27
|
+
readonly name?: string;
|
|
28
|
+
/** Agent-visible description (defaults to the spec's `info.description`,
|
|
29
|
+
* then the title). */
|
|
30
|
+
readonly description?: string;
|
|
31
|
+
readonly baseUrl?: string;
|
|
32
|
+
/** Static headers applied to every request (no secret material). */
|
|
33
|
+
readonly headers?: Record<string, string>;
|
|
34
|
+
/** Static query params applied to every request. */
|
|
35
|
+
readonly queryParams?: Record<string, string>;
|
|
36
|
+
readonly specFormat?: string;
|
|
37
|
+
readonly family?: string;
|
|
38
|
+
readonly healthCheck?: HealthCheckSpec;
|
|
39
|
+
/** Auth methods a connection's value renders through - canonical
|
|
40
|
+
* placements or the request-shaped authoring dialect. */
|
|
41
|
+
readonly authenticationTemplate?: readonly AuthenticationInput[];
|
|
42
|
+
}
|
|
43
|
+
export interface OpenApiExtensionFailure {
|
|
44
|
+
readonly _tag: string;
|
|
45
|
+
}
|
|
46
|
+
/** Add / merge custom auth methods onto an existing OpenAPI integration's
|
|
47
|
+
* `authenticationTemplate`, and update request routing metadata. Mirrors the
|
|
48
|
+
* GraphQL plugin's `configure`. */
|
|
49
|
+
export interface OpenApiConfigureInput {
|
|
50
|
+
/** The auth methods to add. Each entry is appended to (or, when its `slug`
|
|
51
|
+
* already exists, replaces) the integration's existing template array. A
|
|
52
|
+
* custom apiKey method with no `slug` is assigned a generated `custom_<id>`
|
|
53
|
+
* slug that is collision-checked against the existing template. */
|
|
54
|
+
readonly authenticationTemplate?: readonly AuthenticationInput[];
|
|
55
|
+
readonly mode?: "merge" | "replace";
|
|
56
|
+
readonly baseUrl?: string;
|
|
57
|
+
}
|
|
58
|
+
/** What changed in the tool catalog when a spec was updated in place. Tool
|
|
59
|
+
* names, not addresses - the same diff applies to every connection. */
|
|
60
|
+
export interface UpdateSpecResult {
|
|
61
|
+
readonly slug: IntegrationSlug;
|
|
62
|
+
readonly toolCount: number;
|
|
63
|
+
readonly addedTools: readonly string[];
|
|
64
|
+
readonly removedTools: readonly string[];
|
|
65
|
+
}
|
|
66
|
+
export interface OpenApiUpdateSpecInput {
|
|
67
|
+
/** New spec source. Omit to re-fetch from the integration's stored
|
|
68
|
+
* `specUrl`. */
|
|
69
|
+
readonly spec?: OpenApiSpecInput;
|
|
70
|
+
}
|
|
71
|
+
export interface OpenApiPluginExtension {
|
|
72
|
+
readonly previewSpec: (input: string | OpenApiPreviewInput) => Effect.Effect<SpecPreview, OpenApiParseError | OpenApiExtractionError | OpenApiOAuthError | StorageFailure>;
|
|
73
|
+
readonly addSpec: (config: OpenApiSpecConfig) => Effect.Effect<{
|
|
74
|
+
readonly slug: IntegrationSlug;
|
|
75
|
+
readonly toolCount: number;
|
|
76
|
+
}, OpenApiParseError | OpenApiExtractionError | OpenApiOAuthError | IntegrationAlreadyExistsError | StorageFailure>;
|
|
77
|
+
/** Re-resolve the integration's spec (from its stored source URL, or the
|
|
78
|
+
* provided input) and rebuild its tools IN PLACE - connections,
|
|
79
|
+
* credentials, policies, and the curated description are untouched. */
|
|
80
|
+
readonly updateSpec: (slug: string, input?: OpenApiUpdateSpecInput) => Effect.Effect<UpdateSpecResult, OpenApiParseError | OpenApiExtractionError | OpenApiOAuthError | IntegrationNotFoundError | StorageFailure>;
|
|
81
|
+
readonly removeSpec: (slug: string) => Effect.Effect<void, StorageFailure>;
|
|
82
|
+
readonly getIntegration: (slug: string) => Effect.Effect<Integration | null, StorageFailure>;
|
|
83
|
+
/** Read the integration's full opaque config, including its
|
|
84
|
+
* `authenticationTemplate`. Returns null when the integration is absent. */
|
|
85
|
+
readonly getConfig: (slug: string) => Effect.Effect<OpenApiIntegrationConfig | null, StorageFailure>;
|
|
86
|
+
/** Add / merge custom auth methods onto the integration's
|
|
87
|
+
* `authenticationTemplate`. Returns the resulting template array. */
|
|
88
|
+
readonly configure: (slug: string, input: OpenApiConfigureInput) => Effect.Effect<readonly Authentication[], StorageFailure>;
|
|
89
|
+
}
|
|
90
|
+
declare const OpenApiSpecInputSchema: Schema.Union<readonly [Schema.Struct<{
|
|
91
|
+
readonly kind: Schema.Literal<"url">;
|
|
92
|
+
readonly url: Schema.String;
|
|
93
|
+
}>, Schema.Struct<{
|
|
94
|
+
readonly kind: Schema.Literal<"blob">;
|
|
95
|
+
readonly value: Schema.String;
|
|
96
|
+
}>]>;
|
|
97
|
+
export declare const describeOpenApiAuthMethods: (record: IntegrationRecord) => readonly AuthMethodDescriptor[];
|
|
98
|
+
export declare const describeOpenApiIntegrationDisplay: (record: IntegrationRecord) => {
|
|
99
|
+
readonly url?: string;
|
|
100
|
+
readonly family?: string;
|
|
101
|
+
};
|
|
102
|
+
export interface OpenApiPluginOptions {
|
|
103
|
+
readonly httpClientLayer?: Layer.Layer<HttpClient.HttpClient, never, never>;
|
|
104
|
+
readonly invokeOptions?: InvokeOptions;
|
|
105
|
+
readonly specFormats?: readonly SpecFormatAdapter[];
|
|
106
|
+
readonly presets?: readonly OpenApiPreset[];
|
|
107
|
+
}
|
|
108
|
+
export declare const openApiPlugin: import("@rafads/sdk/core").ConfiguredPlugin<"openapi", OpenApiPluginExtension, OpenapiStore, OpenApiPluginOptions, undefined, Layer.Layer<unknown, never, never>, import("effect/unstable/httpapi/HttpApiGroup").Any>;
|
|
109
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import type { HealthCheckSpec, IntegrationPresetAuthentication } from "@rafads/sdk/core";
|
|
2
|
+
export interface OpenApiPreset {
|
|
3
|
+
readonly id: string;
|
|
4
|
+
readonly name: string;
|
|
5
|
+
readonly summary: string;
|
|
6
|
+
readonly url?: string;
|
|
7
|
+
readonly icon?: string;
|
|
8
|
+
readonly featured?: boolean;
|
|
9
|
+
readonly family?: string;
|
|
10
|
+
readonly specFormat?: string;
|
|
11
|
+
readonly defaultSlug?: string;
|
|
12
|
+
readonly authTemplate?: readonly IntegrationPresetAuthentication[];
|
|
13
|
+
readonly healthCheck?: HealthCheckSpec;
|
|
14
|
+
}
|
|
15
|
+
export declare const openApiPresets: readonly OpenApiPreset[];
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,514 @@
|
|
|
1
|
+
import { Effect, Option } from "effect";
|
|
2
|
+
import { Schema } from "effect";
|
|
3
|
+
export declare const OAuth2AuthorizationCodeFlow: Schema.Struct<{
|
|
4
|
+
readonly authorizationUrl: Schema.String;
|
|
5
|
+
readonly tokenUrl: Schema.String;
|
|
6
|
+
readonly refreshUrl: Schema.OptionFromOptional<Schema.String>;
|
|
7
|
+
readonly scopes: Schema.$Record<Schema.String, Schema.String>;
|
|
8
|
+
}>;
|
|
9
|
+
export type OAuth2AuthorizationCodeFlow = typeof OAuth2AuthorizationCodeFlow.Type;
|
|
10
|
+
export declare const OAuth2ClientCredentialsFlow: Schema.Struct<{
|
|
11
|
+
readonly tokenUrl: Schema.String;
|
|
12
|
+
readonly refreshUrl: Schema.OptionFromOptional<Schema.String>;
|
|
13
|
+
readonly scopes: Schema.$Record<Schema.String, Schema.String>;
|
|
14
|
+
}>;
|
|
15
|
+
export type OAuth2ClientCredentialsFlow = typeof OAuth2ClientCredentialsFlow.Type;
|
|
16
|
+
export declare const OAuth2Flows: Schema.Struct<{
|
|
17
|
+
readonly authorizationCode: Schema.OptionFromOptional<Schema.Struct<{
|
|
18
|
+
readonly authorizationUrl: Schema.String;
|
|
19
|
+
readonly tokenUrl: Schema.String;
|
|
20
|
+
readonly refreshUrl: Schema.OptionFromOptional<Schema.String>;
|
|
21
|
+
readonly scopes: Schema.$Record<Schema.String, Schema.String>;
|
|
22
|
+
}>>;
|
|
23
|
+
readonly clientCredentials: Schema.OptionFromOptional<Schema.Struct<{
|
|
24
|
+
readonly tokenUrl: Schema.String;
|
|
25
|
+
readonly refreshUrl: Schema.OptionFromOptional<Schema.String>;
|
|
26
|
+
readonly scopes: Schema.$Record<Schema.String, Schema.String>;
|
|
27
|
+
}>>;
|
|
28
|
+
}>;
|
|
29
|
+
export type OAuth2Flows = typeof OAuth2Flows.Type;
|
|
30
|
+
export declare const SecurityScheme: Schema.Struct<{
|
|
31
|
+
/** Key name in components.securitySchemes (e.g. "api_token") */
|
|
32
|
+
readonly name: Schema.String;
|
|
33
|
+
/** OpenAPI security scheme type */
|
|
34
|
+
readonly type: Schema.Literals<readonly ["http", "apiKey", "oauth2", "openIdConnect"]>;
|
|
35
|
+
/** For type: "http" — e.g. "bearer", "basic" */
|
|
36
|
+
readonly scheme: Schema.OptionFromOptional<Schema.String>;
|
|
37
|
+
/** For type: "http" with scheme "bearer" — e.g. "JWT" */
|
|
38
|
+
readonly bearerFormat: Schema.OptionFromOptional<Schema.String>;
|
|
39
|
+
/** For type: "apiKey" — where the key goes */
|
|
40
|
+
readonly in: Schema.OptionFromOptional<Schema.Literals<readonly ["header", "query", "cookie"]>>;
|
|
41
|
+
/** For type: "apiKey" — the header/query/cookie name */
|
|
42
|
+
readonly headerName: Schema.OptionFromOptional<Schema.String>;
|
|
43
|
+
readonly description: Schema.OptionFromOptional<Schema.String>;
|
|
44
|
+
/** For type: "oauth2" — declared flows (authorizationCode / clientCredentials only; implicit and password are deprecated). */
|
|
45
|
+
readonly flows: Schema.OptionFromOptional<Schema.Struct<{
|
|
46
|
+
readonly authorizationCode: Schema.OptionFromOptional<Schema.Struct<{
|
|
47
|
+
readonly authorizationUrl: Schema.String;
|
|
48
|
+
readonly tokenUrl: Schema.String;
|
|
49
|
+
readonly refreshUrl: Schema.OptionFromOptional<Schema.String>;
|
|
50
|
+
readonly scopes: Schema.$Record<Schema.String, Schema.String>;
|
|
51
|
+
}>>;
|
|
52
|
+
readonly clientCredentials: Schema.OptionFromOptional<Schema.Struct<{
|
|
53
|
+
readonly tokenUrl: Schema.String;
|
|
54
|
+
readonly refreshUrl: Schema.OptionFromOptional<Schema.String>;
|
|
55
|
+
readonly scopes: Schema.$Record<Schema.String, Schema.String>;
|
|
56
|
+
}>>;
|
|
57
|
+
}>>;
|
|
58
|
+
/** For type: "openIdConnect" — the discovery URL. */
|
|
59
|
+
readonly openIdConnectUrl: Schema.OptionFromOptional<Schema.String>;
|
|
60
|
+
}>;
|
|
61
|
+
export type SecurityScheme = typeof SecurityScheme.Type;
|
|
62
|
+
export declare const AuthStrategy: Schema.Struct<{
|
|
63
|
+
/** The security schemes required together for this strategy */
|
|
64
|
+
readonly schemes: Schema.$Array<Schema.String>;
|
|
65
|
+
}>;
|
|
66
|
+
export type AuthStrategy = typeof AuthStrategy.Type;
|
|
67
|
+
export declare const HeaderPreset: Schema.Struct<{
|
|
68
|
+
/** Human-readable label for the UI (e.g. "Bearer Token", "API Key + Email") */
|
|
69
|
+
readonly label: Schema.String;
|
|
70
|
+
/** Headers this strategy needs. Value is null when the user must provide it. */
|
|
71
|
+
readonly headers: Schema.$Record<Schema.String, Schema.NullOr<Schema.String>>;
|
|
72
|
+
/** Which headers should be stored as secrets */
|
|
73
|
+
readonly secretHeaders: Schema.$Array<Schema.String>;
|
|
74
|
+
}>;
|
|
75
|
+
export type HeaderPreset = typeof HeaderPreset.Type;
|
|
76
|
+
export declare const OAuth2Preset: Schema.Struct<{
|
|
77
|
+
/** Human-readable label for the UI (e.g. "OAuth2 (Authorization Code) — oauth_app") */
|
|
78
|
+
readonly label: Schema.String;
|
|
79
|
+
/** The source security scheme this preset came from (components.securitySchemes key). */
|
|
80
|
+
readonly securitySchemeName: Schema.String;
|
|
81
|
+
/** Which OAuth2 flow this preset uses. */
|
|
82
|
+
readonly flow: Schema.Literals<readonly ["authorizationCode", "clientCredentials"]>;
|
|
83
|
+
/** For authorizationCode: user-agent redirect URL (from the spec). */
|
|
84
|
+
readonly authorizationUrl: Schema.OptionFromOptional<Schema.String>;
|
|
85
|
+
/** Token endpoint to exchange the code / refresh. */
|
|
86
|
+
readonly tokenUrl: Schema.String;
|
|
87
|
+
/** RFC 8707 resource indicator discovered from protected-resource metadata. */
|
|
88
|
+
readonly resource: Schema.OptionFromOptional<Schema.String>;
|
|
89
|
+
/** Optional refresh endpoint if the spec declares one separately. */
|
|
90
|
+
readonly refreshUrl: Schema.OptionFromOptional<Schema.String>;
|
|
91
|
+
/** Declared scopes for this flow: `{ scope: description }`. */
|
|
92
|
+
readonly scopes: Schema.$Record<Schema.String, Schema.String>;
|
|
93
|
+
/** Identity scopes to request alongside API scopes. `"auto"` discovers standard OIDC scopes. */
|
|
94
|
+
readonly identityScopes: Schema.Union<readonly [Schema.Literal<"auto">, Schema.Literal<false>, Schema.$Array<Schema.String>]>;
|
|
95
|
+
/** Provider metadata advertised Client ID Metadata Document support. */
|
|
96
|
+
readonly supportsClientIdMetadataDocument: Schema.optional<Schema.Boolean>;
|
|
97
|
+
}>;
|
|
98
|
+
export type OAuth2Preset = typeof OAuth2Preset.Type;
|
|
99
|
+
export declare const PreviewOperation: Schema.Struct<{
|
|
100
|
+
readonly operationId: Schema.String;
|
|
101
|
+
readonly method: Schema.Literals<readonly ["get", "put", "post", "delete", "patch", "head", "options", "trace"]>;
|
|
102
|
+
readonly path: Schema.String;
|
|
103
|
+
readonly summary: Schema.OptionFromOptional<Schema.String>;
|
|
104
|
+
readonly tags: Schema.$Array<Schema.String>;
|
|
105
|
+
readonly deprecated: Schema.Boolean;
|
|
106
|
+
}>;
|
|
107
|
+
export type PreviewOperation = typeof PreviewOperation.Type;
|
|
108
|
+
export declare const SpecPreview: Schema.Struct<{
|
|
109
|
+
readonly title: Schema.OptionFromOptional<Schema.String>;
|
|
110
|
+
/** The spec's `info.description` — prefills the add form's description field. */
|
|
111
|
+
readonly description: Schema.OptionFromOptional<Schema.String>;
|
|
112
|
+
readonly version: Schema.OptionFromOptional<Schema.String>;
|
|
113
|
+
/** Reuses ServerInfo from extraction */
|
|
114
|
+
readonly servers: Schema.$Array<Schema.Struct<{
|
|
115
|
+
readonly url: Schema.String;
|
|
116
|
+
readonly description: Schema.OptionFromOptional<Schema.String>;
|
|
117
|
+
readonly variables: Schema.OptionFromOptional<Schema.$Record<Schema.String, Schema.Struct<{
|
|
118
|
+
readonly default: Schema.String;
|
|
119
|
+
readonly enum: Schema.OptionFromOptional<Schema.$Array<Schema.String>>;
|
|
120
|
+
readonly description: Schema.OptionFromOptional<Schema.String>;
|
|
121
|
+
}>>>;
|
|
122
|
+
}>>;
|
|
123
|
+
readonly operationCount: Schema.Number;
|
|
124
|
+
/** Lightweight operation list for the add-integration UI */
|
|
125
|
+
readonly operations: Schema.$Array<Schema.Struct<{
|
|
126
|
+
readonly operationId: Schema.String;
|
|
127
|
+
readonly method: Schema.Literals<readonly ["get", "put", "post", "delete", "patch", "head", "options", "trace"]>;
|
|
128
|
+
readonly path: Schema.String;
|
|
129
|
+
readonly summary: Schema.OptionFromOptional<Schema.String>;
|
|
130
|
+
readonly tags: Schema.$Array<Schema.String>;
|
|
131
|
+
readonly deprecated: Schema.Boolean;
|
|
132
|
+
}>>;
|
|
133
|
+
readonly tags: Schema.$Array<Schema.String>;
|
|
134
|
+
readonly securitySchemes: Schema.$Array<Schema.Struct<{
|
|
135
|
+
/** Key name in components.securitySchemes (e.g. "api_token") */
|
|
136
|
+
readonly name: Schema.String;
|
|
137
|
+
/** OpenAPI security scheme type */
|
|
138
|
+
readonly type: Schema.Literals<readonly ["http", "apiKey", "oauth2", "openIdConnect"]>;
|
|
139
|
+
/** For type: "http" — e.g. "bearer", "basic" */
|
|
140
|
+
readonly scheme: Schema.OptionFromOptional<Schema.String>;
|
|
141
|
+
/** For type: "http" with scheme "bearer" — e.g. "JWT" */
|
|
142
|
+
readonly bearerFormat: Schema.OptionFromOptional<Schema.String>;
|
|
143
|
+
/** For type: "apiKey" — where the key goes */
|
|
144
|
+
readonly in: Schema.OptionFromOptional<Schema.Literals<readonly ["header", "query", "cookie"]>>;
|
|
145
|
+
/** For type: "apiKey" — the header/query/cookie name */
|
|
146
|
+
readonly headerName: Schema.OptionFromOptional<Schema.String>;
|
|
147
|
+
readonly description: Schema.OptionFromOptional<Schema.String>;
|
|
148
|
+
/** For type: "oauth2" — declared flows (authorizationCode / clientCredentials only; implicit and password are deprecated). */
|
|
149
|
+
readonly flows: Schema.OptionFromOptional<Schema.Struct<{
|
|
150
|
+
readonly authorizationCode: Schema.OptionFromOptional<Schema.Struct<{
|
|
151
|
+
readonly authorizationUrl: Schema.String;
|
|
152
|
+
readonly tokenUrl: Schema.String;
|
|
153
|
+
readonly refreshUrl: Schema.OptionFromOptional<Schema.String>;
|
|
154
|
+
readonly scopes: Schema.$Record<Schema.String, Schema.String>;
|
|
155
|
+
}>>;
|
|
156
|
+
readonly clientCredentials: Schema.OptionFromOptional<Schema.Struct<{
|
|
157
|
+
readonly tokenUrl: Schema.String;
|
|
158
|
+
readonly refreshUrl: Schema.OptionFromOptional<Schema.String>;
|
|
159
|
+
readonly scopes: Schema.$Record<Schema.String, Schema.String>;
|
|
160
|
+
}>>;
|
|
161
|
+
}>>;
|
|
162
|
+
/** For type: "openIdConnect" — the discovery URL. */
|
|
163
|
+
readonly openIdConnectUrl: Schema.OptionFromOptional<Schema.String>;
|
|
164
|
+
}>>;
|
|
165
|
+
/** Valid auth strategies (each is a set of schemes used together) */
|
|
166
|
+
readonly authStrategies: Schema.$Array<Schema.Struct<{
|
|
167
|
+
/** The security schemes required together for this strategy */
|
|
168
|
+
readonly schemes: Schema.$Array<Schema.String>;
|
|
169
|
+
}>>;
|
|
170
|
+
/** Pre-built header presets derived from auth strategies */
|
|
171
|
+
readonly headerPresets: Schema.$Array<Schema.Struct<{
|
|
172
|
+
/** Human-readable label for the UI (e.g. "Bearer Token", "API Key + Email") */
|
|
173
|
+
readonly label: Schema.String;
|
|
174
|
+
/** Headers this strategy needs. Value is null when the user must provide it. */
|
|
175
|
+
readonly headers: Schema.$Record<Schema.String, Schema.NullOr<Schema.String>>;
|
|
176
|
+
/** Which headers should be stored as secrets */
|
|
177
|
+
readonly secretHeaders: Schema.$Array<Schema.String>;
|
|
178
|
+
}>>;
|
|
179
|
+
/** OAuth2 presets — one per (oauth2 scheme × supported flow) combination */
|
|
180
|
+
readonly oauth2Presets: Schema.$Array<Schema.Struct<{
|
|
181
|
+
/** Human-readable label for the UI (e.g. "OAuth2 (Authorization Code) — oauth_app") */
|
|
182
|
+
readonly label: Schema.String;
|
|
183
|
+
/** The source security scheme this preset came from (components.securitySchemes key). */
|
|
184
|
+
readonly securitySchemeName: Schema.String;
|
|
185
|
+
/** Which OAuth2 flow this preset uses. */
|
|
186
|
+
readonly flow: Schema.Literals<readonly ["authorizationCode", "clientCredentials"]>;
|
|
187
|
+
/** For authorizationCode: user-agent redirect URL (from the spec). */
|
|
188
|
+
readonly authorizationUrl: Schema.OptionFromOptional<Schema.String>;
|
|
189
|
+
/** Token endpoint to exchange the code / refresh. */
|
|
190
|
+
readonly tokenUrl: Schema.String;
|
|
191
|
+
/** RFC 8707 resource indicator discovered from protected-resource metadata. */
|
|
192
|
+
readonly resource: Schema.OptionFromOptional<Schema.String>;
|
|
193
|
+
/** Optional refresh endpoint if the spec declares one separately. */
|
|
194
|
+
readonly refreshUrl: Schema.OptionFromOptional<Schema.String>;
|
|
195
|
+
/** Declared scopes for this flow: `{ scope: description }`. */
|
|
196
|
+
readonly scopes: Schema.$Record<Schema.String, Schema.String>;
|
|
197
|
+
/** Identity scopes to request alongside API scopes. `"auto"` discovers standard OIDC scopes. */
|
|
198
|
+
readonly identityScopes: Schema.Union<readonly [Schema.Literal<"auto">, Schema.Literal<false>, Schema.$Array<Schema.String>]>;
|
|
199
|
+
/** Provider metadata advertised Client ID Metadata Document support. */
|
|
200
|
+
readonly supportsClientIdMetadataDocument: Schema.optional<Schema.Boolean>;
|
|
201
|
+
}>>;
|
|
202
|
+
/** Top-ranked health-check candidates (bounded), so the add screen can offer a
|
|
203
|
+
* typed operation + identity picker before the integration is registered. */
|
|
204
|
+
readonly healthCheckCandidates: Schema.$Array<Schema.Struct<{
|
|
205
|
+
readonly operation: Schema.String;
|
|
206
|
+
readonly method: Schema.String;
|
|
207
|
+
readonly requiredArgCount: Schema.Number;
|
|
208
|
+
readonly destructive: Schema.Boolean;
|
|
209
|
+
readonly summary: Schema.optional<Schema.String>;
|
|
210
|
+
readonly parameters: Schema.optional<Schema.$Array<Schema.Struct<{
|
|
211
|
+
readonly name: Schema.String;
|
|
212
|
+
readonly location: Schema.String;
|
|
213
|
+
readonly required: Schema.Boolean;
|
|
214
|
+
readonly description: Schema.optional<Schema.String>;
|
|
215
|
+
}>>>;
|
|
216
|
+
readonly responseFields: Schema.optional<Schema.$Array<Schema.Struct<{
|
|
217
|
+
readonly path: Schema.String;
|
|
218
|
+
readonly type: Schema.String;
|
|
219
|
+
}>>>;
|
|
220
|
+
}>>;
|
|
221
|
+
}>;
|
|
222
|
+
export type SpecPreview = typeof SpecPreview.Type;
|
|
223
|
+
export declare const SpecPreviewSummary: Schema.Struct<{
|
|
224
|
+
readonly title: Schema.OptionFromOptional<Schema.String>;
|
|
225
|
+
readonly description: Schema.OptionFromOptional<Schema.String>;
|
|
226
|
+
readonly version: Schema.OptionFromOptional<Schema.String>;
|
|
227
|
+
readonly servers: Schema.$Array<Schema.Struct<{
|
|
228
|
+
readonly url: Schema.String;
|
|
229
|
+
readonly description: Schema.OptionFromOptional<Schema.String>;
|
|
230
|
+
readonly variables: Schema.OptionFromOptional<Schema.$Record<Schema.String, Schema.Struct<{
|
|
231
|
+
readonly default: Schema.String;
|
|
232
|
+
readonly enum: Schema.OptionFromOptional<Schema.$Array<Schema.String>>;
|
|
233
|
+
readonly description: Schema.OptionFromOptional<Schema.String>;
|
|
234
|
+
}>>>;
|
|
235
|
+
}>>;
|
|
236
|
+
readonly operationCount: Schema.Number;
|
|
237
|
+
readonly tags: Schema.$Array<Schema.String>;
|
|
238
|
+
readonly securitySchemes: Schema.$Array<Schema.Struct<{
|
|
239
|
+
/** Key name in components.securitySchemes (e.g. "api_token") */
|
|
240
|
+
readonly name: Schema.String;
|
|
241
|
+
/** OpenAPI security scheme type */
|
|
242
|
+
readonly type: Schema.Literals<readonly ["http", "apiKey", "oauth2", "openIdConnect"]>;
|
|
243
|
+
/** For type: "http" — e.g. "bearer", "basic" */
|
|
244
|
+
readonly scheme: Schema.OptionFromOptional<Schema.String>;
|
|
245
|
+
/** For type: "http" with scheme "bearer" — e.g. "JWT" */
|
|
246
|
+
readonly bearerFormat: Schema.OptionFromOptional<Schema.String>;
|
|
247
|
+
/** For type: "apiKey" — where the key goes */
|
|
248
|
+
readonly in: Schema.OptionFromOptional<Schema.Literals<readonly ["header", "query", "cookie"]>>;
|
|
249
|
+
/** For type: "apiKey" — the header/query/cookie name */
|
|
250
|
+
readonly headerName: Schema.OptionFromOptional<Schema.String>;
|
|
251
|
+
readonly description: Schema.OptionFromOptional<Schema.String>;
|
|
252
|
+
/** For type: "oauth2" — declared flows (authorizationCode / clientCredentials only; implicit and password are deprecated). */
|
|
253
|
+
readonly flows: Schema.OptionFromOptional<Schema.Struct<{
|
|
254
|
+
readonly authorizationCode: Schema.OptionFromOptional<Schema.Struct<{
|
|
255
|
+
readonly authorizationUrl: Schema.String;
|
|
256
|
+
readonly tokenUrl: Schema.String;
|
|
257
|
+
readonly refreshUrl: Schema.OptionFromOptional<Schema.String>;
|
|
258
|
+
readonly scopes: Schema.$Record<Schema.String, Schema.String>;
|
|
259
|
+
}>>;
|
|
260
|
+
readonly clientCredentials: Schema.OptionFromOptional<Schema.Struct<{
|
|
261
|
+
readonly tokenUrl: Schema.String;
|
|
262
|
+
readonly refreshUrl: Schema.OptionFromOptional<Schema.String>;
|
|
263
|
+
readonly scopes: Schema.$Record<Schema.String, Schema.String>;
|
|
264
|
+
}>>;
|
|
265
|
+
}>>;
|
|
266
|
+
/** For type: "openIdConnect" — the discovery URL. */
|
|
267
|
+
readonly openIdConnectUrl: Schema.OptionFromOptional<Schema.String>;
|
|
268
|
+
}>>;
|
|
269
|
+
readonly authStrategies: Schema.$Array<Schema.Struct<{
|
|
270
|
+
/** The security schemes required together for this strategy */
|
|
271
|
+
readonly schemes: Schema.$Array<Schema.String>;
|
|
272
|
+
}>>;
|
|
273
|
+
readonly headerPresets: Schema.$Array<Schema.Struct<{
|
|
274
|
+
/** Human-readable label for the UI (e.g. "Bearer Token", "API Key + Email") */
|
|
275
|
+
readonly label: Schema.String;
|
|
276
|
+
/** Headers this strategy needs. Value is null when the user must provide it. */
|
|
277
|
+
readonly headers: Schema.$Record<Schema.String, Schema.NullOr<Schema.String>>;
|
|
278
|
+
/** Which headers should be stored as secrets */
|
|
279
|
+
readonly secretHeaders: Schema.$Array<Schema.String>;
|
|
280
|
+
}>>;
|
|
281
|
+
readonly oauth2Presets: Schema.$Array<Schema.Struct<{
|
|
282
|
+
/** Human-readable label for the UI (e.g. "OAuth2 (Authorization Code) — oauth_app") */
|
|
283
|
+
readonly label: Schema.String;
|
|
284
|
+
/** The source security scheme this preset came from (components.securitySchemes key). */
|
|
285
|
+
readonly securitySchemeName: Schema.String;
|
|
286
|
+
/** Which OAuth2 flow this preset uses. */
|
|
287
|
+
readonly flow: Schema.Literals<readonly ["authorizationCode", "clientCredentials"]>;
|
|
288
|
+
/** For authorizationCode: user-agent redirect URL (from the spec). */
|
|
289
|
+
readonly authorizationUrl: Schema.OptionFromOptional<Schema.String>;
|
|
290
|
+
/** Token endpoint to exchange the code / refresh. */
|
|
291
|
+
readonly tokenUrl: Schema.String;
|
|
292
|
+
/** RFC 8707 resource indicator discovered from protected-resource metadata. */
|
|
293
|
+
readonly resource: Schema.OptionFromOptional<Schema.String>;
|
|
294
|
+
/** Optional refresh endpoint if the spec declares one separately. */
|
|
295
|
+
readonly refreshUrl: Schema.OptionFromOptional<Schema.String>;
|
|
296
|
+
/** Declared scopes for this flow: `{ scope: description }`. */
|
|
297
|
+
readonly scopes: Schema.$Record<Schema.String, Schema.String>;
|
|
298
|
+
/** Identity scopes to request alongside API scopes. `"auto"` discovers standard OIDC scopes. */
|
|
299
|
+
readonly identityScopes: Schema.Union<readonly [Schema.Literal<"auto">, Schema.Literal<false>, Schema.$Array<Schema.String>]>;
|
|
300
|
+
/** Provider metadata advertised Client ID Metadata Document support. */
|
|
301
|
+
readonly supportsClientIdMetadataDocument: Schema.optional<Schema.Boolean>;
|
|
302
|
+
}>>;
|
|
303
|
+
readonly healthCheckCandidates: Schema.$Array<Schema.Struct<{
|
|
304
|
+
readonly operation: Schema.String;
|
|
305
|
+
readonly method: Schema.String;
|
|
306
|
+
readonly requiredArgCount: Schema.Number;
|
|
307
|
+
readonly destructive: Schema.Boolean;
|
|
308
|
+
readonly summary: Schema.optional<Schema.String>;
|
|
309
|
+
readonly parameters: Schema.optional<Schema.$Array<Schema.Struct<{
|
|
310
|
+
readonly name: Schema.String;
|
|
311
|
+
readonly location: Schema.String;
|
|
312
|
+
readonly required: Schema.Boolean;
|
|
313
|
+
readonly description: Schema.optional<Schema.String>;
|
|
314
|
+
}>>>;
|
|
315
|
+
readonly responseFields: Schema.optional<Schema.$Array<Schema.Struct<{
|
|
316
|
+
readonly path: Schema.String;
|
|
317
|
+
readonly type: Schema.String;
|
|
318
|
+
}>>>;
|
|
319
|
+
}>>;
|
|
320
|
+
}>;
|
|
321
|
+
export type SpecPreviewSummary = typeof SpecPreviewSummary.Type;
|
|
322
|
+
export declare const specPreviewSummary: (preview: SpecPreview) => SpecPreviewSummary;
|
|
323
|
+
/** Preview already-resolved spec text — extract metadata without registering
|
|
324
|
+
* anything and without any HTTP dependency. */
|
|
325
|
+
export declare const previewSpecText: (specText: string) => Effect.Effect<{
|
|
326
|
+
readonly version: Option.Option<string>;
|
|
327
|
+
readonly operations: readonly {
|
|
328
|
+
readonly path: string;
|
|
329
|
+
readonly summary: Option.Option<string>;
|
|
330
|
+
readonly method: "post" | "options" | "get" | "delete" | "put" | "patch" | "head" | "trace";
|
|
331
|
+
readonly deprecated: boolean;
|
|
332
|
+
readonly tags: readonly string[];
|
|
333
|
+
readonly operationId: string;
|
|
334
|
+
}[];
|
|
335
|
+
readonly description: Option.Option<string>;
|
|
336
|
+
readonly title: Option.Option<string>;
|
|
337
|
+
readonly servers: readonly {
|
|
338
|
+
readonly description: Option.Option<string>;
|
|
339
|
+
readonly url: string;
|
|
340
|
+
readonly variables: Option.Option<{
|
|
341
|
+
readonly [x: string]: {
|
|
342
|
+
readonly default: string;
|
|
343
|
+
readonly description: Option.Option<string>;
|
|
344
|
+
readonly enum: Option.Option<readonly string[]>;
|
|
345
|
+
};
|
|
346
|
+
}>;
|
|
347
|
+
}[];
|
|
348
|
+
readonly tags: readonly string[];
|
|
349
|
+
readonly securitySchemes: readonly {
|
|
350
|
+
readonly name: string;
|
|
351
|
+
readonly type: "oauth2" | "apiKey" | "http" | "openIdConnect";
|
|
352
|
+
readonly in: Option.Option<"header" | "query" | "cookie">;
|
|
353
|
+
readonly description: Option.Option<string>;
|
|
354
|
+
readonly scheme: Option.Option<string>;
|
|
355
|
+
readonly bearerFormat: Option.Option<string>;
|
|
356
|
+
readonly headerName: Option.Option<string>;
|
|
357
|
+
readonly flows: Option.Option<{
|
|
358
|
+
readonly authorizationCode: Option.Option<{
|
|
359
|
+
readonly authorizationUrl: string;
|
|
360
|
+
readonly tokenUrl: string;
|
|
361
|
+
readonly scopes: {
|
|
362
|
+
readonly [x: string]: string;
|
|
363
|
+
};
|
|
364
|
+
readonly refreshUrl: Option.Option<string>;
|
|
365
|
+
}>;
|
|
366
|
+
readonly clientCredentials: Option.Option<{
|
|
367
|
+
readonly tokenUrl: string;
|
|
368
|
+
readonly scopes: {
|
|
369
|
+
readonly [x: string]: string;
|
|
370
|
+
};
|
|
371
|
+
readonly refreshUrl: Option.Option<string>;
|
|
372
|
+
}>;
|
|
373
|
+
}>;
|
|
374
|
+
readonly openIdConnectUrl: Option.Option<string>;
|
|
375
|
+
}[];
|
|
376
|
+
readonly authStrategies: readonly {
|
|
377
|
+
readonly schemes: readonly string[];
|
|
378
|
+
}[];
|
|
379
|
+
readonly headerPresets: readonly {
|
|
380
|
+
readonly label: string;
|
|
381
|
+
readonly headers: {
|
|
382
|
+
readonly [x: string]: string | null;
|
|
383
|
+
};
|
|
384
|
+
readonly secretHeaders: readonly string[];
|
|
385
|
+
}[];
|
|
386
|
+
readonly oauth2Presets: readonly {
|
|
387
|
+
readonly resource: Option.Option<string>;
|
|
388
|
+
readonly label: string;
|
|
389
|
+
readonly authorizationUrl: Option.Option<string>;
|
|
390
|
+
readonly tokenUrl: string;
|
|
391
|
+
readonly scopes: {
|
|
392
|
+
readonly [x: string]: string;
|
|
393
|
+
};
|
|
394
|
+
readonly refreshUrl: Option.Option<string>;
|
|
395
|
+
readonly flow: "authorizationCode" | "clientCredentials";
|
|
396
|
+
readonly identityScopes: false | "auto" | readonly string[];
|
|
397
|
+
readonly securitySchemeName: string;
|
|
398
|
+
readonly supportsClientIdMetadataDocument?: boolean | undefined;
|
|
399
|
+
}[];
|
|
400
|
+
readonly healthCheckCandidates: readonly {
|
|
401
|
+
readonly operation: string;
|
|
402
|
+
readonly method: string;
|
|
403
|
+
readonly requiredArgCount: number;
|
|
404
|
+
readonly destructive: boolean;
|
|
405
|
+
readonly summary?: string | undefined;
|
|
406
|
+
readonly parameters?: readonly {
|
|
407
|
+
readonly name: string;
|
|
408
|
+
readonly required: boolean;
|
|
409
|
+
readonly location: string;
|
|
410
|
+
readonly description?: string | undefined;
|
|
411
|
+
}[] | undefined;
|
|
412
|
+
readonly responseFields?: readonly {
|
|
413
|
+
readonly type: string;
|
|
414
|
+
readonly path: string;
|
|
415
|
+
}[] | undefined;
|
|
416
|
+
}[];
|
|
417
|
+
readonly operationCount: number;
|
|
418
|
+
}, import("./errors").OpenApiParseError | import("./errors").OpenApiExtractionError, never>;
|
|
419
|
+
/** Preview an OpenAPI spec — extract metadata without registering anything.
|
|
420
|
+
* Accepts either a URL or raw JSON/YAML text. */
|
|
421
|
+
export declare const previewSpec: (input: string) => Effect.Effect<{
|
|
422
|
+
readonly version: Option.Option<string>;
|
|
423
|
+
readonly operations: readonly {
|
|
424
|
+
readonly path: string;
|
|
425
|
+
readonly summary: Option.Option<string>;
|
|
426
|
+
readonly method: "post" | "options" | "get" | "delete" | "put" | "patch" | "head" | "trace";
|
|
427
|
+
readonly deprecated: boolean;
|
|
428
|
+
readonly tags: readonly string[];
|
|
429
|
+
readonly operationId: string;
|
|
430
|
+
}[];
|
|
431
|
+
readonly description: Option.Option<string>;
|
|
432
|
+
readonly title: Option.Option<string>;
|
|
433
|
+
readonly servers: readonly {
|
|
434
|
+
readonly description: Option.Option<string>;
|
|
435
|
+
readonly url: string;
|
|
436
|
+
readonly variables: Option.Option<{
|
|
437
|
+
readonly [x: string]: {
|
|
438
|
+
readonly default: string;
|
|
439
|
+
readonly description: Option.Option<string>;
|
|
440
|
+
readonly enum: Option.Option<readonly string[]>;
|
|
441
|
+
};
|
|
442
|
+
}>;
|
|
443
|
+
}[];
|
|
444
|
+
readonly tags: readonly string[];
|
|
445
|
+
readonly securitySchemes: readonly {
|
|
446
|
+
readonly name: string;
|
|
447
|
+
readonly type: "oauth2" | "apiKey" | "http" | "openIdConnect";
|
|
448
|
+
readonly in: Option.Option<"header" | "query" | "cookie">;
|
|
449
|
+
readonly description: Option.Option<string>;
|
|
450
|
+
readonly scheme: Option.Option<string>;
|
|
451
|
+
readonly bearerFormat: Option.Option<string>;
|
|
452
|
+
readonly headerName: Option.Option<string>;
|
|
453
|
+
readonly flows: Option.Option<{
|
|
454
|
+
readonly authorizationCode: Option.Option<{
|
|
455
|
+
readonly authorizationUrl: string;
|
|
456
|
+
readonly tokenUrl: string;
|
|
457
|
+
readonly scopes: {
|
|
458
|
+
readonly [x: string]: string;
|
|
459
|
+
};
|
|
460
|
+
readonly refreshUrl: Option.Option<string>;
|
|
461
|
+
}>;
|
|
462
|
+
readonly clientCredentials: Option.Option<{
|
|
463
|
+
readonly tokenUrl: string;
|
|
464
|
+
readonly scopes: {
|
|
465
|
+
readonly [x: string]: string;
|
|
466
|
+
};
|
|
467
|
+
readonly refreshUrl: Option.Option<string>;
|
|
468
|
+
}>;
|
|
469
|
+
}>;
|
|
470
|
+
readonly openIdConnectUrl: Option.Option<string>;
|
|
471
|
+
}[];
|
|
472
|
+
readonly authStrategies: readonly {
|
|
473
|
+
readonly schemes: readonly string[];
|
|
474
|
+
}[];
|
|
475
|
+
readonly headerPresets: readonly {
|
|
476
|
+
readonly label: string;
|
|
477
|
+
readonly headers: {
|
|
478
|
+
readonly [x: string]: string | null;
|
|
479
|
+
};
|
|
480
|
+
readonly secretHeaders: readonly string[];
|
|
481
|
+
}[];
|
|
482
|
+
readonly oauth2Presets: readonly {
|
|
483
|
+
readonly resource: Option.Option<string>;
|
|
484
|
+
readonly label: string;
|
|
485
|
+
readonly authorizationUrl: Option.Option<string>;
|
|
486
|
+
readonly tokenUrl: string;
|
|
487
|
+
readonly scopes: {
|
|
488
|
+
readonly [x: string]: string;
|
|
489
|
+
};
|
|
490
|
+
readonly refreshUrl: Option.Option<string>;
|
|
491
|
+
readonly flow: "authorizationCode" | "clientCredentials";
|
|
492
|
+
readonly identityScopes: false | "auto" | readonly string[];
|
|
493
|
+
readonly securitySchemeName: string;
|
|
494
|
+
readonly supportsClientIdMetadataDocument?: boolean | undefined;
|
|
495
|
+
}[];
|
|
496
|
+
readonly healthCheckCandidates: readonly {
|
|
497
|
+
readonly operation: string;
|
|
498
|
+
readonly method: string;
|
|
499
|
+
readonly requiredArgCount: number;
|
|
500
|
+
readonly destructive: boolean;
|
|
501
|
+
readonly summary?: string | undefined;
|
|
502
|
+
readonly parameters?: readonly {
|
|
503
|
+
readonly name: string;
|
|
504
|
+
readonly required: boolean;
|
|
505
|
+
readonly location: string;
|
|
506
|
+
readonly description?: string | undefined;
|
|
507
|
+
}[] | undefined;
|
|
508
|
+
readonly responseFields?: readonly {
|
|
509
|
+
readonly type: string;
|
|
510
|
+
readonly path: string;
|
|
511
|
+
}[] | undefined;
|
|
512
|
+
}[];
|
|
513
|
+
readonly operationCount: number;
|
|
514
|
+
}, import("./errors").OpenApiParseError | import("./errors").OpenApiExtractionError, import("effect/unstable/http/HttpClient").HttpClient>;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|