Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .agents/skills/deepgram-js-maintaining-sdk/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ Current permanently frozen entries from `.fernignore` / `AGENTS.md`:

- `src/CustomClient.ts` — custom wrapper for auth prefixing, session ID propagation, browser/Node WebSocket handling, reconnect behavior, binary message fixes, and `createConnection()` aliases
- `src/index.ts` — curated re-exports with backwards-compatible namespace behavior
- `src/transport.ts` — hand-maintained pluggable transport interface for SageMaker and other custom streaming transports
- `scripts/fix-wire-test-imports.js`, `scripts/revert-wire-test-imports.js` — post-generation import fixups
- `scripts/proxy-server.js` — development proxy
- `scripts/validate-esm-build.mjs` — ESM build validation
Expand Down Expand Up @@ -105,7 +106,7 @@ Relevant underlying commands today:
## JS-specific maintainer notes

1. **Do not edit most generated files under `src/api/` directly.** Prefer Fern input changes or post-regen patch review.
2. **`src/CustomClient.ts` is the highest-risk permanent wrapper.** It carries auth prefixing, browser subprotocol auth, custom websocket startup, binary handling, and the user-facing `createConnection()` aliases used by examples.
2. **`src/CustomClient.ts` is the highest-risk permanent wrapper.** It carries auth prefixing, browser subprotocol auth, custom websocket startup, binary handling, the pluggable transport adapter used for SageMaker/custom transports, and the user-facing `createConnection()` aliases used by examples.
3. **The repo ships both CJS and ESM.** Validate both outputs after generator changes.
4. **Browser behavior matters.** The wrapper intentionally diverges for browser WebSocket auth because browsers cannot send arbitrary socket headers.
5. **`.agents/` is permanently frozen in `.fernignore`.** Treat these skills as hand-written documentation during regeneration; Fern will not touch the folder. Keep this note aligned with `AGENTS.md` whenever the frozen-file list changes.
Expand Down
2 changes: 2 additions & 0 deletions .fernignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ examples
# Custom wrapper
src/CustomClient.ts
src/index.ts
src/transport.ts

# Custom Scripts
scripts/fix-wire-test-imports.js
Expand All @@ -23,6 +24,7 @@ tests/unit/custom-client.test.ts
tests/unit/error-handling.test.ts
tests/unit/multiple-keyterms.test.ts
tests/unit/nodejs-version-compatibility.test.ts
tests/unit/transport-factory.test.ts
tests/unit/websocket-reconnection.test.ts
tests/unit/websocket-wrappers.test.ts
tests/wire/websocket
Expand Down
1 change: 1 addition & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ How to identify:
Current permanently frozen files:
- `src/CustomClient.ts` — entirely custom wrapper with WebSocket management, auth providers, and session ID handling; no Fern equivalent
- `src/index.ts` — curated re-export file with custom namespace handling
- `src/transport.ts` — hand-maintained pluggable transport interface for SageMaker and other custom streaming transports
- `scripts/fix-wire-test-imports.js`, `scripts/revert-wire-test-imports.js` — post-generation import fixup scripts
- `scripts/proxy-server.js` — development proxy server
- `scripts/validate-esm-build.mjs` — ESM build validation
Expand Down
Loading
Loading