@did-space/s3-driver 0.2.5

package/README.md

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

package/dist/config/index.d.ts

@@ -0,0 +1,31 @@
+import { SpaceConfigProtocol, SpaceConfig, PermissionOptions } from '@did-space/core';
+import { S3Client } from '@aws-sdk/client-s3';
+import { S3DriverOptions } from '../s3/options';
+export declare class S3SpaceConfig implements SpaceConfigProtocol {
+    readonly key: string;
+    readonly s3Client: S3Client;
+    readonly options: S3DriverOptions;
+    constructor(options: S3DriverOptions);
+    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;
+    setListable(options: PermissionOptions, status: boolean): Promise<void>;
+    setReadable(options: PermissionOptions, status: boolean): Promise<void>;
+    setWritable(options: PermissionOptions, status: boolean): Promise<void>;
+    isListable(options: PermissionOptions): Promise<boolean>;
+    isReadable(options: PermissionOptions): Promise<boolean>;
+    isWritable(options: PermissionOptions): Promise<boolean>;
+}

package/dist/config/index.js

@@ -0,0 +1,152 @@
+"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.S3SpaceConfig = void 0;
+/* eslint-disable no-bitwise */
+const js_yaml_1 = __importDefault(require("js-yaml"));
+const core_1 = require("@did-space/core");
+const client_s3_1 = require("@aws-sdk/client-s3");
+const path_1 = __importDefault(require("path"));
+const utils_1 = require("../utils");
+class S3SpaceConfig {
+    constructor(options) {
+        this.options = options;
+        this.key = path_1.default.join(this.options.root, 'config.yml');
+        this.s3Client = new client_s3_1.S3Client(this.options.s3ClientConfig);
+    }
+    createConfig(spaceConfig) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { error } = core_1.SpaceConfigSchema.validate(spaceConfig);
+            if (error) {
+                core_1.logger.error('S3SpaceConfig.createConfig', error);
+                throw error;
+            }
+            let exists = false;
+            try {
+                const data = yield this.s3Client.send(new client_s3_1.HeadObjectCommand({
+                    Bucket: this.options.bucket,
+                    Key: this.key,
+                }));
+                exists = data.$metadata.httpStatusCode === 200;
+            }
+            catch (err) {
+                core_1.logger.error('S3SpaceConfig.createConfig', err);
+            }
+            if (exists) {
+                throw new Error('The configuration has been initialized and cannot be modified');
+            }
+            yield this.s3Client.send(new client_s3_1.PutObjectCommand({
+                Bucket: this.options.bucket,
+                Key: this.key,
+                Body: js_yaml_1.default.dump(spaceConfig),
+            }));
+        });
+    }
+    // @see: https://stackoverflow.com/questions/20207063/how-can-i-delete-folder-on-s3-with-node-js
+    // FIXME: @yejianchao 目前只能删除空文件夹
+    destroyConfig() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return undefined;
+        });
+    }
+    set(key, value) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const output = yield this.s3Client.send(new client_s3_1.GetObjectCommand({
+                Bucket: this.options.bucket,
+                Key: this.key,
+            }));
+            const data = js_yaml_1.default.load(yield (0, utils_1.streamToString)(output.Body));
+            data[key] = value;
+            yield this.s3Client.send(new client_s3_1.PutObjectCommand({
+                Bucket: this.options.bucket,
+                Key: this.key,
+                Body: js_yaml_1.default.dump(data),
+            }));
+        });
+    }
+    get(key, defaultValue = undefined) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const output = yield this.s3Client.send(new client_s3_1.GetObjectCommand({
+                Bucket: this.options.bucket,
+                Key: this.key,
+            }));
+            const data = js_yaml_1.default.load(yield (0, utils_1.streamToString)(output.Body));
+            return (_a = data[key]) !== null && _a !== void 0 ? _a : defaultValue;
+        });
+    }
+    getPermission({ fromAppDid, toAppDid }) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const permissions = yield this.get('permissions');
+            return ((_a = permissions === null || permissions === void 0 ? void 0 : permissions[fromAppDid]) === null || _a === void 0 ? void 0 : _a[toAppDid]) || 0;
+        });
+    }
+    /**
+     *
+     * @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
+     */
+    setPermission({ fromAppDid, toAppDid }, permission, status) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function* () {
+            const permissions = yield this.get('permissions', {});
+            // 我想知道原来的权限是啥样的？
+            const oldPermission = ((_a = permissions === null || permissions === void 0 ? void 0 : permissions[fromAppDid]) === null || _a === void 0 ? void 0 : _a[toAppDid]) || 0;
+            permissions[fromAppDid] = Object.assign((_b = permissions === null || permissions === void 0 ? void 0 : permissions[fromAppDid]) !== null && _b !== void 0 ? _b : {}, Object.assign(Object.assign({}, permissions === null || permissions === void 0 ? void 0 : permissions[fromAppDid]), { 
+                // eslint-disable-next-line no-bitwise
+                [toAppDid]: status ? oldPermission | permission : oldPermission & ~permission }));
+            yield this.set('permissions', permissions);
+        });
+    }
+    setListable(options, status) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.setPermission(options, core_1.Scopes['list:object'], status);
+        });
+    }
+    setReadable(options, status) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.setPermission(options, core_1.Scopes['read:object'], status);
+        });
+    }
+    setWritable(options, status) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.setPermission(options, core_1.Scopes['write:object'], status);
+        });
+    }
+    isListable(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const permission = yield this.getPermission(options);
+            return Boolean((permission & core_1.Scopes['list:object']) === core_1.Scopes['list:object']);
+        });
+    }
+    isReadable(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const permission = yield this.getPermission(options);
+            return Boolean((permission & core_1.Scopes['read:object']) === core_1.Scopes['read:object']);
+        });
+    }
+    isWritable(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const permission = yield this.getPermission(options);
+            return Boolean((permission & core_1.Scopes['write:object']) === core_1.Scopes['write:object']);
+        });
+    }
+}
+exports.S3SpaceConfig = S3SpaceConfig;

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './s3';
+export * from './config';
+export * from './operator';

package/dist/index.js

@@ -0,0 +1,19 @@
+"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 __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("./s3"), exports);
+__exportStar(require("./config"), exports);
+__exportStar(require("./operator"), exports);

package/dist/operator/index.d.ts

@@ -0,0 +1,74 @@
+/// <reference types="node" />
+import { ReadOptions, WriteOptions, SpaceOperatorProtocol, SpaceConfig, AppSpaceOptions, DeleteOptions, ListOptions, Object, Data, ListsOptions, GetHashOptions } from '@did-space/core';
+import { S3Client } from '@aws-sdk/client-s3';
+import { Stream } from 'stream';
+import { S3DriverOptions } from '../s3/options';
+type PathStatus = {
+    objects: number;
+    lastModified: number;
+    size: number;
+};
+export declare class S3SpaceOperator implements SpaceOperatorProtocol {
+    readonly options: S3DriverOptions;
+    readonly s3Client: S3Client;
+    static readonly APPS = "apps";
+    constructor(options: S3DriverOptions);
+    createSpace(_storageConfig: SpaceConfig): Promise<void>;
+    isSpaceCreated(): Promise<boolean>;
+    destroySpace(): Promise<void>;
+    /**
+     * FIXME: @yejianchao 对于 s3 而言，获得 folder 的 size 只能遍历所有文件获得，更可恶的是 ListObjectsCommand 每次只能返回 1000 个对象，此处后续需要改进
+     * @returns {Promise<number>}
+     */
+    getSpaceSize(): Promise<number>;
+    getPathStatus(path: string): Promise<PathStatus>;
+    createAppSpace(options: AppSpaceOptions): Promise<void>;
+    destroyAppSpace(options: AppSpaceOptions): Promise<void>;
+    getAppSpacePath(options: AppSpaceOptions): Promise<string>;
+    private getObjectKey;
+    /**
+     *
+     * @FIXME lib-storage 暂时不支持计算部件的 MD5  https://github.com/aws/aws-sdk-js-v3/issues/2673#issuecomment-1057408451
+     * @param {WriteOptions} options
+     * @return {*}  {Promise<void>}
+     * @memberof S3SpaceOperator
+     */
+    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>;
+    /**
+     *
+     * @FIXME: @yejianchao 现在的解决足够满足要求了，希望少侠可以找到更优雅的解法
+     * @see How can I get only one level of objects in a S3 bucket? https://stackoverflow.com/a/5497707
+     * @description 仅列出当前文件下的文件和文件夹，不包含嵌套的文件和文件夹
+     * @private
+     * @param {ListsOptions} options
+     * @return {*}  {Promise<Object[]>}
+     * @memberof S3SpaceOperator
+     */
+    private listsOneLevel;
+    /**
+     *
+     * @see 使用paginateListObjectsV2快速检索所有对象 https://stackoverflow.com/a/34912646
+     * @see s3开发者指南 https://docs.aws.amazon.com/zh_cn/sdk-for-javascript/v3/developer-guide/javascript_s3_code_examples.html
+     * @param {ListOptions} options
+     * @return {*}  {Promise<Object[]>}
+     * @memberof S3SpaceOperator
+     */
+    lists(options: ListsOptions): Promise<Object[]>;
+    list(options: ListOptions): Promise<Object>;
+    writeAsOwner(key: string, data: Data): Promise<void>;
+    /**
+     *
+     * FIXME: @yejianchao 需要支持一下删除一个文件夹（非空）的操作
+     * @param {string} key
+     * @return {*}  {Promise<void>}
+     * @memberof S3SpaceOperator
+     */
+    deleteAsOwner(key: string): Promise<void>;
+    readAsOwner(key: string): Promise<Stream>;
+    existsAsOwner(key: string): Promise<boolean>;
+}
+export {};

package/dist/operator/index.js

@@ -0,0 +1,435 @@
+"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 __asyncValues = (this && this.__asyncValues) || function (o) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var m = o[Symbol.asyncIterator], i;
+    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
+    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
+    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.S3SpaceOperator = void 0;
+const core_1 = require("@did-space/core");
+const url_join_1 = __importDefault(require("url-join"));
+const client_s3_1 = require("@aws-sdk/client-s3");
+const path_1 = require("path");
+const lib_storage_1 = require("@aws-sdk/lib-storage");
+const mime_types_1 = __importDefault(require("mime-types"));
+const lodash_1 = require("lodash");
+class S3SpaceOperator {
+    constructor(options) {
+        this.options = options;
+        this.s3Client = new client_s3_1.S3Client(this.options.s3ClientConfig);
+    }
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    createSpace(_storageConfig) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.s3Client.send(new client_s3_1.PutObjectCommand({
+                Bucket: this.options.bucket,
+                Key: `${this.options.root}/`,
+            }));
+        });
+    }
+    isSpaceCreated() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.existsAsOwner('/');
+        });
+    }
+    destroySpace() {
+        return __awaiter(this, void 0, void 0, function* () {
+            // @see: https://stackoverflow.com/questions/20207063/how-can-i-delete-folder-on-s3-with-node-js
+            // FIXME: @yejianchao 目前只能删除空文件夹
+            throw new Error('Method not implemented.');
+        });
+    }
+    /**
+     * FIXME: @yejianchao 对于 s3 而言，获得 folder 的 size 只能遍历所有文件获得，更可恶的是 ListObjectsCommand 每次只能返回 1000 个对象，此处后续需要改进
+     * @returns {Promise<number>}
+     */
+    getSpaceSize() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const prefix = (0, url_join_1.default)(this.options.root, '/');
+            const { size } = yield this.getPathStatus(prefix);
+            return size;
+        });
+    }
+    getPathStatus(path) {
+        var _a, e_1, _b, _c;
+        var _d;
+        return __awaiter(this, void 0, void 0, function* () {
+            const pathStatus = {
+                size: 0,
+                objects: 0,
+                lastModified: 0,
+            };
+            try {
+                for (var _e = true, _f = __asyncValues((0, client_s3_1.paginateListObjectsV2)({ client: this.s3Client }, {
+                    Bucket: this.options.bucket,
+                    Prefix: path,
+                })), _g; _g = yield _f.next(), _a = _g.done, !_a;) {
+                    _c = _g.value;
+                    _e = false;
+                    try {
+                        const response = _c;
+                        const contents = (_d = response === null || response === void 0 ? void 0 : response.Contents) !== null && _d !== void 0 ? _d : [];
+                        contents.forEach((content) => {
+                            var _a;
+                            pathStatus.size += (_a = content === null || content === void 0 ? void 0 : content.Size) !== null && _a !== void 0 ? _a : 0;
+                            pathStatus.lastModified = Math.max(new Date(content.LastModified).getTime(), pathStatus.lastModified);
+                        });
+                        pathStatus.objects += contents.length;
+                    }
+                    finally {
+                        _e = true;
+                    }
+                }
+            }
+            catch (e_1_1) { e_1 = { error: e_1_1 }; }
+            finally {
+                try {
+                    if (!_e && !_a && (_b = _f.return)) yield _b.call(_f);
+                }
+                finally { if (e_1) throw e_1.error; }
+            }
+            return pathStatus;
+        });
+    }
+    createAppSpace(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.s3Client.send(new client_s3_1.PutObjectCommand({
+                Bucket: this.options.bucket,
+                Key: `${yield this.getAppSpacePath(options)}/`,
+            }));
+        });
+    }
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    destroyAppSpace(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // @see: https://stackoverflow.com/questions/20207063/how-can-i-delete-folder-on-s3-with-node-js
+            // FIXME: @yejianchao 目前只能删除空文件夹
+            throw new Error('Method not implemented.');
+        });
+    }
+    getAppSpacePath(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (0, path_1.join)(this.options.root, S3SpaceOperator.APPS, options.appDid);
+        });
+    }
+    getObjectKey(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (0, path_1.join)(yield this.getAppSpacePath(options), options.key);
+        });
+    }
+    /**
+     *
+     * @FIXME lib-storage 暂时不支持计算部件的 MD5  https://github.com/aws/aws-sdk-js-v3/issues/2673#issuecomment-1057408451
+     * @param {WriteOptions} options
+     * @return {*}  {Promise<void>}
+     * @memberof S3SpaceOperator
+     */
+    write(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const upload = new lib_storage_1.Upload({
+                client: this.s3Client,
+                params: {
+                    Bucket: this.options.bucket,
+                    Key: yield this.getObjectKey(options),
+                    Body: options.data,
+                    // @FIXME lib-storage 暂时不支持计算部件的 MD5  https://github.com/aws/aws-sdk-js-v3/issues/2673#issuecomment-1057408451
+                    // ContentMD5: 'wSunmxovn3F4x1+NV+/d1A==',
+                    Metadata: {
+                        'x-hash': options.hash,
+                    },
+                },
+            });
+            yield upload.done();
+        });
+    }
+    delete(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.s3Client.send(new client_s3_1.DeleteObjectCommand({
+                Bucket: this.options.bucket,
+                Key: yield this.getObjectKey(options),
+            }));
+        });
+    }
+    read(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const output = yield this.s3Client.send(new client_s3_1.GetObjectCommand({
+                Bucket: this.options.bucket,
+                Key: yield this.getObjectKey(options),
+            }));
+            return output.Body;
+        });
+    }
+    getHash(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const output = yield this.s3Client.send(new client_s3_1.HeadObjectCommand({
+                Bucket: this.options.bucket,
+                Key: yield this.getObjectKey(options),
+            }));
+            return output.Metadata['x-hash'];
+        });
+    }
+    exists(options) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const $key = yield this.getObjectKey(options);
+            const isDir = $key.endsWith('/');
+            try {
+                // 特别地，如果这是一个 folder 的话，那么需要使用 ListObjectsCommand 做特殊判断
+                if (isDir) {
+                    const output = yield this.s3Client.send(new client_s3_1.ListObjectsCommand({
+                        Bucket: this.options.bucket,
+                        Prefix: $key,
+                        MaxKeys: 1,
+                    }));
+                    return !!((_a = output === null || output === void 0 ? void 0 : output.Contents) === null || _a === void 0 ? void 0 : _a.length);
+                }
+                const data = yield this.s3Client.send(new client_s3_1.HeadObjectCommand({
+                    Bucket: this.options.bucket,
+                    Key: $key,
+                }));
+                return data.$metadata.httpStatusCode === 200;
+            }
+            catch (error) {
+                return false;
+            }
+        });
+    }
+    /**
+     *
+     * @FIXME: @yejianchao 现在的解决足够满足要求了，希望少侠可以找到更优雅的解法
+     * @see How can I get only one level of objects in a S3 bucket? https://stackoverflow.com/a/5497707
+     * @description 仅列出当前文件下的文件和文件夹，不包含嵌套的文件和文件夹
+     * @private
+     * @param {ListsOptions} options
+     * @return {*}  {Promise<Object[]>}
+     * @memberof S3SpaceOperator
+     */
+    listsOneLevel(options) {
+        var _a, e_2, _b, _c;
+        var _d, _e;
+        return __awaiter(this, void 0, void 0, function* () {
+            const prefix = (0, url_join_1.default)(this.options.root, options.key);
+            const objects = [];
+            const folders = [];
+            try {
+                for (var _f = true, _g = __asyncValues((0, client_s3_1.paginateListObjectsV2)({ client: this.s3Client }, {
+                    Bucket: this.options.bucket,
+                    Prefix: prefix,
+                    Delimiter: '/',
+                })), _h; _h = yield _g.next(), _a = _h.done, !_a;) {
+                    _c = _h.value;
+                    _f = false;
+                    try {
+                        const response = _c;
+                        (_d = response === null || response === void 0 ? void 0 : response.Contents) === null || _d === void 0 ? void 0 : _d.forEach((content) => {
+                            const name = content.Key.replace(prefix, '');
+                            // @note: 有时候 name的值可能是空字符 ‘’
+                            if ((0, lodash_1.isEmpty)(name)) {
+                                return;
+                            }
+                            const key = (0, url_join_1.default)(options.key, name);
+                            const isDir = content.Key.endsWith('/');
+                            objects.push({
+                                key,
+                                name,
+                                isDir,
+                                size: content.Size,
+                                lastModified: new Date(content.LastModified).getTime(),
+                                editable: core_1.Space.editable(key),
+                                mimeType: mime_types_1.default.lookup(name) || 'unknown',
+                            });
+                        });
+                        folders.push(...((_e = response === null || response === void 0 ? void 0 : response.CommonPrefixes) !== null && _e !== void 0 ? _e : []).map((c) => c.Prefix));
+                    }
+                    finally {
+                        _f = true;
+                    }
+                }
+            }
+            catch (e_2_1) { e_2 = { error: e_2_1 }; }
+            finally {
+                try {
+                    if (!_f && !_a && (_b = _g.return)) yield _b.call(_g);
+                }
+                finally { if (e_2) throw e_2.error; }
+            }
+            yield Promise.all(folders.map((folderKey) => __awaiter(this, void 0, void 0, function* () {
+                const keys = folderKey.split('/');
+                const name = `${keys[keys.length - 2]}/`;
+                const key = folderKey.replace(this.options.root, '');
+                const pathStatus = yield this.getPathStatus(folderKey);
+                const { size, lastModified } = pathStatus;
+                objects.push({
+                    key,
+                    name,
+                    isDir: true,
+                    size,
+                    lastModified,
+                    editable: false,
+                    mimeType: mime_types_1.default.lookup(name) || 'unknown',
+                });
+            })));
+            return objects;
+        });
+    }
+    /**
+     *
+     * @see 使用paginateListObjectsV2快速检索所有对象 https://stackoverflow.com/a/34912646
+     * @see s3开发者指南 https://docs.aws.amazon.com/zh_cn/sdk-for-javascript/v3/developer-guide/javascript_s3_code_examples.html
+     * @param {ListOptions} options
+     * @return {*}  {Promise<Object[]>}
+     * @memberof S3SpaceOperator
+     */
+    lists(options) {
+        var _a, e_3, _b, _c;
+        var _d;
+        return __awaiter(this, void 0, void 0, function* () {
+            const prefix = (0, url_join_1.default)(this.options.root, options.key);
+            // 以 非递归的方式 && 显示文件夹 的方式列出当前文件
+            if (!options.recursive) {
+                return this.listsOneLevel(options);
+            }
+            if (options.recursive && options.ignoreDirectories) {
+                const objects = [];
+                try {
+                    for (var _e = true, _f = __asyncValues((0, client_s3_1.paginateListObjectsV2)({ client: this.s3Client }, {
+                        Bucket: this.options.bucket,
+                        Prefix: prefix,
+                    })), _g; _g = yield _f.next(), _a = _g.done, !_a;) {
+                        _c = _g.value;
+                        _e = false;
+                        try {
+                            const response = _c;
+                            const contents = (_d = response === null || response === void 0 ? void 0 : response.Contents) !== null && _d !== void 0 ? _d : [];
+                            contents.forEach((content) => {
+                                const key = content.Key.replace(prefix, '/');
+                                const name = (0, path_1.basename)(key);
+                                objects.push({
+                                    key,
+                                    name,
+                                    isDir: name.endsWith('/'),
+                                    size: content.Size,
+                                    lastModified: new Date(content.LastModified).getTime(),
+                                    editable: core_1.Space.editable(key),
+                                    mimeType: mime_types_1.default.lookup(name) || 'unknown',
+                                });
+                            });
+                        }
+                        finally {
+                            _e = true;
+                        }
+                    }
+                }
+                catch (e_3_1) { e_3 = { error: e_3_1 }; }
+                finally {
+                    try {
+                        if (!_e && !_a && (_b = _f.return)) yield _b.call(_f);
+                    }
+                    finally { if (e_3) throw e_3.error; }
+                }
+                return objects;
+            }
+            throw new Error(`Filter methods not yet supported:\n ${JSON.stringify(options, null, 2)}`);
+        });
+    }
+    // FIXME： 最新的研究发现，似乎通过 GetObjectCommand 也能满足我的要求
+    list(options) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const key = (0, url_join_1.default)(this.options.root, options.key);
+            const response = yield this.s3Client.send(new client_s3_1.ListObjectsCommand({
+                Bucket: this.options.bucket,
+                Prefix: key,
+            }));
+            const [content] = (_a = response === null || response === void 0 ? void 0 : response.Contents) !== null && _a !== void 0 ? _a : [];
+            if (!content) {
+                return null;
+            }
+            return {
+                key: options.key,
+                name: (0, path_1.basename)(options.key),
+                isDir: content.Key.endsWith('/'),
+                size: content.Size,
+                lastModified: new Date(content.LastModified).getTime(),
+                editable: core_1.Space.editable(options.key),
+                mimeType: mime_types_1.default.lookup(options.key) || 'unknown',
+            };
+        });
+    }
+    writeAsOwner(key, data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.s3Client.send(new client_s3_1.PutObjectCommand({
+                Bucket: this.options.bucket,
+                Key: (0, path_1.join)(this.options.root, key),
+                Body: data,
+            }));
+        });
+    }
+    /**
+     *
+     * FIXME: @yejianchao 需要支持一下删除一个文件夹（非空）的操作
+     * @param {string} key
+     * @return {*}  {Promise<void>}
+     * @memberof S3SpaceOperator
+     */
+    deleteAsOwner(key) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.s3Client.send(new client_s3_1.DeleteObjectCommand({
+                Bucket: this.options.bucket,
+                Key: (0, path_1.join)(this.options.root, key),
+            }));
+        });
+    }
+    readAsOwner(key) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const output = yield this.s3Client.send(new client_s3_1.GetObjectCommand({
+                Bucket: this.options.bucket,
+                Key: (0, path_1.join)(this.options.root, key),
+                ResponseContentType: 'application/octet-stream',
+            }));
+            return output.Body;
+        });
+    }
+    existsAsOwner(key) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const $key = (0, path_1.join)(this.options.root, key);
+            const isDir = $key.endsWith('/');
+            try {
+                // 特别地，如果这是一个 folder 的话，那么需要使用 ListObjectsCommand 做特殊判断
+                if (isDir) {
+                    const output = yield this.s3Client.send(new client_s3_1.ListObjectsCommand({
+                        Bucket: this.options.bucket,
+                        Prefix: $key,
+                        MaxKeys: 1,
+                    }));
+                    return !!((_a = output === null || output === void 0 ? void 0 : output.Contents) === null || _a === void 0 ? void 0 : _a.length);
+                }
+                const data = yield this.s3Client.send(new client_s3_1.HeadObjectCommand({
+                    Bucket: this.options.bucket,
+                    Key: $key,
+                }));
+                return data.$metadata.httpStatusCode === 200;
+            }
+            catch (error) {
+                return false;
+            }
+        });
+    }
+}
+exports.S3SpaceOperator = S3SpaceOperator;
+S3SpaceOperator.APPS = 'apps';

package/dist/s3/index.d.ts

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

package/dist/s3/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;
+    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 });
+__exportStar(require("./s3"), exports);

package/dist/s3/options.d.ts

@@ -0,0 +1,6 @@
+import { S3ClientConfig } from '@aws-sdk/client-s3';
+import { DriverOptions } from '@did-space/core';
+export interface S3DriverOptions extends DriverOptions {
+    readonly s3ClientConfig: S3ClientConfig;
+    readonly bucket: string;
+}

package/dist/s3/options.js

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

package/dist/s3/s3.d.ts

@@ -0,0 +1,14 @@
+import { S3ClientConfig } from '@aws-sdk/client-s3';
+import { BaseDriver, SpaceConfigProtocol, SpaceOperatorProtocol } from '@did-space/core';
+import { S3DriverOptions } from './options';
+export declare class S3Driver extends BaseDriver {
+    private _spaceConfig;
+    private _spaceOperator;
+    constructor(options: S3DriverOptions);
+    get spaceOperator(): SpaceOperatorProtocol;
+    get spaceConfig(): SpaceConfigProtocol;
+    static existsBucket({ bucket, s3ClientConfig, }: {
+        bucket: string;
+        s3ClientConfig: S3ClientConfig;
+    }): Promise<boolean>;
+}

package/dist/s3/s3.js

@@ -0,0 +1,49 @@
+"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.S3Driver = void 0;
+const client_s3_1 = require("@aws-sdk/client-s3");
+const core_1 = require("@did-space/core");
+const config_1 = require("../config");
+const operator_1 = require("../operator");
+class S3Driver extends core_1.BaseDriver {
+    constructor(options) {
+        super(options);
+        this._spaceConfig = new config_1.S3SpaceConfig(options);
+        this._spaceOperator = new operator_1.S3SpaceOperator(options);
+    }
+    get spaceOperator() {
+        return this._spaceOperator;
+    }
+    get spaceConfig() {
+        return this._spaceConfig;
+    }
+    static existsBucket({ bucket, s3ClientConfig, }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const s3Client = new client_s3_1.S3Client(s3ClientConfig);
+                const data = yield s3Client.send(new client_s3_1.HeadBucketCommand({
+                    Bucket: bucket,
+                }));
+                return data.$metadata.httpStatusCode === 200;
+            }
+            catch (error) {
+                core_1.logger.error('S3Driver.existsBucket', {
+                    bucket,
+                    region: s3ClientConfig.region,
+                });
+                core_1.logger.error('S3Driver.existsBucket', error);
+                return false;
+            }
+        });
+    }
+}
+exports.S3Driver = S3Driver;

package/dist/utils/index.d.ts

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

package/dist/utils/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;
+    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 });
+__exportStar(require("./stream-to-string"), exports);

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/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@did-space/s3-driver",
+  "version": "0.2.5",
+  "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": "yarn test -- --coverage",
+    "prebuild": "rm -fr dist",
+    "build": "tsc",
+    "build:watch": "yarn build --watch",
+    "pre-commit": "lint-staged",
+    "verify": "npm run lint && npm run test && npm run build"
+  },
+  "lint-staged": {
+    "**/*.{js,ts}": [
+      "npm run lint",
+      "npm run test",
+      "git add ."
+    ]
+  },
+  "dependencies": {
+    "@arcblock/did": "^1.18.57",
+    "@arcblock/jwt": "^1.18.57",
+    "@aws-sdk/client-s3": "^3.241.0",
+    "@aws-sdk/lib-storage": "^3.241.0",
+    "@did-space/core": "0.2.5",
+    "@ocap/mcrypto": "^1.18.57",
+    "@ocap/wallet": "^1.18.57",
+    "js-yaml": "^4.1.0",
+    "json-stable-stringify": "^1.0.1",
+    "lodash": "^4.17.21",
+    "mime-types": "^2.1.35",
+    "url-join": "^4.0.1"
+  },
+  "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/json-stable-stringify": "^1.0.34",
+    "@types/lodash": "^4.14.182",
+    "@types/mime-types": "^2.1.1",
+    "@types/node": "15.12.2",
+    "@types/url-join": "^4.0.1",
+    "@typescript-eslint/eslint-plugin": "^5.30.6",
+    "eslint": "^8.19.0",
+    "lint-staged": "^13.0.3",
+    "ts-jest": "^28.0.6",
+    "typescript": "^4.9.5"
+  },
+  "gitHead": "4d49e73817f610375982509ba8f250ba34e16efb"
+}