@meistrari/tela-sdk-js 0.0.3 → 1.0.0

package/dist/resources/chat-completions.d.ts

@@ -1,482 +0,0 @@
-import type { RequestOptions } from '../base-client';
-import type { Stream } from '../streaming';
-import { TelaFile } from '../file';
-import { Resource } from '../resource';
-/**
- * Manages chat completion operations.
- *
- * Provides methods to create chat completions, handle streaming responses,
- * and manage file uploads associated with chat completions.
- *
- * @example
- * ```typescript
- * const tela = new TelaSDK({
- *   apiKey: 'your-api-key',
- * });
- * const response = await tela.completions.create({
- *   canvasId: "your-canvas-id",
- *   messages: [{ role: "user", content: "Hello!" }],
- * });
- * console.log(response.choices[0].message.content);
- * ```
- */
-export declare class ChatCompletions extends Resource {
-    /**
-     * Creates a chat completion with various input options and response formats.
-     *
-     * This method supports synchronous responses, streaming responses, and webhook-based asynchronous processing.
-     *
-     * @param body - The parameters for creating a chat completion.
-     * @param opts - Additional request options.
-     * @returns A Promise that resolves to either a stream of chat completion responses,
-     *          a single chat completion response, or a webhook response, depending on the input parameters.
-     *
-     * @example
-     * ```typescript
-     * // Synchronous response
-     * const response = await tela.completions.create({
-     *   canvasId: "your-canvas-id",
-     *   messages: [{ role: "user", content: "Tell me a joke." }],
-     * });
-     *
-     * // Streaming response
-     * const stream = await tela.completions.create({
-     *   canvasId: "your-canvas-id",
-     *   messages: [{ role: "user", content: "Tell me a story." }],
-     *   stream: true,
-     * });
-     *
-     * // Webhook response
-     * const webhookResponse = await tela.completions.create({
-     *   canvasId: "your-canvas-id",
-     *   messages: [{ role: "user", content: "Generate a report." }],
-     *   webhookUrl: "https://example.com/webhook",
-     * });
-     * ```
-     */
-    create<Variables = ChatCompletionVariables, CompletionContent = string>(body: ChatCompletionCreateWebhookParams<Variables>, opts?: RequestOptions<ChatCompletionCreateParams<Variables>>): Promise<ChatCompletionWebhookResponse<CompletionContent>>;
-    create<Variables = ChatCompletionVariables, CompletionContent = string>(body: CompletionCreateParamsNonStreaming<Variables>, opts?: RequestOptions<ChatCompletionCreateParams<Variables>>): Promise<ChatCompletionCreateResponse<CompletionContent>>;
-    create<Variables = ChatCompletionVariables, CompletionContent = string>(body: CompletionCreateParamsStreaming<Variables>, opts?: RequestOptions<ChatCompletionCreateParams<Variables>>): Promise<Stream<ChatCompletionCreateStreamingResponse<CompletionContent>>>;
-    create<Variables = ChatCompletionVariables, CompletionContent = string>(body: ChatCompletionCreateParamsBase<Variables>, opts?: RequestOptions<ChatCompletionCreateParams<Variables>>): Promise<Stream<ChatCompletionCreateStreamingResponse<CompletionContent>> | ChatCompletionCreateResponse<CompletionContent> | ChatCompletionWebhookResponse<CompletionContent>>;
-    /**
-     * Uploads a file and returns its URL and options.
-     *
-     * This is used internally to handle file uploads associated with chat completions.
-     *
-     * @param file - The TelaFile to be uploaded.
-     * @returns A Promise that resolves to an object containing the file URL and options.
-     * @throws {FileUploadError} If the file upload fails.
-     *
-     * @example
-     * ```typescript
-     * const file = new TelaFile({ /* file options *\/ });
-     * const uploadedFile = await this.uploadFile(file);
-     * console.log(uploadedFile.file_url);
-     * ```
-     */
-    private uploadFile;
-}
-type ChatCompletionVariablesValue = string | number | boolean | TelaFile;
-/**
- * Represents the variables available in the canvas.
- * Keys are strings, and values can be strings, numbers, booleans, or TelaFile instances.
- */
-type ChatCompletionVariables = Record<string, ChatCompletionVariablesValue>;
-/**
- * Represents the processed variables with file URLs.
- * Similar to ChatCompletionVariables, but TelaFile instances are replaced with their URLs.
- */
-type ChatCompletionVariablesWithFileURL = Record<string, string | number | boolean | {
-    fileUrl: string;
-}>;
-/**
- * Base parameters for creating a chat completion.
- */
-export interface ChatCompletionCreateParamsBase<Variables = ChatCompletionVariables> {
-    /**
-     * The version ID of the canvas to use for this chat completion.
-     * If not provided, the latest version of the specified canvas will be used.
-     */
-    versionId?: string;
-    /**
-     * The ID of the canvas to use for this chat completion.
-     * This is required if an applicationId is not provided.
-     */
-    canvasId?: string;
-    /**
-     * The ID of the deployed application to use for this chat completion.
-     * This is required if a canvasId is not provided.
-     */
-    applicationId?: string;
-    /**
-     * The URL to receive a webhook notification when the chat completion is finished.
-     * If provided, the completion will be processed asynchronously.
-     */
-    webhookUrl?: string | null | undefined;
-    /**
-     * Variables to be passed to the canvas for this chat completion.
-     * These can be used to customize the behavior of the canvas for this specific request.
-     */
-    variables?: Variables;
-    /**
-     * An array of previous messages in the conversation.
-     * Each message should have a 'role' (e.g., 'user', 'assistant') and 'content'.
-     */
-    messages?: Array<{
-        role: string;
-        content: string;
-    }>;
-    /**
-     * Override default settings specified in the canvas.
-     * This allows for fine-tuning the completion behavior for this specific request.
-     */
-    override?: {
-        /**
-         * The specific model to use for this completion.
-         * If not specified, the default model set in the canvas will be used.
-         */
-        model?: string;
-        /**
-         * Controls randomness in the output. Values between 0 and 1.
-         * Lower values make the output more focused and deterministic.
-         */
-        temperature?: number;
-        /**
-         * Specifies whether to use a chat or completion model.
-         */
-        type: 'chat' | 'completion';
-        /**
-         * An array of functions that the model can call.
-         * This allows for more structured and interactive completions.
-         */
-        functions?: Array<{
-            id: string;
-            name: string;
-            description?: string;
-            parameters?: {
-                type: 'object';
-                properties: Record<string, unknown>;
-                required?: string[];
-            };
-        }>;
-        /**
-         * Configuration for generating structured output.
-         */
-        structuredOutput?: {
-            /**
-             * Whether to enable structured output for this completion.
-             */
-            enabled: boolean;
-            /**
-             * The schema defining the structure of the output.
-             * This is used when structured output is enabled.
-             */
-            schema?: {
-                properties: Record<string, unknown>;
-                type: 'object';
-                title: string;
-                description: string;
-                required: string[];
-            };
-        };
-    };
-}
-/**
- * Parameters for creating a streaming chat completion.
- */
-export interface CompletionCreateParamsStreaming<T> extends ChatCompletionCreateParamsBase<T> {
-    /**
-     * Whether the response should be streamed.
-     */
-    stream: true;
-    /**
-     * The webhook URL, if you want to receive a webhook when the completion is completed.
-     */
-    webhookUrl?: undefined | null;
-}
-/**
- * Parameters for creating a non-streaming chat completion.
- */
-export interface CompletionCreateParamsNonStreaming<T> extends ChatCompletionCreateParamsBase<T> {
-    /**
-     * Whether the response should be streamed.
-     */
-    stream?: false | undefined | null;
-}
-/**
- * Parameters for creating a chat completion with a webhook.
- */
-export interface ChatCompletionCreateWebhookParams<T> extends CompletionCreateParamsNonStreaming<T> {
-    /**
-     * The webhook URL, if you want to receive a webhook when the completion is completed.
-     */
-    webhookUrl: string;
-}
-/**
- * Union type for all possible chat completion creation parameters.
- */
-export type ChatCompletionCreateParams<T> = CompletionCreateParamsStreaming<T> | CompletionCreateParamsNonStreaming<T> | ChatCompletionCreateWebhookParams<T>;
-/**
- * Response structure for a created chat completion.
- */
-export type ChatCompletionCreateResponse<T> = {
-    /**
-     * The ID of the completion.
-     */
-    id: string;
-    /**
-     * The object of the completion.
-     */
-    object: string;
-    /**
-     * The created time of the completion.
-     */
-    created: number;
-    /**
-     * The choices of the completion.
-     */
-    choices: Array<{
-        message: {
-            role: string;
-            content: T;
-        };
-    }>;
-};
-/**
- * Response structure for a chat completion streaming response.
- */
-export type ChatCompletionCreateStreamingResponse<T> = {
-    /**
-     * The ID of the completion.
-     */
-    id: string;
-    /**
-     * The object of the completion.
-     */
-    object: string;
-    /**
-     * The created time of the completion.
-     */
-    created: number;
-    /**
-     * The model of the completion.
-     */
-    model: string;
-    /**
-     * The choices of the completion.
-     */
-    choices: Array<{
-        delta: {
-            role: string | null;
-            content: string | null;
-            functionCall: {
-                name: string | null;
-                arguments: string | null;
-            } | null;
-        };
-        finishReason: string | null;
-        index: number;
-        logprobs: number | null;
-    }>;
-    /**
-     * The message of the completion.
-     */
-    message: {
-        role: string;
-        content: string | null;
-        functionCall: {
-            name: string | null;
-            arguments: string | null;
-        } | null;
-        toolCalls: Array<{
-            name: string;
-            arguments: string;
-        }>;
-        structuredContent: T;
-    };
-};
-/**
- * Response structure for a chat completion webhook.
- * This interface represents the data sent to the webhook URL when a chat completion is finished.
- */
-interface ChatCompletionWebhookResponse<T> {
-    /**
-     * Unique identifier for this chat completion response.
-     */
-    id: string;
-    /**
-     * The current status of the chat completion.
-     * - 'created': The request has been received but processing hasn't started.
-     * - 'running': The chat completion is currently being processed.
-     * - 'succeeded': The chat completion has finished successfully.
-     * - 'failed': The chat completion encountered an error and couldn't complete.
-     */
-    status: 'created' | 'failed' | 'running' | 'succeeded';
-    /**
-     * Contains information about the input provided for this chat completion.
-     */
-    inputContent: {
-        /**
-         * Variables passed to the chat completion, including any file URLs.
-         */
-        variables: ChatCompletionVariablesWithFileURL;
-        /**
-         * Array of messages that were part of the input.
-         */
-        messages: Array<{
-            /**
-             * The role of the message sender (e.g., 'user', 'assistant', 'system').
-             */
-            role: string;
-            /**
-             * The content of the message. Can be a string for text messages,
-             * or an object for more complex content types like images.
-             */
-            content: string | {
-                type: 'text';
-                text: string;
-            } | {
-                type: 'image_url';
-                imageUrl: {
-                    url: string;
-                    detail?: 'auto' | 'high' | 'low';
-                };
-            };
-            /**
-             * Optional. Information about a function call, if applicable.
-             */
-            functionCall?: {
-                name: string;
-                arguments: string;
-            };
-        }>;
-        /**
-         * Information about files used in the chat completion.
-         */
-        files: Array<{
-            name: string;
-            usedAt: 'variables' | 'messages';
-            parsedContent: string;
-            url: string;
-            type: 'image' | 'file';
-        }>;
-    };
-    /**
-     * Contains the output generated by the chat completion.
-     */
-    outputContent: {
-        /**
-         * The role of the entity providing the output.
-         */
-        role: 'system' | 'user' | 'assistant' | 'function';
-        /**
-         * Optional. Information about tool calls made during the completion.
-         */
-        toolCalls?: Array<{
-            name: string;
-            arguments: string;
-        }>;
-        /**
-         * Optional. Additional information about the completion process.
-         */
-        information?: {
-            duration: number;
-            cost?: number;
-            inputTokens?: number;
-            outputTokens?: number;
-        };
-        /**
-         * Indicates whether the output has a structured format.
-         */
-        hasStructuredOutput?: boolean;
-        /**
-         * The main content of the chat completion output.
-         */
-        content: T;
-        /**
-         * Optional. The input messages in a string format.
-         */
-        inputMessages?: string | undefined;
-    };
-    /**
-     * The original input parameters provided for this chat completion.
-     */
-    rawInput: {
-        versionId?: string;
-        canvasId?: string;
-        applicationId?: string;
-        webhookUrl?: string;
-        variables?: ChatCompletionVariablesWithFileURL;
-        messages?: Array<{
-            role: string;
-            content: string | {
-                type: 'text';
-                text: string;
-            } | {
-                type: 'image_url';
-                imageUrl: {
-                    url: string;
-                    detail?: 'auto' | 'high' | 'low';
-                };
-            };
-        }>;
-        override?: {
-            model?: string;
-            temperature?: number;
-            type: 'chat' | 'completion';
-            functions?: Array<{
-                id: string;
-                name: string;
-                description?: string;
-                parameters?: {
-                    type: 'object';
-                    properties: Record<string, unknown>;
-                    required?: string[];
-                };
-            }>;
-            structuredOutput?: {
-                enabled: boolean;
-                schema?: {
-                    properties: Record<string, unknown>;
-                    type: 'object';
-                    title: string;
-                    description: string;
-                    required: string[];
-                };
-            };
-        };
-    } | null;
-    /**
-     * The raw output from the chat completion process.
-     */
-    rawOutput: Record<string, unknown>;
-    /**
-     * The date used for compatibility checks.
-     */
-    compatibilityDate: Date;
-    /**
-     * The ID of the prompt version used for this chat completion.
-     */
-    promptVersionId: string;
-    /**
-     * The ID of the prompt application, if applicable.
-     */
-    promptApplicationId: string | null;
-    /**
-     * The ID of the workspace where this chat completion was executed.
-     */
-    workspaceId: string;
-    /**
-     * The timestamp when this chat completion was created.
-     */
-    createdAt: string;
-    /**
-     * The timestamp when this chat completion was last updated.
-     */
-    updatedAt: string;
-    /**
-     * The timestamp when this chat completion was deleted, if applicable.
-     */
-    deletedAt: string | null;
-}
-export {};

package/dist/resources/chat-completions.js

@@ -1,86 +0,0 @@
-import { FileUploadError } from '../errors';
-import { TelaFile } from '../file';
-import { Resource } from '../resource';
-/**
- * Manages chat completion operations.
- *
- * Provides methods to create chat completions, handle streaming responses,
- * and manage file uploads associated with chat completions.
- *
- * @example
- * ```typescript
- * const tela = new TelaSDK({
- *   apiKey: 'your-api-key',
- * });
- * const response = await tela.completions.create({
- *   canvasId: "your-canvas-id",
- *   messages: [{ role: "user", content: "Hello!" }],
- * });
- * console.log(response.choices[0].message.content);
- * ```
- */
-export class ChatCompletions extends Resource {
-    async create(body, opts) {
-        const processedBody = { ...body };
-        if (body.variables) {
-            const processedVariables = {};
-            for await (const [key, value] of Object.entries(body.variables)) {
-                if (value instanceof TelaFile) {
-                    const fileWithUrl = await this.uploadFile(value);
-                    processedVariables[key] = fileWithUrl;
-                }
-                else {
-                    processedVariables[key] = value;
-                }
-            }
-            processedBody.variables = processedVariables;
-        }
-        return this._client.post('/v2/chat/completions', {
-            body: processedBody,
-            ...opts,
-            stream: body.stream ?? false,
-        });
-    }
-    /**
-     * Uploads a file and returns its URL and options.
-     *
-     * This is used internally to handle file uploads associated with chat completions.
-     *
-     * @param file - The TelaFile to be uploaded.
-     * @returns A Promise that resolves to an object containing the file URL and options.
-     * @throws {FileUploadError} If the file upload fails.
-     *
-     * @example
-     * ```typescript
-     * const file = new TelaFile({ /* file options *\/ });
-     * const uploadedFile = await this.uploadFile(file);
-     * console.log(uploadedFile.file_url);
-     * ```
-     */
-    async uploadFile(file) {
-        const content = await file.getUploadableContent();
-        if (file.isURL && typeof content === 'string') {
-            return { fileUrl: content, options: file.options };
-        }
-        const response = await this._client.post('/v2/file');
-        const { uploadUrl, downloadUrl } = response;
-        let contentType = 'application/octet-stream';
-        if (content instanceof File || content instanceof Blob) {
-            contentType = content.type;
-        }
-        const uploadResponse = await fetch(uploadUrl, {
-            method: 'PUT',
-            body: content,
-            headers: {
-                'Content-Type': contentType,
-                ...(file.size ? { 'Content-Length': file.size.toString() } : {}),
-            },
-            // @ts-expect-error: duplex is not supported
-            duplex: 'half',
-        });
-        if (!uploadResponse.ok) {
-            throw new FileUploadError(await uploadResponse.text());
-        }
-        return { fileUrl: downloadUrl, options: file.options };
-    }
-}

package/dist/resources/index.d.ts

@@ -1 +0,0 @@
-export * from './chat-completions';

package/dist/resources/index.js

@@ -1 +0,0 @@
-export * from './chat-completions';

package/dist/streaming.d.ts

@@ -1,81 +0,0 @@
-import { ReadableStream } from 'node:stream/web';
-/**
- * Represents a server-sent event.
- */
-export type ServerSentEvent = {
-    /**
-     * The event type, or null if not specified.
-     */
-    event: string | null;
-    /**
-     * The event data.
-     */
-    data: string;
-    /**
-     * The raw event data as an array of strings.
-     */
-    raw: string[];
-};
-/**
- * Represents a stream of items that can be asynchronously iterated over.
- */
-export declare class Stream<Item> implements AsyncIterable<Item> {
-    private iterator;
-    /**
-     * The AbortController associated with this stream.
-     */
-    controller: AbortController;
-    /**
-     * Creates a new Stream instance.
-     *
-     * @param iterator - A function that returns an AsyncIterator<Item>.
-     * @param controller - The AbortController for this stream.
-     */
-    constructor(iterator: () => AsyncIterator<Item>, controller: AbortController);
-    /**
-     * Creates a Stream from a server-sent events (SSE) Response.
-     *
-     * @param response - The Response object containing the SSE data.
-     * @param controller - The AbortController for this stream.
-     * @returns A new Stream instance.
-     * @throws {Error} If the stream is consumed more than once.
-     * @throws {APIError} If the SSE data contains an error.
-     */
-    static fromSSEResponse<Item>(response: Response, controller: AbortController): Stream<Item>;
-    /**
-     * Creates a Stream from a newline-separated ReadableStream where each item is a JSON value.
-     *
-     * @param readableStream - The ReadableStream containing newline-separated JSON data.
-     * @param controller - The AbortController for this stream.
-     * @returns A new Stream instance.
-     * @throws {Error} If the stream is consumed more than once.
-     */
-    static fromReadableStream<Item>(readableStream: ReadableStream, controller: AbortController): Stream<Item>;
-    /**
-     * Implements the AsyncIterable interface, allowing the Stream to be used in a for-await-of loop.
-     *
-     * @returns An AsyncIterator for the stream items.
-     */
-    [Symbol.asyncIterator](): AsyncIterator<Item>;
-    /**
-     * Splits the stream into two streams which can be independently read from at different speeds.
-     *
-     * @returns A tuple containing two new Stream instances.
-     */
-    tee(): [Stream<Item>, Stream<Item>];
-    /**
-     * Converts this stream to a newline-separated ReadableStream of JSON stringified values.
-     * The resulting stream can be converted back to a Stream using `Stream.fromReadableStream()`.
-     *
-     * @returns A ReadableStream containing newline-separated JSON data.
-     */
-    toReadableStream(): ReadableStream;
-}
-export declare function _iterSSEMessages(response: Response, controller: AbortController): AsyncGenerator<ServerSentEvent, void, unknown>;
-/**
- * Most browsers don't yet have async iterable support for ReadableStream,
- * and Node has a very different way of reading bytes from its "ReadableStream".
- *
- * This polyfill was pulled from https://github.com/MattiasBuelens/web-streams-polyfill/pull/122#issuecomment-1627354490
- */
-export declare function readableStreamAsyncIterable<T>(stream: any): AsyncIterableIterator<T>;