@casualoffice/sheets 0.9.0

package/dist/protocol--KyBQUjU.d.cts

@@ -0,0 +1,171 @@
+import { c as SignatureField, e as SignatureMode, C as CancelReason, f as SignedFieldPayload, b as SignatureCompletePayload } from './types-s_O0u6Cg.cjs';
+
+/**
+ * Iframe protocol — wire envelopes that match
+ * `docs/internal/13-iframe-protocol.md`.
+ *
+ * Mirror updates to the doc whenever a new envelope shape lands.
+ * The discriminator on `type` (always starts with `casual.`) and
+ * the per-envelope `data` shape are the contract.
+ */
+
+type CasualApp = 'docs' | 'sheet';
+/** Common envelope shape — every postMessage on the wire matches this. */
+interface CasualEnvelope<T = unknown> {
+    type: string;
+    app: CasualApp;
+    /** Per-request id for request/response correlation. Empty for fire-and-forget. */
+    id?: string;
+    /** Protocol version. Bumped only on breaking changes. */
+    v: 1;
+    data: T;
+}
+interface EditorHelloData {
+    capabilities: string[];
+    version: string;
+    commit: string;
+}
+interface HostHelloData {
+    capabilities: string[];
+    authToken?: string;
+}
+interface LoadRequestData {
+    docId: string;
+}
+interface LoadResponseDataOk {
+    ok: true;
+    bytes: ArrayBuffer;
+    etag?: string;
+    fileName: string;
+    readOnly?: boolean;
+}
+interface LoadResponseDataErr {
+    ok: false;
+    code: string;
+    message?: string;
+}
+type LoadResponseData = LoadResponseDataOk | LoadResponseDataErr;
+interface SaveRequestData {
+    docId: string;
+    bytes: ArrayBuffer;
+    baseEtag?: string;
+}
+interface SaveResponseDataOk {
+    ok: true;
+    etag: string;
+}
+interface SaveResponseDataErr {
+    ok: false;
+    code: string;
+    etag?: string;
+    message?: string;
+}
+type SaveResponseData = SaveResponseDataOk | SaveResponseDataErr;
+interface SelectionChangedData {
+    docs?: {
+        paraId: string;
+        from: number;
+        to: number;
+        selectedText: string;
+    };
+    sheet?: {
+        sheet: string;
+        from: string;
+        to: string;
+    };
+}
+interface TelemetryEventData {
+    kind: string;
+    /** Arbitrary metric fields. */
+    [k: string]: unknown;
+}
+interface LockLostData {
+    reason: 'taken_by_other' | 'expired' | 'host_revoked';
+}
+interface CommandSetReadOnlyData {
+    readOnly: boolean;
+}
+interface CommandSetThemeData {
+    theme: 'light' | 'dark' | 'system';
+}
+interface CommandSetLocaleData {
+    locale: string;
+}
+/** Host → editor: switch chrome density between the two consumer-facing
+ *  modes without re-mounting. `preview` hides toolbar / formula bar /
+ *  side panel / status bar / sheet tabs and runs read-only; `editor`
+ *  shows the full UI. Mirrors the `viewMode` prop on `<CasualSheetsIframe>`. */
+interface CommandSetViewModeData {
+    viewMode: 'preview' | 'editor';
+}
+/** Host → editor: execute a formatting / navigation command against
+ *  the active selection in the embedded workbook. Hosts (like Casual
+ *  Drive) build their own toolbar above the iframe and dispatch these
+ *  commands instead of Univer's built-in ribbon, which the SDK can't
+ *  ship because the ribbon resolves IRPCChannelService at construction
+ *  and that service needs a worker the SDK doesn't bundle.
+ *
+ *  v0.6 covered the toggle set; v0.7 adds the rich-format set (font,
+ *  size, colour, fill) + merge / unmerge. Arg-carrying commands read
+ *  the relevant field off `args` — every other command ignores it. */
+interface CommandExecuteData {
+    command: 'undo' | 'redo' | 'bold' | 'italic' | 'underline' | 'strikethrough' | 'align-left' | 'align-center' | 'align-right' | 'set-font-family' | 'set-font-size' | 'set-text-color' | 'reset-text-color' | 'set-bg-color' | 'reset-bg-color' | 'merge' | 'unmerge' | 'numfmt-currency' | 'numfmt-percent' | 'numfmt-add-decimal' | 'numfmt-subtract-decimal' | 'numfmt-custom' | 'wrap-toggle' | 'freeze-first-row' | 'freeze-first-column' | 'freeze-none';
+    args?: {
+        /** Used by `set-font-family`. */
+        family?: string;
+        /** Used by `set-font-size`. Integer point size. */
+        size?: number;
+        /** Used by `set-text-color` and `set-bg-color`. Hex like `#1a73e8`. */
+        color?: string;
+        /** Used by `numfmt-custom`. The Excel-style format string, e.g.
+         *  `"#,##0.00"`, `"$#,##0"`, `"0.00%"`, `"d-mmm-yy"`. v0.8+. */
+        pattern?: string;
+    };
+}
+/** Editor → host: emitted whenever the selection's active cell's
+ *  format flags change. Drive's toolbar mirrors this state in the
+ *  button "pressed" / value indicators so the surface always reflects
+ *  what the user would see in the cell. v0.7 widens the payload with
+ *  the rich-format read-back (fontFamily, fontSize, textColor, bgColor)
+ *  so the toolbar's font picker / size stepper / colour swatches stay
+ *  in sync without the host having to poll. */
+interface SelectionFormatStateData {
+    bold: boolean;
+    italic: boolean;
+    underline: boolean;
+    strikethrough: boolean;
+    align: 'left' | 'center' | 'right' | null;
+    /** Defined font family on the active cell, or null when the cell
+     *  inherits the workbook default. v0.7+. */
+    fontFamily: string | null;
+    /** Defined font size on the active cell, or null when the cell
+     *  inherits the workbook default. v0.7+. */
+    fontSize: number | null;
+    /** Hex text colour like `#1a73e8`, or null when default. v0.7+. */
+    textColor: string | null;
+    /** Hex background colour, or null when no fill is set. v0.7+. */
+    bgColor: string | null;
+}
+/** Editor → host: a fatal error during boot / load. Hosts surface this
+ *  via the wrapper's `onError` callback. */
+interface CasualErrorData {
+    code: 'embed_not_served' | 'load_failed' | 'parse_failed' | 'boot_failed' | 'internal';
+    message: string;
+}
+interface SignatureRequestData {
+    fields: SignatureField[];
+    mode: SignatureMode;
+    banner?: string;
+}
+interface SignatureRequestAckData {
+    ok: boolean;
+    code?: string;
+}
+type SignatureFieldSignedData = SignedFieldPayload;
+type SignatureCompleteData = SignatureCompletePayload;
+interface SignatureCancelData {
+    reason: CancelReason;
+}
+declare function isCasualEnvelope(value: unknown): value is CasualEnvelope;
+
+export { type CasualApp as C, type EditorHelloData as E, type HostHelloData as H, type LoadRequestData as L, type SaveRequestData as S, type TelemetryEventData as T, type CasualEnvelope as a, type CasualErrorData as b, type CommandExecuteData as c, type CommandSetLocaleData as d, type CommandSetReadOnlyData as e, type CommandSetThemeData as f, type CommandSetViewModeData as g, type LoadResponseData as h, type LoadResponseDataErr as i, type LoadResponseDataOk as j, type LockLostData as k, type SaveResponseData as l, type SaveResponseDataErr as m, type SaveResponseDataOk as n, type SelectionChangedData as o, type SelectionFormatStateData as p, type SignatureCancelData as q, type SignatureCompleteData as r, type SignatureFieldSignedData as s, type SignatureRequestAckData as t, type SignatureRequestData as u, isCasualEnvelope as v };

package/dist/protocol-cEzy7S0i.d.ts

@@ -0,0 +1,171 @@
+import { c as SignatureField, e as SignatureMode, C as CancelReason, f as SignedFieldPayload, b as SignatureCompletePayload } from './types-s_O0u6Cg.js';
+
+/**
+ * Iframe protocol — wire envelopes that match
+ * `docs/internal/13-iframe-protocol.md`.
+ *
+ * Mirror updates to the doc whenever a new envelope shape lands.
+ * The discriminator on `type` (always starts with `casual.`) and
+ * the per-envelope `data` shape are the contract.
+ */
+
+type CasualApp = 'docs' | 'sheet';
+/** Common envelope shape — every postMessage on the wire matches this. */
+interface CasualEnvelope<T = unknown> {
+    type: string;
+    app: CasualApp;
+    /** Per-request id for request/response correlation. Empty for fire-and-forget. */
+    id?: string;
+    /** Protocol version. Bumped only on breaking changes. */
+    v: 1;
+    data: T;
+}
+interface EditorHelloData {
+    capabilities: string[];
+    version: string;
+    commit: string;
+}
+interface HostHelloData {
+    capabilities: string[];
+    authToken?: string;
+}
+interface LoadRequestData {
+    docId: string;
+}
+interface LoadResponseDataOk {
+    ok: true;
+    bytes: ArrayBuffer;
+    etag?: string;
+    fileName: string;
+    readOnly?: boolean;
+}
+interface LoadResponseDataErr {
+    ok: false;
+    code: string;
+    message?: string;
+}
+type LoadResponseData = LoadResponseDataOk | LoadResponseDataErr;
+interface SaveRequestData {
+    docId: string;
+    bytes: ArrayBuffer;
+    baseEtag?: string;
+}
+interface SaveResponseDataOk {
+    ok: true;
+    etag: string;
+}
+interface SaveResponseDataErr {
+    ok: false;
+    code: string;
+    etag?: string;
+    message?: string;
+}
+type SaveResponseData = SaveResponseDataOk | SaveResponseDataErr;
+interface SelectionChangedData {
+    docs?: {
+        paraId: string;
+        from: number;
+        to: number;
+        selectedText: string;
+    };
+    sheet?: {
+        sheet: string;
+        from: string;
+        to: string;
+    };
+}
+interface TelemetryEventData {
+    kind: string;
+    /** Arbitrary metric fields. */
+    [k: string]: unknown;
+}
+interface LockLostData {
+    reason: 'taken_by_other' | 'expired' | 'host_revoked';
+}
+interface CommandSetReadOnlyData {
+    readOnly: boolean;
+}
+interface CommandSetThemeData {
+    theme: 'light' | 'dark' | 'system';
+}
+interface CommandSetLocaleData {
+    locale: string;
+}
+/** Host → editor: switch chrome density between the two consumer-facing
+ *  modes without re-mounting. `preview` hides toolbar / formula bar /
+ *  side panel / status bar / sheet tabs and runs read-only; `editor`
+ *  shows the full UI. Mirrors the `viewMode` prop on `<CasualSheetsIframe>`. */
+interface CommandSetViewModeData {
+    viewMode: 'preview' | 'editor';
+}
+/** Host → editor: execute a formatting / navigation command against
+ *  the active selection in the embedded workbook. Hosts (like Casual
+ *  Drive) build their own toolbar above the iframe and dispatch these
+ *  commands instead of Univer's built-in ribbon, which the SDK can't
+ *  ship because the ribbon resolves IRPCChannelService at construction
+ *  and that service needs a worker the SDK doesn't bundle.
+ *
+ *  v0.6 covered the toggle set; v0.7 adds the rich-format set (font,
+ *  size, colour, fill) + merge / unmerge. Arg-carrying commands read
+ *  the relevant field off `args` — every other command ignores it. */
+interface CommandExecuteData {
+    command: 'undo' | 'redo' | 'bold' | 'italic' | 'underline' | 'strikethrough' | 'align-left' | 'align-center' | 'align-right' | 'set-font-family' | 'set-font-size' | 'set-text-color' | 'reset-text-color' | 'set-bg-color' | 'reset-bg-color' | 'merge' | 'unmerge' | 'numfmt-currency' | 'numfmt-percent' | 'numfmt-add-decimal' | 'numfmt-subtract-decimal' | 'numfmt-custom' | 'wrap-toggle' | 'freeze-first-row' | 'freeze-first-column' | 'freeze-none';
+    args?: {
+        /** Used by `set-font-family`. */
+        family?: string;
+        /** Used by `set-font-size`. Integer point size. */
+        size?: number;
+        /** Used by `set-text-color` and `set-bg-color`. Hex like `#1a73e8`. */
+        color?: string;
+        /** Used by `numfmt-custom`. The Excel-style format string, e.g.
+         *  `"#,##0.00"`, `"$#,##0"`, `"0.00%"`, `"d-mmm-yy"`. v0.8+. */
+        pattern?: string;
+    };
+}
+/** Editor → host: emitted whenever the selection's active cell's
+ *  format flags change. Drive's toolbar mirrors this state in the
+ *  button "pressed" / value indicators so the surface always reflects
+ *  what the user would see in the cell. v0.7 widens the payload with
+ *  the rich-format read-back (fontFamily, fontSize, textColor, bgColor)
+ *  so the toolbar's font picker / size stepper / colour swatches stay
+ *  in sync without the host having to poll. */
+interface SelectionFormatStateData {
+    bold: boolean;
+    italic: boolean;
+    underline: boolean;
+    strikethrough: boolean;
+    align: 'left' | 'center' | 'right' | null;
+    /** Defined font family on the active cell, or null when the cell
+     *  inherits the workbook default. v0.7+. */
+    fontFamily: string | null;
+    /** Defined font size on the active cell, or null when the cell
+     *  inherits the workbook default. v0.7+. */
+    fontSize: number | null;
+    /** Hex text colour like `#1a73e8`, or null when default. v0.7+. */
+    textColor: string | null;
+    /** Hex background colour, or null when no fill is set. v0.7+. */
+    bgColor: string | null;
+}
+/** Editor → host: a fatal error during boot / load. Hosts surface this
+ *  via the wrapper's `onError` callback. */
+interface CasualErrorData {
+    code: 'embed_not_served' | 'load_failed' | 'parse_failed' | 'boot_failed' | 'internal';
+    message: string;
+}
+interface SignatureRequestData {
+    fields: SignatureField[];
+    mode: SignatureMode;
+    banner?: string;
+}
+interface SignatureRequestAckData {
+    ok: boolean;
+    code?: string;
+}
+type SignatureFieldSignedData = SignedFieldPayload;
+type SignatureCompleteData = SignatureCompletePayload;
+interface SignatureCancelData {
+    reason: CancelReason;
+}
+declare function isCasualEnvelope(value: unknown): value is CasualEnvelope;
+
+export { type CasualApp as C, type EditorHelloData as E, type HostHelloData as H, type LoadRequestData as L, type SaveRequestData as S, type TelemetryEventData as T, type CasualEnvelope as a, type CasualErrorData as b, type CommandExecuteData as c, type CommandSetLocaleData as d, type CommandSetReadOnlyData as e, type CommandSetThemeData as f, type CommandSetViewModeData as g, type LoadResponseData as h, type LoadResponseDataErr as i, type LoadResponseDataOk as j, type LockLostData as k, type SaveResponseData as l, type SaveResponseDataErr as m, type SaveResponseDataOk as n, type SelectionChangedData as o, type SelectionFormatStateData as p, type SignatureCancelData as q, type SignatureCompleteData as r, type SignatureFieldSignedData as s, type SignatureRequestAckData as t, type SignatureRequestData as u, isCasualEnvelope as v };