@aparte/core 0.7.0 → 0.8.0

package/dist/types/events.d.ts

@@ -2,8 +2,9 @@
  * Aparte Events
  * Event interfaces for component communication and control
  */
-import type { AparteStatus, AparteMessage } from './models.js';
+import type { AparteMessage } from './models.js';
 import type { AparteUsage } from './chat.js';
+import type { AparteError } from './errors.js';
 /**
  * Detail payload for aparte-send custom event
  * Emitted when user sends a message via the input component
@@ -23,71 +24,38 @@ export interface AparteSendEventDetail {
     files?: File[];
 }
 /**
- * Detail payload for aparte-token custom event
- * Emitted during streaming when a new token is appended
- */
-export interface AparteTokenEventDetail {
-    /** Message ID receiving the token */
-    messageId: string;
-    /** Token chunk content */
-    chunk: string;
-}
-/**
- * Control event for external packages to pilot the Core
- * Allows packages like API adapters or plugins to update message states
- * without direct coupling to the core implementation
+ * Detail payload for `aparte-message-done`.
+ * Dispatched when a turn finishes normally. Carries token usage when the provider
+ * reports it.
+ *
+ * @event aparte-message-done
  */
-export interface AparteControlEvent {
-    /** Target message ID for the control action */
-    messageId: string;
-    /** New status to apply to the message */
-    status: AparteStatus;
+export interface AparteMessageDoneEventDetail {
     /**
-     * Optional metadata for arbitrary context
-     * Examples: response time, tokens/sec, error details
+     * Id of the `<aparte-chat>` host that produced this turn, when it has one.
+     *
+     * Stamped by the client's lifecycle dispatcher on EVERY lifecycle event so
+     * several chats on one page stay isolated — a composer reacts only to its own
+     * host's turn. It was undeclared here while being sent at runtime, and the
+     * dispatcher takes `Record<string, unknown>`, so the compiler could not notice.
      */
-    metadata?: Record<string, unknown>;
-}
-/**
- * Event detail for message lifecycle changes
- * Emitted when a message is added, updated, or removed
- */
-export interface AparteMessageEventDetail {
-    /** The message that changed */
+    targetId?: string;
     messageId: string;
-    /** Type of lifecycle event */
-    type: 'added' | 'updated' | 'removed' | 'completed';
-    /** Optional additional context */
-    metadata?: Record<string, unknown>;
-}
-/**
- * Event detail for status changes
- * Emitted when the global or message status changes
- */
-export interface AparteStatusEventDetail {
-    /** Previous status */
-    previousStatus: AparteStatus;
-    /** New status */
-    currentStatus: AparteStatus;
-    /** Optional message ID if status is message-specific */
-    messageId?: string;
+    role: string;
+    /** Token usage for the completed response, if reported by the provider. */
+    usage?: AparteUsage;
 }
 /**
- * Event detail for model selection changes
- * Emitted when user selects a different provider or model
+ * Detail payload for `aparte-model-change`.
+ * Dispatched by `@aparte/plugin-model-selector` when the user picks a different
+ * provider or model — the clearest cross-package contract in the set.
+ *
+ * Its `@event` tag used to sit above `AparteMessageDoneEventDetail`'s doc block
+ * instead, so this interface had no documentation of its own and the other one
+ * claimed to describe a different event.
  *
  * @event aparte-model-change
  */
-/**
- * Emitted when a message response completes (aparte-message-done).
- * Carries token usage when the provider reports it.
- */
-export interface AparteMessageDoneEventDetail {
-    messageId: string;
-    role: string;
-    /** Token usage for the completed response, if reported by the provider. */
-    usage?: AparteUsage;
-}
 export interface AparteModelChangeEventDetail {
     /** Selected provider ID (e.g., 'openrouter', 'gemini') */
     providerId?: string;
@@ -206,14 +174,19 @@ export interface AparteArtifactReadyEventDetail {
     content: string;
 }
 /**
- * Detail payload for `aparte-artifact-open`.
- * Dispatched by the artifact pill when a user clicks it (e.g. on a persisted
- * conversation reload). Apps use this to re-open the preview panel for an
- * already-completed artifact.
+ * Detail payload for `aparte-artifact-redownload`.
+ * Dispatched by an artifact card's Download button when the artifact is a BINARY
+ * kind: core cannot produce the bytes itself, so it asks the host to re-run the
+ * generation and save the file. Enable it with
+ * `setHostHandlers({ artifactRedownload: true })` — ratified decision #8, tier (b).
+ *
+ * It was declared for `aparte-artifact-open` and said so, an event that exists
+ * nowhere in the repo. The shape is field-for-field what the Download button really
+ * dispatches, so the type moved rather than being deleted.
  *
- * @event aparte-artifact-open
+ * @event aparte-artifact-redownload
  */
-export interface AparteArtifactOpenEventDetail {
+export interface AparteArtifactRedownloadEventDetail {
     /** Owning segment id */
     segmentId: string;
     /** MIME type */
@@ -255,7 +228,7 @@ export interface AparteFeedbackEventDetail {
 }
 /**
  * Detail payload for `aparte-action`.
- * Dispatched by a custom action button (registered via `AparteConfig.registerAction`)
+ * Dispatched by a custom action button (registered via `aparteGlobalConfig.registerAction`)
  * in either the composer or a message-bubble toolbar. Apps listen (bubbling) and
  * dispatch on `actionId`. Mirrors the built-in bubble events (retry/feedback) so
  * custom actions are wired the same way in every framework and in vanilla.
@@ -287,4 +260,173 @@ export interface AparteMessageInfoEventDetail {
     /** Token usage + timing for the message, when available. */
     usage?: AparteUsage;
 }
+/**
+ * Detail payload for `aparte-message-start`.
+ * Dispatched when a turn begins, before the first token. The composer and the
+ * conversation controller both use it to enter their streaming state.
+ *
+ * @event aparte-message-start
+ */
+export interface AparteMessageStartEventDetail {
+    /** Host element id, when the `<aparte-chat>` has one. */
+    targetId?: string;
+    /** Id of the assistant message about to stream. */
+    messageId: string;
+    /** Role of the message being created — `'assistant'` in every current path. */
+    role: string;
+}
+/**
+ * Detail payload for `aparte-message-error`.
+ * Dispatched when a turn fails. Four core components listen for it, and it is the
+ * event `guides/troubleshooting.md` tells you to bind to surface a failure.
+ *
+ * @event aparte-message-error
+ */
+export interface AparteMessageErrorEventDetail {
+    /** Host element id, when the `<aparte-chat>` has one. */
+    targetId?: string;
+    /** Id of the message that failed. */
+    messageId: string;
+    /** The failure, with its `code` — not a string, unlike `aparte-compact-error`. */
+    error: AparteError;
+}
+/**
+ * Detail payload for `aparte-message-aborted`.
+ * Dispatched when the user stops a turn.
+ *
+ * @event aparte-message-aborted
+ */
+export interface AparteMessageAbortedEventDetail {
+    /** Host element id, when the `<aparte-chat>` has one. */
+    targetId?: string;
+    /**
+     * Id of the aborted message — OPTIONAL, and that is not laziness: the composer
+     * dispatches this event on its own with only a `targetId`, because a user can
+     * press Stop during the pre-flight window before any message id exists.
+     */
+    messageId?: string;
+}
+/**
+ * Detail payload for `aparte-abort` — a COMMAND, not a notification.
+ *
+ * `AparteClient` listens for it on `window`; a bring-your-own-composer consumer
+ * dispatches it to stop a stream. Nothing in core dispatches it on the consumer's
+ * behalf, which is exactly why its shape had to be documented somewhere.
+ *
+ * @event aparte-abort
+ */
+export interface AparteAbortEventDetail {
+    /** Which chat to stop. Omit on a single-chat page. */
+    targetId?: string;
+}
+/**
+ * Detail payload for `aparte-compact` — a COMMAND the consumer dispatches on
+ * `window` to ask the client to summarise the conversation so far.
+ *
+ * Core listens and never dispatches it, so this type describes what YOU produce.
+ *
+ * @event aparte-compact
+ */
+export interface AparteCompactEventDetail {
+    /** Which chat to compact. Omit on a single-chat page. */
+    targetId?: string;
+}
+/**
+ * Detail payload for `aparte-compact-done`.
+ *
+ * A union flattened to optional fields, because the two outcomes carry different
+ * payloads and a consumer cannot guess which: nothing to compact sends
+ * `{ skipped: true }`, a real compaction sends `{ summary, kept }`.
+ *
+ * @event aparte-compact-done
+ */
+export interface AparteCompactDoneEventDetail {
+    /** `true` when there was nothing worth summarising; the other two are absent. */
+    skipped?: boolean;
+    /** The summary that replaced the compacted turns. */
+    summary?: string;
+    /** How many messages were kept verbatim after the summary. */
+    kept?: number;
+}
+/**
+ * Detail payload for `aparte-compact-error`.
+ *
+ * Note the asymmetry with `aparte-message-error`, which is deliberate rather than
+ * hidden: `error` here is a plain string, not an `AparteError`.
+ *
+ * @event aparte-compact-error
+ */
+export interface AparteCompactErrorEventDetail {
+    /** Human-readable failure reason. */
+    error: string;
+}
+/**
+ * Detail payload for `aparte-attachment-preview`.
+ * Dispatched when a user clicks an image tile, once
+ * `setHostHandlers({ attachmentPreview: true })` has declared that you will open
+ * a lightbox. Without the handler the tile is not interactive at all.
+ *
+ * @event aparte-attachment-preview
+ */
+export interface AparteAttachmentPreviewEventDetail {
+    /** Object URL or remote URL of the image. */
+    url: string;
+    /** File name, or `''` when the attachment carries none. */
+    name: string;
+}
+/**
+ * Detail payload for `aparte-terminal-run`.
+ * Dispatched by a terminal segment's Run button, once
+ * `setHostHandlers({ terminalRun: true })` has declared that you will execute it.
+ *
+ * @event aparte-terminal-run
+ */
+export interface AparteTerminalRunEventDetail {
+    /**
+     * Owning segment id — nullable because it is read from a DOM attribute that a
+     * custom renderer may not have set.
+     */
+    segmentId: string | null;
+    /** The command text the user asked to run. */
+    command: string;
+}
+/**
+ * Detail payload for `aparte-file-gen-ready` — dispatched by YOU, not by core.
+ *
+ * A binary artifact (pdf, xlsx, docx…) is generated by running the model's code in
+ * a sandbox, which core deliberately does not do. Core renders a "Running sandbox…"
+ * card, listens on `window`, and swaps in the preview when this arrives. Nothing in
+ * the repo dispatches it: the contract is entirely yours to fulfil, which is why
+ * this type is the one most worth having.
+ *
+ * @event aparte-file-gen-ready
+ */
+export interface AparteFileGenReadyEventDetail {
+    /** Must match the artifact segment's id, or the event is ignored. */
+    segmentId: string;
+    /** File name to show and to download as. */
+    filename: string;
+    /** Size in bytes, for the card's label. */
+    bytes: number;
+    /** MIME type of the produced file. */
+    mime: string;
+    /** The file itself. */
+    buffer: Uint8Array | ArrayBuffer;
+    /** Optional HTML preview to show inside the card; `null` for none. */
+    previewHtml: string | null;
+}
+/**
+ * Detail payload for `aparte-file-gen-error` — dispatched by YOU.
+ * Its twin: without it a failed sandbox run leaves the card spinning forever.
+ *
+ * @event aparte-file-gen-error
+ */
+export interface AparteFileGenErrorEventDetail {
+    /** Must match the artifact segment's id. */
+    segmentId: string;
+    /** Which stage failed, shown in the inline error. Defaults to `'exec'`. */
+    phase?: string;
+    /** The message shown to the user. Defaults to `'Unknown error'`. */
+    error?: string;
+}
 //# sourceMappingURL=events.d.ts.map

package/dist/types/events.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../src/types/events.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC/D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAM7C;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IAClC,qCAAqC;IACrC,OAAO,EAAE,MAAM,CAAC;IAEhB,mCAAmC;IACnC,SAAS,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,yEAAyE;IACzE,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACnC,qCAAqC;IACrC,SAAS,EAAE,MAAM,CAAC;IAElB,0BAA0B;IAC1B,KAAK,EAAE,MAAM,CAAC;CACjB;AAMD;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IAC/B,+CAA+C;IAC/C,SAAS,EAAE,MAAM,CAAC;IAElB,yCAAyC;IACzC,MAAM,EAAE,YAAY,CAAC;IAErB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACtC;AAMD;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACrC,+BAA+B;IAC/B,SAAS,EAAE,MAAM,CAAC;IAElB,8BAA8B;IAC9B,IAAI,EAAE,OAAO,GAAG,SAAS,GAAG,SAAS,GAAG,WAAW,CAAC;IAEpD,kCAAkC;IAClC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACtC;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACpC,sBAAsB;IACtB,cAAc,EAAE,YAAY,CAAC;IAE7B,iBAAiB;IACjB,aAAa,EAAE,YAAY,CAAC;IAE5B,wDAAwD;IACxD,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAMD;;;;;GAKG;AACH;;;GAGG;AACH,MAAM,WAAW,4BAA4B;IACzC,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,2EAA2E;IAC3E,KAAK,CAAC,EAAE,WAAW,CAAC;CACvB;AAED,MAAM,WAAW,4BAA4B;IACzC,0DAA0D;IAC1D,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,+DAA+D;IAC/D,OAAO,EAAE,MAAM,CAAC;IAEhB,mCAAmC;IACnC,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,sCAAsC;IACtC,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAMD;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAC9B,iBAAiB;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,2EAA2E;IAC3E,KAAK,EAAE,MAAM,CAAC;IACd,2DAA2D;IAC3D,KAAK,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,+BAA+B;IAC5C,oDAAoD;IACpD,SAAS,EAAE,MAAM,CAAC;IAClB,uEAAuE;IACvE,SAAS,EAAE,MAAM,GAAG,MAAM,CAAC;CAC9B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,4BAA4B;IACzC,oDAAoD;IACpD,QAAQ,EAAE,aAAa,EAAE,CAAC;IAC1B,2DAA2D;IAC3D,QAAQ,EAAE,iBAAiB,EAAE,CAAC;CACjC;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,sBAAsB;IACnC,wFAAwF;IACxF,SAAS,EAAE,MAAM,CAAC;IAClB,iFAAiF;IACjF,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAMD;;;;;;GAMG;AACH,MAAM,WAAW,8BAA8B;IAC3C,wBAAwB;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,uEAAuE;IACvE,SAAS,EAAE,MAAM,CAAC;IAClB,kFAAkF;IAClF,QAAQ,EAAE,MAAM,CAAC;IACjB,mFAAmF;IACnF,YAAY,EAAE,MAAM,CAAC;IACrB,uDAAuD;IACvD,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,8BAA8B;IAC3C,wBAAwB;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,qCAAqC;IACrC,KAAK,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,8BAA8B;IAC3C,wBAAwB;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,wBAAwB;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,gBAAgB;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,uBAAuB;IACvB,YAAY,EAAE,MAAM,CAAC;IACrB,qBAAqB;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,8BAA8B;IAC9B,OAAO,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,6BAA6B;IAC1C,wBAAwB;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,gBAAgB;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,uBAAuB;IACvB,YAAY,EAAE,MAAM,CAAC;IACrB,qBAAqB;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,uBAAuB;IACvB,OAAO,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,qBAAqB;IAClC,mDAAmD;IACnD,SAAS,EAAE,MAAM,CAAC;IAClB,yCAAyC;IACzC,OAAO,EAAE,MAAM,CAAC;IAChB,iFAAiF;IACjF,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;GAKG;AACH,MAAM,WAAW,yBAAyB;IACtC,yCAAyC;IACzC,SAAS,EAAE,MAAM,CAAC;IAClB,4DAA4D;IAC5D,KAAK,EAAE,UAAU,GAAG,UAAU,CAAC;CAClC;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,uBAAuB;IACpC,2DAA2D;IAC3D,QAAQ,EAAE,MAAM,CAAC;IACjB,4CAA4C;IAC5C,IAAI,EAAE,UAAU,GAAG,QAAQ,CAAC;IAC5B,6EAA6E;IAC7E,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,8CAA8C;IAC9C,IAAI,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC;IAC5B,kFAAkF;IAClF,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,4BAA4B;IACzC,8CAA8C;IAC9C,SAAS,EAAE,MAAM,CAAC;IAClB,4DAA4D;IAC5D,KAAK,CAAC,EAAE,WAAW,CAAC;CACvB"}
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../src/types/events.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAM/C;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IAClC,qCAAqC;IACrC,OAAO,EAAE,MAAM,CAAC;IAEhB,mCAAmC;IACnC,SAAS,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,yEAAyE;IACzE,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC;CAClB;AAMD;;;;;;GAMG;AACH,MAAM,WAAW,4BAA4B;IACzC;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,2EAA2E;IAC3E,KAAK,CAAC,EAAE,WAAW,CAAC;CACvB;AAMD;;;;;;;;;;GAUG;AACH,MAAM,WAAW,4BAA4B;IACzC,0DAA0D;IAC1D,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,+DAA+D;IAC/D,OAAO,EAAE,MAAM,CAAC;IAEhB,mCAAmC;IACnC,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,sCAAsC;IACtC,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAMD;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAC9B,iBAAiB;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,2EAA2E;IAC3E,KAAK,EAAE,MAAM,CAAC;IACd,2DAA2D;IAC3D,KAAK,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,+BAA+B;IAC5C,oDAAoD;IACpD,SAAS,EAAE,MAAM,CAAC;IAClB,uEAAuE;IACvE,SAAS,EAAE,MAAM,GAAG,MAAM,CAAC;CAC9B;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,4BAA4B;IACzC,oDAAoD;IACpD,QAAQ,EAAE,aAAa,EAAE,CAAC;IAC1B,2DAA2D;IAC3D,QAAQ,EAAE,iBAAiB,EAAE,CAAC;CACjC;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,sBAAsB;IACnC,wFAAwF;IACxF,SAAS,EAAE,MAAM,CAAC;IAClB,iFAAiF;IACjF,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAMD;;;;;;GAMG;AACH,MAAM,WAAW,8BAA8B;IAC3C,wBAAwB;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,uEAAuE;IACvE,SAAS,EAAE,MAAM,CAAC;IAClB,kFAAkF;IAClF,QAAQ,EAAE,MAAM,CAAC;IACjB,mFAAmF;IACnF,YAAY,EAAE,MAAM,CAAC;IACrB,uDAAuD;IACvD,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,8BAA8B;IAC3C,wBAAwB;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,qCAAqC;IACrC,KAAK,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,8BAA8B;IAC3C,wBAAwB;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,wBAAwB;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,gBAAgB;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,uBAAuB;IACvB,YAAY,EAAE,MAAM,CAAC;IACrB,qBAAqB;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,8BAA8B;IAC9B,OAAO,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,mCAAmC;IAChD,wBAAwB;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,gBAAgB;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,uBAAuB;IACvB,YAAY,EAAE,MAAM,CAAC;IACrB,qBAAqB;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,uBAAuB;IACvB,OAAO,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,qBAAqB;IAClC,mDAAmD;IACnD,SAAS,EAAE,MAAM,CAAC;IAClB,yCAAyC;IACzC,OAAO,EAAE,MAAM,CAAC;IAChB,iFAAiF;IACjF,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;GAKG;AACH,MAAM,WAAW,yBAAyB;IACtC,yCAAyC;IACzC,SAAS,EAAE,MAAM,CAAC;IAClB,4DAA4D;IAC5D,KAAK,EAAE,UAAU,GAAG,UAAU,CAAC;CAClC;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,uBAAuB;IACpC,2DAA2D;IAC3D,QAAQ,EAAE,MAAM,CAAC;IACjB,4CAA4C;IAC5C,IAAI,EAAE,UAAU,GAAG,QAAQ,CAAC;IAC5B,6EAA6E;IAC7E,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,8CAA8C;IAC9C,IAAI,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC;IAC5B,kFAAkF;IAClF,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,4BAA4B;IACzC,8CAA8C;IAC9C,SAAS,EAAE,MAAM,CAAC;IAClB,4DAA4D;IAC5D,KAAK,CAAC,EAAE,WAAW,CAAC;CACvB;AAeD;;;;;;GAMG;AACH,MAAM,WAAW,6BAA6B;IAC1C,yDAAyD;IACzD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,mDAAmD;IACnD,SAAS,EAAE,MAAM,CAAC;IAClB,+EAA+E;IAC/E,IAAI,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,6BAA6B;IAC1C,yDAAyD;IACzD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,qCAAqC;IACrC,SAAS,EAAE,MAAM,CAAC;IAClB,kFAAkF;IAClF,KAAK,EAAE,WAAW,CAAC;CACtB;AAED;;;;;GAKG;AACH,MAAM,WAAW,+BAA+B;IAC5C,yDAAyD;IACzD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,sBAAsB;IACnC,sDAAsD;IACtD,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,wBAAwB;IACrC,yDAAyD;IACzD,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,4BAA4B;IACzC,iFAAiF;IACjF,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,qDAAqD;IACrD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,8DAA8D;IAC9D,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,6BAA6B;IAC1C,qCAAqC;IACrC,KAAK,EAAE,MAAM,CAAC;CACjB;AAMD;;;;;;;GAOG;AACH,MAAM,WAAW,kCAAkC;IAC/C,6CAA6C;IAC7C,GAAG,EAAE,MAAM,CAAC;IACZ,2DAA2D;IAC3D,IAAI,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,4BAA4B;IACzC;;;OAGG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,8CAA8C;IAC9C,OAAO,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,6BAA6B;IAC1C,qEAAqE;IACrE,SAAS,EAAE,MAAM,CAAC;IAClB,4CAA4C;IAC5C,QAAQ,EAAE,MAAM,CAAC;IACjB,2CAA2C;IAC3C,KAAK,EAAE,MAAM,CAAC;IACd,sCAAsC;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,uBAAuB;IACvB,MAAM,EAAE,UAAU,GAAG,WAAW,CAAC;IACjC,sEAAsE;IACtE,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED;;;;;GAKG;AACH,MAAM,WAAW,6BAA6B;IAC1C,4CAA4C;IAC5C,SAAS,EAAE,MAAM,CAAC;IAClB,2EAA2E;IAC3E,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,oEAAoE;IACpE,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB"}

package/dist/types/index.d.ts

@@ -7,16 +7,15 @@
  * @packageDocumentation
  */
 export type { AparteStatus, AparteBubbleRole, AparteAttachment, AparteMessage, AparteMessageBranch, AparteBubbleActionsConfig, AparteBubbleActionName, AparteViewportConfig, AparteInputConfig } from './models.js';
-export type { AparteSendEventDetail, AparteTokenEventDetail, AparteControlEvent, AparteMessageEventDetail, AparteStatusEventDetail, AparteSiblingInfo, AparteBranchNavigateEventDetail, ApartePathChangedEventDetail, AparteRetryEventDetail, AparteEditEventDetail, AparteFeedbackEventDetail, AparteActionEventDetail } from './events.js';
+export type { AparteSendEventDetail, AparteSiblingInfo, AparteBranchNavigateEventDetail, ApartePathChangedEventDetail, AparteRetryEventDetail, AparteEditEventDetail, AparteFeedbackEventDetail, AparteActionEventDetail } from './events.js';
 export type { AparteContentParser, AparteParserRegistry } from './parsers.js';
-export type { AparteSegmentBase, AparteTextSegment, AparteThinkingSegment, AparteCodeSegment, AparteDiffSegment, AparteDiffHunk, AparteDiffLine, AparteTerminalSegment, AparteFileTreeSegment, AparteFileNode, AparteImageSegment, ApartePreviewSegment, AparteErrorSegment, AparteProgressSegment, AparteSegment, AparteCustomSegment, AparteToolCallSegment, AparteArtifactSegment, AparteSegmentType, AparteSegmentRenderer, AparteSegmentActionEvent, AparteSegmentUpdateEvent } from './segments.js';
-export type { AparteDataProvider, AparteStreamProvider, AparteMessageStore, AparteControlHandler } from './providers.js';
+export type { AparteSegmentBase, AparteTextSegment, AparteThinkingSegment, AparteCodeSegment, AparteDiffSegment, AparteDiffHunk, AparteDiffLine, AparteTerminalSegment, AparteFileTreeSegment, AparteFileNode, AparteImageSegment, ApartePreviewSegment, AparteErrorSegment, AparteProgressSegment, AparteSegment, AparteCustomSegment, AparteToolCallSegment, AparteArtifactSegment, AparteSegmentType, AparteSegmentRenderer, AparteSegmentUpdateEventDetail } from './segments.js';
 export type { AparteThemeVariables } from './theming.js';
 export type { AparteAIModel, AparteAIProvider, AparteAIProviderConfigField, AparteAIProviderConfigSchema, AparteModelConfig, ModelStatus, ModelLoadProgress } from './model-provider.js';
 export type { AparteChatRequest, AparteChatResponse, AparteChatMessage, AparteContentPart, AparteTextPart, AparteImagePart, AparteFilePart, AparteStreamEvent, AparteStreamEventMap, AparteUsage } from './chat.js';
 export { contentToText } from './chat.js';
-export type { AparteTool, AparteToolCall, AparteToolResult, AparteToolHandler, AparteToolRenderer, AparteToolDecisionDetail, AparteToolApprovalRequestDetail, AparteToolActionDetail } from './tools.js';
+export type { AparteTool, AparteToolCall, AparteToolResult, AparteToolHandler, AparteToolContext, AparteToolRenderer, AparteToolDecisionDetail, AparteToolApprovalRequestDetail, } from './tools.js';
 export { AparteErrorCode, AparteError } from './errors.js';
-export type { AparteModelChangeEventDetail, AparteMessageDoneEventDetail, AparteMessageInfoEventDetail, AparteArtifactStartEventDetail, AparteArtifactDeltaEventDetail, AparteArtifactReadyEventDetail, AparteArtifactOpenEventDetail } from './events.js';
+export type { AparteModelChangeEventDetail, AparteMessageDoneEventDetail, AparteMessageStartEventDetail, AparteMessageErrorEventDetail, AparteMessageAbortedEventDetail, AparteAbortEventDetail, AparteCompactEventDetail, AparteCompactDoneEventDetail, AparteCompactErrorEventDetail, AparteAttachmentPreviewEventDetail, AparteTerminalRunEventDetail, AparteFileGenReadyEventDetail, AparteFileGenErrorEventDetail, AparteMessageInfoEventDetail, AparteArtifactStartEventDetail, AparteArtifactDeltaEventDetail, AparteArtifactReadyEventDetail, AparteArtifactRedownloadEventDetail } from './events.js';
 export type { AparteChatImperativeApi } from './imperative-api.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAMH,YAAY,EACR,YAAY,EACZ,gBAAgB,EAChB,gBAAgB,EAChB,aAAa,EACb,mBAAmB,EACnB,yBAAyB,EACzB,sBAAsB,EACtB,oBAAoB,EACpB,iBAAiB,EACpB,MAAM,aAAa,CAAC;AAMrB,YAAY,EACR,qBAAqB,EACrB,sBAAsB,EACtB,kBAAkB,EAClB,wBAAwB,EACxB,uBAAuB,EACvB,iBAAiB,EACjB,+BAA+B,EAC/B,4BAA4B,EAC5B,sBAAsB,EACtB,qBAAqB,EACrB,yBAAyB,EACzB,uBAAuB,EAC1B,MAAM,aAAa,CAAC;AAMrB,YAAY,EACR,mBAAmB,EACnB,oBAAoB,EACvB,MAAM,cAAc,CAAC;AAMtB,YAAY,EACR,iBAAiB,EACjB,iBAAiB,EACjB,qBAAqB,EACrB,iBAAiB,EACjB,iBAAiB,EACjB,cAAc,EACd,cAAc,EACd,qBAAqB,EACrB,qBAAqB,EACrB,cAAc,EACd,kBAAkB,EAClB,oBAAoB,EACpB,kBAAkB,EAClB,qBAAqB,EACrB,aAAa,EACb,mBAAmB,EACnB,qBAAqB,EACrB,qBAAqB,EACrB,iBAAiB,EACjB,qBAAqB,EACrB,wBAAwB,EACxB,wBAAwB,EAC3B,MAAM,eAAe,CAAC;AAMvB,YAAY,EACR,kBAAkB,EAClB,oBAAoB,EACpB,kBAAkB,EAClB,oBAAoB,EACvB,MAAM,gBAAgB,CAAC;AAMxB,YAAY,EACR,oBAAoB,EACvB,MAAM,cAAc,CAAC;AAMtB,YAAY,EACR,aAAa,EACb,gBAAgB,EAChB,2BAA2B,EAC3B,4BAA4B,EAC5B,iBAAiB,EACjB,WAAW,EACX,iBAAiB,EACpB,MAAM,qBAAqB,CAAC;AAE7B,YAAY,EACR,iBAAiB,EACjB,kBAAkB,EAClB,iBAAiB,EACjB,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,cAAc,EACd,iBAAiB,EACjB,oBAAoB,EACpB,WAAW,EACd,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAE1C,YAAY,EACR,UAAU,EACV,cAAc,EACd,gBAAgB,EAChB,iBAAiB,EACjB,kBAAkB,EAClB,wBAAwB,EACxB,+BAA+B,EAC/B,sBAAsB,EACzB,MAAM,YAAY,CAAC;AAMpB,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE3D,YAAY,EACR,4BAA4B,EAC5B,4BAA4B,EAC5B,4BAA4B,EAC5B,8BAA8B,EAC9B,8BAA8B,EAC9B,8BAA8B,EAC9B,6BAA6B,EAChC,MAAM,aAAa,CAAC;AAGrB,YAAY,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAMH,YAAY,EACR,YAAY,EACZ,gBAAgB,EAChB,gBAAgB,EAChB,aAAa,EACb,mBAAmB,EACnB,yBAAyB,EACzB,sBAAsB,EACtB,oBAAoB,EACpB,iBAAiB,EACpB,MAAM,aAAa,CAAC;AAMrB,YAAY,EACR,qBAAqB,EACrB,iBAAiB,EACjB,+BAA+B,EAC/B,4BAA4B,EAC5B,sBAAsB,EACtB,qBAAqB,EACrB,yBAAyB,EACzB,uBAAuB,EAC1B,MAAM,aAAa,CAAC;AAMrB,YAAY,EACR,mBAAmB,EACnB,oBAAoB,EACvB,MAAM,cAAc,CAAC;AAMtB,YAAY,EACR,iBAAiB,EACjB,iBAAiB,EACjB,qBAAqB,EACrB,iBAAiB,EACjB,iBAAiB,EACjB,cAAc,EACd,cAAc,EACd,qBAAqB,EACrB,qBAAqB,EACrB,cAAc,EACd,kBAAkB,EAClB,oBAAoB,EACpB,kBAAkB,EAClB,qBAAqB,EACrB,aAAa,EACb,mBAAmB,EACnB,qBAAqB,EACrB,qBAAqB,EACrB,iBAAiB,EACjB,qBAAqB,EACrB,8BAA8B,EACjC,MAAM,eAAe,CAAC;AAgBvB,YAAY,EACR,oBAAoB,EACvB,MAAM,cAAc,CAAC;AAMtB,YAAY,EACR,aAAa,EACb,gBAAgB,EAChB,2BAA2B,EAC3B,4BAA4B,EAC5B,iBAAiB,EACjB,WAAW,EACX,iBAAiB,EACpB,MAAM,qBAAqB,CAAC;AAE7B,YAAY,EACR,iBAAiB,EACjB,kBAAkB,EAClB,iBAAiB,EACjB,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,cAAc,EACd,iBAAiB,EACjB,oBAAoB,EACpB,WAAW,EACd,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAE1C,YAAY,EACR,UAAU,EACV,cAAc,EACd,gBAAgB,EAChB,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,EAClB,wBAAwB,EACxB,+BAA+B,GAClC,MAAM,YAAY,CAAC;AAMpB,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE3D,YAAY,EACR,4BAA4B,EAC5B,4BAA4B,EAC5B,6BAA6B,EAC7B,6BAA6B,EAC7B,+BAA+B,EAC/B,sBAAsB,EACtB,wBAAwB,EACxB,4BAA4B,EAC5B,6BAA6B,EAC7B,kCAAkC,EAClC,4BAA4B,EAC5B,6BAA6B,EAC7B,6BAA6B,EAC7B,4BAA4B,EAC5B,8BAA8B,EAC9B,8BAA8B,EAC9B,8BAA8B,EAC9B,mCAAmC,EACtC,MAAM,aAAa,CAAC;AAGrB,YAAY,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC"}

package/dist/types/model-provider.d.ts

@@ -113,26 +113,13 @@ export interface AparteAIProviderConfigSchema {
     fields: AparteAIProviderConfigField[];
 }
 /**
- * Represents an AI provider (e.g., OpenRouter, OpenAI, Anthropic).
+ * What every provider carries, whichever half of the contract it implements:
+ * an identity, brand metadata, and a synchronous model list.
  *
- * Providers can return a static list of models or fetch them dynamically.
- *
- * @example
- * ```typescript
- * const provider: AparteAIProvider = {
- *   id: 'openrouter',
- *   getMetadata: () => ({
- *     name: 'OpenRouter',
- *     id: 'openrouter',
- *     icon: '<svg>...</svg>',
- *     color: '#000000',
- *     helpUrl: 'https://openrouter.ai/keys'
- *   }),
- *   getModels: () => [...]
- * };
- * ```
+ * On its own this is **not** a usable provider — see {@link AparteAIProvider},
+ * which requires one of the two execution surfaces as well.
  */
-export interface AparteAIProvider {
+export interface AparteAIProviderCore {
     /** Unique identifier for the provider */
     id: string;
     /**
@@ -144,7 +131,7 @@ export interface AparteAIProvider {
      * list). Never return a Promise here — it would be ignored by
      * `getCurrentModel()`, silently disabling capability gates such as
      * `function_calling` (tools). For async fetching implement
-     * {@link fetchModels} instead, which `AparteConfig.refreshProviderModels()`
+     * {@link fetchModels} instead, which `aparteGlobalConfig.refreshProviderModels()`
      * and the model-selector consume. Note: a provider without `fetchModels`
      * shows no models in the model-selector — `getModels()` is only read for
      * the current-model lookup.
@@ -157,41 +144,6 @@ export interface AparteAIProvider {
      * @param config - Optional API key or full configuration object for authenticated requests
      */
     fetchModels?(config?: string | Record<string, string>): Promise<AparteAIModel[]>;
-    /**
-     * Execute a chat request directly. **Optional** — HTTP providers expose the
-     * format-adapter surface below and are driven by an `AparteTransport` instead;
-     * providers that own their own I/O (Transformers.js locally, or a bridge
-     * wrapping an external SDK) implement `chat`, to which `DirectTransport`
-     * delegates.
-     *
-     * @param request - The chat request options (messages, model, etc.)
-     * @param config - Optional API key or full configuration object
-     * @param ctx - Transport context (structurally mirrors `AparteTransportContext`;
-     *   inline to avoid a type cycle with `transport/types`). `signal` aborts the
-     *   in-flight call — bridges MUST honor it so a user "stop" cancels the
-     *   underlying request, not just the local read.
-     * @returns ReadableStream for streaming or string for full response
-     */
-    chat?(request: AparteChatRequest, config?: string | Record<string, string>, ctx?: {
-        providerId: string;
-        signal?: AbortSignal;
-    }): Promise<AparteChatResponse>;
-    /** Build the vendor HTTP request from an Aparte request (auth injected by the transport). */
-    buildRequest?(request: AparteChatRequest): {
-        path: string;
-        body: unknown;
-        headers?: Record<string, string>;
-    };
-    /** Vendor auth headers for a resolved key (browser-direct only). */
-    authHeaders?(key: string): Record<string, string>;
-    /** Vendor auth as URL query params for a resolved key (e.g. Gemini `?key=`). */
-    authQuery?(key: string): Record<string, string>;
-    /** Base URL for browser-direct calls (overridable per request via config). */
-    defaultEndpoint?: string;
-    /** Parse a streaming vendor response body into unified events. */
-    parseStream?(body: ReadableStream<Uint8Array>): ReadableStream<AparteStreamEvent>;
-    /** Extract text from a non-streaming vendor JSON response. */
-    parseText?(json: unknown): string;
     /**
      * Optional. Returns the availability status of a model.
      *
@@ -219,6 +171,100 @@ export interface AparteAIProvider {
      */
     deleteModel?(modelId: string): Promise<void>;
 }
+/**
+ * Execution surface for a provider that **owns its own I/O** — Transformers.js
+ * running locally, or a bridge wrapping an external SDK. `AparteDirectTransport`
+ * delegates to `chat()` and stays out of the way.
+ */
+export interface AparteAIProviderChat {
+    /**
+     * @param request - The chat request options (messages, model, etc.)
+     * @param config - Optional API key or full configuration object
+     * @param ctx - Transport context (structurally mirrors `AparteTransportContext`;
+     *   inline to avoid a type cycle with `transport/types`). `signal` aborts the
+     *   in-flight call — bridges MUST honor it so a user "stop" cancels the
+     *   underlying request, not just the local read.
+     * @returns ReadableStream for streaming or string for full response
+     */
+    chat(request: AparteChatRequest, config?: string | Record<string, string>, ctx?: {
+        providerId: string;
+        signal?: AbortSignal;
+    }): Promise<AparteChatResponse>;
+}
+/**
+ * Execution surface for a provider that only **shapes payloads** (transport ⊥
+ * format): an `AparteTransport` performs the call and handles auth, and the
+ * provider builds the request and parses the stream. See `src/transport/`.
+ */
+export interface AparteAIProviderFormat {
+    /** Base URL for browser-direct calls (overridable per request via config). */
+    defaultEndpoint: string;
+    /** Build the vendor HTTP request from an Aparte request (auth injected by the transport). */
+    buildRequest(request: AparteChatRequest): {
+        path: string;
+        body: unknown;
+        headers?: Record<string, string>;
+    };
+    /** Parse a streaming vendor response body into unified events. */
+    parseStream(body: ReadableStream<Uint8Array>): ReadableStream<AparteStreamEvent>;
+    /** Extract text from a non-streaming vendor JSON response. */
+    parseText?(json: unknown): string;
+}
+/** Both ways a format adapter can present a resolved key. At least one is required. */
+export interface AparteAIProviderAuthMembers {
+    /** Vendor auth headers for a resolved key (browser-direct only). */
+    authHeaders?(key: string): Record<string, string>;
+    /** Vendor auth as URL query params for a resolved key (e.g. Gemini `?key=`). */
+    authQuery?(key: string): Record<string, string>;
+}
+/**
+ * A format adapter with no way to present a key cannot be called, so the union
+ * demands one of the two — mirroring `isFormatAdapter`, which accepts either.
+ */
+export type AparteAIProviderAuth = (AparteAIProviderAuthMembers & {
+    authHeaders(key: string): Record<string, string>;
+}) | (AparteAIProviderAuthMembers & {
+    authQuery(key: string): Record<string, string>;
+});
+/**
+ * An AI provider (e.g. OpenRouter, OpenAI, Transformers.js).
+ *
+ * A **union, not one interface**, because there are two mutually sufficient ways
+ * to be a provider and the compiler should say which one you implemented. It used
+ * to be a single interface with three required members and fifteen optional ones,
+ * discriminated at RUNTIME by `isFormatAdapter()` — so `{ id, getMetadata,
+ * getModels }` typechecked, registered, and then failed on the first message with
+ * nothing at build time to warn you.
+ *
+ * Every member of both surfaces stays reachable on the union (optional on the arm
+ * that does not require it), so runtime probes like `typeof p.buildRequest ===
+ * 'function'` and `isFormatAdapter()` narrowing keep working unchanged. A provider
+ * implementing both surfaces is valid and satisfies the format arm.
+ *
+ * @example A format adapter — a transport does the call
+ * ```typescript
+ * const provider: AparteAIProvider = {
+ *   id: 'openrouter',
+ *   getMetadata: () => ({ name: 'OpenRouter', id: 'openrouter', icon: '<svg/>', color: '#000' }),
+ *   getModels: () => [],
+ *   defaultEndpoint: 'https://openrouter.ai/api/v1',
+ *   buildRequest: (req) => ({ path: '/chat/completions', body: req }),
+ *   authHeaders: (key) => ({ Authorization: `Bearer ${key}` }),
+ *   parseStream: (body) => body as unknown as ReadableStream<AparteStreamEvent>,
+ * };
+ * ```
+ *
+ * @example A provider owning its own I/O
+ * ```typescript
+ * const local: AparteAIProvider = {
+ *   id: 'transformers',
+ *   getMetadata: () => ({ name: 'Transformers.js', id: 'transformers', icon: '<svg/>', color: '#000' }),
+ *   getModels: () => [],
+ *   chat: async (request) => runLocally(request),
+ * };
+ * ```
+ */
+export type AparteAIProvider = (AparteAIProviderCore & AparteAIProviderFormat & AparteAIProviderAuth & Partial<AparteAIProviderChat>) | (AparteAIProviderCore & AparteAIProviderChat & Partial<AparteAIProviderFormat> & AparteAIProviderAuthMembers);
 /**
  * Configuration options for model selection behavior.
  */

package/dist/types/model-provider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"model-provider.d.ts","sourceRoot":"","sources":["../../src/types/model-provider.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAMrF;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,aAAa;IAC1B,6EAA6E;IAC7E,EAAE,EAAE,MAAM,CAAC;IAEX,kCAAkC;IAClC,IAAI,EAAE,MAAM,CAAC;IAEb,6CAA6C;IAC7C,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,mDAAmD;IACnD,OAAO,CAAC,EAAE;QACN,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;KAClB,CAAC;IAEF,gCAAgC;IAChC,YAAY,CAAC,EAAE,CAAC,QAAQ,GAAG,kBAAkB,GAAG,WAAW,GAAG,MAAM,GAAG,WAAW,CAAC,EAAE,CAAC;IAEtF,wDAAwD;IACxD,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,8CAA8C;IAC9C,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACtC;AAMD;;;;;GAKG;AACH,MAAM,MAAM,WAAW,GACjB,OAAO,GACP,QAAQ,GACR,gBAAgB,CAAC;AAEvB;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAC9B,uCAAuC;IACvC,MAAM,EAAE,aAAa,GAAG,SAAS,GAAG,QAAQ,GAAG,OAAO,GAAG,OAAO,CAAC;IACjE,gEAAgE;IAChE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,gCAAgC;IAChC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,sCAAsC;IACtC,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAMD;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACrC,kCAAkC;IAClC,IAAI,EAAE,MAAM,CAAC;IAEb,kBAAkB;IAClB,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,gDAAgD;IAChD,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,oCAAoC;IACpC,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,uDAAuD;IACvD,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB,4DAA4D;IAC5D,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,qEAAqE;IACrE,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,iDAAiD;IACjD,YAAY,CAAC,EAAE,4BAA4B,CAAC;CAC/C;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IACxC,mEAAmE;IACnE,EAAE,EAAE,MAAM,CAAC;IACX,qCAAqC;IACrC,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,KAAK,CAAC;IAClC,0DAA0D;IAC1D,KAAK,EAAE,MAAM,CAAC;IACd,uBAAuB;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,oBAAoB;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,8CAA8C;IAC9C,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,qEAAqE;IACrE,UAAU,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IACzC,MAAM,EAAE,2BAA2B,EAAE,CAAC;CACzC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,WAAW,gBAAgB;IAC7B,yCAAyC;IACzC,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,IAAI,wBAAwB,CAAC;IAExC;;;;;;;;;OASG;IACH,SAAS,IAAI,aAAa,EAAE,CAAC;IAE7B;;;;;OAKG;IACH,WAAW,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC,CAAC;IAEjF;;;;;;;;;;;;;;OAcG;IACH,IAAI,CAAC,CACD,OAAO,EAAE,iBAAiB,EAC1B,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACxC,GAAG,CAAC,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,WAAW,CAAA;KAAE,GACnD,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAS/B,6FAA6F;IAC7F,YAAY,CAAC,CAAC,OAAO,EAAE,iBAAiB,GAAG;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAAE,CAAC;IAC7G,oEAAoE;IACpE,WAAW,CAAC,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClD,gFAAgF;IAChF,SAAS,CAAC,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChD,8EAA8E;IAC9E,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,kEAAkE;IAClE,WAAW,CAAC,CAAC,IAAI,EAAE,cAAc,CAAC,UAAU,CAAC,GAAG,cAAc,CAAC,iBAAiB,CAAC,CAAC;IAClF,8DAA8D;IAC9D,SAAS,CAAC,CAAC,IAAI,EAAE,OAAO,GAAG,MAAM,CAAC;IAElC;;;;;;;;;OASG;IACH,cAAc,CAAC,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAEvD;;;;;;;OAOG;IACH,YAAY,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC,EAAE,iBAAiB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1F;;;;OAIG;IACH,WAAW,CAAC,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAChD;AAMD;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAC9B,iDAAiD;IACjD,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE5B,gCAAgC;IAChC,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IAExC,0BAA0B;IAC1B,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,uBAAuB;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB"}
+{"version":3,"file":"model-provider.d.ts","sourceRoot":"","sources":["../../src/types/model-provider.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAMrF;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,aAAa;IAC1B,6EAA6E;IAC7E,EAAE,EAAE,MAAM,CAAC;IAEX,kCAAkC;IAClC,IAAI,EAAE,MAAM,CAAC;IAEb,6CAA6C;IAC7C,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,mDAAmD;IACnD,OAAO,CAAC,EAAE;QACN,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;KAClB,CAAC;IAEF,gCAAgC;IAChC,YAAY,CAAC,EAAE,CAAC,QAAQ,GAAG,kBAAkB,GAAG,WAAW,GAAG,MAAM,GAAG,WAAW,CAAC,EAAE,CAAC;IAEtF,wDAAwD;IACxD,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,8CAA8C;IAC9C,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACtC;AAMD;;;;;GAKG;AACH,MAAM,MAAM,WAAW,GACjB,OAAO,GACP,QAAQ,GACR,gBAAgB,CAAC;AAEvB;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAC9B,uCAAuC;IACvC,MAAM,EAAE,aAAa,GAAG,SAAS,GAAG,QAAQ,GAAG,OAAO,GAAG,OAAO,CAAC;IACjE,gEAAgE;IAChE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,gCAAgC;IAChC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,sCAAsC;IACtC,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAMD;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACrC,kCAAkC;IAClC,IAAI,EAAE,MAAM,CAAC;IAEb,kBAAkB;IAClB,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,gDAAgD;IAChD,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,oCAAoC;IACpC,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,uDAAuD;IACvD,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB,4DAA4D;IAC5D,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,qEAAqE;IACrE,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,iDAAiD;IACjD,YAAY,CAAC,EAAE,4BAA4B,CAAC;CAC/C;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IACxC,mEAAmE;IACnE,EAAE,EAAE,MAAM,CAAC;IACX,qCAAqC;IACrC,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,KAAK,CAAC;IAClC,0DAA0D;IAC1D,KAAK,EAAE,MAAM,CAAC;IACd,uBAAuB;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,oBAAoB;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,8CAA8C;IAC9C,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,qEAAqE;IACrE,UAAU,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IACzC,MAAM,EAAE,2BAA2B,EAAE,CAAC;CACzC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,oBAAoB;IACjC,yCAAyC;IACzC,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,IAAI,wBAAwB,CAAC;IAExC;;;;;;;;;OASG;IACH,SAAS,IAAI,aAAa,EAAE,CAAC;IAE7B;;;;;OAKG;IACH,WAAW,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC,CAAC;IAEjF;;;;;;;;;OASG;IACH,cAAc,CAAC,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAEvD;;;;;;;OAOG;IACH,YAAY,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC,EAAE,iBAAiB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1F;;;;OAIG;IACH,WAAW,CAAC,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAChD;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACjC;;;;;;;;OAQG;IACH,IAAI,CACA,OAAO,EAAE,iBAAiB,EAC1B,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACxC,GAAG,CAAC,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,WAAW,CAAA;KAAE,GACnD,OAAO,CAAC,kBAAkB,CAAC,CAAC;CAClC;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACnC,8EAA8E;IAC9E,eAAe,EAAE,MAAM,CAAC;IACxB,6FAA6F;IAC7F,YAAY,CAAC,OAAO,EAAE,iBAAiB,GAAG;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAAE,CAAC;IAC5G,kEAAkE;IAClE,WAAW,CAAC,IAAI,EAAE,cAAc,CAAC,UAAU,CAAC,GAAG,cAAc,CAAC,iBAAiB,CAAC,CAAC;IACjF,8DAA8D;IAC9D,SAAS,CAAC,CAAC,IAAI,EAAE,OAAO,GAAG,MAAM,CAAC;CACrC;AAED,uFAAuF;AACvF,MAAM,WAAW,2BAA2B;IACxC,oEAAoE;IACpE,WAAW,CAAC,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClD,gFAAgF;IAChF,SAAS,CAAC,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACnD;AAED;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAC1B,CAAC,2BAA2B,GAAG;IAAE,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAAE,CAAC,GACpF,CAAC,2BAA2B,GAAG;IAAE,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAAE,CAAC,CAAC;AAEzF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,MAAM,MAAM,gBAAgB,GACtB,CAAC,oBAAoB,GAAG,sBAAsB,GAAG,oBAAoB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC,GACtG,CAAC,oBAAoB,GAAG,oBAAoB,GAAG,OAAO,CAAC,sBAAsB,CAAC,GAAG,2BAA2B,CAAC,CAAC;AAMpH;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAC9B,iDAAiD;IACjD,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE5B,gCAAgC;IAChC,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IAExC,0BAA0B;IAC1B,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,uBAAuB;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB"}