recess-cli 3.19.3 → 3.21.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.
@@ -541,7 +541,19 @@ export async function runOnboardingCommand({ parsed, api, writeCommand, }) {
541
541
  const familyId = positional(parsed, 2, "family ID");
542
542
  const kidUserId = flagString(parsed, "kid", { required: true });
543
543
  const grade = flagInteger(parsed, "grade", { min: 1, max: 12 });
544
- const body = grade === undefined ? {} : { grade };
544
+ const courseCode = flagString(parsed, "course")?.trim().toUpperCase();
545
+ if (courseCode !== undefined && !/^[A-Z0-9]{2,16}$/.test(courseCode)) {
546
+ throw new CliError("invalid_arguments", "--course must be a Math Academy course code like PREALG or 5GRMATH.");
547
+ }
548
+ const dailyGoal = flagInteger(parsed, "daily-goal", { min: 1, max: 600 });
549
+ const body = {
550
+ ...(grade === undefined ? {} : { grade }),
551
+ ...(courseCode === undefined ? {} : { courseCode }),
552
+ ...(dailyGoal === undefined ? {} : { dailyGoal }),
553
+ ...(hasFlag(parsed, "include-weekends")
554
+ ? { includeWeekends: true }
555
+ : {}),
556
+ };
545
557
  return writeCommand(parsed, {
546
558
  action: "provision or reconnect the kid's Math Academy account (vendor write; cannot be automatically undone)",
547
559
  target: { familyId, kidUserId },
@@ -105,14 +105,14 @@ function renderPlan(plan, webUrl, pdfPath) {
105
105
  out.push(`PDF: ${pdfPath}`);
106
106
  return out.join("\n");
107
107
  }
108
- /**
109
- * The tuition-plan flags that describe the plan itself (everything but who
110
- * it is for): shared by `tuition-plans generate` and `admissions create`,
111
- * which stores them as the packet's plan spec.
112
- */
113
- export function parseTuitionPlanSpecFlags(parsed) {
114
- const annual = Number(requiredFlag(parsed, "annual").replace(/[$,]/g, ""));
115
- if (!Number.isFinite(annual) || annual <= 0) {
108
+ export function parseTuitionPlanSpecFlags(parsed, options) {
109
+ const annualRaw = options?.annualOptional && flagString(parsed, "annual") === undefined
110
+ ? undefined
111
+ : requiredFlag(parsed, "annual");
112
+ const annual = annualRaw === undefined
113
+ ? undefined
114
+ : Number(annualRaw.replace(/[$,]/g, ""));
115
+ if (annual !== undefined && (!Number.isFinite(annual) || annual <= 0)) {
116
116
  throw new CliError("invalid_arguments", "--annual must be a positive dollar amount (net of Recess financial aid).");
117
117
  }
118
118
  // Add-on overrides; omitted = the server's school-pricing defaults.
@@ -256,7 +256,7 @@ export function parseTuitionPlanSpecFlags(parsed) {
256
256
  };
257
257
  return {
258
258
  startDate: requiredFlag(parsed, "start", ISO_DATE),
259
- annualTuition: annual,
259
+ ...(annual !== undefined ? { annualTuition: annual } : {}),
260
260
  stateFunding: hasFlag(parsed, "state-funding") ? "true" : "false",
261
261
  ...addOnQuery,
262
262
  ...subsetQuery,
package/dist/help.js CHANGED
@@ -80,6 +80,7 @@ Usage:
80
80
  --file </path/to/map-report.pdf> [--confirm]
81
81
  recess [--json] students issue-email --student <kid-id> [--confirm]
82
82
  recess [--json] students web-todos --student <kid-id> [--on|--off] [--confirm]
83
+ recess [--json] students flashcards --student <kid-id> [--on|--off] [--confirm]
83
84
  recess [--json] students notes add --student <kid-id> --text TEXT [--confirm]
84
85
  recess [--json] students interests --student <kid-id> [--add LABEL]...
85
86
  [--remove <interest-id>]... [--confirm]
@@ -185,6 +186,65 @@ Usage:
185
186
  [--description TEXT] [--date YYYY-MM-DD] [--confirm]
186
187
  recess [--json] payout items delete <item-id> [--confirm]
187
188
  recess [--json] families set-addresses --file <json> [--confirm]
189
+ recess [--json] family kids
190
+ recess [--json] family today
191
+ recess [--json] family schedule [--days 14]
192
+ recess [--json] family tutor [--student <kid>]
193
+ recess [--json] family account
194
+ recess [--json] family set-name [--first-name TEXT] [--last-name TEXT] [--confirm]
195
+ recess [--json] family set-notifications [--email-reminders true|false]
196
+ [--sms-reminders true|false] [--confirm]
197
+ recess [--json] family set-phone --phone <+E.164> [--confirm]
198
+ recess [--json] family set-timezone --timezone <IANA-zone> [--confirm]
199
+ recess [--json] family guardians
200
+ recess [--json] family school-classes
201
+ recess [--json] family school-class-options --student <kid>
202
+ recess [--json] family drop-class --student <kid> --cohort <cohort-id> [--confirm]
203
+ recess [--json] family restore-class --student <kid> --cohort <cohort-id> [--confirm]
204
+ recess [--json] family swap-class --student <kid> --from <cohort-id>
205
+ --to <cohort-id-or-none> [--confirm]
206
+ recess [--json] family register-class --student <kid> --cohort <cohort-id> [--confirm]
207
+ recess [--json] kid today --student <kid> [--date YYYY-MM-DD]
208
+ recess [--json] kid goals --student <kid>
209
+ recess [--json] kid xp --student <kid> [--range week|month|quarter|year]
210
+ recess [--json] kid map-scores --student <kid>
211
+ recess [--json] kid classes --student <kid>
212
+ recess [--json] kid profile --student <kid>
213
+ recess [--json] kid set-profile --student <kid> [--first-name TEXT] [--last-name TEXT]
214
+ [--birthday YYYY-MM-DD] [--interests "a,b"] [--confirm]
215
+ recess [--json] kid texts --student <kid>
216
+ recess [--json] kid set-texts --student <kid> [--enabled true|false]
217
+ [--frequency ALL|DAILY|IMPORTANT] [--focus TEXT | --clear-focus]
218
+ [--summary true|false] [--hour <0-23|default>] [--confirm]
219
+ recess [--json] kid set-rooms --student <kid> --allow true|false [--confirm]
220
+ recess [--json] kid feed-lock --student <kid>
221
+ recess [--json] kid set-feed-lock --student <kid> [--enabled true|false]
222
+ [--mode ALL_DAILY_TODOS|SELECTED_GOALS|DAILY_XP] [--xp-target N]
223
+ [--goals <goal-id,...>] [--confirm]
224
+ recess [--json] kid logins --student <kid>
225
+ recess [--json] kid reveal-login --student <kid> --login <login-id>
226
+ recess [--json] kid add-login --student <kid> --platform TEXT --url <site-url>
227
+ [--username TEXT] [--password TEXT] [--notes TEXT] [--confirm]
228
+ recess [--json] kid edit-login --student <kid> --login <login-id> [--platform TEXT]
229
+ [--url <site-url>] [--username TEXT] [--password TEXT] [--notes TEXT] [--confirm]
230
+ recess [--json] kid remove-login --student <kid> --login <login-id> [--confirm]
231
+ recess [--json] kid excuse --student <kid> --event <event-id> [--note TEXT] [--confirm]
232
+ recess [--json] kid cowork --student <kid>
233
+ recess [--json] kid switch-cowork --student <kid> --to <cohort-id> [--confirm]
234
+ recess [--json] kid friends --student <kid>
235
+ recess [--json] kid friend-parent --student <kid> --parent <user-id> [--confirm]
236
+ recess [--json] kid pair-device --student <kid> [--confirm]
237
+ recess [--json] kid goal-schedule --student <kid> --goal <goal-id>
238
+ --schedule <daily|weekly|Mon,Wed,Fri|3x/week> [--confirm]
239
+ recess [--json] kid pause-goal|resume-goal --student <kid> --goal <goal-id> [--confirm]
240
+ recess [--json] kid goal-note --student <kid> --goal <goal-id>
241
+ recess [--json] kid set-goal-note --student <kid> --goal <goal-id>
242
+ (--note TEXT | --clear) [--confirm]
243
+ recess [--json] kid add-todo --student <kid> --title TEXT [--due-date YYYY-MM-DD]
244
+ [--url URL] [--minutes N] [--confirm]
245
+ recess [--json] kid todo --student <kid> --todo <todo-id>
246
+ recess [--json] kid move-todo --student <kid> --todo <todo-id> --due-date YYYY-MM-DD [--confirm]
247
+ recess [--json] kid end-session --student <kid> --todo <todo-id> [--confirm]
188
248
  recess [--json] channels list [<query>...] [--type <channel-type>] [--audience KID|PARENT]
189
249
  [--status ACTIVE|HIDDEN|ARCHIVED] [--limit 1..200]
190
250
  recess [--json] channels create --name TEXT [--type <channel-type>]
@@ -211,7 +271,7 @@ Usage:
211
271
  [--application <application-id>]
212
272
  [--financial-aid <financial-aid-application-id>|none]
213
273
  [--tier complete] [--paywall DOLLARS|--paywall-offline] [--staff-note TEXT]... [--no-email]
214
- (--no-agreement | --start YYYY-MM-DD --annual DOLLARS) [--state-funding] [--end YYYY-MM-DD]
274
+ (--no-agreement | --start YYYY-MM-DD [--annual DOLLARS] [--override-aid-price]) [--state-funding] [--end YYYY-MM-DD]
215
275
  [--terms full-year,school-year,custom] [--payments upfront,installments] [--note TEXT]...
216
276
  [--bill-date upfront|N=YYYY-MM-DD]... [--due-date upfront|N=YYYY-MM-DD]... [--amount N=DOLLARS]... [--even-installments] [--force-direct]
217
277
  [--esa-award DOLLARS | --esa-award-unknown [--esa-scenarios DOLLARS,...]] [--custom-plan JSON|@file] [--custom-only]
@@ -222,9 +282,10 @@ Usage:
222
282
  recess [--json] admissions resend <packet-id> [--no-email] [--confirm]
223
283
  recess [--json] admissions void <packet-id> --reason TEXT [--confirm]
224
284
  recess [--json] admissions mark-signed <packet-id> --option <term:payment> [--note TEXT] [--confirm]
225
- recess [--json] admissions requote <packet-id> (--keep-plan | --no-agreement | --start YYYY-MM-DD --annual DOLLARS [plan flags as in create])
285
+ recess [--json] admissions requote <packet-id> (--keep-plan | --no-agreement | --start YYYY-MM-DD [--annual DOLLARS] [--override-aid-price] [plan flags as in create])
226
286
  [--paywall DOLLARS|--paywall-offline|--no-paywall] [--note TEXT] [--confirm]
227
287
  recess [--json] admissions archive-agreement <packet-id> [--confirm]
288
+ recess [--json] admissions attach-aid <packet-id> --financial-aid <financial-aid-application-id>|none [--confirm]
228
289
  recess [--json] admissions mark-paid <packet-id> [--note TEXT] [--confirm]
229
290
  recess [--json] admissions set-paywall <packet-id> (--paywall DOLLARS | --paywall-offline | --no-paywall) [--note TEXT] [--confirm]
230
291
  recess [--json] admissions contract <packet-id> [--option <term:payment>] [--out <file>]
@@ -299,7 +360,8 @@ Usage:
299
360
  recess [--json] onboarding seed-feed <family-id> --kid <kid-id> [--confirm]
300
361
  recess [--json] onboarding generate-summaries <family-id> [--confirm]
301
362
  recess [--json] onboarding provision-math-academy <family-id>
302
- --kid <kid-id> [--grade 1..12] [--confirm]
363
+ --kid <kid-id> [--grade 1..12] [--course <code>] [--daily-goal 1..600]
364
+ [--include-weekends] [--confirm]
303
365
  recess [--json] onboarding link-math-academy <family-id>
304
366
  --kid <kid-id> [--student-id <math-academy-student-id>] [--confirm]
305
367
  recess [--json] onboarding provision-ixl <family-id>
@@ -734,6 +796,38 @@ omitted for US; US ZIPs must be 12345 or 12345-6789. Each entry replaces the
734
796
  family's whole address. The preview is the server's dry run: before and after
735
797
  for every family that changes.
736
798
 
799
+ Family dashboard notes: "family" is a guardian's own parent dashboard: kids,
800
+ today, the family schedule, tutor, account and reminder settings, guardians, and
801
+ school classes (drop/restore/swap/register). --student takes one of your kids'
802
+ ids, full name, or a unique first name; ambiguous or unknown names list your
803
+ kids. Every write previews first, then needs --confirm after a human approves.
804
+ Dashboard-only, never commands: removing a kid, adding a co-guardian,
805
+ password/PIN, payment cards, billing or membership changes, profile photo and
806
+ screen time. Send the guardian to https://recess.gg/settings (account, security,
807
+ guardians) or https://recess.gg/family?tab=billing (billing).
808
+
809
+ Kid dashboard notes: "kid" reads and manages one of your kids (--student takes
810
+ an id, full name, or unique first name): today, goals, XP, MAP scores, classes,
811
+ profile, the texts you get about them, live rooms, feed lock, saved site logins,
812
+ excusing an absence, the daily coworking pod, friends' parents, and pairing a
813
+ new device. Every write previews first, then needs --confirm. Passwords are
814
+ never echoed in previews (redacted plus a sha256 prefix); "kid reveal-login" is
815
+ an audited read. --interests replaces the whole list. The daily summary is opt-in
816
+ per kid and shared by every guardian: "kid set-texts --summary true|false" turns
817
+ it on or off, and --hour sets when it is sent, in the kid's timezone (default
818
+ 18:00). An hour needs the summary on (add --summary true); turning it off drops
819
+ the hour. Plan controls (any guardian): a goal's cadence ("goal-schedule": daily,
820
+ weekly, Mon,Wed,Fri or 3x/week), pausing/resuming a goal, the goal's note
821
+ ("set-goal-note"), one-off todos ("add-todo"; no bonus/optional kind exists),
822
+ moving a not-started todo ("move-todo"), and ending a stuck session so started
823
+ work can be removed ("end-session"; never completes it or awards XP). The goal note
824
+ is how a parent changes how Rocky behaves on that goal ("ask fewer follow-ups",
825
+ "Scratch is an ongoing project, not daily", "skip the video"): Rocky's goal
826
+ sessions and the daily planner read it. It replaces the current note; max 2000
827
+ characters. Dashboard-only: removing a
828
+ kid, the kid's password/PIN, profile photo, screen time, billing and membership
829
+ (https://recess.gg/settings, https://recess.gg/family?tab=billing).
830
+
737
831
  Activity-report notes: "reports activity" builds a weekly student activity report
738
832
  on the server for exactly one audience: a partner school's enrolled kids
739
833
  (--partner-school), a guide's academy roster grouped by core-academics cohort
@@ -839,7 +933,12 @@ instead of creating one: the kid must be in the family of the guardian who owns
839
933
  --email, the parent signs in with that account to start, and the kid's account,
840
934
  tier and history are left as they are. The envelope opens with the family's financial aid answers
841
935
  for them to initial as true; they come from --financial-aid, else the application's
842
- aid form, else the newest aid form under the parent's email ("none" leaves it out). "resend" mints a new link (the old one dies) and emails
936
+ aid form, else the newest aid form under the parent's email ("none" leaves it out); create
937
+ prints which one it attached and warns when it was an email match. The plan's price comes
938
+ from that aid form's review: leave --annual out and the reviewed annual (after Recess aid)
939
+ is used for a one-child packet (the review is the family's total; with more children give
940
+ the per-child --annual); an --annual that differs from a reviewed price is refused unless
941
+ --override-aid-price is given (requote checks the packet's aid form the same way). "resend" mints a new link (the old one dies) and emails
843
942
  it. "get" prints the agreed plan as signed (each child's option, term and every
844
943
  installment) and whether the signed agreement is archived in our storage; the
845
944
  copy is taken when the envelope completes, and "archive-agreement" retries it.
@@ -978,6 +1077,7 @@ export const COMMAND_SUMMARIES = {
978
1077
  "students upload-map-scores": "Upload a NWEA MAP score report PDF for a kid.",
979
1078
  "students issue-email": "Issue a Recess email address for a kid.",
980
1079
  "students web-todos": "Show or set whether a kid's todos run on web (off: they open in the desktop app).",
1080
+ "students flashcards": "Show or set whether a kid gets a daily flashcard review todo.",
981
1081
  "students interests": "List, add, or remove a kid's interests (Rocky, the feed, and reading/writing passages use them).",
982
1082
  "students notes add": "Add a staff-visible guide note to a kid's profile (Rocky reads it).",
983
1083
  "chat-logs list": "List a student's AI chat conversations.",
@@ -1055,6 +1155,54 @@ export const COMMAND_SUMMARIES = {
1055
1155
  "payout items edit": "Edit a payout line item.",
1056
1156
  "payout items delete": "Delete a payout line item.",
1057
1157
  "families set-addresses": "Replace family mailing addresses from JSON.",
1158
+ "family kids": "List your kids (no billing details).",
1159
+ "family today": "Today across your family.",
1160
+ "family schedule": "Your family's upcoming classes and events.",
1161
+ "family tutor": "Your family's tutor/guide.",
1162
+ "family account": "Your name, email, phone, reminders, timezone.",
1163
+ "family set-name": "Change your own first/last name.",
1164
+ "family set-notifications": "Turn your email/SMS reminders on or off.",
1165
+ "family set-phone": "Change your own phone number.",
1166
+ "family set-timezone": "Set the whole family's timezone.",
1167
+ "family guardians": "List the guardians in your family.",
1168
+ "family school-classes": "Your kids' school classes, slots, queued switches.",
1169
+ "family school-class-options": "Classes a kid can switch to or join.",
1170
+ "family drop-class": "Drop a kid's school class (at period end).",
1171
+ "family restore-class": "Undo a kid's pending class drop.",
1172
+ "family swap-class": "Queue (or cancel) a kid's class switch.",
1173
+ "family register-class": "Register a kid for a school class.",
1174
+ "kid today": "A kid's day: todos, XP, schedule.",
1175
+ "kid goals": "A kid's goals and progress.",
1176
+ "kid xp": "A kid's XP history.",
1177
+ "kid map-scores": "A kid's MAP test scores.",
1178
+ "kid classes": "A kid's classes.",
1179
+ "kid profile": "A kid's name, birthday, email, interests.",
1180
+ "kid set-profile": "Change a kid's name, birthday, or interests.",
1181
+ "kid texts": "The texts you get about a kid; daily summary on/off and hour.",
1182
+ "kid set-texts": "Change your texts about a kid; daily summary on/off and hour.",
1183
+ "kid set-rooms": "Allow or block a kid in live rooms.",
1184
+ "kid feed-lock": "A kid's feed lock (feed opens after daily work).",
1185
+ "kid set-feed-lock": "Change a kid's feed lock.",
1186
+ "kid logins": "A kid's saved site logins (no passwords).",
1187
+ "kid reveal-login": "Show one saved login's password (audited).",
1188
+ "kid add-login": "Save a site login for a kid.",
1189
+ "kid edit-login": "Edit a kid's saved site login.",
1190
+ "kid remove-login": "Delete a kid's saved site login.",
1191
+ "kid excuse": "Excuse a kid from a class session.",
1192
+ "kid cowork": "A kid's daily coworking pod and the options.",
1193
+ "kid switch-cowork": "Move a kid to another coworking pod.",
1194
+ "kid friends": "A kid's friends and their parents.",
1195
+ "kid friend-parent": "Friend-request the parent of a kid's friend.",
1196
+ "kid pair-device": "Mint a code that signs a kid into a new device.",
1197
+ "kid goal-schedule": "Change a goal's cadence (daily, weekly, weekdays).",
1198
+ "kid pause-goal": "Pause a goal (no new work planned for it).",
1199
+ "kid resume-goal": "Resume a paused goal.",
1200
+ "kid goal-note": "Read the note that steers how Rocky works a goal.",
1201
+ "kid set-goal-note": "Change how Rocky works a goal: replace or clear its note.",
1202
+ "kid add-todo": "Add a one-off todo for a kid.",
1203
+ "kid todo": "One todo: status, due day, live session.",
1204
+ "kid move-todo": "Move a not-started todo to another day.",
1205
+ "kid end-session": "End a stuck todo session (no XP, not completed).",
1058
1206
  "channels list": "List community channels with filters.",
1059
1207
  "channels create": "Create a community channel.",
1060
1208
  "channels set-image": "Set or clear a channel's image.",
@@ -1294,6 +1442,8 @@ export const NOUN_SUMMARIES = {
1294
1442
  cohorts: "Cohorts: search, schedule, parent emails, end, billing, email.",
1295
1443
  payout: "Guide payouts: payruns, recipients, invoices, line items.",
1296
1444
  families: "Bulk-set family mailing addresses.",
1445
+ family: "Your parent dashboard: kids, schedule, account, school classes.",
1446
+ kid: "One of your kids: today, goals, profile, texts, logins, pods.",
1297
1447
  channels: "Community channels and their members.",
1298
1448
  "tuition-plans": "Compute tuition plan sheets (stores nothing).",
1299
1449
  feed: "Post messages to users' feeds.",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "recess-cli",
3
- "version": "3.19.3",
3
+ "version": "3.21.0",
4
4
  "description": "Safe Recess administration and family AI tools from the command line.",
5
5
  "license": "UNLICENSED",
6
6
  "repository": {
@@ -17,13 +17,17 @@ recess --json doctor
17
17
 
18
18
  `doctor` reports the API origin, signed-in user, and CLI scope. Use that scope, never a role
19
19
  inferred from the request. Scope `village_home` may use only `village build|library|objects|render`
20
- on the user's own home; it cannot fetch skill catalogs or call other Recess routes.
20
+ on the user's own home; it cannot fetch skill catalogs or call other Recess routes. Scope `family`
21
+ (a guardian without AI access) gets no authoring skills. Parent dashboard: `recess help family`,
22
+ `recess help kid`.
21
23
 
22
24
  Load the audience skill's `SKILL.md`, then only the reference it routes you to:
23
25
 
24
26
  ```bash
25
27
  # Parent or guardian: kids, schedules, goals, todos, progress, memory, Rocky
26
28
  recess --json skills guardian get recess-family
29
+ # Design a challenge: principles and one reference per proven challenge type
30
+ recess --json skills guardian get recess-challenge-design
27
31
  # Research, author, or apply a goal or reusable goal template
28
32
  recess --json skills guardian get recess-goal-authoring
29
33
  # Guide (guide_students): your students, class ops, Math Academy linking and activity
@@ -1,4 +1,4 @@
1
1
  {
2
- "version": "3.5.1",
2
+ "version": "3.5.2",
3
3
  "minCliVersion": "3.19.2"
4
4
  }