@sonatel-os/openapi-runtime 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,74 @@
+/**
+ * Save/register an OpenAPI spec by name.
+ * Automatically generates operationIds if missing.
+ * @param {{ name: string, specName: string|object, autoAuth?: boolean }} opts
+ */
+export function save({ name, specName, autoAuth }: {
+    name: string;
+    specName: string | object;
+    autoAuth?: boolean;
+}): Promise<{
+    name: string;
+    operations: import("./src/registry.js").OperationInfo[];
+}>;
+/** Update an existing spec by name (re-loads). */
+export function update(opts: any): Promise<{
+    name: string;
+    operations: import("./src/registry.js").OperationInfo[];
+}>;
+/** Remove a spec from registry. */
+export function remove({ name }: {
+    name: any;
+}): void;
+/** List saved spec names. */
+export function listSpecs(): any[];
+/** List APIs (operations) for a spec. */
+export function listAPIs({ name }: {
+    name: any;
+}): any;
+/** Return raw OpenAPI operation object. */
+export function showContract({ name, api }: {
+    name: any;
+    api: any;
+}): any;
+/** Build a response sample from schema. */
+export function showResponseSample({ name, api, status }: {
+    name: any;
+    api: any;
+    status: any;
+}): unknown;
+/** Build a request sample for JSON body. */
+export function showRequestSample({ name, api }: {
+    name: any;
+    api: any;
+}): unknown;
+/** Execute an API by operationId. */
+export function executeAPI({ name, api, params, body, headers, qs }: {
+    name: any;
+    api: any;
+    params?: {} | undefined;
+    body: any;
+    headers?: {} | undefined;
+    qs?: {} | undefined;
+}): Promise<any>;
+/** Validate a response against the operation schema. */
+export function validateResponse(opts: any): {
+    valid: boolean;
+    errors?: undefined;
+} | {
+    valid: boolean;
+    errors: import("ajv").ErrorObject<string, Record<string, any>, unknown>[];
+};
+/** Return a mocked response payload (no network). */
+export function mockAPI({ name, api, status }: {
+    name: any;
+    api: any;
+    status: any;
+}): unknown;
+/** Global headers (applied to all specs) */
+export function setGlobalHeaders(headers: any): void;
+/** Per-spec default headers */
+export function setSpecHeaders(name: any, headers: any): void;
+/** Interceptors: { request?, response?, error? } */
+export function setInterceptors(name: any, interceptors: any): void;
+export { setAuth, apiKey, bearer, basic, clientCredentials } from "./src/auth.js";