@blastlauncher/protocol 0.0.0-stage → 3.0.0-alpha.0

package/dist/provider-codec.js

@@ -0,0 +1,57 @@
+// Only attachment data needs a non-JSON representation. Tag strings too, so
+// authored data can never be confused with an encoded value.
+export function encodeModelRequest(request) {
+    return JSON.parse(JSON.stringify({
+        ...request,
+        messages: request.messages?.map((message) => ({
+            ...message,
+            content: typeof message.content === "string"
+                ? message.content
+                : message.content.map((part) => {
+                    if (part.type !== "file")
+                        return part;
+                    const data = part.data;
+                    const encoded = typeof data === "string"
+                        ? { kind: "string", value: data }
+                        : data instanceof URL
+                            ? { kind: "url", value: data.href }
+                            : {
+                                kind: data instanceof ArrayBuffer ? "buffer" : "bytes",
+                                value: Array.from(new Uint8Array(data instanceof ArrayBuffer ? data : data.buffer, data instanceof ArrayBuffer ? 0 : data.byteOffset, data.byteLength)),
+                            };
+                    return { ...part, data: encoded };
+                }),
+        })),
+    }));
+}
+export function decodeModelRequest(value) {
+    const request = value;
+    return {
+        ...request,
+        ...(request.messages === undefined
+            ? {}
+            : {
+                messages: request.messages.map((message) => ({
+                    ...message,
+                    content: typeof message.content === "string"
+                        ? message.content
+                        : message.content.map((part) => {
+                            if (part.type !== "file")
+                                return part;
+                            const data = part.data;
+                            if (data.kind === "string" && typeof data.value === "string")
+                                return { ...part, data: data.value };
+                            if (data.kind === "url" && typeof data.value === "string")
+                                return { ...part, data: new URL(data.value) };
+                            if ((data.kind === "bytes" || data.kind === "buffer") &&
+                                Array.isArray(data.value) &&
+                                data.value.every((n) => Number.isInteger(n) && n >= 0 && n <= 255)) {
+                                const bytes = new Uint8Array(data.value);
+                                return { ...part, data: data.kind === "buffer" ? bytes.buffer : bytes };
+                            }
+                            throw new Error("Invalid encoded attachment data");
+                        }),
+                })),
+            }),
+    };
+}

package/dist/provider.d.ts

@@ -0,0 +1,236 @@
+import type { JsonValue } from "./messages.js";
+export type GetModels<TIcon = unknown> = () => RegisteredModel<TIcon>[] | Promise<RegisteredModel<TIcon>[]>;
+export type RegisteredModel<TIcon = unknown> = {
+    id: string;
+    title: string;
+    isLocal?: boolean;
+    icon?: TIcon;
+    description?: string;
+    capabilities?: {
+        systemMessage?: {
+            supported: boolean;
+        };
+        temperature?: {
+            supported: boolean;
+        };
+        vision?: {
+            mediaTypes: Array<"image/png" | "image/jpeg" | "image/webp" | "image/gif">;
+        };
+        tools?: {
+            supported: boolean;
+        };
+        streaming?: {
+            supported: boolean;
+        };
+        reasoningEffort?: {
+            supported: boolean;
+            options: string[];
+            default: string;
+        };
+    };
+    contextWindow?: number;
+    sizeInBytes?: number;
+};
+export type ModelAssistantMessageContent = Array<{
+    type: "text";
+    text: string;
+} | {
+    type: "file";
+    data: string | Uint8Array | ArrayBuffer | URL;
+    mediaType: string;
+} | {
+    type: "reasoning";
+    text: string;
+} | {
+    type: "tool-call";
+    toolCallId: string;
+    toolName: string;
+    input: unknown;
+}>;
+export type ModelFullStream = ReadableStream<ModelStreamPart> | AsyncIterable<ModelStreamPart>;
+export type ModelMessage = {
+    role: "system";
+    content: string;
+} | {
+    role: "user";
+    content: ModelUserMessageContent;
+} | {
+    role: "assistant";
+    content: ModelAssistantMessageContent;
+} | {
+    role: "tool";
+    content: Array<{
+        type: "tool-result";
+        toolCallId: string;
+        toolName: string;
+        input?: unknown;
+        output: {
+            type: "json";
+            value: JsonValue;
+        };
+    }>;
+};
+export type ModelProviderOptions = Record<string, Record<string, unknown>> & {
+    raycast: Record<string, unknown> & {
+        locale: string;
+        currentDate: string;
+        reasoningEffort?: string;
+        sessionId: string;
+    };
+};
+export type ModelRequest = {
+    system?: string;
+    messages?: ModelMessage[];
+    temperature?: number;
+    tools?: ModelToolSet;
+    toolChoice?: "auto" | "required";
+    providerOptions: ModelProviderOptions;
+};
+export type ModelStream = ModelFullStream | ModelTextStream | {
+    fullStream: ModelFullStream;
+} | {
+    textStream: ModelTextStream;
+};
+export type ModelStreamPart = {
+    type: "text-start";
+    id: string;
+    [key: string]: unknown;
+} | {
+    type: "text-end";
+    id: string;
+    [key: string]: unknown;
+} | {
+    type: "text";
+    text: string;
+} | {
+    type: "text-delta";
+    id?: string;
+    text?: string;
+    textDelta?: string;
+    [key: string]: unknown;
+} | {
+    type: "reasoning-start";
+    id: string;
+    [key: string]: unknown;
+} | {
+    type: "reasoning-end";
+    id: string;
+    [key: string]: unknown;
+} | {
+    type: "reasoning";
+    text: string;
+} | {
+    type: "reasoning-delta";
+    id?: string;
+    text?: string;
+    textDelta?: string;
+    [key: string]: unknown;
+} | {
+    type: "source";
+    sourceType: "url";
+    id: string;
+    url: string;
+    title?: string;
+    [key: string]: unknown;
+} | {
+    type: "source";
+    sourceType: "document";
+    id: string;
+    mediaType: string;
+    title?: string;
+    filename?: string;
+    [key: string]: unknown;
+} | {
+    type: "file";
+    file: unknown;
+} | {
+    type: "tool-call-streaming-start";
+    toolCallId: string;
+    toolName: string;
+} | {
+    type: "tool-call-delta";
+    toolCallId: string;
+    toolName: string;
+    argsTextDelta: string;
+} | {
+    type: "tool-input-start";
+    id: string;
+    toolName: string;
+    [key: string]: unknown;
+} | {
+    type: "tool-input-end";
+    id: string;
+    [key: string]: unknown;
+} | {
+    type: "tool-input-delta";
+    id: string;
+    delta: string;
+    [key: string]: unknown;
+} | {
+    type: "tool-input-error";
+    id?: string;
+    error?: unknown;
+    [key: string]: unknown;
+} | {
+    type: "tool-call";
+    toolCallId: string;
+    toolName: string;
+    input: unknown;
+} | {
+    type: "tool-result";
+    toolCallId: string;
+    toolName: string;
+    input?: unknown;
+    output?: unknown;
+} | {
+    type: "tool-error";
+    toolCallId: string;
+    toolName: string;
+    input?: unknown;
+    error: unknown;
+    [key: string]: unknown;
+} | {
+    type: "tool-output-denied";
+    toolCallId: string;
+    toolName: string;
+    [key: string]: unknown;
+} | {
+    type: "tool-approval-request";
+    approvalId: string;
+    toolCall: unknown;
+    [key: string]: unknown;
+} | {
+    type: "finish";
+    finishReason: "stop" | "length" | "content-filter" | "tool-calls" | "error" | "other" | "unknown";
+    totalUsage?: {
+        inputTokens?: number;
+        outputTokens?: number;
+        totalTokens?: number;
+        [key: string]: unknown;
+    };
+} | {
+    type: "error";
+    error: unknown;
+} | {
+    type: "abort";
+    reason?: unknown;
+} | {
+    type: "start" | "stream-start" | "response-metadata" | "start-step" | "finish-step" | "reasoning-part-finish" | "step-start" | "raw";
+    [key: string]: unknown;
+};
+export type ModelTextStream = ReadableStream<string> | AsyncIterable<string>;
+export type ModelTool = {
+    type?: "function";
+    description?: string;
+    inputSchema?: unknown;
+};
+export type ModelToolSet = Record<string, ModelTool>;
+export type ModelUserMessageContent = Array<{
+    type: "text";
+    text: string;
+} | {
+    type: "file";
+    data: string | Uint8Array | ArrayBuffer | URL;
+    mediaType: string;
+}>;
+export type StreamCompletion<TIcon = unknown> = (model: RegisteredModel<TIcon>, request: ModelRequest) => ModelStream | Promise<ModelStream>;

package/dist/provider.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,22 @@
 {
   "name": "@blastlauncher/protocol",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "version": "3.0.0-alpha.0",
+  "license": "MIT",
+  "engines": {
+    "node": ">=24.20.0"
+  },
+  "files": [
+    "dist",
+    "schema",
+    "LICENSE",
+    "README.md"
+  ]
+}