@did-space/core 0.3.67 → 0.3.68

package/dist/constants/index.d.ts

@@ -10,3 +10,9 @@ export declare const HEADERS: {
     X_HASH: string;
     X_SIGNATURE_VERSION: string;
 };
+export declare const APP: {
+    FOLDER_PREFIX: string;
+    COMPONENT: {
+        FOLDER_PREFIX: string;
+    };
+};

package/dist/constants/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.HEADERS = exports.APP_BACKUP_STATUS = exports.DID_OBJECTS = exports.APPS = void 0;
+exports.APP = exports.HEADERS = exports.APP_BACKUP_STATUS = exports.DID_OBJECTS = exports.APPS = void 0;
 exports.APPS = 'apps';
 exports.DID_OBJECTS = '.did-objects';
 // eslint-disable-next-line @typescript-eslint/naming-convention
@@ -18,3 +18,11 @@ exports.HEADERS = {
     // 取值为 2，表示 url 使用了 base64url 编码的方式
     X_SIGNATURE_VERSION: 'x-signature-version',
 };
+exports.APP = {
+    // @example: /${spaceDid}/apps/${appDid}
+    FOLDER_PREFIX: 'apps',
+    COMPONENT: {
+        // @example: /${spaceDid}/apps/${appDid}/.components/${componentDid}
+        FOLDER_PREFIX: '.components',
+    },
+};

package/dist/meta/object.d.ts

@@ -1,3 +1,4 @@
+import type { ObjectMetadata } from '../protocols';
 export interface Object {
     /**
      *
@@ -58,5 +59,12 @@ export interface Object {
      * @memberof Object
      */
     hash?: string;
+    /**
+     * @description 存储 metadata 信息
+     * @default {{}}
+     * @type {ObjectMetadata}
+     * @memberof Object
+     */
+    metadata?: ObjectMetadata;
     [key: string]: any;
 }

package/dist/meta/template/app.d.ts

@@ -3,6 +3,11 @@ import { AppConnected } from './app-connected';
 import { AppDisconnected } from './app-disconnected';
 import { AppRestore } from './app-restore';
 export declare const APP_TYPE = "app";
+export interface AppPermissions {
+    [scope: string]: {
+        [authorizedAppDid: string]: number;
+    };
+}
 /**
  *
  * @description 此文件存储的位置在 ${spaceDid}/apps/${appDid}/.meta/config.yml
@@ -24,6 +29,7 @@ export interface App {
     disconnected: Array<AppDisconnected>;
     backup: Array<AppBackup>;
     restore: Array<AppRestore>;
+    permissions: AppPermissions;
     createAt: string;
     updateAt: string;
 }

package/dist/model/app-space-apply.d.ts

@@ -0,0 +1,62 @@
+import type { AppPermissions } from '../meta';
+export interface AppSpaceApplyModel {
+    /**
+     * @description 记录的唯一标识,是一个 UUIDV4
+     * @type {string}
+     * @memberof AppSpaceApplyModel
+     */
+    id: string;
+    /**
+     * @description
+     * @type {string}
+     * @memberof AppSpaceApplyModel
+     */
+    storageDid: string;
+    /**
+     * @description
+     * @type {string}
+     * @memberof AppSpaceApplyModel
+     */
+    assetDid: string;
+    /**
+     * @description
+     * @type {string}
+     * @memberof AppSpaceApplyModel
+     */
+    ownerDid: string;
+    /**
+     * @description 应用最新的 appDid,如果应用被迁移了,这个值也会更新到最新
+     * @type {string}
+     * @memberof AppSpaceApplyModel
+     */
+    appDid: string;
+    /**
+     * @description
+     * @type {string}
+     * @memberof AppSpaceApplyModel
+     */
+    appName: string;
+    /**
+     * @description
+     * @type {string}
+     * @default {''}
+     * @memberof AppSpaceApplyModel
+     */
+    appDescription?: string;
+    /**
+     * @description 目前存储着授权信息
+     * @memberof AppSpaceApplyModel
+     */
+    metadata: {
+        permissions: AppPermissions;
+    };
+    createAt: string;
+    updateAt: string;
+}
+/**
+ * @description
+ * @export
+ * @interface CreationAppSpaceApplyModel
+ */
+export interface CreationAppSpaceApplyModel extends Omit<AppSpaceApplyModel, 'id'> {
+}

package/dist/model/app-space-apply.js

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

package/dist/model/index.d.ts

@@ -1,3 +1,4 @@
-export * from './tree';
-export * from './object';
+export * from './app-space-apply';
 export * from './object-collection';
+export * from './object';
+export * from './tree';

package/dist/model/index.js

@@ -14,6 +14,7 @@ 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("./tree"), exports);
-__exportStar(require("./object"), exports);
+__exportStar(require("./app-space-apply"), exports);
 __exportStar(require("./object-collection"), exports);
+__exportStar(require("./object"), exports);
+__exportStar(require("./tree"), exports);

package/dist/model/object-collection.d.ts

@@ -21,8 +21,22 @@ export interface ObjectCollectionModel {
      */
     createdAt: string;
 }
-export declare class ObjectCollectionRepositoryClass extends Model<ObjectCollectionModel> implements ObjectCollectionModel {
+export type ObjectCollectionModelCreation = Pick<ObjectCollectionModel, 'id'>;
+export declare class ObjectCollectionRepositoryClass extends Model<ObjectCollectionModel, ObjectCollectionModelCreation> {
+    /**
+     * @primaryKey
+     * @description 对象的唯一标识,格式是 ipfs cid v1
+     * @type {string}
+     * @column {DataTypes.CHAR(64)}
+     * @memberof ObjectCollectionModel
+     */
     id: string;
+    /**
+     * @description 对象的创建时间
+     * @type {string}
+     * @column {DataTypes.DATE}
+     * @memberof ObjectCollectionModel
+     */
     createdAt: string;
 }
 export type ObjectCollectionRepository = typeof ObjectCollectionRepositoryClass;

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

@@ -2,7 +2,7 @@
 import { Stream } from 'stream';
 import { SpaceConfig } from '../configuration';
 import { Data, Object } from '../meta';
-import { SpaceOwnerOperatorProtocol } from './space-owner-operator';
+import { SpaceOwnerOperatorProtocol, type ObjectMetadata } from './space-owner-operator';
 export interface AppSpaceOptions {
     appDid: string;
 }
@@ -11,6 +11,7 @@ export interface WriteOptions extends AppSpaceOptions {
     data: Data;
     hash?: string;
     size?: number;
+    metadata?: ObjectMetadata;
 }
 export interface DeleteOptions extends AppSpaceOptions {
     key: string;

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

@@ -18,10 +18,12 @@ export type KeyStatus = {
      */
     size: number;
 };
+export type ObjectMetadata = Record<string, any>;
 export type WriteAsOwnerOptions = {
     hash: string;
     size: number;
     useGlobal?: false | true;
+    metadata?: ObjectMetadata;
 };
 export type ReadAsOwnerOptions = {
     useGlobal?: false | true;

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

@@ -1,4 +1,4 @@
-export declare const KeySchema: import("joi").StringSchema<string>;
+export declare const OwnerOperatorKeySchema: import("joi").StringSchema<string>;
 export declare const WriteAsOwnerOptionsSchema: import("joi").ObjectSchema<any>;
 export declare const ObjectSpaceOptionsSchema: import("joi").ObjectSchema<any>;
 export declare const DeleteAsOwnerOptionsSchema: import("joi").ObjectSchema<any>;

package/dist/schemas/object-space.js

@@ -1,20 +1,26 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GetHashOptionsSchema = exports.WriteOptionsSchema = exports.DeleteAsOwnerOptionsSchema = exports.ObjectSpaceOptionsSchema = exports.WriteAsOwnerOptionsSchema = exports.KeySchema = void 0;
+exports.GetHashOptionsSchema = exports.WriteOptionsSchema = exports.DeleteAsOwnerOptionsSchema = exports.ObjectSpaceOptionsSchema = exports.WriteAsOwnerOptionsSchema = exports.OwnerOperatorKeySchema = void 0;
 const validator_1 = require("@arcblock/validator");
-exports.KeySchema = validator_1.Joi.string().regex(/^\//).required();
+exports.OwnerOperatorKeySchema = validator_1.Joi.string().regex(/^\//).required();
 const WriteAsOwnerOptionsByFolderSchema = {
     is: validator_1.Joi.string().regex(/\/$/),
-    then: validator_1.Joi.valid(null).default(null),
+    then: validator_1.Joi.optional().default(null),
+    otherwise: validator_1.Joi.required(),
+};
+const MetadataSchema = {
+    is: validator_1.Joi.object(),
+    then: validator_1.Joi.optional().default(null),
     otherwise: validator_1.Joi.required(),
 };
 exports.WriteAsOwnerOptionsSchema = validator_1.Joi.object({
-    key: exports.KeySchema,
-    data: validator_1.Joi.any().when('key', WriteAsOwnerOptionsByFolderSchema),
+    key: exports.OwnerOperatorKeySchema,
+    data: validator_1.Joi.any().when('key', WriteAsOwnerOptionsByFolderSchema).when('metadata', MetadataSchema),
     // @FIXME: 当 key 是文件夹 或者 data 不是一个 stream 的时候，hash， size 是可选的，现在的规则尝试之后没能做到这么精细化(使用 when 无法满足要求) @jianchao
     hash: validator_1.Joi.string().optional().allow(null).default(null),
     size: validator_1.Joi.number().integer().optional().allow(null).default(null),
     useGlobal: validator_1.Joi.boolean().optional().default(false),
+    metadata: validator_1.Joi.object().optional().default({}),
 });
 exports.ObjectSpaceOptionsSchema = validator_1.Joi.object({
     driver: validator_1.Joi.any().required(),
@@ -24,14 +30,15 @@ exports.ObjectSpaceOptionsSchema = validator_1.Joi.object({
     objectCollectionRepository: validator_1.Joi.any().required(),
 });
 exports.DeleteAsOwnerOptionsSchema = validator_1.Joi.object({
-    key: exports.KeySchema,
+    key: exports.OwnerOperatorKeySchema,
 });
 exports.WriteOptionsSchema = validator_1.Joi.object({
     appDid: validator_1.Joi.DID().required(),
     key: validator_1.Joi.string().required(),
-    data: validator_1.Joi.any().required(),
+    data: validator_1.Joi.any().when('key', WriteAsOwnerOptionsByFolderSchema).when('metadata', MetadataSchema),
     hash: validator_1.Joi.string().optional().allow(null).default(null),
     size: validator_1.Joi.number().integer().optional().allow(null).default(null),
+    metadata: validator_1.Joi.object().optional().default({}),
 });
 exports.GetHashOptionsSchema = validator_1.Joi.object({
     appDid: validator_1.Joi.DID().required(),

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

@@ -63,8 +63,6 @@ export declare class ObjectSpace implements SpaceProtocol {
      * @memberof ObjectSpace
      */
     list(options: ListOptions): Promise<Object>;
-    private _updateAsOwner;
-    private _createAsOwner;
     /**
      * @refactor: @jianchao 后续让 write 的接口参数保持一致，即 key, data 都在 options 里面，目前改动收益比较小
      * @description
@@ -75,6 +73,9 @@ export declare class ObjectSpace implements SpaceProtocol {
      * @memberof ObjectSpace
      */
     writeAsOwner(key: string, data: Data, options?: WriteAsOwnerOptions): Promise<void>;
+    private updateAsOwner;
+    private createAsOwner;
+    private updateMetadata;
     deleteAsOwner(key: string): Promise<void>;
     readAsOwner(key: string, options?: ReadAsOwnerOptions): Promise<Stream>;
     existsAsOwner(key: string): Promise<boolean>;

package/dist/space/object-space.js

@@ -17,7 +17,9 @@ const debug_1 = __importDefault(require("debug"));
 const skypesky_sequelize_1 = require("skypesky-sequelize");
 const js_yaml_1 = __importDefault(require("js-yaml"));
 const path_1 = require("path");
-const lodash_1 = require("lodash");
+const isEmpty_1 = __importDefault(require("lodash/isEmpty"));
+const isUndefined_1 = __importDefault(require("lodash/isUndefined"));
+const omit_1 = __importDefault(require("lodash/omit"));
 const xbytes_1 = __importDefault(require("xbytes"));
 const configuration_1 = require("../configuration");
 const model_1 = require("../model");
@@ -128,6 +130,7 @@ class ObjectSpace {
             }
             const [did, capacity, usedCapacity] = yield Promise.all([
                 this.spaceDid,
+                // @FIXME: 此处应该用 cache 层的数据,可以加速查询
                 this.get('size'),
                 this.getSpaceSize(),
             ]);
@@ -143,7 +146,7 @@ class ObjectSpace {
     }
     write(options) {
         return __awaiter(this, void 0, void 0, function* () {
-            debug('write.before', JSON.stringify((0, lodash_1.omit)(options, 'data')));
+            debug('write.before', JSON.stringify((0, omit_1.default)(options, 'data')));
             const { error } = schemas_1.WriteOptionsSchema.validate(options, {
                 allowUnknown: true,
                 stripUnknown: true,
@@ -196,7 +199,7 @@ class ObjectSpace {
     }
     exists(options) {
         return __awaiter(this, void 0, void 0, function* () {
-            debug('exists.before', JSON.stringify({ options: (0, lodash_1.omit)(options, 'data') }));
+            debug('exists.before', JSON.stringify({ options: (0, omit_1.default)(options, 'data') }));
             const key = (0, path_1.join)(yield this.getAppSpacePath(options), options.key);
             return this.existsAsOwner(key);
         });
@@ -223,6 +226,7 @@ class ObjectSpace {
             return Promise.all(trees.map((x) => __awaiter(this, void 0, void 0, function* () {
                 const absolutePath = (0, path_1.join)(x.spaceDid, x.key);
                 if (x.type === model_1.TreeModelType.FOLDER) {
+                    // @FIXME: 如果追求极速,此处是一个优化的点,文件夹不一定需要看到 更新时间和大小,S3 就是这么做的,默认是不展示的
                     const { size, lastModified } = yield this.getStatusAsOwner(x.key);
                     return {
                         key: x.key,
@@ -233,6 +237,7 @@ class ObjectSpace {
                         editable: true,
                         mimeType: null,
                         absolutePath,
+                        metadata: x.meta,
                     };
                 }
                 return {
@@ -245,6 +250,7 @@ class ObjectSpace {
                     mimeType: x.Object.meta.mimeType,
                     hash: x.objectId,
                     absolutePath,
+                    metadata: x.meta,
                 };
             })));
         });
@@ -274,6 +280,7 @@ class ObjectSpace {
                     mimeType: x.Object.meta.mimeType,
                     hash: x.objectId,
                     absolutePath: (0, path_1.join)(x.spaceDid, x.key),
+                    metadata: x.meta,
                 };
             });
         });
@@ -331,12 +338,59 @@ class ObjectSpace {
                 editable: true,
                 mimeType: x.type === model_1.TreeModelType.FOLDER ? null : x.Object.meta.mimeType,
                 absolutePath: (0, path_1.join)(x.spaceDid, x.key),
+                metadata: x.meta,
             };
         });
     }
-    _updateAsOwner(key, data, options) {
+    /**
+     * @refactor: @jianchao 后续让 write 的接口参数保持一致，即 key, data 都在 options 里面，目前改动收益比较小
+     * @description
+     * @param {string} key
+     * @param {Data} data
+     * @param {WriteAsOwnerOptions} options
+     * @return {*}  {Promise<void>}
+     * @memberof ObjectSpace
+     */
+    writeAsOwner(key, data, options = { hash: null, size: 0 }) {
         return __awaiter(this, void 0, void 0, function* () {
-            debug('_updateAsOwner.before', { key, options: (0, lodash_1.omit)(options, 'data') });
+            debug('writeAsOwner.before', JSON.stringify({ key, options: (0, omit_1.default)(options, 'data') }));
+            const { error } = schemas_1.WriteAsOwnerOptionsSchema.validate(Object.assign(Object.assign({}, options), { key,
+                data }), {
+                allowUnknown: true,
+                stripUnknown: true,
+            });
+            if (error) {
+                throw error;
+            }
+            if (!(0, utils_1.isDirectory)(key) && !(0, stream_1.isStream)(data)) {
+                options.hash = options.hash || (yield (0, utils_1.getHash)(data));
+                options.size = options.size || (0, utils_1.getSize)(data);
+                if (!options.hash || !options.size) {
+                    throw new Error('Hash and size cannot be empty');
+                }
+            }
+            const exists = yield this.existsAsOwner(key);
+            debug('writeAsOwner.$exists', exists);
+            if (exists) {
+                // 更新对象
+                yield this.updateAsOwner(key, data, options);
+            }
+            else {
+                // @note: 只有新增的时候才会触发检测
+                yield this.verifySpace(options === null || options === void 0 ? void 0 : options.size);
+                // 添加新对象
+                yield this.createAsOwner(key, data, options);
+            }
+            debug('writeAsOwner.after', JSON.stringify({ key, options: (0, omit_1.default)(options, 'data') }));
+        });
+    }
+    updateAsOwner(key, data, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            debug('updateAsOwner.before', { key, options: (0, omit_1.default)(options, 'data') });
+            yield this.updateMetadata(key, data, options);
+            if ((0, isUndefined_1.default)(data)) {
+                return;
+            }
             if ((0, utils_1.isDirectory)(key)) {
                 return;
             }
@@ -344,12 +398,12 @@ class ObjectSpace {
                 spaceDid: this.spaceDid,
                 key,
             };
-            debug('_updateAsOwner.before', JSON.stringify({ key, options: (0, lodash_1.omit)(options, 'data'), where }));
+            debug('updateAsOwner.before', JSON.stringify({ key, options: (0, omit_1.default)(options, 'data'), where }));
             const oldTree = yield this.treeRepository.findOne({
                 where,
                 include: this.objectRepository,
             });
-            debug('_updateAsOwner.$oldTree', JSON.stringify(oldTree));
+            debug('updateAsOwner.$oldTree', JSON.stringify(oldTree));
             const listObject = yield this.driver.list({
                 key: (0, utils_1.getHashPath)(options.hash),
                 useGlobal: true,
@@ -382,9 +436,9 @@ class ObjectSpace {
             yield this.globalSpace.mark(oldTree.objectId);
         });
     }
-    _createAsOwner(key, data, options) {
+    createAsOwner(key, data, options) {
         return __awaiter(this, void 0, void 0, function* () {
-            debug('_createAsOwner.before', JSON.stringify({ key, options: (0, lodash_1.omit)(options, 'data') }));
+            debug('createAsOwner.before', JSON.stringify({ key, options: (0, omit_1.default)(options, 'data') }));
             const isDir = key.endsWith('/');
             if (isDir) {
                 // 添加 tree 记录
@@ -395,6 +449,7 @@ class ObjectSpace {
                     key,
                     type: model_1.TreeModelType.FOLDER,
                 });
+                yield this.updateMetadata(key, data, options);
                 return;
             }
             // 存储新对象到全局存储区
@@ -407,48 +462,27 @@ class ObjectSpace {
                 key,
                 type: key.endsWith('/') ? model_1.TreeModelType.FOLDER : model_1.TreeModelType.FILE,
             });
+            yield this.updateMetadata(key, data, options);
         });
     }
-    /**
-     * @refactor: @jianchao 后续让 write 的接口参数保持一致，即 key, data 都在 options 里面，目前改动收益比较小
-     * @description
-     * @param {string} key
-     * @param {Data} data
-     * @param {WriteAsOwnerOptions} options
-     * @return {*}  {Promise<void>}
-     * @memberof ObjectSpace
-     */
-    writeAsOwner(key, data, options = { hash: null, size: 0 }) {
+    updateMetadata(key, data, options) {
         return __awaiter(this, void 0, void 0, function* () {
-            debug('writeAsOwner.before', JSON.stringify({ key, options: (0, lodash_1.omit)(options, 'data') }));
-            const { error } = schemas_1.WriteAsOwnerOptionsSchema.validate(Object.assign(Object.assign({}, options), { key,
-                data }), {
-                allowUnknown: true,
-                stripUnknown: true,
+            debug('updateMetadata.before', { key, options: (0, omit_1.default)(options, 'data') });
+            const where = {
+                spaceDid: this.spaceDid,
+                key,
+                type: key.endsWith('/') ? model_1.TreeModelType.FOLDER : model_1.TreeModelType.FILE,
+            };
+            debug('updateMetadata.before', JSON.stringify({ key, options: (0, omit_1.default)(options, 'data'), where }));
+            const oldTree = yield this.treeRepository.findOne({
+                where,
             });
-            if (error) {
-                throw error;
-            }
-            if (!(0, utils_1.isDirectory)(key) && !(0, stream_1.isStream)(data)) {
-                options.hash = options.hash || (yield (0, utils_1.getHash)(data));
-                options.size = options.size || (0, utils_1.getSize)(data);
-                if (!options.hash || !options.size) {
-                    throw new Error('Hash and size cannot be empty');
-                }
-            }
-            const exists = yield this.existsAsOwner(key);
-            debug('writeAsOwner.$exists', exists);
-            if (exists) {
-                // 更新对象
-                yield this._updateAsOwner(key, data, options);
-            }
-            else {
-                // @note: 只有新增的时候才会触发检测
-                yield this.verifySpace(options === null || options === void 0 ? void 0 : options.size);
-                // 添加新对象
-                yield this._createAsOwner(key, data, options);
+            debug('updateMetadata.$oldTree', JSON.stringify(oldTree));
+            if (!(0, isEmpty_1.default)(options.metadata)) {
+                yield oldTree.update({
+                    meta: Object.assign(Object.assign({}, oldTree.meta), options.metadata),
+                });
             }
-            debug('writeAsOwner.after', JSON.stringify({ key, options: (0, lodash_1.omit)(options, 'data') }));
         });
     }
     deleteAsOwner(key) {
@@ -537,7 +571,7 @@ class ObjectSpace {
                 spaceDid: this.spaceDid,
                 key,
             }));
-            const { error } = schemas_1.KeySchema.validate(key);
+            const { error } = schemas_1.OwnerOperatorKeySchema.validate(key);
             if (error) {
                 throw error;
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@did-space/core",
-  "version": "0.3.67",
+  "version": "0.3.68",
   "publishConfig": {
     "access": "public"
   },
@@ -37,7 +37,7 @@
   },
   "dependencies": {
     "@arcblock/ipfs-only-hash": "^0.0.2",
-    "@arcblock/validator": "^1.18.110",
+    "@arcblock/validator": "^1.18.113",
     "debug": "^4.3.4",
     "hasha": "^5.2.2",
     "joi": "^17.12.2",
@@ -60,5 +60,5 @@
     "ts-jest": "^28.0.8",
     "typescript": "^4.9.5"
   },
-  "gitHead": "caa0de1abb3552ee376be2fed2670303d7f602a1"
+  "gitHead": "64012c24c566b0d066689cbe6d4ba689c54c8065"
 }