ooxml-core 1.19.2 → 1.21.0

package/dist/{chunk-M6GDBVQ7.mjs → chunk-VQF6HQEE.mjs}

@@ -1,4 +1,4 @@
-import { hasTextProperties, isImageLikeElement, blobUrlToDataUrl, getSubstituteFontFamily, stripXmlOrderSuffix } from './chunk-SLNQNVQM.mjs';
+import { hasTextProperties, isImageLikeElement, blobUrlToDataUrl, getSubstituteFontFamily, stripXmlOrderSuffix } from './chunk-4QPOJCJG.mjs';
 
 // pptx/converter/media-context.ts
 var MIME_TO_EXT = {

package/dist/collab/embedding.d.ts

@@ -0,0 +1,103 @@
+import type { ExternalSession } from './external-provider.js';
+import type { CollaborationRole } from './identity.js';
+import type { ConnectionStatus, ProviderFactory } from './provider.js';
+import { type CollabSession } from './session.js';
+/** Who this window is in the room. */
+export interface CollaborationUser {
+    /** Display name; each editor falls back to its own author name. */
+    name?: string;
+    /** Hex colour; defaults to a palette colour derived from the client id. */
+    color?: string;
+    avatar?: string;
+    /** `viewer` makes the editor read-only (advisory: a server must enforce it). */
+    role?: CollaborationRole;
+}
+/**
+ * How an editor joins a shared document. One transport is used, in this order: `session`
+ * (host-owned, never destroyed by the editor), `provider`, `serverUrl` (a y-websocket compatible
+ * server), else a BroadcastChannel between tabs and windows of this browser. `P` is the product's
+ * presence payload, only relevant to a host-made `session`.
+ */
+export interface CollaborationOptions<P extends object = object> {
+    /** Room name: 1-128 letters, digits, hyphens or underscores. Not needed with `session`. */
+    roomId?: string;
+    /** Base URL of a y-websocket compatible server (`wss://host/collab`); the room is appended. */
+    serverUrl?: string;
+    /** A provider factory of your own (WebRTC, or an existing provider through `adaptYjsProvider`). */
+    provider?: ProviderFactory;
+    /**
+     * A session the host created, connected and will destroy. Create it with the product's
+     * presence sanitiser so peers validate each other the same way.
+     */
+    session?: CollabSession<P>;
+    user?: CollaborationUser;
+    /**
+     * `join` never seeds an empty room with the local document, `create` may. Products whose
+     * model merges (Excel) seed an empty room either way and ignore it. Default `create`.
+     */
+    intent?: 'create' | 'join';
+}
+/** One person in the room, as title bars and `collaboration-change` list them. */
+export interface Collaborator {
+    clientId: number;
+    name: string;
+    color: string;
+    self: boolean;
+}
+/** Reported by every editor's `collaborationState` and `collaboration-change` event. */
+export interface CollaborationState {
+    active: boolean;
+    roomId: string | undefined;
+    /** `off` when not sharing; otherwise the provider's connection status. */
+    status: ConnectionStatus | 'off';
+    /** The first exchange with the room finished. */
+    synced: boolean;
+    people: Collaborator[];
+}
+/** The event every editor element dispatches, with a {@link CollaborationState} detail. */
+export declare const COLLABORATION_CHANGE_EVENT = "collaboration-change";
+export declare const COLLABORATION_OFF_STATE: CollaborationState;
+/**
+ * What every editor element exposes, whatever its product. `collaboration` is declarative: while
+ * set, the open document is shared; `null` leaves the room.
+ */
+export interface CollaborativeEditor<P extends object = object> {
+    collaboration: CollaborationOptions<P> | null;
+    readonly collaborationState: CollaborationState;
+    /** Leave the room and clear `collaboration`. A host-owned session stays alive. */
+    stopCollaboration(): void;
+    /** Restart the connection, keeping the shared document and queued offline changes. */
+    reconnectCollaboration(): void;
+}
+/** The product-specific parts of a room session an editor opens itself. */
+export interface RoomSessionDefaults<P extends object> {
+    /** The user name when `options.user.name` is empty (the editor's author name). */
+    defaultName: string;
+    /** BroadcastChannel name prefix, one per product so their rooms never cross. */
+    broadcastPrefix: string;
+    sanitizePayload?: (raw: Record<string, unknown>) => P | null;
+    initialPresence?: P;
+}
+export declare const INVALID_ROOM_MESSAGE = "Use 1 to 128 letters, digits, hyphens or underscores for the room name.";
+export declare const NO_BROADCAST_MESSAGE = "This browser cannot share between windows; pass a server URL.";
+/**
+ * The session for `options`: the host's own (`owned: false`, never destroy it) or a new one this
+ * caller owns, connected through `provider`, `serverUrl` or a BroadcastChannel, with pagehide
+ * teardown. Throws {@link INVALID_ROOM_MESSAGE} or {@link NO_BROADCAST_MESSAGE}.
+ */
+export declare function openCollaborationSession<P extends object>(options: CollaborationOptions<P>, defaults: RoomSessionDefaults<P>): {
+    session: CollabSession<P>;
+    owned: boolean;
+};
+/** The {@link CollaborationState} of a joined session, this window first. */
+export declare function collaborationStateOf(session: CollabSession<object>): CollaborationState;
+/** Calls `listener` whenever the session's {@link CollaborationState} may have changed. */
+export declare function onCollaborationStateChange(session: CollabSession<object>, listener: () => void): () => void;
+/**
+ * A {@link CollabSession} as the borrowed {@link ExternalSession} that viewers taking host-owned
+ * Yjs resources observe (PowerPoint's `externalSession`). `synced` is the session's write gate:
+ * open once the provider synced, or after the grace period for a lone peer on a mesh. The view
+ * never connects or destroys the session.
+ */
+export declare function toExternalSession(session: CollabSession<object>): ExternalSession;
+//# sourceMappingURL=embedding.d.ts.map

package/dist/collab/embedding.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"embedding.d.ts","sourceRoot":"","sources":["../../collab/embedding.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,eAAe,EAAoB,MAAM,qBAAqB,CAAC;AAC7E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AACpD,OAAO,KAAK,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AACpE,OAAO,EAAE,KAAK,aAAa,EAAuB,MAAM,WAAW,CAAC;AAKpE,sCAAsC;AACtC,MAAM,WAAW,iBAAiB;IACjC,mEAAmE;IACnE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,2EAA2E;IAC3E,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,gFAAgF;IAChF,IAAI,CAAC,EAAE,iBAAiB,CAAC;CACzB;AAED;;;;;GAKG;AACH,MAAM,WAAW,oBAAoB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM;IAC9D,2FAA2F;IAC3F,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,+FAA+F;IAC/F,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,mGAAmG;IACnG,QAAQ,CAAC,EAAE,eAAe,CAAC;IAC3B;;;OAGG;IACH,OAAO,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;IAC3B,IAAI,CAAC,EAAE,iBAAiB,CAAC;IACzB;;;OAGG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;CAC3B;AAED,kFAAkF;AAClF,MAAM,WAAW,YAAY;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,OAAO,CAAC;CACd;AAED,wFAAwF;AACxF,MAAM,WAAW,kBAAkB;IAClC,MAAM,EAAE,OAAO,CAAC;IAChB,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,0EAA0E;IAC1E,MAAM,EAAE,gBAAgB,GAAG,KAAK,CAAC;IACjC,iDAAiD;IACjD,MAAM,EAAE,OAAO,CAAC;IAChB,MAAM,EAAE,YAAY,EAAE,CAAC;CACvB;AAED,2FAA2F;AAC3F,eAAO,MAAM,0BAA0B,yBAAyB,CAAC;AAEjE,eAAO,MAAM,uBAAuB,EAAE,kBAMpC,CAAC;AAEH;;;GAGG;AACH,MAAM,WAAW,mBAAmB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM;IAC7D,aAAa,EAAE,oBAAoB,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAC9C,QAAQ,CAAC,kBAAkB,EAAE,kBAAkB,CAAC;IAChD,kFAAkF;IAClF,iBAAiB,IAAI,IAAI,CAAC;IAC1B,sFAAsF;IACtF,sBAAsB,IAAI,IAAI,CAAC;CAC/B;AAED,2EAA2E;AAC3E,MAAM,WAAW,mBAAmB,CAAC,CAAC,SAAS,MAAM;IACpD,kFAAkF;IAClF,WAAW,EAAE,MAAM,CAAC;IACpB,gFAAgF;IAChF,eAAe,EAAE,MAAM,CAAC;IACxB,eAAe,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;IAC7D,eAAe,CAAC,EAAE,CAAC,CAAC;CACpB;AAED,eAAO,MAAM,oBAAoB,4EACyC,CAAC;AAC3E,eAAO,MAAM,oBAAoB,kEAAkE,CAAC;AAEpG;;;;GAIG;AACH,wBAAgB,wBAAwB,CAAC,CAAC,SAAS,MAAM,EACxD,OAAO,EAAE,oBAAoB,CAAC,CAAC,CAAC,EAChC,QAAQ,EAAE,mBAAmB,CAAC,CAAC,CAAC,GAC9B;IAAE,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;IAAC,KAAK,EAAE,OAAO,CAAA;CAAE,CA8B/C;AAED,6EAA6E;AAC7E,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,GAAG,kBAAkB,CAqBvF;AAED,2FAA2F;AAC3F,wBAAgB,0BAA0B,CACzC,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,EAC9B,QAAQ,EAAE,MAAM,IAAI,GAClB,MAAM,IAAI,CASZ;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,GAAG,eAAe,CAuBjF"}