@kubb/studio 5.12.8 → 5.13.1

package/dist/{protocol-C4loKcxw.d.cts → protocol-DQTwqmNO.d.ts}

@@ -1,70 +1,22 @@
 import { ExtensionKind, ExtensionManifest } from "@kubb/core";
 import { InputNode } from "@kubb/ast";
-//#region src/protocol.d.ts
-/**
- * JSON-serializable Kubb config exchanged over RPC. A live `kubb/kit` config holds
- * functions and class instances that cannot survive JSON, so both sides pass this flattened shape
- * and rebuild the real config from it.
- */
-type JSONKubbConfig = {
-  /**
-   * Plugins with their serialized options. `name` is the package name (e.g. `@kubb/plugin-ts`)
-   * and `options` is an opaque blob the agent forwards unchanged to the plugin factory. An entry
-   * with `disabled: true` is dropped even when the disk config's `plugins` array still lists it.
-   */
-  plugins?: Array<{
-    name: string;
-    options?: object;
-    disabled?: boolean;
-  }>;
-  /**
-   * Raw OpenAPI / Swagger spec content (YAML or JSON string), never a file path.
-   * Required by a 'sandbox' agent, which has no disk config of its own and refuses anything else.
-   * A 'managed' agent also takes a URL or a `git+<repo>#<ref>:<path>` input, and falls back to its disk config without one.
-   * Any other agent always reads its spec from disk, so this is ignored with a `kubb:warn`.
-   */
-  input?: string;
-  /**
-   * Adapter option overrides sent from Studio UI. Merged into the disk config's adapter options
-   * and re-applied through the same adapter factory, since an adapter instance's functions
-   * (`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;
-  }>;
-  /** Root `output` overrides for `barrel`, `format`, `lint`, `clean`, and `defaultBanner`. Other members are ignored. */
-  output?: object;
-  /**
-   * Which `defineConfig(...)` entry to generate from. Omitted runs the first one.
-   */
-  config?: ConfigRef;
-};
-/**
- * Which `defineConfig(...)` entry an edit targets, for a config file that exports an array.
- *
- * A number selects by position, a string matches the entry's `name`. Omitted targets the only
- * entry, or the first one when the file exports an array.
- */
+//#region ../../internals/shared/src/configFile/types.d.ts
+/** Which `defineConfig(...)` entry an edit targets: its index or `name`, the first entry when omitted. */
 type ConfigRef = string | number;
-/**
- * A value the agent can read out of a plugin option in `kubb.config.ts` and round-trip through JSON.
- */
+/** A literal option value that survives a JSON round trip. */
 type OptionValue = string | number | boolean | null | Array<OptionValue> | {
   [key: string]: OptionValue;
 };
-/**
- * The kinds of {@link ConfigEdit}, one per `operation`.
- */
+declare const extensionKinds: {
+  readonly plugin: 'plugin';
+  readonly adapter: 'adapter';
+  readonly parser: 'parser';
+};
 declare const ConfigEditOperation: {
-  readonly SET: 'set';
-  readonly REMOVE: 'remove';
+  readonly SET_OPTION: 'set-option';
+  readonly REMOVE_OPTION: 'remove-option';
   readonly ADD_PLUGIN: 'add-plugin';
+  readonly REMOVE_EXTENSION: 'remove-extension';
   readonly DISABLE_PLUGIN: 'disable-plugin';
   readonly ENABLE_PLUGIN: 'enable-plugin';
   readonly SET_INPUT: 'set-input';
@@ -73,177 +25,170 @@ declare const ConfigEditOperation: {
 };
 type ConfigEditOperation = (typeof ConfigEditOperation)[keyof typeof ConfigEditOperation];
 /**
- * One change to a plugin's options in the user's `kubb.config.ts`.
- *
- * `plugin` is the package name (`@kubb/plugin-ts`), the same identity used in {@link JSONKubbConfig}.
- * The agent applies these to the file with an AST patch, so only the targeted values are rewritten.
- *
- * Declared here rather than in `configFile.ts` because this is the wire contract, and the patcher
- * imports it from here. Type-only, so nothing pulls `magicast` into this entry point.
+ * One change to `kubb.config.ts`. `plugin` is the package name, and `kind` picks the `plugins` entry
+ * (default), the `adapter`, or a `parsers` entry. `path` walks nested option objects.
  */
-type ConfigEdit =
-/**
- * Write a literal option value. `path` walks nested objects, so `['enum', 'type']` targets
- * `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: typeof ConfigEditOperation.SET;
+type ConfigEdit = {
+  operation: typeof ConfigEditOperation.SET_OPTION;
   config?: ConfigRef;
   kind?: ExtensionKind;
   plugin: string;
   path: Array<string>;
   value: unknown;
-} |
-/**
- * Drop an option so the extension falls back to its default. `kind` as for `set`.
- */
-{
-  operation: typeof ConfigEditOperation.REMOVE;
+} | {
+  operation: typeof ConfigEditOperation.REMOVE_OPTION;
   config?: ConfigRef;
   kind?: ExtensionKind;
   plugin: string;
   path: Array<string>;
 } |
-/**
- * Add a plugin factory call and its import to the `plugins` array.
- */
+/** With `kind: 'parser'`, adds to `parsers`. A config without `parsers` gets the defaults written next to it, so they keep running. */
 {
   operation: typeof ConfigEditOperation.ADD_PLUGIN;
   config?: ConfigRef;
+  kind?: typeof extensionKinds.plugin | typeof extensionKinds.parser;
   plugin: string;
   options?: Record<string, unknown>;
 } |
-/**
- * Comment the plugin call out, keeping its options in the file so enabling it again restores them.
- */
+/** Deletes every call of a plugin, or a parser with `kind: 'parser'`, a disabled block included, and the imports nothing else uses. */
 {
+  operation: typeof ConfigEditOperation.REMOVE_EXTENSION;
+  config?: ConfigRef;
+  kind?: typeof extensionKinds.plugin | typeof extensionKinds.parser;
+  plugin: string;
+} | {
   operation: typeof ConfigEditOperation.DISABLE_PLUGIN;
   config?: ConfigRef;
   plugin: string;
-} |
-/**
- * Uncomment a plugin call a previous `disable-plugin` commented out.
- */
-{
+} | {
   operation: typeof ConfigEditOperation.ENABLE_PLUGIN;
   config?: ConfigRef;
   plugin: string;
-} |
-/**
- * Point the config's `input` at a spec. The agent writes a document to `openapi.yaml` (or
- * `openapi.json`, and `openapi-<entry>` for a later entry) in its project and points `input` there.
- * Refused without `allowSaveInput`, and a managed agent takes only a document, a URL, or a `git+` file.
- */
-{
+} | {
   operation: typeof ConfigEditOperation.SET_INPUT;
   config?: ConfigRef;
   input: string;
-} |
-/** Write a literal inside the root `output` object, for the members `JSONKubbConfig.output` takes. */
-{
+} | {
   operation: typeof ConfigEditOperation.SET_OUTPUT;
   config?: ConfigRef;
   path: Array<string>;
   value: unknown;
-} |
-/** Drop a member of the root `output` object that `set-output` may write. */
-{
+} | {
   operation: typeof ConfigEditOperation.REMOVE_OUTPUT;
   config?: ConfigRef;
   path: Array<string>;
 };
-/** The top-level keys of an object in the config file, as {@link PluginView.options} describes. */
+/** Option keys, each with whether Studio may write it. `locked` lists the code paths inside a partly literal object. */
 type OptionsView = Record<string, {
   literal: boolean;
   value?: OptionValue;
   locked?: Array<Array<string>>;
 }>;
-/**
- * A factory call the agent found in a `defineConfig(...)`: a plugin in `plugins`, the `adapter`, or
- * a parser in `parsers`.
- */
+/** A factory call in `plugins`, `adapter`, or `parsers`. `importName` is the local name, alias included. */
 type PluginView = {
-  /**
-   * Local identifier of the factory in the file, e.g. `pluginTs`. This is the alias when the plugin
-   * was imported under one.
-   */
   importName: string;
-  /**
-   * Module the factory is imported from, e.g. `@kubb/plugin-ts`.
-   */
   packageName: string;
-  /**
-   * Top-level option keys, each flagged with whether the agent may write it and, when it can, the
-   * value found in the file. An option marked `literal: false` holds a function or a reference the
-   * agent will not overwrite, so Studio shows the control disabled rather than hiding it, and
-   * `value` is absent since there is nothing safe to display as the current value.
-   *
-   * An object option that holds code in only some members, such as
-   * `output: { path: './gen', banner: () => '' }`, also carries `value` with its literal members
-   * and `locked` with the paths of the members that are code, relative to the option
-   * (`[['banner']]`). A `set` at any deeper path outside `locked` succeeds, so Studio can edit
-   * `output.path` there.
-   */
   options: OptionsView;
-  /**
-   * Set when the plugin call is commented out in the file. Its options stay on disk but are not
-   * readable, so `options` is empty until it is enabled again.
-   */
+  /** The call is commented out by `disable-plugin`. */
   disabled?: true;
 };
-/**
- * One `defineConfig(...)` entry. A config file that exports a single object has exactly one.
- */
 type ConfigView = {
-  /**
-   * The entry's `name`, when it sets one. Studio labels the config picker with it.
-   */
   name?: string;
-  /**
-   * 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>;
-  /** The root `output` members Studio may set. Absent when `output` is not an object literal. */
+  /** The root `output` members Studio may set, absent when `output` is not an object literal. */
   output?: OptionsView;
 };
-/**
- * What the agent found in the user's config file, so Studio knows which controls it may offer.
- * Absent when the agent could not read the file at all.
- */
+/** The config file as Studio may edit it, or why it cannot. */
 type ConfigFileView = {
   managed: true;
-  /**
-   * One entry per config the file exports, in source order. Every {@link ConfigEdit} names
-   * which of these it targets through its `config` field.
-   */
   configs: Array<ConfigView>;
 } | {
   managed: false;
-  /**
-   * Why the file is outside what the agent edits, for example a default export that is not a
-   * `defineConfig(...)` call. Studio shows this and offers no property-level controls.
-   */
   reason: string;
 };
-/**
- * Outcome of a single {@link ConfigEdit}, returned in a {@link SaveResult}.
- */
 type ConfigEditOutcome = {
   edit: ConfigEdit;
   applied: boolean;
+  reason?: string;
+};
+type ExtensionEntry = {
+  package: string;
+  version: string;
+  manifest: ExtensionManifest;
+  /** Ships with `kubb` at its version, so updating `kubb` updates it and `kubb update` cannot. */
+  bundled?: true;
+};
+/** Installed extensions by package name, the only ones Studio may import besides `@kubb/plugin-*`. */
+type InstalledExtensions = ReadonlyMap<string, ExtensionEntry>;
+//#endregion
+//#region ../../internals/shared/src/configFile/configFile.d.ts
+/** Applies edits in place, touching only the text each targets. A refused edit is reported and the rest still run. */
+declare function editConfig({ source, edits, extensions }: {
+  source: string;
+  edits: Array<ConfigEdit>;
+  extensions?: InstalledExtensions;
+}): {
+  source: string;
+  outcomes: Array<ConfigEditOutcome>;
+  changed: boolean;
+};
+/** Applies `edits` to `filePath`, writing only when something changed. */
+declare function editConfigFile({ filePath, edits, extensions }: {
+  filePath: string;
+  edits: Array<ConfigEdit>;
+  extensions?: InstalledExtensions;
+}): Promise<{
+  source: string;
+  outcomes: Array<ConfigEditOutcome>;
+  changed: boolean;
+}>;
+//#endregion
+//#region src/protocol.d.ts
+/**
+ * JSON-serializable Kubb config exchanged over RPC. A live `kubb/kit` config holds
+ * functions and class instances that cannot survive JSON, so both sides pass this flattened shape
+ * and rebuild the real config from it.
+ */
+type JSONKubbConfig = {
   /**
-   * Why the edit was refused, absent when it was applied.
+   * Plugins with their serialized options. `name` is the package name (e.g. `@kubb/plugin-ts`)
+   * and `options` is an opaque blob the agent forwards unchanged to the plugin factory. An entry
+   * with `disabled: true` is dropped even when the disk config's `plugins` array still lists it.
    */
-  reason?: string;
+  plugins?: Array<{
+    name: string;
+    options?: object;
+    disabled?: boolean;
+  }>;
+  /**
+   * Raw OpenAPI / Swagger spec content (YAML or JSON string), never a file path.
+   * Required by a 'sandbox' agent, which has no disk config of its own and refuses anything else.
+   * A 'managed' agent also takes a URL or a `git+<repo>#<ref>:<path>` input, and falls back to its disk config without one.
+   * Any other agent always reads its spec from disk, so this is ignored with a `kubb:warn`.
+   */
+  input?: string;
+  /**
+   * Adapter option overrides sent from Studio UI. Merged into the disk config's adapter options
+   * and re-applied through the same adapter factory, since an adapter instance's functions
+   * (`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;
+  }>;
+  /** Root `output` overrides for `barrel`, `format`, `lint`, `clean`, and `defaultBanner`. Other members are ignored. */
+  output?: object;
+  /**
+   * Which `defineConfig(...)` entry to generate from. Omitted runs the first one.
+   */
+  config?: ConfigRef;
 };
 /**
  * The public, JSON-safe subset of Kubb lifecycle hooks. The core registry remains extensible;
@@ -455,6 +400,16 @@ type UpdateExtensionsResult = {
   updated: boolean;
   reason?: string;
 };
+/** Asks the agent to run `kubb remove <id> --yes`. `requestedBy` as for {@link GenerateInput}. */
+type RemoveExtensionInput = {
+  id: string;
+  requestedBy?: string;
+};
+/** `removed` is false when the agent refused or `kubb remove` failed, with `reason` saying why. */
+type RemoveExtensionResult = {
+  removed: boolean;
+  reason?: string;
+};
 /**
  * Reads an immutable output set kept on disk, from a generation or the initial connection.
  */
@@ -613,6 +568,8 @@ type AgentApi = {
   installExtension: (input: InstallExtensionInput) => Promise<InstallExtensionResult>;
   /** Refused without `allowUpdate`. Installs packages only, so `kubb.config.ts` stays as it is. */
   updateExtensions: (input: UpdateExtensionsInput) => Promise<UpdateExtensionsResult>;
+  /** Refused without `allowRemove` and `allowConfigEdit`. An agent from before `removeExtension` rejects the call. */
+  removeExtension: (input: RemoveExtensionInput) => Promise<RemoveExtensionResult>;
   readFiles: (input: ReadFilesInput) => Promise<ReadFilesResult>;
   /**
    * Refused unless the agent was granted `allowRead`, like {@link AgentApi.readFiles}.
@@ -733,14 +690,6 @@ type ConfigEntryView = {
     options?: object;
   }>;
 };
-/** An installed extension package and the manifest it ships. */
-type ExtensionEntry = {
-  package: string;
-  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.
@@ -764,6 +713,8 @@ type AgentPermissions = {
   allowInstall: boolean;
   /** Whether the agent may run `kubb update` in the project, which installs newer extension versions and leaves `kubb.config.ts` alone. */
   allowUpdate: boolean;
+  /** Whether the agent may run `kubb remove` in the project, which edits `kubb.config.ts` and uninstalls packages. Needs `allowConfigEdit` as well. */
+  allowRemove: boolean;
   /** Whether the agent may keep the spec Studio sends: a document in `openapi.yaml` and `input` in `kubb.config.ts`. Needs `allowConfigEdit` as well. */
   allowSaveInput: boolean;
   /**
@@ -787,6 +738,7 @@ declare const AgentPermission: {
   readonly CONFIG_EDIT: 'allowConfigEdit';
   readonly INSTALL: 'allowInstall';
   readonly UPDATE: 'allowUpdate';
+  readonly REMOVE: 'allowRemove';
   readonly SAVE_INPUT: 'allowSaveInput';
   readonly EXEC: 'allowExec';
 };
@@ -879,5 +831,5 @@ type PublishedSnapshot = {
   branchChanges?: BranchSnapshotChanges;
 };
 //#endregion
-export { generationEventTypes as $, InstallExtensionResult as A, ReadDiffInput as B, GenerateInput as C, GenerationEventType as D, GenerationEventPayloads as E, MAX_SNAPSHOT_BYTES as F, ReadInputResult as G, ReadFilesInput as H, OptionValue as I, SnapshotChanges as J, SaveConfigInput as K, OptionsView as L, JSONKubbConfig as M, MAX_FILES_PER_REQUEST as N, GenerationRun as O, MAX_PAGE_LINES as P, UpdateExtensionsResult as Q, PluginView as R, FilePage as S, GenerationEvent as T, ReadFilesResult as U, ReadDiffResult as V, ReadInputInput as W, StudioApi as X, SnapshotUploadMetadata as Y, UpdateExtensionsInput as Z, ConnectMessagePayload as _, AgentConnectInfo as a, DiskOutput as b, AgentPermissions as c, ConfigEditOperation as d, ConfigEditOutcome as f, ConfigView as g, ConfigRef as h, AgentCloseCode as i, InstalledExtensions as j, InstallExtensionInput as k, BranchSnapshotChanges as l, ConfigFileView as m, AGENT_SOCKET_PATH as n, AgentMessage as o, ConfigEntryView as p, SaveResult as q, AgentApi as r, AgentPermission as s, AGENT_INSTANCE_HEADER as t, ConfigEdit as u, DiffHunk as v, GenerateResult as w, ExtensionEntry as x, DiffStats as y, PublishedSnapshot as z };
-//# sourceMappingURL=protocol-C4loKcxw.d.cts.map
+export { ExtensionEntry as $, ReadDiffResult as A, SnapshotUploadMetadata as B, InstallExtensionResult as C, MAX_SNAPSHOT_BYTES as D, MAX_PAGE_LINES as E, RemoveExtensionInput as F, editConfig as G, UpdateExtensionsInput as H, RemoveExtensionResult as I, ConfigEditOperation as J, editConfigFile as K, SaveConfigInput as L, ReadFilesResult as M, ReadInputInput as N, PublishedSnapshot as O, ReadInputResult as P, ConfigView as Q, SaveResult as R, InstallExtensionInput as S, MAX_FILES_PER_REQUEST as T, UpdateExtensionsResult as U, StudioApi as V, generationEventTypes as W, ConfigFileView as X, ConfigEditOutcome as Y, ConfigRef as Z, GenerateResult as _, AgentConnectInfo as a, GenerationEventType as b, AgentPermissions as c, ConnectMessagePayload as d, InstalledExtensions as et, DiffHunk as f, GenerateInput as g, FilePage as h, AgentCloseCode as i, ReadFilesInput as j, ReadDiffInput as k, BranchSnapshotChanges as l, DiskOutput as m, AGENT_SOCKET_PATH as n, OptionsView as nt, AgentMessage as o, DiffStats as p, ConfigEdit as q, AgentApi as r, PluginView as rt, AgentPermission as s, AGENT_INSTANCE_HEADER as t, OptionValue as tt, ConfigEntryView as u, GenerationEvent as v, JSONKubbConfig as w, GenerationRun as x, GenerationEventPayloads as y, SnapshotChanges as z };
+//# sourceMappingURL=protocol-DQTwqmNO.d.ts.map

package/dist/protocol-DQnAN8NE.js

@@ -0,0 +1,118 @@
+//#region ../../internals/shared/src/configFile/types.ts
+const extensionKinds = {
+	plugin: "plugin",
+	adapter: "adapter",
+	parser: "parser"
+};
+const ConfigEditOperation = {
+	SET_OPTION: "set-option",
+	REMOVE_OPTION: "remove-option",
+	ADD_PLUGIN: "add-plugin",
+	REMOVE_EXTENSION: "remove-extension",
+	DISABLE_PLUGIN: "disable-plugin",
+	ENABLE_PLUGIN: "enable-plugin",
+	SET_INPUT: "set-input",
+	SET_OUTPUT: "set-output",
+	REMOVE_OUTPUT: "remove-output"
+};
+//#endregion
+//#region src/protocol.ts
+/**
+* The public, JSON-safe subset of Kubb lifecycle hooks. The core registry remains extensible;
+* adding a core hook does not publish it to Studio until it is listed here and projected below.
+*/
+const generationEventTypes = [
+	"kubb:plugin:start",
+	"kubb:plugin:end",
+	"kubb:build:start",
+	"kubb:build:end",
+	"kubb:files:processing:start",
+	"kubb:files:processing:update",
+	"kubb:files:processing:end",
+	"kubb:info",
+	"kubb:success",
+	"kubb:warn",
+	"kubb:error",
+	"kubb:diagnostic",
+	"kubb:generation:start",
+	"kubb:generation:end",
+	"kubb:generation:summary",
+	"kubb:lifecycle:start",
+	"kubb:lifecycle:end",
+	"kubb:format:start",
+	"kubb:format:end",
+	"kubb:lint:start",
+	"kubb:lint:end",
+	"kubb:hooks:start",
+	"kubb:hooks:end",
+	"kubb:hook:start",
+	"kubb:hook:line",
+	"kubb:hook:end"
+];
+/**
+* Why the agent refuses a request. Studio matches on these to answer with the right status.
+*/
+const AgentMessage = {
+	GENERATION_IN_PROGRESS: "A generation is already in progress, please wait for it to finish",
+	INSTALL_IN_PROGRESS: "An extension install or update is running, please wait for it to finish",
+	SAVE_IN_PROGRESS: "The config is being saved, please wait for it to finish",
+	SANDBOX_INPUT_ONLY: "A sandbox agent generates only from the OpenAPI document content Studio sends, not from a file path or URL",
+	MANAGED_INPUT_KIND: "A managed agent generates from the OpenAPI document content, a URL, or a git file that Studio sends, not from a file path",
+	CONFIG_ENTRY_NOT_FOUND: "The config file has no entry at that position or with that name",
+	JOB_REQUIRED: "The request must name a job",
+	FILE_REQUEST_INVALID: "The request must name an output set and carry paths",
+	TOO_MANY_FILES: "Too many paths were requested at once",
+	INVALID_PAGE: "The requested file page is invalid",
+	DIFF_REQUEST_INVALID: "The request must name a job, a base, and a path",
+	HASHES_ONLY: "This agent kept only the hashes of that job",
+	/**
+	* A read for a job whose files the agent no longer keeps.
+	*/
+	GENERATION_GONE: "The files of this generation are no longer kept on the agent, run the generation again",
+	READ_NOT_ALLOWED: "The agent was not granted permission to read generated files",
+	/**
+	* Reading the parsed spec is its own permission.
+	*/
+	READ_AST_NOT_ALLOWED: "The agent was not granted permission to read the parsed spec",
+	NO_INPUT: "This job kept no API input"
+};
+/**
+* Close codes Studio sends when it ends an agent socket on purpose. `UNAUTHORIZED` means the token
+* was refused, so pair again. `SUPERSEDED` and `INCOMPATIBLE` mean stop. Any other code, `1011`
+* included, is an ordinary drop and the agent reconnects.
+*/
+const AgentCloseCode = {
+	UNAUTHORIZED: 4001,
+	SUPERSEDED: 4002,
+	INCOMPATIBLE: 4003
+};
+const AGENT_SOCKET_PATH = "/api/agent/socket";
+/**
+* Optional header naming the process a socket belongs to, for agents that run several processes.
+*/
+const AGENT_INSTANCE_HEADER = "x-kubb-instance-id";
+/**
+* How many files a single `readFiles` request may ask for at once.
+*/
+const MAX_FILES_PER_REQUEST = 50;
+/** Most lines one page may ask for. */
+const MAX_PAGE_LINES = 2e3;
+const MAX_SNAPSHOT_BYTES = 52428800;
+/**
+* The keys of {@link AgentPermissions}, such as the permission a refused request names.
+*/
+const AgentPermission = {
+	READ: "allowRead",
+	READ_AST: "allowReadAst",
+	WRITE: "allowWrite",
+	CONFIG_EDIT: "allowConfigEdit",
+	INSTALL: "allowInstall",
+	UPDATE: "allowUpdate",
+	REMOVE: "allowRemove",
+	SAVE_INPUT: "allowSaveInput",
+	EXEC: "allowExec"
+};
+//#endregion
+export { AgentPermission as a, MAX_SNAPSHOT_BYTES as c, extensionKinds as d, AgentMessage as i, generationEventTypes as l, AGENT_SOCKET_PATH as n, MAX_FILES_PER_REQUEST as o, AgentCloseCode as r, MAX_PAGE_LINES as s, AGENT_INSTANCE_HEADER as t, ConfigEditOperation as u };
+
+//# sourceMappingURL=protocol-DQnAN8NE.js.map

package/dist/protocol-DQnAN8NE.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"protocol-DQnAN8NE.js","names":[],"sources":["../../../internals/shared/src/configFile/types.ts","../src/protocol.ts"],"sourcesContent":["import type { ExtensionKind, ExtensionManifest } from '@kubb/core'\n\n/** Which `defineConfig(...)` entry an edit targets: its index or `name`, the first entry when omitted. */\nexport type ConfigRef = string | number\n\n/** A literal option value that survives a JSON round trip. */\nexport type OptionValue = string | number | boolean | null | Array<OptionValue> | { [key: string]: OptionValue }\n\nexport const extensionKinds = { plugin: 'plugin', adapter: 'adapter', parser: 'parser' } as const satisfies Record<string, ExtensionKind>\n\nexport const ConfigEditOperation = {\n  SET_OPTION: 'set-option',\n  REMOVE_OPTION: 'remove-option',\n  ADD_PLUGIN: 'add-plugin',\n  REMOVE_EXTENSION: 'remove-extension',\n  DISABLE_PLUGIN: 'disable-plugin',\n  ENABLE_PLUGIN: 'enable-plugin',\n  SET_INPUT: 'set-input',\n  SET_OUTPUT: 'set-output',\n  REMOVE_OUTPUT: 'remove-output',\n} as const\nexport type ConfigEditOperation = (typeof ConfigEditOperation)[keyof typeof ConfigEditOperation]\n\n/**\n * One change to `kubb.config.ts`. `plugin` is the package name, and `kind` picks the `plugins` entry\n * (default), the `adapter`, or a `parsers` entry. `path` walks nested option objects.\n */\nexport type ConfigEdit =\n  | { operation: typeof ConfigEditOperation.SET_OPTION; config?: ConfigRef; kind?: ExtensionKind; plugin: string; path: Array<string>; value: unknown }\n  | { operation: typeof ConfigEditOperation.REMOVE_OPTION; config?: ConfigRef; kind?: ExtensionKind; plugin: string; path: Array<string> }\n  /** With `kind: 'parser'`, adds to `parsers`. A config without `parsers` gets the defaults written next to it, so they keep running. */\n  | {\n      operation: typeof ConfigEditOperation.ADD_PLUGIN\n      config?: ConfigRef\n      kind?: typeof extensionKinds.plugin | typeof extensionKinds.parser\n      plugin: string\n      options?: Record<string, unknown>\n    }\n  /** Deletes every call of a plugin, or a parser with `kind: 'parser'`, a disabled block included, and the imports nothing else uses. */\n  | {\n      operation: typeof ConfigEditOperation.REMOVE_EXTENSION\n      config?: ConfigRef\n      kind?: typeof extensionKinds.plugin | typeof extensionKinds.parser\n      plugin: string\n    }\n  | { operation: typeof ConfigEditOperation.DISABLE_PLUGIN; config?: ConfigRef; plugin: string }\n  | { operation: typeof ConfigEditOperation.ENABLE_PLUGIN; config?: ConfigRef; plugin: string }\n  | { operation: typeof ConfigEditOperation.SET_INPUT; config?: ConfigRef; input: string }\n  | { operation: typeof ConfigEditOperation.SET_OUTPUT; config?: ConfigRef; path: Array<string>; value: unknown }\n  | { operation: typeof ConfigEditOperation.REMOVE_OUTPUT; config?: ConfigRef; path: Array<string> }\n\n/** Option keys, each with whether Studio may write it. `locked` lists the code paths inside a partly literal object. */\nexport type OptionsView = Record<string, { literal: boolean; value?: OptionValue; locked?: Array<Array<string>> }>\n\n/** A factory call in `plugins`, `adapter`, or `parsers`. `importName` is the local name, alias included. */\nexport type PluginView = {\n  importName: string\n  packageName: string\n  options: OptionsView\n  /** The call is commented out by `disable-plugin`. */\n  disabled?: true\n}\n\nexport type ConfigView = {\n  name?: string\n  plugins: Array<PluginView>\n  adapter?: PluginView\n  parsers?: Array<PluginView>\n  /** The root `output` members Studio may set, absent when `output` is not an object literal. */\n  output?: OptionsView\n}\n\n/** The config file as Studio may edit it, or why it cannot. */\nexport type ConfigFileView = { managed: true; configs: Array<ConfigView> } | { managed: false; reason: string }\n\nexport type ConfigEditOutcome = {\n  edit: ConfigEdit\n  applied: boolean\n  reason?: string\n}\n\nexport type ExtensionEntry = {\n  package: string\n  version: string\n  manifest: ExtensionManifest\n  /** Ships with `kubb` at its version, so updating `kubb` updates it and `kubb update` cannot. */\n  bundled?: true\n}\n\n/** Installed extensions by package name, the only ones Studio may import besides `@kubb/plugin-*`. */\nexport type InstalledExtensions = ReadonlyMap<string, ExtensionEntry>\n","import type { InputNode } from '@kubb/ast'\nimport type { KubbHooks } from '@kubb/core'\nimport type { ConfigEdit, ConfigEditOutcome, ConfigFileView, ConfigRef, ExtensionEntry } from '@internals/shared'\n\nexport {\n  ConfigEditOperation,\n  type ConfigEdit,\n  type ConfigEditOutcome,\n  type ConfigFileView,\n  type ConfigRef,\n  type ConfigView,\n  type ExtensionEntry,\n  type InstalledExtensions,\n  type OptionsView,\n  type OptionValue,\n  type PluginView,\n} from '@internals/shared'\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.\n   * Required by a 'sandbox' agent, which has no disk config of its own and refuses anything else.\n   * A 'managed' agent also takes a URL or a `git+<repo>#<ref>:<path>` input, and falls back to its disk config without one.\n   * Any other 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  /** Root `output` overrides for `barrel`, `format`, `lint`, `clean`, and `defaultBanner`. Other members are ignored. */\n  output?: object\n  /**\n   * Which `defineConfig(...)` entry to generate from. Omitted runs the first one.\n   */\n  config?: ConfigRef\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. `requestedBy` names the Studio user in the agent's\n * command log, and Studio leaves it out for a shared agent.\n */\nexport type GenerateInput = {\n  jobId: string\n  config: JSONKubbConfig\n  /**\n   * Display name of the Studio user who asked for the run, shown in the agent's job log.\n   */\n  requestedBy?: string\n  /**\n   * A short-lived `Authorization` header value that a managed agent sends with the git fetch of a `git+` input, to its origin only.\n   */\n  gitAuth?: { authorization: string }\n}\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\n/**\n * Asks the agent to apply a batch of edits to the config file on disk. `requestedBy` as for {@link GenerateInput}.\n */\nexport type SaveConfigInput = {\n  edits: Array<ConfigEdit>\n  /**\n   * Display name of the Studio user who asked for the save, shown in the agent's job log.\n   */\n  requestedBy?: string\n}\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/** Asks the agent to run `kubb add <id>`: `owner/slug`, or a bare `slug` for an official extension. `requestedBy` as for {@link GenerateInput}. */\nexport type InstallExtensionInput = { id: string; requestedBy?: string }\n\n/** `installed` is false when the agent refused or `kubb add` failed, with `reason` saying why. */\nexport type InstallExtensionResult = { installed: boolean; reason?: string }\n\n/** Asks the agent to run `kubb update [ids] --yes`. Empty `ids` updates every installed extension the registry lists. */\nexport type UpdateExtensionsInput = { ids?: Array<string>; requestedBy?: string }\n\n/** `updated` is false when the agent refused or `kubb update` failed, with `reason` saying why. */\nexport type UpdateExtensionsResult = { updated: boolean; reason?: string }\n\n/** Asks the agent to run `kubb remove <id> --yes`. `requestedBy` as for {@link GenerateInput}. */\nexport type RemoveExtensionInput = { id: string; requestedBy?: string }\n\n/** `removed` is false when the agent refused or `kubb remove` failed, with `reason` saying why. */\nexport type RemoveExtensionResult = { removed: boolean; reason?: string }\n\n/**\n * Reads an immutable output set kept on disk, from a generation or the initial connection.\n */\nexport type ReadFilesInput = {\n  jobId: string\n  paths: Array<string>\n  cursor?: number\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 * Asks for one page of a file's line diff between two kept sets, so a large file never leaves the agent whole.\n * `jobId`'s `output` is the newer side, `base` the older one. `cursor` and `limit` page the patch lines.\n */\nexport type ReadDiffInput = { jobId: string; path: string; base: { jobId: string }; cursor?: number; limit: number }\n\n/**\n * One hunk of a diff page, with its `@@` header. Pages hold whole hunks, and only a hunk longer than a page is\n * split: its parts keep `index` and the header.\n */\nexport type DiffHunk = { index: number; oldStart: number; oldLines: number; newStart: number; newLines: number; lines: Array<string> }\n\n/**\n * The size of the whole diff, sent with every page, so a viewer can summarize it before reading every page.\n */\nexport type DiffStats = {\n  additions: number\n  deletions: number\n  hunks: number\n  /**\n   * Patch lines in all hunks, the range `cursor` pages through.\n   */\n  lines: number\n  /**\n   * True when part of the diff ran out of time and shows as one block that replaces those lines.\n   */\n  coarse: boolean\n}\n\n/**\n * One page of a diff. `hasBase` is false, and the page empty, when the base set does not hold the path.\n */\nexport type ReadDiffResult = { hunks: Array<DiffHunk>; nextCursor: number | null; hasBase: boolean; stats: DiffStats }\n\n/**\n * Asks for the Kubb AST one job parsed its spec into. A job the agent no longer keeps fails with {@link AgentMessage.GENERATION_GONE}.\n */\nexport type ReadInputInput = { jobId: string }\n\n/**\n * The job's `InputNode`, as JSON. A ref schema names its target, which `input.schemas` holds, without a copy.\n */\nexport type ReadInputResult = { input: InputNode }\n\n/**\n * Why the agent refuses a request. Studio matches on these to answer with the right status.\n */\nexport const AgentMessage = {\n  GENERATION_IN_PROGRESS: 'A generation is already in progress, please wait for it to finish',\n  INSTALL_IN_PROGRESS: 'An extension install or update is running, please wait for it to finish',\n  SAVE_IN_PROGRESS: 'The config is being saved, please wait for it to finish',\n  SANDBOX_INPUT_ONLY: 'A sandbox agent generates only from the OpenAPI document content Studio sends, not from a file path or URL',\n  MANAGED_INPUT_KIND: 'A managed agent generates from the OpenAPI document content, a URL, or a git file that Studio sends, not from a file path',\n  CONFIG_ENTRY_NOT_FOUND: 'The config file has no entry at that position or with that name',\n  JOB_REQUIRED: 'The request must name a job',\n  FILE_REQUEST_INVALID: 'The request must name an output set and carry paths',\n  TOO_MANY_FILES: 'Too many paths were requested at once',\n  INVALID_PAGE: 'The requested file page is invalid',\n  DIFF_REQUEST_INVALID: 'The request must name a job, a base, and a path',\n  HASHES_ONLY: 'This agent kept only the hashes of that job',\n  /**\n   * A read for a job whose files the agent no longer keeps.\n   */\n  GENERATION_GONE: 'The files of this generation are no longer kept on the agent, run the generation again',\n  READ_NOT_ALLOWED: 'The agent was not granted permission to read generated files',\n  /**\n   * Reading the parsed spec is its own permission.\n   */\n  READ_AST_NOT_ALLOWED: 'The agent was not granted permission to read the parsed spec',\n  NO_INPUT: 'This job kept no API input',\n} as const\nexport type AgentMessage = (typeof AgentMessage)[keyof typeof AgentMessage]\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 on temporary disk, runs each job in a\n   * temporary root, and generates from the spec Studio sends without editing a project or its config.\n   */\n  sandbox: boolean\n  /**\n   * A `managed` agent Studio hosts for the organization. It has no project spec on disk, so it\n   * may generate from a spec Studio sends: the content, a URL, or a git file.\n   */\n  managed?: 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  /** Refused without `allowInstall` and `allowConfigEdit`. An agent from before `installExtension` rejects the call. */\n  installExtension: (input: InstallExtensionInput) => Promise<InstallExtensionResult>\n  /** Refused without `allowUpdate`. Installs packages only, so `kubb.config.ts` stays as it is. */\n  updateExtensions: (input: UpdateExtensionsInput) => Promise<UpdateExtensionsResult>\n  /** Refused without `allowRemove` and `allowConfigEdit`. An agent from before `removeExtension` rejects the call. */\n  removeExtension: (input: RemoveExtensionInput) => Promise<RemoveExtensionResult>\n  readFiles: (input: ReadFilesInput) => Promise<ReadFilesResult>\n  /**\n   * Refused unless the agent was granted `allowRead`, like {@link AgentApi.readFiles}.\n   */\n  readInput: (input: ReadInputInput) => Promise<ReadInputResult>\n  /**\n   * Refused unless the agent was granted `allowRead`, like {@link AgentApi.readFiles}.\n   */\n  readDiff: (input: ReadDiffInput) => Promise<ReadDiffResult>\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    /** Installed packages that ship a `kubb-extension.json`, including plugins the config does not use yet. */\n    extensions?: Array<ExtensionEntry>\n    /** Every entry the config exports, in source order. */\n    configs: Array<ConfigEntryView>\n  }\n  permissions: AgentPermissions\n}\n\nexport type DiskOutput = {\n  jobId: string\n  files: Array<string>\n  hashes: Record<string, string>\n}\n\n/**\n * One `defineConfig(...)` entry as the agent runs it. Every option is a JSON copy: anything JSON cannot\n * hold, such as a function, is left out. A plugin defined in the project keeps its own `name`.\n */\nexport type ConfigEntryView = {\n  name?: string\n  /** The input file path or URL, without credentials. Omitted for an inline or parsed document. */\n  input?: string\n  /** The output directory as the entry gives it, relative to the project root unless absolute. */\n  output: string\n  /** The root `output` members Studio may set, as a JSON copy. */\n  outputOptions?: object\n  /**\n   * The output directory's current file list, readable through `readFiles` without generating.\n   * Absent for a sandbox or when the host has not granted `allowRead`.\n   */\n  disk?: DiskOutput\n  plugins: Array<{\n    name: string\n    options?: object\n  }>\n  adapter?: {\n    name: string\n    options?: object\n  }\n  parsers: Array<{\n    name: string\n    options?: object\n  }>\n}\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  /** Whether the agent may run `kubb add` in the project, which also edits `kubb.config.ts`. Needs `allowConfigEdit` as well. */\n  allowInstall: boolean\n  /** Whether the agent may run `kubb update` in the project, which installs newer extension versions and leaves `kubb.config.ts` alone. */\n  allowUpdate: boolean\n  /** Whether the agent may run `kubb remove` in the project, which edits `kubb.config.ts` and uninstalls packages. Needs `allowConfigEdit` as well. */\n  allowRemove: boolean\n  /** Whether the agent may keep the spec Studio sends: a document in `openapi.yaml` and `input` in `kubb.config.ts`. Needs `allowConfigEdit` as well. */\n  allowSaveInput: boolean\n  /**\n   * Whether the agent shares existing output on connect and hands back file source through\n   * `readFiles`. A sandbox always permits reads of its generated files.\n   */\n  allowRead: boolean\n  /**\n   * Whether the agent hands back the parsed spec (the Kubb AST) in response to `readInput`.\n   * Separate from `allowRead`, which covers generated files. Always true for a sandbox.\n   */\n  allowReadAst: boolean\n}\n\n/**\n * The keys of {@link AgentPermissions}, such as the permission a refused request names.\n */\nexport const AgentPermission = {\n  READ: 'allowRead',\n  READ_AST: 'allowReadAst',\n  WRITE: 'allowWrite',\n  CONFIG_EDIT: 'allowConfigEdit',\n  INSTALL: 'allowInstall',\n  UPDATE: 'allowUpdate',\n  REMOVE: 'allowRemove',\n  SAVE_INPUT: 'allowSaveInput',\n  EXEC: 'allowExec',\n} as const satisfies Record<string, keyof AgentPermissions>\nexport type AgentPermission = (typeof AgentPermission)[keyof typeof AgentPermission]\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; number?: number } | 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  /**\n   * Studio page of this snapshot, such as `/kubb-labs/petstore/182`. Absent from a Studio that does not send it.\n   */\n  webUrl?: string\n  /**\n   * The snapshot's sequence number on its CI agent, shown as `#182`. Absent from a Studio that does not send it.\n   */\n  number?: number\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":";AAQA,MAAa,iBAAiB;CAAE,QAAQ;CAAU,SAAS;CAAW,QAAQ;AAAS;AAEvF,MAAa,sBAAsB;CACjC,YAAY;CACZ,eAAe;CACf,YAAY;CACZ,kBAAkB;CAClB,gBAAgB;CAChB,eAAe;CACf,WAAW;CACX,YAAY;CACZ,eAAe;AACjB;;;;;;;AC+CA,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;;;;AA0NA,MAAa,eAAe;CAC1B,wBAAwB;CACxB,qBAAqB;CACrB,kBAAkB;CAClB,oBAAoB;CACpB,oBAAoB;CACpB,wBAAwB;CACxB,cAAc;CACd,sBAAsB;CACtB,gBAAgB;CAChB,cAAc;CACd,sBAAsB;CACtB,aAAa;;;;CAIb,iBAAiB;CACjB,kBAAkB;;;;CAIlB,sBAAsB;CACtB,UAAU;AACZ;;;;;;AA8EA,MAAa,iBAAiB;CAC5B,cAAc;CACd,YAAY;CACZ,cAAc;AAChB;AAEA,MAAa,oBAAoB;;;;AAKjC,MAAa,wBAAwB;;;;AAKrC,MAAa,wBAAwB;;AAGrC,MAAa,iBAAiB;AAE9B,MAAa,qBAAqB;;;;AA8HlC,MAAa,kBAAkB;CAC7B,MAAM;CACN,UAAU;CACV,OAAO;CACP,aAAa;CACb,SAAS;CACT,QAAQ;CACR,QAAQ;CACR,YAAY;CACZ,MAAM;AACR"}