@did-space/core 0.5.78 → 0.5.80

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

@@ -0,0 +1,35 @@
+import z from 'zod';
+export declare const PassportPreviewTemplateSchema: 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 PassportPreviewTemplate = z.infer<typeof PassportPreviewTemplateSchema>;

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

@@ -0,0 +1,19 @@
+import z from 'zod';
+import { BasePreviewTemplateSchema, DidSchema } from './base';
+export const PassportPreviewTemplateSchema = BasePreviewTemplateSchema.extend({
+    template: z.literal('passport'),
+    // 通常是一个 svg 图片
+    image: z.string().min(1),
+    // 类型
+    type: z.array(z.string()).min(1),
+    // 颁发者 DID
+    issuerDid: DidSchema,
+    // 颁发者
+    issuerName: z.string().min(1),
+    // 颁发时间
+    issuedAt: z.string().min(1),
+    // 颁发给了谁
+    issuedTo: z.string().min(1),
+    // 验证状态
+    verified: z.boolean(),
+});

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

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

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

@@ -0,0 +1,8 @@
+import { z } from 'zod';
+import { BasePreviewTemplateSchema } from './base';
+export const ProfilePreviewTemplateSchema = BasePreviewTemplateSchema.extend({
+    template: z.literal('profile').optional().default('profile'),
+    avatar: z.string().min(1),
+    fullname: z.string().min(1),
+    email: z.string().min(1),
+});

package/dist/es/model/app-space-apply.d.ts

@@ -0,0 +1,75 @@
+import type { Model } from 'sequelize';
+import type { AppPermissions } from '../meta';
+export interface AppSpaceApplyModel {
+    /**
+     * @description 记录的唯一标识,是一个 UUIDV4
+     * @type {string}
+     * @memberof AppSpaceApplyModel
+     */
+    id: string;
+    /**
+     * @description
+     * @type {string}
+     * @memberof AppSpaceApplyModel
+     */
+    storageDid: string;
+    /**
+     * @description
+     * @type {string}
+     * @memberof AppSpaceApplyModel
+     */
+    assetDid: string;
+    /**
+     * @description
+     * @type {string}
+     * @memberof AppSpaceApplyModel
+     */
+    ownerDid: string;
+    /**
+     * @description 应用最新的 appDid,如果应用被迁移了,这个值也会更新到最新
+     * @type {string}
+     * @memberof AppSpaceApplyModel
+     */
+    appDid: string;
+    /**
+     * @description
+     * @type {string}
+     * @memberof AppSpaceApplyModel
+     */
+    appName: string;
+    /**
+     * @description
+     * @type {string}
+     * @default {''}
+     * @memberof AppSpaceApplyModel
+     */
+    appDescription?: string;
+    /**
+     * @description 目前存储着授权信息
+     * @memberof AppSpaceApplyModel
+     */
+    metadata: {
+        permissions: AppPermissions;
+    };
+    createAt: string;
+    updateAt: string;
+}
+/**
+ * @description
+ * @export
+ * @interface CreationAppSpaceApplyModel
+ */
+export interface CreationAppSpaceApplyModel extends Omit<AppSpaceApplyModel, 'id'> {
+}
+export declare class AppSpaceApplyRepository extends Model<AppSpaceApplyModel, CreationAppSpaceApplyModel> {
+    id: string;
+    storageDid: string;
+    assetDid: string;
+    ownerDid: string;
+    appDid: string;
+    appName: string;
+    appDescription: string | null;
+    metadata: Record<string, unknown>;
+    createAt: Date;
+    updateAt: Date;
+}

package/dist/es/model/app-space-apply.js

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

package/dist/es/model/audit-log.d.ts

@@ -0,0 +1,527 @@
+import type { Model } from 'sequelize';
+import { z } from 'zod';
+export type JsonData = Record<string, any>;
+export declare enum AuditLogStatus {
+    DEFAULT = "default",
+    SUCCEEDED = "succeeded",
+    FAILED = "failed",
+    PENDING = "pending"
+}
+export declare enum AuditLogAction {
+    APP_DISCONNECTED = "app-disconnected",
+    APP_RESTORE = "app-restore",
+    APP_BACKUP = "app-backup",
+    APP_CONNECTED = "app-connected"
+}
+export declare const AppConnectedSchema: z.ZodObject<{
+    spaceDid: z.ZodString;
+    appDid: z.ZodString;
+    appName: z.ZodString;
+    appDescription: z.ZodString;
+    scopes: z.ZodString;
+    /** 注意，有了 appUrl，只要使用它的 __blocklet__.js?type=json api就能获取 blocklet的 logo，描述，等信息 */
+    appUrl: z.ZodString;
+    /**  授权的时候用户当时在哪个网址？比如在 server 的 blocklet 的备份页面进行授权的，在blocklet 的授权页面进行授权的 */
+    referrer: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    appDid: string;
+    appName: string;
+    appDescription: string;
+    spaceDid: string;
+    scopes: string;
+    appUrl: string;
+    referrer: string;
+}, {
+    appDid: string;
+    appName: string;
+    appDescription: string;
+    spaceDid: string;
+    scopes: string;
+    appUrl: string;
+    referrer: string;
+}>;
+export declare const AppDisconnectedSchema: z.ZodObject<{
+    spaceDid: z.ZodString;
+    appDid: z.ZodString;
+    appName: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    appDid: string;
+    appName: string;
+    spaceDid: string;
+}, {
+    appDid: string;
+    appName: string;
+    spaceDid: string;
+}>;
+export declare const AppBackupSchema: z.ZodObject<{
+    /** 指向 server 的 did 地址 */
+    serverDid: z.ZodString;
+    /** 本质上是始终指向最新的 appDid,目前主要是 rotate 的 blocklet 在还原的时候会用到这个参数 */
+    signerDid: z.ZodString;
+    appName: z.ZodString;
+    appDescription: z.ZodString;
+    /**  授权的时候用户当时在哪个网址？比如在 server 的 blocklet 的备份页面进行授权的，在blocklet 的授权页面进行授权的 */
+    referrer: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    appName: string;
+    appDescription: string;
+    referrer: string;
+    serverDid: string;
+    signerDid: string;
+}, {
+    appName: string;
+    appDescription: string;
+    referrer: string;
+    serverDid: string;
+    signerDid: string;
+}>;
+export declare const AppRestoreSchema: z.ZodObject<{
+    /** 指向 server 的 did 地址 */
+    serverDid: z.ZodString;
+    appName: z.ZodString;
+    appDescription: z.ZodString;
+    referrer: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    appName: string;
+    appDescription: string;
+    referrer: string;
+    serverDid: string;
+}, {
+    appName: string;
+    appDescription: string;
+    referrer: string;
+    serverDid: string;
+}>;
+export declare const AuditLogSchema: z.ZodObject<{
+    id: z.ZodString;
+    actionType: z.ZodNativeEnum<typeof AuditLogAction>;
+    entityId: z.ZodString;
+    entityName: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    userId: z.ZodString;
+    username: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    data: z.ZodUnion<[z.ZodObject<{
+        spaceDid: z.ZodString;
+        appDid: z.ZodString;
+        appName: z.ZodString;
+        appDescription: z.ZodString;
+        scopes: z.ZodString;
+        /** 注意，有了 appUrl，只要使用它的 __blocklet__.js?type=json api就能获取 blocklet的 logo，描述，等信息 */
+        appUrl: z.ZodString;
+        /**  授权的时候用户当时在哪个网址？比如在 server 的 blocklet 的备份页面进行授权的，在blocklet 的授权页面进行授权的 */
+        referrer: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        appDid: string;
+        appName: string;
+        appDescription: string;
+        spaceDid: string;
+        scopes: string;
+        appUrl: string;
+        referrer: string;
+    }, {
+        appDid: string;
+        appName: string;
+        appDescription: string;
+        spaceDid: string;
+        scopes: string;
+        appUrl: string;
+        referrer: string;
+    }>, z.ZodObject<{
+        spaceDid: z.ZodString;
+        appDid: z.ZodString;
+        appName: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        appDid: string;
+        appName: string;
+        spaceDid: string;
+    }, {
+        appDid: string;
+        appName: string;
+        spaceDid: string;
+    }>, z.ZodObject<{
+        /** 指向 server 的 did 地址 */
+        serverDid: z.ZodString;
+        /** 本质上是始终指向最新的 appDid,目前主要是 rotate 的 blocklet 在还原的时候会用到这个参数 */
+        signerDid: z.ZodString;
+        appName: z.ZodString;
+        appDescription: z.ZodString;
+        /**  授权的时候用户当时在哪个网址？比如在 server 的 blocklet 的备份页面进行授权的，在blocklet 的授权页面进行授权的 */
+        referrer: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        appName: string;
+        appDescription: string;
+        referrer: string;
+        serverDid: string;
+        signerDid: string;
+    }, {
+        appName: string;
+        appDescription: string;
+        referrer: string;
+        serverDid: string;
+        signerDid: string;
+    }>, z.ZodObject<{
+        /** 指向 server 的 did 地址 */
+        serverDid: z.ZodString;
+        appName: z.ZodString;
+        appDescription: z.ZodString;
+        referrer: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        appName: string;
+        appDescription: string;
+        referrer: string;
+        serverDid: string;
+    }, {
+        appName: string;
+        appDescription: string;
+        referrer: string;
+        serverDid: string;
+    }>]>;
+    status: z.ZodDefault<z.ZodOptional<z.ZodNativeEnum<typeof AuditLogStatus>>>;
+    reason: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    env: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
+    createdAt: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    updatedAt: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    status: AuditLogStatus;
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    actionType: AuditLogAction;
+    entityId: string;
+    entityName: string;
+    userId: string;
+    username: string;
+    data: {
+        appDid: string;
+        appName: string;
+        appDescription: string;
+        spaceDid: string;
+        scopes: string;
+        appUrl: string;
+        referrer: string;
+    } | {
+        appDid: string;
+        appName: string;
+        spaceDid: string;
+    } | {
+        appName: string;
+        appDescription: string;
+        referrer: string;
+        serverDid: string;
+        signerDid: string;
+    } | {
+        appName: string;
+        appDescription: string;
+        referrer: string;
+        serverDid: string;
+    };
+    reason: string;
+    env: Record<string, any>;
+}, {
+    id: string;
+    actionType: AuditLogAction;
+    entityId: string;
+    userId: string;
+    data: {
+        appDid: string;
+        appName: string;
+        appDescription: string;
+        spaceDid: string;
+        scopes: string;
+        appUrl: string;
+        referrer: string;
+    } | {
+        appDid: string;
+        appName: string;
+        spaceDid: string;
+    } | {
+        appName: string;
+        appDescription: string;
+        referrer: string;
+        serverDid: string;
+        signerDid: string;
+    } | {
+        appName: string;
+        appDescription: string;
+        referrer: string;
+        serverDid: string;
+    };
+    status?: AuditLogStatus | undefined;
+    createdAt?: string | undefined;
+    updatedAt?: string | undefined;
+    entityName?: string | undefined;
+    username?: string | undefined;
+    reason?: string | undefined;
+    env?: Record<string, any> | undefined;
+}>;
+export declare const CreationAuditLogSchema: z.ZodObject<z.objectUtil.extendShape<{
+    id: z.ZodString;
+    actionType: z.ZodNativeEnum<typeof AuditLogAction>;
+    entityId: z.ZodString;
+    entityName: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    userId: z.ZodString;
+    username: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    data: z.ZodUnion<[z.ZodObject<{
+        spaceDid: z.ZodString;
+        appDid: z.ZodString;
+        appName: z.ZodString;
+        appDescription: z.ZodString;
+        scopes: z.ZodString;
+        /** 注意，有了 appUrl，只要使用它的 __blocklet__.js?type=json api就能获取 blocklet的 logo，描述，等信息 */
+        appUrl: z.ZodString;
+        /**  授权的时候用户当时在哪个网址？比如在 server 的 blocklet 的备份页面进行授权的，在blocklet 的授权页面进行授权的 */
+        referrer: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        appDid: string;
+        appName: string;
+        appDescription: string;
+        spaceDid: string;
+        scopes: string;
+        appUrl: string;
+        referrer: string;
+    }, {
+        appDid: string;
+        appName: string;
+        appDescription: string;
+        spaceDid: string;
+        scopes: string;
+        appUrl: string;
+        referrer: string;
+    }>, z.ZodObject<{
+        spaceDid: z.ZodString;
+        appDid: z.ZodString;
+        appName: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        appDid: string;
+        appName: string;
+        spaceDid: string;
+    }, {
+        appDid: string;
+        appName: string;
+        spaceDid: string;
+    }>, z.ZodObject<{
+        /** 指向 server 的 did 地址 */
+        serverDid: z.ZodString;
+        /** 本质上是始终指向最新的 appDid,目前主要是 rotate 的 blocklet 在还原的时候会用到这个参数 */
+        signerDid: z.ZodString;
+        appName: z.ZodString;
+        appDescription: z.ZodString;
+        /**  授权的时候用户当时在哪个网址？比如在 server 的 blocklet 的备份页面进行授权的，在blocklet 的授权页面进行授权的 */
+        referrer: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        appName: string;
+        appDescription: string;
+        referrer: string;
+        serverDid: string;
+        signerDid: string;
+    }, {
+        appName: string;
+        appDescription: string;
+        referrer: string;
+        serverDid: string;
+        signerDid: string;
+    }>, z.ZodObject<{
+        /** 指向 server 的 did 地址 */
+        serverDid: z.ZodString;
+        appName: z.ZodString;
+        appDescription: z.ZodString;
+        referrer: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        appName: string;
+        appDescription: string;
+        referrer: string;
+        serverDid: string;
+    }, {
+        appName: string;
+        appDescription: string;
+        referrer: string;
+        serverDid: string;
+    }>]>;
+    status: z.ZodDefault<z.ZodOptional<z.ZodNativeEnum<typeof AuditLogStatus>>>;
+    reason: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    env: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>>;
+    createdAt: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    updatedAt: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+}, {
+    id: z.ZodOptional<z.ZodString>;
+}>, "strip", z.ZodTypeAny, {
+    status: AuditLogStatus;
+    createdAt: string;
+    updatedAt: string;
+    actionType: AuditLogAction;
+    entityId: string;
+    entityName: string;
+    userId: string;
+    username: string;
+    data: {
+        appDid: string;
+        appName: string;
+        appDescription: string;
+        spaceDid: string;
+        scopes: string;
+        appUrl: string;
+        referrer: string;
+    } | {
+        appDid: string;
+        appName: string;
+        spaceDid: string;
+    } | {
+        appName: string;
+        appDescription: string;
+        referrer: string;
+        serverDid: string;
+        signerDid: string;
+    } | {
+        appName: string;
+        appDescription: string;
+        referrer: string;
+        serverDid: string;
+    };
+    reason: string;
+    env: Record<string, any>;
+    id?: string | undefined;
+}, {
+    actionType: AuditLogAction;
+    entityId: string;
+    userId: string;
+    data: {
+        appDid: string;
+        appName: string;
+        appDescription: string;
+        spaceDid: string;
+        scopes: string;
+        appUrl: string;
+        referrer: string;
+    } | {
+        appDid: string;
+        appName: string;
+        spaceDid: string;
+    } | {
+        appName: string;
+        appDescription: string;
+        referrer: string;
+        serverDid: string;
+        signerDid: string;
+    } | {
+        appName: string;
+        appDescription: string;
+        referrer: string;
+        serverDid: string;
+    };
+    status?: AuditLogStatus | undefined;
+    id?: string | undefined;
+    createdAt?: string | undefined;
+    updatedAt?: string | undefined;
+    entityName?: string | undefined;
+    username?: string | undefined;
+    reason?: string | undefined;
+    env?: Record<string, any> | undefined;
+}>;
+export type AppConnected = z.infer<typeof AppConnectedSchema>;
+export type AppDisconnected = z.infer<typeof AppDisconnectedSchema>;
+export type AppBackup = z.infer<typeof AppBackupSchema>;
+export type AppRestore = z.infer<typeof AppRestoreSchema>;
+export type AuditLogDataTypeMapping = {
+    [AuditLogAction.APP_CONNECTED]: AppConnected;
+    [AuditLogAction.APP_DISCONNECTED]: AppDisconnected;
+    [AuditLogAction.APP_BACKUP]: AppBackup;
+    [AuditLogAction.APP_RESTORE]: AppRestore;
+};
+export interface AuditLogModel<T extends keyof AuditLogDataTypeMapping = AuditLogAction> {
+    /**
+     * @description 使用 nanoid 生成即可，标识这一条记录
+     * @type {string}
+     * @memberof AuditLog
+     */
+    id: string;
+    /**
+     * @description 被操作的实体的唯一标识，它是其他表的唯一标识，比如说如果他是应用的审计日志，那么它应该是 AppSpaceApply 表的 id，
+     * @type {string}
+     * @memberof AuditLog
+     */
+    entityId: string;
+    /**
+     * @description 被操作的实体的名称，比如说如果他是应用的审计日志，那么它应该是应用的名称
+     * @type {string}
+     * @memberof AuditLog
+     */
+    entityName: string;
+    /**
+     * @description 操作类型，比如说应用的审计日志，它的类型有 app-disconnected, app-restore 等等，它应该是一个可枚举的类型
+     * @type {AuditLogAction}
+     * @memberof AuditLog
+     */
+    actionType: T;
+    /**
+     * @description 操作人
+     * @type {string}
+     * @memberof AuditLog
+     */
+    userId: string;
+    /**
+     * @description 操作人名称
+     * @type {string}
+     * @memberof AuditLog
+     */
+    username: string;
+    /**
+     * @description 信息的主体
+     * @type {Record<string, any>}
+     * @default {}
+     * @memberof AuditLog
+     */
+    data: AuditLogDataTypeMapping[T];
+    /**
+     * @description 操作的状态，比如说应用的审计日志，它的状态有 succeeded, failed 等等，它应该是一个可枚举的类型
+     * @type {string}
+     * @default AuditLogStatus.SUCCEEDED
+     * @memberof AuditLog
+     */
+    status: AuditLogStatus;
+    /**
+     * @description 操作失败的原因
+     * @type {string}
+     * @default ''
+     * @memberof AuditLog
+     */
+    reason: string;
+    /**
+     * @description 操作的环境，记录操作的环境，比如说操作的设备，操作的浏览器，操作的网络等等
+     * @type {Record<string, any>}
+     * @default {}
+     * @memberof AuditLog
+     */
+    env: JsonData;
+    /**
+     * @description 操作的创建时间，也就是操作时间
+     * @type {string}
+     * @memberof AuditLog
+     */
+    createdAt: string;
+    /**
+     * @description 操作的更新时间
+     * @type {string}
+     * @memberof AuditLog
+     */
+    updatedAt: string;
+}
+export interface CreationAuditLogModel<T extends keyof AuditLogDataTypeMapping = AuditLogAction> extends Partial<Omit<AuditLogModel<T>, 'id'>> {
+}
+export interface AuditLogRaw extends Omit<AuditLogModel, 'data' | 'env'> {
+    data: string;
+    env: string;
+}
+export declare class AuditLogRepository<T extends keyof AuditLogDataTypeMapping = AuditLogAction> extends Model<AuditLogModel<T>, CreationAuditLogModel<T>> {
+    id: string;
+    entityId: string;
+    entityName: string;
+    actionType: T;
+    userId: string;
+    username: string;
+    data: AuditLogDataTypeMapping[T];
+    status: AuditLogStatus;
+    reason: string;
+    env: JsonData;
+    createdAt: Date;
+    updatedAt: Date;
+    static safeCreate<M>(_data: M): Promise<M>;
+}