@blocklet/js-sdk 1.17.8-beta-20260119-102944-6ba93a16 → 1.17.8-beta-20260125-093329-64b43854

package/dist/index.d.mts

@@ -1,360 +1,447 @@
-import * as axios from 'axios';
-import { Axios, AxiosRequestConfig } from 'axios';
-import { USER_SESSION_STATUS } from '@abtnode/constant';
-import { TTheme, TNavigationItem } from '@blocklet/meta/lib/types';
-import { TComponentInternalInfo } from '@blocklet/meta/lib/blocklet';
-import { BlockletStatus } from '@blocklet/meta/lib/constants';
+import { USER_SESSION_STATUS } from "@abtnode/constant";
+import * as axios0 from "axios";
+import { Axios, AxiosRequestConfig } from "axios";
+import { TNavigationItem, TTheme } from "@blocklet/meta/lib/types";
+import { TComponentInternalInfo } from "@blocklet/meta/lib/blocklet";
+import { BlockletStatus } from "@blocklet/meta/lib/constants";
 
+//#region src/services/token.d.ts
 declare class TokenService {
-    getSessionToken(config: any): string;
-    setSessionToken(value: string): void;
-    removeSessionToken(): void;
-    getRefreshToken(): string;
-    setRefreshToken(value: string): void;
-    removeRefreshToken(): void;
+  getSessionToken(config: any): string;
+  setSessionToken(value: string): void;
+  removeSessionToken(): void;
+  getRefreshToken(): string;
+  setRefreshToken(value: string): void;
+  removeRefreshToken(): void;
 }
-
+//#endregion
+//#region src/services/auth.d.ts
 type UserPublicInfo = {
-    avatar: string;
-    did: string;
-    fullName: string;
-    sourceAppPid: string | null;
+  avatar: string;
+  did: string;
+  name: string;
+  fullName: string;
+  sourceAppPid: string | null;
 };
 type Webhook = {
-    type: 'slack' | 'api';
-    url: string;
+  type: 'slack' | 'api';
+  url: string;
 };
 type NotificationConfig = {
-    webhooks?: Webhook[];
-    notifications?: {
-        email?: boolean;
-        wallet?: boolean;
-        phone?: boolean;
-    };
+  webhooks?: Webhook[];
+  notifications?: {
+    email?: boolean;
+    wallet?: boolean;
+    phone?: boolean;
+  };
 };
 type PrivacyConfig = {
-    [key: string]: boolean;
+  [key: string]: boolean;
 };
 interface SpaceGateway {
-    did: string;
-    name: string;
-    url: string;
-    endpoint: string;
+  did: string;
+  name: string;
+  url: string;
+  endpoint: string;
 }
 declare enum OrgQueryType {
-    OWNED = "owned",
-    JOINED = "joined"
+  OWNED = "owned",
+  JOINED = "joined",
 }
 declare class AuthService {
-    private api;
-    private token;
-    constructor({ api, token }: {
-        api: Axios;
-        token: TokenService;
-    });
-    getUserPublicInfo({ did }: {
-        did: string;
-    }): Promise<UserPublicInfo>;
-    getUserPrivacyConfig({ did }: {
-        did: string;
-    }): Promise<PrivacyConfig>;
-    saveUserPrivacyConfig(config: PrivacyConfig): Promise<PrivacyConfig>;
-    getUserNotificationConfig(): Promise<NotificationConfig>;
-    saveUserNotificationConfig(config: NotificationConfig): Promise<NotificationConfig>;
-    testNotificationWebhook(webhook: Webhook): Promise<{
-        success: boolean;
-    }>;
-    getProfileUrl({ did, locale }: {
-        did: string;
-        locale: string;
-    }): Promise<string>;
-    getProfile(): Promise<any>;
-    refreshProfile(): Promise<void>;
-    followUser({ userDid }: {
-        userDid: string;
-    }): Promise<void>;
-    unfollowUser({ userDid }: {
-        userDid: string;
-    }): Promise<void>;
-    isFollowingUser({ userDid }: {
-        userDid: string;
-    }): Promise<boolean>;
-    saveProfile({ locale, inviter, metadata, address, }: {
-        locale?: string;
-        inviter?: string;
-        metadata?: any;
-        address?: any;
-    }): Promise<any>;
-    updateDidSpace({ spaceGateway }: {
-        spaceGateway: SpaceGateway;
-    }): Promise<void>;
-    /**
-     * 指定要退出登录的设备 id
-     * 指定要退出登录的会话状态
-     * @param {{ visitorId: string, status: string }} { visitorId, status }
-     * @return {Promise<void>}
-     */
-    logout({ visitorId, status, includeFederated, }: {
-        visitorId?: string;
-        status?: string;
-        includeFederated?: boolean;
-    }): Promise<void>;
-    /**
-     * 删除当前登录用户
-     * @return {Promise<{did: string}>}
-     */
-    destroyMyself(): Promise<{
-        did: string;
-    }>;
-    /**
-     * org 相关
-     */
-    getOrgs({ search, type, page, pageSize, }: {
-        search?: string;
-        page: number;
-        pageSize: number;
-        type?: OrgQueryType | '';
-    }): Promise<any>;
-    getOrg(orgId: string): Promise<any>;
-    createOrg(org: any): Promise<any>;
-    getRole(name: string): Promise<any>;
-    addResourceToOrg({ orgId, resourceId, type, metadata, }: {
-        orgId: string;
-        resourceId: string;
-        type?: string;
-        metadata?: any;
-    }): Promise<any>;
-    migrateResourceToOrg({ form, to, resourceId }: {
-        form: string;
-        to: string;
-        resourceId: string;
-    }): Promise<any>;
+  private api;
+  private token;
+  constructor({
+    api,
+    token
+  }: {
+    api: Axios;
+    token: TokenService;
+  });
+  getUserPublicInfo({
+    did,
+    name
+  }: {
+    did: string;
+    name?: string;
+  }): Promise<UserPublicInfo>;
+  getUserPrivacyConfig({
+    did,
+    name
+  }: {
+    did: string;
+    name?: string;
+  }): Promise<PrivacyConfig>;
+  saveUserPrivacyConfig(config: PrivacyConfig): Promise<PrivacyConfig>;
+  getUserNotificationConfig(): Promise<NotificationConfig>;
+  saveUserNotificationConfig(config: NotificationConfig): Promise<NotificationConfig>;
+  testNotificationWebhook(webhook: Webhook): Promise<{
+    success: boolean;
+  }>;
+  getProfileUrl({
+    did,
+    locale
+  }: {
+    did: string;
+    locale: string;
+  }): Promise<string>;
+  getProfile(): Promise<any>;
+  refreshProfile(): Promise<void>;
+  followUser({
+    userDid
+  }: {
+    userDid: string;
+  }): Promise<void>;
+  unfollowUser({
+    userDid
+  }: {
+    userDid: string;
+  }): Promise<void>;
+  isFollowingUser({
+    userDid
+  }: {
+    userDid: string;
+  }): Promise<boolean>;
+  saveProfile({
+    locale,
+    inviter,
+    metadata,
+    address
+  }: {
+    locale?: string;
+    inviter?: string;
+    metadata?: any;
+    address?: any;
+  }): Promise<any>;
+  updateDidSpace({
+    spaceGateway
+  }: {
+    spaceGateway: SpaceGateway;
+  }): Promise<void>;
+  /**
+       * 指定要退出登录的设备 id
+       * 指定要退出登录的会话状态
+       * @param {{ visitorId: string, status: string }} { visitorId, status }
+       * @return {Promise<void>}
+       */
+  logout({
+    visitorId,
+    status,
+    includeFederated
+  }: {
+    visitorId?: string;
+    status?: string;
+    includeFederated?: boolean;
+  }): Promise<void>;
+  /**
+       * 删除当前登录用户
+       * @return {Promise<{did: string}>}
+       */
+  destroyMyself(): Promise<{
+    did: string;
+  }>;
+  /**
+       * org 相关
+       */
+  getOrgs({
+    search,
+    type,
+    page,
+    pageSize
+  }: {
+    search?: string;
+    page: number;
+    pageSize: number;
+    type?: OrgQueryType | '';
+  }): Promise<any>;
+  getOrg(orgId: string): Promise<any>;
+  createOrg(org: any): Promise<any>;
+  getRole(name: string): Promise<any>;
+  addResourceToOrg({
+    orgId,
+    resourceId,
+    type,
+    metadata
+  }: {
+    orgId: string;
+    resourceId: string;
+    type?: string;
+    metadata?: any;
+  }): Promise<any>;
+  migrateResourceToOrg({
+    form,
+    to,
+    resourceId
+  }: {
+    form: string;
+    to: string;
+    resourceId: string;
+  }): Promise<any>;
 }
-
+//#endregion
+//#region src/types/index.d.ts
+/**
+ * 签名验证函数类型
+ * @param data - 待验证的数据（JSON 字符串）
+ * @param signature - 签名值
+ * @param appPk - 应用公钥
+ * @param appId - 应用 DID
+ * @returns 验证结果，支持同步或异步
+ */
+type VerifyFn = (data: string, signature: string, appPk: string, appId: string) => boolean | Promise<boolean>;
 type RequestParams = {
-    lazy?: boolean;
-    lazyTime?: number;
-    componentDid?: string;
+  lazy?: boolean;
+  lazyTime?: number;
+  componentDid?: string;
+  verifyFn?: VerifyFn;
 };
 type BlockletComponent = TComponentInternalInfo & {
-    status: keyof typeof BlockletStatus;
+  status: keyof typeof BlockletStatus;
 };
 type BlockletSettings = {
-    session: {
-        ttl: number;
-        cacheTtl: number;
-    };
-    federated: {
-        master: {
-            appId: string;
-            appPid: string;
-            appName: string;
-            appDescription: string;
-            appUrl: string;
-            appLogo: string;
-            version: string;
-        };
-        config: Record<string, any>;
+  session: {
+    ttl: number;
+    cacheTtl: number;
+  };
+  federated: {
+    master: {
+      appId: string;
+      appPid: string;
+      appName: string;
+      appDescription: string;
+      appUrl: string;
+      appLogo: string;
+      version: string;
     };
-    oauth: Record<string, {
-        enabled: boolean;
-        [x: string]: any;
-    }>;
+    config: Record<string, any>;
+  };
+  oauth: Record<string, {
+    enabled: boolean;
+    [x: string]: any;
+  }>;
 };
 type Blocklet = {
-    [x: string]: any;
-    did: string;
-    appId: string;
-    appPk: string;
-    appIds?: string[];
-    appPid: string;
-    appName: string;
-    appDescription: string;
-    appLogo: string;
-    appLogoRect: string;
-    appUrl: string;
-    domainAliases?: string[];
-    isComponent: boolean;
-    prefix: string;
-    groupPrefix: string;
-    pageGroup: string;
-    version: string;
-    mode: string;
-    tenantMode: 'single' | 'multiple';
-    theme: TTheme;
-    navigation: TNavigationItem[];
-    preferences: Record<string, any>;
-    languages: {
-        code: string;
-        name: string;
-    }[];
-    passportColor: string;
-    componentMountPoints: BlockletComponent[];
-    alsoKnownAs: string[];
-    trustedFactories: string[];
-    status: string;
-    serverDid: string;
-    serverVersion: string;
-    componentId: string;
-    webWalletUrl: string;
-    updatedAt: number;
-    settings: BlockletSettings;
+  [x: string]: any;
+  did: string;
+  appId: string;
+  appPk: string;
+  appIds?: string[];
+  appPid: string;
+  appName: string;
+  appDescription: string;
+  appLogo: string;
+  appLogoRect: string;
+  appUrl: string;
+  domainAliases?: string[];
+  isComponent: boolean;
+  prefix: string;
+  groupPrefix: string;
+  pageGroup: string;
+  version: string;
+  mode: string;
+  tenantMode: 'single' | 'multiple';
+  theme: TTheme;
+  navigation: TNavigationItem[];
+  preferences: Record<string, any>;
+  languages: {
+    code: string;
+    name: string;
+  }[];
+  passportColor: string;
+  componentMountPoints: BlockletComponent[];
+  alsoKnownAs: string[];
+  trustedFactories: string[];
+  status: string;
+  serverDid: string;
+  serverVersion: string;
+  componentId: string;
+  webWalletUrl: string;
+  updatedAt: number;
+  settings: BlockletSettings;
 };
-
+//#endregion
+//#region src/services/blocklet.d.ts
 declare class BlockletService {
-    getBlocklet(): Blocklet;
-    getBlocklet(baseUrl?: string, force?: boolean): Promise<Blocklet>;
-    loadBlocklet(): Promise<void>;
-    getPrefix(blocklet?: Blocklet): string;
+  getBlocklet(): Blocklet;
+  getBlocklet(baseUrl?: string, force?: boolean): Promise<Blocklet>;
+  loadBlocklet(): Promise<void>;
+  getPrefix(blocklet?: Blocklet): any;
 }
-
+//#endregion
+//#region src/services/user-session.d.ts
 type UserSessionUser = {
-    avatar: string;
-    did: string;
-    email: string;
-    fullName: string;
-    pk: string;
-    remark?: string;
-    role: string;
-    roleTitle: string;
-    sourceAppPid: string | null;
-    sourceProvider: 'wallet' | 'auth0' | 'nft';
+  avatar: string;
+  did: string;
+  email: string;
+  fullName: string;
+  pk: string;
+  remark?: string;
+  role: string;
+  roleTitle: string;
+  sourceAppPid: string | null;
+  sourceProvider: 'wallet' | 'auth0' | 'nft';
 };
 type UserSession = {
-    appName: string;
-    appPid: string;
-    extra: {
-        walletOS: 'android' | 'ios' | 'web';
-    };
-    id: string;
-    lastLoginIp: string;
-    passportId: string | null;
-    ua: string;
-    createdAt?: string;
-    updatedAt: string;
-    status?: string;
-    user?: UserSessionUser;
-    userDid: string;
-    visitorId: string;
+  appName: string;
+  appPid: string;
+  extra: {
+    walletOS: 'android' | 'ios' | 'web';
+  };
+  id: string;
+  lastLoginIp: string;
+  passportId: string | null;
+  ua: string;
+  createdAt?: string;
+  updatedAt: string;
+  status?: string;
+  user?: UserSessionUser;
+  userDid: string;
+  visitorId: string;
 };
 type UserSessionList = {
-    list: UserSession[];
-    paging: {
-        page: number;
-        pageSize: number;
-        total: number;
-    };
-};
-type UserSessionQuery = {
+  list: UserSession[];
+  paging: {
     page: number;
     pageSize: number;
-    status?: USER_SESSION_STATUS.ONLINE | USER_SESSION_STATUS.EXPIRED | USER_SESSION_STATUS.OFFLINE;
+    total: number;
+  };
+};
+type UserSessionQuery = {
+  page: number;
+  pageSize: number;
+  status?: USER_SESSION_STATUS.ONLINE | USER_SESSION_STATUS.EXPIRED | USER_SESSION_STATUS.OFFLINE;
 };
 declare class UserSessionService {
-    private api;
-    private blocklet;
-    constructor({ api, blocklet }: {
-        api: Axios;
-        blocklet?: BlockletService;
-    });
-    getBaseUrl(appUrl?: string): string | undefined;
-    getUserSessions({ did, appUrl }: {
-        did: string;
-        appUrl?: string;
-    }): Promise<UserSession[]>;
-    /**
-     * 获取个人的所有登录会话
-     */
-    getMyLoginSessions({ appUrl }?: {
-        appUrl?: string;
-    }, params?: UserSessionQuery): Promise<UserSessionList>;
-    loginByUserSession({ id, appPid, userDid, passportId, appUrl, }: {
-        appPid: string;
-        userDid: string;
-        id: string;
-        passportId: string;
-        appUrl?: string;
-    }): Promise<UserSession[]>;
+  private api;
+  private blocklet;
+  constructor({
+    api,
+    blocklet
+  }: {
+    api: Axios;
+    blocklet?: BlockletService;
+  });
+  getBaseUrl(appUrl?: string): string | undefined;
+  getUserSessions({
+    did,
+    appUrl
+  }: {
+    did: string;
+    appUrl?: string;
+  }): Promise<UserSession[]>;
+  /**
+       * 获取个人的所有登录会话
+       */
+  getMyLoginSessions({
+    appUrl
+  }?: {
+    appUrl?: string;
+  }, params?: UserSessionQuery): Promise<UserSessionList>;
+  loginByUserSession({
+    id,
+    appPid,
+    userDid,
+    passportId,
+    appUrl
+  }: {
+    appPid: string;
+    userDid: string;
+    id: string;
+    passportId: string;
+    appUrl?: string;
+  }): Promise<UserSession[]>;
 }
-
+//#endregion
+//#region src/services/component.d.ts
 declare class ComponentService {
-    private blocklet;
-    constructor({ blocklet }?: {
-        blocklet?: Blocklet;
-    });
-    getComponent(name: string): never;
-    getComponentMountPoint(name?: string): string;
-    getUrl(name: string, ...parts: string[]): string;
+  private blocklet;
+  constructor({
+    blocklet
+  }?: {
+    blocklet?: Blocklet;
+  });
+  getComponent(name: string): never;
+  getComponentMountPoint(name?: string): string;
+  getUrl(name: string, ...parts: string[]): string;
 }
-
+//#endregion
+//#region src/services/federated.d.ts
 type AppInfo = {
-    appId: string;
-    appName: string;
-    appDescription: string;
-    appLogo: string;
-    appPid: string;
-    appUrl: string;
-    version: string;
-    sourceAppPid: string;
-    provider: string;
+  appId: string;
+  appName: string;
+  appDescription: string;
+  appLogo: string;
+  appPid: string;
+  appUrl: string;
+  version: string;
+  sourceAppPid: string;
+  provider: string;
 };
 type ServerInfo = {
+  appId: string;
+  appName: string;
+  appDescription: string;
+  appUrl: string;
+  sourceAppPid: string;
+  provider: string;
+  type: 'server';
+};
+declare class FederatedService {
+  private api;
+  private blocklet;
+  private blockletDataCache;
+  constructor({
+    api,
+    blocklet
+  }: {
+    api: Axios;
+    blocklet?: BlockletService;
+  });
+  getTrustedDomains(): Promise<Array<string>>;
+  getMaster(blocklet?: Blocklet): {
     appId: string;
+    appPid: string;
     appName: string;
     appDescription: string;
     appUrl: string;
-    sourceAppPid: string;
-    provider: string;
-    type: 'server';
-};
-declare class FederatedService {
-    private api;
-    private blocklet;
-    private blockletDataCache;
-    constructor({ api, blocklet }: {
-        api: Axios;
-        blocklet?: BlockletService;
-    });
-    getTrustedDomains(): Promise<Array<string>>;
-    getMaster(blocklet?: Blocklet): {
-        appId: string;
-        appPid: string;
-        appName: string;
-        appDescription: string;
-        appUrl: string;
-        appLogo: string;
-        version: string;
-    };
-    getConfig(blocklet?: Blocklet): Record<string, any>;
-    getFederatedEnabled(blocklet?: Blocklet): boolean;
-    getSourceAppPid(blocklet?: Blocklet): string;
-    getFederatedApp(blocklet?: Blocklet): AppInfo | null;
-    getCurrentApp(blocklet?: Blocklet): AppInfo | ServerInfo;
-    getApps(blocklet?: Blocklet): any[];
-    getBlockletData(appUrl: string, force?: boolean): Promise<any>;
+    appLogo: string;
+    version: string;
+  };
+  getConfig(blocklet?: Blocklet): Record<string, any>;
+  getFederatedEnabled(blocklet?: Blocklet): boolean;
+  getSourceAppPid(blocklet?: Blocklet): string;
+  getFederatedApp(blocklet?: Blocklet): AppInfo | null;
+  getCurrentApp(blocklet?: Blocklet): AppInfo | ServerInfo;
+  getApps(blocklet?: Blocklet): any[];
+  getBlockletData(appUrl: string, force?: boolean): Promise<any>;
 }
-
+//#endregion
+//#region src/libs/csrf.d.ts
 declare function getCSRFToken(): string;
 declare function getLoginToken(): string;
 declare function getCSRFTokenByLoginToken(): Promise<{
-    loginToken: string;
-    csrfToken: string | null;
+  loginToken: string;
+  csrfToken: string | null;
 }>;
-
+//#endregion
+//#region src/index.d.ts
+interface BlockletSDKOptions {
+  verifyFn?: VerifyFn;
+}
 declare class BlockletSDK {
-    api: Axios;
-    user: AuthService;
-    userSession: UserSessionService;
-    token: TokenService;
-    blocklet: BlockletService;
-    federated: FederatedService;
-    constructor();
+  api: Axios;
+  user: AuthService;
+  userSession: UserSessionService;
+  token: TokenService;
+  blocklet: BlockletService;
+  federated: FederatedService;
+  constructor(options?: BlockletSDKOptions);
 }
-declare function createAxios(config?: AxiosRequestConfig, requestParams?: RequestParams): axios.AxiosInstance;
+declare function createAxios(config?: AxiosRequestConfig, requestParams?: RequestParams): axios0.AxiosInstance;
 declare function createFetch(options?: RequestInit, requestParams?: RequestParams): (input: string | Request | URL, options?: RequestInit & {
-    secure?: boolean;
+  secure?: boolean;
 }) => Promise<Response>;
-declare const getBlockletSDK: () => BlockletSDK;
-
-export { AuthService, BlockletSDK, BlockletService, ComponentService, FederatedService, OrgQueryType, TokenService, UserSessionService, createAxios, createFetch, getBlockletSDK, getCSRFToken, getCSRFTokenByLoginToken, getLoginToken };
-export type { NotificationConfig, PrivacyConfig, SpaceGateway, UserPublicInfo, UserSession, UserSessionList, UserSessionQuery, UserSessionUser, Webhook };
+declare const getBlockletSDK: (options?: BlockletSDKOptions) => BlockletSDK;
+//#endregion
+export { AuthService, BlockletSDK, BlockletSDKOptions, BlockletService, ComponentService, FederatedService, NotificationConfig, OrgQueryType, PrivacyConfig, SpaceGateway, TokenService, UserPublicInfo, UserSession, UserSessionList, UserSessionQuery, UserSessionService, UserSessionUser, type VerifyFn, Webhook, createAxios, createFetch, getBlockletSDK, getCSRFToken, getCSRFTokenByLoginToken, getLoginToken };
+//# sourceMappingURL=index.d.mts.map