@pdfvector/instance-contract 0.0.20 → 0.0.22

package/.tsc/lib/router/free/bank-statement-parse.d.ts

@@ -0,0 +1,15 @@
+import { z } from "zod";
+export declare const bankStatementParse: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
+    url: z.ZodOptional<z.ZodURL>;
+    file: z.ZodOptional<z.ZodFile>;
+    base64: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>, z.ZodObject<{
+    markdown: z.ZodString;
+    pageCount: z.ZodNumber;
+    model: z.ZodEnum<{
+        pro: "pro";
+        max: "max";
+    }>;
+    requestId: z.ZodNumber;
+    html: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>, Record<never, never>, Record<never, never>>;

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

@@ -0,0 +1,94 @@
+import { oc } from "@orpc/contract";
+import { z } from "zod";
+const inputSchema = z.object({
+    url: z
+        .url()
+        .optional()
+        .describe("URL of the bank statement file to fetch and parse"),
+    file: z
+        .file()
+        .mime([
+        "application/pdf",
+        "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
+        "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
+        "text/csv",
+        "application/csv",
+        "image/png",
+        "image/jpeg",
+    ])
+        .optional()
+        .describe("Bank statement file upload via multipart form-data (PDF, DOCX, XLSX, CSV, PNG, JPG)"),
+    base64: z
+        .string()
+        .optional()
+        .describe("Base64-encoded bank statement file content"),
+});
+const outputSchema = z.object({
+    markdown: z
+        .string()
+        .describe("Extracted text content from the bank statement"),
+    pageCount: z.number().int().describe("Total number of pages in the document"),
+    model: z
+        .enum(["pro", "max"])
+        .describe("Model tier used to parse the bank statement"),
+    requestId: z
+        .number()
+        .int()
+        .describe("Unique request identifier for this API call"),
+    html: z
+        .string()
+        .optional()
+        .describe("Full HTML representation of the document content"),
+});
+const requestExamples = {
+    "Parse from URL": {
+        summary: "Parse from URL",
+        value: {
+            url: "https://raw.githubusercontent.com/aws-samples/textract-bank-statement-processor/main/Statement20230428.pdf",
+        },
+    },
+    "Parse from base64": {
+        summary: "Parse from base64",
+        value: {
+            base64: "JVBERi0xLjAKMSAwIG9iajw8L1R5cGUvQ2F0YWxvZy9QYWdlcyAyIDAgUj4+ZW5kb2JqIDIgMCBvYmo8PC9UeXBlL1BhZ2VzL0tpZHNbMyAwIFJdL0NvdW50IDE+PmVuZG9iaiAzIDAgb2JqPDwvVHlwZS9QYWdlL01lZGlhQm94WzAgMCAzIDNdL1BhcmVudCAyIDAgUj4+ZW5kb2JqCnhyZWYKMCA0CjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDAwOSAwMDAwMCBuIAowMDAwMDAwMDU4IDAwMDAwIG4gCjAwMDAwMDAxMTUgMDAwMDAgbiAKdHJhaWxlcjw8L1NpemUgNC9Sb290IDEgMCBSPj4Kc3RhcnR4cmVmCjE5MAolJUVPRg==",
+        },
+    },
+    "Parse from file upload": {
+        summary: "Parse from file upload",
+        value: {
+            file: "(binary)",
+        },
+    },
+};
+const responseExample = {
+    markdown: "## Bank Statement\n\n### Account Information\n\n| Field | Value |\n|-------|-------|\n| Bank Name | Example Bank |\n| Account Number | ****1234 |\n| Statement Start Date | 2023-03-01 |\n| Statement End Date | 2023-03-31 |\n| Beginning Balance | $5,432.10 |\n| Ending Balance | $4,891.55 |\n\n### Transactions\n\n| Date | Description | Deposit Amount | Withdrawal Amount |\n| --- | --- | --- | --- |\n| 2023-03-05 | Direct Deposit - Payroll | $3,200.00 | |\n| 2023-03-08 | Online Transfer Out | | $500.00 |\n| 2023-03-15 | Grocery Store | | $142.35 |",
+    pageCount: 2,
+    model: "max",
+    requestId: 42,
+    html: "<p>Full HTML content...</p>",
+};
+export const bankStatementParse = oc
+    .route({
+    summary: "Free: Parse a bank statement",
+    description: "Extract text and structured data from a bank statement. Supports PDF, Word, Excel, CSV, and Image files. Free tier: max 5 pages, max 5 MB. Rate limited to 5 requests per IP per day.",
+    tags: ["Free"],
+    spec: (op) => {
+        op.security = [];
+        const reqBody = op.requestBody;
+        if (reqBody?.content) {
+            for (const mediaType of Object.values(reqBody.content)) {
+                mediaType.examples = requestExamples;
+            }
+        }
+        const responses = op.responses;
+        const okResponse = responses?.["200"];
+        if (okResponse?.content) {
+            for (const mediaType of Object.values(okResponse.content)) {
+                mediaType.example = responseExample;
+            }
+        }
+        return op;
+    },
+})
+    .input(inputSchema)
+    .output(outputSchema);

package/.tsc/lib/router/free/generate-schema.d.ts

@@ -0,0 +1,7 @@
+import { z } from "zod";
+export declare const generateSchema: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
+    instruction: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    requestId: z.ZodNumber;
+}, z.core.$strip>, Record<never, never>, Record<never, never>>;

package/.tsc/lib/router/free/generate-schema.js

@@ -0,0 +1,110 @@
+import { oc } from "@orpc/contract";
+import { z } from "zod";
+const inputSchema = z.object({
+    instruction: z
+        .string()
+        .min(10, "Instruction must be at least 10 characters")
+        .max(2000, "Instruction must be at most 2000 characters")
+        .describe("Describe the data you want to extract, e.g. 'Extract vendor name, total amount, and line items from an invoice'"),
+});
+const outputSchema = z.object({
+    schema: z
+        .record(z.string(), z.unknown())
+        .describe("Generated JSON Schema for structured data extraction"),
+    requestId: z
+        .number()
+        .int()
+        .describe("Unique request identifier for this API call"),
+});
+const requestExamples = {
+    "Invoice extraction": {
+        summary: "Generate schema for invoice extraction",
+        value: {
+            instruction: "Extract vendor name, total amount, invoice date, and line items from an invoice",
+        },
+    },
+    "Resume parsing": {
+        summary: "Generate schema for resume parsing",
+        value: {
+            instruction: "Extract name, email, phone number, work experience, and education from a resume",
+        },
+    },
+    "Receipt data": {
+        summary: "Generate schema for receipt data",
+        value: {
+            instruction: "Extract store name, date, items purchased with prices, subtotal, tax, and total from a receipt",
+        },
+    },
+};
+const responseExample = {
+    schema: {
+        type: "object",
+        description: "Extracted data from an invoice document.",
+        properties: {
+            vendor_name: {
+                type: "string",
+                description: "The name of the vendor or supplier.",
+            },
+            total_amount: {
+                type: "number",
+                description: "The total amount due on the invoice.",
+            },
+            invoice_date: {
+                type: "string",
+                description: "The date the invoice was issued (YYYY-MM-DD).",
+            },
+            line_items: {
+                type: "array",
+                description: "Individual items listed on the invoice.",
+                items: {
+                    type: "object",
+                    properties: {
+                        description: {
+                            type: "string",
+                            description: "Description of the item.",
+                        },
+                        quantity: { type: "number", description: "Quantity ordered." },
+                        unit_price: {
+                            type: "number",
+                            description: "Price per unit.",
+                        },
+                        total: {
+                            type: "number",
+                            description: "Total price for this line item.",
+                        },
+                    },
+                    required: ["description", "quantity", "unit_price", "total"],
+                    additionalProperties: false,
+                },
+            },
+        },
+        required: ["vendor_name", "total_amount", "invoice_date", "line_items"],
+        additionalProperties: false,
+    },
+    requestId: 42,
+};
+export const generateSchema = oc
+    .route({
+    summary: "Free: Generate a JSON Schema",
+    description: "Generate a JSON Schema from a natural language instruction. Use the resulting schema with the /extract endpoints to pull structured data from documents. Rate limited to 10 requests per IP per day.",
+    tags: ["Free"],
+    spec: (op) => {
+        op.security = [];
+        const reqBody = op.requestBody;
+        if (reqBody?.content) {
+            for (const mediaType of Object.values(reqBody.content)) {
+                mediaType.examples = requestExamples;
+            }
+        }
+        const responses = op.responses;
+        const okResponse = responses?.["200"];
+        if (okResponse?.content) {
+            for (const mediaType of Object.values(okResponse.content)) {
+                mediaType.example = responseExample;
+            }
+        }
+        return op;
+    },
+})
+    .input(inputSchema)
+    .output(outputSchema);

package/.tsc/lib/router/free/index.d.ts

@@ -0,0 +1,4 @@
+export { bankStatementParse } from "./bank-statement-parse";
+export { generateSchema } from "./generate-schema";
+export { publicationPdfUrl } from "./publication-pdf-url";
+export { rateLimitStatus } from "./rate-limit-status";

package/.tsc/lib/router/free/index.js

@@ -0,0 +1,4 @@
+export { bankStatementParse } from "./bank-statement-parse";
+export { generateSchema } from "./generate-schema";
+export { publicationPdfUrl } from "./publication-pdf-url";
+export { rateLimitStatus } from "./rate-limit-status";

package/.tsc/lib/router/free/publication-pdf-url.d.ts

@@ -0,0 +1,11 @@
+import { z } from "zod";
+export declare const publicationPdfUrl: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
+    ids: z.ZodArray<z.ZodString>;
+}, z.core.$strip>, z.ZodObject<{
+    results: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        pdfUrl: z.ZodOptional<z.ZodString>;
+        title: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    requestId: z.ZodNumber;
+}, z.core.$strip>, Record<never, never>, Record<never, never>>;

package/.tsc/lib/router/free/publication-pdf-url.js

@@ -0,0 +1,86 @@
+import { oc } from "@orpc/contract";
+import { z } from "zod";
+const inputSchema = z.object({
+    ids: z
+        .array(z.string().min(1, "Each ID must be a non-empty string"), {
+        message: "ids is required and must be an array of strings",
+    })
+        .min(1, "ids must contain at least 1 identifier")
+        .max(20, "ids must contain at most 20 identifiers")
+        .describe("Publication identifiers: DOI (e.g. 10.1371/journal.pone.0185809), PubMed ID (e.g. 33116299), ArXiv ID (e.g. 1706.03762), or other supported format"),
+});
+const resultSchema = z.object({
+    id: z.string().describe("The input publication identifier"),
+    pdfUrl: z
+        .string()
+        .optional()
+        .describe("Direct URL to the publication PDF, if available"),
+    title: z.string().optional().describe("Title of the publication"),
+});
+const outputSchema = z.object({
+    results: z.array(resultSchema).describe("Results for each input ID"),
+    requestId: z
+        .number()
+        .int()
+        .describe("Unique request identifier for this API call"),
+});
+const requestExamples = {
+    "Single ArXiv ID": {
+        summary: "Get PDF URL for an ArXiv paper",
+        value: {
+            ids: ["1706.03762"],
+        },
+    },
+    "Multiple IDs": {
+        summary: "Batch lookup with mixed identifier types",
+        value: {
+            ids: ["1706.03762", "33116299", "10.1371/journal.pone.0185809"],
+        },
+    },
+    "Single PubMed ID": {
+        summary: "Get PDF URL for a PubMed paper",
+        value: {
+            ids: ["33116299"],
+        },
+    },
+};
+const responseExample = {
+    results: [
+        {
+            id: "1706.03762",
+            pdfUrl: "https://arxiv.org/pdf/1706.03762v7",
+            title: "Attention Is All You Need",
+        },
+        {
+            id: "33116299",
+            pdfUrl: "https://www.nature.com/articles/s41586-020-2901-9.pdf",
+            title: "Identification of SARS-CoV-2 inhibitors using lung and colonic organoids",
+        },
+    ],
+    requestId: 42,
+};
+export const publicationPdfUrl = oc
+    .route({
+    summary: "Free: Get publication PDF URL",
+    description: "Look up publications by DOI, PubMed ID, ArXiv ID, or other identifiers and return their PDF URLs if available. Accepts up to 20 IDs per request. Rate limited to 20 requests per IP per day.",
+    tags: ["Free"],
+    spec: (op) => {
+        op.security = [];
+        const reqBody = op.requestBody;
+        if (reqBody?.content) {
+            for (const mediaType of Object.values(reqBody.content)) {
+                mediaType.examples = requestExamples;
+            }
+        }
+        const responses = op.responses;
+        const okResponse = responses?.["200"];
+        if (okResponse?.content) {
+            for (const mediaType of Object.values(okResponse.content)) {
+                mediaType.example = responseExample;
+            }
+        }
+        return op;
+    },
+})
+    .input(inputSchema)
+    .output(outputSchema);

package/.tsc/lib/router/free/rate-limit-status.d.ts

@@ -0,0 +1,18 @@
+import { z } from "zod";
+export declare const rateLimitStatus: import("@orpc/contract").ContractProcedureBuilderWithOutput<import("@orpc/contract").Schema<unknown, unknown>, z.ZodObject<{
+    bankStatementParse: z.ZodObject<{
+        limit: z.ZodNumber;
+        used: z.ZodNumber;
+        remaining: z.ZodNumber;
+    }, z.core.$strip>;
+    generateSchema: z.ZodObject<{
+        limit: z.ZodNumber;
+        used: z.ZodNumber;
+        remaining: z.ZodNumber;
+    }, z.core.$strip>;
+    publicationPdfUrl: z.ZodObject<{
+        limit: z.ZodNumber;
+        used: z.ZodNumber;
+        remaining: z.ZodNumber;
+    }, z.core.$strip>;
+}, z.core.$strip>, Record<never, never>, Record<never, never>>;

package/.tsc/lib/router/free/rate-limit-status.js

@@ -0,0 +1,36 @@
+import { oc } from "@orpc/contract";
+import { z } from "zod";
+const limitSchema = z.object({
+    limit: z.number().int().describe("Maximum requests allowed per day"),
+    used: z.number().int().describe("Requests used today"),
+    remaining: z.number().int().describe("Requests remaining today"),
+});
+const outputSchema = z.object({
+    bankStatementParse: limitSchema.describe("Bank statement parse limits"),
+    generateSchema: limitSchema.describe("JSON schema generator limits"),
+    publicationPdfUrl: limitSchema.describe("Publication PDF URL lookup limits"),
+});
+const responseExample = {
+    bankStatementParse: { limit: 5, used: 2, remaining: 3 },
+    generateSchema: { limit: 10, used: 0, remaining: 10 },
+    publicationPdfUrl: { limit: 20, used: 5, remaining: 15 },
+};
+export const rateLimitStatus = oc
+    .route({
+    method: "GET",
+    summary: "Free: Get rate limit status",
+    description: "Check the remaining rate limit for all free API endpoints. Limits are per IP and reset daily at midnight UTC.",
+    tags: ["Free"],
+    spec: (op) => {
+        op.security = [];
+        const responses = op.responses;
+        const okResponse = responses?.["200"];
+        if (okResponse?.content) {
+            for (const mediaType of Object.values(okResponse.content)) {
+                mediaType.example = responseExample;
+            }
+        }
+        return op;
+    },
+})
+    .output(outputSchema);

package/.tsc/lib/router/index.d.ts

@@ -3,5 +3,6 @@ export * as admin from "./admin";
 export * as authenticate from "./authenticate";
 export * as bankStatement from "./bankStatement";
 export * as document from "./document";
+export * as free from "./free";
 export * as identity from "./identity";
 export * as invoice from "./invoice";

package/.tsc/lib/router/index.js

@@ -3,5 +3,6 @@ export * as admin from "./admin";
 export * as authenticate from "./authenticate";
 export * as bankStatement from "./bankStatement";
 export * as document from "./document";
+export * as free from "./free";
 export * as identity from "./identity";
 export * as invoice from "./invoice";

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @pdfvector/instance-contract
 
+## 0.0.22
+### Patch Changes
+
+
+
+- [#126](https://github.com/phuctm97/pdfvector/pull/126) [`9f3db7d`](https://github.com/phuctm97/pdfvector/commit/9f3db7d4114169d2dff0f83cad7bf87e054e9206) Thanks [@khanhduyvt0101](https://github.com/khanhduyvt0101)! - Enhance instance client as publishable PDFVector SDK
+
+## 0.0.21
+### Patch Changes
+
+
+
+- [#125](https://github.com/phuctm97/pdfvector/pull/125) [`0eac9b7`](https://github.com/phuctm97/pdfvector/commit/0eac9b7afdbe9b8a41933fd1f92e48da51fb4480) Thanks [@khanhduyvt0101](https://github.com/khanhduyvt0101)! - Add free public APIs with IP rate limiting and interactive tool pages
+
 ## 0.0.20
 ### Patch Changes
 

package/package.json

@@ -1,10 +1,28 @@
 {
   "name": "@pdfvector/instance-contract",
-  "version": "0.0.20",
+  "version": "0.0.22",
   "type": "module",
+  "description": "API contract definitions for PDFVector instance server",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/phuctm97/pdfvector",
+    "directory": "packages/instance-contract"
+  },
+  "keywords": [
+    "pdfvector",
+    "api",
+    "contract",
+    "orpc"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
   "main": ".tsc/lib/index.js",
   "dependencies": {
-    "@orpc/contract": "^1.13.13",
+    "@orpc/contract": "^1.13.13"
+  },
+  "peerDependencies": {
     "zod": "^4.3.6"
   },
   "files": [