@inglorious/store 9.5.3 → 10.0.0

package/README.md

@@ -118,8 +118,8 @@ const types = {
 
 // Define initial entities
 const entities = {
-  work: { type: "todoList", todos: [] },
-  personal: { type: "todoList", todos: [] },
+  work: { type: "TodoList", todos: [] },
+  personal: { type: "TodoList", todos: [] },
 }
 
 // Create store
@@ -171,9 +171,9 @@ const types = {
 }
 
 const entities = {
-  workTodos: { type: "todoList", todos: [], priority: "high" },
-  personalTodos: { type: "todoList", todos: [], priority: "low" },
-  settings: { type: "settings", theme: "dark", language: "en" },
+  workTodos: { type: "TodoList", todos: [], priority: "high" },
+  personalTodos: { type: "TodoList", todos: [], priority: "low" },
+  settings: { type: "Settings", theme: "dark", language: "en" },
 }
 ```
 
@@ -241,7 +241,7 @@ const types = {
 
 // 2. Define initial entities
 const entities = {
-  counter1: { type: "counter", value: 0 },
+  counter1: { type: "Counter", value: 0 },
 }
 
 // 3. Create the store
@@ -352,12 +352,12 @@ const types = {
 }
 
 const entities = {
-  counter1: { type: "counter", value: 0 },
-  counter2: { type: "counter", value: 0 },
-  counter3: { type: "counter", value: 0 },
+  counter1: { type: "Counter", value: 0 },
+  counter2: { type: "Counter", value: 0 },
+  counter3: { type: "Counter", value: 0 },
 }
 
-store.notify("add", { id: "counter4", type: "counter", value: 0 })
+store.notify("add", { id: "counter4", type: "Counter", value: 0 })
 ```
 
 Inglorious Store has a few built-in events that you can use:
@@ -707,7 +707,7 @@ function increment(entity, payload, api) {
 
 // Test it
 const { entity, events } = trigger(
-  { type: "counter", id: "counter1", value: 99 },
+  { type: "Counter", id: "counter1", value: 99 },
   increment,
   { amount: 5 },
 )
@@ -725,8 +725,8 @@ import { createMockApi, trigger } from "@inglorious/store/test"
 
 // Create a mock API with some initial entities
 const api = createMockApi({
-  counter1: { type: "counter", value: 10 },
-  counter2: { type: "counter", value: 20 },
+  counter1: { type: "Counter", value: 10 },
+  counter2: { type: "Counter", value: 20 },
 })
 
 // A handler that copies a value from another entity
@@ -737,7 +737,7 @@ function copyValue(entity, payload, api) {
 
 // Trigger the handler with the custom mock API
 const { entity } = trigger(
-  { type: "counter", id: "counter2", value: 20 },
+  { type: "Counter", id: "counter2", value: 20 },
   copyValue,
   { sourceId: "counter1" },
   api,
@@ -1042,15 +1042,15 @@ const types = {
 
 // Without autoCreateEntities (default)
 const entities = {
-  settings: { type: "settings", theme: "dark" },
-  analytics: { type: "analytics", events: [] },
+  settings: { type: "Settings", theme: "dark" },
+  analytics: { type: "Analytics", events: [] },
 }
 
 // With autoCreateEntities: true
 const entities = {
   // settings and analytics will be auto-created as:
-  // settings: { type: "settings" }
-  // analytics: { type: "analytics" }
+  // settings: { type: "Settings" }
+  // analytics: { type: "Analytics" }
 }
 
 const store = createStore({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inglorious/store",
-  "version": "9.5.3",
+  "version": "10.0.0",
   "description": "A state manager for real-time, collaborative apps, inspired by game development patterns and compatible with Redux.",
   "author": "IceOnFire <antony.mistretta@gmail.com> (https://ingloriouscoderz.it)",
   "license": "MIT",
@@ -56,10 +56,10 @@
   "sideEffects": false,
   "dependencies": {
     "mutative": "^1.3.0",
-    "@inglorious/utils": "3.7.3"
+    "@inglorious/utils": "3.8.0"
   },
   "peerDependencies": {
-    "@inglorious/utils": "3.7.3"
+    "@inglorious/utils": "3.8.0"
   },
   "devDependencies": {
     "@reduxjs/toolkit": "^2.11.2",

package/src/api.js

@@ -19,10 +19,22 @@ export function createApi(store, extras) {
      */
     setType: store.setType,
     /**
-     * Retrieves the full entities state.
-     * @returns {Object}
+     * Retrieves entities.
+     * If `typeName` is omitted, returns the full entities state object.
+     * If `typeName` is provided, returns an array of entities of that type.
+     * @param {string} [typeName]
+     * @returns {Object|Object[]}
      */
-    getEntities: store.getState,
+    getEntities: (typeName) => {
+      const entities = store.getState()
+      if (typeName == null) {
+        return entities
+      }
+
+      return Object.values(entities).filter(
+        (entity) => entity.type === typeName,
+      )
+    },
     /**
      * Retrieves a single entity by ID.
      * @param {string} id

package/src/store.js

@@ -1,3 +1,4 @@
+import { toCamelCase } from "@inglorious/utils/data-structures/string.js"
 import { create } from "mutative"
 
 import { createApi } from "./api.js"
@@ -118,8 +119,19 @@ export function createStore({
           const type = types[entity.type]
           const handle = type[handlerName]
 
-          if (handle) {
-            handle(entity, event.payload, api)
+          handle?.(entity, event.payload, api)
+        }
+
+        if (event.type.endsWith(":destroy")) {
+          const [target] = event.type.split(":")
+          const [, id] = target.split("#")
+          const entity = draft[id]
+          if (entity) {
+            const type = types[entity.type]
+            const typeName = entity.type
+            delete draft[id]
+
+            eventMap.removeEntity(id, type, typeName)
           }
         }
 
@@ -197,9 +209,10 @@ export function createStore({
       }
     }
 
-    if (autoCreateEntities && !state[typeName]) {
+    const entityId = toCamelCase(typeName)
+    if (autoCreateEntities && !state[entityId]) {
       notify("add", {
-        id: typeName,
+        id: entityId,
         type: typeName,
       })
     }
@@ -248,12 +261,13 @@ export function createStore({
 
     if (autoCreateEntities) {
       for (const typeName of Object.keys(types)) {
+        const entityId = toCamelCase(typeName)
         const hasEntity = Object.values(state).some(
           (entity) => entity.type === typeName,
         )
 
         if (!hasEntity) {
-          addEntity(state, { id: typeName, type: typeName })
+          addEntity(state, { id: entityId, type: typeName })
         }
       }
     }
@@ -277,12 +291,7 @@ export function createStore({
 
   function removeEntity(draft, payload) {
     const id = payload
-    const entity = draft[id]
-    const type = types[entity.type]
-    const typeName = entity.type
-    delete draft[id]
 
-    eventMap.removeEntity(id, type, typeName)
     incomingEvents.unshift({ type: `#${id}:destroy` })
   }
 }

package/src/test.js

@@ -12,6 +12,7 @@ import { create } from "mutative"
  *
  * @returns {Object} A mock API object with methods:
  *   - `getEntities()`: Returns all entities (frozen)
+ *   - `getEntities(typeName)`: Returns entities matching that type (frozen array)
  *   - `getEntity(id)`: Returns a specific entity by ID (frozen)
  *   - `select(selector)`: Runs a selector against the entities
  *   - `dispatch(event)`: Records an event (for assertions)
@@ -37,8 +38,14 @@ export function createMockApi(entities) {
   const events = []
 
   return {
-    getEntities() {
-      return frozenEntities
+    getEntities(typeName) {
+      if (typeName == null) {
+        return frozenEntities
+      }
+
+      return Object.values(frozenEntities).filter(
+        (entity) => entity.type === typeName,
+      )
     },
     getEntity(id) {
       return frozenEntities[id]

package/types/api.d.ts

@@ -17,7 +17,10 @@ export interface Api<
   getTypes: () => TypesConfig<TEntity>
   getType: (typeName: string) => EntityType<TEntity>
   setType: (typeName: string, type: EntityType<TEntity>) => void
-  getEntities: () => TState
+  getEntities: {
+    (): TState
+    (typeName: string): TEntity[]
+  }
   getEntity: (id: string) => TEntity | undefined
   select: <TResult>(selector: (state: TState) => TResult) => TResult
   dispatch: (event: Event) => void

package/types/test.d.ts

@@ -7,7 +7,10 @@ export interface MockApi<
   TEntity extends BaseEntity = BaseEntity,
   TState extends EntitiesState<TEntity> = EntitiesState<TEntity>,
 > {
-  getEntities: () => TState
+  getEntities: {
+    (): TState
+    (typeName: string): TEntity[]
+  }
   getEntity: (id: string) => TEntity | undefined
   select: <TResult>(selector: (state: TState) => TResult) => TResult
   dispatch: (event: Event) => void