fix(typings): add typings to service-state

Author: fratzinger

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

@@ -6,21 +6,94 @@ eslint
 
 import _omit from 'lodash/omit'
 
-export default function makeDefaultState(servicePath, options) {
+import { MakeServicePluginOptions, PaginationState } from './types'
+
+export interface ServiceStateExclusiveDefaults {
+  ids: string[]
+
+  errorOnFind: any
+  errorOnGet: any
+  errorOnCreate: any
+  errorOnPatch: any
+  errorOnUpdate: any
+  errorOnRemove: any
+
+  isFindPending: boolean
+  isGetPending: boolean
+  isCreatePending: boolean
+  isPatchPending: boolean
+  isUpdatePending: boolean
+  isRemovePending: boolean
+
+  keyedById: {}
+  tempsById: {}
+  tempsByNewId: {}
+  copiesById: {}
+  namespace?: string
+  pagination?: {
+    defaultLimit: number
+    defaultSkip: number
+    default?: PaginationState
+  }
+  modelName?: string
+}
+
+export interface ServiceState {
+  options: {}
+  ids: string[]
+  autoRemove: boolean
+  errorOnFind: any
+  errorOnGet: any
+  errorOnCreate: any
+  errorOnPatch: any
+  errorOnUpdate: any
+  errorOnRemove: any
+  isFindPending: boolean
+  isGetPending: boolean
+  isCreatePending: boolean
+  isPatchPending: boolean
+  isUpdatePending: boolean
+  isRemovePending: boolean
+  idField: string
+  keyedById: {}
+  tempsById: {}
+  tempsByNewId: {}
+  copiesById: {}
+  whitelist: string[]
+  paramsForServer: string[]
+  namespace: string
+  nameStyle: string // Should be enum of 'short' or 'path'
+  pagination?: {
+    defaultLimit: number
+    defaultSkip: number
+    default?: PaginationState
+  }
+  modelName?: string
+}
+
+export interface PaginationState {
+  ids: any
+  limit: number
+  skip: number
+  ip: number
+  total: number
+  mostRecent: any
+}
+
+export default function makeDefaultState(options: MakeServicePluginOptions) {
   const nonStateProps = [
-    'actions',
-    'getters',
-    'instanceDefaults',
-    'handleEvents',
     'Model',
-    'mutations',
     'service',
+    'instanceDefaults',
     'setupInstance',
+    'handleEvents',
     'state',
+    'getters',
+    'mutations',
     'actions'
   ]
 
-  const state = {
+  const state: ServiceStateExclusiveDefaults = {
     ids: [],
     keyedById: {},
     copiesById: {},
@@ -43,8 +116,7 @@ export default function makeDefaultState(servicePath, options) {
     errorOnCreate: null,
     errorOnUpdate: null,
     errorOnPatch: null,
-    errorOnRemove: null,
-    modelName: null as string | null
+    errorOnRemove: null
   }
 
   if (options.Model) {

test/service-module/types.ts

@@ -3,7 +3,6 @@ eslint
 @typescript-eslint/explicit-function-return-type: 0,
 @typescript-eslint/no-explicit-any: 0
 */
-// TODO: use this in the src
 export interface ServiceState {
   options: {}
   ids: string[]
@@ -23,13 +22,15 @@ export interface ServiceState {
   idField: string
   keyedById: {}
   tempsById: {}
+  tempsByNewId: {}
   whitelist: string[]
   paramsForServer: string[]
   namespace: string
   nameStyle: string // Should be enum of 'short' or 'path'
   pagination?: {
     default: PaginationState
   }
+  modelName: string
 }
 
 export interface PaginationState {