@did-space/fs-driver 0.2.172 → 0.3.0

package/dist/operator/index.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { ReadOptions, WriteOptions, SpaceOperatorProtocol, SpaceConfig, AppSpaceOptions, DeleteOptions, ListOptions, Object, Data, ListsOptions, GetHashOptions } from '@did-space/core';
+import { ReadOptions, WriteOptions, SpaceOperatorProtocol, SpaceConfig, AppSpaceOptions, DeleteOptions, ListOptions, Object, Data, ListsOptions, GetHashOptions, WriteAsOwnerOptions, ReadAsOwnerOptions, DeleteAsOwnerOptions, ExistsAsOwnerOptions } from '@did-space/core';
 import { Stream } from 'stream';
 type PathStatus = {
     objects: number;
@@ -19,7 +19,8 @@ export declare class FsSpaceOperator implements SpaceOperatorProtocol {
     isSpaceCreated(): Promise<boolean>;
     getSpaceSize(): Promise<number>;
     /**
-     * @description @jianchao 这个 getStatusAsOwner 应该 join blocklet 的 data dir，目前不修改，因为需要充分测试
+     * @FIXME @jianchao 这个 getStatusAsOwner 应该 join blocklet 的 data dir，目前不修改，因为需要充分测试
+     * @description
      * @param {string} path
      * @return {*}  {Promise<PathStatus>}
      * @memberof FsSpaceOperator
@@ -43,9 +44,9 @@ export declare class FsSpaceOperator implements SpaceOperatorProtocol {
      */
     lists(options: ListsOptions): Promise<Object[]>;
     list(options: ListOptions): Promise<Object>;
-    writeAsOwner(key: string, data: Data): Promise<void>;
-    deleteAsOwner(key: string): Promise<void>;
-    readAsOwner(key: string): Promise<Stream>;
-    existsAsOwner(key: string): Promise<boolean>;
+    writeAsOwner(key: string, data: Data, options?: WriteAsOwnerOptions): Promise<void>;
+    deleteAsOwner(key: string, options?: DeleteAsOwnerOptions): Promise<void>;
+    readAsOwner(key: string, options?: ReadAsOwnerOptions): Promise<Stream>;
+    existsAsOwner(key: string, options?: ExistsAsOwnerOptions): Promise<boolean>;
 }
 export {};

package/dist/operator/index.js

@@ -1,4 +1,27 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -16,16 +39,21 @@ exports.FsSpaceOperator = void 0;
 /* eslint-disable @typescript-eslint/no-unused-vars */
 const core_1 = require("@did-space/core");
 const filehound_1 = __importDefault(require("filehound"));
-const fs_extra_1 = __importDefault(require("fs-extra"));
+const fs_extra_1 = __importStar(require("fs-extra"));
 const lodash_1 = require("lodash");
 const mime_types_1 = __importDefault(require("mime-types"));
 const path_1 = require("path");
 const stream_1 = require("stream");
-const hasha_1 = __importDefault(require("hasha"));
+const debug_1 = __importDefault(require("debug"));
 const read_stream_to_file_1 = require("./read-stream-to-file");
+const debug = (0, debug_1.default)('@did-space/fs-driver:FsSpaceOperator');
+function getPrefix(root) {
+    return root.split('/').slice(0, -1).join('/');
+}
 class FsSpaceOperator {
     constructor(options) {
         this.options = options;
+        debug('FsSpaceOperator.constructor', JSON.stringify({ options }));
     }
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     createSpace(_spaceConfig) {
@@ -45,7 +73,8 @@ class FsSpaceOperator {
         });
     }
     /**
-     * @description @jianchao 这个 getStatusAsOwner 应该 join blocklet 的 data dir，目前不修改，因为需要充分测试
+     * @FIXME @jianchao 这个 getStatusAsOwner 应该 join blocklet 的 data dir，目前不修改，因为需要充分测试
+     * @description
      * @param {string} path
      * @return {*}  {Promise<PathStatus>}
      * @memberof FsSpaceOperator
@@ -121,9 +150,7 @@ class FsSpaceOperator {
     getHash(options) {
         return __awaiter(this, void 0, void 0, function* () {
             const streamData = yield this.read(options);
-            const hash = yield hasha_1.default.fromStream(streamData, {
-                algorithm: 'md5',
-            });
+            const hash = yield (0, core_1.getHash)(streamData);
             return hash;
         });
     }
@@ -141,8 +168,14 @@ class FsSpaceOperator {
      */
     lists(options) {
         return __awaiter(this, void 0, void 0, function* () {
-            const path = (0, path_1.join)(this.options.root, options.key);
-            if (!(yield this.existsAsOwner(options.key))) {
+            debug('lists.before', JSON.stringify({ options }));
+            let path = (0, path_1.join)(this.options.root, options.key);
+            if (options === null || options === void 0 ? void 0 : options.useGlobal) {
+                const prefix = this.options.root.split('/').slice(0, -1).join('/');
+                path = (0, path_1.join)(prefix, options.key);
+                debug('lists.$prefix', prefix);
+            }
+            if (!(yield this.existsAsOwner(options.key, options))) {
                 return [];
             }
             // 以 非递归的方式 && 显示文件夹 的方式列出当前文件
@@ -214,9 +247,18 @@ class FsSpaceOperator {
             mimeType: mime_types_1.default.lookup(objectName) || 'unknown',
         };
     }
-    writeAsOwner(key, data) {
+    writeAsOwner(key, data, options) {
         return __awaiter(this, void 0, void 0, function* () {
-            const objectPath = (0, path_1.join)(this.options.root, key);
+            debug('writeAsOwner.before', JSON.stringify({ key, options }));
+            let objectPath = (0, path_1.join)(this.options.root, key);
+            if (options === null || options === void 0 ? void 0 : options.useGlobal) {
+                const prefix = this.options.root.split('/').slice(0, -1).join('/');
+                objectPath = (0, path_1.join)(prefix, key);
+                debug('writeAsOwner.$prefix', prefix);
+            }
+            yield (0, fs_extra_1.ensureDir)((0, path_1.dirname)(objectPath));
+            debug('writeAsOwner.$dirname(objectPath)', (0, path_1.dirname)(objectPath));
+            debug('writeAsOwner.$objectPath', objectPath);
             if (objectPath.endsWith('/')) {
                 // 这是一个文件夹
                 yield fs_extra_1.default.ensureDir(objectPath);
@@ -233,16 +275,42 @@ class FsSpaceOperator {
             }
         });
     }
-    deleteAsOwner(key) {
-        return fs_extra_1.default.remove((0, path_1.join)(this.options.root, key));
+    deleteAsOwner(key, options) {
+        debug('deleteAsOwner.before', JSON.stringify({ key, options }));
+        debug('deleteAsOwner.$this.options.root', this.options.root);
+        let $key = (0, path_1.join)(this.options.root, key);
+        if (options === null || options === void 0 ? void 0 : options.useGlobal) {
+            const prefix = this.options.root.split('/').slice(0, -1).join('/');
+            $key = (0, path_1.join)(prefix, key);
+            debug('deleteAsOwner.$prefix', prefix);
+        }
+        debug('deleteAsOwner.$$key', $key);
+        return fs_extra_1.default.remove($key);
     }
-    readAsOwner(key) {
-        // FIXME: @yejianchao 应该可以refactor，但是我还需要测试一下
-        return fs_extra_1.default.readFile((0, path_1.join)(this.options.root, key)).then((data) => stream_1.Readable.from(data));
+    readAsOwner(key, options) {
+        debug('readAsOwner.before', JSON.stringify({ key, options }));
+        // FIXME: @yejianchao 这里的 key 不能以 / 开头
+        let $key = (0, path_1.join)(this.options.root, key);
+        if (options === null || options === void 0 ? void 0 : options.useGlobal) {
+            const prefix = this.options.root.split('/').slice(0, -1).join('/');
+            $key = (0, path_1.join)(prefix, key);
+            debug('readAsOwner.$prefix', prefix);
+        }
+        debug('readAsOwner.$key', $key);
+        // @ts-expect-error
+        return fs_extra_1.default.createReadStream($key);
     }
-    existsAsOwner(key) {
+    existsAsOwner(key, options) {
+        debug('existsAsOwner.before', JSON.stringify({ key, options }));
+        let path = (0, path_1.join)(this.options.root, key);
+        if (options === null || options === void 0 ? void 0 : options.useGlobal) {
+            const prefix = getPrefix(this.options.root);
+            path = (0, path_1.join)(prefix, key);
+            debug('existsAsOwner.$prefix', prefix);
+        }
+        debug('existsAsOwner.$path', path);
         // @ts-expect-error
-        return fs_extra_1.default.existsSync((0, path_1.join)(this.options.root, key));
+        return fs_extra_1.default.existsSync(path);
     }
 }
 exports.FsSpaceOperator = FsSpaceOperator;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@did-space/fs-driver",
-  "version": "0.2.172",
+  "version": "0.3.0",
   "publishConfig": {
     "access": "public"
   },
@@ -32,7 +32,8 @@
     ]
   },
   "dependencies": {
-    "@did-space/core": "0.2.172",
+    "@did-space/core": "0.3.0",
+    "debug": "^4.3.4",
     "filehound": "^1.17.6",
     "fs-extra": "^10.1.0",
     "hasha": "^5.2.2",
@@ -55,5 +56,5 @@
     "ts-jest": "^28.0.6",
     "typescript": "^4.9.5"
   },
-  "gitHead": "0f221e8d8ec17645130499297d7a4a4ae0ef0efb"
+  "gitHead": "a883d2a4ab600138c8a23093ace6b94d9107e43e"
 }