@kubb/studio 5.9.0 → 5.9.1

package/dist/{protocol-BfjNY8-8.d.ts → protocol-gXoAXvT3.d.ts}

@@ -1,5 +1,5 @@
 import { t as __name } from "./rolldown-runtime-CRm0XQPb.js";
-import { ExtensionManifest, ExtensionManifest as ExtensionManifest$1, ExtensionManifestOption, RegistryArtifact, RegistryDetail, RegistryEntry } from "@kubb/core";
+import { ExtensionKind, ExtensionManifest } from "@kubb/core";
 //#region src/protocol.d.ts
 /**
  * JSON-serializable Kubb config exchanged over RPC. A live `kubb/kit` config holds
@@ -29,6 +29,14 @@ type JSONKubbConfig = {
    * (`parse`, `getImports`, ...) can't survive JSON serialization over the WebSocket.
    */
   adapter?: object;
+  /**
+   * Parser option overrides from Studio, matched to the disk config's parsers by `name` and
+   * re-applied through each parser's factory, the same way `adapter` is.
+   */
+  parsers?: Array<{
+    name: string;
+    options?: object;
+  }>;
 };
 /**
  * Which `defineConfig(...)` entry an edit targets, for a config file that exports an array.
@@ -55,21 +63,24 @@ type OptionValue = string | number | boolean | null | Array<OptionValue> | {
 type ConfigEdit =
 /**
  * Write a literal option value. `path` walks nested objects, so `['enum', 'type']` targets
- * `pluginTs({ enum: { type } })`.
+ * `pluginTs({ enum: { type } })`. `kind` names which factory call `plugin` is: one in `plugins`
+ * when left out, the config's `adapter`, or one in `parsers`.
  */
 {
   operation: 'set';
   config?: ConfigRef;
+  kind?: ExtensionKind;
   plugin: string;
   path: Array<string>;
   value: unknown;
 } |
 /**
- * Drop an option so the plugin falls back to its default.
+ * Drop an option so the extension falls back to its default. `kind` as for `set`.
  */
 {
   operation: 'remove';
   config?: ConfigRef;
+  kind?: ExtensionKind;
   plugin: string;
   path: Array<string>;
 } |
@@ -80,7 +91,6 @@ type ConfigEdit =
   operation: 'add-plugin';
   config?: ConfigRef;
   plugin: string;
-  importName?: string;
   options?: Record<string, unknown>;
 } |
 /**
@@ -100,7 +110,8 @@ type ConfigEdit =
   plugin: string;
 };
 /**
- * A plugin factory call the agent found in the `plugins` array of a `defineConfig(...)`.
+ * A factory call the agent found in a `defineConfig(...)`: a plugin in `plugins`, the `adapter`, or
+ * a parser in `parsers`.
  */
 type PluginView = {
   /**
@@ -140,6 +151,14 @@ type ConfigView = {
    * Each plugin call in the entry, with its top-level option keys.
    */
   plugins: Array<PluginView>;
+  /**
+   * The `adapter` call, when the entry sets one through an imported factory.
+   */
+  adapter?: PluginView;
+  /**
+   * The parser calls in `parsers`, when the entry lists any through imported factories.
+   */
+  parsers?: Array<PluginView>;
 };
 /**
  * What the agent found in the user's config file, so Studio knows which controls it may offer.
@@ -346,13 +365,11 @@ type SaveConfigInput = {
   edits: Array<ConfigEdit>;
 };
 /**
- * Per-edit outcomes plus the rewritten file. `changed` is false when every edit was a no-op, so a
- * caller can skip reloading.
+ * Per-edit outcomes. `changed` is false when every edit was a no-op, so a caller can skip reloading.
  */
 type SaveResult = {
   outcomes: Array<ConfigEditOutcome>;
   changed: boolean;
-  file?: ConfigFileView;
 };
 /**
  * What a file read returns for a job: the files that job generated (`output`), or what the output
@@ -518,6 +535,18 @@ type ConnectMessagePayload = {
       name: string;
       options?: object;
     }>;
+    /**
+     * The adapter and the parsers the config registers, named like `plugins` and with the same JSON
+     * copy of their options, so Studio can render their manifest options.
+     */
+    adapter?: {
+      name: string;
+      options?: object;
+    };
+    parsers?: Array<{
+      name: string;
+      options?: object;
+    }>;
     /** Installed packages that ship a `kubb-extension.json`, including plugins the config does not use yet. */
     extensions?: Array<ExtensionEntry>;
   };
@@ -529,6 +558,8 @@ type ExtensionEntry = {
   version: string;
   manifest: ExtensionManifest;
 };
+/** Installed extension packages by package name, the only ones Studio may import besides `@kubb/plugin-*`. */
+type InstalledExtensions = ReadonlyMap<string, ExtensionEntry>;
 /**
  * What an agent may do in the project it serves. Every one is off unless the host granted it, and
  * a sandbox narrows them further.
@@ -633,5 +664,5 @@ type PublishedSnapshot = {
   branchChanges?: BranchSnapshotChanges;
 };
 //#endregion
-export { OptionValue as A, SnapshotChanges as B, GenerationEventPayloads as C, MAX_FILES_PER_REQUEST as D, JSONKubbConfig as E, RegistryArtifact as F, StudioApi as H, RegistryDetail as I, RegistryEntry as L, PublishedSnapshot as M, ReadFilesInput as N, MAX_PAGE_LINES as O, ReadFilesResult as P, SaveConfigInput as R, GenerationEvent as S, GenerationRun as T, generationEventTypes as U, SnapshotUploadMetadata as V, FilePage as _, AgentConnectInfo as a, GenerateInput as b, ConfigEdit as c, ConfigRef as d, ConfigView as f, ExtensionManifestOption as g, ExtensionManifest$1 as h, AgentCloseCode as i, PluginView as j, MAX_SNAPSHOT_BYTES as k, ConfigEditOutcome as l, ExtensionEntry as m, AGENT_SOCKET_PATH as n, AgentPermissions as o, ConnectMessagePayload as p, AgentApi as r, BranchSnapshotChanges as s, AGENT_INSTANCE_HEADER as t, ConfigFileView as u, FileSource as v, GenerationEventType as w, GenerateResult as x, GENERATION_GONE_MESSAGE as y, SaveResult as z };
-//# sourceMappingURL=protocol-BfjNY8-8.d.ts.map
+export { PluginView as A, GenerationRun as C, MAX_PAGE_LINES as D, MAX_FILES_PER_REQUEST as E, SaveResult as F, SnapshotChanges as I, SnapshotUploadMetadata as L, ReadFilesInput as M, ReadFilesResult as N, MAX_SNAPSHOT_BYTES as O, SaveConfigInput as P, StudioApi as R, GenerationEventType as S, JSONKubbConfig as T, GENERATION_GONE_MESSAGE as _, AgentConnectInfo as a, GenerationEvent as b, ConfigEdit as c, ConfigRef as d, ConfigView as f, FileSource as g, FilePage as h, AgentCloseCode as i, PublishedSnapshot as j, OptionValue as k, ConfigEditOutcome as l, ExtensionEntry as m, AGENT_SOCKET_PATH as n, AgentPermissions as o, ConnectMessagePayload as p, AgentApi as r, BranchSnapshotChanges as s, AGENT_INSTANCE_HEADER as t, ConfigFileView as u, GenerateInput as v, InstalledExtensions as w, GenerationEventPayloads as x, GenerateResult as y, generationEventTypes as z };
+//# sourceMappingURL=protocol-gXoAXvT3.d.ts.map

package/dist/protocol.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"protocol.cjs","names":[],"sources":["../src/protocol.ts"],"sourcesContent":["import type { ExtensionManifest, KubbHooks } from '@kubb/core'\n\nexport type { ExtensionManifest, ExtensionManifestOption, RegistryArtifact, RegistryDetail, RegistryEntry } from '@kubb/core'\n\n/**\n * JSON-serializable Kubb config exchanged over RPC. A live `kubb/kit` config holds\n * functions and class instances that cannot survive JSON, so both sides pass this flattened shape\n * and rebuild the real config from it.\n */\nexport type JSONKubbConfig = {\n  /**\n   * Plugins with their serialized options. `name` is the package name (e.g. `@kubb/plugin-ts`)\n   * and `options` is an opaque blob the agent forwards unchanged to the plugin factory. An entry\n   * with `disabled: true` is dropped even when the disk config's `plugins` array still lists it.\n   */\n  plugins?: Array<{\n    name: string\n    options?: object\n    disabled?: boolean\n  }>\n  /**\n   * Raw OpenAPI / Swagger spec content (YAML or JSON string), never a file path or URL.\n   * Required by a 'sandbox' agent, which has no disk config of its own and refuses anything else.\n   * A non-sandbox agent always reads its spec from disk, so this is ignored with a `kubb:warn`.\n   */\n  input?: string\n  /**\n   * Adapter option overrides sent from Studio UI. Merged into the disk config's adapter options\n   * and re-applied through the same adapter factory, since an adapter instance's functions\n   * (`parse`, `getImports`, ...) can't survive JSON serialization over the WebSocket.\n   */\n  adapter?: object\n}\n\n/**\n * Which `defineConfig(...)` entry an edit targets, for a config file that exports an array.\n *\n * A number selects by position, a string matches the entry's `name`. Omitted targets the only\n * entry, or the first one when the file exports an array.\n */\nexport type ConfigRef = string | number\n\n/**\n * A value the agent can read out of a plugin option in `kubb.config.ts` and round-trip through JSON.\n */\nexport type OptionValue = string | number | boolean | null | Array<OptionValue> | { [key: string]: OptionValue }\n\n/**\n * One change to a plugin's options in the user's `kubb.config.ts`.\n *\n * `plugin` is the package name (`@kubb/plugin-ts`), the same identity used in {@link JSONKubbConfig}.\n * The agent applies these to the file with an AST patch, so only the targeted values are rewritten.\n *\n * Declared here rather than in `configFile.ts` because this is the wire contract, and the patcher\n * imports it from here. Type-only, so nothing pulls `magicast` into this entry point.\n */\nexport type ConfigEdit =\n  /**\n   * Write a literal option value. `path` walks nested objects, so `['enum', 'type']` targets\n   * `pluginTs({ enum: { type } })`.\n   */\n  | { operation: 'set'; config?: ConfigRef; plugin: string; path: Array<string>; value: unknown }\n  /**\n   * Drop an option so the plugin falls back to its default.\n   */\n  | { operation: 'remove'; config?: ConfigRef; plugin: string; path: Array<string> }\n  /**\n   * Add a plugin factory call and its import to the `plugins` array.\n   */\n  | { operation: 'add-plugin'; config?: ConfigRef; plugin: string; importName?: string; options?: Record<string, unknown> }\n  /**\n   * Comment the plugin call out, keeping its options in the file so enabling it again restores them.\n   */\n  | { operation: 'disable-plugin'; config?: ConfigRef; plugin: string }\n  /**\n   * Uncomment a plugin call a previous `disable-plugin` commented out.\n   */\n  | { operation: 'enable-plugin'; config?: ConfigRef; plugin: string }\n\n/**\n * A plugin factory call the agent found in the `plugins` array of a `defineConfig(...)`.\n */\nexport type PluginView = {\n  /**\n   * Local identifier of the factory in the file, e.g. `pluginTs`. This is the alias when the plugin\n   * was imported under one.\n   */\n  importName: string\n  /**\n   * Module the factory is imported from, e.g. `@kubb/plugin-ts`.\n   */\n  packageName: string\n  /**\n   * Top-level option keys, each flagged with whether the agent may write it and, when it can, the\n   * value found in the file. An option marked `literal: false` holds a function or a reference the\n   * agent will not overwrite, so Studio shows the control disabled rather than hiding it, and\n   * `value` is absent since there is nothing safe to display as the current value.\n   */\n  options: Record<string, { literal: boolean; value?: OptionValue }>\n  /**\n   * Set when the plugin call is commented out in the file. Its options stay on disk but are not\n   * readable, so `options` is empty until it is enabled again.\n   */\n  disabled?: true\n}\n\n/**\n * One `defineConfig(...)` entry. A config file that exports a single object has exactly one.\n */\nexport type ConfigView = {\n  /**\n   * The entry's `name`, when it sets one. Studio labels the config picker with it.\n   */\n  name?: string\n  /**\n   * Each plugin call in the entry, with its top-level option keys.\n   */\n  plugins: Array<PluginView>\n}\n\n/**\n * What the agent found in the user's config file, so Studio knows which controls it may offer.\n * Absent when the agent could not read the file at all.\n */\nexport type ConfigFileView =\n  | {\n      managed: true\n      /**\n       * One entry per config the file exports, in source order. Every {@link ConfigEdit} names\n       * which of these it targets through its `config` field.\n       */\n      configs: Array<ConfigView>\n    }\n  | {\n      managed: false\n      /**\n       * Why the file is outside what the agent edits, for example a default export that is not a\n       * `defineConfig(...)` call. Studio shows this and offers no property-level controls.\n       */\n      reason: string\n    }\n\n/**\n * Outcome of a single {@link ConfigEdit}, returned in a {@link SaveResult}.\n */\nexport type ConfigEditOutcome = {\n  edit: ConfigEdit\n  applied: boolean\n  /**\n   * Why the edit was refused, absent when it was applied.\n   */\n  reason?: string\n}\n\n/**\n * The public, JSON-safe subset of Kubb lifecycle hooks. The core registry remains extensible;\n * adding a core hook does not publish it to Studio until it is listed here and projected below.\n */\nexport const generationEventTypes = [\n  'kubb:plugin:start',\n  'kubb:plugin:end',\n  'kubb:build:start',\n  'kubb:build:end',\n  'kubb:files:processing:start',\n  'kubb:files:processing:update',\n  'kubb:files:processing:end',\n  'kubb:info',\n  'kubb:success',\n  'kubb:warn',\n  'kubb:error',\n  'kubb:diagnostic',\n  'kubb:generation:start',\n  'kubb:generation:end',\n  'kubb:generation:summary',\n  'kubb:lifecycle:start',\n  'kubb:lifecycle:end',\n  'kubb:format:start',\n  'kubb:format:end',\n  'kubb:lint:start',\n  'kubb:lint:end',\n  'kubb:hooks:start',\n  'kubb:hooks:end',\n  'kubb:hook:start',\n  'kubb:hook:line',\n  'kubb:hook:end',\n] as const satisfies ReadonlyArray<keyof KubbHooks>\n\n/**\n * One of the lifecycle hooks {@link generationEventTypes} publishes.\n */\nexport type GenerationEventType = (typeof generationEventTypes)[number]\n\n/**\n * The JSON-safe payload each published event carries. These are flattened on purpose: a core hook\n * context holds live objects (a `Config`, a `Storage`) that cannot cross the wire.\n */\nexport type GenerationEventPayloads = {\n  'kubb:plugin:start': [ctx: { plugin: { name: string } }]\n  'kubb:plugin:end': [ctx: { plugin: { name: string }; duration: number; success: boolean }]\n  'kubb:build:start': [ctx: { config: { name?: string }; adapter: { name: string } }]\n  'kubb:build:end': [ctx: { files: Array<{ path: string; name: string }>; outputDir: string }]\n  'kubb:files:processing:start': [ctx: { total: number }]\n  'kubb:files:processing:update': [\n    ctx: {\n      files: Array<{\n        file: string\n        processed: number\n        total: number\n        percentage: number\n      }>\n    },\n  ]\n  'kubb:files:processing:end': [ctx: { total: number }]\n  'kubb:info': [ctx: { message: string; info?: string }]\n  'kubb:success': [ctx: { message: string; info?: string }]\n  'kubb:warn': [ctx: { message: string; info?: string }]\n  'kubb:error': [ctx: { message: string; stack?: string }]\n  'kubb:diagnostic': [\n    ctx: {\n      code: string\n      message: string\n      severity: string\n      location?: { kind: string; pointer?: string; ref?: string }\n      help?: string\n      plugin?: string\n      stack?: string\n    },\n  ]\n  'kubb:generation:start': [ctx: { name?: string; plugins: number }]\n  /**\n   * A run finished. See `kubb:build:end` for files, `kubb:generation:summary` for the count, and\n   * `readFiles` for contents.\n   */\n  'kubb:generation:end': []\n  'kubb:generation:summary': [ctx: { duration: number; fileCount: number; failedPlugins: number; status: 'success' | 'failed' }]\n  'kubb:lifecycle:start': []\n  'kubb:lifecycle:end': []\n  'kubb:format:start': []\n  'kubb:format:end': []\n  'kubb:lint:start': []\n  'kubb:lint:end': []\n  'kubb:hooks:start': []\n  'kubb:hooks:end': []\n  'kubb:hook:start': [ctx: { id?: string; command: string; args?: Array<string> }]\n  'kubb:hook:line': [ctx: { id: string; line: string }]\n  'kubb:hook:end': [\n    ctx: {\n      id?: string\n      command: string\n      args?: Array<string>\n      success: boolean\n      error?: { message: string; stack?: string }\n    },\n  ]\n}\n\n/**\n * Versioned envelope around one lifecycle event. Cap'n Web streams preserve the order the agent\n * emitted them in, so the receiver replays a run by reading the stream straight through.\n */\nexport type GenerationEvent = {\n  [Type in GenerationEventType]: { type: Type; data: GenerationEventPayloads[Type] }\n}[GenerationEventType] & {\n  version: 1\n  jobId: string\n  timestamp: number\n}\n\n/**\n * Asks the agent to run one generation. `jobId` tags every event the run emits so a caller\n * watching several runs can tell them apart.\n */\nexport type GenerateInput = { jobId: string; config: JSONKubbConfig }\n\n/**\n * What a finished run produced.\n */\nexport type GenerateResult = {\n  status: 'success' | 'failed'\n  /**\n   * Paths of the generated files, relative to the output directory.\n   */\n  files: Array<string>\n  fileCount: number\n  /**\n   * Content fingerprint per file in `files`, to tell changed files apart without reading them.\n   */\n  hashes: Record<string, string>\n  /**\n   * Fingerprints of the output directory on disk before the run, for an agent with a project on disk.\n   */\n  disk?: { hashes: Record<string, string> }\n}\n\n/**\n * Asks the agent to apply a batch of edits to the config file on disk.\n */\nexport type SaveConfigInput = { edits: Array<ConfigEdit> }\n\n/**\n * Per-edit outcomes plus the rewritten file. `changed` is false when every edit was a no-op, so a\n * caller can skip reloading.\n */\nexport type SaveResult = { outcomes: Array<ConfigEditOutcome>; changed: boolean; file?: ConfigFileView }\n\n/**\n * What a file read returns for a job: the files that job generated (`output`), or what the output\n * directory held on disk before that job ran (`disk`, only on an agent with a project on disk).\n */\nexport type FileSource = 'output' | 'disk'\n\n/**\n * Asks the agent to read files of one generation job back.\n */\nexport type ReadFilesInput = {\n  /**\n   * The job whose files to read, the only lookup key, so the caller decides whose jobs a reader may\n   * see. A job the agent no longer keeps fails with {@link GENERATION_GONE_MESSAGE}.\n   */\n  jobId: string\n  /**\n   * At most {@link MAX_FILES_PER_REQUEST} paths, each checked against what the job's set holds.\n   */\n  paths: Array<string>\n  /**\n   * Which of the job's sets to read, `output` when left out.\n   */\n  source?: FileSource\n  /**\n   * The line to start from (0-based), the `nextCursor` of the previous page. Defaults to 0.\n   */\n  cursor?: number\n  /**\n   * Lines to read per file, at most {@link MAX_PAGE_LINES}. Left out, the whole file.\n   */\n  limit?: number\n}\n\n/**\n * Where a paged read stands for one file: the cursor of the next page, `null` after the last one.\n */\nexport type FilePage = { nextCursor: number | null; totalLines: number }\n\n/**\n * What a file read returns. `pages` is set only for a paged read.\n */\nexport type ReadFilesResult = { files: Record<string, string>; pages?: Record<string, FilePage> }\n\n/**\n * The error a file read fails with once the agent no longer keeps the job's files.\n */\nexport const GENERATION_GONE_MESSAGE = 'The files of this generation are no longer kept on the agent, run the generation again'\n\n/**\n * A generation in flight. Cap'n Web keeps the three calls pointed at the same run, so a caller can\n * read `events()` while `result()` is still pending and `cancel()` stops it early.\n */\nexport type GenerationRun = {\n  events: () => Promise<ReadableStream<GenerationEvent>>\n  result: () => Promise<GenerateResult>\n  cancel: () => Promise<void>\n}\n\n/**\n * What Studio knows about the agent on the other end of a socket. Studio passes it with every\n * {@link AgentApi.connect} call, so it stays the authority on whether the agent is a sandbox.\n */\nexport type AgentConnectInfo = {\n  /**\n   * A shared `sandbox` or `global` agent. It keeps generations in memory, runs each job in a\n   * temporary root, generates from the spec Studio sends, and never writes to disk or edits config.\n   */\n  sandbox: boolean\n  agentSlug: string\n  /**\n   * Absent for a sandbox or global agent, which belongs to no organization.\n   */\n  organizationSlug?: string\n  studioVersion: string\n}\n\n/**\n * Operations Studio invokes on an agent over its socket.\n */\nexport type AgentApi = {\n  /**\n   * The first call on every socket, and again whenever Studio needs the current config.\n   */\n  connect: (info: AgentConnectInfo) => Promise<ConnectMessagePayload>\n  startGeneration: (input: GenerateInput) => GenerationRun\n  saveConfig: (input: SaveConfigInput) => Promise<SaveResult>\n  readFiles: (input: ReadFilesInput) => Promise<ReadFilesResult>\n}\n\n/**\n * Operations an agent invokes on Studio over its socket.\n */\nexport type StudioApi = {\n  /**\n   * Keeps the connection alive. A ping that does not settle in time makes the agent reconnect.\n   */\n  ping: () => Promise<void>\n}\n\n/**\n * Close codes Studio sends when it ends an agent socket on purpose. `UNAUTHORIZED` means the token\n * was refused, so pair again. `SUPERSEDED` and `INCOMPATIBLE` mean stop. Any other code, `1011`\n * included, is an ordinary drop and the agent reconnects.\n */\nexport const AgentCloseCode = {\n  UNAUTHORIZED: 4001,\n  SUPERSEDED: 4002,\n  INCOMPATIBLE: 4003,\n} as const\n\nexport const AGENT_SOCKET_PATH = '/api/agent/socket'\n\n/**\n * Optional header naming the process a socket belongs to, for agents that run several processes.\n */\nexport const AGENT_INSTANCE_HEADER = 'x-kubb-instance-id'\n\n/**\n * How many files a single `readFiles` request may ask for at once.\n */\nexport const MAX_FILES_PER_REQUEST = 50\n\n/** Most lines one page may ask for. */\nexport const MAX_PAGE_LINES = 2000\n\nexport const MAX_SNAPSHOT_BYTES = 50 * 1024 * 1024\n\n/**\n * Connection payload returned by {@link AgentApi.connect}. Carries only what Studio renders, with\n * everything about the config under one key.\n */\nexport type ConnectMessagePayload = {\n  /**\n   * Always sent, so a mismatch is visible on both sides: Studio badges the connection with these\n   * and the host prints them.\n   */\n  versions: {\n    /**\n     * The version of the `@kubb/studio` runtime the agent runs.\n     */\n    kubb: string\n    /**\n     * The version of the host itself (the `kubb.agent` package or the `kubb` CLI).\n     */\n    agent: string\n  }\n  /**\n   * The agent's project root. This is the workspace that generation runs against.\n   */\n  root: string\n  /**\n   * The baseline every generation starts from.\n   */\n  config: {\n    /**\n     * The config path as the host gave it, relative to `root` unless absolute.\n     */\n    path: string\n    /**\n     * What the agent read out of the config file itself, so Studio can render the plugin editor\n     * against the real file. Absent when the agent could not read it, or was not granted\n     * `allowConfigEdit`.\n     */\n    file?: ConfigFileView\n    /**\n     * Plugins the config registers, with a JSON copy of their options: anything JSON cannot hold,\n     * such as a function, is left out. A plugin defined in the project rather than installed as a\n     * `@kubb/plugin-*` package keeps its own `name`.\n     */\n    plugins?: Array<{\n      name: string\n      options?: object\n    }>\n    /** Installed packages that ship a `kubb-extension.json`, including plugins the config does not use yet. */\n    extensions?: Array<ExtensionEntry>\n  }\n  permissions: AgentPermissions\n}\n\n/** An installed extension package and the manifest it ships. */\nexport type ExtensionEntry = { package: string; version: string; manifest: ExtensionManifest }\n\n/**\n * What an agent may do in the project it serves. Every one is off unless the host granted it, and\n * a sandbox narrows them further.\n */\nexport type AgentPermissions = {\n  /**\n   * Whether the agent writes generated files to disk. Always false for a sandbox.\n   */\n  allowWrite: boolean\n  /**\n   * Whether the agent runs the formatter, the linter, and `output.postGenerate` as child\n   * processes after a generation.\n   */\n  allowExec: boolean\n  /**\n   * Whether the agent may change plugin options in the user's `kubb.config.ts`. Separate from\n   * `allowWrite`, which covers generated output: this one edits a hand-authored source file.\n   */\n  allowConfigEdit: boolean\n  /**\n   * Whether the agent hands back file source in response to `readFiles`. Always true for a\n   * sandbox.\n   */\n  allowRead: boolean\n}\n\n/**\n * Metadata part of `POST /api/snapshots`. The `tarball` part carries the packed package.\n */\nexport type SnapshotUploadMetadata = {\n  /**\n   * Stable CI identity, such as `gh:<repoId>:<pr>`. Snapshots with the same `id` share one CI agent.\n   */\n  id: string\n  name: string\n  packageName: string\n  version: string\n  /**\n   * The commit the snapshot is built from, so the next one can name it as its base.\n   */\n  commit?: string\n  /**\n   * The `id` of another CI agent, such as the base branch's, to also compare with.\n   */\n  baseId?: string\n  /**\n   * Content fingerprint per generated file, keyed by path relative to the project root.\n   */\n  hashes: Record<string, string>\n  peerDependencies: Record<string, string>\n}\n\n/**\n * How a snapshot's files differ from an earlier snapshot of the same package.\n */\nexport type SnapshotChanges = {\n  /**\n   * The snapshot these changes are measured against, `null` when there is none to compare with.\n   */\n  base: { id: string; version: string | null; commit?: string; createdAt: string } | null\n  added: Array<string>\n  changed: Array<string>\n  removed: Array<string>\n}\n\n/**\n * {@link SnapshotChanges} against another CI agent. `baseFound` is `false` when Studio has no CI\n * agent with that id yet, and `true` when it has one without a snapshot of this package.\n */\nexport type BranchSnapshotChanges = SnapshotChanges & { baseFound: boolean }\n\n/**\n * Response body of `POST /api/snapshots`: `{ snapshot: PublishedSnapshot }`.\n */\nexport type PublishedSnapshot = {\n  id: string\n  name: string | null\n  version: string | null\n  integrity: string | null\n  agent: { id: string; name: string; slug: string | null }\n  /**\n   * Readable download path, often `/packages/{agentSlug}/{name}.tgz`.\n   */\n  url: string\n  snapshotIdUrl: string\n  createdAt: string\n  expiresAt: string\n  /**\n   * What changed since the previous snapshot of this package on the same CI agent.\n   */\n  changes?: SnapshotChanges\n  /**\n   * What differs from the latest snapshot of the CI agent `baseId` names. Absent without a base.\n   */\n  branchChanges?: BranchSnapshotChanges\n}\n"],"mappings":";;;;;;AA8JA,MAAa,uBAAuB;CAClC;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACF;;;;AAsKA,MAAa,0BAA0B;;;;;;AA0DvC,MAAa,iBAAiB;CAC5B,cAAc;CACd,YAAY;CACZ,cAAc;AAChB;AAEA,MAAa,oBAAoB;;;;AAKjC,MAAa,wBAAwB;;;;AAKrC,MAAa,wBAAwB;;AAGrC,MAAa,iBAAiB;AAE9B,MAAa,qBAAqB"}
+{"version":3,"file":"protocol.cjs","names":[],"sources":["../src/protocol.ts"],"sourcesContent":["import type { ExtensionKind, ExtensionManifest, KubbHooks } from '@kubb/core'\n\n/**\n * JSON-serializable Kubb config exchanged over RPC. A live `kubb/kit` config holds\n * functions and class instances that cannot survive JSON, so both sides pass this flattened shape\n * and rebuild the real config from it.\n */\nexport type JSONKubbConfig = {\n  /**\n   * Plugins with their serialized options. `name` is the package name (e.g. `@kubb/plugin-ts`)\n   * and `options` is an opaque blob the agent forwards unchanged to the plugin factory. An entry\n   * with `disabled: true` is dropped even when the disk config's `plugins` array still lists it.\n   */\n  plugins?: Array<{\n    name: string\n    options?: object\n    disabled?: boolean\n  }>\n  /**\n   * Raw OpenAPI / Swagger spec content (YAML or JSON string), never a file path or URL.\n   * Required by a 'sandbox' agent, which has no disk config of its own and refuses anything else.\n   * A non-sandbox agent always reads its spec from disk, so this is ignored with a `kubb:warn`.\n   */\n  input?: string\n  /**\n   * Adapter option overrides sent from Studio UI. Merged into the disk config's adapter options\n   * and re-applied through the same adapter factory, since an adapter instance's functions\n   * (`parse`, `getImports`, ...) can't survive JSON serialization over the WebSocket.\n   */\n  adapter?: object\n  /**\n   * Parser option overrides from Studio, matched to the disk config's parsers by `name` and\n   * re-applied through each parser's factory, the same way `adapter` is.\n   */\n  parsers?: Array<{\n    name: string\n    options?: object\n  }>\n}\n\n/**\n * Which `defineConfig(...)` entry an edit targets, for a config file that exports an array.\n *\n * A number selects by position, a string matches the entry's `name`. Omitted targets the only\n * entry, or the first one when the file exports an array.\n */\nexport type ConfigRef = string | number\n\n/**\n * A value the agent can read out of a plugin option in `kubb.config.ts` and round-trip through JSON.\n */\nexport type OptionValue = string | number | boolean | null | Array<OptionValue> | { [key: string]: OptionValue }\n\n/**\n * One change to a plugin's options in the user's `kubb.config.ts`.\n *\n * `plugin` is the package name (`@kubb/plugin-ts`), the same identity used in {@link JSONKubbConfig}.\n * The agent applies these to the file with an AST patch, so only the targeted values are rewritten.\n *\n * Declared here rather than in `configFile.ts` because this is the wire contract, and the patcher\n * imports it from here. Type-only, so nothing pulls `magicast` into this entry point.\n */\nexport type ConfigEdit =\n  /**\n   * Write a literal option value. `path` walks nested objects, so `['enum', 'type']` targets\n   * `pluginTs({ enum: { type } })`. `kind` names which factory call `plugin` is: one in `plugins`\n   * when left out, the config's `adapter`, or one in `parsers`.\n   */\n  | { operation: 'set'; config?: ConfigRef; kind?: ExtensionKind; plugin: string; path: Array<string>; value: unknown }\n  /**\n   * Drop an option so the extension falls back to its default. `kind` as for `set`.\n   */\n  | { operation: 'remove'; config?: ConfigRef; kind?: ExtensionKind; plugin: string; path: Array<string> }\n  /**\n   * Add a plugin factory call and its import to the `plugins` array.\n   */\n  | { operation: 'add-plugin'; config?: ConfigRef; plugin: string; options?: Record<string, unknown> }\n  /**\n   * Comment the plugin call out, keeping its options in the file so enabling it again restores them.\n   */\n  | { operation: 'disable-plugin'; config?: ConfigRef; plugin: string }\n  /**\n   * Uncomment a plugin call a previous `disable-plugin` commented out.\n   */\n  | { operation: 'enable-plugin'; config?: ConfigRef; plugin: string }\n\n/**\n * A factory call the agent found in a `defineConfig(...)`: a plugin in `plugins`, the `adapter`, or\n * a parser in `parsers`.\n */\nexport type PluginView = {\n  /**\n   * Local identifier of the factory in the file, e.g. `pluginTs`. This is the alias when the plugin\n   * was imported under one.\n   */\n  importName: string\n  /**\n   * Module the factory is imported from, e.g. `@kubb/plugin-ts`.\n   */\n  packageName: string\n  /**\n   * Top-level option keys, each flagged with whether the agent may write it and, when it can, the\n   * value found in the file. An option marked `literal: false` holds a function or a reference the\n   * agent will not overwrite, so Studio shows the control disabled rather than hiding it, and\n   * `value` is absent since there is nothing safe to display as the current value.\n   */\n  options: Record<string, { literal: boolean; value?: OptionValue }>\n  /**\n   * Set when the plugin call is commented out in the file. Its options stay on disk but are not\n   * readable, so `options` is empty until it is enabled again.\n   */\n  disabled?: true\n}\n\n/**\n * One `defineConfig(...)` entry. A config file that exports a single object has exactly one.\n */\nexport type ConfigView = {\n  /**\n   * The entry's `name`, when it sets one. Studio labels the config picker with it.\n   */\n  name?: string\n  /**\n   * Each plugin call in the entry, with its top-level option keys.\n   */\n  plugins: Array<PluginView>\n  /**\n   * The `adapter` call, when the entry sets one through an imported factory.\n   */\n  adapter?: PluginView\n  /**\n   * The parser calls in `parsers`, when the entry lists any through imported factories.\n   */\n  parsers?: Array<PluginView>\n}\n\n/**\n * What the agent found in the user's config file, so Studio knows which controls it may offer.\n * Absent when the agent could not read the file at all.\n */\nexport type ConfigFileView =\n  | {\n      managed: true\n      /**\n       * One entry per config the file exports, in source order. Every {@link ConfigEdit} names\n       * which of these it targets through its `config` field.\n       */\n      configs: Array<ConfigView>\n    }\n  | {\n      managed: false\n      /**\n       * Why the file is outside what the agent edits, for example a default export that is not a\n       * `defineConfig(...)` call. Studio shows this and offers no property-level controls.\n       */\n      reason: string\n    }\n\n/**\n * Outcome of a single {@link ConfigEdit}, returned in a {@link SaveResult}.\n */\nexport type ConfigEditOutcome = {\n  edit: ConfigEdit\n  applied: boolean\n  /**\n   * Why the edit was refused, absent when it was applied.\n   */\n  reason?: string\n}\n\n/**\n * The public, JSON-safe subset of Kubb lifecycle hooks. The core registry remains extensible;\n * adding a core hook does not publish it to Studio until it is listed here and projected below.\n */\nexport const generationEventTypes = [\n  'kubb:plugin:start',\n  'kubb:plugin:end',\n  'kubb:build:start',\n  'kubb:build:end',\n  'kubb:files:processing:start',\n  'kubb:files:processing:update',\n  'kubb:files:processing:end',\n  'kubb:info',\n  'kubb:success',\n  'kubb:warn',\n  'kubb:error',\n  'kubb:diagnostic',\n  'kubb:generation:start',\n  'kubb:generation:end',\n  'kubb:generation:summary',\n  'kubb:lifecycle:start',\n  'kubb:lifecycle:end',\n  'kubb:format:start',\n  'kubb:format:end',\n  'kubb:lint:start',\n  'kubb:lint:end',\n  'kubb:hooks:start',\n  'kubb:hooks:end',\n  'kubb:hook:start',\n  'kubb:hook:line',\n  'kubb:hook:end',\n] as const satisfies ReadonlyArray<keyof KubbHooks>\n\n/**\n * One of the lifecycle hooks {@link generationEventTypes} publishes.\n */\nexport type GenerationEventType = (typeof generationEventTypes)[number]\n\n/**\n * The JSON-safe payload each published event carries. These are flattened on purpose: a core hook\n * context holds live objects (a `Config`, a `Storage`) that cannot cross the wire.\n */\nexport type GenerationEventPayloads = {\n  'kubb:plugin:start': [ctx: { plugin: { name: string } }]\n  'kubb:plugin:end': [ctx: { plugin: { name: string }; duration: number; success: boolean }]\n  'kubb:build:start': [ctx: { config: { name?: string }; adapter: { name: string } }]\n  'kubb:build:end': [ctx: { files: Array<{ path: string; name: string }>; outputDir: string }]\n  'kubb:files:processing:start': [ctx: { total: number }]\n  'kubb:files:processing:update': [\n    ctx: {\n      files: Array<{\n        file: string\n        processed: number\n        total: number\n        percentage: number\n      }>\n    },\n  ]\n  'kubb:files:processing:end': [ctx: { total: number }]\n  'kubb:info': [ctx: { message: string; info?: string }]\n  'kubb:success': [ctx: { message: string; info?: string }]\n  'kubb:warn': [ctx: { message: string; info?: string }]\n  'kubb:error': [ctx: { message: string; stack?: string }]\n  'kubb:diagnostic': [\n    ctx: {\n      code: string\n      message: string\n      severity: string\n      location?: { kind: string; pointer?: string; ref?: string }\n      help?: string\n      plugin?: string\n      stack?: string\n    },\n  ]\n  'kubb:generation:start': [ctx: { name?: string; plugins: number }]\n  /**\n   * A run finished. See `kubb:build:end` for files, `kubb:generation:summary` for the count, and\n   * `readFiles` for contents.\n   */\n  'kubb:generation:end': []\n  'kubb:generation:summary': [ctx: { duration: number; fileCount: number; failedPlugins: number; status: 'success' | 'failed' }]\n  'kubb:lifecycle:start': []\n  'kubb:lifecycle:end': []\n  'kubb:format:start': []\n  'kubb:format:end': []\n  'kubb:lint:start': []\n  'kubb:lint:end': []\n  'kubb:hooks:start': []\n  'kubb:hooks:end': []\n  'kubb:hook:start': [ctx: { id?: string; command: string; args?: Array<string> }]\n  'kubb:hook:line': [ctx: { id: string; line: string }]\n  'kubb:hook:end': [\n    ctx: {\n      id?: string\n      command: string\n      args?: Array<string>\n      success: boolean\n      error?: { message: string; stack?: string }\n    },\n  ]\n}\n\n/**\n * Versioned envelope around one lifecycle event. Cap'n Web streams preserve the order the agent\n * emitted them in, so the receiver replays a run by reading the stream straight through.\n */\nexport type GenerationEvent = {\n  [Type in GenerationEventType]: { type: Type; data: GenerationEventPayloads[Type] }\n}[GenerationEventType] & {\n  version: 1\n  jobId: string\n  timestamp: number\n}\n\n/**\n * Asks the agent to run one generation. `jobId` tags every event the run emits so a caller\n * watching several runs can tell them apart.\n */\nexport type GenerateInput = { jobId: string; config: JSONKubbConfig }\n\n/**\n * What a finished run produced.\n */\nexport type GenerateResult = {\n  status: 'success' | 'failed'\n  /**\n   * Paths of the generated files, relative to the output directory.\n   */\n  files: Array<string>\n  fileCount: number\n  /**\n   * Content fingerprint per file in `files`, to tell changed files apart without reading them.\n   */\n  hashes: Record<string, string>\n  /**\n   * Fingerprints of the output directory on disk before the run, for an agent with a project on disk.\n   */\n  disk?: { hashes: Record<string, string> }\n}\n\n/**\n * Asks the agent to apply a batch of edits to the config file on disk.\n */\nexport type SaveConfigInput = { edits: Array<ConfigEdit> }\n\n/**\n * Per-edit outcomes. `changed` is false when every edit was a no-op, so a caller can skip reloading.\n */\nexport type SaveResult = { outcomes: Array<ConfigEditOutcome>; changed: boolean }\n\n/**\n * What a file read returns for a job: the files that job generated (`output`), or what the output\n * directory held on disk before that job ran (`disk`, only on an agent with a project on disk).\n */\nexport type FileSource = 'output' | 'disk'\n\n/**\n * Asks the agent to read files of one generation job back.\n */\nexport type ReadFilesInput = {\n  /**\n   * The job whose files to read, the only lookup key, so the caller decides whose jobs a reader may\n   * see. A job the agent no longer keeps fails with {@link GENERATION_GONE_MESSAGE}.\n   */\n  jobId: string\n  /**\n   * At most {@link MAX_FILES_PER_REQUEST} paths, each checked against what the job's set holds.\n   */\n  paths: Array<string>\n  /**\n   * Which of the job's sets to read, `output` when left out.\n   */\n  source?: FileSource\n  /**\n   * The line to start from (0-based), the `nextCursor` of the previous page. Defaults to 0.\n   */\n  cursor?: number\n  /**\n   * Lines to read per file, at most {@link MAX_PAGE_LINES}. Left out, the whole file.\n   */\n  limit?: number\n}\n\n/**\n * Where a paged read stands for one file: the cursor of the next page, `null` after the last one.\n */\nexport type FilePage = { nextCursor: number | null; totalLines: number }\n\n/**\n * What a file read returns. `pages` is set only for a paged read.\n */\nexport type ReadFilesResult = { files: Record<string, string>; pages?: Record<string, FilePage> }\n\n/**\n * The error a file read fails with once the agent no longer keeps the job's files.\n */\nexport const GENERATION_GONE_MESSAGE = 'The files of this generation are no longer kept on the agent, run the generation again'\n\n/**\n * A generation in flight. Cap'n Web keeps the three calls pointed at the same run, so a caller can\n * read `events()` while `result()` is still pending and `cancel()` stops it early.\n */\nexport type GenerationRun = {\n  events: () => Promise<ReadableStream<GenerationEvent>>\n  result: () => Promise<GenerateResult>\n  cancel: () => Promise<void>\n}\n\n/**\n * What Studio knows about the agent on the other end of a socket. Studio passes it with every\n * {@link AgentApi.connect} call, so it stays the authority on whether the agent is a sandbox.\n */\nexport type AgentConnectInfo = {\n  /**\n   * A shared `sandbox` or `global` agent. It keeps generations in memory, runs each job in a\n   * temporary root, generates from the spec Studio sends, and never writes to disk or edits config.\n   */\n  sandbox: boolean\n  agentSlug: string\n  /**\n   * Absent for a sandbox or global agent, which belongs to no organization.\n   */\n  organizationSlug?: string\n  studioVersion: string\n}\n\n/**\n * Operations Studio invokes on an agent over its socket.\n */\nexport type AgentApi = {\n  /**\n   * The first call on every socket, and again whenever Studio needs the current config.\n   */\n  connect: (info: AgentConnectInfo) => Promise<ConnectMessagePayload>\n  startGeneration: (input: GenerateInput) => GenerationRun\n  saveConfig: (input: SaveConfigInput) => Promise<SaveResult>\n  readFiles: (input: ReadFilesInput) => Promise<ReadFilesResult>\n}\n\n/**\n * Operations an agent invokes on Studio over its socket.\n */\nexport type StudioApi = {\n  /**\n   * Keeps the connection alive. A ping that does not settle in time makes the agent reconnect.\n   */\n  ping: () => Promise<void>\n}\n\n/**\n * Close codes Studio sends when it ends an agent socket on purpose. `UNAUTHORIZED` means the token\n * was refused, so pair again. `SUPERSEDED` and `INCOMPATIBLE` mean stop. Any other code, `1011`\n * included, is an ordinary drop and the agent reconnects.\n */\nexport const AgentCloseCode = {\n  UNAUTHORIZED: 4001,\n  SUPERSEDED: 4002,\n  INCOMPATIBLE: 4003,\n} as const\n\nexport const AGENT_SOCKET_PATH = '/api/agent/socket'\n\n/**\n * Optional header naming the process a socket belongs to, for agents that run several processes.\n */\nexport const AGENT_INSTANCE_HEADER = 'x-kubb-instance-id'\n\n/**\n * How many files a single `readFiles` request may ask for at once.\n */\nexport const MAX_FILES_PER_REQUEST = 50\n\n/** Most lines one page may ask for. */\nexport const MAX_PAGE_LINES = 2000\n\nexport const MAX_SNAPSHOT_BYTES = 50 * 1024 * 1024\n\n/**\n * Connection payload returned by {@link AgentApi.connect}. Carries only what Studio renders, with\n * everything about the config under one key.\n */\nexport type ConnectMessagePayload = {\n  /**\n   * Always sent, so a mismatch is visible on both sides: Studio badges the connection with these\n   * and the host prints them.\n   */\n  versions: {\n    /**\n     * The version of the `@kubb/studio` runtime the agent runs.\n     */\n    kubb: string\n    /**\n     * The version of the host itself (the `kubb.agent` package or the `kubb` CLI).\n     */\n    agent: string\n  }\n  /**\n   * The agent's project root. This is the workspace that generation runs against.\n   */\n  root: string\n  /**\n   * The baseline every generation starts from.\n   */\n  config: {\n    /**\n     * The config path as the host gave it, relative to `root` unless absolute.\n     */\n    path: string\n    /**\n     * What the agent read out of the config file itself, so Studio can render the plugin editor\n     * against the real file. Absent when the agent could not read it, or was not granted\n     * `allowConfigEdit`.\n     */\n    file?: ConfigFileView\n    /**\n     * Plugins the config registers, with a JSON copy of their options: anything JSON cannot hold,\n     * such as a function, is left out. A plugin defined in the project rather than installed as a\n     * `@kubb/plugin-*` package keeps its own `name`.\n     */\n    plugins?: Array<{\n      name: string\n      options?: object\n    }>\n    /**\n     * The adapter and the parsers the config registers, named like `plugins` and with the same JSON\n     * copy of their options, so Studio can render their manifest options.\n     */\n    adapter?: {\n      name: string\n      options?: object\n    }\n    parsers?: Array<{\n      name: string\n      options?: object\n    }>\n    /** Installed packages that ship a `kubb-extension.json`, including plugins the config does not use yet. */\n    extensions?: Array<ExtensionEntry>\n  }\n  permissions: AgentPermissions\n}\n\n/** An installed extension package and the manifest it ships. */\nexport type ExtensionEntry = { package: string; version: string; manifest: ExtensionManifest }\n\n/** Installed extension packages by package name, the only ones Studio may import besides `@kubb/plugin-*`. */\nexport type InstalledExtensions = ReadonlyMap<string, ExtensionEntry>\n\n/**\n * What an agent may do in the project it serves. Every one is off unless the host granted it, and\n * a sandbox narrows them further.\n */\nexport type AgentPermissions = {\n  /**\n   * Whether the agent writes generated files to disk. Always false for a sandbox.\n   */\n  allowWrite: boolean\n  /**\n   * Whether the agent runs the formatter, the linter, and `output.postGenerate` as child\n   * processes after a generation.\n   */\n  allowExec: boolean\n  /**\n   * Whether the agent may change plugin options in the user's `kubb.config.ts`. Separate from\n   * `allowWrite`, which covers generated output: this one edits a hand-authored source file.\n   */\n  allowConfigEdit: boolean\n  /**\n   * Whether the agent hands back file source in response to `readFiles`. Always true for a\n   * sandbox.\n   */\n  allowRead: boolean\n}\n\n/**\n * Metadata part of `POST /api/snapshots`. The `tarball` part carries the packed package.\n */\nexport type SnapshotUploadMetadata = {\n  /**\n   * Stable CI identity, such as `gh:<repoId>:<pr>`. Snapshots with the same `id` share one CI agent.\n   */\n  id: string\n  name: string\n  packageName: string\n  version: string\n  /**\n   * The commit the snapshot is built from, so the next one can name it as its base.\n   */\n  commit?: string\n  /**\n   * The `id` of another CI agent, such as the base branch's, to also compare with.\n   */\n  baseId?: string\n  /**\n   * Content fingerprint per generated file, keyed by path relative to the project root.\n   */\n  hashes: Record<string, string>\n  peerDependencies: Record<string, string>\n}\n\n/**\n * How a snapshot's files differ from an earlier snapshot of the same package.\n */\nexport type SnapshotChanges = {\n  /**\n   * The snapshot these changes are measured against, `null` when there is none to compare with.\n   */\n  base: { id: string; version: string | null; commit?: string; createdAt: string } | null\n  added: Array<string>\n  changed: Array<string>\n  removed: Array<string>\n}\n\n/**\n * {@link SnapshotChanges} against another CI agent. `baseFound` is `false` when Studio has no CI\n * agent with that id yet, and `true` when it has one without a snapshot of this package.\n */\nexport type BranchSnapshotChanges = SnapshotChanges & { baseFound: boolean }\n\n/**\n * Response body of `POST /api/snapshots`: `{ snapshot: PublishedSnapshot }`.\n */\nexport type PublishedSnapshot = {\n  id: string\n  name: string | null\n  version: string | null\n  integrity: string | null\n  agent: { id: string; name: string; slug: string | null }\n  /**\n   * Readable download path, often `/packages/{agentSlug}/{name}.tgz`.\n   */\n  url: string\n  snapshotIdUrl: string\n  createdAt: string\n  expiresAt: string\n  /**\n   * What changed since the previous snapshot of this package on the same CI agent.\n   */\n  changes?: SnapshotChanges\n  /**\n   * What differs from the latest snapshot of the CI agent `baseId` names. Absent without a base.\n   */\n  branchChanges?: BranchSnapshotChanges\n}\n"],"mappings":";;;;;;AA8KA,MAAa,uBAAuB;CAClC;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACF;;;;AAqKA,MAAa,0BAA0B;;;;;;AA0DvC,MAAa,iBAAiB;CAC5B,cAAc;CACd,YAAY;CACZ,cAAc;AAChB;AAEA,MAAa,oBAAoB;;;;AAKjC,MAAa,wBAAwB;;;;AAKrC,MAAa,wBAAwB;;AAGrC,MAAa,iBAAiB;AAE9B,MAAa,qBAAqB"}

package/dist/protocol.d.ts

@@ -1,2 +1,2 @@
-import { A as OptionValue, B as SnapshotChanges, C as GenerationEventPayloads, D as MAX_FILES_PER_REQUEST, E as JSONKubbConfig, F as RegistryArtifact, H as StudioApi, I as RegistryDetail, L as RegistryEntry, M as PublishedSnapshot, N as ReadFilesInput, O as MAX_PAGE_LINES, P as ReadFilesResult, R as SaveConfigInput, S as GenerationEvent, T as GenerationRun, U as generationEventTypes, V as SnapshotUploadMetadata, _ as FilePage, a as AgentConnectInfo, b as GenerateInput, c as ConfigEdit, d as ConfigRef, f as ConfigView, g as ExtensionManifestOption, h as ExtensionManifest, i as AgentCloseCode, j as PluginView, k as MAX_SNAPSHOT_BYTES, l as ConfigEditOutcome, m as ExtensionEntry, n as AGENT_SOCKET_PATH, o as AgentPermissions, p as ConnectMessagePayload, r as AgentApi, s as BranchSnapshotChanges, t as AGENT_INSTANCE_HEADER, u as ConfigFileView, v as FileSource, w as GenerationEventType, x as GenerateResult, y as GENERATION_GONE_MESSAGE, z as SaveResult } from "./protocol-BfjNY8-8.js";
-export { AGENT_INSTANCE_HEADER, AGENT_SOCKET_PATH, AgentApi, AgentCloseCode, AgentConnectInfo, AgentPermissions, BranchSnapshotChanges, ConfigEdit, ConfigEditOutcome, ConfigFileView, ConfigRef, ConfigView, ConnectMessagePayload, ExtensionEntry, type ExtensionManifest, type ExtensionManifestOption, FilePage, FileSource, GENERATION_GONE_MESSAGE, GenerateInput, GenerateResult, GenerationEvent, GenerationEventPayloads, GenerationEventType, GenerationRun, JSONKubbConfig, MAX_FILES_PER_REQUEST, MAX_PAGE_LINES, MAX_SNAPSHOT_BYTES, OptionValue, PluginView, PublishedSnapshot, ReadFilesInput, ReadFilesResult, type RegistryArtifact, type RegistryDetail, type RegistryEntry, SaveConfigInput, SaveResult, SnapshotChanges, SnapshotUploadMetadata, StudioApi, generationEventTypes };
+import { A as PluginView, C as GenerationRun, D as MAX_PAGE_LINES, E as MAX_FILES_PER_REQUEST, F as SaveResult, I as SnapshotChanges, L as SnapshotUploadMetadata, M as ReadFilesInput, N as ReadFilesResult, O as MAX_SNAPSHOT_BYTES, P as SaveConfigInput, R as StudioApi, S as GenerationEventType, T as JSONKubbConfig, _ as GENERATION_GONE_MESSAGE, a as AgentConnectInfo, b as GenerationEvent, c as ConfigEdit, d as ConfigRef, f as ConfigView, g as FileSource, h as FilePage, i as AgentCloseCode, j as PublishedSnapshot, k as OptionValue, l as ConfigEditOutcome, m as ExtensionEntry, n as AGENT_SOCKET_PATH, o as AgentPermissions, p as ConnectMessagePayload, r as AgentApi, s as BranchSnapshotChanges, t as AGENT_INSTANCE_HEADER, u as ConfigFileView, v as GenerateInput, w as InstalledExtensions, x as GenerationEventPayloads, y as GenerateResult, z as generationEventTypes } from "./protocol-gXoAXvT3.js";
+export { AGENT_INSTANCE_HEADER, AGENT_SOCKET_PATH, AgentApi, AgentCloseCode, AgentConnectInfo, AgentPermissions, BranchSnapshotChanges, ConfigEdit, ConfigEditOutcome, ConfigFileView, ConfigRef, ConfigView, ConnectMessagePayload, ExtensionEntry, FilePage, FileSource, GENERATION_GONE_MESSAGE, GenerateInput, GenerateResult, GenerationEvent, GenerationEventPayloads, GenerationEventType, GenerationRun, InstalledExtensions, JSONKubbConfig, MAX_FILES_PER_REQUEST, MAX_PAGE_LINES, MAX_SNAPSHOT_BYTES, OptionValue, PluginView, PublishedSnapshot, ReadFilesInput, ReadFilesResult, SaveConfigInput, SaveResult, SnapshotChanges, SnapshotUploadMetadata, StudioApi, generationEventTypes };

package/dist/protocol.js.map

@@ -1 +1 @@
-{"version":3,"file":"protocol.js","names":[],"sources":["../src/protocol.ts"],"sourcesContent":["import type { ExtensionManifest, KubbHooks } from '@kubb/core'\n\nexport type { ExtensionManifest, ExtensionManifestOption, RegistryArtifact, RegistryDetail, RegistryEntry } from '@kubb/core'\n\n/**\n * JSON-serializable Kubb config exchanged over RPC. A live `kubb/kit` config holds\n * functions and class instances that cannot survive JSON, so both sides pass this flattened shape\n * and rebuild the real config from it.\n */\nexport type JSONKubbConfig = {\n  /**\n   * Plugins with their serialized options. `name` is the package name (e.g. `@kubb/plugin-ts`)\n   * and `options` is an opaque blob the agent forwards unchanged to the plugin factory. An entry\n   * with `disabled: true` is dropped even when the disk config's `plugins` array still lists it.\n   */\n  plugins?: Array<{\n    name: string\n    options?: object\n    disabled?: boolean\n  }>\n  /**\n   * Raw OpenAPI / Swagger spec content (YAML or JSON string), never a file path or URL.\n   * Required by a 'sandbox' agent, which has no disk config of its own and refuses anything else.\n   * A non-sandbox agent always reads its spec from disk, so this is ignored with a `kubb:warn`.\n   */\n  input?: string\n  /**\n   * Adapter option overrides sent from Studio UI. Merged into the disk config's adapter options\n   * and re-applied through the same adapter factory, since an adapter instance's functions\n   * (`parse`, `getImports`, ...) can't survive JSON serialization over the WebSocket.\n   */\n  adapter?: object\n}\n\n/**\n * Which `defineConfig(...)` entry an edit targets, for a config file that exports an array.\n *\n * A number selects by position, a string matches the entry's `name`. Omitted targets the only\n * entry, or the first one when the file exports an array.\n */\nexport type ConfigRef = string | number\n\n/**\n * A value the agent can read out of a plugin option in `kubb.config.ts` and round-trip through JSON.\n */\nexport type OptionValue = string | number | boolean | null | Array<OptionValue> | { [key: string]: OptionValue }\n\n/**\n * One change to a plugin's options in the user's `kubb.config.ts`.\n *\n * `plugin` is the package name (`@kubb/plugin-ts`), the same identity used in {@link JSONKubbConfig}.\n * The agent applies these to the file with an AST patch, so only the targeted values are rewritten.\n *\n * Declared here rather than in `configFile.ts` because this is the wire contract, and the patcher\n * imports it from here. Type-only, so nothing pulls `magicast` into this entry point.\n */\nexport type ConfigEdit =\n  /**\n   * Write a literal option value. `path` walks nested objects, so `['enum', 'type']` targets\n   * `pluginTs({ enum: { type } })`.\n   */\n  | { operation: 'set'; config?: ConfigRef; plugin: string; path: Array<string>; value: unknown }\n  /**\n   * Drop an option so the plugin falls back to its default.\n   */\n  | { operation: 'remove'; config?: ConfigRef; plugin: string; path: Array<string> }\n  /**\n   * Add a plugin factory call and its import to the `plugins` array.\n   */\n  | { operation: 'add-plugin'; config?: ConfigRef; plugin: string; importName?: string; options?: Record<string, unknown> }\n  /**\n   * Comment the plugin call out, keeping its options in the file so enabling it again restores them.\n   */\n  | { operation: 'disable-plugin'; config?: ConfigRef; plugin: string }\n  /**\n   * Uncomment a plugin call a previous `disable-plugin` commented out.\n   */\n  | { operation: 'enable-plugin'; config?: ConfigRef; plugin: string }\n\n/**\n * A plugin factory call the agent found in the `plugins` array of a `defineConfig(...)`.\n */\nexport type PluginView = {\n  /**\n   * Local identifier of the factory in the file, e.g. `pluginTs`. This is the alias when the plugin\n   * was imported under one.\n   */\n  importName: string\n  /**\n   * Module the factory is imported from, e.g. `@kubb/plugin-ts`.\n   */\n  packageName: string\n  /**\n   * Top-level option keys, each flagged with whether the agent may write it and, when it can, the\n   * value found in the file. An option marked `literal: false` holds a function or a reference the\n   * agent will not overwrite, so Studio shows the control disabled rather than hiding it, and\n   * `value` is absent since there is nothing safe to display as the current value.\n   */\n  options: Record<string, { literal: boolean; value?: OptionValue }>\n  /**\n   * Set when the plugin call is commented out in the file. Its options stay on disk but are not\n   * readable, so `options` is empty until it is enabled again.\n   */\n  disabled?: true\n}\n\n/**\n * One `defineConfig(...)` entry. A config file that exports a single object has exactly one.\n */\nexport type ConfigView = {\n  /**\n   * The entry's `name`, when it sets one. Studio labels the config picker with it.\n   */\n  name?: string\n  /**\n   * Each plugin call in the entry, with its top-level option keys.\n   */\n  plugins: Array<PluginView>\n}\n\n/**\n * What the agent found in the user's config file, so Studio knows which controls it may offer.\n * Absent when the agent could not read the file at all.\n */\nexport type ConfigFileView =\n  | {\n      managed: true\n      /**\n       * One entry per config the file exports, in source order. Every {@link ConfigEdit} names\n       * which of these it targets through its `config` field.\n       */\n      configs: Array<ConfigView>\n    }\n  | {\n      managed: false\n      /**\n       * Why the file is outside what the agent edits, for example a default export that is not a\n       * `defineConfig(...)` call. Studio shows this and offers no property-level controls.\n       */\n      reason: string\n    }\n\n/**\n * Outcome of a single {@link ConfigEdit}, returned in a {@link SaveResult}.\n */\nexport type ConfigEditOutcome = {\n  edit: ConfigEdit\n  applied: boolean\n  /**\n   * Why the edit was refused, absent when it was applied.\n   */\n  reason?: string\n}\n\n/**\n * The public, JSON-safe subset of Kubb lifecycle hooks. The core registry remains extensible;\n * adding a core hook does not publish it to Studio until it is listed here and projected below.\n */\nexport const generationEventTypes = [\n  'kubb:plugin:start',\n  'kubb:plugin:end',\n  'kubb:build:start',\n  'kubb:build:end',\n  'kubb:files:processing:start',\n  'kubb:files:processing:update',\n  'kubb:files:processing:end',\n  'kubb:info',\n  'kubb:success',\n  'kubb:warn',\n  'kubb:error',\n  'kubb:diagnostic',\n  'kubb:generation:start',\n  'kubb:generation:end',\n  'kubb:generation:summary',\n  'kubb:lifecycle:start',\n  'kubb:lifecycle:end',\n  'kubb:format:start',\n  'kubb:format:end',\n  'kubb:lint:start',\n  'kubb:lint:end',\n  'kubb:hooks:start',\n  'kubb:hooks:end',\n  'kubb:hook:start',\n  'kubb:hook:line',\n  'kubb:hook:end',\n] as const satisfies ReadonlyArray<keyof KubbHooks>\n\n/**\n * One of the lifecycle hooks {@link generationEventTypes} publishes.\n */\nexport type GenerationEventType = (typeof generationEventTypes)[number]\n\n/**\n * The JSON-safe payload each published event carries. These are flattened on purpose: a core hook\n * context holds live objects (a `Config`, a `Storage`) that cannot cross the wire.\n */\nexport type GenerationEventPayloads = {\n  'kubb:plugin:start': [ctx: { plugin: { name: string } }]\n  'kubb:plugin:end': [ctx: { plugin: { name: string }; duration: number; success: boolean }]\n  'kubb:build:start': [ctx: { config: { name?: string }; adapter: { name: string } }]\n  'kubb:build:end': [ctx: { files: Array<{ path: string; name: string }>; outputDir: string }]\n  'kubb:files:processing:start': [ctx: { total: number }]\n  'kubb:files:processing:update': [\n    ctx: {\n      files: Array<{\n        file: string\n        processed: number\n        total: number\n        percentage: number\n      }>\n    },\n  ]\n  'kubb:files:processing:end': [ctx: { total: number }]\n  'kubb:info': [ctx: { message: string; info?: string }]\n  'kubb:success': [ctx: { message: string; info?: string }]\n  'kubb:warn': [ctx: { message: string; info?: string }]\n  'kubb:error': [ctx: { message: string; stack?: string }]\n  'kubb:diagnostic': [\n    ctx: {\n      code: string\n      message: string\n      severity: string\n      location?: { kind: string; pointer?: string; ref?: string }\n      help?: string\n      plugin?: string\n      stack?: string\n    },\n  ]\n  'kubb:generation:start': [ctx: { name?: string; plugins: number }]\n  /**\n   * A run finished. See `kubb:build:end` for files, `kubb:generation:summary` for the count, and\n   * `readFiles` for contents.\n   */\n  'kubb:generation:end': []\n  'kubb:generation:summary': [ctx: { duration: number; fileCount: number; failedPlugins: number; status: 'success' | 'failed' }]\n  'kubb:lifecycle:start': []\n  'kubb:lifecycle:end': []\n  'kubb:format:start': []\n  'kubb:format:end': []\n  'kubb:lint:start': []\n  'kubb:lint:end': []\n  'kubb:hooks:start': []\n  'kubb:hooks:end': []\n  'kubb:hook:start': [ctx: { id?: string; command: string; args?: Array<string> }]\n  'kubb:hook:line': [ctx: { id: string; line: string }]\n  'kubb:hook:end': [\n    ctx: {\n      id?: string\n      command: string\n      args?: Array<string>\n      success: boolean\n      error?: { message: string; stack?: string }\n    },\n  ]\n}\n\n/**\n * Versioned envelope around one lifecycle event. Cap'n Web streams preserve the order the agent\n * emitted them in, so the receiver replays a run by reading the stream straight through.\n */\nexport type GenerationEvent = {\n  [Type in GenerationEventType]: { type: Type; data: GenerationEventPayloads[Type] }\n}[GenerationEventType] & {\n  version: 1\n  jobId: string\n  timestamp: number\n}\n\n/**\n * Asks the agent to run one generation. `jobId` tags every event the run emits so a caller\n * watching several runs can tell them apart.\n */\nexport type GenerateInput = { jobId: string; config: JSONKubbConfig }\n\n/**\n * What a finished run produced.\n */\nexport type GenerateResult = {\n  status: 'success' | 'failed'\n  /**\n   * Paths of the generated files, relative to the output directory.\n   */\n  files: Array<string>\n  fileCount: number\n  /**\n   * Content fingerprint per file in `files`, to tell changed files apart without reading them.\n   */\n  hashes: Record<string, string>\n  /**\n   * Fingerprints of the output directory on disk before the run, for an agent with a project on disk.\n   */\n  disk?: { hashes: Record<string, string> }\n}\n\n/**\n * Asks the agent to apply a batch of edits to the config file on disk.\n */\nexport type SaveConfigInput = { edits: Array<ConfigEdit> }\n\n/**\n * Per-edit outcomes plus the rewritten file. `changed` is false when every edit was a no-op, so a\n * caller can skip reloading.\n */\nexport type SaveResult = { outcomes: Array<ConfigEditOutcome>; changed: boolean; file?: ConfigFileView }\n\n/**\n * What a file read returns for a job: the files that job generated (`output`), or what the output\n * directory held on disk before that job ran (`disk`, only on an agent with a project on disk).\n */\nexport type FileSource = 'output' | 'disk'\n\n/**\n * Asks the agent to read files of one generation job back.\n */\nexport type ReadFilesInput = {\n  /**\n   * The job whose files to read, the only lookup key, so the caller decides whose jobs a reader may\n   * see. A job the agent no longer keeps fails with {@link GENERATION_GONE_MESSAGE}.\n   */\n  jobId: string\n  /**\n   * At most {@link MAX_FILES_PER_REQUEST} paths, each checked against what the job's set holds.\n   */\n  paths: Array<string>\n  /**\n   * Which of the job's sets to read, `output` when left out.\n   */\n  source?: FileSource\n  /**\n   * The line to start from (0-based), the `nextCursor` of the previous page. Defaults to 0.\n   */\n  cursor?: number\n  /**\n   * Lines to read per file, at most {@link MAX_PAGE_LINES}. Left out, the whole file.\n   */\n  limit?: number\n}\n\n/**\n * Where a paged read stands for one file: the cursor of the next page, `null` after the last one.\n */\nexport type FilePage = { nextCursor: number | null; totalLines: number }\n\n/**\n * What a file read returns. `pages` is set only for a paged read.\n */\nexport type ReadFilesResult = { files: Record<string, string>; pages?: Record<string, FilePage> }\n\n/**\n * The error a file read fails with once the agent no longer keeps the job's files.\n */\nexport const GENERATION_GONE_MESSAGE = 'The files of this generation are no longer kept on the agent, run the generation again'\n\n/**\n * A generation in flight. Cap'n Web keeps the three calls pointed at the same run, so a caller can\n * read `events()` while `result()` is still pending and `cancel()` stops it early.\n */\nexport type GenerationRun = {\n  events: () => Promise<ReadableStream<GenerationEvent>>\n  result: () => Promise<GenerateResult>\n  cancel: () => Promise<void>\n}\n\n/**\n * What Studio knows about the agent on the other end of a socket. Studio passes it with every\n * {@link AgentApi.connect} call, so it stays the authority on whether the agent is a sandbox.\n */\nexport type AgentConnectInfo = {\n  /**\n   * A shared `sandbox` or `global` agent. It keeps generations in memory, runs each job in a\n   * temporary root, generates from the spec Studio sends, and never writes to disk or edits config.\n   */\n  sandbox: boolean\n  agentSlug: string\n  /**\n   * Absent for a sandbox or global agent, which belongs to no organization.\n   */\n  organizationSlug?: string\n  studioVersion: string\n}\n\n/**\n * Operations Studio invokes on an agent over its socket.\n */\nexport type AgentApi = {\n  /**\n   * The first call on every socket, and again whenever Studio needs the current config.\n   */\n  connect: (info: AgentConnectInfo) => Promise<ConnectMessagePayload>\n  startGeneration: (input: GenerateInput) => GenerationRun\n  saveConfig: (input: SaveConfigInput) => Promise<SaveResult>\n  readFiles: (input: ReadFilesInput) => Promise<ReadFilesResult>\n}\n\n/**\n * Operations an agent invokes on Studio over its socket.\n */\nexport type StudioApi = {\n  /**\n   * Keeps the connection alive. A ping that does not settle in time makes the agent reconnect.\n   */\n  ping: () => Promise<void>\n}\n\n/**\n * Close codes Studio sends when it ends an agent socket on purpose. `UNAUTHORIZED` means the token\n * was refused, so pair again. `SUPERSEDED` and `INCOMPATIBLE` mean stop. Any other code, `1011`\n * included, is an ordinary drop and the agent reconnects.\n */\nexport const AgentCloseCode = {\n  UNAUTHORIZED: 4001,\n  SUPERSEDED: 4002,\n  INCOMPATIBLE: 4003,\n} as const\n\nexport const AGENT_SOCKET_PATH = '/api/agent/socket'\n\n/**\n * Optional header naming the process a socket belongs to, for agents that run several processes.\n */\nexport const AGENT_INSTANCE_HEADER = 'x-kubb-instance-id'\n\n/**\n * How many files a single `readFiles` request may ask for at once.\n */\nexport const MAX_FILES_PER_REQUEST = 50\n\n/** Most lines one page may ask for. */\nexport const MAX_PAGE_LINES = 2000\n\nexport const MAX_SNAPSHOT_BYTES = 50 * 1024 * 1024\n\n/**\n * Connection payload returned by {@link AgentApi.connect}. Carries only what Studio renders, with\n * everything about the config under one key.\n */\nexport type ConnectMessagePayload = {\n  /**\n   * Always sent, so a mismatch is visible on both sides: Studio badges the connection with these\n   * and the host prints them.\n   */\n  versions: {\n    /**\n     * The version of the `@kubb/studio` runtime the agent runs.\n     */\n    kubb: string\n    /**\n     * The version of the host itself (the `kubb.agent` package or the `kubb` CLI).\n     */\n    agent: string\n  }\n  /**\n   * The agent's project root. This is the workspace that generation runs against.\n   */\n  root: string\n  /**\n   * The baseline every generation starts from.\n   */\n  config: {\n    /**\n     * The config path as the host gave it, relative to `root` unless absolute.\n     */\n    path: string\n    /**\n     * What the agent read out of the config file itself, so Studio can render the plugin editor\n     * against the real file. Absent when the agent could not read it, or was not granted\n     * `allowConfigEdit`.\n     */\n    file?: ConfigFileView\n    /**\n     * Plugins the config registers, with a JSON copy of their options: anything JSON cannot hold,\n     * such as a function, is left out. A plugin defined in the project rather than installed as a\n     * `@kubb/plugin-*` package keeps its own `name`.\n     */\n    plugins?: Array<{\n      name: string\n      options?: object\n    }>\n    /** Installed packages that ship a `kubb-extension.json`, including plugins the config does not use yet. */\n    extensions?: Array<ExtensionEntry>\n  }\n  permissions: AgentPermissions\n}\n\n/** An installed extension package and the manifest it ships. */\nexport type ExtensionEntry = { package: string; version: string; manifest: ExtensionManifest }\n\n/**\n * What an agent may do in the project it serves. Every one is off unless the host granted it, and\n * a sandbox narrows them further.\n */\nexport type AgentPermissions = {\n  /**\n   * Whether the agent writes generated files to disk. Always false for a sandbox.\n   */\n  allowWrite: boolean\n  /**\n   * Whether the agent runs the formatter, the linter, and `output.postGenerate` as child\n   * processes after a generation.\n   */\n  allowExec: boolean\n  /**\n   * Whether the agent may change plugin options in the user's `kubb.config.ts`. Separate from\n   * `allowWrite`, which covers generated output: this one edits a hand-authored source file.\n   */\n  allowConfigEdit: boolean\n  /**\n   * Whether the agent hands back file source in response to `readFiles`. Always true for a\n   * sandbox.\n   */\n  allowRead: boolean\n}\n\n/**\n * Metadata part of `POST /api/snapshots`. The `tarball` part carries the packed package.\n */\nexport type SnapshotUploadMetadata = {\n  /**\n   * Stable CI identity, such as `gh:<repoId>:<pr>`. Snapshots with the same `id` share one CI agent.\n   */\n  id: string\n  name: string\n  packageName: string\n  version: string\n  /**\n   * The commit the snapshot is built from, so the next one can name it as its base.\n   */\n  commit?: string\n  /**\n   * The `id` of another CI agent, such as the base branch's, to also compare with.\n   */\n  baseId?: string\n  /**\n   * Content fingerprint per generated file, keyed by path relative to the project root.\n   */\n  hashes: Record<string, string>\n  peerDependencies: Record<string, string>\n}\n\n/**\n * How a snapshot's files differ from an earlier snapshot of the same package.\n */\nexport type SnapshotChanges = {\n  /**\n   * The snapshot these changes are measured against, `null` when there is none to compare with.\n   */\n  base: { id: string; version: string | null; commit?: string; createdAt: string } | null\n  added: Array<string>\n  changed: Array<string>\n  removed: Array<string>\n}\n\n/**\n * {@link SnapshotChanges} against another CI agent. `baseFound` is `false` when Studio has no CI\n * agent with that id yet, and `true` when it has one without a snapshot of this package.\n */\nexport type BranchSnapshotChanges = SnapshotChanges & { baseFound: boolean }\n\n/**\n * Response body of `POST /api/snapshots`: `{ snapshot: PublishedSnapshot }`.\n */\nexport type PublishedSnapshot = {\n  id: string\n  name: string | null\n  version: string | null\n  integrity: string | null\n  agent: { id: string; name: string; slug: string | null }\n  /**\n   * Readable download path, often `/packages/{agentSlug}/{name}.tgz`.\n   */\n  url: string\n  snapshotIdUrl: string\n  createdAt: string\n  expiresAt: string\n  /**\n   * What changed since the previous snapshot of this package on the same CI agent.\n   */\n  changes?: SnapshotChanges\n  /**\n   * What differs from the latest snapshot of the CI agent `baseId` names. Absent without a base.\n   */\n  branchChanges?: BranchSnapshotChanges\n}\n"],"mappings":";;;;;AA8JA,MAAa,uBAAuB;CAClC;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACF;;;;AAsKA,MAAa,0BAA0B;;;;;;AA0DvC,MAAa,iBAAiB;CAC5B,cAAc;CACd,YAAY;CACZ,cAAc;AAChB;AAEA,MAAa,oBAAoB;;;;AAKjC,MAAa,wBAAwB;;;;AAKrC,MAAa,wBAAwB;;AAGrC,MAAa,iBAAiB;AAE9B,MAAa,qBAAqB"}
+{"version":3,"file":"protocol.js","names":[],"sources":["../src/protocol.ts"],"sourcesContent":["import type { ExtensionKind, ExtensionManifest, KubbHooks } from '@kubb/core'\n\n/**\n * JSON-serializable Kubb config exchanged over RPC. A live `kubb/kit` config holds\n * functions and class instances that cannot survive JSON, so both sides pass this flattened shape\n * and rebuild the real config from it.\n */\nexport type JSONKubbConfig = {\n  /**\n   * Plugins with their serialized options. `name` is the package name (e.g. `@kubb/plugin-ts`)\n   * and `options` is an opaque blob the agent forwards unchanged to the plugin factory. An entry\n   * with `disabled: true` is dropped even when the disk config's `plugins` array still lists it.\n   */\n  plugins?: Array<{\n    name: string\n    options?: object\n    disabled?: boolean\n  }>\n  /**\n   * Raw OpenAPI / Swagger spec content (YAML or JSON string), never a file path or URL.\n   * Required by a 'sandbox' agent, which has no disk config of its own and refuses anything else.\n   * A non-sandbox agent always reads its spec from disk, so this is ignored with a `kubb:warn`.\n   */\n  input?: string\n  /**\n   * Adapter option overrides sent from Studio UI. Merged into the disk config's adapter options\n   * and re-applied through the same adapter factory, since an adapter instance's functions\n   * (`parse`, `getImports`, ...) can't survive JSON serialization over the WebSocket.\n   */\n  adapter?: object\n  /**\n   * Parser option overrides from Studio, matched to the disk config's parsers by `name` and\n   * re-applied through each parser's factory, the same way `adapter` is.\n   */\n  parsers?: Array<{\n    name: string\n    options?: object\n  }>\n}\n\n/**\n * Which `defineConfig(...)` entry an edit targets, for a config file that exports an array.\n *\n * A number selects by position, a string matches the entry's `name`. Omitted targets the only\n * entry, or the first one when the file exports an array.\n */\nexport type ConfigRef = string | number\n\n/**\n * A value the agent can read out of a plugin option in `kubb.config.ts` and round-trip through JSON.\n */\nexport type OptionValue = string | number | boolean | null | Array<OptionValue> | { [key: string]: OptionValue }\n\n/**\n * One change to a plugin's options in the user's `kubb.config.ts`.\n *\n * `plugin` is the package name (`@kubb/plugin-ts`), the same identity used in {@link JSONKubbConfig}.\n * The agent applies these to the file with an AST patch, so only the targeted values are rewritten.\n *\n * Declared here rather than in `configFile.ts` because this is the wire contract, and the patcher\n * imports it from here. Type-only, so nothing pulls `magicast` into this entry point.\n */\nexport type ConfigEdit =\n  /**\n   * Write a literal option value. `path` walks nested objects, so `['enum', 'type']` targets\n   * `pluginTs({ enum: { type } })`. `kind` names which factory call `plugin` is: one in `plugins`\n   * when left out, the config's `adapter`, or one in `parsers`.\n   */\n  | { operation: 'set'; config?: ConfigRef; kind?: ExtensionKind; plugin: string; path: Array<string>; value: unknown }\n  /**\n   * Drop an option so the extension falls back to its default. `kind` as for `set`.\n   */\n  | { operation: 'remove'; config?: ConfigRef; kind?: ExtensionKind; plugin: string; path: Array<string> }\n  /**\n   * Add a plugin factory call and its import to the `plugins` array.\n   */\n  | { operation: 'add-plugin'; config?: ConfigRef; plugin: string; options?: Record<string, unknown> }\n  /**\n   * Comment the plugin call out, keeping its options in the file so enabling it again restores them.\n   */\n  | { operation: 'disable-plugin'; config?: ConfigRef; plugin: string }\n  /**\n   * Uncomment a plugin call a previous `disable-plugin` commented out.\n   */\n  | { operation: 'enable-plugin'; config?: ConfigRef; plugin: string }\n\n/**\n * A factory call the agent found in a `defineConfig(...)`: a plugin in `plugins`, the `adapter`, or\n * a parser in `parsers`.\n */\nexport type PluginView = {\n  /**\n   * Local identifier of the factory in the file, e.g. `pluginTs`. This is the alias when the plugin\n   * was imported under one.\n   */\n  importName: string\n  /**\n   * Module the factory is imported from, e.g. `@kubb/plugin-ts`.\n   */\n  packageName: string\n  /**\n   * Top-level option keys, each flagged with whether the agent may write it and, when it can, the\n   * value found in the file. An option marked `literal: false` holds a function or a reference the\n   * agent will not overwrite, so Studio shows the control disabled rather than hiding it, and\n   * `value` is absent since there is nothing safe to display as the current value.\n   */\n  options: Record<string, { literal: boolean; value?: OptionValue }>\n  /**\n   * Set when the plugin call is commented out in the file. Its options stay on disk but are not\n   * readable, so `options` is empty until it is enabled again.\n   */\n  disabled?: true\n}\n\n/**\n * One `defineConfig(...)` entry. A config file that exports a single object has exactly one.\n */\nexport type ConfigView = {\n  /**\n   * The entry's `name`, when it sets one. Studio labels the config picker with it.\n   */\n  name?: string\n  /**\n   * Each plugin call in the entry, with its top-level option keys.\n   */\n  plugins: Array<PluginView>\n  /**\n   * The `adapter` call, when the entry sets one through an imported factory.\n   */\n  adapter?: PluginView\n  /**\n   * The parser calls in `parsers`, when the entry lists any through imported factories.\n   */\n  parsers?: Array<PluginView>\n}\n\n/**\n * What the agent found in the user's config file, so Studio knows which controls it may offer.\n * Absent when the agent could not read the file at all.\n */\nexport type ConfigFileView =\n  | {\n      managed: true\n      /**\n       * One entry per config the file exports, in source order. Every {@link ConfigEdit} names\n       * which of these it targets through its `config` field.\n       */\n      configs: Array<ConfigView>\n    }\n  | {\n      managed: false\n      /**\n       * Why the file is outside what the agent edits, for example a default export that is not a\n       * `defineConfig(...)` call. Studio shows this and offers no property-level controls.\n       */\n      reason: string\n    }\n\n/**\n * Outcome of a single {@link ConfigEdit}, returned in a {@link SaveResult}.\n */\nexport type ConfigEditOutcome = {\n  edit: ConfigEdit\n  applied: boolean\n  /**\n   * Why the edit was refused, absent when it was applied.\n   */\n  reason?: string\n}\n\n/**\n * The public, JSON-safe subset of Kubb lifecycle hooks. The core registry remains extensible;\n * adding a core hook does not publish it to Studio until it is listed here and projected below.\n */\nexport const generationEventTypes = [\n  'kubb:plugin:start',\n  'kubb:plugin:end',\n  'kubb:build:start',\n  'kubb:build:end',\n  'kubb:files:processing:start',\n  'kubb:files:processing:update',\n  'kubb:files:processing:end',\n  'kubb:info',\n  'kubb:success',\n  'kubb:warn',\n  'kubb:error',\n  'kubb:diagnostic',\n  'kubb:generation:start',\n  'kubb:generation:end',\n  'kubb:generation:summary',\n  'kubb:lifecycle:start',\n  'kubb:lifecycle:end',\n  'kubb:format:start',\n  'kubb:format:end',\n  'kubb:lint:start',\n  'kubb:lint:end',\n  'kubb:hooks:start',\n  'kubb:hooks:end',\n  'kubb:hook:start',\n  'kubb:hook:line',\n  'kubb:hook:end',\n] as const satisfies ReadonlyArray<keyof KubbHooks>\n\n/**\n * One of the lifecycle hooks {@link generationEventTypes} publishes.\n */\nexport type GenerationEventType = (typeof generationEventTypes)[number]\n\n/**\n * The JSON-safe payload each published event carries. These are flattened on purpose: a core hook\n * context holds live objects (a `Config`, a `Storage`) that cannot cross the wire.\n */\nexport type GenerationEventPayloads = {\n  'kubb:plugin:start': [ctx: { plugin: { name: string } }]\n  'kubb:plugin:end': [ctx: { plugin: { name: string }; duration: number; success: boolean }]\n  'kubb:build:start': [ctx: { config: { name?: string }; adapter: { name: string } }]\n  'kubb:build:end': [ctx: { files: Array<{ path: string; name: string }>; outputDir: string }]\n  'kubb:files:processing:start': [ctx: { total: number }]\n  'kubb:files:processing:update': [\n    ctx: {\n      files: Array<{\n        file: string\n        processed: number\n        total: number\n        percentage: number\n      }>\n    },\n  ]\n  'kubb:files:processing:end': [ctx: { total: number }]\n  'kubb:info': [ctx: { message: string; info?: string }]\n  'kubb:success': [ctx: { message: string; info?: string }]\n  'kubb:warn': [ctx: { message: string; info?: string }]\n  'kubb:error': [ctx: { message: string; stack?: string }]\n  'kubb:diagnostic': [\n    ctx: {\n      code: string\n      message: string\n      severity: string\n      location?: { kind: string; pointer?: string; ref?: string }\n      help?: string\n      plugin?: string\n      stack?: string\n    },\n  ]\n  'kubb:generation:start': [ctx: { name?: string; plugins: number }]\n  /**\n   * A run finished. See `kubb:build:end` for files, `kubb:generation:summary` for the count, and\n   * `readFiles` for contents.\n   */\n  'kubb:generation:end': []\n  'kubb:generation:summary': [ctx: { duration: number; fileCount: number; failedPlugins: number; status: 'success' | 'failed' }]\n  'kubb:lifecycle:start': []\n  'kubb:lifecycle:end': []\n  'kubb:format:start': []\n  'kubb:format:end': []\n  'kubb:lint:start': []\n  'kubb:lint:end': []\n  'kubb:hooks:start': []\n  'kubb:hooks:end': []\n  'kubb:hook:start': [ctx: { id?: string; command: string; args?: Array<string> }]\n  'kubb:hook:line': [ctx: { id: string; line: string }]\n  'kubb:hook:end': [\n    ctx: {\n      id?: string\n      command: string\n      args?: Array<string>\n      success: boolean\n      error?: { message: string; stack?: string }\n    },\n  ]\n}\n\n/**\n * Versioned envelope around one lifecycle event. Cap'n Web streams preserve the order the agent\n * emitted them in, so the receiver replays a run by reading the stream straight through.\n */\nexport type GenerationEvent = {\n  [Type in GenerationEventType]: { type: Type; data: GenerationEventPayloads[Type] }\n}[GenerationEventType] & {\n  version: 1\n  jobId: string\n  timestamp: number\n}\n\n/**\n * Asks the agent to run one generation. `jobId` tags every event the run emits so a caller\n * watching several runs can tell them apart.\n */\nexport type GenerateInput = { jobId: string; config: JSONKubbConfig }\n\n/**\n * What a finished run produced.\n */\nexport type GenerateResult = {\n  status: 'success' | 'failed'\n  /**\n   * Paths of the generated files, relative to the output directory.\n   */\n  files: Array<string>\n  fileCount: number\n  /**\n   * Content fingerprint per file in `files`, to tell changed files apart without reading them.\n   */\n  hashes: Record<string, string>\n  /**\n   * Fingerprints of the output directory on disk before the run, for an agent with a project on disk.\n   */\n  disk?: { hashes: Record<string, string> }\n}\n\n/**\n * Asks the agent to apply a batch of edits to the config file on disk.\n */\nexport type SaveConfigInput = { edits: Array<ConfigEdit> }\n\n/**\n * Per-edit outcomes. `changed` is false when every edit was a no-op, so a caller can skip reloading.\n */\nexport type SaveResult = { outcomes: Array<ConfigEditOutcome>; changed: boolean }\n\n/**\n * What a file read returns for a job: the files that job generated (`output`), or what the output\n * directory held on disk before that job ran (`disk`, only on an agent with a project on disk).\n */\nexport type FileSource = 'output' | 'disk'\n\n/**\n * Asks the agent to read files of one generation job back.\n */\nexport type ReadFilesInput = {\n  /**\n   * The job whose files to read, the only lookup key, so the caller decides whose jobs a reader may\n   * see. A job the agent no longer keeps fails with {@link GENERATION_GONE_MESSAGE}.\n   */\n  jobId: string\n  /**\n   * At most {@link MAX_FILES_PER_REQUEST} paths, each checked against what the job's set holds.\n   */\n  paths: Array<string>\n  /**\n   * Which of the job's sets to read, `output` when left out.\n   */\n  source?: FileSource\n  /**\n   * The line to start from (0-based), the `nextCursor` of the previous page. Defaults to 0.\n   */\n  cursor?: number\n  /**\n   * Lines to read per file, at most {@link MAX_PAGE_LINES}. Left out, the whole file.\n   */\n  limit?: number\n}\n\n/**\n * Where a paged read stands for one file: the cursor of the next page, `null` after the last one.\n */\nexport type FilePage = { nextCursor: number | null; totalLines: number }\n\n/**\n * What a file read returns. `pages` is set only for a paged read.\n */\nexport type ReadFilesResult = { files: Record<string, string>; pages?: Record<string, FilePage> }\n\n/**\n * The error a file read fails with once the agent no longer keeps the job's files.\n */\nexport const GENERATION_GONE_MESSAGE = 'The files of this generation are no longer kept on the agent, run the generation again'\n\n/**\n * A generation in flight. Cap'n Web keeps the three calls pointed at the same run, so a caller can\n * read `events()` while `result()` is still pending and `cancel()` stops it early.\n */\nexport type GenerationRun = {\n  events: () => Promise<ReadableStream<GenerationEvent>>\n  result: () => Promise<GenerateResult>\n  cancel: () => Promise<void>\n}\n\n/**\n * What Studio knows about the agent on the other end of a socket. Studio passes it with every\n * {@link AgentApi.connect} call, so it stays the authority on whether the agent is a sandbox.\n */\nexport type AgentConnectInfo = {\n  /**\n   * A shared `sandbox` or `global` agent. It keeps generations in memory, runs each job in a\n   * temporary root, generates from the spec Studio sends, and never writes to disk or edits config.\n   */\n  sandbox: boolean\n  agentSlug: string\n  /**\n   * Absent for a sandbox or global agent, which belongs to no organization.\n   */\n  organizationSlug?: string\n  studioVersion: string\n}\n\n/**\n * Operations Studio invokes on an agent over its socket.\n */\nexport type AgentApi = {\n  /**\n   * The first call on every socket, and again whenever Studio needs the current config.\n   */\n  connect: (info: AgentConnectInfo) => Promise<ConnectMessagePayload>\n  startGeneration: (input: GenerateInput) => GenerationRun\n  saveConfig: (input: SaveConfigInput) => Promise<SaveResult>\n  readFiles: (input: ReadFilesInput) => Promise<ReadFilesResult>\n}\n\n/**\n * Operations an agent invokes on Studio over its socket.\n */\nexport type StudioApi = {\n  /**\n   * Keeps the connection alive. A ping that does not settle in time makes the agent reconnect.\n   */\n  ping: () => Promise<void>\n}\n\n/**\n * Close codes Studio sends when it ends an agent socket on purpose. `UNAUTHORIZED` means the token\n * was refused, so pair again. `SUPERSEDED` and `INCOMPATIBLE` mean stop. Any other code, `1011`\n * included, is an ordinary drop and the agent reconnects.\n */\nexport const AgentCloseCode = {\n  UNAUTHORIZED: 4001,\n  SUPERSEDED: 4002,\n  INCOMPATIBLE: 4003,\n} as const\n\nexport const AGENT_SOCKET_PATH = '/api/agent/socket'\n\n/**\n * Optional header naming the process a socket belongs to, for agents that run several processes.\n */\nexport const AGENT_INSTANCE_HEADER = 'x-kubb-instance-id'\n\n/**\n * How many files a single `readFiles` request may ask for at once.\n */\nexport const MAX_FILES_PER_REQUEST = 50\n\n/** Most lines one page may ask for. */\nexport const MAX_PAGE_LINES = 2000\n\nexport const MAX_SNAPSHOT_BYTES = 50 * 1024 * 1024\n\n/**\n * Connection payload returned by {@link AgentApi.connect}. Carries only what Studio renders, with\n * everything about the config under one key.\n */\nexport type ConnectMessagePayload = {\n  /**\n   * Always sent, so a mismatch is visible on both sides: Studio badges the connection with these\n   * and the host prints them.\n   */\n  versions: {\n    /**\n     * The version of the `@kubb/studio` runtime the agent runs.\n     */\n    kubb: string\n    /**\n     * The version of the host itself (the `kubb.agent` package or the `kubb` CLI).\n     */\n    agent: string\n  }\n  /**\n   * The agent's project root. This is the workspace that generation runs against.\n   */\n  root: string\n  /**\n   * The baseline every generation starts from.\n   */\n  config: {\n    /**\n     * The config path as the host gave it, relative to `root` unless absolute.\n     */\n    path: string\n    /**\n     * What the agent read out of the config file itself, so Studio can render the plugin editor\n     * against the real file. Absent when the agent could not read it, or was not granted\n     * `allowConfigEdit`.\n     */\n    file?: ConfigFileView\n    /**\n     * Plugins the config registers, with a JSON copy of their options: anything JSON cannot hold,\n     * such as a function, is left out. A plugin defined in the project rather than installed as a\n     * `@kubb/plugin-*` package keeps its own `name`.\n     */\n    plugins?: Array<{\n      name: string\n      options?: object\n    }>\n    /**\n     * The adapter and the parsers the config registers, named like `plugins` and with the same JSON\n     * copy of their options, so Studio can render their manifest options.\n     */\n    adapter?: {\n      name: string\n      options?: object\n    }\n    parsers?: Array<{\n      name: string\n      options?: object\n    }>\n    /** Installed packages that ship a `kubb-extension.json`, including plugins the config does not use yet. */\n    extensions?: Array<ExtensionEntry>\n  }\n  permissions: AgentPermissions\n}\n\n/** An installed extension package and the manifest it ships. */\nexport type ExtensionEntry = { package: string; version: string; manifest: ExtensionManifest }\n\n/** Installed extension packages by package name, the only ones Studio may import besides `@kubb/plugin-*`. */\nexport type InstalledExtensions = ReadonlyMap<string, ExtensionEntry>\n\n/**\n * What an agent may do in the project it serves. Every one is off unless the host granted it, and\n * a sandbox narrows them further.\n */\nexport type AgentPermissions = {\n  /**\n   * Whether the agent writes generated files to disk. Always false for a sandbox.\n   */\n  allowWrite: boolean\n  /**\n   * Whether the agent runs the formatter, the linter, and `output.postGenerate` as child\n   * processes after a generation.\n   */\n  allowExec: boolean\n  /**\n   * Whether the agent may change plugin options in the user's `kubb.config.ts`. Separate from\n   * `allowWrite`, which covers generated output: this one edits a hand-authored source file.\n   */\n  allowConfigEdit: boolean\n  /**\n   * Whether the agent hands back file source in response to `readFiles`. Always true for a\n   * sandbox.\n   */\n  allowRead: boolean\n}\n\n/**\n * Metadata part of `POST /api/snapshots`. The `tarball` part carries the packed package.\n */\nexport type SnapshotUploadMetadata = {\n  /**\n   * Stable CI identity, such as `gh:<repoId>:<pr>`. Snapshots with the same `id` share one CI agent.\n   */\n  id: string\n  name: string\n  packageName: string\n  version: string\n  /**\n   * The commit the snapshot is built from, so the next one can name it as its base.\n   */\n  commit?: string\n  /**\n   * The `id` of another CI agent, such as the base branch's, to also compare with.\n   */\n  baseId?: string\n  /**\n   * Content fingerprint per generated file, keyed by path relative to the project root.\n   */\n  hashes: Record<string, string>\n  peerDependencies: Record<string, string>\n}\n\n/**\n * How a snapshot's files differ from an earlier snapshot of the same package.\n */\nexport type SnapshotChanges = {\n  /**\n   * The snapshot these changes are measured against, `null` when there is none to compare with.\n   */\n  base: { id: string; version: string | null; commit?: string; createdAt: string } | null\n  added: Array<string>\n  changed: Array<string>\n  removed: Array<string>\n}\n\n/**\n * {@link SnapshotChanges} against another CI agent. `baseFound` is `false` when Studio has no CI\n * agent with that id yet, and `true` when it has one without a snapshot of this package.\n */\nexport type BranchSnapshotChanges = SnapshotChanges & { baseFound: boolean }\n\n/**\n * Response body of `POST /api/snapshots`: `{ snapshot: PublishedSnapshot }`.\n */\nexport type PublishedSnapshot = {\n  id: string\n  name: string | null\n  version: string | null\n  integrity: string | null\n  agent: { id: string; name: string; slug: string | null }\n  /**\n   * Readable download path, often `/packages/{agentSlug}/{name}.tgz`.\n   */\n  url: string\n  snapshotIdUrl: string\n  createdAt: string\n  expiresAt: string\n  /**\n   * What changed since the previous snapshot of this package on the same CI agent.\n   */\n  changes?: SnapshotChanges\n  /**\n   * What differs from the latest snapshot of the CI agent `baseId` names. Absent without a base.\n   */\n  branchChanges?: BranchSnapshotChanges\n}\n"],"mappings":";;;;;AA8KA,MAAa,uBAAuB;CAClC;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACF;;;;AAqKA,MAAa,0BAA0B;;;;;;AA0DvC,MAAa,iBAAiB;CAC5B,cAAc;CACd,YAAY;CACZ,cAAc;AAChB;AAEA,MAAa,oBAAoB;;;;AAKjC,MAAa,wBAAwB;;;;AAKrC,MAAa,wBAAwB;;AAGrC,MAAa,iBAAiB;AAE9B,MAAa,qBAAqB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/studio",
-  "version": "5.9.0",
+  "version": "5.9.1",
   "description": "Kubb Studio client runtime. Connects a Kubb project to Kubb Studio over one WebSocket and publishes CI snapshots, shared by the `kubb studio` CLI command and the Docker agent.",
   "keywords": [
     "agent",
@@ -62,7 +62,7 @@
     "registry": "https://registry.npmjs.org/"
   },
   "dependencies": {
-    "@kubb/core": "5.9.0",
+    "@kubb/core": "5.9.1",
     "capnweb": "^0.12.0",
     "magicast": "^0.5.5",
     "ofetch": "^1.5.1",
@@ -70,8 +70,8 @@
   },
   "devDependencies": {
     "@internals/utils": "0.0.1",
-    "@kubb/adapter-oas": "5.9.0",
-    "@kubb/ast": "5.9.0"
+    "@kubb/adapter-oas": "5.9.1",
+    "@kubb/ast": "5.9.1"
   },
   "engines": {
     "node": ">=22"