refactor(pinia-orm): useRepo was having the wrong types for repositories

CodeDredd · CodeDredd · commit be3c4f4257e9 · 2023-09-05T21:44:36.000+02:00
diff --git a/packages/pinia-orm/src/composables/useRepo.ts b/packages/pinia-orm/src/composables/useRepo.ts
@@ -4,16 +4,16 @@ import { Repository } from '../repository/Repository'
 import { Database } from '../database/Database'
 import type { Constructor } from '../types'
 
+export function useRepo<R extends Repository>(
+  repository: R,
+  pinia?: Pinia,
+): R
+
 export function useRepo<M extends Model>(
   model: Constructor<M>,
   pinia?: Pinia,
 ): Repository<M>
 
-export function useRepo<R extends Repository>(
-  repository: Constructor<R>,
-  pinia?: Pinia,
-): R
-
 export function useRepo (
   ModelOrRepository: any,
   pinia?: Pinia
@@ -26,7 +26,11 @@ export function useRepo (
 
   try {
     const typeModels = Object.values(repository.getModel().$types())
-    if (typeModels.length > 0) { typeModels.forEach(typeModel => repository.database.register(typeModel.newRawInstance())) } else { repository.database.register(repository.getModel()) }
+    if (typeModels.length > 0) {
+      typeModels.forEach(typeModel => repository.database.register(typeModel.newRawInstance()))
+    } else {
+      repository.database.register(repository.getModel())
+    }
   } catch (e) {}
 
   return repository
diff --git a/packages/pinia-orm/src/store/Config.ts b/packages/pinia-orm/src/store/Config.ts
@@ -1,16 +1,16 @@
 import { WeakCache } from '../cache/WeakCache'
-import type { FilledInstallOptions } from './Store'
+import type { InstallOptions } from './Store'
 
 export const CONFIG_DEFAULTS = {
   model: {
     withMeta: false,
-    hidden: ['_meta', 'original'],
-    visible: ['*']
+    hidden: ['_meta'],
+    visible: ['*'],
   },
   cache: {
     shared: true,
     provider: WeakCache
-  }
+  },
 }
 
-export const config: FilledInstallOptions = { ...CONFIG_DEFAULTS }
+export const config: InstallOptions = { ...CONFIG_DEFAULTS }
diff --git a/packages/pinia-orm/src/store/Store.ts b/packages/pinia-orm/src/store/Store.ts
@@ -15,19 +15,14 @@ export interface CacheConfigOptions {
 }
 
 export interface InstallOptions {
-  model?: ModelConfigOptions
-  cache?: CacheConfigOptions | boolean
-}
-
-export interface FilledInstallOptions {
-  model: Required<ModelConfigOptions>
-  cache: Required<CacheConfigOptions | boolean>
+  model: ModelConfigOptions
+  cache: CacheConfigOptions | boolean
 }
 
 /**
  * Install Pinia ORM to the store.
  */
-export function createORM (options?: InstallOptions): PiniaPlugin {
+export function createORM (options?: Partial<InstallOptions>): PiniaPlugin {
   config.model = { ...CONFIG_DEFAULTS.model, ...options?.model }
   config.cache = options?.cache === false ? false : { ...CONFIG_DEFAULTS.cache, ...(options?.cache !== true && options?.cache) }
   return () => {}
diff --git a/packages/pinia-orm/tests/helpers.ts b/packages/pinia-orm/tests/helpers.ts
@@ -15,7 +15,7 @@ interface Entities {
   [name: string]: Elements
 }
 
-export function createPiniaORM (options?: InstallOptions) {
+export function createPiniaORM (options?: Partial<InstallOptions>) {
   const app = createApp({})
   const pinia = createPinia()
   pinia.use(createORM(options))

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ interface Entities {`
`15`	`15`	`[name: string]: Elements`
`16`	`16`	`}`
`17`	`17`
`18`		`-export function createPiniaORM (options?: InstallOptions) {`
	`18`	`+export function createPiniaORM (options?: Partial<InstallOptions>) {`
`19`	`19`	`const app = createApp({})`
`20`	`20`	`const pinia = createPinia()`
`21`	`21`	`pinia.use(createORM(options))`