@blocklet/did-space-js 0.5.74 → 0.5.76

package/dist/commands/index.d.ts

@@ -1,9 +1,10 @@
 export * from './backup';
+export * from './base';
 export * from './incremental-backup';
 export * from './incremental-sync';
 export * from './nft';
 export * from './object';
+export * from './preview';
 export * from './restore';
 export * from './space';
 export * from './sync';
-export * from './base';

package/dist/commands/index.js

@@ -15,11 +15,12 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./backup"), exports);
+__exportStar(require("./base"), exports);
 __exportStar(require("./incremental-backup"), exports);
 __exportStar(require("./incremental-sync"), exports);
 __exportStar(require("./nft"), exports);
 __exportStar(require("./object"), exports);
+__exportStar(require("./preview"), exports);
 __exportStar(require("./restore"), exports);
 __exportStar(require("./space"), exports);
 __exportStar(require("./sync"), exports);
-__exportStar(require("./base"), exports);

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

@@ -1,5 +1,5 @@
+export * from './delete-object';
 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

@@ -14,8 +14,8 @@ 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("./delete-object"), exports);
 __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/preview/delete-preview-object.d.ts

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

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

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeletePreviewObjectCommand = void 0;
+const path_1 = require("path");
+const ufo_1 = require("ufo");
+const core_1 = require("@did-space/core");
+const meta_1 = require("../../meta");
+const base_1 = require("../base");
+const security_1 = require("../../security");
+const libs_1 = require("../../libs");
+class DeletePreviewObjectCommand extends base_1.BaseCommand {
+    getAxiosRequestConfig() {
+        return Promise.resolve(null);
+    }
+    async resolveMiddleware() {
+        this.input = await meta_1.GetPreviewObjectCommandInputSchema.parseAsync(this.input);
+        const url = (0, ufo_1.joinURL)(this.context.endpoint, 'object', this.getKey((0, path_1.join)(this.input.key, '.meta/preview.yml')));
+        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 optionsOfTextResponseBody = {
+            method,
+            headers: {
+                ...headers,
+            },
+        };
+        const response = await (0, libs_1.gotApi)(url, optionsOfTextResponseBody);
+        return {
+            statusCode: response.statusCode,
+            statusMessage: response.statusMessage,
+            data: undefined,
+        };
+    }
+}
+exports.DeletePreviewObjectCommand = DeletePreviewObjectCommand;

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

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

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

@@ -0,0 +1,47 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetPreviewObjectCommand = void 0;
+const js_yaml_1 = __importDefault(require("js-yaml"));
+const path_1 = require("path");
+const ufo_1 = require("ufo");
+const core_1 = require("@did-space/core");
+const meta_1 = require("../../meta");
+const base_1 = require("../base");
+const security_1 = require("../../security");
+const libs_1 = require("../../libs");
+class GetPreviewObjectCommand extends base_1.BaseCommand {
+    getAxiosRequestConfig() {
+        return Promise.resolve(null);
+    }
+    async resolveMiddleware() {
+        this.input = await meta_1.GetPreviewObjectCommandInputSchema.parseAsync(this.input);
+        const url = (0, ufo_1.joinURL)(this.context.endpoint, 'object', this.getKey((0, path_1.join)(this.input.key, '.meta/preview.yml')));
+        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 optionsOfTextResponseBody = {
+            method,
+            headers: {
+                ...headers,
+            },
+        };
+        const response = await (0, libs_1.gotApi)(url, optionsOfTextResponseBody);
+        return {
+            statusCode: response.statusCode,
+            statusMessage: response.statusMessage,
+            data: js_yaml_1.default.load(response.body),
+        };
+    }
+}
+exports.GetPreviewObjectCommand = GetPreviewObjectCommand;

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

@@ -0,0 +1,3 @@
+export * from './delete-preview-object';
+export * from './get-preview-object';
+export * from './put-preview-object';

package/dist/commands/preview/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("./delete-preview-object"), exports);
+__exportStar(require("./get-preview-object"), exports);
+__exportStar(require("./put-preview-object"), exports);

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

@@ -0,0 +1,8 @@
+import { AxiosRequestConfig } from 'axios';
+import { PutPreviewObjectCommandInput, PutPreviewObjectCommandOutput } from '../../meta';
+import { BaseCommand } from '../base';
+export declare class PutPreviewObjectCommand extends BaseCommand<PutPreviewObjectCommandInput, PutPreviewObjectCommandOutput> {
+    getAxiosRequestConfig(): Promise<AxiosRequestConfig<any>>;
+    normalize(): Promise<void>;
+    resolveMiddleware(): Promise<PutPreviewObjectCommandOutput>;
+}

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

@@ -0,0 +1,77 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PutPreviewObjectCommand = 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 js_yaml_1 = __importDefault(require("js-yaml"));
+const path_1 = require("path");
+const p_all_1 = __importDefault(require("p-all"));
+const libs_1 = require("../../libs");
+const meta_1 = require("../../meta");
+const security_1 = require("../../security");
+const base_1 = require("../base");
+const object_1 = require("../object");
+class PutPreviewObjectCommand extends base_1.BaseCommand {
+    getAxiosRequestConfig() {
+        return Promise.resolve(null);
+    }
+    async normalize() {
+        this.input = await meta_1.PutPreviewObjectCommandInputSchema.parseAsync(this.input);
+        for (const resource of this.input.resources) {
+            if (!resource.key.startsWith(this.input.key)) {
+                console.error(`Resource key(${resource.key}) must start with ${this.input.key}`, { resource });
+                throw new Error(`Resource key(${resource.key}) must start with ${this.input.key}`);
+            }
+        }
+    }
+    async resolveMiddleware() {
+        await this.normalize();
+        const url = (0, ufo_1.joinURL)(this.context.endpoint, 'object', this.getKey((0, path_1.join)(this.input.key, '.meta/preview.yml')));
+        const method = 'PUT';
+        const data = new form_data_1.default();
+        // @see: https://stackoverflow.com/a/43914175
+        data.append('data', js_yaml_1.default.dump(this.input.data), {
+            filename: this.input.key,
+        });
+        if (!(0, isEmpty_1.default)(this.input.metadata)) {
+            data.append('metadata', JSON.stringify(this.input.metadata));
+        }
+        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 optionsOfTextResponseBody = {
+            method,
+            body: data,
+            headers: {
+                ...headers,
+                'x-hash': this.input.hash,
+                'Content-Type': 'multipart/form-data',
+                ...data.getHeaders(),
+            },
+        };
+        const response = await (0, libs_1.gotApi)(url, optionsOfTextResponseBody);
+        await (0, p_all_1.default)(this.input.resources.map((resource) => () => {
+            return new object_1.PutObjectCommand(resource, this.context).request();
+        }), {
+            concurrency: 4,
+        });
+        return {
+            statusCode: response.statusCode,
+            statusMessage: response.statusMessage,
+            data: undefined,
+        };
+    }
+}
+exports.PutPreviewObjectCommand = PutPreviewObjectCommand;

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

@@ -1,5 +1,7 @@
 export * from './delete-object-command';
 export * from './get-object-command';
+export * from './head-object-command';
 export * from './list-object-command';
 export * from './list-objects-command';
+export * from './preview-object-command';
 export * from './put-object-command';

package/dist/meta/object/index.js

@@ -16,6 +16,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./delete-object-command"), exports);
 __exportStar(require("./get-object-command"), exports);
+__exportStar(require("./head-object-command"), exports);
 __exportStar(require("./list-object-command"), exports);
 __exportStar(require("./list-objects-command"), exports);
+__exportStar(require("./preview-object-command"), exports);
 __exportStar(require("./put-object-command"), exports);

package/dist/meta/object/preview-object-command.d.ts

@@ -0,0 +1,204 @@
+import { PreviewTemplate } from '@did-space/core';
+import { z } from 'zod';
+import type { CommandOutput } from '../../protocol';
+export declare const PutPreviewObjectCommandInputSchema: z.ZodObject<{
+    /**
+     * @description 文件夹的路径,必须以 / 结尾
+     */
+    key: z.ZodString;
+    /**
+     * @description 预览模板的数据
+     */
+    data: z.ZodUnion<[z.ZodObject<z.objectUtil.extendShape<{
+        template: z.ZodString;
+        did: z.ZodEffects<z.ZodString, string, string>;
+    }, {
+        template: z.ZodLiteral<"nft">;
+        name: z.ZodString;
+        image: z.ZodString;
+        /**
+         * @description 文件夹的路径,必须以 / 结尾
+         */
+        chainHost: z.ZodString;
+    }>, "strip", z.ZodTypeAny, {
+        template: "nft";
+        did: string;
+        name: string;
+        image: string;
+        chainHost: string;
+    }, {
+        template: "nft";
+        did: string;
+        name: string;
+        image: string;
+        chainHost: string;
+    }>, z.ZodObject<z.objectUtil.extendShape<{
+        template: z.ZodString;
+        did: z.ZodEffects<z.ZodString, string, string>;
+    }, {
+        template: z.ZodDefault<z.ZodOptional<z.ZodLiteral<"profile">>>;
+        avatar: z.ZodString;
+        fullname: z.ZodString;
+        email: z.ZodString;
+    }>, "strip", z.ZodTypeAny, {
+        template: "profile";
+        did: string;
+        avatar: string;
+        fullname: string;
+        email: string;
+    }, {
+        did: string;
+        avatar: string;
+        fullname: string;
+        email: string;
+        template?: "profile";
+    }>, z.ZodObject<z.objectUtil.extendShape<{
+        template: z.ZodString;
+        did: z.ZodEffects<z.ZodString, string, string>;
+    }, {
+        template: z.ZodLiteral<"passport">;
+        image: z.ZodString;
+        type: z.ZodArray<z.ZodString, "many">;
+        issuerDid: z.ZodEffects<z.ZodString, string, string>;
+        issuerName: z.ZodString;
+        issuedAt: z.ZodString;
+        issuedTo: z.ZodString;
+        verified: z.ZodBoolean;
+    }>, "strip", z.ZodTypeAny, {
+        type: string[];
+        template: "passport";
+        did: string;
+        image: string;
+        issuerDid: string;
+        issuerName: string;
+        issuedAt: string;
+        issuedTo: string;
+        verified: boolean;
+    }, {
+        type: string[];
+        template: "passport";
+        did: string;
+        image: string;
+        issuerDid: string;
+        issuerName: string;
+        issuedAt: string;
+        issuedTo: string;
+        verified: boolean;
+    }>]>;
+    /**
+     * @description 存储元数据
+     */
+    metadata: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
+    /**
+     * @description 对象的 hash 值,它是 ipfs cid v1 的 hash
+     */
+    hash: z.ZodOptional<z.ZodString>;
+    /**
+     * @description 资源列表
+     */
+    resources: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+        data: z.ZodOptional<z.ZodAny>;
+        hash: z.ZodOptional<z.ZodString>;
+        metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    }, "strip", z.ZodTypeAny, {
+        key?: string;
+        data?: any;
+        hash?: string;
+        metadata?: Record<string, any>;
+    }, {
+        key?: string;
+        data?: any;
+        hash?: string;
+        metadata?: Record<string, any>;
+    }>, "many">>>;
+}, "strip", z.ZodTypeAny, {
+    key?: string;
+    data?: {
+        template: "nft";
+        did: string;
+        name: string;
+        image: string;
+        chainHost: string;
+    } | {
+        template: "profile";
+        did: string;
+        avatar: string;
+        fullname: string;
+        email: string;
+    } | {
+        type: string[];
+        template: "passport";
+        did: string;
+        image: string;
+        issuerDid: string;
+        issuerName: string;
+        issuedAt: string;
+        issuedTo: string;
+        verified: boolean;
+    };
+    hash?: string;
+    metadata?: Record<string, any>;
+    resources?: {
+        key?: string;
+        data?: any;
+        hash?: string;
+        metadata?: Record<string, any>;
+    }[];
+}, {
+    key?: string;
+    data?: {
+        template: "nft";
+        did: string;
+        name: string;
+        image: string;
+        chainHost: string;
+    } | {
+        did: string;
+        avatar: string;
+        fullname: string;
+        email: string;
+        template?: "profile";
+    } | {
+        type: string[];
+        template: "passport";
+        did: string;
+        image: string;
+        issuerDid: string;
+        issuerName: string;
+        issuedAt: string;
+        issuedTo: string;
+        verified: boolean;
+    };
+    hash?: string;
+    metadata?: Record<string, any>;
+    resources?: {
+        key?: string;
+        data?: any;
+        hash?: string;
+        metadata?: Record<string, any>;
+    }[];
+}>;
+export interface PutPreviewObjectCommandInput extends z.infer<typeof PutPreviewObjectCommandInputSchema> {
+}
+export type PutPreviewObjectCommandOutput = CommandOutput<void>;
+export declare const GetPreviewObjectCommandInputSchema: z.ZodObject<{
+    key: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    key?: string;
+}, {
+    key?: string;
+}>;
+export interface GetPreviewObjectCommandInput extends z.infer<typeof GetPreviewObjectCommandInputSchema> {
+}
+export type GetPreviewObjectCommandOutput = CommandOutput<PreviewTemplate>;
+export declare const DeletePreviewObjectCommandInputSchema: z.ZodObject<{
+    key: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    key?: string;
+}, {
+    key?: string;
+}>;
+export interface DeletePreviewObjectCommandInput extends z.infer<typeof DeletePreviewObjectCommandInputSchema> {
+}
+export type DeletePreviewObjectCommandOutput = CommandOutput<void>;

package/dist/meta/object/preview-object-command.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeletePreviewObjectCommandInputSchema = exports.GetPreviewObjectCommandInputSchema = exports.PutPreviewObjectCommandInputSchema = void 0;
+const core_1 = require("@did-space/core");
+const zod_1 = require("zod");
+const put_object_command_1 = require("./put-object-command");
+exports.PutPreviewObjectCommandInputSchema = zod_1.z.object({
+    /**
+     * @description 文件夹的路径,必须以 / 结尾
+     */
+    key: zod_1.z.string().endsWith('/'),
+    /**
+     * @description 预览模板的数据
+     */
+    data: core_1.PreviewTemplateSchema,
+    /**
+     * @description 存储元数据
+     */
+    metadata: zod_1.z.record(zod_1.z.any()).optional().default({}),
+    /**
+     * @description 对象的 hash 值,它是 ipfs cid v1 的 hash
+     */
+    hash: zod_1.z.string().optional(),
+    /**
+     * @description 资源列表
+     */
+    resources: zod_1.z.array(put_object_command_1.PutObjectCommandInputSchema).optional().default([]),
+});
+exports.GetPreviewObjectCommandInputSchema = zod_1.z.object({
+    key: zod_1.z.string().endsWith('/'),
+});
+exports.DeletePreviewObjectCommandInputSchema = zod_1.z.object({
+    key: zod_1.z.string().endsWith('/'),
+});

package/dist/meta/object/put-object-command.d.ts

@@ -1,29 +1,35 @@
 import { Data } from '@did-space/core';
+import { z } from 'zod';
 import type { CommandOutput } from '../../protocol';
-export interface PutObjectCommandInput {
+export declare const PutObjectCommandInputSchema: z.ZodObject<{
     /**
      * @description 可以是一个文件名或者文件夹
-     * @type {string}
-     * @memberof PutObjectCommandInput
      */
-    key: string;
+    key: z.ZodString;
     /**
-     * @description
-     * @type {Data}
-     * @memberof PutObjectCommandInput
+     * @description 存储文件夹或者文件的内容
      */
-    data?: Data;
+    data: z.ZodOptional<z.ZodAny>;
     /**
      * @description 对象的 hash 值,我们期望它是 ipfs v1 的 hash
-     * @type {string}
-     * @memberof PutObjectCommandInput
      */
-    hash?: string;
+    hash: z.ZodOptional<z.ZodString>;
     /**
      * @description 存储文件夹或者文件的元数据
-     * @type {Record<string, any>}
-     * @memberof PutObjectCommandInput
      */
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+}, "strip", z.ZodTypeAny, {
+    key?: string;
+    data?: any;
+    hash?: string;
     metadata?: Record<string, any>;
+}, {
+    key?: string;
+    data?: any;
+    hash?: string;
+    metadata?: Record<string, any>;
+}>;
+export interface PutObjectCommandInput extends z.infer<typeof PutObjectCommandInputSchema> {
+    data?: Data;
 }
 export type PutObjectCommandOutput = CommandOutput<void>;

package/dist/meta/object/put-object-command.js

@@ -1,2 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.PutObjectCommandInputSchema = void 0;
+const zod_1 = require("zod");
+exports.PutObjectCommandInputSchema = zod_1.z.object({
+    /**
+     * @description 可以是一个文件名或者文件夹
+     */
+    key: zod_1.z.string(),
+    /**
+     * @description 存储文件夹或者文件的内容
+     */
+    data: zod_1.z.any().optional(),
+    /**
+     * @description 对象的 hash 值,我们期望它是 ipfs v1 的 hash
+     */
+    hash: zod_1.z.string().optional(),
+    /**
+     * @description 存储文件夹或者文件的元数据
+     */
+    metadata: zod_1.z.record(zod_1.z.any()).optional(),
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blocklet/did-space-js",
-  "version": "0.5.74",
+  "version": "0.5.76",
   "publishConfig": {
     "access": "public"
   },
@@ -32,8 +32,8 @@
     "@arcblock/did": "^1.18.152",
     "@arcblock/jwt": "^1.18.152",
     "@arcblock/validator": "^1.18.152",
-    "@blocklet/env": "1.16.32",
-    "@did-space/core": "0.5.66",
+    "@blocklet/env": "^1.16.34-beta-20241129-100152-679bd732",
+    "@did-space/core": "^0.5.76",
     "@ocap/mcrypto": "^1.18.152",
     "@ocap/util": "^1.18.152",
     "@ocap/wallet": "^1.18.152",
@@ -49,13 +49,15 @@
     "hasha": "^5.2.2",
     "is-url": "^1.2.4",
     "joi": "^17.13.3",
+    "js-yaml": "^4.1.0",
     "json-stable-stringify": "^1.1.1",
     "lodash": "^4.17.21",
     "mime-types": "^2.1.35",
     "p-all": "3.0.0",
     "p-queue": "6.6.2",
     "ufo": "^1.5.4",
-    "xbytes": "^1.9.1"
+    "xbytes": "^1.9.1",
+    "zod": "^3.23.8"
   },
   "devDependencies": {
     "@arcblock/eslint-config-ts": "^0.3.3",
@@ -74,5 +76,5 @@
     "ts-jest": "^28.0.8",
     "typescript": "^4.9.5"
   },
-  "gitHead": "65431172d5fd6faec61194e635e05ed018a9ac6a"
+  "gitHead": "4df393e520450f2eacab119c125ba34af1629d5d"
 }