weboffice-js-sdk 2.0.5-beta.14 → 2.0.5-beta.16

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,9 @@ 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 { ContentVersion } from './types/ConnectV2';
 import type { CollaboratorFacade, CommentsFacade, ContentFacade, DiscussionFacade, DocsActiveOutlineFacade, 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 { OfficeSDKMethodPath } from './OfficeSDK.methods';
 import type { HeaderBarsFacade } from './OfficeSDK.headerBars';
 export * from './OfficeSDK.facade.types';
 export * from './OfficeSDK.headerBars';
@@ -39,6 +41,10 @@ export declare class OfficeSDK extends TinyEmitter {
     spreadsheet?: Spreadsheet.Editor;
     /** 当前轻文档的标准化、强类型文档入口。 */
     ActiveOutline?: DocsActiveOutlineFacade;
+    /**
+     * 判断当前套件和 iframe runtime 是否支持指定的公开 SDK 方法。
+     */
+    canIUse(method: OfficeSDKMethodPath): Promise<boolean>;
     /**
      * 当前套件支持的标题能力。
      */
@@ -180,6 +186,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;
@@ -211,10 +218,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;
     /**
@@ -283,6 +295,8 @@ export declare class OfficeSDK extends TinyEmitter {
      */
     ready(): Promise<void>;
     private initIframe;
+    private handlePreloadMessage;
+    private getPreloadCredentials;
     private runPreloadHandshake;
     private initChannel;
     /**

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

@@ -52,15 +52,10 @@ export interface DocsProductEditorFacade {
 }
 export interface DocsActiveOutlineFacade {
     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>;
 }

package/dist/OfficeSDK.methods.d.ts

@@ -0,0 +1,67 @@
+/**
+ * SDK capability method identifiers.
+ *
+ * Values are public SDK method paths. Keeping the object tree aligned with the
+ * public facade makes the accepted canIUse arguments discoverable without
+ * exposing product-specific API namespaces.
+ */
+export declare const OfficeSDKMethods: {
+    readonly ActiveOutline: {
+        readonly Editor: {
+            readonly GetEditMode: "ActiveOutline.Editor.GetEditMode";
+            readonly Document: {
+                readonly GetContent: "ActiveOutline.Editor.Document.GetContent";
+                readonly GetTitleContent: "ActiveOutline.Editor.Document.GetTitleContent";
+                readonly SetTitleContent: "ActiveOutline.Editor.Document.SetTitleContent";
+                readonly Font: {
+                    readonly SetTextColor: "ActiveOutline.Editor.Document.Font.SetTextColor";
+                    readonly SetHighLightColor: "ActiveOutline.Editor.Document.Font.SetHighLightColor";
+                    readonly SetBold: "ActiveOutline.Editor.Document.Font.SetBold";
+                    readonly SetItalic: "ActiveOutline.Editor.Document.Font.SetItalic";
+                    readonly SetUnderline: "ActiveOutline.Editor.Document.Font.SetUnderline";
+                    readonly SetStrike: "ActiveOutline.Editor.Document.Font.SetStrike";
+                };
+                readonly Markdown: {
+                    readonly GetMarkdown: "ActiveOutline.Editor.Document.Markdown.GetMarkdown";
+                    readonly AppendMarkdown: "ActiveOutline.Editor.Document.Markdown.AppendMarkdown";
+                    readonly InsertMarkdown: "ActiveOutline.Editor.Document.Markdown.InsertMarkdown";
+                    readonly ValidateMarkdown: "ActiveOutline.Editor.Document.Markdown.ValidateMarkdown";
+                };
+                readonly Content: {
+                    readonly ReplaceSelection: "ActiveOutline.Editor.Document.Content.ReplaceSelection";
+                    readonly ReplaceAllContent: "ActiveOutline.Editor.Document.Content.ReplaceAllContent";
+                };
+            };
+        };
+        readonly Service: {
+            readonly User: {
+                readonly GetUserInfo: "ActiveOutline.Service.User.GetUserInfo";
+            };
+            readonly Permission: {
+                readonly GetDocumentPermission: "ActiveOutline.Service.Permission.GetDocumentPermission";
+            };
+            readonly Export: {
+                readonly DownloadDocument: "ActiveOutline.Service.Export.DownloadDocument";
+            };
+            readonly Collaboration: {
+                readonly GetSaveStatus: "ActiveOutline.Service.Collaboration.GetSaveStatus";
+            };
+        };
+        readonly Env: {
+            readonly Language: {
+                readonly GetLanguage: "ActiveOutline.Env.Language.GetLanguage";
+            };
+            readonly DocsMode: {
+                readonly GetDocsMode: "ActiveOutline.Env.DocsMode.GetDocsMode";
+            };
+        };
+        readonly Sub: {
+            readonly OnDocumentChange: "ActiveOutline.Sub.OnDocumentChange";
+        };
+    };
+};
+type LeafValues<T> = T extends string ? T : T extends object ? {
+    [K in keyof T]: LeafValues<T[K]>;
+}[keyof T] : never;
+export type OfficeSDKMethodPath = LeafValues<typeof OfficeSDKMethods>;
+export {};

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,5 @@
 import type { AddChartFromSelectionResult, BasicPresentationFacade, DocsActiveOutlineFacade, DocsEditorDeltaSnapshot, DocsRangeFacade, DocsRangeValue, DocsTableFacade, EditorTextFormat, OfficeSDK, PresentationFacade, PresentationSlideFacade, PresentationShape, PresentationShapeBase, PresentationTableCell, PresentationTableItem, PresentationTableRange, PresentationTableSelection, PresentationTextShape, PresentationTextRangeFacade, PresentationTextRangeValue, SheetRangeValue, SheetRangeFacade, SheetSelection } from './OfficeSDK';
+import type { OfficeSDKMethodPath } from './OfficeSDK.methods';
 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,6 +12,7 @@ type PresentationSelection = Extract<RootSelection, {
 }>;
 type RootPresentation = NonNullable<OfficeSDK['presentation']>;
 export type EditorFacadeContractAssertions = [
+    Assert<IsEqual<OfficeSDK['canIUse'], (method: OfficeSDKMethodPath) => Promise<boolean>>>,
     Assert<IsEqual<NonNullable<OfficeSDK['ActiveOutline']>, DocsActiveOutlineFacade>>,
     Assert<IsEqual<DocsActiveOutlineFacade['Editor']['Document']['GetContent'], () => Promise<DocsEditorDeltaSnapshot>>>,
     Assert<IsEqual<DocsActiveOutlineFacade['Editor']['Document']['Markdown']['AppendMarkdown'], (value: string) => Promise<DocsRangeValue>>>,

package/dist/index.d.ts

@@ -10,6 +10,7 @@ export * from 'weboffice-js-sdk-shared';
 export * from './connect';
 export type { JSAPIAdapter, JSAPIContract, JSAPIContractCatalog, JSAPITransport } from './jsapi';
 export * from './OfficeSDK';
+export * from './OfficeSDK.methods';
 export type { EmptyPageScene, EmptyPageOptions, EmptyPageActionOverride, EmptyPageContentOverride, NormalizedEmptyPageOptions, EmptyPageShownPayload, EmptyPageActionPayload, EmptyPageHiddenPayload, FileOpenFailedReason, TokenExpiredStrategy } from './types/EmptyPage';
 export type { SlashMenuButton, SlashMenuEntry, SlashMenuOptions } from './types/SlashMenu';
 export { ALL_EMPTY_PAGE_SCENES, normalizeEmptyPageOptions } from './types/EmptyPage';