@pdfvector/instance-client 0.0.40 → 0.0.42

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

@@ -1,61 +1,13 @@
-import type { ContractRouterClient } from "@orpc/contract";
-import type { contract } from "@pdfvector/instance-contract";
+import { type ContractRouterClient, type contract } from "@pdfvector/instance-contract";
 export interface CreateClientOptions {
-    /** Domain of the PDF Vector instance server (e.g., "your-instance.pdfvector.com"). Defaults to "global.pdfvector.com". */
+    /** Defaults to "global.pdfvector.com". */
     domain?: string;
-    /** API key for Bearer token authentication */
     apiKey?: string;
-    /** @internal Server secret */
-    secret?: string;
-    /** @internal Additional headers merged into every outgoing request (e.g. forwarded IP) */
-    forwardedHeaders?: Record<string, string>;
 }
-/** Per-request context passed as the second argument to any API call. */
 export interface ClientContext {
-    /** Document ID for usage tracking. Returned in response for document, identity, invoice, and bank statement endpoints. */
+    /** Optional ID echoed back in responses, used for per-document usage tracking. */
     documentId?: string;
 }
-/**
- * Custom error class for PDF Vector API errors.
- *
- * All API errors thrown by the client are instances of this class.
- * Provides structured access to error code, HTTP status, message, and additional data.
- *
- * @example
- * ```typescript
- * try {
- *   await client.document.parse({ url: "..." });
- * } catch (error) {
- *   if (error instanceof PDFVectorError) {
- *     console.error(error.code);    // "UNAUTHORIZED" | "BAD_REQUEST" | ...
- *     console.error(error.status);  // 401 | 400 | 422 | 500
- *     console.error(error.message); // "Invalid API key"
- *     console.error(error.data);    // { requestId: 1 }
- *   }
- * }
- * ```
- */
-export declare class PDFVectorError extends Error {
-    /** Error code identifying the type of error */
-    readonly code: string;
-    /** HTTP status code */
-    readonly status: number;
-    /** Additional error data from the server (e.g., requestId) */
-    readonly data: unknown;
-    constructor(options: {
-        code: string;
-        message: string;
-        status: number;
-        data?: unknown;
-    });
-    /**
-     * Type guard to check if an unknown error is a PDFVectorError.
-     */
-    static is(error: unknown): error is PDFVectorError;
-}
-/** @internal */
-export declare function _buildClient(options?: CreateClientOptions): Client;
-export declare function createClient(options?: CreateClientOptions): PublicClient;
-type Client = ContractRouterClient<typeof contract, ClientContext>;
-export type PublicClient = Omit<ContractRouterClient<typeof contract, ClientContext>, "admin" | "free">;
-export type { ContractInputs, ContractOutputs, PDFVectorModel, } from "@pdfvector/instance-contract";
+export type Client = Omit<ContractRouterClient<typeof contract, ClientContext>, "admin" | "free">;
+export declare function createClient(options?: CreateClientOptions): Client;
+export * from "@pdfvector/instance-contract";

package/.tsc/lib/index.js

@@ -1,85 +1,22 @@
-import { createORPCClient, ORPCError, onError } from "@orpc/client";
-import { RPCLink } from "@orpc/client/fetch";
+import { createORPCClient, RPCLink, } from "@pdfvector/instance-contract";
 const DEFAULT_DOMAIN = "global.pdfvector.com";
-/**
- * Custom error class for PDF Vector API errors.
- *
- * All API errors thrown by the client are instances of this class.
- * Provides structured access to error code, HTTP status, message, and additional data.
- *
- * @example
- * ```typescript
- * try {
- *   await client.document.parse({ url: "..." });
- * } catch (error) {
- *   if (error instanceof PDFVectorError) {
- *     console.error(error.code);    // "UNAUTHORIZED" | "BAD_REQUEST" | ...
- *     console.error(error.status);  // 401 | 400 | 422 | 500
- *     console.error(error.message); // "Invalid API key"
- *     console.error(error.data);    // { requestId: 1 }
- *   }
- * }
- * ```
- */
-export class PDFVectorError extends Error {
-    /** Error code identifying the type of error */
-    code;
-    /** HTTP status code */
-    status;
-    /** Additional error data from the server (e.g., requestId) */
-    data;
-    constructor(options) {
-        super(options.message);
-        this.name = "PDFVectorError";
-        this.code = options.code;
-        this.status = options.status;
-        this.data = options.data;
-    }
-    /**
-     * Type guard to check if an unknown error is a PDFVectorError.
-     */
-    static is(error) {
-        return error instanceof PDFVectorError;
-    }
-}
-/** @internal */
-export function _buildClient(options) {
+export function createClient(options) {
     const domain = options?.domain ?? DEFAULT_DOMAIN;
     const isLocal = domain.startsWith("localhost") || domain.startsWith("127.0.0.1");
     const baseUrl = `${isLocal ? "http" : "https"}://${domain}`;
-    const token = options?.apiKey ?? options?.secret;
+    const token = options?.apiKey;
     const link = new RPCLink({
         url: `${baseUrl}/rpc`,
         headers: ({ context }) => {
-            const headers = {
-                ...options?.forwardedHeaders,
-            };
-            if (token) {
+            const headers = {};
+            if (token)
                 headers.authorization = `Bearer ${token}`;
-            }
-            if (context?.documentId) {
+            if (context?.documentId)
                 headers["x-pdfvector-document-id"] = context.documentId;
-            }
             return headers;
         },
-        fetch: token
-            ? undefined
-            : (input, init) => fetch(input, { ...init, credentials: "include" }),
-        interceptors: [
-            onError((error) => {
-                if (error instanceof ORPCError) {
-                    throw new PDFVectorError({
-                        code: error.code,
-                        message: error.message,
-                        status: error.status,
-                        data: error.data,
-                    });
-                }
-            }),
-        ],
+        fetch: (input, init) => fetch(input, token ? init : { ...init, credentials: "include" }),
     });
     return createORPCClient(link);
 }
-export function createClient(options) {
-    return _buildClient(options);
-}
+export * from "@pdfvector/instance-contract";

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @pdfvector/instance-client
 
+## 0.0.42
+### Patch Changes
+
+
+
+- [#214](https://github.com/phuctm97/pdfvector/pull/214) [`3a1c66b`](https://github.com/phuctm97/pdfvector/commit/3a1c66bcdfade057be5f1b9170f8ed64934bf2a9) Thanks [@khanhduyvt0101](https://github.com/khanhduyvt0101)! - Fix PDFVECTOR-INSTANCE-T and slim instance-client SDK
+
+- Updated dependencies [[`3a1c66b`](https://github.com/phuctm97/pdfvector/commit/3a1c66bcdfade057be5f1b9170f8ed64934bf2a9)]:
+  - @pdfvector/instance-contract@0.0.41
+
+## 0.0.41
+### Patch Changes
+
+
+
+- [#205](https://github.com/phuctm97/pdfvector/pull/205) [`93b9624`](https://github.com/phuctm97/pdfvector/commit/93b9624333f643b143062e08c6af216eed5a859a) Thanks [@khanhduyvt0101](https://github.com/khanhduyvt0101)! - Improve SDK error handling and tighten academic provider types
+
+- Updated dependencies [[`93b9624`](https://github.com/phuctm97/pdfvector/commit/93b9624333f643b143062e08c6af216eed5a859a)]:
+  - @pdfvector/instance-contract@0.0.40
+
 ## 0.0.40
 ### Patch Changes
 

package/README.md

@@ -580,10 +580,10 @@ console.log(resultB.documentId); // "doc-b"
 
 ## Error Handling
 
-All API errors are thrown as `PDFVectorError` instances with structured error information:
+All API errors are thrown as `ORPCError` instances with structured error information matching the server's error response shape:
 
 ```typescript
-import { createClient, PDFVectorError } from "@pdfvector/instance-client";
+import { createClient, ORPCError } from "@pdfvector/instance-client";
 
 const client = createClient({
   apiKey: "your-api-key",
@@ -595,23 +595,24 @@ try {
   });
   console.log(result.markdown);
 } catch (error) {
-  if (error instanceof PDFVectorError) {
+  if (error instanceof ORPCError) {
     console.error(`API Error [${error.code}]: ${error.message}`);
     console.error(`HTTP Status: ${error.status}`);
     console.error(`Error Data:`, error.data);
   } else {
+    // Network errors (DNS, connection refused, timeout) bubble up as TypeError.
     console.error("Unexpected Error:", error);
   }
 }
 ```
 
-You can also use the static type guard:
+You can branch on the error code:
 
 ```typescript
 try {
   await client.document.parse({ url: "..." });
 } catch (error) {
-  if (PDFVectorError.is(error)) {
+  if (error instanceof ORPCError) {
     switch (error.code) {
       case "UNAUTHORIZED":
         console.error("Invalid API key");
@@ -644,7 +645,7 @@ The SDK is written in TypeScript and includes full type definitions:
 ```typescript
 import {
   createClient,
-  PDFVectorError,
+  ORPCError,
 } from "@pdfvector/instance-client";
 
 import type {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pdfvector/instance-client",
-  "version": "0.0.40",
+  "version": "0.0.42",
   "type": "module",
   "description": "Official TypeScript/JavaScript SDK for PDF Vector API - Parse PDF/Word/Image/Excel documents to clean, structured markdown format and search academic publications across multiple databases",
   "license": "MIT",
@@ -33,12 +33,11 @@
   },
   "main": ".tsc/lib/index.js",
   "dependencies": {
-    "@orpc/client": "^1.13.14",
-    "@orpc/contract": "^1.13.14",
-    "@pdfvector/instance-contract": "^0.0.39"
+    "@pdfvector/instance-contract": "^0.0.41"
   },
   "files": [
     ".tsc",
-    "CHANGELOG.md"
+    "CHANGELOG.md",
+    "README.md"
   ]
 }

package/.tsc/lib/internal.d.ts

@@ -1,5 +0,0 @@
-import type { ContractRouterClient } from "@orpc/contract";
-import type { contract } from "@pdfvector/instance-contract";
-import { type ClientContext, type CreateClientOptions } from ".";
-export type Client = ContractRouterClient<typeof contract, ClientContext>;
-export declare function createInternalClient(options?: CreateClientOptions): Client;

package/.tsc/lib/internal.js

@@ -1,4 +0,0 @@
-import { _buildClient } from ".";
-export function createInternalClient(options) {
-    return _buildClient(options);
-}