@playcademy/sandbox 0.2.3 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (10) hide show
  1. package/README.md +20 -16
  2. package/dist/cli.js +808 -569
  3. package/dist/config.d.ts +38 -2
  4. package/dist/config.js +31 -5
  5. package/dist/constants.d.ts +193 -0
  6. package/dist/constants.js +231 -0
  7. package/dist/mocks/timeback.d.ts +30 -0
  8. package/dist/server.d.ts +21 -2
  9. package/dist/server.js +796 -461
  10. package/package.json +5 -1
package/README.md CHANGED
@@ -136,10 +136,14 @@ npx @playcademy/sandbox --port 8080 --realtime --realtime-port 8081
136
136
  | Option | Alias | Description | Default |
137
137
  | :------------------------- | :---- | :--------------------------------------- | :----------- |
138
138
  | `--port <number>` | `-p` | Port for the main API server. | `4321` |
139
+ | `--verbose` | `-v` | Enables verbose logging for debugging. | `false` |
139
140
  | `--realtime` | | Enables the real-time WebSocket server. | `false` |
140
141
  | `--realtime-port <number>` | | Port for the real-time WebSocket server. | API port + 1 |
141
- | `--verbose` | `-v` | Enables verbose logging for debugging. | `false` |
142
- | `--no-seed` | | Disables seeding of demo data. | `false` |
142
+ | `--no-seed` | | Disables seeding of demo data. | seeds |
143
+ | `--recreate-db` | | Recreate the on-disk database on start. | `false` |
144
+ | `--memory` | | Use in-memory database (no persistence). | `false` |
145
+ | `--db-path <path>` | | Custom path for the database file. | `undefined` |
146
+ | `--config-path <path>` | | Path to playcademy.config.json. | `cwd` |
143
147
  | `--project-name <name>` | | Sets the project name for game seeding. | `undefined` |
144
148
  | `--project-slug <slug>` | | Sets the project slug for game seeding. | `undefined` |
145
149
 
@@ -160,13 +164,13 @@ const client = await PlaycademyClient.init({
160
164
 
161
165
  ## Sandbox Features
162
166
 
163
- | Feature | Description |
164
- | :------------------- | :-------------------------------------------------------------------------------------------------------------------- |
165
- | **API Simulation** | Emulates the entire Playcademy backend API for users, games, inventory, etc. |
166
- | **Real-time Server** | Provides WebSocket-based real-time channels for multiplayer communication. |
167
- | **Data Persistence** | Persists data to disk by default (survives restarts). Use `--recreate-db` to reset, or `--memory` for in-memory only. |
168
- | **Mock Data** | Automatically seeds with demo users and data on first run or when database is empty. |
169
- | **Game Context** | When run via the Vite plugin, it automatically registers your current project as a mock game. |
167
+ | Feature | Description |
168
+ | :------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------- |
169
+ | **API Simulation** | Emulates the entire Playcademy backend API for users, games, inventory, etc. |
170
+ | **Real-time Server** | Provides WebSocket-based real-time channels for multiplayer communication. |
171
+ | **Data Persistence** | Persists data to disk by default (survives restarts). Use `--recreate-db` to reset, `--memory` for in-memory only, or `--db-path` for custom location. |
172
+ | **Mock Data** | Automatically seeds with demo users and data on first run or when database is empty. |
173
+ | **Game Context** | When run via the Vite plugin, it automatically registers your current project as a mock game. |
170
174
 
171
175
  ## Server Endpoints
172
176
 
@@ -208,13 +212,13 @@ bunx @playcademy/sandbox \
208
212
  --timeback-student-id your-student-sourcedId
209
213
  ```
210
214
 
211
- | Option | Description |
212
- | :------------------------- | :---------------------------------- |
213
- | `--timeback-local` | Enable local TimeBack mode (Docker) |
214
- | `--timeback-oneroster-url` | OneRoster API URL |
215
- | `--timeback-caliper-url` | Caliper API URL |
216
- | `--timeback-course-id` | Course ID for enrollments |
217
- | `--timeback-student-id` | Student ID to link to demo user |
215
+ | Option | Description |
216
+ | :------------------------------- | :---------------------------------- |
217
+ | `--timeback-local` | Enable local TimeBack mode (Docker) |
218
+ | `--timeback-oneroster-url <url>` | OneRoster API URL |
219
+ | `--timeback-caliper-url <url>` | Caliper API URL |
220
+ | `--timeback-course-id <id>` | Course ID for enrollments |
221
+ | `--timeback-student-id <id>` | Student ID to link to demo user |
218
222
 
219
223
  ### Environment Variables
220
224