@furystack/sequelize-store 6.0.27 → 6.0.28

package/README.md

@@ -5,17 +5,28 @@ Sequelize physical store implementation for FuryStack.
 ## Initialization
 
 ```ts
-import '@furystack/sequelize-store'
+import { Injector } from '@furystack/inject'
+import { StoreManager, type PhysicalStore } from '@furystack/core'
+import { useSequelize } from '@furystack/sequelize-store'
+import { Model, type Options } from 'sequelize'
 
-export class TestEntry extends Model<...,...> {
-  public declare _id: string
-  public declare value: string
+export class TestEntry extends Model {
+  declare public _id: string
+  declare public value: string
 }
 
-myInjector
-  .setupStores(sm => {
-    sm.useSequelize(TestEntry, '...other Sequelize-related options...')
-  })
+const myInjector = new Injector()
+useSequelize({
+  injector: myInjector,
+  model: TestEntry,
+  sequelizeModel: TestEntry, // Your Sequelize Model class
+  primaryKey: '_id',
+  options: {
+    // Sequelize connection options
+    dialect: 'sqlite',
+    storage: ':memory:',
+  } as Options,
+})
 
-const myStore: IPhysicalStore<TestEntry> = myInjector.getInstance(StoreManager).getStoreFor(TestEntry)
+const myStore: PhysicalStore<TestEntry, '_id'> = myInjector.getInstance(StoreManager).getStoreFor(TestEntry, '_id')
 ```

package/esm/sequelize-store.d.ts

@@ -20,12 +20,12 @@ export interface SequelizeStoreSettings<T extends object, M extends Model<T>, TP
      */
     getSequelizeClient: () => Sequelize;
     /**
-     * Optional calback that will initialize the Model for the Sequelize instance
+     * Optional callback that will initialize the Model for the Sequelize instance
      */
     initModel?: (sequelize: Sequelize) => Promise<void>;
 }
 /**
- * TypeORM Store implementation for FuryStack
+ * Sequelize Store implementation for FuryStack
  */
 export declare class SequelizeStore<T extends object, M extends Model<T>, TPrimaryKey extends keyof T, TWriteableData = WithOptionalId<T, TPrimaryKey>> extends EventHub<{
     onEntityAdded: {

package/esm/sequelize-store.js

@@ -1,7 +1,7 @@
 import { EventHub } from '@furystack/utils';
 import { Lock } from 'semaphore-async-await';
 /**
- * TypeORM Store implementation for FuryStack
+ * Sequelize Store implementation for FuryStack
  */
 export class SequelizeStore extends EventHub {
     options;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@furystack/sequelize-store",
-  "version": "6.0.27",
+  "version": "6.0.28",
   "description": "Sequelize-based Store implementation for FuryStack",
   "type": "module",
   "scripts": {
@@ -35,9 +35,9 @@
   },
   "homepage": "https://github.com/furystack/furystack",
   "dependencies": {
-    "@furystack/core": "^15.0.27",
-    "@furystack/inject": "^12.0.21",
-    "@furystack/utils": "^8.1.3",
+    "@furystack/core": "^15.0.28",
+    "@furystack/inject": "^12.0.22",
+    "@furystack/utils": "^8.1.4",
     "semaphore-async-await": "^1.5.1",
     "sequelize": "^6.37.7"
   },

package/src/sequelize-store.ts

@@ -30,13 +30,13 @@ export interface SequelizeStoreSettings<T extends object, M extends Model<T>, TP
    */
   getSequelizeClient: () => Sequelize
   /**
-   * Optional calback that will initialize the Model for the Sequelize instance
+   * Optional callback that will initialize the Model for the Sequelize instance
    */
   initModel?: (sequelize: Sequelize) => Promise<void>
 }
 
 /**
- * TypeORM Store implementation for FuryStack
+ * Sequelize Store implementation for FuryStack
  */
 export class SequelizeStore<
     T extends object,