@did-space/core 0.5.78 → 0.5.80

package/dist/{model → cjs/model}/object-collection.d.ts

@@ -1,4 +1,4 @@
-import { Model } from 'sequelize';
+import type { Model } from 'sequelize';
 /**
  * @description 存储的是对象的信息，不保存结构，创建之初就确定了，只能增加，删除
  * @export

package/dist/{model → cjs/model}/object.d.ts

@@ -1,4 +1,4 @@
-import { Model, CreationOptional } from 'sequelize';
+import type { Model, CreationOptional } from 'sequelize';
 /**
  * @description 存储的是对象的信息，不保存结构，创建之初就确定了，只能增加，删除
  * @export

package/dist/{model → cjs/model}/space.d.ts

@@ -1,4 +1,4 @@
-import { Model } from 'sequelize';
+import type { Model } from 'sequelize';
 import type { LiteralUnion } from 'type-fest';
 export declare class SpaceRepositoryClass extends Model<SpaceRepositoryClass, SpaceRepositoryClass> {
     id: string;

package/dist/{model → cjs/model}/tree.d.ts

@@ -1,5 +1,5 @@
-import { Model } from 'sequelize';
-import { ObjectModel } from './object';
+import type { Model } from 'sequelize';
+import type { ObjectModel } from './object';
 export interface TreeModel {
     /**
      * @description uuidv4

package/dist/cjs/model/tree.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TreeModelDefaultMeta = exports.TreeModelType = void 0;
+var TreeModelType;
+(function (TreeModelType) {
+    TreeModelType[TreeModelType["FOLDER"] = 0] = "FOLDER";
+    TreeModelType[TreeModelType["FILE"] = 1] = "FILE";
+})(TreeModelType = exports.TreeModelType || (exports.TreeModelType = {}));
+exports.TreeModelDefaultMeta = {};

package/dist/cjs/protocols/driver.js

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

package/dist/cjs/protocols/space-config.js

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

package/dist/cjs/protocols/space-operator.js

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

package/dist/cjs/protocols/space-owner-operator.js

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

package/dist/cjs/protocols/space.js

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

package/dist/es/configuration/index.d.ts

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

package/dist/es/configuration/index.js

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

package/dist/es/configuration/space-config.d.ts

@@ -0,0 +1,23 @@
+export interface SpaceConfig {
+    did: string;
+    drive?: 'fs' | 's3';
+    type?: 'buy' | 'default';
+    name: string;
+    description?: string;
+    size?: number;
+    assetDid: string;
+    createAt: string;
+    updateAt: string;
+    expireAt: string;
+    ownerDid: string;
+    permissions?: Permissions;
+}
+export interface Permissions {
+    [fromAppDid: string]: {
+        [toAppDid: string]: number;
+    };
+}
+export type Scope = 'list:object' | 'read:object' | 'write:object';
+export declare const Scopes: {
+    [key in Scope]: number;
+};

package/dist/es/configuration/space-config.js

@@ -0,0 +1,5 @@
+export const Scopes = {
+    'list:object': 1,
+    'read:object': 2,
+    'write:object': 4,
+};

package/dist/es/constants/index.d.ts

@@ -0,0 +1,30 @@
+export declare const APPS = "apps";
+export declare const DID_OBJECTS = ".did-objects";
+export declare const HEADERS: {
+    X_HASH: string;
+    X_SIGNATURE_VERSION: string;
+};
+export declare const APP: {
+    FOLDER_PREFIX: string;
+    COMPONENT: {
+        FOLDER_PREFIX: string;
+    };
+};
+export declare const SPACE_CONNECT_ERROR_CODE: {
+    /** 网络错误 */
+    NETWORK_ERROR: number;
+    /** 未授权 */
+    UNAUTHORIZED: number;
+    /** 订阅过期 */
+    EXPIRED: number;
+    /** 订阅逾期 */
+    PAST_DUE: number;
+    /** 订阅状态异常 */
+    INVALID: number;
+    /** 用量不足 */
+    UNIT_LIMIT: number;
+    /** 跨域限制 */
+    CORS_BLOCKED: number;
+};
+export declare const GLOBAL_SPACE_ROOT = "__GLOBAL__";
+export declare const STORAGE_BUILT_IN_OBJECTS: string[];

package/dist/es/constants/index.js

@@ -0,0 +1,35 @@
+export const APPS = 'apps';
+export const DID_OBJECTS = '.did-objects';
+export const HEADERS = {
+    X_HASH: 'x-hash',
+    // 取值范围 undefined | "2"
+    // (默认）取值为 undefined，表示 url 未使用任何编码方式。
+    // 取值为 2，表示 url 使用了 base64url 编码的方式
+    X_SIGNATURE_VERSION: 'x-signature-version',
+};
+export const APP = {
+    // @example: /${spaceDid}/apps/${appDid}
+    FOLDER_PREFIX: 'apps',
+    COMPONENT: {
+        // @example: /${spaceDid}/apps/${appDid}/.components/${componentDid}
+        FOLDER_PREFIX: '.components',
+    },
+};
+export const SPACE_CONNECT_ERROR_CODE = {
+    /** 网络错误 */
+    NETWORK_ERROR: 1001,
+    /** 未授权 */
+    UNAUTHORIZED: 1002,
+    /** 订阅过期 */
+    EXPIRED: 1003,
+    /** 订阅逾期 */
+    PAST_DUE: 1004,
+    /** 订阅状态异常 */
+    INVALID: 1005,
+    /** 用量不足 */
+    UNIT_LIMIT: 1006,
+    /** 跨域限制 */
+    CORS_BLOCKED: 1007,
+};
+export const GLOBAL_SPACE_ROOT = '__GLOBAL__';
+export const STORAGE_BUILT_IN_OBJECTS = ['/config.yml', '/apps/', '/.meta/'];

package/dist/es/drivers/base.d.ts

@@ -0,0 +1,40 @@
+/// <reference types="node" />
+import { Stream } from 'stream';
+import { SpaceConfig } from '../configuration';
+import { Data, Object } from '../meta';
+import { AppSpaceOptions, DeleteOptions, DriverOptions, DriverProtocol, ExistsAsOwnerOptions, GetHashOptions, KeyStatus, ListOptions, ListsOptions, PermissionOptions, ReadAsOwnerOptions, ReadOptions, SpaceConfigProtocol, SpaceOperatorProtocol, WriteAsOwnerOptions, WriteOptions } from '../protocols';
+export declare abstract class BaseDriver implements DriverProtocol {
+    readonly options: DriverOptions;
+    constructor(options: DriverOptions);
+    abstract get spaceOperator(): SpaceOperatorProtocol;
+    abstract get spaceConfig(): SpaceConfigProtocol;
+    createSpace(spaceConfig: SpaceConfig): Promise<void>;
+    destroySpace(): Promise<void>;
+    isSpaceCreated(): Promise<boolean>;
+    getSpaceSize(): Promise<number>;
+    createAppSpace(options: AppSpaceOptions): Promise<void>;
+    destroyAppSpace(options: AppSpaceOptions): Promise<void>;
+    getAppSpacePath(options: AppSpaceOptions): Promise<string>;
+    createConfig(spaceConfig: SpaceConfig): Promise<void>;
+    destroyConfig(): Promise<void>;
+    set<T = any>(key: string, value: T): Promise<void>;
+    get<T = any>(key: string): Promise<T>;
+    setListable(options: PermissionOptions, value: boolean): Promise<void>;
+    setReadable(options: PermissionOptions, value: boolean): Promise<void>;
+    setWritable(options: PermissionOptions, value: boolean): Promise<void>;
+    isListable(options: PermissionOptions): Promise<boolean>;
+    isReadable(options: PermissionOptions): Promise<boolean>;
+    isWritable(options: PermissionOptions): Promise<boolean>;
+    write(options: WriteOptions): Promise<void>;
+    delete(options: DeleteOptions): Promise<void>;
+    read(options: ReadOptions): Promise<Stream>;
+    getHash(options: GetHashOptions): Promise<string>;
+    exists(options: ReadOptions): Promise<boolean>;
+    lists(options: ListsOptions): Promise<Object[]>;
+    list(options: ListOptions): Promise<Object | null>;
+    writeAsOwner(key: string, data: Data, options?: WriteAsOwnerOptions): Promise<void>;
+    deleteAsOwner(key: string, options?: ReadAsOwnerOptions): Promise<void>;
+    readAsOwner(key: string, options?: ReadAsOwnerOptions): Promise<Stream>;
+    existsAsOwner(key: string, options?: ExistsAsOwnerOptions): Promise<boolean>;
+    getStatusAsOwner(key: string): Promise<KeyStatus>;
+}

package/dist/es/drivers/base.js

@@ -0,0 +1,113 @@
+export class BaseDriver {
+    options;
+    constructor(options) {
+        this.options = options;
+    }
+    async createSpace(spaceConfig) {
+        await this.spaceConfig.createConfig(spaceConfig);
+        await this.spaceOperator.createSpace(spaceConfig);
+    }
+    async destroySpace() {
+        await this.spaceConfig.destroyConfig();
+        await this.spaceOperator.destroySpace();
+    }
+    isSpaceCreated() {
+        return this.spaceOperator.isSpaceCreated();
+    }
+    getSpaceSize() {
+        return this.spaceOperator.getSpaceSize();
+    }
+    async createAppSpace(options) {
+        await this.spaceOperator.createAppSpace(options);
+    }
+    async destroyAppSpace(options) {
+        await this.spaceOperator.destroyAppSpace(options);
+    }
+    getAppSpacePath(options) {
+        return this.spaceOperator.getAppSpacePath(options);
+    }
+    async createConfig(spaceConfig) {
+        await this.spaceConfig.createConfig(spaceConfig);
+    }
+    async destroyConfig() {
+        await this.spaceConfig.destroyConfig();
+    }
+    async set(key, value) {
+        await this.spaceConfig.set(key, value);
+    }
+    get(key) {
+        return this.spaceConfig.get(key);
+    }
+    async setListable(options, value) {
+        await this.spaceConfig.setListable(options, value);
+    }
+    async setReadable(options, value) {
+        await this.spaceConfig.setReadable(options, value);
+    }
+    async setWritable(options, value) {
+        await this.spaceConfig.setWritable(options, value);
+    }
+    isListable(options) {
+        return this.spaceConfig.isListable(options);
+    }
+    isReadable(options) {
+        return this.spaceConfig.isReadable(options);
+    }
+    isWritable(options) {
+        return this.spaceConfig.isWritable(options);
+    }
+    async write(options) {
+        if (!(await this.spaceConfig.isWritable({
+            fromAppDid: options.appDid,
+            toAppDid: options.appDid,
+        }))) {
+            throw new Error('Unable to write object with insufficient permissions');
+        }
+        await this.spaceOperator.write(options);
+    }
+    async delete(options) {
+        await this.spaceOperator.delete(options);
+    }
+    async read(options) {
+        if (!(await this.spaceConfig.isReadable({
+            fromAppDid: options.appDid,
+            toAppDid: options.appDid,
+        }))) {
+            throw new Error('Unable to read object with insufficient permissions');
+        }
+        return this.spaceOperator.read(options);
+    }
+    getHash(options) {
+        return this.spaceOperator.getHash(options);
+    }
+    async exists(options) {
+        if (!(await this.spaceConfig.isListable({
+            fromAppDid: options.appDid,
+            toAppDid: options.appDid,
+        }))) {
+            throw new Error('Unable to list object with insufficient permissions');
+        }
+        return this.spaceOperator.exists(options);
+    }
+    lists(options) {
+        return this.spaceOperator.lists(options);
+    }
+    list(options) {
+        return this.spaceOperator.list(options);
+    }
+    writeAsOwner(key, data, options) {
+        return this.spaceOperator.writeAsOwner(key, data, options);
+    }
+    deleteAsOwner(key, options) {
+        return this.spaceOperator.deleteAsOwner(key, options);
+    }
+    readAsOwner(key, options) {
+        return this.spaceOperator.readAsOwner(key, options);
+    }
+    existsAsOwner(key, options) {
+        return this.spaceOperator.existsAsOwner(key, options);
+    }
+    getStatusAsOwner(key) {
+        return this.spaceOperator.getStatusAsOwner(key);
+    }
+}

package/dist/es/drivers/index.d.ts

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

package/dist/es/drivers/index.js

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

package/dist/es/index.d.ts

@@ -0,0 +1,9 @@
+export * from './configuration';
+export * from './constants';
+export * from './drivers';
+export * from './meta';
+export * from './model';
+export * from './protocols';
+export * from './schemas';
+export * from './space';
+export * from './utils';

package/dist/es/index.js

@@ -0,0 +1,9 @@
+export * from './configuration';
+export * from './constants';
+export * from './drivers';
+export * from './meta';
+export * from './model';
+export * from './protocols';
+export * from './schemas';
+export * from './space';
+export * from './utils';

package/dist/es/meta/data.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { Readable } from 'stream';
+export type Data = Readable | ReadableStream | string | Buffer | ReadableStream<any> | null;

package/dist/es/meta/data.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,3 @@
+export * from './template';
+export * from './data';
+export * from './object';

package/dist/es/meta/index.js

@@ -0,0 +1,3 @@
+export * from './template';
+export * from './data';
+export * from './object';

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

@@ -0,0 +1,70 @@
+import type { ObjectMetadata } from '../protocols';
+export interface Object {
+    /**
+     *
+     * @description
+     * @tips 约定好 key 的第一个字符是 /
+     * @example /demo/index.html
+     * @type {string}
+     * @memberof Object
+     */
+    key: string;
+    /**
+     * @description 文件名
+     * @example index.html
+     * @type {string}
+     * @memberof Object
+     */
+    name: string;
+    /**
+     * @description
+     * @type {boolean}
+     * @memberof Object
+     */
+    isDir: boolean;
+    /**
+     * @description 文件的大小
+     * @type {number}
+     * @memberof Object
+     */
+    size: number;
+    /**
+     * @description
+     * @type {number}
+     * @memberof Object
+     */
+    lastModified: number;
+    /**
+     * @description
+     * @type {boolean}
+     * @memberof Object
+     */
+    editable: boolean;
+    /**
+     * @description 如果是一个文件夹，则为 null
+     * @example video/mp4
+     * @type {string}
+     * @memberof Object
+     */
+    mimeType: string | null;
+    /**
+     * @description
+     * @type {string}
+     * @memberof Object
+     */
+    absolutePath: string;
+    /**
+     * @description 对象的 hash 值(ipfs CID v1)
+     * @type {string}
+     * @memberof Object
+     */
+    hash?: string;
+    /**
+     * @description 存储 metadata 信息
+     * @default {{}}
+     * @type {ObjectMetadata}
+     * @memberof Object
+     */
+    metadata?: ObjectMetadata;
+    [key: string]: any;
+}

package/dist/es/meta/object.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,27 @@
+export declare const APP_TYPE = "app";
+export interface AppPermissions {
+    [scope: string]: {
+        [authorizedAppDid: string]: number;
+    };
+}
+/**
+ *
+ * @description 此文件存储的位置在 ${spaceDid}/apps/${appDid}/.meta/config.yml
+ * @export
+ * @interface AppMeta
+ */
+export interface App {
+    /**
+     *
+     * @description uid
+     * @link https://www.npmjs.com/package/nanoid?activeTab=readme
+     * @type {string}
+     * @memberof App
+     */
+    id: string;
+    type: 'app';
+    userDid: string;
+    permissions: AppPermissions;
+    createAt: string;
+    updateAt: string;
+}

package/dist/es/meta/template/app.js

@@ -0,0 +1 @@
+export const APP_TYPE = 'app';

package/dist/es/meta/template/index.d.ts

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

package/dist/es/meta/template/index.js

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

package/dist/es/meta/template/preview/base.d.ts

@@ -0,0 +1,13 @@
+import { z } from 'zod';
+export declare const DidSchema: z.ZodEffects<z.ZodString, string, string>;
+export declare const BasePreviewTemplateSchema: z.ZodObject<{
+    template: z.ZodString;
+    did: z.ZodEffects<z.ZodString, string, string>;
+}, "strip", z.ZodTypeAny, {
+    template: string;
+    did: string;
+}, {
+    template: string;
+    did: string;
+}>;
+export type BasePreviewTemplate = z.infer<typeof BasePreviewTemplateSchema>;

package/dist/es/meta/template/preview/base.js

@@ -0,0 +1,12 @@
+import { isValid } from '@arcblock/did';
+import { z } from 'zod';
+export const DidSchema = z.string().refine((value) => isValid(value), (value) => {
+    return {
+        code: z.ZodIssueCode.custom,
+        message: `${value} is not a valid DID`,
+    };
+});
+export const BasePreviewTemplateSchema = z.object({
+    template: z.string().min(1),
+    did: DidSchema,
+});

package/dist/es/meta/template/preview/default.d.ts

@@ -0,0 +1,75 @@
+import z from 'zod';
+export declare const PreviewTemplateSchema: 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;
+    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" | undefined;
+}>, 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;
+}>]>;
+export type PreviewTemplate = z.infer<typeof PreviewTemplateSchema>;

package/dist/es/meta/template/preview/default.js

@@ -0,0 +1,9 @@
+import z from 'zod';
+import { NftPreviewTemplateSchema } from './nft';
+import { ProfilePreviewTemplateSchema } from './profile';
+import { PassportPreviewTemplateSchema } from './passport';
+export const PreviewTemplateSchema = z.union([
+    NftPreviewTemplateSchema,
+    ProfilePreviewTemplateSchema,
+    PassportPreviewTemplateSchema,
+]);

package/dist/es/meta/template/preview/index.d.ts

@@ -0,0 +1,5 @@
+export * from './base';
+export * from './default';
+export * from './nft';
+export * from './passport';
+export * from './profile';

package/dist/es/meta/template/preview/index.js

@@ -0,0 +1,5 @@
+export * from './base';
+export * from './default';
+export * from './nft';
+export * from './passport';
+export * from './profile';

package/dist/es/meta/template/preview/nft.d.ts

@@ -0,0 +1,23 @@
+import z from 'zod';
+export declare const NftPreviewTemplateSchema: 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;
+    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;
+}>;
+export type NftPreviewTemplate = z.infer<typeof NftPreviewTemplateSchema>;

package/dist/es/meta/template/preview/nft.js

@@ -0,0 +1,8 @@
+import z from 'zod';
+import { BasePreviewTemplateSchema } from './base';
+export const NftPreviewTemplateSchema = BasePreviewTemplateSchema.extend({
+    template: z.literal('nft'),
+    name: z.string().min(1),
+    image: z.string().min(1),
+    chainHost: z.string().min(1).startsWith('http').url(),
+});