@pdfvector/instance-client 0.0.73 → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.tsc/lib/errors.d.ts +9 -1
- package/.tsc/lib/errors.d.ts.map +1 -1
- package/.tsc/lib/errors.js +30 -3
- package/CHANGELOG.md +11 -0
- package/package.json +2 -2
package/.tsc/lib/errors.d.ts
CHANGED
|
@@ -58,7 +58,15 @@ export declare class PaymentRequiredError extends PDFVectorError {
|
|
|
58
58
|
readonly totalCredits: number | undefined;
|
|
59
59
|
readonly remainingCredits: number | undefined;
|
|
60
60
|
readonly resetsAt: string | undefined;
|
|
61
|
-
|
|
61
|
+
readonly billingReason: string | undefined;
|
|
62
|
+
readonly invoiceCount: number | undefined;
|
|
63
|
+
readonly amountDue: number | undefined;
|
|
64
|
+
readonly currency: string | undefined;
|
|
65
|
+
readonly billingUrl: string | undefined;
|
|
66
|
+
readonly payUrl: string | undefined;
|
|
67
|
+
constructor(options: SubclassOptions);
|
|
68
|
+
get isBillingHold(): boolean;
|
|
69
|
+
get isCreditsExhausted(): boolean;
|
|
62
70
|
}
|
|
63
71
|
export declare class NotFoundError extends PDFVectorError {
|
|
64
72
|
constructor(options: SubclassOptions);
|
package/.tsc/lib/errors.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../lib/errors.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,kBAAkB,GAC3B,aAAa,GACb,cAAc,GACd,kBAAkB,GAClB,WAAW,GACX,mBAAmB,GACnB,UAAU,GACV,iBAAiB,GACjB,uBAAuB,GACvB,uBAAuB,CAAC;AAE3B,MAAM,MAAM,sBAAsB,GAC/B,gBAAgB,GAChB,SAAS,GACT,YAAY,GACZ,gBAAgB,GAChB,qBAAqB,GACrB,YAAY,GACZ,WAAW,GACX,UAAU,GACV,aAAa,GACb,QAAQ,CAAC;AAEZ,MAAM,MAAM,oBAAoB,GAAG,MAAM,GAAG,QAAQ,CAAC;AAErD,MAAM,WAAW,qBAAqB;IACrC,IAAI,EAAE,kBAAkB,CAAC;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;IAC3C,KAAK,CAAC,EAAE,OAAO,CAAC;CAChB;AAED,KAAK,eAAe,GAAG,IAAI,CAAC,qBAAqB,EAAE,MAAM,GAAG,QAAQ,CAAC,CAAC;AAEtE,MAAM,WAAW,mBAAmB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,kBAAkB,CAAC;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,sBAAsB,CAAC;IACjC,MAAM,EAAE,oBAAoB,CAAC;IAC7B,SAAS,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,OAAO,CAAC;IACnB,wBAAwB,EAAE,OAAO,CAAC;IAClC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,cAAc,EAAE,MAAM,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC9B;
|
|
1
|
+
{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../lib/errors.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,kBAAkB,GAC3B,aAAa,GACb,cAAc,GACd,kBAAkB,GAClB,WAAW,GACX,mBAAmB,GACnB,UAAU,GACV,iBAAiB,GACjB,uBAAuB,GACvB,uBAAuB,CAAC;AAE3B,MAAM,MAAM,sBAAsB,GAC/B,gBAAgB,GAChB,SAAS,GACT,YAAY,GACZ,gBAAgB,GAChB,qBAAqB,GACrB,YAAY,GACZ,WAAW,GACX,UAAU,GACV,aAAa,GACb,QAAQ,CAAC;AAEZ,MAAM,MAAM,oBAAoB,GAAG,MAAM,GAAG,QAAQ,CAAC;AAErD,MAAM,WAAW,qBAAqB;IACrC,IAAI,EAAE,kBAAkB,CAAC;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;IAC3C,KAAK,CAAC,EAAE,OAAO,CAAC;CAChB;AAED,KAAK,eAAe,GAAG,IAAI,CAAC,qBAAqB,EAAE,MAAM,GAAG,QAAQ,CAAC,CAAC;AAEtE,MAAM,WAAW,mBAAmB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,kBAAkB,CAAC;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,sBAAsB,CAAC;IACjC,MAAM,EAAE,oBAAoB,CAAC;IAC7B,SAAS,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,OAAO,CAAC;IACnB,wBAAwB,EAAE,OAAO,CAAC;IAClC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,cAAc,EAAE,MAAM,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC9B;AAkRD,qBAAa,cAAe,SAAQ,KAAK;IACxC,QAAQ,CAAC,IAAI,EAAE,kBAAkB,CAAC;IAClC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACvC,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IACvC,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,QAAQ,EAAE,sBAAsB,CAAC;IAC1C,QAAQ,CAAC,MAAM,EAAE,oBAAoB,CAAC;IACtC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,wBAAwB,EAAE,OAAO,CAAC;IAC3C,QAAQ,CAAC,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5C,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAEhC,YAAY,OAAO,EAAE,qBAAqB,EA+BzC;IAED,YAAY,IAAI,mBAAmB,CAsBlC;IAED,MAAM,IAAI,mBAAmB,CAE5B;CACD;AAED,qBAAa,eAAgB,SAAQ,cAAc;IAClD,YAAY,OAAO,EAAE,eAAe,EAEnC;CACD;AAED,qBAAa,iBAAkB,SAAQ,cAAc;IACpD,YAAY,OAAO,EAAE,eAAe,EAEnC;CACD;AAED,qBAAa,oBAAqB,SAAQ,cAAc;IACvD,QAAQ,CAAC,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1C,QAAQ,CAAC,gBAAgB,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9C,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3C,QAAQ,CAAC,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1C,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IACvC,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAEpC,YAAY,OAAO,EAAE,eAAe,EAWnC;IAED,IAAI,aAAa,IAAI,OAAO,CAE3B;IAED,IAAI,kBAAkB,IAAI,OAAO,CAEhC;CACD;AAED,qBAAa,aAAc,SAAQ,cAAc;IAChD,YAAY,OAAO,EAAE,eAAe,EAEnC;CACD;AAED,qBAAa,oBAAqB,SAAQ,cAAc;IACvD,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC,QAAQ,CAAC,iBAAiB,EAAE,MAAM,GAAG,SAAS,CAAC;IAE/C,YAAY,OAAO,EAAE,eAAe,EAKnC;CACD;AAED,qBAAa,aAAc,SAAQ,cAAc;IAChD,YAAY,OAAO,EAAE,eAAe,EAEnC;CACD;AAED,qBAAa,mBAAoB,SAAQ,cAAc;IACtD,YAAY,OAAO,EAAE,eAAe,EAEnC;CACD;AAED,qBAAa,yBAA0B,SAAQ,cAAc;IAC5D,YAAY,OAAO,EAAE,eAAe,EAEnC;CACD;AAED,qBAAa,mBAAoB,SAAQ,cAAc;IACtD,YAAY,OAAO,EAAE,eAAe,EAEnC;CACD;AAED,qBAAa,iBAAkB,SAAQ,eAAe;IACrD,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IAEnC,YAAY,OAAO,EAAE,eAAe,EAcnC;CACD;AAED,qBAAa,sBAAuB,SAAQ,eAAe;IAC1D,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IACvC,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IACvC,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IAEnC,YAAY,OAAO,EAAE,eAAe,EAcnC;CACD;AAED,qBAAa,sBAAuB,SAAQ,eAAe;CAAG;AAE9D,qBAAa,sBAAuB,SAAQ,eAAe;IAC1D,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,QAAQ,CAAC,gBAAgB,EAAE,MAAM,GAAG,SAAS,CAAC;IAE9C,YAAY,OAAO,EAAE,eAAe,EAQnC;CACD;AAED,qBAAa,aAAc,SAAQ,eAAe;IACjD,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;IAExC,YAAY,OAAO,EAAE,eAAe,EAYnC;CACD;AAED,qBAAa,uBAAwB,SAAQ,eAAe;CAAG;AAE/D,qBAAa,kBAAmB,SAAQ,eAAe;CAAG;AAE1D,qBAAa,qBAAsB,SAAQ,eAAe;IACzD,QAAQ,CAAC,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1C,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,QAAQ,CAAC,YAAY,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAE5C,YAAY,OAAO,EAAE,eAAe,EAWnC;CACD;AAED,qBAAa,kBAAmB,SAAQ,eAAe;IACtD,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAEpC,YAAY,OAAO,EAAE,eAAe,EAKnC;CACD;AAED,qBAAa,oBAAqB,SAAQ,eAAe;CAAG;AAE5D,qBAAa,kBAAmB,SAAQ,yBAAyB;CAAG;AAEpE,qBAAa,mBAAoB,SAAQ,yBAAyB;CAAG;AAErE,qBAAa,qBAAsB,SAAQ,yBAAyB;IACnE,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IAErC,YAAY,OAAO,EAAE,eAAe,EAInC;CACD;AAED,qBAAa,0BAA2B,SAAQ,aAAa;IAC5D,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,QAAQ,CAAC,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;IAE5C,YAAY,OAAO,EAAE,eAAe,EAInC;CACD;AAED,qBAAa,gBAAiB,SAAQ,aAAa;IAClD,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;IAEzC,YAAY,OAAO,EAAE,eAAe,EAMnC;CACD;AAmGD,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,cAAc,GAAG,SAAS,CAexE;AAED,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,cAAc,CAExE;AAED,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,cAAc,CAE5E"}
|
package/.tsc/lib/errors.js
CHANGED
|
@@ -89,7 +89,7 @@ function inferOrigin(code, category, data) {
|
|
|
89
89
|
return "system";
|
|
90
90
|
return "user";
|
|
91
91
|
}
|
|
92
|
-
function inferTitle(code, className, message) {
|
|
92
|
+
function inferTitle(code, className, message, billingCode) {
|
|
93
93
|
const lower = message.toLowerCase();
|
|
94
94
|
if (className === "FileTooLargeError")
|
|
95
95
|
return "File too large";
|
|
@@ -131,7 +131,7 @@ function inferTitle(code, className, message) {
|
|
|
131
131
|
case "UNAUTHORIZED":
|
|
132
132
|
return "Authentication failed";
|
|
133
133
|
case "PAYMENT_REQUIRED":
|
|
134
|
-
return "Out of credits";
|
|
134
|
+
return billingCode ? "Payment required" : "Out of credits";
|
|
135
135
|
case "NOT_FOUND":
|
|
136
136
|
return "Resource not found";
|
|
137
137
|
case "TOO_MANY_REQUESTS":
|
|
@@ -152,6 +152,15 @@ function inferSuggestion(code, message, data) {
|
|
|
152
152
|
if (code === "UNAUTHORIZED") {
|
|
153
153
|
return "Check that the API key is present, valid, and belongs to the workspace you intend to use.";
|
|
154
154
|
}
|
|
155
|
+
if (code === "PAYMENT_REQUIRED" &&
|
|
156
|
+
readString(data, "code")?.startsWith("BILLING_")) {
|
|
157
|
+
const payUrl = readString(data, "payUrl");
|
|
158
|
+
if (readString(data, "code") === "BILLING_DISPUTE")
|
|
159
|
+
return "Resolve the payment dispute with your bank or contact team@pdfvector.com.";
|
|
160
|
+
return payUrl
|
|
161
|
+
? `Pay the outstanding balance at ${payUrl}.`
|
|
162
|
+
: "Open billing at https://app.pdfvector.com/workspace/billing and settle the outstanding balance.";
|
|
163
|
+
}
|
|
155
164
|
if (code === "PAYMENT_REQUIRED") {
|
|
156
165
|
const resetsAt = readString(data, "resetsAt");
|
|
157
166
|
return resetsAt
|
|
@@ -250,7 +259,7 @@ export class PDFVectorError extends Error {
|
|
|
250
259
|
this.category = inferCategory(this.code, this.message, this.data);
|
|
251
260
|
this.origin = inferOrigin(this.code, this.category, this.data);
|
|
252
261
|
this.userError = this.origin === "user";
|
|
253
|
-
this.title = inferTitle(this.code, this.name, this.message);
|
|
262
|
+
this.title = inferTitle(this.code, this.name, this.message, readString(this.data, "code")?.startsWith("BILLING_") ?? false);
|
|
254
263
|
this.suggestion = inferSuggestion(this.code, this.message, this.data);
|
|
255
264
|
this.retryableWithHigherModel = hasHigherModelHint(this.message, this.data);
|
|
256
265
|
this.retryable =
|
|
@@ -304,11 +313,29 @@ export class PaymentRequiredError extends PDFVectorError {
|
|
|
304
313
|
totalCredits;
|
|
305
314
|
remainingCredits;
|
|
306
315
|
resetsAt;
|
|
316
|
+
billingReason;
|
|
317
|
+
invoiceCount;
|
|
318
|
+
amountDue;
|
|
319
|
+
currency;
|
|
320
|
+
billingUrl;
|
|
321
|
+
payUrl;
|
|
307
322
|
constructor(options) {
|
|
308
323
|
super({ ...options, code: "PAYMENT_REQUIRED", status: 402 });
|
|
309
324
|
this.totalCredits = readNumber(options.data, "total");
|
|
310
325
|
this.remainingCredits = readNumber(options.data, "remaining");
|
|
311
326
|
this.resetsAt = readString(options.data, "resetsAt");
|
|
327
|
+
this.billingReason = readString(options.data, "reason");
|
|
328
|
+
this.invoiceCount = readNumber(options.data, "invoiceCount");
|
|
329
|
+
this.amountDue = readNumber(options.data, "amountDue");
|
|
330
|
+
this.currency = readString(options.data, "currency");
|
|
331
|
+
this.billingUrl = readString(options.data, "billingUrl");
|
|
332
|
+
this.payUrl = readString(options.data, "payUrl");
|
|
333
|
+
}
|
|
334
|
+
get isBillingHold() {
|
|
335
|
+
return this.reasonCode?.startsWith("BILLING_") ?? false;
|
|
336
|
+
}
|
|
337
|
+
get isCreditsExhausted() {
|
|
338
|
+
return this.reasonCode === "CREDITS_EXHAUSTED" || !this.isBillingHold;
|
|
312
339
|
}
|
|
313
340
|
}
|
|
314
341
|
export class NotFoundError extends PDFVectorError {
|
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,16 @@
|
|
|
1
1
|
# @pdfvector/instance-client
|
|
2
2
|
|
|
3
|
+
## 0.1.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- [#507](https://github.com/phuctm97/pdfvector/pull/507) [`fbe51ca`](https://github.com/phuctm97/pdfvector/commit/fbe51ca228221c31d36565b14c284c1259ddcef1) Thanks [@khanhduyvt0101](https://github.com/khanhduyvt0101)! - Billing holds: workspaces with unpaid invoices, payment disputes or a card/sign-in linked to another account's unpaid balance are blocked with HTTP 402 and a stable code (`BILLING_UNPAID_INVOICE`, `BILLING_DISPUTE`, `BILLING_PAYMENT_METHOD_REQUIRED`, `BILLING_LINKED_UNPAID_BALANCE`, `BILLING_ACCOUNT_HOLD`), cannot resubscribe until paid, and see their invoices with Pay buttons in billing. Out-of-credit errors now carry `CREDITS_EXHAUSTED`. Holds come from webhooks plus an hourly sweep, never from Stripe calls on the request path.
|
|
8
|
+
|
|
9
|
+
### Patch Changes
|
|
10
|
+
|
|
11
|
+
- Updated dependencies []:
|
|
12
|
+
- @pdfvector/instance-contract@0.2.17
|
|
13
|
+
|
|
3
14
|
## 0.0.73
|
|
4
15
|
|
|
5
16
|
### Patch Changes
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@pdfvector/instance-client",
|
|
3
|
-
"version": "0.0
|
|
3
|
+
"version": "0.1.0",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"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",
|
|
6
6
|
"license": "MIT",
|
|
@@ -33,7 +33,7 @@
|
|
|
33
33
|
},
|
|
34
34
|
"main": ".tsc/lib/index.js",
|
|
35
35
|
"dependencies": {
|
|
36
|
-
"@pdfvector/instance-contract": "^0.2.
|
|
36
|
+
"@pdfvector/instance-contract": "^0.2.17"
|
|
37
37
|
},
|
|
38
38
|
"types": ".tsc/lib/index.d.ts",
|
|
39
39
|
"files": [
|