okengine 0.9.0 → 0.10.0

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 (175) hide show
  1. package/AGENTS.md +1 -1
  2. package/manifest.v1.schema.json +9 -1
  3. package/package.json +3 -3
  4. package/site/content/docs/console/runs.mdx +10 -0
  5. package/site/content/docs/console/traces.mdx +4 -0
  6. package/site/content/docs/elements/ai.mdx +54 -32
  7. package/site/content/docs/elements/channel.mdx +105 -14
  8. package/site/content/docs/elements/clock.mdx +1 -0
  9. package/site/content/docs/elements/flow.mdx +42 -8
  10. package/site/content/docs/get-started/basic-usage.mdx +5 -1
  11. package/site/content/docs/get-started/installation.mdx +9 -5
  12. package/site/content/docs/meta.json +2 -0
  13. package/site/content/docs/plugins/otp.mdx +58 -46
  14. package/site/content/docs/providers/azure-redis.mdx +85 -0
  15. package/site/content/docs/providers/cockroachdb.mdx +86 -0
  16. package/site/content/docs/providers/digitalocean-caching.mdx +88 -0
  17. package/site/content/docs/providers/dragonfly-cloud.mdx +82 -0
  18. package/site/content/docs/providers/elasticache.mdx +92 -0
  19. package/site/content/docs/providers/index.mdx +101 -0
  20. package/site/content/docs/providers/memorystore.mdx +89 -0
  21. package/site/content/docs/providers/meta.json +20 -0
  22. package/site/content/docs/providers/neon.mdx +115 -0
  23. package/site/content/docs/providers/redis-cloud.mdx +93 -0
  24. package/site/content/docs/providers/supabase.mdx +117 -0
  25. package/site/content/docs/providers/upstash.mdx +91 -0
  26. package/site/content/docs/providers/yugabytedb.mdx +95 -0
  27. package/site/content/docs/recipes/caddy.mdx +128 -0
  28. package/site/content/docs/recipes/cockroachdb.mdx +127 -0
  29. package/site/content/docs/recipes/dragonfly.mdx +125 -0
  30. package/site/content/docs/recipes/index.mdx +146 -0
  31. package/site/content/docs/recipes/llama-cpp.mdx +153 -0
  32. package/site/content/docs/recipes/mailpit.mdx +136 -0
  33. package/site/content/docs/recipes/meilisearch.mdx +139 -0
  34. package/site/content/docs/recipes/meta.json +31 -0
  35. package/site/content/docs/recipes/ollama.mdx +142 -0
  36. package/site/content/docs/recipes/openbao.mdx +141 -0
  37. package/site/content/docs/recipes/pgdog.mdx +137 -0
  38. package/site/content/docs/recipes/postgres.mdx +136 -0
  39. package/site/content/docs/recipes/redis.mdx +130 -0
  40. package/site/content/docs/recipes/rustfs.mdx +148 -0
  41. package/site/content/docs/recipes/sglang.mdx +105 -0
  42. package/site/content/docs/recipes/supabase-docker.mdx +145 -0
  43. package/site/content/docs/recipes/timescale.mdx +129 -0
  44. package/site/content/docs/recipes/traefik.mdx +136 -0
  45. package/site/content/docs/recipes/valkey.mdx +121 -0
  46. package/site/content/docs/recipes/vllm.mdx +106 -0
  47. package/site/content/docs/recipes/yugabytedb.mdx +135 -0
  48. package/site/content/docs/reference/cli.md +42 -6
  49. package/site/content/docs/reference/configuration.mdx +5 -3
  50. package/site/content/docs/reference/environment-variables.mdx +12 -12
  51. package/site/content/docs/reference/fx.mdx +38 -4
  52. package/src/auth/otp-capability.ts +14 -14
  53. package/src/cli/ai-setup/ai-setup.test.ts +32 -12
  54. package/src/cli/ai-setup/apply.ts +65 -23
  55. package/src/cli/ai-setup/catalog.ts +1316 -35
  56. package/src/cli/ai-setup/detect-ollama.ts +47 -0
  57. package/src/cli/ai-setup/index.ts +44 -7
  58. package/src/cli/ai-setup/prompts.ts +430 -486
  59. package/src/cli/ai-setup/recommend.test.ts +150 -50
  60. package/src/cli/ai-setup/recommend.ts +118 -101
  61. package/src/cli/ask-seed.test.ts +68 -0
  62. package/src/cli/ask-seed.ts +79 -0
  63. package/src/cli/db-seed-redact.test.ts +25 -0
  64. package/src/cli/db-seed.ts +36 -7
  65. package/src/cli/db.test.ts +1 -1
  66. package/src/cli/db.ts +2 -2
  67. package/src/cli/dev-controls.test.ts +107 -0
  68. package/src/cli/dev-controls.ts +354 -0
  69. package/src/cli/dev-schema-sync.ts +12 -4
  70. package/src/cli/dev.test.ts +50 -30
  71. package/src/cli/dev.ts +607 -66
  72. package/src/cli/drizzle-env.test.ts +40 -6
  73. package/src/cli/drizzle-env.ts +22 -1
  74. package/src/cli/ensure-drizzle-config.ts +6 -4
  75. package/src/cli/hero-meta.test.ts +13 -1
  76. package/src/cli/hero-meta.ts +28 -6
  77. package/src/cli/index.ts +5 -0
  78. package/src/cli/registry.ts +24 -0
  79. package/src/cli/replay.test.ts +105 -0
  80. package/src/cli/replay.ts +206 -0
  81. package/src/compiler/extract.ts +3 -3
  82. package/src/config/index.ts +3 -3
  83. package/src/console/server/claim.ts +3 -1
  84. package/src/console/ui/dist/assets/{index-ClX0ZCe5.js → index-D-9KFce5.js} +2 -2
  85. package/src/console/ui/dist/assets/panel-overview-CW0CQEc2.js +1 -0
  86. package/src/console/ui/dist/assets/panel-runs-BxuyDI3x.js +1 -0
  87. package/src/console/ui/dist/assets/{panel-signals-Dsxdu_AR.js → panel-signals-BXofbj7v.js} +1 -1
  88. package/src/console/ui/dist/assets/{panel-store-hy7O8HOs.js → panel-store-B8mH-arU.js} +1 -1
  89. package/src/console/ui/dist/assets/{panel-traces-CBiAe5go.js → panel-traces-DSA-ZWnf.js} +1 -1
  90. package/src/console/ui/dist/index.html +1 -1
  91. package/src/console/ui/overview/slo.ts +31 -3
  92. package/src/console/ui/overview/types.ts +6 -0
  93. package/src/console/ui/runs/errors.test.ts +53 -0
  94. package/src/console/ui/runs/errors.ts +88 -0
  95. package/src/console/ui/runs/index.ts +8 -0
  96. package/src/console/ui/runs/search.ts +16 -0
  97. package/src/console/ui/shell/panels/runs/RunsPanel.tsx +72 -1
  98. package/src/docker/ai-model-status.test.ts +101 -0
  99. package/src/docker/ai-model-status.ts +276 -0
  100. package/src/docker/compose-health.test.ts +115 -0
  101. package/src/docker/compose-health.ts +234 -0
  102. package/src/docker/compose.ts +24 -8
  103. package/src/docker/derive.ts +35 -9
  104. package/src/docker/docker.test.ts +304 -12
  105. package/src/docker/helpers.ts +56 -0
  106. package/src/docker/index.ts +52 -0
  107. package/src/docker/ollama-pull.ts +232 -0
  108. package/src/docker/recipes/cockroach.ts +24 -0
  109. package/src/docker/recipes/index.ts +32 -0
  110. package/src/docker/recipes/llama-cpp.ts +273 -0
  111. package/src/docker/recipes/ollama.ts +19 -23
  112. package/src/docker/recipes/pgdog.ts +4 -1
  113. package/src/docker/recipes/postgres.ts +5 -18
  114. package/src/docker/recipes/sglang.ts +55 -0
  115. package/src/docker/recipes/supabase.ts +21 -0
  116. package/src/docker/recipes/timescale.ts +18 -0
  117. package/src/docker/recipes/vllm.ts +44 -0
  118. package/src/docker/recipes/yugabyte.ts +23 -0
  119. package/src/docker/stack-id.test.ts +22 -0
  120. package/src/docker/stack-id.ts +38 -4
  121. package/src/docker/types.ts +15 -0
  122. package/src/drivers/ai-ollama.integration.test.ts +7 -4
  123. package/src/drivers/signal-engine.ts +10 -0
  124. package/src/drivers/signal-postgres.ts +24 -2
  125. package/src/drivers/signal-types.ts +10 -0
  126. package/src/elements/channel/fallback.test.ts +91 -0
  127. package/src/elements/channel/hard-bounce.test.ts +82 -0
  128. package/src/elements/channel/injection.test.ts +153 -0
  129. package/src/elements/channel/locale-ar.test.ts +102 -0
  130. package/src/elements/channel/otp-delivery.ts +5 -2
  131. package/src/elements/channel/receipts-ledger.test.ts +100 -0
  132. package/src/elements/channel/runtime.ts +24 -1
  133. package/src/elements/channel/test-helpers.ts +60 -0
  134. package/src/elements/channel/whatsapp-compliance.test.ts +124 -0
  135. package/src/elements/store/cache.ts +1 -1
  136. package/src/elements/store/emit-drizzle.ts +43 -9
  137. package/src/elements/store/runtime.ts +1 -1
  138. package/src/elements/store/schema-decl.test.ts +2 -0
  139. package/src/elements/store/schema-decl.ts +15 -0
  140. package/src/elements/store/seed.ts +1 -1
  141. package/src/index.ts +1 -0
  142. package/src/kernel/app.ts +118 -11
  143. package/src/kernel/boot-bind/signal.ts +6 -2
  144. package/src/kernel/boot-bind/store.ts +2 -1
  145. package/src/kernel/boot.test.ts +6 -5
  146. package/src/kernel/boot.ts +8 -3
  147. package/src/kernel/compensate.test.ts +131 -0
  148. package/src/kernel/correlation.test.ts +108 -0
  149. package/src/kernel/effect-timing.test.ts +82 -0
  150. package/src/kernel/flow.ts +38 -0
  151. package/src/kernel/fx-runs.test.ts +49 -0
  152. package/src/kernel/fx.test.ts +14 -0
  153. package/src/kernel/fx.ts +111 -1
  154. package/src/manifest/types.ts +8 -2
  155. package/src/plugins/auth-delivery.mailpit.integration.test.ts +1 -1
  156. package/src/plugins/auth-methods.security.test.ts +3 -3
  157. package/src/plugins/auth-methods.test.ts +1 -1
  158. package/src/plugins/index.ts +2 -2
  159. package/src/plugins/otp.test.ts +21 -19
  160. package/src/plugins/otp.ts +36 -34
  161. package/src/plugins/taqnyat.live.test.ts +3 -3
  162. package/src/runs/collect.ts +3 -0
  163. package/src/runs/export-otlp.ts +64 -0
  164. package/src/runs/index.ts +16 -0
  165. package/src/runs/parquet.ts +9 -0
  166. package/src/runs/types.ts +5 -0
  167. package/src/runs/window.test.ts +68 -0
  168. package/src/runs/window.ts +148 -0
  169. package/src/runtime/boot-warn.test.ts +45 -0
  170. package/src/runtime/boot-warn.ts +17 -0
  171. package/src/runtime/dev-request-log.ts +5 -5
  172. package/src/term.test.ts +95 -10
  173. package/src/term.ts +369 -14
  174. package/src/console/ui/dist/assets/panel-overview-DONDzBd2.js +0 -1
  175. package/src/console/ui/dist/assets/panel-runs-D5zf-D9c.js +0 -1
@@ -30,9 +30,9 @@ export {
30
30
  otpEmailTemplate,
31
31
  otpSmsTemplate,
32
32
  otpWhatsappTemplate,
33
+ type OtpAppModeOptions,
33
34
  type OtpOptions,
34
- type OtpTier1Options,
35
- type OtpTier2Options,
35
+ type OtpProviderModeOptions,
36
36
  type PhoneStore,
37
37
  } from "./otp.ts";
38
38
  export {
@@ -1,5 +1,5 @@
1
1
  /**
2
- * otp() plugin — plug-time fail-loud, Tier 2 resend / sealed lifetime, Tier 1 boot.
2
+ * otp() plugin — plug-time fail-loud, app-mode resend / sealed lifetime, provider-mode boot.
3
3
  */
4
4
 
5
5
  import { afterEach, describe, expect, test } from "bun:test";
@@ -71,44 +71,46 @@ function mockOtpSmsDriver(): ChannelDriver {
71
71
  }
72
72
 
73
73
  describe("otp() plug-time fail-loud", () => {
74
- test("missing tier throws", () => {
75
- expect(() => otp({} as never)).toThrow(/tier is required/);
74
+ test("missing mode throws", () => {
75
+ expect(() => otp({} as never)).toThrow(/mode is required/);
76
76
  });
77
77
 
78
- test("tier 1 with channels throws", () => {
79
- expect(() => otp({ tier: 1, channels: ["sms"] } as never)).toThrow(/channels are forbidden/);
78
+ test('mode "provider" with channels throws', () => {
79
+ expect(() => otp({ mode: "provider", channels: ["sms"] } as never)).toThrow(
80
+ /channels are forbidden/,
81
+ );
80
82
  });
81
83
 
82
- test("tier 1 with exposeDevOtp throws", () => {
83
- expect(() => otp({ tier: 1, exposeDevOtp: true } as never)).toThrow(
84
+ test('mode "provider" with exposeDevOtp throws', () => {
85
+ expect(() => otp({ mode: "provider", exposeDevOtp: true } as never)).toThrow(
84
86
  /exposeDevOtp is forbidden/,
85
87
  );
86
88
  });
87
89
 
88
- test("tier 2 without channels throws", () => {
89
- expect(() => otp({ tier: 2 } as never)).toThrow(/channels is required/);
90
+ test('mode "app" without channels throws', () => {
91
+ expect(() => otp({ mode: "app" } as never)).toThrow(/channels is required/);
90
92
  });
91
93
  });
92
94
 
93
- describe("otp() Tier 1 boot", () => {
95
+ describe("otp() provider mode boot", () => {
94
96
  test("fails loud without Verify-capable SMS driver", async () => {
95
97
  const app = oke({
96
- name: `otp-t1-${crypto.randomUUID()}`,
98
+ name: `otp-provider-${crypto.randomUUID()}`,
97
99
  env: "test",
98
100
  registry: "ignore",
99
101
  gate: { auth: { secret: SECRET } },
100
- }).plug(otp({ tier: 1 }));
101
- await expect(app.boot({ env: "test" })).rejects.toThrow(/tier: 1/);
102
+ }).plug(otp({ mode: "provider" }));
103
+ await expect(app.boot({ env: "test" })).rejects.toThrow(/mode: "provider"/);
102
104
  });
103
105
 
104
106
  test("boots when Verify-capable SMS driver is bound", async () => {
105
107
  const app = oke({
106
- name: `otp-t1-ok-${crypto.randomUUID()}`,
108
+ name: `otp-provider-ok-${crypto.randomUUID()}`,
107
109
  env: "test",
108
110
  registry: "ignore",
109
111
  gate: { auth: { secret: SECRET } },
110
112
  channel: { drivers: [mockOtpSmsDriver()] },
111
- }).plug(otp({ tier: 1 }));
113
+ }).plug(otp({ mode: "provider" }));
112
114
  await app.boot({ env: "test" });
113
115
  const res = await app.fetch(jsonPost("/auth/otp/request", { phone: "+15551234567" }));
114
116
  expect(res.status).toBe(200);
@@ -120,12 +122,12 @@ describe("otp() Tier 1 boot", () => {
120
122
  });
121
123
  });
122
124
 
123
- describe("otp() Tier 2 resend + sealed lifetime", () => {
125
+ describe("otp() app mode resend + sealed lifetime", () => {
124
126
  test("cross-channel resend keeps same code; cooldown then verify wipes seal", async () => {
125
127
  let now = 1_000_000;
126
128
  const verifications: VerificationStore = createVerificationStore();
127
129
  const app = oke({
128
- name: `otp-t2-${crypto.randomUUID()}`,
130
+ name: `otp-app-${crypto.randomUUID()}`,
129
131
  env: "test",
130
132
  registry: "ignore",
131
133
  gate: { auth: { secret: SECRET } },
@@ -133,7 +135,7 @@ describe("otp() Tier 2 resend + sealed lifetime", () => {
133
135
  fx: { now: () => now },
134
136
  }).plug(
135
137
  otp({
136
- tier: 2,
138
+ mode: "app",
137
139
  channels: ["sms", "email"],
138
140
  exposeDevOtp: true,
139
141
  resendCooldownMs: 60_000,
@@ -209,7 +211,7 @@ describe("otp() Tier 2 resend + sealed lifetime", () => {
209
211
  fx: { now: () => now },
210
212
  }).plug(
211
213
  otp({
212
- tier: 2,
214
+ mode: "app",
213
215
  channels: ["email"],
214
216
  exposeDevOtp: true,
215
217
  ttlMs: 1_000,
@@ -1,6 +1,6 @@
1
1
  /**
2
- * Unified OTP Gate auth method plugin — Tier 1 (provider-owned) or Tier 2
3
- * (app-owned multi-channel). Replaces emailOtp() + phoneNumber().
2
+ * Unified OTP Gate auth method plugin — provider mode (Verify) or app mode
3
+ * (multi-channel). Replaces emailOtp() + phoneNumber().
4
4
  */
5
5
 
6
6
  import { constantTimeEqual } from "../auth/constant-time.ts";
@@ -66,20 +66,20 @@ interface OtpBaseOptions extends AuthMethodOptions {
66
66
  readonly identities?: IdentityStore;
67
67
  }
68
68
 
69
- /** Tier 1 — provider-owned OTP via fx.sendOtp / fx.verifyOtp. */
70
- export interface OtpTier1Options extends OtpBaseOptions {
71
- readonly tier: 1;
72
- /** Forbidden on Tier 1 — fail loud if set. */
69
+ /** Provider mode — provider-owned OTP via fx.sendOtp / fx.verifyOtp. */
70
+ export interface OtpProviderModeOptions extends OtpBaseOptions {
71
+ readonly mode: "provider";
72
+ /** Forbidden in provider mode — fail loud if set. */
73
73
  readonly channels?: never;
74
- /** Forbidden on Tier 1 — code never exists server-side. */
74
+ /** Forbidden in provider mode — code never exists server-side. */
75
75
  readonly exposeDevOtp?: never;
76
76
  readonly resendCooldownMs?: never;
77
77
  readonly from?: never;
78
78
  }
79
79
 
80
- /** Tier 2 — app-owned OTP with multi-channel delivery. */
81
- export interface OtpTier2Options extends OtpBaseOptions {
82
- readonly tier: 2;
80
+ /** App mode — app-owned OTP with multi-channel delivery. */
81
+ export interface OtpAppModeOptions extends OtpBaseOptions {
82
+ readonly mode: "app";
83
83
  /** Build-time preferred channel order (required). */
84
84
  readonly channels: readonly OtpChannel[];
85
85
  readonly resendCooldownMs?: number;
@@ -87,24 +87,24 @@ export interface OtpTier2Options extends OtpBaseOptions {
87
87
  readonly from?: string;
88
88
  }
89
89
 
90
- /** Options for {@link otp}. `tier` is mandatory — no auto-detect. */
91
- export type OtpOptions = OtpTier1Options | OtpTier2Options;
90
+ /** Options for {@link otp}. `mode` is mandatory — no auto-detect. */
91
+ export type OtpOptions = OtpProviderModeOptions | OtpAppModeOptions;
92
92
 
93
- /** Email OTP template (Tier 2). */
93
+ /** Email OTP template (app mode). */
94
94
  export const otpEmailTemplate = channel.email({ from: DEFAULT_FROM }).template("auth-otp-email", {
95
95
  description: "OTP sign-in code (email)",
96
96
  schema: z.object({ email: z.string(), otp: z.string() }),
97
97
  locales: ["en", "ar"],
98
98
  });
99
99
 
100
- /** SMS OTP template (Tier 2 — plain message, not provider Verify). */
100
+ /** SMS OTP template (app mode — plain message, not provider Verify). */
101
101
  export const otpSmsTemplate = channel.sms().template("auth-otp-sms", {
102
102
  description: "OTP sign-in code (SMS)",
103
103
  schema: z.object({ phone: z.string(), otp: z.string() }),
104
104
  locales: ["en", "ar"],
105
105
  });
106
106
 
107
- /** WhatsApp OTP template (Tier 2). */
107
+ /** WhatsApp OTP template (app mode). */
108
108
  export const otpWhatsappTemplate = channel.whatsapp().template("auth-otp-whatsapp", {
109
109
  description: "OTP sign-in code (WhatsApp)",
110
110
  schema: z.object({ phone: z.string(), otp: z.string() }),
@@ -136,18 +136,20 @@ export const otpCatalog = {
136
136
  } as const;
137
137
 
138
138
  function assertOtpOptions(opts: OtpOptions): void {
139
- if (opts.tier !== 1 && opts.tier !== 2) {
140
- throw new Error("otp(): tier is required — set tier: 1 or tier: 2 (no auto-detect)");
139
+ if (opts.mode !== "provider" && opts.mode !== "app") {
140
+ throw new Error(
141
+ 'otp(): mode is required — set mode: "provider" or mode: "app" (no auto-detect)',
142
+ );
141
143
  }
142
- if (opts.tier === 1) {
144
+ if (opts.mode === "provider") {
143
145
  if ("channels" in opts && opts.channels !== undefined) {
144
146
  throw new Error(
145
- "otp({ tier: 1 }): channels are forbidden — provider-owned OTP cannot resend via a different channel; use tier: 2 for multi-channel",
147
+ 'otp({ mode: "provider" }): channels are forbidden — provider-owned OTP cannot resend via a different channel; use mode: "app" for multi-channel',
146
148
  );
147
149
  }
148
150
  if ("exposeDevOtp" in opts && (opts as { exposeDevOtp?: boolean }).exposeDevOtp === true) {
149
151
  throw new Error(
150
- "otp({ tier: 1 }): exposeDevOtp is forbidden — the code never exists server-side",
152
+ 'otp({ mode: "provider" }): exposeDevOtp is forbidden — the code never exists server-side',
151
153
  );
152
154
  }
153
155
  return;
@@ -155,12 +157,12 @@ function assertOtpOptions(opts: OtpOptions): void {
155
157
  const channels = opts.channels;
156
158
  if (!channels || channels.length === 0) {
157
159
  throw new Error(
158
- 'otp({ tier: 2 }): channels is required — declare at least one of "sms" | "whatsapp" | "email"',
160
+ 'otp({ mode: "app" }): channels is required — declare at least one of "sms" | "whatsapp" | "email"',
159
161
  );
160
162
  }
161
163
  for (const ch of channels) {
162
164
  if (!(OTP_CHANNELS as readonly string[]).includes(ch)) {
163
- throw new Error(`otp({ tier: 2 }): unknown channel "${String(ch)}"`);
165
+ throw new Error(`otp({ mode: "app" }): unknown channel "${String(ch)}"`);
164
166
  }
165
167
  }
166
168
  }
@@ -186,9 +188,9 @@ function pickRequestChannel(
186
188
  }
187
189
 
188
190
  /**
189
- * Unified OTP request + verify (+ Tier-2 resend).
191
+ * Unified OTP request + verify (+ app-mode resend).
190
192
  *
191
- * @param opts - Must include `tier: 1` or `tier: 2`
193
+ * @param opts - Must include `mode: "provider"` or `mode: "app"`
192
194
  */
193
195
  export function otp(opts: OtpOptions): PluginDef {
194
196
  assertOtpOptions(opts);
@@ -200,12 +202,12 @@ export function otp(opts: OtpOptions): PluginDef {
200
202
  const verifications = opts.verifications ?? createVerificationStore();
201
203
  const ttlMs = opts.ttlMs ?? DEFAULT_TTL_MS;
202
204
  const resendCooldownMs =
203
- opts.tier === 2
205
+ opts.mode === "app"
204
206
  ? (opts.resendCooldownMs ?? DEFAULT_RESEND_COOLDOWN_MS)
205
207
  : DEFAULT_RESEND_COOLDOWN_MS;
206
- const channels = opts.tier === 2 ? opts.channels : ([] as const);
207
- const exposeDevOtp = opts.tier === 2 && opts.exposeDevOtp === true;
208
- const from = opts.tier === 2 ? opts.from : undefined;
208
+ const channels = opts.mode === "app" ? opts.channels : ([] as const);
209
+ const exposeDevOtp = opts.mode === "app" && opts.exposeDevOtp === true;
210
+ const from = opts.mode === "app" ? opts.from : undefined;
209
211
 
210
212
  const emailTmpl =
211
213
  from !== undefined
@@ -223,9 +225,9 @@ export function otp(opts: OtpOptions): PluginDef {
223
225
  } as const;
224
226
 
225
227
  const configSnapshot: OtpPluginConfig =
226
- opts.tier === 1
227
- ? { method: "otp", tier: 1 }
228
- : { method: "otp", tier: 2, channels: [...channels] };
228
+ opts.mode === "provider"
229
+ ? { method: "otp", mode: "provider" }
230
+ : { method: "otp", mode: "app", channels: [...channels] };
229
231
 
230
232
  const requestOut = z.object({
231
233
  ok: z.literal(true),
@@ -233,7 +235,7 @@ export function otp(opts: OtpOptions): PluginDef {
233
235
  channel: z.enum(["sms", "whatsapp", "email"]).optional(),
234
236
  });
235
237
 
236
- if (opts.tier === 1) {
238
+ if (opts.mode === "provider") {
237
239
  const request = flow({
238
240
  name: "auth.requestOtp",
239
241
  unit: "auth",
@@ -270,7 +272,7 @@ export function otp(opts: OtpOptions): PluginDef {
270
272
  phone,
271
273
  sealedOtp: null,
272
274
  });
273
- // Tier 1: resend-via-different-channel is impossible — provider owns the code.
275
+ // Provider mode: resend-via-different-channel is impossible — provider owns the code.
274
276
  return { ok: true as const, channel: "sms" as const };
275
277
  },
276
278
  });
@@ -344,7 +346,7 @@ export function otp(opts: OtpOptions): PluginDef {
344
346
  .binding(bindPublicAuth("/otp/verify", verify, "otp"));
345
347
  }
346
348
 
347
- // ── Tier 2 ────────────────────────────────────────────────────────────
349
+ // ── App mode ───────────────────────────────────────────────────────────
348
350
  const request = flow({
349
351
  name: "auth.requestOtp",
350
352
  unit: "auth",
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Real Taqnyat end-to-end: otp({ tier: 1 }) via Verify API + magic-link via Taqnyat Mail.
2
+ * Real Taqnyat end-to-end: otp({ mode: "provider" }) via Verify API + magic-link via Taqnyat Mail.
3
3
  *
4
4
  * Double-gated — runs ONLY when BOTH:
5
5
  * 1. The global per-medium opt-in flag is set explicitly
@@ -82,7 +82,7 @@ if (!LIVE_MAIL) {
82
82
  const liveSms = LIVE_SMS ? test : test.skip;
83
83
  const liveMail = LIVE_MAIL ? test : test.skip;
84
84
 
85
- describe("taqnyat live — provider-managed OTP (Taqnyat Verify)", () => {
85
+ describe("taqnyat live — provider OTP (Taqnyat Verify)", () => {
86
86
  liveSms(
87
87
  "phone OTP request → real sendOtp → Taqnyat success code 5",
88
88
  async () => {
@@ -94,7 +94,7 @@ describe("taqnyat live — provider-managed OTP (Taqnyat Verify)", () => {
94
94
  config: {
95
95
  drivers: { channel: { sms: { test: "taqnyat" } } },
96
96
  },
97
- }).plug(otp({ tier: 1 }));
97
+ }).plug(otp({ mode: "provider" }));
98
98
  await app.boot({ env: "test" });
99
99
 
100
100
  // Wrap the live transport so the plugin's single real send also proves
@@ -32,6 +32,8 @@ export interface CollectWideEventInput {
32
32
  readonly endedAt: number;
33
33
  /** Pipeline failure when present. */
34
34
  readonly failure?: FlowFailure | null;
35
+ /** Validated flow input (for local replay). */
36
+ readonly input?: unknown;
35
37
  /** Optional parent run id (causal chain). */
36
38
  readonly parentId?: string;
37
39
  /** Optional run id (generated when omitted). */
@@ -104,6 +106,7 @@ export function collectWideEvent(input: CollectWideEventInput): WideEvent {
104
106
  : {}),
105
107
  ...(input.buildVersion !== undefined ? { buildVersion: input.buildVersion } : {}),
106
108
  error,
109
+ ...(input.input !== undefined ? { input: input.input } : {}),
107
110
  effects: [...input.ledger.entries],
108
111
  logs: [...input.telemetry.logs],
109
112
  durationMs,
@@ -0,0 +1,64 @@
1
+ /**
2
+ * Optional OTLP metrics export shape — additive sink for WideEvents.
3
+ *
4
+ * Not a prerequisite for native alerting (Runs + Clock + Channel).
5
+ * Protocol-named (`otlp`); vendor choice stays in config / images.
6
+ */
7
+
8
+ import type { WideEvent } from "./types.ts";
9
+
10
+ /** One OTLP-shaped metric datapoint derived from a wide event. */
11
+ export interface OtlpRunMetric {
12
+ readonly name: "oke.runs" | "oke.run.duration_ms";
13
+ readonly kind: "counter" | "histogram";
14
+ readonly value: number;
15
+ readonly attributes: Readonly<Record<string, string>>;
16
+ readonly timeUnixMs: number;
17
+ }
18
+
19
+ /**
20
+ * Map a WideEvent onto OTLP-friendly metric datapoints.
21
+ *
22
+ * @param event - Appended run
23
+ */
24
+ export function wideEventToOtlpMetrics(event: WideEvent): readonly OtlpRunMetric[] {
25
+ const attributes = {
26
+ flow: event.flow,
27
+ trigger: event.trigger,
28
+ outcome: event.error ? "error" : "ok",
29
+ ...(event.error ? { error_code: event.error.code } : {}),
30
+ };
31
+ return [
32
+ {
33
+ name: "oke.runs",
34
+ kind: "counter",
35
+ value: 1,
36
+ attributes,
37
+ timeUnixMs: event.endedAt,
38
+ },
39
+ {
40
+ name: "oke.run.duration_ms",
41
+ kind: "histogram",
42
+ value: event.durationMs,
43
+ attributes: { flow: event.flow, trigger: event.trigger },
44
+ timeUnixMs: event.endedAt,
45
+ },
46
+ ];
47
+ }
48
+
49
+ /** Pluggable sink for teams with an existing Grafana / Datadog stack. */
50
+ export type OtlpMetricsSink = (metrics: readonly OtlpRunMetric[]) => void | Promise<void>;
51
+
52
+ /**
53
+ * Fan-out helper: call after `runs.record` when an OTLP sink is configured.
54
+ *
55
+ * @param event - Just-recorded wide event
56
+ * @param sink - Optional exporter
57
+ */
58
+ export async function exportRunMetrics(
59
+ event: WideEvent,
60
+ sink: OtlpMetricsSink | undefined,
61
+ ): Promise<void> {
62
+ if (!sink) return;
63
+ await sink(wideEventToOtlpMetrics(event));
64
+ }
package/src/runs/index.ts CHANGED
@@ -68,5 +68,21 @@ export {
68
68
 
69
69
  export { privacyErase, type PrivacyEraseOptions, type PrivacyEraseResult } from "./privacy.ts";
70
70
 
71
+ export {
72
+ evaluateSloBreaches,
73
+ parseLatencyMs,
74
+ percentile,
75
+ windowStatsForFlow,
76
+ type RunWindowStats,
77
+ type SloBreach,
78
+ } from "./window.ts";
79
+
80
+ export {
81
+ exportRunMetrics,
82
+ wideEventToOtlpMetrics,
83
+ type OtlpMetricsSink,
84
+ type OtlpRunMetric,
85
+ } from "./export-otlp.ts";
86
+
71
87
  export { createRunsPostgresFake } from "./drivers/postgres.ts";
72
88
  export { createRunsClickHouseFake } from "./drivers/clickhouse.ts";
@@ -42,6 +42,7 @@ export function wideEventToRow(event: WideEvent): ParquetRow {
42
42
  build_version: event.buildVersion ?? null,
43
43
  error_code: event.error?.code ?? null,
44
44
  error_message: event.error?.message ?? null,
45
+ input: event.input === undefined ? null : JSON.stringify(event.input),
45
46
  effects: JSON.stringify(event.effects),
46
47
  logs: JSON.stringify(event.logs),
47
48
  duration_ms: event.durationMs,
@@ -103,6 +104,14 @@ export function rowToWideEvent(row: Record<string, unknown>): WideEvent {
103
104
  ...(row.error_message != null ? { message: String(row.error_message) } : {}),
104
105
  }
105
106
  : null,
107
+ ...(row.input != null && row.input !== ""
108
+ ? {
109
+ input:
110
+ typeof row.input === "string"
111
+ ? (JSON.parse(row.input) as unknown)
112
+ : (row.input as unknown),
113
+ }
114
+ : {}),
106
115
  effects: parseJsonArray(row.effects) as WideEvent["effects"],
107
116
  logs: parseJsonArray(row.logs) as WideEvent["logs"],
108
117
  durationMs: Number(row.duration_ms ?? 0),
package/src/runs/types.ts CHANGED
@@ -69,6 +69,11 @@ export interface WideEvent {
69
69
  readonly buildVersion?: string;
70
70
  /** Typed error when the flow failed. */
71
71
  readonly error?: RunError | null;
72
+ /**
73
+ * Validated flow input snapshot for local replay (`oke replay`).
74
+ * Declared personal fields may be crypto-shredded into {@link archived}.
75
+ */
76
+ readonly input?: unknown;
72
77
  /** Effect ledger snapshot. */
73
78
  readonly effects: readonly EffectEntry[];
74
79
  /**
@@ -0,0 +1,68 @@
1
+ import { describe, expect, test } from "bun:test";
2
+ import type { WideEvent } from "./types.ts";
3
+ import { evaluateSloBreaches, parseLatencyMs, windowStatsForFlow } from "./window.ts";
4
+
5
+ function ev(
6
+ partial: Partial<WideEvent> & Pick<WideEvent, "id" | "durationMs" | "startedAt">,
7
+ ): WideEvent {
8
+ return {
9
+ flow: "checkout.create",
10
+ trigger: "http",
11
+ plane: "user",
12
+ gates: [],
13
+ cache: "none",
14
+ error: null,
15
+ effects: [],
16
+ logs: [],
17
+ endedAt: partial.startedAt + partial.durationMs,
18
+ dimensions: {},
19
+ ...partial,
20
+ };
21
+ }
22
+
23
+ describe("runs window stats", () => {
24
+ test("parseLatencyMs", () => {
25
+ expect(parseLatencyMs("200ms")).toBe(200);
26
+ expect(parseLatencyMs("1s")).toBe(1000);
27
+ expect(parseLatencyMs("bad")).toBeNull();
28
+ });
29
+
30
+ test("computes p95 and error rate", () => {
31
+ const now = 10_000;
32
+ const events = [
33
+ ev({ id: "1", durationMs: 10, startedAt: now - 1000 }),
34
+ ev({ id: "2", durationMs: 20, startedAt: now - 900 }),
35
+ ev({ id: "3", durationMs: 30, startedAt: now - 800 }),
36
+ ev({ id: "4", durationMs: 40, startedAt: now - 700 }),
37
+ ev({
38
+ id: "5",
39
+ durationMs: 200,
40
+ startedAt: now - 600,
41
+ error: { code: "Timeout" },
42
+ }),
43
+ ];
44
+ const stats = windowStatsForFlow(events, "checkout.create", now, 5 * 60_000);
45
+ expect(stats.total).toBe(5);
46
+ expect(stats.errors).toBe(1);
47
+ expect(stats.errorRate).toBeCloseTo(0.2);
48
+ expect(stats.p95Ms).toBe(200);
49
+ });
50
+
51
+ test("evaluateSloBreaches flags latency and availability", () => {
52
+ const stats = windowStatsForFlow(
53
+ [
54
+ ev({ id: "1", durationMs: 500, startedAt: 9000, error: { code: "X" } }),
55
+ ev({ id: "2", durationMs: 500, startedAt: 9100 }),
56
+ ],
57
+ "checkout.create",
58
+ 10_000,
59
+ 5_000,
60
+ );
61
+ const breaches = evaluateSloBreaches(stats, {
62
+ availability: "99.9%",
63
+ latency: { p95: "100ms" },
64
+ });
65
+ expect(breaches.some((b) => b.kind === "availability")).toBe(true);
66
+ expect(breaches.some((b) => b.kind === "latency_p95")).toBe(true);
67
+ });
68
+ });
@@ -0,0 +1,148 @@
1
+ /**
2
+ * Rolling window metrics over WideEvents — shared by Console Overview and
3
+ * Flow-facing `fx.runs` checkers (native alerting without `fx.metric`).
4
+ */
5
+
6
+ import type { WideEvent } from "./types.ts";
7
+
8
+ /** One flow's rolling stats over a time window. */
9
+ export interface RunWindowStats {
10
+ readonly flow: string;
11
+ readonly total: number;
12
+ readonly errors: number;
13
+ readonly errorRate: number;
14
+ readonly p50Ms: number;
15
+ readonly p95Ms: number;
16
+ readonly p99Ms: number;
17
+ readonly from: number;
18
+ readonly to: number;
19
+ }
20
+
21
+ /**
22
+ * Percentile of a sorted numeric array.
23
+ *
24
+ * @param sorted - Ascending durations
25
+ * @param p - Percentile in (0, 1]
26
+ */
27
+ export function percentile(sorted: readonly number[], p: number): number {
28
+ if (sorted.length === 0) return 0;
29
+ if (sorted.length === 1) return sorted[0]!;
30
+ const idx = Math.min(sorted.length - 1, Math.max(0, Math.ceil(p * sorted.length) - 1));
31
+ return sorted[idx]!;
32
+ }
33
+
34
+ /**
35
+ * Parse a Manifest latency string like `200ms` / `1s` into milliseconds.
36
+ *
37
+ * @param raw - Latency threshold
38
+ */
39
+ export function parseLatencyMs(raw: string | undefined): number | null {
40
+ if (!raw) return null;
41
+ const match = /^(\d+(?:\.\d+)?)\s*(ms|s|m)?$/i.exec(raw.trim());
42
+ if (!match) return null;
43
+ const n = Number(match[1]);
44
+ if (!Number.isFinite(n) || n < 0) return null;
45
+ const unit = (match[2] ?? "ms").toLowerCase();
46
+ if (unit === "s") return Math.round(n * 1000);
47
+ if (unit === "m") return Math.round(n * 60_000);
48
+ return Math.round(n);
49
+ }
50
+
51
+ /**
52
+ * Compute rolling stats for one flow over `[to - windowMs, to]`.
53
+ *
54
+ * @param events - Wide events
55
+ * @param flow - Flow name filter
56
+ * @param to - Window end (epoch-ms)
57
+ * @param windowMs - Window length
58
+ */
59
+ export function windowStatsForFlow(
60
+ events: readonly WideEvent[],
61
+ flow: string,
62
+ to: number,
63
+ windowMs: number,
64
+ ): RunWindowStats {
65
+ const from = to - Math.max(0, windowMs);
66
+ const mine = events.filter((e) => e.flow === flow && e.startedAt >= from && e.startedAt <= to);
67
+ const durations = mine.map((e) => e.durationMs).sort((a, b) => a - b);
68
+ const errors = mine.filter((e) => e.error != null).length;
69
+ const total = mine.length;
70
+ return {
71
+ flow,
72
+ total,
73
+ errors,
74
+ errorRate: total === 0 ? 0 : errors / total,
75
+ p50Ms: percentile(durations, 0.5),
76
+ p95Ms: percentile(durations, 0.95),
77
+ p99Ms: percentile(durations, 0.99),
78
+ from,
79
+ to,
80
+ };
81
+ }
82
+
83
+ /** Breach report for a declared latency / availability SLO. */
84
+ export interface SloBreach {
85
+ readonly flow: string;
86
+ readonly kind: "availability" | "latency_p95" | "latency_p99";
87
+ readonly threshold: number;
88
+ readonly observed: number;
89
+ readonly sampleCount: number;
90
+ }
91
+
92
+ /**
93
+ * Evaluate Manifest-style SLO thresholds against window stats.
94
+ *
95
+ * @param stats - Window stats
96
+ * @param slo - Declared availability + latency
97
+ */
98
+ export function evaluateSloBreaches(
99
+ stats: RunWindowStats,
100
+ slo: {
101
+ readonly availability?: string;
102
+ readonly latency?: { readonly p95?: string; readonly p99?: string };
103
+ },
104
+ ): SloBreach[] {
105
+ const out: SloBreach[] = [];
106
+ if (stats.total === 0) return out;
107
+
108
+ if (slo.availability) {
109
+ const match = /^(\d+(?:\.\d+)?)\s*%?$/.exec(slo.availability.trim());
110
+ if (match) {
111
+ const pct = Number(match[1]);
112
+ const tolerable = Math.max(0, 1 - pct / 100);
113
+ if (stats.errorRate > tolerable) {
114
+ out.push({
115
+ flow: stats.flow,
116
+ kind: "availability",
117
+ threshold: tolerable,
118
+ observed: stats.errorRate,
119
+ sampleCount: stats.total,
120
+ });
121
+ }
122
+ }
123
+ }
124
+
125
+ const p95 = parseLatencyMs(slo.latency?.p95);
126
+ if (p95 != null && stats.p95Ms > p95) {
127
+ out.push({
128
+ flow: stats.flow,
129
+ kind: "latency_p95",
130
+ threshold: p95,
131
+ observed: stats.p95Ms,
132
+ sampleCount: stats.total,
133
+ });
134
+ }
135
+
136
+ const p99 = parseLatencyMs(slo.latency?.p99);
137
+ if (p99 != null && stats.p99Ms > p99) {
138
+ out.push({
139
+ flow: stats.flow,
140
+ kind: "latency_p99",
141
+ threshold: p99,
142
+ observed: stats.p99Ms,
143
+ sampleCount: stats.total,
144
+ });
145
+ }
146
+
147
+ return out;
148
+ }