@sqsoffice/slide 0.0.0-stage → 0.1.0

package/dist/types/sdk/types.d.ts

@@ -0,0 +1,59 @@
+import type { BrowserFileSession, FileSessionState } from '../app/lib/files/session';
+import type { EngineEvent, EngineResult, TaskOptions } from '../app/lib/engine/client';
+import type { Command, CommandResponse } from '../app/lib/engine/protocol';
+import type { ViewRequest, ViewResult } from '../app/lib/engine/view';
+export type PackageKind = 'pdf' | 'word' | 'grid' | 'slide' | 'kit';
+export type ViewerKind = Exclude<PackageKind, 'kit'>;
+export type OfficeDocumentBytes = ArrayBuffer | Uint8Array;
+export interface OfficeOptions {
+    /** Same-origin directory containing the package's engine/, fonts/ and optional OCR resources. */
+    assetBase?: string;
+    /** Install the existing unsaved-document beforeunload handler. Defaults to true. */
+    bindLifecycle?: boolean;
+    requestPassword?: (name: string, retry: boolean) => Promise<string | undefined>;
+    confirmDiscard?: (name: string) => Promise<boolean>;
+}
+export interface MountOptions extends OfficeOptions {
+    /** File to open after the component has mounted. */
+    file?: File;
+}
+export interface MountedOffice<K extends PackageKind = PackageKind> {
+    readonly api: OfficeApi<K>;
+    open(file: File): Promise<void>;
+    flush(): Promise<void>;
+    /** Releases the component and discards unsaved changes; wait for saving to finish first. */
+    destroy(): Promise<void>;
+}
+export type ReadonlyCommandKind = 'status' | 'info' | 'search' | 'to_markdown' | 'body' | 'docx' | 'xlsx' | 'pptx' | 'pdf' | 'pdf_view' | 'markdown' | 'text';
+/** Each viewer additionally checks that the command belongs to its document format. */
+export type ReadonlyCommand = Command & {
+    kind: ReadonlyCommandKind;
+};
+export type ReadonlyViewRequest = Extract<ViewRequest, {
+    kind: 'layout' | 'tile' | 'hit' | 'selection' | 'text_review' | 'text_statistics' | 'text_objects' | 'grid_layout' | 'grid_tile' | 'grid_hit' | 'grid_selection' | 'pdf_state' | 'pdf_reading' | 'pdf_selection' | 'pdf_hit' | 'pdf_text_selection' | 'pdf_tools' | 'pdf_authenticate' | 'presentation_state' | 'presentation_selection' | 'presentation_hit' | 'presentation_playback' | 'presentation_frame' | 'presentation_media';
+}>;
+export interface OfficeCommonApi<K extends PackageKind = PackageKind> {
+    readonly kind: K;
+    readonly assetBase: string;
+    readonly state: Readonly<FileSessionState>;
+    open(file: File): Promise<void>;
+    open(name: string, bytes: OfficeDocumentBytes): Promise<void>;
+    read(command: ReadonlyCommand, options?: TaskOptions): Promise<EngineResult<CommandResponse>>;
+    view<T extends ViewResult = ViewResult>(request: ReadonlyViewRequest, options?: TaskOptions): Promise<EngineResult<T>>;
+    subscribe(listener: (state: FileSessionState, event?: EngineEvent) => void): () => void;
+    whenIdle(): Promise<void>;
+    close(options?: {
+        discard?: boolean;
+    }): Promise<void>;
+}
+export interface ReadonlyOfficeApi<K extends ViewerKind = ViewerKind> extends OfficeCommonApi<K> {
+    readonly readOnly: true;
+}
+export interface OfficeKitApi extends OfficeCommonApi<'kit'> {
+    readonly readOnly: false;
+    /** Full browser host: editing, scripts, history, export, and verified save transactions. */
+    readonly session: BrowserFileSession;
+}
+export type OfficeApi<K extends PackageKind = PackageKind> = K extends 'kit' ? OfficeKitApi : ReadonlyOfficeApi<Extract<K, ViewerKind>>;
+export type { BrowserFileSession, FileSessionState, EngineEvent, EngineResult, TaskOptions };
+export type { Command, CommandResponse, ViewRequest, ViewResult };

package/package.json

@@ -1,6 +1,43 @@
 {
   "name": "@sqsoffice/slide",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.0",
+  "description": "演示文稿浏览组件与浏览器 API，基于 Rust / WebAssembly",
+  "type": "module",
+  "license": "Apache-2.0",
+  "sideEffects": [
+    "**/*.css"
+  ],
+  "main": "./dist/index.js",
+  "types": "./dist/types/packages/slide/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types/packages/slide/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./api": {
+      "types": "./dist/types/packages/slide/api.d.ts",
+      "import": "./dist/api.js"
+    },
+    "./style.css": "./dist/style.css",
+    "./assets/*": "./dist/assets/*",
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "keywords": [
+    "office",
+    "wasm",
+    "slide",
+    "viewer"
+  ],
+  "scripts": {
+    "prepack": "node ../../scripts/check-package.mjs"
+  }
 }