apps 0.0.1-beta.8 → 0.0.1-beta.81

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (180) hide show
  1. package/README.md +25 -22
  2. package/framework-reference.json +1 -1
  3. package/js/{chunk-72JNVHPK.js → chunk-4NFSABEA.js} +4 -3
  4. package/js/chunk-5FHWNLCI.js +88 -0
  5. package/js/chunk-5WGONRKQ.js +426 -0
  6. package/js/{chunk-M3B3DE4K.js → chunk-74YVXBKY.js} +463 -218
  7. package/js/chunk-CDXQDN7W.js +92 -0
  8. package/js/{chunk-UK573G7W.js → chunk-EOPQ727L.js} +87 -51
  9. package/js/{chunk-27F7W2LG.js → chunk-H2CJWXA3.js} +2 -2
  10. package/js/{chunk-JU7VHODU.js → chunk-H72MEDMN.js} +65 -10
  11. package/js/{chunk-FL2QR3XW.js → chunk-HJG4RBYM.js} +333 -69
  12. package/js/chunk-I6Q7ZPKJ.js +49 -0
  13. package/js/{chunk-CDL5PM2Q.js → chunk-IFJU5SYQ.js} +19082 -18402
  14. package/js/{chunk-VFZKSM3T.js → chunk-JPEUKEV4.js} +3 -3
  15. package/js/{chunk-5T57N25Q.js → chunk-KGCTYL2S.js} +511 -63
  16. package/js/{chunk-KUMBKVJD.js → chunk-KLYSEHUD.js} +2 -2
  17. package/js/{chunk-WLE7WX2U.js → chunk-NG56RPCA.js} +2348 -472
  18. package/js/chunk-OD3KFKZD.js +1617 -0
  19. package/js/{chunk-Z5M2LQOZ.js → chunk-OY47QPQY.js} +67 -55
  20. package/js/{chunk-57RKNWL2.js → chunk-PD6I2SDG.js} +4 -4
  21. package/js/chunk-PL5KOEZD.js +334 -0
  22. package/js/chunk-Q4IZAUIF.js +285 -0
  23. package/js/{chunk-RJDDBDSN.js → chunk-QWQM3CLH.js} +795 -177
  24. package/js/{chunk-RFVIONFX.js → chunk-TE25A7D6.js} +123 -44
  25. package/js/{chunk-IJX4CYZO.js → chunk-TUMGL2OC.js} +228 -264
  26. package/js/chunk-W6XCQAXP.js +171 -0
  27. package/js/chunk-WCGAO3X5.js +348 -0
  28. package/js/{chunk-IPI4MFSN.js → chunk-XBG7HHXC.js} +2 -2
  29. package/js/{chunk-CMYUWAX7.js → chunk-YQUG4CES.js} +126 -31
  30. package/js/{chunk-UESPOTUI.js → chunk-Z2SWTZCF.js} +861 -231
  31. package/js/client.js +142 -94
  32. package/js/contracts.js +127 -26
  33. package/js/effect.js +19 -19
  34. package/js/{es-APDZKREY.js → es-DIULA3ZF.js} +62 -1659
  35. package/js/graphql.js +50 -40
  36. package/js/host.js +83 -58
  37. package/js/index.js +131 -46
  38. package/js/mcp/effect.js +23 -21
  39. package/js/mcp/stdio.js +44 -34
  40. package/js/mcp.js +76 -53
  41. package/js/openapi.js +4071 -1357
  42. package/js/react.js +2 -3
  43. package/js/skills/effect.js +6 -3
  44. package/js/skills.js +208 -81
  45. package/js/storage/facet.js +1 -540
  46. package/js/ui/auth/contracts.js +2 -2
  47. package/js/ui/auth.js +5 -5
  48. package/js/ui/contracts.js +5 -4
  49. package/js/ui/serving.js +8604 -223
  50. package/package.json +3 -4
  51. package/runtime.json +1 -1
  52. package/types/app-cache/src/contracts/cache.d.ts +18 -0
  53. package/types/app-cache/src/index.d.ts +34 -2
  54. package/types/apps/src/contracts/api-response-error.d.ts +4 -0
  55. package/types/apps/src/contracts/app.d.ts +7 -3
  56. package/types/apps/src/contracts/cache.d.ts +20 -0
  57. package/types/apps/src/contracts/context.d.ts +19 -11
  58. package/types/apps/src/contracts/elicitation.d.ts +23 -7
  59. package/types/apps/src/contracts/events.d.ts +93 -0
  60. package/types/apps/src/contracts/failure.d.ts +30 -1
  61. package/types/apps/src/contracts/graphql.d.ts +2 -1
  62. package/types/apps/src/contracts/host.d.ts +649 -17
  63. package/types/apps/src/contracts/live.d.ts +2 -0
  64. package/types/apps/src/contracts/mcp.d.ts +80 -10
  65. package/types/apps/src/contracts/network.d.ts +120 -0
  66. package/types/apps/src/contracts/openapi-compile.d.ts +82 -3
  67. package/types/apps/src/contracts/openapi.d.ts +41 -9
  68. package/types/apps/src/contracts/operations.d.ts +8 -4
  69. package/types/apps/src/contracts/placement.d.ts +102 -0
  70. package/types/apps/src/contracts/protocol-version.d.ts +2 -2
  71. package/types/apps/src/contracts/protocols/1.d.ts +733 -81
  72. package/types/apps/src/contracts/protocols/10.d.ts +1450 -0
  73. package/types/apps/src/contracts/protocols/2.d.ts +69 -26
  74. package/types/apps/src/contracts/protocols/3.d.ts +133 -33
  75. package/types/apps/src/contracts/protocols/4.d.ts +122 -45
  76. package/types/apps/src/contracts/protocols/5.d.ts +157 -47
  77. package/types/apps/src/contracts/protocols/6.d.ts +1629 -0
  78. package/types/apps/src/contracts/protocols/7.d.ts +1785 -0
  79. package/types/apps/src/contracts/protocols/8.d.ts +1182 -0
  80. package/types/apps/src/contracts/protocols/9.d.ts +1104 -0
  81. package/types/apps/src/contracts/protocols/current.d.ts +3843 -0
  82. package/types/apps/src/contracts/protocols/oauth-6.d.ts +74 -0
  83. package/types/apps/src/contracts/protocols/oauth.d.ts +134 -0
  84. package/types/apps/src/contracts/provider-error.d.ts +9 -0
  85. package/types/apps/src/contracts/provider.d.ts +90 -6
  86. package/types/apps/src/contracts/skills.d.ts +50 -13
  87. package/types/apps/src/contracts/sql.d.ts +63 -0
  88. package/types/apps/src/contracts/ui.d.ts +37 -3
  89. package/types/apps/src/contracts/workflows.d.ts +6 -0
  90. package/types/apps/src/facet.d.ts +4 -5
  91. package/types/apps/src/host.d.ts +5 -0
  92. package/types/apps/src/implementation/account-router.d.ts +4 -3
  93. package/types/apps/src/implementation/authoring.d.ts +25 -5
  94. package/types/apps/src/implementation/browser-scripts.gen.d.ts +6 -0
  95. package/types/apps/src/implementation/cache.d.ts +28 -1
  96. package/types/apps/src/implementation/catalog-cache.d.ts +35 -4
  97. package/types/apps/src/implementation/elicitation.d.ts +18 -15
  98. package/types/apps/src/implementation/events.d.ts +59 -0
  99. package/types/apps/src/implementation/failure-detail.d.ts +25 -3
  100. package/types/apps/src/implementation/graphql-catalog.d.ts +3 -3
  101. package/types/apps/src/implementation/graphql.d.ts +4 -3
  102. package/types/apps/src/implementation/input-problems.d.ts +6 -2
  103. package/types/apps/src/implementation/invocation-timing.d.ts +18 -0
  104. package/types/apps/src/implementation/live.d.ts +2 -2
  105. package/types/apps/src/implementation/mcp-call.d.ts +6 -5
  106. package/types/apps/src/implementation/mcp-catalog.d.ts +6 -4
  107. package/types/apps/src/implementation/mcp-client.d.ts +17 -9
  108. package/types/apps/src/implementation/mcp-stdio.d.ts +1 -1
  109. package/types/apps/src/implementation/mcp-tools.d.ts +2 -1
  110. package/types/apps/src/implementation/mcp.d.ts +20 -9
  111. package/types/apps/src/implementation/network.d.ts +16 -0
  112. package/types/apps/src/implementation/openapi-compile.d.ts +26 -6
  113. package/types/apps/src/implementation/openapi-document.d.ts +46 -19
  114. package/types/apps/src/implementation/openapi-names.d.ts +9 -4
  115. package/types/apps/src/implementation/openapi-request.d.ts +10 -2
  116. package/types/apps/src/implementation/openapi-source.d.ts +18 -0
  117. package/types/apps/src/implementation/openapi-upgrade.d.ts +4 -0
  118. package/types/apps/src/implementation/operations.d.ts +17 -2
  119. package/types/apps/src/implementation/optimistic.d.ts +1 -1
  120. package/types/apps/src/implementation/placement.d.ts +60 -0
  121. package/types/apps/src/implementation/protocol-operations.d.ts +3 -0
  122. package/types/apps/src/implementation/provider-error.d.ts +28 -1
  123. package/types/apps/src/implementation/provider.d.ts +18 -3
  124. package/types/apps/src/implementation/query-commit.d.ts +1 -1
  125. package/types/apps/src/implementation/router-catalog.d.ts +11 -13
  126. package/types/apps/src/implementation/router.d.ts +16 -5
  127. package/types/apps/src/implementation/runtime-yield.d.ts +7 -0
  128. package/types/apps/src/implementation/schema.d.ts +90 -10
  129. package/types/apps/src/implementation/skills.d.ts +18 -24
  130. package/types/apps/src/implementation/sql.d.ts +71 -0
  131. package/types/apps/src/implementation/ui-account-notice.d.ts +9 -0
  132. package/types/apps/src/implementation/ui-auth.d.ts +1 -1
  133. package/types/apps/src/implementation/ui-client.d.ts +2 -2
  134. package/types/apps/src/implementation/ui-document.d.ts +5 -0
  135. package/types/apps/src/implementation/ui-errors.d.ts +1 -1
  136. package/types/apps/src/implementation/ui-serving.d.ts +28 -9
  137. package/types/apps/src/implementation/ui-watch.d.ts +1 -1
  138. package/types/apps/src/implementation/upstream-error.d.ts +7 -0
  139. package/types/apps/src/implementation/webhooks.d.ts +1 -1
  140. package/types/apps/src/implementation/workflows.d.ts +1 -1
  141. package/types/apps/src/index.d.ts +55 -13
  142. package/types/apps/src/mcp.d.ts +20 -1
  143. package/types/apps/src/openapi.d.ts +1 -1
  144. package/types/apps/src/react.d.ts +1 -1
  145. package/types/apps/src/skills.d.ts +10 -8
  146. package/types/apps/src/ui-serving.d.ts +1 -1
  147. package/types/telemetry/src/app-records.d.ts +42 -0
  148. package/types/telemetry/src/browser-operations.d.ts +2 -2
  149. package/types/telemetry/src/browser.d.ts +8 -3
  150. package/types/telemetry/src/config.d.ts +2 -2
  151. package/types/telemetry/src/index.d.ts +2 -1
  152. package/types/telemetry/src/layer.d.ts +10 -4
  153. package/types/telemetry/src/measurements.d.ts +1 -1
  154. package/types/telemetry/src/ownership.d.ts +60 -0
  155. package/types/telemetry/src/recorded-failure.d.ts +29 -0
  156. package/types/telemetry/src/relay.d.ts +16 -6
  157. package/types/telemetry/src/span-attributes.d.ts +17 -1
  158. package/types/telemetry/src/transport.d.ts +8 -1
  159. package/types/utils/src/api-error.d.ts +55 -0
  160. package/types/utils/src/connection-failure.d.ts +33 -0
  161. package/types/utils/src/recorded-message.d.ts +18 -0
  162. package/types/utils/src/user-facing-error.d.ts +83 -0
  163. package/js/chunk-MKWZPDR6.js +0 -63
  164. package/js/chunk-N7YDVXYJ.js +0 -186
  165. package/js/chunk-NKLWZJLE.js +0 -172
  166. package/js/chunk-OCYUEU47.js +0 -224
  167. package/js/chunk-PJJ24GU7.js +0 -877
  168. package/js/chunk-PZB6T6KU.js +0 -19
  169. package/js/chunk-R3EV5FTO.js +0 -97
  170. package/js/chunk-YXQHV65J.js +0 -242
  171. package/js/chunk-ZQINWV4W.js +0 -630
  172. package/types/app-data/src/implementation/cursor.d.ts +0 -10
  173. package/types/app-data/src/implementation/index-key.d.ts +0 -7
  174. package/types/app-data/src/implementation/promise.d.ts +0 -68
  175. package/types/app-data/src/implementation/range.d.ts +0 -8
  176. package/types/app-data/src/implementation/schema.d.ts +0 -18
  177. package/types/app-data/src/implementation/sqlite.d.ts +0 -11
  178. package/types/app-data/src/index.d.ts +0 -4
  179. package/types/apps/src/contracts/storage.d.ts +0 -68
  180. package/types/apps/src/implementation/storage.d.ts +0 -15
@@ -1,18 +1,25 @@
1
1
  import type { ProviderError } from "../contracts/provider-error.js";
2
+ import type { NetworkRefused } from "../contracts/network.js";
2
3
  /** Shared MCP pagination, wire parsing and calls. Transport owns connection lifetime. */
3
4
  import type { Client } from "@modelcontextprotocol/sdk/client/index.js";
4
5
  import type { jsonSchemaValidator } from "@modelcontextprotocol/sdk/validation/types.js";
5
6
  import { Effect, Schema } from "effect";
6
7
  import { McpError, type McpToolContext } from "../contracts/mcp.js";
8
+ import type { UpstreamError } from "../contracts/failure.js";
7
9
  import type { JsonObject } from "../effect.js";
10
+ /**
11
+ * The JSON-RPC error a server answered a request with, if `error` is one. The SDK formats its
12
+ * message as `MCP error <code>: <message>`; the server's own message follows that prefix.
13
+ */
14
+ export declare const answeredError: (error: unknown) => UpstreamError | undefined;
8
15
  /** Use the framework-owned interpreter at the MCP SDK's synchronous validation boundary. */
9
16
  export declare const mcpJsonSchemaValidator: jsonSchemaValidator;
10
17
  /** An operation owns its connection; it must close even when interrupted. */
11
18
  export interface WithMcpClient {
12
- <A, E>(mode: "discover" | "call", use: (client: Client) => Effect.Effect<A, E>): Effect.Effect<A, E | McpError | ProviderError>;
19
+ <A, E>(mode: "discover" | "call", use: (client: Client) => Effect.Effect<A, E>): Effect.Effect<A, E | McpError | ProviderError | NetworkRefused>;
13
20
  }
14
21
  /** Shared client operations never cache catalogs or account credentials. */
15
- export declare function mcpClient(withClient: WithMcpClient, timeoutMs: number, failure: (phase: McpError["phase"], error: unknown) => McpError | ProviderError): {
22
+ export declare function mcpClient(withClient: WithMcpClient, timeoutMs: number, failure: (phase: McpError["phase"], error: unknown) => McpError | ProviderError | NetworkRefused): {
16
23
  list: Effect.Effect<{
17
24
  tools: {
18
25
  readonly name: string;
@@ -36,11 +43,11 @@ export declare function mcpClient(withClient: WithMcpClient, timeoutMs: number,
36
43
  } | undefined;
37
44
  }[];
38
45
  server: {
46
+ readonly description?: string;
39
47
  readonly version?: string;
40
48
  readonly name?: string;
41
- readonly description?: string;
42
- readonly title?: string;
43
49
  readonly instructions?: string;
50
+ readonly title?: string;
44
51
  readonly icons?: readonly {
45
52
  readonly src: string;
46
53
  readonly mimeType?: string;
@@ -49,19 +56,20 @@ export declare function mcpClient(withClient: WithMcpClient, timeoutMs: number,
49
56
  }[];
50
57
  readonly websiteUrl?: string;
51
58
  } | {};
52
- }, ProviderError | McpError, never>;
59
+ }, ProviderError | NetworkRefused | McpError, never>;
60
+ check: Effect.Effect<void, ProviderError | NetworkRefused | McpError, never>;
53
61
  call: (name: string, input: JsonObject, context: McpToolContext) => Effect.Effect<{
54
62
  readonly content: readonly {
55
63
  readonly [x: string]: Schema.Json;
56
64
  }[];
57
65
  readonly _meta?: {
58
66
  readonly [x: string]: Schema.Json;
59
- } | undefined;
67
+ };
60
68
  readonly structuredContent?: {
61
69
  readonly [x: string]: Schema.Json;
62
- } | undefined;
63
- readonly isError?: boolean | undefined;
64
- }, ProviderError | import("../index.js").ElicitationFailed | McpError, never>;
70
+ };
71
+ readonly isError?: boolean;
72
+ }, ProviderError | NetworkRefused | import("../index.js").ElicitationFailed | McpError, never>;
65
73
  };
66
74
  /** Transport-independent operations consumed by the app tool adapter. */
67
75
  export type McpClient = ReturnType<typeof mcpClient>;
@@ -1,4 +1,4 @@
1
1
  import { Effect } from "effect";
2
2
  import { McpError, ProcessConfig } from "../contracts/mcp.js";
3
3
  /** Each discovery/call owns and closes its subprocess. Deployment never starts it. */
4
- export declare const stdioToolsEffect: (input: ProcessConfig) => Effect.Effect<Readonly<Record<string, import("../contracts/mcp.js").McpTool>>, import("../index.js").ProviderError | McpError, never>;
4
+ export declare const stdioToolsEffect: (input: ProcessConfig) => Effect.Effect<Readonly<Record<string, import("../contracts/mcp.js").McpTool>>, import("../index.js").ProviderError | import("../index.js").NetworkRefused | McpError, never>;
@@ -1,4 +1,5 @@
1
1
  import type { ProviderError } from "../contracts/provider-error.js";
2
+ import type { NetworkRefused } from "../contracts/network.js";
2
3
  /** Adapt any MCP transport into ordinary tools with shared validation behavior. */
3
4
  import { Effect } from "effect";
4
5
  import { McpError, type McpTools, type McpToolMetadata } from "../contracts/mcp.js";
@@ -6,4 +7,4 @@ import type { McpClient } from "./mcp-client.js";
6
7
  /** Compile only the selected tool and bind its executable to the current invocation. */
7
8
  export declare const adaptMcpTool: (client: McpClient, tool: McpToolMetadata) => Effect.Effect<import("../contracts/mcp.js").McpTool, McpError, never>;
8
9
  /** Discover a complete catalog for probes and uncached low-level callers. */
9
- export declare const adaptMcpTools: (client: McpClient) => Effect.Effect<McpTools, McpError | ProviderError>;
10
+ export declare const adaptMcpTools: (client: McpClient) => Effect.Effect<McpTools, McpError | ProviderError | NetworkRefused>;
@@ -1,6 +1,7 @@
1
1
  import { ProviderError } from "../contracts/provider-error.js";
2
2
  import { Effect, Schema } from "effect";
3
- import { McpError, McpToolsOptions } from "../contracts/mcp.js";
3
+ import { McpCredentialsUnverified, McpError, McpToolsOptions, type McpHealthCheck, type McpHealthOptions } from "../contracts/mcp.js";
4
+ import { NetworkRefused } from "../contracts/network.js";
4
5
  /** Discover and call with a fresh selected-account transport for each operation. */
5
6
  export declare const mcpClientEffect: (input: McpToolsOptions, changed?: Effect.Effect<void, unknown>) => Effect.Effect<{
6
7
  list: Effect.Effect<{
@@ -26,11 +27,11 @@ export declare const mcpClientEffect: (input: McpToolsOptions, changed?: Effect.
26
27
  } | undefined;
27
28
  }[];
28
29
  server: {
30
+ readonly description?: string;
29
31
  readonly version?: string;
30
32
  readonly name?: string;
31
- readonly description?: string;
32
- readonly title?: string;
33
33
  readonly instructions?: string;
34
+ readonly title?: string;
34
35
  readonly icons?: readonly {
35
36
  readonly src: string;
36
37
  readonly mimeType?: string;
@@ -39,19 +40,29 @@ export declare const mcpClientEffect: (input: McpToolsOptions, changed?: Effect.
39
40
  }[];
40
41
  readonly websiteUrl?: string;
41
42
  } | {};
42
- }, ProviderError | McpError, never>;
43
+ }, ProviderError | NetworkRefused | McpError, never>;
44
+ check: Effect.Effect<void, ProviderError | NetworkRefused | McpError, never>;
43
45
  call: (name: string, input: import("../index.js").JsonObject, context: import("../mcp.js").McpToolContext) => Effect.Effect<{
44
46
  readonly content: readonly {
45
47
  readonly [x: string]: Schema.Json;
46
48
  }[];
47
49
  readonly _meta?: {
48
50
  readonly [x: string]: Schema.Json;
49
- } | undefined;
51
+ };
50
52
  readonly structuredContent?: {
51
53
  readonly [x: string]: Schema.Json;
52
- } | undefined;
53
- readonly isError?: boolean | undefined;
54
- }, ProviderError | import("../index.js").ElicitationFailed | McpError, never>;
54
+ };
55
+ readonly isError?: boolean;
56
+ }, ProviderError | NetworkRefused | import("../index.js").ElicitationFailed | McpError, never>;
55
57
  }, McpError, never>;
58
+ /**
59
+ * Check one account: initialize and read the first page of tools with the account's headers, then
60
+ * repeat that with no headers on a fresh transport. A refused account fails with its
61
+ * `ProviderError`, and anything else that stops the first check is an `McpError`; the second never
62
+ * runs. The check passes only when the server refuses the second, which shows it checked the
63
+ * credentials. Otherwise it fails with `McpCredentialsUnverified`. Both share one budget, which
64
+ * ends early enough before the check context's deadline to close the session and report why.
65
+ */
66
+ export declare const mcpHealthEffect: (check: McpHealthCheck, options: McpHealthOptions) => Effect.Effect<void, ProviderError | NetworkRefused | McpError | McpCredentialsUnverified, never>;
56
67
  /** Discover and compile all tools for connection probes and low-level consumers. */
57
- export declare const mcpToolsEffect: (input: McpToolsOptions) => Effect.Effect<Readonly<Record<string, import("../contracts/mcp.js").McpTool>>, ProviderError | McpError, never>;
68
+ export declare const mcpToolsEffect: (input: McpToolsOptions) => Effect.Effect<Readonly<Record<string, import("../contracts/mcp.js").McpTool>>, ProviderError | NetworkRefused | McpError, never>;
@@ -0,0 +1,16 @@
1
+ /** Typed refusals and option checks for the fetch app code receives from the framework. */
2
+ import { Effect } from "effect";
3
+ import type { HttpClientResponse } from "effect/http";
4
+ import { type NetworkRefused } from "../contracts/network.js";
5
+ type Fetch = (input: string | URL | Request, init?: RequestInit) => Promise<Response>;
6
+ /** Fail with the refusal a protocol helper's response carries, or continue to its own handling. */
7
+ export declare const failOnNetworkRefusal: (response: HttpClientResponse.HttpClientResponse) => Effect.Effect<void, NetworkRefused>;
8
+ /**
9
+ * The fetch app code receives as `ctx.fetch`. It rejects a RequestInit value the app runtime
10
+ * would reject, naming the option, on every host. A request Executor's app network refused
11
+ * rejects with `NetworkRefused`: the service never answered, so there is no response to return.
12
+ */
13
+ export declare const appFetch: (fetch: Fetch) => Fetch;
14
+ /** The invocation's correlated, cancellable fetch, as app code receives it. */
15
+ export declare const appInvocationFetch: (signal: AbortSignal) => Effect.Effect<Fetch, never, never>;
16
+ export {};
@@ -1,24 +1,36 @@
1
1
  /** Compile an OpenAPI document into tool declarations inside the app runtime, never a second execution engine. */
2
2
  import { Effect, Schema } from "effect";
3
3
  import { JsonObject } from "../contracts/schema.js";
4
+ import { OpenapiErrorResponse } from "../contracts/openapi.js";
4
5
  import { OpenapiCompileError as TemplateError } from "../contracts/openapi-compile.js";
5
6
  import type { OpenApiImport } from "../contracts/openapi-document.js";
6
7
  import { type GeneratedOperation, type GeneratedSecrets } from "../contracts/openapi-document.js";
7
- /** Compile a revision of a live OpenAPI source into tool declarations for the app runtime. */
8
- export declare const compileOpenApiDocument: (entry: OpenApiImport, inputDocument: unknown, options?: {
8
+ import { type OpenApiDocument } from "./openapi-document.js";
9
+ /** Keep tagged errors, including response/component refs and anyOf alternatives.
10
+ * Public text comes from a declared string message or the schema's static description.
11
+ * `scripts/check-api-errors.ts` applies this to Executor's own API documents.
12
+ */
13
+ export declare function errorResponses(document: OpenApiDocument, operation: JsonObject, at: string): OpenapiErrorResponse[];
14
+ /** Compile a revision of a live OpenAPI source into tool declarations for the app runtime.
15
+ * The document is consumed: compilation upgrades it in place instead of copying it. It must be a
16
+ * tree, with no object reached twice, as parsed JSON is.
17
+ */
18
+ export declare const compileOpenApiDocument: (entry: OpenApiImport, inputDocument: JsonObject, options?: {
9
19
  readonly baseUrl?: string;
10
20
  readonly allowedOrigin?: string;
21
+ /** Inserted between every operation's server and path; see `prefixParameters`. */
22
+ readonly pathPrefix?: string;
11
23
  readonly securitySchemes?: Readonly<Record<string, JsonObject>>;
12
24
  readonly fallbackSecurity?: GeneratedOperation["request"]["security"];
13
25
  }) => Effect.Effect<{
14
26
  operations: {
15
- readonly name: string;
16
- readonly path: string;
27
+ readonly method: "HEAD" | "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "QUERY";
17
28
  readonly description: string;
29
+ readonly name: string;
18
30
  readonly request: {
19
31
  readonly parameters: readonly {
32
+ readonly in: "header" | "query" | "path" | "querystring" | "cookie";
20
33
  readonly name: string;
21
- readonly in: "query" | "path" | "header" | "cookie";
22
34
  readonly required?: boolean;
23
35
  readonly schema?: {
24
36
  readonly [x: string]: Schema.Json;
@@ -53,10 +65,10 @@ export declare const compileOpenApiDocument: (entry: OpenApiImport, inputDocumen
53
65
  readonly required?: boolean;
54
66
  };
55
67
  };
68
+ readonly path: string;
56
69
  readonly input: {
57
70
  readonly [x: string]: Schema.Json;
58
71
  };
59
- readonly method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD" | "OPTIONS";
60
72
  readonly securitySchemes: {
61
73
  readonly [x: string]: {
62
74
  readonly [x: string]: Schema.Json;
@@ -84,6 +96,14 @@ export declare const compileOpenApiDocument: (entry: OpenApiImport, inputDocumen
84
96
  };
85
97
  }[];
86
98
  }[];
99
+ /** Declared operations left out of `operations`, in definition order. */
100
+ skipped: {
101
+ readonly name: string;
102
+ readonly method: string;
103
+ readonly path: string;
104
+ readonly code: "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";
105
+ readonly reason: string;
106
+ }[];
87
107
  definitions: {
88
108
  [k: string]: {
89
109
  readonly [x: string]: Schema.Json;
@@ -1,11 +1,32 @@
1
1
  import { Schema } from "effect";
2
2
  import { JsonObject } from "../contracts/schema.js";
3
- /** Resolve OpenAPI objects once with Swagger; schemas retain their original recursive references.
4
- * Scalar first upgrades Swagger 2.0 and OpenAPI 3.0 to 3.1, so the importer has one dialect and
5
- * 3.1 keywords that appear in 3.0 documents keep their meaning.
6
- * Unsupported versions, references and conversions throw TemplateError at the import boundary.
3
+ /**
4
+ * An object in a document that was validated as JSON when it was read. Compilation only turns JSON
5
+ * into JSON, so inside it an object's shape is checked, not its every leaf again: re-validating
6
+ * whole documents was most of a large API's compile time.
7
7
  */
8
- export declare function openApiDocument(input: unknown): Promise<{
8
+ export declare const DocumentObject: Schema.declare<{
9
+ readonly [x: string]: Schema.Json;
10
+ }, {
11
+ readonly [x: string]: Schema.Json;
12
+ }>;
13
+ export declare const documentObject: (input: unknown, options?: import("effect/SchemaAST").ParseOptions) => {
14
+ readonly [x: string]: Schema.Json;
15
+ };
16
+ /** One JSON Pointer reference token. */
17
+ export declare const pointerToken: (key: string) => string;
18
+ /**
19
+ * Decode one part of the definition, located by the JSON Pointer `at`. A mismatch names the
20
+ * pointer of the first failing value and what was expected there.
21
+ */
22
+ export declare const decodeDefinition: <S extends Schema.Decoder<unknown>>(schema: S, value: unknown, at: string, what: string) => S["Type"];
23
+ /** Resolve OpenAPI objects once; schemas retain their original recursive references.
24
+ * Scalar first upgrades Swagger 2.0 and OpenAPI 3.0 to 3.1, so the importer reads 3.1 and 3.2,
25
+ * whose Schema Objects share one dialect, and 3.1 keywords that appear in 3.0 documents keep
26
+ * their meaning. Unsupported versions, references and conversions throw TemplateError at the
27
+ * import boundary.
28
+ */
29
+ export declare function openApiDocument(input: JsonObject): Promise<{
9
30
  spec: {
10
31
  readonly openapi: string;
11
32
  readonly paths: {
@@ -13,39 +34,45 @@ export declare function openApiDocument(input: unknown): Promise<{
13
34
  readonly [x: string]: Schema.Json;
14
35
  };
15
36
  };
16
- readonly security?: readonly {
17
- readonly [x: string]: readonly string[];
18
- }[];
19
- readonly servers?: readonly {
20
- readonly url: string;
21
- readonly variables?: {
22
- readonly [x: string]: Schema.Json;
23
- };
24
- }[];
25
37
  readonly components?: {
26
- readonly securitySchemes?: {
38
+ readonly schemas?: {
27
39
  readonly [x: string]: {
28
40
  readonly [x: string]: Schema.Json;
29
41
  };
30
42
  };
31
- readonly schemas?: {
43
+ readonly securitySchemes?: {
32
44
  readonly [x: string]: {
33
45
  readonly [x: string]: Schema.Json;
34
46
  };
35
47
  };
36
48
  };
49
+ readonly security?: readonly {
50
+ readonly [x: string]: readonly string[];
51
+ }[];
52
+ readonly servers?: readonly {
53
+ readonly url: string;
54
+ readonly variables?: {
55
+ readonly [x: string]: Schema.Json;
56
+ };
57
+ }[];
37
58
  };
38
59
  definitions: Map<string, {
39
60
  readonly [x: string]: Schema.Json;
40
61
  }>;
62
+ /**
63
+ * The JSON Pointer of the object a local reference resolved to, so a diagnostic can locate
64
+ * a resolved Response, Parameter, Request Body or Path Item where the definition declares it.
65
+ */
66
+ origin(value: unknown): string | undefined;
41
67
  /** Inspect a component schema without expanding its children. OpenAPI object refs must already be resolved by Swagger. */
42
68
  resolve(value: JsonObject): JsonObject;
43
69
  /** Compose a Draft 2020-12 schema around API Schema Objects. Only values passed to
44
70
  * `api` use the document's OpenAPI dialect; Executor-authored wrappers are already
45
- * Draft 2020-12 and must not be reinterpreted. Reached components are converted once into
46
- * the shared `definitions` and stay references here; nothing is inlined or copied per operation.
71
+ * Draft 2020-12 and must not be reinterpreted. `api` takes the schema's JSON Pointer in the
72
+ * definition, which failures name. Reached components are converted once into the shared
73
+ * `definitions` and stay references here; nothing is inlined or copied per operation.
47
74
  */
48
- schema(build: (api: (input: Schema.Json) => JsonObject) => JsonObject): JsonObject;
75
+ schema(build: (api: (input: Schema.Json, at: string) => JsonObject) => JsonObject): JsonObject;
49
76
  }>;
50
77
  /** A parsed document with one reference scope and one schema dialect. */
51
78
  export type OpenApiDocument = Awaited<ReturnType<typeof openApiDocument>>;
@@ -11,8 +11,13 @@ export interface OperationNameInput {
11
11
  readonly path: string;
12
12
  }
13
13
  /**
14
- * Plan one name per input, in input order. Names that collide are refined together: first by
15
- * the path's version segment, then by the HTTP method, then by a stable hash. Refinement only
16
- * touches the colliding names, so adding an operation never renames an unrelated one.
14
+ * Name every input, in input order. Names that collide, whether or not they come from an
15
+ * operationId, are refined together: first by the path's version segment, then by the path
16
+ * segments that tell them apart (`GET /items` and `GET /items/{id}` are `items.getItems` and
17
+ * `items.getItemsById`), then by the whole path, then by the HTTP method, then by a stable hash.
18
+ * Refinement only touches the colliding names, so adding an operation never renames an unrelated
19
+ * one.
17
20
  */
18
- export declare const planOperationNames: (inputs: readonly OperationNameInput[]) => string[];
21
+ export declare const planOperationNames: <I extends OperationNameInput>(inputs: readonly I[]) => (I & {
22
+ readonly name: string;
23
+ })[];
@@ -1,3 +1,4 @@
1
+ import { NetworkRefused } from "../contracts/network.js";
1
2
  import { ProviderError } from "../contracts/provider-error.js";
2
3
  /** Swagger constructs requests; Effect owns HTTP policy and bounded results. */
3
4
  import { Effect, Schema } from "effect";
@@ -6,12 +7,19 @@ import { OpenapiError, type CredentialBinding, type OpenapiOperation, type Opena
6
7
  type DeclaredError = OpenapiErrorResponse & {
7
8
  readonly decoder: Schema.Decoder<Schema.Json>;
8
9
  };
10
+ /** What decides whether an account can call an operation: its transport and security. */
11
+ export interface OpenapiOperationAccess {
12
+ readonly streaming?: true;
13
+ readonly request: {
14
+ readonly security: OpenapiOperation["request"]["security"];
15
+ };
16
+ }
9
17
  /** Create request helpers from credential-free generated authentication metadata. */
10
18
  export declare function createRequest(config: {
11
19
  readonly methods: Readonly<Record<string, readonly CredentialBinding[]>>;
12
20
  readonly oauth: readonly string[];
13
21
  }): {
14
- available: (op: OpenapiOperation, account: OpenapiAccount | undefined) => boolean;
15
- call: (op: OpenapiOperation, input: unknown, account: OpenapiAccount | undefined, errors: readonly DeclaredError[]) => Effect.Effect<Schema.Json, ProviderError | OpenapiResponseError | OpenapiError, never>;
22
+ available: (op: OpenapiOperationAccess, account: OpenapiAccount | undefined) => boolean;
23
+ call: (op: OpenapiOperation, input: unknown, account: OpenapiAccount | undefined, errors: readonly DeclaredError[]) => Effect.Effect<Schema.Json, ProviderError | NetworkRefused | OpenapiResponseError | OpenapiError, never>;
16
24
  };
17
25
  export {};
@@ -3,6 +3,7 @@ import { Duration } from "effect";
3
3
  import type { AppCache } from "../contracts/cache.js";
4
4
  import { OpenapiOperation, type OpenapiToolsOptions } from "../contracts/openapi.js";
5
5
  import { JsonObject, JsonValue } from "../contracts/schema.js";
6
+ import { type OpenapiToolNames } from "../contracts/openapi-compile.js";
6
7
  import { type OperationKinds } from "./protocol-operations.js";
7
8
  import { type RouterDeclaration } from "./router.js";
8
9
  /** Static credential placement and destination are reviewed when the app is authored/imported. */
@@ -16,6 +17,12 @@ export interface OpenapiSourceOptions extends Omit<OpenapiToolsOptions, "operati
16
17
  readonly allowedOrigin: string;
17
18
  readonly securitySchemes: Readonly<Record<string, JsonObject>>;
18
19
  readonly baseUrl?: string;
20
+ /**
21
+ * A path inserted between the server and every operation's path, for a definition that omits a
22
+ * leading segment, such as `/projects/{project}`. Each `{name}` becomes a required string path
23
+ * parameter of every tool, unless the operation already declares it without placing it.
24
+ */
25
+ readonly pathPrefix?: string;
19
26
  readonly freshFor?: Duration.Input;
20
27
  readonly staleFor?: Duration.Input;
21
28
  /**
@@ -34,3 +41,14 @@ export interface OpenapiSourceOptions extends Omit<OpenapiToolsOptions, "operati
34
41
  export declare function patchOpenapi(root: JsonObject, patches: OpenapiSourceOptions["patches"]): JsonObject;
35
42
  /** No I/O during app construction. All accounts share credential-free compilation. */
36
43
  export declare const liveOpenapiRouter: (options: OpenapiSourceOptions) => RouterDeclaration;
44
+ /** The settings `openapiToolNames` reads: the router's, without an account or cache. */
45
+ export type OpenapiToolNamesOptions = Omit<OpenapiSourceOptions, "cache" | "account" | "parameterDefaults" | "freshFor" | "staleFor">;
46
+ /**
47
+ * The tools `liveOpenapiRouter` with the same options exposes, from the definition alone: no
48
+ * account, cache or deployment. Each tool says which `methods` and `oauth` entries expose it, so
49
+ * an author can check the names a `withApprovals` policy matches before any account connects.
50
+ * `skipped` lists only the operations the compiler left out and why. An operation no configured
51
+ * `methods` or `oauth` entry can authorize is missing from `tools` and not listed in `skipped`.
52
+ * `fetch` defaults to the global fetch.
53
+ */
54
+ export declare const openapiToolNames: (options: OpenapiToolNamesOptions) => Promise<OpenapiToolNames>;
@@ -0,0 +1,4 @@
1
+ type Node = Record<string, unknown>;
2
+ /** Upgrade a 3.0 document the caller owns. Any other version is returned unchanged. */
3
+ export declare const upgradeOpenApi30InPlace: (document: Node) => Node;
4
+ export {};
@@ -1,5 +1,5 @@
1
1
  /** Pure operation declarations. Only the author callback crosses the Promise boundary. */
2
- import { Effect, Schema as EffectSchema } from "effect";
2
+ import { Schema as EffectSchema } from "effect";
3
3
  import type { AppOperation } from "../contracts/operations.js";
4
4
  import type { AppContext, QueryContext, MutationContext } from "../contracts/context.js";
5
5
  import type { Approval } from "../approval.js";
@@ -38,6 +38,11 @@ export interface RouterChild<Query, Mutation> {
38
38
  readonly [QueryHandlerContext]?: (context: Query) => void;
39
39
  readonly [MutationHandlerContext]?: (context: Mutation) => void;
40
40
  }
41
+ /**
42
+ * A query or mutation whose handler context is checked by its kind, as a dynamic router resolves
43
+ * one. `query()` and `mutation()` results fit with their inferred contexts.
44
+ */
45
+ export type OperationChild<Query, Mutation> = RouterChild<Query, Mutation> & Pick<OperationDeclaration<"query" | "mutation">, "kind" | typeof NativeOperation>;
41
46
  /** Private key for a router's native definition. */
42
47
  export declare const NativeRouterKey: unique symbol;
43
48
  /** Typed operation handles drive browser reference inference without bundling handlers. */
@@ -64,7 +69,7 @@ export interface OperationOptions<Input, Output> {
64
69
  }
65
70
  /** Adapt metadata and approval without running user code. */
66
71
  export declare const operationOptions: <Input, Output>(options: OperationOptions<Input, Output>) => {
67
- approval?: (context: Parameters<Approval<Input>>[0]) => Effect.Effect<"approved" | "denied" | "user-approval", unknown, never>;
72
+ approval?: (context: Parameters<Approval<Input>>[0]) => import("effect/Effect").Effect<"approved" | "denied" | "user-approval", unknown, never>;
68
73
  input: EffectSchema.Decoder<Input, never>;
69
74
  _meta?: {
70
75
  readonly [x: string]: EffectSchema.Json;
@@ -79,8 +84,18 @@ export declare const operationOptions: <Input, Output>(options: OperationOptions
79
84
  title?: string;
80
85
  description?: string;
81
86
  };
87
+ /**
88
+ * Replace a native operation's approval. Property descriptors are copied so an output schema that
89
+ * a protocol adapter builds only when read stays lazy.
90
+ */
91
+ export declare const approvedOperation: <Input, Native extends AppOperation<Input, unknown>>(operation: Native, approval: Approval<Input>) => Native;
82
92
  /** Attach the same approval function to a generated or shared operation. */
83
93
  export declare const withApproval: <Input, Output, Kind extends "query" | "mutation", Context>(operation: Operation<Input, Output, Kind, Context>, approval: Approval<Input>) => Operation<Input, Output, Kind, Context>;
94
+ /**
95
+ * The advisory hints an operation carries, such as an MCP server's `destructiveHint`. App code
96
+ * reads them to choose an approval; the framework never infers one from them.
97
+ */
98
+ export declare const toolAnnotations: (operation: OperationDeclaration<"query" | "mutation", never>) => ToolAnnotations | undefined;
84
99
  /** Read operation. External reads are allowed; only database writes are mechanically prohibited. */
85
100
  export declare const query: <Input, Output, Context extends AppContext = QueryContext>(options: OperationOptions<Input, Output>, run: (context: Context, input: Input) => Promise<Output>) => Operation<Input, Output, "query", Context>;
86
101
  /** Explicit write operation. Database writes roll back on failure; external effects cannot be undone. */
@@ -1,6 +1,6 @@
1
1
  /** One client's mounted queries and ordered optimistic write/read handoffs. */
2
2
  import { Effect } from "effect";
3
- import { Atom, AsyncResult } from "effect/unstable/reactivity";
3
+ import { Atom, AsyncResult } from "effect/reactivity";
4
4
  import type { AppMutation } from "../contracts/optimistic.js";
5
5
  import type { OperationReference } from "../contracts/live.js";
6
6
  import { JsonValue } from "../contracts/schema.js";
@@ -0,0 +1,60 @@
1
+ /**
2
+ * Authoring credential placements. A method's `request` callback runs once, when the provider is
3
+ * declared, with an opaque reference for each of the method's fields. It returns placements built
4
+ * from `header` or `query` and a value from `t`, `base64` and references; the result is stored
5
+ * as data. A reference is not a string: an untagged template literal fails when it is evaluated.
6
+ */
7
+ import { Placement, type PlacementPart } from "../contracts/placement.js";
8
+ import type { AccountRequest, FieldExposure } from "../contracts/provider.js";
9
+ /** Throw when JavaScript turns a placement into a string, so untagged templates fail. */
10
+ declare class NotAString {
11
+ #private;
12
+ constructor(described: string);
13
+ [Symbol.toPrimitive](): never;
14
+ toString(): never;
15
+ toJSON(): never;
16
+ }
17
+ /** A reference to one of the method's account fields, given to its `request` callback. */
18
+ export declare class FieldRef<Name extends string = string> extends NotAString {
19
+ readonly field: Name;
20
+ constructor(field: Name);
21
+ }
22
+ /** A value template built with `t` or `base64`. */
23
+ export declare class PlacementValue extends NotAString {
24
+ readonly parts: readonly PlacementPart[];
25
+ constructor(parts: readonly PlacementPart[]);
26
+ }
27
+ /** What a template may interpolate: literal text, a field reference or another value. */
28
+ export type PlacementInput = string | FieldRef | PlacementValue;
29
+ /** A value template: literal text with interpolated field references and values. */
30
+ export declare const t: (strings: TemplateStringsArray, ...values: readonly PlacementInput[]) => PlacementValue;
31
+ /** Base64 of a value's UTF-8 bytes, such as the `user:password` of Basic credentials. */
32
+ export declare const base64: (value: PlacementInput) => PlacementValue;
33
+ /** Send a value as the whole value of this header. The name is case-insensitive. */
34
+ export declare const header: (name: string, input: PlacementInput) => Placement;
35
+ /** Send a value as the whole value of this query parameter. */
36
+ export declare const query: (name: string, input: unknown) => Placement;
37
+ /** `Authorization: Bearer <token>`. */
38
+ export declare const bearer: (token: FieldRef) => Placement;
39
+ /** `Authorization: Basic base64(<user>:<password>)`. */
40
+ export declare const basic: (user: PlacementInput, password: PlacementInput) => Placement;
41
+ /** The field references a `request` callback receives, by field name. */
42
+ export type FieldRefs<Name extends string> = {
43
+ readonly [Key in Name]: FieldRef<Key>;
44
+ };
45
+ /** How a method declares its placements: called once with its field references. */
46
+ export type RequestPlacements<Name extends string> = (fields: FieldRefs<Name>) => Placement | readonly Placement[];
47
+ /**
48
+ * Run a method's `request` callback once and check its placements. Every reference names one of
49
+ * the method's fields, no `raw()` field appears, and each placement references a secret field.
50
+ */
51
+ export declare const declarePlacements: (method: string, names: readonly string[], exposure: Readonly<Record<string, FieldExposure>> | undefined, request: RequestPlacements<string>) => readonly Placement[];
52
+ /**
53
+ * Give a bound account `headers()` and `url()`, rendering the placements the host granted with the
54
+ * fields app code holds. They are not enumerable, so the account's JSON is unchanged.
55
+ */
56
+ export declare const withPlacements: <Account extends {
57
+ readonly method: string;
58
+ readonly fields: unknown;
59
+ }>(account: Account, placements: readonly Placement[] | undefined) => Account & AccountRequest;
60
+ export {};
@@ -13,6 +13,9 @@ interface ProtocolOperation {
13
13
  readonly annotations?: ToolAnnotations | undefined;
14
14
  readonly _meta?: JsonObject | undefined;
15
15
  readonly input: Schema.Decoder<JsonValue>;
16
+ /** Checks and describes every returned value. */
17
+ readonly output?: Schema.Decoder<JsonValue> | undefined;
18
+ /** Describes the returned value without checking it; ignored when `output` is declared. */
16
19
  readonly outputSchema?: JsonObject | undefined;
17
20
  readonly run: (context: OperationContext, input: JsonValue) => Effect.Effect<unknown, unknown>;
18
21
  }
@@ -1,10 +1,37 @@
1
1
  import { Option } from "effect";
2
+ import type { FailurePhase, UpstreamError } from "../contracts/failure.js";
2
3
  import { ProviderError } from "../contracts/provider-error.js";
4
+ import { AccountId } from "../contracts/schema.js";
5
+ /** A provider failure's fields, each optional one possibly absent. */
6
+ interface ProviderErrorFields {
7
+ readonly reason: ProviderError["reason"];
8
+ readonly status?: number | undefined;
9
+ readonly accountId?: AccountId | undefined;
10
+ readonly phase?: FailurePhase | undefined;
11
+ readonly upstream?: UpstreamError | undefined;
12
+ }
13
+ /**
14
+ * Construct a provider failure without keys for absent fields. Failures inside a catalog cross the
15
+ * boundary as JSON values, which have no `undefined`.
16
+ */
17
+ export declare const providerError: ({ reason, status, accountId, phase, upstream, }: ProviderErrorFields) => ProviderError;
3
18
  /** Parse and rebuild the allowlisted fields, including when the input is already an Error instance. */
4
19
  export declare function parseProviderError(error: unknown): Option.Option<ProviderError>;
5
- /** Classify only explicit HTTP evidence. Raw provider content never enters the error. */
20
+ /**
21
+ * The same failure with detail its raiser could not know: the phase it happened in, and the
22
+ * error the service stated. Detail the failure already carries is kept.
23
+ */
24
+ export declare function providerErrorDetail(error: ProviderError, detail: {
25
+ readonly phase?: FailurePhase;
26
+ readonly upstream?: UpstreamError | undefined;
27
+ }): ProviderError;
28
+ /**
29
+ * Classify only explicit HTTP evidence. Raw provider content never enters the error; a Bearer
30
+ * challenge's documented error code and description do.
31
+ */
6
32
  export declare function httpProviderError(status: number, headers?: Readonly<Record<string, string>>): ProviderError | undefined;
7
33
  /** Attach the account used by the enclosing operation, without preserving arbitrary thrown fields. */
8
34
  export declare function accountProviderError<E>(error: E, accountId: string): E | ProviderError;
9
35
  /** GraphQL has no standard auth code; recognize these documented codes without guessing from prose. */
10
36
  export declare function graphqlProviderError(errors: readonly unknown[], status: number): ProviderError | undefined;
37
+ export {};
@@ -1,21 +1,36 @@
1
1
  /** Pure constructors over the native provider contracts. */
2
2
  import { Effect, Schema } from "effect";
3
3
  import { type PromiseMethod } from "./authoring.js";
4
- import { type AccountCheck, type AuthMethods, OAuth2Config, OAuth2Method, Provider, SecretsMethod } from "../contracts/provider.js";
4
+ import { type AccountCheck, type AuthMethods, type FieldExposure, OAuth2Config, OAuth2Method, Provider, SecretsMethod } from "../contracts/provider.js";
5
+ import type { Placement } from "../contracts/placement.js";
5
6
  import type { ValidationError } from "../contracts/schema.js";
6
7
  /** Declare a secrets method with an Effect decoder. */
7
8
  export declare const secrets: <Fields extends Schema.Decoder<unknown>>(options: {
8
9
  readonly label: string;
9
10
  readonly fields: Fields;
11
+ readonly exposure?: Readonly<Record<string, FieldExposure>>;
12
+ readonly request?: readonly Placement[];
10
13
  }) => SecretsMethod<Fields>;
11
14
  /** Validate OAuth endpoints while declaring their app-visible response projection. */
12
- export declare const oauth2: <Response extends Schema.Decoder<unknown>>(config: OAuth2Config, response: Response) => Effect.Effect<OAuth2Method<Response>, ValidationError>;
15
+ export declare const oauth2: <Response extends Schema.Decoder<unknown>>(config: OAuth2Config, response: Response, exposure?: Readonly<Record<string, FieldExposure>>, request?: readonly Placement[]) => Effect.Effect<OAuth2Method<Response>, ValidationError>;
13
16
  /** Author options: the account check is an ordinary async function. */
14
17
  export interface ProviderOptions<Auth extends AuthMethods> {
15
18
  readonly name: string;
16
19
  readonly auth: Auth;
20
+ /**
21
+ * Hosts the credentials may be sent to: `api.example.com`, `api.example.com:8443`, or
22
+ * `*.example.com` for one level of subdomain. Secret fields then reach app code as handles
23
+ * that the outbound network replaces only on requests to these hosts. An account records the
24
+ * hosts it was connected for; changing them does not change the provider, but an existing
25
+ * account sends only to hosts it was connected for until it is connected again.
26
+ */
27
+ readonly hosts?: readonly string[];
17
28
  /** Verify a connected account with a safe read, optionally reporting its upstream identity. */
18
29
  readonly health?: PromiseMethod<AccountCheck<Auth>["run"]>;
19
30
  }
20
- /** Retain the provider and literal method names without registering or authenticating it. */
31
+ /**
32
+ * Retain the provider and literal method names without registering or authenticating it. A
33
+ * method's `request` restricts where its credentials go only among the provider's `hosts`, so a
34
+ * provider that declares a `request` declares `hosts` too.
35
+ */
21
36
  export declare const defineProvider: <const Auth extends AuthMethods>({ health, ...options }: ProviderOptions<Auth>) => Provider<Auth>;