Edstem Archive Extension

v0.4 Distribution - Source-Available Self-Install

v0.4 is the first public release of the browser extension and ships as source-available self-install only. Chrome Web Store and Microsoft Edge Add-ons listings are planned for a later milestone.

End users: see INSTALL.md (English) / INSTALL.zh-CN.md (Chinese) for the Load-unpacked install path on Chrome and Edge.

Purpose

This directory contains the self-contained Chromium Manifest V3 extension for Edstem Archive. It is independent from the Python CLI and does not require a top-level Node project.

Commands

npm ci
npm run build
npm run build:edge
npm test
npm run test:e2e
npm run test:e2e:headed
npm run policy:check
npm run lint
npm run verify
npm run screenshots
npm run package:chrome
npm run package:edge
npm run package:check

npm run verify runs the extension build, tests, and policy check in sequence. npm run package:chrome and npm run package:edge create predictable review artifacts under .output/; npm run package:check inspects those artifacts for forbidden package contents. npm run screenshots regenerates synthetic HTML screenshot fixtures under store-assets/screenshots/.

E2E Tests

npm run test:e2e runs the Playwright end-to-end suite against the built extension using the bundled Chromium. Before running E2E tests, build the extension first with npm run build.

npm run test:e2e:headed runs the same suite with the browser window visible - useful for debugging.

E2E tests use synthetic Edstem fixture data only. No real course names, course IDs, student names, instructor names, cookies, auth headers, or private thread bodies are used in or committed by the E2E suite.

E2E output (browser profiles, downloads, Playwright reports) lives under tests/e2e/.output/ and tests/e2e/downloads/, which are git-ignored.

Load Unpacked

For day-to-day development:

1. Run npm ci.
2. Run npm run build (Chrome) or npm run build:edge (Edge).
3. Open chrome://extensions (or edge://extensions).
4. Enable Developer mode.
5. Choose Load unpacked and select .output/chrome-mv3 (or .output/edge-mv3).

For end users installing a released zip, follow INSTALL.md instead.

Privacy Boundaries

The extension permission and privacy contracts live in PERMISSIONS.md and PRIVACY.md. The extension does not collect credentials or cookies, does not include telemetry, and does not read or write Python CLI archive paths.

Release Materials

• INSTALL.md / INSTALL.zh-CN.md - end-user install guide for the source-available self-install distribution (v0.4 path).
• STORE-LISTING.en.md and STORE-LISTING.zh-CN.md - bilingual listing copy retained for the future store-submission milestone.
• STORE-DASHBOARD-COPY.md - paste-ready Chrome / Edge dashboard text (retained for future store submission).
• PRE_SUBMIT_CHECKLIST.md - local verification commands, expected artifacts, inventory rules.
• RELEASE-HARDENING.md - pre-release hardening evidence with SHA-256 inventory.
• MANUAL-VERIFICATION.md / MANUAL-VERIFICATION-RESULTS.md - dual-OS real-browser verification runbook.
• STORE-SUBMISSION-RESULTS.md - submission template for the future store milestone.
• store-assets/screenshots/ - synthetic review fixtures.

License

This repository is source-available under the PolyForm Noncommercial License 1.0.0.

You may use, inspect, modify, and redistribute this software only for permitted noncommercial purposes under that license. Commercial use, paid redistribution, hosted commercial services, paid course/archive products, store listings operated for commercial gain, or incorporation into a commercial product require a separate written commercial license from the copyright holder.

The copyright holder reserves the right to offer separate commercial licenses and to commercialize the software independently.