@read-frog/api-contract 0.12.6 → 0.15.0

package/src/schemas/ebook.ts

@@ -1,143 +1,179 @@
-import { EBOOK_ALLOWED_COVER_CONTENT_TYPES } from "@read-frog/definitions"
-import { z } from "zod"
-
-export const ebookStatusSchema = z.enum(["pending", "ready"])
-export type EbookStatus = z.infer<typeof ebookStatusSchema>
-
-export const ebookCoverContentTypeSchema = z.enum(EBOOK_ALLOWED_COVER_CONTENT_TYPES)
-export type EbookCoverContentType = z.infer<typeof ebookCoverContentTypeSchema>
-
-export const ebookListItemSchema = z.object({
-  id: z.uuid(),
-  title: z.string(),
-  author: z.string().nullable(),
-  language: z.string().nullable(),
-  fileByteSize: z.number().int(),
-  status: ebookStatusSchema,
-  progressFraction: z.number(),
-  lastReadAt: z.coerce.date().nullable(),
-  coverUrl: z.url().nullable(),
-  createdAt: z.coerce.date(),
-  updatedAt: z.coerce.date(),
-}).strict()
-export type EbookListItem = z.infer<typeof ebookListItemSchema>
+import { EBOOK_ALLOWED_COVER_CONTENT_TYPES } from "@read-frog/definitions";
+import { z } from "zod";
+
+export const ebookStatusSchema = z.enum(["pending", "ready"]);
+export type EbookStatus = z.infer<typeof ebookStatusSchema>;
+
+export const ebookCoverContentTypeSchema = z.enum(EBOOK_ALLOWED_COVER_CONTENT_TYPES);
+export type EbookCoverContentType = z.infer<typeof ebookCoverContentTypeSchema>;
+
+export const ebookListItemSchema = z
+  .object({
+    id: z.uuid(),
+    title: z.string(),
+    author: z.string().nullable(),
+    language: z.string().nullable(),
+    fileByteSize: z.number().int(),
+    status: ebookStatusSchema,
+    progressFraction: z.number(),
+    lastReadAt: z.coerce.date().nullable(),
+    coverUrl: z.url().nullable(),
+    createdAt: z.coerce.date(),
+    updatedAt: z.coerce.date(),
+  })
+  .strict();
+export type EbookListItem = z.infer<typeof ebookListItemSchema>;
 
 export const ebookDetailSchema = ebookListItemSchema.extend({
   progressCfi: z.string().nullable(),
-})
-export type EbookDetail = z.infer<typeof ebookDetailSchema>
-
-export const ebookQuotaSchema = z.object({
-  count: z.number().int().min(0),
-  // 0 is a valid limit: uploading is a paid feature, so free plans get no quota.
-  limit: z.number().int().min(0),
-}).strict()
-export type EbookQuota = z.infer<typeof ebookQuotaSchema>
-
-export const ebookListInputSchema = z.object({}).strict()
-export type EbookListInput = z.infer<typeof ebookListInputSchema>
-
-export const ebookListOutputSchema = z.object({
-  items: z.array(ebookListItemSchema),
-  quota: ebookQuotaSchema,
-}).strict()
-export type EbookListOutput = z.infer<typeof ebookListOutputSchema>
-
-export const ebookGetInputSchema = z.object({
-  id: z.uuid(),
-}).strict()
-export type EbookGetInput = z.infer<typeof ebookGetInputSchema>
-
-export const ebookGetOutputSchema = z.object({
-  ebook: ebookDetailSchema,
-}).strict()
-export type EbookGetOutput = z.infer<typeof ebookGetOutputSchema>
-
-export const ebookRequestUploadInputSchema = z.object({
-  title: z.string().min(1).max(500),
-  author: z.string().max(500).optional(),
-  language: z.string().max(35).optional(),
-  coverContentType: ebookCoverContentTypeSchema.optional(),
-}).strict()
-export type EbookRequestUploadInput = z.infer<typeof ebookRequestUploadInputSchema>
+});
+export type EbookDetail = z.infer<typeof ebookDetailSchema>;
+
+export const ebookQuotaSchema = z
+  .object({
+    count: z.number().int().min(0),
+    // 0 is a valid limit: uploading is a paid feature, so free plans get no quota.
+    limit: z.number().int().min(0),
+  })
+  .strict();
+export type EbookQuota = z.infer<typeof ebookQuotaSchema>;
+
+export const ebookListInputSchema = z.object({}).strict();
+export type EbookListInput = z.infer<typeof ebookListInputSchema>;
+
+export const ebookListOutputSchema = z
+  .object({
+    items: z.array(ebookListItemSchema),
+    quota: ebookQuotaSchema,
+  })
+  .strict();
+export type EbookListOutput = z.infer<typeof ebookListOutputSchema>;
+
+export const ebookGetInputSchema = z
+  .object({
+    id: z.uuid(),
+  })
+  .strict();
+export type EbookGetInput = z.infer<typeof ebookGetInputSchema>;
+
+export const ebookGetOutputSchema = z
+  .object({
+    ebook: ebookDetailSchema,
+  })
+  .strict();
+export type EbookGetOutput = z.infer<typeof ebookGetOutputSchema>;
+
+export const ebookRequestUploadInputSchema = z
+  .object({
+    title: z.string().min(1).max(500),
+    author: z.string().max(500).optional(),
+    language: z.string().max(35).optional(),
+    coverContentType: ebookCoverContentTypeSchema.optional(),
+  })
+  .strict();
+export type EbookRequestUploadInput = z.infer<typeof ebookRequestUploadInputSchema>;
 
 /**
  * S3 POST form policy. `fields` must be appended to the form in iteration order
  * with the file last; S3 ignores anything sent after the `file` part.
  */
-export const ebookPresignedPostSchema = z.object({
-  url: z.url(),
-  fields: z.record(z.string(), z.string()),
-}).strict()
-export type EbookPresignedPost = z.infer<typeof ebookPresignedPostSchema>
-
-export const ebookRequestUploadOutputSchema = z.object({
-  ebookId: z.uuid(),
-  upload: ebookPresignedPostSchema,
-  coverUpload: ebookPresignedPostSchema.nullable(),
-  expiresAt: z.coerce.date(),
-}).strict()
-export type EbookRequestUploadOutput = z.infer<typeof ebookRequestUploadOutputSchema>
-
-export const ebookFinalizeUploadInputSchema = z.object({
-  ebookId: z.uuid(),
-}).strict()
-export type EbookFinalizeUploadInput = z.infer<typeof ebookFinalizeUploadInputSchema>
-
-export const ebookFinalizeUploadOutputSchema = z.object({
-  ebook: ebookListItemSchema,
-}).strict()
-export type EbookFinalizeUploadOutput = z.infer<typeof ebookFinalizeUploadOutputSchema>
-
-export const ebookGetDownloadUrlInputSchema = z.object({
-  id: z.uuid(),
-}).strict()
-export type EbookGetDownloadUrlInput = z.infer<typeof ebookGetDownloadUrlInputSchema>
-
-export const ebookGetDownloadUrlOutputSchema = z.object({
-  url: z.url(),
-  expiresAt: z.coerce.date(),
-}).strict()
-export type EbookGetDownloadUrlOutput = z.infer<typeof ebookGetDownloadUrlOutputSchema>
-
-export const ebookUpdateProgressDataSchema = z.object({
-  cfi: z.string().max(2000),
-  fraction: z.number().min(0).max(1),
-}).strict()
-export type EbookUpdateProgressData = z.infer<typeof ebookUpdateProgressDataSchema>
+export const ebookPresignedPostSchema = z
+  .object({
+    url: z.url(),
+    fields: z.record(z.string(), z.string()),
+  })
+  .strict();
+export type EbookPresignedPost = z.infer<typeof ebookPresignedPostSchema>;
+
+export const ebookRequestUploadOutputSchema = z
+  .object({
+    ebookId: z.uuid(),
+    upload: ebookPresignedPostSchema,
+    coverUpload: ebookPresignedPostSchema.nullable(),
+    expiresAt: z.coerce.date(),
+  })
+  .strict();
+export type EbookRequestUploadOutput = z.infer<typeof ebookRequestUploadOutputSchema>;
+
+export const ebookFinalizeUploadInputSchema = z
+  .object({
+    ebookId: z.uuid(),
+  })
+  .strict();
+export type EbookFinalizeUploadInput = z.infer<typeof ebookFinalizeUploadInputSchema>;
+
+export const ebookFinalizeUploadOutputSchema = z
+  .object({
+    ebook: ebookListItemSchema,
+  })
+  .strict();
+export type EbookFinalizeUploadOutput = z.infer<typeof ebookFinalizeUploadOutputSchema>;
+
+export const ebookGetDownloadUrlInputSchema = z
+  .object({
+    id: z.uuid(),
+  })
+  .strict();
+export type EbookGetDownloadUrlInput = z.infer<typeof ebookGetDownloadUrlInputSchema>;
+
+export const ebookGetDownloadUrlOutputSchema = z
+  .object({
+    url: z.url(),
+    expiresAt: z.coerce.date(),
+  })
+  .strict();
+export type EbookGetDownloadUrlOutput = z.infer<typeof ebookGetDownloadUrlOutputSchema>;
+
+export const ebookUpdateProgressDataSchema = z
+  .object({
+    cfi: z.string().max(2000),
+    fraction: z.number().min(0).max(1),
+  })
+  .strict();
+export type EbookUpdateProgressData = z.infer<typeof ebookUpdateProgressDataSchema>;
 
 export const ebookUpdateProgressInputSchema = ebookUpdateProgressDataSchema.extend({
   id: z.uuid(),
-})
-export type EbookUpdateProgressInput = z.infer<typeof ebookUpdateProgressInputSchema>
-
-export const ebookUpdateProgressOutputSchema = z.object({
-  lastReadAt: z.coerce.date(),
-}).strict()
-export type EbookUpdateProgressOutput = z.infer<typeof ebookUpdateProgressOutputSchema>
-
-export const ebookRenameDataSchema = z.object({
-  title: z.string().min(1).max(500),
-  author: z.string().max(500).nullable().optional(),
-}).strict()
-export type EbookRenameData = z.infer<typeof ebookRenameDataSchema>
+});
+export type EbookUpdateProgressInput = z.infer<typeof ebookUpdateProgressInputSchema>;
+
+export const ebookUpdateProgressOutputSchema = z
+  .object({
+    lastReadAt: z.coerce.date(),
+  })
+  .strict();
+export type EbookUpdateProgressOutput = z.infer<typeof ebookUpdateProgressOutputSchema>;
+
+export const ebookRenameDataSchema = z
+  .object({
+    title: z.string().min(1).max(500),
+    author: z.string().max(500).nullable().optional(),
+  })
+  .strict();
+export type EbookRenameData = z.infer<typeof ebookRenameDataSchema>;
 
 export const ebookRenameInputSchema = ebookRenameDataSchema.extend({
   id: z.uuid(),
-})
-export type EbookRenameInput = z.infer<typeof ebookRenameInputSchema>
-
-export const ebookRenameOutputSchema = z.object({
-  ebook: ebookListItemSchema,
-}).strict()
-export type EbookRenameOutput = z.infer<typeof ebookRenameOutputSchema>
-
-export const ebookDeleteInputSchema = z.object({
-  id: z.uuid(),
-}).strict()
-export type EbookDeleteInput = z.infer<typeof ebookDeleteInputSchema>
-
-export const ebookDeleteOutputSchema = z.object({
-  id: z.uuid(),
-}).strict()
-export type EbookDeleteOutput = z.infer<typeof ebookDeleteOutputSchema>
+});
+export type EbookRenameInput = z.infer<typeof ebookRenameInputSchema>;
+
+export const ebookRenameOutputSchema = z
+  .object({
+    ebook: ebookListItemSchema,
+  })
+  .strict();
+export type EbookRenameOutput = z.infer<typeof ebookRenameOutputSchema>;
+
+export const ebookDeleteInputSchema = z
+  .object({
+    id: z.uuid(),
+  })
+  .strict();
+export type EbookDeleteInput = z.infer<typeof ebookDeleteInputSchema>;
+
+export const ebookDeleteOutputSchema = z
+  .object({
+    id: z.uuid(),
+  })
+  .strict();
+export type EbookDeleteOutput = z.infer<typeof ebookDeleteOutputSchema>;

package/src/schemas/hosted-ai.ts

@@ -1,20 +1,20 @@
-import { z } from "zod"
+import { z } from "zod";
 
-export const HostedAiOutputFieldTypeSchema = z.enum(["string", "number"])
+export const HostedAiOutputFieldTypeSchema = z.enum(["string", "number"]);
 
 export const HostedAiOutputFieldSchema = z.strictObject({
   name: z.string().trim().min(1).max(80),
   type: HostedAiOutputFieldTypeSchema,
-})
+});
 
-const HostedAiInstructionsSchema = z.string().trim().min(1).max(16000)
+const HostedAiInstructionsSchema = z.string().trim().min(1).max(16000);
 
 /**
  * Which hosted model a request runs on. Deliberately NOT named after a billing
  * plan: which plans may reach which tier is policy (see `access-policy.ts`),
  * not identity, so a future plan can be sold with any tier without a rename.
  */
-export const HostedAiModelTierSchema = z.enum(["normal", "advance"])
+export const HostedAiModelTierSchema = z.enum(["normal", "advance"]);
 /**
  * The billing/access subject of a hosted request, not a route id. Sub-calls
  * bill against the feature they serve: the page summary is `pageTranslation`,
@@ -31,8 +31,8 @@ export const HostedAiFeatureSchema = z.enum([
   "videoSubtitles",
   "inputTranslation",
   "languageDetection",
-])
-export const HostedAiRequestIdSchema = z.uuid()
+]);
+export const HostedAiRequestIdSchema = z.uuid();
 
 const HostedAiRequestMetadataSchema = {
   /**
@@ -47,47 +47,49 @@ const HostedAiRequestMetadataSchema = {
    */
   modelTier: HostedAiModelTierSchema.default("normal"),
   requestId: HostedAiRequestIdSchema.optional(),
-}
+};
 
 export const HostedAiStreamTextInputSchema = z.strictObject({
   ...HostedAiRequestMetadataSchema,
   instructions: HostedAiInstructionsSchema,
   prompt: z.string().trim().min(1).max(32000),
   temperature: z.number().min(0).max(2).optional(),
-})
+});
 
-export const HostedAiStreamStructuredObjectInputSchema = z.strictObject({
-  ...HostedAiRequestMetadataSchema,
-  instructions: HostedAiInstructionsSchema,
-  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) => {
-  const fieldNames = new Set<string>()
+export const HostedAiStreamStructuredObjectInputSchema = z
+  .strictObject({
+    ...HostedAiRequestMetadataSchema,
+    instructions: HostedAiInstructionsSchema,
+    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) => {
+    const fieldNames = new Set<string>();
 
-  input.outputSchema.forEach((field, index) => {
-    if (fieldNames.has(field.name)) {
-      ctx.addIssue({
-        code: "custom",
-        message: `Duplicate output schema name "${field.name}".`,
-        path: ["outputSchema", index, "name"],
-      })
-      return
-    }
+    input.outputSchema.forEach((field, index) => {
+      if (fieldNames.has(field.name)) {
+        ctx.addIssue({
+          code: "custom",
+          message: `Duplicate output schema name "${field.name}".`,
+          path: ["outputSchema", index, "name"],
+        });
+        return;
+      }
 
-    fieldNames.add(field.name)
-  })
-})
+      fieldNames.add(field.name);
+    });
+  });
 
-export const HOSTED_AI_NOTE_SUGGESTION_MAX_NOTES = 2
-export const HOSTED_AI_NOTE_SUGGESTION_MAX_NOTE_FIELDS = 16
+export const HOSTED_AI_NOTE_SUGGESTION_MAX_NOTES = 2;
+export const HOSTED_AI_NOTE_SUGGESTION_MAX_NOTE_FIELDS = 16;
 
 export const HostedAiNoteSuggestionStreamInputSchema = z.strictObject({
   ...HostedAiRequestMetadataSchema,
   instructions: HostedAiInstructionsSchema,
   prompt: z.string().trim().min(1).max(32000),
   temperature: z.number().min(0).max(2).optional(),
-})
+});
 
 /**
  * Fixed structured-output schema for hosted note suggestions. Must stay
@@ -109,21 +111,25 @@ export const HostedAiNoteSuggestionObjectSchema = z.strictObject({
      */
     summaryFieldName: z.string().max(80).nullable(),
   }),
-  notes: z.array(
-    z.strictObject({
-      fields: z.array(
-        z.strictObject({
-          name: z.string().max(80),
-          value: z.union([z.string(), z.number()]).nullable(),
-        }),
-      ).max(HOSTED_AI_NOTE_SUGGESTION_MAX_NOTE_FIELDS),
-    }),
-  ).max(HOSTED_AI_NOTE_SUGGESTION_MAX_NOTES),
-})
+  notes: z
+    .array(
+      z.strictObject({
+        fields: z
+          .array(
+            z.strictObject({
+              name: z.string().max(80),
+              value: z.union([z.string(), z.number()]).nullable(),
+            }),
+          )
+          .max(HOSTED_AI_NOTE_SUGGESTION_MAX_NOTE_FIELDS),
+      }),
+    )
+    .max(HOSTED_AI_NOTE_SUGGESTION_MAX_NOTES),
+});
 
 export const HostedAiStreamPartSchema = z.looseObject({
   type: z.string().trim().min(1),
-})
+});
 
 /**
  * The only stream part types this API emits. Every other part the AI SDK
@@ -143,7 +149,7 @@ export const HOSTED_AI_CLIENT_STREAM_PART_TYPES = [
   "reasoning-end",
   "reasoning-file",
   "finish",
-] as const
+] as const;
 
 /**
  * Status is per-identity, not per-feature: one call reports every feature and
@@ -151,25 +157,25 @@ export const HOSTED_AI_CLIENT_STREAM_PART_TYPES = [
  * Non-strict so a client still sending the retired `feature` argument gets a
  * useful response rather than a validation error.
  */
-export const HostedAiStatusInputSchema = z.object({})
+export const HostedAiStatusInputSchema = z.object({});
 
 export const HostedAiUnavailableReasonSchema = z.enum([
   "authentication_required",
   "ultra_required",
   "quota_exhausted",
   "service_unavailable",
-])
+]);
 
 export const HostedAiCreditPolicyIdSchema = z.enum([
   "custom-action-guest-daily-v1",
   "custom-action-user-daily-v1",
   "custom-action-pro-daily-v1",
   "ultra-weekly-v1",
-])
+]);
 
-export const HostedAiCreditPeriodKindSchema = z.enum(["daily", "weekly"])
+export const HostedAiCreditPeriodKindSchema = z.enum(["daily", "weekly"]);
 
-export const HostedAiQuotaScopeSchema = z.enum(["guest", "user"])
+export const HostedAiQuotaScopeSchema = z.enum(["guest", "user"]);
 
 /**
  * Data payload of the TOO_MANY_REQUESTS error every hosted AI guard emits.
@@ -187,7 +193,7 @@ export const HostedAiQuotaScopeSchema = z.enum(["guest", "user"])
 export const HostedAiRateLimitErrorDataSchema = z.object({
   retryAfterMs: z.number().int().min(0),
   quotaScope: HostedAiQuotaScopeSchema,
-})
+});
 
 /**
  * Deliberately free of dollar amounts and of the versioned policy id. Clients
@@ -206,7 +212,7 @@ export const HostedAiCreditStatusSchema = z.strictObject({
    * a client can tell one shared pool from several separate ones.
    */
   features: z.array(HostedAiFeatureSchema).min(1),
-})
+});
 
 export const HostedAiTierStatusSchema = z.strictObject({
   accessAllowed: z.boolean(),
@@ -220,12 +226,12 @@ export const HostedAiTierStatusSchema = z.strictObject({
    */
   requiresUltra: z.boolean(),
   modelRevision: z.string().trim().min(1),
-})
+});
 
 export const HostedAiFeatureStatusSchema = z.strictObject({
   normal: HostedAiTierStatusSchema,
   advance: HostedAiTierStatusSchema,
-})
+});
 
 export const HostedAiStatusOutputSchema = z.strictObject({
   credits: z.array(HostedAiCreditStatusSchema),
@@ -238,24 +244,28 @@ export const HostedAiStatusOutputSchema = z.strictObject({
     inputTranslation: HostedAiFeatureStatusSchema,
     languageDetection: HostedAiFeatureStatusSchema,
   }),
-})
+});
 
-export type HostedAiOutputFieldType = z.infer<typeof HostedAiOutputFieldTypeSchema>
-export type HostedAiOutputField = z.infer<typeof HostedAiOutputFieldSchema>
-export type HostedAiModelTier = z.infer<typeof HostedAiModelTierSchema>
-export type HostedAiFeature = z.infer<typeof HostedAiFeatureSchema>
-export type HostedAiStreamTextInput = z.infer<typeof HostedAiStreamTextInputSchema>
-export type HostedAiStreamStructuredObjectInput = z.infer<typeof HostedAiStreamStructuredObjectInputSchema>
-export type HostedAiNoteSuggestionStreamInput = z.infer<typeof HostedAiNoteSuggestionStreamInputSchema>
-export type HostedAiNoteSuggestionObject = z.infer<typeof HostedAiNoteSuggestionObjectSchema>
-export type HostedAiStreamPart = z.infer<typeof HostedAiStreamPartSchema>
-export type HostedAiStatusInput = z.infer<typeof HostedAiStatusInputSchema>
-export type HostedAiUnavailableReason = z.infer<typeof HostedAiUnavailableReasonSchema>
-export type HostedAiCreditPolicyId = z.infer<typeof HostedAiCreditPolicyIdSchema>
-export type HostedAiCreditPeriodKind = z.infer<typeof HostedAiCreditPeriodKindSchema>
-export type HostedAiQuotaScope = z.infer<typeof HostedAiQuotaScopeSchema>
-export type HostedAiRateLimitErrorData = z.infer<typeof HostedAiRateLimitErrorDataSchema>
-export type HostedAiCreditStatus = z.infer<typeof HostedAiCreditStatusSchema>
-export type HostedAiTierStatus = z.infer<typeof HostedAiTierStatusSchema>
-export type HostedAiFeatureStatus = z.infer<typeof HostedAiFeatureStatusSchema>
-export type HostedAiStatusOutput = z.infer<typeof HostedAiStatusOutputSchema>
+export type HostedAiOutputFieldType = z.infer<typeof HostedAiOutputFieldTypeSchema>;
+export type HostedAiOutputField = z.infer<typeof HostedAiOutputFieldSchema>;
+export type HostedAiModelTier = z.infer<typeof HostedAiModelTierSchema>;
+export type HostedAiFeature = z.infer<typeof HostedAiFeatureSchema>;
+export type HostedAiStreamTextInput = z.infer<typeof HostedAiStreamTextInputSchema>;
+export type HostedAiStreamStructuredObjectInput = z.infer<
+  typeof HostedAiStreamStructuredObjectInputSchema
+>;
+export type HostedAiNoteSuggestionStreamInput = z.infer<
+  typeof HostedAiNoteSuggestionStreamInputSchema
+>;
+export type HostedAiNoteSuggestionObject = z.infer<typeof HostedAiNoteSuggestionObjectSchema>;
+export type HostedAiStreamPart = z.infer<typeof HostedAiStreamPartSchema>;
+export type HostedAiStatusInput = z.infer<typeof HostedAiStatusInputSchema>;
+export type HostedAiUnavailableReason = z.infer<typeof HostedAiUnavailableReasonSchema>;
+export type HostedAiCreditPolicyId = z.infer<typeof HostedAiCreditPolicyIdSchema>;
+export type HostedAiCreditPeriodKind = z.infer<typeof HostedAiCreditPeriodKindSchema>;
+export type HostedAiQuotaScope = z.infer<typeof HostedAiQuotaScopeSchema>;
+export type HostedAiRateLimitErrorData = z.infer<typeof HostedAiRateLimitErrorDataSchema>;
+export type HostedAiCreditStatus = z.infer<typeof HostedAiCreditStatusSchema>;
+export type HostedAiTierStatus = z.infer<typeof HostedAiTierStatusSchema>;
+export type HostedAiFeatureStatus = z.infer<typeof HostedAiFeatureStatusSchema>;
+export type HostedAiStatusOutput = z.infer<typeof HostedAiStatusOutputSchema>;