@read-frog/api-contract 0.11.1 → 0.12.0

package/dist/index.js

@@ -1,5 +1,5 @@
 import { eventIterator, oc } from "@orpc/contract";
-import { BETA_FEATURE_KEYS, NOTEBASE_COLUMN_MAX_WIDTH, NOTEBASE_COLUMN_MIN_WIDTH, SRS_REVIEW_DURATION_MS_MAX, activeScheduleStatusSchema, cardIdentityShape, cardMemoryStateShape, cardStateSchema, cardStateSchema as cardStateSchema$1, cardTemplateConfigSchema, fsrsReviewLogSnapshotSchema, getVideoIdFromUrl, notebaseColumnConfigSchema, reviewRatingSchema, scheduleStatusSchema, scheduleStatusSchema as scheduleStatusSchema$1, schedulingParamsSchema, schedulingParamsShape, srsStepSchema, srsWeightsSchema, transcriptSegmentSchema } from "@read-frog/definitions";
+import { BETA_FEATURE_KEYS, EBOOK_ALLOWED_COVER_CONTENT_TYPES, NOTEBASE_COLUMN_MAX_WIDTH, NOTEBASE_COLUMN_MIN_WIDTH, SRS_REVIEW_DURATION_MS_MAX, activeScheduleStatusSchema, cardIdentityShape, cardMemoryStateShape, cardStateSchema, cardStateSchema as cardStateSchema$1, cardTemplateConfigSchema, fsrsReviewLogSnapshotSchema, getVideoIdFromUrl, notebaseColumnConfigSchema, reviewRatingSchema, scheduleStatusSchema, scheduleStatusSchema as scheduleStatusSchema$1, schedulingParamsSchema, schedulingParamsShape, srsStepSchema, srsWeightsSchema, transcriptSegmentSchema } from "@read-frog/definitions";
 import { z } from "zod";
 //#region src/schemas/beta-access.ts
 const BetaFeatureKeySchema = z.enum(BETA_FEATURE_KEYS);
@@ -157,6 +157,26 @@ const PUBLIC_APP_ERROR_DEFS = {
 	CONCURRENT_POSITION_CONFLICT: {
 		message: "Concurrent position conflict, please retry",
 		status: 409
+	},
+	EBOOK_BETA_RESTRICTED: {
+		message: "Ebooks are currently in beta for selected accounts",
+		status: 403
+	},
+	EBOOK_NOT_FOUND: {
+		message: "Ebook not found",
+		status: 404
+	},
+	EBOOK_LIMIT_EXCEEDED: {
+		message: "Upgrade is required to upload more ebooks",
+		status: 403
+	},
+	EBOOK_FILE_TOO_LARGE: {
+		message: "Ebook file exceeds the maximum allowed size",
+		status: 413
+	},
+	EBOOK_UPLOAD_NOT_COMPLETED: {
+		message: "Ebook upload has not been completed",
+		status: 409
 	}
 };
 function isPublicAppErrorCode(code) {
@@ -386,6 +406,129 @@ const cardTemplateContract = {
 	}).input(CardTemplateDeleteInputSchema).output(CardTemplateDeleteOutputSchema)
 };
 //#endregion
+//#region src/schemas/ebook.ts
+const ebookStatusSchema = z.enum(["pending", "ready"]);
+const ebookCoverContentTypeSchema = z.enum(EBOOK_ALLOWED_COVER_CONTENT_TYPES);
+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();
+const ebookDetailSchema = ebookListItemSchema.extend({ progressCfi: z.string().nullable() });
+const ebookQuotaSchema = z.object({
+	count: z.number().int().min(0),
+	limit: z.number().int().min(0)
+}).strict();
+const ebookListInputSchema = z.object({}).strict();
+const ebookListOutputSchema = z.object({
+	items: z.array(ebookListItemSchema),
+	quota: ebookQuotaSchema
+}).strict();
+const ebookGetInputSchema = z.object({ id: z.uuid() }).strict();
+const ebookGetOutputSchema = z.object({ ebook: ebookDetailSchema }).strict();
+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();
+/**
+* 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.
+*/
+const ebookPresignedPostSchema = z.object({
+	url: z.url(),
+	fields: z.record(z.string(), z.string())
+}).strict();
+const ebookRequestUploadOutputSchema = z.object({
+	ebookId: z.uuid(),
+	upload: ebookPresignedPostSchema,
+	coverUpload: ebookPresignedPostSchema.nullable(),
+	expiresAt: z.coerce.date()
+}).strict();
+const ebookFinalizeUploadInputSchema = z.object({ ebookId: z.uuid() }).strict();
+const ebookFinalizeUploadOutputSchema = z.object({ ebook: ebookListItemSchema }).strict();
+const ebookGetDownloadUrlInputSchema = z.object({ id: z.uuid() }).strict();
+const ebookGetDownloadUrlOutputSchema = z.object({
+	url: z.url(),
+	expiresAt: z.coerce.date()
+}).strict();
+const ebookUpdateProgressDataSchema = z.object({
+	cfi: z.string().max(2e3),
+	fraction: z.number().min(0).max(1)
+}).strict();
+const ebookUpdateProgressInputSchema = ebookUpdateProgressDataSchema.extend({ id: z.uuid() });
+const ebookUpdateProgressOutputSchema = z.object({ lastReadAt: z.coerce.date() }).strict();
+const ebookRenameDataSchema = z.object({
+	title: z.string().min(1).max(500),
+	author: z.string().max(500).nullable().optional()
+}).strict();
+const ebookRenameInputSchema = ebookRenameDataSchema.extend({ id: z.uuid() });
+const ebookRenameOutputSchema = z.object({ ebook: ebookListItemSchema }).strict();
+const ebookDeleteInputSchema = z.object({ id: z.uuid() }).strict();
+const ebookDeleteOutputSchema = z.object({ id: z.uuid() }).strict();
+//#endregion
+//#region src/contracts/ebook.ts
+const ebookProcedure = oc;
+const ebookContract = {
+	list: ebookProcedure.errors(pickPublicErrorMap("EBOOK_BETA_RESTRICTED")).route({
+		method: "GET",
+		path: "/ebooks",
+		summary: "List ebooks with quota",
+		tags: ["Ebooks"]
+	}).input(ebookListInputSchema).output(ebookListOutputSchema),
+	get: ebookProcedure.errors(pickPublicErrorMap("EBOOK_BETA_RESTRICTED", "EBOOK_NOT_FOUND")).route({
+		method: "GET",
+		path: "/ebooks/{id}",
+		summary: "Get an ebook with reading progress",
+		tags: ["Ebooks"]
+	}).input(ebookGetInputSchema).output(ebookGetOutputSchema),
+	requestUpload: ebookProcedure.errors(pickPublicErrorMap("EBOOK_BETA_RESTRICTED", "EBOOK_LIMIT_EXCEEDED")).route({
+		method: "POST",
+		path: "/ebooks/uploads",
+		summary: "Request presigned upload URLs for a new ebook",
+		tags: ["Ebooks"]
+	}).input(ebookRequestUploadInputSchema).output(ebookRequestUploadOutputSchema),
+	finalizeUpload: ebookProcedure.errors(pickPublicErrorMap("EBOOK_BETA_RESTRICTED", "EBOOK_NOT_FOUND", "EBOOK_UPLOAD_NOT_COMPLETED", "EBOOK_FILE_TOO_LARGE")).route({
+		method: "POST",
+		path: "/ebooks/{ebookId}/finalize",
+		summary: "Finalize an ebook upload",
+		tags: ["Ebooks"]
+	}).input(ebookFinalizeUploadInputSchema).output(ebookFinalizeUploadOutputSchema),
+	getDownloadUrl: ebookProcedure.errors(pickPublicErrorMap("EBOOK_BETA_RESTRICTED", "EBOOK_NOT_FOUND")).route({
+		method: "GET",
+		path: "/ebooks/{id}/download-url",
+		summary: "Get a presigned download URL for an ebook",
+		tags: ["Ebooks"]
+	}).input(ebookGetDownloadUrlInputSchema).output(ebookGetDownloadUrlOutputSchema),
+	updateProgress: ebookProcedure.errors(pickPublicErrorMap("EBOOK_BETA_RESTRICTED", "EBOOK_NOT_FOUND")).route({
+		method: "PATCH",
+		path: "/ebooks/{id}/progress",
+		summary: "Update ebook reading progress",
+		tags: ["Ebooks"]
+	}).input(ebookUpdateProgressInputSchema).output(ebookUpdateProgressOutputSchema),
+	rename: ebookProcedure.errors(pickPublicErrorMap("EBOOK_BETA_RESTRICTED", "EBOOK_NOT_FOUND")).route({
+		method: "PATCH",
+		path: "/ebooks/{id}",
+		summary: "Rename an ebook",
+		tags: ["Ebooks"]
+	}).input(ebookRenameInputSchema).output(ebookRenameOutputSchema),
+	delete: ebookProcedure.errors(pickPublicErrorMap("EBOOK_BETA_RESTRICTED", "EBOOK_NOT_FOUND")).route({
+		method: "DELETE",
+		path: "/ebooks/{id}",
+		summary: "Delete an ebook",
+		tags: ["Ebooks"]
+	}).input(ebookDeleteInputSchema).output(ebookDeleteOutputSchema)
+};
+//#endregion
 //#region src/schemas/hosted-ai.ts
 const HOSTED_AI_SYSTEM_FALLBACK_REMOVAL_DATE = "2026-07-11";
 const HostedAiOutputFieldTypeSchema = z.enum(["string", "number"]);
@@ -1045,6 +1188,7 @@ const contract = {
 	billing: billingContract,
 	card: cardContract,
 	cardTemplate: cardTemplateContract,
+	ebook: ebookContract,
 	hostedAi: hostedAiContract,
 	notebase: notebaseContract,
 	notebaseColumn: notebaseColumnContract,
@@ -1079,6 +1223,6 @@ const contract = {
 	}
 };
 //#endregion
-export { BetaAccessStatusInputSchema, BetaAccessStatusOutputSchema, BetaFeatureKeySchema, CardGenerateInputSchema, CardGenerateOutputSchema, CardGetInputSchema, CardGetOutputSchema, CardListInputSchema, CardListOutputSchema, CardTemplateCreateInputSchema, CardTemplateCreateOutputSchema, CardTemplateDeleteInputSchema, CardTemplateDeleteOutputSchema, CardTemplateGetInputSchema, CardTemplateGetOutputSchema, CardTemplateInvalidColumnsDataSchema, CardTemplateListInputSchema, CardTemplateListOutputSchema, CardTemplateUpdateInputSchema, CardTemplateUpdateOutputSchema, CellValidationFailedDataSchema, CellValidationFailureDetailsSchema, CellValidationFailureReasonSchema, HOSTED_AI_NOTE_SUGGESTION_MAX_NOTES, HOSTED_AI_NOTE_SUGGESTION_MAX_NOTE_FIELDS, HostedAiNoteSuggestionObjectSchema, HostedAiNoteSuggestionStreamInputSchema, HostedAiOutputFieldSchema, HostedAiOutputFieldTypeSchema, HostedAiStreamPartSchema, HostedAiStreamStructuredObjectInputSchema, HostedAiStreamTextInputSchema, NOTEBASE_ROW_CREATE_MANY_MAX_ROWS, NotebaseColumnCreateInputSchema, NotebaseColumnCreateOutputSchema, NotebaseColumnDeleteInputSchema, NotebaseColumnDeleteOutputSchema, NotebaseColumnReorderInputSchema, NotebaseColumnReorderOutputSchema, NotebaseColumnUpdateInputSchema, NotebaseColumnUpdateOutputSchema, NotebaseCreateInputSchema, NotebaseCreateOutputSchema, NotebaseDeleteInputSchema, NotebaseDeleteOutputSchema, NotebaseGetInputSchema, NotebaseGetOutputSchema, NotebaseGetSchemaInputSchema, NotebaseGetSchemaOutputSchema, NotebaseListInputSchema, NotebaseListItemSchema, NotebaseListOutputSchema, NotebaseRowCreateInputSchema, NotebaseRowCreateManyInputSchema, NotebaseRowCreateManyOutputSchema, NotebaseRowCreateOutputSchema, NotebaseRowDeleteInputSchema, NotebaseRowDeleteOutputSchema, NotebaseRowReorderInputSchema, NotebaseRowReorderOutputSchema, NotebaseRowUpdateInputSchema, NotebaseRowUpdateOutputSchema, NotebaseUpdateInputSchema, NotebaseUpdateOutputSchema, PUBLIC_APP_ERROR_DEFS, SRS_REVIEW_CLIENT_ID_NAMESPACE, SRS_REVIEW_DURATION_MS_MAX, billingAccessSourceSchema, billingCancelScheduledChangeOutputSchema, billingCheckoutPlanSchema, billingCreateCheckoutSessionInputSchema, billingCreateCustomerPortalSessionInputSchema, billingCurrencySchema, billingIntervalSchema, billingLocaleSchema, billingPlanSchema, billingScheduledChangeSchema, billingSessionUrlOutputSchema, billingStatusSchema, billingSubscriptionStatusSchema, cardSchema, cardStateSchema, cardTemplateSchema, contract, createSrsReviewClientId, getPublicErrorDefinition, isPublicAppErrorCode, notebaseColumnCreateDataSchema, notebaseColumnSchema, notebaseColumnUpdateDataSchema, notebaseColumnWidthSchema, notebaseCreateDataSchema, notebaseRowCellsSchema, notebaseRowCreateDataSchema, notebaseRowSchema, notebaseRowUpdateDataSchema, notebaseSchema, notebaseUpdateDataSchema, notebaseViewConfigSchema, notebaseViewCreateDataSchema, notebaseViewFilterSchema, notebaseViewFiltersSchema, notebaseViewSchema, notebaseViewSortSchema, notebaseViewSortsSchema, notebaseViewTypeSchema, notebaseViewUpdateDataSchema, pickPublicErrorMap, renderedCardSchema, reviewRatingSchema, scheduleStatusSchema, schedulingParamsSchema, srsManualCardStatusInputSchema, srsReviewInputSchema, srsReviewOutputSchema, srsRevlogSchema, srsRevlogWithoutSnapshotSchema, srsRollbackReviewInputSchema, srsRollbackReviewOutputSchema, srsScheduleStatusStatsInputSchema, srsScheduleStatusStatsOutputSchema, srsScheduleStatusStatsSchema, srsSetCardBuriedInputSchema, srsSetCardBuriedOutputSchema, srsSetCardSuspendedInputSchema, srsSetCardSuspendedOutputSchema, srsTxidOutputSchema, stepSchema, timezoneSchema, userEnsureTimezoneInputSchema, userEnsureTimezoneOutputSchema, userUpdateTimezoneInputSchema, userUpdateTimezoneOutputSchema, videoTranscriptCreateInputSchema, videoTranscriptGetInputSchema, videoTranscriptResourceSchema, videoTranscriptStatusSchema, videoTranscriptSubtitlesSchema, videoTranscriptUsageSchema };
+export { BetaAccessStatusInputSchema, BetaAccessStatusOutputSchema, BetaFeatureKeySchema, CardGenerateInputSchema, CardGenerateOutputSchema, CardGetInputSchema, CardGetOutputSchema, CardListInputSchema, CardListOutputSchema, CardTemplateCreateInputSchema, CardTemplateCreateOutputSchema, CardTemplateDeleteInputSchema, CardTemplateDeleteOutputSchema, CardTemplateGetInputSchema, CardTemplateGetOutputSchema, CardTemplateInvalidColumnsDataSchema, CardTemplateListInputSchema, CardTemplateListOutputSchema, CardTemplateUpdateInputSchema, CardTemplateUpdateOutputSchema, CellValidationFailedDataSchema, CellValidationFailureDetailsSchema, CellValidationFailureReasonSchema, HOSTED_AI_NOTE_SUGGESTION_MAX_NOTES, HOSTED_AI_NOTE_SUGGESTION_MAX_NOTE_FIELDS, HostedAiNoteSuggestionObjectSchema, HostedAiNoteSuggestionStreamInputSchema, HostedAiOutputFieldSchema, HostedAiOutputFieldTypeSchema, HostedAiStreamPartSchema, HostedAiStreamStructuredObjectInputSchema, HostedAiStreamTextInputSchema, NOTEBASE_ROW_CREATE_MANY_MAX_ROWS, NotebaseColumnCreateInputSchema, NotebaseColumnCreateOutputSchema, NotebaseColumnDeleteInputSchema, NotebaseColumnDeleteOutputSchema, NotebaseColumnReorderInputSchema, NotebaseColumnReorderOutputSchema, NotebaseColumnUpdateInputSchema, NotebaseColumnUpdateOutputSchema, NotebaseCreateInputSchema, NotebaseCreateOutputSchema, NotebaseDeleteInputSchema, NotebaseDeleteOutputSchema, NotebaseGetInputSchema, NotebaseGetOutputSchema, NotebaseGetSchemaInputSchema, NotebaseGetSchemaOutputSchema, NotebaseListInputSchema, NotebaseListItemSchema, NotebaseListOutputSchema, NotebaseRowCreateInputSchema, NotebaseRowCreateManyInputSchema, NotebaseRowCreateManyOutputSchema, NotebaseRowCreateOutputSchema, NotebaseRowDeleteInputSchema, NotebaseRowDeleteOutputSchema, NotebaseRowReorderInputSchema, NotebaseRowReorderOutputSchema, NotebaseRowUpdateInputSchema, NotebaseRowUpdateOutputSchema, NotebaseUpdateInputSchema, NotebaseUpdateOutputSchema, PUBLIC_APP_ERROR_DEFS, SRS_REVIEW_CLIENT_ID_NAMESPACE, SRS_REVIEW_DURATION_MS_MAX, billingAccessSourceSchema, billingCancelScheduledChangeOutputSchema, billingCheckoutPlanSchema, billingCreateCheckoutSessionInputSchema, billingCreateCustomerPortalSessionInputSchema, billingCurrencySchema, billingIntervalSchema, billingLocaleSchema, billingPlanSchema, billingScheduledChangeSchema, billingSessionUrlOutputSchema, billingStatusSchema, billingSubscriptionStatusSchema, cardSchema, cardStateSchema, cardTemplateSchema, contract, createSrsReviewClientId, ebookCoverContentTypeSchema, ebookDeleteInputSchema, ebookDeleteOutputSchema, ebookDetailSchema, ebookFinalizeUploadInputSchema, ebookFinalizeUploadOutputSchema, ebookGetDownloadUrlInputSchema, ebookGetDownloadUrlOutputSchema, ebookGetInputSchema, ebookGetOutputSchema, ebookListInputSchema, ebookListItemSchema, ebookListOutputSchema, ebookPresignedPostSchema, ebookQuotaSchema, ebookRenameDataSchema, ebookRenameInputSchema, ebookRenameOutputSchema, ebookRequestUploadInputSchema, ebookRequestUploadOutputSchema, ebookStatusSchema, ebookUpdateProgressDataSchema, ebookUpdateProgressInputSchema, ebookUpdateProgressOutputSchema, getPublicErrorDefinition, isPublicAppErrorCode, notebaseColumnCreateDataSchema, notebaseColumnSchema, notebaseColumnUpdateDataSchema, notebaseColumnWidthSchema, notebaseCreateDataSchema, notebaseRowCellsSchema, notebaseRowCreateDataSchema, notebaseRowSchema, notebaseRowUpdateDataSchema, notebaseSchema, notebaseUpdateDataSchema, notebaseViewConfigSchema, notebaseViewCreateDataSchema, notebaseViewFilterSchema, notebaseViewFiltersSchema, notebaseViewSchema, notebaseViewSortSchema, notebaseViewSortsSchema, notebaseViewTypeSchema, notebaseViewUpdateDataSchema, pickPublicErrorMap, renderedCardSchema, reviewRatingSchema, scheduleStatusSchema, schedulingParamsSchema, srsManualCardStatusInputSchema, srsReviewInputSchema, srsReviewOutputSchema, srsRevlogSchema, srsRevlogWithoutSnapshotSchema, srsRollbackReviewInputSchema, srsRollbackReviewOutputSchema, srsScheduleStatusStatsInputSchema, srsScheduleStatusStatsOutputSchema, srsScheduleStatusStatsSchema, srsSetCardBuriedInputSchema, srsSetCardBuriedOutputSchema, srsSetCardSuspendedInputSchema, srsSetCardSuspendedOutputSchema, srsTxidOutputSchema, stepSchema, timezoneSchema, userEnsureTimezoneInputSchema, userEnsureTimezoneOutputSchema, userUpdateTimezoneInputSchema, userUpdateTimezoneOutputSchema, videoTranscriptCreateInputSchema, videoTranscriptGetInputSchema, videoTranscriptResourceSchema, videoTranscriptStatusSchema, videoTranscriptSubtitlesSchema, videoTranscriptUsageSchema };
 
 //# sourceMappingURL=index.js.map