@speechall/sdk 0.0.1 → 2.0.4

package/.github/workflows/auto-release-simple.yml.deprecated

@@ -0,0 +1,106 @@
+name: Auto Release (Simple)
+
+on:
+  push:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [16.x, 18.x, 20.x]
+
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v4
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    
+    - name: Install dependencies
+      run: npm ci
+    
+    - name: Run lint
+      run: npm run lint
+    
+    - name: Build package
+      run: npm run build
+    
+    - name: Test package can be imported
+      run: node -e "require('./dist/index.js')"
+
+  check-version:
+    runs-on: ubuntu-latest
+    outputs:
+      version-changed: ${{ steps.version-check.outputs.changed }}
+      new-version: ${{ steps.version-check.outputs.version }}
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 2
+    
+    - name: Check if version changed
+      id: version-check
+      run: |
+        # Get current version
+        CURRENT_VERSION=$(node -p "require('./package.json').version")
+        
+        # Get previous version (from previous commit)
+        git checkout HEAD~1
+        PREVIOUS_VERSION=$(node -p "require('./package.json').version")
+        git checkout -
+        
+        echo "Previous version: $PREVIOUS_VERSION"
+        echo "Current version: $CURRENT_VERSION"
+        
+        if [ "$CURRENT_VERSION" != "$PREVIOUS_VERSION" ]; then
+          echo "changed=true" >> $GITHUB_OUTPUT
+          echo "version=$CURRENT_VERSION" >> $GITHUB_OUTPUT
+        else
+          echo "changed=false" >> $GITHUB_OUTPUT
+        fi
+
+  release-and-publish:
+    needs: [test, check-version]
+    runs-on: ubuntu-latest
+    if: needs.check-version.outputs.version-changed == 'true'
+    
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Use Node.js 18
+      uses: actions/setup-node@v4
+      with:
+        node-version: 18
+        cache: 'npm'
+        registry-url: 'https://registry.npmjs.org'
+    
+    - name: Install dependencies
+      run: npm ci
+    
+    - name: Build package
+      run: npm run build
+    
+    - name: Create Release
+      id: create_release
+      uses: actions/create-release@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        tag_name: v${{ needs.check-version.outputs.new-version }}
+        release_name: Release v${{ needs.check-version.outputs.new-version }}
+        draft: false
+        prerelease: false
+        body: |
+          Changes in this release:
+          - Version bump to ${{ needs.check-version.outputs.new-version }}
+          
+          For detailed changes, see the commit history.
+    
+    - name: Publish to NPM
+      run: npm publish
+      env:
+        NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} 

package/.github/workflows/auto-release.yml

@@ -0,0 +1,67 @@
+name: Auto Release
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'package.json'
+
+jobs:
+  create-release:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Get version from package.json
+        id: version
+        run: |
+          VERSION=$(node -p "require('./package.json').version")
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
+          echo "tag=v$VERSION" >> $GITHUB_OUTPUT
+
+      - name: Check if tag exists
+        id: check_tag
+        run: |
+          if git rev-parse "v${{ steps.version.outputs.version }}" >/dev/null 2>&1; then
+            echo "exists=true" >> $GITHUB_OUTPUT
+          else
+            echo "exists=false" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Extract changelog for version
+        if: steps.check_tag.outputs.exists == 'false'
+        id: changelog
+        run: |
+          VERSION="${{ steps.version.outputs.version }}"
+          # Extract changelog section for this version
+          CHANGELOG=$(awk "/^## \[$VERSION\]/{flag=1; next} /^## \[/{flag=0} flag" CHANGELOG.md | head -50)
+          if [ -z "$CHANGELOG" ]; then
+            CHANGELOG="Release v$VERSION"
+          fi
+          # Write to file for multiline handling
+          echo "$CHANGELOG" > release_notes.txt
+
+      - name: Create GitHub Release
+        if: steps.check_tag.outputs.exists == 'false'
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ steps.version.outputs.tag }}
+          name: ${{ steps.version.outputs.tag }}
+          body_path: release_notes.txt
+          draft: false
+          prerelease: false
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Trigger npm publish workflow
+        if: steps.check_tag.outputs.exists == 'false'
+        uses: peter-evans/repository-dispatch@v3
+        with:
+          event-type: npm-publish
+          client-payload: '{"tag": "${{ steps.version.outputs.tag }}", "version": "${{ steps.version.outputs.version }}"}'

package/.github/workflows/ci.yml

@@ -0,0 +1,41 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [18.x, 20.x]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build SDK
+        run: npm run build
+
+      - name: Verify TypeScript compilation
+        run: npx tsc --noEmit
+
+      - name: Run unit tests
+        run: npm run test:unit
+
+      - name: Run integration tests
+        run: npm run test:integration
+
+      - name: Test package can be imported
+        run: node -e "require('./dist/index.js')"

package/.github/workflows/release.yml

@@ -0,0 +1,57 @@
+name: Release
+
+on:
+  release:
+    types: [published]
+  repository_dispatch:
+    types: [npm-publish]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write # for npm provenance
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+          registry-url: 'https://registry.npmjs.org'
+          cache: 'npm'
+
+      - name: Ensure npm version supports Trusted Publishing
+        run: |
+          npm --version
+          npm install -g npm@latest
+          npm --version
+
+      - name: Verify version matches release tag
+        run: |
+          PACKAGE_VERSION=$(node -p "require('./package.json').version")
+          # Handle both release event and repository_dispatch event
+          if [ "${{ github.event_name }}" = "repository_dispatch" ]; then
+            RELEASE_VERSION="${{ github.event.client_payload.version }}"
+          else
+            RELEASE_VERSION=${GITHUB_REF#refs/tags/v}
+          fi
+          if [ "$PACKAGE_VERSION" != "$RELEASE_VERSION" ]; then
+            echo "Error: package.json version ($PACKAGE_VERSION) does not match release version ($RELEASE_VERSION)"
+            exit 1
+          fi
+          echo "Version verified: $PACKAGE_VERSION"
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build SDK
+        run: npm run build
+
+      - name: Run tests before publishing
+        run: npm test
+
+      - name: Publish to npm
+        run: npm publish --access public

package/AGENTS.md

@@ -0,0 +1,94 @@
+## Issue Tracking with bd (beads)
+
+**IMPORTANT**: This project uses **bd (beads)** for ALL issue tracking. Do NOT use markdown TODOs, task lists, or other tracking methods.
+
+### Quick Start
+
+**Check for ready work:**
+```bash
+bd ready --json
+```
+
+**Create new issues:**
+```bash
+bd create "Issue title" -t bug|feature|task -p 0-4 --json
+bd create "Issue title" -p 1 --deps discovered-from:bd-123 --json
+bd create "Subtask" --parent <epic-id> --json  # Hierarchical subtask (gets ID like epic-id.1)
+```
+
+**Claim and update:**
+```bash
+bd update bd-42 --status in_progress --json
+bd update bd-42 --priority 1 --json
+```
+
+**Complete work:**
+```bash
+bd close bd-42 --reason "Completed" --json
+```
+
+### Issue Types
+
+- `bug` - Something broken
+- `feature` - New functionality
+- `task` - Work item (tests, docs, refactoring)
+- `epic` - Large feature with subtasks
+- `chore` - Maintenance (dependencies, tooling)
+
+### Priorities
+
+- `0` - Critical (security, data loss, broken builds)
+- `1` - High (major features, important bugs)
+- `2` - Medium (default, nice-to-have)
+- `3` - Low (polish, optimization)
+- `4` - Backlog (future ideas)
+
+### Workflow
+
+1. **Check ready work**: `bd ready` shows unblocked issues
+2. **Claim your task**: `bd update <id> --status in_progress`
+3. **Work on it**: Implement, test, document
+4. **Discover new work?** Create linked issue:
+   - `bd create "Found bug" -p 1 --deps discovered-from:<parent-id>`
+5. **Complete**: `bd close <id> --reason "Done"`
+6. **Commit together**: Always commit the `.beads/issues.jsonl` file together with the code changes so issue state stays in sync with code state
+
+### Auto-Sync
+
+bd automatically syncs with git:
+- Exports to `.beads/issues.jsonl` after changes (5s debounce)
+- Imports from JSONL when newer (e.g., after `git pull`)
+- No manual export/import needed!
+
+### Planning Documents
+
+If you want to create planning and design documents during development:
+- PLAN.md, IMPLEMENTATION.md, ARCHITECTURE.md
+- DESIGN.md, CODEBASE_SUMMARY.md, INTEGRATION_PLAN.md
+- TESTING_GUIDE.md, TECHNICAL_DESIGN.md, and similar files
+
+**Best Practice: Use a dedicated directory for these ephemeral files**
+
+**Recommended approach:**
+- Create a `history/` directory in the project root
+- Store ALL planning/design docs in `history/`
+- Keep the repository root clean and focused on permanent project files
+- Only access `history/` when explicitly asked to review past planning
+
+### CLI Help
+
+Run `bd <command> --help` to see all available flags for any command.
+For example: `bd create --help` shows `--parent`, `--deps`, `--assignee`, etc.
+
+### Important Rules
+
+- ✅ Use bd for ALL task tracking
+- ✅ Always use `--json` flag for programmatic use
+- ✅ Link discovered work with `discovered-from` dependencies
+- ✅ Check `bd ready` before asking "what should I work on?"
+- ✅ Store AI planning docs in `history/` directory
+- ✅ Run `bd <cmd> --help` to discover available flags
+- ❌ Do NOT create markdown TODO lists
+- ❌ Do NOT use external issue trackers
+- ❌ Do NOT duplicate tracking systems
+- ❌ Do NOT clutter repo root with planning documents

package/CHANGELOG.md

@@ -0,0 +1,58 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [2.0.4] - 2025-12-18
+
+### Fixed
+
+- Updated to npm 11.5.1+ for Trusted Publishing OIDC support
+
+## [2.0.3] - 2025-12-18
+
+### Fixed
+
+- Fixed npm Trusted Publishing workflow configuration
+
+## [2.0.2] - 2025-12-18
+
+### Fixed
+
+- Switched to npm Trusted Publishing (OIDC) for more secure token-less authentication
+
+## [2.0.1] - 2025-12-17
+
+### Fixed
+
+- Fixed auto-release workflow not triggering npm publish due to GITHUB_TOKEN limitation
+- Added repository_dispatch event to chain workflows correctly
+
+## [2.0.0] - 2025-12-17
+
+### Changed
+
+- **BREAKING**: Migrated SDK code generator from openapi-generator to [Fern](https://buildwithfern.com)
+- Removed OpenAI-compatible endpoints (use the native OpenAI SDK instead)
+- Regenerated SDK with improved TypeScript types and error handling
+
+### Migration Guide
+
+The package name remains `@speechall/sdk`. Update your code to remove any OpenAI-compatible endpoint usage:
+
+```typescript
+// v1.x OpenAI-compatible (REMOVED)
+// client.openaiCompatible.createTranscription(...)
+
+// v2.x - Use native Speechall API
+const result = await client.speechToText.transcribe(audioFile, {
+  model: 'openai.whisper-1',
+  language: 'en',
+});
+```
+
+## [1.0.0] - 2025-06-09
+
+Initial release of the TypeScript SDK generated with openapi-generator.

package/CLAUDE.md

@@ -0,0 +1,75 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+This is the official TypeScript SDK for [speechall.com](https://speechall.com), a speech-to-text API supporting multiple providers (OpenAI Whisper, Deepgram, AssemblyAI, RevAI, Amazon Transcribe, etc.).
+
+**The SDK is auto-generated using [Fern](https://buildwithfern.com) from an OpenAPI specification. Do not manually edit files in `src/`.**
+
+## Common Commands
+
+```bash
+# Build
+npm run build           # Compile TypeScript to dist/
+
+# Test
+npm test                # Run all tests
+npm run test:unit       # Unit tests only
+npm run test:integration  # Integration tests (requires SPEECHALL_API_TOKEN env var)
+npm run test:coverage   # Tests with coverage report
+
+# SDK Regeneration (after OpenAPI spec changes)
+./regenerate.sh         # Recommended: validates, generates, type-checks, and tests
+fern generate --local --force  # Manual generation
+fern check              # Validate OpenAPI spec
+
+# Run examples (requires npm run build first)
+npx tsx examples/basic-transcription.ts  # Use tsx, not ts-node
+```
+
+## Architecture
+
+### Code Generation Flow
+```
+OpenAPI spec → Fern generator → src/ (TypeScript) → npm run build → dist/ (JavaScript)
+```
+
+Configuration: `fern/generators.yml` controls SDK generation options.
+
+### Client Structure
+```typescript
+SpeechallClient
+├── speechToText              // Main transcription API
+│   ├── transcribe()          // Local audio file
+│   ├── transcribeRemote()    // Remote URL
+│   └── listSpeechToTextModels()
+└── replacementRules          // Text replacement rulesets
+    └── create()
+```
+
+### Key Directories
+- `src/` - Generated TypeScript source (do not edit)
+- `dist/` - Compiled JavaScript output
+- `fern/` - Fern configuration (`generators.yml`, `fern.config.json`)
+- `tests/` - Jest tests (unit and integration)
+- `examples/` - Usage examples
+
+### Protected Files (not overwritten by Fern)
+See `.fernignore`: tests/, examples/, tsconfig.json, jest.config.js, README.md
+
+### Regenerated Files
+- `src/` - Fully regenerated by Fern
+- `package.json` - Metadata from `fern/generators.yml` packageJson config
+
+## Error Types
+
+SDK provides typed errors for HTTP status codes:
+- `BadRequestError` (400), `UnauthorizedError` (401), `PaymentRequiredError` (402)
+- `NotFoundError` (404), `TooManyRequestsError` (429)
+- `InternalServerError` (500), `ServiceUnavailableError` (503), `GatewayTimeoutError` (504)
+- `SpeechallTimeoutError` - Request timeout
+- `SpeechallError` - Base error class
+
+@AGENTS.md