@signaldb/core 1.0.0 → 1.2.0

package/README.md

@@ -1,6 +1,6 @@
 <p align="center">
   <a href="#">
-    <img src="/docs/public/logo.svg" width="150px" alt="SignalDB Logo" />
+    <img src="https://raw.githubusercontent.com/maxnowack/signaldb/refs/heads/main/docs/public/logo.svg" width="150px" alt="SignalDB Logo" />
   </a>
 </p>
 
@@ -63,6 +63,6 @@ See [Contributing.md](https://github.com/maxnowack/signaldb/blob/main/CONTRIBUTI
 ## Troubleshooting
 
 If you encounter any issues, there are several ways to get support.
-- Join our [Discord server](https://discord.gg/MB4ZGJX7).
+- Join our [Discord server](https://discord.gg/qMvXKXxBTp).
 - [Start a discussion](https://github.com/maxnowack/signaldb/discussions/new/choose)
 - [Open an issue](https://github.com/maxnowack/signaldb/issues/new)

package/dist/.vite/manifest.json

@@ -1,12 +1,13 @@
 {
-  "../../../node_modules/tslib/tslib.es6.mjs": {
-    "file": "index.cjs24.js",
-    "name": "node_modules/tslib/tslib.es6",
-    "src": "../../../node_modules/tslib/tslib.es6.mjs"
+  "__vite-browser-external": {
+    "file": "index.cjs15.js",
+    "name": "_virtual/__vite-browser-external",
+    "src": "__vite-browser-external",
+    "isDynamicEntry": true
   },
   "src/AutoFetchCollection.ts": {
-    "file": "index.cjs3.js",
-    "name": "packages/base/core/src/AutoFetchCollection",
+    "file": "index.cjs4.js",
+    "name": "AutoFetchCollection",
     "src": "src/AutoFetchCollection.ts",
     "imports": [
       "src/ReplicatedCollection.ts",
@@ -14,8 +15,8 @@
     ]
   },
   "src/Collection/Cursor.ts": {
-    "file": "index.cjs18.js",
-    "name": "packages/base/core/src/Collection/Cursor",
+    "file": "index.cjs20.js",
+    "name": "Collection/Cursor",
     "src": "src/Collection/Cursor.ts",
     "imports": [
       "src/utils/sortItems.ts",
@@ -24,8 +25,8 @@
     ]
   },
   "src/Collection/Observer.ts": {
-    "file": "index.cjs23.js",
-    "name": "packages/base/core/src/Collection/Observer",
+    "file": "index.cjs25.js",
+    "name": "Collection/Observer",
     "src": "src/Collection/Observer.ts",
     "imports": [
       "src/utils/isEqual.ts",
@@ -33,8 +34,8 @@
     ]
   },
   "src/Collection/createIndex.ts": {
-    "file": "index.cjs12.js",
-    "name": "packages/base/core/src/Collection/createIndex",
+    "file": "index.cjs14.js",
+    "name": "Collection/createIndex",
     "src": "src/Collection/createIndex.ts",
     "imports": [
       "src/createIndexProvider.ts",
@@ -44,20 +45,19 @@
     ]
   },
   "src/Collection/getIndexInfo.ts": {
-    "file": "index.cjs19.js",
-    "name": "packages/base/core/src/Collection/getIndexInfo",
+    "file": "index.cjs21.js",
+    "name": "Collection/getIndexInfo",
     "src": "src/Collection/getIndexInfo.ts",
     "imports": [
-      "../../../node_modules/tslib/tslib.es6.mjs",
       "src/utils/intersection.ts"
     ]
   },
   "src/Collection/index.ts": {
-    "file": "index.cjs2.js",
-    "name": "packages/base/core/src/Collection/index",
+    "file": "index.cjs3.js",
+    "name": "Collection/index",
     "src": "src/Collection/index.ts",
     "imports": [
-      "src/types/EventEmitter.ts",
+      "src/utils/EventEmitter.ts",
       "src/utils/match.ts",
       "src/utils/modify.ts",
       "src/utils/isEqual.ts",
@@ -71,8 +71,8 @@
     ]
   },
   "src/ReplicatedCollection.ts": {
-    "file": "index.cjs20.js",
-    "name": "packages/base/core/src/ReplicatedCollection",
+    "file": "index.cjs22.js",
+    "name": "ReplicatedCollection",
     "src": "src/ReplicatedCollection.ts",
     "imports": [
       "src/Collection/index.ts",
@@ -82,26 +82,39 @@
     ]
   },
   "src/createIndexProvider.ts": {
-    "file": "index.cjs5.js",
-    "name": "packages/base/core/src/createIndexProvider",
+    "file": "index.cjs6.js",
+    "name": "createIndexProvider",
     "src": "src/createIndexProvider.ts"
   },
   "src/createMemoryAdapter.ts": {
-    "file": "index.cjs6.js",
-    "name": "packages/base/core/src/createMemoryAdapter",
+    "file": "index.cjs7.js",
+    "name": "createMemoryAdapter",
     "src": "src/createMemoryAdapter.ts"
   },
   "src/createReactivityAdapter.ts": {
-    "file": "index.cjs8.js",
-    "name": "packages/base/core/src/createReactivityAdapter",
+    "file": "index.cjs9.js",
+    "name": "createReactivityAdapter",
     "src": "src/createReactivityAdapter.ts"
   },
+  "src/devtools.ts": {
+    "file": "index.cjs2.js",
+    "name": "devtools",
+    "src": "src/devtools.ts",
+    "imports": [
+      "src/Collection/index.ts"
+    ],
+    "dynamicImports": [
+      "__vite-browser-external",
+      "__vite-browser-external"
+    ]
+  },
   "src/index.ts": {
     "file": "index.cjs.js",
-    "name": "packages/base/core/src/index",
+    "name": "index",
     "src": "src/index.ts",
     "isEntry": true,
     "imports": [
+      "src/devtools.ts",
       "src/Collection/index.ts",
       "src/AutoFetchCollection.ts",
       "src/persistence/combinePersistenceAdapters.ts",
@@ -112,45 +125,46 @@
       "src/utils/isEqual.ts",
       "src/utils/modify.ts",
       "src/utils/randomId.ts",
+      "src/utils/EventEmitter.ts",
       "src/Collection/createIndex.ts"
     ]
   },
   "src/persistence/combinePersistenceAdapters.ts": {
-    "file": "index.cjs4.js",
-    "name": "packages/base/core/src/persistence/combinePersistenceAdapters",
+    "file": "index.cjs5.js",
+    "name": "persistence/combinePersistenceAdapters",
     "src": "src/persistence/combinePersistenceAdapters.ts",
     "imports": [
       "src/persistence/createPersistenceAdapter.ts"
     ]
   },
   "src/persistence/createPersistenceAdapter.ts": {
-    "file": "index.cjs7.js",
-    "name": "packages/base/core/src/persistence/createPersistenceAdapter",
+    "file": "index.cjs8.js",
+    "name": "persistence/createPersistenceAdapter",
     "src": "src/persistence/createPersistenceAdapter.ts"
   },
-  "src/types/EventEmitter.ts": {
+  "src/utils/EventEmitter.ts": {
     "file": "index.cjs13.js",
-    "name": "packages/base/core/src/types/EventEmitter",
-    "src": "src/types/EventEmitter.ts"
+    "name": "utils/EventEmitter",
+    "src": "src/utils/EventEmitter.ts"
   },
   "src/utils/createSignal.ts": {
-    "file": "index.cjs17.js",
-    "name": "packages/base/core/src/utils/createSignal",
+    "file": "index.cjs19.js",
+    "name": "utils/createSignal",
     "src": "src/utils/createSignal.ts"
   },
   "src/utils/deepClone.ts": {
-    "file": "index.cjs15.js",
-    "name": "packages/base/core/src/utils/deepClone",
+    "file": "index.cjs17.js",
+    "name": "utils/deepClone",
     "src": "src/utils/deepClone.ts"
   },
   "src/utils/get.ts": {
-    "file": "index.cjs26.js",
-    "name": "packages/base/core/src/utils/get",
+    "file": "index.cjs27.js",
+    "name": "utils/get",
     "src": "src/utils/get.ts"
   },
   "src/utils/getMatchingKeys.ts": {
-    "file": "index.cjs27.js",
-    "name": "packages/base/core/src/utils/getMatchingKeys",
+    "file": "index.cjs28.js",
+    "name": "utils/getMatchingKeys",
     "src": "src/utils/getMatchingKeys.ts",
     "imports": [
       "src/utils/isFieldExpression.ts",
@@ -158,33 +172,33 @@
     ]
   },
   "src/utils/intersection.ts": {
-    "file": "index.cjs25.js",
-    "name": "packages/base/core/src/utils/intersection",
+    "file": "index.cjs26.js",
+    "name": "utils/intersection",
     "src": "src/utils/intersection.ts"
   },
   "src/utils/isEqual.ts": {
-    "file": "index.cjs9.js",
-    "name": "packages/base/core/src/utils/isEqual",
+    "file": "index.cjs10.js",
+    "name": "utils/isEqual",
     "src": "src/utils/isEqual.ts"
   },
   "src/utils/isFieldExpression.ts": {
-    "file": "index.cjs28.js",
-    "name": "packages/base/core/src/utils/isFieldExpression",
+    "file": "index.cjs29.js",
+    "name": "utils/isFieldExpression",
     "src": "src/utils/isFieldExpression.ts"
   },
   "src/utils/match.ts": {
-    "file": "index.cjs14.js",
-    "name": "packages/base/core/src/utils/match",
+    "file": "index.cjs16.js",
+    "name": "utils/match",
     "src": "src/utils/match.ts"
   },
   "src/utils/modify.ts": {
-    "file": "index.cjs10.js",
-    "name": "packages/base/core/src/utils/modify",
+    "file": "index.cjs11.js",
+    "name": "utils/modify",
     "src": "src/utils/modify.ts"
   },
   "src/utils/project.ts": {
-    "file": "index.cjs22.js",
-    "name": "packages/base/core/src/utils/project",
+    "file": "index.cjs24.js",
+    "name": "utils/project",
     "src": "src/utils/project.ts",
     "imports": [
       "src/utils/get.ts",
@@ -192,31 +206,31 @@
     ]
   },
   "src/utils/randomId.ts": {
-    "file": "index.cjs11.js",
-    "name": "packages/base/core/src/utils/randomId",
+    "file": "index.cjs12.js",
+    "name": "utils/randomId",
     "src": "src/utils/randomId.ts"
   },
   "src/utils/serializeValue.ts": {
-    "file": "index.cjs16.js",
-    "name": "packages/base/core/src/utils/serializeValue",
+    "file": "index.cjs18.js",
+    "name": "utils/serializeValue",
     "src": "src/utils/serializeValue.ts"
   },
   "src/utils/set.ts": {
-    "file": "index.cjs29.js",
-    "name": "packages/base/core/src/utils/set",
+    "file": "index.cjs30.js",
+    "name": "utils/set",
     "src": "src/utils/set.ts"
   },
   "src/utils/sortItems.ts": {
-    "file": "index.cjs21.js",
-    "name": "packages/base/core/src/utils/sortItems",
+    "file": "index.cjs23.js",
+    "name": "utils/sortItems",
     "src": "src/utils/sortItems.ts",
     "imports": [
       "src/utils/get.ts"
     ]
   },
   "src/utils/uniqueBy.ts": {
-    "file": "index.cjs30.js",
-    "name": "packages/base/core/src/utils/uniqueBy",
+    "file": "index.cjs31.js",
+    "name": "utils/uniqueBy",
     "src": "src/utils/uniqueBy.ts"
   }
 }

package/dist/Collection/index.d.ts

@@ -1,7 +1,7 @@
 import type MemoryAdapter from '../types/MemoryAdapter';
 import type ReactivityAdapter from '../types/ReactivityAdapter';
 import type PersistenceAdapter from '../types/PersistenceAdapter';
-import EventEmitter from '../types/EventEmitter';
+import EventEmitter from '../utils/EventEmitter';
 import type Selector from '../types/Selector';
 import type Modifier from '../types/Modifier';
 import type IndexProvider from '../types/IndexProvider';
@@ -12,6 +12,7 @@ export type { CursorOptions } from './Cursor';
 export type { ObserveCallbacks } from './Observer';
 export { default as createIndex } from './createIndex';
 export interface CollectionOptions<T extends BaseItem<I>, I, U = T> {
+    name?: string;
     memory?: MemoryAdapter;
     reactivity?: ReactivityAdapter;
     transform?: Transform<T, U>;
@@ -21,9 +22,9 @@ export interface CollectionOptions<T extends BaseItem<I>, I, U = T> {
     fieldTracking?: boolean;
 }
 interface CollectionEvents<T extends BaseItem, U = T> {
-    added: (item: T) => void;
-    changed: (item: T, modifier: Modifier<T>) => void;
-    removed: (item: T) => void;
+    'added': (item: T) => void;
+    'changed': (item: T, modifier: Modifier<T>) => void;
+    'removed': (item: T) => void;
     'persistence.init': () => void;
     'persistence.error': (error: Error) => void;
     'persistence.transmitted': () => void;
@@ -34,14 +35,14 @@ interface CollectionEvents<T extends BaseItem, U = T> {
     'persistence.pushCompleted': () => void;
     'observer.created': <O extends FindOptions<T>>(selector?: Selector<T>, options?: O) => void;
     'observer.disposed': <O extends FindOptions<T>>(selector?: Selector<T>, options?: O) => void;
-    getItems: (selector: Selector<T> | undefined) => void;
-    find: <O extends FindOptions<T>>(selector: Selector<T> | undefined, options: O | undefined, cursor: Cursor<T, U>) => void;
-    findOne: <O extends FindOptions<T>>(selector: Selector<T>, options: O | undefined, item: U | undefined) => void;
-    insert: (item: Omit<T, 'id'> & Partial<Pick<T, 'id'>>) => void;
-    updateOne: (selector: Selector<T>, modifier: Modifier<T>) => void;
-    updateMany: (selector: Selector<T>, modifier: Modifier<T>) => void;
-    removeOne: (selector: Selector<T>) => void;
-    removeMany: (selector: Selector<T>) => void;
+    'getItems': (selector: Selector<T> | undefined) => void;
+    'find': <O extends FindOptions<T>>(selector: Selector<T> | undefined, options: O | undefined, cursor: Cursor<T, U>) => void;
+    'findOne': <O extends FindOptions<T>>(selector: Selector<T>, options: O | undefined, item: U | undefined) => void;
+    'insert': (item: Omit<T, 'id'> & Partial<Pick<T, 'id'>>) => void;
+    'updateOne': (selector: Selector<T>, modifier: Modifier<T>) => void;
+    'updateMany': (selector: Selector<T>, modifier: Modifier<T>) => void;
+    'removeOne': (selector: Selector<T>) => void;
+    'removeMany': (selector: Selector<T>) => void;
     '_debug.getItems': (callstack: string, selector: Selector<T> | undefined, measuredTime: number) => void;
     '_debug.find': <O extends FindOptions<T>>(callstack: string, selector: Selector<T> | undefined, options: O | undefined, cursor: Cursor<T, U>) => void;
     '_debug.findOne': <O extends FindOptions<T>>(callstack: string, selector: Selector<T>, options: O | undefined, item: U | undefined) => void;
@@ -60,10 +61,15 @@ interface CollectionEvents<T extends BaseItem, U = T> {
  * @template U - The transformed item type after applying transformations (default is T).
  */
 export default class Collection<T extends BaseItem<I> = BaseItem, I = any, U = T> extends EventEmitter<CollectionEvents<T, U>> {
-    static collections: Collection<any, any>[];
-    static debugMode: boolean;
-    static batchOperationInProgress: boolean;
-    static fieldTracking: boolean;
+    private static collections;
+    private static debugMode;
+    private static batchOperationInProgress;
+    private static fieldTracking;
+    private static onCreationCallbacks;
+    private static onDisposeCallbacks;
+    static getCollections(): Collection<any, any, any>[];
+    static onCreation(callback: (collection: Collection<any>) => void): void;
+    static onDispose(callback: (collection: Collection<any>) => void): void;
     /**
      * Enables debug mode for all collections.
      */
@@ -81,6 +87,7 @@ export default class Collection<T extends BaseItem<I> = BaseItem, I = any, U = T
      * @param callback - The batch operation to execute.
      */
     static batch(callback: () => void): void;
+    readonly name: string;
     private options;
     private persistenceAdapter;
     private isPullingSignal;
@@ -93,6 +100,7 @@ export default class Collection<T extends BaseItem<I> = BaseItem, I = any, U = T
     private isDisposed;
     private postBatchCallbacks;
     private fieldTracking;
+    private persistenceReadyPromise;
     /**
      * Initializes a new instance of the `Collection` class with optional configuration.
      * Sets up memory, persistence, reactivity, and indices as specified in the options.
@@ -100,6 +108,7 @@ export default class Collection<T extends BaseItem<I> = BaseItem, I = any, U = T
      * @template I - The type of the unique identifier for the items.
      * @template U - The transformed item type after applying transformations (default is T).
      * @param options - Optional configuration for the collection.
+     * @param options.name - An optional name for the collection.
      * @param options.memory - The in-memory adapter for storing items.
      * @param options.reactivity - The reactivity adapter for observing changes in the collection.
      * @param options.transform - A transformation function to apply to items when retrieving them.
@@ -146,6 +155,20 @@ export default class Collection<T extends BaseItem<I> = BaseItem, I = any, U = T
      * @param enable - A boolean indicating whether to enable (`true`) or disable (`false`) field tracking.
      */
     setFieldTracking(enable: boolean): void;
+    /**
+     * Resolves when the persistence adapter finished initializing
+     * and the collection is ready to be used.
+     * @returns A promise that resolves when the collection is ready.
+     * @example
+     * ```ts
+     * const collection = new Collection({
+     *   persistence: // ...
+     * })
+     * await collection.isReady()
+     *
+     * collection.insert({ name: 'Item 1' })
+     */
+    isReady(): Promise<void>;
     private profile;
     private executeInDebugMode;
     private rebuildIndices;

package/dist/Collection/types.d.ts

@@ -2,7 +2,7 @@ import type ReactivityAdapter from '../types/ReactivityAdapter';
 export type BaseItem<I = any> = {
     id: I;
 } & Record<string, any>;
-export type Transform<T, U = T> = ((doc: T) => U) | null | undefined;
+export type Transform<T, U = T> = ((document: T) => U) | null | undefined;
 export type SortSpecifier<T> = {
     [P in keyof T]?: -1 | 1;
 } & Record<string, -1 | 1>;

package/dist/devtools.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Loads the devtools in production mode and logs a warning if in production.
+ */
+export default function loadDeveloperTools(): void;

package/dist/index.cjs.js

@@ -1,16 +1,23 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const index = require("./index.cjs2.js");
-const AutoFetchCollection = require("./index.cjs3.js");
-const combinePersistenceAdapters = require("./index.cjs4.js");
-const createIndexProvider = require("./index.cjs5.js");
-const createMemoryAdapter = require("./index.cjs6.js");
-const createPersistenceAdapter = require("./index.cjs7.js");
-const createReactivityAdapter = require("./index.cjs8.js");
-const isEqual = require("./index.cjs9.js");
-const modify = require("./index.cjs10.js");
-const randomId = require("./index.cjs11.js");
-const createIndex = require("./index.cjs12.js");
+const devtools = require("./index.cjs2.js");
+const index = require("./index.cjs3.js");
+const AutoFetchCollection = require("./index.cjs4.js");
+const combinePersistenceAdapters = require("./index.cjs5.js");
+const createIndexProvider = require("./index.cjs6.js");
+const createMemoryAdapter = require("./index.cjs7.js");
+const createPersistenceAdapter = require("./index.cjs8.js");
+const createReactivityAdapter = require("./index.cjs9.js");
+const isEqual = require("./index.cjs10.js");
+const modify = require("./index.cjs11.js");
+const randomId = require("./index.cjs12.js");
+const EventEmitter = require("./index.cjs13.js");
+const createIndex = require("./index.cjs14.js");
+/* istanbul ignore if -- @preserve */
+if (process.env.NODE_ENV !== "production") {
+  devtools();
+}
+exports.loadDeveloperTools = devtools;
 exports.Collection = index.default;
 exports.AutoFetchCollection = AutoFetchCollection;
 exports.combinePersistenceAdapters = combinePersistenceAdapters.default;
@@ -21,4 +28,5 @@ exports.createReactivityAdapter = createReactivityAdapter;
 exports.isEqual = isEqual;
 exports.modify = modify;
 exports.randomId = randomId;
+exports.EventEmitter = EventEmitter;
 exports.createIndex = createIndex.default;

package/dist/index.cjs10.js

@@ -1,8 +1,29 @@
 "use strict";
-const updater = require("mingo/updater");
-function modify(item, modifier) {
-  const clonedItem = Object.assign({}, item);
-  updater.updateObject(clonedItem, modifier);
-  return clonedItem;
+function isEqual(a, b) {
+  if (Object.is(a, b))
+    return true;
+  if (a instanceof RegExp && b instanceof RegExp)
+    return a.toString() === b.toString();
+  if (a instanceof Date && b instanceof Date)
+    return a.getTime() === b.getTime();
+  if (typeof a !== "object")
+    return false;
+  if (typeof b !== "object")
+    return false;
+  if (a === null)
+    return false;
+  if (b === null)
+    return false;
+  const aKeys = Object.keys(a);
+  const bKeys = Object.keys(b);
+  if (aKeys.length !== bKeys.length)
+    return false;
+  for (const key of aKeys) {
+    if (!bKeys.includes(key))
+      return false;
+    if (!isEqual(a[key], b[key]))
+      return false;
+  }
+  return true;
 }
-module.exports = modify;
+module.exports = isEqual;

package/dist/index.cjs11.js

@@ -1,5 +1,8 @@
 "use strict";
-function randomId() {
-  return Math.floor(Math.random() * 1e17).toString(16);
+const mingo = require("mingo");
+function modify(item, modifier) {
+  const clonedItem = { ...item };
+  mingo.update(clonedItem, modifier);
+  return clonedItem;
 }
-module.exports = randomId;
+module.exports = modify;

package/dist/index.cjs12.js

@@ -1,37 +1,5 @@
 "use strict";
-Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: "Module" } });
-const createIndexProvider = require("./index.cjs5.js");
-const get = require("./index.cjs26.js");
-const getMatchingKeys = require("./index.cjs27.js");
-const serializeValue = require("./index.cjs16.js");
-function createExternalIndex(field, index) {
-  return createIndexProvider({
-    query(selector) {
-      const keys = getMatchingKeys(field, selector);
-      if (keys == null)
-        return { matched: false };
-      const itemPositions = keys.reduce((memo, key) => [...memo, ...index.get(key) || []], []);
-      return {
-        matched: true,
-        positions: itemPositions,
-        fields: [field]
-      };
-    },
-    rebuild() {
-    }
-  });
+function randomId() {
+  return Math.floor(Math.random() * 1e17).toString(16);
 }
-function createIndex(field) {
-  const index = /* @__PURE__ */ new Map();
-  return Object.assign(Object.assign({}, createExternalIndex(field, index)), { rebuild(items) {
-    index.clear();
-    items.forEach((item, i) => {
-      const value = serializeValue(get(item, field));
-      const current = index.get(value) || /* @__PURE__ */ new Set();
-      current.add(i);
-      index.set(value, current);
-    });
-  } });
-}
-exports.createExternalIndex = createExternalIndex;
-exports.default = createIndex;
+module.exports = randomId;