@rhc-office/sdk 6.6.385 → 6.6.387

package/dist/viewer/DocumentSDK.d.ts

@@ -71,6 +71,7 @@ export declare class DocumentSDK implements IDocumentSDK {
     readonly createKVField: IDocumentSDK['createKVField'];
     private readonly mountReader;
     private applyReaderRuntimeConfig;
+    private syncReaderRuntimeConfig;
     private restoreReaderRuntimeConfig;
     private readonly bindNativeReaderEvents;
     private readonly cleanupNativeEventForwarders;

package/dist/viewer/DocumentSDK.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DocumentSDK.d.ts","sourceRoot":"","sources":["../../src/viewer/DocumentSDK.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,YAAY,EAAmB,MAAM,qBAAqB,CAAC;AA+CzE,UAAU,yBAAyB;IACjC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAkND,qBAAa,WAAY,YAAW,YAAY;IAC9C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA4B;IACnD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA6B;IACvD,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA0B;IACtD,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAMhC;IACF,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAgD;IAC7E,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA0C;IACjE,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA4C;IACrE,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAmD;IACnF,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA4C;IACrE,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAkD;IACjF,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAmD;IACnF,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAiD;IAC/E,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAkD;IACjF,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAoD;IACrF,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAiD;IAC/E,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAkD;IACjF,OAAO,CAAC,QAAQ,CAAC,UAAU,CAA8C;IACzE,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAgD;IAE7E,OAAO,CAAC,QAAQ,CAAC,cAAc,CAA6B;IAC5D,OAAO,CAAC,QAAQ,CAAC,eAAe,CAA8B;IAE9D,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,UAAU,CAAK;IAEvB,OAAO,CAAC,mBAAmB,CAAC,CAAsB;IAClD,OAAO,CAAC,aAAa,CAA+B;IACpD,OAAO,CAAC,aAAa,CAA4B;IACjD,OAAO,CAAC,QAAQ,CAAuB;IACvC,OAAO,CAAC,uBAAuB,CAA6C;IAC5E,OAAO,CAAC,mBAAmB,CAGX;IAChB,OAAO,CAAC,WAAW,CAAC,CAAgD;IACpE,OAAO,CAAC,aAAa,CAAC,CAAkD;IACxE,OAAO,CAAC,WAAW,CAAC,CAAS;IAC7B,OAAO,CAAC,QAAQ,CAAC,2BAA2B,CAAyB;IACrE,OAAO,CAAC,YAAY,CAAmC;gBAE3C,OAAO,CAAC,EAAE,yBAAyB;IAO/C,QAAQ,CAAC,WAAW,EAAE,YAAY,CAAC,aAAa,CAAC,CAE/C;IAEF,QAAQ,CAAC,cAAc,EAAE,YAAY,CAAC,gBAAgB,CAAC,CAMrD;IAEF,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC,cAAc,CAAC,CAejD;IAEF,QAAQ,CAAC,cAAc,EAAE,YAAY,CAAC,gBAAgB,CAAC,CAErD;IAEF,QAAQ,CAAC,gBAAgB,EAAE,YAAY,CAAC,kBAAkB,CAAC,CAEzD;IAEF,QAAQ,CAAC,cAAc,EAAE,YAAY,CAAC,gBAAgB,CAAC,CAErD;IAEF,QAAQ,CAAC,aAAa,EAAE,YAAY,CAAC,eAAe,CAAC,CAEnD;IAEF,QAAQ,CAAC,iBAAiB,EAAE,YAAY,CAAC,mBAAmB,CAAC,CAE3D;IAEF,QAAQ,CAAC,sBAAsB,EAAE,YAAY,CAAC,wBAAwB,CAAC,CAErE;IAEF,QAAQ,CAAC,uBAAuB,EAAE,YAAY,CAAC,yBAAyB,CAAC,CAEvE;IAEF,QAAQ,CAAC,sBAAsB,EAAE,YAAY,CAAC,wBAAwB,CAAC,CAErE;IAEF,QAAQ,CAAC,WAAW,EAAE,YAAY,CAAC,aAAa,CAAC,CAgB/C;IAEF,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC,cAAc,CAAC,CA4BjD;IAEF,QAAQ,CAAC,eAAe,EAAE,YAAY,CAAC,iBAAiB,CAAC,CAEvD;IAEF,QAAQ,CAAC,SAAS,EAAE,YAAY,CAAC,WAAW,CAAC,CAE3C;IAEF,QAAQ,CAAC,WAAW,EAAE,YAAY,CAAC,aAAa,CAAC,CAE/C;IAEF,QAAQ,CAAC,kBAAkB,EAAE,YAAY,CAAC,oBAAoB,CAAC,CAE7D;IAEF,QAAQ,CAAC,WAAW,EAAE,YAAY,CAAC,aAAa,CAAC,CAE/C;IAEF,QAAQ,CAAC,iBAAiB,EAAE,YAAY,CAAC,mBAAmB,CAAC,CAE3D;IAEF,QAAQ,CAAC,kBAAkB,EAAE,YAAY,CAAC,oBAAoB,CAAC,CAE7D;IAEF,QAAQ,CAAC,gBAAgB,EAAE,YAAY,CAAC,kBAAkB,CAAC,CAEzD;IAEF,QAAQ,CAAC,iBAAiB,EAAE,YAAY,CAAC,mBAAmB,CAAC,CAE3D;IAEF,QAAQ,CAAC,mBAAmB,EAAE,YAAY,CAAC,qBAAqB,CAAC,CAE/D;IAEF,QAAQ,CAAC,gBAAgB,EAAE,YAAY,CAAC,kBAAkB,CAAC,CAEzD;IAEF,QAAQ,CAAC,iBAAiB,EAAE,YAAY,CAAC,mBAAmB,CAAC,CAE3D;IAEF,QAAQ,CAAC,aAAa,EAAE,YAAY,CAAC,eAAe,CAAC,CAEnD;IAEF,QAAQ,CAAC,eAAe,EAAE,YAAY,CAAC,iBAAiB,CAAC,CAEvD;IAEF,QAAQ,CAAC,wBAAwB,EAAE,YAAY,CAAC,0BAA0B,CAAC,CAEzE;IAEF,QAAQ,CAAC,aAAa,EAAE,YAAY,CAAC,eAAe,CAAC,CAEnD;IAEF,OAAO,CAAC,QAAQ,CAAC,WAAW,CAyD1B;IAEF,OAAO,CAAC,wBAAwB;IA0BhC,OAAO,CAAC,0BAA0B;IAclC,OAAO,CAAC,QAAQ,CAAC,sBAAsB,CAsCrC;IAEF,OAAO,CAAC,QAAQ,CAAC,4BAA4B,CAE3C;IAEF,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAGlC;IAEF,OAAO,CAAC,QAAQ,CAAC,eAAe,CAE9B;IAEF,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAOhC;IAEF,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAMjC;CACH;AAED,eAAO,MAAM,oBAAoB,GAAI,UAAU,yBAAyB,KAAG,YAE1E,CAAC"}
+{"version":3,"file":"DocumentSDK.d.ts","sourceRoot":"","sources":["../../src/viewer/DocumentSDK.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,YAAY,EAAmB,MAAM,qBAAqB,CAAC;AA+CzE,UAAU,yBAAyB;IACjC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAgQD,qBAAa,WAAY,YAAW,YAAY;IAC9C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA4B;IACnD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA6B;IACvD,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA0B;IACtD,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAMhC;IACF,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAgD;IAC7E,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA0C;IACjE,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA4C;IACrE,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAmD;IACnF,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA4C;IACrE,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAkD;IACjF,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAmD;IACnF,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAiD;IAC/E,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAkD;IACjF,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAoD;IACrF,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAiD;IAC/E,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAkD;IACjF,OAAO,CAAC,QAAQ,CAAC,UAAU,CAA8C;IACzE,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAgD;IAE7E,OAAO,CAAC,QAAQ,CAAC,cAAc,CAA6B;IAC5D,OAAO,CAAC,QAAQ,CAAC,eAAe,CAA8B;IAE9D,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,UAAU,CAAK;IAEvB,OAAO,CAAC,mBAAmB,CAAC,CAAsB;IAClD,OAAO,CAAC,aAAa,CAA+B;IACpD,OAAO,CAAC,aAAa,CAA4B;IACjD,OAAO,CAAC,QAAQ,CAAuB;IACvC,OAAO,CAAC,uBAAuB,CAA6C;IAC5E,OAAO,CAAC,mBAAmB,CAGX;IAChB,OAAO,CAAC,WAAW,CAAC,CAAgD;IACpE,OAAO,CAAC,aAAa,CAAC,CAAkD;IACxE,OAAO,CAAC,WAAW,CAAC,CAAS;IAC7B,OAAO,CAAC,QAAQ,CAAC,2BAA2B,CAAyB;IACrE,OAAO,CAAC,YAAY,CAAmC;gBAE3C,OAAO,CAAC,EAAE,yBAAyB;IAO/C,QAAQ,CAAC,WAAW,EAAE,YAAY,CAAC,aAAa,CAAC,CAE/C;IAEF,QAAQ,CAAC,cAAc,EAAE,YAAY,CAAC,gBAAgB,CAAC,CAMrD;IAEF,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC,cAAc,CAAC,CAejD;IAEF,QAAQ,CAAC,cAAc,EAAE,YAAY,CAAC,gBAAgB,CAAC,CAGrD;IAEF,QAAQ,CAAC,gBAAgB,EAAE,YAAY,CAAC,kBAAkB,CAAC,CAGzD;IAEF,QAAQ,CAAC,cAAc,EAAE,YAAY,CAAC,gBAAgB,CAAC,CAGrD;IAEF,QAAQ,CAAC,aAAa,EAAE,YAAY,CAAC,eAAe,CAAC,CAEnD;IAEF,QAAQ,CAAC,iBAAiB,EAAE,YAAY,CAAC,mBAAmB,CAAC,CAE3D;IAEF,QAAQ,CAAC,sBAAsB,EAAE,YAAY,CAAC,wBAAwB,CAAC,CAErE;IAEF,QAAQ,CAAC,uBAAuB,EAAE,YAAY,CAAC,yBAAyB,CAAC,CAEvE;IAEF,QAAQ,CAAC,sBAAsB,EAAE,YAAY,CAAC,wBAAwB,CAAC,CAErE;IAEF,QAAQ,CAAC,WAAW,EAAE,YAAY,CAAC,aAAa,CAAC,CAgB/C;IAEF,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC,cAAc,CAAC,CA4BjD;IAEF,QAAQ,CAAC,eAAe,EAAE,YAAY,CAAC,iBAAiB,CAAC,CAEvD;IAEF,QAAQ,CAAC,SAAS,EAAE,YAAY,CAAC,WAAW,CAAC,CAE3C;IAEF,QAAQ,CAAC,WAAW,EAAE,YAAY,CAAC,aAAa,CAAC,CAE/C;IAEF,QAAQ,CAAC,kBAAkB,EAAE,YAAY,CAAC,oBAAoB,CAAC,CAE7D;IAEF,QAAQ,CAAC,WAAW,EAAE,YAAY,CAAC,aAAa,CAAC,CAE/C;IAEF,QAAQ,CAAC,iBAAiB,EAAE,YAAY,CAAC,mBAAmB,CAAC,CAE3D;IAEF,QAAQ,CAAC,kBAAkB,EAAE,YAAY,CAAC,oBAAoB,CAAC,CAE7D;IAEF,QAAQ,CAAC,gBAAgB,EAAE,YAAY,CAAC,kBAAkB,CAAC,CAEzD;IAEF,QAAQ,CAAC,iBAAiB,EAAE,YAAY,CAAC,mBAAmB,CAAC,CAE3D;IAEF,QAAQ,CAAC,mBAAmB,EAAE,YAAY,CAAC,qBAAqB,CAAC,CAE/D;IAEF,QAAQ,CAAC,gBAAgB,EAAE,YAAY,CAAC,kBAAkB,CAAC,CAEzD;IAEF,QAAQ,CAAC,iBAAiB,EAAE,YAAY,CAAC,mBAAmB,CAAC,CAE3D;IAEF,QAAQ,CAAC,aAAa,EAAE,YAAY,CAAC,eAAe,CAAC,CAEnD;IAEF,QAAQ,CAAC,eAAe,EAAE,YAAY,CAAC,iBAAiB,CAAC,CAEvD;IAEF,QAAQ,CAAC,wBAAwB,EAAE,YAAY,CAAC,0BAA0B,CAAC,CAEzE;IAEF,QAAQ,CAAC,aAAa,EAAE,YAAY,CAAC,eAAe,CAAC,CAEnD;IAEF,OAAO,CAAC,QAAQ,CAAC,WAAW,CAyD1B;IAEF,OAAO,CAAC,wBAAwB;IAiChC,OAAO,CAAC,uBAAuB;IA2C/B,OAAO,CAAC,0BAA0B;IAclC,OAAO,CAAC,QAAQ,CAAC,sBAAsB,CAsCrC;IAEF,OAAO,CAAC,QAAQ,CAAC,4BAA4B,CAE3C;IAEF,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAGlC;IAEF,OAAO,CAAC,QAAQ,CAAC,eAAe,CAE9B;IAEF,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAOhC;IAEF,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAMjC;CACH;AAED,eAAO,MAAM,oBAAoB,GAAI,UAAU,yBAAyB,KAAG,YAE1E,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rhc-office/sdk",
-  "version": "6.6.385",
+  "version": "6.6.387",
   "description": "SDK for third-party integration with RHC Office Platform",
   "type": "module",
   "main": "dist/index.js",

package/src/api/annotation-tool.ts

@@ -173,6 +173,7 @@ export interface AnnotationPenStyleOptions {
 
 export interface AnnotationToolSelectOptions {
   stamp?: AnnotationStampOptions;
+  textBox?: AnnotationTextBoxOptions;
 }
 
 export type AnnotationType =

package/src/viewer/DocumentSDK.ts

@@ -57,14 +57,21 @@ type ReaderHostRuntimeKind = 'server' | 'browser-static' | 'mobile-webview' | 'd
 
 interface ReaderHostRuntimeConfig {
   hostKind?: ReaderHostRuntimeKind | (string & {});
+  embedOptions?: {
+    canDownload?: boolean;
+    canOpenNewFile?: boolean;
+    canPrint?: boolean;
+  };
   server?: {
     baseUrl?: string;
     paths?: Record<string, string | undefined>;
   };
   identity?: {
+    feature?: string;
     sessionUser?: string;
     sessionUserId?: string;
   };
+  sessionData?: string;
 }
 
 type NativeReaderEventName = 'documentLoaded' | 'documentStateChange' | 'documentError';
@@ -114,7 +121,9 @@ const createReaderPayload = (
 const normalizeSessionUserIdentity = (
   sessionUser: Parameters<IDocumentSDK['setSessionUser']>[0] | undefined,
   sessionUserId: Parameters<IDocumentSDK['setSessionUserId']>[0] | undefined,
-): ReaderHostRuntimeConfig['identity'] | undefined => {
+):
+  | Pick<NonNullable<ReaderHostRuntimeConfig['identity']>, 'sessionUser' | 'sessionUserId'>
+  | undefined => {
   if (!sessionUser) {
     return undefined;
   }
@@ -141,6 +150,43 @@ const normalizeSessionUserIdentity = (
   };
 };
 
+const normalizeReaderHostActivationFeature = (viewMode: string): string => {
+  const normalizedViewMode = viewMode
+    .trim()
+    .replace(/[-_\s]/g, '')
+    .toLowerCase();
+
+  if (normalizedViewMode === 'annotation') {
+    return 'ANNOTATION';
+  }
+
+  if (normalizedViewMode === 'digitalsign') {
+    return 'DIGITAL_SIGN';
+  }
+
+  return 'VIEW';
+};
+
+const normalizeEmbedRuntimeOptions = (
+  configuration: NormalizedReaderEmbedOptions,
+): ReaderHostRuntimeConfig['embedOptions'] | undefined => {
+  const embedOptions: NonNullable<ReaderHostRuntimeConfig['embedOptions']> = {};
+
+  if (configuration.canOpenNewFile !== undefined) {
+    embedOptions.canOpenNewFile = configuration.canOpenNewFile;
+  }
+
+  if (configuration.canPrint !== undefined) {
+    embedOptions.canPrint = configuration.canPrint;
+  }
+
+  if (configuration.canDownload !== undefined) {
+    embedOptions.canDownload = configuration.canDownload;
+  }
+
+  return Object.keys(embedOptions).length > 0 ? embedOptions : undefined;
+};
+
 const resolveContainerElement = (container: string | HTMLDivElement): HTMLDivElement => {
   if (typeof container === 'string') {
     const element = document.getElementById(container);
@@ -348,14 +394,17 @@ export class DocumentSDK implements IDocumentSDK {
 
   readonly setSessionUser: IDocumentSDK['setSessionUser'] = (userNameOrInfo): void => {
     this.sessionUser = userNameOrInfo;
+    this.syncReaderRuntimeConfig();
   };
 
   readonly setSessionUserId: IDocumentSDK['setSessionUserId'] = (userId): void => {
     this.sessionUserId = userId;
+    this.syncReaderRuntimeConfig();
   };
 
   readonly setSessionData: IDocumentSDK['setSessionData'] = (sessionData): void => {
     this.sessionData = sessionData;
+    this.syncReaderRuntimeConfig();
   };
 
   readonly isReaderReady: IDocumentSDK['isReaderReady'] = (): boolean => {
@@ -554,13 +603,20 @@ export class DocumentSDK implements IDocumentSDK {
     configuration: NormalizedReaderEmbedOptions,
   ): void {
     this.restoreReaderRuntimeConfig();
-    const identity = normalizeSessionUserIdentity(this.sessionUser, this.sessionUserId);
+    const sessionIdentity = normalizeSessionUserIdentity(this.sessionUser, this.sessionUserId);
+    const identity: NonNullable<ReaderHostRuntimeConfig['identity']> = {
+      feature: normalizeReaderHostActivationFeature(configuration.viewMode),
+      ...(sessionIdentity ?? {}),
+    };
+    const embedOptions = normalizeEmbedRuntimeOptions(configuration);
     const readerHost: ReaderHostRuntimeConfig = {
       hostKind: 'server',
+      ...(embedOptions ? { embedOptions } : {}),
       server: {
         baseUrl: configuration.appUrl,
       },
-      ...(identity ? { identity } : {}),
+      identity,
+      ...(this.sessionData !== undefined ? { sessionData: this.sessionData } : {}),
     };
 
     const runtimeElement = readerElement as ReaderRuntimeElement;
@@ -575,6 +631,49 @@ export class DocumentSDK implements IDocumentSDK {
     browserGlobal[READER_RUNTIME_GLOBAL_KEY] = readerHost;
   }
 
+  private syncReaderRuntimeConfig(): void {
+    if (!this.readerElement || !this.normalizedConfiguration) {
+      return;
+    }
+
+    const runtimeElement = this.readerElement as ReaderRuntimeElement;
+    const currentRuntime = runtimeElement[READER_RUNTIME_PROPERTY_KEY];
+    if (!currentRuntime) {
+      return;
+    }
+
+    const sessionIdentity = normalizeSessionUserIdentity(this.sessionUser, this.sessionUserId);
+    const restIdentity = { ...(currentRuntime.identity ?? {}) };
+    delete restIdentity.sessionUser;
+    delete restIdentity.sessionUserId;
+    const identity: NonNullable<ReaderHostRuntimeConfig['identity']> = {
+      ...restIdentity,
+      feature: normalizeReaderHostActivationFeature(this.normalizedConfiguration.viewMode),
+      ...(sessionIdentity ?? {}),
+    };
+    const nextRuntime: ReaderHostRuntimeConfig = {
+      ...currentRuntime,
+      identity,
+      ...(this.sessionData !== undefined ? { sessionData: this.sessionData } : {}),
+    };
+
+    runtimeElement[READER_RUNTIME_PROPERTY_KEY] = nextRuntime;
+    (globalThis as ReaderRuntimeBrowserGlobal)[READER_RUNTIME_GLOBAL_KEY] = nextRuntime;
+
+    if (!this.isReady) {
+      return;
+    }
+
+    void this.bridge
+      .request('extension', 'updateReaderRuntimeConfig', {
+        identity,
+        ...(this.sessionData !== undefined ? { sessionData: this.sessionData } : {}),
+      })
+      .catch((error: unknown) => {
+        this.reportAdapterError(error);
+      });
+  }
+
   private restoreReaderRuntimeConfig(): void {
     if (!this.runtimeRestoreState) {
       return;