@webda/fs 4.0.0-beta.3
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 +166 -0
- package/README.md +130 -0
- package/lib/filebinary.service.d.ts +184 -0
- package/lib/filebinary.service.d.ts.map +1 -0
- package/lib/filebinary.service.js +467 -0
- package/lib/filebinary.service.js.map +1 -0
- package/lib/filequeue.service.d.ts +62 -0
- package/lib/filequeue.service.d.ts.map +1 -0
- package/lib/filequeue.service.js +138 -0
- package/lib/filequeue.service.js.map +1 -0
- package/lib/filestore.service.d.ts +133 -0
- package/lib/filestore.service.d.ts.map +1 -0
- package/lib/filestore.service.js +423 -0
- package/lib/filestore.service.js.map +1 -0
- package/lib/index.d.ts +5 -0
- package/lib/index.d.ts.map +1 -0
- package/lib/index.js +5 -0
- package/lib/index.js.map +1 -0
- package/lib/socketpubsub.service.d.ts +150 -0
- package/lib/socketpubsub.service.d.ts.map +1 -0
- package/lib/socketpubsub.service.js +348 -0
- package/lib/socketpubsub.service.js.map +1 -0
- package/package.json +50 -0
- package/webda.module.json +304 -0
|
@@ -0,0 +1,304 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://webda.io/schemas/webda.module.v4.json",
|
|
3
|
+
"beans": {},
|
|
4
|
+
"deployers": {},
|
|
5
|
+
"moddas": {
|
|
6
|
+
"Webda/FileBinary": {
|
|
7
|
+
"Import": "lib/filebinary.service:FileBinary",
|
|
8
|
+
"Schema": {
|
|
9
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
10
|
+
"additionalProperties": false,
|
|
11
|
+
"definitions": {
|
|
12
|
+
"models": {
|
|
13
|
+
"additionalProperties": {
|
|
14
|
+
"items": {
|
|
15
|
+
"type": "string"
|
|
16
|
+
},
|
|
17
|
+
"type": "array"
|
|
18
|
+
},
|
|
19
|
+
"description": "Define the map of models\n* indicates all models\n\nkey is a Store name\nthe string[] represent all valids attributes to store files in * indicates all attributes",
|
|
20
|
+
"type": "object"
|
|
21
|
+
}
|
|
22
|
+
},
|
|
23
|
+
"description": "Configuration parameters for the filesystem-backed binary storage service.",
|
|
24
|
+
"properties": {
|
|
25
|
+
"folder": {
|
|
26
|
+
"description": "Define the folder to store objects in",
|
|
27
|
+
"type": "string"
|
|
28
|
+
},
|
|
29
|
+
"maxFileSize": {
|
|
30
|
+
"default": "10 MB",
|
|
31
|
+
"description": "Define the maximum filesize to accept as direct upload\nGet the max file size in bytes",
|
|
32
|
+
"returns": "the result number",
|
|
33
|
+
"type": "number"
|
|
34
|
+
},
|
|
35
|
+
"maxSize": {
|
|
36
|
+
"default": "10Mb",
|
|
37
|
+
"description": "Maximum size to handle",
|
|
38
|
+
"type": "number"
|
|
39
|
+
},
|
|
40
|
+
"models": {
|
|
41
|
+
"$ref": "#/definitions/models",
|
|
42
|
+
"description": "Define the map of models\n* indicates all models\n\nkey is a Store name\nthe string[] represent all valids attributes to store files in * indicates all attributes"
|
|
43
|
+
},
|
|
44
|
+
"prefix": {
|
|
45
|
+
"type": "string"
|
|
46
|
+
},
|
|
47
|
+
"type": {
|
|
48
|
+
"description": "Type of the service",
|
|
49
|
+
"type": "string"
|
|
50
|
+
},
|
|
51
|
+
"url": {
|
|
52
|
+
"description": "URL to use for direct download",
|
|
53
|
+
"type": "string"
|
|
54
|
+
},
|
|
55
|
+
"openapi": {
|
|
56
|
+
"type": "object",
|
|
57
|
+
"additionalProperties": true
|
|
58
|
+
}
|
|
59
|
+
},
|
|
60
|
+
"required": [
|
|
61
|
+
"folder",
|
|
62
|
+
"models",
|
|
63
|
+
"type"
|
|
64
|
+
],
|
|
65
|
+
"type": "object",
|
|
66
|
+
"title": "FileBinary"
|
|
67
|
+
},
|
|
68
|
+
"Configuration": "lib/filebinary.service:FileBinaryParameters"
|
|
69
|
+
},
|
|
70
|
+
"Webda/FileQueue": {
|
|
71
|
+
"Import": "lib/filequeue.service:FileQueue",
|
|
72
|
+
"Schema": {
|
|
73
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
74
|
+
"additionalProperties": false,
|
|
75
|
+
"definitions": {
|
|
76
|
+
"WaitDelayerDefinition": {
|
|
77
|
+
"additionalProperties": false,
|
|
78
|
+
"description": "Configuration object for selecting and parameterizing a `WaitDelayer` from the registry.",
|
|
79
|
+
"properties": {
|
|
80
|
+
"interval": {
|
|
81
|
+
"description": "Base interval in milliseconds passed to the delayer factory.",
|
|
82
|
+
"type": "number"
|
|
83
|
+
},
|
|
84
|
+
"type": {
|
|
85
|
+
"description": "Key identifying the factory in `WaitDelayerFactories.registry` (e.g. `\"linear\"`, `\"exponential\"`).",
|
|
86
|
+
"type": "string"
|
|
87
|
+
}
|
|
88
|
+
},
|
|
89
|
+
"required": [
|
|
90
|
+
"interval",
|
|
91
|
+
"type"
|
|
92
|
+
],
|
|
93
|
+
"type": "object"
|
|
94
|
+
}
|
|
95
|
+
},
|
|
96
|
+
"description": "Configuration parameters for the filesystem-backed FIFO queue.",
|
|
97
|
+
"properties": {
|
|
98
|
+
"expire": {
|
|
99
|
+
"default": 30,
|
|
100
|
+
"description": "Number of seconds before dropping message",
|
|
101
|
+
"type": "number"
|
|
102
|
+
},
|
|
103
|
+
"folder": {
|
|
104
|
+
"description": "Where to store the queue",
|
|
105
|
+
"type": "string"
|
|
106
|
+
},
|
|
107
|
+
"maxConsumers": {
|
|
108
|
+
"default": 10,
|
|
109
|
+
"description": "Max number of queue consumers\nQueue will auto increase to this max number if queue is loaded\nand it will decrease to just one consumer if no messages are available",
|
|
110
|
+
"type": "number"
|
|
111
|
+
},
|
|
112
|
+
"type": {
|
|
113
|
+
"description": "Type of the service",
|
|
114
|
+
"type": "string"
|
|
115
|
+
},
|
|
116
|
+
"workerDelayer": {
|
|
117
|
+
"$ref": "#/definitions/WaitDelayerDefinition",
|
|
118
|
+
"description": "Delayer between two failed attempts to process messages"
|
|
119
|
+
},
|
|
120
|
+
"workerParallelism": {
|
|
121
|
+
"default": true,
|
|
122
|
+
"description": "Define if worker should process multi message received in //",
|
|
123
|
+
"type": "boolean"
|
|
124
|
+
},
|
|
125
|
+
"openapi": {
|
|
126
|
+
"type": "object",
|
|
127
|
+
"additionalProperties": true
|
|
128
|
+
}
|
|
129
|
+
},
|
|
130
|
+
"required": [
|
|
131
|
+
"folder",
|
|
132
|
+
"type"
|
|
133
|
+
],
|
|
134
|
+
"type": "object",
|
|
135
|
+
"title": "FileQueue"
|
|
136
|
+
},
|
|
137
|
+
"Configuration": "lib/filequeue.service:FileQueueParameters"
|
|
138
|
+
},
|
|
139
|
+
"Webda/FileStore": {
|
|
140
|
+
"Import": "lib/filestore.service:FileStore",
|
|
141
|
+
"Schema": {
|
|
142
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
143
|
+
"additionalProperties": false,
|
|
144
|
+
"definitions": {
|
|
145
|
+
"modelAliases": {
|
|
146
|
+
"additionalProperties": {
|
|
147
|
+
"type": "string"
|
|
148
|
+
},
|
|
149
|
+
"description": "Model Aliases to allow easier rename of Model",
|
|
150
|
+
"type": "object"
|
|
151
|
+
}
|
|
152
|
+
},
|
|
153
|
+
"description": "Configuration parameters for the JSON-file-backed store.",
|
|
154
|
+
"properties": {
|
|
155
|
+
"beautify": {
|
|
156
|
+
"description": "Parameter sent to JSON.stringify when storing the json",
|
|
157
|
+
"type": [
|
|
158
|
+
"string",
|
|
159
|
+
"number"
|
|
160
|
+
]
|
|
161
|
+
},
|
|
162
|
+
"defaultModel": {
|
|
163
|
+
"default": true,
|
|
164
|
+
"description": "When __type model not found, use the model\nIf strict is setup this parameter is not used",
|
|
165
|
+
"type": "boolean"
|
|
166
|
+
},
|
|
167
|
+
"folder": {
|
|
168
|
+
"description": "Local path where to store all `json` files",
|
|
169
|
+
"type": "string"
|
|
170
|
+
},
|
|
171
|
+
"forceModel": {
|
|
172
|
+
"default": false,
|
|
173
|
+
"description": "If set, Store will ignore the __type",
|
|
174
|
+
"type": "boolean"
|
|
175
|
+
},
|
|
176
|
+
"modelAliases": {
|
|
177
|
+
"$ref": "#/definitions/modelAliases",
|
|
178
|
+
"description": "Model Aliases to allow easier rename of Model"
|
|
179
|
+
},
|
|
180
|
+
"models": {
|
|
181
|
+
"default": [
|
|
182
|
+
"Webda/RegistryEntry"
|
|
183
|
+
],
|
|
184
|
+
"description": "Models managed by this Store.",
|
|
185
|
+
"items": {
|
|
186
|
+
"type": "string"
|
|
187
|
+
},
|
|
188
|
+
"type": "array"
|
|
189
|
+
},
|
|
190
|
+
"noCache": {
|
|
191
|
+
"default": false,
|
|
192
|
+
"description": "Disable default memory cache",
|
|
193
|
+
"type": "boolean"
|
|
194
|
+
},
|
|
195
|
+
"slowQueryThreshold": {
|
|
196
|
+
"default": 30000,
|
|
197
|
+
"description": "Slow query threshold",
|
|
198
|
+
"type": "number"
|
|
199
|
+
},
|
|
200
|
+
"strict": {
|
|
201
|
+
"default": false,
|
|
202
|
+
"description": "Allow to load object that does not have the type data\n\nIf set to true, then the Store will only managed the defined _model and no\nmodel extending this one",
|
|
203
|
+
"type": "boolean"
|
|
204
|
+
},
|
|
205
|
+
"type": {
|
|
206
|
+
"description": "Type of the service",
|
|
207
|
+
"type": "string"
|
|
208
|
+
},
|
|
209
|
+
"openapi": {
|
|
210
|
+
"type": "object",
|
|
211
|
+
"additionalProperties": true
|
|
212
|
+
}
|
|
213
|
+
},
|
|
214
|
+
"required": [
|
|
215
|
+
"folder",
|
|
216
|
+
"type"
|
|
217
|
+
],
|
|
218
|
+
"type": "object",
|
|
219
|
+
"title": "FileStore"
|
|
220
|
+
},
|
|
221
|
+
"Configuration": "lib/filestore.service:FileStoreParameters"
|
|
222
|
+
},
|
|
223
|
+
"Webda/SocketPubSub": {
|
|
224
|
+
"Import": "lib/socketpubsub.service:default",
|
|
225
|
+
"Schema": {
|
|
226
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
227
|
+
"additionalProperties": false,
|
|
228
|
+
"description": "Configuration for {@link SocketPubSubService}.",
|
|
229
|
+
"properties": {
|
|
230
|
+
"path": {
|
|
231
|
+
"description": "Filesystem path of the unix-domain socket. The first peer to bind this\npath becomes the broker; subsequent peers connect as clients.",
|
|
232
|
+
"type": "string"
|
|
233
|
+
},
|
|
234
|
+
"reconnectDelay": {
|
|
235
|
+
"default": 100,
|
|
236
|
+
"description": "Reconnect delay in milliseconds when the broker disconnects. A small\nrandom jitter is added on top to avoid stampedes when several clients\nrace to bind a new socket.",
|
|
237
|
+
"type": "number"
|
|
238
|
+
},
|
|
239
|
+
"type": {
|
|
240
|
+
"description": "Type of the service",
|
|
241
|
+
"type": "string"
|
|
242
|
+
},
|
|
243
|
+
"openapi": {
|
|
244
|
+
"type": "object",
|
|
245
|
+
"additionalProperties": true
|
|
246
|
+
}
|
|
247
|
+
},
|
|
248
|
+
"required": [
|
|
249
|
+
"path",
|
|
250
|
+
"type"
|
|
251
|
+
],
|
|
252
|
+
"type": "object",
|
|
253
|
+
"title": "SocketPubSubService"
|
|
254
|
+
},
|
|
255
|
+
"Configuration": "lib/socketpubsub.service:SocketPubSubParameters"
|
|
256
|
+
}
|
|
257
|
+
},
|
|
258
|
+
"models": {},
|
|
259
|
+
"schemas": {
|
|
260
|
+
"Webda/BinaryFile": {
|
|
261
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
262
|
+
"WebdaSchema": true,
|
|
263
|
+
"additionalProperties": false,
|
|
264
|
+
"description": "Represent a file to store",
|
|
265
|
+
"properties": {
|
|
266
|
+
"challenge": {
|
|
267
|
+
"description": "Will be computed by the service\n\nhash of the content prefixed by 'WEBDA'",
|
|
268
|
+
"type": "string"
|
|
269
|
+
},
|
|
270
|
+
"hash": {
|
|
271
|
+
"description": "Will be computed by the service\n\nhash of the content",
|
|
272
|
+
"type": "string"
|
|
273
|
+
},
|
|
274
|
+
"metadata": {
|
|
275
|
+
"description": "Metadatas stored along with the binary"
|
|
276
|
+
},
|
|
277
|
+
"mimetype": {
|
|
278
|
+
"description": "Mimetype of the binary",
|
|
279
|
+
"type": "string"
|
|
280
|
+
},
|
|
281
|
+
"name": {
|
|
282
|
+
"description": "Current name",
|
|
283
|
+
"type": "string"
|
|
284
|
+
},
|
|
285
|
+
"originalname": {
|
|
286
|
+
"description": "Original name",
|
|
287
|
+
"type": "string"
|
|
288
|
+
},
|
|
289
|
+
"size": {
|
|
290
|
+
"description": "Size of the binary",
|
|
291
|
+
"type": "number"
|
|
292
|
+
}
|
|
293
|
+
},
|
|
294
|
+
"required": [
|
|
295
|
+
"mimetype",
|
|
296
|
+
"name",
|
|
297
|
+
"size"
|
|
298
|
+
],
|
|
299
|
+
"type": "object",
|
|
300
|
+
"title": "BinaryFile"
|
|
301
|
+
}
|
|
302
|
+
},
|
|
303
|
+
"behaviors": {}
|
|
304
|
+
}
|