Merge branch 'main' into audio-sdk-impl

Author: oliverlaz

AGENTS.md

@@ -0,0 +1,197 @@
+# Guidance for AI coding agents
+
+File purpose: operational rules for automated or assisted code changes. Human-facing conceptual docs belong in `README.md` or the docs site.
+
+## Repository purpose
+
+Stream Video SDKs for:
+
+- React
+- React Native
+- Plain JavaScript (core client)
+
+Goals: API stability, backward compatibility, predictable releases, strong test coverage, accessibility, and performance discipline.
+
+## Tech & toolchain
+
+- Languages: TypeScript, React (web + native)
+- Runtime: Node (use `nvm use` with `.nvmrc`)
+- Package manager: Yarn (workspaces)
+- Testing: Vitest (unit/integration), Playwright (E2E)
+- Lint/Format: ESLint + Prettier
+- Build: Package-local build scripts (composed via root)
+- Release: Conventional Commits -> automated versioning/publishing
+- Platforms:
+  - React: Web
+  - React Native: iOS and Android
+
+## Environment setup
+
+1. `nvm use`
+2. `yarn install`
+3. (Optional) Verify: `node -v` matches `.nvmrc`
+4. Run initial full build: `yarn build:all`
+5. Run tests: `yarn test:ci:all`
+
+## Project layout (high-level)
+
+- `packages/`
+  - `react-sdk/`
+  - `react-native-sdk/`
+  - `client/` (core, no UI)
+- `sample-apps/`
+  - `react/`
+  - `react-native/`
+  - `client/`
+- Config roots: linting, tsconfig, playwright, babel
+- Do not edit generated output (`dist/`, build artifacts)
+
+## Core commands (Runbook)
+
+| Action                              | Command                                    |
+| ----------------------------------- | ------------------------------------------ |
+| Install deps                        | `yarn install`                             |
+| Full build                          | `yarn build:all`                           |
+| Watch (if available)                | `yarn dev` or `yarn start` (add if absent) |
+| Lint                                | `yarn lint:all`                            |
+| Fix lint (if separate)              | `yarn lint:all --fix`                      |
+| Unit/Integration tests (CI profile) | `yarn test:ci:all`                         |
+| Local fast tests                    | `yarn test`                                |
+| E2E (Playwright)                    | `yarn test:e2e`                            |
+| Coverage                            | `yarn test:coverage`                       |
+| Clean                               | `yarn clean:all`                           |
+
+## API design principles
+
+- Semantic versioning
+- Use `@deprecated` JSDoc with replacement guidance
+- Provide migration docs for breaking changes
+- Avoid breaking changes; prefer additive evolution
+- Public surfaces: explicit TypeScript types/interfaces
+- Consistent naming: `camelCase` for functions/properties, `PascalCase` for components/types
+
+### Deprecation lifecycle
+
+1. Mark with `@deprecated` + rationale + alternative.
+2. Maintain for at least one minor release unless security-critical.
+3. Add to migration documentation.
+4. Remove only in next major.
+
+## Performance guidelines
+
+- Minimize re-renders (memoization, stable refs)
+- Use `React.memo` / `useCallback` / `useMemo` when profiling justifies
+- Clean up side effects (`AbortController` for network calls)
+- Monitor bundle size; justify increases > 2% per package
+- Prefer lazy loading for optional heavy modules
+- Avoid unnecessary large dependency additions
+
+## Accessibility (a11y)
+
+- All interactive elements keyboard accessible
+- Provide ARIA roles/labels where semantic tags insufficient
+- Maintain color contrast (WCAG AA)
+- Do not convey state by color alone
+- Announce dynamic content changes (ARIA live regions if needed)
+
+## Error & logging policy
+
+- Public API: throw descriptive errors or return typed error results (consistent with existing patterns)
+- No console noise in production builds
+- Internal debug logging gated behind env flag (if present)
+- Never leak credentials/user data in errors
+
+## Concurrency & async
+
+- Cancel stale async operations (media, network) when components unmount
+- Use `AbortController` for fetch-like APIs
+- Avoid race conditions: check instance IDs / timestamps before state updates
+
+## Testing strategy
+
+- Unit: pure functions, small components
+- Integration: component-tree interactions, state flows
+- React Native: target minimal smoke + platform logic (avoid flakiness)
+- E2E: critical user journeys (Playwright)
+- Mocks/fakes: prefer shared test helpers
+- Coverage target: maintain or improve existing percentage (fail PR if global coverage drops)
+- File naming: `*.test.ts` / `*.spec.ts(x)`
+- Add tests for: new public API, bug fixes (regression test), performance-sensitive utilities
+
+## CI expectations
+
+- Mandatory: build, lint, type check, unit/integration tests, (optionally) E2E smoke
+- Node versions: those listed in matrix (see workflow YAML)
+- Failing or flaky tests: fix or quarantine with justification PR comment (temporary)
+- Zero new warnings
+
+## Release workflow (high-level)
+
+1. Conventional Commit messages on PR merge
+2. Release automation aggregates commits
+3. Version bump + changelog + tag
+4. Publish to registry
+5. Deprecations noted in CHANGELOG
+6. Ensure docs updated prior to publishing breaking changes
+
+## Dependency policy
+
+- Avoid adding large deps without justification (size, maintenance)
+- Prefer existing utility packages
+- Run `yarn audit` (or equivalent) if adding security-impacting deps
+- Keep upgrades separate from feature changes when possible
+
+## Samples & docs
+
+- New public feature: update at least one sample app
+- Breaking changes: provide migration snippet
+- Keep code snippets compilable
+- Use placeholder keys (`YOUR_STREAM_KEY`)
+
+## React Native specifics
+
+- Clear Metro cache if module resolution issues: `yarn react-native start --reset-cache`
+- Test on iOS + Android for native module or platform-specific UI changes
+- Avoid unguarded web-only APIs in shared code
+
+## Linting & formatting
+
+- Run `yarn lint:all` before commit
+- Narrowly scope `eslint-disable` with inline comments and rationale
+- No broad rule disabling
+
+## Commit / PR conventions
+
+- Small, focused PRs
+- Include tests for changes
+- Screenshot or video for UI changes (before/after)
+- Label breaking changes clearly in description
+- Document public API changes
+
+## Security
+
+- No credentials or real user data
+- Use placeholders in examples
+- Scripts must error on missing critical env vars
+- Avoid introducing unmaintained dependencies
+
+## Prohibited edits
+
+- Do not edit build artifacts (`dist/`, generated types)
+- Do not bypass lint/type errors with force merges
+
+## Quick agent checklist (per commit)
+
+- Build succeeds
+- Lint clean
+- Type check clean
+- Tests (unit/integration) green
+- Coverage not reduced
+- Public API docs updated if changed
+- Samples updated if feature surfaced
+- No new warnings
+- No generated files modified
+
+---
+
+Refine this file iteratively for agent clarity; keep human-facing explanations in docs site / `README.md`.

package.json

@@ -70,7 +70,7 @@
     "eslint": "^9.26.0",
     "eslint-plugin-import": "^2.31.0",
     "eslint-plugin-react": "^7.37.5",
-    "eslint-plugin-react-hooks": "^5.2.0",
+    "eslint-plugin-react-hooks": "^6.1.0",
     "globals": "^16.1.0",
     "husky": "^9.1.7",
     "lint-staged": "^15.5.2",

packages/audio-filters-web/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [0.5.0](https://github.com/GetStream/stream-video-js/compare/@stream-io/audio-filters-web-0.4.3...@stream-io/audio-filters-web-0.5.0) (2025-09-30)
+
+### Features
+
+- Audio profiles and Hi-Fi stereo audio ([#1887](https://github.com/GetStream/stream-video-js/issues/1887)) ([3b60c89](https://github.com/GetStream/stream-video-js/commit/3b60c89b8c0dbc40544fe13be79c10e93bbddd3d))
+
 ## [0.4.3](https://github.com/GetStream/stream-video-js/compare/@stream-io/audio-filters-web-0.4.2...@stream-io/audio-filters-web-0.4.3) (2025-07-25)
 
 ### Bug Fixes

packages/audio-filters-web/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stream-io/audio-filters-web",
-  "version": "0.4.3",
+  "version": "0.5.0",
   "main": "./dist/index.cjs.js",
   "module": "./dist/index.es.js",
   "types": "./dist/index.d.ts",

packages/audio-filters-web/src/NoiseCancellation.ts

@@ -269,8 +269,13 @@ export class NoiseCancellation implements INoiseCancellation {
     if (!this.filterNode || !this.audioContext) {
       throw new Error('NoiseCancellation is not initialized');
     }
+
+    const [audioTrack] = mediaStream.getAudioTracks();
+    if (!audioTrack) throw new Error('No audio track found in the stream');
+
     const source = this.audioContext.createMediaStreamSource(mediaStream);
     const destination = this.audioContext.createMediaStreamDestination();
+    destination.channelCount = audioTrack.getSettings().channelCount ?? 1;
 
     source.connect(this.filterNode).connect(destination);
     // When filter is started, user's microphone media stream is active.

packages/client/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [1.33.1](https://github.com/GetStream/stream-video-js/compare/@stream-io/video-client-1.33.0...@stream-io/video-client-1.33.1) (2025-10-02)
+
+### Bug Fixes
+
+- ensure ingress participants are prioritized ([#1943](https://github.com/GetStream/stream-video-js/issues/1943)) ([a51a119](https://github.com/GetStream/stream-video-js/commit/a51a119cfb9f13736395b4afb3d3947ef994a6d9))
+
+## [1.33.0](https://github.com/GetStream/stream-video-js/compare/@stream-io/video-client-1.32.0...@stream-io/video-client-1.33.0) (2025-09-30)
+
+### Features
+
+- Audio profiles and Hi-Fi stereo audio ([#1887](https://github.com/GetStream/stream-video-js/issues/1887)) ([3b60c89](https://github.com/GetStream/stream-video-js/commit/3b60c89b8c0dbc40544fe13be79c10e93bbddd3d))
+
+### Bug Fixes
+
+- **client:** server side pinning ([#1936](https://github.com/GetStream/stream-video-js/issues/1936)) ([cd33b9e](https://github.com/GetStream/stream-video-js/commit/cd33b9e4417e8fdc452b6d4a192e10183ddfa31b))
+
 ## [1.32.0](https://github.com/GetStream/stream-video-js/compare/@stream-io/video-client-1.31.0...@stream-io/video-client-1.32.0) (2025-09-29)
 
 ### Features

packages/client/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stream-io/video-client",
-  "version": "1.32.0",
+  "version": "1.33.1",
   "main": "dist/index.cjs.js",
   "module": "dist/index.es.js",
   "browser": "dist/index.browser.es.js",
@@ -42,6 +42,7 @@
     "@rollup/plugin-typescript": "^12.1.2",
     "@stream-io/audio-filters-web": "workspace:^",
     "@stream-io/node-sdk": "^0.4.24",
+    "@total-typescript/shoehorn": "^0.1.2",
     "@types/sdp-transform": "^2.4.9",
     "@types/ua-parser-js": "^0.7.39",
     "@vitest/coverage-v8": "^3.1.3",

packages/client/src/Call.ts

@@ -8,6 +8,7 @@ import {
   Publisher,
   Subscriber,
   toRtcConfiguration,
+  TrackPublishOptions,
   trackTypeToParticipantStreamKey,
 } from './rtc';
 import {
@@ -1287,6 +1288,7 @@ export class Call {
     }
 
     this.tracer.setEnabled(enableTracing);
+    this.sfuStatsReporter?.flush();
     this.sfuStatsReporter?.stop();
     if (statsOptions?.reporting_interval_ms > 0) {
       this.sfuStatsReporter = new SfuStatsReporter(sfuClient, {
@@ -1770,9 +1772,14 @@ export class Call {
    *
    * @param mediaStream the media stream to publish.
    * @param trackType the type of the track to announce.
+   * @param options the publish options.
    */
-  publish = async (mediaStream: MediaStream, trackType: TrackType) => {
-    if (!this.sfuClient) throw new Error(`Call not joined yet.`);
+  publish = async (
+    mediaStream: MediaStream,
+    trackType: TrackType,
+    options?: TrackPublishOptions,
+  ) => {
+    if (!this.sfuClient) throw new Error(`Call is not joined yet`);
     // joining is in progress, and we should wait until the client is ready
     await this.sfuClient.joinTask;
 
@@ -1797,15 +1804,16 @@ export class Call {
     }
 
     pushToIfMissing(this.trackPublishOrder, trackType);
-    await this.publisher.publish(track, trackType);
+    await this.publisher.publish(track, trackType, options);
 
     const trackTypes = [trackType];
     if (trackType === TrackType.SCREEN_SHARE) {
       const [audioTrack] = mediaStream.getAudioTracks();
       if (audioTrack) {
-        pushToIfMissing(this.trackPublishOrder, TrackType.SCREEN_SHARE_AUDIO);
-        await this.publisher.publish(audioTrack, TrackType.SCREEN_SHARE_AUDIO);
-        trackTypes.push(TrackType.SCREEN_SHARE_AUDIO);
+        const screenShareAudio = TrackType.SCREEN_SHARE_AUDIO;
+        pushToIfMissing(this.trackPublishOrder, screenShareAudio);
+        await this.publisher.publish(audioTrack, screenShareAudio, options);
+        trackTypes.push(screenShareAudio);
       }
     }
 

packages/client/src/__tests__/Call.publishing.test.ts

@@ -35,7 +35,7 @@ describe('Publishing and Unpublishing tracks', () => {
   describe('Validations', () => {
     it('publishing is not allowed only when call is not joined', async () => {
       const ms = new MediaStream();
-      const err = 'Call not joined yet.';
+      const err = 'Call is not joined yet';
       await expect(call.publish(ms, TrackType.VIDEO)).rejects.toThrowError(err);
       await expect(call.publish(ms, TrackType.AUDIO)).rejects.toThrowError(err);
       await expect(
@@ -140,7 +140,11 @@ describe('Publishing and Unpublishing tracks', () => {
       vi.spyOn(mediaStream, 'getVideoTracks').mockReturnValue([track]);
 
       await call.publish(mediaStream, TrackType.VIDEO);
-      expect(publisher.publish).toHaveBeenCalledWith(track, TrackType.VIDEO);
+      expect(publisher.publish).toHaveBeenCalledWith(
+        track,
+        TrackType.VIDEO,
+        undefined,
+      );
       expect(call['trackPublishOrder']).toEqual([TrackType.VIDEO]);
 
       expect(sfuClient.updateMuteStates).toHaveBeenCalledWith([
@@ -159,7 +163,11 @@ describe('Publishing and Unpublishing tracks', () => {
       vi.spyOn(mediaStream, 'getAudioTracks').mockReturnValue([track]);
 
       await call.publish(mediaStream, TrackType.AUDIO);
-      expect(publisher.publish).toHaveBeenCalledWith(track, TrackType.AUDIO);
+      expect(publisher.publish).toHaveBeenCalledWith(
+        track,
+        TrackType.AUDIO,
+        undefined,
+      );
       expect(call['trackPublishOrder']).toEqual([TrackType.AUDIO]);
 
       expect(sfuClient.updateMuteStates).toHaveBeenCalledWith([
@@ -181,6 +189,7 @@ describe('Publishing and Unpublishing tracks', () => {
       expect(publisher.publish).toHaveBeenCalledWith(
         track,
         TrackType.SCREEN_SHARE,
+        undefined,
       );
       expect(call['trackPublishOrder']).toEqual([TrackType.SCREEN_SHARE]);
 
@@ -205,10 +214,12 @@ describe('Publishing and Unpublishing tracks', () => {
       expect(publisher.publish).toHaveBeenCalledWith(
         videoTrack,
         TrackType.SCREEN_SHARE,
+        undefined,
       );
       expect(publisher.publish).toHaveBeenCalledWith(
         audioTrack,
         TrackType.SCREEN_SHARE_AUDIO,
+        undefined,
       );
       expect(call['trackPublishOrder']).toEqual([
         TrackType.SCREEN_SHARE,

packages/client/src/__tests__/StreamVideoClient.api.test.ts

@@ -25,7 +25,7 @@ const tokenProvider = (userId: string) => {
   };
 };
 
-describe.skip('StreamVideoClient - coordinator API', () => {
+describe('StreamVideoClient - coordinator API', () => {
   let client: StreamVideoClient;
   const user = {
     id: 'sara',