@pdfvector/instance-contract 0.0.38 → 0.0.40

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.
Files changed (17) hide show
  1. package/.tsc/lib/router/academic/fetch.d.ts +20 -2
  2. package/.tsc/lib/router/academic/fetch.js +3 -3
  3. package/.tsc/lib/router/academic/find-citations.d.ts +10 -1
  4. package/.tsc/lib/router/academic/find-citations.js +2 -13
  5. package/.tsc/lib/router/academic/paper-graph.d.ts +30 -3
  6. package/.tsc/lib/router/academic/paper-graph.js +2 -1
  7. package/.tsc/lib/router/academic/provider.d.ts +17 -0
  8. package/.tsc/lib/router/academic/provider.js +16 -0
  9. package/.tsc/lib/router/academic/search-grants.d.ts +6 -1
  10. package/.tsc/lib/router/academic/search-grants.js +2 -4
  11. package/.tsc/lib/router/academic/search.d.ts +10 -1
  12. package/.tsc/lib/router/academic/search.js +2 -13
  13. package/.tsc/lib/router/academic/similar-papers.d.ts +20 -2
  14. package/.tsc/lib/router/academic/similar-papers.js +2 -1
  15. package/.tsc/lib/supported-mimes.js +2 -2
  16. package/CHANGELOG.md +17 -0
  17. package/package.json +2 -2
package/.tsc/lib/router/academic/fetch.d.ts CHANGED
@@ -23,7 +23,16 @@ export declare const fetch: import("@orpc/contract").ContractProcedureBuilderWit
23
23
  }, z.core.$strip>, z.ZodObject<{
24
24
  results: z.ZodArray<z.ZodObject<{
25
25
  id: z.ZodString;
26
- detectedProvider: z.ZodOptional<z.ZodNullable<z.ZodString>>;
26
+ detectedProvider: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
27
+ "semantic-scholar": "semantic-scholar";
28
+ pubmed: "pubmed";
29
+ arxiv: "arxiv";
30
+ "google-scholar": "google-scholar";
31
+ eric: "eric";
32
+ "europe-pmc": "europe-pmc";
33
+ openalex: "openalex";
34
+ crossref: "crossref";
35
+ }>>>;
27
36
  doi: z.ZodOptional<z.ZodNullable<z.ZodString>>;
28
37
  title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
29
38
  url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -38,7 +47,16 @@ export declare const fetch: import("@orpc/contract").ContractProcedureBuilderWit
38
47
  totalReferences: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
39
48
  abstract: z.ZodOptional<z.ZodNullable<z.ZodString>>;
40
49
  pdfURL: z.ZodOptional<z.ZodNullable<z.ZodString>>;
41
- provider: z.ZodOptional<z.ZodNullable<z.ZodString>>;
50
+ provider: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
51
+ "semantic-scholar": "semantic-scholar";
52
+ pubmed: "pubmed";
53
+ arxiv: "arxiv";
54
+ "google-scholar": "google-scholar";
55
+ eric: "eric";
56
+ "europe-pmc": "europe-pmc";
57
+ openalex: "openalex";
58
+ crossref: "crossref";
59
+ }>>>;
42
60
  providerData: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
43
61
  }, z.core.$strip>>;
44
62
  errors: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
package/.tsc/lib/router/academic/fetch.js CHANGED
@@ -1,14 +1,14 @@
1
1
  import { oc } from "@orpc/contract";
2
2
  import { academicCreditCosts } from "@pdfvector/util";
3
3
  import { z } from "zod";
4
+ import { providerSchema } from "./provider";
4
5
  const authorSchema = z.object({
5
6
  name: z.string(),
6
7
  url: z.string().nullish(),
7
8
  });
8
9
  const publicationSchema = z.object({
9
10
  id: z.string().describe("Original input identifier"),
10
- detectedProvider: z
11
- .string()
11
+ detectedProvider: providerSchema
12
12
  .nullish()
13
13
  .describe("Provider that returned this result"),
14
14
  doi: z.string().nullish(),
@@ -22,7 +22,7 @@ const publicationSchema = z.object({
22
22
  totalReferences: z.number().nullish(),
23
23
  abstract: z.string().nullish(),
24
24
  pdfURL: z.string().nullish(),
25
- provider: z.string().nullish(),
25
+ provider: providerSchema.nullish(),
26
26
  providerData: z.record(z.string(), z.unknown()).nullish(),
27
27
  });
28
28
  const fetchErrorSchema = z.object({
package/.tsc/lib/router/academic/find-citations.d.ts CHANGED
@@ -49,7 +49,16 @@ export declare const findCitations: import("@orpc/contract").ContractProcedureBu
49
49
  totalReferences: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
50
50
  abstract: z.ZodOptional<z.ZodNullable<z.ZodString>>;
51
51
  pdfURL: z.ZodOptional<z.ZodNullable<z.ZodString>>;
52
- provider: z.ZodOptional<z.ZodNullable<z.ZodString>>;
52
+ provider: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
53
+ "semantic-scholar": "semantic-scholar";
54
+ pubmed: "pubmed";
55
+ arxiv: "arxiv";
56
+ "google-scholar": "google-scholar";
57
+ eric: "eric";
58
+ "europe-pmc": "europe-pmc";
59
+ openalex: "openalex";
60
+ crossref: "crossref";
61
+ }>>>;
53
62
  providerData: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
54
63
  }, z.core.$strip>>;
55
64
  }, z.core.$strip>>;
package/.tsc/lib/router/academic/find-citations.js CHANGED
@@ -1,18 +1,7 @@
1
1
  import { oc } from "@orpc/contract";
2
2
  import { academicCreditCosts } from "@pdfvector/util";
3
3
  import { z } from "zod";
4
- const providerSchema = z.enum([
5
- "semantic-scholar",
6
- "pubmed",
7
- "arxiv",
8
- "google-scholar",
9
- "eric",
10
- "europe-pmc",
11
- "openalex",
12
- "crossref",
13
- ], {
14
- message: "Invalid provider. Must be one of: semantic-scholar, pubmed, arxiv, google-scholar, eric, europe-pmc, openalex, crossref",
15
- });
4
+ import { providerSchema } from "./provider";
16
5
  const authorSchema = z.object({
17
6
  name: z.string(),
18
7
  url: z.string().nullish(),
@@ -30,7 +19,7 @@ const scoredPublicationSchema = z.object({
30
19
  totalReferences: z.number().nullish(),
31
20
  abstract: z.string().nullish(),
32
21
  pdfURL: z.string().nullish(),
33
- provider: z.string().nullish(),
22
+ provider: providerSchema.nullish(),
34
23
  providerData: z.record(z.string(), z.unknown()).nullish(),
35
24
  });
36
25
  const sentenceCitationSchema = z.object({
package/.tsc/lib/router/academic/paper-graph.d.ts CHANGED
@@ -40,7 +40,16 @@ export declare const paperGraph: import("@orpc/contract").ContractProcedureBuild
40
40
  totalReferences: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
41
41
  abstract: z.ZodOptional<z.ZodNullable<z.ZodString>>;
42
42
  pdfURL: z.ZodOptional<z.ZodNullable<z.ZodString>>;
43
- provider: z.ZodOptional<z.ZodNullable<z.ZodString>>;
43
+ provider: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
44
+ "semantic-scholar": "semantic-scholar";
45
+ pubmed: "pubmed";
46
+ arxiv: "arxiv";
47
+ "google-scholar": "google-scholar";
48
+ eric: "eric";
49
+ "europe-pmc": "europe-pmc";
50
+ openalex: "openalex";
51
+ crossref: "crossref";
52
+ }>>>;
44
53
  providerData: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
45
54
  }, z.core.$strip>;
46
55
  citations: z.ZodArray<z.ZodObject<{
@@ -58,7 +67,16 @@ export declare const paperGraph: import("@orpc/contract").ContractProcedureBuild
58
67
  totalReferences: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
59
68
  abstract: z.ZodOptional<z.ZodNullable<z.ZodString>>;
60
69
  pdfURL: z.ZodOptional<z.ZodNullable<z.ZodString>>;
61
- provider: z.ZodOptional<z.ZodNullable<z.ZodString>>;
70
+ provider: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
71
+ "semantic-scholar": "semantic-scholar";
72
+ pubmed: "pubmed";
73
+ arxiv: "arxiv";
74
+ "google-scholar": "google-scholar";
75
+ eric: "eric";
76
+ "europe-pmc": "europe-pmc";
77
+ openalex: "openalex";
78
+ crossref: "crossref";
79
+ }>>>;
62
80
  providerData: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
63
81
  }, z.core.$strip>>;
64
82
  references: z.ZodArray<z.ZodObject<{
@@ -76,7 +94,16 @@ export declare const paperGraph: import("@orpc/contract").ContractProcedureBuild
76
94
  totalReferences: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
77
95
  abstract: z.ZodOptional<z.ZodNullable<z.ZodString>>;
78
96
  pdfURL: z.ZodOptional<z.ZodNullable<z.ZodString>>;
79
- provider: z.ZodOptional<z.ZodNullable<z.ZodString>>;
97
+ provider: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
98
+ "semantic-scholar": "semantic-scholar";
99
+ pubmed: "pubmed";
100
+ arxiv: "arxiv";
101
+ "google-scholar": "google-scholar";
102
+ eric: "eric";
103
+ "europe-pmc": "europe-pmc";
104
+ openalex: "openalex";
105
+ crossref: "crossref";
106
+ }>>>;
80
107
  providerData: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
81
108
  }, z.core.$strip>>;
82
109
  totalCitations: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
package/.tsc/lib/router/academic/paper-graph.js CHANGED
@@ -1,6 +1,7 @@
1
1
  import { oc } from "@orpc/contract";
2
2
  import { academicCreditCosts } from "@pdfvector/util";
3
3
  import { z } from "zod";
4
+ import { providerSchema } from "./provider";
4
5
  const authorSchema = z.object({
5
6
  name: z.string(),
6
7
  url: z.string().nullish(),
@@ -17,7 +18,7 @@ const publicationSchema = z.object({
17
18
  totalReferences: z.number().nullish(),
18
19
  abstract: z.string().nullish(),
19
20
  pdfURL: z.string().nullish(),
20
- provider: z.string().nullish(),
21
+ provider: providerSchema.nullish(),
21
22
  providerData: z.record(z.string(), z.unknown()).nullish(),
22
23
  });
23
24
  const requestExamples = {
package/.tsc/lib/router/academic/provider.d.ts ADDED
@@ -0,0 +1,17 @@
1
+ import { z } from "zod";
2
+ export declare const providerSchema: z.ZodEnum<{
3
+ "semantic-scholar": "semantic-scholar";
4
+ pubmed: "pubmed";
5
+ arxiv: "arxiv";
6
+ "google-scholar": "google-scholar";
7
+ eric: "eric";
8
+ "europe-pmc": "europe-pmc";
9
+ openalex: "openalex";
10
+ crossref: "crossref";
11
+ }>;
12
+ export declare const grantProviderSchema: z.ZodEnum<{
13
+ "grants-gov": "grants-gov";
14
+ "nih-reporter": "nih-reporter";
15
+ cordis: "cordis";
16
+ ukri: "ukri";
17
+ }>;
package/.tsc/lib/router/academic/provider.js ADDED
@@ -0,0 +1,16 @@
1
+ import { z } from "zod";
2
+ export const providerSchema = z.enum([
3
+ "semantic-scholar",
4
+ "pubmed",
5
+ "arxiv",
6
+ "google-scholar",
7
+ "eric",
8
+ "europe-pmc",
9
+ "openalex",
10
+ "crossref",
11
+ ], {
12
+ message: "Invalid provider. Must be one of: semantic-scholar, pubmed, arxiv, google-scholar, eric, europe-pmc, openalex, crossref",
13
+ });
14
+ export const grantProviderSchema = z.enum(["grants-gov", "nih-reporter", "cordis", "ukri"], {
15
+ message: "Invalid provider. Must be one of: grants-gov, nih-reporter, cordis, ukri",
16
+ });
package/.tsc/lib/router/academic/search-grants.d.ts CHANGED
@@ -69,7 +69,12 @@ export declare const searchGrants: import("@orpc/contract").ContractProcedureBui
69
69
  providerData: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
70
70
  }, z.core.$strip>>;
71
71
  errors: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
72
- provider: z.ZodString;
72
+ provider: z.ZodEnum<{
73
+ "grants-gov": "grants-gov";
74
+ "nih-reporter": "nih-reporter";
75
+ cordis: "cordis";
76
+ ukri: "ukri";
77
+ }>;
73
78
  message: z.ZodString;
74
79
  code: z.ZodOptional<z.ZodNullable<z.ZodString>>;
75
80
  details: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
package/.tsc/lib/router/academic/search-grants.js CHANGED
@@ -1,9 +1,7 @@
1
1
  import { oc } from "@orpc/contract";
2
2
  import { academicCreditCosts } from "@pdfvector/util";
3
3
  import { z } from "zod";
4
- const grantProviderSchema = z.enum(["grants-gov", "nih-reporter", "cordis", "ukri"], {
5
- message: "Invalid provider. Must be one of: grants-gov, nih-reporter, cordis, ukri",
6
- });
4
+ import { grantProviderSchema } from "./provider";
7
5
  const grantSchema = z.object({
8
6
  sourceId: z.string().nullish(),
9
7
  title: z.string().nullish(),
@@ -27,7 +25,7 @@ const grantSchema = z.object({
27
25
  providerData: z.record(z.string(), z.unknown()).nullish(),
28
26
  });
29
27
  const providerErrorSchema = z.object({
30
- provider: z.string(),
28
+ provider: grantProviderSchema,
31
29
  message: z.string(),
32
30
  code: z.string().nullish(),
33
31
  details: z.record(z.string(), z.unknown()).nullish(),
package/.tsc/lib/router/academic/search.d.ts CHANGED
@@ -64,7 +64,16 @@ export declare const search: import("@orpc/contract").ContractProcedureBuilderWi
64
64
  providerData: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
65
65
  }, z.core.$strip>>;
66
66
  errors: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
67
- provider: z.ZodString;
67
+ provider: z.ZodEnum<{
68
+ "semantic-scholar": "semantic-scholar";
69
+ pubmed: "pubmed";
70
+ arxiv: "arxiv";
71
+ "google-scholar": "google-scholar";
72
+ eric: "eric";
73
+ "europe-pmc": "europe-pmc";
74
+ openalex: "openalex";
75
+ crossref: "crossref";
76
+ }>;
68
77
  message: z.ZodString;
69
78
  code: z.ZodOptional<z.ZodNullable<z.ZodString>>;
70
79
  details: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
package/.tsc/lib/router/academic/search.js CHANGED
@@ -1,18 +1,7 @@
1
1
  import { oc } from "@orpc/contract";
2
2
  import { academicCreditCosts } from "@pdfvector/util";
3
3
  import { z } from "zod";
4
- const providerSchema = z.enum([
5
- "semantic-scholar",
6
- "pubmed",
7
- "arxiv",
8
- "google-scholar",
9
- "eric",
10
- "europe-pmc",
11
- "openalex",
12
- "crossref",
13
- ], {
14
- message: "Invalid provider. Must be one of: semantic-scholar, pubmed, arxiv, google-scholar, eric, europe-pmc, openalex, crossref",
15
- });
4
+ import { providerSchema } from "./provider";
16
5
  const authorSchema = z.object({
17
6
  name: z.string(),
18
7
  url: z.string().nullish(),
@@ -33,7 +22,7 @@ const publicationSchema = z.object({
33
22
  providerData: z.record(z.string(), z.unknown()).nullish(),
34
23
  });
35
24
  const providerErrorSchema = z.object({
36
- provider: z.string(),
25
+ provider: providerSchema,
37
26
  message: z.string(),
38
27
  code: z.string().nullish(),
39
28
  details: z.record(z.string(), z.unknown()).nullish(),
package/.tsc/lib/router/academic/similar-papers.d.ts CHANGED
@@ -38,7 +38,16 @@ export declare const similarPapers: import("@orpc/contract").ContractProcedureBu
38
38
  totalReferences: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
39
39
  abstract: z.ZodOptional<z.ZodNullable<z.ZodString>>;
40
40
  pdfURL: z.ZodOptional<z.ZodNullable<z.ZodString>>;
41
- provider: z.ZodOptional<z.ZodNullable<z.ZodString>>;
41
+ provider: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
42
+ "semantic-scholar": "semantic-scholar";
43
+ pubmed: "pubmed";
44
+ arxiv: "arxiv";
45
+ "google-scholar": "google-scholar";
46
+ eric: "eric";
47
+ "europe-pmc": "europe-pmc";
48
+ openalex: "openalex";
49
+ crossref: "crossref";
50
+ }>>>;
42
51
  providerData: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
43
52
  }, z.core.$strip>;
44
53
  results: z.ZodArray<z.ZodObject<{
@@ -57,7 +66,16 @@ export declare const similarPapers: import("@orpc/contract").ContractProcedureBu
57
66
  totalReferences: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
58
67
  abstract: z.ZodOptional<z.ZodNullable<z.ZodString>>;
59
68
  pdfURL: z.ZodOptional<z.ZodNullable<z.ZodString>>;
60
- provider: z.ZodOptional<z.ZodNullable<z.ZodString>>;
69
+ provider: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
70
+ "semantic-scholar": "semantic-scholar";
71
+ pubmed: "pubmed";
72
+ arxiv: "arxiv";
73
+ "google-scholar": "google-scholar";
74
+ eric: "eric";
75
+ "europe-pmc": "europe-pmc";
76
+ openalex: "openalex";
77
+ crossref: "crossref";
78
+ }>>>;
61
79
  providerData: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
62
80
  }, z.core.$strip>;
63
81
  similarity: z.ZodNumber;
package/.tsc/lib/router/academic/similar-papers.js CHANGED
@@ -1,6 +1,7 @@
1
1
  import { oc } from "@orpc/contract";
2
2
  import { academicCreditCosts } from "@pdfvector/util";
3
3
  import { z } from "zod";
4
+ import { providerSchema } from "./provider";
4
5
  const authorSchema = z.object({
5
6
  name: z.string(),
6
7
  url: z.string().nullish(),
@@ -17,7 +18,7 @@ const publicationSchema = z.object({
17
18
  totalReferences: z.number().nullish(),
18
19
  abstract: z.string().nullish(),
19
20
  pdfURL: z.string().nullish(),
20
- provider: z.string().nullish(),
21
+ provider: providerSchema.nullish(),
21
22
  providerData: z.record(z.string(), z.unknown()).nullish(),
22
23
  });
23
24
  const similarPaperSchema = z.object({
package/.tsc/lib/supported-mimes.js CHANGED
@@ -69,8 +69,8 @@ export const documentParseModelDescription = "Model tier for parsing.\n\n" +
69
69
  `- auto (default): Intelligent fallback — credits based on the tier selected automatically. ${autoLimitStr}\n` +
70
70
  `${tierDesc("nano", documentParseCosts.nano, "credit/page", "Simple plain text documents.")}\n` +
71
71
  `${tierDesc("mini", documentParseCosts.mini, "credits/page", "Documents with tables and structured content.")}\n` +
72
- `${tierDesc("pro", documentParseCosts.pro, "credits/page", "Tables, handwritten text, figures, math, Arabic.")}\n` +
73
- `${tierDesc("max", documentParseCosts.max, "credits/page", "Full Pro capabilities + image support + enhanced multilingual.")}` +
72
+ `${tierDesc("pro", documentParseCosts.pro, "credits/page", "Tables, handwritten text, figures, math, Arabic, image support.")}\n` +
73
+ `${tierDesc("max", documentParseCosts.max, "credits/page", "Full Pro capabilities + enhanced multilingual.")}` +
74
74
  formatNote;
75
75
  /** Model tier descriptions for document extract endpoints. */
76
76
  export const documentExtractModelDescription = "Model tier for extracting structured data.\n\n" +
package/CHANGELOG.md CHANGED
@@ -1,5 +1,22 @@
1
1
  # @pdfvector/instance-contract
2
2
 
3
+ ## 0.0.40
4
+ ### Patch Changes
5
+
6
+
7
+
8
+ - [#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
9
+
10
+ ## 0.0.39
11
+ ### Patch Changes
12
+
13
+
14
+
15
+ - [`868be37`](https://github.com/phuctm97/pdfvector/commit/868be37857f362a428f52b5ea0ce6b359b858c20) Thanks [@khanhduyvt0101](https://github.com/khanhduyvt0101)! - Migrate document parsing to Form Parser with Pro image support
16
+
17
+ - Updated dependencies [[`868be37`](https://github.com/phuctm97/pdfvector/commit/868be37857f362a428f52b5ea0ce6b359b858c20)]:
18
+ - @pdfvector/util@0.0.20
19
+
3
20
  ## 0.0.38
4
21
  ### Patch Changes
5
22
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pdfvector/instance-contract",
3
- "version": "0.0.38",
3
+ "version": "0.0.40",
4
4
  "type": "module",
5
5
  "description": "API contract definitions for PDF Vector instance server",
6
6
  "license": "MIT",
@@ -21,7 +21,7 @@
21
21
  "main": ".tsc/lib/index.js",
22
22
  "dependencies": {
23
23
  "@orpc/contract": "^1.13.14",
24
- "@pdfvector/util": "0.0.19"
24
+ "@pdfvector/util": "0.0.20"
25
25
  },
26
26
  "peerDependencies": {
27
27
  "zod": "^4.3.6"