mobiletto 1.2.1 → 2.0.1

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 (124) hide show
  1. package/lib/cjs/index.d.ts +2 -0
  2. package/lib/cjs/index.js +30 -0
  3. package/lib/cjs/package.json +16 -0
  4. package/lib/esm/index.d.ts +2 -0
  5. package/lib/esm/index.js +12 -0
  6. package/package.json +27 -13
  7. package/.babelrc +0 -5
  8. package/.eslintrc.js +0 -14
  9. package/docs/README.md +0 -113
  10. package/docs/af/README.md +0 -481
  11. package/docs/am/README.md +0 -481
  12. package/docs/ar/README.md +0 -481
  13. package/docs/az/README.md +0 -481
  14. package/docs/be/README.md +0 -481
  15. package/docs/bg/README.md +0 -481
  16. package/docs/bn/README.md +0 -481
  17. package/docs/bs/README.md +0 -481
  18. package/docs/ca/README.md +0 -481
  19. package/docs/ceb/README.md +0 -481
  20. package/docs/co/README.md +0 -481
  21. package/docs/cs/README.md +0 -481
  22. package/docs/cy/README.md +0 -481
  23. package/docs/da/README.md +0 -481
  24. package/docs/de/README.md +0 -481
  25. package/docs/el/README.md +0 -481
  26. package/docs/eo/README.md +0 -481
  27. package/docs/es/README.md +0 -481
  28. package/docs/et/README.md +0 -481
  29. package/docs/eu/README.md +0 -481
  30. package/docs/fa/README.md +0 -481
  31. package/docs/fi/README.md +0 -481
  32. package/docs/fr/README.md +0 -481
  33. package/docs/fy/README.md +0 -481
  34. package/docs/ga/README.md +0 -481
  35. package/docs/gd/README.md +0 -481
  36. package/docs/gl/README.md +0 -481
  37. package/docs/gu/README.md +0 -481
  38. package/docs/ha/README.md +0 -481
  39. package/docs/haw/README.md +0 -481
  40. package/docs/he/README.md +0 -481
  41. package/docs/hi/README.md +0 -481
  42. package/docs/hmn/README.md +0 -481
  43. package/docs/hr/README.md +0 -481
  44. package/docs/ht/README.md +0 -481
  45. package/docs/hu/README.md +0 -481
  46. package/docs/hy/README.md +0 -481
  47. package/docs/id/README.md +0 -481
  48. package/docs/ig/README.md +0 -481
  49. package/docs/is/README.md +0 -481
  50. package/docs/it/README.md +0 -481
  51. package/docs/iw/README.md +0 -481
  52. package/docs/ja/README.md +0 -481
  53. package/docs/jv/README.md +0 -481
  54. package/docs/ka/README.md +0 -481
  55. package/docs/kk/README.md +0 -481
  56. package/docs/km/README.md +0 -481
  57. package/docs/kn/README.md +0 -481
  58. package/docs/ko/README.md +0 -481
  59. package/docs/ku/README.md +0 -481
  60. package/docs/ky/README.md +0 -481
  61. package/docs/la/README.md +0 -481
  62. package/docs/lb/README.md +0 -481
  63. package/docs/lo/README.md +0 -481
  64. package/docs/lt/README.md +0 -481
  65. package/docs/lv/README.md +0 -481
  66. package/docs/mg/README.md +0 -481
  67. package/docs/mi/README.md +0 -481
  68. package/docs/mk/README.md +0 -481
  69. package/docs/ml/README.md +0 -481
  70. package/docs/mn/README.md +0 -481
  71. package/docs/mr/README.md +0 -481
  72. package/docs/ms/README.md +0 -481
  73. package/docs/mt/README.md +0 -481
  74. package/docs/my/README.md +0 -481
  75. package/docs/ne/README.md +0 -481
  76. package/docs/nl/README.md +0 -481
  77. package/docs/no/README.md +0 -481
  78. package/docs/ny/README.md +0 -481
  79. package/docs/or/README.md +0 -481
  80. package/docs/pa/README.md +0 -481
  81. package/docs/pl/README.md +0 -481
  82. package/docs/ps/README.md +0 -481
  83. package/docs/pt/README.md +0 -481
  84. package/docs/ro/README.md +0 -481
  85. package/docs/ru/README.md +0 -481
  86. package/docs/rw/README.md +0 -481
  87. package/docs/sd/README.md +0 -481
  88. package/docs/si/README.md +0 -481
  89. package/docs/sk/README.md +0 -481
  90. package/docs/sl/README.md +0 -481
  91. package/docs/sm/README.md +0 -481
  92. package/docs/sn/README.md +0 -481
  93. package/docs/so/README.md +0 -481
  94. package/docs/sq/README.md +0 -481
  95. package/docs/sr/README.md +0 -481
  96. package/docs/st/README.md +0 -481
  97. package/docs/su/README.md +0 -481
  98. package/docs/sv/README.md +0 -481
  99. package/docs/sw/README.md +0 -481
  100. package/docs/ta/README.md +0 -481
  101. package/docs/te/README.md +0 -481
  102. package/docs/tg/README.md +0 -481
  103. package/docs/th/README.md +0 -481
  104. package/docs/tk/README.md +0 -481
  105. package/docs/tl/README.md +0 -481
  106. package/docs/tr/README.md +0 -481
  107. package/docs/tt/README.md +0 -481
  108. package/docs/ug/README.md +0 -481
  109. package/docs/uk/README.md +0 -481
  110. package/docs/ur/README.md +0 -481
  111. package/docs/uz/README.md +0 -481
  112. package/docs/vi/README.md +0 -481
  113. package/docs/xh/README.md +0 -481
  114. package/docs/yi/README.md +0 -481
  115. package/docs/yo/README.md +0 -481
  116. package/docs/zh/README.md +0 -481
  117. package/docs/zu/README.md +0 -481
  118. package/drivers/b2/index.js +0 -451
  119. package/drivers/local/index.js +0 -315
  120. package/drivers/s3/index.js +0 -316
  121. package/hokey.json +0 -16
  122. package/index.js +0 -29
  123. package/test/api.spec.js +0 -512
  124. package/test/crypt.spec.js +0 -67
package/docs/ar/README.md DELETED
@@ -1,481 +0,0 @@
1
- موبيليتو
2
- =========
3
-
4
- Mobiletto عبارة عن طبقة تجريدية لتخزين JavaScript ، مع تشفير اختياري شفاف من جانب العميل.
5
-
6
- # محتويات
7
- * [لماذا موبيليتو؟](# لماذا موبيليتو؟)
8
- * [بداية سريعة](# بدء سريع)
9
- * [Mobiletto CLI](# mobiletto-cli)
10
- * [المصدر](# المصدر)
11
- * [التثبيت](# التثبيت)
12
- * [الدعم والتمويل](# دعم وتمويل)
13
- * [الاستخدام الأساسي](# الاستخدام الأساسي)
14
- * [البيانات الوصفية](# بيانات وصفية)
15
- * [نمط الاستيراد البديل](# نمط الاستيراد البديل)
16
- * [Caching](# Caching)
17
- * [انعكاس](# انعكاس)
18
- * [تشفير شفاف](# تشفير شفاف)
19
- * [Key rotation](# Key-rotation) (دوران المفتاح #)
20
- * [واجهة السائق](# واجهة سائق)
21
- * [تسجيل](# تسجيل)
22
-
23
- # اقرأ هذا بلغة أخرى
24
- تمت ترجمة هذا المستند README.md عبر [hokeylization](https://github.com/cobbzilla/hokeylization) إلى
25
- ** [كل لغة تدعمها ترجمة Google](https://cloud.google.com/translate/docs/languages)! **
26
-
27
- أنا متأكد من أنها ليست مثالية ، لكني آمل أن تكون أفضل من لا شيء!
28
-
29
- [🇸🇦 عربي](docs / ar / README.md)
30
- [🇧🇩 بنغالي](docs / bn / README.md)
31
- [🇩🇪 ألماني](docs / de / README.md)
32
- [🇺🇸 إنجليزي](docs / en / README.md)
33
- [🇪🇸 إسباني](docs / es / README.md)
34
- [🇫🇷 فرنسي](docs / fr / README.md)
35
- [🇹🇩 الهوسا](docs / ha / README.md)
36
- [🇮🇳 هندي](docs / hi / README.md)
37
- [🇮🇩 إندونيسي](docs / id / README.md)
38
- [🇮🇹 إيطالي](docs / it / README.md)
39
- [🇯🇵 باليابانية](docs / ja / README.md)
40
- [🇰🇷 كوري](docs / ko / README.md)
41
- [🇮🇳 مارانثي](مستندات / السيد / README.md)
42
- [🇵🇱 بولندي](docs / pl / README.md)
43
- [🇧🇷 برتغالي](docs / pt / README.md)
44
- [🇷🇺 بالروسية](docs / ru / README.md)
45
- [🇰🇪 السواحيلية](docs / sw / README.md)
46
- [🇵🇭 تاغالوغ](docs / tl / README.md)
47
- [🇹🇷 التركية](docs / tr / README.md)
48
- [🇵🇰 الأردية](docs / ur / README.md)
49
- [🇻🇳 فيتنامي](docs / vi / README.md)
50
- [🇨🇳 الصينية](docs / zh / README.md)
51
-
52
-
53
- ** [📚 ... كل اللغات ...](docs / README.md) **
54
- ----
55
-
56
- ### هل هناك مشكلة في ترجمة التمهيدي؟
57
- هذه الترجمة المحددة لـ [README] الأصلي (https://github.com/cobbzilla/mobiletto/blob/master/README.md)
58
- قد يكون معيبًا - * نرحب بالتصحيحات! * يُرجى إرسال [طلب سحب على GitHub](https://github.com/cobbzilla/mobiletto/pulls) ،
59
- أو إذا لم تكن مرتاحًا لفعل ذلك ، [افتح مشكلة](https://github.com/cobbzilla/mobiletto/issues)
60
-
61
- عند إنشاء مشكلة جديدة على GitHub بخصوص ترجمة ، يرجى القيام بما يلي:
62
- * تضمين عنوان URL للصفحة (نسخ / لصق من شريط عنوان المتصفح)
63
- * تضمين النص الخاطئ بالضبط (نسخ / لصق من المتصفح)
64
- * يرجى وصف ما هو الخطأ - هل الترجمة غير صحيحة؟ هل التنسيق معطل بطريقة ما؟
65
- * يرجى تقديم اقتراح بترجمة أفضل ، أو كيفية تنسيق النص بشكل صحيح
66
- * **شكرًا لك!**
67
-
68
- ## لماذا موبيليتو؟
69
-
70
- ### وداعا حبس البائع!
71
- لدى مختلف موفري التخزين السحابي واجهات برمجة تطبيقات غير متوافقة. حتى أولئك الذين يسعون جاهدين من أجل "التوافق مع S3"
72
- لديهم سلوكيات خاصة.
73
-
74
- عندما تختار بائع تخزين معين لتطبيقك ، إذا قمت بالتشفير مباشرة إلى واجهة برمجة التطبيقات الخاصة بهم ، فإن تطبيقك
75
- تعتمد الآن على تلك الخدمة. مع مرور الوقت وتراكم الكود ، يصبح تغيير البائعين
76
- لا يمكن الدفاع عنه على نحو متزايد. مرحبًا بك في عالم المرح من قفل البائع!
77
-
78
- تم تصميم Mobiletto لحل هذه المشكلة. من خلال ترميز التطبيق الخاص بك إلى واجهة برمجة التطبيقات الخاصة بشركة Mobiletto ، يمكنك ذلك بسهولة
79
- قم بتغيير موفري التخزين واعلم أن طبقة تخزين التطبيق الخاص بك سوف تتصرف بشكل متماثل.
80
-
81
- ### اختبارات مكثفة
82
- يتم اختبار جميع السائقين من أجل سلوك متطابق مع أكثر من 60 اختبارًا لكل سائق.
83
- نقوم باختبار جميع السائقين مع كل مجموعة من:
84
- * التشفير: ممكّن ومعطل
85
- * ذاكرة التخزين المؤقت Redis: ممكّنة ومعطلة
86
-
87
- يمنحنا هذا النهج راحة البال التي سيتصرف بها Mobiletto بغض النظر عن السائق الذي تستخدمه ،
88
- وبغض النظر عما إذا كنت تقوم بتمكين التخزين المؤقت و / أو التشفير.
89
-
90
- ### دعم السائق
91
- برامج تشغيل التخزين Mobiletto الحالية:
92
- * `s3` : Amazon S3
93
- * `b2` : Backblaze B2
94
- * `local` : نظام ملفات محلي
95
-
96
- * نرحب بالمساهمات لدعم المزيد من مزودي التخزين السحابي! *
97
-
98
- ## Mobiletto-CLI
99
- يهدف Mobiletto إلى استخدامه كمكتبة بواسطة كود JavaScript آخر.
100
-
101
- للعمل مع mobiletto في سطر الأوامر ، استخدم [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli)
102
-
103
- ## مصدر
104
- * [mobiletto على GitHub](https://github.com/cobbzilla/mobiletto)
105
- * [mobiletto on npm](https://www.npmjs.com/package/mobiletto)
106
-
107
- ## الدعم والتمويل
108
- أحاول أن أكون مطور برامج محترف مفتوح المصدر. لقد كنت أعمل في
109
- صناعة البرمجيات لسنوات عديدة ، لقد بدأت شركات ناجحة وقمت ببيعها لشركات عامة.
110
- لقد فقدت وظيفتي مؤخرًا ، وليس لدي حقًا أي عمل آخر مرتب
111
-
112
- لذلك سأحاول كتابة برنامج مفيد ومعرفة ما إذا كان ذلك يعمل
113
-
114
- إذا كنت تستمتع باستخدام هذا البرنامج ، فسأكون ممتنًا جدًا حتى لملفات
115
- أصغر [مساهمة شهرية عبر Patreon](https://www.patreon.com/cobbzilla)
116
-
117
- *شكرًا لك!*
118
-
119
- ## تثبيت
120
- التثبيت باستخدام `npm` `yarn` . ربما تريد الإصدار `lite` الذي لا يتضمن جميع ملفات
121
- ملفات README المترجمة:
122
-
123
- npm install mobiletto-lite
124
- yarn add mobiletto-lite
125
-
126
- إذا كنت تريد حقًا ملفات README بكل لغة ، فقم بتثبيت الإصدار الكامل:
127
-
128
- npm install mobiletto
129
- yarn add mobiletto
130
-
131
- ## بداية سريعة
132
- مثال قصير على استخدام مشغل mobiletto `s3` .
133
-
134
- سيعمل هذا الرمز بنفس الطريقة إذا كان برنامج التشغيل `b2` " أو `local` .
135
-
136
- const storage = require('mobiletto')
137
- const bucket = await storage.connect('s3', aws_key, aws_secret, {bucket: 'bk'})
138
-
139
- // list objects: returns array of metadata objects
140
- const listing = await bucket.list()
141
- const dirList = await bucket.list('some/dir/')
142
- const everything = await bucket.list('', {recursive: true})
143
-
144
- // write an entire file
145
- let bytesWritten = await bucket.writeFile('some/path', someBufferOfData)
146
-
147
- // write a file from a stream/generator
148
- bytesWritten = await bucket.write('some/path', streamOrGenerator)
149
-
150
- // read an entire file
151
- // returns null if an exception would otherwise be thrown
152
- const bufferOrNull = await bucket.safeReadFile('some/path')
153
-
154
- // stream-read a file, passing data to callback
155
- const bytesRead = await bucket.read('some/path', (chunk) => { ...do something with chunk... } )
156
-
157
- // remove a file, returns the path removed
158
- let removed = await bucket.remove('some/path') // removed is a string
159
-
160
- // remove a directory, returns array of paths removed
161
- removed = await bucket.remove('some/directory', {recursive: true}) // removed is now an array!
162
-
163
- ----
164
- ## الاستخدام الأساسي
165
- مثال أكثر شمولاً ، يُظهر معظم الميزات المعروضة:
166
-
167
- const { mobiletto } = require('mobiletto')
168
-
169
- // General usage
170
- const api = await mobiletto(driverName, key, secret, opts)
171
-
172
- // To use 'local' driver:
173
- // * key: base directory
174
- // * secret: ignored, can be null
175
- // * opts object:
176
- // * readOnly: optional, never change anything on the filesystem; default is false
177
- // * fileMode: optional, permissions used when creating new files, default is 0600. can be string or integer
178
- // * dirMode: optional, permissions used when creating new directories, default is 0700. can be string or integer
179
- const local = await mobiletto('local', '/home/ubuntu/tmp', null, {fileMode: 0o0600, dirMode: '0700'})
180
-
181
- // To use 's3' driver:
182
- // * key: AWS Access Key ID
183
- // * secret: AWS Secret Key
184
- // * opts object:
185
- // * readOnly: optional, never change anything on the bucket; default is false
186
- // * bucket: required, name of the S3 bucket
187
- // * region: optional, the AWS region to communicate with, default is us-east-1
188
- // * prefix: optional, all read/writes within the S3 bucket will be under this prefix
189
- // * delimiter: optional, directory delimiter, default is '/' (note: always '/' when encryption is enabled)
190
- const s3 = await mobiletto('s3', aws_key, aws_secret, {bucket: 'bk', region: 'us-east-1'})
191
-
192
- // To use 'b2' driver:
193
- // * key: Backblaze Key ID
194
- // * secret: Backblaze Application Key
195
- // * opts object:
196
- // * readOnly: optional, never change anything on the bucket; default is false
197
- // * bucket: required, the ID (**not the name**) of the B2 bucket
198
- // * prefix: optional, all read/writes within the B2 bucket will be under this prefix
199
- // * delimiter: optional, directory delimiter, default is '/' (note: always '/' when encryption is enabled)
200
- // * partSize: optional, large files will be split into chunks of this size when uploading
201
- const b3 = await mobiletto('b2', b2_key_id, b2_app_key, {bucket: 'bk', partSize: 10000000})
202
-
203
- // List files
204
- api.list() // --> returns an array of metadata objects
205
-
206
- // List files recursively
207
- api.list({ recursive: true })
208
-
209
- // List files in a directory
210
- const path = 'some/path'
211
- api.list(path)
212
- api.list(path, { recursive: true }) // also supports recursive flag
213
-
214
- // Visit files in a directory -- visitor function must be async
215
- api.list(path, { visitor: myAsyncFunc })
216
- api.list(path, { visitor: myAsyncFunc, recursive: true })
217
-
218
- // The `list` method throws MobilettoNotFoundError if the path does not exist
219
- // When you call `safeList` on a non-existent path, it returns an empty array
220
- api.safeList('/path/that/does/not/exist') // returns []
221
-
222
- // Read metadata for a file
223
- api.metadata(path) // returns metadata object
224
-
225
- // The `metadata` method throws MobilettoNotFoundError if the path does not exist
226
- // When you call `safeMetadata` on a non-existent path, it returns null
227
- api.safeMetadata('/tmp/does_not_exist') // returns null
228
-
229
- // Read a file
230
- // Provide a callback that writes the data someplace
231
- const callback = (chunk) => { ... write chunk somewhere ... }
232
- api.read(path, callback) // returns count of bytes read
233
-
234
- // Read an entire file at once
235
- const data = await api.readFile(path) // returns a byte Buffer of the file contents
236
-
237
- // Read an entire file at once
238
- // returns null if an exception would otherwise be thrown
239
- const bufferOrNull = await bucket.safeReadFile('some/path')
240
-
241
- // Write a file
242
- // Provide a generator function that yields chunks of data
243
- const generator = function* () {
244
- while ( ... more-data-to-return ... ) {
245
- data = ... load-data ...
246
- yield data
247
- }
248
- }
249
- local.api(path, generator) // returns count of bytes written
250
-
251
- // Write an entire file at once (convenience method)
252
- await api.writeFile(path, bufferOrString) // returns count of bytes written
253
-
254
- // Delete a file
255
- // Quiet param is optional (default false), when set errors will not be thrown if the path does not exist
256
- // Always returns a value or throws an error.
257
- // Return value may be a single string of the file removed, or an array of all files removed (driver-dependent)
258
- const quiet = true
259
- api.remove(path, {quiet}) // returns single path removed
260
-
261
- // Recursively delete a directory and do it quietly (do not report errors)
262
- const recursive = true
263
- const quiet = true
264
- api.remove(path, {recursive, quiet}) // returns array of paths removed
265
-
266
- ## البيانات الوصفية
267
- يقوم الأمر `metadata` بإرجاع البيانات الوصفية حول إدخال واحد في نظام الملفات.
268
- وبالمثل ، فإن القيمة المعادة من الأمر `list` هي مصفوفة من كائنات البيانات الوصفية.
269
-
270
- يبدو كائن البيانات الوصفية كما يلي:
271
-
272
- {
273
- "name": "fully/qualified/path/to/file",
274
- "type": "entry-type",
275
- "size": size-in-bytes,
276
- "ctime": creation-time-epoch-millis,
277
- "mtime": modification-time-epoch-millis
278
- }
279
-
280
- يمكن أن تكون خاصية `type` `file` " `link` أو " `dir` " أو `special` أو "خاص".
281
-
282
- اعتمادًا على نوع برنامج التشغيل ، قد لا يقوم أمر `list` بإرجاع جميع الحقول. خصائص `name` الاسم" و `type`
283
- يجب أن يكون حاضرًا دائمًا. سيعيد أمر `metadata` اللاحق جميع الخصائص المتاحة.
284
-
285
- ## أسلوب الاستيراد البديل
286
- قم باستيراد الوحدة كاملة النطاق `connect` :
287
-
288
- const storage = require('mobiletto')
289
- const opts = {bucket: 'bk', region: 'us-east-1'}
290
- const s3 = await storage.connect('s3', aws_key, aws_secret, opts)
291
- const objectData = await s3.readFile('some/path')
292
-
293
- ## التخزين المؤقت
294
- Mobiletto يعمل بشكل أفضل مع مخبأ <a href="https://redis.io">redis</a> .
295
-
296
- سيحاول Mobiletto الاتصال بنسخة redis على 127.0.0.1:6379
297
-
298
- يمكنك تجاوز أي مما يلي:
299
- * اضبط `MOBILETTO_REDIS_HOST` env var ، mobiletto connect هنا بدلاً من localhost
300
- * اضبط `MOBILETTO_REDIS_PORT` env var ، سيتم استخدام هذا المنفذ
301
-
302
- ستقوم Mobiletto بتخزين جميع مفاتيح redis الخاصة بها بالبادئة `_mobiletto__` . يمكنك تغيير هذا
303
- عن طريق تعيين `MOBILETTO_REDIS_PREFIX` var.
304
-
305
- يمكنك أيضًا تعيين التخزين المؤقت لكل اتصال باستخدام الكائن `opts.redisConfig` :
306
-
307
- const redisConfig = {
308
- enabled: true, // optional, default is true. if false other props are ignored
309
- host: '127.0.0.1',
310
- port: 6379,
311
- prefix: '_mobiletto__'
312
- }
313
- const opts = { redisConfig, bucket: 'bk', region: 'us-east-1' }
314
- const s3 = await storage.connect('s3', aws_key, aws_secret, opts)
315
-
316
- ### ألا تريد تخزين redis مؤقتًا؟
317
- للتعطيل: قم بتمرير `enabled: false` خطأ" في كائن `opts.redisConfig` عند إنشاء اتصالك.
318
-
319
- كما هو موضح أدناه ، سيكون لتعطيل التخزين المؤقت تأثير سلبي على الأداء وسيتسبب في المزيد من الطلبات
320
- للتخزين الذي تحتاجه حقًا.
321
-
322
- ### إرشادات التخزين المؤقت
323
- ** التخزين المشفر **: قراءة / كتابة التخزين المشفر أبطأ قليلاً من المعتاد ،
324
- لكن التنقل حول الدلائل (وهو ما تفعله بعض الأشياء) مكلف إلى حد ما. استخدام ذاكرة التخزين المؤقت redis
325
- سيعطيك دفعة كبيرة في الأداء.
326
-
327
- ذاكرة التخزين المؤقت الافتراضية آمنة ، ولكنها لا تعمل بشكل جيد إذا كان لديك الكثير من عمليات الكتابة / الإزالة.
328
- تؤدي أي عملية كتابة أو إزالة إلى إبطال ذاكرة التخزين المؤقت بالكامل ، مما يضمن أن القراءات اللاحقة ستشاهد ملف
329
- أحدث التغييرات.
330
-
331
- ### أدوات CLI
332
- إذا كنت تستخدم أداة CLI مثل [mobiletto-cli](https://www.npmjs.com/package/mobiletto-cli) ،
333
- ستحتاج بالتأكيد إلى تمكين ذاكرة التخزين المؤقت redis ، لأنها تدوم عبر استدعاءات الأمر `mo` .
334
-
335
- ## انعكاس
336
-
337
- // Copy a local filesystem mobiletto to S3
338
- s3.mirror(local)
339
-
340
- // Mirror a local subdirectory from one mobiletto to an S3 mobiletto, with it's own subdirectory
341
- local.mirror(s3, 'some/local-folder', 'some/s3-folder')
342
-
343
- ينفذ الأمر `mirror` " نسخة لمرة واحدة من جميع الملفات من Mobiletto إلى آخر.
344
- لا يتم تشغيل أي عملية للحفاظ على المرآة بمرور الوقت. قم بتشغيل أمر `mirror` مرة أخرى
345
- لمزامنة أي ملفات مفقودة.
346
-
347
- القيمة المعادة من `mirror` هي كائن بسيط به عدادات لعدد الملفات التي تم بنجاح
348
- معكوسة وعدد الملفات التي بها أخطاء:
349
-
350
- {
351
- success: count-of-files-mirrored,
352
- errors: count-of-files-with-errors
353
- }
354
-
355
- تحذير: يمكن أن يكون عكس مجموعات البيانات الكبيرة مستهلكًا للوقت ومكثفًا للنطاق الترددي
356
-
357
- باستخدام دلالات استدعاء `mirror` ، قد يكون من المربك أحيانًا فهم من هو
358
- القارئ ومن هو الكاتب. تخيلها مثل بيان مهمة: "left-hand mobiletto"
359
- هو الشيء الذي يتم تخصيصه لـ (بيانات معكوسة مكتوبة) ، و "Mobiletto الأيمن" (
360
- الوسيطة إلى طريقة `mirror` ) هي القيمة التي يتم تعيينها (تتم قراءة البيانات المنعكسة).
361
-
362
- ## تشفير شفاف
363
- تمكين التشفير الشفاف من جانب العميل:
364
-
365
- // Pass encryption parameters
366
- const encryption = {
367
- // key is required, must be >= 16 chars
368
- key: randomstring.generate(128),
369
-
370
- // optional, the default is to derive IV from key
371
- // when set, IV must be >= 16 chars
372
- iv: randomstring.generate(128),
373
-
374
- // optional, the default is aes-256-cbc
375
- algo: 'aes-256-cbc'
376
- }
377
- const api = await mobiletto(driverName, key, secret, opts, encryption)
378
-
379
- // Subsequent write operations will encrypt data (client side) when writing
380
- // Subsequent read operations will decrypt data (client side) when reading
381
-
382
- ماذا يحدث؟ يتتبع دليل "إدخال الدليل" (dirent) المنفصل (المشفر) الملفات الموجودة في ذلك الدليل
383
- الدليل (المعروف أيضًا باسم دليل dirent).
384
- * يقرأ الأمر `list` ملفات إدخال الدليل ، ويفك تشفير كل مسار مدرج ؛ ثم تقوم بإرجاع البيانات الوصفية لكل ملف
385
- * أوامر `list` غير فعالة بشكل أكبر ، خاصة بالنسبة للأدلة التي تحتوي على عدد كبير من الملفات
386
- * يقوم الأمر `write` بكتابة ملفات dirent في دليل الدليل الخاص بكل والد ، بشكل متكرر ؛ ثم يكتب الملف
387
- * أوامر `write` ستتضمن كتابة O (N) ، مع N = عمق في التسلسل الهرمي للدليل
388
- * يقوم الأمر `remove` بإزالة ملف الدليل المقابل ، وملفه الأصلي إذا كان فارغًا ، بشكل متكرر ؛ ثم يزيل الملف
389
- * أوامر `remove` غير العودية ستتعرض لقراءات O (N) ويحتمل أن يتم حذف العديد منها ، مع N = العمق في التسلسل الهرمي للدليل
390
- * أوامر `remove` على أنظمة الملفات الكبيرة والعميقة يمكن أن تكون باهظة الثمن
391
-
392
- لاحظ أنه حتى مع تمكين التشفير من جانب العميل ، فإن الخصم يتمتع برؤية كاملة من جانب الخادم المشفر
393
- التخزين ، حتى بدون المفتاح ، لا يزال بإمكانه رؤية العدد الإجمالي للأدلة وعدد الملفات الموجودة في كل منها ومع
394
- بعض الجهد ، اكتشف بعض أو كل الهيكل العام للتسلسل الهرمي للدليل.
395
- * ملاحظة: استخدم هيكلًا مسطحًا نسبيًا لتحسين الأمان. *
396
- لن يعرف الخصم أسماء الدلائل / الملفات ما لم يعرف أيضًا تشفيرك
397
- مفتاح أو نجح في كسر التشفير. كل الرهانات بعد ذلك!
398
-
399
- ### الأداء والتخزين المؤقت
400
- يمكن أن تكون العمليات على التخزين المشفر بطيئة. يمكن أن تكون عمليات الإزالة والقوائم المتكررة بطيئة للغاية.
401
- يساعد التخزين المؤقت عبر redis بشكل كبير ، ولكن لاحظ أنه يتم مسح ذاكرة التخزين المؤقت عند الكتابة أو الإزالة.
402
-
403
- ## مفتاح التناوب
404
- قم بإنشاء Mobiletto باستخدام مفتاحك الجديد ، ثم قم بنسخ البيانات القديمة فيه:
405
-
406
- const storage = require('mobiletto')
407
-
408
- const oldEncryption = { key: .... }
409
- const oldStorage = await storage.connect('s3', aws_key, aws_secret, {bucket: 'bk', region: 'us-east-1'}, oldEncryption)
410
-
411
- const newEncryption = { key: .... }
412
- const newStorage = await storage.connect('s3', aws_key, aws_secret, {bucket: 'zz', region: 'us-east-1'}, newEncryption)
413
-
414
- newStorage.mirror(oldStorage) // if oldStorage is very large, this may take a looooooong time...
415
-
416
- ## واجهة السائق
417
- السائق هو أي ملف JS يصدر وظيفة "storageClient" بهذا التوقيع:
418
-
419
- function storageClient (key, secret, opts)
420
-
421
- * `key` : سلسلة ، مفتاح API الخاص بك (بالنسبة لبرنامج `local` ، هذا هو الدليل الأساسي)
422
- * `secret` : سلسلة ، سر واجهة برمجة التطبيقات (يمكن حذفه لبرنامج `local` )
423
- * `opts` : كائن ، الخصائص لكل سائق:
424
- * بالنسبة إلى `local` " ، تحدد خصائص " `fileMode` " و `dirMode` كيفية إنشاء ملفات وأدلة جديدة
425
- * بالنسبة لـ `s3` ، تكون `bucket` مطلوبة. الخصائص الاختيارية هي:
426
- * `region`: the S3 region, default is us-east-1
427
- * `prefix`: a prefix to prepend to all S3 paths, default is the empty string
428
- * `delimiter`: the directory delimiter, default is '/'
429
-
430
- يجب أن يحدد الكائن الذي تعرضه دالة storageClient هذه الوظائف:
431
-
432
- // Test the driver before using, ensure proper configuration
433
- async testConfig ()
434
-
435
- // List files in path (or from base-directory)
436
- // If recursive is true, list recursively
437
- // If visitor is defined, it will be an async function. await the visitor function on each file found
438
- // Otherwise, perform the listing and return an array of objects
439
- async list (path, recursive = false, visitor = null) // path may be omitted
440
-
441
- // Read metadata for a path
442
- async metadata (path)
443
-
444
- // Read a file
445
- // callback receives a chunk of data. endCallback is called at end-of-stream
446
- async read (path, callback, endCallback = null)
447
-
448
- // Write a file
449
- // driver must be able to handle a generator or a stream
450
- async write (path, generatorOrReadableStream)
451
-
452
- // Remove a file, or recursively delete a directory
453
- // returns a string of a single path removed, or an array of multiple paths removed
454
- async remove (path, recursive = false, quiet = false)
455
-
456
- ## تسجيل
457
- يستخدم Mobiletto مكتبة التسجيل [winston](https://www.npmjs.com/package/winston).
458
-
459
- سوف تحتوي السجلات ** ** على مسارات ملفات ورسائل خطأ ، ولكنها لن ** ** أبدًا ** تحتوي على مفاتيح وأسرار ،
460
- أو أي معلومات تكوين اتصال أخرى.
461
-
462
- ### تسجيل مستوى
463
- استخدم متغير البيئة `MOBILETTO_LOG_LEVEL` لتعيين مستوى السجل ، باستخدام واحد
464
- من مستويات `npm` المحددة في [https://www.npmjs.com/package/winston#logging-levels](https://www.npmjs.com/package/winston#logging-levels)
465
-
466
- المستوى الافتراضي هو `error` . المستوى الأكثر تفصيلاً هو `silly` ، على الرغم من أن Mobiletto حاليًا
467
- لا يسجل في المستويات أدناه `debug`
468
-
469
- MOBILETTO_LOG_LEVEL=silly # maximum logs!
470
-
471
- ### ملف تسجيل
472
- بشكل افتراضي ، يكتب المسجل إلى وحدة التحكم. لإرسال سجلات إلى ملف ، قم بتعيين `MOBILETTO_LOG_FILE`
473
- متغيرات البيئة. عند تسجيل الدخول إلى ملف ، لن تتم كتابة السجلات إلى وحدة التحكم.
474
-
475
- MOBILETTO_LOG_FILE=/var/my_mobiletto_log
476
-
477
- لإيقاف التسجيل:
478
-
479
- MOBILETTO_LOG_FILE=/dev/null
480
-
481
- </pre>