fauna-api 0.0.0-stage → 1.0.679

package/dist/src/parrot/generative.d.ts

@@ -0,0 +1,261 @@
+import { Credentials, ApiKey, Profile } from "../authentification.js";
+import type { File as FaunaFile } from "../drive.js";
+import type { Demographic } from "../ant/persona.js";
+import type { Schema } from "../shared/schema.js";
+import type { Group } from "../groups.js";
+export type { Demographic };
+export declare enum Text {
+    AUTO = "auto",
+    GPT_5_4 = "gpt-5.4",
+    GPT_5_4_MINI = "gpt-5.4-mini",
+    GPT_5_4_NANO = "gpt-5.4-nano",
+    GPT_5_4_PRO = "gpt-5.4-pro",
+    GPT_5_5 = "gpt-5.5",
+    GPT_5_5_PRO = "gpt-5.5-pro",
+    GPT_5_6_SOL = "gpt-5.6-sol",
+    GPT_5_6_TERRA = "gpt-5.6-terra",
+    GPT_5_6_LUNA = "gpt-5.6-luna",
+    CLAUDE_SONNET_4_6 = "claude-sonnet-4-6",
+    CLAUDE_SONNET_5 = "claude-sonnet-5",
+    CLAUDE_OPUS_4_6 = "claude-opus-4-6",
+    CLAUDE_OPUS_4_7 = "claude-opus-4-7",
+    CLAUDE_OPUS_4_8 = "claude-opus-4-8",
+    CLAUDE_OPUS_5 = "claude-opus-5",
+    CLAUDE_FABLE_5 = "claude-fable-5",
+    GEMINI_3_1_PRO = "gemini-3.1-pro-preview",
+    GEMINI_3_FLASH = "gemini-3-flash-preview",
+    GEMINI_3_1_FLASH_LITE = "gemini-3.1-flash-lite",
+    GEMINI_3_5_FLASH = "gemini-3.5-flash",
+    GROK_4_20_REASONING = "grok-4.20-reasoning-latest",
+    GROK_4_20_NON_REASONING = "grok-4.20-non-reasoning-latest",
+    GROK_4_3 = "grok-4.3-latest",
+    GROK_4_5 = "grok-4.5",
+    GROK_4_6 = "grok-4.6",
+    GROK_CODE_4_1_FAST = "grok-code-fast-1"
+}
+export declare enum Image {
+    GROK_IMAGINE_IMAGE = "grok-imagine-image",
+    GROK_IMAGINE_IMAGE_2 = "grok-imagine-image-2.0",
+    GROK_IMAGINE_IMAGE_QUALITY = "grok-imagine-image-quality",
+    GPT_IMAGE_1_5 = "gpt-image-1.5",
+    GPT_IMAGE_1_MINI = "gpt-image-1-mini"
+}
+export declare enum Video {
+    GROK_IMAGINE_VIDEO = "grok-imagine-video",
+    GROK_IMAGINE_VIDEO_1_5 = "grok-imagine-video-1.5",
+    SORA_2 = "sora-2",
+    SORA_2_PRO = "sora-2-pro"
+}
+export declare enum Speech {
+    GPT_4O_MINI_TTS = "gpt-4o-mini-tts",
+    GROK_TTS = "grok-tts",
+    ELEVEN_V3 = "eleven_v3",
+    ELEVEN_FLASH_V2_5 = "eleven_flash_v2_5"
+}
+export declare enum Transcription {
+    GPT_TRANSCRIBE = "gpt-transcribe",
+    GROK_STT = "grok-stt",
+    SCRIBE_V2 = "scribe_v2"
+}
+export declare enum Embedding {
+    TEXT_EMBEDDING_3_SMALL = "text-embedding-3-small",
+    TEXT_EMBEDDING_3_LARGE = "text-embedding-3-large",
+    GEMINI_EMBEDDING_001 = "gemini-embedding-001",
+    GEMINI_EMBEDDING_2_PREVIEW = "gemini-embedding-2-preview",
+    VOYAGE_3 = "voyage-3",
+    VOYAGE_3_LARGE = "voyage-3-large",
+    VOYAGE_3_LITE = "voyage-3-lite",
+    VOYAGE_CODE_3 = "voyage-code-3",
+    VOYAGE_FINANCE_2 = "voyage-finance-2",
+    VOYAGE_LAW_2 = "voyage-law-2"
+}
+export declare enum Voice {
+    GPT_REALTIME = "gpt-realtime-2",
+    GROK_VOICE = "grok-voice-think-fast-2.0",
+    ELEVEN_V3 = "eleven_v3_conversational"
+}
+export declare enum Decision {
+    JEV_1_13 = "jev-1.13.0",
+    JEV_1_14 = "jev-1.14.0",
+    GPT_6_LUNA = "gpt-6-luna"
+}
+export declare enum Role {
+    USER = "USER",
+    MODEL = "MODEL",
+    SYSTEM = "SYSTEM",
+    TOOL = "TOOL"
+}
+export type TextPart = {
+    type: 'TEXT';
+    text: string;
+};
+export type File = {
+    type: 'FILE';
+    file: FaunaFile;
+};
+export type Invocation = {
+    type: 'INVOCATION';
+    id?: string;
+    args?: Record<string, unknown>;
+    name: string;
+    status?: 'success' | 'error';
+    result?: string;
+};
+export type Result = {
+    type: 'RESULT';
+    id: string;
+    result: string;
+};
+/**
+ * A reaction to the message at transcript `position`. It travels as its own
+ * USER message; chat UIs fold it onto that message instead of drawing a bubble.
+ * `on: false` takes the reaction back; the latest one per person, message and
+ * emoji wins.
+ */
+export type Reaction = {
+    type: 'REACTION';
+    emoji: string;
+    position: number;
+    on: boolean;
+};
+export type Part = TextPart | File | Invocation | Result | Reaction;
+export type Function = {
+    name: string;
+    parameters: Schema;
+    description?: string;
+    default?: unknown;
+    example?: unknown;
+    behavior?: 'BLOCKING' | 'NON_BLOCKING';
+};
+export type Tool = {
+    function: Function;
+    evaluate: (params: any) => Promise<string>;
+    instruction?: (params: any) => string;
+};
+export type Content = {
+    parts: Part[];
+    role: Role;
+    createdAt: Date;
+    author?: Profile;
+    /** Text model id that produced a MODEL turn (for UI avatar / rehydrate). */
+    model?: string;
+    /** The name of the API key an agent posted this with, for its author. */
+    via?: string;
+};
+export type TextResponse = {
+    content: Content;
+    usage: {
+        promptTokens: number;
+        completionTokens: number;
+    };
+};
+export type EmbeddingResponse = {
+    embedding: number[];
+    usage: {
+        promptTokens: number;
+    };
+};
+export type StreamEvent = {
+    event: 'text';
+    delta: string;
+} | {
+    event: 'tool_call';
+    id: string;
+    name: string;
+    args: Record<string, unknown>;
+    server?: boolean;
+} | {
+    event: 'done';
+    usage: {
+        promptTokens: number;
+        completionTokens: number;
+    };
+} | {
+    event: 'error';
+    message: string;
+    code?: string;
+};
+export type VoiceEvent = {
+    event: 'audio';
+    delta: Uint8Array;
+    contentType: 'audio/pcm';
+} | {
+    event: 'input_transcript';
+    delta: string;
+} | {
+    event: 'output_transcript';
+    delta: string;
+} | {
+    event: 'tool_call';
+    id: string;
+    name: string;
+    args: Record<string, unknown>;
+} | {
+    event: 'speech_started';
+} | {
+    event: 'speech_stopped';
+} | {
+    event: 'done';
+    usage: {
+        promptTokens: number;
+        completionTokens: number;
+    };
+} | {
+    event: 'error';
+    message: string;
+    code?: string;
+};
+export declare function generateText(authorization: Credentials | ApiKey, model: Text, options?: Partial<{
+    content: Content[];
+    tools: Tool[] | Tool;
+    maxTools: number;
+    reasoning: string;
+    signal: AbortSignal;
+    group: Group;
+}>): AsyncGenerator<StreamEvent>;
+export declare function generateTextSync(authorization: Credentials | ApiKey, model: Text, options?: Partial<{
+    content: Content[];
+    tools: Tool[] | Tool;
+    maxTools: number;
+    reasoning: string;
+    group: Group;
+}>): Promise<TextResponse>;
+export declare function generateEmbedding(authorization: Credentials | ApiKey, model: Embedding, content: string, group?: Group): Promise<EmbeddingResponse>;
+export declare function generateDecision(authorization: Credentials | ApiKey, model: Decision, content: Content[], questions: Record<string, string[]>, group?: Group): Promise<Record<string, Record<string, number>>>;
+export declare function generateImage(authorization: Credentials | ApiKey, model: Image, options?: Partial<{
+    content: Content[];
+    size: [number, number];
+    group: Group;
+}>): Promise<TextResponse>;
+export declare function generateVideo(authorization: Credentials | ApiKey, model: Video, options?: Partial<{
+    content: Content[];
+    duration: number;
+    size: [number, number];
+    group: Group;
+}>): Promise<TextResponse>;
+export declare function generateSpeech(authorization: Credentials | ApiKey, model: Speech, options?: Partial<{
+    content: Content[];
+    voice: Demographic;
+    group: Group;
+}>): Promise<TextResponse>;
+export declare function generateTranscription(authorization: Credentials | ApiKey, model: Transcription, options?: Partial<{
+    content: Content[];
+    group: Group;
+}>): Promise<TextResponse>;
+export declare function generateVoice(authorization: Credentials | ApiKey, model: Voice, options?: Partial<{
+    content: Content[];
+    audio: AsyncIterable<Uint8Array>;
+    tools: Tool[] | Tool;
+    maxTools: number;
+    voice: Partial<Demographic>;
+    signal: AbortSignal;
+    group: Group;
+}>): AsyncGenerator<VoiceEvent>;
+export declare function generateVoiceSync(authorization: Credentials | ApiKey, model: Voice, options?: Partial<{
+    content: Content[];
+    audio: AsyncIterable<Uint8Array>;
+    tools: Tool[] | Tool;
+    maxTools: number;
+    voice: Partial<Demographic>;
+    group: Group;
+}>): Promise<TextResponse>;

package/dist/src/parrot/generative.js

@@ -0,0 +1,185 @@
+import { Parrot } from "./index.js";
+import { collectText, collectVoice, generateMedia, prepareMessages, streamText, streamVoice } from "./socket.js";
+// Text Clients
+export var Text;
+(function (Text) {
+    Text["AUTO"] = "auto";
+    // OpenAI
+    Text["GPT_5_4"] = "gpt-5.4";
+    Text["GPT_5_4_MINI"] = "gpt-5.4-mini";
+    Text["GPT_5_4_NANO"] = "gpt-5.4-nano";
+    Text["GPT_5_4_PRO"] = "gpt-5.4-pro";
+    Text["GPT_5_5"] = "gpt-5.5";
+    Text["GPT_5_5_PRO"] = "gpt-5.5-pro";
+    Text["GPT_5_6_SOL"] = "gpt-5.6-sol";
+    Text["GPT_5_6_TERRA"] = "gpt-5.6-terra";
+    Text["GPT_5_6_LUNA"] = "gpt-5.6-luna";
+    // Anthropic
+    Text["CLAUDE_SONNET_4_6"] = "claude-sonnet-4-6";
+    Text["CLAUDE_SONNET_5"] = "claude-sonnet-5";
+    Text["CLAUDE_OPUS_4_6"] = "claude-opus-4-6";
+    Text["CLAUDE_OPUS_4_7"] = "claude-opus-4-7";
+    Text["CLAUDE_OPUS_4_8"] = "claude-opus-4-8";
+    Text["CLAUDE_OPUS_5"] = "claude-opus-5";
+    Text["CLAUDE_FABLE_5"] = "claude-fable-5";
+    // Google (Pro and 3-Flash are still preview-only, hence the -preview suffix;
+    // 3.5-flash and 3.1-flash-lite are GA and use bare IDs)
+    Text["GEMINI_3_1_PRO"] = "gemini-3.1-pro-preview";
+    Text["GEMINI_3_FLASH"] = "gemini-3-flash-preview";
+    Text["GEMINI_3_1_FLASH_LITE"] = "gemini-3.1-flash-lite";
+    Text["GEMINI_3_5_FLASH"] = "gemini-3.5-flash";
+    // Grok
+    Text["GROK_4_20_REASONING"] = "grok-4.20-reasoning-latest";
+    Text["GROK_4_20_NON_REASONING"] = "grok-4.20-non-reasoning-latest";
+    Text["GROK_4_3"] = "grok-4.3-latest";
+    Text["GROK_4_5"] = "grok-4.5";
+    Text["GROK_4_6"] = "grok-4.6";
+    Text["GROK_CODE_4_1_FAST"] = "grok-code-fast-1";
+})(Text || (Text = {}));
+export var Image;
+(function (Image) {
+    Image["GROK_IMAGINE_IMAGE"] = "grok-imagine-image";
+    Image["GROK_IMAGINE_IMAGE_2"] = "grok-imagine-image-2.0";
+    Image["GROK_IMAGINE_IMAGE_QUALITY"] = "grok-imagine-image-quality";
+    Image["GPT_IMAGE_1_5"] = "gpt-image-1.5";
+    Image["GPT_IMAGE_1_MINI"] = "gpt-image-1-mini";
+})(Image || (Image = {}));
+export var Video;
+(function (Video) {
+    // Grok
+    Video["GROK_IMAGINE_VIDEO"] = "grok-imagine-video";
+    Video["GROK_IMAGINE_VIDEO_1_5"] = "grok-imagine-video-1.5";
+    // OpenAI
+    Video["SORA_2"] = "sora-2";
+    Video["SORA_2_PRO"] = "sora-2-pro";
+})(Video || (Video = {}));
+export var Speech;
+(function (Speech) {
+    // OpenAI
+    Speech["GPT_4O_MINI_TTS"] = "gpt-4o-mini-tts";
+    // xAI
+    Speech["GROK_TTS"] = "grok-tts";
+    // ElevenLabs
+    Speech["ELEVEN_V3"] = "eleven_v3";
+    Speech["ELEVEN_FLASH_V2_5"] = "eleven_flash_v2_5";
+})(Speech || (Speech = {}));
+export var Transcription;
+(function (Transcription) {
+    // OpenAI
+    Transcription["GPT_TRANSCRIBE"] = "gpt-transcribe";
+    // xAI
+    Transcription["GROK_STT"] = "grok-stt";
+    // ElevenLabs
+    Transcription["SCRIBE_V2"] = "scribe_v2";
+})(Transcription || (Transcription = {}));
+// Embedding Clients
+export var Embedding;
+(function (Embedding) {
+    // OpenAI
+    Embedding["TEXT_EMBEDDING_3_SMALL"] = "text-embedding-3-small";
+    Embedding["TEXT_EMBEDDING_3_LARGE"] = "text-embedding-3-large";
+    // Google
+    Embedding["GEMINI_EMBEDDING_001"] = "gemini-embedding-001";
+    Embedding["GEMINI_EMBEDDING_2_PREVIEW"] = "gemini-embedding-2-preview";
+    // Voyage
+    Embedding["VOYAGE_3"] = "voyage-3";
+    Embedding["VOYAGE_3_LARGE"] = "voyage-3-large";
+    Embedding["VOYAGE_3_LITE"] = "voyage-3-lite";
+    Embedding["VOYAGE_CODE_3"] = "voyage-code-3";
+    Embedding["VOYAGE_FINANCE_2"] = "voyage-finance-2";
+    Embedding["VOYAGE_LAW_2"] = "voyage-law-2";
+})(Embedding || (Embedding = {}));
+export var Voice;
+(function (Voice) {
+    Voice["GPT_REALTIME"] = "gpt-realtime-2";
+    Voice["GROK_VOICE"] = "grok-voice-think-fast-2.0";
+    Voice["ELEVEN_V3"] = "eleven_v3_conversational";
+})(Voice || (Voice = {}));
+export var Decision;
+(function (Decision) {
+    // TypeSafe
+    Decision["JEV_1_13"] = "jev-1.13.0";
+    Decision["JEV_1_14"] = "jev-1.14.0";
+    // OpenAI
+    Decision["GPT_6_LUNA"] = "gpt-6-luna";
+})(Decision || (Decision = {}));
+// Roles
+export var Role;
+(function (Role) {
+    Role["USER"] = "USER";
+    Role["MODEL"] = "MODEL";
+    Role["SYSTEM"] = "SYSTEM";
+    Role["TOOL"] = "TOOL";
+})(Role || (Role = {}));
+// Streaming Text Generation. A singular Tool forces it; an array lets the model choose.
+export async function* generateText(authorization, model, options = {}) {
+    yield* streamText(authorization, '/generative/text', model, options);
+}
+// Synchronous wrapper — buffers the stream and returns full TextResponse
+export async function generateTextSync(authorization, model, options = {}) {
+    return collectText(generateText(authorization, model, options));
+}
+// Embedding (stays HTTP). With `group`, the group pays.
+export async function generateEmbedding(authorization, model, content, group) {
+    const response = await fetch(`${Parrot.getURL()}/generative/embed`, {
+        method: "POST",
+        headers: {
+            "Content-Type": "application/json",
+            "Authorization": 'email' in authorization ? `Token ${authorization.token}` : `ApiKey ${authorization.id}`,
+            ...(group ? { "Group": group.id } : {})
+        },
+        body: JSON.stringify({
+            model: model,
+            content: content
+        })
+    });
+    if (!response.ok) {
+        throw new Error(`Failed to generate embedding: ${response.statusText}`);
+    }
+    return await response.json();
+}
+// Decision (stays HTTP). Each question lists its options; every option comes back
+// with its probability. A question the model declines is left out. With `group`,
+// the group pays.
+export async function generateDecision(authorization, model, content, questions, group) {
+    const response = await fetch(`${Parrot.getURL()}/generative/decision`, {
+        method: "POST",
+        headers: {
+            "Content-Type": "application/json",
+            "Authorization": 'email' in authorization ? `Token ${authorization.token}` : `ApiKey ${authorization.id}`,
+            ...(group ? { "Group": group.id } : {})
+        },
+        body: JSON.stringify({
+            model: model,
+            messages: await prepareMessages(authorization, content),
+            questions: questions
+        })
+    });
+    if (!response.ok) {
+        throw new Error(await response.text());
+    }
+    return await response.json();
+}
+// Image Generation
+export async function generateImage(authorization, model, options = {}) {
+    return generateMedia(authorization, '/generative/image', model, options, 'image/png');
+}
+// Video Generation
+export async function generateVideo(authorization, model, options = {}) {
+    return generateMedia(authorization, '/generative/video', model, options, 'video/mp4');
+}
+// Speech Generation
+export async function generateSpeech(authorization, model, options = {}) {
+    return generateMedia(authorization, '/generative/speech', model, options, 'audio/mpeg');
+}
+// Transcription Generation
+export async function generateTranscription(authorization, model, options = {}) {
+    return generateMedia(authorization, '/generative/transcription', model, options, 'application/octet-stream');
+}
+// Streaming Voice Generation
+export async function* generateVoice(authorization, model, options = {}) {
+    yield* streamVoice(authorization, '/generative/voice', model, options);
+}
+export async function generateVoiceSync(authorization, model, options = {}) {
+    return collectVoice(authorization, generateVoice(authorization, model, options));
+}

package/dist/src/parrot/index.d.ts

@@ -0,0 +1,22 @@
+import * as GenerativeAPI from "./generative.js";
+import * as RoutingAPI from "./routing.js";
+import * as FormatAPI from "./format.js";
+import * as ChatAPI from "./chat.js";
+import * as AgentAPI from "./agent.js";
+import * as ShareAPI from "./share.js";
+import * as RoomAPI from "./room.js";
+export declare namespace Parrot {
+    function setRoute(route: string): void;
+    function getIP(): string;
+    function getPort(): number;
+    function getRoute(): string;
+    function getURL(): string;
+    function ping(): Promise<number>;
+    export import Generative = GenerativeAPI;
+    export import Routing = RoutingAPI;
+    export import Format = FormatAPI;
+    export import Chat = ChatAPI;
+    export import Agent = AgentAPI;
+    export import Share = ShareAPI;
+    export import Room = RoomAPI;
+}

package/dist/src/parrot/index.js

@@ -0,0 +1,67 @@
+import * as GenerativeAPI from "./generative.js";
+import * as RoutingAPI from "./routing.js";
+import * as FormatAPI from "./format.js";
+import * as ChatAPI from "./chat.js";
+import * as AgentAPI from "./agent.js";
+import * as ShareAPI from "./share.js";
+import * as RoomAPI from "./room.js";
+export var Parrot;
+(function (Parrot) {
+    var PREFIX = 'https://';
+    var IP = 'api.faunakit.com';
+    var PORT = 443;
+    function setRoute(route) {
+        const parts_0 = route.split('//');
+        if (parts_0.length > 1) {
+            PREFIX = parts_0[0] + '//';
+            const parts_1 = parts_0[1].split(':');
+            if (parts_1.length > 1) {
+                IP = parts_1[0];
+                PORT = Number(parts_1[1]);
+            }
+            else {
+                IP = parts_1[0];
+            }
+        }
+        else {
+            const parts_1 = parts_0[0].split(':');
+            if (parts_1.length > 1) {
+                IP = parts_1[0];
+                PORT = Number(parts_1[1]);
+            }
+            else {
+                IP = parts_1[0];
+            }
+        }
+    }
+    Parrot.setRoute = setRoute;
+    function getIP() {
+        return IP;
+    }
+    Parrot.getIP = getIP;
+    function getPort() {
+        return PORT;
+    }
+    Parrot.getPort = getPort;
+    function getRoute() {
+        return IP + ':' + PORT;
+    }
+    Parrot.getRoute = getRoute;
+    function getURL() {
+        return PREFIX + IP + ':' + PORT;
+    }
+    Parrot.getURL = getURL;
+    async function ping() {
+        const start = Date.now();
+        await fetch(`${getURL()}/`);
+        return Date.now() - start;
+    }
+    Parrot.ping = ping;
+    Parrot.Generative = GenerativeAPI;
+    Parrot.Routing = RoutingAPI;
+    Parrot.Format = FormatAPI;
+    Parrot.Chat = ChatAPI;
+    Parrot.Agent = AgentAPI;
+    Parrot.Share = ShareAPI;
+    Parrot.Room = RoomAPI;
+})(Parrot || (Parrot = {}));