@pdfvector/instance-contract 0.0.36 → 0.0.38

package/.tsc/lib/router/admin/get-free-usage-records.d.ts

@@ -14,6 +14,18 @@ export declare const getFreeUsageRecords: import("@orpc/contract").ContractProce
         documentType: z.ZodNullable<z.ZodString>;
         pageCount: z.ZodNullable<z.ZodNumber>;
         error: z.ZodNullable<z.ZodString>;
+        status: z.ZodEnum<{
+            success: "success";
+            user_error: "user_error";
+            system_error: "system_error";
+        }>;
+        errorStage: z.ZodNullable<z.ZodEnum<{
+            auth: "auth";
+            validation: "validation";
+            preprocessing: "preprocessing";
+            processing: "processing";
+        }>>;
+        errorCode: z.ZodNullable<z.ZodString>;
         duration: z.ZodNumber;
         createdAt: z.ZodNumber;
     }, z.core.$strip>>;

package/.tsc/lib/router/admin/get-free-usage-records.js

@@ -1,4 +1,5 @@
 import { oc } from "@orpc/contract";
+import { errorStages, usageStatuses } from "@pdfvector/util";
 import { z } from "zod";
 const freeUsageRecordSchema = z.object({
     id: z.number(),
@@ -11,6 +12,9 @@ const freeUsageRecordSchema = z.object({
     documentType: z.string().nullable(),
     pageCount: z.number().nullable(),
     error: z.string().nullable(),
+    status: z.enum(usageStatuses),
+    errorStage: z.enum(errorStages).nullable(),
+    errorCode: z.string().nullable(),
     duration: z.number(),
     createdAt: z.number(),
 });

package/.tsc/lib/router/admin/get-usage-records.d.ts

@@ -13,6 +13,18 @@ export declare const getUsageRecords: import("@orpc/contract").ContractProcedure
         documentType: z.ZodString;
         documentId: z.ZodNullable<z.ZodString>;
         error: z.ZodNullable<z.ZodString>;
+        status: z.ZodEnum<{
+            success: "success";
+            user_error: "user_error";
+            system_error: "system_error";
+        }>;
+        errorStage: z.ZodNullable<z.ZodEnum<{
+            auth: "auth";
+            validation: "validation";
+            preprocessing: "preprocessing";
+            processing: "processing";
+        }>>;
+        errorCode: z.ZodNullable<z.ZodString>;
         duration: z.ZodNumber;
         operation: z.ZodString;
         pageCount: z.ZodNullable<z.ZodNumber>;

package/.tsc/lib/router/admin/get-usage-records.js

@@ -1,4 +1,5 @@
 import { oc } from "@orpc/contract";
+import { errorStages, usageStatuses } from "@pdfvector/util";
 import { z } from "zod";
 const usageRecordSchema = z.object({
     id: z.number(),
@@ -10,6 +11,9 @@ const usageRecordSchema = z.object({
     documentType: z.string(),
     documentId: z.string().nullable(),
     error: z.string().nullable(),
+    status: z.enum(usageStatuses),
+    errorStage: z.enum(errorStages).nullable(),
+    errorCode: z.string().nullable(),
     duration: z.number(),
     operation: z.string(),
     pageCount: z.number().nullable(),

package/.tsc/lib/router/bankStatement/ask.js

@@ -1,7 +1,7 @@
 import { oc } from "@orpc/contract";
 import { z } from "zod";
 import { pdfvectorModelSchema } from "../../pdfvector-model-schema";
-import { outputAskModelDescription, specializedAskModelDescription, supportedFileFormatsDescription, supportedFileMimes, supportedFileTypesLong, } from "../../supported-mimes";
+import { outputAskModelDescription, specializedAskModelDescription, supportedFileFormatsDescription, supportedFileMimeErrorMessage, supportedFileMimes, supportedFileTypesLong, } from "../../supported-mimes";
 import { getDefaultSpec } from "./get-default-spec";
 const specializedModelSchema = z
     .enum(["auto", ...pdfvectorModelSchema.options])
@@ -13,7 +13,7 @@ const askInputSchema = z.object({
         .describe("URL of the bank statement file to fetch and parse"),
     file: z
         .file()
-        .mime([...supportedFileMimes])
+        .mime([...supportedFileMimes], supportedFileMimeErrorMessage)
         .optional()
         .describe(`Bank statement file upload via multipart form-data (${supportedFileFormatsDescription})`),
     base64: z

package/.tsc/lib/router/bankStatement/extract.js

@@ -1,7 +1,7 @@
 import { oc } from "@orpc/contract";
 import { z } from "zod";
 import { pdfvectorModelSchema } from "../../pdfvector-model-schema";
-import { outputExtractModelDescription, specializedExtractModelDescription, supportedFileFormatsDescription, supportedFileMimes, supportedFileTypesLong, } from "../../supported-mimes";
+import { outputExtractModelDescription, specializedExtractModelDescription, supportedFileFormatsDescription, supportedFileMimeErrorMessage, supportedFileMimes, supportedFileTypesLong, } from "../../supported-mimes";
 import { getDefaultSpec } from "./get-default-spec";
 const specializedModelSchema = z
     .enum(["auto", ...pdfvectorModelSchema.options])
@@ -13,7 +13,7 @@ const extractInputSchema = z.object({
         .describe("URL of the bank statement file to fetch and parse"),
     file: z
         .file()
-        .mime([...supportedFileMimes])
+        .mime([...supportedFileMimes], supportedFileMimeErrorMessage)
         .optional()
         .describe(`Bank statement file upload via multipart form-data (${supportedFileFormatsDescription})`),
     base64: z

package/.tsc/lib/router/bankStatement/parse.js

@@ -1,6 +1,6 @@
 import { oc } from "@orpc/contract";
 import { z } from "zod";
-import { specializedParseModelDescription, supportedFileFormatsDescription, supportedFileMimes, supportedFileTypesLong, } from "../../supported-mimes";
+import { specializedParseModelDescription, supportedFileFormatsDescription, supportedFileMimeErrorMessage, supportedFileMimes, supportedFileTypesLong, } from "../../supported-mimes";
 import { getDefaultSpec } from "./get-default-spec";
 const specializedParseModelSchema = z
     .enum(["pro", "max", "auto"], {
@@ -14,7 +14,7 @@ const parseInputSchema = z.object({
         .describe("URL of the bank statement file to fetch and parse"),
     file: z
         .file()
-        .mime([...supportedFileMimes])
+        .mime([...supportedFileMimes], supportedFileMimeErrorMessage)
         .optional()
         .describe(`Bank statement file upload via multipart form-data (${supportedFileFormatsDescription})`),
     base64: z

package/.tsc/lib/router/document/ask.js

@@ -1,7 +1,7 @@
 import { oc } from "@orpc/contract";
 import { z } from "zod";
 import { pdfvectorModelSchema } from "../../pdfvector-model-schema";
-import { documentAskModelDescription, outputAskModelDescription, supportedFileFormatsDescription, supportedFileMimes, supportedFileTypesLong, } from "../../supported-mimes";
+import { documentAskModelDescription, outputAskModelDescription, supportedFileFormatsDescription, supportedFileMimeErrorMessage, supportedFileMimes, supportedFileTypesLong, } from "../../supported-mimes";
 import { getDefaultSpec } from "./get-default-spec";
 const askInputSchema = z.object({
     url: z
@@ -10,7 +10,7 @@ const askInputSchema = z.object({
         .describe("URL of the document file to fetch and parse"),
     file: z
         .file()
-        .mime([...supportedFileMimes])
+        .mime([...supportedFileMimes], supportedFileMimeErrorMessage)
         .optional()
         .describe(`Document file upload via multipart form-data (${supportedFileFormatsDescription})`),
     base64: z

package/.tsc/lib/router/document/extract.js

@@ -1,7 +1,7 @@
 import { oc } from "@orpc/contract";
 import { z } from "zod";
 import { pdfvectorModelSchema } from "../../pdfvector-model-schema";
-import { documentExtractModelDescription, outputExtractModelDescription, supportedFileFormatsDescription, supportedFileMimes, supportedFileTypesLong, } from "../../supported-mimes";
+import { documentExtractModelDescription, outputExtractModelDescription, supportedFileFormatsDescription, supportedFileMimeErrorMessage, supportedFileMimes, supportedFileTypesLong, } from "../../supported-mimes";
 import { getDefaultSpec } from "./get-default-spec";
 const extractInputSchema = z.object({
     url: z
@@ -10,7 +10,7 @@ const extractInputSchema = z.object({
         .describe("URL of the document file to fetch and parse"),
     file: z
         .file()
-        .mime([...supportedFileMimes])
+        .mime([...supportedFileMimes], supportedFileMimeErrorMessage)
         .optional()
         .describe(`Document file upload via multipart form-data (${supportedFileFormatsDescription})`),
     base64: z

package/.tsc/lib/router/document/parse.js

@@ -1,7 +1,7 @@
 import { oc } from "@orpc/contract";
 import { z } from "zod";
 import { pdfvectorModelSchema } from "../../pdfvector-model-schema";
-import { documentParseModelDescription, outputModelDescription, supportedFileFormatsDescription, supportedFileMimes, supportedFileTypesLong, } from "../../supported-mimes";
+import { documentParseModelDescription, outputModelDescription, supportedFileFormatsDescription, supportedFileMimeErrorMessage, supportedFileMimes, supportedFileTypesLong, } from "../../supported-mimes";
 import { getDefaultSpec } from "./get-default-spec";
 const parseInputSchema = z.object({
     url: z
@@ -10,7 +10,7 @@ const parseInputSchema = z.object({
         .describe("URL of the document file to fetch and parse"),
     file: z
         .file()
-        .mime([...supportedFileMimes])
+        .mime([...supportedFileMimes], supportedFileMimeErrorMessage)
         .optional()
         .describe(`Document file upload via multipart form-data (${supportedFileFormatsDescription})`),
     base64: z

package/.tsc/lib/router/free/bank-statement-parse.js

@@ -1,6 +1,6 @@
 import { oc } from "@orpc/contract";
 import { z } from "zod";
-import { supportedFileFormatsDescription, supportedFileMimes, supportedFileTypesLong, } from "../../supported-mimes";
+import { supportedFileFormatsDescription, supportedFileMimeErrorMessage, supportedFileMimes, supportedFileTypesLong, } from "../../supported-mimes";
 const inputSchema = z.object({
     url: z
         .url()
@@ -8,7 +8,7 @@ const inputSchema = z.object({
         .describe("URL of the bank statement file to fetch and parse"),
     file: z
         .file()
-        .mime([...supportedFileMimes])
+        .mime([...supportedFileMimes], supportedFileMimeErrorMessage)
         .optional()
         .describe(`Bank statement file upload via multipart form-data (${supportedFileFormatsDescription})`),
     base64: z

package/.tsc/lib/router/identity/ask.js

@@ -1,7 +1,7 @@
 import { oc } from "@orpc/contract";
 import { z } from "zod";
 import { pdfvectorModelSchema } from "../../pdfvector-model-schema";
-import { outputAskModelDescription, specializedAskModelDescription, supportedFileFormatsDescription, supportedFileMimes, supportedFileTypesLong, } from "../../supported-mimes";
+import { outputAskModelDescription, specializedAskModelDescription, supportedFileFormatsDescription, supportedFileMimeErrorMessage, supportedFileMimes, supportedFileTypesLong, } from "../../supported-mimes";
 import { getDefaultSpec } from "./get-default-spec";
 const specializedModelSchema = z
     .enum(["auto", ...pdfvectorModelSchema.options])
@@ -13,7 +13,7 @@ const askInputSchema = z.object({
         .describe("URL of the identity document file to fetch and parse"),
     file: z
         .file()
-        .mime([...supportedFileMimes])
+        .mime([...supportedFileMimes], supportedFileMimeErrorMessage)
         .optional()
         .describe(`Identity document file upload via multipart form-data (${supportedFileFormatsDescription})`),
     base64: z

package/.tsc/lib/router/identity/extract.js

@@ -1,7 +1,7 @@
 import { oc } from "@orpc/contract";
 import { z } from "zod";
 import { pdfvectorModelSchema } from "../../pdfvector-model-schema";
-import { outputExtractModelDescription, specializedExtractModelDescription, supportedFileFormatsDescription, supportedFileMimes, supportedFileTypesLong, } from "../../supported-mimes";
+import { outputExtractModelDescription, specializedExtractModelDescription, supportedFileFormatsDescription, supportedFileMimeErrorMessage, supportedFileMimes, supportedFileTypesLong, } from "../../supported-mimes";
 import { getDefaultSpec } from "./get-default-spec";
 const specializedModelSchema = z
     .enum(["auto", ...pdfvectorModelSchema.options])
@@ -13,7 +13,7 @@ const extractInputSchema = z.object({
         .describe("URL of the identity document file to fetch and parse"),
     file: z
         .file()
-        .mime([...supportedFileMimes])
+        .mime([...supportedFileMimes], supportedFileMimeErrorMessage)
         .optional()
         .describe(`Identity document file upload via multipart form-data (${supportedFileFormatsDescription})`),
     base64: z

package/.tsc/lib/router/identity/parse.js

@@ -1,6 +1,6 @@
 import { oc } from "@orpc/contract";
 import { z } from "zod";
-import { specializedParseModelDescription, supportedFileFormatsDescription, supportedFileMimes, supportedFileTypesLong, } from "../../supported-mimes";
+import { specializedParseModelDescription, supportedFileFormatsDescription, supportedFileMimeErrorMessage, supportedFileMimes, supportedFileTypesLong, } from "../../supported-mimes";
 import { getDefaultSpec } from "./get-default-spec";
 const specializedParseModelSchema = z
     .enum(["pro", "max", "auto"], {
@@ -14,7 +14,7 @@ const parseInputSchema = z.object({
         .describe("URL of the identity document file to fetch and parse"),
     file: z
         .file()
-        .mime([...supportedFileMimes])
+        .mime([...supportedFileMimes], supportedFileMimeErrorMessage)
         .optional()
         .describe(`Identity document file upload via multipart form-data (${supportedFileFormatsDescription})`),
     base64: z

package/.tsc/lib/router/invoice/ask.js

@@ -1,7 +1,7 @@
 import { oc } from "@orpc/contract";
 import { z } from "zod";
 import { pdfvectorModelSchema } from "../../pdfvector-model-schema";
-import { outputAskModelDescription, specializedAskModelDescription, supportedFileFormatsDescription, supportedFileMimes, supportedFileTypesLong, } from "../../supported-mimes";
+import { outputAskModelDescription, specializedAskModelDescription, supportedFileFormatsDescription, supportedFileMimeErrorMessage, supportedFileMimes, supportedFileTypesLong, } from "../../supported-mimes";
 import { getDefaultSpec } from "./get-default-spec";
 const specializedModelSchema = z
     .enum(["auto", ...pdfvectorModelSchema.options])
@@ -13,7 +13,7 @@ const askInputSchema = z.object({
         .describe("URL of the invoice file to fetch and parse"),
     file: z
         .file()
-        .mime([...supportedFileMimes])
+        .mime([...supportedFileMimes], supportedFileMimeErrorMessage)
         .optional()
         .describe(`Invoice file upload via multipart form-data (${supportedFileFormatsDescription})`),
     base64: z.string().optional().describe("Base64-encoded invoice file content"),

package/.tsc/lib/router/invoice/extract.js

@@ -1,7 +1,7 @@
 import { oc } from "@orpc/contract";
 import { z } from "zod";
 import { pdfvectorModelSchema } from "../../pdfvector-model-schema";
-import { outputExtractModelDescription, specializedExtractModelDescription, supportedFileFormatsDescription, supportedFileMimes, supportedFileTypesLong, } from "../../supported-mimes";
+import { outputExtractModelDescription, specializedExtractModelDescription, supportedFileFormatsDescription, supportedFileMimeErrorMessage, supportedFileMimes, supportedFileTypesLong, } from "../../supported-mimes";
 import { getDefaultSpec } from "./get-default-spec";
 const specializedModelSchema = z
     .enum(["auto", ...pdfvectorModelSchema.options])
@@ -13,7 +13,7 @@ const extractInputSchema = z.object({
         .describe("URL of the invoice file to fetch and parse"),
     file: z
         .file()
-        .mime([...supportedFileMimes])
+        .mime([...supportedFileMimes], supportedFileMimeErrorMessage)
         .optional()
         .describe(`Invoice file upload via multipart form-data (${supportedFileFormatsDescription})`),
     base64: z.string().optional().describe("Base64-encoded invoice file content"),

package/.tsc/lib/router/invoice/parse.js

@@ -1,6 +1,6 @@
 import { oc } from "@orpc/contract";
 import { z } from "zod";
-import { specializedParseModelDescription, supportedFileFormatsDescription, supportedFileMimes, supportedFileTypesLong, } from "../../supported-mimes";
+import { specializedParseModelDescription, supportedFileFormatsDescription, supportedFileMimeErrorMessage, supportedFileMimes, supportedFileTypesLong, } from "../../supported-mimes";
 import { getDefaultSpec } from "./get-default-spec";
 const specializedParseModelSchema = z
     .enum(["pro", "max", "auto"], {
@@ -14,7 +14,7 @@ const parseInputSchema = z.object({
         .describe("URL of the invoice file to fetch and parse"),
     file: z
         .file()
-        .mime([...supportedFileMimes])
+        .mime([...supportedFileMimes], supportedFileMimeErrorMessage)
         .optional()
         .describe(`Invoice file upload via multipart form-data (${supportedFileFormatsDescription})`),
     base64: z.string().optional().describe("Base64-encoded invoice file content"),

package/.tsc/lib/supported-mimes.d.ts

@@ -4,6 +4,11 @@
  */
 export declare const supportedFileMimes: readonly ["application/pdf", "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", "application/vnd.openxmlformats-officedocument.presentationml.presentation", "text/csv", "application/csv", "image/png", "image/jpeg", "image/tiff", "image/bmp", "image/heif", "image/heic", "text/plain", "text/markdown", "text/tab-separated-values", "text/xml", "application/xml", "application/rtf", "text/rtf", "text/html", "application/epub+zip", "application/vnd.oasis.opendocument.text", "application/vnd.oasis.opendocument.spreadsheet", "application/vnd.oasis.opendocument.presentation", "application/x-bibtex"];
 export declare const supportedFileFormatsDescription = "PDF, DOCX, XLSX, PPTX, CSV, PNG, JPG, TIFF, BMP, HEIF, TXT, MD, TSV, XML, RTF, HTML, ODT, ODS, ODP, EPUB, BIB, RIS, NBIB, ENW";
+/**
+ * Friendly validation error when an uploaded file's MIME type is not supported.
+ * Lists the human-readable extensions instead of raw MIME types.
+ */
+export declare const supportedFileMimeErrorMessage = "file must be a supported format: PDF, DOCX, XLSX, PPTX, CSV, PNG, JPG, TIFF, BMP, HEIF, TXT, MD, TSV, XML, RTF, HTML, ODT, ODS, ODP, EPUB, BIB, RIS, NBIB, ENW";
 /**
  * Human-readable description of supported file types with extensions.
  * Used in route-level API descriptions.

package/.tsc/lib/supported-mimes.js

@@ -40,6 +40,11 @@ export const supportedFileMimes = [
     "application/x-bibtex",
 ];
 export const supportedFileFormatsDescription = allSupportedFormatsShort;
+/**
+ * Friendly validation error when an uploaded file's MIME type is not supported.
+ * Lists the human-readable extensions instead of raw MIME types.
+ */
+export const supportedFileMimeErrorMessage = `file must be a supported format: ${allSupportedFormatsShort}`;
 /**
  * Human-readable description of supported file types with extensions.
  * Used in route-level API descriptions.

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @pdfvector/instance-contract
 
+## 0.0.38
+### Patch Changes
+
+
+
+- [`f715571`](https://github.com/phuctm97/pdfvector/commit/f715571148b5adcee39caa66291bf886e3eac7b6) Thanks [@khanhduyvt0101](https://github.com/khanhduyvt0101)! - Redesign playground and return friendly file upload errors
+
+## 0.0.37
+### Patch Changes
+
+
+
+- [#199](https://github.com/phuctm97/pdfvector/pull/199) [`761547d`](https://github.com/phuctm97/pdfvector/commit/761547db6ad1cf6bd11ea7a1f56b6f4806c72f6a) Thanks [@khanhduyvt0101](https://github.com/khanhduyvt0101)! - Redesign request usage tracking with 3-state taxonomy
+
+- Updated dependencies [[`761547d`](https://github.com/phuctm97/pdfvector/commit/761547db6ad1cf6bd11ea7a1f56b6f4806c72f6a)]:
+  - @pdfvector/util@0.0.19
+
 ## 0.0.36
 ### Patch Changes
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pdfvector/instance-contract",
-  "version": "0.0.36",
+  "version": "0.0.38",
   "type": "module",
   "description": "API contract definitions for PDF Vector instance server",
   "license": "MIT",
@@ -21,7 +21,7 @@
   "main": ".tsc/lib/index.js",
   "dependencies": {
     "@orpc/contract": "^1.13.14",
-    "@pdfvector/util": "0.0.18"
+    "@pdfvector/util": "0.0.19"
   },
   "peerDependencies": {
     "zod": "^4.3.6"