@speechall/sdk 1.0.0 → 2.1.0

package/fern/generators.yml

@@ -0,0 +1,43 @@
+# yaml-language-server: $schema=https://schema.buildwithfern.dev/generators-yml.json
+api:
+  specs:
+    # Fern doesn't support remote URLs in generators.yml (only local paths)
+    # The remote URL is public: https://raw.githubusercontent.com/Speechall/speechall-openapi/refs/heads/main/openapi.yaml
+    # But must be downloaded locally first via: fern init --openapi <url>
+    - openapi: ../../../Speechall-Repositories/speechall-openapi/openapi.yaml
+
+default-group: local
+
+groups:
+  local:
+    generators:
+      - name: fernapi/fern-typescript-sdk
+        version: 3.42.0
+        output:
+          location: local-file-system
+          path: ../src
+        config:
+          namespaceExport: Speechall
+          enableInlineTypes: true
+          generateWireTests: true
+          neverThrowErrors: false
+          skipResponseValidation: false
+          treatUnknownAsAny: false
+          outputSourceFiles: true
+          packageJson:
+            name: "@speechall/sdk"
+            version: 2.1.0
+            description: "TypeScript SDK for Speechall API - Speech-to-text transcription
+              service"
+            author: Speechall
+            license: MIT
+            repository:
+              type: git
+              url: "https://github.com/Speechall/speechall-typescript-sdk"
+            homepage: "https://docs.speechall.com"
+            keywords:
+              - speechall
+              - speech-to-text
+              - transcription
+              - api
+              - sdk

package/jest.config.js

@@ -0,0 +1,11 @@
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  roots: ['<rootDir>/tests'],
+  testMatch: ['**/*.test.ts'],
+  collectCoverageFrom: ['src/**/*.ts'],
+  coverageDirectory: 'coverage',
+  moduleNameMapper: {
+    '^(\\.{1,2}/.*)\\.js$': '$1',
+  },
+};

package/package.json

@@ -1,64 +1,44 @@
 {
   "name": "@speechall/sdk",
-  "version": "1.0.0",
-  "description": "TypeScript SDK for the Speechall API - A powerful and flexible speech-to-text service",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "module": "dist/esm/index.js",
-  "sideEffects": false,
-  "files": [
-    "dist/**/*",
-    "README.md",
-    "LICENSE"
-  ],
-  "scripts": {
-    "build": "npm run build:cjs && npm run build:esm",
-    "build:cjs": "tsc -p tsconfig.json",
-    "build:esm": "tsc -p tsconfig.esm.json && node scripts/fix-esm-imports.js",
-    "clean": "rimraf dist",
-    "prepublishOnly": "npm run clean && npm run build",
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "lint": "eslint . --ext .ts",
-    "lint:fix": "eslint . --ext .ts --fix",
-    "generate": "node scripts/generate-sdk.js",
-    "generate:bash": "bash scripts/generate-sdk.sh"
+  "version": "2.1.0",
+  "description": "TypeScript SDK for Speechall API - Speech-to-text transcription service",
+  "author": "Speechall",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Speechall/speechall-typescript-sdk"
   },
+  "homepage": "https://docs.speechall.com",
   "keywords": [
     "speechall",
     "speech-to-text",
-    "stt",
     "transcription",
-    "audio",
-    "voice",
     "api",
-    "typescript",
     "sdk"
   ],
-  "author": "Speechall",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/speechall/speechall-typescript-sdk.git"
-  },
-  "bugs": {
-    "url": "https://github.com/speechall/speechall-typescript-sdk/issues"
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build",
+    "test": "jest",
+    "test:unit": "jest tests/unit",
+    "test:integration": "jest tests/integration",
+    "test:coverage": "jest --coverage",
+    "test:watch": "jest --watch"
   },
-  "homepage": "https://github.com/speechall/speechall-typescript-sdk#readme",
   "dependencies": {
-    "axios": "^1.6.0"
+    "@types/url-join": "4.0.1",
+    "url-join": "4.0.1"
   },
   "devDependencies": {
-    "@semantic-release/changelog": "^6.0.3",
-    "@semantic-release/git": "^10.0.1",
+    "@types/jest": "^30.0.0",
     "@types/node": "^20.0.0",
-    "@typescript-eslint/eslint-plugin": "^6.0.0",
-    "@typescript-eslint/parser": "^6.0.0",
-    "eslint": "^8.0.0",
-    "rimraf": "^5.0.0",
-    "semantic-release": "^22.0.12",
+    "dotenv": "^17.2.3",
+    "jest": "^30.2.0",
+    "ts-jest": "^29.4.6",
+    "ts-node": "^10.9.2",
+    "tsx": "^4.21.0",
     "typescript": "^5.0.0"
-  },
-  "engines": {
-    "node": ">=16"
   }
 }

package/regenerate.sh

@@ -0,0 +1,45 @@
+#!/bin/bash
+set -e
+
+echo "Validating Fern configuration..."
+
+if [ ! -f "fern/generators.yml" ]; then
+    echo "Error: fern/generators.yml not found"
+    exit 1
+fi
+
+echo "Using OpenAPI spec configured in fern/generators.yml"
+echo "Note: The OpenAPI spec path is configured in fern/generators.yml"
+echo "For local OpenAPI changes, edit fern/generators.yml to use your local path."
+
+echo "Generating TypeScript SDK with Fern..."
+fern generate --local --force
+
+echo "SDK generation complete!"
+
+# Apply post-generation fixes for known Fern generator bugs
+if [ -f "scripts/fix-generated-code.sh" ]; then
+    ./scripts/fix-generated-code.sh
+fi
+
+# Optional: Run type checking
+if [ -f "tsconfig.json" ]; then
+    echo "Running TypeScript type check..."
+    if command -v npx &> /dev/null; then
+        npx tsc --noEmit
+    else
+        echo "npx not available, skipping type check"
+    fi
+fi
+
+# Optional: Run tests
+if [ -d "tests" ] || [ -d "__tests__" ]; then
+    echo "Running tests..."
+    if command -v npm &> /dev/null; then
+        npm test
+    else
+        echo "npm not available, skipping tests"
+    fi
+fi
+
+echo "Regeneration complete!"

package/scripts/fix-generated-code.sh

@@ -0,0 +1,25 @@
+#!/bin/bash
+# Post-generation fix script for Fern TypeScript SDK
+# Fixes known bugs in the generated code
+#
+# This script is automatically run by regenerate.sh after fern generate
+
+set -e
+
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+PROJECT_ROOT="$(dirname "$SCRIPT_DIR")"
+SRC_DIR="$PROJECT_ROOT/src"
+
+echo "Applying post-generation fixes..."
+
+# Fix 1: Remove spurious "*/" before JSDoc comments (Fern generator bug)
+# This bug appears when a method without @example is followed by a method with @example
+if [[ "$OSTYPE" == "darwin"* ]]; then
+    # macOS requires different sed syntax
+    find "$SRC_DIR" -name "*.ts" -exec sed -i '' 's/^\([[:space:]]*\)\*\/\/\*\*/\1\/\*\*/g' {} +
+else
+    # Linux
+    find "$SRC_DIR" -name "*.ts" -exec sed -i 's/^\([[:space:]]*\)\*\/\/\*\*/\1\/\*\*/g' {} +
+fi
+
+echo "Post-generation fixes applied successfully."

package/src/BaseClient.ts

@@ -0,0 +1,82 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import { BearerAuthProvider } from "./auth/BearerAuthProvider.js";
+import { mergeHeaders } from "./core/headers.js";
+import * as core from "./core/index.js";
+import type * as environments from "./environments.js";
+
+export type BaseClientOptions = {
+    environment?: core.Supplier<environments.SpeechallEnvironment | string>;
+    /** Specify a custom URL to connect the client to. */
+    baseUrl?: core.Supplier<string>;
+    /** Additional headers to include in requests. */
+    headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+    /** The default maximum time to wait for a response in seconds. */
+    timeoutInSeconds?: number;
+    /** The default number of times to retry the request. Defaults to 2. */
+    maxRetries?: number;
+    /** Provide a custom fetch implementation. Useful for platforms that don't have a built-in fetch or need a custom implementation. */
+    fetch?: typeof fetch;
+    /** Configure logging for the client. */
+    logging?: core.logging.LogConfig | core.logging.Logger;
+} & BearerAuthProvider.AuthOptions;
+
+export interface BaseRequestOptions {
+    /** The maximum time to wait for a response in seconds. */
+    timeoutInSeconds?: number;
+    /** The number of times to retry the request. Defaults to 2. */
+    maxRetries?: number;
+    /** A hook to abort the request. */
+    abortSignal?: AbortSignal;
+    /** Additional query string parameters to include in the request. */
+    queryParams?: Record<string, unknown>;
+    /** Additional headers to include in the request. */
+    headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
+}
+
+export type NormalizedClientOptions<T extends BaseClientOptions = BaseClientOptions> = T & {
+    logging: core.logging.Logger;
+    authProvider?: core.AuthProvider;
+};
+
+export type NormalizedClientOptionsWithAuth<T extends BaseClientOptions = BaseClientOptions> =
+    NormalizedClientOptions<T> & {
+        authProvider: core.AuthProvider;
+    };
+
+export function normalizeClientOptions<T extends BaseClientOptions = BaseClientOptions>(
+    options: T,
+): NormalizedClientOptions<T> {
+    const headers = mergeHeaders(
+        {
+            "X-Fern-Language": "JavaScript",
+            "X-Fern-Runtime": core.RUNTIME.type,
+            "X-Fern-Runtime-Version": core.RUNTIME.version,
+        },
+        options?.headers,
+    );
+
+    return {
+        ...options,
+        logging: core.logging.createLogger(options?.logging),
+        headers,
+    } as NormalizedClientOptions<T>;
+}
+
+export function normalizeClientOptionsWithAuth<T extends BaseClientOptions = BaseClientOptions>(
+    options: T,
+): NormalizedClientOptionsWithAuth<T> {
+    const normalized = normalizeClientOptions(options) as NormalizedClientOptionsWithAuth<T>;
+    const normalizedWithNoOpAuthProvider = withNoOpAuthProvider(normalized);
+    normalized.authProvider ??= new BearerAuthProvider(normalizedWithNoOpAuthProvider);
+    return normalized;
+}
+
+function withNoOpAuthProvider<T extends BaseClientOptions = BaseClientOptions>(
+    options: NormalizedClientOptions<T>,
+): NormalizedClientOptionsWithAuth<T> {
+    return {
+        ...options,
+        authProvider: new core.NoOpAuthProvider(),
+    };
+}

package/src/Client.ts

@@ -0,0 +1,30 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import { ReplacementRulesClient } from "./api/resources/replacementRules/client/Client.js";
+import { SpeechToTextClient } from "./api/resources/speechToText/client/Client.js";
+import type { BaseClientOptions, BaseRequestOptions } from "./BaseClient.js";
+import { type NormalizedClientOptionsWithAuth, normalizeClientOptionsWithAuth } from "./BaseClient.js";
+
+export declare namespace SpeechallClient {
+    export type Options = BaseClientOptions;
+
+    export interface RequestOptions extends BaseRequestOptions {}
+}
+
+export class SpeechallClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<SpeechallClient.Options>;
+    protected _speechToText: SpeechToTextClient | undefined;
+    protected _replacementRules: ReplacementRulesClient | undefined;
+
+    constructor(options: SpeechallClient.Options) {
+        this._options = normalizeClientOptionsWithAuth(options);
+    }
+
+    public get speechToText(): SpeechToTextClient {
+        return (this._speechToText ??= new SpeechToTextClient(this._options));
+    }
+
+    public get replacementRules(): ReplacementRulesClient {
+        return (this._replacementRules ??= new ReplacementRulesClient(this._options));
+    }
+}

package/src/api/errors/BadRequestError.ts

@@ -0,0 +1,22 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as core from "../../core/index.js";
+import * as errors from "../../errors/index.js";
+import type * as Speechall from "../index.js";
+
+export class BadRequestError extends errors.SpeechallError {
+    constructor(body: Speechall.ErrorResponse, rawResponse?: core.RawResponse) {
+        super({
+            message: "BadRequestError",
+            statusCode: 400,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+
+        this.name = this.constructor.name;
+    }
+}

package/src/api/errors/GatewayTimeoutError.ts

@@ -0,0 +1,22 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as core from "../../core/index.js";
+import * as errors from "../../errors/index.js";
+import type * as Speechall from "../index.js";
+
+export class GatewayTimeoutError extends errors.SpeechallError {
+    constructor(body: Speechall.ErrorResponse, rawResponse?: core.RawResponse) {
+        super({
+            message: "GatewayTimeoutError",
+            statusCode: 504,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+
+        this.name = this.constructor.name;
+    }
+}

package/src/api/errors/InternalServerError.ts

@@ -0,0 +1,22 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as core from "../../core/index.js";
+import * as errors from "../../errors/index.js";
+import type * as Speechall from "../index.js";
+
+export class InternalServerError extends errors.SpeechallError {
+    constructor(body: Speechall.ErrorResponse, rawResponse?: core.RawResponse) {
+        super({
+            message: "InternalServerError",
+            statusCode: 500,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+
+        this.name = this.constructor.name;
+    }
+}

package/src/api/errors/NotFoundError.ts

@@ -0,0 +1,22 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as core from "../../core/index.js";
+import * as errors from "../../errors/index.js";
+import type * as Speechall from "../index.js";
+
+export class NotFoundError extends errors.SpeechallError {
+    constructor(body: Speechall.ErrorResponse, rawResponse?: core.RawResponse) {
+        super({
+            message: "NotFoundError",
+            statusCode: 404,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+
+        this.name = this.constructor.name;
+    }
+}

package/src/api/errors/PaymentRequiredError.ts

@@ -0,0 +1,22 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as core from "../../core/index.js";
+import * as errors from "../../errors/index.js";
+import type * as Speechall from "../index.js";
+
+export class PaymentRequiredError extends errors.SpeechallError {
+    constructor(body: Speechall.ErrorResponse, rawResponse?: core.RawResponse) {
+        super({
+            message: "PaymentRequiredError",
+            statusCode: 402,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+
+        this.name = this.constructor.name;
+    }
+}

package/src/api/errors/ServiceUnavailableError.ts

@@ -0,0 +1,22 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as core from "../../core/index.js";
+import * as errors from "../../errors/index.js";
+import type * as Speechall from "../index.js";
+
+export class ServiceUnavailableError extends errors.SpeechallError {
+    constructor(body: Speechall.ErrorResponse, rawResponse?: core.RawResponse) {
+        super({
+            message: "ServiceUnavailableError",
+            statusCode: 503,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+
+        this.name = this.constructor.name;
+    }
+}

package/src/api/errors/TooManyRequestsError.ts

@@ -0,0 +1,22 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as core from "../../core/index.js";
+import * as errors from "../../errors/index.js";
+import type * as Speechall from "../index.js";
+
+export class TooManyRequestsError extends errors.SpeechallError {
+    constructor(body: Speechall.ErrorResponse, rawResponse?: core.RawResponse) {
+        super({
+            message: "TooManyRequestsError",
+            statusCode: 429,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+
+        this.name = this.constructor.name;
+    }
+}

package/src/api/errors/UnauthorizedError.ts

@@ -0,0 +1,22 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as core from "../../core/index.js";
+import * as errors from "../../errors/index.js";
+import type * as Speechall from "../index.js";
+
+export class UnauthorizedError extends errors.SpeechallError {
+    constructor(body: Speechall.ErrorResponse, rawResponse?: core.RawResponse) {
+        super({
+            message: "UnauthorizedError",
+            statusCode: 401,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+
+        this.name = this.constructor.name;
+    }
+}

package/src/api/errors/index.ts

@@ -0,0 +1,8 @@
+export * from "./BadRequestError.js";
+export * from "./GatewayTimeoutError.js";
+export * from "./InternalServerError.js";
+export * from "./NotFoundError.js";
+export * from "./PaymentRequiredError.js";
+export * from "./ServiceUnavailableError.js";
+export * from "./TooManyRequestsError.js";
+export * from "./UnauthorizedError.js";

package/src/api/index.ts

@@ -0,0 +1,3 @@
+export * from "./errors/index.js";
+export * from "./resources/index.js";
+export * from "./types/index.js";

package/src/api/resources/index.ts

@@ -0,0 +1,5 @@
+export * from "./replacementRules/client/requests/index.js";
+export * as replacementRules from "./replacementRules/index.js";
+export * from "./replacementRules/types/index.js";
+export * from "./speechToText/client/requests/index.js";
+export * as speechToText from "./speechToText/index.js";