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

package/dist/OfficeSDK.d.ts

@@ -10,6 +10,7 @@ import { EmptyPageOptions } from './types/EmptyPage';
 import { BaseEditor } from './types/BaseEditor';
 import { SlashMenuOptions } from './types/SlashMenu';
 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 +40,10 @@ export declare class OfficeSDK extends TinyEmitter {
     spreadsheet?: Spreadsheet.Editor;
     /** 当前轻文档的标准化、强类型文档入口。 */
     ActiveOutline?: DocsActiveOutlineFacade;
+    /**
+     * 判断当前套件和 iframe runtime 是否支持指定的公开 SDK 方法。
+     */
+    canIUse(method: OfficeSDKMethodPath): Promise<boolean>;
     /**
      * 当前套件支持的标题能力。
      */

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/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';