@blocklet/did-space-js 0.5.58

package/dist/commands/nft/put-nft-object.js

@@ -0,0 +1,143 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PutNftObjectCommand = void 0;
+const util_1 = require("@ocap/util");
+const env_1 = __importDefault(require("@blocklet/env"));
+const path_1 = require("path");
+const fs_extra_1 = require("fs-extra");
+const form_data_1 = __importDefault(require("form-data"));
+const core_1 = require("@did-space/core");
+const ufo_1 = require("ufo");
+const did_document_1 = require("../../did-document");
+const base_1 = require("../base");
+const security_1 = require("../../security");
+const libs_1 = require("../../libs");
+class PutNftObjectCommand extends base_1.BaseCommand {
+    tempCacheObjectKey;
+    tempCacheObjectHash;
+    constructor(input) {
+        super(input);
+        this.tempCacheObjectKey = (0, path_1.join)(env_1.default.dataDir, 'temp-uploads', Date.now() + this.input.display.key);
+        (0, fs_extra_1.ensureDirSync)((0, path_1.dirname)(this.tempCacheObjectKey));
+    }
+    getUrl() {
+        const { endpoint } = this.context;
+        const didObjectUrl = (0, ufo_1.joinURL)(endpoint, 'did-objects', (0, libs_1.encode)(this.input.display.key));
+        const didObjectURL = new URL(didObjectUrl);
+        didObjectURL.searchParams.set('did', this.input.did);
+        // @ts-expect-error
+        return didObjectURL.toString();
+    }
+    getDisplayUrl() {
+        // @ts-expect-error
+        return (0, ufo_1.joinURL)(this.context.endpoint.replace(/\/api\/space.*/, ''), 'resolve', (0, libs_1.toABTDid)(this.input.did), 'display');
+    }
+    async getStreams() {
+        const writeStream = (0, fs_extra_1.createWriteStream)(this.tempCacheObjectKey);
+        this.input.display.data.pipe(writeStream);
+        await (0, libs_1.streamToFile)(writeStream);
+        this.input.display.data = (0, fs_extra_1.createReadStream)(this.tempCacheObjectKey);
+        const streamForHash = (0, fs_extra_1.createReadStream)(this.tempCacheObjectKey);
+        return {
+            streamForHash,
+            streamForUpload: this.input.display.data,
+        };
+    }
+    async getDidDocument(streamForHash) {
+        const displayUrl = await this.getDisplayUrl();
+        const currentTime = new Date().toISOString();
+        const wallet = this.input.controller;
+        const ABTDid = (0, libs_1.toABTDid)(this.input.did);
+        const controllerAddress = (0, libs_1.toABTDid)(wallet.address);
+        const hash = await (0, core_1.getHash)(streamForHash);
+        this.tempCacheObjectHash = hash;
+        const didDocument = {
+            '@context': 'https://www.w3.org/ns/did/v1',
+            id: ABTDid,
+            controller: controllerAddress,
+            service: [
+                {
+                    id: `${ABTDid}/display`,
+                    type: 'NFTDisplay',
+                    key: this.input.display.key,
+                    // v0.2 版本开始有的
+                    hash,
+                    serviceEndpoint: displayUrl,
+                },
+                {
+                    id: `${ABTDid}/explorer`,
+                    type: 'ArcBlockExplorerUrl',
+                    serviceEndpoint: (0, ufo_1.joinURL)(this.input.chainHost, 'assets', ABTDid),
+                },
+            ],
+            verificationMethod: [
+                {
+                    id: `${ABTDid}#key-1`,
+                    type: 'Ed25519Signature',
+                    controller: controllerAddress,
+                    publicKeyMultibase: (0, util_1.toBase58)(wallet.publicKey),
+                },
+            ],
+            proof: {
+                type: 'Ed25519Signature',
+                created: currentTime,
+                verificationMethod: `${ABTDid}#key-1`,
+            },
+            authentication: [`${ABTDid}#key-1`],
+            created: currentTime,
+            updated: currentTime,
+        };
+        (0, did_document_1.signDidDocument)(didDocument, wallet);
+        return didDocument;
+    }
+    async getAxiosRequestConfig() {
+        try {
+            const url = await this.getUrl();
+            const method = 'PUT';
+            const { streamForUpload, streamForHash } = await this.getStreams();
+            const didDocument = await this.getDidDocument(streamForHash);
+            const formData = new form_data_1.default();
+            formData.append('data', streamForUpload);
+            formData.append('didDocument', JSON.stringify(didDocument));
+            const { headers } = (0, security_1.signRequest)({
+                url,
+                method,
+                data: formData,
+                headers: {
+                    [core_1.HEADERS.X_HASH]: this.tempCacheObjectHash,
+                    [core_1.HEADERS.X_SIGNATURE_VERSION]: '2',
+                },
+                wallet: this.context.wallet,
+                delegation: this.context.delegation,
+            });
+            const config = {
+                url,
+                method,
+                data: formData,
+                maxContentLength: Infinity,
+                maxBodyLength: Infinity,
+                headers: {
+                    ...headers,
+                    'Content-Type': 'multipart/form-data',
+                    ...formData.getHeaders(),
+                },
+                // @FIXME: @yejianchao 后续根据文件计算出一个合理的超时时间
+                timeout: 5 * libs_1.MIN,
+            };
+            return config;
+        }
+        finally {
+            await this.destroy();
+        }
+    }
+    // @ts-expect-error
+    destroy() {
+        if ((0, fs_extra_1.existsSync)(this.tempCacheObjectKey)) {
+            (0, fs_extra_1.removeSync)(this.tempCacheObjectKey);
+        }
+    }
+}
+exports.PutNftObjectCommand = PutNftObjectCommand;

package/dist/commands/object/delete-object.d.ts

@@ -0,0 +1,7 @@
+import { AxiosRequestConfig, AxiosResponse } from 'axios';
+import { DeleteObjectCommandOutput, DeleteObjectCommandInput } from '../../meta';
+import { BaseCommand } from '../base';
+export declare class DeleteObjectCommand extends BaseCommand<DeleteObjectCommandInput, DeleteObjectCommandOutput> {
+    getAxiosRequestConfig(): Promise<AxiosRequestConfig<any>>;
+    resolveMiddleware(res: AxiosResponse<DeleteObjectCommandOutput['data'], any>): Promise<DeleteObjectCommandOutput>;
+}

package/dist/commands/object/delete-object.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeleteObjectCommand = void 0;
+const ufo_1 = require("ufo");
+const core_1 = require("@did-space/core");
+const base_1 = require("../base");
+const security_1 = require("../../security");
+class DeleteObjectCommand extends base_1.BaseCommand {
+    getAxiosRequestConfig() {
+        const url = (0, ufo_1.joinURL)(this.context.endpoint, 'object', this.getKey(this.input.key));
+        const method = 'DELETE';
+        const { headers } = (0, security_1.signRequest)({
+            url,
+            method,
+            data: {},
+            headers: {
+                [core_1.HEADERS.X_SIGNATURE_VERSION]: '2',
+            },
+            wallet: this.context.wallet,
+            delegation: this.context.delegation,
+        });
+        const axiosRequestConfig = {
+            url,
+            method,
+            headers,
+        };
+        // @ts-expect-error
+        return axiosRequestConfig;
+    }
+    resolveMiddleware(res) {
+        return Promise.resolve({
+            statusCode: res.status,
+            statusMessage: res.statusText,
+            data: undefined,
+        });
+    }
+}
+exports.DeleteObjectCommand = DeleteObjectCommand;

package/dist/commands/object/get-object.d.ts

@@ -0,0 +1,7 @@
+import { AxiosRequestConfig, AxiosResponse } from 'axios';
+import { GetObjectCommandInput, GetObjectCommandOutput } from '../../meta';
+import { BaseCommand } from '../base';
+export declare class GetObjectCommand extends BaseCommand<GetObjectCommandInput, GetObjectCommandOutput> {
+    getAxiosRequestConfig(): Promise<AxiosRequestConfig<any>>;
+    resolveMiddleware(res: AxiosResponse<GetObjectCommandOutput['data'], any>): Promise<GetObjectCommandOutput>;
+}

package/dist/commands/object/get-object.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetObjectCommand = void 0;
+const ufo_1 = require("ufo");
+const core_1 = require("@did-space/core");
+const base_1 = require("../base");
+const security_1 = require("../../security");
+class GetObjectCommand extends base_1.BaseCommand {
+    getAxiosRequestConfig() {
+        const url = (0, ufo_1.joinURL)(this.context.endpoint, 'object', this.getKey(this.input.key));
+        const method = 'GET';
+        const { headers } = (0, security_1.signRequest)({
+            url,
+            method,
+            data: {},
+            headers: {
+                [core_1.HEADERS.X_SIGNATURE_VERSION]: '2',
+            },
+            wallet: this.context.wallet,
+            delegation: this.context.delegation,
+        });
+        const config = {
+            url,
+            method,
+            responseType: 'stream',
+            headers: {
+                'x-content-type': 'application/octet-stream',
+                ...headers,
+            },
+        };
+        // @ts-expect-error
+        return config;
+    }
+    resolveMiddleware(res) {
+        return Promise.resolve({
+            statusCode: res.status,
+            statusMessage: res.statusText,
+            headers: res.headers,
+            data: res.data,
+        });
+    }
+}
+exports.GetObjectCommand = GetObjectCommand;

package/dist/commands/object/index.d.ts

@@ -0,0 +1,5 @@
+export * from './get-object';
+export * from './list-object';
+export * from './list-objects';
+export * from './put-object';
+export * from './delete-object';

package/dist/commands/object/index.js

@@ -0,0 +1,21 @@
+"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("./get-object"), exports);
+__exportStar(require("./list-object"), exports);
+__exportStar(require("./list-objects"), exports);
+__exportStar(require("./put-object"), exports);
+__exportStar(require("./delete-object"), exports);

package/dist/commands/object/list-object.d.ts

@@ -0,0 +1,7 @@
+import { Object } from '@did-space/core';
+import { AxiosRequestConfig } from 'axios';
+import { ListObjectCommandInput, ListObjectCommandOutput } from '../../meta';
+import { BaseCommand } from '../base';
+export declare class ListObjectCommand extends BaseCommand<ListObjectCommandInput, ListObjectCommandOutput> {
+    getAxiosRequestConfig(): Promise<AxiosRequestConfig<Object>>;
+}

package/dist/commands/object/list-object.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ListObjectCommand = void 0;
+const core_1 = require("@did-space/core");
+const ufo_1 = require("ufo");
+const base_1 = require("../base");
+const security_1 = require("../../security");
+class ListObjectCommand extends base_1.BaseCommand {
+    getAxiosRequestConfig() {
+        const url = (0, ufo_1.joinURL)(this.context.endpoint, 'list', this.getKey(this.input.key));
+        const method = 'GET';
+        const { headers } = (0, security_1.signRequest)({
+            url,
+            method,
+            data: {},
+            headers: {
+                [core_1.HEADERS.X_SIGNATURE_VERSION]: '2',
+            },
+            wallet: this.context.wallet,
+            delegation: this.context.delegation,
+        });
+        const config = {
+            url,
+            method,
+            headers,
+        };
+        // @ts-expect-error
+        return config;
+    }
+}
+exports.ListObjectCommand = ListObjectCommand;

package/dist/commands/object/list-objects.d.ts

@@ -0,0 +1,7 @@
+import { Object } from '@did-space/core';
+import { AxiosRequestConfig } from 'axios';
+import { ListObjectsCommandInput, ListObjectsCommandOutput } from '../../meta';
+import { BaseCommand } from '../base';
+export declare class ListObjectsCommand extends BaseCommand<ListObjectsCommandInput, ListObjectsCommandOutput> {
+    getAxiosRequestConfig(): Promise<AxiosRequestConfig<Object>>;
+}

package/dist/commands/object/list-objects.js

@@ -0,0 +1,44 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ListObjectsCommand = void 0;
+const core_1 = require("@did-space/core");
+const ufo_1 = require("ufo");
+const debug_1 = __importDefault(require("debug"));
+const pick_1 = __importDefault(require("lodash/pick"));
+const querystring_1 = __importDefault(require("querystring"));
+const isEmpty_1 = __importDefault(require("lodash/isEmpty"));
+const base_1 = require("../base");
+const security_1 = require("../../security");
+const { name, version } = require('../../../package.json');
+const debug = (0, debug_1.default)(`${name}@${version}:list-objects`);
+class ListObjectsCommand extends base_1.BaseCommand {
+    getAxiosRequestConfig() {
+        // TODO: 此处应该有 joi 校验
+        const options = (0, pick_1.default)(this.input, ['recursive', 'ignoreDirectories']);
+        const queryParams = (0, isEmpty_1.default)(options) ? '' : `?${querystring_1.default.stringify(options)}`;
+        const url = (0, ufo_1.joinURL)(this.context.endpoint, 'lists', this.getKey(this.input.key), queryParams);
+        const method = 'GET';
+        debug('getAxiosRequestConfig.$url', url);
+        const { headers } = (0, security_1.signRequest)({
+            url,
+            method,
+            data: {},
+            headers: {
+                [core_1.HEADERS.X_SIGNATURE_VERSION]: '2',
+            },
+            wallet: this.context.wallet,
+            delegation: this.context.delegation,
+        });
+        const config = {
+            url,
+            method,
+            headers,
+        };
+        // @ts-expect-error
+        return config;
+    }
+}
+exports.ListObjectsCommand = ListObjectsCommand;

package/dist/commands/object/put-object.d.ts

@@ -0,0 +1,7 @@
+import { AxiosRequestConfig } from 'axios';
+import { PutObjectCommandInput, PutObjectCommandOutput } from '../../meta';
+import { BaseCommand } from '../base';
+export declare class PutObjectCommand extends BaseCommand<PutObjectCommandInput, PutObjectCommandOutput> {
+    getAxiosRequestConfig(): Promise<AxiosRequestConfig<any>>;
+    resolveMiddleware(): Promise<PutObjectCommandOutput>;
+}

package/dist/commands/object/put-object.js

@@ -0,0 +1,61 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PutObjectCommand = void 0;
+const core_1 = require("@did-space/core");
+const form_data_1 = __importDefault(require("form-data"));
+const isEmpty_1 = __importDefault(require("lodash/isEmpty"));
+const ufo_1 = require("ufo");
+const libs_1 = require("../../libs");
+const security_1 = require("../../security");
+const base_1 = require("../base");
+class PutObjectCommand extends base_1.BaseCommand {
+    // eslint-disable-next-line require-await
+    async getAxiosRequestConfig() {
+        return null;
+    }
+    async resolveMiddleware() {
+        const url = (0, ufo_1.joinURL)(this.context.endpoint, 'object', this.getKey(this.input.key));
+        const method = 'PUT';
+        const body = new form_data_1.default();
+        if (!(0, isEmpty_1.default)(this.input.data)) {
+            // @see: https://stackoverflow.com/a/43914175
+            body.append('data', this.input.data, {
+                filename: this.input.key,
+            });
+        }
+        if (!(0, isEmpty_1.default)(this.input.metadata)) {
+            body.append('metadata', JSON.stringify(this.input.metadata));
+        }
+        const { headers } = (0, security_1.signRequest)({
+            url,
+            method,
+            data: body,
+            headers: {
+                [core_1.HEADERS.X_SIGNATURE_VERSION]: '2',
+            },
+            wallet: this.context.wallet,
+            delegation: this.context.delegation,
+        });
+        const optionsOfTextResponseBody = {
+            method,
+            body,
+            headers: {
+                ...headers,
+                'x-hash': this.input.hash,
+                'Content-Type': 'multipart/form-data',
+                ...body.getHeaders(),
+            },
+        };
+        // TODO: axios 会导致严重的内存泄漏, 之后可以考虑切换到 got, @see: https://github.com/axios/axios/issues/4763#issuecomment-1334953446
+        const response = await (0, libs_1.gotApi)(url, optionsOfTextResponseBody);
+        return {
+            statusCode: response.statusCode,
+            statusMessage: response.statusMessage,
+            data: undefined,
+        };
+    }
+}
+exports.PutObjectCommand = PutObjectCommand;

package/dist/commands/restore/index.d.ts

@@ -0,0 +1,3 @@
+export * from './post-app-restore';
+export * from './put-app-restore';
+export * from './restore-blocklet';

package/dist/commands/restore/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("./post-app-restore"), exports);
+__exportStar(require("./put-app-restore"), exports);
+__exportStar(require("./restore-blocklet"), exports);

package/dist/commands/restore/post-app-restore.d.ts

@@ -0,0 +1,7 @@
+import { AxiosRequestConfig } from 'axios';
+import { PostAppRestoreCommandInput, PostAppRestoreCommandOutput } from '../../meta';
+import { BaseCommand } from '../base';
+export declare class PostAppRestoreCommand extends BaseCommand<PostAppRestoreCommandInput, PostAppRestoreCommandOutput> {
+    getAxiosRequestConfig(): Promise<AxiosRequestConfig<any>>;
+    resolveMiddleware(): Promise<PostAppRestoreCommandOutput>;
+}

package/dist/commands/restore/post-app-restore.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PostAppRestoreCommand = void 0;
+const ufo_1 = require("ufo");
+const libs_1 = require("../../libs");
+const meta_1 = require("../../meta");
+const security_1 = require("../../security");
+const base_1 = require("../base");
+class PostAppRestoreCommand extends base_1.BaseCommand {
+    getAxiosRequestConfig() {
+        return null;
+    }
+    async resolveMiddleware() {
+        const { error } = meta_1.PostAppRestoreCommandInputSchema.validate(this.input);
+        if (error) {
+            throw error;
+        }
+        const url = (0, ufo_1.joinURL)(this.context.endpoint, 'restore');
+        const data = this.input;
+        const method = 'POST';
+        const { headers } = (0, security_1.signRequest)({
+            url,
+            method,
+            data,
+            headers: {},
+            wallet: this.context.wallet,
+            delegation: this.context.delegation,
+        });
+        const response = await (0, libs_1.gotApi)({
+            url,
+            method,
+            json: data,
+            responseType: 'json',
+            headers: {
+                ...headers,
+            },
+        });
+        return {
+            statusCode: response.statusCode,
+            statusMessage: response.statusMessage,
+            data: response.body,
+        };
+    }
+}
+exports.PostAppRestoreCommand = PostAppRestoreCommand;

package/dist/commands/restore/put-app-restore.d.ts

@@ -0,0 +1,9 @@
+import { AxiosRequestConfig } from 'axios';
+import { PutAppRestoreCommandInput, PutAppRestoreCommandOutput } from '../../meta';
+import { BaseCommand } from '../base';
+import type { SpaceClientOptions } from '../../protocol';
+export declare class PutAppRestoreCommand extends BaseCommand<PutAppRestoreCommandInput, PutAppRestoreCommandOutput> {
+    constructor(input: PutAppRestoreCommandInput, context?: SpaceClientOptions);
+    getAxiosRequestConfig(): Promise<AxiosRequestConfig<any>>;
+    resolveMiddleware(): Promise<PutAppRestoreCommandOutput>;
+}

package/dist/commands/restore/put-app-restore.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PutAppRestoreCommand = void 0;
+const ufo_1 = require("ufo");
+const libs_1 = require("../../libs");
+const meta_1 = require("../../meta");
+const security_1 = require("../../security");
+const base_1 = require("../base");
+class PutAppRestoreCommand extends base_1.BaseCommand {
+    constructor(input, context) {
+        super(input, context);
+        const { error, value } = meta_1.PutAppRestoreCommandInputSchema.validate(input);
+        if (error) {
+            throw error;
+        }
+        this.input = value;
+    }
+    getAxiosRequestConfig() {
+        return null;
+    }
+    async resolveMiddleware() {
+        const url = (0, ufo_1.joinURL)(this.context.endpoint, 'restore');
+        const data = this.input;
+        const method = 'PUT';
+        const { headers } = (0, security_1.signRequest)({
+            url,
+            method,
+            data,
+            headers: {},
+            wallet: this.context.wallet,
+            delegation: this.context.delegation,
+        });
+        const response = await (0, libs_1.gotApi)({
+            url,
+            method,
+            json: data,
+            responseType: 'json',
+            headers: {
+                ...headers,
+            },
+        });
+        return {
+            statusCode: response.statusCode,
+            statusMessage: response.statusMessage,
+            data: response.body,
+        };
+    }
+}
+exports.PutAppRestoreCommand = PutAppRestoreCommand;

package/dist/commands/restore/restore-blocklet.d.ts

@@ -0,0 +1,14 @@
+import { AxiosRequestConfig } from 'axios';
+import { RestoreBlockletCommandInput, RestoreBlockletCommandOutput } from '../../meta';
+import { BaseCommand } from '../base';
+/**
+ *
+ * FIXME: @yejianchao 优化点，需要支持 joi 校验
+ * @export
+ * @class RestoreBlockletCommand
+ * @extends {BaseCommand<RestoreBlockletCommandInput, RestoreBlockletCommandOutput>}
+ */
+export declare class RestoreBlockletCommand extends BaseCommand<RestoreBlockletCommandInput, RestoreBlockletCommandOutput> {
+    getAxiosRequestConfig(): Promise<AxiosRequestConfig<any>>;
+    resolveMiddleware(): Promise<RestoreBlockletCommandOutput>;
+}