@things-factory/board-service 7.0.1-rc.0 → 7.0.1-rc.10
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.
|
@@ -0,0 +1,136 @@
|
|
|
1
|
+
paths:
|
|
2
|
+
/print/:
|
|
3
|
+
get:
|
|
4
|
+
summary: Direct print using query parameters
|
|
5
|
+
tags:
|
|
6
|
+
- board-print
|
|
7
|
+
parameters:
|
|
8
|
+
- name: printerId
|
|
9
|
+
in: query
|
|
10
|
+
required: true
|
|
11
|
+
schema:
|
|
12
|
+
type: string
|
|
13
|
+
description: Printer ID
|
|
14
|
+
- name: data
|
|
15
|
+
in: query
|
|
16
|
+
required: true
|
|
17
|
+
schema:
|
|
18
|
+
type: string
|
|
19
|
+
description: GRF string to print
|
|
20
|
+
responses:
|
|
21
|
+
'200':
|
|
22
|
+
description: Successful print
|
|
23
|
+
content:
|
|
24
|
+
text/plain:
|
|
25
|
+
schema:
|
|
26
|
+
type: string
|
|
27
|
+
post:
|
|
28
|
+
summary: Direct print using request body
|
|
29
|
+
tags:
|
|
30
|
+
- board-print
|
|
31
|
+
requestBody:
|
|
32
|
+
required: true
|
|
33
|
+
content:
|
|
34
|
+
application/json:
|
|
35
|
+
schema:
|
|
36
|
+
type: object
|
|
37
|
+
properties:
|
|
38
|
+
printerId:
|
|
39
|
+
type: string
|
|
40
|
+
description: Printer ID
|
|
41
|
+
data:
|
|
42
|
+
type: string
|
|
43
|
+
description: GRF string to print
|
|
44
|
+
responses:
|
|
45
|
+
'200':
|
|
46
|
+
description: Successful print
|
|
47
|
+
content:
|
|
48
|
+
text/plain:
|
|
49
|
+
schema:
|
|
50
|
+
type: string
|
|
51
|
+
/print-label/{id}:
|
|
52
|
+
get:
|
|
53
|
+
summary: Print label for released version board
|
|
54
|
+
tags:
|
|
55
|
+
- board-print
|
|
56
|
+
parameters:
|
|
57
|
+
- name: id
|
|
58
|
+
in: path
|
|
59
|
+
required: true
|
|
60
|
+
schema:
|
|
61
|
+
type: string
|
|
62
|
+
description: Label ID
|
|
63
|
+
- name: orientation
|
|
64
|
+
in: query
|
|
65
|
+
required: false
|
|
66
|
+
schema:
|
|
67
|
+
type: string
|
|
68
|
+
description: Orientation of the label
|
|
69
|
+
- name: mirror
|
|
70
|
+
in: query
|
|
71
|
+
required: false
|
|
72
|
+
schema:
|
|
73
|
+
type: boolean
|
|
74
|
+
description: Whether to mirror the label
|
|
75
|
+
- name: upsideDown
|
|
76
|
+
in: query
|
|
77
|
+
required: false
|
|
78
|
+
schema:
|
|
79
|
+
type: boolean
|
|
80
|
+
description: Whether to print the label upside down
|
|
81
|
+
- name: printerId
|
|
82
|
+
in: query
|
|
83
|
+
required: true
|
|
84
|
+
schema:
|
|
85
|
+
type: string
|
|
86
|
+
description: Printer ID
|
|
87
|
+
responses:
|
|
88
|
+
'200':
|
|
89
|
+
description: Successful print
|
|
90
|
+
content:
|
|
91
|
+
text/plain:
|
|
92
|
+
schema:
|
|
93
|
+
type: string
|
|
94
|
+
/print-label-draft/{id}:
|
|
95
|
+
get:
|
|
96
|
+
summary: Print label for draft version board
|
|
97
|
+
tags:
|
|
98
|
+
- board-print
|
|
99
|
+
parameters:
|
|
100
|
+
- name: id
|
|
101
|
+
in: path
|
|
102
|
+
required: true
|
|
103
|
+
schema:
|
|
104
|
+
type: string
|
|
105
|
+
description: Label ID
|
|
106
|
+
- name: orientation
|
|
107
|
+
in: query
|
|
108
|
+
required: false
|
|
109
|
+
schema:
|
|
110
|
+
type: string
|
|
111
|
+
description: Orientation of the label
|
|
112
|
+
- name: mirror
|
|
113
|
+
in: query
|
|
114
|
+
required: false
|
|
115
|
+
schema:
|
|
116
|
+
type: boolean
|
|
117
|
+
description: Whether to mirror the label
|
|
118
|
+
- name: upsideDown
|
|
119
|
+
in: query
|
|
120
|
+
required: false
|
|
121
|
+
schema:
|
|
122
|
+
type: boolean
|
|
123
|
+
description: Whether to print the label upside down
|
|
124
|
+
- name: printerId
|
|
125
|
+
in: query
|
|
126
|
+
required: true
|
|
127
|
+
schema:
|
|
128
|
+
type: string
|
|
129
|
+
description: Printer ID
|
|
130
|
+
responses:
|
|
131
|
+
'200':
|
|
132
|
+
description: Successful print
|
|
133
|
+
content:
|
|
134
|
+
text/plain:
|
|
135
|
+
schema:
|
|
136
|
+
type: string
|
|
@@ -0,0 +1,324 @@
|
|
|
1
|
+
paths:
|
|
2
|
+
/headless-full/{id}:
|
|
3
|
+
get:
|
|
4
|
+
summary: Render full headless board by ID
|
|
5
|
+
tags:
|
|
6
|
+
- board-headless
|
|
7
|
+
parameters:
|
|
8
|
+
- name: id
|
|
9
|
+
in: path
|
|
10
|
+
required: true
|
|
11
|
+
schema:
|
|
12
|
+
type: string
|
|
13
|
+
description: Board ID
|
|
14
|
+
- name: access_token
|
|
15
|
+
in: query
|
|
16
|
+
required: false
|
|
17
|
+
schema:
|
|
18
|
+
type: string
|
|
19
|
+
responses:
|
|
20
|
+
'200':
|
|
21
|
+
description: Successful render
|
|
22
|
+
content:
|
|
23
|
+
text/html:
|
|
24
|
+
schema:
|
|
25
|
+
type: string
|
|
26
|
+
|
|
27
|
+
/headless-full-by-name/{name}:
|
|
28
|
+
get:
|
|
29
|
+
summary: Render full headless board by name
|
|
30
|
+
tags:
|
|
31
|
+
- board-headless
|
|
32
|
+
parameters:
|
|
33
|
+
- name: name
|
|
34
|
+
in: path
|
|
35
|
+
required: true
|
|
36
|
+
schema:
|
|
37
|
+
type: string
|
|
38
|
+
description: Board name
|
|
39
|
+
- name: access_token
|
|
40
|
+
in: query
|
|
41
|
+
required: false
|
|
42
|
+
schema:
|
|
43
|
+
type: string
|
|
44
|
+
responses:
|
|
45
|
+
'200':
|
|
46
|
+
description: Successful render
|
|
47
|
+
content:
|
|
48
|
+
text/html:
|
|
49
|
+
schema:
|
|
50
|
+
type: string
|
|
51
|
+
|
|
52
|
+
/headless/{id}:
|
|
53
|
+
get:
|
|
54
|
+
summary: Render headless board by ID
|
|
55
|
+
tags:
|
|
56
|
+
- board-headless
|
|
57
|
+
parameters:
|
|
58
|
+
- name: id
|
|
59
|
+
in: path
|
|
60
|
+
required: true
|
|
61
|
+
schema:
|
|
62
|
+
type: string
|
|
63
|
+
description: Board ID
|
|
64
|
+
- name: access_token
|
|
65
|
+
in: query
|
|
66
|
+
required: false
|
|
67
|
+
schema:
|
|
68
|
+
type: string
|
|
69
|
+
responses:
|
|
70
|
+
'200':
|
|
71
|
+
description: Successful render
|
|
72
|
+
content:
|
|
73
|
+
text/html:
|
|
74
|
+
schema:
|
|
75
|
+
type: string
|
|
76
|
+
|
|
77
|
+
/headless-by-name/{name}:
|
|
78
|
+
get:
|
|
79
|
+
summary: Render headless board by name
|
|
80
|
+
tags:
|
|
81
|
+
- board-headless
|
|
82
|
+
parameters:
|
|
83
|
+
- name: name
|
|
84
|
+
in: path
|
|
85
|
+
required: true
|
|
86
|
+
schema:
|
|
87
|
+
type: string
|
|
88
|
+
description: Board name
|
|
89
|
+
- name: access_token
|
|
90
|
+
in: query
|
|
91
|
+
required: false
|
|
92
|
+
schema:
|
|
93
|
+
type: string
|
|
94
|
+
responses:
|
|
95
|
+
'200':
|
|
96
|
+
description: Successful render
|
|
97
|
+
content:
|
|
98
|
+
text/html:
|
|
99
|
+
schema:
|
|
100
|
+
type: string
|
|
101
|
+
|
|
102
|
+
/headless-player/{id}:
|
|
103
|
+
get:
|
|
104
|
+
summary: Render headless board player by ID
|
|
105
|
+
tags:
|
|
106
|
+
- board-headless
|
|
107
|
+
parameters:
|
|
108
|
+
- name: id
|
|
109
|
+
in: path
|
|
110
|
+
required: true
|
|
111
|
+
schema:
|
|
112
|
+
type: string
|
|
113
|
+
description: Board ID
|
|
114
|
+
- name: access_token
|
|
115
|
+
in: query
|
|
116
|
+
required: false
|
|
117
|
+
schema:
|
|
118
|
+
type: string
|
|
119
|
+
responses:
|
|
120
|
+
'200':
|
|
121
|
+
description: Successful render
|
|
122
|
+
content:
|
|
123
|
+
text/html:
|
|
124
|
+
schema:
|
|
125
|
+
type: string
|
|
126
|
+
|
|
127
|
+
/headless-player-by-name/{name}:
|
|
128
|
+
get:
|
|
129
|
+
summary: Render headless board player by name
|
|
130
|
+
tags:
|
|
131
|
+
- board-headless
|
|
132
|
+
parameters:
|
|
133
|
+
- name: name
|
|
134
|
+
in: path
|
|
135
|
+
required: true
|
|
136
|
+
schema:
|
|
137
|
+
type: string
|
|
138
|
+
description: Board name
|
|
139
|
+
- name: access_token
|
|
140
|
+
in: query
|
|
141
|
+
required: false
|
|
142
|
+
schema:
|
|
143
|
+
type: string
|
|
144
|
+
responses:
|
|
145
|
+
'200':
|
|
146
|
+
description: Successful render
|
|
147
|
+
content:
|
|
148
|
+
text/html:
|
|
149
|
+
schema:
|
|
150
|
+
type: string
|
|
151
|
+
|
|
152
|
+
/thumbnail/{id}:
|
|
153
|
+
get:
|
|
154
|
+
summary: Get board thumbnail by ID
|
|
155
|
+
tags:
|
|
156
|
+
- board-headless
|
|
157
|
+
parameters:
|
|
158
|
+
- name: id
|
|
159
|
+
in: path
|
|
160
|
+
required: true
|
|
161
|
+
schema:
|
|
162
|
+
type: string
|
|
163
|
+
description: Board ID
|
|
164
|
+
responses:
|
|
165
|
+
'200':
|
|
166
|
+
description: Successful thumbnail retrieval
|
|
167
|
+
content:
|
|
168
|
+
image/png:
|
|
169
|
+
schema:
|
|
170
|
+
type: string
|
|
171
|
+
'404':
|
|
172
|
+
description: Thumbnail not found
|
|
173
|
+
|
|
174
|
+
/board-template-thumbnail/{id}:
|
|
175
|
+
get:
|
|
176
|
+
summary: Get board template thumbnail by ID
|
|
177
|
+
tags:
|
|
178
|
+
- board-headless
|
|
179
|
+
parameters:
|
|
180
|
+
- name: id
|
|
181
|
+
in: path
|
|
182
|
+
required: true
|
|
183
|
+
schema:
|
|
184
|
+
type: string
|
|
185
|
+
description: Board template ID
|
|
186
|
+
responses:
|
|
187
|
+
'200':
|
|
188
|
+
description: Successful thumbnail retrieval
|
|
189
|
+
content:
|
|
190
|
+
image/png:
|
|
191
|
+
schema:
|
|
192
|
+
type: string
|
|
193
|
+
'404':
|
|
194
|
+
description: Thumbnail not found
|
|
195
|
+
|
|
196
|
+
/screenshot/{id}:
|
|
197
|
+
get:
|
|
198
|
+
summary: Get screenshot of board by ID
|
|
199
|
+
tags:
|
|
200
|
+
- board-headless
|
|
201
|
+
parameters:
|
|
202
|
+
- name: id
|
|
203
|
+
in: path
|
|
204
|
+
required: true
|
|
205
|
+
schema:
|
|
206
|
+
type: string
|
|
207
|
+
description: Board ID
|
|
208
|
+
- name: access_token
|
|
209
|
+
in: query
|
|
210
|
+
required: false
|
|
211
|
+
schema:
|
|
212
|
+
type: string
|
|
213
|
+
responses:
|
|
214
|
+
'200':
|
|
215
|
+
description: Successful screenshot retrieval
|
|
216
|
+
content:
|
|
217
|
+
image/png:
|
|
218
|
+
schema:
|
|
219
|
+
type: string
|
|
220
|
+
|
|
221
|
+
/board/pdf/{id}:
|
|
222
|
+
get:
|
|
223
|
+
summary: Get PDF of board by ID
|
|
224
|
+
tags:
|
|
225
|
+
- board-headless
|
|
226
|
+
parameters:
|
|
227
|
+
- name: id
|
|
228
|
+
in: path
|
|
229
|
+
required: true
|
|
230
|
+
schema:
|
|
231
|
+
type: string
|
|
232
|
+
description: Board ID
|
|
233
|
+
- name: access_token
|
|
234
|
+
in: query
|
|
235
|
+
required: false
|
|
236
|
+
schema:
|
|
237
|
+
type: string
|
|
238
|
+
responses:
|
|
239
|
+
'200':
|
|
240
|
+
description: Successful PDF retrieval
|
|
241
|
+
content:
|
|
242
|
+
application/pdf:
|
|
243
|
+
schema:
|
|
244
|
+
type: string
|
|
245
|
+
|
|
246
|
+
/label-command/{id}:
|
|
247
|
+
get:
|
|
248
|
+
summary: Get label command for released version board by ID
|
|
249
|
+
tags:
|
|
250
|
+
- board-headless
|
|
251
|
+
parameters:
|
|
252
|
+
- name: id
|
|
253
|
+
in: path
|
|
254
|
+
required: true
|
|
255
|
+
schema:
|
|
256
|
+
type: string
|
|
257
|
+
description: Board ID
|
|
258
|
+
- name: orientation
|
|
259
|
+
in: query
|
|
260
|
+
required: false
|
|
261
|
+
schema:
|
|
262
|
+
type: string
|
|
263
|
+
- name: mirror
|
|
264
|
+
in: query
|
|
265
|
+
required: false
|
|
266
|
+
schema:
|
|
267
|
+
type: boolean
|
|
268
|
+
- name: upsideDown
|
|
269
|
+
in: query
|
|
270
|
+
required: false
|
|
271
|
+
schema:
|
|
272
|
+
type: boolean
|
|
273
|
+
- name: access_token
|
|
274
|
+
in: query
|
|
275
|
+
required: false
|
|
276
|
+
schema:
|
|
277
|
+
type: string
|
|
278
|
+
responses:
|
|
279
|
+
'200':
|
|
280
|
+
description: Successful label command retrieval
|
|
281
|
+
content:
|
|
282
|
+
text/plain:
|
|
283
|
+
schema:
|
|
284
|
+
type: string
|
|
285
|
+
|
|
286
|
+
/label-command-draft/{id}:
|
|
287
|
+
get:
|
|
288
|
+
summary: Get label command for draft version board by ID
|
|
289
|
+
tags:
|
|
290
|
+
- board-headless
|
|
291
|
+
parameters:
|
|
292
|
+
- name: id
|
|
293
|
+
in: path
|
|
294
|
+
required: true
|
|
295
|
+
schema:
|
|
296
|
+
type: string
|
|
297
|
+
description: Board ID
|
|
298
|
+
- name: orientation
|
|
299
|
+
in: query
|
|
300
|
+
required: false
|
|
301
|
+
schema:
|
|
302
|
+
type: string
|
|
303
|
+
- name: mirror
|
|
304
|
+
in: query
|
|
305
|
+
required: false
|
|
306
|
+
schema:
|
|
307
|
+
type: boolean
|
|
308
|
+
- name: upsideDown
|
|
309
|
+
in: query
|
|
310
|
+
required: false
|
|
311
|
+
schema:
|
|
312
|
+
type: boolean
|
|
313
|
+
- name: access_token
|
|
314
|
+
in: query
|
|
315
|
+
required: false
|
|
316
|
+
schema:
|
|
317
|
+
type: string
|
|
318
|
+
responses:
|
|
319
|
+
'200':
|
|
320
|
+
description: Successful label command retrieval
|
|
321
|
+
content:
|
|
322
|
+
text/plain:
|
|
323
|
+
schema:
|
|
324
|
+
type: string
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
openapi: 3.0.0
|
|
2
|
+
info:
|
|
3
|
+
description: >
|
|
4
|
+
For the latest release information please check our [release notes](https://developer.myoperato.com/release_notes).
|
|
5
|
+
The Board Service API exposes board-services endpoint and related functions.
|
|
6
|
+
version: unstable
|
|
7
|
+
title: Board Service
|
|
8
|
+
termsOfService: https://myoperato.com/terms/
|
|
9
|
+
contact:
|
|
10
|
+
email: heartyoh@hatiolab.com
|
|
11
|
+
license:
|
|
12
|
+
name: MIT
|
|
13
|
+
url: http://mit-license.org/
|
|
14
|
+
tags:
|
|
15
|
+
- name: board-print
|
|
16
|
+
description: API to service based on board
|
|
17
|
+
- name: board-headless
|
|
18
|
+
description: API to service based on headless
|
|
19
|
+
schemes:
|
|
20
|
+
- https
|
|
21
|
+
- http
|
|
22
|
+
servers:
|
|
23
|
+
- url: /api/unstable/
|
|
24
|
+
|
|
25
|
+
components:
|
|
26
|
+
securitySchemes:
|
|
27
|
+
basicAuth:
|
|
28
|
+
type: http
|
|
29
|
+
scheme: basic
|
|
30
|
+
bearerAuth:
|
|
31
|
+
type: http
|
|
32
|
+
scheme: bearer
|
|
33
|
+
|
|
34
|
+
security:
|
|
35
|
+
- basicAuth: []
|
|
36
|
+
- bearerAuth: []
|
|
37
|
+
responses:
|
|
38
|
+
UnauthorizedError:
|
|
39
|
+
description: Unauthorized
|
|
40
|
+
|
|
41
|
+
externalDocs:
|
|
42
|
+
description: Find out about our release notes
|
|
43
|
+
url: https://developer.myoperato.com/release_notes
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@things-factory/board-service",
|
|
3
|
-
"version": "7.0.1-rc.
|
|
3
|
+
"version": "7.0.1-rc.10",
|
|
4
4
|
"main": "dist-server/index.js",
|
|
5
5
|
"things-factory": true,
|
|
6
6
|
"author": "",
|
|
@@ -23,11 +23,11 @@
|
|
|
23
23
|
"migration:create": "node ../../node_modules/typeorm/cli.js migration:create -d ./server/migrations"
|
|
24
24
|
},
|
|
25
25
|
"dependencies": {
|
|
26
|
-
"@things-factory/auth-base": "^7.0.1-rc.
|
|
27
|
-
"@things-factory/env": "^7.0.1-rc.
|
|
28
|
-
"@things-factory/fav-base": "^7.0.1-rc.
|
|
29
|
-
"@things-factory/font-base": "^7.0.1-rc.
|
|
30
|
-
"@things-factory/integration-base": "^7.0.1-rc.
|
|
26
|
+
"@things-factory/auth-base": "^7.0.1-rc.10",
|
|
27
|
+
"@things-factory/env": "^7.0.1-rc.8",
|
|
28
|
+
"@things-factory/fav-base": "^7.0.1-rc.10",
|
|
29
|
+
"@things-factory/font-base": "^7.0.1-rc.10",
|
|
30
|
+
"@things-factory/integration-base": "^7.0.1-rc.10",
|
|
31
31
|
"@things-factory/operato-license-checker": "^4.0.4",
|
|
32
32
|
"content-disposition": "^0.5.3",
|
|
33
33
|
"generic-pool": "^3.8.2"
|
|
@@ -36,5 +36,5 @@
|
|
|
36
36
|
"@thiagoelg/node-printer": "0.6.2",
|
|
37
37
|
"puppeteer": "^22.3.0"
|
|
38
38
|
},
|
|
39
|
-
"gitHead": "
|
|
39
|
+
"gitHead": "259524f7aeb4368a5a4792aa31e4d11b525dbb28"
|
|
40
40
|
}
|