@did-space/core 0.1.53

package/README.md

@@ -0,0 +1 @@
+# DID Space Core

package/dist/configuration/index.d.ts

@@ -0,0 +1 @@
+export * from './space-config';

package/dist/configuration/index.js

@@ -0,0 +1,13 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (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 });
+__exportStar(require("./space-config"), exports);

package/dist/configuration/space-config.d.ts

@@ -0,0 +1,23 @@
+export interface SpaceConfig {
+    did: string;
+    drive?: 'fs' | 's3';
+    type?: 'buy' | 'default';
+    name: string;
+    description?: string;
+    size?: number;
+    assetDid: string;
+    createAt: string;
+    updateAt: string;
+    expireAt: string;
+    ownerDid: string;
+    permissions?: Permissions;
+}
+export interface Permissions {
+    [fromAppDid: string]: {
+        [toAppDid: string]: number;
+    };
+}
+export declare type Scope = 'list:object' | 'read:object' | 'write:object';
+export declare const Scopes: {
+    [key in Scope]: number;
+};

package/dist/configuration/space-config.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Scopes = void 0;
+exports.Scopes = {
+    'list:object': 1,
+    'read:object': 2,
+    'write:object': 4,
+};

package/dist/constants/index.d.ts

@@ -0,0 +1,2 @@
+export declare const APPS = "apps";
+export declare const DID_OBJECTS = ".did-objects";

package/dist/constants/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DID_OBJECTS = exports.APPS = void 0;
+exports.APPS = 'apps';
+exports.DID_OBJECTS = '.did-objects';

package/dist/drivers/base.d.ts

@@ -0,0 +1,38 @@
+/// <reference types="node" />
+import { Stream } from 'stream';
+import { SpaceConfig } from '../configuration';
+import { Data, Object } from '../meta';
+import { AppSpaceOptions, DeleteOptions, DriverOptions, DriverProtocol, ListOptions, PermissionOptions, ReadOptions, SpaceConfigProtocol, SpaceOperatorProtocol, WriteOptions } from '../protocols';
+export declare abstract class BaseDriver implements DriverProtocol {
+    readonly options: DriverOptions;
+    constructor(options: DriverOptions);
+    abstract get spaceOperator(): SpaceOperatorProtocol;
+    abstract get spaceConfig(): SpaceConfigProtocol;
+    createSpace(spaceConfig: 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>;
+    write(options: WriteOptions): Promise<void>;
+    delete(options: DeleteOptions): Promise<void>;
+    read(options: ReadOptions): Promise<Stream>;
+    exists(options: ReadOptions): Promise<boolean>;
+    lists(options: ListOptions): 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>;
+}

package/dist/drivers/base.js

@@ -0,0 +1,171 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseDriver = void 0;
+class BaseDriver {
+    constructor(options) {
+        this.options = options;
+    }
+    createSpace(spaceConfig) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.spaceConfig.createConfig(spaceConfig);
+            yield this.spaceOperator.createSpace(spaceConfig);
+        });
+    }
+    destroySpace() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.spaceConfig.destroyConfig();
+            yield this.spaceOperator.destroySpace();
+        });
+    }
+    isSpaceCreated() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.spaceOperator.isSpaceCreated();
+        });
+    }
+    getSpaceSize() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.spaceOperator.getSpaceSize();
+        });
+    }
+    createAppSpace(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.spaceOperator.createAppSpace(options);
+        });
+    }
+    destroyAppSpace(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.spaceOperator.destroyAppSpace(options);
+        });
+    }
+    getAppSpacePath(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.spaceOperator.getAppSpacePath(options);
+        });
+    }
+    createConfig(spaceConfig) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.spaceConfig.createConfig(spaceConfig);
+        });
+    }
+    destroyConfig() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.spaceConfig.destroyConfig();
+        });
+    }
+    set(key, value) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.spaceConfig.set(key, value);
+        });
+    }
+    get(key) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.spaceConfig.get(key);
+        });
+    }
+    setListable(options, value) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.spaceConfig.setListable(options, value);
+        });
+    }
+    setReadable(options, value) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.spaceConfig.setReadable(options, value);
+        });
+    }
+    setWritable(options, value) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.spaceConfig.setWritable(options, value);
+        });
+    }
+    isListable(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.spaceConfig.isListable(options);
+        });
+    }
+    isReadable(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.spaceConfig.isReadable(options);
+        });
+    }
+    isWritable(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.spaceConfig.isWritable(options);
+        });
+    }
+    write(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!(yield this.spaceConfig.isWritable({
+                fromAppDid: options.appDid,
+                toAppDid: options.appDid,
+            }))) {
+                throw new Error('Unable to write object with insufficient permissions');
+            }
+            yield this.spaceOperator.write(options);
+        });
+    }
+    delete(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.spaceOperator.delete(options);
+        });
+    }
+    read(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!(yield this.spaceConfig.isReadable({
+                fromAppDid: options.appDid,
+                toAppDid: options.appDid,
+            }))) {
+                throw new Error('Unable to read object with insufficient permissions');
+            }
+            return this.spaceOperator.read(options);
+        });
+    }
+    exists(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!(yield this.spaceConfig.isListable({
+                fromAppDid: options.appDid,
+                toAppDid: options.appDid,
+            }))) {
+                throw new Error('Unable to list object with insufficient permissions');
+            }
+            return this.spaceOperator.exists(options);
+        });
+    }
+    lists(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.spaceOperator.lists(options);
+        });
+    }
+    list(options) {
+        return this.spaceOperator.list(options);
+    }
+    writeAsOwner(key, data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.spaceOperator.writeAsOwner(key, data);
+        });
+    }
+    deleteAsOwner(key) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.spaceOperator.deleteAsOwner(key);
+        });
+    }
+    readAsOwner(key) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.spaceOperator.readAsOwner(key);
+        });
+    }
+    existsAsOwner(key) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.spaceOperator.existsAsOwner(key);
+        });
+    }
+}
+exports.BaseDriver = BaseDriver;

package/dist/drivers/index.d.ts

@@ -0,0 +1 @@
+export * from './base';

package/dist/drivers/index.js

@@ -0,0 +1,13 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (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 });
+__exportStar(require("./base"), exports);

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+export * from './meta';
+export * from './configuration';
+export * from './drivers';
+export * from './protocols';
+export * from './schemas';
+export * from './utils';
+export * from './space';

package/dist/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (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 });
+// eslint-disable-next-line import/export
+__exportStar(require("./meta"), exports);
+__exportStar(require("./configuration"), exports);
+__exportStar(require("./drivers"), exports);
+__exportStar(require("./protocols"), exports);
+__exportStar(require("./schemas"), exports);
+__exportStar(require("./utils"), exports);
+__exportStar(require("./space"), exports);

package/dist/meta/data.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="node" />
+import { Readable } from 'stream';
+export declare type Data = Readable | ReadableStream | string | Buffer | ReadableStream<any>;

package/dist/meta/data.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/meta/index.d.ts

@@ -0,0 +1,2 @@
+export * from './data';
+export * from './object';

package/dist/meta/index.js

@@ -0,0 +1,14 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (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 });
+__exportStar(require("./data"), exports);
+__exportStar(require("./object"), exports);

package/dist/meta/object.d.ts

@@ -0,0 +1,10 @@
+export interface Object {
+    key: string;
+    name: string;
+    isDir: boolean;
+    size: number;
+    lastModified: number;
+    editable: boolean;
+    mimeType: string;
+    [key: string]: any;
+}

package/dist/meta/object.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,4 @@
+import { SpaceConfigProtocol } from './space-config';
+import { SpaceOperatorProtocol } from './space-operator';
+export interface BaseSpaceProtocol extends SpaceOperatorProtocol, SpaceConfigProtocol {
+}

package/dist/protocols/base-space.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/protocols/driver.d.ts

@@ -0,0 +1,7 @@
+import { BaseSpaceProtocol } from './base-space';
+export interface DriverOptions {
+    root: string;
+}
+export interface DriverProtocol extends BaseSpaceProtocol {
+    readonly options: DriverOptions;
+}

package/dist/protocols/driver.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/protocols/index.d.ts

@@ -0,0 +1,5 @@
+export * from './driver';
+export * from './space';
+export * from './space-config';
+export * from './space-operator';
+export * from './space-owner-operator';

package/dist/protocols/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (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 });
+__exportStar(require("./driver"), exports);
+__exportStar(require("./space"), exports);
+__exportStar(require("./space-config"), exports);
+__exportStar(require("./space-operator"), exports);
+__exportStar(require("./space-owner-operator"), exports);

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

@@ -0,0 +1,17 @@
+import { SpaceConfig } from '../configuration';
+export interface PermissionOptions {
+    fromAppDid: string;
+    toAppDid: string;
+}
+export interface SpaceConfigProtocol {
+    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>;
+}

package/dist/protocols/space-config.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,36 @@
+/// <reference types="node" />
+import { Stream } from 'stream';
+import { SpaceConfig } from '../configuration';
+import { Data, Object } from '../meta';
+import { SpaceOwnerOperatorProtocol } from './space-owner-operator';
+export interface AppSpaceOptions {
+    appDid: string;
+}
+export interface WriteOptions extends AppSpaceOptions {
+    key: string;
+    data: Data;
+}
+export interface DeleteOptions extends AppSpaceOptions {
+    key: string;
+}
+export interface ReadOptions extends AppSpaceOptions {
+    key: string;
+}
+export interface ListOptions {
+    key: string;
+}
+export interface SpaceOperatorProtocol extends SpaceOwnerOperatorProtocol {
+    createSpace(spaceConfig: SpaceConfig): Promise<void>;
+    isSpaceCreated(): Promise<boolean>;
+    destroySpace(): Promise<void>;
+    getSpaceSize(): Promise<number>;
+    createAppSpace(options: AppSpaceOptions): Promise<void>;
+    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>;
+    exists(options: ReadOptions): Promise<boolean>;
+    lists(options: ListOptions): Promise<Object[]>;
+    list(options: ListOptions): Promise<Object>;
+}

package/dist/protocols/space-operator.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,9 @@
+/// <reference types="node" />
+import { Stream } from 'stream';
+import { Data } from '../meta';
+export interface SpaceOwnerOperatorProtocol {
+    writeAsOwner(key: string, data: Data): Promise<void>;
+    deleteAsOwner(key: string): Promise<void>;
+    readAsOwner(key: string): Promise<Stream>;
+    existsAsOwner(key: string): Promise<boolean>;
+}

package/dist/protocols/space-owner-operator.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/protocols/space.d.ts

@@ -0,0 +1,5 @@
+import { BaseSpaceProtocol } from './base-space';
+import { DriverProtocol } from './driver';
+export interface SpaceProtocol extends BaseSpaceProtocol {
+    readonly driver: DriverProtocol;
+}

package/dist/protocols/space.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/schemas/index.d.ts

@@ -0,0 +1,2 @@
+export * from './space-options';
+export * from './space-configuration';

package/dist/schemas/index.js

@@ -0,0 +1,14 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (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 });
+__exportStar(require("./space-options"), exports);
+__exportStar(require("./space-configuration"), exports);

package/dist/schemas/space-configuration.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @see {SpaceConfig}
+ */
+export declare const SpaceConfigSchema: import("joi").ObjectSchema<any>;

package/dist/schemas/space-configuration.js

@@ -0,0 +1,28 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SpaceConfigSchema = void 0;
+const xbytes_1 = __importDefault(require("xbytes"));
+const validator_1 = require("@arcblock/validator");
+/**
+ * @see {SpaceConfig}
+ */
+exports.SpaceConfigSchema = validator_1.Joi.object({
+    did: validator_1.Joi.DID(),
+    // 标识这个驱动是什么，默认取值为 fs, 表示文件存储到了本地的文件系统
+    drive: validator_1.Joi.string().valid('fs', 's3').optional().allow('').default('fs'),
+    // type: 'buy | 'default'
+    type: validator_1.Joi.string().required().default('buy'),
+    name: validator_1.Joi.string().required(),
+    // @see: https://github.com/sideway/joi/blob/master/API.md#string
+    description: validator_1.Joi.string().required().allow('').default(''),
+    // 字节数,默认给个1GB
+    size: validator_1.Joi.number().required().default(xbytes_1.default.parseSize('1GB')),
+    assetDid: validator_1.Joi.DID(),
+    createAt: validator_1.Joi.string().required(),
+    updateAt: validator_1.Joi.string().required(),
+    expireAt: validator_1.Joi.string().required(),
+    ownerDid: validator_1.Joi.DID(),
+});

package/dist/schemas/space-options.d.ts

@@ -0,0 +1 @@
+export declare const SpaceOptionsSchema: import("joi").ObjectSchema<any>;

package/dist/schemas/space-options.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SpaceOptionsSchema = void 0;
+const validator_1 = require("@arcblock/validator");
+exports.SpaceOptionsSchema = validator_1.Joi.object({
+    root: validator_1.Joi.string().required(),
+});

package/dist/space/index.d.ts

@@ -0,0 +1,38 @@
+/// <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 } 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>;
+    write(options: WriteOptions): Promise<void>;
+    delete(options: DeleteOptions): Promise<void>;
+    read(options: ReadOptions): Promise<Stream>;
+    exists(options: ReadOptions): Promise<boolean>;
+    lists(options: ListOptions): 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>;
+    static editable(key: string): boolean;
+}

package/dist/space/index.js

@@ -0,0 +1,160 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Space = void 0;
+class Space {
+    constructor(driver) {
+        this.driver = driver;
+    }
+    createSpace(spaceConfiguration) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.driver.createSpace(spaceConfiguration);
+        });
+    }
+    destroySpace() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.driver.destroySpace();
+        });
+    }
+    isSpaceCreated() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.driver.isSpaceCreated();
+        });
+    }
+    getSpaceSize() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.driver.getSpaceSize();
+        });
+    }
+    createAppSpace(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.driver.createAppSpace(options);
+        });
+    }
+    destroyAppSpace(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.driver.destroyAppSpace(options);
+        });
+    }
+    getAppSpacePath(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.driver.getAppSpacePath(options);
+        });
+    }
+    createConfig(spaceConfig) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.driver.createConfig(spaceConfig);
+        });
+    }
+    destroyConfig() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.driver.destroyConfig();
+        });
+    }
+    set(key, value) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.driver.set(key, value);
+        });
+    }
+    get(key) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.driver.get(key);
+        });
+    }
+    setListable(options, value) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.driver.setListable(options, value);
+        });
+    }
+    setReadable(options, value) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.driver.setReadable(options, value);
+        });
+    }
+    setWritable(options, value) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.driver.setWritable(options, value);
+        });
+    }
+    isListable(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.driver.isListable(options);
+        });
+    }
+    isReadable(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.driver.isReadable(options);
+        });
+    }
+    isWritable(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.driver.isWritable(options);
+        });
+    }
+    write(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.driver.write(options);
+        });
+    }
+    delete(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.driver.delete(options);
+        });
+    }
+    read(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.driver.read(options);
+        });
+    }
+    exists(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.driver.exists(options);
+        });
+    }
+    lists(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.driver.lists(options);
+        });
+    }
+    list(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.driver.list(options);
+        });
+    }
+    writeAsOwner(key, data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.driver.writeAsOwner(key, data);
+        });
+    }
+    deleteAsOwner(key) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (Space.READONLY_OBJECT_KEYS.includes(key)) {
+                throw new Error(`Object ${key} cannot be deleted`);
+            }
+            return this.driver.deleteAsOwner(key);
+        });
+    }
+    readAsOwner(key) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.driver.readAsOwner(key);
+        });
+    }
+    existsAsOwner(key) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.driver.existsAsOwner(key);
+        });
+    }
+    static editable(key) {
+        return !Space.READONLY_OBJECT_KEYS.includes(key);
+    }
+}
+exports.Space = Space;
+Space.READONLY_OBJECT_KEYS = ['/config.yml'];

package/dist/utils/index.d.ts

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

package/dist/utils/index.js

@@ -0,0 +1,15 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (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 });
+__exportStar(require("./logger"), exports);
+__exportStar(require("./stream-to-string"), exports);
+__exportStar(require("./string-to-stream"), exports);

package/dist/utils/logger.d.ts

@@ -0,0 +1,2 @@
+declare const logger: Console;
+export { logger };

package/dist/utils/logger.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logger = void 0;
+const logger = console;
+exports.logger = logger;

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

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

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

@@ -0,0 +1,10 @@
+"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.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="node" />
+import { Readable } from 'stream';
+export declare function stringToStream(str: string): Readable;

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

@@ -0,0 +1,11 @@
+"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;

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@did-space/core",
+  "version": "0.1.53",
+  "publishConfig": {
+    "access": "public"
+  },
+  "description": "Decentralized file space managed by DID",
+  "author": "linchen1987 <linchen.1987@foxmail.com>",
+  "homepage": "",
+  "license": "ISC",
+  "main": "dist/index.js",
+  "typings": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "lint": "eslint src tests",
+    "lint:fix": "npm run lint -- --fix",
+    "test": "jest --forceExit --detectOpenHandles --passWithNoTests",
+    "coverage": "npm run test -- --coverage",
+    "verify": "npm run lint && npm run test && npm run build",
+    "prebuild": "rm -fr dist",
+    "build": "tsc",
+    "build:watch": "npm run build -- -w",
+    "pre-commit": "lint-staged"
+  },
+  "lint-staged": {
+    "**/*.{js,ts}": [
+      "npm run lint",
+      "npm run test",
+      "git add ."
+    ]
+  },
+  "dependencies": {
+    "@arcblock/did": "^1.18.26",
+    "@arcblock/jwt": "^1.18.26",
+    "@arcblock/validator": "^1.18.26",
+    "@aws-sdk/client-s3": "^3.45.0",
+    "@aws-sdk/signature-v4-crt": "^3.45.0",
+    "@blocklet/meta": "^1.8.40",
+    "@ocap/mcrypto": "^1.18.26",
+    "@ocap/wallet": "^1.18.26",
+    "fs-extra": "^10.0.0",
+    "joi": "^17.5.0",
+    "js-yaml": "^4.1.0",
+    "lodash": "^4.17.21",
+    "url-join": "^4.0.1",
+    "xbytes": "^1.8.0"
+  },
+  "devDependencies": {
+    "@arcblock/eslint-config-ts": "^0.2.3",
+    "@types/fs-extra": "^9.0.13",
+    "@types/jest": "^28.1.5",
+    "@types/js-yaml": "^4.0.5",
+    "@types/lodash": "^4.14.182",
+    "@types/node": "15.12.2",
+    "@typescript-eslint/eslint-plugin": "^5.30.6",
+    "eslint": "^8.19.0",
+    "lint-staged": "^13.0.3",
+    "ts-jest": "^28.0.6",
+    "typescript": "4.4.4"
+  },
+  "gitHead": "48625a15f22a5b9d6830f2336848cd75f9db42a4"
+}