JavaScript/TypeScript client SDK for Zocks.io

@zocks-communications/client-sdk-js is the official client SDK for Zocks.io. The SDK provides session management, API access and event processing for room, participant and track control.

Release

Production Release

To release a new version to both GitHub Packages Registry (GPR) and npm.js:

1. Create a release and publish to GPR - Trigger the publish-release-gpr.yaml workflow:

   • Select a version bump level: patch, minor, or major
   • This workflow will:
     • Bump the version in package.json
     • Create a git commit with the new version
     • Create a GitHub release with the version tag
     • Build and publish the package to GitHub Packages Registry

2. Publish to npm.js - After the GPR release is complete, manually trigger the publish-npmjs.yaml workflow:

   • This workflow will build and publish the package to npm.js
   • Note: The published version must already exist in your git history for npm authentication to work

Pre-release / Snapshot Release

Pre-release versions are automatically published to GitHub Packages Registry when pushing to any branch except main:

• The publish-prerelease.yaml workflow automatically triggers on push
• Creates a snapshot version with the branch name appended (e.g., 1.0.0-feature-branch-snapshot.1)
• Publishes to GPR for testing before a production release

Docs

Docs are available at https://docs.zocks.io

Javascript SDK Reference