@did-space/template 0.1.87-beta-1

package/README.md

@@ -0,0 +1,7 @@
+# @did-space/template
+
+# Install
+
+```
+npm install @did-space/template
+```

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './schema';
+export * from './template';

package/dist/index.js

@@ -0,0 +1,18 @@
+"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("./schema"), exports);
+__exportStar(require("./template"), exports);

package/dist/libs/api.d.ts

@@ -0,0 +1 @@
+export declare const api: import("axios").AxiosInstance;

package/dist/libs/api.js

@@ -0,0 +1,8 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.api = void 0;
+const axios_1 = __importDefault(require("axios"));
+exports.api = axios_1.default.create();

package/dist/libs/index.d.ts

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

package/dist/libs/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("./api"), exports);

package/dist/schema/app-backup.d.ts

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

package/dist/schema/app-backup.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AppBackupSchema = void 0;
+const validator_1 = require("@arcblock/validator");
+const core_1 = require("@did-space/core");
+const app_connected_1 = require("./app-connected");
+const nanoid_1 = require("./nanoid");
+exports.AppBackupSchema = validator_1.Joi.object({
+    id: nanoid_1.NanoidSchema,
+    type: validator_1.Joi.string().valid(core_1.APP_BACKUP_TYPE).default(core_1.APP_BACKUP_TYPE),
+    userDid: validator_1.Joi.DID().required(),
+    referrer: app_connected_1.AppUrlSchema,
+    createAt: validator_1.Joi.string()
+        .optional()
+        .default(() => new Date().toISOString()),
+    updateAt: validator_1.Joi.string().optional().allow('').default(''),
+});

package/dist/schema/app-connected.d.ts

@@ -0,0 +1,5 @@
+export declare const AppUrlSchema: import("joi").StringSchema<string>;
+/**
+ * @link My Data 准备工作 之 交互设计 && 实现 https://team.arcblock.io/comment/discussions/594accd7-9379-4700-87a4-9fd5ef5b0bee
+ */
+export declare const AppConnectedSchema: import("joi").ObjectSchema<any>;

package/dist/schema/app-connected.js

@@ -0,0 +1,39 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AppConnectedSchema = exports.AppUrlSchema = void 0;
+const validator_1 = require("@arcblock/validator");
+const is_url_1 = __importDefault(require("is-url"));
+const core_1 = require("@did-space/core");
+const nanoid_1 = require("./nanoid");
+exports.AppUrlSchema = validator_1.Joi.string()
+    .required()
+    .custom((value, helper) => {
+    if (!(0, is_url_1.default)(value)) {
+        return helper.message(`appUrl(${value}) must be a http/https url`);
+    }
+    return value;
+});
+/**
+ * @link My Data 准备工作 之 交互设计 && 实现 https://team.arcblock.io/comment/discussions/594accd7-9379-4700-87a4-9fd5ef5b0bee
+ */
+exports.AppConnectedSchema = validator_1.Joi.object({
+    id: nanoid_1.NanoidSchema,
+    type: validator_1.Joi.string().valid(core_1.APP_CONNECT_TYPE).default(core_1.APP_CONNECT_TYPE),
+    userDid: validator_1.Joi.DID().required(),
+    spaceDid: validator_1.Joi.DID().required(),
+    appDid: validator_1.Joi.DID().required(),
+    appName: validator_1.Joi.string().required(),
+    appDescription: validator_1.Joi.string().optional().allow('').default(''),
+    scopes: validator_1.Joi.string().required(),
+    appUrl: exports.AppUrlSchema,
+    referrer: exports.AppUrlSchema,
+    createAt: validator_1.Joi.string()
+        .optional()
+        .default(() => new Date().toISOString()),
+    updateAt: validator_1.Joi.string()
+        .optional()
+        .default(() => new Date().toISOString()),
+});

package/dist/schema/app-restore.d.ts

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

package/dist/schema/app-restore.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AppRestoreSchema = void 0;
+const validator_1 = require("@arcblock/validator");
+const core_1 = require("@did-space/core");
+const app_connected_1 = require("./app-connected");
+const nanoid_1 = require("./nanoid");
+exports.AppRestoreSchema = validator_1.Joi.object({
+    id: nanoid_1.NanoidSchema,
+    type: validator_1.Joi.string().valid(core_1.APP_RESTORE_TYPE).default(core_1.APP_RESTORE_TYPE),
+    userDid: validator_1.Joi.DID().required(),
+    referrer: app_connected_1.AppUrlSchema,
+    createAt: validator_1.Joi.string()
+        .optional()
+        .default(() => new Date().toISOString()),
+    updateAt: validator_1.Joi.string().optional().allow('').default(''),
+});

package/dist/schema/app.d.ts

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

package/dist/schema/app.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AppSchema = void 0;
+const validator_1 = require("@arcblock/validator");
+const core_1 = require("@did-space/core");
+const app_backup_1 = require("./app-backup");
+const app_connected_1 = require("./app-connected");
+const app_restore_1 = require("./app-restore");
+const nanoid_1 = require("./nanoid");
+exports.AppSchema = validator_1.Joi.object({
+    id: nanoid_1.NanoidSchema,
+    type: validator_1.Joi.string().valid(core_1.APP_TYPE).default(core_1.APP_TYPE),
+    userDid: validator_1.Joi.DID().required(),
+    connected: validator_1.Joi.array().items(app_connected_1.AppConnectedSchema).optional().default([]),
+    backup: validator_1.Joi.array().items(app_backup_1.AppBackupSchema).optional().default([]),
+    restore: validator_1.Joi.array().items(app_restore_1.AppRestoreSchema).optional().default([]),
+    createAt: validator_1.Joi.string()
+        .optional()
+        .default(() => new Date().toISOString()),
+    updateAt: validator_1.Joi.string()
+        .optional()
+        .default(() => new Date().toISOString()),
+});

package/dist/schema/index.d.ts

@@ -0,0 +1,2 @@
+export * from './app-connected';
+export * from './app';

package/dist/schema/index.js

@@ -0,0 +1,18 @@
+"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("./app-connected"), exports);
+__exportStar(require("./app"), exports);

package/dist/schema/nanoid.d.ts

@@ -0,0 +1 @@
+export declare const NanoidSchema: import("joi").StringSchema<string>;

package/dist/schema/nanoid.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NanoidSchema = void 0;
+const validator_1 = require("@arcblock/validator");
+const nanoid_1 = require("nanoid");
+exports.NanoidSchema = validator_1.Joi.string()
+    .optional()
+    .default(() => (0, nanoid_1.nanoid)());

package/dist/template/app.d.ts

@@ -0,0 +1,29 @@
+import { Space, App, AppBackup, AppRestore } from '@did-space/core';
+export interface AppTemplateOptions {
+    space: Space;
+    appDid: string;
+}
+/**
+ *
+ * FIXME: @yejianchao 实验性的功能实现，需要后续改进支持
+ * @export
+ * @class AppTemplate
+ */
+export declare class AppTemplate {
+    private readonly options;
+    private cacheApp;
+    constructor(options: AppTemplateOptions);
+    private get key();
+    private verify;
+    create(options: {
+        userDid: string;
+    }): Promise<void>;
+    isCreated(): Promise<boolean>;
+    get(): Promise<App | null>;
+    set(app: App): Promise<App>;
+    isConnected(url: string): Promise<boolean>;
+    addAppBackup(appBackup: AppBackup): Promise<AppBackup>;
+    updateAppBackupById(id: string, appBackup: Omit<AppBackup, 'id'>): Promise<AppBackup>;
+    addAppRestore(appRestore: AppRestore): Promise<AppRestore>;
+    updateAppRestoreById(id: string, appRestore: Omit<AppRestore, 'id'>): Promise<AppRestore>;
+}

package/dist/template/app.js

@@ -0,0 +1,144 @@
+"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.AppTemplate = void 0;
+const core_1 = require("@did-space/core");
+const did_1 = require("@arcblock/did");
+const js_yaml_1 = __importDefault(require("js-yaml"));
+const isEmpty_1 = __importDefault(require("lodash/isEmpty"));
+const cloneDeep_1 = __importDefault(require("lodash/cloneDeep"));
+const last_1 = __importDefault(require("lodash/last"));
+const findLastIndex_1 = __importDefault(require("lodash/findLastIndex"));
+const path_1 = require("path");
+const schema_1 = require("../schema");
+const libs_1 = require("../libs");
+/**
+ *
+ * FIXME: @yejianchao 实验性的功能实现，需要后续改进支持
+ * @export
+ * @class AppTemplate
+ */
+class AppTemplate {
+    constructor(options) {
+        this.verify(options);
+        this.options = options;
+    }
+    get key() {
+        return (0, path_1.join)('/apps', this.options.appDid, '.meta/config.yml');
+    }
+    verify(options) {
+        if (!options) {
+            throw new Error('options is required');
+        }
+        if (!options.space instanceof core_1.Space) {
+            throw new Error('space must be a Space instance');
+        }
+        if (!(0, did_1.isValid)(options.appDid)) {
+            throw new Error(`appDid(${options.appDid}) must be a valid did`);
+        }
+    }
+    create(options) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const app = (_a = (yield this.get())) !== null && _a !== void 0 ? _a : {};
+            if ((0, isEmpty_1.default)(app)) {
+                app.userDid = options.userDid;
+                yield this.set(app);
+            }
+        });
+    }
+    isCreated() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.options.space.existsAsOwner(this.key);
+        });
+    }
+    get() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!(yield this.isCreated())) {
+                return null;
+            }
+            if (this.cacheApp) {
+                return (0, cloneDeep_1.default)(this.cacheApp);
+            }
+            // 我觉得这个 readAsOwner 以及 其他 xxxAsOwner 函数已经不好用了，建议重新思考一下 @yejianchao
+            const data = yield this.options.space.readAsOwner(this.key);
+            const ymlStr = yield (0, core_1.streamToString)(data);
+            this.cacheApp = js_yaml_1.default.load(ymlStr);
+            return this.cacheApp;
+        });
+    }
+    set(app) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { error, value } = schema_1.AppSchema.validate(app);
+            if (error) {
+                throw new Error(error.message);
+            }
+            yield this.options.space.writeAsOwner(this.key, js_yaml_1.default.dump(value));
+            this.cacheApp = value;
+            return this.cacheApp;
+        });
+    }
+    isConnected(url) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const res = yield libs_1.api.get(url);
+                return res.status === 200;
+            }
+            catch (error) {
+                return false;
+            }
+        });
+    }
+    addAppBackup(appBackup) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const app = yield this.get();
+            app.backup.push(Object.assign({}, appBackup));
+            const latestApp = yield this.set(app);
+            return (0, last_1.default)(latestApp.backup);
+        });
+    }
+    updateAppBackupById(id, appBackup) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const app = yield this.get();
+            const index = (0, findLastIndex_1.default)(app.backup, (b) => b.id === id);
+            if (index === -1) {
+                throw new Error(`AppBackup with id(${id}) not found`);
+            }
+            app.backup[index] = Object.assign(Object.assign({}, app.backup[index]), appBackup);
+            yield this.set(app);
+            return app.backup[index];
+        });
+    }
+    addAppRestore(appRestore) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const app = yield this.get();
+            app.restore.push(Object.assign({}, appRestore));
+            const latestApp = yield this.set(app);
+            return (0, last_1.default)(latestApp.restore);
+        });
+    }
+    updateAppRestoreById(id, appRestore) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const app = yield this.get();
+            const index = (0, findLastIndex_1.default)(app.restore, (b) => b.id === id);
+            if (index === -1) {
+                throw new Error(`AppRestore with id(${id}) not found`);
+            }
+            app.restore[index] = Object.assign(Object.assign({}, app.restore[index]), appRestore);
+            yield this.set(app);
+            return app.restore[index];
+        });
+    }
+}
+exports.AppTemplate = AppTemplate;

package/dist/template/index.d.ts

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

package/dist/template/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("./app"), exports);

package/package.json

@@ -0,0 +1,79 @@
+{
+  "name": "@did-space/template",
+  "version": "0.1.87-beta-1",
+  "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",
+    "coverage": "yarn test -- --coverage",
+    "prebuild": "rm -fr dist",
+    "build": "tsc",
+    "build:watch": "npm run build -- --watch",
+    "pre-commit": "lint-staged",
+    "verify": "npm run lint:fix && 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",
+    "@arcblock/validator": "^1.18.57",
+    "@blocklet/sdk": "1.8.67",
+    "@did-space/core": "^0.1.86",
+    "@ocap/mcrypto": "^1.18.57",
+    "@ocap/util": "^1.18.57",
+    "@ocap/wallet": "^1.18.57",
+    "agentkeepalive": "^4.2.1",
+    "axios": "^0.27.2",
+    "debug": "^4.3.4",
+    "filehound": "^1.17.6",
+    "form-data": "^4.0.0",
+    "fs-extra": "^11.1.0",
+    "got": "11.8.6",
+    "hasha": "^5.2.2",
+    "is-url": "^1.2.4",
+    "js-yaml": "^4.1.0",
+    "json-stable-stringify": "^1.0.1",
+    "lodash": "^4.17.21",
+    "nanoid": "^3.3.4",
+    "p-all": "3.0.0",
+    "p-queue": "6.6.2",
+    "readable-stream-clone": "^0.0.7",
+    "url-join": "^4.0.1",
+    "valid-url": "^1.0.9"
+  },
+  "devDependencies": {
+    "@arcblock/eslint-config-ts": "^0.2.3",
+    "@types/fs-extra": "^9.0.13",
+    "@types/is-url": "^1.2.30",
+    "@types/jest": "^28.1.5",
+    "@types/js-yaml": "^4.0.5",
+    "@types/json-stable-stringify": "^1.0.34",
+    "@types/lodash": "^4.14.191",
+    "@types/node": "15.12.2",
+    "@types/url-join": "^4.0.1",
+    "@typescript-eslint/eslint-plugin": "^5.30.6",
+    "eslint": "^8.19.0",
+    "jest": "^28.1.3",
+    "lint-staged": "^13.0.3",
+    "ts-jest": "^28.0.6",
+    "typescript": "^4.9.5"
+  }
+}