@corsair-dev/craftmypdf 0.0.0-stage → 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/LICENSE +191 -0
- package/README.md +52 -2
- package/dist/api.test.d.ts +15 -0
- package/dist/api.test.d.ts.map +1 -0
- package/dist/client.d.ts +50 -0
- package/dist/client.d.ts.map +1 -0
- package/dist/client.test.d.ts +2 -0
- package/dist/client.test.d.ts.map +1 -0
- package/dist/endpoints/account.d.ts +4 -0
- package/dist/endpoints/account.d.ts.map +1 -0
- package/dist/endpoints/call.d.ts +28 -0
- package/dist/endpoints/call.d.ts.map +1 -0
- package/dist/endpoints/editor.d.ts +9 -0
- package/dist/endpoints/editor.d.ts.map +1 -0
- package/dist/endpoints/index.d.ts +7 -0
- package/dist/endpoints/index.d.ts.map +1 -0
- package/dist/endpoints/pages.d.ts +12 -0
- package/dist/endpoints/pages.d.ts.map +1 -0
- package/dist/endpoints/pdf.d.ts +12 -0
- package/dist/endpoints/pdf.d.ts.map +1 -0
- package/dist/endpoints/templates.d.ts +11 -0
- package/dist/endpoints/templates.d.ts.map +1 -0
- package/dist/endpoints/types.d.ts +1129 -0
- package/dist/endpoints/types.d.ts.map +1 -0
- package/dist/error-handlers.d.ts +49 -0
- package/dist/error-handlers.d.ts.map +1 -0
- package/dist/error-handlers.test.d.ts +2 -0
- package/dist/error-handlers.test.d.ts.map +1 -0
- package/dist/index.d.ts +610 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +1 -0
- package/dist/integration.test.d.ts +2 -0
- package/dist/integration.test.d.ts.map +1 -0
- package/dist/plugin.test.d.ts +2 -0
- package/dist/plugin.test.d.ts.map +1 -0
- package/dist/requests.test.d.ts +2 -0
- package/dist/requests.test.d.ts.map +1 -0
- package/dist/schema/index.d.ts +5 -0
- package/dist/schema/index.d.ts.map +1 -0
- package/dist/schema.test.d.ts +2 -0
- package/dist/schema.test.d.ts.map +1 -0
- package/dist/test-fixtures.d.ts +179 -0
- package/dist/test-fixtures.d.ts.map +1 -0
- package/dist/tsup.config.d.ts +3 -0
- package/dist/tsup.config.d.ts.map +1 -0
- package/package.json +51 -3
package/LICENSE
ADDED
|
@@ -0,0 +1,191 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(which shall not include Communications that are clearly marked or
|
|
39
|
+
otherwise designated in writing by the copyright owner as "Not a Work").
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution".
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
Copyright (c) 2026 Corsair
|
|
180
|
+
|
|
181
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
182
|
+
you may not use this file except in compliance with the License.
|
|
183
|
+
You may obtain a copy of the License at
|
|
184
|
+
|
|
185
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
186
|
+
|
|
187
|
+
Unless required by applicable law or agreed to in writing, software
|
|
188
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
189
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
190
|
+
See the License for the specific language governing permissions and
|
|
191
|
+
limitations under the License.
|
package/README.md
CHANGED
|
@@ -1,3 +1,53 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @corsair-dev/craftmypdf
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
CraftMyPDF plugin for Corsair.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
pnpm add @corsair-dev/craftmypdf
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Endpoints
|
|
12
|
+
|
|
13
|
+
| Operation | Operation ID | Risk | Description |
|
|
14
|
+
|-----------|--------------|------|-------------|
|
|
15
|
+
| `account.getInfo` | `craftmypdf.api.account.getInfo` | `read` | Read the account name, credit usage and template count against their limits |
|
|
16
|
+
| `editor.createSession` | `craftmypdf.api.editor.createSession` | `write` | Create a signed URL that lets its bearer edit a template in the embedded designer; the URL is a credential |
|
|
17
|
+
| `editor.deactivateSession` | `craftmypdf.api.editor.deactivateSession` | `write` | Revoke an editor session so its URL stops working |
|
|
18
|
+
| `pdf.addText` | `craftmypdf.api.pdf.addText` | `write` | Draw text such as page numbers or headers on chosen pages of a PDF and return a new file |
|
|
19
|
+
| `pdf.addWatermark` | `craftmypdf.api.pdf.addWatermark` | `write` | Stamp a text watermark on every page of a PDF and return a new file |
|
|
20
|
+
| `pdf.create` | `craftmypdf.api.pdf.create` | `write` | Generate a PDF from a template and JSON data, synchronously; consumes one credit per PDF |
|
|
21
|
+
| `pdf.createAsync` | `craftmypdf.api.pdf.createAsync` | `write` | Queue a PDF generation and return at once with a transaction reference, delivering the file to a webhook URL; consumes one credit per PDF |
|
|
22
|
+
| `pdf.createImage` | `craftmypdf.api.pdf.createImage` | `write` | Render a template to a JPEG or PNG image instead of a PDF; consumes one credit per image |
|
|
23
|
+
| `pdf.createMerge` | `craftmypdf.api.pdf.createMerge` | `write` | Render several templates, each with its own data, into one combined PDF; consumes one credit per template |
|
|
24
|
+
| `pdf.createParallel` | `craftmypdf.api.pdf.createParallel` | `write` | Generate a batch of PDFs in one request, each from its own template data, optionally merging them into a single file; consumes one credit per PDF |
|
|
25
|
+
| `pdf.getInfo` | `craftmypdf.api.pdf.getInfo` | `read` | Read the page count and document properties of a PDF at a URL |
|
|
26
|
+
| `pdf.merge` | `craftmypdf.api.pdf.merge` | `write` | Merge several PDFs fetched by URL into one file |
|
|
27
|
+
| `pdf.updateFields` | `craftmypdf.api.pdf.updateFields` | `write` | Fill the form fields of a PDF and optionally make them read-only, returning a new file |
|
|
28
|
+
| `templates.createFrom` | `craftmypdf.api.templates.createFrom` | `write` | Create a new template by copying an existing one |
|
|
29
|
+
| `templates.delete` | `craftmypdf.api.templates.delete` | `destructive` | Permanently delete a template |
|
|
30
|
+
| `templates.get` | `craftmypdf.api.templates.get` | `read` | Read one template, including its body and sample JSON data |
|
|
31
|
+
| `templates.list` | `craftmypdf.api.templates.list` | `read` | List the templates on the account with the ids generation calls need |
|
|
32
|
+
| `templates.listVersions` | `craftmypdf.api.templates.listVersions` | `read` | List the saved versions of a template |
|
|
33
|
+
| `templates.queryUsage` | `craftmypdf.api.templates.queryUsage` | `read` | Report how many PDFs and credits the given templates used in a date range |
|
|
34
|
+
| `templates.retainVersions` | `craftmypdf.api.templates.retainVersions` | `write` | Mark template versions to protect from automatic cleanup, or release the ones already kept; a released version can be cleaned up later |
|
|
35
|
+
| `templates.transfer` | `craftmypdf.api.templates.transfer` | `write` | Move a template to another team, after which this account no longer owns it |
|
|
36
|
+
| `templates.update` | `craftmypdf.api.templates.update` | `write` | Change a template's name, sample JSON data or body; the body is what the template renders |
|
|
37
|
+
| `transactions.list` | `craftmypdf.api.transactions.list` | `read` | List past generations with their status, credit cost and file size |
|
|
38
|
+
|
|
39
|
+
## Auth
|
|
40
|
+
|
|
41
|
+
Auth: API key. Corsair prompts your tenant for credentials on first use.
|
|
42
|
+
|
|
43
|
+
## Webhooks
|
|
44
|
+
|
|
45
|
+
No webhooks.
|
|
46
|
+
|
|
47
|
+
## Reference
|
|
48
|
+
|
|
49
|
+
Full docs, types, and examples: https://docs.corsair.dev/plugins/craftmypdf
|
|
50
|
+
|
|
51
|
+
## License
|
|
52
|
+
|
|
53
|
+
Apache-2.0
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Live CraftMyPDF tests. These run only when `CRAFTMYPDF_API_KEY` is set;
|
|
3
|
+
* otherwise they are skipped so CI stays green without credentials.
|
|
4
|
+
*
|
|
5
|
+
* Most calls are reads and cost nothing. Generation and PDF editing do spend
|
|
6
|
+
* credits (one per generated file, half for a merge), so every spending test
|
|
7
|
+
* is gated on `CRAFTMYPDF_TEMPLATE_ID` as well: a key alone never charges the
|
|
8
|
+
* account. Without the template id they skip rather than fail.
|
|
9
|
+
*
|
|
10
|
+
* Run with:
|
|
11
|
+
* CRAFTMYPDF_API_KEY=... CRAFTMYPDF_TEMPLATE_ID=... \
|
|
12
|
+
* pnpm --filter @corsair-dev/craftmypdf test:live
|
|
13
|
+
*/
|
|
14
|
+
export {};
|
|
15
|
+
//# sourceMappingURL=api.test.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api.test.d.ts","sourceRoot":"","sources":["../api.test.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG"}
|
package/dist/client.d.ts
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* CraftMyPDF runs the same API in several regions, and the docs recommend
|
|
3
|
+
* picking the one nearest the caller. Singapore is the default.
|
|
4
|
+
* https://support.craftmypdf.com/regional-api-endpoints
|
|
5
|
+
*/
|
|
6
|
+
export declare const CRAFTMYPDF_API_BASE = "https://api.craftmypdf.com/v1";
|
|
7
|
+
export type CraftmypdfRegion = 'sg' | 'de' | 'us' | 'au';
|
|
8
|
+
/**
|
|
9
|
+
* CraftMyPDF answers every failure with `{ status: 'error', message }`, and a
|
|
10
|
+
* bad key is a **400**, not a 401, so the status alone cannot tell an auth
|
|
11
|
+
* failure from a malformed body. `message` is the only thing that separates
|
|
12
|
+
* them, which is why it is matched in error-handlers.ts.
|
|
13
|
+
*/
|
|
14
|
+
export declare class CraftmypdfAPIError extends Error {
|
|
15
|
+
readonly status?: number;
|
|
16
|
+
readonly code?: string;
|
|
17
|
+
/** Milliseconds from a Retry-After header, when CraftMyPDF sent one. */
|
|
18
|
+
readonly retryAfter?: number;
|
|
19
|
+
/** The HTTP method of the failed request. */
|
|
20
|
+
readonly method?: string;
|
|
21
|
+
/** CraftMyPDF's own `status` field, `error` on every failure seen so far. */
|
|
22
|
+
readonly envelopeStatus?: string;
|
|
23
|
+
constructor(message: string, options?: {
|
|
24
|
+
cause?: Error;
|
|
25
|
+
status?: number;
|
|
26
|
+
retryAfter?: number;
|
|
27
|
+
method?: string;
|
|
28
|
+
envelopeStatus?: string;
|
|
29
|
+
});
|
|
30
|
+
/** True for a throttled call: an HTTP 429 with no message of its own. */
|
|
31
|
+
get isRateLimit(): boolean;
|
|
32
|
+
/** True when CraftMyPDF rejected the API key. */
|
|
33
|
+
get isAuthFailure(): boolean;
|
|
34
|
+
}
|
|
35
|
+
/** The wordings CraftMyPDF uses for a rejected key, across its two handlers. */
|
|
36
|
+
export declare function isAuthMessage(message: string): boolean;
|
|
37
|
+
export type CraftmypdfQueryValue = string | number | boolean | undefined;
|
|
38
|
+
export type CraftmypdfRequest = {
|
|
39
|
+
method: 'GET' | 'POST';
|
|
40
|
+
path: string;
|
|
41
|
+
query?: Record<string, CraftmypdfQueryValue>;
|
|
42
|
+
body?: unknown;
|
|
43
|
+
};
|
|
44
|
+
export type CraftmypdfClientOptions = {
|
|
45
|
+
region?: CraftmypdfRegion;
|
|
46
|
+
};
|
|
47
|
+
/** Builds the base URL for a region; unknown ids fall back to the default. */
|
|
48
|
+
export declare function resolveBase(region?: string): string;
|
|
49
|
+
export declare function makeCraftmypdfRequest(apiKey: string, { method, path, query, body }: CraftmypdfRequest, options?: CraftmypdfClientOptions): Promise<unknown>;
|
|
50
|
+
//# sourceMappingURL=client.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../client.ts"],"names":[],"mappings":"AAQA;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,kCAAkC,CAAC;AAEnE,MAAM,MAAM,gBAAgB,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;AAmDzD;;;;;GAKG;AACH,qBAAa,kBAAmB,SAAQ,KAAK;IAC5C,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,wEAAwE;IACxE,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,6CAA6C;IAC7C,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,6EAA6E;IAC7E,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;gBAGhC,OAAO,EAAE,MAAM,EACf,OAAO,GAAE;QACR,KAAK,CAAC,EAAE,KAAK,CAAC;QACd,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,cAAc,CAAC,EAAE,MAAM,CAAC;KACnB;IAaP,yEAAyE;IACzE,IAAI,WAAW,IAAI,OAAO,CAEzB;IAED,iDAAiD;IACjD,IAAI,aAAa,IAAI,OAAO,CAE3B;CACD;AAED,gFAAgF;AAChF,wBAAgB,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAQtD;AAED,MAAM,MAAM,oBAAoB,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;AAEzE,MAAM,MAAM,iBAAiB,GAAG;IAC/B,MAAM,EAAE,KAAK,GAAG,MAAM,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;IAE7C,IAAI,CAAC,EAAE,OAAO,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACrC,MAAM,CAAC,EAAE,gBAAgB,CAAC;CAC1B,CAAC;AAEF,8EAA8E;AAC9E,wBAAgB,WAAW,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAKnD;AAID,wBAAsB,qBAAqB,CAC1C,MAAM,EAAE,MAAM,EACd,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,iBAAiB,EAChD,OAAO,GAAE,uBAA4B,GACnC,OAAO,CAAC,OAAO,CAAC,CAyClB"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"client.test.d.ts","sourceRoot":"","sources":["../client.test.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"account.d.ts","sourceRoot":"","sources":["../../endpoints/account.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,IAAI,CAAC;AAS9C,eAAO,MAAM,OAAO,EAAE,mBAAmB,CAAC,gBAAgB,CAUxD,CAAC;AAEH,eAAO,MAAM,IAAI,EAAE,mBAAmB,CAAC,kBAAkB,CA8BvD,CAAC"}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import type { z } from 'zod';
|
|
2
|
+
import type { CraftmypdfContext } from '..';
|
|
3
|
+
import type { CraftmypdfRequest } from '../client';
|
|
4
|
+
type LogFields = Record<string, string | number | boolean | undefined>;
|
|
5
|
+
/**
|
|
6
|
+
* CraftMyPDF echoes the URL it was given in some error messages, for example
|
|
7
|
+
* "Failed to load: <url>". A PDF URL is often a signed S3 link, so its query
|
|
8
|
+
* string is a bearer credential: saving the raw message in `corsair_events`
|
|
9
|
+
* would keep that credential at rest. The query string and any userinfo are
|
|
10
|
+
* dropped; the scheme, host and path stay because they are what makes the
|
|
11
|
+
* message useful.
|
|
12
|
+
*/
|
|
13
|
+
export declare function redactUrls(message: string): string;
|
|
14
|
+
/**
|
|
15
|
+
* Validates the input, sends the request, shapes and validates the response,
|
|
16
|
+
* then logs the event. Inputs are not logged: a create call body holds the
|
|
17
|
+
* template data, which is the caller's own customer data.
|
|
18
|
+
*/
|
|
19
|
+
export declare function call<Input extends z.ZodType, Output extends z.ZodType>(ctx: CraftmypdfContext, operation: {
|
|
20
|
+
event: string;
|
|
21
|
+
input: Input;
|
|
22
|
+
output: Output;
|
|
23
|
+
}, rawInput: unknown, toRequest: (parsed: z.output<Input>) => CraftmypdfRequest, options?: {
|
|
24
|
+
shape?: (raw: unknown, parsed: z.output<Input>) => unknown;
|
|
25
|
+
log?: (parsed: z.output<Input>, result: z.output<Output>) => LogFields;
|
|
26
|
+
}): Promise<z.output<Output>>;
|
|
27
|
+
export {};
|
|
28
|
+
//# sourceMappingURL=call.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"call.d.ts","sourceRoot":"","sources":["../../endpoints/call.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAC7B,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,IAAI,CAAC;AAC5C,OAAO,KAAK,EAA2B,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAG5E,KAAK,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC,CAAC;AAEvE;;;;;;;GAOG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAclD;AAED;;;;GAIG;AACH,wBAAsB,IAAI,CAAC,KAAK,SAAS,CAAC,CAAC,OAAO,EAAE,MAAM,SAAS,CAAC,CAAC,OAAO,EAC3E,GAAG,EAAE,iBAAiB,EACtB,SAAS,EAAE;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,KAAK,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAE1D,QAAQ,EAAE,OAAO,EACjB,SAAS,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,iBAAiB,EACzD,OAAO,GAAE;IAGR,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,OAAO,CAAC;IAC3D,GAAG,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,SAAS,CAAC;CAClE,GACJ,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAwC3B"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type { CraftmypdfEndpoints } from '..';
|
|
2
|
+
/**
|
|
3
|
+
* The session URL carries a signed token that lets its bearer edit the
|
|
4
|
+
* template, so creating a session is a write: a read-only caller must not be
|
|
5
|
+
* able to mint one.
|
|
6
|
+
*/
|
|
7
|
+
export declare const createSession: CraftmypdfEndpoints['editorCreateSession'];
|
|
8
|
+
export declare const deactivateSession: CraftmypdfEndpoints['editorDeactivateSession'];
|
|
9
|
+
//# sourceMappingURL=editor.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"editor.d.ts","sourceRoot":"","sources":["../../endpoints/editor.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,IAAI,CAAC;AAO9C;;;;GAIG;AACH,eAAO,MAAM,aAAa,EAAE,mBAAmB,CAAC,qBAAqB,CAuBnE,CAAC;AAEH,eAAO,MAAM,iBAAiB,EAAE,mBAAmB,CAAC,yBAAyB,CAgB1E,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../endpoints/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AACrC,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,KAAK,GAAG,MAAM,OAAO,CAAC;AAC7B,OAAO,KAAK,SAAS,MAAM,aAAa,CAAC;AAEzC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC;AAC3C,cAAc,SAAS,CAAC"}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Reads a list field from a CraftMyPDF response. A missing field is an empty
|
|
3
|
+
* page; a field of the wrong shape throws rather than becoming a blank row,
|
|
4
|
+
* because a page of empty records looks like data.
|
|
5
|
+
*/
|
|
6
|
+
export declare function readList(raw: unknown, key: string): unknown[];
|
|
7
|
+
/**
|
|
8
|
+
* CraftMyPDF reports no total and no cursor, so the only signal that another
|
|
9
|
+
* page exists is a full page: a short page is the end.
|
|
10
|
+
*/
|
|
11
|
+
export declare function nextOffsetFor(returned: number, limit: number, offset: number): number | undefined;
|
|
12
|
+
//# sourceMappingURL=pages.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"pages.d.ts","sourceRoot":"","sources":["../../endpoints/pages.ts"],"names":[],"mappings":"AAGA;;;;GAIG;AAGH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,EAAE,CAiB7D;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAC5B,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,GACZ,MAAM,GAAG,SAAS,CAEpB"}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type { CraftmypdfEndpoints } from '..';
|
|
2
|
+
export declare const create: CraftmypdfEndpoints['pdfCreate'];
|
|
3
|
+
export declare const createAsync: CraftmypdfEndpoints['pdfCreateAsync'];
|
|
4
|
+
export declare const createImage: CraftmypdfEndpoints['pdfCreateImage'];
|
|
5
|
+
export declare const createMerge: CraftmypdfEndpoints['pdfCreateMerge'];
|
|
6
|
+
export declare const createParallel: CraftmypdfEndpoints['pdfCreateParallel'];
|
|
7
|
+
export declare const addWatermark: CraftmypdfEndpoints['pdfAddWatermark'];
|
|
8
|
+
export declare const addText: CraftmypdfEndpoints['pdfAddText'];
|
|
9
|
+
export declare const updateFields: CraftmypdfEndpoints['pdfUpdateFields'];
|
|
10
|
+
export declare const merge: CraftmypdfEndpoints['pdfMerge'];
|
|
11
|
+
export declare const getInfo: CraftmypdfEndpoints['pdfGetInfo'];
|
|
12
|
+
//# sourceMappingURL=pdf.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"pdf.d.ts","sourceRoot":"","sources":["../../endpoints/pdf.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,IAAI,CAAC;AAiB9C,eAAO,MAAM,MAAM,EAAE,mBAAmB,CAAC,WAAW,CAsBlD,CAAC;AAEH,eAAO,MAAM,WAAW,EAAE,mBAAmB,CAAC,gBAAgB,CAsB5D,CAAC;AAEH,eAAO,MAAM,WAAW,EAAE,mBAAmB,CAAC,gBAAgB,CAsB5D,CAAC;AAEH,eAAO,MAAM,WAAW,EAAE,mBAAmB,CAAC,gBAAgB,CAsB5D,CAAC;AAEH,eAAO,MAAM,cAAc,EAAE,mBAAmB,CAAC,mBAAmB,CAuBlE,CAAC;AAEH,eAAO,MAAM,YAAY,EAAE,mBAAmB,CAAC,iBAAiB,CAsB9D,CAAC;AAEH,eAAO,MAAM,OAAO,EAAE,mBAAmB,CAAC,YAAY,CAmBpD,CAAC;AAEH,eAAO,MAAM,YAAY,EAAE,mBAAmB,CAAC,iBAAiB,CAoC9D,CAAC;AAEH,eAAO,MAAM,KAAK,EAAE,mBAAmB,CAAC,UAAU,CAmBhD,CAAC;AAEH,eAAO,MAAM,OAAO,EAAE,mBAAmB,CAAC,YAAY,CAiBpD,CAAC"}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type { CraftmypdfEndpoints } from '..';
|
|
2
|
+
export declare const list: CraftmypdfEndpoints['templatesList'];
|
|
3
|
+
export declare const get: CraftmypdfEndpoints['templatesGet'];
|
|
4
|
+
export declare const update: CraftmypdfEndpoints['templatesUpdate'];
|
|
5
|
+
export declare const remove: CraftmypdfEndpoints['templatesDelete'];
|
|
6
|
+
export declare const createFrom: CraftmypdfEndpoints['templatesCreateFrom'];
|
|
7
|
+
export declare const transfer: CraftmypdfEndpoints['templatesTransfer'];
|
|
8
|
+
export declare const listVersions: CraftmypdfEndpoints['templatesListVersions'];
|
|
9
|
+
export declare const retainVersions: CraftmypdfEndpoints['templatesRetainVersions'];
|
|
10
|
+
export declare const queryUsage: CraftmypdfEndpoints['templatesQueryUsage'];
|
|
11
|
+
//# sourceMappingURL=templates.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"templates.d.ts","sourceRoot":"","sources":["../../endpoints/templates.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,IAAI,CAAC;AAS9C,eAAO,MAAM,IAAI,EAAE,mBAAmB,CAAC,eAAe,CAkCpD,CAAC;AAEH,eAAO,MAAM,GAAG,EAAE,mBAAmB,CAAC,cAAc,CAkBlD,CAAC;AAEH,eAAO,MAAM,MAAM,EAAE,mBAAmB,CAAC,iBAAiB,CAexD,CAAC;AAEH,eAAO,MAAM,MAAM,EAAE,mBAAmB,CAAC,iBAAiB,CAexD,CAAC;AAEH,eAAO,MAAM,UAAU,EAAE,mBAAmB,CAAC,qBAAqB,CA2BhE,CAAC;AAEH,eAAO,MAAM,QAAQ,EAAE,mBAAmB,CAAC,mBAAmB,CAuB5D,CAAC;AAEH,eAAO,MAAM,YAAY,EAAE,mBAAmB,CAAC,uBAAuB,CAoBpE,CAAC;AAEH,eAAO,MAAM,cAAc,EAAE,mBAAmB,CAAC,yBAAyB,CAwBxE,CAAC;AAEH,eAAO,MAAM,UAAU,EAAE,mBAAmB,CAAC,qBAAqB,CA4BhE,CAAC"}
|