@korala/api-client 1.9.1 → 1.10.2
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.
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { AcroFormFieldDto, ConfirmReplaceTemplateFileDto, CreateDocumentFromTemplateDto, CreateSignerRoleDto, CreateTemplateDto, CreateTemplateFieldDto, CreateTemplateUploadUrlDto, DetectedMergeFieldDto, DocumentDto, DuplicateTemplateDto, GenerateDocumentDto, GeneratedDocumentDto, PaginatedTemplatesDto, ReplaceTemplateFileDto, ReplaceTemplateFileResponseDto, TemplateDto, TemplateFieldDto, TemplateSignerRoleDto, TemplateUploadUrlResponseDto, TemplateWithDetailsDto, UpdateSignerRoleDto, UpdateTemplateDto, UpdateTemplateFieldDto } from '@korala/public-dtos';
|
|
1
|
+
import type { AcroFormFieldDto, ConfirmReplaceTemplateFileDto, CreateDocumentFromTemplateDto, CreateSignerRoleDto, CreateTemplateDto, CreateTemplateFieldDto, CreateTemplateUploadUrlDto, DetectedMergeFieldDto, DocumentDto, DuplicateTemplateDto, GenerateDocumentDto, GeneratedDocumentDto, PaginatedTemplatesDto, ReplaceTemplateFileDto, ReplaceTemplateFileResponseDto, TemplateBookmarksDto, TemplateDto, TemplateFieldDto, TemplateSignerRoleDto, TemplateUploadUrlResponseDto, TemplateWithDetailsDto, UpdateSignerRoleDto, UpdateTemplateDto, UpdateTemplateFieldDto } from '@korala/public-dtos';
|
|
2
2
|
import type { HttpClient } from '../http.js';
|
|
3
3
|
export declare class TemplatesResource {
|
|
4
4
|
private readonly http;
|
|
@@ -30,6 +30,16 @@ export declare class TemplatesResource {
|
|
|
30
30
|
* PDFs such as IRS tax forms). Returns [] for flat PDFs.
|
|
31
31
|
*/
|
|
32
32
|
getFormFields(templateId: string): Promise<AcroFormFieldDto[]>;
|
|
33
|
+
/**
|
|
34
|
+
* List the Word bookmarks a DOCX template exposes for bookmark placement,
|
|
35
|
+
* plus any names that collapse onto one PDF destination once the converter
|
|
36
|
+
* rewrites them.
|
|
37
|
+
*
|
|
38
|
+
* A bookmark leaves no trace in the document or the rendered PDF, so this is
|
|
39
|
+
* the only way to confirm a name exists and to see the form it was rewritten
|
|
40
|
+
* to.
|
|
41
|
+
*/
|
|
42
|
+
getBookmarks(templateId: string): Promise<TemplateBookmarksDto>;
|
|
33
43
|
getMergeFields(templateId: string): Promise<DetectedMergeFieldDto[]>;
|
|
34
44
|
createDocument(templateId: string, data: CreateDocumentFromTemplateDto): Promise<DocumentDto>;
|
|
35
45
|
generate(templateId: string, data?: GenerateDocumentDto): Promise<GeneratedDocumentDto>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"templates.d.ts","sourceRoot":"","sources":["../../src/resources/templates.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAChB,6BAA6B,EAC7B,6BAA6B,EAC7B,mBAAmB,EACnB,iBAAiB,EACjB,sBAAsB,EACtB,0BAA0B,EAC1B,qBAAqB,EACrB,WAAW,EACX,oBAAoB,EACpB,mBAAmB,EACnB,oBAAoB,EACpB,qBAAqB,EACrB,sBAAsB,EACtB,8BAA8B,EAC9B,WAAW,EACX,gBAAgB,EAChB,qBAAqB,EACrB,4BAA4B,EAC5B,sBAAsB,EACtB,mBAAmB,EACnB,iBAAiB,EACjB,sBAAsB,EACvB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE7C,qBAAa,iBAAiB;IAChB,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAI7C,eAAe,CACb,IAAI,EAAE,0BAA0B,GAC/B,OAAO,CAAC,4BAA4B,CAAC;IAOxC,aAAa,CACX,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,iBAAiB,GACtB,OAAO,CAAC,WAAW,CAAC;IAOvB,WAAW,CACT,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,sBAAsB,GAC3B,OAAO,CAAC,8BAA8B,CAAC;IAO1C,kBAAkB,CAChB,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,6BAA6B,GAClC,OAAO,CAAC,WAAW,CAAC;IAOvB,IAAI,CAAC,MAAM,CAAC,EAAE;QACZ,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAalC,GAAG,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAIxD,SAAS,CACP,UAAU,EAAE,MAAM,EAClB,IAAI,GAAE,oBAAyB,GAC9B,OAAO,CAAC,WAAW,CAAC;IAOvB,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,WAAW,CAAC;IAIzE,MAAM,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAMzC,aAAa,CACX,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,mBAAmB,GACxB,OAAO,CAAC,qBAAqB,CAAC;IAOjC,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC;IAMpE,gBAAgB,CACd,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,mBAAmB,GACxB,OAAO,CAAC,qBAAqB,CAAC;IAOjC,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAMnE,QAAQ,CACN,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,sBAAsB,GAC3B,OAAO,CAAC,gBAAgB,CAAC;IAO5B,SAAS,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAI1D,WAAW,CACT,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,sBAAsB,GAC3B,OAAO,CAAC,gBAAgB,CAAC;IAO5B,WAAW,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI/D;;;OAGG;IACH,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;
|
|
1
|
+
{"version":3,"file":"templates.d.ts","sourceRoot":"","sources":["../../src/resources/templates.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAChB,6BAA6B,EAC7B,6BAA6B,EAC7B,mBAAmB,EACnB,iBAAiB,EACjB,sBAAsB,EACtB,0BAA0B,EAC1B,qBAAqB,EACrB,WAAW,EACX,oBAAoB,EACpB,mBAAmB,EACnB,oBAAoB,EACpB,qBAAqB,EACrB,sBAAsB,EACtB,8BAA8B,EAC9B,oBAAoB,EACpB,WAAW,EACX,gBAAgB,EAChB,qBAAqB,EACrB,4BAA4B,EAC5B,sBAAsB,EACtB,mBAAmB,EACnB,iBAAiB,EACjB,sBAAsB,EACvB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE7C,qBAAa,iBAAiB;IAChB,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAI7C,eAAe,CACb,IAAI,EAAE,0BAA0B,GAC/B,OAAO,CAAC,4BAA4B,CAAC;IAOxC,aAAa,CACX,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,iBAAiB,GACtB,OAAO,CAAC,WAAW,CAAC;IAOvB,WAAW,CACT,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,sBAAsB,GAC3B,OAAO,CAAC,8BAA8B,CAAC;IAO1C,kBAAkB,CAChB,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,6BAA6B,GAClC,OAAO,CAAC,WAAW,CAAC;IAOvB,IAAI,CAAC,MAAM,CAAC,EAAE;QACZ,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAalC,GAAG,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAIxD,SAAS,CACP,UAAU,EAAE,MAAM,EAClB,IAAI,GAAE,oBAAyB,GAC9B,OAAO,CAAC,WAAW,CAAC;IAOvB,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,WAAW,CAAC;IAIzE,MAAM,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAMzC,aAAa,CACX,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,mBAAmB,GACxB,OAAO,CAAC,qBAAqB,CAAC;IAOjC,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC;IAMpE,gBAAgB,CACd,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,mBAAmB,GACxB,OAAO,CAAC,qBAAqB,CAAC;IAOjC,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAMnE,QAAQ,CACN,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,sBAAsB,GAC3B,OAAO,CAAC,gBAAgB,CAAC;IAO5B,SAAS,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAI1D,WAAW,CACT,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,sBAAsB,GAC3B,OAAO,CAAC,gBAAgB,CAAC;IAO5B,WAAW,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI/D;;;OAGG;IACH,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAM9D;;;;;;;;OAQG;IACH,YAAY,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAQ/D,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC;IAQpE,cAAc,CACZ,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,6BAA6B,GAClC,OAAO,CAAC,WAAW,CAAC;IASvB,QAAQ,CACN,UAAU,EAAE,MAAM,EAClB,IAAI,GAAE,mBAAwB,GAC7B,OAAO,CAAC,oBAAoB,CAAC;CAMjC"}
|
|
@@ -77,6 +77,18 @@ class TemplatesResource {
|
|
|
77
77
|
getFormFields(templateId) {
|
|
78
78
|
return this.http.get(`/templates/${templateId}/form-fields`);
|
|
79
79
|
}
|
|
80
|
+
/**
|
|
81
|
+
* List the Word bookmarks a DOCX template exposes for bookmark placement,
|
|
82
|
+
* plus any names that collapse onto one PDF destination once the converter
|
|
83
|
+
* rewrites them.
|
|
84
|
+
*
|
|
85
|
+
* A bookmark leaves no trace in the document or the rendered PDF, so this is
|
|
86
|
+
* the only way to confirm a name exists and to see the form it was rewritten
|
|
87
|
+
* to.
|
|
88
|
+
*/
|
|
89
|
+
getBookmarks(templateId) {
|
|
90
|
+
return this.http.get(`/templates/${templateId}/bookmarks`);
|
|
91
|
+
}
|
|
80
92
|
// Merge Fields (DOCX templates)
|
|
81
93
|
getMergeFields(templateId) {
|
|
82
94
|
return this.http.get(`/templates/${templateId}/merge-fields`);
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@korala/api-client",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.10.2",
|
|
4
4
|
"description": "TypeScript API client for Korala document signing API",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"homepage": "https://docs.korala.ai",
|
|
@@ -30,7 +30,7 @@
|
|
|
30
30
|
],
|
|
31
31
|
"dependencies": {
|
|
32
32
|
"@korala/auth": "^1.1.0",
|
|
33
|
-
"@korala/public-dtos": "^1.
|
|
33
|
+
"@korala/public-dtos": "^1.10.2"
|
|
34
34
|
},
|
|
35
35
|
"devDependencies": {
|
|
36
36
|
"typescript": "^5.9.3"
|