apps 0.0.1-beta.55 → 0.0.1-beta.59

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

@@ -37,4 +37,54 @@ declare const OpenapiCompileError_base: Schema.Class<OpenapiCompileError, Schema
 export declare class OpenapiCompileError extends OpenapiCompileError_base {
     get message(): string;
 }
+/** A tool a generated OpenAPI router exposes, read from the definition alone. */
+export declare const OpenapiToolName: Schema.Struct<{
+    /** The tool name relative to the router, as `withApprovals` receives it. */
+    readonly name: Schema.String;
+    /** The HTTP method, such as `GET`. */
+    readonly method: Schema.String;
+    /** The request path, including any `pathPrefix`. */
+    readonly path: Schema.String;
+    readonly operationId: Schema.optionalKey<Schema.String>;
+    /** After `kinds` (keyed by `operationId`, else `name`); otherwise reading methods are queries. */
+    readonly kind: Schema.Literals<readonly ["query", "mutation"]>;
+    /** Callable without credentials, so every account and a router without one expose it. */
+    readonly public: Schema.Boolean;
+    /** The `methods` and `oauth` entries whose accounts expose it. */
+    readonly methods: Schema.$Array<Schema.String>;
+}>;
+export type OpenapiToolName = typeof OpenapiToolName.Type;
+/** Every tool a definition yields for some account, and the operations the compiler left out. */
+export declare const OpenapiToolNames: Schema.Struct<{
+    readonly tools: Schema.$Array<Schema.Struct<{
+        /** The tool name relative to the router, as `withApprovals` receives it. */
+        readonly name: Schema.String;
+        /** The HTTP method, such as `GET`. */
+        readonly method: Schema.String;
+        /** The request path, including any `pathPrefix`. */
+        readonly path: Schema.String;
+        readonly operationId: Schema.optionalKey<Schema.String>;
+        /** After `kinds` (keyed by `operationId`, else `name`); otherwise reading methods are queries. */
+        readonly kind: Schema.Literals<readonly ["query", "mutation"]>;
+        /** Callable without credentials, so every account and a router without one expose it. */
+        readonly public: Schema.Boolean;
+        /** The `methods` and `oauth` entries whose accounts expose it. */
+        readonly methods: Schema.$Array<Schema.String>;
+    }>>;
+    /**
+     * Operations the compiler left out, and why. An operation it imports but no configured `methods`
+     * or `oauth` entry can authorize is missing from `tools` and is not listed here.
+     */
+    readonly skipped: Schema.$Array<Schema.Struct<{
+        /** The tool name the operation would have; reading that tool reports why it is missing. */
+        readonly name: Schema.String;
+        /** The HTTP method, such as `GET`. */
+        readonly method: Schema.String;
+        /** The path as the definition declares it. */
+        readonly path: Schema.String;
+        readonly code: Schema.Literals<readonly ["server_protocol", "server_url", "external_reference", "circular_reference", "schema_keyword", "schema_reference", "missing_component", "openapi_version", "auth_helper", "auth_missing", "operation_path", "operation_method", "duplicate_operation", "server_missing", "multiple_hosts", "parameter_encoding", "parameter_style", "request_body", "combined_oauth", "auth_method", "event_stream", "input_schema", "no_operations", "no_supported_operations", "invalid_document", "source_generation", "authoring_reference"]>;
+        readonly reason: Schema.String;
+    }>>;
+}>;
+export type OpenapiToolNames = typeof OpenapiToolNames.Type;
 export {};

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

@@ -3,6 +3,7 @@ import { Duration } from "effect";
 import type { AppCache } from "../contracts/cache.js";
 import { OpenapiOperation, type OpenapiToolsOptions } from "../contracts/openapi.js";
 import { JsonObject, JsonValue } from "../contracts/schema.js";
+import { type OpenapiToolNames } from "../contracts/openapi-compile.js";
 import { type OperationKinds } from "./protocol-operations.js";
 import { type RouterDeclaration } from "./router.js";
 /** Static credential placement and destination are reviewed when the app is authored/imported. */
@@ -40,3 +41,14 @@ export interface OpenapiSourceOptions extends Omit<OpenapiToolsOptions, "operati
 export declare function patchOpenapi(root: JsonObject, patches: OpenapiSourceOptions["patches"]): JsonObject;
 /** No I/O during app construction. All accounts share credential-free compilation. */
 export declare const liveOpenapiRouter: (options: OpenapiSourceOptions) => RouterDeclaration;
+/** The settings `openapiToolNames` reads: the router's, without an account or cache. */
+export type OpenapiToolNamesOptions = Omit<OpenapiSourceOptions, "cache" | "account" | "parameterDefaults" | "freshFor" | "staleFor">;
+/**
+ * The tools `liveOpenapiRouter` with the same options exposes, from the definition alone: no
+ * account, cache or deployment. Each tool says which `methods` and `oauth` entries expose it, so
+ * an author can check the names a `withApprovals` policy matches before any account connects.
+ * `skipped` lists only the operations the compiler left out and why. An operation no configured
+ * `methods` or `oauth` entry can authorize is missing from `tools` and not listed in `skipped`.
+ * `fetch` defaults to the global fetch.
+ */
+export declare const openapiToolNames: (options: OpenapiToolNamesOptions) => Promise<OpenapiToolNames>;

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

@@ -9,4 +9,4 @@ export { OpenapiError, isOpenapiTextMedia, openapiBinaryResultSchema, OpenapiErr
 export declare const openapiRouter: (options: OpenapiToolsOptions, kinds?: OperationKinds) => Promise<import("./index.js").RouterDeclaration<unknown, unknown>>;
 export type { OperationKinds } from "./implementation/protocol-operations.js";
 export * from "./contracts/openapi-compile.js";
-export { liveOpenapiRouter, type OpenapiSourceOptions } from "./implementation/openapi-source.js";
+export { liveOpenapiRouter, openapiToolNames, type OpenapiSourceOptions, type OpenapiToolNamesOptions, } from "./implementation/openapi-source.js";