@did-space/core 0.2.173 → 0.3.0

package/dist/space/index.d.ts

@@ -1,45 +1,3 @@
-/// <reference types="node" />
-import { Stream } from 'stream';
-import { SpaceConfig } from '../configuration';
-import { Data, Object } from '../meta';
-import { WriteOptions, ReadOptions, SpaceProtocol, DriverProtocol, AppSpaceOptions, PermissionOptions, DeleteOptions, ListOptions, ListsOptions, GetHashOptions, KeyStatus } from '../protocols';
-export declare class Space implements SpaceProtocol {
-    readonly driver: DriverProtocol;
-    static readonly READONLY_OBJECT_KEYS: string[];
-    constructor(driver: DriverProtocol);
-    createSpace(spaceConfiguration: SpaceConfig): Promise<void>;
-    destroySpace(): Promise<void>;
-    isSpaceCreated(): Promise<boolean>;
-    getSpaceSize(): Promise<number>;
-    createAppSpace(options: AppSpaceOptions): Promise<void>;
-    destroyAppSpace(options: AppSpaceOptions): Promise<void>;
-    getAppSpacePath(options: AppSpaceOptions): Promise<string>;
-    createConfig(spaceConfig: SpaceConfig): Promise<void>;
-    destroyConfig(): Promise<void>;
-    set<T = any>(key: string, value: T): Promise<void>;
-    get<T = any>(key: string): Promise<T>;
-    setListable(options: PermissionOptions, value: boolean): Promise<void>;
-    setReadable(options: PermissionOptions, value: boolean): Promise<void>;
-    setWritable(options: PermissionOptions, value: boolean): Promise<void>;
-    isListable(options: PermissionOptions): Promise<boolean>;
-    isReadable(options: PermissionOptions): Promise<boolean>;
-    isWritable(options: PermissionOptions): Promise<boolean>;
-    getSpaceStatus(): Promise<{
-        totalCapacity: number;
-        usedCapacity: number;
-        isFull: boolean;
-    }>;
-    write(options: WriteOptions): Promise<void>;
-    delete(options: DeleteOptions): Promise<void>;
-    read(options: ReadOptions): Promise<Stream>;
-    getHash(options: GetHashOptions): Promise<string>;
-    exists(options: ReadOptions): Promise<boolean>;
-    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>;
-    getStatusAsOwner(key: string): Promise<KeyStatus>;
-    static editable(key: string): boolean;
-}
+export * from './space';
+export * from './object-space';
+export * from './global-space';

package/dist/space/index.js

@@ -1,190 +1,19 @@
 "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 };
+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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 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) {
-        return this.driver.readAsOwner(key);
-    }
-    existsAsOwner(key) {
-        return this.driver.existsAsOwner(key);
-    }
-    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'];
+__exportStar(require("./space"), exports);
+__exportStar(require("./object-space"), exports);
+__exportStar(require("./global-space"), exports);

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

@@ -0,0 +1,111 @@
+/// <reference types="node" />
+import { Stream } from 'stream';
+import { SpaceConfig } from '../configuration';
+import { Object, Data } from '../meta';
+import { AppSpaceOptions, DeleteOptions, DriverProtocol, GetHashOptions, KeyStatus, ListOptions, ListsOptions, PermissionOptions, ReadAsOwnerOptions, ReadOptions, SpaceProtocol, WriteAsOwnerOptions, WriteOptions } from '../protocols';
+import { ObjectCollectionRepository, ObjectRepository, TreeRepository } from '../model';
+import { GlobalSpace } from './global-space';
+export type ObjectSpaceOptions = {
+    driver: DriverProtocol;
+    spaceDid: string;
+    treeRepository: TreeRepository;
+    objectRepository: ObjectRepository;
+    objectCollectionRepository: ObjectCollectionRepository;
+};
+export declare class ObjectSpace implements SpaceProtocol {
+    readonly spaceDid: string;
+    readonly driver: DriverProtocol;
+    readonly objectRepository: ObjectRepository;
+    readonly treeRepository: TreeRepository;
+    readonly objectCollectionRepository: ObjectCollectionRepository;
+    readonly globalSpace: GlobalSpace;
+    constructor(options: ObjectSpaceOptions);
+    createSpace(spaceConfig: SpaceConfig): Promise<void>;
+    isSpaceCreated(): Promise<boolean>;
+    /**
+     *
+     * @description
+     * @return {*}  {Promise<void>}
+     * @memberof ObjectSpace
+     */
+    destroySpace(): Promise<void>;
+    getSpaceSize(): Promise<number>;
+    createAppSpace(options: AppSpaceOptions): Promise<void>;
+    /**
+     * @description
+     * @param {AppSpaceOptions} options
+     * @return {Promise<void>}  {Promise<void>}
+     * @memberof ObjectSpace
+     */
+    destroyAppSpace(options: AppSpaceOptions): Promise<void>;
+    getAppSpacePath(options: AppSpaceOptions): Promise<string>;
+    write(options: WriteOptions): Promise<void>;
+    delete(options: DeleteOptions): Promise<void>;
+    read(options: ReadOptions): Promise<Stream>;
+    getHash(options: GetHashOptions): Promise<string>;
+    exists(options: ReadOptions): Promise<boolean>;
+    private listsOneLevelAsOwner;
+    private listsRecursiveAsOwner;
+    /**
+     * @description 后续改名为 listsAsOwner 更合适
+     * @param {ListsOptions} options
+     * @return {*}  {Promise<Object[]>}
+     * @memberof ObjectSpace
+     */
+    lists(options: ListsOptions): Promise<Object[]>;
+    /**
+     * @FIXME: 接口的功能实际应该是 listAsOwner 实现的，属于技术债 @jianchao
+     * @description
+     * @param {ListOptions} options
+     * @return {*}  {Promise<Object>}
+     * @memberof ObjectSpace
+     */
+    list(options: ListOptions): Promise<Object>;
+    private _updateAsOwner;
+    private _createAsOwner;
+    /**
+     * @refactor: @jianchao 后续让 write 的接口参数保持一致，即 key, data 都在 options 里面，目前改动收益比较小
+     * @description
+     * @param {string} key
+     * @param {Data} data
+     * @param {WriteAsOwnerOptions} options
+     * @return {*}  {Promise<void>}
+     * @memberof ObjectSpace
+     */
+    writeAsOwner(key: string, data: Data, options?: WriteAsOwnerOptions): Promise<void>;
+    deleteAsOwner(key: string): Promise<void>;
+    readAsOwner(key: string, options?: ReadAsOwnerOptions): Promise<Stream>;
+    existsAsOwner(key: string): Promise<boolean>;
+    getStatusAsOwner(key: string): Promise<KeyStatus>;
+    createConfig(spaceConfig: SpaceConfig): Promise<void>;
+    destroyConfig(): Promise<void>;
+    set<T = any>(key: string, value: T): Promise<void>;
+    get<T = any>(key: string, defaultValue?: T): Promise<T>;
+    private getPermission;
+    /**
+     *
+     * @see https://blog.csdn.net/a1173537204/article/details/89765932
+     * @private
+     * @param {PermissionOptions} { fromAppDid, toAppDid }
+     * @param {number} permission
+     * @param {boolean} status
+     * @return {*}  {Promise<void>}
+     * @memberof S3SpaceConfig
+     */
+    private setPermission;
+    /**
+     *
+     * @refactor 这部分的实现大同小异，之后可以抽象到上层实现，这样可以减少代码量 @jianchao
+     * @description
+     * @param {PermissionOptions} options
+     * @param {boolean} value
+     * @return {*}  {Promise<void>}
+     * @memberof ObjectSpace
+     */
+    setListable(options: PermissionOptions, value: boolean): Promise<void>;
+    setReadable(options: PermissionOptions, value: boolean): Promise<void>;
+    setWritable(options: PermissionOptions, value: boolean): Promise<void>;
+    isListable(options: PermissionOptions): Promise<boolean>;
+    isReadable(options: PermissionOptions): Promise<boolean>;
+    isWritable(options: PermissionOptions): Promise<boolean>;
+}