@rhc-office/sdk 6.6.256

package/src/api/document-tool.ts

@@ -0,0 +1,106 @@
+import { DocumentClosedCallback, DocumentSavedCallback } from './callbacks';
+
+export type IFileSaveFormat = 'pdf' | 'png' | 'jpeg' | 'jpg' | 'tiff';
+
+export interface IFileOpenOptions {
+  timestamp: number;
+  fileId: string;
+  fileCacheId?: string;
+  fileType:
+    | 'application/ofd'
+    | 'application/pdf'
+    | 'application/mso'
+    | 'application/image'
+    | 'application/text';
+  fileName: string;
+  fileUrl?: string;
+  fileBase64?: string;
+  fileContent?: ArrayBuffer;
+  contentEncoding?: string;
+  textPreviewFont?: {
+    fontName: string;
+    fontSize: number;
+  };
+  uploadUrl?: string;
+  readOnly?: boolean;
+  fromCache?: boolean;
+  viewMode?: 'view' | 'annotation' | 'digital-sign';
+  annotationConfigs?: {
+    strokeColor?: string;
+    strokeWidth?: number;
+  };
+  showFileUploadDialog?: boolean;
+}
+
+export interface IFileSaveOptions {
+  /** 静默式 */
+  silent?: boolean;
+  filename?: string;
+  format?: IFileSaveFormat;
+  rasterScale?: number;
+  jpegQuality?: number;
+  pages?: number[];
+}
+
+export interface IFileSaveResult {
+  success: boolean;
+  action: 'save-as' | 'export';
+  format?: IFileSaveFormat;
+  filename?: string;
+  error?: string;
+}
+
+export interface DocumentTool {
+  addDocumentOpenedCallback(callback: (status: string, error: string) => void): void;
+
+  addDocumentSavedCallback(callback: DocumentSavedCallback): void;
+
+  addDocumentClosedCallback(callback: DocumentClosedCallback): void;
+
+  openPDFDocument(options: IFileOpenOptions, onDocumentOpened?: (event: any) => void): void;
+
+  openPdfDocument(options: IFileOpenOptions, onDocumentOpened?: (event: any) => void): void;
+
+  openOFDDocument(options: IFileOpenOptions, onDocumentOpened?: (event: any) => void): void;
+
+  openOfdDocument(options: IFileOpenOptions, onDocumentOpened?: (event: any) => void): void;
+
+  openOfficeDocument(options: IFileOpenOptions, onDocumentOpened?: (event: any) => void): void;
+
+  openImageDocument(options: IFileOpenOptions, onDocumentOpened?: (event: any) => void): void;
+
+  openTextDocument(options: IFileOpenOptions, onDocumentOpened?: (event: any) => void): void;
+
+  openFromLocalStorage(): void;
+
+  setUploadUrl(uploadUrl: string): void;
+
+  save(
+    uploadUrl?: string,
+    onSavedCallback?: DocumentSavedCallback,
+    options?: IFileSaveOptions,
+  ): void;
+
+  saveAs(options?: IFileSaveOptions): Promise<IFileSaveResult>;
+
+  getDocumentContent(
+    onDocumentContent?: (fileCacheId?: string, fileBuffer?: ArrayBuffer) => void,
+  ): void;
+
+  closeDocument(
+    discardModify: boolean,
+    onClose?: DocumentClosedCallback,
+    options?: {
+      keepViewer?: boolean;
+      fileOptions?: IFileOpenOptions;
+    },
+  ): void;
+
+  isDocumentOpened(): boolean;
+
+  isDocumentModified(): boolean;
+
+  print(): void;
+
+  createPreview(serverUrl: string, options: any): void;
+}

package/src/api/ekey-tool.ts

@@ -0,0 +1,11 @@
+export type OnLoadEkeyCallback = (ekeyList: string[]) => void;
+
+export interface EkeyTool {
+  setOperationTimeout(timeout: number): void;
+
+  isEkeyConnected(callback: OnLoadEkeyCallback): void;
+
+  setDefaultEKEYPassword(ekeyPassword: string): void;
+
+  setDefaultEKEYAuthentication(ekeyLogin: boolean): void;
+}

package/src/api/extension-tool.ts

@@ -0,0 +1,5 @@
+import { ExtensionStateChangedCallback } from './callbacks';
+
+export interface ExtensionTool {
+  addExtensionStateChangedCallback(callback: ExtensionStateChangedCallback): void;
+}

package/src/api/find-tool.ts

@@ -0,0 +1,7 @@
+export interface FindTool {
+  clearFind(): void;
+
+  findNext(queryText: string | any): void;
+
+  findPrevious(queryText: string | any): void;
+}

package/src/api/menu-visibility.ts

@@ -0,0 +1,17 @@
+export interface ViewVisibility {
+  visible: boolean;
+  disabled: boolean;
+  children: {
+    [propName: string]: ViewVisibility;
+  };
+}
+
+export interface RibbonMenuItemVisibility {
+  [propName: string]: ViewVisibility;
+}
+
+export interface MenuActionButtonStyle {
+  type: 'Icon' | 'Label' | 'ToolTip';
+  content: string;
+  iconContentType?: 'application/svg' | 'url';
+}

package/src/api/networking-tool.ts

@@ -0,0 +1,9 @@
+import { FileUploadOptions, IKVField } from './common';
+
+export interface NetworkingTool {
+  configFileUpload(options: FileUploadOptions): void;
+
+  setHttpHeaders(headers: IKVField[] | any): void;
+
+  setHttpFormFields(fields: IKVField[]): void;
+}

package/src/api/page-tool.ts

@@ -0,0 +1,56 @@
+import {
+  PageChangeCallback,
+  PageCountCallback,
+  PageIndexGetCallback,
+  PageModeChangeCallback,
+} from './callbacks';
+
+export interface PageTool {
+  addPageChangeCallback(callback: PageChangeCallback): void;
+
+  addPageModeChangeCallback(callback: PageModeChangeCallback): void;
+
+  getPageCount(callback: PageCountCallback): void;
+
+  getPageIndex(callback: PageIndexGetCallback): void;
+
+  setSinglePageViewMode(): void;
+
+  setTwoPagesViewMode(): void;
+
+  setPageScrollVertical(): void;
+
+  setPageScrollHorizontal(): void;
+
+  setPageCursorPanDrag(): void;
+
+  setPageCursorTextSelect(): void;
+
+  rotateCW(): void;
+
+  rotateCCW(): void;
+
+  autoFitPage(): void;
+
+  fitPageSize(): void;
+
+  fitPageWidth(): void;
+
+  fitPageHeight(): void;
+
+  increasePageScale(): void;
+
+  decreasePageScale(): void;
+
+  setPageScale(scale: number): void;
+
+  setPageBlendColor(r: number, g: number, b: number, alpha?: number): void;
+
+  gotoPage(pageIndex: number, x?: number, y?: number): void;
+
+  gotoNextPage(): void;
+
+  gotoPreviousPage(): void;
+
+  rotatePage(rotation: number): void;
+}

package/src/api/pdf-formfiller.ts

@@ -0,0 +1,13 @@
+export interface PdfFormFiller {
+  open(): void;
+
+  setFormFieldValue(filedName: string, value: string): void;
+
+  setFormFieldReadonly(filedName: string, readOnly: boolean): void;
+
+  commit(callback?: () => void): void;
+
+  clear(callback?: () => void): void;
+
+  toKeyValue(callback: (fields: { key: string; value: string }[]) => void): void;
+}

package/src/api/review-tool.ts

@@ -0,0 +1,105 @@
+export interface SessionView {
+  sessionId?: string;
+}
+
+export interface RawReviewParticipant extends SessionView {
+  userName: string;
+  userTitle: string;
+  password?: string;
+  themeColor?: string;
+
+  isHost?: boolean;
+  isSpeaker?: boolean;
+  isOrganizer?: boolean;
+}
+
+export interface ReviewParticipant {
+  userId: number;
+  userName: string;
+  userTitle: string;
+  themeColor: string;
+
+  id: number;
+  agentInfo: string;
+  ipAddress: string;
+  roomHost: boolean;
+  roomOrganizer: boolean;
+  following?: number;
+
+  roomId: number;
+  online?: boolean;
+  idle?: boolean;
+  onPresentation?: boolean;
+  annotationAbiLocked?: boolean;
+
+  nameTag: string;
+  englishName: boolean;
+  inAnnotation?: boolean;
+}
+
+export interface ReviewFile extends SessionView {
+  fileName: string;
+  downloadURL: string;
+}
+
+export interface ReviewSession extends SessionView {
+  sessionId: string;
+  sessionURL: string;
+  sessionName: string;
+
+  addParticipants(participants: RawReviewParticipant[]): void;
+
+  getParticipants(): Promise<RawReviewParticipant[]>;
+
+  addParticipantCreatedCallback(callback: (participant: ReviewParticipant) => void): void;
+
+  notifyParticipantCreated(participant: ReviewParticipant): void;
+
+  notifyParticipantsFetched(questKey: string, participant: ReviewParticipant[]): void;
+
+  addDocuments(documents: ReviewFile[]): void;
+
+  showDocumentsUploader(): void;
+
+  showDocumentsExplorer(): void;
+
+  getDocuments(): Promise<ReviewFile[]>;
+
+  addParticipantOnlineCallback(callback: (participant: ReviewParticipant) => void): void;
+
+  addParticipantOfflineCallback(callback: (participant: ReviewParticipant) => void): void;
+
+  enableAnnotation(): void;
+
+  disableAnnotation(): void;
+
+  isAnnotationEnabled(): Promise<boolean>;
+
+  enableAnnotationForParticipant(participant: RawReviewParticipant): void;
+
+  disableAnnotationForParticipant(participant: RawReviewParticipant): void;
+
+  isAnnotationEnabledForParticipant(participant: RawReviewParticipant): Promise<boolean>;
+
+  isSpeaker(participant: RawReviewParticipant): Promise<boolean>;
+
+  getSpeaker(): Promise<RawReviewParticipant | undefined>;
+
+  setSpeaker(participant: RawReviewParticipant): void;
+
+  removeSpeaker(): void;
+}
+
+export interface ReviewTool {
+  startSession(sessionName: string, sessionPassword?: string, organizer?: RawReviewParticipant): Promise<ReviewSession | undefined>;
+
+  getSessions(): Promise<ReviewSession[]>;
+
+  getSession(sessionId: string): Promise<ReviewSession | undefined>;
+
+  endSession(session: ReviewSession): Promise<ReviewSession | undefined>;
+
+  openSession(session: ReviewSession): Promise<ReviewSession | undefined>;
+
+  embedReviewer(session: ReviewSession, domIdOrDomElement: string | HTMLDivElement): Promise<ReviewSession | undefined>;
+}

package/src/api/sign-server.ts

@@ -0,0 +1,53 @@
+export type SignServerAuthCallback = (authorization: ISignServerAuthorization) => void;
+
+export interface ISignServerAuthorization {
+  status: string;
+  login: string;
+  token: string;
+  userName: string;
+  realName: string;
+  canDoSign: boolean;
+
+  getStatus(): string;
+
+  getLogin(): string;
+
+  getToken(): string;
+
+  getUserName(): string;
+
+  getRealName(): string;
+
+  canSign(): boolean;
+}
+
+export interface SignServerTool {
+  setSignServer(signServer: string): void;
+
+  addSignServerAuthCallback(callback: SignServerAuthCallback): void;
+
+  setSignServerDefaultLogin(login: string): void;
+
+  setDefaultSignServerLogin(login: string): void;
+
+  setSignServerDefaultPassword(password: string): void;
+
+  setDefaultSignServerPassword(password: string): void;
+
+  loginNTKOSignServer(serverAddress: string, login: string, password: string): void;
+
+  loginSignServer(server: string, login: string, password: string, onSuccess?: SignServerAuthCallback): void;
+
+  signOutSignServer(): void;
+
+  isAuthenticatedOnSignServer(): boolean;
+
+  setSignServerLoginFromUSBKey(
+    enabled: boolean,
+    options?: {
+      checkCertificateBinding: boolean;
+    },
+  ): void;
+
+  setUserAuthSource(source: 'Password' | 'USBKey' | 'KolKey' | 'Token'): void;
+}

package/src/api/sign-tool.ts

@@ -0,0 +1,50 @@
+import { DigitalSignatureRetrieveCallback, DigitalSignCallback } from './callbacks';
+import { IDigitalSignOptions } from './common';
+
+export interface DigitalSignTool {
+  addDigitalSignatureRetrieveCallback(callback: DigitalSignatureRetrieveCallback): void;
+
+  addDigitalSignatureParseCallback(callback: (digitalSignature: any[]) => void): void;
+
+  setCryptoProvider(usage: 'DigitalSign' | 'SignatureVerification', provider: string, configuration?: any): void;
+
+  setSealSource(source: 'SignServer' | 'USBKey' | 'ExternalServer'): void;
+
+  setDefaultStampPassword(stampPassword: string): void;
+
+  setDefaultSealPassword(sealPassword: string): void;
+
+  setDefaultKeystorePassword(pkPassword: string): void;
+
+  setDefaultUSBKeyPassword(pkPassword: string): void;
+
+  addDigitalSignCallback(callback: DigitalSignCallback): void;
+
+  setupExternalSealServer(options: void | unknown): void;
+
+  setDigitalSignOptions(options: {
+    signReason?: string;
+    signLocation?: string;
+    signUserData?: string;
+    fields?: any[];
+    printMargin?: number;
+  }): void;
+
+  setExternalDigitalSignOptions(options: void | unknown): void;
+
+  setPDFDigitalSignCaptionOptions(options: void | unknown): void;
+
+  addDigitalSignature(options: void | unknown, callback?: DigitalSignCallback): void;
+
+  addDigitalSignatureBySelectedSearchHighlight(options: IDigitalSignOptions | any): void;
+
+  listDigitalSignatures(callback?: (digitalSignature: any[]) => void): void;
+
+  getDigitalSignatures(): any[];
+
+  getDigitalSignaturesCount(): number;
+
+  enableDigitalSignatureInfoView(enabled: boolean): void;
+
+  enableDigitalSignatureRevocation(enabled: boolean): void;
+}

package/src/api/symbology-tool.ts

@@ -0,0 +1,11 @@
+export interface SymbologyTool {
+  createPDF417Barcode(
+    content: string,
+    pageIndex?: number,
+    x?: number,
+    y?: number,
+    width?: number,
+    height?: number,
+    margin?: number,
+  ): void;
+}

package/src/api/template-sign.ts

@@ -0,0 +1,102 @@
+import { DigitalSignCallback } from './callbacks';
+
+/**
+ * 印模信息
+ */
+export interface TemplateSignMarkup {
+  x: number;
+  y: number;
+  width: number;
+  height: number;
+  pageIndex: number;
+  sealName: string;
+  sealSerialNumber: string;
+}
+
+/**
+ * 印模设置项
+ */
+export interface TemplateSignOption {
+  /** 印模ID */
+  markupId?: string;
+
+  /** 印模删除时是否显示OkayCancel消息框 */
+  prompt?: boolean;
+
+  /** 下载印模印章列表时是否需要授权 */
+  accessToken?: string;
+
+  /**
+   * 默认的印模类型
+   *   4: 印模常规
+   *   5: 印模单侧骑缝
+   *   6: 印模对称骑缝
+   *   7: 印模校核
+   */
+  signType?: number;
+
+  /**
+   * 设置骑缝印模的页面位置，不设置时，默认为2
+   *   1: 上
+   *   2: 中
+   *   3: 下
+   */
+  signPosition?: number;
+
+  /**
+   * 印模尺寸是否控制最终印章尺寸
+   * 设置仅对常规印模有效，骑缝印模最终仍使用的是印章的尺寸
+   */
+  fixedSealSize?: boolean;
+
+  /**
+   * 是否显示设置视图
+   * 如果显示，signType和signPosition的设置的值将不取用
+   * 设置仅对骑缝印模有效，常规印模本来就需要用户在页面上选择位置
+   */
+  configUI?: boolean;
+
+  /**
+   * 印模中保存的自定义数据
+   * 如果设置，在印模详情、列举印模接口中均可看到和得到。盖章时，这个数据自动传递到印章中。
+   * 通过列举印章列表的接口返回的印章信息中也会携带这个数据
+   */
+  userData?: string;
+}
+
+export interface TemplateSignTool {
+  /**
+   * 印模设置项
+   */
+  setup(option: TemplateSignOption): void;
+
+  /**
+   * 印模类型
+   * @param signType
+   *    4: 印模常规
+   *    5: 印模单侧骑缝
+   *    6: 印模对称骑缝
+   *    7: 印模校核
+   */
+  create(signType?: number): void;
+
+  /**
+   * 列举文档中的印模信息
+   */
+  getMarkups(callback: (markups: TemplateSignMarkup[]) => void): void;
+
+  /**
+   * 删除文档中的某个印模信息
+   */
+  removeMarkup(markupId: string, prompt: boolean): void;
+
+  /**
+   * 删除文档中的印模信息
+   */
+  removeAllMarkups(prompt: boolean): void;
+
+  /**
+   * 按印模对文档进行签章
+   */
+  sign(callback?: DigitalSignCallback): void;
+}

package/src/api/ui-tool.ts

@@ -0,0 +1,66 @@
+import { RibbonMenuItemVisibility, MenuActionButtonStyle } from './menu-visibility';
+import { IWatermark } from './watermark';
+
+export interface UITool {
+  showToolbarMenu(): void;
+
+  hideToolbarMenu(): void;
+
+  setupToolbarMenu(
+    opt:
+      | boolean
+      | {
+          menu: string;
+          visible: boolean;
+        },
+  ): void;
+
+  showToolbarMenuItem(menuId: string): void;
+
+  hideToolbarMenuItem(menuId: string): void;
+
+  setupRibbonMenu(
+    opt:
+      | boolean
+      | {
+          menu: string;
+          visible: boolean;
+        },
+  ): void;
+
+  setupRibbonMenuItem(menuId: string, visible: boolean, config?: RibbonMenuItemVisibility): void;
+
+  setupRibbonTitleBar(visible: boolean): void;
+
+  showRibbonMenu(): void;
+
+  hideRibbonMenu(): void;
+
+  showRibbonMenuItem(menuId: string, config?: RibbonMenuItemVisibility): void;
+
+  hideRibbonMenuItem(menuId: string, config?: RibbonMenuItemVisibility): void;
+
+  showRibbonTitleBar(): void;
+
+  hideRibbonTitleBar(): void;
+
+  selectRibbonMenu(menuId: string): void;
+
+  setRibbonMenuButtonStyle(buttonId: string, buttonStyle: MenuActionButtonStyle): void;
+
+  setWatermark(fields: IWatermark | unknown): void;
+
+  setCompactMode(compact: boolean): void;
+
+  enterBookViewMode(callback?: () => void): void;
+
+  exitBookViewMode(): void;
+
+  isBookViewActivated(): boolean;
+
+  requestFullScreen(): void;
+
+  exitFullScreen(): void;
+
+  invalidateView(): void;
+}

package/src/api/watermark.ts

@@ -0,0 +1,35 @@
+export interface IWatermarkTextStyle {
+  size?: number;
+  color?: string;
+  compact?: boolean;
+  rotation?: number;
+  opacity?: number;
+
+  hex(color: string): IWatermarkTextStyle;
+
+  rgb(r: number, g: number, b: number): IWatermarkTextStyle;
+
+  rgba(r: number, g: number, b: number, a: number): IWatermarkTextStyle;
+}
+
+export enum WatermarkDisplay {
+  DEFAULT = 'default',
+  COMPACT = 'compact',
+  HIDE = 'none',
+}
+
+export interface IWatermark {
+  text?: string;
+
+  sparseRatio?: number;
+
+  display?: WatermarkDisplay;
+
+  config?: IWatermarkTextStyle;
+
+  setDisplay(display: WatermarkDisplay): void;
+
+  setText(text: string, style?: IWatermarkTextStyle): void;
+
+  setSparseRatio(sparseRatio: number): void;
+}

package/src/index.ts

@@ -0,0 +1,22 @@
+export * from './api/common';
+export * from './api/callbacks';
+export * from './api/watermark';
+export * from './api/menu-visibility';
+export * from './api/document-tool';
+export * from './api/annotation-tool';
+export * from './api/ui-tool';
+export * from './api/page-tool';
+export * from './api/find-tool';
+export * from './api/sign-tool';
+export * from './api/sign-server';
+export * from './api/digital-sign-environment';
+export * from './api/networking-tool';
+export * from './api/ekey-tool';
+export * from './api/extension-tool';
+export * from './api/symbology-tool';
+export * from './api/template-sign';
+export * from './api/pdf-formfiller';
+export * from './api/review-tool';
+export * from './api/crypto-tool';
+export * from './api/document-sdk';
+export * from './viewer';