devframe 0.6.1 → 0.7.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 (40) hide show
  1. package/dist/adapters/build.d.mts +1 -1
  2. package/dist/adapters/cac.d.mts +41 -0
  3. package/dist/adapters/cac.mjs +2 -0
  4. package/dist/adapters/cli.d.mts +8 -31
  5. package/dist/adapters/cli.mjs +3 -143
  6. package/dist/adapters/dev.d.mts +3 -3
  7. package/dist/adapters/dev.mjs +1 -1
  8. package/dist/adapters/embedded.d.mts +1 -1
  9. package/dist/adapters/mcp.d.mts +1 -1
  10. package/dist/cac-DCBSjlzl.mjs +152 -0
  11. package/dist/client/index.d.mts +90 -5
  12. package/dist/client/index.mjs +143 -6
  13. package/dist/{context-UX9qUDK7.d.mts → context-BsiCAEC4.d.mts} +1 -1
  14. package/dist/{dev-DE51PeJc.mjs → dev-YeAm6GL0.mjs} +1 -1
  15. package/dist/{devframe-BtVHhmwM.d.mts → devframe-Dma0XG3U.d.mts} +53 -6
  16. package/dist/helpers/vite.d.mts +2 -2
  17. package/dist/helpers/vite.mjs +2 -2
  18. package/dist/{index-DXHWuwJk.d.mts → index-BAZpbgHu.d.mts} +1 -1
  19. package/dist/{index-Dy6GFDRf.d.mts → index-DI_TMGjv.d.mts} +2 -2
  20. package/dist/{index-ByaMT1Xp.d.mts → index-d40ZLcYw.d.mts} +3 -3
  21. package/dist/index.d.mts +4 -4
  22. package/dist/node/auth.d.mts +1 -1
  23. package/dist/node/hub-internals.d.mts +2 -2
  24. package/dist/node/index.d.mts +5 -5
  25. package/dist/recipes/interactive-auth.d.mts +2 -2
  26. package/dist/recipes/open-helpers.d.mts +1 -1
  27. package/dist/rpc/dump.d.mts +1 -1
  28. package/dist/rpc/index.d.mts +2 -2
  29. package/dist/rpc/transports/ws-client.d.mts +1 -1
  30. package/dist/rpc/transports/ws-server.d.mts +1 -1
  31. package/dist/{server-Cfr1NrGQ.d.mts → server-BD-tKDVf.d.mts} +2 -2
  32. package/dist/types/index.d.mts +4 -4
  33. package/dist/{types-DZEx4ffs.d.mts → types-oEqKqUC9.d.mts} +4 -4
  34. package/dist/utils/events.d.mts +1 -1
  35. package/dist/utils/shared-state.d.mts +1 -1
  36. package/dist/utils/streaming-channel.d.mts +1 -1
  37. package/dist/{ws-client-D0z0pOhn.d.mts → ws-client-nBjpin71.d.mts} +1 -1
  38. package/dist/{ws-server-Bc2wBHl-.d.mts → ws-server-BUgJpdX4.d.mts} +1 -1
  39. package/package.json +8 -3
  40. package/skills/devframe/SKILL.md +4 -4
@@ -1,4 +1,4 @@
1
- import { r as DevframeDefinition } from "../devframe-BtVHhmwM.mjs";
1
+ import { r as DevframeDefinition } from "../devframe-Dma0XG3U.mjs";
2
2
 
3
3
  //#region src/adapters/build.d.ts
4
4
  interface CreateBuildOptions {
@@ -0,0 +1,41 @@
1
+ import { Dt as defineCliFlags, Et as InferCliFlags, Ot as parseCliFlags, Tt as CliFlagsSchema, r as DevframeDefinition } from "../devframe-Dma0XG3U.mjs";
2
+ import { CAC } from "cac";
3
+ import { H3 } from "h3";
4
+
5
+ //#region src/adapters/cac.d.ts
6
+ interface CreateCacOptions {
7
+ /** Default port for `dev` (default: 9999). */
8
+ defaultPort?: number;
9
+ /**
10
+ * Final CAC hook invoked after devframe's built-in subcommands and
11
+ * after the definition's `cli.configure`. Use this to add app-level
12
+ * flags and commands at the assembly stage.
13
+ */
14
+ configureCli?: (cli: CAC) => void;
15
+ /**
16
+ * Called once the dev server is listening. Use this to print a
17
+ * startup banner or trigger side-effects that depend on the live URL.
18
+ */
19
+ onReady?: (info: {
20
+ origin: string;
21
+ port: number;
22
+ app: H3;
23
+ }) => void | Promise<void>;
24
+ }
25
+ interface CacHandle {
26
+ /**
27
+ * Raw CAC instance. Mutate before calling `parse()` for last-mile
28
+ * flag or command additions that don't fit `configureCli`.
29
+ */
30
+ cli: CAC;
31
+ parse: (argv?: string[]) => Promise<void>;
32
+ }
33
+ /**
34
+ * Wrap a {@link DevframeDefinition} in a `cac`-powered command-line
35
+ * interface exposing `dev` / `build` / `mcp` subcommands.
36
+ *
37
+ * Requires the optional `cac` peer dependency.
38
+ */
39
+ declare function createCac(d: DevframeDefinition, options?: CreateCacOptions): CacHandle;
40
+ //#endregion
41
+ export { CacHandle, type CliFlagsSchema, CreateCacOptions, type InferCliFlags, createCac, defineCliFlags, parseCliFlags };
@@ -0,0 +1,2 @@
1
+ import { n as defineCliFlags, r as parseCliFlags, t as createCac } from "../cac-DCBSjlzl.mjs";
2
+ export { createCac, defineCliFlags, parseCliFlags };
@@ -1,35 +1,12 @@
1
- import { Dt as parseCliFlags, Et as defineCliFlags, Tt as InferCliFlags, r as DevframeDefinition, wt as CliFlagsSchema } from "../devframe-BtVHhmwM.mjs";
2
- import { CAC } from "cac";
3
- import { H3 } from "h3";
1
+ import { Dt as defineCliFlags, Et as InferCliFlags, Ot as parseCliFlags, Tt as CliFlagsSchema } from "../devframe-Dma0XG3U.mjs";
2
+ import { CacHandle, CreateCacOptions, createCac } from "./cac.mjs";
4
3
 
5
4
  //#region src/adapters/cli.d.ts
6
- interface CreateCliOptions {
7
- /** Default port for `dev` (default: 9999). */
8
- defaultPort?: number;
9
- /**
10
- * Final CAC hook invoked after devframe's built-in subcommands and
11
- * after the definition's `cli.configure`. Use this to add app-level
12
- * flags and commands at the assembly stage.
13
- */
14
- configureCli?: (cli: CAC) => void;
15
- /**
16
- * Called once the dev server is listening. Use this to print a
17
- * startup banner or trigger side-effects that depend on the live URL.
18
- */
19
- onReady?: (info: {
20
- origin: string;
21
- port: number;
22
- app: H3;
23
- }) => void | Promise<void>;
24
- }
25
- interface CliHandle {
26
- /**
27
- * Raw CAC instance. Mutate before calling `parse()` for last-mile
28
- * flag or command additions that don't fit `configureCli`.
29
- */
30
- cli: CAC;
31
- parse: (argv?: string[]) => Promise<void>;
32
- }
33
- declare function createCli(d: DevframeDefinition, options?: CreateCliOptions): CliHandle;
5
+ /** @deprecated Use `createCac` from `devframe/adapters/cac` instead. */
6
+ declare const createCli: typeof createCac;
7
+ /** @deprecated Use `CreateCacOptions` from `devframe/adapters/cac` instead. */
8
+ type CreateCliOptions = CreateCacOptions;
9
+ /** @deprecated Use `CacHandle` from `devframe/adapters/cac` instead. */
10
+ type CliHandle = CacHandle;
34
11
  //#endregion
35
12
  export { type CliFlagsSchema, CliHandle, CreateCliOptions, type InferCliFlags, createCli, defineCliFlags, parseCliFlags };
@@ -1,146 +1,6 @@
1
- import { n as colors } from "../diagnostics-reporter-CsIG85Q5.mjs";
2
- import { createBuild } from "./build.mjs";
3
- import { n as resolveDevServerPort, t as createDevServer } from "../dev-DE51PeJc.mjs";
4
- import process from "node:process";
5
- import cac from "cac";
6
- import { safeParse } from "valibot";
7
- //#region src/adapters/flags.ts
8
- /**
9
- * Identity helper that preserves the literal schema-map type — use this
10
- * so `InferCliFlags<typeof myFlags>` resolves to the right object shape.
11
- *
12
- * ```ts
13
- * const appFlags = defineCliFlags({
14
- * depth: v.pipe(v.number(), v.integer()),
15
- * config: v.optional(v.string()),
16
- * })
17
- *
18
- * defineDevframe({
19
- * cli: { flags: appFlags },
20
- * setup(ctx, info) {
21
- * const flags = info.flags as InferCliFlags<typeof appFlags>
22
- * flags.depth // number
23
- * flags.config // string | undefined
24
- * },
25
- * })
26
- * ```
27
- */
28
- function defineCliFlags(flags) {
29
- return flags;
30
- }
31
- /**
32
- * Best-effort probe of a valibot schema to decide whether the
33
- * corresponding CAC option takes a value. Unwraps `optional` / `nullable`
34
- * / `nullish` / `default` / `pipe` wrappers then matches on the inner
35
- * type's kind.
36
- */
37
- function getSchemaKind(schema) {
38
- let current = schema;
39
- while (current) {
40
- const kind = current.type;
41
- if (kind === "optional" || kind === "nullable" || kind === "nullish" || kind === "undefined") {
42
- current = current.wrapped ?? current.inner;
43
- continue;
44
- }
45
- if (kind === "pipe" && Array.isArray(current.pipe) && current.pipe.length > 0) {
46
- current = current.pipe[0];
47
- continue;
48
- }
49
- return kind;
50
- }
51
- return "unknown";
52
- }
53
- /** Whether the CAC option for this schema should be a boolean flag. */
54
- function isBooleanFlag(schema) {
55
- return getSchemaKind(schema) === "boolean";
56
- }
57
- /** Validate and coerce the raw cac-parsed bag against a {@link CliFlagsSchema}. */
58
- function parseCliFlags(schema, raw) {
59
- const flags = {};
60
- const issues = [];
61
- for (const [key, fieldSchema] of Object.entries(schema)) {
62
- const result = safeParse(fieldSchema, raw[key]);
63
- if (result.success) flags[key] = result.output;
64
- else issues.push(`--${toKebab(key)}: ${result.issues.map((i) => i.message).join(", ")}`);
65
- }
66
- for (const [key, value] of Object.entries(raw)) if (!(key in schema) && !(key in flags)) flags[key] = value;
67
- return issues.length ? {
68
- flags,
69
- issues
70
- } : { flags };
71
- }
72
- function toKebab(camel) {
73
- return camel.replaceAll(/([a-z])([A-Z])/g, "$1-$2").toLowerCase();
74
- }
75
- /** Kebab-case a schema key for CAC option registration. */
76
- function flagKeyToOption(camel) {
77
- return toKebab(camel);
78
- }
79
- //#endregion
1
+ import { n as defineCliFlags, r as parseCliFlags, t as createCac } from "../cac-DCBSjlzl.mjs";
80
2
  //#region src/adapters/cli.ts
81
- function createCli(d, options = {}) {
82
- const defaultPort = options.defaultPort ?? d.cli?.port ?? 9999;
83
- const defaultHost = d.cli?.host ?? "localhost";
84
- const cli = cac(d.cli?.command ?? d.id);
85
- const devCommand = cli.command("[...args]", "Start a local dev server").option("--port <port>", "Port to listen on").option("--host <host>", "Host to bind to", { default: defaultHost }).option("--open", "Open the browser on start").option("--no-open", "Do not open the browser").option("--mcp", "Expose an MCP server over HTTP at /__mcp (use --no-mcp to disable) [experimental]");
86
- if (d.cli?.flags) for (const [key, schema] of Object.entries(d.cli.flags)) {
87
- const optionName = flagKeyToOption(key);
88
- const description = schema.description ?? "";
89
- if (isBooleanFlag(schema)) devCommand.option(`--${optionName}`, description);
90
- else devCommand.option(`--${optionName} <value>`, description);
91
- }
92
- devCommand.action(async (_args, rawFlags) => {
93
- const flags = resolveTypedFlags(d, rawFlags);
94
- const host = flags.host ?? defaultHost;
95
- const port = flags.port ?? await resolveDevServerPort(d, {
96
- host,
97
- defaultPort
98
- });
99
- const mcp = flags.mcp;
100
- await createDevServer(d, {
101
- host,
102
- port,
103
- flags,
104
- mcp,
105
- onReady: options.onReady
106
- });
107
- });
108
- cli.command("build", "Build a self-contained static deploy of the devframe").option("--out-dir <outDir>", "Output directory", { default: "dist-static" }).option("--base <base>", "URL base", { default: "/" }).option("--pretty", "Pretty-print dump JSON (larger on disk)").action(async (flags) => {
109
- await createBuild(d, {
110
- outDir: flags.outDir,
111
- base: flags.base,
112
- pretty: flags.pretty
113
- });
114
- });
115
- cli.command("mcp", "Start an MCP server exposing agent-facing tools (stdio) [experimental]").action(async () => {
116
- const { createMcpServer } = await import("./mcp.mjs");
117
- await createMcpServer(d, {
118
- transport: "stdio",
119
- onReady: ({ transport }) => {
120
- console.error(`[devframe] "${d.id}" MCP server ready (${transport})`);
121
- }
122
- });
123
- });
124
- d.cli?.configure?.(cli);
125
- options.configureCli?.(cli);
126
- cli.help();
127
- cli.version("0.0.0");
128
- return {
129
- cli,
130
- async parse(argv = process.argv) {
131
- cli.parse(argv, { run: false });
132
- await cli.runMatchedCommand();
133
- }
134
- };
135
- }
136
- function resolveTypedFlags(d, raw) {
137
- if (!d.cli?.flags) return raw;
138
- const { flags, issues } = parseCliFlags(d.cli.flags, raw);
139
- if (issues?.length) {
140
- for (const issue of issues) console.error(colors.red`[devframe] invalid flag — ${issue}`);
141
- process.exit(1);
142
- }
143
- return flags;
144
- }
3
+ /** @deprecated Use `createCac` from `devframe/adapters/cac` instead. */
4
+ const createCli = createCac;
145
5
  //#endregion
146
6
  export { createCli, defineCliFlags, parseCliFlags };
@@ -1,5 +1,5 @@
1
- import { l as DevframeWsOptions, r as DevframeDefinition, u as McpRouteOptions } from "../devframe-BtVHhmwM.mjs";
2
- import { n as StartedServer } from "../server-Cfr1NrGQ.mjs";
1
+ import { d as McpRouteOptions, r as DevframeDefinition, u as DevframeWsOptions } from "../devframe-Dma0XG3U.mjs";
2
+ import { n as StartedServer } from "../server-BD-tKDVf.mjs";
3
3
  import { H3 } from "h3";
4
4
 
5
5
  //#region src/adapters/dev.d.ts
@@ -98,7 +98,7 @@ declare function resolveDevServerPort(def: DevframeDefinition, options?: Resolve
98
98
  *
99
99
  * Use this directly when integrating devframe into an existing CLI
100
100
  * framework (commander, yargs, hand-rolled CAC). For the all-in-one
101
- * `dev` / `build` / `mcp` shell, reach for {@link createCli} instead.
101
+ * `dev` / `build` / `mcp` shell, reach for {@link createCac} instead.
102
102
  */
103
103
  declare function createDevServer(def: DevframeDefinition, options?: CreateDevServerOptions): Promise<StartedServer>;
104
104
  //#endregion
@@ -1,2 +1,2 @@
1
- import { n as resolveDevServerPort, t as createDevServer } from "../dev-DE51PeJc.mjs";
1
+ import { n as resolveDevServerPort, t as createDevServer } from "../dev-YeAm6GL0.mjs";
2
2
  export { createDevServer, resolveDevServerPort };
@@ -1,4 +1,4 @@
1
- import { h as DevframeNodeContext, r as DevframeDefinition } from "../devframe-BtVHhmwM.mjs";
1
+ import { g as DevframeNodeContext, r as DevframeDefinition } from "../devframe-Dma0XG3U.mjs";
2
2
 
3
3
  //#region src/adapters/embedded.d.ts
4
4
  interface CreateEmbeddedOptions {
@@ -1,4 +1,4 @@
1
- import { r as DevframeDefinition } from "../devframe-BtVHhmwM.mjs";
1
+ import { r as DevframeDefinition } from "../devframe-Dma0XG3U.mjs";
2
2
  //#region src/adapters/mcp/build-server.d.ts
3
3
  interface CreateMcpServerOptions {
4
4
  /**
@@ -0,0 +1,152 @@
1
+ import { n as colors } from "./diagnostics-reporter-CsIG85Q5.mjs";
2
+ import { createBuild } from "./adapters/build.mjs";
3
+ import { n as resolveDevServerPort, t as createDevServer } from "./dev-YeAm6GL0.mjs";
4
+ import process from "node:process";
5
+ import cac from "cac";
6
+ import { safeParse } from "valibot";
7
+ //#region src/adapters/flags.ts
8
+ /**
9
+ * Identity helper that preserves the literal schema-map type — use this
10
+ * so `InferCliFlags<typeof myFlags>` resolves to the right object shape.
11
+ *
12
+ * ```ts
13
+ * const appFlags = defineCliFlags({
14
+ * depth: v.pipe(v.number(), v.integer()),
15
+ * config: v.optional(v.string()),
16
+ * })
17
+ *
18
+ * defineDevframe({
19
+ * cli: { flags: appFlags },
20
+ * setup(ctx, info) {
21
+ * const flags = info.flags as InferCliFlags<typeof appFlags>
22
+ * flags.depth // number
23
+ * flags.config // string | undefined
24
+ * },
25
+ * })
26
+ * ```
27
+ */
28
+ function defineCliFlags(flags) {
29
+ return flags;
30
+ }
31
+ /**
32
+ * Best-effort probe of a valibot schema to decide whether the
33
+ * corresponding CAC option takes a value. Unwraps `optional` / `nullable`
34
+ * / `nullish` / `default` / `pipe` wrappers then matches on the inner
35
+ * type's kind.
36
+ */
37
+ function getSchemaKind(schema) {
38
+ let current = schema;
39
+ while (current) {
40
+ const kind = current.type;
41
+ if (kind === "optional" || kind === "nullable" || kind === "nullish" || kind === "undefined") {
42
+ current = current.wrapped ?? current.inner;
43
+ continue;
44
+ }
45
+ if (kind === "pipe" && Array.isArray(current.pipe) && current.pipe.length > 0) {
46
+ current = current.pipe[0];
47
+ continue;
48
+ }
49
+ return kind;
50
+ }
51
+ return "unknown";
52
+ }
53
+ /** Whether the CAC option for this schema should be a boolean flag. */
54
+ function isBooleanFlag(schema) {
55
+ return getSchemaKind(schema) === "boolean";
56
+ }
57
+ /** Validate and coerce the raw cac-parsed bag against a {@link CliFlagsSchema}. */
58
+ function parseCliFlags(schema, raw) {
59
+ const flags = {};
60
+ const issues = [];
61
+ for (const [key, fieldSchema] of Object.entries(schema)) {
62
+ const result = safeParse(fieldSchema, raw[key]);
63
+ if (result.success) flags[key] = result.output;
64
+ else issues.push(`--${toKebab(key)}: ${result.issues.map((i) => i.message).join(", ")}`);
65
+ }
66
+ for (const [key, value] of Object.entries(raw)) if (!(key in schema) && !(key in flags)) flags[key] = value;
67
+ return issues.length ? {
68
+ flags,
69
+ issues
70
+ } : { flags };
71
+ }
72
+ function toKebab(camel) {
73
+ return camel.replaceAll(/([a-z])([A-Z])/g, "$1-$2").toLowerCase();
74
+ }
75
+ /** Kebab-case a schema key for CAC option registration. */
76
+ function flagKeyToOption(camel) {
77
+ return toKebab(camel);
78
+ }
79
+ //#endregion
80
+ //#region src/adapters/cac.ts
81
+ /**
82
+ * Wrap a {@link DevframeDefinition} in a `cac`-powered command-line
83
+ * interface exposing `dev` / `build` / `mcp` subcommands.
84
+ *
85
+ * Requires the optional `cac` peer dependency.
86
+ */
87
+ function createCac(d, options = {}) {
88
+ const defaultPort = options.defaultPort ?? d.cli?.port ?? 9999;
89
+ const defaultHost = d.cli?.host ?? "localhost";
90
+ const cli = cac(d.cli?.command ?? d.id);
91
+ const devCommand = cli.command("[...args]", "Start a local dev server").option("--port <port>", "Port to listen on").option("--host <host>", "Host to bind to", { default: defaultHost }).option("--open", "Open the browser on start").option("--no-open", "Do not open the browser").option("--mcp", "Expose an MCP server over HTTP at /__mcp (use --no-mcp to disable) [experimental]");
92
+ if (d.cli?.flags) for (const [key, schema] of Object.entries(d.cli.flags)) {
93
+ const optionName = flagKeyToOption(key);
94
+ const description = schema.description ?? "";
95
+ if (isBooleanFlag(schema)) devCommand.option(`--${optionName}`, description);
96
+ else devCommand.option(`--${optionName} <value>`, description);
97
+ }
98
+ devCommand.action(async (_args, rawFlags) => {
99
+ const flags = resolveTypedFlags(d, rawFlags);
100
+ const host = flags.host ?? defaultHost;
101
+ const port = flags.port ?? await resolveDevServerPort(d, {
102
+ host,
103
+ defaultPort
104
+ });
105
+ const mcp = flags.mcp;
106
+ await createDevServer(d, {
107
+ host,
108
+ port,
109
+ flags,
110
+ mcp,
111
+ onReady: options.onReady
112
+ });
113
+ });
114
+ cli.command("build", "Build a self-contained static deploy of the devframe").option("--out-dir <outDir>", "Output directory", { default: "dist-static" }).option("--base <base>", "URL base", { default: "/" }).option("--pretty", "Pretty-print dump JSON (larger on disk)").action(async (flags) => {
115
+ await createBuild(d, {
116
+ outDir: flags.outDir,
117
+ base: flags.base,
118
+ pretty: flags.pretty
119
+ });
120
+ });
121
+ cli.command("mcp", "Start an MCP server exposing agent-facing tools (stdio) [experimental]").action(async () => {
122
+ const { createMcpServer } = await import("./adapters/mcp.mjs");
123
+ await createMcpServer(d, {
124
+ transport: "stdio",
125
+ onReady: ({ transport }) => {
126
+ console.error(`[devframe] "${d.id}" MCP server ready (${transport})`);
127
+ }
128
+ });
129
+ });
130
+ d.cli?.configure?.(cli);
131
+ options.configureCli?.(cli);
132
+ cli.help();
133
+ cli.version("0.0.0");
134
+ return {
135
+ cli,
136
+ async parse(argv = process.argv) {
137
+ cli.parse(argv, { run: false });
138
+ await cli.runMatchedCommand();
139
+ }
140
+ };
141
+ }
142
+ function resolveTypedFlags(d, raw) {
143
+ if (!d.cli?.flags) return raw;
144
+ const { flags, issues } = parseCliFlags(d.cli.flags, raw);
145
+ if (issues?.length) {
146
+ for (const issue of issues) console.error(colors.red`[devframe] invalid flag — ${issue}`);
147
+ process.exit(1);
148
+ }
149
+ return flags;
150
+ }
151
+ //#endregion
152
+ export { defineCliFlags as n, parseCliFlags as r, createCac as t };
@@ -1,9 +1,58 @@
1
- import { O as StreamReader, R as SharedState, Y as DevframeSettings, at as DevframeRpcServerFunctions, b as RpcSharedStateHost, et as ScopedServerFunctions, f as ConnectionMeta, it as DevframeRpcClientFunctions, k as StreamSink, nt as SettingsForNamespace, tt as ScopedSharedStates, xt as EventEmitter, y as RpcSharedStateGetOptions } from "../devframe-BtVHhmwM.mjs";
2
- import { _ as RpcFunctionDefinition, w as RpcFunctionsCollector } from "../types-DZEx4ffs.mjs";
3
- import { C as RpcCacheManager, w as RpcCacheOptions } from "../index-Dy6GFDRf.mjs";
4
- import { t as WsRpcChannelOptions } from "../ws-client-D0z0pOhn.mjs";
1
+ import { A as StreamSink, St as EventEmitter, X as DevframeSettings, at as DevframeRpcClientFunctions, b as RpcSharedStateGetOptions, k as StreamReader, nt as ScopedSharedStates, ot as DevframeRpcServerFunctions, p as ConnectionMeta, rt as SettingsForNamespace, tt as ScopedServerFunctions, x as RpcSharedStateHost, z as SharedState } from "../devframe-Dma0XG3U.mjs";
2
+ import { _ as RpcFunctionDefinition, w as RpcFunctionsCollector } from "../types-oEqKqUC9.mjs";
3
+ import { C as RpcCacheManager, w as RpcCacheOptions } from "../index-DI_TMGjv.mjs";
4
+ import { t as WsRpcChannelOptions } from "../ws-client-nBjpin71.mjs";
5
5
  import { BirpcOptions, BirpcReturn } from "birpc";
6
6
 
7
+ //#region src/client/connection.d.ts
8
+ /**
9
+ * The connection lifecycle of a devframe client, as a single value a UI can
10
+ * render from. Derived from the transport (WebSocket open/close/error) and the
11
+ * trust handshake, so a viewer never has to reason about the two dimensions
12
+ * separately.
13
+ *
14
+ * - `connecting` — establishing the WebSocket / running the initial trust
15
+ * handshake. Calls issued here queue until the socket opens.
16
+ * - `connected` — socket open and trusted; RPC calls will be served.
17
+ * - `unauthorized` — socket open but the server rejected trust (no valid token,
18
+ * or an auth-enforcing host refused it). Calls fail fast with an auth error;
19
+ * the UI should prompt for re-authentication or a reload.
20
+ * - `disconnected` — the socket closed (dropped mid-session, or never opened).
21
+ * Pending and new calls fail fast until the page reconnects.
22
+ * - `error` — a fatal connection error (e.g. the WebSocket errored, or the
23
+ * connection meta could not be loaded).
24
+ *
25
+ * A `static` backend has no live socket, so it reports `connected` for its
26
+ * whole life.
27
+ */
28
+ type DevframeConnectionStatus = 'connecting' | 'connected' | 'unauthorized' | 'disconnected' | 'error';
29
+ /**
30
+ * What kind of failure a {@link DevframeConnectionError} describes:
31
+ * - `connection` — the transport dropped, errored, or never opened.
32
+ * - `auth` — the server rejected trust for this client.
33
+ * - `timeout` — a call exceeded its {@link DevframeRpcClientOptions.callTimeout}.
34
+ */
35
+ type DevframeConnectionErrorKind = 'connection' | 'auth' | 'timeout';
36
+ /**
37
+ * The error rejected from `rpc.call(...)` (and carried on
38
+ * `rpc.connectionError`) when a call cannot be served because the connection is
39
+ * down, the client is unauthorized, or a call timed out. Its `kind` lets a UI
40
+ * tailor its message and recovery affordance without string-matching.
41
+ */
42
+ declare class DevframeConnectionError extends Error {
43
+ name: string;
44
+ readonly kind: DevframeConnectionErrorKind;
45
+ constructor(kind: DevframeConnectionErrorKind, message: string, options?: {
46
+ cause?: unknown;
47
+ });
48
+ }
49
+ /**
50
+ * Whether a status means calls can be attempted. `connecting` counts because
51
+ * the transport queues outgoing calls until the socket opens; the terminal
52
+ * failure states short-circuit calls so a stuck socket never hangs the UI.
53
+ */
54
+ declare function isCallableStatus(status: DevframeConnectionStatus): boolean;
55
+ //#endregion
7
56
  //#region src/client/rpc-streaming.d.ts
8
57
  interface StreamingSubscribeOptions {
9
58
  /** Maximum buffered chunks before the oldest is dropped. Default 256. */
@@ -119,6 +168,21 @@ interface DevframeRpcContext {
119
168
  type DevframeClientRpcHost = RpcFunctionsCollector<DevframeRpcClientFunctions, DevframeRpcContext>;
120
169
  interface RpcClientEvents {
121
170
  'rpc:is-trusted:updated': (isTrusted: boolean) => void;
171
+ /**
172
+ * The connection status changed. Carries the new status and the previous one
173
+ * so a UI can react to specific transitions (e.g. `connected` → `disconnected`).
174
+ */
175
+ 'connection:status': (status: DevframeConnectionStatus, previous: DevframeConnectionStatus) => void;
176
+ /**
177
+ * A connection-level error occurred (the WebSocket errored, or trust was
178
+ * refused). The status typically moves to `error`/`unauthorized` alongside it.
179
+ */
180
+ 'connection:error': (error: Error) => void;
181
+ /**
182
+ * An RPC call rejected — either from the server, or because the connection
183
+ * was down / timed out. Useful for a global error feed or toast surface.
184
+ */
185
+ 'rpc:error': (error: Error, method: string) => void;
122
186
  }
123
187
  interface DevframeRpcClientOptions {
124
188
  connectionMeta?: ConnectionMeta;
@@ -138,6 +202,14 @@ interface DevframeRpcClientOptions {
138
202
  wsOptions?: Partial<WsRpcChannelOptions>;
139
203
  rpcOptions?: Partial<BirpcOptions<DevframeRpcServerFunctions, DevframeRpcClientFunctions, boolean>>;
140
204
  cacheOptions?: boolean | Partial<RpcCacheOptions>;
205
+ /**
206
+ * Reject a pending `rpc.call(...)` if the server hasn't answered within this
207
+ * many milliseconds, with a {@link DevframeConnectionError} of kind
208
+ * `'timeout'`. Guards against a live-but-unresponsive server hanging the UI.
209
+ * Omit (or `0`) to wait indefinitely. Calls always fail fast — regardless of
210
+ * this option — once the socket closes or trust is refused.
211
+ */
212
+ callTimeout?: number;
141
213
  }
142
214
  type DevframeRpcClientCall = BirpcReturn<DevframeRpcServerFunctions, DevframeRpcClientFunctions>['$call'];
143
215
  type DevframeRpcClientCallEvent = BirpcReturn<DevframeRpcServerFunctions, DevframeRpcClientFunctions>['$callEvent'];
@@ -151,6 +223,17 @@ interface DevframeRpcClient {
151
223
  * Whether the client is trusted
152
224
  */
153
225
  readonly isTrusted: boolean | null;
226
+ /**
227
+ * The current connection status. Drives connection/auth/error UI without the
228
+ * consumer having to track the transport and trust handshake separately.
229
+ * Subscribe to `events.on('connection:status', …)` to react to changes.
230
+ */
231
+ readonly status: DevframeConnectionStatus;
232
+ /**
233
+ * The most recent connection-level error (WebSocket error, refused trust, or
234
+ * failed connection-meta load), or `null` when the connection is healthy.
235
+ */
236
+ readonly connectionError: Error | null;
154
237
  /**
155
238
  * The connection meta
156
239
  */
@@ -225,6 +308,8 @@ interface DevframeRpcClient {
225
308
  }
226
309
  interface DevframeRpcClientMode {
227
310
  readonly isTrusted: boolean;
311
+ readonly status: DevframeConnectionStatus;
312
+ readonly connectionError: Error | null;
228
313
  ensureTrusted: DevframeRpcClient['ensureTrusted'];
229
314
  requestTrust: DevframeRpcClient['requestTrust'];
230
315
  requestTrustWithToken: DevframeRpcClient['requestTrustWithToken'];
@@ -276,4 +361,4 @@ declare function createClientSettings<T extends Record<string, any> = Record<str
276
361
  //#region src/client/index.d.ts
277
362
  declare const connectDevframe: typeof getDevframeRpcClient;
278
363
  //#endregion
279
- export { DevframeClientRpcHost, DevframeRpcClient, DevframeRpcClientCall, DevframeRpcClientCallEvent, DevframeRpcClientCallOptional, DevframeRpcClientMode, DevframeRpcClientOptions, DevframeRpcContext, DevframeScopedClientContext, DevframeScopedClientRpc, DevframeScopedClientStreamingHost, RpcClientEvents, RpcStreamingClientHost, StreamingSubscribeOptions, authenticateWithUrlOtp, connectDevframe, consumeOtpFromUrl, createClientSettings, createRpcStreamingClientHost, createScopedClientContext, getDevframeRpcClient, readOtpFromUrl };
364
+ export { DevframeClientRpcHost, DevframeConnectionError, DevframeConnectionErrorKind, DevframeConnectionStatus, DevframeRpcClient, DevframeRpcClientCall, DevframeRpcClientCallEvent, DevframeRpcClientCallOptional, DevframeRpcClientMode, DevframeRpcClientOptions, DevframeRpcContext, DevframeScopedClientContext, DevframeScopedClientRpc, DevframeScopedClientStreamingHost, RpcClientEvents, RpcStreamingClientHost, StreamingSubscribeOptions, authenticateWithUrlOtp, connectDevframe, consumeOtpFromUrl, createClientSettings, createRpcStreamingClientHost, createScopedClientContext, getDevframeRpcClient, isCallableStatus, readOtpFromUrl };