@wirebench/engine 2.1.1

package/dist/rest/openapi/model.js

@@ -0,0 +1,37 @@
+/**
+ * The subset of OpenAPI 3.0.x and 3.1.x this client consumes, as readonly types.
+ *
+ * Deliberately a *subset*: an import turns a description into requests you can send, so the model
+ * carries what decides a request — where it goes, what it carries, and what it authenticates with —
+ * and nothing else. Everything else a document says (callbacks, links, webhooks, vendor extensions)
+ * is kept only as a count, so the import summary can say what it did not understand rather than
+ * quietly dropping it.
+ *
+ * Every field is optional where the specification allows it, because a document in the wild will
+ * omit anything that is not required, and a parser that insists otherwise refuses documents users
+ * legitimately have.
+ */
+/** The HTTP methods an operation key may name, per OpenAPI's Path Item Object. */
+export const HTTP_METHODS = [
+    'get',
+    'put',
+    'post',
+    'delete',
+    'options',
+    'head',
+    'patch',
+    'trace',
+    'query',
+];
+/**
+ * The base URL a server entry resolves to, with each `{variable}` replaced by its default.
+ *
+ * A variable with no default is left as it is: the API's base URL then still shows the template,
+ * which is honest — the user has to decide what it should be, and the field is editable.
+ */
+export function serverUrl(server) {
+    return server.url.replace(/\{([^{}]+)\}/g, (whole, name) => {
+        const fallback = server.variables?.[name]?.default;
+        return fallback === undefined || fallback === '' ? whole : fallback;
+    });
+}

package/dist/rest/openapi/parse.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Reading an OpenAPI or Swagger document into the model this client imports from.
+ *
+ * Tolerant on purpose. A description in the wild is written by hand, generated by a framework, or
+ * both, and a parser that refuses a whole document because one operation is malformed refuses
+ * documents users legitimately need. So anything that cannot be understood is *skipped and counted*
+ * — the import summary names it — and only two things are fatal: text that is neither JSON nor
+ * YAML, and a document that does not declare a supported OpenAPI or Swagger version. Swagger 1.x
+ * and 2.0 documents are converted into the intermediate OpenAPI representation.
+ *
+ * The parser reads a document that is already resolved: `refs.ts` inlines every `$ref` first, so
+ * nothing here has to fetch anything.
+ */
+import type { JsonSchema, OpenApiDocument, OpenApiVersion } from './model.js';
+/** A plain object, which is all this parser ever walks into. */
+type Record_ = Readonly<Record<string, unknown>>;
+/**
+ * Parses text as JSON when it looks like JSON, and as YAML otherwise.
+ *
+ * JSON is a subset of YAML, so one parser would do — but a JSON document with a syntax error gets a
+ * far better message from `JSON.parse`, and that message is what the user has to act on.
+ *
+ * @throws OpenApiError `openapi-malformed` when the text parses as neither.
+ */
+export declare function parseDocumentText(text: string, where?: string): unknown;
+/**
+ * The version a document declares, as a major-minor this client supports.
+ *
+ * @throws OpenApiError `openapi-unsupported-version` for an OpenAPI major this client
+ * does not read, and `openapi-not-a-document` when there is no version at all.
+ */
+export declare function versionOf(root: unknown): {
+    readonly version: OpenApiVersion;
+    readonly declared: string;
+};
+/**
+ * Reads a resolved OpenAPI document.
+ *
+ * @param root the parsed document, with every `$ref` already inlined (see `refs.ts`)
+ * @throws OpenApiError `openapi-not-a-document` / `openapi-unsupported-version` as {@link versionOf} does
+ */
+export declare function parseOpenApiDocument(root: unknown): OpenApiDocument;
+export declare function parseSchema(value: Record_): JsonSchema;
+export {};