@blocklet/did-space-js 0.5.58

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

@@ -0,0 +1,6 @@
+import { Object } from '@did-space/core';
+import type { CommandOutput } from '../../protocol';
+export interface ListObjectCommandInput {
+    key: string;
+}
+export type ListObjectCommandOutput = CommandOutput<Object>;

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

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

package/dist/meta/object/list-objects-command.d.ts

@@ -0,0 +1,8 @@
+import { Object } from '@did-space/core';
+import { CommandOutput } from '../../protocol';
+export interface ListObjectsCommandInput {
+    key: string;
+    recursive?: false | true;
+    ignoreDirectories?: false | true;
+}
+export type ListObjectsCommandOutput = CommandOutput<Object[]>;

package/dist/meta/object/list-objects-command.js

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

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

@@ -0,0 +1,29 @@
+import { Data } from '@did-space/core';
+import type { CommandOutput } from '../../protocol';
+export interface PutObjectCommandInput {
+    /**
+     * @description 可以是一个文件名或者文件夹
+     * @type {string}
+     * @memberof PutObjectCommandInput
+     */
+    key: string;
+    /**
+     * @description
+     * @type {Data}
+     * @memberof PutObjectCommandInput
+     */
+    data?: Data;
+    /**
+     * @description 对象的 hash 值,我们期望它是 ipfs v1 的 hash
+     * @type {string}
+     * @memberof PutObjectCommandInput
+     */
+    hash?: string;
+    /**
+     * @description 存储文件夹或者文件的元数据
+     * @type {Record<string, any>}
+     * @memberof PutObjectCommandInput
+     */
+    metadata?: Record<string, any>;
+}
+export type PutObjectCommandOutput = CommandOutput<void>;

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

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

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

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

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

package/dist/meta/restore/post-app-restore-command.d.ts

@@ -0,0 +1,8 @@
+import { AppRestore } from '@did-space/core';
+import type { ObjectSchema } from 'joi';
+import { CommandOutput } from '../../protocol/command.protocol';
+export declare const PostAppRestoreCommandInputSchema: ObjectSchema<any>;
+export interface PostAppRestoreCommandInput extends Pick<AppRestore, 'userDid' | 'referrer' | 'serverDid'> {
+}
+export interface PostAppRestoreCommandOutput extends CommandOutput<Required<AppRestore>> {
+}

package/dist/meta/restore/post-app-restore-command.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PostAppRestoreCommandInputSchema = void 0;
+const validator_1 = require("@arcblock/validator");
+exports.PostAppRestoreCommandInputSchema = validator_1.Joi.object({
+    userDid: validator_1.Joi.DID(),
+    referrer: validator_1.Joi.string()
+        .uri({
+        scheme: ['http', 'https'],
+    })
+        .required(),
+    serverDid: validator_1.Joi.string().optional().allow('').default(''),
+});

package/dist/meta/restore/put-app-restore-command.d.ts

@@ -0,0 +1,7 @@
+import { AppRestore } from '@did-space/core';
+import type { ObjectSchema } from 'joi';
+import type { CommandOutput } from '../../protocol';
+export declare const PutAppRestoreCommandInputSchema: ObjectSchema<any>;
+export type PutAppRestoreCommandInput = Required<Pick<AppRestore, 'id'>> & Partial<AppRestore>;
+export interface PutAppRestoreCommandOutput extends CommandOutput<Required<AppRestore>> {
+}

package/dist/meta/restore/put-app-restore-command.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PutAppRestoreCommandInputSchema = void 0;
+const validator_1 = require("@arcblock/validator");
+const core_1 = require("@did-space/core");
+exports.PutAppRestoreCommandInputSchema = validator_1.Joi.object({
+    id: validator_1.Joi.string().required(),
+    updateAt: validator_1.Joi.string()
+        .optional()
+        .default(() => new Date().toISOString()),
+    // 默认是 APP_BACKUP_STATUS.DEFAULT 是因为我要兼容以前的旧版本的数据
+    status: validator_1.Joi.string()
+        .optional()
+        .allow('')
+        .valid(...Object.values(core_1.APP_BACKUP_STATUS))
+        .default(core_1.APP_BACKUP_STATUS.DEFAULT),
+    message: validator_1.Joi.string().optional().allow('').default(''),
+});

package/dist/meta/restore/restore-blocklet-command.d.ts

@@ -0,0 +1,28 @@
+import { SyncFolderBaseCommandInput, SyncFolderBaseCommandOutput } from '../sync/sync-folder-base-command';
+export interface RestoreBlockletCommandInput extends Omit<SyncFolderBaseCommandInput, 'source'> {
+    appDid: string;
+    /**
+     *
+     * @description 备份人员的 userDid
+     * @type {string}
+     * @memberof RestoreBlockletCommandInput
+     */
+    userDid: string;
+    /**
+     *
+     * @description 用户当时在什么页面备份的呢？
+     * @type {string}
+     * @memberof RestoreBlockletCommandInput
+     */
+    referrer: string;
+    /**
+     *
+     * @description 指向 server 的 did 地址
+     * @default ""
+     * @type {string}
+     * @memberof RestoreBlockletCommandInput
+     */
+    serverDid: string;
+}
+export interface RestoreBlockletCommandOutput extends SyncFolderBaseCommandOutput {
+}

package/dist/meta/restore/restore-blocklet-command.js

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

package/dist/meta/spaces-client-options.d.ts

@@ -0,0 +1,5 @@
+export interface SpaceEndpointContext {
+    baseUrl: string;
+    spaceDid: string;
+    appDid: string;
+}

package/dist/meta/spaces-client-options.js

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

package/dist/meta/sync/incremental-sync-base-command.d.ts

@@ -0,0 +1,7 @@
+import { Object } from '@did-space/core';
+import { SyncBaseCommandInput, SyncBaseCommandOutput } from './sync-base-command';
+export interface IncrementalSyncBaseCommandInput extends SyncBaseCommandInput {
+    source: Object[];
+}
+export interface IncrementalSyncBaseCommandOutput extends SyncBaseCommandOutput {
+}

package/dist/meta/sync/incremental-sync-base-command.js

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

package/dist/meta/sync/incremental-sync-push-command.d.ts

@@ -0,0 +1,8 @@
+import { Object, type ObjectMetadata } from '@did-space/core';
+import { SyncBaseCommandInput, SyncBaseCommandOutput } from './sync-base-command';
+export interface IncrementalSyncPushCommandInput extends SyncBaseCommandInput {
+    source: Object[];
+    metadata?: ObjectMetadata;
+}
+export interface IncrementalSyncPushCommandOutput extends SyncBaseCommandOutput {
+}

package/dist/meta/sync/incremental-sync-push-command.js

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

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

@@ -0,0 +1,6 @@
+export * from './incremental-sync-push-command';
+export * from './incremental-sync-base-command';
+export * from './sync-base-command';
+export * from './sync-folder-base-command';
+export * from './sync-folder-pull-command';
+export * from './sync-folder-push-command';

package/dist/meta/sync/index.js

@@ -0,0 +1,22 @@
+"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("./incremental-sync-push-command"), exports);
+__exportStar(require("./incremental-sync-base-command"), exports);
+__exportStar(require("./sync-base-command"), exports);
+__exportStar(require("./sync-folder-base-command"), exports);
+__exportStar(require("./sync-folder-pull-command"), exports);
+__exportStar(require("./sync-folder-push-command"), exports);

package/dist/meta/sync/sync-base-command.d.ts

@@ -0,0 +1,121 @@
+import { Object } from '@did-space/core';
+import type { CommandOutput } from '../../protocol';
+export interface OnProgressInput {
+    /**
+     *
+     * @description 已完成的任务数
+     * @type {number}
+     * @memberof OnProgressInput
+     */
+    completed: number;
+    /**
+     *
+     * @description 总任务数
+     * @type {number}
+     * @memberof OnProgressInput
+     */
+    total: number;
+    /**
+     *
+     * @description 文件的key
+     * @type {string}
+     * @memberof OnProgressInput
+     */
+    key: string;
+}
+export interface OnAfterUploadInput {
+    /**
+     *
+     * @description 已完成的任务数
+     * @type {number}
+     * @memberof OnProgressInput
+     */
+    completed: number;
+    /**
+     *
+     * @description 总任务数
+     * @type {number}
+     * @memberof OnProgressInput
+     */
+    total: number;
+    /**
+     *
+     * @description 文件的key
+     * @type {string}
+     * @memberof OnProgressInput
+     */
+    key: string;
+}
+export interface SyncBaseCommandInput {
+    /**
+     *
+     * @description 将 source 同步到 target, 文件夹请添加尾杠 /
+     * @type {string}
+     * @memberof SyncFolderBaseCommandInput
+     */
+    target: string;
+    /**
+     *
+     * @description 并发数，默认为 256
+     * @default 256
+     * @type {number}
+     * @memberof SyncFolderBaseCommandInput
+     */
+    concurrency?: number;
+    /**
+     *
+     * @description 同步失败后重试次数，默认重试 3 次
+     * @default 3
+     * @type {number}
+     * @memberof SyncFolderPushCommandInput
+     */
+    retryCount?: number;
+    /**
+     *
+     * @description 是否输出 debug 信息
+     * @default false
+     * @type {boolean}
+     * @memberof SyncFolderPushCommandInput
+     */
+    debug?: boolean;
+    /**
+     *
+     * @description 过滤函数，可用于过滤掉某些目录或者文件，需要 sync 请返回 true, 不需要 sync 请返回 false
+     * @default 默认同步所有文件，不过滤
+     * @memberof SyncFolderBaseCommandInput
+     */
+    filter?: (object: Object, index: number, objects: Object[]) => boolean;
+    onProgress?: (input: OnProgressInput) => Promise<void>;
+    onAfterUpload?: (input: OnAfterUploadInput) => Promise<void>;
+    /**
+     * @description 可以临时存放文件的一个目录,可不填写,但运行时一定有值
+     * @type {string}
+     * @memberof SyncBaseCommandInput
+     */
+    tmpDir?: string;
+}
+export interface SyncBaseCommandOutputData {
+    /**
+     * @description 发生错误的任务数
+     * @type {number}
+     * @memberof SyncFolderBaseCommandOutput
+     */
+    errorCount: number;
+    /**
+     *
+     * @description 总任务数
+     * @type {number}
+     * @memberof SyncFolderBaseCommandOutput
+     */
+    count: number;
+    /**
+     *
+     * @description 花了多少秒才处理完成呢?
+     * @unit 秒(s)
+     * @type {number}
+     * @memberof SyncFolderBaseCommandOutput
+     */
+    duration: number;
+}
+export interface SyncBaseCommandOutput extends CommandOutput<SyncBaseCommandOutputData> {
+}

package/dist/meta/sync/sync-base-command.js

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

package/dist/meta/sync/sync-folder-base-command.d.ts

@@ -0,0 +1,12 @@
+import { SyncBaseCommandInput, SyncBaseCommandOutput } from './sync-base-command';
+export interface SyncFolderBaseCommandInput extends SyncBaseCommandInput {
+    /**
+     *
+     * @description 需要被同步的 source, 文件夹请添加尾杠 /
+     * @type {string}
+     * @memberof SyncFolderBaseCommandInput
+     */
+    source: string;
+}
+export interface SyncFolderBaseCommandOutput extends SyncBaseCommandOutput {
+}

package/dist/meta/sync/sync-folder-base-command.js

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

package/dist/meta/sync/sync-folder-pull-command.d.ts

@@ -0,0 +1,5 @@
+import { SyncFolderBaseCommandInput, SyncFolderBaseCommandOutput } from './sync-folder-base-command';
+export interface SyncFolderPullCommandInput extends SyncFolderBaseCommandInput {
+}
+export interface SyncFolderPullCommandOutput extends SyncFolderBaseCommandOutput {
+}

package/dist/meta/sync/sync-folder-pull-command.js

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

package/dist/meta/sync/sync-folder-push-command.d.ts

@@ -0,0 +1,7 @@
+import type { ObjectMetadata } from '@did-space/core';
+import { SyncFolderBaseCommandInput, SyncFolderBaseCommandOutput } from './sync-folder-base-command';
+export interface SyncFolderPushCommandInput extends SyncFolderBaseCommandInput {
+    metadata?: ObjectMetadata;
+}
+export interface SyncFolderPushCommandOutput extends SyncFolderBaseCommandOutput {
+}

package/dist/meta/sync/sync-folder-push-command.js

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

package/dist/protocol/command.protocol.d.ts

@@ -0,0 +1,68 @@
+import type { WalletObject } from '@ocap/wallet';
+import type { Response } from 'got';
+export interface CommandInput {
+}
+export interface CommandOutput<D = any> {
+    /**
+     *
+     * @description
+     * @type {string}
+     * @memberof CommandOutput
+     */
+    statusCode: number;
+    /**
+     *
+     * @description 一般来说，发生错误的时候才会有值
+     * @type {string}
+     * @memberof CommandOutput
+     */
+    statusMessage?: string;
+    /**
+     * @description
+     * @type {string}
+     * @memberof CommandOutput
+     */
+    stack?: string;
+    /**
+     * @description
+     * @type {D}
+     * @memberof CommandOutput
+     */
+    data: D;
+    response?: Response;
+}
+export interface SpaceClientOptions {
+    /**
+     *
+     * @default blocklet wallet
+     * @type {WalletObject}
+     * @memberof SpaceClientOptions
+     */
+    wallet: WalletObject;
+    /**
+     *
+     * @description spaces endpoint
+     * @example https://cedcaa27-znkomkclejcfbjaxw9knzzebmzmqrxjnn9bb.did.abtnet.io/api/space/z3T6EHN7sLhH5cty1PshDeSipeG7JNxEVaRFS/app/zNKabhhwdvVmXjtRTtSHk2YQz4pdDPStV289/
+     * @type {string}
+     * @memberof SpaceClientOptions
+     */
+    endpoint: string;
+    /**
+     * A jwt token that certifies the requester is authorized to access the space
+     * @description delegation token
+     * @type {string}
+     * @memberof SpaceClientOptions
+     */
+    delegation?: string;
+    /**
+     * @description
+     * @type {string}
+     * @memberof SpaceClientOptions
+     */
+    componentDid?: string;
+}
+export interface CommandProtocol<Input extends CommandInput, Output extends CommandOutput> {
+    input: Input;
+    context: SpaceClientOptions;
+    request(...args: any[]): Promise<Output>;
+}

package/dist/protocol/command.protocol.js

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

package/dist/protocol/index.d.ts

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

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

package/dist/security/index.d.ts

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

package/dist/security/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("./request-signature"), exports);

package/dist/security/request-signature.d.ts

@@ -0,0 +1,32 @@
+import { WalletObject } from '@ocap/wallet';
+type Method = import('got/dist/source').Method;
+type Headers = {
+    'x-app-did': string;
+    'x-app-pk': string;
+    'x-app-token': string;
+    'x-app-delegation': string;
+    [key: string]: any;
+};
+declare function verifyDelegation(delegation: string, delegatee: WalletObject): string;
+declare function signRequest({ url, method, data, headers, wallet, delegation, }: {
+    url: string;
+    method: Method;
+    data: any;
+    headers: {
+        [key: string]: string;
+    };
+    wallet: WalletObject;
+    delegation?: string;
+}): {
+    url: string;
+    method: Method;
+    data: any;
+    headers: Headers;
+};
+declare function verifyRequest({ url, method, data, headers, }: {
+    url: string;
+    method: Method;
+    data: any;
+    headers: Headers;
+}): string;
+export { signRequest, verifyRequest, verifyDelegation };