weboffice-js-sdk 2.0.5-beta.10 → 2.0.5-beta.12

package/README.md

@@ -47,6 +47,27 @@ connect({
 - `disableAiEntry` 为可选布尔值，透传到 iframe 内 `OfficeSDK` 的 AI 入口开关能力。
 - `theme` 为可选主题对象，宿主侧仅负责透传；未传时 iframe 内仍使用默认主题配置。
 
+### V2 统一编辑 / 预览入口
+
+V2 使用独立的 `connectV2()`，旧 `connect()` 保持兼容。V2 要求 `type` 和 `mode` 必填：
+
+```typescript
+import { connectV2 } from 'weboffice-js-sdk'
+
+const sdk = await connectV2({
+  fileId: 'your-file-id',
+  endpoint: 'https://your-shimo-endpoint',
+  signature: 'your-signature',
+  token: 'your-token',
+  container: document.querySelector('#shimo-file'),
+  type: 'writer',
+  mode: 'edit',
+  refreshCredentialsInterval: 600000
+})
+```
+
+支持的 `type` 包括 `file`、`document`、`documentPro`、`writer`、`spreadsheet`、`presentation`、`table` 和 `form`。`writer` 与 `documentPro` 当前共存，`writer` 目前处于内测阶段。当前 `type` 主要作为 iframe 后续基于 `manifest.json` 选择资源的预留字段，不改变后端编辑准备判断。
+
 返回值：
 
 ```

package/dist/OfficeSDK.d.ts

@@ -9,7 +9,8 @@ import { Document, DocumentPro, Presentation, Spreadsheet, Table, Form, Flowchar
 import { EmptyPageOptions } from './types/EmptyPage';
 import { BaseEditor } from './types/BaseEditor';
 import { SlashMenuOptions } from './types/SlashMenu';
-import type { CollaboratorFacade, CommentsFacade, ContentFacade, DiscussionFacade, DocsActiveDocumentFacade, DocsOutlineFacade, DocsSearchFacade, DocsSelectionFacade, DocsSettingsFacade, DocsSidebarFacade, DocsTablesFacade, ExternalAppFacade, HistoryFacade, LocksFacade, MentionFacade, OfficeSDKPresentationFacade, PresentationEventSubscriptionFacade, PresentationSelectionFacade, PresentationSlidesFacade, PresentationTextFacade, PresentationZoomFacade, SheetChartsFacade, SheetSelectionsFacade, SheetWorkbookFacade, SheetWorksheetFacade, TitleFacade, VersionFacade } from './OfficeSDK.facade.types';
+import type { ContentVersion } from './types/ConnectV2';
+import type { CollaboratorFacade, CommentsFacade, ContentFacade, DiscussionFacade, DocsOutlineFacade, DocsSearchFacade, DocsSelectionFacade, DocsSettingsFacade, DocsSidebarFacade, DocsTablesFacade, ExternalAppFacade, HistoryFacade, LocksFacade, MentionFacade, OfficeSDKPresentationFacade, PresentationEventSubscriptionFacade, PresentationSelectionFacade, PresentationSlidesFacade, PresentationTextFacade, PresentationZoomFacade, SheetChartsFacade, SheetSelectionsFacade, SheetWorkbookFacade, SheetWorksheetFacade, TitleFacade, VersionFacade } from './OfficeSDK.facade.types';
 import type { HeaderBarsFacade } from './OfficeSDK.headerBars';
 export * from './OfficeSDK.facade.types';
 export * from './OfficeSDK.headerBars';
@@ -36,8 +37,6 @@ export declare class OfficeSDK extends TinyEmitter {
      * @deprecated - 用 `sdk.getEditor<T>()` 替代
      */
     spreadsheet?: Spreadsheet.Editor;
-    /** 当前轻文档的标准化、强类型文档入口。 */
-    ActiveDocument?: DocsActiveDocumentFacade;
     /**
      * 当前套件支持的标题能力。
      */
@@ -179,6 +178,7 @@ export declare class OfficeSDK extends TinyEmitter {
     private readonly emitter;
     private channel;
     private readonly connectOptions;
+    private readonly contentVersion?;
     private _readyState;
     private editor;
     private readonly startParams;
@@ -208,10 +208,15 @@ export declare class OfficeSDK extends TinyEmitter {
      * 归一化后的缺省页配置，构造时一次算完，后续仅读取。
      */
     private readonly normalizedEmptyPage;
+    private readonly preloadCredentialsMessageHandler;
+    private pendingInitializationErrorHandler?;
+    private pendingInitializationError?;
+    private preloadCredentialsPromise?;
+    private disconnected;
     private readonly preloadAckTimeoutMs;
     private readonly preloadDoneTimeoutMs;
     private readonly preloadReadyTimeoutMs;
-    constructor(options: OfficeSDKOptions);
+    constructor(options: OfficeSDKOptions, contentVersion?: ContentVersion);
     get fileType(): FileType;
     get readyState(): ReadyState;
     /**
@@ -280,6 +285,8 @@ export declare class OfficeSDK extends TinyEmitter {
      */
     ready(): Promise<void>;
     private initIframe;
+    private handlePreloadMessage;
+    private getPreloadCredentials;
     private runPreloadHandshake;
     private initChannel;
     /**
@@ -312,7 +319,6 @@ export declare class OfficeSDK extends TinyEmitter {
      * 输出：无。
      */
     private unregisterEditorFacadeCallback;
-    private reportEditorFacadeError;
     /**
      * 创建基于 method-path 的模块 facade。
      * 输入：模块前缀与少量自定义实现覆盖。

package/dist/OfficeSDK.facade.d.ts

@@ -10,7 +10,6 @@ interface FacadeHost {
     registerEditorFacadeListener<T>(method: string, listener: (payload: T) => void): () => void;
     registerEditorFacadeCallback(callback: EditorFacadeCallback): string;
     unregisterEditorFacadeCallback(callbackId: string): void;
-    reportEditorFacadeError(message: string, error: unknown): void;
 }
 export declare function buildRootFacadeState(host: FacadeHost): OfficeSDKRootFacadeState;
 export {};

package/dist/OfficeSDK.facade.types.d.ts

@@ -3,95 +3,6 @@ export interface TitleFacade {
     addChangedListener: (listener: (title: string) => void) => () => void;
     setTitle: (title: string) => Promise<void>;
 }
-/**
- * 可安全跨 iframe 传输的文档 Delta 快照。
- *
- * 这里只公开序列化结果和基础元数据，不承诺编辑器运行时对象上的
- * compose / transform 等方法。
- */
-export interface DocsEditorDeltaSnapshot {
-    length: number;
-    serialized: string;
-    stringify: () => string;
-}
-export interface DocsDocumentPermission {
-    read: boolean;
-    write: boolean;
-    comment: boolean;
-}
-export type DocsDownloadDocumentType = 'pdf' | 'word' | 'image' | 'md';
-export interface DocsProductFontFacade {
-    SetTextColor: (color: string) => Promise<boolean>;
-    SetHighLightColor: (color: string) => Promise<boolean>;
-    SetBold: (value?: boolean) => Promise<boolean>;
-    SetItalic: (value?: boolean) => Promise<boolean>;
-    SetUnderline: (value?: boolean) => Promise<boolean>;
-    SetStrike: (value?: boolean) => Promise<boolean>;
-}
-export interface DocsProductMarkdownFacade {
-    GetMarkdown: () => Promise<string>;
-    AppendMarkdown: (value: string) => Promise<DocsRangeValue>;
-    InsertMarkdown: (value: string) => Promise<DocsRangeValue>;
-    ValidateMarkdown: (value: string) => Promise<boolean>;
-}
-export interface DocsProductContentFacade {
-    ReplaceSelection: (value: string) => Promise<boolean>;
-    ReplaceAllContent: (value: string) => Promise<boolean>;
-}
-export interface DocsProductDocumentFacade {
-    GetContent: () => Promise<DocsEditorDeltaSnapshot>;
-    GetTitleContent: () => Promise<string>;
-    SetTitleContent: (title: string) => Promise<void>;
-    Font: DocsProductFontFacade;
-    Markdown: DocsProductMarkdownFacade;
-    Content: DocsProductContentFacade;
-}
-export interface DocsProductEditorFacade {
-    GetEditMode: () => Promise<string>;
-    Document: DocsProductDocumentFacade;
-}
-export interface DocsActiveDocumentFacade {
-    Editor: DocsProductEditorFacade;
-    Reference: DocsProductReferenceFacade;
-    Service: DocsProductServiceFacade;
-    Sub: DocsProductSubFacade;
-    Env: DocsProductEnvFacade;
-}
-/** 轻文档产品引用能力。 */
-export interface DocsProductReferenceFacade {
-    CanIUse: (scopes: string | string[]) => Promise<boolean>;
-}
-export interface DocsProductUserFacade {
-    GetUserInfo: () => Promise<unknown>;
-}
-export interface DocsProductPermissionFacade {
-    GetDocumentPermission: () => Promise<DocsDocumentPermission>;
-}
-export interface DocsProductExportFacade {
-    DownloadDocument: (format: DocsDownloadDocumentType) => Promise<void>;
-}
-export interface DocsProductCollaborationFacade {
-    GetSaveStatus: () => Promise<unknown>;
-}
-export interface DocsProductServiceFacade {
-    User: DocsProductUserFacade;
-    Permission: DocsProductPermissionFacade;
-    Export: DocsProductExportFacade;
-    Collaboration: DocsProductCollaborationFacade;
-}
-export interface DocsProductSubFacade {
-    OnDocumentChange: (handler: (delta: DocsEditorDeltaSnapshot) => void) => () => void;
-}
-export interface DocsProductLanguageFacade {
-    GetLanguage: () => Promise<string>;
-}
-export interface DocsProductModeFacade {
-    GetDocsMode: () => Promise<string>;
-}
-export interface DocsProductEnvFacade {
-    Language: DocsProductLanguageFacade;
-    DocsMode: DocsProductModeFacade;
-}
 export interface CommentsFacade {
     show: (type?: 'list' | 'card') => Promise<void>;
     hide: (type?: 'list' | 'card') => Promise<void>;
@@ -919,7 +830,6 @@ export interface PresentationEventSubscriptionFacade {
     addLoadedListener: (listener: () => void) => () => void;
 }
 export interface OfficeSDKRootFacadeState {
-    ActiveDocument?: DocsActiveDocumentFacade;
     title?: TitleFacade;
     history?: HistoryFacade;
     comments?: CommentsFacade;

package/dist/connect.d.ts

@@ -1,6 +1,19 @@
 import { OfficeSDK, OfficeSDKOptions } from './OfficeSDK';
+import { type ConnectV2FileType } from './types/ConnectV2';
+export { CONNECT_V2_FILE_TYPES, isConnectV2FileType, isConnectV2Mode, validateConnectV2Options } from './types/ConnectV2';
+export type { ConnectV2FileType } from './types/ConnectV2';
 export interface ConnectOptions extends OfficeSDKOptions {
 }
+export interface ConnectV2Options extends ConnectOptions {
+    /**
+     * V2 套件类型。当前用于 iframe 侧资源选择预留。
+     */
+    type: ConnectV2FileType;
+    /**
+     * V2 打开模式。
+     */
+    mode: 'edit' | 'preview';
+}
 /**
  * 初始化 SDK，返回 Promise，当 ReadState 变为 Ready 或 Failed 时，Promise 将被 resolve。
  * Promise resovled 不代表编辑器已经完整加载完毕，只代表 SDK 已经准备好了。
@@ -8,3 +21,9 @@ export interface ConnectOptions extends OfficeSDKOptions {
  * 比如受浏览器限制无法发出 postMessage() 时，Promise 将会一直 pending。
  */
 export declare function connect(options: ConnectOptions): Promise<OfficeSDK>;
+/**
+ * 初始化 V2 统一编辑 / 预览入口。
+ *
+ * V2 在运行时强制校验 type 和 mode，底层 iframe 初始化流程与旧 connect 共用。
+ */
+export declare function connectV2(options: ConnectV2Options): Promise<OfficeSDK>;

package/dist/editorFacade.contract.d.ts

@@ -1,4 +1,4 @@
-import type { AddChartFromSelectionResult, BasicPresentationFacade, DocsActiveDocumentFacade, DocsEditorDeltaSnapshot, DocsRangeFacade, DocsRangeValue, DocsTableFacade, EditorTextFormat, OfficeSDK, PresentationFacade, PresentationSlideFacade, PresentationShape, PresentationShapeBase, PresentationTableCell, PresentationTableItem, PresentationTableRange, PresentationTableSelection, PresentationTextShape, PresentationTextRangeFacade, PresentationTextRangeValue, SheetRangeValue, SheetRangeFacade, SheetSelection } from './OfficeSDK';
+import type { AddChartFromSelectionResult, BasicPresentationFacade, DocsRangeFacade, DocsRangeValue, DocsTableFacade, EditorTextFormat, OfficeSDK, PresentationFacade, PresentationSlideFacade, PresentationShape, PresentationShapeBase, PresentationTableCell, PresentationTableItem, PresentationTableRange, PresentationTableSelection, PresentationTextShape, PresentationTextRangeFacade, PresentationTextRangeValue, SheetRangeValue, SheetRangeFacade, SheetSelection } from './OfficeSDK';
 type IsAssignable<T, U> = T extends U ? true : false;
 type IsEqual<T, U> = (<V>() => V extends T ? 1 : 2) extends <V>() => V extends U ? 1 : 2 ? (<V>() => V extends U ? 1 : 2) extends <V>() => V extends T ? 1 : 2 ? true : false : false;
 type Assert<T extends true> = T;
@@ -11,12 +11,6 @@ type PresentationSelection = Extract<RootSelection, {
 }>;
 type RootPresentation = NonNullable<OfficeSDK['presentation']>;
 export type EditorFacadeContractAssertions = [
-    Assert<IsEqual<NonNullable<OfficeSDK['ActiveDocument']>, DocsActiveDocumentFacade>>,
-    Assert<IsEqual<DocsActiveDocumentFacade['Editor']['Document']['GetContent'], () => Promise<DocsEditorDeltaSnapshot>>>,
-    Assert<IsEqual<DocsActiveDocumentFacade['Editor']['Document']['Markdown']['AppendMarkdown'], (value: string) => Promise<DocsRangeValue>>>,
-    Assert<IsEqual<DocsActiveDocumentFacade['Service']['Permission']['GetDocumentPermission'], () => Promise<import('./OfficeSDK').DocsDocumentPermission>>>,
-    Assert<IsEqual<DocsActiveDocumentFacade['Service']['Export']['DownloadDocument'], (format: import('./OfficeSDK').DocsDownloadDocumentType) => Promise<void>>>,
-    Assert<IsEqual<DocsActiveDocumentFacade['Sub']['OnDocumentChange'], (handler: (delta: DocsEditorDeltaSnapshot) => void) => () => void>>,
     Assert<IsAssignable<NonNullable<OfficeSDK['title']>['setTitle'], (title: string) => Promise<void>>>,
     Assert<IsAssignable<NonNullable<OfficeSDK['title']>['addChangedListener'], (listener: (title: string) => void) => () => void>>,
     Assert<IsAssignable<NonNullable<OfficeSDK['locks']>['addRangeLock'], (options: import('./OfficeSDK').AddRangeLockParams) => Promise<void>>>,

package/dist/index.d.ts

@@ -8,7 +8,6 @@ import * as Flowchart from './types/FlowChart';
 import { EventMap as BaseEventMap, BaseEditor } from './types/BaseEditor';
 export * from 'weboffice-js-sdk-shared';
 export * from './connect';
-export type { JSAPIAdapter, JSAPIContract, JSAPIContractCatalog, JSAPITransport } from './jsapi';
 export * from './OfficeSDK';
 export type { EmptyPageScene, EmptyPageOptions, EmptyPageActionOverride, EmptyPageContentOverride, NormalizedEmptyPageOptions, EmptyPageShownPayload, EmptyPageActionPayload, EmptyPageHiddenPayload, FileOpenFailedReason, TokenExpiredStrategy } from './types/EmptyPage';
 export type { SlashMenuButton, SlashMenuEntry, SlashMenuOptions } from './types/SlashMenu';