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,6 +1,8 @@
1
1
  /** Browser subscription contracts contain no executable server declarations. */
2
2
  import { Schema } from "effect";
3
3
  import type { JsonValue } from "./schema.js";
4
+ /** Names of authored operations. */
5
+ export declare const OperationName: Schema.NonEmptyString;
4
6
  /** Serializable named reference; the phantom field is never populated at runtime. */
5
7
  export interface OperationReference<Input, Output, Kind extends "query" | "mutation"> {
6
8
  readonly name: string;
@@ -1,7 +1,9 @@
1
- import type { ProviderError } from "./provider-error.js";
1
+ import { ProviderError } from "./provider-error.js";
2
+ import type { NetworkRefused } from "./network.js";
2
3
  /** MCP protocol data uses Effect Schema; executable tool methods use Effect. */
3
4
  import { type Effect, type Redacted, Schema } from "effect";
4
5
  import type { Elicit, ElicitationFailed } from "./elicitation.js";
6
+ import type { AccountCheckContext, AuthMethods } from "./provider.js";
5
7
  import { type JsonValue } from "./schema.js";
6
8
  /** Upstream MCP resource bounds, independent of the outer codemode execution budget. */
7
9
  export declare const McpClientLimits: Schema.Struct<{
@@ -31,6 +33,37 @@ export declare const McpToolsOptions: Schema.Struct<{
31
33
  readonly timeoutMs: Schema.optional<Schema.Number>;
32
34
  }>;
33
35
  export type McpToolsOptions = typeof McpToolsOptions.Type;
36
+ /**
37
+ * What `mcpHealth` checks, as decoded: its options, with the account's ID, signal and deadline
38
+ * taken from the check context.
39
+ */
40
+ export declare const McpHealthInput: Schema.Struct<{
41
+ readonly headers: Schema.$Record<Schema.String, Schema.String>;
42
+ readonly deadline: Schema.optional<Schema.Finite>;
43
+ readonly url: Schema.String;
44
+ readonly accountId: Schema.optional<Schema.brand<Schema.String, "acc">>;
45
+ readonly signal: Schema.optional<Schema.instanceOf<AbortSignal, AbortSignal>>;
46
+ readonly timeoutMs: Schema.optional<Schema.Number>;
47
+ }>;
48
+ /**
49
+ * The server a provider check verifies, and the headers that send the checked account's
50
+ * credentials. The account, signal and deadline come from the check context instead. Both attempts
51
+ * share one budget that ends `mcpHealthReserveMs` before the deadline. `timeoutMs` bounds the whole
52
+ * check too; it can shorten the budget, never extend it.
53
+ */
54
+ export type McpHealthOptions = Pick<typeof McpHealthInput.Type, "url" | "headers" | "timeoutMs">;
55
+ /** What `mcpHealth` reads from the check context the host passes to a provider's `health`. */
56
+ export type McpHealthCheck = Pick<AccountCheckContext<AuthMethods>, "signal" | "deadline"> & {
57
+ readonly account: {
58
+ readonly id: string;
59
+ };
60
+ };
61
+ /**
62
+ * How long before an account check's deadline `mcpHealth` stops waiting for the server, so it can
63
+ * still close its session, ending it and then its transport, each within `cleanupTimeoutMs`, and
64
+ * report why before the host stops waiting.
65
+ */
66
+ export declare const mcpHealthReserveMs: number;
34
67
  /** One parsed server and credential snapshot; never shared across account evaluations. */
35
68
  export interface McpConnection {
36
69
  readonly url: URL;
@@ -38,15 +71,21 @@ export interface McpConnection {
38
71
  readonly timeoutMs: number;
39
72
  }
40
73
  export { ToolAnnotations as McpToolAnnotations } from "./tools.js";
41
- /** Native MCP result semantics. Protocol/transport failures use the Effect error channel. */
74
+ /**
75
+ * Native MCP result semantics, and the value every MCP tool call returns. A tool's output
76
+ * schema is built from this declaration. Protocol/transport failures use the Effect error channel.
77
+ */
42
78
  export declare const McpToolResult: Schema.Struct<{
43
79
  readonly content: Schema.$Array<Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>>;
44
- readonly structuredContent: Schema.optional<Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>>;
45
- readonly isError: Schema.optional<Schema.Boolean>;
46
- readonly _meta: Schema.optional<Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>>;
80
+ readonly structuredContent: Schema.optionalKey<Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>>;
81
+ readonly isError: Schema.optionalKey<Schema.Boolean>;
82
+ readonly _meta: Schema.optionalKey<Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>>;
47
83
  }>;
48
84
  export type McpToolResult = typeof McpToolResult.Type;
49
- /** Remote metadata. Input/output schemas remain upstream JSON Schema documents. */
85
+ /**
86
+ * Remote metadata. Input/output schemas remain upstream JSON Schema documents; the upstream
87
+ * output schema describes only a result's `structuredContent`.
88
+ */
50
89
  export declare const McpToolMetadata: Schema.Struct<{
51
90
  readonly name: Schema.String;
52
91
  readonly title: Schema.optional<Schema.String>;
@@ -83,12 +122,17 @@ export type McpServerHeader = typeof McpServerHeader.Type;
83
122
  export interface McpToolContext {
84
123
  readonly elicit?: Elicit;
85
124
  }
86
- /** A tool bound to one evaluation's account; do not reuse it with another account. */
87
- export interface McpTool extends McpToolMetadata {
125
+ /**
126
+ * A tool bound to one evaluation's account; do not reuse it with another account. `output`
127
+ * decodes and describes the `McpToolResult` that `run` returns, with the upstream output schema
128
+ * under `structuredContent`.
129
+ */
130
+ export interface McpTool extends Omit<McpToolMetadata, "outputSchema"> {
88
131
  readonly description: string;
89
132
  readonly input: Schema.Decoder<JsonValue>;
133
+ readonly output: Schema.Decoder<JsonValue>;
90
134
  readonly readOnly?: boolean;
91
- readonly run: (context: McpToolContext, input: JsonValue) => Effect.Effect<McpToolResult, McpError | ProviderError | ElicitationFailed>;
135
+ readonly run: (context: McpToolContext, input: JsonValue) => Effect.Effect<McpToolResult, McpError | ProviderError | NetworkRefused | ElicitationFailed>;
92
136
  }
93
137
  /** The discovered catalog keyed by remote tool name. */
94
138
  export type McpTools = Readonly<Record<string, McpTool>>;
@@ -96,10 +140,36 @@ declare const McpError_base: Schema.Class<McpError, Schema.TaggedStruct<"McpErro
96
140
  readonly phase: Schema.Literals<readonly ["connect", "discover", "call", "schema", "transport"]>;
97
141
  readonly reason: Schema.Literals<readonly ["request", "unauthorized", "invalid_response", "timeout", "invalid_input"]>;
98
142
  readonly status: Schema.optional<Schema.Number>;
143
+ readonly upstream: Schema.optional<Schema.Struct<{
144
+ readonly code: Schema.Union<readonly [Schema.Int, Schema.String]>;
145
+ readonly message: Schema.optionalKey<Schema.String>;
146
+ }>>;
147
+ readonly session: Schema.optional<Schema.Literal<true>>;
99
148
  }>, import("effect/Cause").YieldableError>;
100
- /** Safe protocol/transport failure; no raw upstream payloads or credentials. */
149
+ /**
150
+ * Safe protocol/transport failure; no raw upstream payloads or credentials. `status` is the HTTP
151
+ * status a `request` failure was redirected or refused with. Without one, a `request` failure in
152
+ * the `transport` phase never reached the server; in another phase it may be a JSON-RPC error the
153
+ * server answered with. `upstream` is that JSON-RPC error, bounded and with account secrets
154
+ * replaced. A response that is not MCP is `invalid_response`. `session` is set when the refused
155
+ * request carried the session ID the server issued at initialization.
156
+ *
157
+ * These fields describe the failure for whoever reads it. App code can set any of them, so they
158
+ * never show that the failure lies outside Executor.
159
+ */
101
160
  export declare class McpError extends McpError_base {
102
161
  }
162
+ declare const McpCredentialsUnverified_base: Schema.Class<McpCredentialsUnverified, Schema.TaggedStruct<"McpCredentialsUnverified", {
163
+ readonly anonymous: Schema.Union<readonly [Schema.Literal<"answered">, typeof McpError, typeof ProviderError]>;
164
+ }>, import("effect/Cause").YieldableError>;
165
+ /**
166
+ * `mcpHealth` could not show that the server needs the account's credentials, although it accepted
167
+ * them. `anonymous` is what the same check without credentials met: `answered` when it succeeded,
168
+ * so a refused key would pass too, or the failure, other than a refusal, that left it undecided.
169
+ * Only app code raises it; the host reports its fixed message, so no host protocol carries it.
170
+ */
171
+ export declare class McpCredentialsUnverified extends McpCredentialsUnverified_base {
172
+ }
103
173
  /** Public process configuration. Credentials arrive through the selected account. */
104
174
  export declare const ProcessConfig: Schema.Struct<{
105
175
  readonly command: Schema.NonEmptyString;
@@ -0,0 +1,120 @@
1
+ /**
2
+ * What app code sees when Executor's app network refuses a request, and the fetch options the
3
+ * app runtime accepts. A refusal is Executor's decision, not the service's: the request never
4
+ * left Executor. App code runs on workerd, Cloudflare's runtime, on every host.
5
+ */
6
+ import { Schema } from "effect";
7
+ /**
8
+ * Why Executor's app network refused a request.
9
+ * - `private_address`: the destination is a private, loopback or internal address, and this
10
+ * instance lets apps reach only public addresses.
11
+ * - `credential_host`: the request carries a credential handle, and its provider does not allow
12
+ * the destination host.
13
+ * - `credential_app`: the request carries a credential handle that is not valid for this app.
14
+ * - `credential_expired`: the request carries an expired credential handle.
15
+ * - `credential_placement`: the request carries a credential handle somewhere its method does not
16
+ * place it, such as a body, the URL path or another header, or in a value that does not match
17
+ * the method's template exactly.
18
+ * - `credential_transport`: the request would send a placed credential over plain HTTP. Placed
19
+ * credentials go only over HTTPS, except to a loopback address on an instance whose operator
20
+ * lets apps reach private addresses, for local development.
21
+ * - `credential_method`: the request carries a credential handle and uses a method that asks the
22
+ * service to echo the request back, such as `TRACE`.
23
+ */
24
+ export declare const NetworkRefusal: Schema.Union<readonly [Schema.Struct<{
25
+ readonly reason: Schema.Literal<"private_address">;
26
+ }>, Schema.Struct<{
27
+ readonly reason: Schema.Literal<"credential_host">;
28
+ /** The provider of the credential handle the request carried. */
29
+ readonly provider: Schema.String;
30
+ /** The hosts that provider's credentials may reach; empty when it declares none. */
31
+ readonly allowedHosts: Schema.$Array<Schema.String>;
32
+ }>, Schema.Struct<{
33
+ readonly reason: Schema.Literal<"credential_app">;
34
+ }>, Schema.Struct<{
35
+ readonly reason: Schema.Literal<"credential_expired">;
36
+ /** The provider of the expired credential handle. */
37
+ readonly provider: Schema.String;
38
+ }>, Schema.Struct<{
39
+ readonly reason: Schema.Literal<"credential_placement">;
40
+ /** The provider of the misplaced credential handle. */
41
+ readonly provider: Schema.String;
42
+ /** Where the handle was found, such as `body` or `header x-note`. */
43
+ readonly location: Schema.String;
44
+ }>, Schema.Struct<{
45
+ readonly reason: Schema.Literal<"credential_transport">;
46
+ /** The provider of the credential handle the request carried. */
47
+ readonly provider: Schema.String;
48
+ }>, Schema.Struct<{
49
+ readonly reason: Schema.Literal<"credential_method">;
50
+ /** The refused HTTP method. */
51
+ readonly method: Schema.String;
52
+ }>]>;
53
+ export type NetworkRefusal = typeof NetworkRefusal.Type;
54
+ declare const NetworkRefused_base: Schema.Class<NetworkRefused, Schema.TaggedStruct<"NetworkRefused", {
55
+ /** The refused destination, with its port when the URL names one. */
56
+ readonly host: Schema.String;
57
+ readonly refusal: Schema.Union<readonly [Schema.Struct<{
58
+ readonly reason: Schema.Literal<"private_address">;
59
+ }>, Schema.Struct<{
60
+ readonly reason: Schema.Literal<"credential_host">;
61
+ /** The provider of the credential handle the request carried. */
62
+ readonly provider: Schema.String;
63
+ /** The hosts that provider's credentials may reach; empty when it declares none. */
64
+ readonly allowedHosts: Schema.$Array<Schema.String>;
65
+ }>, Schema.Struct<{
66
+ readonly reason: Schema.Literal<"credential_app">;
67
+ }>, Schema.Struct<{
68
+ readonly reason: Schema.Literal<"credential_expired">;
69
+ /** The provider of the expired credential handle. */
70
+ readonly provider: Schema.String;
71
+ }>, Schema.Struct<{
72
+ readonly reason: Schema.Literal<"credential_placement">;
73
+ /** The provider of the misplaced credential handle. */
74
+ readonly provider: Schema.String;
75
+ /** Where the handle was found, such as `body` or `header x-note`. */
76
+ readonly location: Schema.String;
77
+ }>, Schema.Struct<{
78
+ readonly reason: Schema.Literal<"credential_transport">;
79
+ /** The provider of the credential handle the request carried. */
80
+ readonly provider: Schema.String;
81
+ }>, Schema.Struct<{
82
+ readonly reason: Schema.Literal<"credential_method">;
83
+ /** The refused HTTP method. */
84
+ readonly method: Schema.String;
85
+ }>]>;
86
+ }>, import("effect/Cause").YieldableError>;
87
+ /** Executor's app network refused a request before it reached the service. */
88
+ export declare class NetworkRefused extends NetworkRefused_base {
89
+ get message(): string;
90
+ }
91
+ /**
92
+ * A refusal reaches app code as a response with this status and header. The header holds the
93
+ * encoded `NetworkRefused`, so it survives responses without a body, such as to `HEAD`; the
94
+ * body repeats it as JSON with its message. `ctx.fetch` and the framework's protocol helpers
95
+ * raise it as `NetworkRefused`; the platform's global `fetch` returns the response. Only
96
+ * Executor's app network sets the mark: it removes the header from a service's 421 response.
97
+ */
98
+ export declare const networkRefusalStatus = 421;
99
+ export declare const networkRefusalHeader = "x-executor-refused";
100
+ /** The header's value: the refusal as JSON, URI-encoded so any provider name fits in a header. */
101
+ export declare const NetworkRefusedHeader: Schema.compose<Schema.fromJsonString<typeof NetworkRefused>, Schema.StringFromUriComponent>;
102
+ /** The response Executor's app network returns in place of a request it refused. */
103
+ export declare const networkRefusalResponse: (refused: NetworkRefused) => Response;
104
+ /** RequestInit options the app runtime restricts. */
105
+ export declare const RestrictedFetchOption: Schema.Literals<readonly ["redirect", "cache", "integrity"]>;
106
+ export type RestrictedFetchOption = typeof RestrictedFetchOption.Type;
107
+ /** The values the app runtime accepts for each restricted option. */
108
+ export declare const supportedFetchOptions: Readonly<Record<RestrictedFetchOption, ReadonlyArray<string>>>;
109
+ declare const FetchOptionUnsupported_base: Schema.Class<FetchOptionUnsupported, Schema.TaggedStruct<"FetchOptionUnsupported", {
110
+ readonly option: Schema.Literals<readonly ["redirect", "cache", "integrity"]>;
111
+ readonly value: Schema.String;
112
+ readonly supported: Schema.$Array<Schema.String>;
113
+ }>, import("effect/Cause").YieldableError>;
114
+ /** `ctx.fetch` was given a standard RequestInit value the app runtime does not implement. */
115
+ export declare class FetchOptionUnsupported extends FetchOptionUnsupported_base {
116
+ get message(): string;
117
+ /** What to do instead, when the standard value has an equivalent the runtime supports. */
118
+ private get advice();
119
+ }
120
+ export {};
@@ -1,11 +1,90 @@
1
1
  /** Shared OpenAPI compilation diagnostics. */
2
2
  import { Schema } from "effect";
3
- export declare const OpenapiCompileErrorCode: 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", "duplicate_operation", "server_missing", "multiple_hosts", "parameter_encoding", "parameter_style", "request_body", "combined_oauth", "auth_method", "input_schema", "no_operations", "no_supported_operations", "invalid_document", "source_generation", "authoring_reference"]>;
3
+ /** Which part of an OpenAPI document could not be compiled into tools. */
4
+ export declare const OpenapiCompileErrorCode: 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"]>;
5
+ /** A declared operation the importer left out, and why. */
6
+ export declare const OpenapiSkippedOperation: Schema.Struct<{
7
+ /** The tool name the operation would have; reading that tool reports why it is missing. */
8
+ readonly name: Schema.String;
9
+ /** The HTTP method, such as `GET`. */
10
+ readonly method: Schema.String;
11
+ /** The path as the definition declares it. */
12
+ readonly path: Schema.String;
13
+ 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"]>;
14
+ readonly reason: Schema.String;
15
+ }>;
16
+ export type OpenapiSkippedOperation = typeof OpenapiSkippedOperation.Type;
4
17
  declare const OpenapiCompileError_base: Schema.Class<OpenapiCompileError, Schema.TaggedStruct<"OpenapiCompileError", {
5
- 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", "duplicate_operation", "server_missing", "multiple_hosts", "parameter_encoding", "parameter_style", "request_body", "combined_oauth", "auth_method", "input_schema", "no_operations", "no_supported_operations", "invalid_document", "source_generation", "authoring_reference"]>;
18
+ 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"]>;
6
19
  readonly reason: Schema.String;
20
+ readonly skipped: Schema.optionalKey<Schema.$Array<Schema.Struct<{
21
+ /** The tool name the operation would have; reading that tool reports why it is missing. */
22
+ readonly name: Schema.String;
23
+ /** The HTTP method, such as `GET`. */
24
+ readonly method: Schema.String;
25
+ /** The path as the definition declares it. */
26
+ readonly path: Schema.String;
27
+ 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"]>;
28
+ readonly reason: Schema.String;
29
+ }>>>;
30
+ readonly origins: Schema.optionalKey<Schema.$Array<Schema.String>>;
7
31
  }>, import("effect/Cause").YieldableError>;
8
- /** A safe generation failure, translated into product HTTP errors at the boundary. */
32
+ /**
33
+ * A safe generation failure. `reason` explains the cause; `skipped` lists the declared operations
34
+ * it left out and why, and `origins` the origins operations resolve to when none of them matches
35
+ * the allowed origin. Reading one left-out tool fails with this error for that operation alone.
36
+ */
9
37
  export declare class OpenapiCompileError extends OpenapiCompileError_base {
38
+ get message(): string;
10
39
  }
40
+ /** A tool a generated OpenAPI router exposes, read from the definition alone. */
41
+ export declare const OpenapiToolName: Schema.Struct<{
42
+ /** The tool name relative to the router, as `withApprovals` receives it. */
43
+ readonly name: Schema.String;
44
+ /** The HTTP method, such as `GET`. */
45
+ readonly method: Schema.String;
46
+ /** The request path, including any `pathPrefix`. */
47
+ readonly path: Schema.String;
48
+ readonly operationId: Schema.optionalKey<Schema.String>;
49
+ /** After `kinds` (keyed by `operationId`, else `name`); otherwise reading methods are queries. */
50
+ readonly kind: Schema.Literals<readonly ["query", "mutation"]>;
51
+ /** Callable without credentials, so every account and a router without one expose it. */
52
+ readonly public: Schema.Boolean;
53
+ /** The `methods` and `oauth` entries whose accounts expose it. */
54
+ readonly methods: Schema.$Array<Schema.String>;
55
+ }>;
56
+ export type OpenapiToolName = typeof OpenapiToolName.Type;
57
+ /** Every tool a definition yields for some account, and the operations the compiler left out. */
58
+ export declare const OpenapiToolNames: Schema.Struct<{
59
+ readonly tools: Schema.$Array<Schema.Struct<{
60
+ /** The tool name relative to the router, as `withApprovals` receives it. */
61
+ readonly name: Schema.String;
62
+ /** The HTTP method, such as `GET`. */
63
+ readonly method: Schema.String;
64
+ /** The request path, including any `pathPrefix`. */
65
+ readonly path: Schema.String;
66
+ readonly operationId: Schema.optionalKey<Schema.String>;
67
+ /** After `kinds` (keyed by `operationId`, else `name`); otherwise reading methods are queries. */
68
+ readonly kind: Schema.Literals<readonly ["query", "mutation"]>;
69
+ /** Callable without credentials, so every account and a router without one expose it. */
70
+ readonly public: Schema.Boolean;
71
+ /** The `methods` and `oauth` entries whose accounts expose it. */
72
+ readonly methods: Schema.$Array<Schema.String>;
73
+ }>>;
74
+ /**
75
+ * Operations the compiler left out, and why. An operation it imports but no configured `methods`
76
+ * or `oauth` entry can authorize is missing from `tools` and is not listed here.
77
+ */
78
+ readonly skipped: Schema.$Array<Schema.Struct<{
79
+ /** The tool name the operation would have; reading that tool reports why it is missing. */
80
+ readonly name: Schema.String;
81
+ /** The HTTP method, such as `GET`. */
82
+ readonly method: Schema.String;
83
+ /** The path as the definition declares it. */
84
+ readonly path: Schema.String;
85
+ 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"]>;
86
+ readonly reason: Schema.String;
87
+ }>>;
88
+ }>;
89
+ export type OpenapiToolNames = typeof OpenapiToolNames.Type;
11
90
  export {};
@@ -1,4 +1,5 @@
1
1
  import type { ProviderError } from "./provider-error.js";
2
+ import type { NetworkRefused } from "./network.js";
2
3
  /** Credential-free OpenAPI request declarations and validation schemas retained with app source. */
3
4
  import { Schema, type Effect } from "effect";
4
5
  import { JsonObject } from "./schema.js";
@@ -20,7 +21,8 @@ export type OpenapiErrorResponse = typeof OpenapiErrorResponse.Type;
20
21
  /** Resolved OpenAPI parameter shared by import validation and request construction. */
21
22
  export declare const OpenapiParameter: Schema.Struct<{
22
23
  readonly name: Schema.String;
23
- readonly in: Schema.Literals<readonly ["path", "query", "header", "cookie"]>;
24
+ /** OpenAPI 3.2's `querystring` is the whole query string, serialized from one `content` value. */
25
+ readonly in: Schema.Literals<readonly ["path", "query", "querystring", "header", "cookie"]>;
24
26
  readonly required: Schema.optionalKey<Schema.Boolean>;
25
27
  readonly schema: Schema.optionalKey<Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>>;
26
28
  readonly style: Schema.optionalKey<Schema.String>;
@@ -45,7 +47,7 @@ export declare const OpenapiOperation: Schema.Struct<{
45
47
  /** The document's operationId, when it declares one. `kinds` overrides are keyed by it. */
46
48
  readonly operationId: Schema.optionalKey<Schema.String>;
47
49
  readonly description: Schema.String;
48
- readonly method: Schema.Literals<readonly ["GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS"]>;
50
+ readonly method: Schema.Literals<readonly ["GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS", "QUERY"]>;
49
51
  readonly path: Schema.String;
50
52
  readonly baseUrl: Schema.String;
51
53
  readonly openapi: Schema.String;
@@ -54,7 +56,8 @@ export declare const OpenapiOperation: Schema.Struct<{
54
56
  readonly request: Schema.Struct<{
55
57
  readonly parameters: Schema.$Array<Schema.Struct<{
56
58
  readonly name: Schema.String;
57
- readonly in: Schema.Literals<readonly ["path", "query", "header", "cookie"]>;
59
+ /** OpenAPI 3.2's `querystring` is the whole query string, serialized from one `content` value. */
60
+ readonly in: Schema.Literals<readonly ["path", "query", "querystring", "header", "cookie"]>;
58
61
  readonly required: Schema.optionalKey<Schema.Boolean>;
59
62
  readonly schema: Schema.optionalKey<Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>>;
60
63
  readonly style: Schema.optionalKey<Schema.String>;
@@ -92,6 +95,8 @@ export declare const OpenapiOperation: Schema.Struct<{
92
95
  }>>>;
93
96
  }>;
94
97
  export type OpenapiOperation = typeof OpenapiOperation.Type;
98
+ /** Safe methods, whose operations are queries unless `kinds` says otherwise. QUERY is OpenAPI 3.2's. */
99
+ export declare const isOpenapiReadMethod: (method: OpenapiOperation["method"]) => method is "HEAD" | "GET" | "OPTIONS" | "QUERY";
95
100
  /** Map a selected account field to one Swagger credential value. */
96
101
  export declare const CredentialBinding: Schema.Struct<{
97
102
  readonly scheme: Schema.String;
@@ -125,7 +130,7 @@ export declare const OpenapiToolsOptions: Schema.Struct<{
125
130
  /** The document's operationId, when it declares one. `kinds` overrides are keyed by it. */
126
131
  readonly operationId: Schema.optionalKey<Schema.String>;
127
132
  readonly description: Schema.String;
128
- readonly method: Schema.Literals<readonly ["GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS"]>;
133
+ readonly method: Schema.Literals<readonly ["GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS", "QUERY"]>;
129
134
  readonly path: Schema.String;
130
135
  readonly baseUrl: Schema.String;
131
136
  readonly openapi: Schema.String;
@@ -134,7 +139,8 @@ export declare const OpenapiToolsOptions: Schema.Struct<{
134
139
  readonly request: Schema.Struct<{
135
140
  readonly parameters: Schema.$Array<Schema.Struct<{
136
141
  readonly name: Schema.String;
137
- readonly in: Schema.Literals<readonly ["path", "query", "header", "cookie"]>;
142
+ /** OpenAPI 3.2's `querystring` is the whole query string, serialized from one `content` value. */
143
+ readonly in: Schema.Literals<readonly ["path", "query", "querystring", "header", "cookie"]>;
138
144
  readonly required: Schema.optionalKey<Schema.Boolean>;
139
145
  readonly schema: Schema.optionalKey<Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>>;
140
146
  readonly style: Schema.optionalKey<Schema.String>;
@@ -201,11 +207,32 @@ export type OpenapiToolsOptions = Omit<typeof OpenapiToolsOptions.Type, "operati
201
207
  readonly operations: unknown;
202
208
  readonly definitions?: unknown;
203
209
  };
210
+ /** The operation a failed call addressed: its method and templated path, never parameter values. */
211
+ export declare const OpenapiFailedOperation: Schema.Struct<{
212
+ readonly method: Schema.Literals<readonly ["GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS", "QUERY"]>;
213
+ readonly path: Schema.String;
214
+ }>;
215
+ export type OpenapiFailedOperation = typeof OpenapiFailedOperation.Type;
216
+ /** A response media type without parameters, such as `text/html`. */
217
+ export declare const OpenapiMediaType: Schema.String;
204
218
  declare const OpenapiError_base: Schema.Class<OpenapiError, Schema.TaggedStruct<"OpenapiError", {
205
219
  readonly reason: Schema.Literals<readonly ["invalid_definition", "invalid_input", "request"]>;
206
220
  readonly status: Schema.optional<Schema.Number>;
221
+ /** Absent only when the definition itself could not be read. */
222
+ readonly operation: Schema.optional<Schema.Struct<{
223
+ readonly method: Schema.Literals<readonly ["GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS", "QUERY"]>;
224
+ readonly path: Schema.String;
225
+ }>>;
226
+ readonly contentType: Schema.optional<Schema.String>;
227
+ /** The response's `content-length`, when it declared one. */
228
+ readonly bytes: Schema.optional<Schema.Int>;
207
229
  }>, import("effect/Cause").YieldableError>;
208
- /** Safe failures omit request headers, credentials and upstream bodies. */
230
+ /**
231
+ * Safe failures omit request headers, credentials and upstream body text: the failure message is
232
+ * also recorded in traces. A `request` failure with a status names the response that no declared
233
+ * error matched, or the success response whose body could not be read, by its media type and
234
+ * declared length.
235
+ */
209
236
  export declare class OpenapiError extends OpenapiError_base {
210
237
  }
211
238
  /** An ordinary native tool bound to one selected account. */
@@ -214,7 +241,7 @@ export interface OpenapiTool {
214
241
  readonly readOnly: boolean;
215
242
  readonly outputSchema?: JsonObject;
216
243
  readonly input: Schema.Decoder<Schema.Json>;
217
- readonly run: (context: unknown, input: Schema.Json) => Effect.Effect<unknown, OpenapiError | OpenapiResponseError | ProviderError>;
244
+ readonly run: (context: unknown, input: Schema.Json) => Effect.Effect<unknown, OpenapiError | OpenapiResponseError | ProviderError | NetworkRefused>;
218
245
  }
219
246
  /** Executable operations keyed by their generated names. */
220
247
  export type OpenapiTools = Readonly<Record<string, OpenapiTool>>;
@@ -223,7 +250,12 @@ export declare const defaultOpenapiResponseLimits: {
223
250
  readonly maxBodyBytes: 16777216;
224
251
  readonly readTimeoutMs: 30000;
225
252
  };
226
- /** Media returned as text rather than a base64 file. NDJSON remains an unparsed text result. */
253
+ /**
254
+ * A sequence of JSON values, one per line or record: NDJSON, JSON Lines and `json-seq`, whose
255
+ * items OpenAPI 3.2 describes with `itemSchema`. The body is not one JSON value.
256
+ */
257
+ export declare const isOpenapiJsonSequence: (type: string) => boolean;
258
+ /** Media returned as text rather than a base64 file. JSON sequences remain unparsed text. */
227
259
  export declare const isOpenapiTextMedia: (type: string) => boolean;
228
260
  /** A form field that carries raw file bytes: OpenAPI 3.1 `contentMediaType` without an
229
261
  * encoding, or the `format: binary` string that 3.1 documents still commonly use. */
@@ -231,5 +263,5 @@ export declare const isOpenapiFileSchema: (shape: Readonly<Record<string, unknow
231
263
  /** JSON-safe binary result, independent of the host's file storage. */
232
264
  export declare const openapiBinaryResultSchema: JsonObject;
233
265
  /** Classify request media for JSON-safe tool arguments; Swagger owns wire serialization. */
234
- export declare const openapiMediaKind: (type: string) => "form" | "binary" | "json" | "multipart" | "text";
266
+ export declare const openapiMediaKind: (type: string) => "form" | "json" | "binary" | "multipart" | "text";
235
267
  export {};
@@ -1,13 +1,13 @@
1
- /** Native operation declarations. Database access is an optional invocation capability. */
1
+ /** Native operation declarations. SQL access is an optional invocation capability. */
2
2
  import type { Effect, Schema } from "effect";
3
3
  import type { Approval } from "./approval.js";
4
4
  import type { BoundContext, AccountSlots } from "./app.js";
5
- import type { Database, DatabaseReader, Tables } from "./storage.js";
5
+ import type { Sql, SqlReader } from "./sql.js";
6
6
  import type { ToolAnnotations } from "./tools.js";
7
7
  import type { JsonObject } from "./schema.js";
8
8
  /** Host-bound operation capabilities; the author declaration refines accounts and storage. */
9
9
  export type OperationContext = BoundContext<AccountSlots> & {
10
- readonly db?: DatabaseReader<Tables> | Database<Tables>;
10
+ readonly sql?: SqlReader | Sql;
11
11
  };
12
12
  /** The host validates input, checks approval, then owns the transaction and output validation. */
13
13
  export interface AppOperation<Input = unknown, Output = unknown> {
@@ -17,8 +17,12 @@ export interface AppOperation<Input = unknown, Output = unknown> {
17
17
  readonly annotations?: ToolAnnotations;
18
18
  readonly _meta?: JsonObject;
19
19
  readonly input: Schema.Decoder<Input>;
20
+ /** Checks every value `run` returns and is the output schema the operation is described with. */
20
21
  readonly output?: Schema.Decoder<Output>;
21
- /** Upstream protocol result metadata; the protocol adapter validates its own result envelope. */
22
+ /**
23
+ * An upstream protocol's description of the value `run` returns, used only when `output` is
24
+ * absent. The host does not check it, so declare `output` when the result can be checked.
25
+ */
22
26
  readonly outputSchema?: JsonObject;
23
27
  readonly approval?: Approval<Input>;
24
28
  readonly run: (context: OperationContext, input: Input) => Effect.Effect<Output, unknown>;
@@ -0,0 +1,102 @@
1
+ /**
2
+ * Credential placement: where an auth method's secret fields may be sent. A placement is a
3
+ * location in the request, a header or a query parameter, and a value template built from
4
+ * literal text, references to the method's own account fields, and base64 of those. Executor's
5
+ * outbound network substitutes a placed credential handle only where a request matches one of
6
+ * its method's placements exactly, and refuses the request when the handle is anywhere else.
7
+ */
8
+ import { Result, Schema } from "effect";
9
+ /** A reference to one of the method's own account fields. */
10
+ export declare const PlacementField: Schema.Struct<{
11
+ readonly field: Schema.NonEmptyString;
12
+ }>;
13
+ export type PlacementField = typeof PlacementField.Type;
14
+ /** Literal text or a field reference: what base64 may encode. Base64 never nests. */
15
+ export declare const PlacementText: Schema.Union<readonly [Schema.String, Schema.Struct<{
16
+ readonly field: Schema.NonEmptyString;
17
+ }>]>;
18
+ export type PlacementText = typeof PlacementText.Type;
19
+ /** Base64 (RFC 4648, padded) of the UTF-8 bytes of its parts, such as Basic credentials. */
20
+ export declare const PlacementBase64: Schema.Struct<{
21
+ readonly base64: Schema.$Array<Schema.Union<readonly [Schema.String, Schema.Struct<{
22
+ readonly field: Schema.NonEmptyString;
23
+ }>]>>;
24
+ }>;
25
+ export type PlacementBase64 = typeof PlacementBase64.Type;
26
+ /** One part of a value template. Parts concatenate. */
27
+ export declare const PlacementPart: Schema.Union<readonly [Schema.String, Schema.Struct<{
28
+ readonly field: Schema.NonEmptyString;
29
+ }>, Schema.Struct<{
30
+ readonly base64: Schema.$Array<Schema.Union<readonly [Schema.String, Schema.Struct<{
31
+ readonly field: Schema.NonEmptyString;
32
+ }>]>>;
33
+ }>]>;
34
+ export type PlacementPart = typeof PlacementPart.Type;
35
+ /** A lowercase HTTP header name (RFC 9110 token). */
36
+ export declare const PlacementHeaderName: Schema.String;
37
+ /**
38
+ * Where a credential may be sent and the exact value it is sent as. A header placement is the
39
+ * header's whole value; a query placement is the whole value of the named query parameter.
40
+ */
41
+ export declare const Placement: Schema.Union<readonly [Schema.Struct<{
42
+ readonly in: Schema.Literal<"header">;
43
+ readonly name: Schema.String;
44
+ readonly value: Schema.$Array<Schema.Union<readonly [Schema.String, Schema.Struct<{
45
+ readonly field: Schema.NonEmptyString;
46
+ }>, Schema.Struct<{
47
+ readonly base64: Schema.$Array<Schema.Union<readonly [Schema.String, Schema.Struct<{
48
+ readonly field: Schema.NonEmptyString;
49
+ }>]>>;
50
+ }>]>>;
51
+ }>, Schema.Struct<{
52
+ readonly in: Schema.Literal<"query">;
53
+ readonly name: Schema.NonEmptyString;
54
+ readonly value: Schema.$Array<Schema.Union<readonly [Schema.String, Schema.Struct<{
55
+ readonly field: Schema.NonEmptyString;
56
+ }>, Schema.Struct<{
57
+ readonly base64: Schema.$Array<Schema.Union<readonly [Schema.String, Schema.Struct<{
58
+ readonly field: Schema.NonEmptyString;
59
+ }>]>>;
60
+ }>]>>;
61
+ }>]>;
62
+ export type Placement = typeof Placement.Type;
63
+ /** An auth method's placements. */
64
+ export declare const Placements: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
65
+ readonly in: Schema.Literal<"header">;
66
+ readonly name: Schema.String;
67
+ readonly value: Schema.$Array<Schema.Union<readonly [Schema.String, Schema.Struct<{
68
+ readonly field: Schema.NonEmptyString;
69
+ }>, Schema.Struct<{
70
+ readonly base64: Schema.$Array<Schema.Union<readonly [Schema.String, Schema.Struct<{
71
+ readonly field: Schema.NonEmptyString;
72
+ }>]>>;
73
+ }>]>>;
74
+ }>, Schema.Struct<{
75
+ readonly in: Schema.Literal<"query">;
76
+ readonly name: Schema.NonEmptyString;
77
+ readonly value: Schema.$Array<Schema.Union<readonly [Schema.String, Schema.Struct<{
78
+ readonly field: Schema.NonEmptyString;
79
+ }>, Schema.Struct<{
80
+ readonly base64: Schema.$Array<Schema.Union<readonly [Schema.String, Schema.Struct<{
81
+ readonly field: Schema.NonEmptyString;
82
+ }>]>>;
83
+ }>]>>;
84
+ }>]>>;
85
+ /** Whether a part references a field. */
86
+ export declare const isPlacementField: (part: PlacementPart) => part is PlacementField;
87
+ /** The field names a template references, base64 parts included. */
88
+ export declare const placementFields: (placement: Placement) => ReadonlySet<string>;
89
+ /** Placements are equal when their JSON is: same location, name and template. */
90
+ export declare const placementKey: (placement: Placement) => string;
91
+ /** Placements in a stable order without repeats, so their order never changes an identity. */
92
+ export declare const normalizePlacements: (placements: readonly Placement[]) => readonly Placement[];
93
+ declare const PlacementFieldMissing_base: Schema.Class<PlacementFieldMissing, Schema.TaggedStruct<"PlacementFieldMissing", {
94
+ readonly field: Schema.String;
95
+ }>, import("effect/Cause").YieldableError>;
96
+ /** A field the template references has no string value. */
97
+ export declare class PlacementFieldMissing extends PlacementFieldMissing_base {
98
+ get message(): string;
99
+ }
100
+ /** Render a template with field values. A referenced field without a string value fails. */
101
+ export declare const renderPlacement: (placement: Placement, fields: Readonly<Record<string, unknown>>) => Result.Result<string, PlacementFieldMissing>;
102
+ export {};
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * The host protocol this framework speaks. It is written into `runtime.json` and every host
3
- * snapshot. Released protocols are frozen: see `protocols/4.ts` and notes/apps-publishing.md.
3
+ * snapshot. Its schemas are `protocols/current.ts`; released protocols are frozen. See notes/apps-publishing.md.
4
4
  * This file has no imports so the package build script can read it directly.
5
5
  */
6
- export declare const frameworkProtocol = 5;
6
+ export declare const frameworkProtocol = 12;