@databricks/appkit 0.36.0 → 0.38.0

package/dist/shared/src/schemas/manifest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"manifest.d.ts","names":[],"sources":["../../../../../shared/src/schemas/manifest.ts"],"mappings":";;;cAoVa,wBAAA,EAAwB,CAAA,CAAA,SAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cAsUxB,oBAAA,EAAoB,CAAA,CAAA,SAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KA+frB,kBAAA,GAAqB,CAAA,CAAE,KAAA,QAAa,wBAAA;AAAA,KAOpC,cAAA,GAAiB,CAAA,CAAE,KAAA,QAAa,oBAAA"}

package/dist/stream/arrow-stream-processor.js

@@ -1,10 +1,9 @@
 import { createLogger } from "../logging/logger.js";
 import { ExecutionError } from "../errors/execution.js";
 import { ValidationError } from "../errors/validation.js";
-import { init_errors } from "../errors/index.js";
+import "../errors/index.js";
 
 //#region src/stream/arrow-stream-processor.ts
-init_errors();
 const logger = createLogger("stream:arrow");
 const BACKOFF_MULTIPLIER = 1e3;
 var ArrowStreamProcessor = class ArrowStreamProcessor {

package/dist/stream/arrow-stream-processor.js.map

@@ -1 +1 @@
-{"version":3,"file":"arrow-stream-processor.js","names":[],"sources":["../../src/stream/arrow-stream-processor.ts"],"sourcesContent":["import type { sql } from \"@databricks/sdk-experimental\";\nimport { ExecutionError, ValidationError } from \"../errors\";\nimport { createLogger } from \"../logging/logger\";\n\nconst logger = createLogger(\"stream:arrow\");\n\ntype ResultManifest = sql.ResultManifest;\ntype ExternalLink = sql.ExternalLink;\n\ninterface ArrowStreamOptions {\n  maxConcurrentDownloads: number;\n  timeout: number;\n  retries: number;\n}\n\n/**\n * Result from zero-copy Arrow chunk processing.\n * Contains raw IPC bytes without server-side parsing.\n */\ninterface ArrowRawResult {\n  /** Concatenated raw Arrow IPC bytes */\n  data: Uint8Array;\n  /** Schema from Databricks manifest (not parsed from Arrow) */\n  schema: ResultManifest[\"schema\"];\n}\n\nconst BACKOFF_MULTIPLIER = 1000;\n\nexport class ArrowStreamProcessor {\n  static readonly DEFAULT_MAX_CONCURRENT_DOWNLOADS = 5;\n  static readonly DEFAULT_TIMEOUT = 30000;\n  static readonly DEFAULT_RETRIES = 3;\n\n  constructor(\n    private options: ArrowStreamOptions = {\n      maxConcurrentDownloads:\n        ArrowStreamProcessor.DEFAULT_MAX_CONCURRENT_DOWNLOADS,\n      timeout: ArrowStreamProcessor.DEFAULT_TIMEOUT,\n      retries: ArrowStreamProcessor.DEFAULT_RETRIES,\n    },\n  ) {\n    this.options = {\n      maxConcurrentDownloads:\n        options.maxConcurrentDownloads ??\n        ArrowStreamProcessor.DEFAULT_MAX_CONCURRENT_DOWNLOADS,\n      timeout: options.timeout ?? ArrowStreamProcessor.DEFAULT_TIMEOUT,\n      retries: options.retries ?? ArrowStreamProcessor.DEFAULT_RETRIES,\n    };\n  }\n\n  /**\n   * Process Arrow chunks using zero-copy proxy pattern.\n   *\n   * Downloads raw IPC bytes from external links and concatenates them\n   * without parsing into Arrow Tables on the server. This reduces:\n   * - Memory usage by ~50% (no parsed Table representation)\n   * - CPU usage (no tableFromIPC/tableToIPC calls)\n   *\n   * The client is responsible for parsing the IPC bytes.\n   *\n   * @param chunks - External links to Arrow IPC data\n   * @param schema - Schema from Databricks manifest\n   * @param signal - Optional abort signal\n   * @returns Raw concatenated IPC bytes with schema\n   */\n  async processChunks(\n    chunks: ExternalLink[],\n    schema: ResultManifest[\"schema\"],\n    signal?: AbortSignal,\n  ): Promise<ArrowRawResult> {\n    if (chunks.length === 0) {\n      throw ValidationError.missingField(\"chunks\");\n    }\n\n    const buffers = await this.downloadChunksRaw(chunks, signal);\n    const data = this.concatenateBuffers(buffers);\n\n    return { data, schema };\n  }\n\n  /**\n   * Download all chunks as raw bytes with concurrency control.\n   */\n  private async downloadChunksRaw(\n    chunks: ExternalLink[],\n    signal?: AbortSignal,\n  ): Promise<Uint8Array[]> {\n    const semaphore = new Semaphore(this.options.maxConcurrentDownloads);\n\n    const downloadPromises = chunks.map(async (chunk) => {\n      await semaphore.acquire();\n      try {\n        return await this.downloadChunkRaw(chunk, signal);\n      } finally {\n        semaphore.release();\n      }\n    });\n\n    return Promise.all(downloadPromises);\n  }\n\n  /**\n   * Download a single chunk as raw bytes with retry logic.\n   */\n  private async downloadChunkRaw(\n    chunk: ExternalLink,\n    signal?: AbortSignal,\n  ): Promise<Uint8Array> {\n    let lastError: Error | null = null;\n\n    for (let attempt = 0; attempt < this.options.retries; attempt++) {\n      const timeoutController = new AbortController();\n      const timeoutId = setTimeout(() => {\n        timeoutController.abort();\n      }, this.options.timeout);\n\n      const combinedSignal = signal\n        ? this.combineAbortSignals(signal, timeoutController.signal)\n        : timeoutController.signal;\n\n      try {\n        const externalLink = chunk.external_link;\n        if (!externalLink) {\n          logger.error(\"External link is required for chunk: %O\", chunk);\n          continue;\n        }\n\n        const response = await fetch(externalLink, {\n          signal: combinedSignal,\n        });\n\n        if (!response.ok) {\n          throw ExecutionError.statementFailed(\n            `Failed to download chunk ${chunk.chunk_index}: ${response.status} ${response.statusText}`,\n          );\n        }\n\n        const arrayBuffer = await response.arrayBuffer();\n        return new Uint8Array(arrayBuffer);\n      } catch (error) {\n        lastError = error as Error;\n\n        if (timeoutController.signal.aborted) {\n          lastError = new Error(\n            `Chunk ${chunk.chunk_index} download timed out after ${this.options.timeout}ms`,\n          );\n        }\n\n        if (signal?.aborted) {\n          throw ExecutionError.canceled();\n        }\n\n        if (attempt < this.options.retries - 1) {\n          await this.delay(2 ** attempt * BACKOFF_MULTIPLIER);\n        }\n      } finally {\n        clearTimeout(timeoutId);\n      }\n    }\n\n    throw ExecutionError.statementFailed(\n      `Failed to download chunk ${chunk.chunk_index} after ${this.options.retries} attempts: ${lastError?.message}`,\n    );\n  }\n\n  /**\n   * Concatenate multiple Uint8Array buffers into a single buffer.\n   * Pre-allocates the result array for efficiency.\n   */\n  private concatenateBuffers(buffers: Uint8Array[]): Uint8Array {\n    if (buffers.length === 0) {\n      throw ValidationError.missingField(\"buffers\");\n    }\n\n    if (buffers.length === 1) {\n      return buffers[0];\n    }\n\n    const totalLength = buffers.reduce((sum, buf) => sum + buf.length, 0);\n    const result = new Uint8Array(totalLength);\n\n    let offset = 0;\n    for (const buffer of buffers) {\n      result.set(buffer, offset);\n      offset += buffer.length;\n    }\n\n    return result;\n  }\n\n  /**\n   * Combines multiple AbortSignals into one.\n   * The combined signal aborts when any of the input signals abort.\n   */\n  private combineAbortSignals(...signals: AbortSignal[]): AbortSignal {\n    const controller = new AbortController();\n\n    for (const signal of signals) {\n      if (signal.aborted) {\n        controller.abort();\n        return controller.signal;\n      }\n      signal.addEventListener(\"abort\", () => controller.abort(), {\n        once: true,\n      });\n    }\n\n    return controller.signal;\n  }\n\n  private delay(ms: number): Promise<void> {\n    return new Promise((resolve) => setTimeout(resolve, ms));\n  }\n}\n\nclass Semaphore {\n  private permits: number;\n  private waiting: (() => void)[] = [];\n\n  constructor(permits: number) {\n    this.permits = permits;\n  }\n\n  async acquire(): Promise<void> {\n    if (this.permits > 0) {\n      this.permits--;\n      return;\n    }\n\n    return new Promise<void>((resolve) => {\n      this.waiting.push(resolve);\n    });\n  }\n\n  release(): void {\n    if (this.waiting.length > 0) {\n      const next = this.waiting.shift();\n\n      if (next) {\n        next();\n      }\n    } else {\n      this.permits++;\n    }\n  }\n}\n"],"mappings":";;;;;;aAC4D;AAG5D,MAAM,SAAS,aAAa,eAAe;AAsB3C,MAAM,qBAAqB;AAE3B,IAAa,uBAAb,MAAa,qBAAqB;CAChC,OAAgB,mCAAmC;CACnD,OAAgB,kBAAkB;CAClC,OAAgB,kBAAkB;CAElC,YACE,AAAQ,UAA8B;EACpC,wBACE,qBAAqB;EACvB,SAAS,qBAAqB;EAC9B,SAAS,qBAAqB;EAC/B,EACD;EANQ;AAOR,OAAK,UAAU;GACb,wBACE,QAAQ,0BACR,qBAAqB;GACvB,SAAS,QAAQ,WAAW,qBAAqB;GACjD,SAAS,QAAQ,WAAW,qBAAqB;GAClD;;;;;;;;;;;;;;;;;CAkBH,MAAM,cACJ,QACA,QACA,QACyB;AACzB,MAAI,OAAO,WAAW,EACpB,OAAM,gBAAgB,aAAa,SAAS;EAG9C,MAAM,UAAU,MAAM,KAAK,kBAAkB,QAAQ,OAAO;AAG5D,SAAO;GAAE,MAFI,KAAK,mBAAmB,QAAQ;GAE9B;GAAQ;;;;;CAMzB,MAAc,kBACZ,QACA,QACuB;EACvB,MAAM,YAAY,IAAI,UAAU,KAAK,QAAQ,uBAAuB;EAEpE,MAAM,mBAAmB,OAAO,IAAI,OAAO,UAAU;AACnD,SAAM,UAAU,SAAS;AACzB,OAAI;AACF,WAAO,MAAM,KAAK,iBAAiB,OAAO,OAAO;aACzC;AACR,cAAU,SAAS;;IAErB;AAEF,SAAO,QAAQ,IAAI,iBAAiB;;;;;CAMtC,MAAc,iBACZ,OACA,QACqB;EACrB,IAAI,YAA0B;AAE9B,OAAK,IAAI,UAAU,GAAG,UAAU,KAAK,QAAQ,SAAS,WAAW;GAC/D,MAAM,oBAAoB,IAAI,iBAAiB;GAC/C,MAAM,YAAY,iBAAiB;AACjC,sBAAkB,OAAO;MACxB,KAAK,QAAQ,QAAQ;GAExB,MAAM,iBAAiB,SACnB,KAAK,oBAAoB,QAAQ,kBAAkB,OAAO,GAC1D,kBAAkB;AAEtB,OAAI;IACF,MAAM,eAAe,MAAM;AAC3B,QAAI,CAAC,cAAc;AACjB,YAAO,MAAM,2CAA2C,MAAM;AAC9D;;IAGF,MAAM,WAAW,MAAM,MAAM,cAAc,EACzC,QAAQ,gBACT,CAAC;AAEF,QAAI,CAAC,SAAS,GACZ,OAAM,eAAe,gBACnB,4BAA4B,MAAM,YAAY,IAAI,SAAS,OAAO,GAAG,SAAS,aAC/E;IAGH,MAAM,cAAc,MAAM,SAAS,aAAa;AAChD,WAAO,IAAI,WAAW,YAAY;YAC3B,OAAO;AACd,gBAAY;AAEZ,QAAI,kBAAkB,OAAO,QAC3B,6BAAY,IAAI,MACd,SAAS,MAAM,YAAY,4BAA4B,KAAK,QAAQ,QAAQ,IAC7E;AAGH,QAAI,QAAQ,QACV,OAAM,eAAe,UAAU;AAGjC,QAAI,UAAU,KAAK,QAAQ,UAAU,EACnC,OAAM,KAAK,MAAM,KAAK,UAAU,mBAAmB;aAE7C;AACR,iBAAa,UAAU;;;AAI3B,QAAM,eAAe,gBACnB,4BAA4B,MAAM,YAAY,SAAS,KAAK,QAAQ,QAAQ,aAAa,WAAW,UACrG;;;;;;CAOH,AAAQ,mBAAmB,SAAmC;AAC5D,MAAI,QAAQ,WAAW,EACrB,OAAM,gBAAgB,aAAa,UAAU;AAG/C,MAAI,QAAQ,WAAW,EACrB,QAAO,QAAQ;EAGjB,MAAM,cAAc,QAAQ,QAAQ,KAAK,QAAQ,MAAM,IAAI,QAAQ,EAAE;EACrE,MAAM,SAAS,IAAI,WAAW,YAAY;EAE1C,IAAI,SAAS;AACb,OAAK,MAAM,UAAU,SAAS;AAC5B,UAAO,IAAI,QAAQ,OAAO;AAC1B,aAAU,OAAO;;AAGnB,SAAO;;;;;;CAOT,AAAQ,oBAAoB,GAAG,SAAqC;EAClE,MAAM,aAAa,IAAI,iBAAiB;AAExC,OAAK,MAAM,UAAU,SAAS;AAC5B,OAAI,OAAO,SAAS;AAClB,eAAW,OAAO;AAClB,WAAO,WAAW;;AAEpB,UAAO,iBAAiB,eAAe,WAAW,OAAO,EAAE,EACzD,MAAM,MACP,CAAC;;AAGJ,SAAO,WAAW;;CAGpB,AAAQ,MAAM,IAA2B;AACvC,SAAO,IAAI,SAAS,YAAY,WAAW,SAAS,GAAG,CAAC;;;AAI5D,IAAM,YAAN,MAAgB;CACd,AAAQ;CACR,AAAQ,UAA0B,EAAE;CAEpC,YAAY,SAAiB;AAC3B,OAAK,UAAU;;CAGjB,MAAM,UAAyB;AAC7B,MAAI,KAAK,UAAU,GAAG;AACpB,QAAK;AACL;;AAGF,SAAO,IAAI,SAAe,YAAY;AACpC,QAAK,QAAQ,KAAK,QAAQ;IAC1B;;CAGJ,UAAgB;AACd,MAAI,KAAK,QAAQ,SAAS,GAAG;GAC3B,MAAM,OAAO,KAAK,QAAQ,OAAO;AAEjC,OAAI,KACF,OAAM;QAGR,MAAK"}
+{"version":3,"file":"arrow-stream-processor.js","names":[],"sources":["../../src/stream/arrow-stream-processor.ts"],"sourcesContent":["import type { sql } from \"@databricks/sdk-experimental\";\nimport { ExecutionError, ValidationError } from \"../errors\";\nimport { createLogger } from \"../logging/logger\";\n\nconst logger = createLogger(\"stream:arrow\");\n\ntype ResultManifest = sql.ResultManifest;\ntype ExternalLink = sql.ExternalLink;\n\ninterface ArrowStreamOptions {\n  maxConcurrentDownloads: number;\n  timeout: number;\n  retries: number;\n}\n\n/**\n * Result from zero-copy Arrow chunk processing.\n * Contains raw IPC bytes without server-side parsing.\n */\ninterface ArrowRawResult {\n  /** Concatenated raw Arrow IPC bytes */\n  data: Uint8Array;\n  /** Schema from Databricks manifest (not parsed from Arrow) */\n  schema: ResultManifest[\"schema\"];\n}\n\nconst BACKOFF_MULTIPLIER = 1000;\n\nexport class ArrowStreamProcessor {\n  static readonly DEFAULT_MAX_CONCURRENT_DOWNLOADS = 5;\n  static readonly DEFAULT_TIMEOUT = 30000;\n  static readonly DEFAULT_RETRIES = 3;\n\n  constructor(\n    private options: ArrowStreamOptions = {\n      maxConcurrentDownloads:\n        ArrowStreamProcessor.DEFAULT_MAX_CONCURRENT_DOWNLOADS,\n      timeout: ArrowStreamProcessor.DEFAULT_TIMEOUT,\n      retries: ArrowStreamProcessor.DEFAULT_RETRIES,\n    },\n  ) {\n    this.options = {\n      maxConcurrentDownloads:\n        options.maxConcurrentDownloads ??\n        ArrowStreamProcessor.DEFAULT_MAX_CONCURRENT_DOWNLOADS,\n      timeout: options.timeout ?? ArrowStreamProcessor.DEFAULT_TIMEOUT,\n      retries: options.retries ?? ArrowStreamProcessor.DEFAULT_RETRIES,\n    };\n  }\n\n  /**\n   * Process Arrow chunks using zero-copy proxy pattern.\n   *\n   * Downloads raw IPC bytes from external links and concatenates them\n   * without parsing into Arrow Tables on the server. This reduces:\n   * - Memory usage by ~50% (no parsed Table representation)\n   * - CPU usage (no tableFromIPC/tableToIPC calls)\n   *\n   * The client is responsible for parsing the IPC bytes.\n   *\n   * @param chunks - External links to Arrow IPC data\n   * @param schema - Schema from Databricks manifest\n   * @param signal - Optional abort signal\n   * @returns Raw concatenated IPC bytes with schema\n   */\n  async processChunks(\n    chunks: ExternalLink[],\n    schema: ResultManifest[\"schema\"],\n    signal?: AbortSignal,\n  ): Promise<ArrowRawResult> {\n    if (chunks.length === 0) {\n      throw ValidationError.missingField(\"chunks\");\n    }\n\n    const buffers = await this.downloadChunksRaw(chunks, signal);\n    const data = this.concatenateBuffers(buffers);\n\n    return { data, schema };\n  }\n\n  /**\n   * Download all chunks as raw bytes with concurrency control.\n   */\n  private async downloadChunksRaw(\n    chunks: ExternalLink[],\n    signal?: AbortSignal,\n  ): Promise<Uint8Array[]> {\n    const semaphore = new Semaphore(this.options.maxConcurrentDownloads);\n\n    const downloadPromises = chunks.map(async (chunk) => {\n      await semaphore.acquire();\n      try {\n        return await this.downloadChunkRaw(chunk, signal);\n      } finally {\n        semaphore.release();\n      }\n    });\n\n    return Promise.all(downloadPromises);\n  }\n\n  /**\n   * Download a single chunk as raw bytes with retry logic.\n   */\n  private async downloadChunkRaw(\n    chunk: ExternalLink,\n    signal?: AbortSignal,\n  ): Promise<Uint8Array> {\n    let lastError: Error | null = null;\n\n    for (let attempt = 0; attempt < this.options.retries; attempt++) {\n      const timeoutController = new AbortController();\n      const timeoutId = setTimeout(() => {\n        timeoutController.abort();\n      }, this.options.timeout);\n\n      const combinedSignal = signal\n        ? this.combineAbortSignals(signal, timeoutController.signal)\n        : timeoutController.signal;\n\n      try {\n        const externalLink = chunk.external_link;\n        if (!externalLink) {\n          logger.error(\"External link is required for chunk: %O\", chunk);\n          continue;\n        }\n\n        const response = await fetch(externalLink, {\n          signal: combinedSignal,\n        });\n\n        if (!response.ok) {\n          throw ExecutionError.statementFailed(\n            `Failed to download chunk ${chunk.chunk_index}: ${response.status} ${response.statusText}`,\n          );\n        }\n\n        const arrayBuffer = await response.arrayBuffer();\n        return new Uint8Array(arrayBuffer);\n      } catch (error) {\n        lastError = error as Error;\n\n        if (timeoutController.signal.aborted) {\n          lastError = new Error(\n            `Chunk ${chunk.chunk_index} download timed out after ${this.options.timeout}ms`,\n          );\n        }\n\n        if (signal?.aborted) {\n          throw ExecutionError.canceled();\n        }\n\n        if (attempt < this.options.retries - 1) {\n          await this.delay(2 ** attempt * BACKOFF_MULTIPLIER);\n        }\n      } finally {\n        clearTimeout(timeoutId);\n      }\n    }\n\n    throw ExecutionError.statementFailed(\n      `Failed to download chunk ${chunk.chunk_index} after ${this.options.retries} attempts: ${lastError?.message}`,\n    );\n  }\n\n  /**\n   * Concatenate multiple Uint8Array buffers into a single buffer.\n   * Pre-allocates the result array for efficiency.\n   */\n  private concatenateBuffers(buffers: Uint8Array[]): Uint8Array {\n    if (buffers.length === 0) {\n      throw ValidationError.missingField(\"buffers\");\n    }\n\n    if (buffers.length === 1) {\n      return buffers[0];\n    }\n\n    const totalLength = buffers.reduce((sum, buf) => sum + buf.length, 0);\n    const result = new Uint8Array(totalLength);\n\n    let offset = 0;\n    for (const buffer of buffers) {\n      result.set(buffer, offset);\n      offset += buffer.length;\n    }\n\n    return result;\n  }\n\n  /**\n   * Combines multiple AbortSignals into one.\n   * The combined signal aborts when any of the input signals abort.\n   */\n  private combineAbortSignals(...signals: AbortSignal[]): AbortSignal {\n    const controller = new AbortController();\n\n    for (const signal of signals) {\n      if (signal.aborted) {\n        controller.abort();\n        return controller.signal;\n      }\n      signal.addEventListener(\"abort\", () => controller.abort(), {\n        once: true,\n      });\n    }\n\n    return controller.signal;\n  }\n\n  private delay(ms: number): Promise<void> {\n    return new Promise((resolve) => setTimeout(resolve, ms));\n  }\n}\n\nclass Semaphore {\n  private permits: number;\n  private waiting: (() => void)[] = [];\n\n  constructor(permits: number) {\n    this.permits = permits;\n  }\n\n  async acquire(): Promise<void> {\n    if (this.permits > 0) {\n      this.permits--;\n      return;\n    }\n\n    return new Promise<void>((resolve) => {\n      this.waiting.push(resolve);\n    });\n  }\n\n  release(): void {\n    if (this.waiting.length > 0) {\n      const next = this.waiting.shift();\n\n      if (next) {\n        next();\n      }\n    } else {\n      this.permits++;\n    }\n  }\n}\n"],"mappings":";;;;;;AAIA,MAAM,SAAS,aAAa,eAAe;AAsB3C,MAAM,qBAAqB;AAE3B,IAAa,uBAAb,MAAa,qBAAqB;CAChC,OAAgB,mCAAmC;CACnD,OAAgB,kBAAkB;CAClC,OAAgB,kBAAkB;CAElC,YACE,AAAQ,UAA8B;EACpC,wBACE,qBAAqB;EACvB,SAAS,qBAAqB;EAC9B,SAAS,qBAAqB;EAC/B,EACD;EANQ;AAOR,OAAK,UAAU;GACb,wBACE,QAAQ,0BACR,qBAAqB;GACvB,SAAS,QAAQ,WAAW,qBAAqB;GACjD,SAAS,QAAQ,WAAW,qBAAqB;GAClD;;;;;;;;;;;;;;;;;CAkBH,MAAM,cACJ,QACA,QACA,QACyB;AACzB,MAAI,OAAO,WAAW,EACpB,OAAM,gBAAgB,aAAa,SAAS;EAG9C,MAAM,UAAU,MAAM,KAAK,kBAAkB,QAAQ,OAAO;AAG5D,SAAO;GAAE,MAFI,KAAK,mBAAmB,QAAQ;GAE9B;GAAQ;;;;;CAMzB,MAAc,kBACZ,QACA,QACuB;EACvB,MAAM,YAAY,IAAI,UAAU,KAAK,QAAQ,uBAAuB;EAEpE,MAAM,mBAAmB,OAAO,IAAI,OAAO,UAAU;AACnD,SAAM,UAAU,SAAS;AACzB,OAAI;AACF,WAAO,MAAM,KAAK,iBAAiB,OAAO,OAAO;aACzC;AACR,cAAU,SAAS;;IAErB;AAEF,SAAO,QAAQ,IAAI,iBAAiB;;;;;CAMtC,MAAc,iBACZ,OACA,QACqB;EACrB,IAAI,YAA0B;AAE9B,OAAK,IAAI,UAAU,GAAG,UAAU,KAAK,QAAQ,SAAS,WAAW;GAC/D,MAAM,oBAAoB,IAAI,iBAAiB;GAC/C,MAAM,YAAY,iBAAiB;AACjC,sBAAkB,OAAO;MACxB,KAAK,QAAQ,QAAQ;GAExB,MAAM,iBAAiB,SACnB,KAAK,oBAAoB,QAAQ,kBAAkB,OAAO,GAC1D,kBAAkB;AAEtB,OAAI;IACF,MAAM,eAAe,MAAM;AAC3B,QAAI,CAAC,cAAc;AACjB,YAAO,MAAM,2CAA2C,MAAM;AAC9D;;IAGF,MAAM,WAAW,MAAM,MAAM,cAAc,EACzC,QAAQ,gBACT,CAAC;AAEF,QAAI,CAAC,SAAS,GACZ,OAAM,eAAe,gBACnB,4BAA4B,MAAM,YAAY,IAAI,SAAS,OAAO,GAAG,SAAS,aAC/E;IAGH,MAAM,cAAc,MAAM,SAAS,aAAa;AAChD,WAAO,IAAI,WAAW,YAAY;YAC3B,OAAO;AACd,gBAAY;AAEZ,QAAI,kBAAkB,OAAO,QAC3B,6BAAY,IAAI,MACd,SAAS,MAAM,YAAY,4BAA4B,KAAK,QAAQ,QAAQ,IAC7E;AAGH,QAAI,QAAQ,QACV,OAAM,eAAe,UAAU;AAGjC,QAAI,UAAU,KAAK,QAAQ,UAAU,EACnC,OAAM,KAAK,MAAM,KAAK,UAAU,mBAAmB;aAE7C;AACR,iBAAa,UAAU;;;AAI3B,QAAM,eAAe,gBACnB,4BAA4B,MAAM,YAAY,SAAS,KAAK,QAAQ,QAAQ,aAAa,WAAW,UACrG;;;;;;CAOH,AAAQ,mBAAmB,SAAmC;AAC5D,MAAI,QAAQ,WAAW,EACrB,OAAM,gBAAgB,aAAa,UAAU;AAG/C,MAAI,QAAQ,WAAW,EACrB,QAAO,QAAQ;EAGjB,MAAM,cAAc,QAAQ,QAAQ,KAAK,QAAQ,MAAM,IAAI,QAAQ,EAAE;EACrE,MAAM,SAAS,IAAI,WAAW,YAAY;EAE1C,IAAI,SAAS;AACb,OAAK,MAAM,UAAU,SAAS;AAC5B,UAAO,IAAI,QAAQ,OAAO;AAC1B,aAAU,OAAO;;AAGnB,SAAO;;;;;;CAOT,AAAQ,oBAAoB,GAAG,SAAqC;EAClE,MAAM,aAAa,IAAI,iBAAiB;AAExC,OAAK,MAAM,UAAU,SAAS;AAC5B,OAAI,OAAO,SAAS;AAClB,eAAW,OAAO;AAClB,WAAO,WAAW;;AAEpB,UAAO,iBAAiB,eAAe,WAAW,OAAO,EAAE,EACzD,MAAM,MACP,CAAC;;AAGJ,SAAO,WAAW;;CAGpB,AAAQ,MAAM,IAA2B;AACvC,SAAO,IAAI,SAAS,YAAY,WAAW,SAAS,GAAG,CAAC;;;AAI5D,IAAM,YAAN,MAAgB;CACd,AAAQ;CACR,AAAQ,UAA0B,EAAE;CAEpC,YAAY,SAAiB;AAC3B,OAAK,UAAU;;CAGjB,MAAM,UAAyB;AAC7B,MAAI,KAAK,UAAU,GAAG;AACpB,QAAK;AACL;;AAGF,SAAO,IAAI,SAAe,YAAY;AACpC,QAAK,QAAQ,KAAK,QAAQ;IAC1B;;CAGJ,UAAgB;AACd,MAAI,KAAK,QAAQ,SAAS,GAAG;GAC3B,MAAM,OAAO,KAAK,QAAQ,OAAO;AAEjC,OAAI,KACF,OAAM;QAGR,MAAK"}

package/dist/stream/buffers.js

@@ -1,8 +1,7 @@
 import { ValidationError } from "../errors/validation.js";
-import { init_errors } from "../errors/index.js";
+import "../errors/index.js";
 
 //#region src/stream/buffers.ts
-init_errors();
 var RingBuffer = class {
 	buffer;
 	capacity;

package/dist/stream/buffers.js.map

@@ -1 +1 @@
-{"version":3,"file":"buffers.js","names":[],"sources":["../../src/stream/buffers.ts"],"sourcesContent":["import { ValidationError } from \"../errors\";\nimport type { BufferedEvent } from \"./types\";\n\n// generic ring buffer implementation\nexport class RingBuffer<T> {\n  public buffer: (T | null)[];\n  public capacity: number;\n  private writeIndex: number;\n  private size: number;\n  private keyExtractor: (item: T) => string;\n  private keyIndex: Map<string, number>;\n\n  constructor(capacity: number, keyExtractor: (item: T) => string) {\n    if (capacity <= 0) {\n      throw ValidationError.invalidValue(\n        \"capacity\",\n        capacity,\n        \"greater than 0\",\n      );\n    }\n\n    this.capacity = capacity;\n    this.buffer = new Array(capacity).fill(null);\n    this.writeIndex = 0;\n    this.size = 0;\n    this.keyExtractor = keyExtractor;\n    this.keyIndex = new Map();\n  }\n\n  // add an item to the buffer\n  add(item: T): void {\n    const key = this.keyExtractor(item);\n\n    // check if item already exists\n    const existingIndex = this.keyIndex.get(key);\n    if (existingIndex !== undefined) {\n      // update existing item\n      this.buffer[existingIndex] = item;\n      return;\n    }\n\n    // evict least recently used item if at capacity\n    const evicted = this.buffer[this.writeIndex];\n    if (evicted !== null) {\n      const evictedKey = this.keyExtractor(evicted);\n      this.keyIndex.delete(evictedKey);\n    }\n\n    // add new item\n    this.buffer[this.writeIndex] = item;\n    this.keyIndex.set(key, this.writeIndex);\n\n    // update write index and size\n    this.writeIndex = (this.writeIndex + 1) % this.capacity;\n    this.size = Math.min(this.size + 1, this.capacity);\n  }\n\n  // get an item from the buffer\n  get(key: string): T | null {\n    const index = this.keyIndex.get(key);\n    if (index === undefined) return null;\n\n    return this.buffer[index];\n  }\n\n  // check if an item exists in the buffer\n  has(key: string): boolean {\n    return this.keyIndex.has(key);\n  }\n\n  // remove an item from the buffer\n  remove(key: string): void {\n    const index = this.keyIndex.get(key);\n    if (index === undefined) return;\n\n    // remove item from buffer\n    this.buffer[index] = null;\n    this.keyIndex.delete(key);\n\n    // update size\n    this.size = Math.max(this.size - 1, 0);\n  }\n\n  // get all items from the buffer\n  getAll(): T[] {\n    const result: T[] = [];\n\n    // iterate over buffer in order of insertion\n    for (let i = 0; i < this.size; i++) {\n      // calculate index of item in buffer\n      const index =\n        (this.writeIndex - this.size + i + this.capacity) % this.capacity;\n      // add item to result if not null\n      const item = this.buffer[index];\n      if (item !== null) {\n        result.push(item);\n      }\n    }\n    return result;\n  }\n\n  // get the size of the buffer\n  getSize(): number {\n    return this.size;\n  }\n\n  // clear the buffer\n  clear(): void {\n    this.buffer = new Array(this.capacity).fill(null);\n    this.keyIndex.clear();\n    this.writeIndex = 0;\n    this.size = 0;\n  }\n}\n\n// event ring buffer implementation\nexport class EventRingBuffer {\n  private buffer: RingBuffer<BufferedEvent>;\n\n  constructor(capacity: number = 100) {\n    this.buffer = new RingBuffer<BufferedEvent>(capacity, (event) => event.id);\n  }\n\n  // add an event to the buffer\n  add(event: BufferedEvent): void {\n    this.buffer.add(event);\n  }\n\n  // check if an event exists in the buffer\n  has(eventId: string): boolean {\n    return this.buffer.has(eventId);\n  }\n\n  // get all events since a given event id\n  getEventsSince(lastEventId: string): BufferedEvent[] {\n    const allEvents = this.buffer.getAll();\n    const result: BufferedEvent[] = [];\n    // flag to track if we've found the last event\n    let foundLastEvent = false;\n\n    // iterate over all events\n    for (const event of allEvents) {\n      // if found, add to result\n      if (foundLastEvent) {\n        result.push(event);\n        // if not found, check if it's the last event\n      } else if (event.id === lastEventId) {\n        foundLastEvent = true;\n      }\n    }\n    return result;\n  }\n\n  clear(): void {\n    this.buffer.clear();\n  }\n}\n"],"mappings":";;;;aAA4C;AAI5C,IAAa,aAAb,MAA2B;CACzB,AAAO;CACP,AAAO;CACP,AAAQ;CACR,AAAQ;CACR,AAAQ;CACR,AAAQ;CAER,YAAY,UAAkB,cAAmC;AAC/D,MAAI,YAAY,EACd,OAAM,gBAAgB,aACpB,YACA,UACA,iBACD;AAGH,OAAK,WAAW;AAChB,OAAK,SAAS,IAAI,MAAM,SAAS,CAAC,KAAK,KAAK;AAC5C,OAAK,aAAa;AAClB,OAAK,OAAO;AACZ,OAAK,eAAe;AACpB,OAAK,2BAAW,IAAI,KAAK;;CAI3B,IAAI,MAAe;EACjB,MAAM,MAAM,KAAK,aAAa,KAAK;EAGnC,MAAM,gBAAgB,KAAK,SAAS,IAAI,IAAI;AAC5C,MAAI,kBAAkB,QAAW;AAE/B,QAAK,OAAO,iBAAiB;AAC7B;;EAIF,MAAM,UAAU,KAAK,OAAO,KAAK;AACjC,MAAI,YAAY,MAAM;GACpB,MAAM,aAAa,KAAK,aAAa,QAAQ;AAC7C,QAAK,SAAS,OAAO,WAAW;;AAIlC,OAAK,OAAO,KAAK,cAAc;AAC/B,OAAK,SAAS,IAAI,KAAK,KAAK,WAAW;AAGvC,OAAK,cAAc,KAAK,aAAa,KAAK,KAAK;AAC/C,OAAK,OAAO,KAAK,IAAI,KAAK,OAAO,GAAG,KAAK,SAAS;;CAIpD,IAAI,KAAuB;EACzB,MAAM,QAAQ,KAAK,SAAS,IAAI,IAAI;AACpC,MAAI,UAAU,OAAW,QAAO;AAEhC,SAAO,KAAK,OAAO;;CAIrB,IAAI,KAAsB;AACxB,SAAO,KAAK,SAAS,IAAI,IAAI;;CAI/B,OAAO,KAAmB;EACxB,MAAM,QAAQ,KAAK,SAAS,IAAI,IAAI;AACpC,MAAI,UAAU,OAAW;AAGzB,OAAK,OAAO,SAAS;AACrB,OAAK,SAAS,OAAO,IAAI;AAGzB,OAAK,OAAO,KAAK,IAAI,KAAK,OAAO,GAAG,EAAE;;CAIxC,SAAc;EACZ,MAAM,SAAc,EAAE;AAGtB,OAAK,IAAI,IAAI,GAAG,IAAI,KAAK,MAAM,KAAK;GAElC,MAAM,SACH,KAAK,aAAa,KAAK,OAAO,IAAI,KAAK,YAAY,KAAK;GAE3D,MAAM,OAAO,KAAK,OAAO;AACzB,OAAI,SAAS,KACX,QAAO,KAAK,KAAK;;AAGrB,SAAO;;CAIT,UAAkB;AAChB,SAAO,KAAK;;CAId,QAAc;AACZ,OAAK,SAAS,IAAI,MAAM,KAAK,SAAS,CAAC,KAAK,KAAK;AACjD,OAAK,SAAS,OAAO;AACrB,OAAK,aAAa;AAClB,OAAK,OAAO;;;AAKhB,IAAa,kBAAb,MAA6B;CAC3B,AAAQ;CAER,YAAY,WAAmB,KAAK;AAClC,OAAK,SAAS,IAAI,WAA0B,WAAW,UAAU,MAAM,GAAG;;CAI5E,IAAI,OAA4B;AAC9B,OAAK,OAAO,IAAI,MAAM;;CAIxB,IAAI,SAA0B;AAC5B,SAAO,KAAK,OAAO,IAAI,QAAQ;;CAIjC,eAAe,aAAsC;EACnD,MAAM,YAAY,KAAK,OAAO,QAAQ;EACtC,MAAM,SAA0B,EAAE;EAElC,IAAI,iBAAiB;AAGrB,OAAK,MAAM,SAAS,UAElB,KAAI,eACF,QAAO,KAAK,MAAM;WAET,MAAM,OAAO,YACtB,kBAAiB;AAGrB,SAAO;;CAGT,QAAc;AACZ,OAAK,OAAO,OAAO"}
+{"version":3,"file":"buffers.js","names":[],"sources":["../../src/stream/buffers.ts"],"sourcesContent":["import { ValidationError } from \"../errors\";\nimport type { BufferedEvent } from \"./types\";\n\n// generic ring buffer implementation\nexport class RingBuffer<T> {\n  public buffer: (T | null)[];\n  public capacity: number;\n  private writeIndex: number;\n  private size: number;\n  private keyExtractor: (item: T) => string;\n  private keyIndex: Map<string, number>;\n\n  constructor(capacity: number, keyExtractor: (item: T) => string) {\n    if (capacity <= 0) {\n      throw ValidationError.invalidValue(\n        \"capacity\",\n        capacity,\n        \"greater than 0\",\n      );\n    }\n\n    this.capacity = capacity;\n    this.buffer = new Array(capacity).fill(null);\n    this.writeIndex = 0;\n    this.size = 0;\n    this.keyExtractor = keyExtractor;\n    this.keyIndex = new Map();\n  }\n\n  // add an item to the buffer\n  add(item: T): void {\n    const key = this.keyExtractor(item);\n\n    // check if item already exists\n    const existingIndex = this.keyIndex.get(key);\n    if (existingIndex !== undefined) {\n      // update existing item\n      this.buffer[existingIndex] = item;\n      return;\n    }\n\n    // evict least recently used item if at capacity\n    const evicted = this.buffer[this.writeIndex];\n    if (evicted !== null) {\n      const evictedKey = this.keyExtractor(evicted);\n      this.keyIndex.delete(evictedKey);\n    }\n\n    // add new item\n    this.buffer[this.writeIndex] = item;\n    this.keyIndex.set(key, this.writeIndex);\n\n    // update write index and size\n    this.writeIndex = (this.writeIndex + 1) % this.capacity;\n    this.size = Math.min(this.size + 1, this.capacity);\n  }\n\n  // get an item from the buffer\n  get(key: string): T | null {\n    const index = this.keyIndex.get(key);\n    if (index === undefined) return null;\n\n    return this.buffer[index];\n  }\n\n  // check if an item exists in the buffer\n  has(key: string): boolean {\n    return this.keyIndex.has(key);\n  }\n\n  // remove an item from the buffer\n  remove(key: string): void {\n    const index = this.keyIndex.get(key);\n    if (index === undefined) return;\n\n    // remove item from buffer\n    this.buffer[index] = null;\n    this.keyIndex.delete(key);\n\n    // update size\n    this.size = Math.max(this.size - 1, 0);\n  }\n\n  // get all items from the buffer\n  getAll(): T[] {\n    const result: T[] = [];\n\n    // iterate over buffer in order of insertion\n    for (let i = 0; i < this.size; i++) {\n      // calculate index of item in buffer\n      const index =\n        (this.writeIndex - this.size + i + this.capacity) % this.capacity;\n      // add item to result if not null\n      const item = this.buffer[index];\n      if (item !== null) {\n        result.push(item);\n      }\n    }\n    return result;\n  }\n\n  // get the size of the buffer\n  getSize(): number {\n    return this.size;\n  }\n\n  // clear the buffer\n  clear(): void {\n    this.buffer = new Array(this.capacity).fill(null);\n    this.keyIndex.clear();\n    this.writeIndex = 0;\n    this.size = 0;\n  }\n}\n\n// event ring buffer implementation\nexport class EventRingBuffer {\n  private buffer: RingBuffer<BufferedEvent>;\n\n  constructor(capacity: number = 100) {\n    this.buffer = new RingBuffer<BufferedEvent>(capacity, (event) => event.id);\n  }\n\n  // add an event to the buffer\n  add(event: BufferedEvent): void {\n    this.buffer.add(event);\n  }\n\n  // check if an event exists in the buffer\n  has(eventId: string): boolean {\n    return this.buffer.has(eventId);\n  }\n\n  // get all events since a given event id\n  getEventsSince(lastEventId: string): BufferedEvent[] {\n    const allEvents = this.buffer.getAll();\n    const result: BufferedEvent[] = [];\n    // flag to track if we've found the last event\n    let foundLastEvent = false;\n\n    // iterate over all events\n    for (const event of allEvents) {\n      // if found, add to result\n      if (foundLastEvent) {\n        result.push(event);\n        // if not found, check if it's the last event\n      } else if (event.id === lastEventId) {\n        foundLastEvent = true;\n      }\n    }\n    return result;\n  }\n\n  clear(): void {\n    this.buffer.clear();\n  }\n}\n"],"mappings":";;;;AAIA,IAAa,aAAb,MAA2B;CACzB,AAAO;CACP,AAAO;CACP,AAAQ;CACR,AAAQ;CACR,AAAQ;CACR,AAAQ;CAER,YAAY,UAAkB,cAAmC;AAC/D,MAAI,YAAY,EACd,OAAM,gBAAgB,aACpB,YACA,UACA,iBACD;AAGH,OAAK,WAAW;AAChB,OAAK,SAAS,IAAI,MAAM,SAAS,CAAC,KAAK,KAAK;AAC5C,OAAK,aAAa;AAClB,OAAK,OAAO;AACZ,OAAK,eAAe;AACpB,OAAK,2BAAW,IAAI,KAAK;;CAI3B,IAAI,MAAe;EACjB,MAAM,MAAM,KAAK,aAAa,KAAK;EAGnC,MAAM,gBAAgB,KAAK,SAAS,IAAI,IAAI;AAC5C,MAAI,kBAAkB,QAAW;AAE/B,QAAK,OAAO,iBAAiB;AAC7B;;EAIF,MAAM,UAAU,KAAK,OAAO,KAAK;AACjC,MAAI,YAAY,MAAM;GACpB,MAAM,aAAa,KAAK,aAAa,QAAQ;AAC7C,QAAK,SAAS,OAAO,WAAW;;AAIlC,OAAK,OAAO,KAAK,cAAc;AAC/B,OAAK,SAAS,IAAI,KAAK,KAAK,WAAW;AAGvC,OAAK,cAAc,KAAK,aAAa,KAAK,KAAK;AAC/C,OAAK,OAAO,KAAK,IAAI,KAAK,OAAO,GAAG,KAAK,SAAS;;CAIpD,IAAI,KAAuB;EACzB,MAAM,QAAQ,KAAK,SAAS,IAAI,IAAI;AACpC,MAAI,UAAU,OAAW,QAAO;AAEhC,SAAO,KAAK,OAAO;;CAIrB,IAAI,KAAsB;AACxB,SAAO,KAAK,SAAS,IAAI,IAAI;;CAI/B,OAAO,KAAmB;EACxB,MAAM,QAAQ,KAAK,SAAS,IAAI,IAAI;AACpC,MAAI,UAAU,OAAW;AAGzB,OAAK,OAAO,SAAS;AACrB,OAAK,SAAS,OAAO,IAAI;AAGzB,OAAK,OAAO,KAAK,IAAI,KAAK,OAAO,GAAG,EAAE;;CAIxC,SAAc;EACZ,MAAM,SAAc,EAAE;AAGtB,OAAK,IAAI,IAAI,GAAG,IAAI,KAAK,MAAM,KAAK;GAElC,MAAM,SACH,KAAK,aAAa,KAAK,OAAO,IAAI,KAAK,YAAY,KAAK;GAE3D,MAAM,OAAO,KAAK,OAAO;AACzB,OAAI,SAAS,KACX,QAAO,KAAK,KAAK;;AAGrB,SAAO;;CAIT,UAAkB;AAChB,SAAO,KAAK;;CAId,QAAc;AACZ,OAAK,SAAS,IAAI,MAAM,KAAK,SAAS,CAAC,KAAK,KAAK;AACjD,OAAK,SAAS,OAAO;AACrB,OAAK,aAAa;AAClB,OAAK,OAAO;;;AAKhB,IAAa,kBAAb,MAA6B;CAC3B,AAAQ;CAER,YAAY,WAAmB,KAAK;AAClC,OAAK,SAAS,IAAI,WAA0B,WAAW,UAAU,MAAM,GAAG;;CAI5E,IAAI,OAA4B;AAC9B,OAAK,OAAO,IAAI,MAAM;;CAIxB,IAAI,SAA0B;AAC5B,SAAO,KAAK,OAAO,IAAI,QAAQ;;CAIjC,eAAe,aAAsC;EACnD,MAAM,YAAY,KAAK,OAAO,QAAQ;EACtC,MAAM,SAA0B,EAAE;EAElC,IAAI,iBAAiB;AAGrB,OAAK,MAAM,SAAS,UAElB,KAAI,eACF,QAAO,KAAK,MAAM;WAET,MAAM,OAAO,YACtB,kBAAiB;AAGrB,SAAO;;CAGT,QAAc;AACZ,OAAK,OAAO,OAAO"}

package/docs/api/appkit/Enumeration.ResourceType.md

@@ -1,6 +1,6 @@
 # Enumeration: ResourceType
 
-Resource types from schema $defs.resourceType.enum
+Resource types from resourceTypeSchema.options
 
 ## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")
 

package/docs/api/appkit/Interface.PluginManifest.md

@@ -4,7 +4,7 @@ Plugin manifest that declares metadata and resource requirements. Attached to pl
 
 ## See[​](#see "Direct link to See")
 
-* `packages/shared/src/schemas/plugin-manifest.generated.ts` `PluginManifest` — generated base
+* `packages/shared/src/schemas/manifest.ts` `pluginManifestSchema` — Zod source of truth
 * SharedPluginManifest — shared re-export with JSONSchema7 config
 
 ## Extends[​](#extends "Direct link to Extends")
@@ -233,6 +233,60 @@ Resources that must be available for the plugin to function
 
 ***
 
+### scaffolding?[​](#scaffolding "Direct link to scaffolding?")
+
+```ts
+optional scaffolding: {
+  rules?: {
+     must?: string[];
+     never?: string[];
+     should?: string[];
+  };
+};
+
+```
+
+#### rules?[​](#rules "Direct link to rules?")
+
+```ts
+optional rules: {
+  must?: string[];
+  never?: string[];
+  should?: string[];
+};
+
+```
+
+##### rules.must?[​](#rulesmust "Direct link to rules.must?")
+
+```ts
+optional must: string[];
+
+```
+
+##### rules.never?[​](#rulesnever "Direct link to rules.never?")
+
+```ts
+optional never: string[];
+
+```
+
+##### rules.should?[​](#rulesshould "Direct link to rules.should?")
+
+```ts
+optional should: string[];
+
+```
+
+#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")
+
+```ts
+Omit.scaffolding
+
+```
+
+***
+
 ### stability?[​](#stability "Direct link to stability?")
 
 ```ts
@@ -242,7 +296,7 @@ optional stability: "beta" | "ga";
 
 Plugin stability level. Beta plugins may have breaking API changes between minor releases but are on a path to GA. GA (general availability) plugins follow semver strictly.
 
-#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")
+#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")
 
 ```ts
 Omit.stability
@@ -260,7 +314,7 @@ optional version: string;
 
 Plugin version (semver format)
 
-#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")
+#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")
 
 ```ts
 Omit.version

package/docs/api/appkit/Interface.ResourceEntry.md

@@ -15,7 +15,7 @@ alias: string;
 
 ```
 
-Human-readable label for UI/display only. Deduplication uses resourceKey, not alias.
+Human-readable label for UI/display only.
 
 #### Inherited from[​](#inherited-from "Direct link to Inherited from")
 
@@ -30,7 +30,7 @@ description: string;
 
 ```
 
-Human-readable description of why this resource is needed
+Human-readable description of why this resource is needed.
 
 #### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")
 
@@ -45,7 +45,7 @@ fields: Record<string, ResourceFieldEntry>;
 
 ```
 
-Map of field name to env and optional description. Single-value types use one key (e.g. id); multi-value (database, secret) use multiple (e.g. instance\_name, database\_name or scope, key).
+Map of field name to field entry. Required at runtime.
 
 #### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")
 
@@ -97,6 +97,8 @@ required: boolean;
 
 ```
 
+Whether the resource is mandatory at runtime.
+
 #### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")
 
 [`ResourceRequirement`](./docs/api/appkit/Interface.ResourceRequirement.md).[`required`](./docs/api/appkit/Interface.ResourceRequirement.md#required)
@@ -121,7 +123,7 @@ resourceKey: string;
 
 ```
 
-Stable key for machine use: deduplication, env naming, composite keys, app.yaml. Required for registry lookup.
+Stable key for machine use: deduplication, env naming, composite keys, app.yaml.
 
 #### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")
 

package/docs/api/appkit/Interface.ResourceRequirement.md

@@ -1,15 +1,8 @@
 # Interface: ResourceRequirement
 
-Declares a resource requirement for a plugin. Can be defined statically in a manifest or dynamically via getResourceRequirements(). Narrows the generated base: type → ResourceType enum, permission → ResourcePermission union.
+Declares a resource requirement for a plugin. Can be defined statically in a manifest or dynamically via getResourceRequirements().
 
-## See[​](#see "Direct link to See")
-
-* `packages/shared/src/schemas/plugin-manifest.generated.ts` `ResourceRequirement` — generated base
-* SharedResourceRequirement — shared re-export with runtime `fields` and `required`
-
-## Extends[​](#extends "Direct link to Extends")
-
-* `ResourceRequirement`
+Defined as a flat structural shape rather than narrowing the shared discriminated-union `ResourceRequirement`. The registry needs to construct and pass these values around at runtime where `type` and `permission` are looked up dynamically from a string; preserving per-variant tightness here would force every constructor to thread variant types end-to-end. The runtime guarantee (permission valid for type) is enforced by the manifest schema's parse, not by the registry's static types.
 
 ## Extended by[​](#extended-by "Direct link to Extended by")
 
@@ -24,14 +17,7 @@ alias: string;
 
 ```
 
-Human-readable label for UI/display only. Deduplication uses resourceKey, not alias.
-
-#### Inherited from[​](#inherited-from "Direct link to Inherited from")
-
-```ts
-SharedResourceRequirement.alias
-
-```
+Human-readable label for UI/display only.
 
 ***
 
@@ -42,14 +28,7 @@ description: string;
 
 ```
 
-Human-readable description of why this resource is needed
-
-#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")
-
-```ts
-SharedResourceRequirement.description
-
-```
+Human-readable description of why this resource is needed.
 
 ***
 
@@ -60,14 +39,7 @@ fields: Record<string, ResourceFieldEntry>;
 
 ```
 
-Map of field name to env and optional description. Single-value types use one key (e.g. id); multi-value (database, secret) use multiple (e.g. instance\_name, database\_name or scope, key).
-
-#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")
-
-```ts
-SharedResourceRequirement.fields
-
-```
+Map of field name to field entry. Required at runtime.
 
 ***
 
@@ -80,13 +52,6 @@ permission: ResourcePermission;
 
 Required permission level for the resource (narrowed to union)
 
-#### Overrides[​](#overrides "Direct link to Overrides")
-
-```ts
-SharedResourceRequirement.permission
-
-```
-
 ***
 
 ### required[​](#required "Direct link to required")
@@ -96,12 +61,7 @@ required: boolean;
 
 ```
 
-#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")
-
-```ts
-SharedResourceRequirement.required
-
-```
+Whether the resource is mandatory at runtime.
 
 ***
 
@@ -112,14 +72,7 @@ resourceKey: string;
 
 ```
 
-Stable key for machine use: deduplication, env naming, composite keys, app.yaml. Required for registry lookup.
-
-#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")
-
-```ts
-SharedResourceRequirement.resourceKey
-
-```
+Stable key for machine use: deduplication, env naming, composite keys, app.yaml.
 
 ***
 
@@ -131,10 +84,3 @@ type: ResourceType;
 ```
 
 Type of Databricks resource required (narrowed to enum)
-
-#### Overrides[​](#overrides-1 "Direct link to Overrides")
-
-```ts
-SharedResourceRequirement.type
-
-```

package/docs/api/appkit/TypeAlias.ResourceFieldEntry.md

@@ -0,0 +1,6 @@
+# Type Alias: ResourceFieldEntry
+
+```ts
+type ResourceFieldEntry = z.infer<typeof resourceFieldEntrySchema>;
+
+```

package/docs/api/appkit/Variable.agents.md

@@ -5,7 +5,7 @@ const agents: ToPlugin<typeof AgentsPlugin, AgentsPluginConfig, string>;
 
 ```
 
-Plugin factory for the agents plugin. Reads `config/agents/*.md` by default, resolves toolkits/tools from registered plugins, exposes `appkit.agents.*` runtime API and mounts `/invocations`.
+Plugin factory for the agents plugin. Reads `config/agents/*.md` by default, resolves toolkits/tools from registered plugins, exposes `appkit.agents.*` runtime API and mounts `POST /invocations` and `POST /responses` (aliased non-streaming invoke endpoints) plus `POST /chat` (streaming, HITL-capable).
 
 ## Example[​](#example "Direct link to Example")
 

package/docs/api/appkit.md

@@ -4,10 +4,10 @@ Documentation merge entry for Typedoc — combines the stable `@databricks/appki
 
 ## Enumerations[​](#enumerations "Direct link to Enumerations")
 
-| Enumeration                                                                                         | Description                                        |
-| --------------------------------------------------------------------------------------------------- | -------------------------------------------------- |
-| [RequestedClaimsPermissionSet](./docs/api/appkit/Enumeration.RequestedClaimsPermissionSet.md) | Permission set for Unity Catalog table access      |
-| [ResourceType](./docs/api/appkit/Enumeration.ResourceType.md)                                 | Resource types from schema $defs.resourceType.enum |
+| Enumeration                                                                                         | Description                                    |
+| --------------------------------------------------------------------------------------------------- | ---------------------------------------------- |
+| [RequestedClaimsPermissionSet](./docs/api/appkit/Enumeration.RequestedClaimsPermissionSet.md) | Permission set for Unity Catalog table access  |
+| [ResourceType](./docs/api/appkit/Enumeration.ResourceType.md)                                 | Resource types from resourceTypeSchema.options |
 
 ## Classes[​](#classes "Direct link to Classes")
 
@@ -64,8 +64,7 @@ Documentation merge entry for Typedoc — combines the stable `@databricks/appki
 | [RequestedClaims](./docs/api/appkit/Interface.RequestedClaims.md)                                     | Optional claims for fine-grained Unity Catalog table permissions When specified, the returned token will be scoped to only the requested tables                                                                                                                                                                                                                                                                                            |
 | [RequestedResource](./docs/api/appkit/Interface.RequestedResource.md)                                 | Resource to request permissions for in Unity Catalog                                                                                                                                                                                                                                                                                                                                                                                       |
 | [ResourceEntry](./docs/api/appkit/Interface.ResourceEntry.md)                                         | Internal representation of a resource in the registry. Extends ResourceRequirement with resolution state and plugin ownership.                                                                                                                                                                                                                                                                                                             |
-| [ResourceFieldEntry](./docs/api/appkit/Interface.ResourceFieldEntry.md)                               | Defines a single field for a resource. Each field has its own environment variable and optional description. Single-value types use one key (e.g. id); multi-value types (database, secret) use multiple (e.g. instance\_name, database\_name or scope, key).                                                                                                                                                                              |
-| [ResourceRequirement](./docs/api/appkit/Interface.ResourceRequirement.md)                             | Declares a resource requirement for a plugin. Can be defined statically in a manifest or dynamically via getResourceRequirements(). Narrows the generated base: type → ResourceType enum, permission → ResourcePermission union.                                                                                                                                                                                                           |
+| [ResourceRequirement](./docs/api/appkit/Interface.ResourceRequirement.md)                             | Declares a resource requirement for a plugin. Can be defined statically in a manifest or dynamically via getResourceRequirements().                                                                                                                                                                                                                                                                                                        |
 | [RunAgentInput](./docs/api/appkit/Interface.RunAgentInput.md)                                         | -                                                                                                                                                                                                                                                                                                                                                                                                                                          |
 | [RunAgentResult](./docs/api/appkit/Interface.RunAgentResult.md)                                       | -                                                                                                                                                                                                                                                                                                                                                                                                                                          |
 | [ServingEndpointEntry](./docs/api/appkit/Interface.ServingEndpointEntry.md)                           | Shape of a single registry entry.                                                                                                                                                                                                                                                                                                                                                                                                          |
@@ -102,6 +101,7 @@ Documentation merge entry for Typedoc — combines the stable `@databricks/appki
 | [PluginData](./docs/api/appkit/TypeAlias.PluginData.md)                         | Tuple of plugin class, config, and name. Created by `toPlugin()` and passed to `createApp()`.                                                                                                                                                                                                                          |
 | [Plugins](./docs/api/appkit/TypeAlias.Plugins.md)                               | Plugin map passed to the function form of [AgentDefinition.tools](./docs/api/appkit/Interface.AgentDefinition.md#tools). Each entry exposes a `.toolkit(opts?)` method that returns a record of [ToolkitEntry](./docs/api/appkit/Interface.ToolkitEntry.md) markers ready to be spread into a tool record. |
 | [ResolvedToolEntry](./docs/api/appkit/TypeAlias.ResolvedToolEntry.md)           | Internal tool-index entry after a tool record has been resolved to a dispatchable form.                                                                                                                                                                                                                                |
+| [ResourceFieldEntry](./docs/api/appkit/TypeAlias.ResourceFieldEntry.md)         | -                                                                                                                                                                                                                                                                                                                      |
 | [ResourcePermission](./docs/api/appkit/TypeAlias.ResourcePermission.md)         | Union of all possible permission levels across all resource types.                                                                                                                                                                                                                                                     |
 | [ServingFactory](./docs/api/appkit/TypeAlias.ServingFactory.md)                 | Factory function returned by `AppKit.serving`.                                                                                                                                                                                                                                                                         |
 | [ToolRegistry](./docs/api/appkit/TypeAlias.ToolRegistry.md)                     | -                                                                                                                                                                                                                                                                                                                      |
@@ -109,12 +109,12 @@ Documentation merge entry for Typedoc — combines the stable `@databricks/appki
 
 ## Variables[​](#variables "Direct link to Variables")
 
-| Variable                                                            | Description                                                                                                                                                                                    |
-| ------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [agents](./docs/api/appkit/Variable.agents.md)                | Plugin factory for the agents plugin. Reads `config/agents/*.md` by default, resolves toolkits/tools from registered plugins, exposes `appkit.agents.*` runtime API and mounts `/invocations`. |
-| [READ\_ACTIONS](./docs/api/appkit/Variable.READ_ACTIONS.md)   | Actions that only read data.                                                                                                                                                                   |
-| [sql](./docs/api/appkit/Variable.sql.md)                      | SQL helper namespace                                                                                                                                                                           |
-| [WRITE\_ACTIONS](./docs/api/appkit/Variable.WRITE_ACTIONS.md) | Actions that mutate data.                                                                                                                                                                      |
+| Variable                                                            | Description                                                                                                                                                                                                                                                                                                    |
+| ------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [agents](./docs/api/appkit/Variable.agents.md)                | Plugin factory for the agents plugin. Reads `config/agents/*.md` by default, resolves toolkits/tools from registered plugins, exposes `appkit.agents.*` runtime API and mounts `POST /invocations` and `POST /responses` (aliased non-streaming invoke endpoints) plus `POST /chat` (streaming, HITL-capable). |
+| [READ\_ACTIONS](./docs/api/appkit/Variable.READ_ACTIONS.md)   | Actions that only read data.                                                                                                                                                                                                                                                                                   |
+| [sql](./docs/api/appkit/Variable.sql.md)                      | SQL helper namespace                                                                                                                                                                                                                                                                                           |
+| [WRITE\_ACTIONS](./docs/api/appkit/Variable.WRITE_ACTIONS.md) | Actions that mutate data.                                                                                                                                                                                                                                                                                      |
 
 ## Functions[​](#functions "Direct link to Functions")
 

package/docs/app-management.md

@@ -5,7 +5,7 @@ Manage your AppKit application throughout its lifecycle using the Databricks CLI
 ## Prerequisites[​](#prerequisites "Direct link to Prerequisites")
 
 * [Node.js](https://nodejs.org) v22+ environment with `npm`
-* Databricks CLI (v0.295.0 or higher): install and configure it according to the [official tutorial](https://docs.databricks.com/aws/en/dev-tools/cli/tutorial).
+* Databricks CLI (v1.0.0 or higher): install and configure it according to the [official tutorial](https://docs.databricks.com/aws/en/dev-tools/cli/tutorial).
 
 ## Create app[​](#create-app "Direct link to Create app")
 

package/docs/development/ai-assisted-development.md

@@ -3,7 +3,7 @@
 ## Prerequisites[​](#prerequisites "Direct link to Prerequisites")
 
 * [Node.js](https://nodejs.org) v22+ environment with `npm`
-* Databricks CLI (v0.295.0 or higher): install and configure it according to the [official tutorial](https://docs.databricks.com/aws/en/dev-tools/cli/tutorial).
+* Databricks CLI (v1.0.0 or higher): install and configure it according to the [official tutorial](https://docs.databricks.com/aws/en/dev-tools/cli/tutorial).
 * A new Databricks app with AppKit installed. See [Bootstrap a new Databricks app](./docs.md#quick-start-options) for more details.
 
 AppKit integrates with AI coding assistants through the Agent Skills.
@@ -13,7 +13,7 @@ AppKit integrates with AI coding assistants through the Agent Skills.
 To install the Databricks Agent Skills for your preferred AI assistant, run:
 
 ```bash
-databricks experimental aitools install
+databricks aitools install
 
 ```
 

package/docs/development/local-development.md

@@ -3,7 +3,7 @@
 ## Prerequisites[​](#prerequisites "Direct link to Prerequisites")
 
 * [Node.js](https://nodejs.org) v22+ environment with `npm`
-* Databricks CLI (v0.295.0 or higher): install and configure it according to the [official tutorial](https://docs.databricks.com/aws/en/dev-tools/cli/tutorial).
+* Databricks CLI (v1.0.0 or higher): install and configure it according to the [official tutorial](https://docs.databricks.com/aws/en/dev-tools/cli/tutorial).
 * A new Databricks app with AppKit installed. See [Bootstrap a new Databricks app](./docs.md#quick-start-options) for more details.
 
 Once your app is bootstrapped according to the [Manual quick start](./docs.md#manual-quick-start) guide, you can start the development server with hot reload for both UI and backend code.

package/docs/development/remote-bridge.md

@@ -3,7 +3,7 @@
 ## Prerequisites[​](#prerequisites "Direct link to Prerequisites")
 
 * [Node.js](https://nodejs.org) v22+ environment with `npm`
-* Databricks CLI (v0.295.0 or higher): install and configure it according to the [official tutorial](https://docs.databricks.com/aws/en/dev-tools/cli/tutorial).
+* Databricks CLI (v1.0.0 or higher): install and configure it according to the [official tutorial](https://docs.databricks.com/aws/en/dev-tools/cli/tutorial).
 * A new Databricks app with AppKit installed. See [Bootstrap a new Databricks app](./docs.md#quick-start-options) for more details.
 
 Remote bridge allows you to develop against a deployed backend while keeping your UI and queries local. This is useful for testing against production data or debugging deployed backend code without redeploying your app.