mobiletto 1.1.8 → 1.1.11

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.
Files changed (117) hide show
  1. package/README.md +56 -4
  2. package/docs/README.md +113 -0
  3. package/docs/af/README.md +455 -0
  4. package/docs/am/README.md +455 -0
  5. package/docs/ar/README.md +455 -0
  6. package/docs/az/README.md +455 -0
  7. package/docs/be/README.md +455 -0
  8. package/docs/bg/README.md +455 -0
  9. package/docs/bn/README.md +455 -0
  10. package/docs/bs/README.md +455 -0
  11. package/docs/ca/README.md +455 -0
  12. package/docs/ceb/README.md +455 -0
  13. package/docs/co/README.md +455 -0
  14. package/docs/cs/README.md +455 -0
  15. package/docs/cy/README.md +455 -0
  16. package/docs/da/README.md +455 -0
  17. package/docs/de/README.md +455 -0
  18. package/docs/el/README.md +455 -0
  19. package/docs/eo/README.md +455 -0
  20. package/docs/es/README.md +455 -0
  21. package/docs/et/README.md +455 -0
  22. package/docs/eu/README.md +455 -0
  23. package/docs/fa/README.md +455 -0
  24. package/docs/fi/README.md +455 -0
  25. package/docs/fr/README.md +455 -0
  26. package/docs/fy/README.md +455 -0
  27. package/docs/ga/README.md +455 -0
  28. package/docs/gd/README.md +455 -0
  29. package/docs/gl/README.md +455 -0
  30. package/docs/gu/README.md +455 -0
  31. package/docs/ha/README.md +455 -0
  32. package/docs/haw/README.md +455 -0
  33. package/docs/he/README.md +455 -0
  34. package/docs/hi/README.md +455 -0
  35. package/docs/hmn/README.md +455 -0
  36. package/docs/hr/README.md +455 -0
  37. package/docs/ht/README.md +455 -0
  38. package/docs/hu/README.md +455 -0
  39. package/docs/hy/README.md +455 -0
  40. package/docs/id/README.md +455 -0
  41. package/docs/ig/README.md +455 -0
  42. package/docs/is/README.md +455 -0
  43. package/docs/it/README.md +455 -0
  44. package/docs/iw/README.md +455 -0
  45. package/docs/ja/README.md +455 -0
  46. package/docs/jv/README.md +455 -0
  47. package/docs/ka/README.md +455 -0
  48. package/docs/kk/README.md +455 -0
  49. package/docs/km/README.md +455 -0
  50. package/docs/kn/README.md +455 -0
  51. package/docs/ko/README.md +455 -0
  52. package/docs/ku/README.md +455 -0
  53. package/docs/ky/README.md +455 -0
  54. package/docs/la/README.md +455 -0
  55. package/docs/lb/README.md +455 -0
  56. package/docs/lo/README.md +455 -0
  57. package/docs/lt/README.md +455 -0
  58. package/docs/lv/README.md +455 -0
  59. package/docs/mg/README.md +455 -0
  60. package/docs/mi/README.md +455 -0
  61. package/docs/mk/README.md +455 -0
  62. package/docs/ml/README.md +455 -0
  63. package/docs/mn/README.md +455 -0
  64. package/docs/mr/README.md +455 -0
  65. package/docs/ms/README.md +455 -0
  66. package/docs/mt/README.md +455 -0
  67. package/docs/my/README.md +455 -0
  68. package/docs/ne/README.md +455 -0
  69. package/docs/nl/README.md +455 -0
  70. package/docs/no/README.md +455 -0
  71. package/docs/ny/README.md +455 -0
  72. package/docs/or/README.md +455 -0
  73. package/docs/pa/README.md +455 -0
  74. package/docs/pl/README.md +455 -0
  75. package/docs/ps/README.md +455 -0
  76. package/docs/pt/README.md +455 -0
  77. package/docs/ro/README.md +455 -0
  78. package/docs/ru/README.md +455 -0
  79. package/docs/rw/README.md +455 -0
  80. package/docs/sd/README.md +455 -0
  81. package/docs/si/README.md +455 -0
  82. package/docs/sk/README.md +455 -0
  83. package/docs/sl/README.md +455 -0
  84. package/docs/sm/README.md +455 -0
  85. package/docs/sn/README.md +455 -0
  86. package/docs/so/README.md +455 -0
  87. package/docs/sq/README.md +455 -0
  88. package/docs/sr/README.md +455 -0
  89. package/docs/st/README.md +455 -0
  90. package/docs/su/README.md +455 -0
  91. package/docs/sv/README.md +455 -0
  92. package/docs/sw/README.md +455 -0
  93. package/docs/ta/README.md +455 -0
  94. package/docs/te/README.md +455 -0
  95. package/docs/tg/README.md +455 -0
  96. package/docs/th/README.md +455 -0
  97. package/docs/tk/README.md +455 -0
  98. package/docs/tl/README.md +455 -0
  99. package/docs/tr/README.md +455 -0
  100. package/docs/tt/README.md +455 -0
  101. package/docs/ug/README.md +455 -0
  102. package/docs/uk/README.md +455 -0
  103. package/docs/ur/README.md +455 -0
  104. package/docs/uz/README.md +455 -0
  105. package/docs/vi/README.md +455 -0
  106. package/docs/xh/README.md +455 -0
  107. package/docs/yi/README.md +455 -0
  108. package/docs/yo/README.md +455 -0
  109. package/docs/zh/README.md +455 -0
  110. package/docs/zu/README.md +455 -0
  111. package/drivers/b2/index.js +24 -6
  112. package/hokey.json +16 -0
  113. package/index.js +33 -17
  114. package/package.json +3 -2
  115. package/test/api.spec.js +319 -306
  116. package/util/logger.js +1 -1
  117. package/util/redis.js +1 -1
@@ -0,0 +1,455 @@
1
+ Mobilettu
2
+ =========
3
+
4
+ Mobiletto hè una strata di astrazione di almacenamiento JavaScript, cù una criptografia trasparente opzionale da u cliente.
5
+
6
+ # Cuntinutu
7
+ * [Perchè Mobiletto?](#Perchè-Mobiletto?)
8
+ * [Inizio rapidu](#Inizio rapidu)
9
+ * [Mobiletto CLI](#mobiletto-cli)
10
+ * [Source](#Source)
11
+ * [Usu di basa](#Usu di basa)
12
+ * [Metadata](#Metadata)
13
+ * [Stile d'importazione alternativu](#Stile d'importazione alternativu)
14
+ * [Caching](#Caching)
15
+ * [Mirroring](#Mirroring)
16
+ * [Cittografia trasparente](#Crittografia-trasparente)
17
+ * [Rotazione di chjave](#Rotazione di chjave)
18
+ * [Interfaccia Driver](#Driver-interface)
19
+ * [Logging](#Logging)
20
+
21
+ # Leghjite questu in un'altra lingua
22
+ Stu documentu README.md hè statu traduttu, via [hokeylization](https://github.com/cobbzilla/hokeylization), in
23
+ **[tutte lingue supportate da Google Translate](https://cloud.google.com/translate/docs/languages)!**
24
+
25
+ Sò sicuru chì ùn hè micca perfettu, ma spergu chì hè megliu cà nunda !
26
+
27
+ [🇸🇦 Arabu](../ar/README.md)
28
+ [🇧🇩 Bengali](../bn/README.md)
29
+ [🇩🇪 Tedesco](../de/README.md)
30
+ [🇺🇸 Inglese](../en/README.md)
31
+ [🇪🇸 Spagnolo](../es/README.md)
32
+ [🇫🇷 Francese](../fr/README.md)
33
+ [🇹🇩 Hausa](../ha/README.md)
34
+ [🇮🇳 Hindi](../hi/README.md)
35
+ [🇮🇩 Indonesian](../id/README.md)
36
+ [🇮🇹 Italian](../it/README.md)
37
+ [🇯🇵 Giapponese](../ja/README.md)
38
+ [🇰🇷 Coreano](../ko/README.md)
39
+ [🇮🇳 Maranthi](../mr/README.md)
40
+ [🇵🇱 Polacco](../pl/README.md)
41
+ [🇧🇷 Portoghese](../pt/README.md)
42
+ [🇷🇺 Russu](../ru/README.md)
43
+ [🇰🇪 Swahili](../sw/README.md)
44
+ [🇵🇭 Tagalog](../tl/README.md)
45
+ [🇹🇷 Turcu](../tr/README.md)
46
+ [🇵🇰 Urdu](../ur/README.md)
47
+ [🇻🇳 Vietnamita](../vi/README.md)
48
+ [🇨🇳 Cinese](../zh/README.md)
49
+
50
+
51
+ **[📚 ... Tutte e lingue ...](../README.md)**
52
+ ----
53
+
54
+ ### Ci hè un prublema cù sta traduzzione di u README ?
55
+ Questa traduzzione particulare di u [README] originale (https://github.com/cobbzilla/mobiletto/blob/master/README.md)
56
+ pò esse difettu -- * e currezzione sò assai benvenute ! * Mandate una [pull request on GitHub](https://github.com/cobbzilla/mobiletto/pulls),
57
+ o se ùn site micca còmode di fà quessa, [apre un prublema](https://github.com/cobbzilla/mobiletto/issues)
58
+
59
+ Quandu create un novu prublema GitHub nantu à una traduzzione, fate:
60
+ * include l'URL di a pagina (copia / incollà da a barra di indirizzu di u navigatore)
61
+ * include u testu esatta chì hè sbagliatu (copia / incollà da u navigatore)
62
+ * per piacè descrivi ciò chì hè sbagliatu -- a traduzzione hè sbagliata? a formattazione hè rotta in qualchì modu?
63
+ * Per piacè offre un suggerimentu di una traduzzione megliu, o cumu u testu deve esse furmatu bè
64
+ * **Grazie!**
65
+
66
+ ## Perchè Mobiletto ?
67
+
68
+ ### Adiu lock-in di u venditore!
69
+ I vari fornitori di almacenamiento in nuvola anu API incompatibili. Ancu quelli chì lottanu per a "compatibilità S3"
70
+ avè cumpurtamenti idiosincratici.
71
+
72
+ Quandu sceglite un venditore di almacenamiento particulari per a vostra app, se codificate direttamente à a so API, a vostra app
73
+ avà dipende di stu serviziu. Quandu u tempu passa è u codice s'accumula, i venditori cambianti diventanu
74
+ sempre più insostenibile. Benvenuti à u mondu divertente di u lock-in di u venditore!
75
+
76
+ Mobiletto hè statu cuncepitu per risolve stu prublema. Codificà a vostra app à l'API di mobiletto, pudete facilmente
77
+ cambia i fornitori di almacenamentu è sapete chì a strata di almacenamentu di a vostra app si comporta in modu identicu.
78
+
79
+ ### Teste estensive
80
+ Tutti i cunduttori sò testati per un cumpurtamentu identicu cù più di 60 teste per ogni cunduttore.
81
+ Testemu tutti i cunduttori cù ogni cumminazione di:
82
+ * Cifratura: sia attivata sia disattivata
83
+ * Cache Redis: sia attivata sia disattivata
84
+
85
+ Stu approcciu ci dà a pace di mente chì u mobiletto si cumportarà u listessu, indipendentemente da quale driver utilizate,
86
+ è indipendentemente da esse attivate a cache è / o a criptografia.
87
+
88
+ ### Supportu di i cunduttori
89
+ Drivers di almacenamento Mobiletto attuali:
90
+ * `s3` : Amazon S3
91
+ * `b2` : Backblaze B2
92
+ * `local` : sistema di fugliale locale
93
+
94
+ * I cuntributi per sustene più fornitori di almacenamentu in nuvola sò assai benvenuti ! *
95
+
96
+ ## mobiletto-cli
97
+ Mobiletto hè destinatu à esse usatu cum'è una biblioteca da un altru codice JavaScript.
98
+
99
+ Per travaglià cù mobiletto à a linea di cummanda, utilizate [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
100
+
101
+ ## Fonte
102
+ * [mobiletto in GitHub](https://github.com/cobbzilla/mobiletto)
103
+ * [mobiletto on npm](https://www.npmjs.com/package/mobiletto)
104
+
105
+ ## Inizio rapidu
106
+ Un brevi esempiu utilizendu u driver mobiletto `s3` .
107
+
108
+ Stu codice correrà u listessu se u driver era `b2` o `local` .
109
+
110
+ const storage = require('mobiletto')
111
+ const bucket = await storage.connect('s3', aws_key, aws_secret, {bucket: 'bk'})
112
+
113
+ // list objects: returns array of metadata objects
114
+ const listing = await bucket.list()
115
+ const dirList = await bucket.list('some/dir/')
116
+ const everything = await bucket.list('', {recursive: true})
117
+
118
+ // write an entire file
119
+ let bytesWritten = await bucket.writeFile('some/path', someBufferOfData)
120
+
121
+ // write a file from a stream/generator
122
+ bytesWritten = await bucket.write('some/path', streamOrGenerator)
123
+
124
+ // read an entire file
125
+ // returns null if an exception would otherwise be thrown
126
+ const bufferOrNull = await bucket.safeReadFile('some/path')
127
+
128
+ // stream-read a file, passing data to callback
129
+ const bytesRead = await bucket.read('some/path', (chunk) => { ...do something with chunk... } )
130
+
131
+ // remove a file, returns the path removed
132
+ let removed = await bucket.remove('some/path') // removed is a string
133
+
134
+ // remove a directory, returns array of paths removed
135
+ removed = await bucket.remove('some/directory', {recursive: true}) // removed is now an array!
136
+
137
+ ----
138
+ ## Usu di basa
139
+ Un esempiu assai più estensivu, chì mostra a maiò parte di e caratteristiche offerte:
140
+
141
+ const { mobiletto } = require('mobiletto')
142
+
143
+ // General usage
144
+ const api = await mobiletto(driverName, key, secret, opts)
145
+
146
+ // To use 'local' driver:
147
+ // * key: base directory
148
+ // * secret: ignored, can be null
149
+ // * opts object:
150
+ // * readOnly: optional, never change anything on the filesystem; default is false
151
+ // * fileMode: optional, permissions used when creating new files, default is 0600. can be string or integer
152
+ // * dirMode: optional, permissions used when creating new directories, default is 0700. can be string or integer
153
+ const local = await mobiletto('local', '/home/ubuntu/tmp', null, {fileMode: 0o0600, dirMode: '0700'})
154
+
155
+ // To use 's3' driver:
156
+ // * key: AWS Access Key ID
157
+ // * secret: AWS Secret Key
158
+ // * opts object:
159
+ // * readOnly: optional, never change anything on the bucket; default is false
160
+ // * bucket: required, name of the S3 bucket
161
+ // * region: optional, the AWS region to communicate with, default is us-east-1
162
+ // * prefix: optional, all read/writes within the S3 bucket will be under this prefix
163
+ // * delimiter: optional, directory delimiter, default is '/' (note: always '/' when encryption is enabled)
164
+ const s3 = await mobiletto('s3', aws_key, aws_secret, {bucket: 'bk', region: 'us-east-1'})
165
+
166
+ // To use 'b2' driver:
167
+ // * key: Backblaze Key ID
168
+ // * secret: Backblaze Application Key
169
+ // * opts object:
170
+ // * readOnly: optional, never change anything on the bucket; default is false
171
+ // * bucket: required, the ID (**not the name**) of the B2 bucket
172
+ // * prefix: optional, all read/writes within the B2 bucket will be under this prefix
173
+ // * delimiter: optional, directory delimiter, default is '/' (note: always '/' when encryption is enabled)
174
+ // * partSize: optional, large files will be split into chunks of this size when uploading
175
+ const b3 = await mobiletto('b2', b2_key_id, b2_app_key, {bucket: 'bk', partSize: 10000000})
176
+
177
+ // List files
178
+ api.list() // --> returns an array of metadata objects
179
+
180
+ // List files recursively
181
+ api.list({ recursive: true })
182
+
183
+ // List files in a directory
184
+ const path = 'some/path'
185
+ api.list(path)
186
+ api.list(path, { recursive: true }) // also supports recursive flag
187
+
188
+ // Visit files in a directory -- visitor function must be async
189
+ api.list(path, { visitor: myAsyncFunc })
190
+ api.list(path, { visitor: myAsyncFunc, recursive: true })
191
+
192
+ // The `list` method throws MobilettoNotFoundError if the path does not exist
193
+ // When you call `safeList` on a non-existent path, it returns an empty array
194
+ api.safeList('/path/that/does/not/exist') // returns []
195
+
196
+ // Read metadata for a file
197
+ api.metadata(path) // returns metadata object
198
+
199
+ // The `metadata` method throws MobilettoNotFoundError if the path does not exist
200
+ // When you call `safeMetadata` on a non-existent path, it returns null
201
+ api.safeMetadata('/tmp/does_not_exist') // returns null
202
+
203
+ // Read a file
204
+ // Provide a callback that writes the data someplace
205
+ const callback = (chunk) => { ... write chunk somewhere ... }
206
+ api.read(path, callback) // returns count of bytes read
207
+
208
+ // Read an entire file at once
209
+ const data = await api.readFile(path) // returns a byte Buffer of the file contents
210
+
211
+ // Read an entire file at once
212
+ // returns null if an exception would otherwise be thrown
213
+ const bufferOrNull = await bucket.safeReadFile('some/path')
214
+
215
+ // Write a file
216
+ // Provide a generator function that yields chunks of data
217
+ const generator = function* () {
218
+ while ( ... more-data-to-return ... ) {
219
+ data = ... load-data ...
220
+ yield data
221
+ }
222
+ }
223
+ local.api(path, generator) // returns count of bytes written
224
+
225
+ // Write an entire file at once (convenience method)
226
+ await api.writeFile(path, bufferOrString) // returns count of bytes written
227
+
228
+ // Delete a file
229
+ // Quiet param is optional (default false), when set errors will not be thrown if the path does not exist
230
+ // Always returns a value or throws an error.
231
+ // Return value may be a single string of the file removed, or an array of all files removed (driver-dependent)
232
+ const quiet = true
233
+ api.remove(path, {quiet}) // returns single path removed
234
+
235
+ // Recursively delete a directory and do it quietly (do not report errors)
236
+ const recursive = true
237
+ const quiet = true
238
+ api.remove(path, {recursive, quiet}) // returns array of paths removed
239
+
240
+ ## Metadata
241
+ U cumandamentu `metadata` torna metadata nantu à una sola entrata di sistema di filesystem.
242
+ In listessu modu, u valore di ritornu da u cumandamentu `list` hè un array di oggetti di metadata.
243
+
244
+ Un oggettu di metadata s'assumiglia cusì:
245
+
246
+ {
247
+ "name": "fully/qualified/path/to/file",
248
+ "type": "entry-type",
249
+ "size": size-in-bytes,
250
+ "ctime": creation-time-epoch-millis,
251
+ "mtime": modification-time-epoch-millis
252
+ }
253
+
254
+ A pruprietà `type` pò esse `file` , `dir` , `link` , o `special` .
255
+
256
+ Sicondu u tipu di driver, un cumandamentu `list` pò micca restituverà tutti i campi. E `name` è `type`
257
+ deve esse sempre presente. Un cumandamentu `metadata` sussegwente restituverà tutte e pruprietà dispunibili.
258
+
259
+ ## Stile d'importazione alternativu
260
+ Impurtà u modulu cumpletu cumpletu è utilizate a funzione `connect` :
261
+
262
+ const storage = require('mobiletto')
263
+ const opts = {bucket: 'bk', region: 'us-east-1'}
264
+ const s3 = await storage.connect('s3', aws_key, aws_secret, opts)
265
+ const objectData = await s3.readFile('some/path')
266
+
267
+ ## Caching
268
+ Mobiletto funziona megliu cù una cache <a href="https://redis.io">redis</a> .
269
+
270
+ Mobiletto pruverà à cunnette à una istanza redis in 127.0.0.1:6379
271
+
272
+ Pudete annullà unu di questi:
273
+ * Impostate l'env var `MOBILETTO_REDIS_HOST` , mobiletto cunnetta quì invece di localhost
274
+ * Stabilite u `MOBILETTO_REDIS_PORT` env var, stu portu serà utilizatu
275
+
276
+ Mobiletto salvarà tutte e so chjave redis cù u prefissu `_mobiletto__` . Pudete cambià questu
277
+ insettendu u `MOBILETTO_REDIS_PREFIX` env var.
278
+
279
+ Pudete ancu stabilisce a cache per cunnessione cù l'ughjettu `opts.redisConfig` :
280
+
281
+ const redisConfig = {
282
+ enabled: true, // optional, default is true. if false other props are ignored
283
+ host: '127.0.0.1',
284
+ port: 6379,
285
+ prefix: '_mobiletto__'
286
+ }
287
+ const opts = { redisConfig, bucket: 'bk', region: 'us-east-1' }
288
+ const s3 = await storage.connect('s3', aws_key, aws_secret, opts)
289
+
290
+ ### Ùn vogliu micca caching redis ?
291
+ Per disattivà: passate `enabled: false` in u vostru ughjettu `opts.redisConfig` quandu stabilisce a vostra cunnessione.
292
+
293
+ Comu discutitu quì sottu, disattivà a cache averà un effettu avversu nantu à u rendiment è incurrà più richieste
294
+ à u almacenamentu chì avete veramente bisognu.
295
+
296
+ ### Guida di caching
297
+ **Almacenamiento criptatu**: a lettura/scrittura di u almacenamentu criptatu hè solu un pocu più lento di u normale,
298
+ ma a navigazione intornu à i cartulari (chì alcune cose facenu) hè abbastanza caru. Utilizendu una cache redis
299
+ vi darà un impulsu significativu di rendiment.
300
+
301
+ A cache predeterminata hè sicura, ma ùn funziona micca bè si avete assai operazioni di scrittura / rimuzione.
302
+ Ogni operazione di scrittura o rimozione invalida tutta a cache, assicurendu chì e letture successive vedenu u
303
+ l'ultimi cambiamenti.
304
+
305
+ ### Strumenti CLI
306
+ Sè vo aduprate un strumentu CLI cum'è [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli),
307
+ Definitivamente vulete chì a cache di redis sia attivata, postu chì dura in l'invucazioni di u cumandamentu `mo` .
308
+
309
+ ## Mirroring
310
+
311
+ // Copy a local filesystem mobiletto to S3
312
+ s3.mirror(local)
313
+
314
+ // Mirror a local subdirectory from one mobiletto to an S3 mobiletto, with it's own subdirectory
315
+ local.mirror(s3, 'some/local-folder', 'some/s3-folder')
316
+
317
+ U cumandamentu `mirror` una copia unica di tutti i schedari da un mobiletto à l'altru.
318
+ Ùn eseguisce nisun prucessu per mantene u specchiu cù u tempu. `mirror` di novu
319
+ per sincronizà qualsiasi fugliali mancanti.
320
+
321
+ U valore di ritornu da `mirror` hè un ughjettu simplice cù cuntatori per quanti schedari sò stati successu
322
+ mirrored è quanti schedari avianu errore:
323
+
324
+ {
325
+ success: count-of-files-mirrored,
326
+ errors: count-of-files-with-errors
327
+ }
328
+
329
+ AVVERTENZA: Mirroring setti grandi di dati pò esse assai tempu è intensivi in larghezza di banda
330
+
331
+ Cù a `mirror` " pò esse cunfusu per capisce quale hè u
332
+ lettore è quale hè u scrittore. Immaginate cum'è una dichjarazione di assignazione: u "mobiletto di manca"
333
+ hè a cosa chì hè attribuita à (dati specchiati scritti), è u "mobiletto à destra" (u
334
+ argumentu à u metudu `mirror` ) hè u valore chì hè assignatu (i dati specchi sò letti).
335
+
336
+ ## Criptazione trasparente
337
+ Abilita a criptografia trasparente di u cliente:
338
+
339
+ // Pass encryption parameters
340
+ const encryption = {
341
+ // key is required, must be >= 16 chars
342
+ key: randomstring.generate(128),
343
+
344
+ // optional, the default is to derive IV from key
345
+ // when set, IV must be >= 16 chars
346
+ iv: randomstring.generate(128),
347
+
348
+ // optional, the default is aes-256-cbc
349
+ algo: 'aes-256-cbc'
350
+ }
351
+ const api = await mobiletto(driverName, key, secret, opts, encryption)
352
+
353
+ // Subsequent write operations will encrypt data (client side) when writing
354
+ // Subsequent read operations will decrypt data (client side) when reading
355
+
356
+ Chì succede ? Un repertoriu separatu di "entrata di u repertoriu" (direttivu) (cifratu) traccia ciò chì i schedari sò in questu
357
+ annuariu (aka u cartulare dirent).
358
+ * U cumandamentu `list` leghje i fugliali di entrata di u cartulare, decripta ogni percorsu listatu; poi torna metadata per ogni schedariu
359
+ * I cumandamenti `list` sò più inefficienti, in particulare per i cartulari cù un gran numaru di schedari
360
+ * U cumandimu `write` scrive i fugliali dirent in u cartulare dirent di ogni genitore, recursivamente; poi scrive u schedariu
361
+ * I cumandamenti `write` O (N) scrive, cù N = prufundità in a ghjerarchia di u cartulare
362
+ * U cumandamentu `remove` elimina u schedariu dirent currispundente, è u so parente s'ellu hè viotu, recursivamente; poi sguassate u schedariu
363
+ * I cumandamenti "rimuove" non-recursivi `remove` O (N) letture è potenzalmentu quant'è eliminazioni, cù N = prufundità in a ghjerarchia di u cartulare
364
+ * I cumandamenti recursivi `remove` nantu à i sistemi di fugliali grandi è profondi ponu esse caru
365
+
366
+ Nota chì ancu cù a criptografia di u cliente attivata, un avversariu cù visibilità cumpleta in u vostru latu di u servitore criptatu.
367
+ almacenamiento, ancu senza a chjave, pò sempre vede u numeru tutali di cartulari è quanti schedari sò in ognunu, è cù
368
+ qualchì sforzu, scopre una parte o tutta a struttura generale di a ghjerarchia di u repertoriu.
369
+ * Nota: Aduprate una struttura relativamente piatta per una sicurità megliu.*
370
+ L'avversu ùn sapia micca i nomi di i cartulari / fugliali, salvu ch'elli anu cunnisciutu ancu a vostra criptografia
371
+ chjave o avia altrimenti crackatu cù successu a criptografia. Allora tutte e scumesse sò spente!
372
+
373
+ ### Prestazione è cache
374
+ L'operazioni nantu à l'almacenamiento criptatu ponu esse lente. Elenchi recursivi è rimozioni ponu esse assai lenti.
375
+ Caching via redis aiuta tremendamente, ma nutate chì a cache hè sguassata annantu à qualsiasi scrittura o eliminazione.
376
+
377
+ ## Rotazione di chjave
378
+ Crea un mobiletto cù a vostra nova chjave, poi riflette i vechji dati in questu:
379
+
380
+ const storage = require('mobiletto')
381
+
382
+ const oldEncryption = { key: .... }
383
+ const oldStorage = await storage.connect('s3', aws_key, aws_secret, {bucket: 'bk', region: 'us-east-1'}, oldEncryption)
384
+
385
+ const newEncryption = { key: .... }
386
+ const newStorage = await storage.connect('s3', aws_key, aws_secret, {bucket: 'zz', region: 'us-east-1'}, newEncryption)
387
+
388
+ newStorage.mirror(oldStorage) // if oldStorage is very large, this may take a looooooong time...
389
+
390
+ ## Interfaccia di driver
391
+ Un driver hè qualsiasi fugliale JS chì esporta una funzione "storageClient" cù questa firma:
392
+
393
+ function storageClient (key, secret, opts)
394
+
395
+ * `key` : una stringa, a vostra chjave API (per u driver `local` questu hè u cartulare di basa)
396
+ * `secret` : una stringa, u vostru secretu API (pò esse omessi per u driver `local` )
397
+ * `opts` : un oggettu, e proprietà sò per driver:
398
+ * Per `local` , e `fileMode` è `dirMode` determinanu cumu si creanu novi fugliali è cartulari di creazione
399
+ * Per `s3` , a pruprietà `bucket` hè necessaria. Proprietà opzionali sò:
400
+ * `region`: the S3 region, default is us-east-1
401
+ * `prefix`: a prefix to prepend to all S3 paths, default is the empty string
402
+ * `delimiter`: the directory delimiter, default is '/'
403
+
404
+ L'ughjettu chì torna a funzione storageClient deve definisce queste funzioni:
405
+
406
+ // Test the driver before using, ensure proper configuration
407
+ async testConfig ()
408
+
409
+ // List files in path (or from base-directory)
410
+ // If recursive is true, list recursively
411
+ // If visitor is defined, it will be an async function. await the visitor function on each file found
412
+ // Otherwise, perform the listing and return an array of objects
413
+ async list (path, recursive = false, visitor = null) // path may be omitted
414
+
415
+ // Read metadata for a path
416
+ async metadata (path)
417
+
418
+ // Read a file
419
+ // callback receives a chunk of data. endCallback is called at end-of-stream
420
+ async read (path, callback, endCallback = null)
421
+
422
+ // Write a file
423
+ // driver must be able to handle a generator or a stream
424
+ async write (path, generatorOrReadableStream)
425
+
426
+ // Remove a file, or recursively delete a directory
427
+ // returns a string of a single path removed, or an array of multiple paths removed
428
+ async remove (path, recursive = false, quiet = false)
429
+
430
+ ## Logging
431
+ Mobiletto usa a libreria di log [winston](https://www.npmjs.com/package/winston).
432
+
433
+ I logs **conteneranu ** percorsi di fugliali è missaghji d'errore, ma **mai** cuntenenu chjave, secreti,
434
+ o qualsiasi altra infurmazione di cunfigurazione di cunnessione.
435
+
436
+ ### Livellu di log
437
+ Aduprate a variabile d'ambiente `MOBILETTO_LOG_LEVEL` per stabilisce u livellu di log, usendu unu
438
+ di i livelli `npm` definiti in [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
439
+
440
+ U livellu predeterminatu hè `error` . U livellu più verbose hè `silly` , ancu s'ellu hè attualmente mobiletto
441
+ ùn registra micca à i livelli sottu à `debug`
442
+
443
+ MOBILETTO_LOG_LEVEL=silly # maximum logs!
444
+
445
+ ### File di log
446
+ Per automaticamente, u logger scrive à a cunsola. Per mandà logs à un schedariu, stabilisce u `MOBILETTO_LOG_FILE`
447
+ variabile ambientale. Quandu si accede à un schedariu, i logs ùn saranu più scritti in a cunsola.
448
+
449
+ MOBILETTO_LOG_FILE=/var/my_mobiletto_log
450
+
451
+ Per disattivà u logu:
452
+
453
+ MOBILETTO_LOG_FILE=/dev/null
454
+
455
+ </pre>