juneau 0.1.0 → 0.1.1

package/dist/adapters/createFetchStreamAdapter.d.ts

@@ -0,0 +1,88 @@
+import type { AiBackendAdapter, AiAdapterInput, AiStreamEvent } from '../core/types';
+/**
+ * How to map a raw text chunk from the response body to Juneau stream events.
+ *
+ * Return an array — a chunk may produce one event, multiple, or none (empty array to skip).
+ * The chunk is whatever the server sent — could be a full JSON line, a partial one,
+ * or plain text depending on your backend.
+ */
+export type FetchChunkParser = (chunk: string) => AiStreamEvent[];
+/**
+ * Options for createFetchStreamAdapter.
+ */
+export type FetchStreamAdapterOptions = {
+    /**
+     * HTTP method. Defaults to 'POST'.
+     */
+    method?: string;
+    /**
+     * Static headers merged with Content-Type. Use for auth tokens etc.
+     * For dynamic headers (e.g. per-request auth), use getHeaders instead.
+     *
+     * @example { Authorization: 'Bearer sk-...' }
+     */
+    headers?: Record<string, string>;
+    /**
+     * Dynamic headers — called before every request with the current adapter input.
+     * Merged on top of `headers`. Use this when the token is fetched at runtime.
+     */
+    getHeaders?: (input: AiAdapterInput) => Record<string, string> | Promise<Record<string, string>>;
+    /**
+     * Override the request body. By default sends `{ messages, context }`.
+     * Return anything JSON-serialisable.
+     */
+    getBody?: (input: AiAdapterInput) => unknown;
+    /**
+     * How to parse each chunk from the response stream into Juneau events.
+     *
+     * Defaults to a newline-delimited JSON (NDJSON) parser that expects each
+     * line to be either `{ text: "..." }` or `{ done: true }`.
+     *
+     * @example
+     * // Plain text streaming — treat every chunk as raw text:
+     * parseChunk: (chunk) => chunk ? [{ type: 'text', text: chunk }] : []
+     *
+     * @example
+     * // Custom JSON lines format:
+     * parseChunk: (chunk) => {
+     *   try {
+     *     const json = JSON.parse(chunk);
+     *     if (json.error) return [{ type: 'error', message: json.error }];
+     *     if (json.done) return [{ type: 'done' }];
+     *     if (json.delta) return [{ type: 'text', text: json.delta }];
+     *     return [];
+     *   } catch { return []; }
+     * }
+     */
+    parseChunk?: FetchChunkParser;
+};
+/**
+ * Creates an adapter that connects to a **raw chunked HTTP streaming** endpoint —
+ * for backends that stream newline-delimited JSON (NDJSON) or plain text,
+ * rather than SSE.
+ *
+ * Use `createSseAdapter` instead if your backend streams Server-Sent Events
+ * (the format used by OpenAI, Anthropic, and most AI APIs).
+ *
+ * @example
+ * // NDJSON backend streaming { text: "..." } lines — works with zero config:
+ * const adapter = createFetchStreamAdapter('/api/chat');
+ *
+ * @example
+ * // Plain text streaming (each chunk is raw text, no JSON):
+ * const adapter = createFetchStreamAdapter('/api/chat', {
+ *   parseChunk: (chunk) => chunk ? [{ type: 'text', text: chunk }] : [],
+ * });
+ *
+ * @example
+ * // Custom body + auth:
+ * const adapter = createFetchStreamAdapter('/api/chat', {
+ *   getHeaders: async () => ({ Authorization: `Bearer ${await getToken()}` }),
+ *   getBody: ({ messages, context }) => ({
+ *     history: messages,
+ *     model: context?.model ?? 'default',
+ *   }),
+ * });
+ */
+export declare function createFetchStreamAdapter(url: string, options?: FetchStreamAdapterOptions): AiBackendAdapter;
+//# sourceMappingURL=createFetchStreamAdapter.d.ts.map

package/dist/adapters/createFetchStreamAdapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createFetchStreamAdapter.d.ts","sourceRoot":"","sources":["../../src/adapters/createFetchStreamAdapter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAErF;;;;;;GAMG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,KAAK,EAAE,MAAM,KAAK,aAAa,EAAE,CAAC;AAElE;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEjC;;;OAGG;IACH,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAEjG;;;OAGG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,OAAO,CAAC;IAE7C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAC;CAC/B,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,wBAAwB,CACtC,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,yBAA8B,GACtC,gBAAgB,CAyClB"}

package/dist/adapters/createSseAdapter.d.ts

@@ -0,0 +1,94 @@
+import type { AiBackendAdapter, AiAdapterInput, AiStreamEvent } from '../core/types';
+/**
+ * How to map a parsed SSE data payload to Juneau stream events.
+ *
+ * Return an array — most lines produce one event, but you can return multiple
+ * or an empty array to skip a line entirely.
+ */
+export type SseEventParser = (data: string) => AiStreamEvent[];
+/**
+ * Options for createSseAdapter.
+ */
+export type SseAdapterOptions = {
+    /**
+     * HTTP method. Defaults to 'POST'.
+     */
+    method?: string;
+    /**
+     * Static headers merged with Content-Type. Use for auth tokens etc.
+     * For dynamic headers (e.g. per-request auth), use getHeaders instead.
+     *
+     * @example { Authorization: 'Bearer sk-...' }
+     */
+    headers?: Record<string, string>;
+    /**
+     * Dynamic headers — called before every request with the current adapter input.
+     * Merged on top of `headers`. Use this when the token is fetched at runtime.
+     */
+    getHeaders?: (input: AiAdapterInput) => Record<string, string> | Promise<Record<string, string>>;
+    /**
+     * Override the request body. By default sends `{ messages, context }`.
+     * Return anything JSON-serialisable.
+     */
+    getBody?: (input: AiAdapterInput) => unknown;
+    /**
+     * Custom SSE line parser. Receives the raw string after `data: ` and returns
+     * zero or more Juneau stream events.
+     *
+     * Defaults to an OpenAI-compatible parser that reads
+     * `choices[0].delta.content` and handles `[DONE]`.
+     *
+     * @example
+     * // For a backend that streams { text: "..." } JSON lines:
+     * parseEvent: (data) => {
+     *   const json = JSON.parse(data);
+     *   return json.text ? [{ type: 'text', text: json.text }] : [];
+     * }
+     */
+    parseEvent?: SseEventParser;
+};
+/**
+ * Creates an adapter that connects to a **Server-Sent Events (SSE)** streaming
+ * endpoint — the format used by OpenAI, Anthropic, and most AI backend proxies.
+ *
+ * The default parser understands OpenAI's streaming format out of the box.
+ * Override `parseEvent` for any other SSE schema.
+ *
+ * @example
+ * // OpenAI-compatible backend proxy — works with zero configuration:
+ * const adapter = createSseAdapter('/api/chat');
+ *
+ * @example
+ * // With auth header:
+ * const adapter = createSseAdapter('/api/chat', {
+ *   getHeaders: async () => ({
+ *     Authorization: `Bearer ${await getToken()}`,
+ *   }),
+ * });
+ *
+ * @example
+ * // Custom body shape:
+ * const adapter = createSseAdapter('/api/chat', {
+ *   getBody: ({ messages, context }) => ({
+ *     messages,
+ *     model: 'gpt-4o',
+ *     stream: true,
+ *     ...(context?.systemPrompt ? { system: context.systemPrompt } : {}),
+ *   }),
+ * });
+ *
+ * @example
+ * // Custom SSE schema (backend streams { text: "..." }):
+ * const adapter = createSseAdapter('/api/chat', {
+ *   parseEvent: (data) => {
+ *     try {
+ *       const json = JSON.parse(data);
+ *       return json.text ? [{ type: 'text', text: json.text }] : [];
+ *     } catch {
+ *       return [];
+ *     }
+ *   },
+ * });
+ */
+export declare function createSseAdapter(url: string, options?: SseAdapterOptions): AiBackendAdapter;
+//# sourceMappingURL=createSseAdapter.d.ts.map

package/dist/adapters/createSseAdapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createSseAdapter.d.ts","sourceRoot":"","sources":["../../src/adapters/createSseAdapter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAErF;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,IAAI,EAAE,MAAM,KAAK,aAAa,EAAE,CAAC;AAE/D;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEjC;;;OAGG;IACH,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAEjG;;;OAGG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,OAAO,CAAC;IAE7C;;;;;;;;;;;;;OAaG;IACH,UAAU,CAAC,EAAE,cAAc,CAAC;CAC7B,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,iBAAsB,GAAG,gBAAgB,CAyC/F"}