{"id":44502962,"url":"https://github.com/pie-framework/pie-players","last_synced_at":"2026-06-09T19:01:44.293Z","repository":{"id":334367009,"uuid":"1134036450","full_name":"pie-framework/pie-players","owner":"pie-framework","description":"item and assessment players and the assessment toolkit","archived":false,"fork":false,"pushed_at":"2026-06-03T19:41:36.000Z","size":81950,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2026-06-03T21:21:20.872Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pie-framework.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2026-01-14T06:46:25.000Z","updated_at":"2026-06-03T19:32:02.000Z","dependencies_parsed_at":"2026-05-05T01:04:41.054Z","dependency_job_id":null,"html_url":"https://github.com/pie-framework/pie-players","commit_stats":null,"previous_names":["pie-framework/pie-players"],"tags_count":1385,"template":false,"template_full_name":null,"purl":"pkg:github/pie-framework/pie-players","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pie-framework%2Fpie-players","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pie-framework%2Fpie-players/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pie-framework%2Fpie-players/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pie-framework%2Fpie-players/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pie-framework","download_url":"https://codeload.github.com/pie-framework/pie-players/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pie-framework%2Fpie-players/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34121022,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-09T02:00:06.510Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-02-13T07:57:52.660Z","updated_at":"2026-06-09T19:01:44.272Z","avatar_url":"https://github.com/pie-framework.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# pie-players\n\nPIE players and assessment toolkit with Bun + TypeScript + Svelte 5.\n\n**Docs app**: `apps/docs`\n**Examples app**: `apps/section-demos`\n\n## Quick Start\n\n```bash\nbun install\nbun run dev:section -- --rebuild   # First section-demo run (builds package dist outputs)\nbun run dev:section                # Section demos (daily run)\nbun run dev:docs                   # Docs site\n```\n\n## Development\n\n```bash\nbun run dev      # Turbo dev for section-demos (see package.json \"dev\")\nbun run build    # Build publishable packages + tools (excludes apps)\nbun run typecheck\nbun run test\nbun run format   # Format (Biome)\n```\n\nDemo apps resolve publishable packages through **`dist/`** (and section-demos uses explicit Vite aliases for many tools). See [Demo workspace resolution](docs/development/demo-workspace-resolution.md).\n\n## Consumer Import Rules\n\nWhen consuming PIE web components from apps or other packages:\n\n- Import custom-element registration entrypoints (for example `@pie-players/pie-assessment-toolkit/components/item-toolbar-element`), not raw package `.svelte` component files.\n- Do not import package source paths like `@pie-players/\u003cpkg\u003e/src/...` from consumers.\n- Do not use cross-package `?customElement` imports.\n- Keep runtime package exports pointing to built `dist` artifacts.\n\nBoundary checks:\n\n```bash\nbun run check:source-exports\nbun run check:consumer-boundaries\nbun run check:custom-elements\n```\n\n## Versioning Policy\n\nAll publishable `@pie-players/*` packages are released with a **fixed (lockstep)\nversion**. At any published version, every package in the suite carries that same\nversion number — there is no per-package version drift.\n\n### What this means for consumers\n\n- Pick one `@pie-players/*` version and update every `@pie-players/*` dependency\n  in your app to that version. The suite is tested and published as a cohesive\n  unit at that version.\n- You will never need to reason about a compatibility matrix across\n  `@pie-players/*` packages. If two `@pie-players/*` packages report the same\n  version, they are designed and tested to work together.\n- While the project remains on the pre-1.0 `0.x.y` line, every release is a\n  **patch** release across **all** publishable packages, including ones whose\n  source did not change. This is expected — it is the cost of the lockstep\n  guarantee above.\n\n### Why fixed versioning\n\nThe publishable packages in this repo (players, tools, TTS servers, theming,\ntoolkits) form a single cohesive player framework. Internal contracts cross\npackage boundaries (element registration, theme tokens, tool coordination,\nsession/session-state shape), so consumers almost always adopt the suite\ntogether rather than piecemeal. Fixed versioning removes a category of\ncompatibility bugs at the cost of more churn on unchanged packages per release.\n\n### How it is enforced\n\n- Changesets' `fixed` block in\n  [`.changeset/config.json`](./.changeset/config.json) lists every publishable\n  package.\n- `scripts/check-fixed-versioning.mjs` runs as part of `bun run verify:publish`\n  and blocks publish if any publishable package has drifted.\n- Release prep always covers every publishable package — see\n  [`.cursor/rules/release-version-alignment.mdc`](./.cursor/rules/release-version-alignment.mdc)\n  and [`docs/setup/publishing.md`](./docs/setup/publishing.md).\n\n## Releasing From Workspace\n\nThis monorepo keeps internal dependencies as `workspace:*` during development.\n\nThe canonical local release command is `bun run release:with-version`. It\ncreates the temporary all-packages patch changeset, rewrites workspace ranges to\nconcrete package versions for publish, runs preflight checks/tests, publishes,\nthen restores the original workspace ranges. This avoids leaking `workspace:*`\ninto npm metadata while keeping local development ergonomics unchanged.\n\nLocal publishing uses the codebase and branch currently checked out. Confirm the\ncurrent branch and working tree state before publishing; do not switch to a\ndifferent branch or use the GitHub workflow unless that is explicitly requested.\n\nBefore release merges/publishes, run:\n\n```bash\nbun run verify:publish\n```\n\nManual patch-only publish flow (matches CI gates):\n\n```bash\nbun run release:with-version\n```\n\n`release:with-version` creates a temporary all-packages patch changeset, runs preflight checks/tests, then publishes.\nMerges to `master` also auto-generate a temporary patch changeset when needed for release PR prep.\n\n### Registry switching (CodeArtifact vs npmjs)\n\nUse npmjs for publishing `@pie-players/*`, and switch back to CodeArtifact for\nprivate consumer installs when needed.\n\n```bash\n# one command on npmjs (preferred)\nNPM_CONFIG_REGISTRY=https://registry.npmjs.org npm whoami\n\n# publish path on npmjs\nNPM_CONFIG_REGISTRY=https://registry.npmjs.org bun run release:with-version\n\n# set current registry to npmjs\nnpm config set registry https://registry.npmjs.org/\n\n# set current registry back to CodeArtifact\nnpm config set registry https://renaissance-112784725199.d.codeartifact.us-east-1.amazonaws.com/npm/npm-rgp/\n```\n\n## Release Labels\n\nUse release labels to tag a coordinated release wave without forcing lockstep package versions.\n\n```bash\nbun run release:label                # Create annotated tag (default: pie-players-YYYY.MM.DD)\nbun run release:label -- --label players-2026.02\nbun run release:label:push           # Create and push tag to origin\n```\n\n## Packages\n\n**Interactive Players**: pie-item-player\n**Print Player**: print-player - Item-level print rendering for production use\n**Tools**: calculator, graph, ruler, protractor, annotation-toolbar, color-scheme, periodic-table\n**Shared**: players-shared, assessment-toolkit\n\n## Documentation\n\n- [Architecture](docs/architecture/architecture.md)\n- [Item Player Overview](docs/item-player/overview.md)\n- [Launching from LTI](docs/integrations/lti.md)\n- [NPM Token Setup](docs/setup/npm_token_setup.md)\n- [Publishing Contract](docs/setup/publishing.md)\n- [Docs Index](docs/readme.md)\n\n## License\n\nSee LICENSE file.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpie-framework%2Fpie-players","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpie-framework%2Fpie-players","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpie-framework%2Fpie-players/lists"}