openapi

Import

Import

import * as api from "@fungi.computer/forage/openapi";

Exports

Kind	Export	Description
Cclass	OpenApiError	A bounded intake refusal, distinct from a listed unsupported operation.
Ttype alias	OpenApiThirdPartyText	Bounded provider-authored text. Hosts must frame it as data, never instructions.
Ttype alias	OpenApiIntakeOptions	Optional owner-declared credential parameter excluded from guest input.
Ttype alias	OpenApiRefusalCode	Stable intake and per-operation refusal codes.
Ttype alias	OpenApiOperation	Decoded normalized operation ready for selection, not an execution grant.
Ttype alias	OpenApiPreviewOperation	An operation’s supported call shape or bounded unsupported reason.
constconstant	openApiOperationSchema	One stored operation, independent of spec-host URLs or credentials.
fnfunction	normalizeOpenApi()	Pure intake: the host supplies bounded spec text, never a fetch locator.
fnfunction	parseOpenApiTable()	Decode selected operations before persistence or execution; no authority is granted.

OpenApiErrorCclass

A bounded intake refusal, distinct from a listed unsupported operation.

Extends

• Error

Constructors

Constructor

Signature

new OpenApiError(
   code,
   message,
   cause?
): OpenApiError;

Parameters

Parameter	Type
code	OpenApiRefusalCode
message	string
cause?	unknown

Returns

OpenApiError

Overrides

Signature

Error.constructor;

Properties

name

Signature

readonly name: "OpenApiError" = "OpenApiError";

Overrides

Signature

Error.name;

code

Signature

readonly code: OpenApiRefusalCode;

OpenApiThirdPartyTextTtype alias

Signature

type OpenApiThirdPartyText = string & z.BRAND<"ThirdPartyText">;

Bounded provider-authored text. Hosts must frame it as data, never instructions.

---

OpenApiIntakeOptionsTtype alias

Signature

type OpenApiIntakeOptions = object;

Optional owner-declared credential parameter excluded from guest input.

Properties

authParameter?

Signature

optional authParameter?: object;

in

Signature

in: "header" | "query";

name

Signature

name: string;

---

OpenApiRefusalCodeTtype alias

Signature

type OpenApiRefusalCode =
  | "too_large"
  | "invalid_spec"
  | "not_openapi3"
  | "nodes_limit"
  | "depth_limit"
  | "alias_limit"
  | "external_reference"
  | "recursive_schema"
  | "operations_limit"
  | "invalid_operation"
  | "unsupported_schema"
  | "parameter_collision"
  | "unsafe_auth_parameter"
  | "unsafe_header"
  | "unsupported_parameter"
  | "unsupported_media"
  | "unsupported_path_item"
  | "unsupported_method"
  | "table_too_large"
  | "invalid_table"
  | "unsafe_name"
  | "unsafe_path";

Stable intake and per-operation refusal codes.

---

OpenApiOperationTtype alias

Signature

type OpenApiOperation = z.output<typeof openApiOperationSchema>;

Decoded normalized operation ready for selection, not an execution grant.

---

OpenApiPreviewOperationTtype alias

Signature

type OpenApiPreviewOperation =
  | OpenApiOperation
  | {
      status: "unsupported";
      name: string;
      method: string;
      path: string;
      reason: OpenApiRefusalCode;
    };

An operation’s supported call shape or bounded unsupported reason.

openApiOperationSchemaconstconstant

Signature

const openApiOperationSchema: ZodObject<
  {
    status: ZodLiteral<"supported">;
    name: ZodString;
    method: ZodEnum<{
      GET: "GET";
      HEAD: "HEAD";
      OPTIONS: "OPTIONS";
      POST: "POST";
      PUT: "PUT";
      PATCH: "PATCH";
      DELETE: "DELETE";
    }>;
    path: ZodString;
    effect: ZodEnum<{
      write: "write";
      read: "read";
    }>;
    description: $ZodBranded<ZodString, "ThirdPartyText", "out">;
    textSource: ZodLiteral<"third_party">;
    tags: ZodArray<$ZodBranded<ZodString, "ThirdPartyText", "out">>;
    parameters: ZodArray<
      ZodObject<
        {
          name: ZodLazy<ZodString>;
          in: ZodEnum<{
            header: "header";
            path: "path";
            query: "query";
          }>;
          required: ZodDefault<ZodBoolean>;
          schema: ZodUnion<
            readonly [ZodRecord<ZodString, ZodJSONSchema>, ZodBoolean]
          >;
          style: ZodOptional<ZodString>;
          explode: ZodOptional<ZodBoolean>;
          allowReserved: ZodOptional<ZodBoolean>;
        },
        $strip
      >
    >;
    input: ZodPipe<
      ZodUnknown,
      ZodType<
        boolean | Record<string, JSONType>,
        unknown,
        $ZodTypeInternals<boolean | Record<string, JSONType>, unknown>
      >
    >;
    output: ZodPipe<
      ZodUnknown,
      ZodType<
        boolean | Record<string, JSONType>,
        unknown,
        $ZodTypeInternals<boolean | Record<string, JSONType>, unknown>
      >
    >;
  },
  $strict
>;

One stored operation, independent of spec-host URLs or credentials.

normalizeOpenApi()fnfunction

Signature

function normalizeOpenApi(
  source,
  options?,
): Promise<{
  title: string & $brand<"ThirdPartyText">;
  version: string;
  servers: string[];
  authHints: (
    | {
        scheme: string;
        kind: "api_key_header" | "api_key_query";
        name: string;
      }
    | {
        scheme: string;
        kind: "bearer" | "oauth" | "unsupported";
      }
  )[];
  operations: OpenApiPreviewOperation[];
  tableDigest: string;
}>;

Pure intake: the host supplies bounded spec text, never a fetch locator.

Parameters

Parameter	Type
source	string
options	OpenApiIntakeOptions

Returns

Promise<{ title: string & $brand<"ThirdPartyText">; version: string; servers: string[]; authHints: ( | { scheme: string; kind: "api_key_header" | "api_key_query"; name: string; } | { scheme: string; kind: "bearer" | "oauth" | "unsupported"; })[]; operations: OpenApiPreviewOperation[]; tableDigest: string; }>

---

parseOpenApiTable()fnfunction

Signature

function parseOpenApiTable(source): Promise<{
  operations: object[];
  digest: string;
}>;

Decode selected operations before persistence or execution; no authority is granted.

Parameters

Parameter	Type
source	unknown

Returns

Promise<{ operations: object[]; digest: string; }>