Decide the pack catalog distribution model and implement it

Đang mở
  • Có gì không ổn?
#52 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
25/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
typescript
Lĩnh vực
full-stack

Hướng nghiên cứu

Start by reading docs/adr/0006-offline-first-pwa-on-github-pages.md and docs/architecture.md, section 9, to understand the existing constraints and pack sources. Then inspect packages/cli/src/commands/build.ts, apps/web/src/logic/catalog.ts, and apps/web/src/services/packs.ts. Done means the distribution decision is recorded in an accepted ADR, catalog validation and CI checks are documented and implemented, catalog packs work offline through the listed player flows, the end-to-end test verifies no cross-origin requests, and the offline file stays within the ADR’s budget.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

area: content area: infra area: web priority: medium type: decision

Context

Packs are bundled into the player at build time (the lexvm-catalog/1 index.json from lexvm build) or imported from files. As community packs grow, bundling everything into the PWA and into lexvm-offline.html stops scaling, and players need a way to discover packs. At the v0.1 pull request, with two packs, lexvm-offline.html is 660 KB (209 KB gzip), and the noir pack alone is a 100 KB .lexpack.json. Constraints: no server, no accounts, no tracking, no network requests beyond the player's own files (ADR 0006), offline-first, and no pack enters the catalog without passing lexvm check.

Options

  • A. Status quo: every pack in this repository is bundled. Simple, but the offline file and the precache grow with every pack.
  • B. Same-origin catalog on GitHub Pages: all packs stay in this repository; the catalog lists them; only featured packs are bundled and precached; the others are downloaded on demand from the same origin and stored on the device.
  • C. A separate registry repository with its own Pages site. The player would fetch a cross-origin index, which needs an amendment to ADR 0006 and a content security policy for it.
  • D. GitHub Releases as the distribution channel. Cross-origin, with CORS and rate-limit issues.

Proposed: B.

Scope

  • ADR for the chosen model.
  • Catalog format (a new version if needed): id, version, hash, language, estimated length, license, author, size, content notes; generated and validated in CI.
  • Library: a "More adventures" section with download, size, update notice when the hash changes (using the existing replay flow) and delete.
  • lexvm-offline.html contains only the featured packs.

Acceptance criteria

  • The ADR is accepted.
  • The catalog format is documented, and CI fails if a listed pack does not pass lexvm check.
  • The player lists, downloads, stores, updates and deletes catalog packs, and downloaded packs play offline.
  • An end-to-end test asserts that no cross-origin request is made.
  • The size of lexvm-offline.html stays within a budget recorded in the ADR.

References

  • packages/cli/src/commands/build.ts
  • apps/web/src/logic/catalog.ts
  • apps/web/src/services/packs.ts
  • docs/adr/0006-offline-first-pwa-on-github-pages.md
  • docs/architecture.md (section 9, Pack sources)
Ngôn ngữ chính
TypeScript
Star
0
Fork
0
Merge trung bình
1 giờ 24 phút
Pull request đã merge (30 ngày)
5

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của nullthrone/lexvm

Tất cả issue của nullthrone/lexvm

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.