weboffice-js-sdk-shared 2.0.1

package/README.md

@@ -0,0 +1,5 @@
+# Weboffice JS SDK Shared
+
+- types
+- utils
+- ...

package/dist/APIAdaptor.d.ts

@@ -0,0 +1,34 @@
+/**
+ * 发出 XHR 请求前，会调用这个函数对请求参数进行处理，并以最终结果发起请求。因为会被 toString() 后 eval()，因此需要确保函数体内无外部依赖。
+ *
+ * @param requestOptions - 请求参数
+ * @param context - 用于传递上下文信息的对象
+ */
+export type APIAdaptor = (requestOptions: RequestOptions, context?: RequestContext) => RequestOptions;
+/**
+ * 请求参数
+ */
+export interface RequestOptions {
+    /**
+     * 目标 URL，不含 query string
+     */
+    url: string;
+    method: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
+    headers?: {
+        [K: string]: string;
+    };
+    /**
+     * URL query string 参数
+     */
+    query?: Record<string, string>;
+}
+/**
+ * APIAdaptor 上下文允许的数据类型
+ */
+export type RequestContextType = boolean | number | string;
+/**
+ * APIAdaptor 上下文信息的对象，需确保可以通过 JSON.stringify() 序列化。
+ */
+export interface RequestContext {
+    [key: string]: unknown;
+}

package/dist/APIAdaptor.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/File.d.ts

@@ -0,0 +1,74 @@
+export type FileId = string;
+/**
+ * 石墨文档类型
+ */
+export declare enum FileType {
+    /**
+     * 传统文档
+     */
+    DocumentPro = "documentPro",
+    /**
+     * 轻文档
+     */
+    Document = "document",
+    /**
+     * 表格
+     */
+    Spreadsheet = "spreadsheet",
+    /**
+     * 专业幻灯片
+     */
+    Presentation = "presentation",
+    /**
+     * 应用表格
+     */
+    Table = "table",
+    /**
+     * 表单
+     */
+    Form = "form",
+    /**
+     * 流程图
+     */
+    Flowchart = "flowchart",
+    /**
+     * 思维导图
+     */
+    Mindmap = "mindmap",
+    /**
+     * 白板
+     */
+    Board = "board",
+    /**
+     * 未知类型
+     */
+    Unknown = "unknown"
+}
+export declare const FileTypeAlias: {
+    document: string;
+    documentPro: string;
+    spreadsheet: string;
+    presentation: string;
+    table: string;
+    form: string;
+    mindmap: string;
+    board: string;
+    flowchart: string;
+};
+/**
+ * 对应石墨类型的文件信息
+ */
+export interface FileInfo {
+    /**
+     * 文件 ID，非石墨内部的 ID / GUID
+     */
+    fileId: FileId;
+    /**
+     * 文件对应石墨类型
+     */
+    type: 'docs' | 'docx' | 'sheets' | 'presentation' | 'table';
+}
+/**
+ * 根据传入值转换为 FileType 枚举值
+ */
+export declare function convertFileType(value: string | number): FileType;

package/dist/File.js

@@ -0,0 +1,150 @@
+"use strict";
+var __values = (this && this.__values) || function(o) {
+    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
+    if (m) return m.call(o);
+    if (o && typeof o.length === "number") return {
+        next: function () {
+            if (o && i >= o.length) o = void 0;
+            return { value: o && o[i++], done: !o };
+        }
+    };
+    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
+};
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertFileType = exports.FileTypeAlias = exports.FileType = void 0;
+/**
+ * 石墨文档类型
+ */
+var FileType;
+(function (FileType) {
+    /**
+     * 传统文档
+     */
+    FileType["DocumentPro"] = "documentPro";
+    /**
+     * 轻文档
+     */
+    FileType["Document"] = "document";
+    /**
+     * 表格
+     */
+    FileType["Spreadsheet"] = "spreadsheet";
+    /**
+     * 专业幻灯片
+     */
+    FileType["Presentation"] = "presentation";
+    /**
+     * 应用表格
+     */
+    FileType["Table"] = "table";
+    /**
+     * 表单
+     */
+    FileType["Form"] = "form";
+    /**
+     * 流程图
+     */
+    FileType["Flowchart"] = "flowchart";
+    /**
+     * 思维导图
+     */
+    FileType["Mindmap"] = "mindmap";
+    /**
+     * 白板
+     */
+    FileType["Board"] = "board";
+    /**
+     * 未知类型
+     */
+    FileType["Unknown"] = "unknown";
+})(FileType = exports.FileType || (exports.FileType = {}));
+exports.FileTypeAlias = (_a = {},
+    _a[FileType.Document] = 'docs',
+    _a[FileType.DocumentPro] = 'docx',
+    _a[FileType.Spreadsheet] = 'sheets',
+    _a[FileType.Presentation] = 'presentation',
+    _a[FileType.Table] = 'table',
+    _a[FileType.Form] = 'form',
+    _a[FileType.Mindmap] = 'mindmap',
+    _a[FileType.Board] = 'board',
+    _a[FileType.Flowchart] = 'flowchart',
+    _a);
+/**
+ * 根据传入值转换为 FileType 枚举值
+ */
+function convertFileType(value) {
+    var e_1, _a, e_2, _b;
+    if (typeof value === 'string') {
+        try {
+            for (var _c = __values(Object.entries(FileType)), _d = _c.next(); !_d.done; _d = _c.next()) {
+                var _e = __read(_d.value, 2), k = _e[0], v = _e[1];
+                if (k === value || v === value) {
+                    return v;
+                }
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (_d && !_d.done && (_a = _c.return)) _a.call(_c);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+        try {
+            for (var _f = __values(Object.entries(exports.FileTypeAlias)), _g = _f.next(); !_g.done; _g = _f.next()) {
+                var _h = __read(_g.value, 2), k = _h[0], v = _h[1];
+                if (v === value) {
+                    return k;
+                }
+            }
+        }
+        catch (e_2_1) { e_2 = { error: e_2_1 }; }
+        finally {
+            try {
+                if (_g && !_g.done && (_b = _f.return)) _b.call(_f);
+            }
+            finally { if (e_2) throw e_2.error; }
+        }
+    }
+    else {
+        switch (value) {
+            case -2:
+                return FileType.Document;
+            case -4:
+                return FileType.Spreadsheet;
+            case -6:
+                return FileType.DocumentPro;
+            case -7:
+                return FileType.Mindmap;
+            case -8:
+                return FileType.Form;
+            case -9:
+                return FileType.Board;
+            case -10:
+                return FileType.Presentation;
+            case -11:
+                return FileType.Table;
+            case -13:
+                return FileType.Flowchart;
+        }
+    }
+    return FileType.Unknown;
+}
+exports.convertFileType = convertFileType;

package/dist/event.d.ts

@@ -0,0 +1,72 @@
+import { FileType } from './File';
+import { ContainerRect } from './types';
+/**
+ * SDK 相关的事件，和编辑器无关
+ */
+export declare const SDKEvent: Readonly<{
+    /**
+     * 一般指 container viewport 发生变化时触发，比如窗口大小变化。会优先使用 window.visualViewport resize 事件，不可用时使用 window.resize 事件。
+     */
+    ViewportResize: "ViewportResize";
+    /**
+     * SDK 和编辑器初始化状态
+     */
+    ReadyState: "ReadyState";
+}>;
+export interface SDKEventMap {
+    [SDKEvent.ViewportResize]: ContainerRect;
+    [SDKEvent.ReadyState]: ReadyStateEventPayload;
+}
+/**
+ * 用于 postMessage 通信的 SDKEvent 消息体
+ */
+export interface SDKEventMessage {
+    event: keyof SDKEventMap;
+    payload: unknown;
+}
+/**
+ * 判断是否是 SDKEvent 事件消息
+ */
+export declare function isSDKEventMessage(input: unknown): input is SDKEventMessage;
+/**
+ * SDK 和编辑器初始化状态
+ */
+export declare enum ReadyState {
+    /**
+     * 正在初始化 SDK
+     */
+    Loading = "loading",
+    /**
+     * 正在初始化编辑器
+     */
+    LoadingEditor = "loadingEditor",
+    /**
+     * SDK 和编辑器初始化完成，因编辑器含异步组件，因此仅代表可以和编辑器交互，不代表编辑器完成全部加载。
+     */
+    Ready = "ready",
+    /**
+     * 初始化失败
+     */
+    Failed = "failed",
+    /**
+     * 已经被销毁
+     */
+    Disconnected = "disconnected"
+}
+/**
+ * ReadyState 事件变化数据
+ */
+export interface ReadyStateEventPayload {
+    /**
+     * 当前 ReadyState
+     */
+    state: ReadyState;
+    /**
+     * 对应的文件类型
+     */
+    fileType: FileType;
+    /**
+     * 错误信息
+     */
+    error?: Error;
+}

package/dist/event.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReadyState = exports.isSDKEventMessage = exports.SDKEvent = void 0;
+/**
+ * SDK 相关的事件，和编辑器无关
+ */
+exports.SDKEvent = Object.freeze({
+    /**
+     * 一般指 container viewport 发生变化时触发，比如窗口大小变化。会优先使用 window.visualViewport resize 事件，不可用时使用 window.resize 事件。
+     */
+    ViewportResize: 'ViewportResize',
+    /**
+     * SDK 和编辑器初始化状态
+     */
+    ReadyState: 'ReadyState',
+});
+/**
+ * 判断是否是 SDKEvent 事件消息
+ */
+function isSDKEventMessage(input) {
+    var event;
+    if (input != null) {
+        event = input.event;
+    }
+    return typeof event === 'string' && event in exports.SDKEvent;
+}
+exports.isSDKEventMessage = isSDKEventMessage;
+/**
+ * SDK 和编辑器初始化状态
+ */
+var ReadyState;
+(function (ReadyState) {
+    /**
+     * 正在初始化 SDK
+     */
+    ReadyState["Loading"] = "loading";
+    /**
+     * 正在初始化编辑器
+     */
+    ReadyState["LoadingEditor"] = "loadingEditor";
+    /**
+     * SDK 和编辑器初始化完成，因编辑器含异步组件，因此仅代表可以和编辑器交互，不代表编辑器完成全部加载。
+     */
+    ReadyState["Ready"] = "ready";
+    /**
+     * 初始化失败
+     */
+    ReadyState["Failed"] = "failed";
+    /**
+     * 已经被销毁
+     */
+    ReadyState["Disconnected"] = "disconnected";
+})(ReadyState = exports.ReadyState || (exports.ReadyState = {}));

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from './types';
+export * from './APIAdaptor';
+export * from './File';
+export * from './event';

package/dist/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./types"), exports);
+__exportStar(require("./APIAdaptor"), exports);
+__exportStar(require("./File"), exports);
+__exportStar(require("./event"), exports);

package/dist/types.d.ts

@@ -0,0 +1,363 @@
+import { FileId } from './File';
+export type UserId = string;
+/**
+ * JS SDK 之间通信用的方法。一般用在 WebofficeBroadcastChannel.invoke() 中。
+ */
+export declare enum InvokeMethod {
+    /**
+     * SDK 初始化，用于获取配置信息
+     */
+    SDKInit = "SDKInit",
+    /**
+     * 用于 error 处理
+     */
+    Error = "error",
+    /**
+     * 用于处理 ReadyState 变化
+     */
+    ReadyState = "readyState",
+    /**
+     * 用于更新鉴权信息
+     */
+    SetCredentials = "setCredentials",
+    /**
+     * 调用容器方法
+     */
+    InvokeContainerMethod = "invokeContainerMethod",
+    /**
+     * 请求调用编辑器方法，并将结果返回
+     */
+    InvokeEditorMethod = "invokeEditorMethod",
+    /**
+     * 派发 SDK 自身相关的事件
+     */
+    DispatchSDKEvent = "dispatchSDKEvent",
+    /**
+     * 派发编辑器相关的事件
+     */
+    DispatchEditorEvent = "dispatchEditorEvent",
+    /**
+     * 监听编辑器相关的事件
+     */
+    ListenEditorEvent = "listenEditorEvent",
+    /**
+     * 请求性能信息列表
+     */
+    RequestPerformanceEntries = "requestPerformanceEntries"
+}
+/**
+ * 是否禁用提及的浮动卡片组件
+ */
+export interface DisableMentionCards {
+    /**
+     * 是否禁用提及人的浮动卡片组件
+     */
+    user?: boolean;
+    /**
+     * 是否禁用提及文件的浮动卡片组件
+     */
+    file?: boolean;
+    /**
+     * 是否禁用提及日期的浮动卡片组件
+     */
+    date?: boolean;
+}
+/**
+ * 容器的尺寸信息
+ */
+export interface ContainerRect {
+    /**
+     * 容器所在 viewport 的宽度
+     */
+    viewportWidth: number;
+    /**
+     * 容器所在 viewport 的高度
+     */
+    viewportHeight: number;
+    /**
+     * 容器在 viewport 的 top
+     */
+    top: number;
+    /**
+     * 容器在 viewport 的 left
+     */
+    left: number;
+    /**
+     * 容器在 viewport 的 bottom
+     */
+    bottom: number;
+    /**
+     * 容器在 viewport 的 right
+     */
+    right: number;
+    /**
+     * 容器在 viewport 的 scrollTop
+     */
+    scrollTop?: number;
+    /**
+     * window.visualViewport 的值
+     */
+    visualViewport?: {
+        width?: number;
+        height?: number;
+        offsetLeft?: number;
+        offsetTop?: number;
+        pageLeft?: number;
+        pageTop?: number;
+        scale?: number;
+    };
+}
+/**
+ * 容器能提供的方法
+ */
+export declare enum ContainerMethod {
+    /**
+     * 获取容器的尺寸信息
+     */
+    GetContainerRect = "getContainerRect",
+    /**
+     * 请求容器打开链接
+     */
+    OpenLink = "openLink",
+    /**
+     * 请求容器生成 URL
+     */
+    GenerateUrl = "generateUrl",
+    /**
+     * 请求容器打开处理移动端点击事件
+     */
+    MentionClickHandlerForMobile = "mentionClickHandlerForMobile",
+    /**
+     * 请求容器解析 URL，并返回 FileInfo
+     */
+    GetFileInfoFromUrl = "getFileInfoFromUrl",
+    /**
+     * 请求容器显示签名组件，受套件和版本限制
+     */
+    ShowSignatureComponent = "showSignatureComponent",
+    /**
+     * 请求容器显示toast，受套件和版本限制
+     */
+    ShowToast = "showToast",
+    /**
+     * 通知用户执行自定义操作，操作由用户自定义按钮触发
+     */
+    HandleCustomTask = "handleCustomTask",
+    /**
+     * 请求容器获取鉴权信息
+     */
+    GetCredentials = "getCredentials"
+}
+/**
+ * 用户 hover 在 at 上时，at 在该行信息
+ */
+export interface LineInfo {
+    /**
+     * @ 在该行的顶点 x 坐标
+     */
+    left: number;
+    /**
+     * @ 在该行的顶点 y 坐标
+     */
+    top: number;
+    /**
+     * @ 在该行的宽度
+     */
+    width: number;
+    /**
+     * @ 在该行的高度
+     */
+    height: number;
+}
+/**
+ * 用户 hover 在 at 上时，at 涉及的 user ID 或 file ID 信息
+ */
+export interface MentionInfo extends LineInfo {
+    /**
+     * 用户 ID
+     */
+    userId?: UserId;
+    /**
+     * 文件 ID
+     */
+    fileId?: FileId;
+}
+/**
+ * 鼠标事件相关的信息
+ */
+export interface MouseMovePayload {
+    x: number;
+    y: number;
+    /**
+     * 光标所在位置是否是一个 @ 元素
+     */
+    isMention: boolean;
+    mentionInfo: MentionInfo;
+}
+/**
+ * 性能信息
+ */
+export interface PerformanceEntry {
+    /**
+     * 性能信息片段的标记，如 "sdk_initialized"、"editor_render_end"
+     */
+    mark: string;
+    /**
+     * 性能信息片段的标记时间，以毫秒为单位
+     */
+    timestamp: number;
+    /**
+     * Performance 开始记录时间的节点，用于静态资源加载时间计算等用途
+     * https://developer.mozilla.org/en-US/docs/Web/API/Performance/timeOrigin
+     */
+    timeOrigin?: number;
+    /**
+     * 原始 PerformanceResourceTiming.toJSON()
+     */
+    resourceTiming?: Record<string, unknown>;
+}
+/**
+ * 使用什么设备类型模式，会直接影响功能和样式，不传值或空字符串则默认用 user-agent 自动判断。受版本限制，不是所有类型都支持。
+ * - pc - 桌面模式
+ * - mobile - 移动模式
+ * - pad - 平板模式
+ */
+export type DeviceMode = 'pc' | 'mobile' | 'pad';
+export type GenerateUrlHandler = (
+/**
+ * 该 URL 对应的 file ID，用于生成用户可访问的 URL，比如 https://domain/files/<fileId>
+ */
+fileId: string, 
+/**
+ * 用于生成 URL 的额外信息
+ */
+info?: GenerateUrlInfo, 
+/**
+ * 传递 smParams
+ */
+smParams?: Record<string, any>) => string | Promise<string>;
+/**
+ * 用于生成 URL 的额外信息
+ */
+export type GenerateUrlInfo = {
+    /**
+     * 石墨返回的默认的分享 URL 文本，可以拼接到 URL 后，比如 「https://domain/files/1 xxx 分享文件 yyy，复制到浏览器打开」
+     */
+    sharingText?: string;
+} & SharingSource<UrlSharingType>;
+export type SharingSource<T extends UrlSharingType> = T extends UrlSharingType.Spreadsheet ? {
+    /**
+     * 分享 URL 的类型
+     */
+    sharingType?: T;
+    /**
+     * 分享 URL 的场景/来源
+     */
+    sharingFrom?: SpreadsheetSharingFrom;
+} : {
+    /**
+     * 分享 URL 的类型
+     */
+    sharingType?: T;
+};
+export declare enum SpreadsheetSharingFrom {
+    /**
+     * 获取选区链接
+     */
+    copyRangeLink = "copyRangeLink",
+    /**
+     * 复制独立视图链接
+     */
+    copyViewportLink = "copyViewportLink",
+    /**
+     * 复制链接到工作表的内链接
+     */
+    copySheetLink = "copySheetLink",
+    /**
+     * 跨表格引用
+     */
+    importRange = "importRange",
+    /**
+     * 预览被跨表引用或合并工作表引用的表格
+     */
+    preview = "preview"
+}
+/**
+ * 分享链接的类型，用于在 generateUrl 中返回不同的 URL。
+ * 比如 return sharingType === UrlSharingType.FormFill ? '/form/1/fill' : '/form/1'。
+ * '/form/1/fill' 为对外匿名可访问填写表单的链接，'/form/1' 为对内编辑表单元素、需鉴权的链接。
+ */
+export declare enum UrlSharingType {
+    /**
+     * 代表分享的是轻文档链接
+     */
+    Doc = "doc",
+    /**
+     * 代表分享的是传统文档链接
+     */
+    Docx = "docx",
+    /**
+     * 代表分享的是表格链接
+     */
+    Spreadsheet = "sheet",
+    /**
+     * 代表分享的是表单编辑器链接
+     */
+    Form = "form",
+    /**
+     * 代表分享的是表单预览链接
+     */
+    FormPreview = "formPreview",
+    /**
+     * 代表分享的是表单填写链接
+     */
+    FormFill = "formFill",
+    /**
+     * 代表分享的是幻灯片链接
+     */
+    Presentation = "presentation",
+    /**
+     * 代表分享的是应用表格链接
+     */
+    Table = "table",
+    /**
+     * 代表分享的是流程图链接
+     */
+    Flowchart = "flowchart",
+    /**
+     * 代表分享的是思维导图链接
+     */
+    Mindmap = "mindmap",
+    /**
+     * 代表分享的是白板链接
+     */
+    Board = "board"
+}
+export interface ShowToastOptions {
+    /**
+     * toast标题
+     */
+    title: string;
+    /**
+     * toast类型, 默认为info
+     */
+    type?: 'success' | 'error' | 'warn' | 'info';
+    /**
+     * 显示时长，默认3s
+     */
+    duration?: number;
+    /**
+     * 是否自动隐藏，默认true
+     */
+    autoHide?: boolean;
+}
+export interface Credentials {
+    /**
+     * 鉴权 token
+     */
+    token: string;
+    /**
+     * 鉴权 signature
+     */
+    signature: string;
+}

package/dist/types.js

@@ -0,0 +1,166 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UrlSharingType = exports.SpreadsheetSharingFrom = exports.ContainerMethod = exports.InvokeMethod = void 0;
+/**
+ * JS SDK 之间通信用的方法。一般用在 WebofficeBroadcastChannel.invoke() 中。
+ */
+var InvokeMethod;
+(function (InvokeMethod) {
+    /**
+     * SDK 初始化，用于获取配置信息
+     */
+    InvokeMethod["SDKInit"] = "SDKInit";
+    /**
+     * 用于 error 处理
+     */
+    InvokeMethod["Error"] = "error";
+    /**
+     * 用于处理 ReadyState 变化
+     */
+    InvokeMethod["ReadyState"] = "readyState";
+    /**
+     * 用于更新鉴权信息
+     */
+    InvokeMethod["SetCredentials"] = "setCredentials";
+    /**
+     * 调用容器方法
+     */
+    InvokeMethod["InvokeContainerMethod"] = "invokeContainerMethod";
+    /**
+     * 请求调用编辑器方法，并将结果返回
+     */
+    InvokeMethod["InvokeEditorMethod"] = "invokeEditorMethod";
+    /**
+     * 派发 SDK 自身相关的事件
+     */
+    InvokeMethod["DispatchSDKEvent"] = "dispatchSDKEvent";
+    /**
+     * 派发编辑器相关的事件
+     */
+    InvokeMethod["DispatchEditorEvent"] = "dispatchEditorEvent";
+    /**
+     * 监听编辑器相关的事件
+     */
+    InvokeMethod["ListenEditorEvent"] = "listenEditorEvent";
+    /**
+     * 请求性能信息列表
+     */
+    InvokeMethod["RequestPerformanceEntries"] = "requestPerformanceEntries";
+})(InvokeMethod = exports.InvokeMethod || (exports.InvokeMethod = {}));
+/**
+ * 容器能提供的方法
+ */
+var ContainerMethod;
+(function (ContainerMethod) {
+    /**
+     * 获取容器的尺寸信息
+     */
+    ContainerMethod["GetContainerRect"] = "getContainerRect";
+    /**
+     * 请求容器打开链接
+     */
+    ContainerMethod["OpenLink"] = "openLink";
+    /**
+     * 请求容器生成 URL
+     */
+    ContainerMethod["GenerateUrl"] = "generateUrl";
+    /**
+     * 请求容器打开处理移动端点击事件
+     */
+    ContainerMethod["MentionClickHandlerForMobile"] = "mentionClickHandlerForMobile";
+    /**
+     * 请求容器解析 URL，并返回 FileInfo
+     */
+    ContainerMethod["GetFileInfoFromUrl"] = "getFileInfoFromUrl";
+    /**
+     * 请求容器显示签名组件，受套件和版本限制
+     */
+    ContainerMethod["ShowSignatureComponent"] = "showSignatureComponent";
+    /**
+     * 请求容器显示toast，受套件和版本限制
+     */
+    ContainerMethod["ShowToast"] = "showToast";
+    /**
+     * 通知用户执行自定义操作，操作由用户自定义按钮触发
+     */
+    ContainerMethod["HandleCustomTask"] = "handleCustomTask";
+    /**
+     * 请求容器获取鉴权信息
+     */
+    ContainerMethod["GetCredentials"] = "getCredentials";
+})(ContainerMethod = exports.ContainerMethod || (exports.ContainerMethod = {}));
+var SpreadsheetSharingFrom;
+(function (SpreadsheetSharingFrom) {
+    /**
+     * 获取选区链接
+     */
+    SpreadsheetSharingFrom["copyRangeLink"] = "copyRangeLink";
+    /**
+     * 复制独立视图链接
+     */
+    SpreadsheetSharingFrom["copyViewportLink"] = "copyViewportLink";
+    /**
+     * 复制链接到工作表的内链接
+     */
+    SpreadsheetSharingFrom["copySheetLink"] = "copySheetLink";
+    /**
+     * 跨表格引用
+     */
+    SpreadsheetSharingFrom["importRange"] = "importRange";
+    /**
+     * 预览被跨表引用或合并工作表引用的表格
+     */
+    SpreadsheetSharingFrom["preview"] = "preview";
+})(SpreadsheetSharingFrom = exports.SpreadsheetSharingFrom || (exports.SpreadsheetSharingFrom = {}));
+/**
+ * 分享链接的类型，用于在 generateUrl 中返回不同的 URL。
+ * 比如 return sharingType === UrlSharingType.FormFill ? '/form/1/fill' : '/form/1'。
+ * '/form/1/fill' 为对外匿名可访问填写表单的链接，'/form/1' 为对内编辑表单元素、需鉴权的链接。
+ */
+var UrlSharingType;
+(function (UrlSharingType) {
+    /**
+     * 代表分享的是轻文档链接
+     */
+    UrlSharingType["Doc"] = "doc";
+    /**
+     * 代表分享的是传统文档链接
+     */
+    UrlSharingType["Docx"] = "docx";
+    /**
+     * 代表分享的是表格链接
+     */
+    UrlSharingType["Spreadsheet"] = "sheet";
+    /**
+     * 代表分享的是表单编辑器链接
+     */
+    UrlSharingType["Form"] = "form";
+    /**
+     * 代表分享的是表单预览链接
+     */
+    UrlSharingType["FormPreview"] = "formPreview";
+    /**
+     * 代表分享的是表单填写链接
+     */
+    UrlSharingType["FormFill"] = "formFill";
+    /**
+     * 代表分享的是幻灯片链接
+     */
+    UrlSharingType["Presentation"] = "presentation";
+    /**
+     * 代表分享的是应用表格链接
+     */
+    UrlSharingType["Table"] = "table";
+    /**
+     * 代表分享的是流程图链接
+     */
+    UrlSharingType["Flowchart"] = "flowchart";
+    /**
+     * 代表分享的是思维导图链接
+     */
+    UrlSharingType["Mindmap"] = "mindmap";
+    /**
+     * 代表分享的是白板链接
+     */
+    UrlSharingType["Board"] = "board";
+})(UrlSharingType = exports.UrlSharingType || (exports.UrlSharingType = {}));

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "weboffice-js-sdk-shared",
+  "version": "2.0.1",
+  "description": "SDK 2.0 前端共享资源，如 types。",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "preversion": "npm run docs-auto",
+    "prepare": "husky install",
+    "build": "del-cli dist && tsc --skipLibCheck",
+    "prepack": "npm run build",
+    "docs": "typedoc src/index.ts",
+    "docs-auto": "npm run docs && git add -A docs && git diff-index --quiet HEAD || git commit -m 'docs: update'"
+  },
+  "license": "MIT",
+  "devDependencies": {
+    "@types/node": "^17.0.35",
+    "@typescript-eslint/eslint-plugin": "^5.25.0",
+    "@typescript-eslint/parser": "^5.25.0",
+    "del-cli": "^5.0.0",
+    "eslint": "8.37.0",
+    "eslint-config-prettier": "8.8.0",
+    "husky": "^7.0.4",
+    "lint-staged": "^12.3.4",
+    "prettier": "^2.6.2",
+    "typedoc": "0.26.2",
+    "typedoc-plugin-markdown": "4.1.0",
+    "typescript": "^4.7.4"
+  },
+  "lint-staged": {
+    "*.{js,ts}": [
+      "eslint --cache --fix",
+      "prettier --write"
+    ],
+    "*.{md}": "prettier --write"
+  },
+  "files": [
+    "dist"
+  ]
+}