apps 0.0.1-beta.100 → 0.0.1-beta.101

package/types/apps/src/implementation/openapi-compile.d.ts

@@ -11,6 +11,16 @@ import { type OpenApiDocument } from "./openapi-document.js";
  * `scripts/check-api-errors.ts` applies this to Executor's own API documents.
  */
 export declare function errorResponses(document: OpenApiDocument, operation: JsonObject, at: string): OpenapiErrorResponse[];
+/**
+ * The tool name, method and declared path of every operation a definition declares, in definition
+ * order, whether or not the compiler imports it: the names `compileOpenApiDocument` gives them.
+ * The document is consumed, as compilation consumes it.
+ */
+export declare const compiledOperationNames: (document: JsonObject) => Effect.Effect<{
+    name: string;
+    method: string;
+    path: string;
+}[], TemplateError, never>;
 /** Compile a revision of a live OpenAPI source into tool declarations for the app runtime.
  * The document is consumed: compilation upgrades it in place instead of copying it. It must be a
  * tree, with no object reached twice, as parsed JSON is.

package/types/apps/src/implementation/openapi-document.d.ts

@@ -64,7 +64,10 @@ export declare function openApiDocument(input: JsonObject): Promise<{
      * a resolved Response, Parameter, Request Body or Path Item where the definition declares it.
      */
     origin(value: unknown): string | undefined;
-    /** Inspect a component schema without expanding its children. OpenAPI object refs must already be resolved by Swagger. */
+    /**
+     * Inspect the schema a reference reaches without expanding its children: a component, or any
+     * other schema in the definition. OpenAPI object references are already resolved.
+     */
     resolve(value: JsonObject): JsonObject;
     /** Compose a Draft 2020-12 schema around API Schema Objects. Only values passed to
      * `api` use the document's OpenAPI dialect; Executor-authored wrappers are already

package/types/apps/src/openapi.d.ts

@@ -14,4 +14,20 @@ export * from "./contracts/openapi-compile.js";
  * operationId, first tag, method and path alone. It reads no document and compiles nothing.
  */
 export { planOperationNames, type OperationNameInput } from "./implementation/openapi-names.js";
+/** One operation a document declares, as `openapiOperationNames` lists it. */
+export interface OpenapiDeclaredOperation {
+    /** The tool name `liveOpenapiRouter` gives the operation. */
+    readonly name: string;
+    /** The HTTP method, such as `GET`. */
+    readonly method: string;
+    /** The path as the document declares it. */
+    readonly path: string;
+}
+/**
+ * Every operation a document declares, in document order, with the name `liveOpenapiRouter` gives
+ * it, whether or not the router can import it. Unlike `planOperationNames`, it reads the document
+ * as the router does, references included. It rejects with `OpenapiCompileError` when the
+ * document is not one the router reads. The document is not modified.
+ */
+export declare const openapiOperationNames: (document: Readonly<Record<string, unknown>>) => Promise<readonly OpenapiDeclaredOperation[]>;
 export { liveOpenapiRouter, openapiToolNames, type OpenapiSourceOptions, type OpenapiToolNamesOptions, } from "./implementation/openapi-source.js";