@rhc-office/sdk 6.6.256

package/src/api/common.ts

@@ -0,0 +1,117 @@
+/**
+ * 键值字段
+ */
+export interface IKVField {
+  key?: string;
+  value?: string;
+  description?: string;
+
+  setFieldName(name: string): void;
+
+  setFieldValue(value: string): void;
+
+  setDescription(description?: string): void;
+}
+
+/**
+ * 文件上传选项
+ */
+export interface FileUploadOptions {
+  formFiledName: string;
+  fileName: string;
+}
+
+/**
+ * 签章类型
+ *   0 - 普通章
+ *   1 - 校核章
+ *   2 - 单侧骑缝章
+ *   3 - 双侧骑缝章
+ */
+export type DigitalSignType = 0 | 1 | 2 | 3;
+
+/**
+ * 印章位置
+ */
+export type DigitalSealPosition = number;
+
+/**
+ * 数字签章选项
+ */
+export interface IDigitalSignOptions {
+  pageRange?: string;
+  page?: number;
+  pageX?: number;
+  pageY?: number;
+
+  signReason?: string;
+  signLocation?: string;
+  signUserData?: string;
+
+  fields: IKVField[];
+
+  defaultStampPassword?: string;
+  defaultKeystorePassword?: string;
+
+  keywordText?: string | undefined;
+  keywordTextFixedPositions:
+    | {
+        pageIndex?: number;
+        firstOccurrence?: boolean;
+        position?: number;
+      }[]
+    | undefined;
+  keywordOffsetX: number;
+  keywordOffsetY: number;
+
+  bookmarkName?: string | undefined;
+  bookmarkOffsetX: number;
+  bookmarkOffsetY: number;
+
+  printMargin?: number;
+
+  grayscaleSealImage: boolean;
+
+  getSignType(): DigitalSignType;
+
+  setSignType(signType: DigitalSignType): void;
+
+  isCrossPageSideSign(): boolean;
+
+  getSealPosition(): DigitalSealPosition;
+
+  setSignOnPageSides(signType: number): void;
+
+  setSignPositionOnPageSides(position: number): void;
+
+  setPageRange(text: string): void;
+
+  getPageRange(): string | undefined;
+
+  getPageRanges(): number[];
+
+  setSignUserData(signUserData: string): void;
+
+  setPrintMargin(margin: number): void;
+
+  getPrintMargin(): number;
+
+  setSignReason(reason: string): void;
+
+  getSignReason(): string | undefined;
+
+  setSignLocation(location: string): void;
+
+  getSignLocation(): string | undefined;
+
+  setDefaultStampPassword(password: string): void;
+}
+
+/**
+ * 签名字段（扩展自键值字段）
+ */
+export interface ISignatureField extends IKVField {
+  setHidden(hidden: boolean): void;
+
+  isHidden(): boolean;
+}

package/src/api/crypto-tool.ts

@@ -0,0 +1,10 @@
+export type SecurityProviderInfo = {
+  providerName: string;
+  applyFor: 'DocSign' | 'DocSignVerification';
+};
+
+export interface CryptoTool {
+  configSecurityProvider(providers: SecurityProviderInfo[]): void;
+
+  getSecurityProviders(): Promise<SecurityProviderInfo[]>;
+}

package/src/api/digital-sign-environment.ts

@@ -0,0 +1,411 @@
+export type SignServerAuthSource = 'Password' | 'USBKey' | 'KolKey' | 'Token';
+export type DigitalSignRsaMode = 'auto' | 'rsa' | 'sm2';
+export type SigningDeviceType = 'client' | 'bjca' | 'plugin' | 'kol' | 'hsm' | string;
+export type EdgePosition =
+  | 'LEFT_TOP'
+  | 'LEFT_CENTER'
+  | 'LEFT_BOTTOM'
+  | 'RIGHT_TOP'
+  | 'RIGHT_CENTER'
+  | 'RIGHT_BOTTOM'
+  | string;
+export type SignatureType = 'REGULAR_ESM' | 'OFCRYPTO_ESM' | string;
+
+const DEFAULT_EDGE_POSITION = 'RIGHT_CENTER' as EdgePosition;
+const DEFAULT_SIGNATURE_TYPE = 'REGULAR_ESM' as SignatureType;
+const DEFAULT_RSA_MODE: DigitalSignRsaMode = 'auto';
+
+export interface DigitalSignSignServerConfig {
+  authSource: SignServerAuthSource;
+  defaultLogin: string;
+  defaultPassword: string;
+  defaultServer: string;
+  kol: {
+    appId: string;
+    appName: string;
+    serviceUrl: string;
+    token: string;
+  };
+  macAddress: string;
+  token: string;
+  usbKey: {
+    checkCertificateBinding: boolean;
+    usbKeyType: number;
+  };
+}
+
+export interface DigitalSignDefaultsConfig {
+  bjca: {
+    pin: string;
+  };
+  deviceType: SigningDeviceType;
+  edgePosition: EdgePosition;
+  kol: {
+    appId: string;
+    appName: string;
+    pin: string;
+    serviceUrl: string;
+    token: string;
+  };
+  plugin: {
+    pin: string;
+    usbKeyType: number;
+  };
+  rsaMode: DigitalSignRsaMode;
+  signatureType: SignatureType;
+}
+
+export interface DigitalSignEnvironmentConfig {
+  defaults: DigitalSignDefaultsConfig;
+  signServer: DigitalSignSignServerConfig;
+}
+
+export interface DigitalSignDefaultsPatch {
+  bjca?: {
+    pin?: string;
+  };
+  deviceType?: SigningDeviceType;
+  edgePosition?: EdgePosition;
+  kol?: {
+    appId?: string;
+    appName?: string;
+    pin?: string;
+    serviceUrl?: string;
+    token?: string;
+  };
+  plugin?: {
+    pin?: string;
+    usbKeyType?: number;
+  };
+  rsaMode?: DigitalSignRsaMode;
+  signatureType?: SignatureType;
+}
+
+export interface DigitalSignSignServerPatch {
+  authSource?: SignServerAuthSource;
+  defaultLogin?: string;
+  defaultPassword?: string;
+  defaultServer?: string;
+  kol?: {
+    appId?: string;
+    appName?: string;
+    serviceUrl?: string;
+    token?: string;
+  };
+  macAddress?: string;
+  token?: string;
+  usbKey?: {
+    checkCertificateBinding?: boolean;
+    usbKeyType?: number;
+  };
+}
+
+export interface DigitalSignEnvironmentPatch {
+  defaults?: DigitalSignDefaultsPatch;
+  signServer?: DigitalSignSignServerPatch;
+}
+
+interface DigitalSignEnvironmentRuntimeStore {
+  current: DigitalSignEnvironmentConfig;
+  defaults: DigitalSignEnvironmentConfig;
+  overrides: DigitalSignEnvironmentPatch;
+}
+
+const DIGITAL_SIGN_ENVIRONMENT_STORE_KEY = '__RHC_OFFICE_DIGITAL_SIGN_ENVIRONMENT__';
+
+const EMPTY_DIGITAL_SIGN_ENVIRONMENT: DigitalSignEnvironmentConfig = {
+  defaults: {
+    bjca: {
+      pin: '',
+    },
+    deviceType: 'client',
+    edgePosition: DEFAULT_EDGE_POSITION,
+    kol: {
+      appId: '',
+      appName: '',
+      pin: '',
+      serviceUrl: '',
+      token: '',
+    },
+    plugin: {
+      pin: '',
+      usbKeyType: 14,
+    },
+    rsaMode: DEFAULT_RSA_MODE,
+    signatureType: DEFAULT_SIGNATURE_TYPE,
+  },
+  signServer: {
+    authSource: 'Password',
+    defaultLogin: '',
+    defaultPassword: '',
+    defaultServer: '',
+    kol: {
+      appId: '',
+      appName: '',
+      serviceUrl: '',
+      token: '',
+    },
+    macAddress: '',
+    token: '',
+    usbKey: {
+      checkCertificateBinding: false,
+      usbKeyType: 14,
+    },
+  },
+};
+
+const cloneDefaultsConfig = (config: DigitalSignDefaultsConfig): DigitalSignDefaultsConfig => {
+  return {
+    bjca: {
+      pin: config.bjca.pin,
+    },
+    deviceType: config.deviceType,
+    edgePosition: config.edgePosition,
+    kol: {
+      appId: config.kol.appId,
+      appName: config.kol.appName,
+      pin: config.kol.pin,
+      serviceUrl: config.kol.serviceUrl,
+      token: config.kol.token,
+    },
+    plugin: {
+      pin: config.plugin.pin,
+      usbKeyType: config.plugin.usbKeyType,
+    },
+    rsaMode: config.rsaMode,
+    signatureType: config.signatureType,
+  };
+};
+
+const cloneSignServerConfig = (
+  config: DigitalSignSignServerConfig,
+): DigitalSignSignServerConfig => {
+  return {
+    authSource: config.authSource,
+    defaultLogin: config.defaultLogin,
+    defaultPassword: config.defaultPassword,
+    defaultServer: config.defaultServer,
+    kol: {
+      appId: config.kol.appId,
+      appName: config.kol.appName,
+      serviceUrl: config.kol.serviceUrl,
+      token: config.kol.token,
+    },
+    macAddress: config.macAddress,
+    token: config.token,
+    usbKey: {
+      checkCertificateBinding: config.usbKey.checkCertificateBinding,
+      usbKeyType: config.usbKey.usbKeyType,
+    },
+  };
+};
+
+const cloneEnvironmentConfig = (
+  config: DigitalSignEnvironmentConfig,
+): DigitalSignEnvironmentConfig => {
+  return {
+    defaults: cloneDefaultsConfig(config.defaults),
+    signServer: cloneSignServerConfig(config.signServer),
+  };
+};
+
+const cloneEnvironmentPatch = (patch: DigitalSignEnvironmentPatch): DigitalSignEnvironmentPatch => {
+  return {
+    defaults: patch.defaults
+      ? {
+          ...patch.defaults,
+          bjca: patch.defaults.bjca ? { ...patch.defaults.bjca } : undefined,
+          kol: patch.defaults.kol ? { ...patch.defaults.kol } : undefined,
+          plugin: patch.defaults.plugin ? { ...patch.defaults.plugin } : undefined,
+        }
+      : undefined,
+    signServer: patch.signServer
+      ? {
+          ...patch.signServer,
+          kol: patch.signServer.kol ? { ...patch.signServer.kol } : undefined,
+          usbKey: patch.signServer.usbKey ? { ...patch.signServer.usbKey } : undefined,
+        }
+      : undefined,
+  };
+};
+
+const mergeDefaultsPatch = (
+  base: DigitalSignDefaultsConfig,
+  patch?: DigitalSignEnvironmentPatch['defaults'],
+): DigitalSignDefaultsConfig => {
+  if (!patch) {
+    return cloneDefaultsConfig(base);
+  }
+
+  return {
+    bjca: {
+      pin: patch.bjca?.pin ?? base.bjca.pin,
+    },
+    deviceType: patch.deviceType ?? base.deviceType,
+    edgePosition: patch.edgePosition ?? base.edgePosition,
+    kol: {
+      appId: patch.kol?.appId ?? base.kol.appId,
+      appName: patch.kol?.appName ?? base.kol.appName,
+      pin: patch.kol?.pin ?? base.kol.pin,
+      serviceUrl: patch.kol?.serviceUrl ?? base.kol.serviceUrl,
+      token: patch.kol?.token ?? base.kol.token,
+    },
+    plugin: {
+      pin: patch.plugin?.pin ?? base.plugin.pin,
+      usbKeyType: patch.plugin?.usbKeyType ?? base.plugin.usbKeyType,
+    },
+    rsaMode: patch.rsaMode ?? base.rsaMode,
+    signatureType: patch.signatureType ?? base.signatureType,
+  };
+};
+
+const mergeSignServerPatch = (
+  base: DigitalSignSignServerConfig,
+  patch?: DigitalSignEnvironmentPatch['signServer'],
+): DigitalSignSignServerConfig => {
+  if (!patch) {
+    return cloneSignServerConfig(base);
+  }
+
+  return {
+    authSource: patch.authSource ?? base.authSource,
+    defaultLogin: patch.defaultLogin ?? base.defaultLogin,
+    defaultPassword: patch.defaultPassword ?? base.defaultPassword,
+    defaultServer: patch.defaultServer ?? base.defaultServer,
+    kol: {
+      appId: patch.kol?.appId ?? base.kol.appId,
+      appName: patch.kol?.appName ?? base.kol.appName,
+      serviceUrl: patch.kol?.serviceUrl ?? base.kol.serviceUrl,
+      token: patch.kol?.token ?? base.kol.token,
+    },
+    macAddress: patch.macAddress ?? base.macAddress,
+    token: patch.token ?? base.token,
+    usbKey: {
+      checkCertificateBinding:
+        patch.usbKey?.checkCertificateBinding ?? base.usbKey.checkCertificateBinding,
+      usbKeyType: patch.usbKey?.usbKeyType ?? base.usbKey.usbKeyType,
+    },
+  };
+};
+
+const mergeEnvironmentPatch = (
+  base: DigitalSignEnvironmentConfig,
+  patch: DigitalSignEnvironmentPatch,
+): DigitalSignEnvironmentConfig => {
+  return {
+    defaults: mergeDefaultsPatch(base.defaults, patch.defaults),
+    signServer: mergeSignServerPatch(base.signServer, patch.signServer),
+  };
+};
+
+const mergeEnvironmentPatchState = (
+  base: DigitalSignEnvironmentPatch,
+  patch: DigitalSignEnvironmentPatch,
+): DigitalSignEnvironmentPatch => {
+  return {
+    defaults:
+      base.defaults || patch.defaults
+        ? {
+            ...base.defaults,
+            ...patch.defaults,
+            bjca: {
+              ...(base.defaults?.bjca ?? {}),
+              ...(patch.defaults?.bjca ?? {}),
+            },
+            kol: {
+              ...(base.defaults?.kol ?? {}),
+              ...(patch.defaults?.kol ?? {}),
+            },
+            plugin: {
+              ...(base.defaults?.plugin ?? {}),
+              ...(patch.defaults?.plugin ?? {}),
+            },
+          }
+        : undefined,
+    signServer:
+      base.signServer || patch.signServer
+        ? {
+            ...base.signServer,
+            ...patch.signServer,
+            kol: {
+              ...(base.signServer?.kol ?? {}),
+              ...(patch.signServer?.kol ?? {}),
+            },
+            usbKey: {
+              ...(base.signServer?.usbKey ?? {}),
+              ...(patch.signServer?.usbKey ?? {}),
+            },
+          }
+        : undefined,
+  };
+};
+
+const getGlobalScope = (): typeof globalThis & {
+  [DIGITAL_SIGN_ENVIRONMENT_STORE_KEY]?: DigitalSignEnvironmentRuntimeStore;
+} => {
+  return globalThis as typeof globalThis & {
+    [DIGITAL_SIGN_ENVIRONMENT_STORE_KEY]?: DigitalSignEnvironmentRuntimeStore;
+  };
+};
+
+const resolveRuntimeStore = (): DigitalSignEnvironmentRuntimeStore => {
+  const globalScope = getGlobalScope();
+  if (!globalScope[DIGITAL_SIGN_ENVIRONMENT_STORE_KEY]) {
+    globalScope[DIGITAL_SIGN_ENVIRONMENT_STORE_KEY] = {
+      current: cloneEnvironmentConfig(EMPTY_DIGITAL_SIGN_ENVIRONMENT),
+      defaults: cloneEnvironmentConfig(EMPTY_DIGITAL_SIGN_ENVIRONMENT),
+      overrides: {},
+    };
+  }
+
+  return globalScope[DIGITAL_SIGN_ENVIRONMENT_STORE_KEY]!;
+};
+
+export const getDigitalSignEnvironment = (): DigitalSignEnvironmentConfig => {
+  return resolveRuntimeStore().current;
+};
+
+export const initializeDigitalSignEnvironment = (
+  defaults: DigitalSignEnvironmentConfig,
+): DigitalSignEnvironmentConfig => {
+  const store = resolveRuntimeStore();
+  store.defaults = cloneEnvironmentConfig(defaults);
+  store.current = mergeEnvironmentPatch(store.defaults, store.overrides);
+  return store.current;
+};
+
+export const setDigitalSignEnvironment = (
+  config: DigitalSignEnvironmentConfig,
+): DigitalSignEnvironmentConfig => {
+  const store = resolveRuntimeStore();
+  store.current = cloneEnvironmentConfig(config);
+  store.overrides = cloneEnvironmentPatch(config);
+  return store.current;
+};
+
+export const patchDigitalSignEnvironment = (
+  patch: DigitalSignEnvironmentPatch,
+): DigitalSignEnvironmentConfig => {
+  const store = resolveRuntimeStore();
+  store.overrides = mergeEnvironmentPatchState(store.overrides, cloneEnvironmentPatch(patch));
+  store.current = mergeEnvironmentPatch(store.current, patch);
+  return store.current;
+};
+
+export const resetDigitalSignEnvironment = (
+  defaults?: DigitalSignEnvironmentConfig,
+): DigitalSignEnvironmentConfig => {
+  const store = resolveRuntimeStore();
+  if (defaults) {
+    store.defaults = cloneEnvironmentConfig(defaults);
+  }
+  store.overrides = {};
+  store.current = cloneEnvironmentConfig(store.defaults);
+  return store.current;
+};
+
+export const DIGITAL_SIGN_DEFAULTS = {
+  EDGE_POSITION: DEFAULT_EDGE_POSITION,
+  RSA_MODE: DEFAULT_RSA_MODE,
+  SIGNATURE_TYPE: DEFAULT_SIGNATURE_TYPE,
+} as const;

package/src/api/document-sdk.ts

@@ -0,0 +1,152 @@
+import { IDigitalSignOptions, IKVField } from './common';
+import { ReaderReadyCallback, ReaderUnloadCallback } from './callbacks';
+import { DocumentTool } from './document-tool';
+import { AnnotationTool } from './annotation-tool';
+import { UITool } from './ui-tool';
+import { PageTool } from './page-tool';
+import { FindTool } from './find-tool';
+import { DigitalSignTool } from './sign-tool';
+import { SignServerTool } from './sign-server';
+import { NetworkingTool } from './networking-tool';
+import { EkeyTool } from './ekey-tool';
+import { ExtensionTool } from './extension-tool';
+import { SymbologyTool } from './symbology-tool';
+import { TemplateSignTool } from './template-sign';
+import { PdfFormFiller } from './pdf-formfiller';
+import { ReviewTool } from './review-tool';
+import { CryptoTool } from './crypto-tool';
+
+export interface IReaderEmbedOptions {
+  debug?: boolean;
+  scrollIntoView?: boolean;
+  toolbar?: boolean;
+  canOpenNewFile?: boolean;
+  canPrint?: boolean;
+  canDownload?: boolean;
+  language?: 'en_US' | 'zh_CN';
+  theme?: string;
+  binder?: string;
+  origin?: string;
+
+  /**
+   * 阅读器部署的地址
+   */
+  officeServer: string;
+  /**
+   * View: 阅读模式，Annotation: 批注模式，DigitalSign: 签章模式
+   */
+  viewMode: string;
+  /**
+   * 签章功能：Server: 服务器签章，Extension: 浏览器控件签章
+   */
+  signMode?: 'Extension' | 'Server';
+  /**
+   * 是否显示菜单
+   */
+  ribbonMenu?: boolean;
+  /**
+   * 是否显示菜单标题
+   */
+  ribbonTitle?: boolean;
+  /**
+   * 是否保持菜单样式
+   */
+  keepPCMenu?: boolean;
+  /**
+   * 是否紧凑模式，通常可以在移动设备上有更好的体验
+   */
+  compactViewer?: boolean;
+  /**
+   * 单文档模式
+   * 设置为 true 时可以同时打开多个文档，页面上使用 Tab 视图来呈现
+   * 注意：compactViewer 为 true 时，单文档模式将自动禁用
+   */
+  singleViewer?: boolean;
+  /**
+   * 阅读器视图样式
+   */
+  style?: string;
+  /**
+   * 阅读器视图宽度
+   */
+  width?: string;
+  /**
+   * 阅读器视图高度
+   */
+  height?: string;
+}
+
+export interface IDocumentSDK {
+  enableDebug(debug: boolean): void;
+
+  changeLanguage(lang: string): void;
+
+  setLicense(license: string, feature: string): void;
+
+  setSessionUser(
+    userNameOrInfo:
+      | string
+      | {
+          userName: string;
+          userId?: any;
+        },
+  ): void;
+
+  setSessionUserId(userId: string | number): void;
+
+  setSessionData(sessionData: string): void;
+
+  isReaderReady(): boolean;
+
+  isReaderDestroyed(): boolean;
+
+  addReaderReadyCallback(callback: ReaderReadyCallback): void;
+
+  addReaderUnloadCallback(callback: ReaderUnloadCallback): void;
+
+  setReaderEventListener(callback: (event: string, payload: any) => void): void;
+
+  embedReader(
+    container: string | HTMLDivElement,
+    appUrl: string,
+    configuration: IReaderEmbedOptions,
+  ): void;
+
+  removeReader(): void;
+
+  // Tool accessors
+
+  getDocumentTool(): DocumentTool;
+
+  getUITool(): UITool;
+
+  getPageTool(): PageTool;
+
+  getFindTool(): FindTool;
+
+  getSignServerTool(): SignServerTool;
+
+  getDigitalSignTool(): DigitalSignTool;
+
+  getReviewTool(): ReviewTool;
+
+  getEkeyTool(): EkeyTool;
+
+  getSymbologyTool(): SymbologyTool;
+
+  getAnnotationTool(): AnnotationTool;
+
+  getTemplateSignTool(): TemplateSignTool;
+
+  getPdfFormFiller(): PdfFormFiller;
+
+  getExtensionTool(): ExtensionTool;
+
+  getNetworkingTool(): NetworkingTool;
+
+  getCryptoTool(): CryptoTool;
+
+  createDigitalSignOptions(): IDigitalSignOptions;
+
+  createKVField(key: string, value: string, description?: string): IKVField;
+}