streamshare

StreamShare developer ecosystem

This repository is the controlled public distribution of the StreamShare developer ecosystem. It contains the contracts, tools, examples and documentation intended for addon, service and client developers.

Packages

Package	Purpose
@streamshare/plugin-sdk	TypeScript contracts and validators for StreamShare addons
@streamshare/plugin-cli	Development, validation and packaging tools for addons
@streamshare/service	Typed protocol and runtime validators for StreamShare services
@streamshare/remote-protocol	Versioned contract for compatible remote playback clients

Examples

• @streamshare/example-hello-addon: minimal addon lifecycle example;
• @streamshare/example-source-addon: catalog, discovery, search and playback source example;
• streamshare-example-service: reference service with catalog, playback and authentication flows.

Examples are marked private so they cannot be published accidentally.

Documentation

The documentation workspace builds the human-readable site, generated API reference and AI-oriented Markdown outputs from the same maintained sources.

• Applications
• Addon development
• Service development

Development

Requirements:

• Node.js 22.15 or newer;
• pnpm 11.9.0 through Corepack.

corepack enable
pnpm install
pnpm test
pnpm run docs:build

Run the complete public validation suite with:

pnpm run ci

Releases

Publishable packages use independent semantic versions managed with Changesets. Add a changeset whenever a public package change affects consumers:

pnpm changeset

This repository does not publish packages automatically. Releases are promoted only from main through a controlled two-step process:

1. Changesets creates or updates a draft version pull request containing the package versions and changelogs. A maintainer reviews and merges it.
2. A maintainer starts the manual publication workflow and explicitly approves the protected npm-production environment.

The publication workflow runs the complete release check, uses npm trusted publishing without a long-lived publication token, and pushes the annotated Git tags created for the published package versions.

Public scope

Only the material present in this repository is part of the public developer surface. Application internals, unpublished integrations and private test packages are not public contracts.

See PUBLIC_SCOPE.md and CONTRIBUTING.md before proposing a change.