kritzel-stencil 0.4.23 → 0.4.25

package/dist/types/classes/providers/sync/websocket-sync-provider.class.d.ts

@@ -47,11 +47,8 @@ export declare class WebSocketSyncProvider implements ISyncProvider {
     private provider;
     private isConnected;
     private _quiet;
-    private _isSynced;
-    private _syncedResolvers;
     get awareness(): Awareness;
-    /** y-websocket applies remote updates with the underlying provider as the Yjs transaction origin. */
-    get updateOrigin(): unknown;
+    get rawProvider(): unknown;
     constructor(docName: string, doc: Y.Doc, options?: WebSocketOptions);
     /**
      * Static factory method for creating WebSocketSyncProvider with configuration options
@@ -59,8 +56,6 @@ export declare class WebSocketSyncProvider implements ISyncProvider {
      */
     static with(options?: WebSocketOptions): ProviderFactory;
     private setupEventListeners;
-    private releaseSyncedWaiters;
-    whenSynced(): Promise<void>;
     connect(): Promise<void>;
     disconnect(): void;
     reconnect(): Promise<void>;

package/dist/types/classes/structures/object-map.structure.d.ts

@@ -34,13 +34,14 @@ export declare class KritzelObjectMap<T extends KritzelBaseObject<any>> {
     private _awarenessChangeHandler;
     private _awarenessChangeCallbacks;
     private _objectsChangeCallbacks;
-    private _remoteChangesCallbacks;
-    private _docUpdateHandler;
-    private _remoteOrigins;
-    private _appliedRemoteChanges;
     private _lastAwarenessEmitTime;
     private _awarenessEmitTimeout;
     private readonly AWARENESS_THROTTLE_INTERVAL;
+    private _networkTransactionOrigins;
+    private _isSyncing;
+    private _syncingChangeCallbacks;
+    private _beforeTransactionHandler;
+    private _afterAllTransactionsHandler;
     /**
      * When true, update() only modifies local state (quadtree + idMap)
      * without writing to Yjs. Used during drag operations to avoid
@@ -59,30 +60,10 @@ export declare class KritzelObjectMap<T extends KritzelBaseObject<any>> {
      */
     get isReady(): boolean;
     /**
-     * Promise that settles when network providers finish connecting and complete
-     * their Yjs sync handshake. Resolves immediately if no network providers.
+     * Promise that settles when network providers finish connecting.
+     * Resolves immediately if no network providers. Awaited by the loading overlay.
      */
     whenNetworkSynced(): Promise<void>;
-    /**
-     * Whether any configured provider synchronizes over the network.
-     */
-    get hasNetworkSyncProvider(): boolean;
-    /**
-     * Whether remote-originated changes can be told apart from local writes.
-     * Requires every network provider to expose its Yjs update origin.
-     */
-    get supportsRemoteChangeDetection(): boolean;
-    /**
-     * Whether at least one update originating from a network provider has been
-     * applied to this document. Stays `false` when the remote held no data the
-     * local document was missing, because Yjs suppresses empty updates.
-     */
-    get hasAppliedRemoteChanges(): boolean;
-    /**
-     * Registers a callback invoked whenever a network provider applies changes to this document.
-     * @returns A function that unregisters the callback.
-     */
-    onRemoteChangesApplied(callback: () => void): () => void;
     /**
      * Returns the Yjs Awareness instance, if a network provider is available.
      */
@@ -149,6 +130,15 @@ export declare class KritzelObjectMap<T extends KritzelBaseObject<any>> {
      * from the latest object data when a remote user is actively drawing.
      */
     onObjectsChange(callback: () => void): () => void;
+    /**
+     * Whether the local copy currently differs from data a remote peer is in the process of merging in.
+     */
+    get isSyncing(): boolean;
+    /**
+     * Registers a callback invoked when a remote sync starts (`true`) or finishes (`false`).
+     * "Starts" fires from `beforeTransaction`, before the incoming remote update is merged.
+     */
+    onSyncingChange(callback: (isSyncing: boolean) => void): () => void;
     /**
      * Returns the Yjs UndoManager instance for managing undo/redo operations.
      * @returns The UndoManager instance, or `null` if not initialized

package/dist/types/components/core/kritzel-editor/kritzel-editor.d.ts

@@ -92,9 +92,7 @@ export declare class KritzelEditor {
     login: EventEmitter<LoginEvent>;
     isPublicChange: EventEmitter<IKritzelIsPublicChangedEvent>;
     awarenessChange: EventEmitter<Map<number, Record<string, any>>>;
-    /** Emitted while remote changes are being applied to the active workspace. Stays silent when the remote holds nothing new. */
-    syncingChange: EventEmitter<boolean>;
-    loadingChange: EventEmitter<boolean>;
+    isSyncing: EventEmitter<boolean>;
     isEngineReady: boolean;
     isControlsReady: boolean;
     isWorkspaceManagerReady: boolean;
@@ -119,8 +117,8 @@ export declare class KritzelEditor {
     contextMenuState?: KritzelContextMenuState;
     normalizedControls: KritzelToolbarControl[];
     resolvedMoreMenuItems: IKritzelMenuItem[];
-    isSyncing: boolean;
     isLoadingOverlayVisible: boolean;
+    isSyncingIndicatorVisible: boolean;
     private notificationDismissTimeout?;
     private notificationDismissAnimationTimeout?;
     private readonly notificationDisplayDurationMs;
@@ -266,6 +264,7 @@ export declare class KritzelEditor {
     handleViewportChange(event: CustomEvent<KritzelViewportState>): void;
     private getZoomPercentFromScale;
     handleAwarenessChange(event: CustomEvent<Map<number, Record<string, any>>>): void;
+    handleIsSyncingChange(event: CustomEvent<boolean>): void;
     handleNotificationsChange(event: CustomEvent<KritzelNotification>): void;
     handleContextMenuStateChange(event: CustomEvent<KritzelContextMenuState>): void;
     private handleContextMenuActionSelected;

package/dist/types/components/core/kritzel-engine/kritzel-engine.d.ts

@@ -140,16 +140,15 @@ export declare class KritzelEngine {
     viewportChange: EventEmitter<KritzelViewportState>;
     /** Emitted when the awareness state changes (remote user cursors, presence). */
     awarenessChange: EventEmitter<Map<number, Record<string, any>>>;
+    /** Emitted when a remote sync starts (`true`, data differs from the local copy) or finishes (`false`). */
+    isSyncing: EventEmitter<boolean>;
     /** Emitted when notifications change. */
     notificationsChange: EventEmitter<KritzelNotification>;
     /** Emitted when context-menu visibility, items, or position changes. */
     contextMenuStateChange: EventEmitter<KritzelContextMenuState>;
     /** Emitted when the combined loading state (external `isLoading` prop or internal workspace loading) changes. */
     loadingChange: EventEmitter<boolean>;
-    /** Emitted while remote changes are being applied to the active workspace. Stays silent when the remote holds nothing new. */
-    syncingChange: EventEmitter<boolean>;
     forceUpdate: number;
-    isSyncing: boolean;
     /** Manually triggers the `objectsSelectionChange` event. */
     triggerSelectionChange(): Promise<void>;
     /** Starts a scene bootstrap phase by hiding the scene immediately. */
@@ -634,7 +633,6 @@ export declare class KritzelEngine {
     private _sceneBootstrapOpacity;
     private _sceneBootstrapTransitionEnabled;
     private _sceneBootstrapTransitionTimer;
-    private _remoteChangesUnsubscribe;
     private readonly _defaultUndoState;
     private readonly _objectDistanceFadeNearScale;
     private readonly _objectDistanceFadeFarScale;
@@ -643,8 +641,6 @@ export declare class KritzelEngine {
     private readonly _objectDistanceFadeCloseMaxScale;
     private readonly _objectDistanceFadeCloseMinOpacity;
     private syncLoadingState;
-    private syncSyncingState;
-    private clearRemoteChangesSubscription;
     private isNetworkAvailable;
     private emitContextMenuStateChange;
     private applyToolConfig;
@@ -682,12 +678,6 @@ export declare class KritzelEngine {
     private tryResolveActiveWorkspaceFromId;
     private switchToWorkspaceById;
     private initializeWorkspaceIfNeeded;
-    /**
-     * Reports syncing only while remote data is actually being reconciled into the
-     * active workspace. Yjs suppresses updates that carry nothing new, so a workspace
-     * that already matches the remote never reports syncing at all.
-     */
-    private trackRemoteSynchronization;
     emitObjectsChange(): void;
     emitObjectsAdded(objects: KritzelBaseObject<any>[]): void;
     emitObjectsRemoved(objects: KritzelBaseObject<any>[]): void;
@@ -696,6 +686,7 @@ export declare class KritzelEngine {
         changedProperties: string[];
     }[]): void;
     emitAwarenessChange(states: Map<number, Record<string, any>>): void;
+    emitIsSyncing(isSyncing: boolean): void;
     emitObjectsInViewportChange(): void;
     private _registerStateChangeListeners;
     private _handleActiveToolChange;

package/dist/types/components.d.ts

@@ -2003,8 +2003,7 @@ declare global {
         "login": LoginEvent;
         "isPublicChange": IKritzelIsPublicChangedEvent;
         "awarenessChange": Map<number, Record<string, any>>;
-        "syncingChange": boolean;
-        "loadingChange": boolean;
+        "isSyncing": boolean;
     }
     interface HTMLKritzelEditorElement extends Components.KritzelEditor, HTMLStencilElement {
         addEventListener<K extends keyof HTMLKritzelEditorElementEventMap>(type: K, listener: (this: HTMLKritzelEditorElement, ev: KritzelEditorCustomEvent<HTMLKritzelEditorElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -2035,10 +2034,10 @@ declare global {
         "objectsInViewportChange": ObjectsInViewportChangeEvent;
         "viewportChange": KritzelViewportState;
         "awarenessChange": Map<number, Record<string, any>>;
+        "isSyncing": boolean;
         "notificationsChange": KritzelNotification;
         "contextMenuStateChange": KritzelContextMenuState;
         "loadingChange": boolean;
-        "syncingChange": boolean;
     }
     interface HTMLKritzelEngineElement extends Components.KritzelEngine, HTMLStencilElement {
         addEventListener<K extends keyof HTMLKritzelEngineElementEventMap>(type: K, listener: (this: HTMLKritzelEngineElement, ev: KritzelEngineCustomEvent<HTMLKritzelEngineElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -3013,7 +3012,7 @@ declare namespace LocalJSX {
         "onAwarenessChange"?: (event: KritzelEditorCustomEvent<Map<number, Record<string, any>>>) => void;
         "onIsPublicChange"?: (event: KritzelEditorCustomEvent<IKritzelIsPublicChangedEvent>) => void;
         "onIsReady"?: (event: KritzelEditorCustomEvent<EditorIsReadyEvent>) => void;
-        "onLoadingChange"?: (event: KritzelEditorCustomEvent<boolean>) => void;
+        "onIsSyncing"?: (event: KritzelEditorCustomEvent<boolean>) => void;
         "onLocaleChange"?: (event: KritzelEditorCustomEvent<LocaleCode>) => void;
         "onLogin"?: (event: KritzelEditorCustomEvent<LoginEvent>) => void;
         "onLogout"?: (event: KritzelEditorCustomEvent<void>) => void;
@@ -3021,10 +3020,6 @@ declare namespace LocalJSX {
         "onObjectsChange"?: (event: KritzelEditorCustomEvent<KritzelBaseObject[]>) => void;
         "onObjectsRemoved"?: (event: KritzelEditorCustomEvent<ObjectsRemovedEvent>) => void;
         "onObjectsUpdated"?: (event: KritzelEditorCustomEvent<ObjectsUpdatedEvent>) => void;
-        /**
-          * Emitted while remote changes are being applied to the active workspace. Stays silent when the remote holds nothing new.
-         */
-        "onSyncingChange"?: (event: KritzelEditorCustomEvent<boolean>) => void;
         "onThemeChange"?: (event: KritzelEditorCustomEvent<ThemeName>) => void;
         "onUndoStateChange"?: (event: KritzelEditorCustomEvent<KritzelUndoState1>) => void;
         "onViewportChange"?: (event: KritzelEditorCustomEvent<KritzelViewportState>) => void;
@@ -3155,6 +3150,10 @@ declare namespace LocalJSX {
           * Emitted when the engine has fully initialized and is ready for interaction.
          */
         "onIsEngineReady"?: (event: KritzelEngineCustomEvent<KritzelEngineState>) => void;
+        /**
+          * Emitted when a remote sync starts (`true`, data differs from the local copy) or finishes (`false`).
+         */
+        "onIsSyncing"?: (event: KritzelEngineCustomEvent<boolean>) => void;
         /**
           * Emitted when the combined loading state (external `isLoading` prop or internal workspace loading) changes.
          */
@@ -3191,10 +3190,6 @@ declare namespace LocalJSX {
           * Emitted when one or more objects are updated on the canvas.
          */
         "onObjectsUpdated"?: (event: KritzelEngineCustomEvent<ObjectsUpdatedEvent>) => void;
-        /**
-          * Emitted while remote changes are being applied to the active workspace. Stays silent when the remote holds nothing new.
-         */
-        "onSyncingChange"?: (event: KritzelEngineCustomEvent<boolean>) => void;
         /**
           * Emitted when the undo/redo state changes, providing current undo availability.
          */

package/dist/types/constants/version.d.ts

@@ -3,4 +3,4 @@
  * This file is auto-generated by the version bump scripts.
  * Do not modify manually.
  */
-export declare const KRITZEL_VERSION = "0.4.23";
+export declare const KRITZEL_VERSION = "0.4.25";

package/dist/types/interfaces/sync-provider.interface.d.ts

@@ -23,22 +23,16 @@ export interface ISyncProvider {
      */
     readonly awareness?: Awareness | null;
     /**
-     * The object this provider passes as the Yjs transaction origin when it applies
-     * updates it received from its peer. Consumers use it to tell remote-originated
-     * changes apart from local writes. Providers that cannot expose it opt out of
-     * remote-change detection.
+     * The underlying third-party provider instance (e.g. `WebsocketProvider`, `HocuspocusProvider`)
+     * used as the Yjs transaction origin for updates it applies. Exposed so callers can
+     * distinguish genuine remote-origin transactions from local-only providers (IndexedDB,
+     * BroadcastChannel), which don't tag their transactions with a recognizable origin.
      */
-    readonly updateOrigin?: unknown;
+    readonly rawProvider?: unknown;
     /**
      * Initialize and connect the provider
      */
     connect(): Promise<void>;
-    /**
-     * Resolves once the Yjs sync handshake with the peer has completed, which is
-     * later than `connect()` for providers that resolve on transport connection.
-     * Never rejects.
-     */
-    whenSynced?(): Promise<void>;
     /**
      * Disconnect the provider (can be reconnected later)
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kritzel-stencil",
-  "version": "0.4.23",
+  "version": "0.4.25",
   "homepage": "https://kritzel.io/",
   "description": "Kritzel helps you build infinite whiteboard experiences.",
   "keywords": [