simplify: combine Model and ModelClone interfaces

this gives better typing for decendent classes

Author: hamiltoes

src/index.ts

@@ -24,14 +24,12 @@ import {
   ModelStatic,
   ModelSetupContext,
   Model,
-  ModelClone,
   Id,
   FeathersVuexStoreState,
   FeathersVuexGlobalModels,
   FeathersVuexTypeOptions,
   GlobalModels,
-  ModelInstance,
-  ModelInstanceClone
+  ModelInstance
 } from './service-module/types'
 import { initAuth, hydrateApi } from './utils'
 import { FeathersVuex } from './vue-plugin/vue-plugin'
@@ -113,10 +111,8 @@ export {
   AuthState,
   Id,
   Model,
-  ModelClone,
   ModelStatic,
   ModelInstance,
-  ModelInstanceClone,
   ModelSetupContext,
   ServiceState,
   FeathersVuexGlobalModels,

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

@@ -9,10 +9,9 @@ import {
   ModelInstanceOptions,
   Model,
   ModelStatic,
-  ModelInstanceClone,
-  ModelClone,
   GlobalModels,
-  StoreState
+  StoreState,
+  ModelInstance
 } from './types'
 import { globalModels, prepareAddModel } from './global-models'
 import { mergeWithAccessors, checkNamespace, getId, Params } from '../utils'
@@ -63,7 +62,7 @@ export default function makeBaseModel(options: FeathersVuexOptions) {
     return ExistingBaseModel as ModelStatic<D>
   }
 
-  abstract class BaseModel implements ModelInstanceClone<D> {
+  abstract class BaseModel implements ModelInstance<D> {
     // Think of these as abstract static properties
     public static servicePath: string
     public static namespace: string
@@ -90,8 +89,8 @@ export default function makeBaseModel(options: FeathersVuexOptions) {
 
     public static readonly models = globalModels as GlobalModels // Can access other Models here
     public static copiesById: {
-      [key: string]: ModelClone<D> | undefined
-      [key: number]: ModelClone<D> | undefined
+      [key: string]: Model<D> | undefined
+      [key: number]: Model<D> | undefined
     } = {}
 
     public __id: string
@@ -269,7 +268,7 @@ export default function makeBaseModel(options: FeathersVuexOptions) {
     /**
      * clone the current record using the `createCopy` mutation
      */
-    public clone(data: Partial<D>): ModelClone<D> {
+    public clone(data: Partial<D>): this {
       const { idField, tempIdField } = this.constructor as typeof BaseModel
       if (this.__isClone) {
         throw new Error('You cannot clone a copy')
@@ -321,7 +320,7 @@ export default function makeBaseModel(options: FeathersVuexOptions) {
     /**
      * Update a store instance to match a clone.
      */
-    public commit(): Model<D> {
+    public commit(): this {
       const { idField, tempIdField, _commit, _getters } = this
         .constructor as typeof BaseModel
       if (this.__isClone) {

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

@@ -6,7 +6,7 @@ eslint
 
 import _omit from 'lodash/omit'
 
-import { MakeServicePluginOptions, AnyData, Model, ModelClone } from './types'
+import { MakeServicePluginOptions, AnyData, Model } from './types'
 
 export interface ServiceStateExclusiveDefaults {
   ids: string[]
@@ -64,7 +64,7 @@ export interface ServiceState<D extends AnyData = AnyData> {
     [k: number]: Model<D>
   }
   copiesById: {
-    [k: string]: ModelClone<D>
+    [k: string]: Model<D>
   }
   whitelist: string[]
   paramsForServer: string[]

src/service-module/types.ts

@@ -137,11 +137,6 @@ type ModelData<D> = GetOption<
  */
 export type Model<D extends {} = AnyData> = ModelInstance<D> & ModelData<D>
 
-/**
- * FeathersVuex Model clone with writeable data props
- */
-export type ModelClone<D extends {} = AnyData> = ModelInstanceClone<D> & D
-
 /** Static Model interface */
 export interface ModelStatic<D extends {} = AnyData> extends EventEmitter {
   /**
@@ -186,8 +181,8 @@ export interface ModelStatic<D extends {} = AnyData> extends EventEmitter {
    * All model copies created using `model.clone()`
    */
   readonly copiesById: {
-    [key: string]: ModelClone<D> | undefined
-    [key: number]: ModelClone<D> | undefined
+    [key: string]: Model<D> | undefined
+    [key: number]: Model<D> | undefined
   }
 
   /**
@@ -292,15 +287,18 @@ export interface ModelInstance<D extends {} = AnyData> {
    * model is temporary?
    */
   readonly __isTemp?: boolean
-
+  /**
+   * model is a clone?
+   */
+  readonly __isClone?: boolean
   /**
    * Creates a deep copy of the record and stores it on
    * `Model.copiesById`. This allows you to make changes
    * to the clone and not update visible data until you
    * commit or save the data.
    * @param data Properties to modify on the cloned instance
    */
-  clone(data?: Partial<D>): ModelClone<D>
+  clone(data?: Partial<D>): this
   /**
    * The create method calls the create action (service method)
    * using the instance data.
@@ -339,20 +337,12 @@ export interface ModelInstance<D extends {} = AnyData> {
    * @param params Params passed to the Feathers client request
    */
   save(params?: Params): Promise<this>
-}
 
-/** Model instance clone interface */
-export interface ModelInstanceClone<D extends {} = AnyData>
-  extends Omit<ModelInstance<D>, 'clone'> {
-  /**
-   * model is a clone?
-   */
-  readonly __isClone: true
 
   /**
    * Commit changes from clone to original
    */
-  commit(): Model<D>
+  commit(): this
 
   /**
    * Discards changes made on this clone and syncs with the original