compatcompatSign in
Deepgram

Deepgram SDK migration

Move to @deepgram/sdk v3: createClient, new namespaces, renamed live events, model ids.

Try compat freeSee a real pull request

1 repository · 3 migrations a month · no card

What compat detects

  • @deepgram/sdk

Deepgram's v3 SDK replaced the Deepgram class with createClient and reorganised transcription under listen.prerecorded and listen.live. compat migrates the client, every event handler and the response access paths.

What breaks across majors

  1. 01

    The Deepgram class became createClient(); namespaces moved to deepgram.listen.prerecorded, deepgram.listen.live and deepgram.manage.

  2. 02

    Live transcription event names changed: LiveTranscriptionEvents.Transcript, Open, Close, Error.

  3. 03

    Model ids such as nova-2 and nova-3, and deprecated models.

  4. 04

    Response shape: result.results.channels[0].alternatives[0].transcript; smart formatting and diarization moved into the options object.

Typecheck flags the class to createClient migration. Tests that mock the client need updated shapes.

What a @deepgram/sdk v2 to v3 run looks like

Illustrative

compat swaps the constructor for createClient, moves each call under the new namespaces, renames every .on handler, updates response paths and opens the pull request. Illustrative; no public run recorded yet.

  1. 01

    Detect

    compat finds the Deepgram packages your code imports and the upstream releases that affect them.

  2. 02

    Migrate and verify

    It edits only the affected code in a disposable sandbox, regenerates the lockfile, and runs your existing tests, type checks, lint and build where available.

  3. 03

    Pull request

    It opens a PR with the diff, verification results, warnings and manual steps. A person merges.

Questions

Does compat merge the Deepgram migration automatically?
No. compat has no merge capability. It pushes a branch and opens a pull request with the diff, the recorded checks and any manual steps. A person on your team reviews and merges.
Which checks run?
Your repository's own: install, typecheck, lint, test and build where the scripts exist. Each is listed in the pull request as passed, failed or not run. A check that did not run is never shown as passed.
Does compat need my production credentials?
No. Migrations run in a disposable sandbox with your code and package manager, not your environment. Checks that need live credentials are reported as not run.
How does compat know a release affects my repository?
It watches the Deepgram packages your code imports, reads new release notes, and judges relevance against the files that actually use the SDK. Irrelevant releases are dismissed with the reason; relevant ones become a proposal or, if you allow it, a run.

Other providers