@did-space/core 0.5.78 → 0.5.80

package/dist/es/model/audit-log.js

@@ -0,0 +1,69 @@
+import { z } from 'zod';
+export var AuditLogStatus;
+(function (AuditLogStatus) {
+    AuditLogStatus["DEFAULT"] = "default";
+    AuditLogStatus["SUCCEEDED"] = "succeeded";
+    AuditLogStatus["FAILED"] = "failed";
+    AuditLogStatus["PENDING"] = "pending";
+})(AuditLogStatus || (AuditLogStatus = {}));
+export var AuditLogAction;
+(function (AuditLogAction) {
+    AuditLogAction["APP_DISCONNECTED"] = "app-disconnected";
+    AuditLogAction["APP_RESTORE"] = "app-restore";
+    AuditLogAction["APP_BACKUP"] = "app-backup";
+    AuditLogAction["APP_CONNECTED"] = "app-connected";
+})(AuditLogAction || (AuditLogAction = {}));
+export const AppConnectedSchema = z.object({
+    spaceDid: z.string().min(1),
+    appDid: z.string().min(1),
+    appName: z.string().min(1),
+    appDescription: z.string(),
+    scopes: z.string().min(1),
+    /** 注意，有了 appUrl，只要使用它的 __blocklet__.js?type=json api就能获取 blocklet的 logo，描述，等信息 */
+    appUrl: z.string(),
+    /**  授权的时候用户当时在哪个网址？比如在 server 的 blocklet 的备份页面进行授权的，在blocklet 的授权页面进行授权的 */
+    referrer: z.string(),
+});
+export const AppDisconnectedSchema = z.object({
+    spaceDid: z.string().min(1),
+    appDid: z.string().min(1),
+    appName: z.string().min(1),
+});
+export const AppBackupSchema = z.object({
+    /** 指向 server 的 did 地址 */
+    serverDid: z.string().min(1),
+    /** 本质上是始终指向最新的 appDid,目前主要是 rotate 的 blocklet 在还原的时候会用到这个参数 */
+    signerDid: z.string().min(1),
+    appName: z.string().min(1),
+    appDescription: z.string(),
+    /**  授权的时候用户当时在哪个网址？比如在 server 的 blocklet 的备份页面进行授权的，在blocklet 的授权页面进行授权的 */
+    referrer: z.string(),
+});
+export const AppRestoreSchema = z.object({
+    /** 指向 server 的 did 地址 */
+    serverDid: z.string().min(1),
+    appName: z.string().min(1),
+    appDescription: z.string(),
+    referrer: z.string(),
+});
+export const AuditLogSchema = z.object({
+    id: z.string(),
+    actionType: z.nativeEnum(AuditLogAction),
+    entityId: z.string().min(1),
+    entityName: z.string().optional().default(''),
+    userId: z.string().min(1),
+    username: z.string().optional().default(''),
+    data: z.union([AppConnectedSchema, AppDisconnectedSchema, AppBackupSchema, AppRestoreSchema]),
+    status: z.nativeEnum(AuditLogStatus).optional().default(AuditLogStatus.SUCCEEDED),
+    reason: z.string().optional().default(''),
+    env: z.record(z.any()).optional().default({}),
+    createdAt: z
+        .string()
+        .optional()
+        .default(() => new Date().toISOString()),
+    updatedAt: z
+        .string()
+        .optional()
+        .default(() => new Date().toISOString()),
+});
+export const CreationAuditLogSchema = AuditLogSchema.extend({ id: AuditLogSchema.shape.id.optional() });

package/dist/es/model/did-object-mapping.d.ts

@@ -0,0 +1,8 @@
+import type { Model, InferAttributes } from 'sequelize';
+export declare class DidObjectMappingRepository extends Model<InferAttributes<DidObjectMappingRepository>, InferAttributes<DidObjectMappingRepository>> {
+    did: string;
+    spaceDid: string;
+    appDid: string;
+    key: string;
+    metadata: Record<string, string>;
+}

package/dist/es/model/did-object-mapping.js

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

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

@@ -0,0 +1,5 @@
+export * from './app-space-apply';
+export * from './object-collection';
+export * from './object';
+export * from './tree';
+export * from './audit-log';

package/dist/es/model/index.js

@@ -0,0 +1,5 @@
+export * from './app-space-apply';
+export * from './object-collection';
+export * from './object';
+export * from './tree';
+export * from './audit-log';

package/dist/es/model/object-collection.d.ts

@@ -0,0 +1,42 @@
+import type { Model } from 'sequelize';
+/**
+ * @description 存储的是对象的信息，不保存结构，创建之初就确定了，只能增加，删除
+ * @export
+ * @interface ObjectModel
+ */
+export interface ObjectCollectionModel {
+    /**
+     * @primaryKey
+     * @description 对象的唯一标识,格式是 ipfs cid v1
+     * @type {string}
+     * @column {DataTypes.CHAR(64)}
+     * @memberof ObjectCollectionModel
+     */
+    id: string;
+    /**
+     * @description 对象的创建时间
+     * @type {string}
+     * @column {DataTypes.DATE}
+     * @memberof ObjectCollectionModel
+     */
+    createdAt: string;
+}
+export type ObjectCollectionModelCreation = Pick<ObjectCollectionModel, 'id'>;
+export declare class ObjectCollectionRepositoryClass extends Model<ObjectCollectionModel, ObjectCollectionModelCreation> {
+    /**
+     * @primaryKey
+     * @description 对象的唯一标识,格式是 ipfs cid v1
+     * @type {string}
+     * @column {DataTypes.CHAR(64)}
+     * @memberof ObjectCollectionModel
+     */
+    id: string;
+    /**
+     * @description 对象的创建时间
+     * @type {string}
+     * @column {DataTypes.DATE}
+     * @memberof ObjectCollectionModel
+     */
+    createdAt: string;
+}
+export type ObjectCollectionRepository = typeof ObjectCollectionRepositoryClass;

package/dist/es/model/object-collection.js

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

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

@@ -0,0 +1,59 @@
+import type { Model, CreationOptional } from 'sequelize';
+/**
+ * @description 存储的是对象的信息，不保存结构，创建之初就确定了，只能增加，删除
+ * @export
+ * @interface ObjectModel
+ */
+export interface ObjectModel {
+    /**
+     * @primaryKey
+     * @description 对象的唯一标识,格式是 ipfs cid v1
+     * @type {string}
+     * @column {DataTypes.STRING(59)}
+     * @memberof ObjectModel
+     */
+    id: string;
+    /**
+     * @description 对象的大小
+     * @type {number}
+     * @column {DataTypes.BIGINT.UNSIGNED}
+     * @memberof ObjectModel
+     */
+    size: number;
+    /**
+     * @description 存储对象的元数据
+     * @type {ObjectModelMeta}
+     * @column {DataTypes.JSON}
+     * @memberof ObjectModel
+     */
+    meta: ObjectModelMeta;
+    /**
+     * @description 对象的创建时间
+     * @type {string}
+     * @column {DataTypes.DATE}
+     * @memberof ObjectModel
+     */
+    createdAt?: CreationOptional<string>;
+}
+export interface ObjectModelMeta {
+    /**
+     *
+     * @description 对象的 hash,如果对象是文件夹则为 null,否则必须有值
+     * @type {string}
+     * @memberof ObjectModelMeta
+     */
+    mimeType: string | null;
+    /**
+     * @description 保存这个对象第一次出现的文件名
+     * @type {string}
+     * @memberof ObjectModelMeta
+     */
+    key: string;
+}
+export declare class ObjectRepositoryClass extends Model<ObjectModel> implements ObjectModel {
+    id: string;
+    size: number;
+    meta: ObjectModelMeta;
+    createdAt?: CreationOptional<string>;
+}
+export type ObjectRepository = typeof ObjectRepositoryClass;

package/dist/es/model/object.js

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

package/dist/es/model/space.d.ts

@@ -0,0 +1,21 @@
+import type { Model } from 'sequelize';
+import type { LiteralUnion } from 'type-fest';
+export declare class SpaceRepositoryClass extends Model<SpaceRepositoryClass, SpaceRepositoryClass> {
+    id: string;
+    drive: string;
+    did: string;
+    type: LiteralUnion<'default' | 'buy', string>;
+    name: string;
+    description: string;
+    size: number;
+    assetDid: string;
+    metadata: {
+        usageReportId?: string;
+        usedUnit?: number;
+    };
+    createAt: Date;
+    updateAt: Date | string;
+    expireAt: Date;
+    ownerDid: string;
+}
+export type SpaceRepository = typeof SpaceRepositoryClass;

package/dist/es/model/space.js

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

package/dist/es/model/tree.d.ts

@@ -0,0 +1,96 @@
+import type { Model } from 'sequelize';
+import type { ObjectModel } from './object';
+export interface TreeModel {
+    /**
+     * @description uuidv4
+     * @type {string}
+     * @column {DataTypes.BIGINT.UNSIGNED}
+     * @memberof Tree
+     */
+    id: string;
+    /**
+     * @description Space 的 DID
+     * @type {string}
+     * @column {DataTypes.STRING(40)}
+     * @memberof Tree
+     */
+    spaceDid: string;
+    /**
+     * @description 当且仅当，指向文件夹的时候才为空
+     * @column {DataTypes.CHAR(64)}
+     * @memberof Tree
+     */
+    objectId: null | string;
+    /**
+     * @description 绑定对象的上一级目录的 id
+     * @example /abc/
+     * @column {DataTypes.BIGINT.UNSIGNED}
+     * @memberof Tree
+     */
+    parentId: null | string;
+    /**
+     * @description 等价于文件夹和文件的路径,注意不包含 SpaceDid
+     * @example /app 或 /app/objects
+     * @type {string}
+     * @column {DataTypes.STRING(1024)}
+     * @memberof Tree
+     */
+    key: string;
+    /**
+     * @description folder or file
+     * @type {number}
+     * @column {DataTypes.TINYINT.UNSIGNED({ length: 1 })}
+     * @memberof Tree
+     */
+    type: number;
+    /**
+     *
+     * @description
+     * @default {{}}
+     * @type {TreeMeta}
+     * @column {DataTypes.JSON}
+     * @memberof Tree
+     */
+    meta: TreeModelMeta;
+    /**
+     * @description
+     * @type {string}
+     * @column {DataTypes.DATE}
+     * @memberof Tree
+     */
+    createdAt: Date | string;
+    /**
+     * @description
+     * @type {string}
+     * @column {DataTypes.DATE}
+     * @memberof Tree
+     */
+    updatedAt: Date | string;
+    size?: number;
+    count?: number;
+}
+export interface TreeModelMeta {
+}
+export type CreationTreeModel = Omit<TreeModel, 'id' | 'createdAt' | 'updatedAt' | 'meta'>;
+export declare class TreeRepositoryClass extends Model<TreeModel, CreationTreeModel> implements TreeModel {
+    id: string;
+    spaceDid: string;
+    objectId: string;
+    parentId: string;
+    key: string;
+    type: number;
+    meta: TreeModelMeta;
+    createdAt: Date;
+    updatedAt: Date;
+    size: number;
+    count: number;
+    Object: ObjectModel;
+    static deepCreate(_data: CreationTreeModel): Promise<TreeModel>;
+    [key: string]: any;
+}
+export type TreeRepository = typeof TreeRepositoryClass;
+export declare enum TreeModelType {
+    FOLDER = 0,
+    FILE = 1
+}
+export declare const TreeModelDefaultMeta: {};

package/dist/es/model/tree.js

@@ -0,0 +1,6 @@
+export var TreeModelType;
+(function (TreeModelType) {
+    TreeModelType[TreeModelType["FOLDER"] = 0] = "FOLDER";
+    TreeModelType[TreeModelType["FILE"] = 1] = "FILE";
+})(TreeModelType || (TreeModelType = {}));
+export const TreeModelDefaultMeta = {};

package/dist/es/protocols/base-space.d.ts

@@ -0,0 +1,4 @@
+import { SpaceConfigProtocol } from './space-config';
+import { SpaceOperatorProtocol } from './space-operator';
+export interface BaseSpaceProtocol extends SpaceOperatorProtocol, SpaceConfigProtocol {
+}

package/dist/es/protocols/base-space.js

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

package/dist/es/protocols/driver.d.ts

@@ -0,0 +1,7 @@
+import { BaseSpaceProtocol } from './base-space';
+export interface DriverOptions {
+    root: string;
+}
+export interface DriverProtocol extends BaseSpaceProtocol {
+    readonly options: DriverOptions;
+}

package/dist/es/protocols/driver.js

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

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

@@ -0,0 +1,5 @@
+export * from './driver';
+export * from './space';
+export * from './space-config';
+export * from './space-operator';
+export * from './space-owner-operator';

package/dist/es/protocols/index.js

@@ -0,0 +1,5 @@
+export * from './driver';
+export * from './space';
+export * from './space-config';
+export * from './space-operator';
+export * from './space-owner-operator';

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

@@ -0,0 +1,17 @@
+import { SpaceConfig } from '../configuration';
+export interface PermissionOptions {
+    fromAppDid: string;
+    toAppDid: string;
+}
+export interface SpaceConfigProtocol {
+    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>;
+}

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

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

package/dist/es/protocols/space-operator.d.ts

@@ -0,0 +1,63 @@
+/// <reference types="node" />
+import { Stream } from 'stream';
+import { SpaceConfig } from '../configuration';
+import { Data, Object } from '../meta';
+import { SpaceOwnerOperatorProtocol, type ObjectMetadata } from './space-owner-operator';
+export interface AppSpaceOptions {
+    appDid: string;
+}
+export interface WriteOptions extends AppSpaceOptions {
+    key: string;
+    data: Data;
+    hash?: string;
+    size?: number;
+    metadata?: ObjectMetadata;
+}
+export interface DeleteOptions extends AppSpaceOptions {
+    key: string;
+}
+export interface ReadOptions extends AppSpaceOptions {
+    key: string;
+}
+export interface GetHashOptions extends AppSpaceOptions {
+    key: string;
+}
+export interface ListOptions {
+    key: string;
+    useGlobal?: false | true;
+}
+export interface ListsOptions {
+    key: string;
+    /**
+     *
+     * @description 递归的列出文件吗?
+     * @default false
+     * @type {boolean}
+     * @memberof ListsOptions
+     */
+    recursive?: boolean;
+    /**
+     * @description 需要显示目录吗？默认显示
+     * @default false
+     * @type {boolean}
+     * @memberof ListOptions
+     */
+    ignoreDirectories?: boolean;
+    useGlobal?: false | true;
+}
+export interface SpaceOperatorProtocol extends SpaceOwnerOperatorProtocol {
+    createSpace(spaceConfig: SpaceConfig): Promise<void>;
+    isSpaceCreated(): Promise<boolean>;
+    destroySpace(): Promise<void>;
+    getSpaceSize(): Promise<number>;
+    createAppSpace(options: AppSpaceOptions): Promise<void>;
+    destroyAppSpace(options: AppSpaceOptions): Promise<void>;
+    getAppSpacePath(options: AppSpaceOptions): Promise<string>;
+    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>;
+}

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

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

package/dist/es/protocols/space-owner-operator.d.ts

@@ -0,0 +1,43 @@
+/// <reference types="node" />
+import { Stream } from 'stream';
+import { Data } from '../meta';
+export type KeyStatus = {
+    /**
+     * @description 文件夹已存储的对象个数
+     * @type {number}
+     */
+    objects: number;
+    /**
+     * @description 文件夹的最新修改时间
+     * @type {number}
+     */
+    lastModified: number;
+    /**
+     * @description 文件夹的总大小
+     * @type {number}
+     */
+    size: number;
+};
+export type ObjectMetadata = Record<string, any>;
+export type WriteAsOwnerOptions = {
+    hash: string | null;
+    size: number;
+    useGlobal?: false | true;
+    metadata?: ObjectMetadata;
+};
+export type ReadAsOwnerOptions = {
+    useGlobal?: false | true;
+};
+export type DeleteAsOwnerOptions = {
+    useGlobal?: false | true;
+};
+export type ExistsAsOwnerOptions = {
+    useGlobal?: false | true;
+};
+export interface SpaceOwnerOperatorProtocol {
+    writeAsOwner(key: string, data: Data, options?: WriteAsOwnerOptions): Promise<void>;
+    deleteAsOwner(key: string, options?: DeleteAsOwnerOptions): Promise<void>;
+    readAsOwner(key: string, options?: ReadAsOwnerOptions): Promise<Stream>;
+    existsAsOwner(key: string, options?: ExistsAsOwnerOptions): Promise<boolean>;
+    getStatusAsOwner(key: string): Promise<KeyStatus>;
+}

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

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

package/dist/es/protocols/space.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="node" />
+import type EventEmitter from 'events';
+import { BaseSpaceProtocol } from './base-space';
+import { DriverProtocol } from './driver';
+export interface SpaceProtocol extends BaseSpaceProtocol, EventEmitter {
+    readonly driver: DriverProtocol;
+}

package/dist/es/protocols/space.js

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

package/dist/es/schemas/global-space.d.ts

@@ -0,0 +1,2 @@
+export declare const GlobalSpaceOptionsSchema: import("joi").ObjectSchema<any>;
+export declare const HashSchema: import("joi").StringSchema<string>;

package/dist/es/schemas/global-space.js

@@ -0,0 +1,19 @@
+import { Joi } from '@arcblock/validator';
+import { isCidV1 } from '../utils';
+export const GlobalSpaceOptionsSchema = Joi.object({
+    driver: Joi.any().required(),
+    treeRepository: Joi.any().required(),
+    objectRepository: Joi.any().required(),
+    objectCollectionRepository: Joi.any().required(),
+    gcMaxCount: Joi.number().integer().optional().default(100),
+    gcMaxConcurrency: Joi.number().integer().optional().default(8),
+});
+export const HashSchema = Joi.string()
+    .custom((value, helper) => {
+    // @NOTE: 不是一个 ipfs cid，且不是一个 sha256 hash，才会报错
+    if (!isCidV1(value) && value.length !== 64) {
+        return helper.error(`Invalid hash(${value})`);
+    }
+    return value;
+})
+    .required();

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

@@ -0,0 +1,3 @@
+export * from './space-options';
+export * from './space-configuration';
+export * from './object-space';

package/dist/es/schemas/index.js

@@ -0,0 +1,3 @@
+export * from './space-options';
+export * from './space-configuration';
+export * from './object-space';

package/dist/es/schemas/object-space.d.ts

@@ -0,0 +1,6 @@
+export declare const OwnerOperatorKeySchema: import("joi").StringSchema<string>;
+export declare const WriteAsOwnerOptionsSchema: import("joi").ObjectSchema<any>;
+export declare const ObjectSpaceOptionsSchema: import("joi").ObjectSchema<any>;
+export declare const DeleteAsOwnerOptionsSchema: import("joi").ObjectSchema<any>;
+export declare const WriteOptionsSchema: import("joi").ObjectSchema<any>;
+export declare const GetHashOptionsSchema: import("joi").ObjectSchema<any>;

package/dist/es/schemas/object-space.js

@@ -0,0 +1,44 @@
+import { Joi } from '@arcblock/validator';
+import { GLOBAL_SPACE_ROOT } from '../constants';
+export const OwnerOperatorKeySchema = Joi.string().regex(/^\//).required();
+const WriteAsOwnerOptionsByFolderSchema = {
+    is: Joi.string().regex(/\/$/),
+    then: Joi.optional().default(''),
+    otherwise: Joi.required(),
+};
+const MetadataSchema = {
+    is: Joi.object(),
+    then: Joi.optional().default(''),
+    otherwise: Joi.required(),
+};
+export const WriteAsOwnerOptionsSchema = Joi.object({
+    key: OwnerOperatorKeySchema,
+    data: Joi.any().when('key', WriteAsOwnerOptionsByFolderSchema).when('metadata', MetadataSchema),
+    // @FIXME: 当 key 是文件夹 或者 data 不是一个 stream 的时候，hash， size 是可选的，现在的规则尝试之后没能做到这么精细化(使用 when 无法满足要求) @jianchao
+    hash: Joi.string().optional().allow(null).default(null),
+    size: Joi.number().integer().optional().allow(null).default(null),
+    useGlobal: Joi.boolean().optional().default(false),
+    metadata: Joi.object().optional().default({}),
+});
+export const ObjectSpaceOptionsSchema = Joi.object({
+    driver: Joi.any().required(),
+    spaceDid: Joi.alternatives().try(Joi.DID(), Joi.string().valid(GLOBAL_SPACE_ROOT)).required(),
+    treeRepository: Joi.any().required(),
+    objectRepository: Joi.any().required(),
+    objectCollectionRepository: Joi.any().required(),
+});
+export const DeleteAsOwnerOptionsSchema = Joi.object({
+    key: OwnerOperatorKeySchema,
+});
+export const WriteOptionsSchema = Joi.object({
+    appDid: Joi.DID().required(),
+    key: Joi.string().required(),
+    data: Joi.any().when('key', WriteAsOwnerOptionsByFolderSchema).when('metadata', MetadataSchema),
+    hash: Joi.string().optional().allow(null).default(null),
+    size: Joi.number().integer().optional().allow(null).default(null),
+    metadata: Joi.object().optional().default({}),
+});
+export const GetHashOptionsSchema = Joi.object({
+    appDid: Joi.DID().required(),
+    key: Joi.string().required(),
+});

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

@@ -0,0 +1,4 @@
+/**
+ * @see {SpaceConfig}
+ */
+export declare const SpaceConfigSchema: import("joi").ObjectSchema<any>;

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

@@ -0,0 +1,22 @@
+import xbytes from 'xbytes';
+import { Joi } from '@arcblock/validator';
+/**
+ * @see {SpaceConfig}
+ */
+export const SpaceConfigSchema = Joi.object({
+    did: Joi.DID(),
+    // 标识这个驱动是什么，默认取值为 fs, 表示文件存储到了本地的文件系统
+    drive: Joi.string().valid('fs', 's3').optional().allow('').default('fs'),
+    // type: 'buy | 'default'
+    type: Joi.string().optional().allow('buy', 'default').default('buy'),
+    name: Joi.string().required(),
+    // @see: https://github.com/sideway/joi/blob/master/API.md#string
+    description: Joi.string().required().allow('').default(''),
+    // 字节数,默认给个1GiB, size 为 0 表示空间无限制
+    size: Joi.number().required().default(xbytes.parseSize('1GiB')),
+    assetDid: Joi.DID(),
+    createAt: Joi.string().required(),
+    updateAt: Joi.string().required(),
+    expireAt: Joi.string().required(),
+    ownerDid: Joi.DID(),
+});

package/dist/es/schemas/space-options.d.ts

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

package/dist/es/schemas/space-options.js

@@ -0,0 +1,4 @@
+import { Joi } from '@arcblock/validator';
+export const SpaceOptionsSchema = Joi.object({
+    root: Joi.string().required(),
+});