@speechall/sdk 1.0.0 → 2.0.4

package/src/api/types/ReplacementRule.ts

@@ -0,0 +1,25 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as Speechall from "../index.js";
+
+/**
+ * Defines a single rule for finding and replacing text in a transcription. Use one of the specific rule types (`ExactRule`, `RegexRule`, `RegexGroupRule`). The `kind` property acts as a discriminator.
+ */
+export type ReplacementRule =
+    | Speechall.ReplacementRule.Exact
+    | Speechall.ReplacementRule.Regex
+    | Speechall.ReplacementRule.RegexGroup;
+
+export namespace ReplacementRule {
+    export interface Exact extends Speechall.ExactRule {
+        kind: "exact";
+    }
+
+    export interface Regex extends Speechall.RegexRule {
+        kind: "regex";
+    }
+
+    export interface RegexGroup extends Speechall.RegexGroupRule {
+        kind: "regex_group";
+    }
+}

package/src/api/types/SpeechToTextModel.ts

@@ -0,0 +1,90 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as Speechall from "../index.js";
+
+/**
+ * Describes an available speech-to-text model, its provider, capabilities, and characteristics.
+ */
+export interface SpeechToTextModel {
+    /** The unique identifier for this model (`provider.model_name`). */
+    id: Speechall.TranscriptionModelIdentifier;
+    /** A user-friendly name for the model. */
+    display_name: string;
+    /** The provider of this model. */
+    provider: Speechall.TranscriptionProvider;
+    /** A brief description of the model, its intended use case, or version notes. */
+    description?: string | null;
+    /** The cost per second of audio processed in USD. */
+    cost_per_second_usd?: number | null;
+    /** Indicates whether the model is currently available for use. */
+    is_available: boolean;
+    /** A list of language codes (preferably BCP 47, e.g., "en-US", "en-GB", "es-ES") supported by this model. May include `auto` if automatic language detection is supported across multiple languages within a single audio file. */
+    supported_languages?: string[] | null;
+    /** Indicates whether the model generally supports automatic punctuation insertion. */
+    punctuation?: boolean | null;
+    /** Indicates whether the model generally supports speaker diarization (identifying different speakers). */
+    diarization?: boolean | null;
+    /** Indicates whether the model can be used for real-time streaming transcription via a WebSocket connection (if offered by Speechall). */
+    streamable?: boolean | null;
+    /** An approximate measure of processing speed for batch processing. Defined as (audio duration) / (processing time). A higher value means faster processing (e.g., RTF=2 means it processes 1 second of audio in 0.5 seconds). May not be available for all models or streaming scenarios. */
+    real_time_factor?: number | null;
+    /** The maximum duration of a single audio file (in seconds) that the model can reliably process in one request. May vary by provider or plan. */
+    max_duration_seconds?: number | null;
+    /** The maximum size of a single audio file (in bytes) that can be uploaded for processing by this model. May vary by provider or plan. */
+    max_file_size_bytes?: number | null;
+    /** The specific version identifier for the model. */
+    version?: string | null;
+    /** The date when this specific version of the model was released or last updated. */
+    release_date?: string | null;
+    /** The primary type or training domain of the model. Helps identify suitability for different audio types. */
+    model_type?: SpeechToTextModel.ModelType | null;
+    /** A general indication of the model's expected accuracy level relative to other models. Not a guaranteed metric. */
+    accuracy_tier?: SpeechToTextModel.AccuracyTier | null;
+    /** A list of audio encodings that this model supports or is optimized for (e.g., LINEAR16, FLAC, MP3, Opus). */
+    supported_audio_encodings?: string[] | null;
+    /** A list of audio sample rates (in Hz) that this model supports or is optimized for. */
+    supported_sample_rates?: number[] | null;
+    /** Indicates whether the model can provide speaker labels for the transcription. */
+    speaker_labels?: boolean | null;
+    /** Indicates whether the model can provide timestamps for individual words. */
+    word_timestamps?: boolean | null;
+    /** Indicates whether the model provides confidence scores for the transcription or individual words. */
+    confidence_scores?: boolean | null;
+    /** Indicates whether the model supports automatic language detection for input audio. */
+    language_detection?: boolean | null;
+    /** Indicates if the model can leverage a custom vocabulary or language model adaptation. */
+    custom_vocabulary_support?: boolean | null;
+    /** Indicates if the model supports filtering or masking of profanity. */
+    profanity_filtering?: boolean | null;
+    /** Indicates if the model supports noise reduction. */
+    noise_reduction?: boolean | null;
+    /** Indicates whether the model supports SRT subtitle format output. */
+    supports_srt: boolean;
+    /** Indicates whether the model supports VTT subtitle format output. */
+    supports_vtt: boolean;
+    /** Indicates whether the model supports voice activity detection (VAD) to identify speech segments. */
+    voice_activity_detection?: boolean | null;
+}
+
+export namespace SpeechToTextModel {
+    /** The primary type or training domain of the model. Helps identify suitability for different audio types. */
+    export const ModelType = {
+        General: "general",
+        PhoneCall: "phone_call",
+        Video: "video",
+        CommandAndSearch: "command_and_search",
+        Medical: "medical",
+        Legal: "legal",
+        Voicemail: "voicemail",
+        Meeting: "meeting",
+    } as const;
+    export type ModelType = (typeof ModelType)[keyof typeof ModelType];
+    /** A general indication of the model's expected accuracy level relative to other models. Not a guaranteed metric. */
+    export const AccuracyTier = {
+        Basic: "basic",
+        Standard: "standard",
+        Enhanced: "enhanced",
+        Premium: "premium",
+    } as const;
+    export type AccuracyTier = (typeof AccuracyTier)[keyof typeof AccuracyTier];
+}

package/src/api/types/TranscriptLanguageCode.ts

@@ -0,0 +1,114 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/**
+ * The language code of the audio file, typically in ISO 639-1 format.
+ * Specifying the correct language improves transcription accuracy and speed.
+ * The special value `auto` can be used to request automatic language detection, if supported by the selected model.
+ * If omitted, the default language is English (`en`).
+ */
+export const TranscriptLanguageCode = {
+    Auto: "auto",
+    En: "en",
+    EnAu: "en_au",
+    EnUk: "en_uk",
+    EnUs: "en_us",
+    Af: "af",
+    Am: "am",
+    Ar: "ar",
+    As: "as",
+    Az: "az",
+    Ba: "ba",
+    Be: "be",
+    Bg: "bg",
+    Bn: "bn",
+    Bo: "bo",
+    Br: "br",
+    Bs: "bs",
+    Ca: "ca",
+    Cs: "cs",
+    Cy: "cy",
+    Da: "da",
+    De: "de",
+    El: "el",
+    Es: "es",
+    Et: "et",
+    Eu: "eu",
+    Fa: "fa",
+    Fi: "fi",
+    Fo: "fo",
+    Fr: "fr",
+    Gl: "gl",
+    Gu: "gu",
+    Ha: "ha",
+    Haw: "haw",
+    He: "he",
+    Hi: "hi",
+    Hr: "hr",
+    Ht: "ht",
+    Hu: "hu",
+    Hy: "hy",
+    Id: "id",
+    Is: "is",
+    It: "it",
+    Ja: "ja",
+    Jw: "jw",
+    Ka: "ka",
+    Kk: "kk",
+    Km: "km",
+    Kn: "kn",
+    Ko: "ko",
+    La: "la",
+    Lb: "lb",
+    Ln: "ln",
+    Lo: "lo",
+    Lt: "lt",
+    Lv: "lv",
+    Mg: "mg",
+    Mi: "mi",
+    Mk: "mk",
+    Ml: "ml",
+    Mn: "mn",
+    Mr: "mr",
+    Ms: "ms",
+    Mt: "mt",
+    My: "my",
+    Ne: "ne",
+    Nl: "nl",
+    Nn: "nn",
+    No: "no",
+    Oc: "oc",
+    Pa: "pa",
+    Pl: "pl",
+    Ps: "ps",
+    Pt: "pt",
+    Ro: "ro",
+    Ru: "ru",
+    Sa: "sa",
+    Sd: "sd",
+    Si: "si",
+    Sk: "sk",
+    Sl: "sl",
+    Sn: "sn",
+    So: "so",
+    Sq: "sq",
+    Sr: "sr",
+    Su: "su",
+    Sv: "sv",
+    Sw: "sw",
+    Ta: "ta",
+    Te: "te",
+    Tg: "tg",
+    Th: "th",
+    Tk: "tk",
+    Tl: "tl",
+    Tr: "tr",
+    Tt: "tt",
+    Uk: "uk",
+    Ur: "ur",
+    Uz: "uz",
+    Vi: "vi",
+    Yi: "yi",
+    Yo: "yo",
+    Zh: "zh",
+} as const;
+export type TranscriptLanguageCode = (typeof TranscriptLanguageCode)[keyof typeof TranscriptLanguageCode];

package/src/api/types/TranscriptOutputFormat.ts

@@ -0,0 +1,18 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/**
+ * Specifies the desired format of the transcription output.
+ * - `text`: Plain text containing the full transcription.
+ * - `json_text`: A simple JSON object containing the transcription ID and the full text (`TranscriptionOnlyText` schema).
+ * - `json`: A detailed JSON object including segments, timestamps (based on `timestamp_granularity`), language, and potentially speaker labels and provider metadata (`TranscriptionDetailed` schema).
+ * - `srt`: SubRip subtitle format (returned as plain text).
+ * - `vtt`: WebVTT subtitle format (returned as plain text).
+ */
+export const TranscriptOutputFormat = {
+    Text: "text",
+    JsonText: "json_text",
+    Json: "json",
+    Srt: "srt",
+    Vtt: "vtt",
+} as const;
+export type TranscriptOutputFormat = (typeof TranscriptOutputFormat)[keyof typeof TranscriptOutputFormat];

package/src/api/types/TranscriptionDetailed.ts

@@ -0,0 +1,19 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as Speechall from "../index.js";
+
+/**
+ * A detailed JSON response format containing the full text, detected language, duration, individual timed segments, and potentially speaker labels and provider-specific metadata. Returned when `output_format` is `json`.
+ */
+export interface TranscriptionDetailed {
+    /** A unique identifier for the transcription job/request. */
+    id: string;
+    /** The full transcribed text as a single string. */
+    text: string;
+    /** The detected or specified language of the audio (ISO 639-1 code). */
+    language?: string;
+    /** An array of transcribed segments, providing time-coded chunks of the transcription. May include speaker labels if diarization was enabled. */
+    segments?: Speechall.TranscriptionSegment[];
+    /** An array of transcribed words, providing time-coded chunks of the transcription. May include speaker labels if diarization was enabled. */
+    words?: Speechall.TranscriptionWord[];
+}

package/src/api/types/TranscriptionModelIdentifier.ts

@@ -0,0 +1,80 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/** Unique identifier for a specific Speech-to-Text model, composed as `provider.model_name`. Used to select the engine for transcription. */
+export const TranscriptionModelIdentifier = {
+    AmazonTranscribe: "amazon.transcribe",
+    AssemblyaiBest: "assemblyai.best",
+    AssemblyaiNano: "assemblyai.nano",
+    AssemblyaiSlam1: "assemblyai.slam-1",
+    AssemblyaiUniversal: "assemblyai.universal",
+    AzureStandard: "azure.standard",
+    CloudflareWhisper: "cloudflare.whisper",
+    CloudflareWhisperLargeV3Turbo: "cloudflare.whisper-large-v3-turbo",
+    CloudflareWhisperTinyEn: "cloudflare.whisper-tiny-en",
+    DeepgramBase: "deepgram.base",
+    DeepgramBaseConversationalai: "deepgram.base-conversationalai",
+    DeepgramBaseFinance: "deepgram.base-finance",
+    DeepgramBaseGeneral: "deepgram.base-general",
+    DeepgramBaseMeeting: "deepgram.base-meeting",
+    DeepgramBasePhonecall: "deepgram.base-phonecall",
+    DeepgramBaseVideo: "deepgram.base-video",
+    DeepgramBaseVoicemail: "deepgram.base-voicemail",
+    DeepgramEnhanced: "deepgram.enhanced",
+    DeepgramEnhancedFinance: "deepgram.enhanced-finance",
+    DeepgramEnhancedGeneral: "deepgram.enhanced-general",
+    DeepgramEnhancedMeeting: "deepgram.enhanced-meeting",
+    DeepgramEnhancedPhonecall: "deepgram.enhanced-phonecall",
+    DeepgramNova: "deepgram.nova",
+    DeepgramNovaGeneral: "deepgram.nova-general",
+    DeepgramNovaPhonecall: "deepgram.nova-phonecall",
+    DeepgramNova2: "deepgram.nova-2",
+    DeepgramNova2Atc: "deepgram.nova-2-atc",
+    DeepgramNova2Automotive: "deepgram.nova-2-automotive",
+    DeepgramNova2Conversationalai: "deepgram.nova-2-conversationalai",
+    DeepgramNova2Drivethru: "deepgram.nova-2-drivethru",
+    DeepgramNova2Finance: "deepgram.nova-2-finance",
+    DeepgramNova2General: "deepgram.nova-2-general",
+    DeepgramNova2Medical: "deepgram.nova-2-medical",
+    DeepgramNova2Meeting: "deepgram.nova-2-meeting",
+    DeepgramNova2Phonecall: "deepgram.nova-2-phonecall",
+    DeepgramNova2Video: "deepgram.nova-2-video",
+    DeepgramNova2Voicemail: "deepgram.nova-2-voicemail",
+    DeepgramNova3: "deepgram.nova-3",
+    DeepgramNova3General: "deepgram.nova-3-general",
+    DeepgramNova3Medical: "deepgram.nova-3-medical",
+    DeepgramWhisper: "deepgram.whisper",
+    DeepgramWhisperBase: "deepgram.whisper-base",
+    DeepgramWhisperLarge: "deepgram.whisper-large",
+    DeepgramWhisperMedium: "deepgram.whisper-medium",
+    DeepgramWhisperSmall: "deepgram.whisper-small",
+    DeepgramWhisperTiny: "deepgram.whisper-tiny",
+    ElevenlabsScribeV1: "elevenlabs.scribe-v1",
+    FalaiElevenlabsSpeechToText: "falai.elevenlabs-speech-to-text",
+    FalaiSpeechToText: "falai.speech-to-text",
+    FalaiWhisper: "falai.whisper",
+    FalaiWizper: "falai.wizper",
+    FireworksaiWhisperV3: "fireworksai.whisper-v3",
+    FireworksaiWhisperV3Turbo: "fireworksai.whisper-v3-turbo",
+    GladiaStandard: "gladia.standard",
+    GoogleEnhanced: "google.enhanced",
+    GoogleStandard: "google.standard",
+    GeminiGemini25Pro: "gemini.gemini-2.5-pro",
+    GeminiGemini25Flash: "gemini.gemini-2.5-flash",
+    GeminiGemini25FlashLite: "gemini.gemini-2.5-flash-lite",
+    GeminiGemini20Flash: "gemini.gemini-2.0-flash",
+    GeminiGemini20FlashLite: "gemini.gemini-2.0-flash-lite",
+    GroqWhisperLargeV3: "groq.whisper-large-v3",
+    GroqWhisperLargeV3Turbo: "groq.whisper-large-v3-turbo",
+    IbmStandard: "ibm.standard",
+    MistralVoxtralMini: "mistral.voxtral-mini",
+    OpenaiWhisper1: "openai.whisper-1",
+    OpenaiGpt4OTranscribe: "openai.gpt-4o-transcribe",
+    OpenaiGpt4OMiniTranscribe: "openai.gpt-4o-mini-transcribe",
+    OpenaiGpt4OTranscribeDiarize: "openai.gpt-4o-transcribe-diarize",
+    RevaiMachine: "revai.machine",
+    RevaiFusion: "revai.fusion",
+    SpeechmaticsEnhanced: "speechmatics.enhanced",
+    SpeechmaticsStandard: "speechmatics.standard",
+} as const;
+export type TranscriptionModelIdentifier =
+    (typeof TranscriptionModelIdentifier)[keyof typeof TranscriptionModelIdentifier];

package/src/api/types/TranscriptionOnlyText.ts

@@ -0,0 +1,11 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/**
+ * A simplified JSON response format containing only the transcription ID and the full transcribed text. Returned when `output_format` is `json_text`.
+ */
+export interface TranscriptionOnlyText {
+    /** A unique identifier for the transcription job/request. */
+    id: string;
+    /** The full transcribed text as a single string. */
+    text: string;
+}

package/src/api/types/TranscriptionProvider.ts

@@ -0,0 +1,23 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/** The identifier for the underlying Speech-to-Text service provider (e.g., 'openai', 'deepgram'). */
+export const TranscriptionProvider = {
+    Amazon: "amazon",
+    Assemblyai: "assemblyai",
+    Azure: "azure",
+    Cloudflare: "cloudflare",
+    Deepgram: "deepgram",
+    Elevenlabs: "elevenlabs",
+    Falai: "falai",
+    Fireworksai: "fireworksai",
+    Gemini: "gemini",
+    Gladia: "gladia",
+    Google: "google",
+    Groq: "groq",
+    Ibm: "ibm",
+    Mistral: "mistral",
+    Openai: "openai",
+    Revai: "revai",
+    Speechmatics: "speechmatics",
+} as const;
+export type TranscriptionProvider = (typeof TranscriptionProvider)[keyof typeof TranscriptionProvider];

package/src/api/types/TranscriptionResponse.ts

@@ -0,0 +1,8 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as Speechall from "../index.js";
+
+/**
+ * Represents the JSON structure returned when a JSON-based `output_format` (`json` or `json_text`) is requested. It can be either a detailed structure or a simple text-only structure.
+ */
+export type TranscriptionResponse = Speechall.TranscriptionDetailed | Speechall.TranscriptionOnlyText;

package/src/api/types/TranscriptionSegment.ts

@@ -0,0 +1,17 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/**
+ * Represents a time-coded segment of the transcription, typically corresponding to a phrase, sentence, or speaker turn.
+ */
+export interface TranscriptionSegment {
+    /** The start time of the segment in seconds from the beginning of the audio. */
+    start?: number;
+    /** The end time of the segment in seconds from the beginning of the audio. */
+    end?: number;
+    /** The transcribed text content of this segment. */
+    text?: string;
+    /** An identifier for the speaker of this segment, present if diarization was enabled and successful. */
+    speaker?: string;
+    /** The model's confidence score for the transcription of this segment, typically between 0 and 1 (if provided by the model). */
+    confidence?: number;
+}

package/src/api/types/TranscriptionWord.ts

@@ -0,0 +1,17 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/**
+ * Represents a word in the transcription, providing time-coded chunks of the transcription.
+ */
+export interface TranscriptionWord {
+    /** The start time of the word in seconds from the beginning of the audio. */
+    start: number;
+    /** The end time of the word in seconds from the beginning of the audio. */
+    end: number;
+    /** The transcribed word. */
+    word: string;
+    /** An identifier for the speaker of this word, present if diarization was enabled and successful. */
+    speaker?: string;
+    /** The model's confidence score for the transcription of this word, typically between 0 and 1 (if provided by the model). */
+    confidence?: number;
+}

package/src/api/types/index.ts

@@ -0,0 +1,16 @@
+export * from "./BaseTranscriptionConfiguration.js";
+export * from "./ErrorResponse.js";
+export * from "./ExactRule.js";
+export * from "./RegexGroupRule.js";
+export * from "./RegexRule.js";
+export * from "./ReplacementRule.js";
+export * from "./SpeechToTextModel.js";
+export * from "./TranscriptionDetailed.js";
+export * from "./TranscriptionModelIdentifier.js";
+export * from "./TranscriptionOnlyText.js";
+export * from "./TranscriptionProvider.js";
+export * from "./TranscriptionResponse.js";
+export * from "./TranscriptionSegment.js";
+export * from "./TranscriptionWord.js";
+export * from "./TranscriptLanguageCode.js";
+export * from "./TranscriptOutputFormat.js";

package/src/auth/BearerAuthProvider.ts

@@ -0,0 +1,37 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import * as core from "../core/index.js";
+import * as errors from "../errors/index.js";
+
+export namespace BearerAuthProvider {
+    export interface AuthOptions {
+        token: core.Supplier<core.BearerToken>;
+    }
+
+    export interface Options extends AuthOptions {}
+}
+
+export class BearerAuthProvider implements core.AuthProvider {
+    private readonly token: core.Supplier<core.BearerToken>;
+
+    constructor(options: BearerAuthProvider.Options) {
+        this.token = options.token;
+    }
+
+    public static canCreate(options: BearerAuthProvider.Options): boolean {
+        return options.token != null;
+    }
+
+    public async getAuthRequest(_arg?: { endpointMetadata?: core.EndpointMetadata }): Promise<core.AuthRequest> {
+        const token = await core.Supplier.get(this.token);
+        if (token == null) {
+            throw new errors.SpeechallError({
+                message: "Please specify a token by passing it in to the constructor",
+            });
+        }
+
+        return {
+            headers: { Authorization: `Bearer ${token}` },
+        };
+    }
+}

package/src/auth/index.ts

@@ -0,0 +1 @@
+export { BearerAuthProvider } from "./BearerAuthProvider.js";

package/src/core/auth/AuthProvider.ts

@@ -0,0 +1,6 @@
+import type { EndpointMetadata } from "../fetcher/EndpointMetadata.js";
+import type { AuthRequest } from "./AuthRequest.js";
+
+export interface AuthProvider {
+    getAuthRequest(arg?: { endpointMetadata?: EndpointMetadata }): Promise<AuthRequest>;
+}

package/src/core/auth/AuthRequest.ts

@@ -0,0 +1,9 @@
+/**
+ * Request parameters for authentication requests.
+ */
+export interface AuthRequest {
+    /**
+     * The headers to be included in the request.
+     */
+    headers: Record<string, string>;
+}

package/src/core/auth/BasicAuth.ts

@@ -0,0 +1,32 @@
+import { base64Decode, base64Encode } from "../base64.js";
+
+export interface BasicAuth {
+    username: string;
+    password: string;
+}
+
+const BASIC_AUTH_HEADER_PREFIX = /^Basic /i;
+
+export const BasicAuth = {
+    toAuthorizationHeader: (basicAuth: BasicAuth | undefined): string | undefined => {
+        if (basicAuth == null) {
+            return undefined;
+        }
+        const token = base64Encode(`${basicAuth.username}:${basicAuth.password}`);
+        return `Basic ${token}`;
+    },
+    fromAuthorizationHeader: (header: string): BasicAuth => {
+        const credentials = header.replace(BASIC_AUTH_HEADER_PREFIX, "");
+        const decoded = base64Decode(credentials);
+        const [username, ...passwordParts] = decoded.split(":");
+        const password = passwordParts.length > 0 ? passwordParts.join(":") : undefined;
+
+        if (username == null || password == null) {
+            throw new Error("Invalid basic auth");
+        }
+        return {
+            username,
+            password,
+        };
+    },
+};

package/src/core/auth/BearerToken.ts

@@ -0,0 +1,20 @@
+export type BearerToken = string;
+
+const BEARER_AUTH_HEADER_PREFIX = /^Bearer /i;
+
+function toAuthorizationHeader(token: string | undefined): string | undefined {
+    if (token == null) {
+        return undefined;
+    }
+    return `Bearer ${token}`;
+}
+
+export const BearerToken: {
+    toAuthorizationHeader: typeof toAuthorizationHeader;
+    fromAuthorizationHeader: (header: string) => BearerToken;
+} = {
+    toAuthorizationHeader: toAuthorizationHeader,
+    fromAuthorizationHeader: (header: string): BearerToken => {
+        return header.replace(BEARER_AUTH_HEADER_PREFIX, "").trim() as BearerToken;
+    },
+};

package/src/core/auth/NoOpAuthProvider.ts

@@ -0,0 +1,8 @@
+import type { AuthProvider } from "./AuthProvider.js";
+import type { AuthRequest } from "./AuthRequest.js";
+
+export class NoOpAuthProvider implements AuthProvider {
+    public getAuthRequest(): Promise<AuthRequest> {
+        return Promise.resolve({ headers: {} });
+    }
+}

package/src/core/auth/index.ts

@@ -0,0 +1,5 @@
+export type { AuthProvider } from "./AuthProvider.js";
+export type { AuthRequest } from "./AuthRequest.js";
+export { BasicAuth } from "./BasicAuth.js";
+export { BearerToken } from "./BearerToken.js";
+export { NoOpAuthProvider } from "./NoOpAuthProvider.js";

package/src/core/base64.ts

@@ -0,0 +1,27 @@
+function base64ToBytes(base64: string): Uint8Array {
+    const binString = atob(base64);
+    return Uint8Array.from(binString, (m) => m.codePointAt(0)!);
+}
+
+function bytesToBase64(bytes: Uint8Array): string {
+    const binString = String.fromCodePoint(...bytes);
+    return btoa(binString);
+}
+
+export function base64Encode(input: string): string {
+    if (typeof Buffer !== "undefined") {
+        return Buffer.from(input, "utf8").toString("base64");
+    }
+
+    const bytes = new TextEncoder().encode(input);
+    return bytesToBase64(bytes);
+}
+
+export function base64Decode(input: string): string {
+    if (typeof Buffer !== "undefined") {
+        return Buffer.from(input, "base64").toString("utf8");
+    }
+
+    const bytes = base64ToBytes(input);
+    return new TextDecoder().decode(bytes);
+}

package/src/core/exports.ts

@@ -0,0 +1,2 @@
+export * from "./file/exports.js";
+export * from "./logging/exports.js";

package/src/core/fetcher/APIResponse.ts

@@ -0,0 +1,23 @@
+import type { RawResponse } from "./RawResponse.js";
+
+/**
+ * The response of an API call.
+ * It is a successful response or a failed response.
+ */
+export type APIResponse<Success, Failure> = SuccessfulResponse<Success> | FailedResponse<Failure>;
+
+export interface SuccessfulResponse<T> {
+    ok: true;
+    body: T;
+    /**
+     * @deprecated Use `rawResponse` instead
+     */
+    headers?: Record<string, any>;
+    rawResponse: RawResponse;
+}
+
+export interface FailedResponse<T> {
+    ok: false;
+    error: T;
+    rawResponse: RawResponse;
+}