@read-frog/api-contract 0.14.0 → 0.15.0

package/src/schemas/notebase.ts

@@ -1,20 +1,28 @@
-import { notebaseColumnConfigSchema, schedulingParamsShape, srsWeightsSchema } from "@read-frog/definitions"
-import { z } from "zod"
-import { notebaseColumnSchema } from "./notebase-column"
-import { NOTEBASE_ROW_CREATE_MANY_MAX_ROWS, notebaseRowSchema } from "./notebase-row"
-import { notebaseViewSchema } from "./notebase-view"
-
-export const NotebaseListInputSchema = z.object({})
-export type NotebaseListInput = z.infer<typeof NotebaseListInputSchema>
-
-export const NotebaseListItemSchema = z.object({
+import { deletionResultSchema } from "./resource-mutation";
+import {
+  notebaseColumnConfigSchema,
+  schedulingParamsShape,
+  srsWeightsSchema,
+} from "@read-frog/definitions";
+import { z } from "zod";
+import { notebaseColumnSchema } from "./notebase-column";
+import { NOTEBASE_ROW_CREATE_MANY_MAX_ROWS, notebaseRowSchema } from "./notebase-row";
+import { notebaseViewSchema } from "./notebase-view";
+
+export const NotebaseListInputSchema = z.object({});
+export type NotebaseListInput = z.infer<typeof NotebaseListInputSchema>;
+
+export const notebaseSummarySchema = z.object({
   id: z.string(),
   name: z.string(),
-})
-export type NotebaseListItem = z.infer<typeof NotebaseListItemSchema>
+});
+export type NotebaseSummary = z.infer<typeof notebaseSummarySchema>;
 
-export const NotebaseListOutputSchema = z.array(NotebaseListItemSchema)
-export type NotebaseListOutput = z.infer<typeof NotebaseListOutputSchema>
+export const NotebaseListItemSchema = notebaseSummarySchema;
+export type NotebaseListItem = z.infer<typeof NotebaseListItemSchema>;
+
+export const NotebaseListOutputSchema = z.array(NotebaseListItemSchema);
+export type NotebaseListOutput = z.infer<typeof NotebaseListOutputSchema>;
 
 export const notebaseSchema = z.object({
   id: z.string(),
@@ -32,105 +40,137 @@ export const notebaseSchema = z.object({
   srsWeights: srsWeightsSchema.nullable(),
   createdAt: z.date(),
   updatedAt: z.date(),
-})
-export type Notebase = z.infer<typeof notebaseSchema>
-
-const notebaseInitialRowSchema = z.object({
-  id: z.uuid().optional(),
-  cells: z.record(z.string(), z.unknown()),
-}).strict()
-
-export const notebaseCreateDataSchema = z.object({
-  id: z.uuid().optional(),
-  name: z.string().min(1),
-  options: z.object({
-    initialColumns: z.array(z.object({
-      id: z.uuid(),
-      name: z.string().min(1),
-      config: notebaseColumnConfigSchema,
-    }).strict()).min(1),
-    initialRow: notebaseInitialRowSchema.optional(),
-    initialRows: z.array(notebaseInitialRowSchema).min(1).max(NOTEBASE_ROW_CREATE_MANY_MAX_ROWS).optional(),
-  }).strict().superRefine((options, ctx) => {
-    if (options.initialRow && options.initialRows) {
-      ctx.addIssue({
-        code: "custom",
-        message: "Provide either initialRow or initialRows, not both.",
-        path: ["initialRows"],
+});
+export type Notebase = z.infer<typeof notebaseSchema>;
+
+const notebaseInitialRowSchema = z
+  .object({
+    id: z.uuid().optional(),
+    cells: z.record(z.string(), z.unknown()),
+  })
+  .strict();
+
+export const notebaseCreateDataSchema = z
+  .object({
+    id: z.uuid().optional(),
+    name: z.string().min(1),
+    options: z
+      .object({
+        initialColumns: z
+          .array(
+            z
+              .object({
+                id: z.uuid(),
+                name: z.string().min(1),
+                config: notebaseColumnConfigSchema,
+              })
+              .strict(),
+          )
+          .min(1),
+        initialRow: notebaseInitialRowSchema.optional(),
+        initialRows: z
+          .array(notebaseInitialRowSchema)
+          .min(1)
+          .max(NOTEBASE_ROW_CREATE_MANY_MAX_ROWS)
+          .optional(),
+      })
+      .strict()
+      .superRefine((options, ctx) => {
+        if (options.initialRow && options.initialRows) {
+          ctx.addIssue({
+            code: "custom",
+            message: "Provide either initialRow or initialRows, not both.",
+            path: ["initialRows"],
+          });
+        }
+
+        if (!options.initialRows) {
+          return;
+        }
+
+        const seenIds = new Set<string>();
+        options.initialRows.forEach((row, index) => {
+          if (row.id === undefined) {
+            return;
+          }
+
+          if (seenIds.has(row.id)) {
+            ctx.addIssue({
+              code: "custom",
+              message: `Duplicate row id "${row.id}".`,
+              path: ["initialRows", index, "id"],
+            });
+            return;
+          }
+
+          seenIds.add(row.id);
+        });
       })
-    }
-
-    if (!options.initialRows) {
-      return
-    }
-
-    const seenIds = new Set<string>()
-    options.initialRows.forEach((row, index) => {
-      if (row.id === undefined) {
-        return
-      }
-
-      if (seenIds.has(row.id)) {
-        ctx.addIssue({
-          code: "custom",
-          message: `Duplicate row id "${row.id}".`,
-          path: ["initialRows", index, "id"],
-        })
-        return
-      }
-
-      seenIds.add(row.id)
-    })
-  }).optional(),
-}).strict()
-export type NotebaseCreateData = z.infer<typeof notebaseCreateDataSchema>
-
-export const NotebaseCreateInputSchema = notebaseCreateDataSchema
-export type NotebaseCreateInput = z.infer<typeof NotebaseCreateInputSchema>
+      .optional(),
+  })
+  .strict();
+export type NotebaseCreateData = z.infer<typeof notebaseCreateDataSchema>;
+
+export const NotebaseCreateInputSchema = notebaseCreateDataSchema;
+export type NotebaseCreateInput = z.infer<typeof NotebaseCreateInputSchema>;
 
 export const NotebaseCreateOutputSchema = z.object({
+  notebase: notebaseSchema,
   txid: z.number(),
-})
-export type NotebaseCreateOutput = z.infer<typeof NotebaseCreateOutputSchema>
-
-export const notebaseUpdateDataSchema = z.object({
-  name: z.string().min(1).optional(),
-  srsNewPerDay: schedulingParamsShape.newPerDay.optional(),
-  srsReviewsPerDay: schedulingParamsShape.reviewsPerDay.optional(),
-  srsDesiredRetention: schedulingParamsShape.desiredRetention.optional(),
-}).strict()
-export type NotebaseUpdateData = z.infer<typeof notebaseUpdateDataSchema>
+});
+export type NotebaseCreateOutput = z.infer<typeof NotebaseCreateOutputSchema>;
+
+export const notebaseUpdateDataSchema = z
+  .object({
+    name: z.string().min(1).optional(),
+    srsNewPerDay: schedulingParamsShape.newPerDay.optional(),
+    srsReviewsPerDay: schedulingParamsShape.reviewsPerDay.optional(),
+    srsDesiredRetention: schedulingParamsShape.desiredRetention.optional(),
+  })
+  .strict();
+export type NotebaseUpdateData = z.infer<typeof notebaseUpdateDataSchema>;
 
 export const NotebaseUpdateInputSchema = notebaseUpdateDataSchema.extend({
   id: z.uuid(),
-})
-export type NotebaseUpdateInput = z.infer<typeof NotebaseUpdateInputSchema>
+});
+export type NotebaseUpdateInput = z.infer<typeof NotebaseUpdateInputSchema>;
 
 export const NotebaseUpdateOutputSchema = z.object({
+  notebase: notebaseSchema,
   txid: z.number(),
-})
-export type NotebaseUpdateOutput = z.infer<typeof NotebaseUpdateOutputSchema>
+});
+export type NotebaseUpdateOutput = z.infer<typeof NotebaseUpdateOutputSchema>;
 
 export const NotebaseDeleteInputSchema = z.object({
   id: z.uuid(),
-})
-export type NotebaseDeleteInput = z.infer<typeof NotebaseDeleteInputSchema>
+});
+export type NotebaseDeleteInput = z.infer<typeof NotebaseDeleteInputSchema>;
 
-export const NotebaseDeleteOutputSchema = z.object({
-  txid: z.number(),
-})
-export type NotebaseDeleteOutput = z.infer<typeof NotebaseDeleteOutputSchema>
+export const NotebaseDeleteOutputSchema = deletionResultSchema;
+export type NotebaseDeleteOutput = z.infer<typeof NotebaseDeleteOutputSchema>;
 
 // Get endpoint schemas
 export const NotebaseGetInputSchema = z.object({
   id: z.uuid(),
-})
-export type NotebaseGetInput = z.infer<typeof NotebaseGetInputSchema>
+});
+export type NotebaseGetInput = z.infer<typeof NotebaseGetInputSchema>;
+
+export const NotebaseGetSummaryInputSchema = z.object({
+  id: z.uuid(),
+});
+export type NotebaseGetSummaryInput = z.infer<typeof NotebaseGetSummaryInputSchema>;
+
+export const NotebaseGetSummaryOutputSchema = notebaseSummarySchema.extend({
+  srsNewPerDay: schedulingParamsShape.newPerDay,
+  srsReviewsPerDay: schedulingParamsShape.reviewsPerDay,
+  srsDesiredRetention: schedulingParamsShape.desiredRetention,
+});
+export type NotebaseGetSummaryOutput = z.infer<typeof NotebaseGetSummaryOutputSchema>;
 
 export const NotebaseGetSchemaInputSchema = z.object({
   id: z.uuid(),
-})
-export type NotebaseGetSchemaInput = z.infer<typeof NotebaseGetSchemaInputSchema>
+});
+export type NotebaseGetSchemaInput = z.infer<typeof NotebaseGetSchemaInputSchema>;
 
 export const NotebaseGetOutputSchema = notebaseSchema.extend({
   createdAt: z.coerce.date(),
@@ -138,13 +178,13 @@ export const NotebaseGetOutputSchema = notebaseSchema.extend({
   notebaseColumns: z.array(notebaseColumnSchema),
   notebaseRows: z.array(notebaseRowSchema),
   notebaseViews: z.array(notebaseViewSchema),
-})
-export type NotebaseGetOutput = z.infer<typeof NotebaseGetOutputSchema>
+});
+export type NotebaseGetOutput = z.infer<typeof NotebaseGetOutputSchema>;
 
 export const NotebaseGetSchemaOutputSchema = z.object({
   id: z.string(),
   name: z.string(),
   updatedAt: z.coerce.date(),
   notebaseColumns: z.array(notebaseColumnSchema),
-})
-export type NotebaseGetSchemaOutput = z.infer<typeof NotebaseGetSchemaOutputSchema>
+});
+export type NotebaseGetSchemaOutput = z.infer<typeof NotebaseGetSchemaOutputSchema>;

package/src/schemas/pagination.ts

@@ -0,0 +1,9 @@
+import { z } from "zod";
+export const paginationShape = {
+  // Existing callers omit pagination to read all matching records.
+  limit: z.number().int().min(1).max(500).optional(),
+  offset: z.number().int().min(0).optional(),
+};
+export function pageSchema<T extends z.ZodType>(itemSchema: T) {
+  return z.object({ items: z.array(itemSchema), hasMore: z.boolean() });
+}

package/src/schemas/resource-mutation.ts

@@ -0,0 +1,6 @@
+import { z } from "zod";
+export const expectedUpdatedAtSchema = z.iso.datetime({ offset: true });
+export const deletionResultSchema = z.object({
+  id: z.uuid(),
+  txid: z.number(),
+});

package/src/schemas/srs-stats.ts

@@ -1,26 +1,34 @@
-import { z } from "zod"
+import { z } from "zod";
 
-export const srsActivityStatsItemSchema = z.object({
-  date: z.iso.date(),
-  answers: z.number().int().nonnegative(),
-  durationMs: z.number().int().nonnegative(),
-}).strict()
-export type SrsActivityStatsItem = z.infer<typeof srsActivityStatsItemSchema>
+export const srsActivityStatsItemSchema = z
+  .object({
+    date: z.iso.date(),
+    answers: z.number().int().nonnegative(),
+    durationMs: z.number().int().nonnegative(),
+  })
+  .strict();
+export type SrsActivityStatsItem = z.infer<typeof srsActivityStatsItemSchema>;
 
-export const srsActivityStatsOutputSchema = z.object({
-  learnedCards: z.number().int().nonnegative(),
-  daily: z.array(srsActivityStatsItemSchema),
-}).strict()
-export type SrsActivityStatsOutput = z.infer<typeof srsActivityStatsOutputSchema>
+export const srsActivityStatsOutputSchema = z
+  .object({
+    learnedCards: z.number().int().nonnegative(),
+    daily: z.array(srsActivityStatsItemSchema),
+  })
+  .strict();
+export type SrsActivityStatsOutput = z.infer<typeof srsActivityStatsOutputSchema>;
 
-export const srsMemoryGrowthStatsItemSchema = z.object({
-  date: z.iso.date(),
-  delta: z.number().int(),
-}).strict()
-export type SrsMemoryGrowthStatsItem = z.infer<typeof srsMemoryGrowthStatsItemSchema>
+export const srsMemoryGrowthStatsItemSchema = z
+  .object({
+    date: z.iso.date(),
+    delta: z.number().int(),
+  })
+  .strict();
+export type SrsMemoryGrowthStatsItem = z.infer<typeof srsMemoryGrowthStatsItemSchema>;
 
-export const srsMemoryGrowthStatsOutputSchema = z.object({
-  baseTotal: z.number().int().nonnegative(),
-  daily: z.array(srsMemoryGrowthStatsItemSchema),
-}).strict()
-export type SrsMemoryGrowthStatsOutput = z.infer<typeof srsMemoryGrowthStatsOutputSchema>
+export const srsMemoryGrowthStatsOutputSchema = z
+  .object({
+    baseTotal: z.number().int().nonnegative(),
+    daily: z.array(srsMemoryGrowthStatsItemSchema),
+  })
+  .strict();
+export type SrsMemoryGrowthStatsOutput = z.infer<typeof srsMemoryGrowthStatsOutputSchema>;