@did-space/core 0.2.172 → 0.3.0

package/dist/space/space.js

@@ -0,0 +1,190 @@
+"use strict";
+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) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Space = void 0;
+const xbytes_1 = __importDefault(require("xbytes"));
+class Space {
+    constructor(driver) {
+        this.driver = driver;
+    }
+    createSpace(spaceConfiguration) {
+        return this.driver.createSpace(spaceConfiguration);
+    }
+    destroySpace() {
+        return this.driver.destroySpace();
+    }
+    isSpaceCreated() {
+        return this.driver.isSpaceCreated();
+    }
+    getSpaceSize() {
+        return this.driver.getSpaceSize();
+    }
+    createAppSpace(options) {
+        return this.driver.createAppSpace(options);
+    }
+    destroyAppSpace(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const permissionOptions = {
+                fromAppDid: options.appDid,
+                toAppDid: options.appDid,
+            };
+            yield this.driver.setListable(permissionOptions, false);
+            yield this.driver.setReadable(permissionOptions, false);
+            yield this.driver.setWritable(permissionOptions, false);
+            return this.driver.destroyAppSpace(options);
+        });
+    }
+    getAppSpacePath(options) {
+        return this.driver.getAppSpacePath(options);
+    }
+    createConfig(spaceConfig) {
+        return this.driver.createConfig(spaceConfig);
+    }
+    destroyConfig() {
+        return this.driver.destroyConfig();
+    }
+    set(key, value) {
+        return this.driver.set(key, value);
+    }
+    get(key) {
+        return this.driver.get(key);
+    }
+    setListable(options, value) {
+        return this.driver.setListable(options, value);
+    }
+    setReadable(options, value) {
+        return this.driver.setReadable(options, value);
+    }
+    setWritable(options, value) {
+        return this.driver.setWritable(options, value);
+    }
+    isListable(options) {
+        return this.driver.isListable(options);
+    }
+    isReadable(options) {
+        return this.driver.isReadable(options);
+    }
+    isWritable(options) {
+        return this.driver.isWritable(options);
+    }
+    getSpaceStatus() {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function* () {
+            // FIXME: @yejianchao 临时性解决方案,需要新增拓容功能,需要去除白名单功能
+            const [did, totalCapacity, usedCapacity] = yield Promise.all([
+                this.driver.get('did'),
+                this.driver.get('size'),
+                this.driver.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);
+            // @see: https://github.com/ArcBlock/did-spaces/issues/269#issuecomment-1430852234
+            // 存储空间无限制
+            if (totalCapacity === 0) {
+                return {
+                    isFull: false,
+                    totalCapacity,
+                    usedCapacity,
+                };
+            }
+            // 跳过白名单
+            if (whiteList.length && whiteList.includes(did)) {
+                return {
+                    isFull: false,
+                    totalCapacity,
+                    usedCapacity,
+                };
+            }
+            // 存储空间不足
+            if (usedCapacity >= totalCapacity) {
+                return {
+                    isFull: true,
+                    totalCapacity,
+                    usedCapacity,
+                };
+            }
+            return {
+                isFull: false,
+                totalCapacity,
+                usedCapacity,
+            };
+        });
+    }
+    write(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // FIXME: @yejianchao 插入数据和编辑数据应该分离?
+            if (yield this.exists(options)) {
+                return this.driver.write(options);
+            }
+            const spaceStatus = yield this.getSpaceStatus();
+            if (spaceStatus.isFull) {
+                throw new Error(`Insufficient free space, total capacity is ${(0, xbytes_1.default)(spaceStatus.totalCapacity)}, used capacity is ${(0, xbytes_1.default)(spaceStatus.usedCapacity)}`);
+            }
+            return this.driver.write(options);
+        });
+    }
+    delete(options) {
+        return this.driver.delete(options);
+    }
+    read(options) {
+        return this.driver.read(options);
+    }
+    getHash(options) {
+        return this.driver.getHash(options);
+    }
+    exists(options) {
+        return this.driver.exists(options);
+    }
+    lists(options) {
+        return this.driver.lists(options);
+    }
+    list(options) {
+        return this.driver.list(options);
+    }
+    writeAsOwner(key, data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // FIXME: @yejianchao 插入数据和编辑数据应该分离
+            if (yield this.existsAsOwner(key)) {
+                return this.driver.writeAsOwner(key, data);
+            }
+            const spaceStatus = yield this.getSpaceStatus();
+            if (spaceStatus.isFull) {
+                throw new Error(`Insufficient free space, total capacity is ${(0, xbytes_1.default)(spaceStatus.totalCapacity)}, used capacity is ${(0, xbytes_1.default)(spaceStatus.usedCapacity)}`);
+            }
+            return this.driver.writeAsOwner(key, data);
+        });
+    }
+    deleteAsOwner(key) {
+        if (Space.READONLY_OBJECT_KEYS.includes(key)) {
+            throw new Error(`Object ${key} cannot be deleted`);
+        }
+        return this.driver.deleteAsOwner(key);
+    }
+    readAsOwner(key, options) {
+        return this.driver.readAsOwner(key, options);
+    }
+    existsAsOwner(key, options) {
+        return this.driver.existsAsOwner(key, options);
+    }
+    getStatusAsOwner(key) {
+        return this.driver.getStatusAsOwner(key);
+    }
+    static editable(key) {
+        return !Space.READONLY_OBJECT_KEYS.includes(key);
+    }
+}
+exports.Space = Space;
+Space.READONLY_OBJECT_KEYS = ['/config.yml'];

package/dist/utils/common.d.ts

@@ -0,0 +1,3 @@
+import { Data } from '../meta';
+export declare function getSize(data: Data): number;
+export declare function isDirectory(key: string): boolean;

package/dist/utils/common.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isDirectory = exports.getSize = void 0;
+function getSize(data) {
+    if (typeof data === 'string') {
+        return Buffer.byteLength(data, 'utf-8');
+    }
+    if (Buffer.isBuffer(data)) {
+        return Buffer.byteLength(data);
+    }
+    throw new Error(`#getSize() Invalid data type: ${data}`);
+}
+exports.getSize = getSize;
+function isDirectory(key) {
+    return key.endsWith('/');
+}
+exports.isDirectory = isDirectory;

package/dist/utils/hash.d.ts

@@ -0,0 +1,20 @@
+import { Data } from '../meta';
+/**
+ *
+ * @see cid各个版本 https://docs.ipfs.tech/concepts/content-addressing/#cid-versions
+ * @see 浏览 markle 树 https://explore.ipld.io/#/
+ * @see cidV0转cidV1 https://cid.ipfs.tech/#QmaNNTsLtScRVUfPn45s2aVbe8jLwfx6yU4Jiu45h6L9FN
+ * @description
+ * @export
+ * @param {Data} data
+ * @return {Promise<string>}  {Promise<string>}
+ */
+export declare function getHash(data: Data): Promise<string>;
+/**
+ * @description
+ * @export
+ * @param {string} hash cid hash
+ * @return {string}  {string}
+ */
+export declare function getHashPath(hash: string): string;
+export declare function isCidV1(cid: string): boolean;

package/dist/utils/hash.js

@@ -0,0 +1,60 @@
+"use strict";
+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) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isCidV1 = exports.getHashPath = exports.getHash = void 0;
+const path_1 = require("path");
+const ipfs_only_hash_1 = __importDefault(require("ipfs-only-hash"));
+const multiformats_1 = require("multiformats");
+const stream_1 = require("./stream");
+/**
+ *
+ * @see cid各个版本 https://docs.ipfs.tech/concepts/content-addressing/#cid-versions
+ * @see 浏览 markle 树 https://explore.ipld.io/#/
+ * @see cidV0转cidV1 https://cid.ipfs.tech/#QmaNNTsLtScRVUfPn45s2aVbe8jLwfx6yU4Jiu45h6L9FN
+ * @description
+ * @export
+ * @param {Data} data
+ * @return {Promise<string>}  {Promise<string>}
+ */
+function getHash(data) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (typeof data === 'string' || Buffer.isBuffer(data) || (0, stream_1.isStream)(data)) {
+            const cidV0 = yield ipfs_only_hash_1.default.of(data);
+            return multiformats_1.CID.parse(cidV0).toV1().toString();
+        }
+        throw new Error(`#getHash() Invalid data type: ${data}`);
+    });
+}
+exports.getHash = getHash;
+/**
+ * @description
+ * @export
+ * @param {string} hash cid hash
+ * @return {string}  {string}
+ */
+function getHashPath(hash) {
+    const [prefix1, prefix2] = [hash.slice(-2), hash.slice(-6, -2)];
+    return (0, path_1.join)('.objects', prefix1, prefix2, hash);
+}
+exports.getHashPath = getHashPath;
+function isCidV1(cid) {
+    try {
+        const c = multiformats_1.CID.parse(cid);
+        return c.version === 1;
+    }
+    catch (_a) {
+        return false;
+    }
+}
+exports.isCidV1 = isCidV1;

package/dist/utils/index.d.ts

@@ -1,3 +1,4 @@
 export * from './logger';
-export * from './stream-to-string';
-export * from './string-to-stream';
+export * from './hash';
+export * from './common';
+export * from './stream';

package/dist/utils/index.js

@@ -15,5 +15,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./logger"), exports);
-__exportStar(require("./stream-to-string"), exports);
-__exportStar(require("./string-to-stream"), exports);
+__exportStar(require("./hash"), exports);
+__exportStar(require("./common"), exports);
+__exportStar(require("./stream"), exports);

package/dist/utils/{string-to-stream.d.ts → stream.d.ts}

@@ -1,3 +1,5 @@
 /// <reference types="node" />
 import { Readable } from 'stream';
+export declare function isStream(data: any): boolean;
 export declare function stringToStream(str: string): Readable;
+export declare const streamToString: (stream: any) => Promise<string>;

package/dist/utils/stream.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.streamToString = exports.stringToStream = exports.isStream = void 0;
+const stream_1 = require("stream");
+const lodash_1 = require("lodash");
+function isStream(data) {
+    return data instanceof stream_1.Stream || data instanceof stream_1.Readable || (0, lodash_1.isFunction)(data === null || data === void 0 ? void 0 : data.pipe);
+}
+exports.isStream = isStream;
+function stringToStream(str) {
+    const stream = new stream_1.Readable();
+    stream.push(str);
+    stream.push(null);
+    return stream;
+}
+exports.stringToStream = stringToStream;
+const streamToString = (stream) => new Promise((resolve, reject) => {
+    const chunks = [];
+    stream.on('data', (chunk) => chunks.push(chunk));
+    stream.on('error', reject);
+    stream.on('end', () => resolve(Buffer.concat(chunks).toString('utf8')));
+});
+exports.streamToString = streamToString;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@did-space/core",
-  "version": "0.2.172",
+  "version": "0.3.0",
   "publishConfig": {
     "access": "public"
   },
@@ -33,7 +33,16 @@
   },
   "dependencies": {
     "@arcblock/validator": "^1.18.89",
+    "debug": "^4.3.4",
+    "hasha": "^5.2.2",
+    "ipfs-only-hash": "^4.0.0",
     "joi": "^17.9.2",
+    "js-yaml": "^4.1.0",
+    "lodash": "^4.17.21",
+    "mime-types": "^2.1.35",
+    "multiformats": "9",
+    "p-all": "3.0.0",
+    "skypesky-sequelize": "^6.32.2",
     "xbytes": "^1.8.0"
   },
   "devDependencies": {
@@ -47,5 +56,5 @@
     "ts-jest": "^28.0.6",
     "typescript": "^4.9.5"
   },
-  "gitHead": "0f221e8d8ec17645130499297d7a4a4ae0ef0efb"
+  "gitHead": "a883d2a4ab600138c8a23093ace6b94d9107e43e"
 }

package/dist/utils/stream-to-string.d.ts

@@ -1 +0,0 @@
-export declare const streamToString: (stream: any) => Promise<string>;

package/dist/utils/stream-to-string.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.streamToString = void 0;
-const streamToString = (stream) => new Promise((resolve, reject) => {
-    const chunks = [];
-    stream.on('data', (chunk) => chunks.push(chunk));
-    stream.on('error', reject);
-    stream.on('end', () => resolve(Buffer.concat(chunks).toString('utf8')));
-});
-exports.streamToString = streamToString;

package/dist/utils/string-to-stream.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.stringToStream = void 0;
-const stream_1 = require("stream");
-function stringToStream(str) {
-    const stream = new stream_1.Readable();
-    stream.push(str);
-    stream.push(null);
-    return stream;
-}
-exports.stringToStream = stringToStream;