@meistrari/tela-sdk-js 0.0.2 → 0.0.4

package/dist/file.d.ts

@@ -1,123 +0,0 @@
-import { ReadStream } from 'node:fs';
-import { ReadableStream } from 'node:stream/web';
-/**
- * Configuration options for `TelaFile`.
- */
-export type TelaFileOptions = {
-    /**
-     * Defines the page range of the document to be processed.
-     *
-     * Specifies the range of pages to process, starting from `startPage` to `endPage`, inclusive, 0-indexed.
-     *
-     * @example
-     * ```typescript
-     * const file = new TelaFile(fileStream, {
-     *     range: [0, 1],
-     * })
-     * ```
-     */
-    range?: [number, number];
-};
-/**
- * Represents the possible types for a file input,
- * which can be a URL string, Uint8Array, ReadableStream, ReadStream, Blob, or File.
- */
-export type TelaFileInput = string | Uint8Array | ReadableStream | ReadStream | Blob | File;
-/**
- * Represents a file with support for various types including URLs, binary data, streams, and Blobs.
- *
- * @example
- * ```typescript
- * // Using a URL string
- * const urlFile = new TelaFile("https://example.com/file.png", { range: { start: 0, end: 1024 } })
- *
- * // Using a Uint8Array (buffer)
- * const buffer = new Uint8Array([/* binary data * /])
- * const bufferFile = new TelaFile(buffer)
- *
- * // Using a ReadStream
- * import { createReadStream } from 'fs'
- * const readStream = createReadStream('path/to/file')
- * const streamFile = new TelaFile(readStream)
- *
- * // Using a ReadableStream
- * const readableStream = new ReadableStream({
- *     start(controller) {
- *         controller.enqueue(new TextEncoder().encode('Hello, world!'))
- *         controller.close()
- *     }
- * })
- * const readableStreamFile = new TelaFile(readableStream)
- *
- * // Using a Blob (in environments that support Blob)
- * const blob = new Blob(['file content'], { type: 'text/plain' })
- * const blobFile = new TelaFile(blob)
- *
- * // Using a File (in browser environments)
- * const file = new File(['file content'], 'filename.txt', { type: 'text/plain' })
- * const fileInstance = new TelaFile(file)
- * ```
- */
-export declare class TelaFile {
-    private _file;
-    private _options;
-    private _size;
-    /**
-     * Creates an instance of `TelaFile`.
-     *
-     * @param file - The source of the file. Can be a URL string, Uint8Array, ReadableStream, ReadStream, Blob, or File.
-     * @param options - Optional configuration options such as byte range.
-     * @throws {InvalidFileURL} If the provided URL is not valid.
-     * @throws {EmptyFileError} If the provided file is empty.
-     */
-    constructor(file: string | Uint8Array | ReadableStream | ReadStream | Blob | File, options?: TelaFileOptions);
-    /**
-     * Retrieves the options provided during instantiation.
-     *
-     * @returns The `TelaFileOptions` or an empty object if none were provided.
-     */
-    get options(): TelaFileOptions;
-    /**
-     * Determines whether the file source is a valid URL.
-     *
-     * @returns `true` if the file source is a valid URL string, otherwise `false`.
-     */
-    get isURL(): boolean;
-    /**
-     * Gets the size of the file in bytes.
-     *
-     * @returns The size of the file if available, otherwise `null`.
-     */
-    get size(): number | null;
-    /**
-     * Retrieves the content of the file in a format suitable for uploading.
-     *
-     * - If the file is a URL, it returns the URL string.
-     * - If the file is a `Uint8Array`, it converts it to a `File` object.
-     * - If the file is a `ReadStream` or `ReadableStream`, it calculates the size and returns a stream.
-     *
-     * @returns A promise that resolves to the uploadable content.
-     */
-    getUploadableContent(): Promise<string | File | Blob | ReadableStream>;
-    /**
-     * Validates the provided file based on its type.
-     *
-     * @throws {InvalidFileURL} If the file is a string but not a valid URL.
-     * @throws {EmptyFileError} If the file is empty.
-     */
-    private validateFile;
-    /**
-     * Checks if the provided string is a valid URL.
-     *
-     * @param url - The URL string to validate.
-     * @returns `true` if the URL is valid, otherwise `false`.
-     */
-    private isValidURL;
-}
-/**
- * Creates a new `TelaFile` instance from the provided file input.
- *
- * @param file - The file input to create a `TelaFile` instance from.
- * @returns A new `TelaFile` instance.
- */
-export declare function createTelaFile(file: TelaFileInput): TelaFile;

package/dist/file.js

@@ -1,161 +0,0 @@
-import { ReadStream } from 'node:fs';
-import { Readable } from 'node:stream';
-import { ReadableStream } from 'node:stream/web';
-import { EmptyFileError, InvalidFileURL } from './errors';
-import { getStreamSize } from './utils/stream';
-/**
- * Represents a file with support for various types including URLs, binary data, streams, and Blobs.
- *
- * @example
- * ```typescript
- * // Using a URL string
- * const urlFile = new TelaFile("https://example.com/file.png", { range: { start: 0, end: 1024 } })
- *
- * // Using a Uint8Array (buffer)
- * const buffer = new Uint8Array([/* binary data * /])
- * const bufferFile = new TelaFile(buffer)
- *
- * // Using a ReadStream
- * import { createReadStream } from 'fs'
- * const readStream = createReadStream('path/to/file')
- * const streamFile = new TelaFile(readStream)
- *
- * // Using a ReadableStream
- * const readableStream = new ReadableStream({
- *     start(controller) {
- *         controller.enqueue(new TextEncoder().encode('Hello, world!'))
- *         controller.close()
- *     }
- * })
- * const readableStreamFile = new TelaFile(readableStream)
- *
- * // Using a Blob (in environments that support Blob)
- * const blob = new Blob(['file content'], { type: 'text/plain' })
- * const blobFile = new TelaFile(blob)
- *
- * // Using a File (in browser environments)
- * const file = new File(['file content'], 'filename.txt', { type: 'text/plain' })
- * const fileInstance = new TelaFile(file)
- * ```
- */
-export class TelaFile {
-    _file;
-    _options;
-    _size = null;
-    /**
-     * Creates an instance of `TelaFile`.
-     *
-     * @param file - The source of the file. Can be a URL string, Uint8Array, ReadableStream, ReadStream, Blob, or File.
-     * @param options - Optional configuration options such as byte range.
-     * @throws {InvalidFileURL} If the provided URL is not valid.
-     * @throws {EmptyFileError} If the provided file is empty.
-     */
-    constructor(file, options) {
-        this._file = file;
-        this._options = options;
-        this.validateFile();
-    }
-    /**
-     * Retrieves the options provided during instantiation.
-     *
-     * @returns The `TelaFileOptions` or an empty object if none were provided.
-     */
-    get options() {
-        return this._options || {};
-    }
-    /**
-     * Determines whether the file source is a valid URL.
-     *
-     * @returns `true` if the file source is a valid URL string, otherwise `false`.
-     */
-    get isURL() {
-        return typeof this._file === 'string' && this.isValidURL(this._file);
-    }
-    /**
-     * Gets the size of the file in bytes.
-     *
-     * @returns The size of the file if available, otherwise `null`.
-     */
-    get size() {
-        return this._size;
-    }
-    /**
-     * Retrieves the content of the file in a format suitable for uploading.
-     *
-     * - If the file is a URL, it returns the URL string.
-     * - If the file is a `Uint8Array`, it converts it to a `File` object.
-     * - If the file is a `ReadStream` or `ReadableStream`, it calculates the size and returns a stream.
-     *
-     * @returns A promise that resolves to the uploadable content.
-     */
-    async getUploadableContent() {
-        if (this.isURL && typeof this._file === 'string') {
-            return this._file;
-        }
-        if (this._file instanceof Uint8Array) {
-            return new File([this._file], 'file', {
-                type: 'application/octet-stream',
-            });
-        }
-        if (this._file instanceof ReadStream) {
-            const webStream = Readable.toWeb(this._file);
-            const [sizeStream, contentStream] = webStream.tee();
-            this._size = await getStreamSize(sizeStream);
-            return contentStream;
-        }
-        if (this._file instanceof ReadableStream) {
-            const [sizeStream, contentStream] = this._file.tee();
-            this._size = await getStreamSize(sizeStream);
-            return contentStream;
-        }
-        return this._file;
-    }
-    /**
-     * Validates the provided file based on its type.
-     *
-     * @throws {InvalidFileURL} If the file is a string but not a valid URL.
-     * @throws {EmptyFileError} If the file is empty.
-     */
-    validateFile() {
-        if (typeof this._file === 'string') {
-            if (!this.isValidURL(this._file)) {
-                throw new InvalidFileURL(this._file);
-            }
-        }
-        if (this._file instanceof Uint8Array) {
-            if (this._file.length === 0) {
-                throw new EmptyFileError();
-            }
-        }
-        if (this._file instanceof Blob || this._file instanceof File) {
-            if (this._file.size === 0) {
-                throw new EmptyFileError();
-            }
-        }
-    }
-    /**
-     * Checks if the provided string is a valid URL.
-     *
-     * @param url - The URL string to validate.
-     * @returns `true` if the URL is valid, otherwise `false`.
-     */
-    isValidURL(url) {
-        try {
-            // eslint-disable-next-line no-new
-            new URL(url);
-            return true;
-        }
-        catch {
-            return false;
-        }
-    }
-}
-/**
- * Creates a new `TelaFile` instance from the provided file input.
- *
- * @param file - The file input to create a `TelaFile` instance from.
- * @returns A new `TelaFile` instance.
- */
-export function createTelaFile(file) {
-    return new TelaFile(file);
-}

package/dist/index.js

@@ -1,115 +0,0 @@
-import { BaseClient } from './base-client';
-import * as Errors from './errors';
-import { createTelaFile } from './file';
-import * as Resources from './resources';
-export { TelaFile } from './file';
-const baseUrl = 'https://api.tela.com';
-/**
- * The main class for interacting with the Tela API.
- *
- * Provides methods to access various Tela API resources.
- *
- * @example
- * ```typescript
- * const tela = new TelaSDK({ apiKey: 'your-api-key' });
- * const completion = await tela.completions.create({
- *   canvasId: "your-canvas-id",
- *   messages: [{ role: "user", content: "Hello!" }],
- * });
- * ```
- */
-export class TelaSDK extends BaseClient {
-    opts;
-    apiKey;
-    jwt;
-    /**
-     * Creates a new instance of the TelaSDK.
-     */
-    constructor({ baseURL = baseUrl, apiKey, jwt, ...rest }) {
-        super({ baseURL, ...rest });
-        this.opts = { baseURL, ...rest };
-        this.apiKey = apiKey;
-        this.jwt = jwt;
-        this.validateAuth();
-    }
-    validateAuth() {
-        if (!this.apiKey && !this.jwt) {
-            throw new Errors.MissingApiKeyOrJWTError();
-        }
-        if (this.apiKey && this.jwt) {
-            throw new Errors.ConflictApiKeyAndJWTError();
-        }
-    }
-    getAuthHeaders() {
-        return {
-            Authorization: `Bearer ${this.apiKey || this.jwt}`,
-        };
-    }
-    /**
-     * The ChatCompletions resource for interacting with Tela's chat completion API.
-     *
-     * Use this to generate chat completions based on provided messages.
-     *
-     * @example
-     * ```typescript
-     * const completion = await tela.completions.create({
-     *   canvasId: "your-canvas-id",
-     *   messages: [{ role: "user", content: "Hello!" }],
-     * });
-     * ```
-     */
-    completions = new Resources.ChatCompletions(this);
-    /**
-     * Creates a new `TelaFile` instance from the provided file input.
-     *
-     * @param file - The file input to create a `TelaFile` instance from.
-     * @returns A new `TelaFile` instance.
-     */
-    createFile = createTelaFile.bind(this);
-    static TelaSDK = this;
-    static DEFAULT_TIMEOUT = 0;
-    // Error classes
-    /** Thrown when an API request fails. */
-    static APIError = Errors.APIError;
-    /** Thrown when a request is aborted by the user. */
-    static UserAbortError = Errors.UserAbortError;
-    /** Thrown when there's a network connection error. */
-    static ConnectionError = Errors.ConnectionError;
-    /** Thrown when a request times out. */
-    static ConnectionTimeout = Errors.ConnectionTimeout;
-    /** Thrown when the API returns a 400 Bad Request error. */
-    static BadRequestError = Errors.BadRequestError;
-    /** Thrown when authentication fails (e.g., invalid API key). */
-    static AuthenticationError = Errors.AuthenticationError;
-    /** Thrown when the authenticated user doesn't have permission for the requested operation. */
-    static AuthorizationError = Errors.AuthorizationError;
-    /** Thrown when the requested resource is not found. */
-    static NotFoundError = Errors.NotFoundError;
-    /** Thrown when there's a conflict with the current state of the resource. */
-    static ConflictError = Errors.ConflictError;
-    /** Thrown when the request is well-formed but unable to be processed due to semantic errors. */
-    static UnprocessableEntityError = Errors.UnprocessableEntityError;
-    /** Thrown when the API rate limit is exceeded. */
-    static RateLimitError = Errors.RateLimitError;
-    /** Thrown when an unexpected server error occurs. */
-    static InternalServerError = Errors.InternalServerError;
-    /** Thrown when attempting to upload an empty file. */
-    static EmptyFileError = Errors.EmptyFileError;
-    /** Thrown when an invalid file URL is provided. */
-    static InvalidFileURL = Errors.InvalidFileURL;
-    /** Thrown when there's an error during file upload. */
-    static FileUploadError = Errors.FileUploadError;
-    /** Thrown when neither an API key nor a JWT is provided. */
-    static MissingApiKeyOrJWTError = Errors.MissingApiKeyOrJWTError;
-    /** Thrown when both an API key and a JWT are provided. */
-    static ConflictApiKeyAndJWTError = Errors.ConflictApiKeyAndJWTError;
-}
-/**
- * Creates a new instance of the TelaSDK.
- *
- * @param opts - The options for configuring the TelaSDK.
- * @returns A new instance of the TelaSDK.
- */
-export function createTelaClient(opts) {
-    return new TelaSDK(opts);
-}

package/dist/resource.d.ts

@@ -1,8 +0,0 @@
-import type { BaseClient } from './base-client';
-/**
- * Base class for all resources.
- */
-export declare class Resource {
-    protected _client: BaseClient;
-    constructor(client: BaseClient);
-}

package/dist/resource.js

@@ -1,9 +0,0 @@
-/**
- * Base class for all resources.
- */
-export class Resource {
-    _client;
-    constructor(client) {
-        this._client = client;
-    }
-}