@casualoffice/sheets 0.9.0 → 0.10.0

package/dist/api-BI2VLYQ6.d.cts

@@ -0,0 +1,62 @@
+import { FUniver } from '@univerjs/core/facade';
+import { IWorkbookData, IRange } from '@univerjs/core';
+
+/**
+ * CasualSheetsAPI — the imperative ref handed to a host via `<CasualSheets onReady>`.
+ *
+ * This is the SDK's stable integration surface (Excalidraw's model: props +
+ * imperative ref). Hosts drive the editor through these methods rather than
+ * reaching into Univer directly; `api.univer` is the documented escape hatch and
+ * is explicitly NOT covered by semver — everything else here is.
+ *
+ * Scope of THIS batch (SDK restructure, Phase 1 step 3):
+ *   getSnapshot / loadSnapshot / getSelection / executeCommand / univer
+ *
+ * Deferred to later, clearly-scoped batches (kept off the type until they work,
+ * so the surface never advertises a method that throws):
+ *   - importXlsx / exportXlsx — the xlsx I/O batch. importXlsx must NOT be a
+ *     plain `import('../xlsx')` here: the main tsup config is `splitting:false`,
+ *     so a dynamic import gets inlined and balloons the editor entry from ~11KB
+ *     to ~200KB of parser code for hosts that never open a file. The xlsx-I/O
+ *     batch wires it as its own chunk (and lifts the export converter out of
+ *     apps/web — the SDK xlsx module is import-only today).
+ *   - attachCollab — belongs to the storage/collab adapter phase (Phase 2);
+ *     the editor ships collab-unaware until then.
+ */
+
+/** The active selection, as a sheet-scoped range. */
+interface RangeRef {
+    /** Workbook unit id the selection belongs to. */
+    unitId: string;
+    /** Worksheet (sub-unit) id the selection belongs to. */
+    sheetId: string;
+    /** `{ startRow, startColumn, endRow, endColumn }`. */
+    range: IRange;
+}
+interface CasualSheetsAPI {
+    /** Current workbook as an `IWorkbookData` snapshot. `null` before the unit
+     *  is created (shouldn't happen after `onReady`, but typed defensively). */
+    getSnapshot(): IWorkbookData | null;
+    /** Replace the workbook with a new snapshot. Disposes the current unit and
+     *  mounts `data` as a fresh one. */
+    loadSnapshot(data: IWorkbookData): void;
+    /** The active selection, or `null` when there is none. */
+    getSelection(): RangeRef | null;
+    /** Dispatch a Univer command by id. Resolves to the command's boolean
+     *  result. */
+    executeCommand(id: string, params?: object): Promise<boolean>;
+    /** Imperative light/dark switch — the API equivalent of the reactive
+     *  `appearance` prop. Flips Univer's `ThemeService.setDarkMode` (canvas
+     *  colours + the `univer-dark` class Univer applies to the document root). */
+    setTheme(appearance: 'light' | 'dark'): void;
+    /** The FUniver facade — documented escape hatch, NOT covered by semver. */
+    univer: FUniver;
+}
+/**
+ * Build the imperative API over a live FUniver facade. The wrapper holds no
+ * state of its own — every call reads the current active workbook, so it stays
+ * correct across `loadSnapshot` swaps without the host re-acquiring the ref.
+ */
+declare function createCasualSheetsAPI(univerAPI: FUniver): CasualSheetsAPI;
+
+export { type CasualSheetsAPI as C, type RangeRef as R, createCasualSheetsAPI as c };

package/dist/api-BI2VLYQ6.d.ts

@@ -0,0 +1,62 @@
+import { FUniver } from '@univerjs/core/facade';
+import { IWorkbookData, IRange } from '@univerjs/core';
+
+/**
+ * CasualSheetsAPI — the imperative ref handed to a host via `<CasualSheets onReady>`.
+ *
+ * This is the SDK's stable integration surface (Excalidraw's model: props +
+ * imperative ref). Hosts drive the editor through these methods rather than
+ * reaching into Univer directly; `api.univer` is the documented escape hatch and
+ * is explicitly NOT covered by semver — everything else here is.
+ *
+ * Scope of THIS batch (SDK restructure, Phase 1 step 3):
+ *   getSnapshot / loadSnapshot / getSelection / executeCommand / univer
+ *
+ * Deferred to later, clearly-scoped batches (kept off the type until they work,
+ * so the surface never advertises a method that throws):
+ *   - importXlsx / exportXlsx — the xlsx I/O batch. importXlsx must NOT be a
+ *     plain `import('../xlsx')` here: the main tsup config is `splitting:false`,
+ *     so a dynamic import gets inlined and balloons the editor entry from ~11KB
+ *     to ~200KB of parser code for hosts that never open a file. The xlsx-I/O
+ *     batch wires it as its own chunk (and lifts the export converter out of
+ *     apps/web — the SDK xlsx module is import-only today).
+ *   - attachCollab — belongs to the storage/collab adapter phase (Phase 2);
+ *     the editor ships collab-unaware until then.
+ */
+
+/** The active selection, as a sheet-scoped range. */
+interface RangeRef {
+    /** Workbook unit id the selection belongs to. */
+    unitId: string;
+    /** Worksheet (sub-unit) id the selection belongs to. */
+    sheetId: string;
+    /** `{ startRow, startColumn, endRow, endColumn }`. */
+    range: IRange;
+}
+interface CasualSheetsAPI {
+    /** Current workbook as an `IWorkbookData` snapshot. `null` before the unit
+     *  is created (shouldn't happen after `onReady`, but typed defensively). */
+    getSnapshot(): IWorkbookData | null;
+    /** Replace the workbook with a new snapshot. Disposes the current unit and
+     *  mounts `data` as a fresh one. */
+    loadSnapshot(data: IWorkbookData): void;
+    /** The active selection, or `null` when there is none. */
+    getSelection(): RangeRef | null;
+    /** Dispatch a Univer command by id. Resolves to the command's boolean
+     *  result. */
+    executeCommand(id: string, params?: object): Promise<boolean>;
+    /** Imperative light/dark switch — the API equivalent of the reactive
+     *  `appearance` prop. Flips Univer's `ThemeService.setDarkMode` (canvas
+     *  colours + the `univer-dark` class Univer applies to the document root). */
+    setTheme(appearance: 'light' | 'dark'): void;
+    /** The FUniver facade — documented escape hatch, NOT covered by semver. */
+    univer: FUniver;
+}
+/**
+ * Build the imperative API over a live FUniver facade. The wrapper holds no
+ * state of its own — every call reads the current active workbook, so it stays
+ * correct across `loadSnapshot` swaps without the host re-acquiring the ref.
+ */
+declare function createCasualSheetsAPI(univerAPI: FUniver): CasualSheetsAPI;
+
+export { type CasualSheetsAPI as C, type RangeRef as R, createCasualSheetsAPI as c };