@read-frog/api-contract 0.21.1 → 0.22.0

package/src/schemas/notebase.ts

@@ -41,6 +41,8 @@ export const notebaseSchema = z.object({
   srsWeights: srsWeightsSchema.nullable(),
   // Selects the scheduler/curve; read-only, changed only by the FSRS-7 migration.
   srsModelVersion: srsModelVersionSchema,
+  // Null = awake; set = excluded from the combined review. Written by notebase.setSleep and auto sleep.
+  srsSleepingAt: z.date().nullable(),
   createdAt: z.date(),
   updatedAt: z.date(),
 });
@@ -144,6 +146,20 @@ export const NotebaseUpdateOutputSchema = z.object({
 });
 export type NotebaseUpdateOutput = z.infer<typeof NotebaseUpdateOutputSchema>;
 
+export const NotebaseSetSleepInputSchema = z
+  .object({
+    id: z.uuid(),
+    enabled: z.boolean(),
+  })
+  .strict();
+export type NotebaseSetSleepInput = z.infer<typeof NotebaseSetSleepInputSchema>;
+
+// txid is null when the notebase was already in the requested state: nothing to wait for.
+export const NotebaseSetSleepOutputSchema = z.object({
+  txid: z.number().nullable(),
+});
+export type NotebaseSetSleepOutput = z.infer<typeof NotebaseSetSleepOutputSchema>;
+
 export const NotebaseDeleteInputSchema = z.object({
   id: z.uuid(),
 });

package/src/schemas/speech.ts

@@ -109,5 +109,14 @@ export const speechSynthesizeInputSchema = z
   .strict();
 export type SpeechSynthesizeInput = z.infer<typeof speechSynthesizeInputSchema>;
 
-/** The audio, as an MP3 file. */
-export const speechSynthesizeOutputSchema = z.file();
+/**
+ * Where to download the audio, an MP3: a link to fetch at once, which stops
+ * working at `expiresAt`.
+ */
+export const speechSynthesizeOutputSchema = z
+  .object({
+    url: z.url(),
+    expiresAt: z.coerce.date(),
+  })
+  .strict();
+export type SpeechSynthesizeOutput = z.infer<typeof speechSynthesizeOutputSchema>;

package/src/schemas/srs.ts

@@ -13,7 +13,7 @@ import {
 import { z } from "zod";
 import { cardSchema } from "./card";
 import { notebaseSummarySchema } from "./notebase";
-import { timezoneSchema } from "./timezone";
+import { canonicalTimezoneSchema } from "./timezone";
 
 export { reviewRatingSchema, schedulingParamsSchema, SRS_REVIEW_DURATION_MS_MAX };
 export { timezoneSchema } from "./timezone";
@@ -45,7 +45,7 @@ export const srsReviewInputSchema = z
     id: z.uuid().optional(),
     rating: reviewRatingSchema,
     durationMs: z.number().int().min(0).max(SRS_REVIEW_DURATION_MS_MAX),
-    timezone: timezoneSchema,
+    timezone: canonicalTimezoneSchema,
   })
   .strict();
 export type SrsReviewInput = z.infer<typeof srsReviewInputSchema>;
@@ -67,7 +67,7 @@ export type SrsScheduleStatusStats = z.infer<typeof srsScheduleStatusStatsSchema
 export const srsScheduleStatusStatsInputSchema = z
   .object({
     notebaseIds: z.array(z.uuid()).optional(),
-    timezone: timezoneSchema,
+    timezone: canonicalTimezoneSchema,
   })
   .strict();
 export type SrsScheduleStatusStatsInput = z.infer<typeof srsScheduleStatusStatsInputSchema>;
@@ -77,7 +77,7 @@ export type SrsScheduleStatusStatsOutput = z.infer<typeof srsScheduleStatusStats
 
 export const srsRecentNotebaseScheduleStatusStatsInputSchema = z
   .object({
-    timezone: timezoneSchema,
+    timezone: canonicalTimezoneSchema,
   })
   .strict();
 export type SrsRecentNotebaseScheduleStatusStatsInput = z.infer<

package/src/schemas/stats.ts

@@ -1,7 +1,7 @@
 import { z } from "zod";
 import { notebaseActivityStatsOutputSchema } from "./notebase-stats";
 import { srsActivityStatsOutputSchema } from "./srs-stats";
-import { timezoneSchema } from "./timezone";
+import { canonicalTimezoneSchema } from "./timezone";
 
 const statsNotebaseIdsSchema = z
   .array(z.uuid())
@@ -13,7 +13,7 @@ export const statsInputSchema = z
     notebaseIds: statsNotebaseIdsSchema.optional(),
     from: z.iso.date().optional(),
     to: z.iso.date(),
-    timezone: timezoneSchema,
+    timezone: canonicalTimezoneSchema,
   })
   .strict()
   .refine((input) => !input.from || input.from <= input.to, {

package/src/schemas/timezone.ts

@@ -1,3 +1,4 @@
+import { canonicalTimeZone } from "@read-frog/definitions";
 import { z } from "zod";
 
 // @ref https://zenn.dev/herp_inc/articles/js-intl-date-time-format-performance
@@ -46,3 +47,23 @@ export const timezoneSchema = z
     }
   }, "Invalid timezone");
 export type Timezone = z.infer<typeof timezoneSchema>;
+
+/**
+ * The zone a call reckons days in, under the name an account's zone is stored
+ * under (`canonicalTimeZone`): "Asia/Calcutta" arrives as "Asia/Kolkata" and
+ * "CST" as "America/Chicago", names that Temporal and a Debian Postgres both
+ * read. A fixed offset ("+08:00") is refused, as Postgres reads it with the
+ * opposite sign and would put the call's days on the wrong side of UTC.
+ */
+export const canonicalTimezoneSchema = timezoneSchema.transform((timezone, ctx) => {
+  const name = canonicalTimeZone(timezone);
+  if (!name) {
+    ctx.addIssue({
+      code: "custom",
+      message:
+        "Use an IANA time zone identifier instead of a fixed UTC offset. See https://www.iana.org/time-zones",
+    });
+    return z.NEVER;
+  }
+  return name;
+});

package/src/schemas/user.ts

@@ -1,4 +1,5 @@
 import { z } from "zod";
+import { appLocaleSchema } from "./app-locale";
 import { timezoneSchema } from "./timezone";
 
 export const userEnsureTimezoneInputSchema = z
@@ -29,3 +30,35 @@ export const userUpdateTimezoneOutputSchema = z
   })
   .strict();
 export type UserUpdateTimezoneOutput = z.infer<typeof userUpdateTimezoneOutputSchema>;
+
+// The account's language, which emails are written in. `ensureLocale` only
+// fills it in when it is empty (the language www is showing on a signed-in
+// visit); `updateLocale` is the user choosing a language.
+export const userEnsureLocaleInputSchema = z
+  .object({
+    locale: appLocaleSchema,
+  })
+  .strict();
+export type UserEnsureLocaleInput = z.infer<typeof userEnsureLocaleInputSchema>;
+
+export const userEnsureLocaleOutputSchema = z
+  .object({
+    locale: appLocaleSchema,
+    updated: z.boolean(),
+  })
+  .strict();
+export type UserEnsureLocaleOutput = z.infer<typeof userEnsureLocaleOutputSchema>;
+
+export const userUpdateLocaleInputSchema = z
+  .object({
+    locale: appLocaleSchema,
+  })
+  .strict();
+export type UserUpdateLocaleInput = z.infer<typeof userUpdateLocaleInputSchema>;
+
+export const userUpdateLocaleOutputSchema = z
+  .object({
+    locale: appLocaleSchema,
+  })
+  .strict();
+export type UserUpdateLocaleOutput = z.infer<typeof userUpdateLocaleOutputSchema>;

package/src/contracts/beta-access.ts

@@ -1,14 +0,0 @@
-import { oc } from "@orpc/contract";
-import { BetaAccessStatusInputSchema, BetaAccessStatusOutputSchema } from "#/schemas/beta-access";
-
-export const betaAccessContract = {
-  status: oc
-    .route({
-      method: "GET",
-      path: "/beta-access/status",
-      summary: "Get beta access status for a feature",
-      tags: ["Beta Access"],
-    })
-    .input(BetaAccessStatusInputSchema)
-    .output(BetaAccessStatusOutputSchema),
-};

package/src/schemas/beta-access.ts

@@ -1,18 +0,0 @@
-import { BETA_FEATURE_KEYS } from "@read-frog/definitions";
-import { z } from "zod";
-
-export const BetaFeatureKeySchema = z.enum(BETA_FEATURE_KEYS);
-export type BetaFeatureKey = z.infer<typeof BetaFeatureKeySchema>;
-
-export const BetaAccessStatusInputSchema = z
-  .object({
-    featureKey: BetaFeatureKeySchema,
-  })
-  .strict();
-export type BetaAccessStatusInput = z.infer<typeof BetaAccessStatusInputSchema>;
-
-export const BetaAccessStatusOutputSchema = z.object({
-  featureKey: BetaFeatureKeySchema,
-  allowed: z.boolean(),
-});
-export type BetaAccessStatusOutput = z.infer<typeof BetaAccessStatusOutputSchema>;