@templatical/core 0.51.1 → 0.52.0

package/dist/index.d.ts

@@ -1,7 +1,6 @@
 import { Block, BlockDefaults, BlockLock, BlockLockHolder, BlockType, CollaborationActor, CollaborationConflictCode, CollaborationConnectionState, CollaborationMember, CollaborationProvider, CollaborationRemoteChange, Comment, CommentAuthor, CommentInput, CommentPatch, CommentsListParams, CommentsProvider, CustomBlock, CustomBlockDefinition, MediaProvider, Operation, OperationError, SavedBlock, SavedBlockPatch, SavedBlocksListParams, SavedBlocksProvider, Template, TemplateContent, TemplateDefaults, TemplateSaveTrigger, TemplateSettings, TemplateVersion, TemplatesProvider, UiTheme, VersionHistoryListParams, VersionHistoryProvider, ViewportSize, invertOperations } from "@templatical/types";
 import { ComputedRef, DeepReadonly, Ref } from "@vue/reactivity";
 import { ComputedRef as ComputedRef$1, Ref as Ref$1 } from "vue";
-//#region src/editor.d.ts
 interface EditorState {
   /**
    * The template currently being edited, as the store last returned it — `null`
@@ -107,8 +106,6 @@ interface UseEditorReturn {
   hasTemplate: () => boolean;
 }
 export declare function useEditor(options: UseEditorOptions): UseEditorReturn;
-//#endregion
-//#region src/history.d.ts
 interface UseHistoryOptions {
   content: Ref<TemplateContent>;
   setContent: (content: TemplateContent, markDirty?: boolean) => void;
@@ -126,8 +123,6 @@ interface UseHistoryReturn {
   destroy: () => void;
 }
 export declare function useHistory(options: UseHistoryOptions): UseHistoryReturn;
-//#endregion
-//#region src/block-actions.d.ts
 interface UseBlockActionsOptions {
   addBlock: (block: Block, targetSectionId?: string, columnIndex?: number, index?: number) => void;
   removeBlock: (blockId: string) => void;
@@ -157,8 +152,6 @@ interface UseBlockActionsReturn {
   updateBlockProperty: <K extends keyof Block>(blockId: string, key: K, value: Block[K]) => void;
 }
 export declare function useBlockActions(options: UseBlockActionsOptions): UseBlockActionsReturn;
-//#endregion
-//#region src/auto-save.d.ts
 interface UseAutoSaveOptions {
   content: Ref<TemplateContent>;
   isDirty: () => boolean;
@@ -189,8 +182,6 @@ interface UseAutoSaveReturn {
  */
 export declare const DEFAULT_AUTO_SAVE_DEBOUNCE_MS = 2000;
 export declare function useAutoSave(options: UseAutoSaveOptions): UseAutoSaveReturn;
-//#endregion
-//#region src/condition-preview.d.ts
 interface UseConditionPreviewReturn {
   isHidden: (blockId: string) => boolean;
   toggleBlock: (blockId: string) => void;
@@ -209,8 +200,6 @@ interface ConditionPreviewEditor {
   selectBlock: (blockId: string | null) => void;
 }
 export declare function useConditionPreview(editor: ConditionPreviewEditor): UseConditionPreviewReturn;
-//#endregion
-//#region src/data-source-fetch.d.ts
 export declare function useDataSourceFetch(options: {
   definition: ComputedRef<CustomBlockDefinition | undefined>;
   block: ComputedRef<CustomBlock>;
@@ -222,8 +211,6 @@ export declare function useDataSourceFetch(options: {
   hasDataSource: ComputedRef<boolean>;
   needsFetch: ComputedRef<boolean>;
 };
-//#endregion
-//#region src/history-interceptor.d.ts
 /**
  * The mutable slice of an editor this wraps — structural, so the OSS and Cloud
  * `useEditor` returns both satisfy it without either having to grow toward the
@@ -245,8 +232,6 @@ interface HistoryInterceptorEditor {
  * changes by diffing the content and keeps its own undo history.
  */
 export declare function useHistoryInterceptor(editor: HistoryInterceptorEditor, history: UseHistoryReturn): void;
-//#endregion
-//#region src/diff-content.d.ts
 /**
  * The operations that turn `before` into `after`. Blocks are matched by id, so
  * a drag comes out as a `moveBlock` and a layout change as a `columns` change
@@ -269,8 +254,6 @@ export declare function useHistoryInterceptor(editor: HistoryInterceptorEditor,
  * doesn't conflict with it, and locks keep two people off one block.
  */
 export declare function diffContent(before: TemplateContent, after: TemplateContent): Operation[];
-//#endregion
-//#region src/collaboration.d.ts
 /** The template fields the controller reads, as the editor's readonly state holds them. */
 type CollaborationTemplate = DeepReadonly<Pick<Template, "id" | "revision" | "content">>;
 /** The slice of the editor the controller reads and writes. */
@@ -419,8 +402,6 @@ interface UseCollaborationReturn {
  * stacks.
  */
 export declare function useCollaboration(options: UseCollaborationOptions): UseCollaborationReturn;
-//#endregion
-//#region src/saved-blocks.d.ts
 interface UseSavedBlocksOptions {
   /**
    * Storage backend. Supplied by the consumer via `init({ savedBlocks })`, or
@@ -486,8 +467,6 @@ interface UseSavedBlocksReturn {
  * re-thrown, leaving the local list untouched on failure.
  */
 export declare function useSavedBlocks(options: UseSavedBlocksOptions): UseSavedBlocksReturn;
-//#endregion
-//#region src/saved-blocks-local.d.ts
 interface LocalStorageSavedBlocksOptions {
   /**
    * `localStorage` key holding the serialized array.
@@ -509,8 +488,6 @@ interface LocalStorageSavedBlocksOptions {
  * that needs to outlive a browser profile.
  */
 export declare function createLocalStorageSavedBlocksProvider(options?: LocalStorageSavedBlocksOptions): SavedBlocksProvider;
-//#endregion
-//#region src/media-local.d.ts
 interface LocalStorageMediaProviderOptions {
   /**
    * `localStorage` key holding the serialized array.
@@ -534,8 +511,6 @@ interface LocalStorageMediaProviderOptions {
  * this adapter is a flat list of assets.
  */
 export declare function createLocalStorageMediaProvider(options?: LocalStorageMediaProviderOptions): MediaProvider;
-//#endregion
-//#region src/version-history.d.ts
 interface UseVersionHistoryOptions {
   /**
    * Storage backend. Supplied by the consumer via `init({ versionHistory })`,
@@ -603,8 +578,6 @@ interface UseVersionHistoryReturn {
  * decides that, because they are the side that pays for the storage.
  */
 export declare function useVersionHistory(options: UseVersionHistoryOptions): UseVersionHistoryReturn;
-//#endregion
-//#region src/comments.d.ts
 interface UseCommentsOptions {
   /**
    * Storage backend. Supplied by the consumer via `init({ comments })`, or by
@@ -697,6 +670,5 @@ interface UseCommentListenerOptions {
  * one's comments.
  */
 export declare function useCommentListener(options: UseCommentListenerOptions): void;
-//#endregion
 export { type CollaborationApplyOptions, type CollaborationApplyResult, type CollaborationEditor, type CollaborationNotice, type CollaborationRemoteResync, type CollaborationTemplate, type EditorState, type LocalStorageMediaProviderOptions, type LocalStorageSavedBlocksOptions, type UseAutoSaveOptions, type UseAutoSaveReturn, type UseBlockActionsOptions, type UseBlockActionsReturn, type UseCollaborationOptions, type UseCollaborationReturn, type UseCommentListenerOptions, type UseCommentsOptions, type UseCommentsReturn, type UseConditionPreviewReturn, type UseEditorOptions, type UseEditorReturn, type UseHistoryOptions, type UseHistoryReturn, type UseSavedBlocksOptions, type UseSavedBlocksReturn, type UseVersionHistoryOptions, type UseVersionHistoryReturn, invertOperations };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,7 +1,7 @@
 import { OperationError, SdkError, applyOperations, applyOperationsInPlace, assertNoSlotInContent, assertNoWrapperInContent, cloneBlock, createBlock, createDefaultTemplateContent, deepEqual, generateId, getColumnCount, invertOperations, invertOperations as invertOperations$1, safeClone } from "@templatical/types";
 import { computed, getCurrentScope, onScopeDispose, reactive, readonly, ref, shallowRef, watch } from "@vue/reactivity";
 import { computed as computed$1, onScopeDispose as onScopeDispose$1, ref as ref$1, watch as watch$1 } from "vue";
-//#region src/error-reporting.ts
+// src/error-reporting.ts
 /**
 * Turn a thrown value into an `Error`.
 *
@@ -30,8 +30,7 @@ function notifyHandler(onError, run) {
 		onError?.(wrapReportedError(error));
 	}
 }
-//#endregion
-//#region src/editor.ts
+// src/editor.ts
 function useEditor(options) {
 	const seedContent = options.content ?? createDefaultTemplateContent(options.defaultFontFamily, options.templateDefaults);
 	assertNoSlotInContent(seedContent);
@@ -359,8 +358,7 @@ function useEditor(options) {
 		hasTemplate
 	};
 }
-//#endregion
-//#region src/history.ts
+// src/history.ts
 const MAX_STACK_SIZE = 50;
 const DEBOUNCE_MS = 300;
 const NAVIGATE_IDLE_MS = 1500;
@@ -457,8 +455,7 @@ function useHistory(options) {
 		destroy
 	};
 }
-//#endregion
-//#region src/block-actions.ts
+// src/block-actions.ts
 function useBlockActions(options) {
 	const { addBlock, removeBlock, updateBlock, selectBlock, findBlockLocation } = options;
 	function createAndAddBlock(type, targetSectionId, columnIndex) {
@@ -492,8 +489,7 @@ function useBlockActions(options) {
 		updateBlockProperty
 	};
 }
-//#endregion
-//#region src/auto-save.ts
+// src/auto-save.ts
 /**
 * Trailing debounce, in ms, measured from the *last* content mutation.
 *
@@ -556,8 +552,7 @@ function useAutoSave(options) {
 		destroy
 	};
 }
-//#endregion
-//#region src/condition-preview.ts
+// src/condition-preview.ts
 function useConditionPreview(editor) {
 	const hiddenBlockIds = reactive(/* @__PURE__ */ new Set());
 	const hasHiddenBlocks = computed(() => hiddenBlockIds.size > 0);
@@ -581,8 +576,7 @@ function useConditionPreview(editor) {
 		hasHiddenBlocks
 	};
 }
-//#endregion
-//#region src/data-source-fetch.ts
+// src/data-source-fetch.ts
 function useDataSourceFetch(options) {
 	const isFetching = ref(false);
 	const fetchError = ref(false);
@@ -617,8 +611,7 @@ function useDataSourceFetch(options) {
 		needsFetch
 	};
 }
-//#endregion
-//#region src/history-interceptor.ts
+// src/history-interceptor.ts
 /**
 * Wraps editor mutation methods to record history snapshots before each
 * operation. Mutates the editor object in place.
@@ -658,8 +651,7 @@ function useHistoryInterceptor(editor, history) {
 		originalUpdateSettings(updates);
 	};
 }
-//#endregion
-//#region src/diff-content.ts
+// src/diff-content.ts
 const ROOT_KEY = "root";
 const BLOCK_SKIP = /* @__PURE__ */ new Set([
 	"id",
@@ -1791,8 +1783,7 @@ function useCollaboration(options) {
 		destroy
 	};
 }
-//#endregion
-//#region src/saved-blocks.ts
+// src/saved-blocks.ts
 /**
 * Reactive state over a {@link SavedBlocksProvider}.
 *
@@ -1915,8 +1906,7 @@ function useSavedBlocks(options) {
 		remove
 	};
 }
-//#endregion
-//#region src/saved-blocks-local.ts
+// src/saved-blocks-local.ts
 const DEFAULT_KEY$1 = "templatical:saved-blocks";
 /**
 * Browser-local {@link SavedBlocksProvider} backed by `localStorage`.
@@ -1994,8 +1984,7 @@ function createLocalStorageSavedBlocksProvider(options = {}) {
 		}
 	};
 }
-//#endregion
-//#region src/media-local.ts
+// src/media-local.ts
 const DEFAULT_KEY = "templatical:media";
 const PAGE_SIZE = 50;
 /**
@@ -2113,8 +2102,7 @@ function createLocalStorageMediaProvider(options = {}) {
 		storage: false
 	};
 }
-//#endregion
-//#region src/version-history.ts
+// src/version-history.ts
 /**
 * Reactive state over a {@link VersionHistoryProvider}.
 *
@@ -2237,8 +2225,7 @@ function useVersionHistory(options) {
 		restore
 	};
 }
-//#endregion
-//#region src/comments.ts
+// src/comments.ts
 /**
 * Reactive state over a {@link CommentsProvider}.
 *
@@ -2538,7 +2525,6 @@ function useCommentListener(options) {
 	}, { immediate: true });
 	onScopeDispose$1(stop);
 }
-//#endregion
 export { DEFAULT_AUTO_SAVE_DEBOUNCE_MS, createLocalStorageMediaProvider, createLocalStorageSavedBlocksProvider, diffContent, invertOperations, useAutoSave, useBlockActions, useCollaboration, useCommentListener, useComments, useConditionPreview, useDataSourceFetch, useEditor, useHistory, useHistoryInterceptor, useSavedBlocks, useVersionHistory };
 
 //# sourceMappingURL=index.js.map