flowstate-obs-browser Package Skill

Package: @epicdm/flowstate-obs-browser Repository: epic-flowstate-community Path: packages/obs-browser Version: 1.0.7

Use this published Dojo skill as the package-level entrypoint. For detailed workflows, use the package-local skills listed below.

Primary Package Workflow

FlowState Obs Browser Consumer Integration

Status: Active Purpose: Keep obs-browser changes compatible with server and downstream package consumers. Scope: Cross-package compatibility for packages/obs-browser. Trigger: A public export, auth behavior, path, payload, stream filter, React hook API, or RPC type may change. Input: Proposed change and affected public surface. Output: Compatibility-aware implementation with downstream checks.

Consumers To Check

Public Contracts

Check compatibility before changing:

• Export names in src/index.ts.
• ObservabilityClient config and event payloads.
• WebSocket message envelope { type, data }.
• WebSocket session id query parameter.
• WebSocket auth behavior.
• REST /api/logs query parameters.
• SSE /api/stream/events filters and event names.
• useObsStream returned state and control functions.
• RpcClient, RpcHandler, request and response types.

Compatibility Workflow

1. Name the contract change.
2. Search usages:

rg "@epicdm/flowstate-obs-browser|RpcClient|RpcHandler|useObsStream|ObsStreamClient|ObservabilityClient" packages examples docker

3. Update package tests.
4. Update downstream tests or type-only consumers if necessary.
5. Update feature inventory/docs/Dojo only after source behavior is verified.

Verification

Minimum:

yarn workspace @epicdm/flowstate-obs-browser test --runInBand --no-cache
yarn workspace @epicdm/flowstate-obs-browser typecheck
yarn workspace @epicdm/flowstate-obs-browser build

For app-framework RPC type changes:

yarn workspace @epicdm/flowstate-app-framework typecheck

For server contract changes:

yarn workspace @epicdm/flowstate-obs-server test --runInBand --no-cache

Composition Notes

• Use focused obs-browser skills first, then this checklist before finalizing.
• Pair with obs-server skills for auth, route, SSE, WebSocket, and RPC changes.

Created: 2026-06-29

Package Skill Inventory

@epicdm/flowstate-obs-browser Skill Inventory

Repository: epic-flowstate-community Package path: packages/obs-browser Package: @epicdm/flowstate-obs-browser Inventory date: 2026-06-29

Skill Map

Composition

• Start with flowstate-obs-browser for package orientation.
• Use capture/instrumentation skill for application telemetry.
• Use transport skill for WebSocket send-path issues.
• Use streaming skill for REST/SSE read-path issues.
• Use React hook skill for UI log viewers.
• Use RPC skill for app-framework bridge/server-command use cases.
• Use consumer-integration skill before changing public exports, envelopes, auth behavior, or server paths.

Not Created

• No separate skill for every public type; the types only matter in workflows.
• No separate ConnectionState skill; connection state is part of the WebSocket transport workflow.
• No Dojo publishing skill; publication should use the repo-level Dojo lifecycle skills after local review.

Review Gate

@epicdm/flowstate-obs-browser Skills Review

Review date: 2026-06-29 Verdict: Pass for local package-skill coverage; Dojo publication deferred until generated Dojo files are rebuilt from reviewed skills.

Coverage Check

• Package orientation and source map are covered in flowstate-obs-browser.
• Error/log capture, breadcrumbs, users, context, tags, and init/shutdown are covered in flowstate-obs-browser-observability-client.
• WebSocket connection, buffering, reconnect, heartbeat, session id, and reserved message handling are covered in flowstate-obs-browser-websocket-transport.
• REST log fetch and SSE stream reading are covered in flowstate-obs-browser-streaming.
• React hook behavior is covered in flowstate-obs-browser-react-hook.
• Browser RPC handler registration and response behavior are covered in flowstate-obs-browser-rpc-client.
• Downstream compatibility is covered in flowstate-obs-browser-consumer-integration.
• Docs, feature matrix, generated Dojo drift, and verification are covered in flowstate-obs-browser-maintenance.

Quality Notes

• Skills explicitly separate WebSocket telemetry send-path from SSE/REST read-path.
• Skills warn that isomorphic-ws header auth is not the same as native browser WebSocket header support.
• Skills identify current README legacy scope drift.
• Skills are hand-authored from source review rather than copied from the generated feature catalog.

Deferred Work

• Rebuild .flowstate/dojo artifacts from these reviewed package-local skills.
• Update README package scope and examples.
• Validate whether browser-native WebSocket auth needs a protocol/query-token fallback for real browser environments.
• Consider documenting setUser userData as reserved until it is included in event payloads.
• Refresh .flowstate/docs/index.md to include ObsStreamClient, fetchLogs, useObsStream, and RPC exports.
• Watch Rollup's exit-after-build plugin during orchestrated builds.

Verification

Skill-file checks run:

find packages/obs-browser/.flowstate/skills -name 'SKILL.md' -print
rg '^---$|^name:|^description: Use when' packages/obs-browser/.flowstate/skills
LC_ALL=C rg -n '[^\x00-\x7F]' packages/obs-browser/.flowstate/skills

Results:

• Eight SKILL.md files found.
• Frontmatter pattern present for all skills.
• ASCII scan passed.

Package verification run:

yarn workspace @epicdm/flowstate-obs-browser test --runInBand --no-cache
yarn workspace @epicdm/flowstate-obs-browser typecheck
yarn workspace @epicdm/flowstate-obs-browser build
yarn workspace @epicdm/flowstate-obs-browser lint
yarn nx build @epicdm/flowstate-obs-browser

Results:

• test --runInBand --no-cache passed: 7 suites, 113 tests, with ts-jest deprecation warnings.
• typecheck passed.
• build passed and emitted dist/index.js and dist/index.esm.js.
• lint passed with 83 existing warnings.
• nx build passed with local cache output and Nx Cloud setup notice.

Start with this skill to understand the package purpose, then use the package-local focused skills for specific workflows. Keep this Dojo version aligned with packages/obs-browser/package.json. Do not treat generated feature lists as lessons; use workflow evidence from CODE-REVIEW.md, SKILL-INVENTORY.md, and REVIEW.md.