Skip to content

Commit c705d9d

Browse files
authored
Merge pull request #14 from pie-framework/develop
dev merge: slop cleanup and i18n support
2 parents 065e62c + 2cf0fc6 commit c705d9d

155 files changed

Lines changed: 16714 additions & 10654 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,11 @@ This project provides two major capabilities:
1919
2020
---
2121

22+
> [!WARNING]
23+
> While I believe the QTI player is production ready, we're still sticking to 0.1.x for a while, and we may make API changes between versions. I don't foresee a lot of that, but nevertheless, until this project has been used in the wild for a while, we may need some tweaks here and there to make the API good and meanwhile it's best to keep the code clean and unbothered with shims and other backwards compatibility constructs. Once we're at 1.0.0, we'll make stronger commitments for the API. But, let us know if you plan to use this for a non-trivial/ production system, and we can move such commitments forward.
24+
25+
---
26+
2227
## Why This Project Exists
2328

2429
[PIE](https://pie-framework.org/) (Portable Interactions and Elements) is a complete framework for playing and authoring assessment items, maintained by [Renaissance Learning](https://www.renaissance.com/) with implementation partner [MCRO](https://mcro.tech/).
@@ -86,9 +91,10 @@ The player UI supports multiple languages with runtime locale switching:
8691

8792
- **Type-safe translations** — TypeScript autocomplete for all message keys
8893
- **Runtime switching** — Change language without page reload
94+
- **Custom translations** — Clients provide complete locale bundles or override specific strings
8995
- **Small bundle** — <10 KB gzipped (core + default locale)
9096

91-
See [`@pie-qti/qti2-i18n`](packages/qti2-i18n/) for the complete i18n API and migration guide.
97+
See [`@pie-qti/qti2-i18n`](packages/qti2-i18n/) for the complete i18n API and [custom translation examples](packages/qti2-i18n/docs/custom-translations-example.md).
9298

9399
---
94100

bun.lock

Lines changed: 46 additions & 15 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@
5050
"@biomejs/biome": "^2.3.11",
5151
"@changesets/cli": "^2.29.8",
5252
"@types/bun": "^1.3.5",
53+
"@vitalets/google-translate-api": "^9.2.1",
5354
"turbo": "^2.7.3",
5455
"typescript": "^5.9.3"
5556
},

packages/pie-to-qti2/package.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@
99
".": {
1010
"types": "./dist/index.d.ts",
1111
"import": "./dist/index.js"
12+
},
13+
"./generators/manifest-generator": {
14+
"types": "./dist/generators/manifest-generator.d.ts",
15+
"import": "./dist/generators/manifest-generator.js"
1216
}
1317
},
1418
"scripts": {

0 commit comments

Comments
 (0)