edytor 0.1.0-next.21 → 0.1.0-next.23

package/dist/edytor.svelte.d.ts

@@ -43,6 +43,8 @@ export type EdytorOptions = {
     awareness?: Awareness;
     /** The local author of a view-owned document (with `document`, set it there). */
     actor?: DocumentActor;
+    /** A view-owned document's `requireHydration` (with `document`, set it there). */
+    requireHydration?: boolean;
     /** What this view shares of its selection with peers, and how often (`edytor.presence`). */
     presence?: PresenceOptions;
     sync?: boolean;
@@ -193,7 +195,7 @@ export declare class Edytor {
      */
     historyUndo: () => void;
     historyRedo: () => void;
-    constructor({ snippets, readonly, hotKeys, plugins, document, doc, awareness, actor, presence, sync, value, onSelectionChange, placeholder, onChange }: EdytorOptions);
+    constructor({ snippets, readonly, hotKeys, plugins, document, doc, awareness, actor, requireHydration, presence, sync, value, onSelectionChange, placeholder, onChange }: EdytorOptions);
     /** Kinds already reported missing (DEV, once each). */
     private unknownKinds;
     /**

package/dist/edytor.svelte.js

@@ -247,10 +247,13 @@ export class Edytor {
                 : 'noop';
         this.dispatcher.last = { operation: command, status };
     };
-    constructor({ snippets, readonly, hotKeys, plugins, document, doc, awareness, actor, presence, sync, value, onSelectionChange, placeholder, onChange }) {
+    constructor({ snippets, readonly, hotKeys, plugins, document, doc, awareness, actor, requireHydration, presence, sync, value, onSelectionChange, placeholder, onChange }) {
         if (document !== undefined) {
-            if (doc !== undefined || awareness !== undefined || actor !== undefined) {
-                throw new Error('EdytorOptions: `document` cannot be combined with `doc`/`awareness`/`actor` — ' +
+            if (doc !== undefined ||
+                awareness !== undefined ||
+                actor !== undefined ||
+                requireHydration !== undefined) {
+                throw new Error('EdytorOptions: `document` cannot be combined with `doc`/`awareness`/`actor`/`requireHydration` — ' +
                     'the document owns them (compose them via attachDocument first).');
             }
             this.document = document;
@@ -258,7 +261,7 @@ export class Edytor {
         else {
             // Legacy path — the view internally owns a document composed
             // around the injected (or a fresh) doc/awareness.
-            this.document = attachDocument(doc ?? new Y.Doc(), { awareness, actor });
+            this.document = attachDocument(doc ?? new Y.Doc(), { awareness, actor, requireHydration });
             this.ownsDocument = true;
         }
         this.readonly = readonly || false;
@@ -323,9 +326,9 @@ export class Edytor {
             // ANYTHING is applied, so a failed view cannot half-seed semantics.
             const blocks = Array.from(this.blocks);
             this.document.adoptSemantics({
-                roles: Object.fromEntries(blocks.map(([type, { void: v, island, lines, layout }]) => [
+                roles: Object.fromEntries(blocks.map(([type, { void: v, island, lines, layout, atomic }]) => [
                     type,
-                    { void: v, island, lines, layout }
+                    { void: v, island, lines, layout, atomic }
                 ])),
                 rendersContent: Object.fromEntries(blocks.map(([type, definition]) => [type, definition.rendersContent !== false])),
                 defaultChild

package/dist/index.d.ts

@@ -41,4 +41,4 @@ export type { Suggestion, Suggestions, SuggestionAt, SuggestionContent, Suggesti
 export { textToBlocks, type TextToBlocksOptions } from './clipboard/textBlocks.js';
 export * from './plugins/index.js';
 export * from './crdt/index.js';
-export { createIndexeddbSync, createWebsocketSync, clearDocument, storeState, IndexeddbPersistence, WebsocketProvider, PresenceWriter, type PresenceOptions, type PresenceShare } from './collaboration/index.js';
+export { createIndexeddbSync, createWebsocketSync, clearDocument, storeState, IndexeddbPersistence, WebsocketProvider, prefetch, lastUpdated, PresenceWriter, DEFAULT_PRESENCE_THROTTLE, type PresenceOptions, type PresenceShare } from './collaboration/index.js';

package/dist/index.js

@@ -39,4 +39,4 @@ export * from './crdt/index.js';
 // needs no `edytor/crdt` import for the common IndexedDB/websocket cases.
 // The `EdytorSync*`/`IndexeddbSyncOptions`/`WebsocketSyncOptions` types are
 // already re-exported through `./crdt/index.js` above.
-export { createIndexeddbSync, createWebsocketSync, clearDocument, storeState, IndexeddbPersistence, WebsocketProvider, PresenceWriter } from './collaboration/index.js';
+export { createIndexeddbSync, createWebsocketSync, clearDocument, storeState, IndexeddbPersistence, WebsocketProvider, prefetch, lastUpdated, PresenceWriter, DEFAULT_PRESENCE_THROTTLE } from './collaboration/index.js';

package/dist/plugins/image/ImageEmpty.svelte

@@ -1,6 +1,6 @@
 <script lang="ts">
 	import type { Block } from '../../block/block.svelte.js';
-	import { safeImageSrc } from './image.js';
+	import { MAX_INLINE_IMAGE_BYTES, oversizedInlineImage, safeImageSrc } from './image.js';
 
 	/**
 	 * Notion's empty image: "Add an image", then a link field (and Upload with
@@ -12,12 +12,15 @@
 		$props();
 	let draft = $state('');
 	let open = $state(false);
-	let failed = $state(false);
+	/** Why the last link or upload was not embedded (`null`: it was). */
+	let failed = $state<'invalid' | 'inline' | null>(null);
+	const inlineLimit = `${MAX_INLINE_IMAGE_BYTES / (1024 * 1024)} MB`;
 
 	const embed = (value: string) => {
 		const src = safeImageSrc(value);
-		failed = !src;
-		if (src && block) block.data.src = src;
+		// An inline image over the cap is never stored (H6): it would weigh on every sync.
+		failed = !src ? 'invalid' : oversizedInlineImage(src) ? 'inline' : null;
+		if (src && failed === null && block) block.data.src = src;
 	};
 </script>
 
@@ -57,13 +60,23 @@
 							try {
 								embed(await upload(file));
 							} catch {
-								failed = true;
+								failed = 'invalid';
 							}
 						}}
 					/>
 				</label>
 			{/if}
-			{#if failed}<small>That doesn't look like an image link or upload.</small>{/if}
+			{#if failed === 'inline'}
+				<small data-edytor-image-error="inline"
+					>Inline images are limited to {inlineLimit}: {upload
+						? 'upload the file instead'
+						: 'host the image and paste its link'}.</small
+				>
+			{:else if failed}
+				<small data-edytor-image-error="invalid"
+					>That doesn't look like an image link or upload.</small
+				>
+			{/if}
 		</div>
 	{/if}
 {/if}

package/dist/plugins/image/ImagePlugin.svelte

@@ -3,9 +3,14 @@
 	import type { Block } from '../../block/block.svelte.js';
 	import ImageEmpty from './ImageEmpty.svelte';
 	import { imageKinds } from '../../crdt/semantics.js';
-	import { safeImageSrc } from './image.js';
+	import {
+		MAX_INLINE_IMAGE_BYTES,
+		oversizedInlineImage,
+		safeImageSrc,
+		storableImageSrc
+	} from './image.js';
 
-	export { safeImageSrc };
+	export { MAX_INLINE_IMAGE_BYTES, oversizedInlineImage, safeImageSrc, storableImageSrc };
 
 	export type ImagePluginOptions = {
 		/** Upload a picked file and answer its URL; without it only links are embedded. */
@@ -48,10 +53,11 @@
 						const src = safeImageSrc(block.data?.src);
 						return `<figure>${src ? `<img src="${escape(src)}" alt="">` : ''}<figcaption>${caption}</figcaption></figure>`;
 					},
+					// A pasted inline image over the cap is not imported (H6).
 					parse: (el) => {
 						const src =
 							el.localName === 'figure' &&
-							safeImageSrc(el.querySelector('img')?.getAttribute('src'));
+							storableImageSrc(el.querySelector('img')?.getAttribute('src'));
 						return src ? { src } : undefined;
 					}
 				}

package/dist/plugins/image/ImagePlugin.svelte.d.ts

@@ -1,6 +1,6 @@
 import type { Plugin } from '../../plugins.js';
-import { safeImageSrc } from './image.js';
-export { safeImageSrc };
+import { MAX_INLINE_IMAGE_BYTES, oversizedInlineImage, safeImageSrc, storableImageSrc } from './image.js';
+export { MAX_INLINE_IMAGE_BYTES, oversizedInlineImage, safeImageSrc, storableImageSrc };
 export type ImagePluginOptions = {
     /** Upload a picked file and answer its URL; without it only links are embedded. */
     upload?: (file: File) => Promise<string>;

package/dist/plugins/image/image.d.ts

@@ -1,2 +1,18 @@
 /** An image source the block may render: http(s), blob, or an inline image. */
 export declare const safeImageSrc: (value: unknown) => string | null;
+/**
+ * The largest inline image (`data:` URL) an image block takes: 1 MiB of its
+ * URL (H6). An inline image is stored in the document and sent in every
+ * update and catch-up that carries the block, so a larger one would bloat
+ * the room's frames and storage: host the file instead (the plugin's
+ * `upload` option) and embed its URL.
+ */
+export declare const MAX_INLINE_IMAGE_BYTES: number;
+/** Is `src` an inline (`data:`) image larger than {@link MAX_INLINE_IMAGE_BYTES}? */
+export declare const oversizedInlineImage: (src: string) => boolean;
+/**
+ * An image source a block may store: {@link safeImageSrc}'s, but no
+ * inline image over {@link MAX_INLINE_IMAGE_BYTES}. Rendering still takes
+ * any safe source, so a document that holds a larger one shows it.
+ */
+export declare const storableImageSrc: (value: unknown) => string | null;

package/dist/plugins/image/image.js

@@ -5,3 +5,22 @@ export const safeImageSrc = (value) => {
     const src = value.trim();
     return /^(https?:|blob:)/i.test(src) || /^data:image\/[a-z0-9.+-]+[;,]/i.test(src) ? src : null;
 };
+/**
+ * The largest inline image (`data:` URL) an image block takes: 1 MiB of its
+ * URL (H6). An inline image is stored in the document and sent in every
+ * update and catch-up that carries the block, so a larger one would bloat
+ * the room's frames and storage: host the file instead (the plugin's
+ * `upload` option) and embed its URL.
+ */
+export const MAX_INLINE_IMAGE_BYTES = 1024 * 1024;
+/** Is `src` an inline (`data:`) image larger than {@link MAX_INLINE_IMAGE_BYTES}? */
+export const oversizedInlineImage = (src) => /^data:/i.test(src) && src.length > MAX_INLINE_IMAGE_BYTES;
+/**
+ * An image source a block may store: {@link safeImageSrc}'s, but no
+ * inline image over {@link MAX_INLINE_IMAGE_BYTES}. Rendering still takes
+ * any safe source, so a document that holds a larger one shows it.
+ */
+export const storableImageSrc = (value) => {
+    const src = safeImageSrc(value);
+    return src !== null && !oversizedInlineImage(src) ? src : null;
+};

package/dist/plugins/index.d.ts

@@ -12,6 +12,6 @@ export type { ToolbarController } from './toolbar/ToolbarController.svelte.js';
 export { blockMenuPlugin, createBlockMenuPlugin } from './blockMenu/blockMenuPlugin.js';
 export { suggestionsPlugin, createSuggestionsPlugin, isSuggestionsPlugin, type SuggestionsOptions, type SuggestionBarPayload } from './suggestions/suggestionsPlugin.js';
 export type { BlockMenuOptions, BlockMenuController, BlockMenuAction } from './blockMenu/BlockMenuController.svelte.js';
-export { imagePlugin, createImagePlugin, isImagePlugin, safeImageSrc, type ImagePluginOptions } from './image/ImagePlugin.svelte';
+export { imagePlugin, createImagePlugin, isImagePlugin, safeImageSrc, storableImageSrc, oversizedInlineImage, MAX_INLINE_IMAGE_BYTES, type ImagePluginOptions } from './image/ImagePlugin.svelte';
 export type { BlockHandleController } from './blockHandles/BlockHandleController.svelte.js';
 export { columnsPlugin, createColumnsPlugin, isColumnsPlugin, type ColumnsPluginOptions } from './columns/ColumnsPlugin.svelte';

package/dist/plugins/index.js

@@ -9,5 +9,5 @@ export { slashMenuPlugin, createSlashMenuPlugin } from './slashMenu/slashMenuPlu
 export { toolbarPlugin, createToolbarPlugin } from './toolbar/toolbarPlugin.js';
 export { blockMenuPlugin, createBlockMenuPlugin } from './blockMenu/blockMenuPlugin.js';
 export { suggestionsPlugin, createSuggestionsPlugin, isSuggestionsPlugin } from './suggestions/suggestionsPlugin.js';
-export { imagePlugin, createImagePlugin, isImagePlugin, safeImageSrc } from './image/ImagePlugin.svelte';
+export { imagePlugin, createImagePlugin, isImagePlugin, safeImageSrc, storableImageSrc, oversizedInlineImage, MAX_INLINE_IMAGE_BYTES } from './image/ImagePlugin.svelte';
 export { columnsPlugin, createColumnsPlugin, isColumnsPlugin } from './columns/ColumnsPlugin.svelte';

package/dist/plugins.d.ts

@@ -246,6 +246,17 @@ export type BlockDefinition = {
      * in the delete contract). Adopted by the document as a role.
      */
     layout?: boolean;
+    /**
+     * Data paths written as one value (`data.atomic`): a top-level key, or an
+     * array of keys for a nested one. Setting `block.data.link`, or a key
+     * inside it, writes the whole `link` as one property, so two people
+     * setting it at once never merge into a value neither wrote (one wins
+     * whole); elsewhere each key merges on its own. Adopted by the document as
+     * part of the kind's role: every view of a document, a headless one and
+     * the room must declare the same paths (`semanticsOf({ embed: { atomic:
+     * ['link'] } })`).
+     */
+    atomic?: readonly (string | readonly string[])[];
     /**
      * Whether the snippet renders the block's own content (`content()`).
      * Defaults to `true`; containers that render only their children

package/dist/session/commands.d.ts

@@ -57,6 +57,7 @@ export declare class Dispatcher {
     /** The plan `lead` holds for the next dispatched operation (a slash trigger's removal), if any. */
     get pendingLead(): Plan | null;
     /** Admission: a readonly view or a read-only document refuses every mutating command. */
+    /** Admission: not readonly, a writable document, and one decided when it requires hydration (H12). */
     permits: () => boolean;
     /** Apply the undo policy's cut before a `kind` command writes. */
     cut: (kind: string, phase?: "before" | "after") => void;

package/dist/session/commands.js

@@ -163,7 +163,10 @@ export class Dispatcher {
         return this.leading;
     }
     /** Admission: a readonly view or a read-only document refuses every mutating command. */
-    permits = () => !this.edytor.readonly && this.edytor.document.writable;
+    /** Admission: not readonly, a writable document, and one decided when it requires hydration (H12). */
+    permits = () => !this.edytor.readonly &&
+        this.edytor.document.writable &&
+        (this.edytor.document.ready || !this.edytor.document.requireHydration);
     /** Apply the undo policy's cut before a `kind` command writes. */
     cut = (kind, phase = 'before') => {
         const policy = this.decide(policyOf(kind));

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "edytor",
-	"version": "0.1.0-next.21",
+	"version": "0.1.0-next.23",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/beynar/edytor.git"