@verentis/sdk 0.2.3 → 0.2.4

package/dist/index.d.cts

@@ -81,6 +81,51 @@ interface VerentisBackendCredentialResponse extends VerentisMessage {
     credential?: AppBackendCredential;
     error?: string;
 }
+/** Nonsecret active-document metadata. CODE already holds its own scoped credential. */
+interface WopiContinuation {
+    sessionId: string;
+    workspaceId: string;
+    branch: string;
+    nodeId: string;
+    accessTokenTtl: number;
+    fileId: string;
+    format: string;
+    readOnly: boolean;
+    name: string;
+}
+/** Initial document-scoped collaboration authority, never a platform OAuth credential. */
+interface WopiLaunch extends WopiContinuation {
+    action: string;
+    accessToken: string;
+    editorOrigin: string;
+    wopiSource: string;
+}
+interface WopiSaveCheckpoint {
+    generation: number;
+    correlation: string;
+    revision?: string | null;
+}
+interface WopiSaveStatus {
+    state: string;
+    revision: string;
+    readOnly: boolean;
+    receipt: WopiSaveCheckpoint | null;
+    continuationAvailable?: boolean;
+}
+interface VerentisWopiRequest extends VerentisMessage {
+    type: 'verentis:wopi:request';
+    requestId: string;
+    sessionId: string;
+    operation: 'launch' | 'status' | 'save' | 'close' | 'continue';
+    generation?: number;
+}
+interface VerentisWopiResponse extends VerentisMessage {
+    type: 'verentis:wopi:response';
+    requestId: string;
+    sessionId: string;
+    result?: WopiLaunch | WopiContinuation | WopiSaveCheckpoint | WopiSaveStatus | null;
+    error?: string;
+}
 interface VerentisFileChangedMessage extends VerentisMessage {
     type: 'verentis:file:changed';
     path: string;
@@ -118,8 +163,8 @@ interface VerentisDirtyMessage extends VerentisMessage {
     type: 'verentis:dirty';
     isDirty: boolean;
 }
-type HostToAppMessage = VerentisInitMessage | VerentisActionInvokeMessage | VerentisTokenRefreshedMessage | VerentisFileChangedMessage | VerentisThemeMessage | VerentisBackendCredentialResponse;
-type AppToHostMessage = VerentisReadyMessage | VerentisActionsSetMessage | VerentisActionResultMessage | VerentisTokenRefreshMessage | VerentisNavigateMessage | VerentisResizeMessage | VerentisTitleMessage | VerentisDirtyMessage | VerentisBackendCredentialRequest;
+type HostToAppMessage = VerentisInitMessage | VerentisActionInvokeMessage | VerentisTokenRefreshedMessage | VerentisFileChangedMessage | VerentisThemeMessage | VerentisBackendCredentialResponse | VerentisWopiResponse;
+type AppToHostMessage = VerentisReadyMessage | VerentisActionsSetMessage | VerentisActionResultMessage | VerentisTokenRefreshMessage | VerentisNavigateMessage | VerentisResizeMessage | VerentisTitleMessage | VerentisDirtyMessage | VerentisBackendCredentialRequest | VerentisWopiRequest;
 type AppSurface = 'file' | 'workspace';
 interface AppContextBase {
     workspace: WorkspaceInfo;
@@ -127,8 +172,9 @@ interface AppContextBase {
     apiUrl: string;
     installation?: {
         id: string;
-        backendClientId: string;
-        authorizationGeneration: string;
+        backendClientId?: string;
+        authorizationGeneration?: string;
+        wopiEnabled?: boolean;
     };
 }
 /** Context for an application opened against a workspace file. */
@@ -1033,6 +1079,7 @@ declare class Bridge {
     private actions;
     private requests;
     private backendRequests;
+    private wopiRequests;
     constructor(expectedHostOrigin?: string | undefined);
     /** Post `verentis:ready` to the host to start the handshake */
     sendReady(capabilities?: string[]): void;
@@ -1063,6 +1110,14 @@ declare class Bridge {
     setDirty(isDirty: boolean): void;
     /** The host, not the app, selects the installation, file, branch and permission ceiling. */
     requestBackendCredential(): Promise<AppBackendCredential>;
+    /** The trusted parent selects the approved installation, document and action. */
+    requestWopiLaunch(): Promise<WopiLaunch>;
+    /** Recover only the target selected by a completed server-owned derived operation. */
+    requestWopiContinuation(): Promise<WopiContinuation>;
+    getWopiStatus(): Promise<WopiSaveStatus>;
+    requestWopiSave(generation: number): Promise<WopiSaveCheckpoint>;
+    closeWopiSession(): Promise<void>;
+    private requestWopi;
     registerAction(descriptor: HeaderAction, handler: HeaderActionHandler): HeaderActionRegistration;
     private publishActions;
     private invokeAction;
@@ -1202,4 +1257,4 @@ declare class BridgeAuth implements AuthStrategy {
  */
 declare function createVerentisClient(options?: VerentisClientOptions): VerentisClient;
 
-export { ApiError, ApiKeyAuth, type AppBackendCredential, type AppContext, type AppSurface, type AppToHostMessage, type ApplicationDisplayOptions, type ApplicationEntryPoint, type ApplicationFileType, type ApplicationLaunchConfig, type ApplicationManifest, type ApplicationSpec, type ArchiveFormat, type AuthOptions, type AuthStrategy, Bridge, BridgeAuth, type CatalogImage, ContextModule, type DeleteFileOptions, type EngineFileType, type EngineRuntime, type EngineTool, EnginesModule, type EntryPointInfo, type ExecuteEngineOptions, type Execution, type ExecutionEngine, type ExecutionEngineListOptions, type ExecutionListOptions, type ExecutionLogs, type ExecutionMode, type ExecutionResult, type ExecutionScopedOptions, type ExecutionStatus, type ExecutionTrigger, ExecutionsModule, type ExtractUploadOptions, type FileAppContext, type FileEntry, type FileInfo, FilesModule, type GetFileOptions, type HeaderAction, type HeaderActionHandler, type HeaderActionRegistration, type HeaderActionResult, type HostToAppMessage, HttpTransport, type Installation, type InstallationDetail, type InstallationLifecycleResult, type InstallationListOptions, type InstallationMode, type InstallationScopedOptions, type InstallationStatus, InstallationsModule, type InstalledPackageDescriptor, type InstalledPackagePayload, type ManifestMetadata, type MimeTypeBinding, type MoveFileOptions, type NamespacedSettings, type NavigateOptions, type OAuthConfig, type PagedResult, type ReadArchiveOptions, type RequestOptions, type ResolveInstallationOptions, type ResourceMimeTypeBinding, type ResourceRegistration, type ResourceScopedOptions, ResourcesModule, type RunFileOptions, type SandboxOptions, type SettingDeclaration, type SettingDeclarationType, type SettingGroup, type SettingItem, type SettingOption, type SettingPresence, SettingsModule, type SettingsScopedOptions, TokenAuth, type TokenInfo, type UpdateInstallationOptions, type VerentisActionInvokeMessage, type VerentisActionResultMessage, type VerentisActionsSetMessage, type VerentisBackendCredentialRequest, type VerentisBackendCredentialResponse, VerentisClient, type VerentisClientOptions, type VerentisDirtyMessage, type VerentisFileChangedMessage, type VerentisInitMessage, type VerentisMessage, type VerentisNavigateMessage, type VerentisReadyMessage, type VerentisResizeMessage, type VerentisThemeMessage, type VerentisTitleMessage, type VerentisTokenRefreshMessage, type VerentisTokenRefreshedMessage, type WaitOptions, type WorkspaceAppContext, type WorkspaceInfo, type WriteFileOptions, createVerentisClient, findBestMatch, isHeaderAction, isTerminalStatus, matchMimeType };
+export { ApiError, ApiKeyAuth, type AppBackendCredential, type AppContext, type AppSurface, type AppToHostMessage, type ApplicationDisplayOptions, type ApplicationEntryPoint, type ApplicationFileType, type ApplicationLaunchConfig, type ApplicationManifest, type ApplicationSpec, type ArchiveFormat, type AuthOptions, type AuthStrategy, Bridge, BridgeAuth, type CatalogImage, ContextModule, type DeleteFileOptions, type EngineFileType, type EngineRuntime, type EngineTool, EnginesModule, type EntryPointInfo, type ExecuteEngineOptions, type Execution, type ExecutionEngine, type ExecutionEngineListOptions, type ExecutionListOptions, type ExecutionLogs, type ExecutionMode, type ExecutionResult, type ExecutionScopedOptions, type ExecutionStatus, type ExecutionTrigger, ExecutionsModule, type ExtractUploadOptions, type FileAppContext, type FileEntry, type FileInfo, FilesModule, type GetFileOptions, type HeaderAction, type HeaderActionHandler, type HeaderActionRegistration, type HeaderActionResult, type HostToAppMessage, HttpTransport, type Installation, type InstallationDetail, type InstallationLifecycleResult, type InstallationListOptions, type InstallationMode, type InstallationScopedOptions, type InstallationStatus, InstallationsModule, type InstalledPackageDescriptor, type InstalledPackagePayload, type ManifestMetadata, type MimeTypeBinding, type MoveFileOptions, type NamespacedSettings, type NavigateOptions, type OAuthConfig, type PagedResult, type ReadArchiveOptions, type RequestOptions, type ResolveInstallationOptions, type ResourceMimeTypeBinding, type ResourceRegistration, type ResourceScopedOptions, ResourcesModule, type RunFileOptions, type SandboxOptions, type SettingDeclaration, type SettingDeclarationType, type SettingGroup, type SettingItem, type SettingOption, type SettingPresence, SettingsModule, type SettingsScopedOptions, TokenAuth, type TokenInfo, type UpdateInstallationOptions, type VerentisActionInvokeMessage, type VerentisActionResultMessage, type VerentisActionsSetMessage, type VerentisBackendCredentialRequest, type VerentisBackendCredentialResponse, VerentisClient, type VerentisClientOptions, type VerentisDirtyMessage, type VerentisFileChangedMessage, type VerentisInitMessage, type VerentisMessage, type VerentisNavigateMessage, type VerentisReadyMessage, type VerentisResizeMessage, type VerentisThemeMessage, type VerentisTitleMessage, type VerentisTokenRefreshMessage, type VerentisTokenRefreshedMessage, type VerentisWopiRequest, type VerentisWopiResponse, type WaitOptions, type WopiContinuation, type WopiLaunch, type WopiSaveCheckpoint, type WopiSaveStatus, type WorkspaceAppContext, type WorkspaceInfo, type WriteFileOptions, createVerentisClient, findBestMatch, isHeaderAction, isTerminalStatus, matchMimeType };

package/dist/index.d.ts

@@ -81,6 +81,51 @@ interface VerentisBackendCredentialResponse extends VerentisMessage {
     credential?: AppBackendCredential;
     error?: string;
 }
+/** Nonsecret active-document metadata. CODE already holds its own scoped credential. */
+interface WopiContinuation {
+    sessionId: string;
+    workspaceId: string;
+    branch: string;
+    nodeId: string;
+    accessTokenTtl: number;
+    fileId: string;
+    format: string;
+    readOnly: boolean;
+    name: string;
+}
+/** Initial document-scoped collaboration authority, never a platform OAuth credential. */
+interface WopiLaunch extends WopiContinuation {
+    action: string;
+    accessToken: string;
+    editorOrigin: string;
+    wopiSource: string;
+}
+interface WopiSaveCheckpoint {
+    generation: number;
+    correlation: string;
+    revision?: string | null;
+}
+interface WopiSaveStatus {
+    state: string;
+    revision: string;
+    readOnly: boolean;
+    receipt: WopiSaveCheckpoint | null;
+    continuationAvailable?: boolean;
+}
+interface VerentisWopiRequest extends VerentisMessage {
+    type: 'verentis:wopi:request';
+    requestId: string;
+    sessionId: string;
+    operation: 'launch' | 'status' | 'save' | 'close' | 'continue';
+    generation?: number;
+}
+interface VerentisWopiResponse extends VerentisMessage {
+    type: 'verentis:wopi:response';
+    requestId: string;
+    sessionId: string;
+    result?: WopiLaunch | WopiContinuation | WopiSaveCheckpoint | WopiSaveStatus | null;
+    error?: string;
+}
 interface VerentisFileChangedMessage extends VerentisMessage {
     type: 'verentis:file:changed';
     path: string;
@@ -118,8 +163,8 @@ interface VerentisDirtyMessage extends VerentisMessage {
     type: 'verentis:dirty';
     isDirty: boolean;
 }
-type HostToAppMessage = VerentisInitMessage | VerentisActionInvokeMessage | VerentisTokenRefreshedMessage | VerentisFileChangedMessage | VerentisThemeMessage | VerentisBackendCredentialResponse;
-type AppToHostMessage = VerentisReadyMessage | VerentisActionsSetMessage | VerentisActionResultMessage | VerentisTokenRefreshMessage | VerentisNavigateMessage | VerentisResizeMessage | VerentisTitleMessage | VerentisDirtyMessage | VerentisBackendCredentialRequest;
+type HostToAppMessage = VerentisInitMessage | VerentisActionInvokeMessage | VerentisTokenRefreshedMessage | VerentisFileChangedMessage | VerentisThemeMessage | VerentisBackendCredentialResponse | VerentisWopiResponse;
+type AppToHostMessage = VerentisReadyMessage | VerentisActionsSetMessage | VerentisActionResultMessage | VerentisTokenRefreshMessage | VerentisNavigateMessage | VerentisResizeMessage | VerentisTitleMessage | VerentisDirtyMessage | VerentisBackendCredentialRequest | VerentisWopiRequest;
 type AppSurface = 'file' | 'workspace';
 interface AppContextBase {
     workspace: WorkspaceInfo;
@@ -127,8 +172,9 @@ interface AppContextBase {
     apiUrl: string;
     installation?: {
         id: string;
-        backendClientId: string;
-        authorizationGeneration: string;
+        backendClientId?: string;
+        authorizationGeneration?: string;
+        wopiEnabled?: boolean;
     };
 }
 /** Context for an application opened against a workspace file. */
@@ -1033,6 +1079,7 @@ declare class Bridge {
     private actions;
     private requests;
     private backendRequests;
+    private wopiRequests;
     constructor(expectedHostOrigin?: string | undefined);
     /** Post `verentis:ready` to the host to start the handshake */
     sendReady(capabilities?: string[]): void;
@@ -1063,6 +1110,14 @@ declare class Bridge {
     setDirty(isDirty: boolean): void;
     /** The host, not the app, selects the installation, file, branch and permission ceiling. */
     requestBackendCredential(): Promise<AppBackendCredential>;
+    /** The trusted parent selects the approved installation, document and action. */
+    requestWopiLaunch(): Promise<WopiLaunch>;
+    /** Recover only the target selected by a completed server-owned derived operation. */
+    requestWopiContinuation(): Promise<WopiContinuation>;
+    getWopiStatus(): Promise<WopiSaveStatus>;
+    requestWopiSave(generation: number): Promise<WopiSaveCheckpoint>;
+    closeWopiSession(): Promise<void>;
+    private requestWopi;
     registerAction(descriptor: HeaderAction, handler: HeaderActionHandler): HeaderActionRegistration;
     private publishActions;
     private invokeAction;
@@ -1202,4 +1257,4 @@ declare class BridgeAuth implements AuthStrategy {
  */
 declare function createVerentisClient(options?: VerentisClientOptions): VerentisClient;
 
-export { ApiError, ApiKeyAuth, type AppBackendCredential, type AppContext, type AppSurface, type AppToHostMessage, type ApplicationDisplayOptions, type ApplicationEntryPoint, type ApplicationFileType, type ApplicationLaunchConfig, type ApplicationManifest, type ApplicationSpec, type ArchiveFormat, type AuthOptions, type AuthStrategy, Bridge, BridgeAuth, type CatalogImage, ContextModule, type DeleteFileOptions, type EngineFileType, type EngineRuntime, type EngineTool, EnginesModule, type EntryPointInfo, type ExecuteEngineOptions, type Execution, type ExecutionEngine, type ExecutionEngineListOptions, type ExecutionListOptions, type ExecutionLogs, type ExecutionMode, type ExecutionResult, type ExecutionScopedOptions, type ExecutionStatus, type ExecutionTrigger, ExecutionsModule, type ExtractUploadOptions, type FileAppContext, type FileEntry, type FileInfo, FilesModule, type GetFileOptions, type HeaderAction, type HeaderActionHandler, type HeaderActionRegistration, type HeaderActionResult, type HostToAppMessage, HttpTransport, type Installation, type InstallationDetail, type InstallationLifecycleResult, type InstallationListOptions, type InstallationMode, type InstallationScopedOptions, type InstallationStatus, InstallationsModule, type InstalledPackageDescriptor, type InstalledPackagePayload, type ManifestMetadata, type MimeTypeBinding, type MoveFileOptions, type NamespacedSettings, type NavigateOptions, type OAuthConfig, type PagedResult, type ReadArchiveOptions, type RequestOptions, type ResolveInstallationOptions, type ResourceMimeTypeBinding, type ResourceRegistration, type ResourceScopedOptions, ResourcesModule, type RunFileOptions, type SandboxOptions, type SettingDeclaration, type SettingDeclarationType, type SettingGroup, type SettingItem, type SettingOption, type SettingPresence, SettingsModule, type SettingsScopedOptions, TokenAuth, type TokenInfo, type UpdateInstallationOptions, type VerentisActionInvokeMessage, type VerentisActionResultMessage, type VerentisActionsSetMessage, type VerentisBackendCredentialRequest, type VerentisBackendCredentialResponse, VerentisClient, type VerentisClientOptions, type VerentisDirtyMessage, type VerentisFileChangedMessage, type VerentisInitMessage, type VerentisMessage, type VerentisNavigateMessage, type VerentisReadyMessage, type VerentisResizeMessage, type VerentisThemeMessage, type VerentisTitleMessage, type VerentisTokenRefreshMessage, type VerentisTokenRefreshedMessage, type WaitOptions, type WorkspaceAppContext, type WorkspaceInfo, type WriteFileOptions, createVerentisClient, findBestMatch, isHeaderAction, isTerminalStatus, matchMimeType };
+export { ApiError, ApiKeyAuth, type AppBackendCredential, type AppContext, type AppSurface, type AppToHostMessage, type ApplicationDisplayOptions, type ApplicationEntryPoint, type ApplicationFileType, type ApplicationLaunchConfig, type ApplicationManifest, type ApplicationSpec, type ArchiveFormat, type AuthOptions, type AuthStrategy, Bridge, BridgeAuth, type CatalogImage, ContextModule, type DeleteFileOptions, type EngineFileType, type EngineRuntime, type EngineTool, EnginesModule, type EntryPointInfo, type ExecuteEngineOptions, type Execution, type ExecutionEngine, type ExecutionEngineListOptions, type ExecutionListOptions, type ExecutionLogs, type ExecutionMode, type ExecutionResult, type ExecutionScopedOptions, type ExecutionStatus, type ExecutionTrigger, ExecutionsModule, type ExtractUploadOptions, type FileAppContext, type FileEntry, type FileInfo, FilesModule, type GetFileOptions, type HeaderAction, type HeaderActionHandler, type HeaderActionRegistration, type HeaderActionResult, type HostToAppMessage, HttpTransport, type Installation, type InstallationDetail, type InstallationLifecycleResult, type InstallationListOptions, type InstallationMode, type InstallationScopedOptions, type InstallationStatus, InstallationsModule, type InstalledPackageDescriptor, type InstalledPackagePayload, type ManifestMetadata, type MimeTypeBinding, type MoveFileOptions, type NamespacedSettings, type NavigateOptions, type OAuthConfig, type PagedResult, type ReadArchiveOptions, type RequestOptions, type ResolveInstallationOptions, type ResourceMimeTypeBinding, type ResourceRegistration, type ResourceScopedOptions, ResourcesModule, type RunFileOptions, type SandboxOptions, type SettingDeclaration, type SettingDeclarationType, type SettingGroup, type SettingItem, type SettingOption, type SettingPresence, SettingsModule, type SettingsScopedOptions, TokenAuth, type TokenInfo, type UpdateInstallationOptions, type VerentisActionInvokeMessage, type VerentisActionResultMessage, type VerentisActionsSetMessage, type VerentisBackendCredentialRequest, type VerentisBackendCredentialResponse, VerentisClient, type VerentisClientOptions, type VerentisDirtyMessage, type VerentisFileChangedMessage, type VerentisInitMessage, type VerentisMessage, type VerentisNavigateMessage, type VerentisReadyMessage, type VerentisResizeMessage, type VerentisThemeMessage, type VerentisTitleMessage, type VerentisTokenRefreshMessage, type VerentisTokenRefreshedMessage, type VerentisWopiRequest, type VerentisWopiResponse, type WaitOptions, type WopiContinuation, type WopiLaunch, type WopiSaveCheckpoint, type WopiSaveStatus, type WorkspaceAppContext, type WorkspaceInfo, type WriteFileOptions, createVerentisClient, findBestMatch, isHeaderAction, isTerminalStatus, matchMimeType };

package/dist/index.js

@@ -807,6 +807,7 @@ var Bridge = class {
   actions = /* @__PURE__ */ new Map();
   requests = /* @__PURE__ */ new Set();
   backendRequests = /* @__PURE__ */ new Map();
+  wopiRequests = /* @__PURE__ */ new Map();
   /** Post `verentis:ready` to the host to start the handshake */
   sendReady(capabilities) {
     console.info("[Verentis SDK] Sending verentis:ready to host");
@@ -815,7 +816,7 @@ var Bridge = class {
       version: 1,
       capabilities
     };
-    window.parent.postMessage(message, "*");
+    window.parent.postMessage(message, this.expectedHostOrigin ?? "*");
   }
   /** Wait for the host to send `verentis:init` with context and token */
   waitForInit() {
@@ -890,6 +891,53 @@ var Bridge = class {
       }
     });
   }
+  /** The trusted parent selects the approved installation, document and action. */
+  requestWopiLaunch() {
+    return this.requestWopi("launch");
+  }
+  /** Recover only the target selected by a completed server-owned derived operation. */
+  requestWopiContinuation() {
+    return this.requestWopi("continue");
+  }
+  getWopiStatus() {
+    return this.requestWopi("status");
+  }
+  requestWopiSave(generation) {
+    if (!Number.isSafeInteger(generation) || generation < 0)
+      return Promise.reject(new Error("Invalid edit generation."));
+    return this.requestWopi("save", generation);
+  }
+  closeWopiSession() {
+    return this.requestWopi("close");
+  }
+  requestWopi(operation, generation) {
+    if (this._destroyed || !this.sessionId || !this._hostOrigin)
+      return Promise.reject(new Error("An initialized workspace host is required."));
+    if (this.wopiRequests.size >= 4)
+      return Promise.reject(new Error("Too many collaboration requests."));
+    const requestId = crypto.randomUUID();
+    return new Promise((resolve, reject) => {
+      const timer = setTimeout(() => {
+        this.wopiRequests.delete(requestId);
+        reject(new Error("Collaboration authorization timed out."));
+      }, 3e4);
+      this.wopiRequests.set(requestId, { resolve, reject, timer });
+      try {
+        this.postToHost({
+          type: "verentis:wopi:request",
+          version: 1,
+          requestId,
+          sessionId: this.sessionId,
+          operation,
+          ...generation === void 0 ? {} : { generation }
+        });
+      } catch {
+        clearTimeout(timer);
+        this.wopiRequests.delete(requestId);
+        reject(new Error("The workspace host is unavailable."));
+      }
+    });
+  }
   registerAction(descriptor, handler) {
     if (!this.sessionId || this._destroyed) throw new Error("Header actions require an initialized workspace host.");
     if (!isHeaderAction(descriptor)) throw new Error("Invalid header action.");
@@ -977,6 +1025,11 @@ var Bridge = class {
       pending.reject(new Error("Bridge has been destroyed."));
     }
     this.backendRequests.clear();
+    for (const pending of this.wopiRequests.values()) {
+      clearTimeout(pending.timer);
+      pending.reject(new Error("Bridge has been destroyed."));
+    }
+    this.wopiRequests.clear();
     if (typeof window !== "undefined") {
       window.removeEventListener("message", this._messageHandler);
     }
@@ -1014,6 +1067,17 @@ var Bridge = class {
       else pending.resolve(value);
       return;
     }
+    if (data.type === "verentis:wopi:response") {
+      if (!this._hostOrigin || data.sessionId !== this.sessionId) return;
+      const pending = this.wopiRequests.get(data.requestId);
+      if (!pending) return;
+      clearTimeout(pending.timer);
+      this.wopiRequests.delete(data.requestId);
+      if (data.error || !Object.hasOwn(data, "result"))
+        pending.reject(new Error("Collaboration authorization is unavailable."));
+      else pending.resolve(data.result);
+      return;
+    }
     if (data.type === "verentis:action:invoke") {
       void this.invokeAction(data);
       return;