@oneblink/sdk 5.1.0-beta.1 → 5.1.0-beta.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.
- package/package.json +1 -1
- package/tenants/classes/PDF.d.ts +34 -1
- package/tenants/classes/PDF.js +40 -0
- package/tenants/classes/PDF.js.map +1 -1
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@oneblink/sdk",
|
|
3
3
|
"description": "OneBlink SDK to serve as an entry point for all OneBlink Services in NodeJS",
|
|
4
|
-
"version": "5.1.0-beta.
|
|
4
|
+
"version": "5.1.0-beta.2",
|
|
5
5
|
"author": "OneBlink <developers@oneblink.io> (https://oneblink.io)",
|
|
6
6
|
"bugs": {
|
|
7
7
|
"url": "https://github.com/oneblink/sdk-node-js/issues"
|
package/tenants/classes/PDF.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/// <reference types="node" />
|
|
2
|
-
import { PDFTypes, SubmissionEventTypes } from '@oneblink/types';
|
|
2
|
+
import { PDFTypes, SubmissionEventTypes, SubmissionTypes } from '@oneblink/types';
|
|
3
3
|
import OneBlinkAPI from '../lib/one-blink-api';
|
|
4
4
|
import { ConstructorOptions } from '../types';
|
|
5
5
|
export default class PDF extends OneBlinkAPI {
|
|
@@ -96,4 +96,37 @@ export default class PDF extends OneBlinkAPI {
|
|
|
96
96
|
* ```
|
|
97
97
|
*/
|
|
98
98
|
generatePDF(options: PDFTypes.GeneratePDFOptions): Promise<Buffer>;
|
|
99
|
+
/**
|
|
100
|
+
* #### Example
|
|
101
|
+
*
|
|
102
|
+
* ```javascript
|
|
103
|
+
* const fs = require('fs')
|
|
104
|
+
* const util = require('util')
|
|
105
|
+
*
|
|
106
|
+
* const writeFileAsync = util.promisify(fs.writeFile)
|
|
107
|
+
*
|
|
108
|
+
* async function run() {
|
|
109
|
+
* const buffer = await pdf.generatePdfFromSubmissionData({
|
|
110
|
+
* submissionData: {
|
|
111
|
+
* submission: {
|
|
112
|
+
* myElementName: 'text 123'
|
|
113
|
+
* }
|
|
114
|
+
* definition: {} // form definition
|
|
115
|
+
* submissionTimestamp: new Date().toISOString(),
|
|
116
|
+
* formsAppId: 1
|
|
117
|
+
* }
|
|
118
|
+
* })
|
|
119
|
+
* await writeFileAsync('./submission.pdf', buffer, 'binary')
|
|
120
|
+
* }
|
|
121
|
+
* ```
|
|
122
|
+
*
|
|
123
|
+
* @param options An object containing all parameters to be passed into the
|
|
124
|
+
* function.
|
|
125
|
+
*/
|
|
126
|
+
generatePdfFromSubmissionData(options: {
|
|
127
|
+
submissionData: SubmissionTypes.S3SubmissionData;
|
|
128
|
+
excludedElementIds?: string[];
|
|
129
|
+
usePagesBreaks?: boolean;
|
|
130
|
+
excludedCSSClasses?: string[];
|
|
131
|
+
}): Promise<Buffer>;
|
|
99
132
|
}
|
package/tenants/classes/PDF.js
CHANGED
|
@@ -130,6 +130,46 @@ class PDF extends one_blink_api_1.default {
|
|
|
130
130
|
});
|
|
131
131
|
return response.buffer();
|
|
132
132
|
}
|
|
133
|
+
/**
|
|
134
|
+
* #### Example
|
|
135
|
+
*
|
|
136
|
+
* ```javascript
|
|
137
|
+
* const fs = require('fs')
|
|
138
|
+
* const util = require('util')
|
|
139
|
+
*
|
|
140
|
+
* const writeFileAsync = util.promisify(fs.writeFile)
|
|
141
|
+
*
|
|
142
|
+
* async function run() {
|
|
143
|
+
* const buffer = await pdf.generatePdfFromSubmissionData({
|
|
144
|
+
* submissionData: {
|
|
145
|
+
* submission: {
|
|
146
|
+
* myElementName: 'text 123'
|
|
147
|
+
* }
|
|
148
|
+
* definition: {} // form definition
|
|
149
|
+
* submissionTimestamp: new Date().toISOString(),
|
|
150
|
+
* formsAppId: 1
|
|
151
|
+
* }
|
|
152
|
+
* })
|
|
153
|
+
* await writeFileAsync('./submission.pdf', buffer, 'binary')
|
|
154
|
+
* }
|
|
155
|
+
* ```
|
|
156
|
+
*
|
|
157
|
+
* @param options An object containing all parameters to be passed into the
|
|
158
|
+
* function.
|
|
159
|
+
*/
|
|
160
|
+
async generatePdfFromSubmissionData(options) {
|
|
161
|
+
const response = await super.request({
|
|
162
|
+
origin: one_blink_api_1.default.tenant.apiOrigin,
|
|
163
|
+
method: 'POST',
|
|
164
|
+
path: '/generate-pdf',
|
|
165
|
+
body: JSON.stringify(options),
|
|
166
|
+
headers: {
|
|
167
|
+
Accept: `application/pdf`,
|
|
168
|
+
'Content-Type': `application/json`,
|
|
169
|
+
},
|
|
170
|
+
});
|
|
171
|
+
return response.buffer();
|
|
172
|
+
}
|
|
133
173
|
}
|
|
134
174
|
exports.default = PDF;
|
|
135
175
|
//# sourceMappingURL=PDF.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"PDF.js","sourceRoot":"","sources":["../../src/classes/PDF.ts"],"names":[],"mappings":";;;;;
|
|
1
|
+
{"version":3,"file":"PDF.js","sourceRoot":"","sources":["../../src/classes/PDF.ts"],"names":[],"mappings":";;;;;AAKA,yEAA8C;AAG9C,MAAqB,GAAI,SAAQ,uBAAW;IAC1C;;;;;;;;;;;;OAYG;IACH,YAAY,OAA2B;QACrC,OAAO,GAAG,OAAO,IAAI,EAAE,CAAA;QACvB,KAAK,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,SAAS,CAAC,CAAA;IAC7C,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,KAAK,CAAC,yBAAyB,CAC7B,OAO2D;QAE3D,IAAI,CAAC,OAAO,EAAE;YACZ,MAAM,IAAI,SAAS,CAAC,mCAAmC,CAAC,CAAA;SACzD;QACD,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,OAAO,CAAA;QACjD,IAAI,CAAC,YAAY,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE;YACrD,MAAM,IAAI,SAAS,CAAC,gDAAgD,CAAC,CAAA;SACtE;QACD,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;YACtD,MAAM,IAAI,SAAS,CAAC,0CAA0C,CAAC,CAAA;SAChE;QAED,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,OAAO,CAAC;YACnC,MAAM,EAAE,uBAAW,CAAC,MAAM,CAAC,SAAS;YACpC,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,UAAU,MAAM,gBAAgB,YAAY,eAAe;YACjE,OAAO,EAAE;gBACP,MAAM,EAAE,iBAAiB;aAC1B;YACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;SAC3B,CAAC,CAAA;QAEF,OAAO,QAAQ,CAAC,MAAM,EAAE,CAAA;IAC1B,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4CG;IACH,KAAK,CAAC,WAAW,CAAC,OAAoC;QACpD,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE;YACnD,MAAM,IAAI,SAAS,CAAC,6CAA6C,CAAC,CAAA;SACnE;QAED,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,OAAO,CAAC;YACnC,MAAM,EAAE,uBAAW,CAAC,MAAM,CAAC,SAAS;YACpC,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,eAAe;YACrB,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YAC7B,OAAO,EAAE;gBACP,MAAM,EAAE,iBAAiB;gBACzB,cAAc,EAAE,kBAAkB;aACnC;SACF,CAAC,CAAA;QAEF,OAAO,QAAQ,CAAC,MAAM,EAAE,CAAA;IAC1B,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,KAAK,CAAC,6BAA6B,CAAC,OAKnC;QACC,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,OAAO,CAAC;YACnC,MAAM,EAAE,uBAAW,CAAC,MAAM,CAAC,SAAS;YACpC,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,eAAe;YACrB,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YAC7B,OAAO,EAAE;gBACP,MAAM,EAAE,iBAAiB;gBACzB,cAAc,EAAE,kBAAkB;aACnC;SACF,CAAC,CAAA;QAEF,OAAO,QAAQ,CAAC,MAAM,EAAE,CAAA;IAC1B,CAAC;CACF;AA5LD,sBA4LC"}
|