@did-space/core 0.3.5 → 0.3.6

package/dist/meta/object.d.ts

@@ -19,5 +19,11 @@ export interface Object {
      * @memberof Object
      */
     mimeType: string;
+    /**
+     * @description 对象的 hash 值(ipfs CID v1)
+     * @type {string}
+     * @memberof Object
+     */
+    hash?: string;
     [key: string]: any;
 }

package/dist/protocols/space-operator.d.ts

@@ -10,7 +10,7 @@ export interface WriteOptions extends AppSpaceOptions {
     key: string;
     data: Data;
     hash?: string;
-    size?: string;
+    size?: number;
 }
 export interface DeleteOptions extends AppSpaceOptions {
     key: string;

package/dist/space/object-space.d.ts

@@ -19,6 +19,7 @@ export declare class ObjectSpace implements SpaceProtocol {
     readonly treeRepository: TreeRepository;
     readonly objectCollectionRepository: ObjectCollectionRepository;
     readonly globalSpace: GlobalSpace;
+    static readonly READONLY_OBJECT_KEYS: string[];
     constructor(options: ObjectSpaceOptions);
     createSpace(spaceConfig: SpaceConfig): Promise<void>;
     isSpaceCreated(): Promise<boolean>;
@@ -39,6 +40,7 @@ export declare class ObjectSpace implements SpaceProtocol {
      */
     destroyAppSpace(options: AppSpaceOptions): Promise<void>;
     getAppSpacePath(options: AppSpaceOptions): Promise<string>;
+    private verifySpace;
     write(options: WriteOptions): Promise<void>;
     delete(options: DeleteOptions): Promise<void>;
     read(options: ReadOptions): Promise<Stream>;
@@ -108,4 +110,5 @@ export declare class ObjectSpace implements SpaceProtocol {
     isListable(options: PermissionOptions): Promise<boolean>;
     isReadable(options: PermissionOptions): Promise<boolean>;
     isWritable(options: PermissionOptions): Promise<boolean>;
+    static editable(key: string): boolean;
 }

package/dist/space/object-space.js

@@ -18,6 +18,7 @@ const skypesky_sequelize_1 = require("skypesky-sequelize");
 const js_yaml_1 = __importDefault(require("js-yaml"));
 const path_1 = require("path");
 const lodash_1 = require("lodash");
+const xbytes_1 = __importDefault(require("xbytes"));
 const configuration_1 = require("../configuration");
 const model_1 = require("../model");
 const utils_1 = require("../utils");
@@ -102,6 +103,13 @@ class ObjectSpace {
     destroyAppSpace(options) {
         return __awaiter(this, void 0, void 0, function* () {
             debug('destroyAppSpace.before', JSON.stringify({ options }));
+            const permissionOptions = {
+                fromAppDid: options.appDid,
+                toAppDid: options.appDid,
+            };
+            yield this.setListable(permissionOptions, false);
+            yield this.setReadable(permissionOptions, false);
+            yield this.setWritable(permissionOptions, false);
             yield this.deleteAsOwner(yield this.getAppSpacePath(options));
             debug('destroyAppSpace.after', JSON.stringify({ options }));
         });
@@ -110,6 +118,25 @@ class ObjectSpace {
         // @ts-expect-error
         return (0, path_1.join)(`/${constants_1.APPS}`, `${options.appDid}/`);
     }
+    verifySpace(size = 0) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function* () {
+            debug('verifySpace.before', { size });
+            const [did, capacity, usedCapacity] = yield Promise.all([
+                this.get('did'),
+                this.get('size'),
+                this.getSpaceSize(),
+            ]);
+            const whiteList = ((_b = (_a = process.env) === null || _a === void 0 ? void 0 : _a.SPACE_WHITE_LIST) !== null && _b !== void 0 ? _b : '')
+                .split(',')
+                .map((s) => s.trim())
+                .filter(Boolean);
+            debug('verifySpace.before', { did, capacity, usedCapacity });
+            if (capacity && usedCapacity + size >= capacity && !whiteList.includes(did)) {
+                throw new Error(`Insufficient free space, total capacity is ${(0, xbytes_1.default)(capacity)}, used capacity is ${(0, xbytes_1.default)(usedCapacity)}`);
+            }
+        });
+    }
     write(options) {
         return __awaiter(this, void 0, void 0, function* () {
             debug('write.before', JSON.stringify((0, lodash_1.omit)(options, 'data')));
@@ -120,10 +147,13 @@ class ObjectSpace {
             if (error) {
                 throw error;
             }
-            const { data } = options;
+            // @note: 只有新增的时候才会触发检测
+            if (!(yield this.exists(options))) {
+                yield this.verifySpace(options.size);
+            }
             const key = (0, path_1.join)(yield this.getAppSpacePath(options), options.key);
             // @ts-expect-error
-            yield this.writeAsOwner(key, data, options);
+            yield this.writeAsOwner(key, options.data, options);
             debug('write.after', JSON.stringify({ key }));
         });
     }
@@ -202,11 +232,12 @@ class ObjectSpace {
                 return {
                     key: x.key,
                     name: (0, path_1.basename)(x.key),
-                    isDir: x.type === model_1.TreeModelType.FOLDER,
+                    isDir: false,
                     size: x.Object.size,
                     lastModified: new Date(x.updatedAt).getTime(),
                     editable: true,
                     mimeType: x.Object.meta.mimeType,
+                    hash: x.objectId,
                 };
             })));
         });
@@ -234,6 +265,7 @@ class ObjectSpace {
                     lastModified: new Date(x.updatedAt).getTime(),
                     editable: true,
                     mimeType: x.Object.meta.mimeType,
+                    hash: x.objectId,
                 };
             });
         });
@@ -294,39 +326,9 @@ class ObjectSpace {
             };
         });
     }
-    // private async _addToGlobalStorage(key: string, data: Data, options: WriteAsOwnerOptions): Promise<void> {
-    //   // @note: 注意此处必须存储到全局存储区
-    //   // eslint-disable-next-line no-param-reassign
-    //   options = merge(options, { useGlobal: true });
-    //   const where: WhereOptions<ObjectModel> = {
-    //     id: options.hash,
-    //   };
-    //   debug('_addToGlobalStorage.before', JSON.stringify({ key, options, where }));
-    //   const objectRecord: ObjectModel = await this.objectRepository.findOne({
-    //     where,
-    //     raw: true,
-    //   });
-    //   debug('_addToGlobalStorage.$objectRecord', JSON.stringify(objectRecord));
-    //   if (objectRecord) {
-    //     return;
-    //   }
-    //   // 存储新对象到全局存储区
-    //   const newKey = getHashPath(options.hash);
-    //   await this.driver.writeAsOwner(newKey, data, options);
-    //   // 添加 object 记录
-    //   await this.objectRepository.create({
-    //     id: options.hash,
-    //     size: options.size,
-    //     meta: {
-    //       mimeType: <string>mimeTypes.lookup(key) || 'unknown',
-    //       key,
-    //     },
-    //   });
-    //   debug('_addToGlobalStorage.after', JSON.stringify({ objectRecord }));
-    // }
     _updateAsOwner(key, data, options) {
         return __awaiter(this, void 0, void 0, function* () {
-            debug('_updateAsOwner.before', JSON.stringify({ key, options }));
+            debug('_updateAsOwner.before', { key, options: (0, lodash_1.omit)(options, 'data') });
             if ((0, utils_1.isDirectory)(key)) {
                 return;
             }
@@ -334,7 +336,7 @@ class ObjectSpace {
                 spaceDid: this.spaceDid,
                 key,
             };
-            debug('_updateAsOwner.before', JSON.stringify({ key, options, where }));
+            debug('_updateAsOwner.before', JSON.stringify({ key, options: (0, lodash_1.omit)(options, 'data'), where }));
             const oldTree = yield this.treeRepository.findOne({
                 where,
                 raw: true,
@@ -426,6 +428,8 @@ class ObjectSpace {
                 yield this._updateAsOwner(key, data, options);
             }
             else {
+                // @note: 只有新增的时候才会触发检测
+                yield this.verifySpace(options.size);
                 // 添加新对象
                 yield this._createAsOwner(key, data, options);
             }
@@ -441,6 +445,9 @@ class ObjectSpace {
             if (error) {
                 throw error;
             }
+            if (ObjectSpace.READONLY_OBJECT_KEYS.includes(key)) {
+                throw new Error(`Object ${key} cannot be deleted`);
+            }
             const isDir = key.endsWith('/');
             if (isDir) {
                 // 删除文件夹
@@ -649,5 +656,9 @@ class ObjectSpace {
             return Boolean((permission & configuration_1.Scopes['write:object']) === configuration_1.Scopes['write:object']);
         });
     }
+    static editable(key) {
+        return !ObjectSpace.READONLY_OBJECT_KEYS.includes(key);
+    }
 }
 exports.ObjectSpace = ObjectSpace;
+ObjectSpace.READONLY_OBJECT_KEYS = ['/config.yml'];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@did-space/core",
-  "version": "0.3.5",
+  "version": "0.3.6",
   "publishConfig": {
     "access": "public"
   },
@@ -56,5 +56,5 @@
     "ts-jest": "^28.0.6",
     "typescript": "^4.9.5"
   },
-  "gitHead": "a2de4336bf11be1fec7883a0bc1feb179ea1d865"
+  "gitHead": "232d56b265826f480351e9c111268a4b3cf3d355"
 }