allow users to augment type options to disable readonly model data

Author: hamiltoes

src/index.ts

@@ -27,7 +27,8 @@ import {
   ModelClone,
   Id,
   FeathersVuexStoreState,
-  FeathersVuexGlobalModels
+  FeathersVuexGlobalModels,
+  FeathersVuexTypeOptions
 } from './service-module/types'
 import { initAuth, hydrateApi } from './utils'
 import { FeathersVuex } from './vue-plugin/vue-plugin'
@@ -119,5 +120,6 @@ export {
   ModelSetupContext,
   ServiceState,
   FeathersVuexGlobalModels,
-  FeathersVuexStoreState
+  FeathersVuexStoreState,
+  FeathersVuexTypeOptions
 }

src/service-module/types.ts

@@ -112,10 +112,26 @@ export interface ModelInstanceOptions {
 
 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> & Readonly<D>
+export type Model<D extends {} = AnyData> = ModelInstance<D> & ModelData<D>
 
 /**
  * FeathersVuex Model clone with writeable data props