@formicoidea/labre-core 0.30.1 → 0.31.0

package/dist/_pkgs/store/test/test-doc.d.ts

@@ -1,45 +1 @@
-import * as Y from 'yjs';
-import type { Doc, GetStoreOptions, Workspace } from '../extension/index.js';
-import type { YBlock } from '../model/block/types.js';
-import type { AwarenessStore } from '../yjs/index.js';
-type DocOptions = {
-    id: string;
-    collection: Workspace;
-    doc: Y.Doc;
-    awarenessStore: AwarenessStore;
-};
-export declare class TestDoc implements Doc {
-    private readonly _collection;
-    private readonly _storeContainer;
-    private readonly _initSubDoc;
-    private _loaded;
-    private readonly _onSubdocEvent;
-    /** Indicate whether the block tree is ready */
-    private _ready;
-    protected readonly _yBlocks: Y.Map<YBlock>;
-    /**
-     * @internal Used for convenient access to the underlying Yjs map,
-     * can be used interchangeably with ySpace
-     */
-    protected readonly _ySpaceDoc: Y.Doc;
-    readonly awarenessStore: AwarenessStore;
-    readonly id: string;
-    readonly rootDoc: Y.Doc;
-    get blobSync(): import("../../sync/index.js").BlobEngine;
-    get workspace(): Workspace;
-    get isEmpty(): boolean;
-    get loaded(): boolean;
-    get meta(): import("../index.js").DocMeta | undefined;
-    get ready(): boolean;
-    get spaceDoc(): Y.Doc;
-    get yBlocks(): Y.Map<YBlock>;
-    constructor({ id, collection, doc, awarenessStore }: DocOptions);
-    clear(): void;
-    get removeStore(): ({ readonly, query, id }: import("../index.js").RemoveStoreOptions) => void;
-    private _destroy;
-    dispose(): void;
-    getStore({ readonly, query, provider, extensions, id, }?: GetStoreOptions): import("../index.js").Store;
-    load(initFn?: () => void): this;
-    remove(): void;
-}
-export {};
+export { DocImpl as TestDoc } from '../impls/doc.js';

package/dist/_pkgs/store/test/test-doc.js

@@ -1,110 +1 @@
-import * as Y from 'yjs';
-import { StoreContainer } from '../model/index.js';
-export class TestDoc {
-    get blobSync() {
-        return this.workspace.blobSync;
-    }
-    get workspace() {
-        return this._collection;
-    }
-    get isEmpty() {
-        return this._yBlocks.size === 0;
-    }
-    get loaded() {
-        return this._loaded;
-    }
-    get meta() {
-        return this.workspace.meta.getDocMeta(this.id);
-    }
-    get ready() {
-        return this._ready;
-    }
-    get spaceDoc() {
-        return this._ySpaceDoc;
-    }
-    get yBlocks() {
-        return this._yBlocks;
-    }
-    constructor({ id, collection, doc, awarenessStore }) {
-        this._initSubDoc = () => {
-            let subDoc = this.rootDoc.getMap('spaces').get(this.id);
-            if (!subDoc) {
-                subDoc = new Y.Doc({
-                    guid: this.id,
-                });
-                this.rootDoc.getMap('spaces').set(this.id, subDoc);
-                this._loaded = true;
-            }
-            else {
-                this._loaded = false;
-                this.rootDoc.on('subdocs', this._onSubdocEvent);
-            }
-            return subDoc;
-        };
-        this._onSubdocEvent = ({ loaded, }) => {
-            const result = Array.from(loaded).find(doc => doc.guid === this._ySpaceDoc.guid);
-            if (!result) {
-                return;
-            }
-            this.rootDoc.off('subdocs', this._onSubdocEvent);
-            this._loaded = true;
-        };
-        /** Indicate whether the block tree is ready */
-        this._ready = false;
-        this.id = id;
-        this.rootDoc = doc;
-        this.awarenessStore = awarenessStore;
-        this._ySpaceDoc = this._initSubDoc();
-        this._yBlocks = this._ySpaceDoc.getMap('blocks');
-        this._collection = collection;
-        this._storeContainer = new StoreContainer(this);
-    }
-    clear() {
-        this._yBlocks.clear();
-    }
-    get removeStore() {
-        return this._storeContainer.removeStore;
-    }
-    _destroy() {
-        this._ySpaceDoc.destroy();
-        this._loaded = false;
-    }
-    dispose() {
-        if (this.ready) {
-            this._yBlocks.clear();
-        }
-    }
-    getStore({ readonly, query, provider, extensions, id, } = {}) {
-        const storeExtensions = this.workspace.storeExtensions.concat(extensions ?? []);
-        let storeId;
-        if (id) {
-            storeId = id;
-        }
-        else if (readonly !== undefined || query) {
-            storeId = id;
-        }
-        else {
-            storeId = this.spaceDoc.guid;
-        }
-        return this._storeContainer.getStore({
-            id: storeId,
-            readonly,
-            query,
-            provider,
-            extensions: storeExtensions,
-        });
-    }
-    load(initFn) {
-        if (this.ready) {
-            return this;
-        }
-        this._ySpaceDoc.load();
-        initFn?.();
-        this._ready = true;
-        return this;
-    }
-    remove() {
-        this._destroy();
-        this.rootDoc.getMap('spaces').delete(this.id);
-    }
-}
+export { DocImpl as TestDoc } from '../impls/doc.js';

package/dist/_pkgs/store/test/test-meta.d.ts

@@ -1,33 +1 @@
-import { Subject } from 'rxjs';
-import type * as Y from 'yjs';
-import type { DocMeta, DocsPropertiesMeta, WorkspaceMeta } from '../extension/index.js';
-type DocCollectionMetaState = {
-    pages?: unknown[];
-    properties?: DocsPropertiesMeta;
-    name?: string;
-    avatar?: string;
-};
-export declare class TestMeta implements WorkspaceMeta {
-    private readonly _handleDocCollectionMetaEvents;
-    private _prevDocs;
-    protected readonly _proxy: DocCollectionMetaState;
-    protected readonly _yMap: Y.Map<DocCollectionMetaState[keyof DocCollectionMetaState]>;
-    readonly doc: Y.Doc;
-    docMetaAdded: Subject<string>;
-    docMetaRemoved: Subject<string>;
-    docMetaUpdated: Subject<void>;
-    readonly id: string;
-    get docMetas(): DocMeta[];
-    get docs(): unknown[] | undefined;
-    get properties(): DocsPropertiesMeta;
-    get yDocs(): Y.Array<unknown>;
-    constructor(doc: Y.Doc);
-    private _handleDocMetaEvent;
-    addDocMeta(doc: DocMeta, index?: number): void;
-    getDocMeta(id: string): DocMeta | undefined;
-    initialize(): void;
-    removeDocMeta(id: string): void;
-    setDocMeta(id: string, props: Partial<DocMeta>): void;
-    setProperties(meta: DocsPropertiesMeta): void;
-}
-export {};
+export { WorkspaceMetaImpl as TestMeta } from '../impls/workspace-meta.js';

package/dist/_pkgs/store/test/test-meta.js

@@ -1,125 +1 @@
-import { Subject } from 'rxjs';
-import { createYProxy } from '../reactive/proxy.js';
-export class TestMeta {
-    get docMetas() {
-        if (!this._proxy.pages) {
-            return [];
-        }
-        return this._proxy.pages;
-    }
-    get docs() {
-        return this._proxy.pages;
-    }
-    get properties() {
-        const meta = this._proxy.properties;
-        if (!meta) {
-            return {
-                tags: {
-                    options: [],
-                },
-            };
-        }
-        return meta;
-    }
-    get yDocs() {
-        return this._yMap.get('pages');
-    }
-    constructor(doc) {
-        this._handleDocCollectionMetaEvents = (events) => {
-            events.forEach(e => {
-                const hasKey = (k) => e.target === this._yMap && e.changes.keys.has(k);
-                if (e.target === this.yDocs ||
-                    e.target.parent === this.yDocs ||
-                    hasKey('pages')) {
-                    this._handleDocMetaEvent();
-                }
-            });
-        };
-        this._prevDocs = new Set();
-        this.docMetaAdded = new Subject();
-        this.docMetaRemoved = new Subject();
-        this.docMetaUpdated = new Subject();
-        this.id = 'meta';
-        this.doc = doc;
-        const map = doc.getMap(this.id);
-        this._yMap = map;
-        this._proxy = createYProxy(map);
-        this._yMap.observeDeep(this._handleDocCollectionMetaEvents);
-    }
-    _handleDocMetaEvent() {
-        const { docMetas, _prevDocs } = this;
-        const newDocs = new Set();
-        docMetas.forEach(docMeta => {
-            if (!_prevDocs.has(docMeta.id)) {
-                this.docMetaAdded.next(docMeta.id);
-            }
-            newDocs.add(docMeta.id);
-        });
-        _prevDocs.forEach(prevDocId => {
-            const isRemoved = newDocs.has(prevDocId) === false;
-            if (isRemoved) {
-                this.docMetaRemoved.next(prevDocId);
-            }
-        });
-        this._prevDocs = newDocs;
-        this.docMetaUpdated.next();
-    }
-    addDocMeta(doc, index) {
-        this.doc.transact(() => {
-            if (!this.docs) {
-                return;
-            }
-            const docs = this.docs;
-            if (index === undefined) {
-                docs.push(doc);
-            }
-            else {
-                docs.splice(index, 0, doc);
-            }
-        }, this.doc.clientID);
-    }
-    getDocMeta(id) {
-        return this.docMetas.find(doc => doc.id === id);
-    }
-    initialize() {
-        if (!this._proxy.pages) {
-            this._proxy.pages = [];
-        }
-    }
-    removeDocMeta(id) {
-        // you cannot delete a doc if there's no doc
-        if (!this.docs) {
-            return;
-        }
-        const docMeta = this.docMetas;
-        const index = docMeta.findIndex((doc) => id === doc.id);
-        if (index === -1) {
-            return;
-        }
-        this.doc.transact(() => {
-            if (!this.docs) {
-                return;
-            }
-            this.docs.splice(index, 1);
-        }, this.doc.clientID);
-    }
-    setDocMeta(id, props) {
-        const docs = this.docs ?? [];
-        const index = docs.findIndex((doc) => id === doc.id);
-        this.doc.transact(() => {
-            if (!this.docs) {
-                return;
-            }
-            if (index === -1)
-                return;
-            const doc = this.docs[index];
-            Object.entries(props).forEach(([key, value]) => {
-                doc[key] = value;
-            });
-        }, this.doc.clientID);
-    }
-    setProperties(meta) {
-        this._proxy.properties = meta;
-        this.docMetaUpdated.next();
-    }
-}
+export { WorkspaceMetaImpl as TestMeta } from '../impls/workspace-meta.js';

package/dist/_pkgs/store/test/test-workspace.d.ts

@@ -1,73 +1,13 @@
-import { AwarenessEngine, type AwarenessSource, BlobEngine, type BlobSource, DocEngine, type DocSource } from '../../sync/index.js';
-import { Subject } from 'rxjs';
-import * as Y from 'yjs';
-import type { Doc, ExtensionType, Workspace, WorkspaceMeta } from '../extension/index.js';
-import { type IdGenerator } from '../utils/id-generator.js';
-import { AwarenessStore } from '../yjs/index.js';
-import { TestDoc } from './test-doc.js';
-export type DocCollectionOptions = {
-    id?: string;
-    idGenerator?: IdGenerator;
-    docSources?: {
-        main: DocSource;
-        shadows?: DocSource[];
-    };
-    blobSources?: {
-        main: BlobSource;
-        shadows?: BlobSource[];
-    };
-    awarenessSources?: AwarenessSource[];
-};
+import { WorkspaceBase } from '../impls/workspace-base.js';
+export type { DocCollectionOptions, WorkspaceOptions, } from '../impls/workspace-base.js';
 /**
  * @internal
  * Test only
- * Do not use this in production
+ * Do not use this in production — use `WorkspaceImpl` from `@labre/store`.
+ *
+ * Independent from `WorkspaceImpl`: both derive from the shared internal
+ * {@link WorkspaceBase} (neither extends the other), so a test-only helper
+ * added here never leaks into the production class.
  */
-export declare class TestWorkspace implements Workspace {
-    storeExtensions: ExtensionType[];
-    readonly awarenessStore: AwarenessStore;
-    readonly awarenessSync: AwarenessEngine;
-    readonly blobSync: BlobEngine;
-    readonly blockCollections: Map<string, TestDoc>;
-    readonly doc: Y.Doc;
-    readonly docSync: DocEngine;
-    readonly id: string;
-    readonly idGenerator: IdGenerator;
-    meta: WorkspaceMeta;
-    slots: {
-        docListUpdated: Subject<void>;
-    };
-    get docs(): Map<string, TestDoc>;
-    constructor({ id, idGenerator, awarenessSources, docSources, blobSources, }?: DocCollectionOptions);
-    private _bindDocMetaEvents;
-    private _hasDoc;
-    /**
-     * Verify that all data has been successfully saved to the primary storage.
-     * Return true if the data transfer is complete and it is secure to terminate the synchronization operation.
-     */
-    canGracefulStop(): void;
-    /**
-     * By default, only an empty doc will be created.
-     * If the `init` parameter is passed, a `surface`, `note`, and `paragraph` block
-     * will be created in the doc simultaneously.
-     */
-    createDoc(docId?: string): Doc;
-    dispose(): void;
-    /**
-     * Terminate the data sync process forcefully, which may cause data loss.
-     * It is advised to invoke `canGracefulStop` before calling this method.
-     */
-    forceStop(): void;
-    getBlockCollection(docId: string): TestDoc | null;
-    getDoc(docId: string): Doc | null;
-    removeDoc(docId: string): void;
-    /**
-     * Start the data sync process
-     */
-    start(): void;
-    /**
-     * Wait for all data has been successfully saved to the primary storage.
-     */
-    waitForGracefulStop(abort?: AbortSignal): Promise<void>;
-    waitForSynced(): Promise<unknown>;
+export declare class TestWorkspace extends WorkspaceBase {
 }

package/dist/_pkgs/store/test/test-workspace.js

@@ -1,137 +1,12 @@
-import { BlockSuiteError, ErrorCode } from '../../global/exceptions/index.js';
-import { NoopLogger } from '../../global/utils/index.js';
-import { AwarenessEngine, BlobEngine, DocEngine, MemoryBlobSource, NoopDocSource, } from '../../sync/index.js';
-import { Subject } from 'rxjs';
-import { Awareness } from 'y-protocols/awareness.js';
-import * as Y from 'yjs';
-import { nanoid } from '../utils/id-generator.js';
-import { AwarenessStore } from '../yjs/index.js';
-import { TestDoc } from './test-doc.js';
-import { TestMeta } from './test-meta.js';
+import { WorkspaceBase } from '../impls/workspace-base.js';
 /**
  * @internal
  * Test only
- * Do not use this in production
+ * Do not use this in production — use `WorkspaceImpl` from `@labre/store`.
+ *
+ * Independent from `WorkspaceImpl`: both derive from the shared internal
+ * {@link WorkspaceBase} (neither extends the other), so a test-only helper
+ * added here never leaks into the production class.
  */
-export class TestWorkspace {
-    get docs() {
-        return this.blockCollections;
-    }
-    constructor({ id, idGenerator, awarenessSources = [], docSources = {
-        main: new NoopDocSource(),
-    }, blobSources = {
-        main: new MemoryBlobSource(),
-    }, } = {}) {
-        this.storeExtensions = [];
-        this.blockCollections = new Map();
-        this.slots = {
-            docListUpdated: new Subject(),
-        };
-        this.id = id || '';
-        this.doc = new Y.Doc({ guid: id });
-        this.awarenessStore = new AwarenessStore(new Awareness(this.doc));
-        const logger = new NoopLogger();
-        this.awarenessSync = new AwarenessEngine(this.awarenessStore.awareness, awarenessSources);
-        this.docSync = new DocEngine(this.doc, docSources.main, docSources.shadows ?? [], logger);
-        this.blobSync = new BlobEngine(blobSources.main, blobSources.shadows ?? [], logger);
-        this.idGenerator = idGenerator ?? nanoid;
-        this.meta = new TestMeta(this.doc);
-        this._bindDocMetaEvents();
-    }
-    _bindDocMetaEvents() {
-        this.meta.docMetaAdded.subscribe(docId => {
-            const doc = new TestDoc({
-                id: docId,
-                collection: this,
-                doc: this.doc,
-                awarenessStore: this.awarenessStore,
-            });
-            this.blockCollections.set(doc.id, doc);
-        });
-        this.meta.docMetaUpdated.subscribe(() => this.slots.docListUpdated.next());
-        this.meta.docMetaRemoved.subscribe(id => {
-            const space = this.getBlockCollection(id);
-            if (!space)
-                return;
-            this.blockCollections.delete(id);
-            space.remove();
-        });
-    }
-    _hasDoc(docId) {
-        return this.docs.has(docId);
-    }
-    /**
-     * Verify that all data has been successfully saved to the primary storage.
-     * Return true if the data transfer is complete and it is secure to terminate the synchronization operation.
-     */
-    canGracefulStop() {
-        this.docSync.canGracefulStop();
-    }
-    /**
-     * By default, only an empty doc will be created.
-     * If the `init` parameter is passed, a `surface`, `note`, and `paragraph` block
-     * will be created in the doc simultaneously.
-     */
-    createDoc(docId) {
-        const id = docId ?? this.idGenerator();
-        if (this._hasDoc(id)) {
-            throw new BlockSuiteError(ErrorCode.DocCollectionError, 'doc already exists');
-        }
-        this.meta.addDocMeta({
-            id,
-            title: '',
-            createDate: Date.now(),
-            tags: [],
-        });
-        return this.getDoc(id);
-    }
-    dispose() {
-        this.awarenessStore.destroy();
-    }
-    /**
-     * Terminate the data sync process forcefully, which may cause data loss.
-     * It is advised to invoke `canGracefulStop` before calling this method.
-     */
-    forceStop() {
-        this.docSync.forceStop();
-        this.blobSync.stop();
-        this.awarenessSync.disconnect();
-    }
-    getBlockCollection(docId) {
-        const space = this.docs.get(docId);
-        return space ?? null;
-    }
-    getDoc(docId) {
-        const collection = this.getBlockCollection(docId);
-        return collection;
-    }
-    removeDoc(docId) {
-        const docMeta = this.meta.getDocMeta(docId);
-        if (!docMeta) {
-            throw new BlockSuiteError(ErrorCode.DocCollectionError, `doc meta not found: ${docId}`);
-        }
-        const blockCollection = this.getBlockCollection(docId);
-        if (!blockCollection)
-            return;
-        blockCollection.dispose();
-        this.meta.removeDocMeta(docId);
-        this.blockCollections.delete(docId);
-    }
-    /**
-     * Start the data sync process
-     */
-    start() {
-        this.docSync.start();
-        this.blobSync.start();
-        this.awarenessSync.connect();
-    }
-    /**
-     * Wait for all data has been successfully saved to the primary storage.
-     */
-    waitForGracefulStop(abort) {
-        return this.docSync.waitForGracefulStop(abort);
-    }
-    waitForSynced() {
-        return this.docSync.waitForSynced();
-    }
+export class TestWorkspace extends WorkspaceBase {
 }

package/dist/_pkgs/store/transformer/assets.d.ts

@@ -1,5 +1,5 @@
-import type { BlockProps } from '../model';
-import type { BlobCRUD } from './type';
+import type { BlockProps } from '../model/index.js';
+import type { BlobCRUD } from './type.js';
 type AssetsManagerConfig = {
     blob: BlobCRUD;
 };

package/dist/_pkgs/store/transformer/base.d.ts

@@ -1,8 +1,8 @@
-import { BlockModel } from '../model/block/block-model';
-import { type DraftModel } from '../model/block/draft';
-import { type InternalPrimitives } from '../model/block/zod';
-import type { AssetsManager } from './assets';
-import type { BlockSnapshot } from './type';
+import { BlockModel } from '../model/block/block-model.js';
+import { type DraftModel } from '../model/block/draft.js';
+import { type InternalPrimitives } from '../model/block/zod.js';
+import type { AssetsManager } from './assets.js';
+import type { BlockSnapshot } from './type.js';
 export type BlockSnapshotLeaf = Pick<BlockSnapshot, 'id' | 'flavour' | 'props' | 'version'>;
 export type FromSnapshotPayload = {
     json: BlockSnapshotLeaf;

package/dist/_pkgs/store/transformer/base.js

@@ -1,7 +1,7 @@
-import { BlockModel } from '../model/block/block-model';
-import { toDraftModel } from '../model/block/draft';
-import { internalPrimitives, } from '../model/block/zod';
-import { fromJSON, toJSON } from './json';
+import { BlockModel } from '../model/block/block-model.js';
+import { toDraftModel } from '../model/block/draft.js';
+import { internalPrimitives, } from '../model/block/zod.js';
+import { fromJSON, toJSON } from './json.js';
 export class BaseBlockTransformer {
     _propsFromSnapshot(propsJson) {
         return Object.fromEntries(Object.entries(propsJson).map(([key, value]) => {

package/dist/_pkgs/store/transformer/index.d.ts

@@ -1,7 +1,7 @@
-export * from './assets';
-export * from './base';
-export * from './json';
-export * from './middleware';
-export * from './slice';
-export * from './transformer';
-export * from './type';
+export * from './assets.js';
+export * from './base.js';
+export * from './json.js';
+export * from './middleware.js';
+export * from './slice.js';
+export * from './transformer.js';
+export * from './type.js';

package/dist/_pkgs/store/transformer/index.js

@@ -1,7 +1,7 @@
-export * from './assets';
-export * from './base';
-export * from './json';
-export * from './middleware';
-export * from './slice';
-export * from './transformer';
-export * from './type';
+export * from './assets.js';
+export * from './base.js';
+export * from './json.js';
+export * from './middleware.js';
+export * from './slice.js';
+export * from './transformer.js';
+export * from './type.js';

package/dist/_pkgs/store/transformer/json.js

@@ -1,7 +1,7 @@
-import { NATIVE_UNIQ_IDENTIFIER, TEXT_UNIQ_IDENTIFIER } from '../consts';
-import { isPureObject } from '../reactive';
-import { Boxed } from '../reactive/boxed';
-import { Text } from '../reactive/text';
+import { NATIVE_UNIQ_IDENTIFIER, TEXT_UNIQ_IDENTIFIER } from '../consts.js';
+import { isPureObject } from '../reactive/index.js';
+import { Boxed } from '../reactive/boxed.js';
+import { Text } from '../reactive/text/index.js';
 export function toJSON(value) {
     if (value instanceof Boxed) {
         return {

package/dist/_pkgs/store/transformer/slice.d.ts

@@ -1,4 +1,4 @@
-import { BlockModel, type DraftModel, type Store } from '../model/index';
+import { BlockModel, type DraftModel, type Store } from '../model/index.js';
 type SliceData = {
     content: DraftModel[];
     workspaceId: string;

package/dist/_pkgs/store/transformer/slice.js

@@ -1,4 +1,4 @@
-import { BlockModel, toDraftModel, } from '../model/index';
+import { BlockModel, toDraftModel, } from '../model/index.js';
 export class Slice {
     get content() {
         return this.data.content;

package/dist/_pkgs/store/transformer/type.d.ts

@@ -1,6 +1,6 @@
 import { z } from 'zod';
-import type { DocMeta, DocsPropertiesMeta } from '../extension';
-import type { Store } from '../model';
+import type { DocMeta, DocsPropertiesMeta } from '../extension/index.js';
+import type { Store } from '../model/index.js';
 export type BlockSnapshot = {
     type: 'block';
     id: string;

package/dist/_pkgs/sync/doc/peer.js

@@ -1,4 +1,4 @@
-import isEqual from 'lodash-es/isEqual';
+import isEqual from 'lodash-es/isEqual.js';
 import { Subject } from 'rxjs';
 import { applyUpdate, encodeStateAsUpdate, encodeStateVector, mergeUpdates, } from 'yjs';
 import { PriorityAsyncQueue, SharedPriorityTarget, } from '../utils/async-queue.js';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@formicoidea/labre-core",
   "description": "Labre editor — the full BlockSuite-derived editor as one package.",
-  "version": "0.30.1",
+  "version": "0.31.0",
   "type": "module",
   "sideEffects": false,
   "author": "lajola",