@stellar-agent-services/provider-kit 0.0.0-stage → 0.1.1

package/dist/gateway/openapi.d.ts

@@ -0,0 +1,69 @@
+import type { JsonObject } from "@stellar-agent-services/protocol";
+import type { GatewayService } from "./config.js";
+/**
+ * What a generated service starts with, as `provider-kit init` writes it. The developer sets the real values. A call
+ * expected to take seconds is charged only if it succeeds: on-success suits work under half a minute (spec §3.2).
+ */
+export declare const FIRST_GUESS: {
+    readonly price: "0.01";
+    readonly charge: "on-success";
+    readonly expectedDurationSeconds: 5;
+    readonly capacity: {
+        readonly concurrency: 2;
+        readonly maxQueueWaitSeconds: 60;
+    };
+};
+/** The description a service gets when the document has none, as in `provider-kit init`'s starter config. */
+export declare const DESCRIPTION_TO_WRITE = "What it does, when to use it, and its limits (input size, languages, what it won't do).";
+/** The provider description init writes when it has none. */
+export declare const PROVIDER_DESCRIPTION_TO_WRITE = "What you offer, in a sentence or two.";
+export interface SkippedOperation {
+    method: string;
+    path: string;
+    reason: string;
+}
+/** An upstream header whose value comes from the environment: the API's own credentials. */
+export interface UpstreamCredential {
+    header: string;
+    /** The environment variable it reads. */
+    name: string;
+    /** What the variable holds. */
+    holds: string;
+}
+export interface OpenApiGateway {
+    /** The document, for messages: its title and version, and the OpenAPI version. */
+    api: {
+        title: string;
+        version?: string;
+        openapi: string;
+    };
+    provider: {
+        name: string;
+        description?: string;
+    };
+    services: GatewayService[];
+    skipped: SkippedOperation[];
+    credentials: UpstreamCredential[];
+    /** Services whose description is not the document's own, but its summary or a placeholder: to write by hand. */
+    undescribed: string[];
+    /** What the developer has to finish by hand. */
+    warnings: string[];
+}
+/** The document can't be read or used at all. */
+export declare class OpenApiError extends Error {
+    name: string;
+}
+/** Reads an OpenAPI 3 document, JSON or YAML, from a file or an http(s) URL. `url` is where it came from, after redirects. */
+export declare function readOpenApi(source: string, fetcher?: typeof fetch): Promise<{
+    document: JsonObject;
+    url?: string;
+}>;
+/**
+ * The gateway services an OpenAPI document describes. `url` is where the document came from, to resolve a relative
+ * server URL against; `upstream` is the API's base URL, which wins over the document's servers.
+ */
+export declare function gatewayFromOpenApi(document: JsonObject, options?: {
+    url?: string;
+    upstream?: string;
+}): Promise<OpenApiGateway>;
+//# sourceMappingURL=openapi.d.ts.map

package/dist/gateway/openapi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"openapi.d.ts","sourceRoot":"","sources":["../../src/gateway/openapi.ts"],"names":[],"mappings":"AAiBA,OAAO,KAAK,EAAE,UAAU,EAAa,MAAM,kCAAkC,CAAC;AAO9E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAElD;;;GAGG;AACH,eAAO,MAAM,WAAW;;;;;;;;CAKoB,CAAC;AAE7C,6GAA6G;AAC7G,eAAO,MAAM,oBAAoB,4FAA4F,CAAC;AAC9H,6DAA6D;AAC7D,eAAO,MAAM,6BAA6B,0CAA0C,CAAC;AAgCrF,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,4FAA4F;AAC5F,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,yCAAyC;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,+BAA+B;IAC/B,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,cAAc;IAC7B,kFAAkF;IAClF,GAAG,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAC1D,QAAQ,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACjD,QAAQ,EAAE,cAAc,EAAE,CAAC;IAC3B,OAAO,EAAE,gBAAgB,EAAE,CAAC;IAC5B,WAAW,EAAE,kBAAkB,EAAE,CAAC;IAClC,gHAAgH;IAChH,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,gDAAgD;IAChD,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,iDAAiD;AACjD,qBAAa,YAAa,SAAQ,KAAK;IAC5B,IAAI,SAAkB;CAChC;AAOD,8HAA8H;AAC9H,wBAAsB,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,OAAO,KAAa,GAAG,OAAO,CAAC;IAAE,QAAQ,EAAE,UAAU,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC,CAuBhI;AAyBD;;;GAGG;AACH,wBAAsB,kBAAkB,CAAC,QAAQ,EAAE,UAAU,EAAE,OAAO,GAAE;IAAE,GAAG,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAO,GAAG,OAAO,CAAC,cAAc,CAAC,CAsEzI"}