pare down base model typing to non-generic

Author: hamiltoes

src/index.ts

@@ -21,15 +21,13 @@ import useGet from './useGet'
 import {
   FeathersVuexOptions,
   HandleEvents,
+  Model,
   ModelStatic,
   ModelSetupContext,
-  Model,
   Id,
   FeathersVuexStoreState,
   FeathersVuexGlobalModels,
-  FeathersVuexTypeOptions,
   GlobalModels,
-  ModelInstance
 } from './service-module/types'
 import { initAuth, hydrateApi } from './utils'
 import { FeathersVuex } from './vue-plugin/vue-plugin'
@@ -85,7 +83,6 @@ export default function feathersVuex(feathers, options: FeathersVuexOptions) {
   return {
     makeServicePlugin,
     BaseModel: BaseModel as ModelStatic,
-    castBaseModel: <T extends {} = {}>() => BaseModel as ModelStatic<T>,
     makeAuthPlugin,
     FeathersVuex,
     models: models as GlobalModels,
@@ -112,10 +109,8 @@ export {
   Id,
   Model,
   ModelStatic,
-  ModelInstance,
   ModelSetupContext,
   ServiceState,
   FeathersVuexGlobalModels,
   FeathersVuexStoreState,
-  FeathersVuexTypeOptions
 }

src/service-module/make-base-model.ts

@@ -11,7 +11,6 @@ import {
   ModelStatic,
   GlobalModels,
   StoreState,
-  ModelInstance,
   AnyData
 } from './types'
 import { globalModels, prepareAddModel } from './global-models'
@@ -59,23 +58,23 @@ export default function makeBaseModel(options: FeathersVuexOptions) {
   // If this serverAlias already has a BaseModel, return it
   const ExistingBaseModel = _get(globalModels, `[${serverAlias}].BaseModel`)
   if (ExistingBaseModel) {
-    return ExistingBaseModel as ModelStatic<AnyData>
+    return ExistingBaseModel as ModelStatic
   }
 
-  abstract class BaseModel implements ModelInstance<AnyData> {
+  abstract class BaseModel implements Model {
     // Think of these as abstract static properties
     public static servicePath: string
     public static namespace: string
     public static keepCopiesInStore = options.keepCopiesInStore
     // eslint-disable-next-line
-    public static instanceDefaults(data: Partial<AnyData>, ctx: ModelSetupContext) {
+    public static instanceDefaults(data: AnyData, ctx: ModelSetupContext) {
       return data
     }
     // eslint-disable-next-line
-    public static setupInstance(data: Partial<AnyData>, ctx: ModelSetupContext) {
+    public static setupInstance(data: AnyData, ctx: ModelSetupContext) {
       return data
     }
-    public static diffOnPatch(data: Partial<AnyData>) {
+    public static diffOnPatch(data: AnyData) {
       return data
     }
 
@@ -89,8 +88,8 @@ export default function makeBaseModel(options: FeathersVuexOptions) {
 
     public static readonly models = globalModels as GlobalModels // Can access other Models here
     public static copiesById: {
-      [key: string]: Model<AnyData> | undefined
-      [key: number]: Model<AnyData> | undefined
+      [key: string]: Model | undefined
+      [key: number]: Model | undefined
     } = {}
 
     public __id: string
@@ -100,7 +99,7 @@ export default function makeBaseModel(options: FeathersVuexOptions) {
     public static merge = mergeWithAccessors
     public static modelName = 'BaseModel'
 
-    public constructor(data: Partial<AnyData>, options: ModelInstanceOptions) {
+    public constructor(data: AnyData, options: ModelInstanceOptions) {
       // You have to pass at least an empty object to get a tempId.
       data = data || {}
       options = Object.assign({}, defaultOptions, options)
@@ -268,7 +267,7 @@ export default function makeBaseModel(options: FeathersVuexOptions) {
     /**
      * clone the current record using the `createCopy` mutation
      */
-    public clone(data: Partial<AnyData>): this {
+    public clone(data: AnyData): this {
       const { idField, tempIdField } = this.constructor as typeof BaseModel
       if (this.__isClone) {
         throw new Error('You cannot clone a copy')
@@ -428,5 +427,5 @@ export default function makeBaseModel(options: FeathersVuexOptions) {
 
   const BaseModelEventEmitter = BaseModel
   assertIsEventEmitter(BaseModelEventEmitter)
-  return BaseModelEventEmitter as ModelStatic<AnyData>
+  return BaseModelEventEmitter as ModelStatic
 }

src/service-module/service-module.state.ts

@@ -37,7 +37,7 @@ export interface ServiceStateExclusiveDefaults {
   modelName?: string
 }
 
-export interface ServiceState<D extends AnyData = AnyData> {
+export interface ServiceState<M extends Model = Model> {
   options: {}
   ids: string[]
   autoRemove: boolean
@@ -56,15 +56,15 @@ export interface ServiceState<D extends AnyData = AnyData> {
   idField: string
   tempIdField: string
   keyedById: {
-    [k: string]: Model<D>
-    [k: number]: Model<D>
+    [k: string]: M
+    [k: number]: M
   }
   tempsById: {
-    [k: string]: Model<D>
-    [k: number]: Model<D>
+    [k: string]: M
+    [k: number]: M
   }
   copiesById: {
-    [k: string]: Model<D>
+    [k: string]: M
   }
   whitelist: string[]
   paramsForServer: string[]

src/service-module/types.ts

@@ -114,31 +114,10 @@ export interface ModelInstanceOptions {
   merge?: boolean
 }
 
-export type AnyData = { [k: string]: any }
-
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface FeathersVuexTypeOptions {
-  // 'model-readonly': true
-}
-
-type GetOption<T, K, Default = false> = K extends keyof T ? T[K] : Default
-
-// ModelData is readonly unless user explicitly says `model-readonly` is false
-type ModelData<D> = GetOption<
-  FeathersVuexTypeOptions,
-  'model-readonly',
-  true
-> extends false
-  ? D
-  : Readonly<D>
-
-/**
- * FeathersVuex Model with readonly data props
- */
-export type Model<D extends {} = AnyData> = ModelInstance<D> & ModelData<D>
+export type AnyData = { [key: string]: any }
 
 /** Static Model interface */
-export interface ModelStatic<D extends {} = AnyData> extends EventEmitter {
+export interface ModelStatic extends EventEmitter {
   /**
    * The path passed to `FeathersClient.service()` to create the service
    */
@@ -181,8 +160,8 @@ export interface ModelStatic<D extends {} = AnyData> extends EventEmitter {
    * All model copies created using `model.clone()`
    */
   readonly copiesById: {
-    [key: string]: Model<D> | undefined
-    [key: number]: Model<D> | undefined
+    [key: string]: Model | undefined
+    [key: number]: Model | undefined
   }
 
   /**
@@ -215,8 +194,8 @@ export interface ModelStatic<D extends {} = AnyData> extends EventEmitter {
    * @param data partial model data
    * @param options model instance options
    */
-  new (data?: Partial<D>, options?: ModelInstanceOptions): Model<D>
-  prototype: Model<D>
+  new (data?: AnyData, options?: ModelInstanceOptions): Model
+  prototype: Model
 
   /**
    * The instanceDefaults API was created in version 1.7 to prevent
@@ -230,7 +209,7 @@ export interface ModelStatic<D extends {} = AnyData> extends EventEmitter {
    * @param data the instance data
    * @param ctx setup context
    */
-  instanceDefaults(data: Partial<D>, ctx: ModelSetupContext): Partial<D>
+  instanceDefaults(data: AnyData, ctx: ModelSetupContext): AnyData
 
   /**
    * A new setupInstance class method is now available in version 2.0.
@@ -241,7 +220,7 @@ export interface ModelStatic<D extends {} = AnyData> extends EventEmitter {
    * @param data the instance data
    * @param ctx setup context
    */
-  setupInstance(data: Partial<D>, ctx: ModelSetupContext): Partial<D>
+  setupInstance(data: AnyData, ctx: ModelSetupContext): AnyData
 
   /**
    * Gets called just before sending the data to the API server. It gets
@@ -250,35 +229,36 @@ export interface ModelStatic<D extends {} = AnyData> extends EventEmitter {
    * Default: `data => data`
    * @param data the instance data
    */
-  diffOnPatch(data: Partial<D>): Partial<D>
+  diffOnPatch(data: AnyData): AnyData
 
   /**
    * A proxy for the `find` action
    * @param params Find params
    */
-  find(params?: Params): Promise<Model<D>[] | Paginated<Model<D>>>
+  find<M extends Model = Model>(params?: Params): Promise<M[] | Paginated<M>>
   /**
    * A proxy for the `find` getter
    * @param params Find params
    */
-  findInStore(params?: Params): Paginated<Model<D>>
+  findInStore<M extends Model = Model>(params?: Params): Paginated<M>
 
   /**
    * A proxy for the `get` action
    * @param id ID of record to retrieve
    * @param params Get params
    */
-  get(id: Id, params?: Params): Promise<Model<D> | undefined>
+  get<M extends Model = Model>(id: Id, params?: Params): Promise<M | undefined>
   /**
    * A proxy for the `get` getter
    * @param id ID of record to retrieve
    * @param params Get params
    */
-  getFromStore(id: Id, params?: Params): Model<D> | undefined
+  getFromStore<M extends Model = Model>(id: Id, params?: Params): M | undefined
 }
 
 /** Model instance interface */
-export interface ModelInstance<D extends {} = AnyData> {
+export interface Model {
+  [key: string]: any
   /**
    * model's temporary ID
    */
@@ -298,7 +278,7 @@ export interface ModelInstance<D extends {} = AnyData> {
    * commit or save the data.
    * @param data Properties to modify on the cloned instance
    */
-  clone(data?: Partial<D>): this
+  clone(data?: AnyData): this
   /**
    * The create method calls the create action (service method)
    * using the instance data.
@@ -315,7 +295,7 @@ export interface ModelInstance<D extends {} = AnyData> {
    * with partial data.
    * @param params Params passed to the Feathers client request
    */
-  patch(params?: PatchParams<D>): Promise<this>
+  patch<D extends {} = AnyData>(params?: PatchParams<D>): Promise<this>
   /**
    * The remove method calls the remove action (service method)
    * using the instance data. The instance's id field is used

src/useFind.ts

@@ -11,11 +11,11 @@ import {
   watch
 } from '@vue/composition-api'
 import debounce from 'lodash/debounce'
-import { getItemsFromQueryInfo, getQueryInfo, Params } from './utils'
+import { getItemsFromQueryInfo, getQueryInfo, Params, Paginated } from './utils'
 import { AnyData, ModelStatic, Model } from './service-module/types'
 
-interface UseFindOptions<T> {
-  model: ModelStatic<T>
+interface UseFindOptions {
+  model: ModelStatic
   params: Params | Ref<Params>
   fetchParams?: Params | Ref<Params>
   queryWhen?: Ref<boolean>
@@ -33,8 +33,8 @@ interface UseFindState {
   latestQuery: null | object
   isLocal: boolean
 }
-interface UseFindData<T> {
-  items: Ref<Readonly<Model<T>[]>>
+interface UseFindData<M> {
+  items: Ref<Readonly<M[]>>
   servicePath: Ref<string>
   isPending: Ref<boolean>
   haveBeenRequested: Ref<boolean>
@@ -45,14 +45,14 @@ interface UseFindData<T> {
   latestQuery: Ref<object>
   paginationData: Ref<object>
   error: Ref<Error>
-  find: Function
+  find(params: Params | Ref<Params>): Promise<M[] | Paginated<M>>
 }
 
 const unwrapParams = (params: Params | Ref<Params>): Params =>
   isRef(params) ? params.value : params
 
-export default function find<T extends AnyData = AnyData>(options: UseFindOptions<T>): UseFindData<T> {
-  const defaults: UseFindOptions<T> = {
+export default function find<M extends Model = Model>(options: UseFindOptions): UseFindData<M> {
+  const defaults: UseFindOptions = {
     model: null,
     params: null,
     qid: 'default',
@@ -95,7 +95,7 @@ export default function find<T extends AnyData = AnyData>(options: UseFindOption
   })
   const computes = {
     // The find getter
-    items: computed<Model<T>[]>(() => {
+    items: computed<M[]>(() => {
       const getterParams = unwrapParams(params)
 
       if (getterParams && getterParams.paginate) {
@@ -114,8 +114,7 @@ export default function find<T extends AnyData = AnyData>(options: UseFindOption
         )
         return items
       } else {
-        const found = model.findInStore(getterParams)
-        return Array.isArray(found) ? found : found.data
+        return model.findInStore<M>(getterParams).data
       }
     }),
     paginationData: computed(() => {
@@ -124,17 +123,16 @@ export default function find<T extends AnyData = AnyData>(options: UseFindOption
     servicePath: computed<string>(() => model.servicePath)
   }
 
-  function find(params: Params | Ref<Params>) {
+  function find(params: Params | Ref<Params>): Promise<M[] | Paginated<M>> {
     params = unwrapParams(params)
     if (queryWhen.value && !state.isLocal) {
       state.isPending = true
       state.haveBeenRequested = true
 
-      return model.find(params).then(response => {
+      return model.find<M>(params).then(response => {
         // To prevent thrashing, only clear error on response, not on initial request.
         state.error = null
         state.haveLoaded = true
-
         if(!Array.isArray(response)) {
           const queryInfo = getQueryInfo(params, response)
           queryInfo.response = response