@tldraw/tlstore - npm Package Compare versions

Comparing version 2.0.0-canary.d34a76d5d to 2.0.0-canary.d48e403ed1e4

dist-cjs/index.d.ts

 import { Atom } from 'signia';
 import { Computed } from 'signia';
+import { Signal } from 'signia';
 
@@ -58,3 +59,3 @@ /**
 /** @public */
-export declare const compareSchemas: (a: SerializedSchema, b: SerializedSchema) => number;
+export declare const compareSchemas: (a: SerializedSchema, b: SerializedSchema) => -1 | 0 | 1;
 
@@ -85,2 +86,3 @@ /**
     validator: StoreValidator<R>;
+    scope: Scope;
 }): RecordType<R, keyof Omit<R, 'id' | 'typeName'>>;
@@ -228,2 +230,3 @@
     } | StoreValidator<R>;
+    readonly scope: Scope;
     constructor(
@@ -242,2 +245,3 @@ /**
         } | StoreValidator<R>;
+        readonly scope?: Scope;
     });
@@ -353,2 +357,13 @@ /**
 
+/**
+ * Defines the scope of the record
+ *
+ * instance: The record belongs to a single instance of the store. It should not be synced, and any persistence logic should 'de-instance-ize' the record before persisting it, and apply the reverse when rehydrating.
+ * document: The record is persisted and synced. It is available to all store instances.
+ * presence: The record belongs to a single instance of the store. It may be synced to other instances, but other instances should not make changes to it. It should not be persisted.
+ *
+ * @public
+ * */
+declare type Scope = 'document' | 'instance' | 'presence';
+
 /** @public */
@@ -489,2 +504,7 @@ export declare interface SerializedSchema {
     /**
+     * The same as `serialize`, but only serializes records with a scope of `document`.
+     * @returns The record store snapshot as a JSON payload.
+     */
+    serializeDocumentState: () => StoreSnapshot<R>;
+    /**
      * Opposite of `serialize`. Replace the store's current records with records as defined by a
@@ -559,2 +579,3 @@ * simple JSON structure into the stores.
     createSelectedComputedCache: <T, J, V extends R = R>(name: string, selector: (record: V) => T | undefined, derive: (input: T) => J | undefined) => ComputedCache<J, V>;
+    private _integrityChecker?;
     /* Excluded from this release type: ensureStoreIsUsable */
@@ -678,3 +699,4 @@ private _isPossiblyCorrupted;
     migrateStoreSnapshot(storeSnapshot: StoreSnapshot<R>, persistedSchema: SerializedSchema): MigrationResult<StoreSnapshot<R>>;
-    /* Excluded from this release type: ensureStoreIsUsable */
+    /* Excluded from this release type: createIntegrityChecker */
+    /* Excluded from this release type: derivePresenceState */
     serialize(): SerializedSchema;
@@ -696,3 +718,4 @@ serializeEarliestVersion(): SerializedSchema;
     }) => R;
-    /* Excluded from this release type: ensureStoreIsUsable */
+    /* Excluded from this release type: createIntegrityChecker */
+    /* Excluded from this release type: derivePresenceState */
 };
@@ -699,0 +722,0 @@

dist-cjs/lib/RecordType.js

@@ -34,2 +34,3 @@ "use strict";
     this.validator = config.validator ?? { validate: (r) => r };
+    this.scope = config.scope ?? "document";
   }
@@ -39,2 +40,3 @@ createDefaultProperties;
   validator;
+  scope;
   /**
@@ -162,3 +164,4 @@ * Create a new record of this type.
       migrations: this.migrations,
-      validator: this.validator
+      validator: this.validator,
+      scope: this.scope
     });
@@ -178,3 +181,4 @@ }
     migrations: config.migrations ?? { currentVersion: 0, firstVersion: 0, migrators: {} },
-    validator: config.validator
+    validator: config.validator,
+    scope: config.scope
   });
@@ -181,0 +185,0 @@ }

dist-cjs/lib/Store.js

@@ -26,2 +26,3 @@ "use strict";
 module.exports = __toCommonJS(Store_exports);
+var import_utils = require("@tldraw/utils");
 var import_signia = require("signia");
@@ -96,3 +97,3 @@ var import_Cache = require("./Cache");
       },
-      { scheduleEffect: (cb) => requestAnimationFrame(cb) }
+      { scheduleEffect: (cb) => (0, import_utils.throttledRaf)(cb) }
     );
@@ -299,2 +300,12 @@ }
   /**
+   * The same as `serialize`, but only serializes records with a scope of `document`.
+   * @returns The record store snapshot as a JSON payload.
+   */
+  serializeDocumentState = () => {
+    return this.serialize((r) => {
+      const type = this.schema.types[r.typeName];
+      return type.scope === "document";
+    });
+  };
+  /**
    * Opposite of `serialize`. Replace the store's current records with records as defined by a
@@ -469,5 +480,7 @@ * simple JSON structure into the stores.
   };
+  _integrityChecker;
   /** @internal */
   ensureStoreIsUsable() {
-    this.schema.ensureStoreIsUsable(this);
+    this._integrityChecker ??= this.schema.createIntegrityChecker(this);
+    this._integrityChecker?.();
   }
@@ -578,13 +591,3 @@ _isPossiblyCorrupted = false;
   }
-  /**
-   * Ensure that the store is usable. A class that extends this store should override this method.
-   *
-   * @param config - The configuration object. This can be any object that allows the store to
-   *   validate that it is usable; the extending class should specify the type.
-   * @public
-   */
-  ensureStoreIsUsable(_config = {}) {
-    return;
-  }
 }
 //# sourceMappingURL=Store.js.map

dist-cjs/lib/StoreSchema.js

@@ -150,5 +150,9 @@ "use strict";
   /** @internal */
-  ensureStoreIsUsable(store) {
-    this.options.ensureStoreIsUsable?.(store);
+  createIntegrityChecker(store) {
+    return this.options.createIntegrityChecker?.(store) ?? void 0;
   }
+  /** @internal */
+  derivePresenceState(store) {
+    return this.options.derivePresenceState?.(store);
+  }
   serialize() {
@@ -155,0 +159,0 @@ return {

package.json

 {
   "name": "@tldraw/tlstore",
   "description": "A tiny little drawing app (store).",
-  "version": "2.0.0-canary.d34a76d5d",
+  "version": "2.0.0-canary.d48e403ed1e4",
+  "packageManager": "yarn@3.5.0",
   "author": {
@@ -34,15 +35,15 @@ "name": "tldraw GB Ltd.",
   "scripts": {
-    "test": "lazy :inherit",
-    "test:coverage": "lazy :inherit",
-    "build:package": "lazy :inherit",
-    "build:api": "lazy :inherit",
+    "test": "lazy inherit",
+    "test-coverage": "lazy inherit",
+    "build": "yarn run -T tsx ../../scripts/build-package.ts",
+    "build-api": "yarn run -T tsx ../../scripts/build-api.ts",
     "prepack": "yarn run -T tsx ../../scripts/prepack.ts",
     "postpack": "../../scripts/postpack.sh",
     "pack-tarball": "yarn pack",
-    "lint": "lazy :inherit"
+    "lint": "yarn run -T tsx ../../scripts/lint.ts"
   },
   "dependencies": {
-    "@tldraw/utils": "2.0.0-canary.d34a76d5d",
+    "@tldraw/utils": "2.0.0-canary.d48e403ed1e4",
     "lodash.isequal": "^4.5.0",
-    "nanoid": "^3.0.0"
+    "nanoid": "4.0.2"
   },
@@ -55,2 +56,3 @@ "peerDependencies": {
     "@types/lodash.isequal": "^4.5.6",
+    "lazyrepo": "0.0.0-alpha.26",
     "raf": "^3.4.1"
@@ -57,0 +59,0 @@ },

README.md

@@ -351,1 +351,5 @@ # @tldraw/tlstore
 A diff describing the changes to a collection.
+
+## License
+
+The source code in this repository (as well as our 2.0+ distributions and releases) are currently licensed under Apache-2.0. These licenses are subject to change in our upcoming 2.0 release. If you are planning to use tldraw in a commercial product, please reach out at [[e-mail]](mailto://[e-mail]).

src/lib/compareSchemas.ts

 import { SerializedSchema } from './StoreSchema'
 
 /** @public */
-export const compareSchemas = (a: SerializedSchema, b: SerializedSchema): number => {
+export const compareSchemas = (a: SerializedSchema, b: SerializedSchema): 0 | 1 | -1 => {
 	if (a.schemaVersion > b.schemaVersion) {
@@ -6,0 +6,0 @@ return 1

src/lib/RecordType.ts

@@ -10,2 +10,13 @@ import { structuredClone } from '@tldraw/utils'
 /**
+ * Defines the scope of the record
+ *
+ * instance: The record belongs to a single instance of the store. It should not be synced, and any persistence logic should 'de-instance-ize' the record before persisting it, and apply the reverse when rehydrating.
+ * document: The record is persisted and synced. It is available to all store instances.
+ * presence: The record belongs to a single instance of the store. It may be synced to other instances, but other instances should not make changes to it. It should not be persisted.
+ *
+ * @public
+ * */
+export type Scope = 'instance' | 'document' | 'presence'
+
+/**
  * A record type is a type that can be stored in a record store. It is created with
@@ -24,2 +35,4 @@ * `createRecordType`.
 
+	readonly scope: Scope
+
 	constructor(
@@ -37,2 +50,3 @@ /**
 			readonly validator?: StoreValidator<R> | { validate: (r: unknown) => R }
+			readonly scope?: Scope
 		}
@@ -43,2 +57,3 @@ ) {
 		this.validator = config.validator ?? { validate: (r: unknown) => r as R }
+		this.scope = config.scope ?? 'document'
 	}
@@ -181,2 +196,3 @@
 			validator: this.validator,
+			scope: this.scope,
 		})
@@ -212,2 +228,3 @@ }
 		validator: StoreValidator<R>
+		scope: Scope
 	}
@@ -219,2 +236,3 @@ ): RecordType<R, keyof Omit<R, 'id' | 'typeName'>> {
 		validator: config.validator,
+		scope: config.scope,
 	})
@@ -221,0 +239,0 @@ }

src/lib/Store.ts

@@ -0,1 +1,2 @@
+import { throttledRaf } from '@tldraw/utils'
 import { atom, Atom, computed, Computed, Reactor, reactor, transact } from 'signia'
@@ -5,2 +6,3 @@ import { BaseRecord, ID } from './BaseRecord'
 import { devFreeze } from './devFreeze'
+import { RecordType } from './RecordType'
 import { StoreQueries } from './StoreQueries'
@@ -176,3 +178,3 @@ import { StoreSchema } from './StoreSchema'
 			},
-			{ scheduleEffect: (cb) => requestAnimationFrame(cb) }
+			{ scheduleEffect: (cb) => throttledRaf(cb) }
 		)
@@ -434,2 +436,13 @@ }
 	/**
+	 * The same as `serialize`, but only serializes records with a scope of `document`.
+	 * @returns The record store snapshot as a JSON payload.
+	 */
+	serializeDocumentState = (): StoreSnapshot<R> => {
+		return this.serialize((r) => {
+			const type = this.schema.types[r.typeName as R['typeName']] as RecordType<any, any>
+			return type.scope === 'document'
+		})
+	}
+
+	/**
 	 * Opposite of `serialize`. Replace the store's current records with records as defined by a
@@ -627,5 +640,8 @@ * simple JSON structure into the stores.
 
+	private _integrityChecker?: () => void | undefined
+
 	/** @internal */
 	ensureStoreIsUsable() {
-		this.schema.ensureStoreIsUsable(this)
+		this._integrityChecker ??= this.schema.createIntegrityChecker(this)
+		this._integrityChecker?.()
 	}
@@ -773,13 +789,2 @@
 	}
-
-	/**
-	 * Ensure that the store is usable. A class that extends this store should override this method.
-	 *
-	 * @param config - The configuration object. This can be any object that allows the store to
-	 *   validate that it is usable; the extending class should specify the type.
-	 * @public
-	 */
-	ensureStoreIsUsable(_config = {} as any): void {
-		return
-	}
 }

src/lib/StoreSchema.ts

 import { getOwnProperty, objectMapValues } from '@tldraw/utils'
+import { Signal } from 'signia'
 import { BaseRecord } from './BaseRecord'
@@ -50,3 +51,5 @@ import { RecordType } from './RecordType'
 	/** @internal */
-	ensureStoreIsUsable?: (store: Store<R, P>) => void
+	createIntegrityChecker?: (store: Store<R, P>) => void
+	/** @internal */
+	derivePresenceState?: (store: Store<R, P>) => Signal<R | null>
 }
@@ -241,6 +244,11 @@
 	/** @internal */
-	ensureStoreIsUsable(store: Store<R, P>): void {
-		this.options.ensureStoreIsUsable?.(store)
+	createIntegrityChecker(store: Store<R, P>): (() => void) | undefined {
+		return this.options.createIntegrityChecker?.(store) ?? undefined
 	}
 
+	/** @internal */
+	derivePresenceState(store: Store<R, P>): Signal<R | null> | undefined {
+		return this.options.derivePresenceState?.(store)
+	}
+
 	serialize(): SerializedSchema {
@@ -247,0 +255,0 @@ return {

src/lib/test/recordStore.test.ts

@@ -13,3 +13,6 @@ import { Computed, react, RESET_VALUE, transact } from 'signia'
 
-const Book = createRecordType<Book>('book', { validator: { validate: (book) => book as Book } })
+const Book = createRecordType<Book>('book', {
+	validator: { validate: (book) => book as Book },
+	scope: 'document',
+})
 
@@ -23,2 +26,3 @@ interface Author extends BaseRecord<'author'> {
 	validator: { validate: (author) => author as Author },
+	scope: 'document',
 }).withDefaultProperties(() => ({
@@ -470,22 +474,29 @@ isPseudonym: false,
 	it('flushes history before attaching listeners', async () => {
-		store.put([Author.create({ name: 'J.R.R Tolkein', id: Author.createCustomId('tolkein') })])
-		const firstListener = jest.fn()
-		store.listen(firstListener)
-		expect(firstListener).toHaveBeenCalledTimes(0)
+		try {
+			// @ts-expect-error
+			globalThis.__FORCE_RAF_IN_TESTS__ = true
+			store.put([Author.create({ name: 'J.R.R Tolkein', id: Author.createCustomId('tolkein') })])
+			const firstListener = jest.fn()
+			store.listen(firstListener)
+			expect(firstListener).toHaveBeenCalledTimes(0)
 
-		store.put([Author.create({ name: 'Chips McCoy', id: Author.createCustomId('chips') })])
+			store.put([Author.create({ name: 'Chips McCoy', id: Author.createCustomId('chips') })])
 
-		expect(firstListener).toHaveBeenCalledTimes(0)
+			expect(firstListener).toHaveBeenCalledTimes(0)
 
-		const secondListener = jest.fn()
+			const secondListener = jest.fn()
 
-		store.listen(secondListener)
+			store.listen(secondListener)
 
-		expect(firstListener).toHaveBeenCalledTimes(1)
-		expect(secondListener).toHaveBeenCalledTimes(0)
+			expect(firstListener).toHaveBeenCalledTimes(1)
+			expect(secondListener).toHaveBeenCalledTimes(0)
 
-		await new Promise((resolve) => requestAnimationFrame(resolve))
+			await new Promise((resolve) => requestAnimationFrame(resolve))
 
-		expect(firstListener).toHaveBeenCalledTimes(1)
-		expect(secondListener).toHaveBeenCalledTimes(0)
+			expect(firstListener).toHaveBeenCalledTimes(1)
+			expect(secondListener).toHaveBeenCalledTimes(0)
+		} finally {
+			// @ts-expect-error
+			globalThis.__FORCE_RAF_IN_TESTS__ = false
+		}
 	})
@@ -492,0 +503,0 @@

src/lib/test/recordStoreFuzzing.test.ts

@@ -24,2 +24,3 @@ import { atom, EffectScheduler, RESET_VALUE } from 'signia'
 	},
+	scope: 'document',
 }).withDefaultProperties(() => ({ age: 23 }))
@@ -42,2 +43,3 @@
 	},
+	scope: 'document',
 })
@@ -44,0 +46,0 @@

src/lib/test/recordStoreQueries.test.ts

@@ -22,2 +22,3 @@ import { atom, RESET_VALUE } from 'signia'
 	},
+	scope: 'document',
 }).withDefaultProperties(() => ({ age: 23 }))
@@ -40,2 +41,3 @@
 	},
+	scope: 'document',
 })
@@ -42,0 +44,0 @@ const authors = {

src/lib/test/testSchema.v0.ts

@@ -32,2 +32,3 @@ import { assert } from '@tldraw/utils'
 	},
+	scope: 'document',
 })
@@ -94,2 +95,3 @@
 	},
+	scope: 'document',
 })
@@ -112,2 +114,3 @@
 	},
+	scope: 'document',
 })
@@ -114,0 +117,0 @@

src/lib/test/testSchema.v1.ts

@@ -65,2 +65,3 @@ import { assert } from '@tldraw/utils'
 	},
+	scope: 'document',
 }).withDefaultProperties(() => ({
@@ -196,2 +197,3 @@ /* STEP 6: Add any new default values for properties here */
 	},
+	scope: 'document',
 }).withDefaultProperties(() => ({
@@ -198,0 +200,0 @@ x: 0,

src/lib/test/validate.test.ts

@@ -24,2 +24,3 @@ import { BaseRecord, ID } from '../BaseRecord'
 	},
+	scope: 'document',
 })
@@ -43,2 +44,3 @@
 	},
+	scope: 'document',
 }).withDefaultProperties(() => ({
@@ -45,0 +47,0 @@ isPseudonym: false,

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

536257

1.58%

Lines of code

9203

1.02%

Number of lines in readme file

355

1.14%

Number of medium supply chain risk alerts

0

-100%

Worsened metrics

Dev dependency count

4

33.33%

Dependency changes

• + Added

  @tldraw/utils@2.0.0-canary.d48e403ed1e4
  (transitive)

• + Added

  nanoid@4.0.2
  (transitive)

• - Removed

  @tldraw/utils@2.0.0-canary.d34a76d5d
  (transitive)

• - Removed

  nanoid@3.3.11
  (transitive)

• Updated

  @tldraw/utils@2.0.0-canary.d48e403ed1e4

• Updated

  nanoid@4.0.2