@tldraw/store 4.2.2 → 4.2.3

package/src/lib/ImmutableMap.ts

@@ -174,10 +174,20 @@ function SetRef(ref?: Ref): void {
 	}
 }
 
-function arrCopy<I>(arr: Array<I>, offset = 0): Array<I> {
-	return arr.slice(offset)
+// http://jsperf.com/copy-array-inline
+function arrCopy<I>(arr: Array<I>, offset?: number): Array<I> {
+	offset = offset || 0
+	const len = Math.max(0, arr.length - offset)
+	const newArr: Array<I> = new Array(len)
+	for (let ii = 0; ii < len; ii++) {
+		// We may want to guard for undefined values with `if (arr[ii + offset] !== undefined`, but ths should not happen by design
+		newArr[ii] = arr[ii + offset]
+	}
+	return newArr
 }
 
+const is = Object.is
+
 class OwnerID {}
 
 /**
@@ -471,7 +481,7 @@ class ArrayMapNode<K, V> {
 	get(_shift: unknown, _keyHash: unknown, key: K, notSetValue?: V) {
 		const entries = this.entries
 		for (let ii = 0, len = entries.length; ii < len; ii++) {
-			if (Object.is(key, entries[ii][0])) {
+			if (is(key, entries[ii][0])) {
 				return entries[ii][1]
 			}
 		}
@@ -493,7 +503,7 @@ class ArrayMapNode<K, V> {
 		let idx = 0
 		const len = entries.length
 		for (; idx < len; idx++) {
-			if (Object.is(key, entries[idx][0])) {
+			if (is(key, entries[idx][0])) {
 				break
 			}
 		}
@@ -504,7 +514,8 @@ class ArrayMapNode<K, V> {
 		}
 
 		SetRef(didAlter)
-		if (removed || !exists) SetRef(didChangeSize)
+		// eslint-disable-next-line @typescript-eslint/no-unused-expressions -- TODO enable eslint here
+		;(removed || !exists) && SetRef(didChangeSize)
 
 		if (removed && entries.length === 1) {
 			return // undefined
@@ -519,11 +530,8 @@ class ArrayMapNode<K, V> {
 
 		if (exists) {
 			if (removed) {
-				if (idx === len - 1) {
-					newEntries.pop()
-				} else {
-					newEntries[idx] = newEntries.pop()!
-				}
+				// eslint-disable-next-line @typescript-eslint/no-unused-expressions -- TODO enable eslint here
+				idx === len - 1 ? newEntries.pop() : (newEntries[idx] = newEntries.pop()!)
 			} else {
 				newEntries[idx] = [key, value]
 			}
@@ -711,7 +719,7 @@ class HashCollisionNode<K, V> {
 	get(shift: number, keyHash: number, key: K, notSetValue?: V) {
 		const entries = this.entries
 		for (let ii = 0, len = entries.length; ii < len; ii++) {
-			if (Object.is(key, entries[ii][0])) {
+			if (is(key, entries[ii][0])) {
 				return entries[ii][1]
 			}
 		}
@@ -746,7 +754,7 @@ class HashCollisionNode<K, V> {
 		let idx = 0
 		const len = entries.length
 		for (; idx < len; idx++) {
-			if (Object.is(key, entries[idx][0])) {
+			if (is(key, entries[idx][0])) {
 				break
 			}
 		}
@@ -757,7 +765,8 @@ class HashCollisionNode<K, V> {
 		}
 
 		SetRef(didAlter)
-		if (removed || !exists) SetRef(didChangeSize)
+		// eslint-disable-next-line @typescript-eslint/no-unused-expressions -- TODO enable eslint here
+		;(removed || !exists) && SetRef(didChangeSize)
 
 		if (removed && len === 2) {
 			return new ValueNode(ownerID, this.keyHash, entries[idx ^ 1])
@@ -768,11 +777,8 @@ class HashCollisionNode<K, V> {
 
 		if (exists) {
 			if (removed) {
-				if (idx === len - 1) {
-					newEntries.pop()
-				} else {
-					newEntries[idx] = newEntries.pop()!
-				}
+				// eslint-disable-next-line @typescript-eslint/no-unused-expressions -- TODO enable eslint here
+				idx === len - 1 ? newEntries.pop() : (newEntries[idx] = newEntries.pop()!)
 			} else {
 				newEntries[idx] = [key, value]
 			}
@@ -797,7 +803,7 @@ class ValueNode<K, V> {
 	) {}
 
 	get(shift: number, keyHash: number, key: K, notSetValue?: V) {
-		return Object.is(key, this.entry[0]) ? this.entry[1] : notSetValue
+		return is(key, this.entry[0]) ? this.entry[1] : notSetValue
 	}
 
 	update(
@@ -810,7 +816,7 @@ class ValueNode<K, V> {
 		didAlter?: Ref
 	) {
 		const removed = value === NOT_SET
-		const keyMatch = Object.is(key, this.entry[0])
+		const keyMatch = is(key, this.entry[0])
 		if (keyMatch ? value === this.entry[1] : removed) {
 			return this
 		}
@@ -921,11 +927,13 @@ function iteratorValue<K, V>(
 	iteratorResult?: IteratorResult<any>
 ) {
 	const value = type === ITERATE_KEYS ? k : type === ITERATE_VALUES ? v : [k, v]
-	if (iteratorResult) {
-		iteratorResult.value = value
-	} else {
-		iteratorResult = { value, done: false }
-	}
+	// eslint-disable-next-line @typescript-eslint/no-unused-expressions -- TODO enable eslint here
+	iteratorResult
+		? (iteratorResult.value = value)
+		: (iteratorResult = {
+				value: value,
+				done: false,
+			})
 	return iteratorResult
 }
 

package/src/lib/StoreSchema.ts

@@ -1,14 +1,13 @@
 import {
+	Result,
 	assert,
 	exhaustiveSwitchError,
 	getOwnProperty,
-	isEqual,
-	objectMapEntries,
-	Result,
 	structuredClone,
 } from '@tldraw/utils'
 import { UnknownRecord } from './BaseRecord'
-import { devFreeze } from './devFreeze'
+import { RecordType } from './RecordType'
+import { SerializedStore, Store, StoreSnapshot } from './Store'
 import {
 	Migration,
 	MigrationFailureReason,
@@ -17,11 +16,8 @@ import {
 	MigrationSequence,
 	parseMigrationId,
 	sortMigrations,
-	SynchronousStorage,
 	validateMigrations,
 } from './migrate'
-import { RecordType } from './RecordType'
-import { SerializedStore, Store, StoreSnapshot } from './Store'
 
 /**
  * Version 1 format for serialized store schema information.
@@ -534,7 +530,7 @@ export class StoreSchema<R extends UnknownRecord, P = unknown> {
 			return { type: 'success', value: record }
 		}
 
-		if (!migrationsToApply.every((m) => m.scope === 'record')) {
+		if (migrationsToApply.some((m) => m.scope === 'store')) {
 			return {
 				type: 'error',
 				reason:
@@ -545,7 +541,7 @@ export class StoreSchema<R extends UnknownRecord, P = unknown> {
 		}
 
 		if (direction === 'down') {
-			if (!migrationsToApply.every((m) => m.scope === 'record' && m.down)) {
+			if (!migrationsToApply.every((m) => m.down)) {
 				return {
 					type: 'error',
 					reason: MigrationFailureReason.TargetVersionTooOld,
@@ -558,7 +554,6 @@ export class StoreSchema<R extends UnknownRecord, P = unknown> {
 		try {
 			for (const migration of migrationsToApply) {
 				if (migration.scope === 'store') throw new Error(/* won't happen, just for TS */)
-				if (migration.scope === 'storage') throw new Error(/* won't happen, just for TS */)
 				const shouldApply = migration.filter ? migration.filter(record) : true
 				if (!shouldApply) continue
 				const result = migration[direction]!(record)
@@ -574,64 +569,6 @@ export class StoreSchema<R extends UnknownRecord, P = unknown> {
 		return { type: 'success', value: record }
 	}
 
-	migrateStorage(storage: SynchronousStorage<R>) {
-		const schema = storage.getSchema()
-		assert(schema, 'Schema is missing.')
-
-		const migrations = this.getMigrationsSince(schema)
-		if (!migrations.ok) {
-			console.error('Error migrating store', migrations.error)
-			throw new Error(migrations.error)
-		}
-		const migrationsToApply = migrations.value
-		if (migrationsToApply.length === 0) {
-			return
-		}
-
-		storage.setSchema(this.serialize())
-
-		for (const migration of migrationsToApply) {
-			if (migration.scope === 'record') {
-				for (const [id, state] of storage.entries()) {
-					const shouldApply = migration.filter ? migration.filter(state) : true
-					if (!shouldApply) continue
-					const record = structuredClone(state)
-					const result = migration.up!(record as any) ?? record
-					if (!isEqual(result, state)) {
-						storage.set(id, result as R)
-					}
-				}
-			} else if (migration.scope === 'store') {
-				// legacy
-				const prevStore = Object.fromEntries(storage.entries())
-				let nextStore = structuredClone(prevStore)
-				nextStore = (migration.up!(nextStore) as any) ?? nextStore
-				for (const [id, state] of Object.entries(nextStore)) {
-					if (!state) continue // these will be deleted in the next loop
-					if (!isEqual(state, prevStore[id])) {
-						storage.set(id, state)
-					}
-				}
-				for (const id of Object.keys(prevStore)) {
-					if (!nextStore[id]) {
-						storage.delete(id)
-					}
-				}
-			} else if (migration.scope === 'storage') {
-				migration.up!(storage)
-			} else {
-				exhaustiveSwitchError(migration)
-			}
-		}
-		// Clean up by filtering out any non-document records.
-		// This is mainly legacy support for extremely early days tldraw.
-		for (const [id, state] of storage.entries()) {
-			if (this.getType(state.typeName).scope !== 'document') {
-				storage.delete(id)
-			}
-		}
-	}
-
 	/**
 	 * Migrates an entire store snapshot to match the current schema version.
 	 *
@@ -667,6 +604,7 @@ export class StoreSchema<R extends UnknownRecord, P = unknown> {
 		snapshot: StoreSnapshot<R>,
 		opts?: { mutateInputStore?: boolean }
 	): MigrationResult<SerializedStore<R>> {
+		let { store } = snapshot
 		const migrations = this.getMigrationsSince(snapshot.schema)
 		if (!migrations.ok) {
 			// TODO: better error
@@ -675,37 +613,39 @@ export class StoreSchema<R extends UnknownRecord, P = unknown> {
 		}
 		const migrationsToApply = migrations.value
 		if (migrationsToApply.length === 0) {
-			return { type: 'success', value: snapshot.store }
+			return { type: 'success', value: store }
 		}
-		const store = Object.assign(
-			new Map<string, R>(objectMapEntries(snapshot.store).map(devFreeze)),
-			{
-				getSchema: () => snapshot.schema,
-				setSchema: (_: SerializedSchema) => {},
-			}
-		)
+
+		if (!opts?.mutateInputStore) {
+			store = structuredClone(store)
+		}
+
 		try {
-			this.migrateStorage(store)
-			if (opts?.mutateInputStore) {
-				for (const [id, record] of store.entries()) {
-					snapshot.store[id as keyof typeof snapshot.store] = record
-				}
-				for (const id of Object.keys(snapshot.store)) {
-					if (!store.has(id)) {
-						delete snapshot.store[id as keyof typeof snapshot.store]
+			for (const migration of migrationsToApply) {
+				if (migration.scope === 'record') {
+					for (const [id, record] of Object.entries(store)) {
+						const shouldApply = migration.filter ? migration.filter(record as UnknownRecord) : true
+						if (!shouldApply) continue
+						const result = migration.up!(record as any)
+						if (result) {
+							store[id as keyof typeof store] = result as any
+						}
 					}
-				}
-				return { type: 'success', value: snapshot.store }
-			} else {
-				return {
-					type: 'success',
-					value: Object.fromEntries(store.entries()) as SerializedStore<R>,
+				} else if (migration.scope === 'store') {
+					const result = migration.up!(store)
+					if (result) {
+						store = result as any
+					}
+				} else {
+					exhaustiveSwitchError(migration)
 				}
 			}
 		} catch (e) {
 			console.error('Error migrating store', e)
 			return { type: 'error', reason: MigrationFailureReason.MigrationError }
 		}
+
+		return { type: 'success', value: store }
 	}
 
 	/**

package/src/lib/StoreSideEffects.ts

@@ -493,7 +493,7 @@ export class StoreSideEffects<R extends UnknownRecord> {
 	 * ```ts
 	 * editor.sideEffects.registerAfterCreateHandler('page', (page, source) => {
 	 *     // Automatically create a shape when a page is created
-	 *     editor.createShape({
+	 *     editor.createShape<TLTextShape>({
 	 *         id: createShapeId(),
 	 *         type: 'text',
 	 *         props: { richText: toRichText(page.name) },

package/src/lib/devFreeze.test.ts

@@ -1,12 +1,8 @@
-import { afterAll, beforeEach, describe, expect, it, MockedFunction, vi } from 'vitest'
+import { afterAll, beforeEach, describe, expect, it, vi } from 'vitest'
 import { devFreeze } from './devFreeze'
-import { isDev } from './isDev'
 
 // Mock process.env for testing
 const originalEnv = process.env.NODE_ENV
-vi.mock('./isDev', () => ({
-	isDev: vi.fn(() => true),
-}))
 
 describe('devFreeze', () => {
 	beforeEach(() => {
@@ -17,7 +13,7 @@ describe('devFreeze', () => {
 	describe('production mode behavior', () => {
 		beforeEach(() => {
 			// Mock production environment
-			;(isDev as MockedFunction<typeof isDev>).mockReturnValue(false)
+			vi.stubGlobal('process', { env: { NODE_ENV: 'production' } })
 		})
 
 		it('should return objects unchanged in production mode', () => {

package/src/lib/devFreeze.ts

@@ -1,5 +1,4 @@
 import { STRUCTURED_CLONE_OBJECT_PROTOTYPE } from '@tldraw/utils'
-import { isDev } from './isDev'
 
 /**
  * Freeze an object when in development mode. Copied from
@@ -16,8 +15,9 @@ import { isDev } from './isDev'
  * @public
  */
 export function devFreeze<T>(object: T): T {
-	if (!isDev()) return object
-
+	if (process.env.NODE_ENV === 'production') {
+		return object
+	}
 	const proto = Object.getPrototypeOf(object)
 	if (
 		proto &&
@@ -32,10 +32,6 @@ export function devFreeze<T>(object: T): T {
 		throw new Error('cannot include non-js data in a record')
 	}
 
-	if (Object.isFrozen(object)) {
-		return object
-	}
-
 	// Retrieve the property names defined on object
 	const propNames = Object.getOwnPropertyNames(object)
 

package/src/lib/migrate.ts

@@ -1,7 +1,6 @@
 import { assert, objectMapEntries } from '@tldraw/utils'
 import { UnknownRecord } from './BaseRecord'
 import { SerializedStore } from './Store'
-import { SerializedSchema } from './StoreSchema'
 
 function squashDependsOn(sequence: Array<Migration | StandaloneDependsOn>): Migration[] {
 	const result: Migration[] = []
@@ -220,36 +219,8 @@ export type Migration = {
 				newState: SerializedStore<UnknownRecord>
 			) => void | SerializedStore<UnknownRecord>
 	  }
-	| {
-			readonly scope: 'storage'
-			// eslint-disable-next-line @typescript-eslint/method-signature-style
-			readonly up: (storage: SynchronousRecordStorage<UnknownRecord>) => void
-			readonly down?: never
-	  }
 )
 
-/**
- * Abstraction over the store that can be used to perform migrations.
- * @public
- */
-export interface SynchronousRecordStorage<R extends UnknownRecord> {
-	get(id: string): R | undefined
-	set(id: string, record: R): void
-	delete(id: string): void
-	keys(): Iterable<string>
-	values(): Iterable<R>
-	entries(): Iterable<[string, R]>
-}
-
-/**
- * Abstraction over the storage that can be used to perform migrations.
- * @public
- */
-export interface SynchronousStorage<R extends UnknownRecord> extends SynchronousRecordStorage<R> {
-	getSchema(): SerializedSchema
-	setSchema(schema: SerializedSchema): void
-}
-
 /**
  * Base interface for legacy migration information.
  *

package/src/lib/test/recordStore.test.ts

@@ -883,188 +883,6 @@ describe('snapshots', () => {
 		expect(up).toHaveBeenCalledTimes(1)
 		expect(store2.get(Book.createId('lotr'))!.numPages).toBe(42)
 	})
-
-	it('migrates the snapshot with storage scope', () => {
-		const snapshot1 = store.getStoreSnapshot()
-		const up = vi.fn((storage: any) => {
-			const book = storage.get('book:lotr')
-			storage.set('book:lotr', { ...book, numPages: 42 })
-		})
-
-		expect((snapshot1.store as any)['book:lotr'].numPages).toBe(1000)
-
-		const store2 = new Store({
-			props: {},
-			schema: StoreSchema.create<Book | Author>(
-				{
-					book: Book,
-					author: Author,
-				},
-				{
-					migrations: [
-						createMigrationSequence({
-							sequenceId: 'com.tldraw',
-							retroactive: true,
-							sequence: [
-								{
-									id: `com.tldraw/1`,
-									scope: 'storage',
-									up,
-								},
-							],
-						}),
-					],
-				}
-			),
-		})
-
-		expect(() => {
-			store2.loadStoreSnapshot(snapshot1)
-		}).not.toThrow()
-
-		expect(up).toHaveBeenCalledTimes(1)
-		expect(store2.get(Book.createId('lotr'))!.numPages).toBe(42)
-	})
-
-	it('storage scope migration can delete records', () => {
-		const snapshot1 = store.getStoreSnapshot()
-		const up = vi.fn((storage: any) => {
-			storage.delete('author:mcavoy')
-		})
-
-		expect((snapshot1.store as any)['author:mcavoy']).toBeDefined()
-
-		const store2 = new Store({
-			props: {},
-			schema: StoreSchema.create<Book | Author>(
-				{
-					book: Book,
-					author: Author,
-				},
-				{
-					migrations: [
-						createMigrationSequence({
-							sequenceId: 'com.tldraw',
-							retroactive: true,
-							sequence: [
-								{
-									id: `com.tldraw/1`,
-									scope: 'storage',
-									up,
-								},
-							],
-						}),
-					],
-				}
-			),
-		})
-
-		expect(() => {
-			store2.loadStoreSnapshot(snapshot1)
-		}).not.toThrow()
-
-		expect(up).toHaveBeenCalledTimes(1)
-		expect(store2.get(Author.createId('mcavoy'))).toBeUndefined()
-	})
-
-	it('storage scope migration can iterate records', () => {
-		const snapshot1 = store.getStoreSnapshot()
-		const up = vi.fn((storage: any) => {
-			for (const [id, record] of storage.entries()) {
-				if (record.typeName === 'book') {
-					storage.set(id, { ...record, numPages: record.numPages + 100 })
-				}
-			}
-		})
-
-		expect((snapshot1.store as any)['book:lotr'].numPages).toBe(1000)
-		expect((snapshot1.store as any)['book:hobbit'].numPages).toBe(300)
-
-		const store2 = new Store({
-			props: {},
-			schema: StoreSchema.create<Book | Author>(
-				{
-					book: Book,
-					author: Author,
-				},
-				{
-					migrations: [
-						createMigrationSequence({
-							sequenceId: 'com.tldraw',
-							retroactive: true,
-							sequence: [
-								{
-									id: `com.tldraw/1`,
-									scope: 'storage',
-									up,
-								},
-							],
-						}),
-					],
-				}
-			),
-		})
-
-		expect(() => {
-			store2.loadStoreSnapshot(snapshot1)
-		}).not.toThrow()
-
-		expect(up).toHaveBeenCalledTimes(1)
-		expect(store2.get(Book.createId('lotr'))!.numPages).toBe(1100)
-		expect(store2.get(Book.createId('hobbit'))!.numPages).toBe(400)
-	})
-
-	it('storage scope migration can use values() and keys()', () => {
-		const snapshot1 = store.getStoreSnapshot()
-		const keysCollected: string[] = []
-		const valuesCollected: any[] = []
-
-		const up = vi.fn((storage: any) => {
-			for (const key of storage.keys()) {
-				keysCollected.push(key)
-			}
-			for (const value of storage.values()) {
-				valuesCollected.push(value)
-			}
-		})
-
-		const store2 = new Store({
-			props: {},
-			schema: StoreSchema.create<Book | Author>(
-				{
-					book: Book,
-					author: Author,
-				},
-				{
-					migrations: [
-						createMigrationSequence({
-							sequenceId: 'com.tldraw',
-							retroactive: true,
-							sequence: [
-								{
-									id: `com.tldraw/1`,
-									scope: 'storage',
-									up,
-								},
-							],
-						}),
-					],
-				}
-			),
-		})
-
-		expect(() => {
-			store2.loadStoreSnapshot(snapshot1)
-		}).not.toThrow()
-
-		expect(up).toHaveBeenCalledTimes(1)
-		expect(keysCollected).toContain('book:lotr')
-		expect(keysCollected).toContain('book:hobbit')
-		expect(keysCollected).toContain('author:tolkein')
-		expect(keysCollected).toContain('author:mcavoy')
-		expect(keysCollected).toContain('author:cassidy')
-		expect(valuesCollected.length).toBe(5)
-	})
 })
 
 describe('diffs', () => {

package/dist-cjs/lib/AtomSet.js

@@ -1,68 +0,0 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var AtomSet_exports = {};
-__export(AtomSet_exports, {
-  AtomSet: () => AtomSet
-});
-module.exports = __toCommonJS(AtomSet_exports);
-var import_AtomMap = require("./AtomMap");
-class AtomSet {
-  constructor(name, keys) {
-    this.name = name;
-    const entries = keys ? Array.from(keys, (k) => [k, k]) : void 0;
-    this.map = new import_AtomMap.AtomMap(name, entries);
-  }
-  map;
-  add(value) {
-    this.map.set(value, value);
-    return this;
-  }
-  clear() {
-    this.map.clear();
-  }
-  delete(value) {
-    return this.map.delete(value);
-  }
-  forEach(callbackfn, thisArg) {
-    for (const value of this) {
-      callbackfn.call(thisArg, value, value, this);
-    }
-  }
-  has(value) {
-    return this.map.has(value);
-  }
-  // eslint-disable-next-line no-restricted-syntax
-  get size() {
-    return this.map.size;
-  }
-  entries() {
-    return this.map.entries();
-  }
-  keys() {
-    return this.map.keys();
-  }
-  values() {
-    return this.map.keys();
-  }
-  [Symbol.iterator]() {
-    return this.map.keys();
-  }
-  [Symbol.toStringTag] = "AtomSet";
-}
-//# sourceMappingURL=AtomSet.js.map