@speechall/sdk 1.0.0 → 2.1.0

package/tests/integration/api.test.ts

@@ -0,0 +1,93 @@
+import { SpeechallClient } from '../../src';
+import * as fs from 'fs';
+import * as path from 'path';
+
+// Skip integration tests if no API token is provided
+const runIntegration = process.env.SPEECHALL_API_TOKEN !== undefined;
+const describeIntegration = runIntegration ? describe : describe.skip;
+
+describeIntegration('API Integration Tests', () => {
+  let client: SpeechallClient;
+
+  beforeAll(() => {
+    client = new SpeechallClient({
+      token: process.env.SPEECHALL_API_TOKEN!,
+    });
+  });
+
+  describe('SpeechToText API', () => {
+    it('should transcribe audio file', async () => {
+      // This test requires an actual audio file and API token
+      // Skip if no audio fixture is available
+      const audioPath = path.join(__dirname, '../fixtures/audio-sample.wav');
+
+      if (!fs.existsSync(audioPath)) {
+        console.log('Skipping: No audio fixture available');
+        return;
+      }
+
+      const audioBuffer = fs.readFileSync(audioPath);
+      const audioFile = new File([audioBuffer], 'audio-sample.wav', {
+        type: 'audio/wav',
+      });
+
+      const response = await client.speechToText.transcribe(
+        audioFile,
+        {
+          model: 'openai.whisper-1',
+        }
+      );
+
+      expect(response).toBeDefined();
+      // Add more specific assertions based on your API response structure
+    }, 30000); // 30 second timeout for API calls
+
+    it('should list available speech-to-text models', async () => {
+      const models = await client.speechToText.listSpeechToTextModels();
+
+      expect(models).toBeDefined();
+      expect(Array.isArray(models)).toBe(true);
+    }, 30000);
+  });
+
+  describe('Replacement Rules API', () => {
+    it('should create replacement ruleset', async () => {
+      const ruleset = await client.replacementRules.createReplacementRuleset({
+        name: 'Test Ruleset',
+        rules: [
+          {
+            kind: 'exact',
+            search: 'test',
+            replacement: 'TEST',
+          },
+        ],
+      });
+
+      expect(ruleset).toBeDefined();
+      expect(ruleset.id).toBeDefined();
+    });
+  });
+});
+
+// Mock integration tests that always run
+describe('API Integration Tests (Mocked)', () => {
+  let client: SpeechallClient;
+
+  beforeEach(() => {
+    client = new SpeechallClient({
+      token: 'mock-api-token',
+    });
+  });
+
+  it('should have speechToText client available', () => {
+    expect(client.speechToText).toBeDefined();
+    expect(typeof client.speechToText.transcribe).toBe('function');
+    expect(typeof client.speechToText.transcribeRemote).toBe('function');
+    expect(typeof client.speechToText.listSpeechToTextModels).toBe('function');
+  });
+
+  it('should have replacementRules client available', () => {
+    expect(client.replacementRules).toBeDefined();
+    expect(typeof client.replacementRules.createReplacementRuleset).toBe('function');
+  });
+});

package/tests/unit/client.test.ts

@@ -0,0 +1,91 @@
+import { SpeechallClient, SpeechallError } from '../../src';
+
+describe('SpeechallClient', () => {
+  describe('initialization', () => {
+    it('should initialize with token', () => {
+      const client = new SpeechallClient({
+        token: 'test-api-token',
+      });
+      expect(client).toBeDefined();
+      expect(client).toBeInstanceOf(SpeechallClient);
+    });
+
+    it('should initialize with token as a function', () => {
+      const client = new SpeechallClient({
+        token: () => 'test-api-token',
+      });
+      expect(client).toBeDefined();
+      expect(client).toBeInstanceOf(SpeechallClient);
+    });
+
+    it('should expose speechToText client', () => {
+      const client = new SpeechallClient({
+        token: 'test-api-token',
+      });
+      expect(client.speechToText).toBeDefined();
+    });
+
+    it('should expose replacementRules client', () => {
+      const client = new SpeechallClient({
+        token: 'test-api-token',
+      });
+      expect(client.replacementRules).toBeDefined();
+    });
+  });
+
+  describe('configuration', () => {
+    it('should accept custom baseUrl', () => {
+      const client = new SpeechallClient({
+        token: 'test-api-token',
+        baseUrl: 'https://custom-api.example.com',
+      });
+      expect(client).toBeDefined();
+    });
+
+    it('should accept custom headers', () => {
+      const client = new SpeechallClient({
+        token: 'test-api-token',
+        headers: {
+          'X-Custom-Header': 'custom-value',
+        },
+      });
+      expect(client).toBeDefined();
+    });
+
+    it('should accept timeout configuration', () => {
+      const client = new SpeechallClient({
+        token: 'test-api-token',
+        timeoutInSeconds: 30,
+      });
+      expect(client).toBeDefined();
+    });
+
+    it('should accept maxRetries configuration', () => {
+      const client = new SpeechallClient({
+        token: 'test-api-token',
+        maxRetries: 5,
+      });
+      expect(client).toBeDefined();
+    });
+  });
+
+  describe('lazy initialization', () => {
+    it('should lazily initialize speechToText client', () => {
+      const client = new SpeechallClient({
+        token: 'test-api-token',
+      });
+      const firstAccess = client.speechToText;
+      const secondAccess = client.speechToText;
+      expect(firstAccess).toBe(secondAccess);
+    });
+
+    it('should lazily initialize replacementRules client', () => {
+      const client = new SpeechallClient({
+        token: 'test-api-token',
+      });
+      const firstAccess = client.replacementRules;
+      const secondAccess = client.replacementRules;
+      expect(firstAccess).toBe(secondAccess);
+    });
+  });
+});

package/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "CommonJS",
+    "lib": ["ES2020", "DOM", "DOM.Iterable"],
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true,
+    "moduleResolution": "node"
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist", "tests", "examples"]
+}