@read-frog/api-contract 0.8.0 → 0.9.0

package/src/public-errors.ts

@@ -70,6 +70,18 @@ export const PUBLIC_APP_ERROR_DEFS = {
     message: "Notebase column is used by a card template",
     status: 409,
   },
+  NOTE_LIMIT_EXCEEDED: {
+    message: "Upgrade is required to create more Notebase notes",
+    status: 403,
+  },
+  BILLING_NOT_CONFIGURED: {
+    message: "Billing is not configured",
+    status: 503,
+  },
+  BILLING_CUSTOMER_NOT_FOUND: {
+    message: "Billing customer not found",
+    status: 404,
+  },
   CARD_NOT_REVIEWABLE: {
     message: "Card cannot be reviewed in its current state",
     status: 409,

package/src/schemas/billing.ts

@@ -0,0 +1,41 @@
+import { z } from "zod"
+
+export const billingIntervalSchema = z.enum(["month", "year"])
+export type BillingInterval = z.infer<typeof billingIntervalSchema>
+
+export const billingSubscriptionStatusSchema = z.enum([
+  "incomplete",
+  "incomplete_expired",
+  "trialing",
+  "active",
+  "past_due",
+  "canceled",
+  "unpaid",
+  "paused",
+])
+export type BillingSubscriptionStatus = z.infer<typeof billingSubscriptionStatusSchema>
+
+export const billingPlanSchema = z.enum(["free", "pro"])
+export type BillingPlan = z.infer<typeof billingPlanSchema>
+
+export const billingStatusSchema = z.object({
+  plan: billingPlanSchema,
+  status: billingSubscriptionStatusSchema.nullable(),
+  interval: billingIntervalSchema.nullable(),
+  currentPeriodEnd: z.coerce.date().nullable(),
+  cancelAtPeriodEnd: z.boolean(),
+  unlimitedNotebaseNotes: z.boolean(),
+  notebaseNoteLimit: z.number().int().positive(),
+  notebaseNoteCount: z.number().int().min(0),
+}).strict()
+export type BillingStatus = z.infer<typeof billingStatusSchema>
+
+export const billingCreateCheckoutSessionInputSchema = z.object({
+  interval: billingIntervalSchema,
+}).strict()
+export type BillingCreateCheckoutSessionInput = z.infer<typeof billingCreateCheckoutSessionInputSchema>
+
+export const billingSessionUrlOutputSchema = z.object({
+  url: z.url(),
+}).strict()
+export type BillingSessionUrlOutput = z.infer<typeof billingSessionUrlOutputSchema>

package/src/schemas/hosted-ai.ts

@@ -1,5 +1,8 @@
+import type { RefinementCtx } from "zod"
 import { z } from "zod"
 
+const HOSTED_AI_SYSTEM_FALLBACK_REMOVAL_DATE = "2026-07-11"
+
 export const HostedAiOutputFieldTypeSchema = z.enum(["string", "number"])
 
 export const HostedAiOutputFieldSchema = z.strictObject({
@@ -7,18 +10,44 @@ export const HostedAiOutputFieldSchema = z.strictObject({
   type: HostedAiOutputFieldTypeSchema,
 })
 
+const HostedAiInstructionsSchema = z.string().trim().min(1).max(16000)
+
+interface HostedAiInstructionsCompatibilityInput {
+  instructions?: string
+  system?: string
+}
+
+function validateHostedAiInstructionsCompatibility(
+  input: HostedAiInstructionsCompatibilityInput,
+  ctx: RefinementCtx<HostedAiInstructionsCompatibilityInput>,
+): void {
+  if (input.instructions !== undefined || input.system !== undefined) {
+    return
+  }
+
+  ctx.addIssue({
+    code: "custom",
+    message: `instructions is required. The deprecated system field is accepted as a temporary fallback until ${HOSTED_AI_SYSTEM_FALLBACK_REMOVAL_DATE}.`,
+    path: ["instructions"],
+  })
+}
+
 export const HostedAiStreamTextInputSchema = z.strictObject({
-  system: z.string().trim().min(1).max(16000),
+  instructions: HostedAiInstructionsSchema.optional(),
+  system: HostedAiInstructionsSchema.optional(),
   prompt: z.string().trim().min(1).max(32000),
   temperature: z.number().min(0).max(2).optional(),
-})
+}).superRefine(validateHostedAiInstructionsCompatibility)
 
 export const HostedAiStreamStructuredObjectInputSchema = z.strictObject({
-  system: z.string().trim().min(1).max(16000),
+  instructions: HostedAiInstructionsSchema.optional(),
+  system: HostedAiInstructionsSchema.optional(),
   prompt: z.string().trim().min(1).max(32000),
   outputSchema: z.array(HostedAiOutputFieldSchema).min(1).max(32),
   temperature: z.number().min(0).max(2).optional(),
 }).superRefine((input, ctx) => {
+  validateHostedAiInstructionsCompatibility(input, ctx)
+
   const fieldNames = new Set<string>()
 
   input.outputSchema.forEach((field, index) => {