fix(akita): support TS strict mode (#1050)

* fix(akita): support TS strict mode This PR makes the public API of Akita to be consumable in a strict typescript project Refs: #870 * chore(general): fix deps graph to fix build:all Add `dependsOn` for `build` to build dependencies of a project first before building the project Remove "nx/presets/npm.json" to fix deps graph (cause it disabled the analyzeSourceFiles feature)
salesforce · Feb 13, 2023 · 1d9eaac · 1d9eaac
1 parent ea7c0ec
commit 1d9eaac
Show file tree

Hide file tree

Showing 7 changed files with 23 additions and 17 deletions.
diff --git a/nx.json b/nx.json
@@ -1,4 +1,5 @@
 {
+  "$schema": "./node_modules/nx/schemas/nx-schema.json",
   "tasksRunnerOptions": {
     "default": {
       "runner": "nx/tasks-runners/default",
@@ -7,7 +8,6 @@
       }
     }
   },
-  "extends": "nx/presets/npm.json",
   "npmScope": "@datorama",
   "affected": {
     "defaultBase": "master"
@@ -33,6 +33,9 @@
     }
   },
   "targetDefaults": {
+    "build": {
+      "dependsOn": ["^build"]
+    },
     "test": {
       "inputs": ["default", "^default", "{workspaceRoot}/jest.preset.js"]
     },

diff --git a/packages/akita/src/lib/entityStore.ts b/packages/akita/src/lib/entityStore.ts
@@ -663,7 +663,7 @@ export class EntityStore<S extends EntityState = any, EntityType = getEntityType
 }
 
 // @internal
-export class EntityUIStore<UIState, DEPRECATED = any> extends EntityStore<UIState> {
+export class EntityUIStore<UIState extends EntityState, DEPRECATED = any> extends EntityStore<UIState> {
   _akitaCreateEntityFn: EntityUICreateFn;
 
   constructor(initialState = {}, storeConfig: Partial<StoreConfigOptions> = {}) {

diff --git a/packages/akita/src/lib/plugins/dirtyCheck/dirtyCheckPlugin.ts b/packages/akita/src/lib/plugins/dirtyCheck/dirtyCheckPlugin.ts
@@ -6,6 +6,7 @@ import { isUndefined } from '../../isUndefined';
 import { Query } from '../../query';
 import { QueryEntity } from '../../queryEntity';
 import { AkitaPlugin, Queries } from '../plugin';
+import { EntityState } from '../../types';
 
 type Head<State = any> = State | Partial<State>;
 
@@ -29,7 +30,7 @@ export type DirtyCheckResetParams<StoreState = any> = {
   updateFn?: StoreState | ((head: StoreState, current: StoreState) => any);
 };
 
-export class DirtyCheckPlugin<State = any> extends AkitaPlugin<State> {
+export class DirtyCheckPlugin<State extends EntityState = any> extends AkitaPlugin<State> {
   private head: Head<State>;
   private dirty = new BehaviorSubject(false);
   private subscription: Subscription;

diff --git a/packages/akita/src/lib/plugins/plugin.ts b/packages/akita/src/lib/plugins/plugin.ts
@@ -6,10 +6,11 @@ import { toBoolean } from '../toBoolean';
 import { getAkitaConfig } from '../config';
 import { getValue } from '../getValueByString';
 import { setValue } from '../setValueByString';
+import { EntityState } from '../types';
 
-export type Queries<State> = Query<State> | QueryEntity<State>;
+export type Queries<State extends EntityState> = Query<State> | QueryEntity<State>;
 
-export abstract class AkitaPlugin<State = any> {
+export abstract class AkitaPlugin<State extends EntityState = any> {
   protected constructor(protected query: Queries<State>, config?: { resetFn?: Function }) {
     if (config && config.resetFn) {
       if (getAkitaConfig().resettable) {

diff --git a/packages/akita/src/lib/plugins/stateHistory/stateHistoryPlugin.ts b/packages/akita/src/lib/plugins/stateHistory/stateHistoryPlugin.ts
@@ -2,6 +2,7 @@ import { BehaviorSubject, distinctUntilChanged, Observable, pairwise } from 'rxj
 import { logAction } from '../../actions';
 import { isFunction } from '../../isFunction';
 import { AkitaPlugin, Queries } from '../plugin';
+import { EntityState } from '../../types';
 
 export interface StateHistoryParams {
   maxAge?: number;
@@ -15,7 +16,7 @@ export type History<State> = {
   future: State[];
 };
 
-export class StateHistoryPlugin<State = any> extends AkitaPlugin<State> {
+export class StateHistoryPlugin<State extends EntityState = any> extends AkitaPlugin<State> {
   /** Allow skipping an update from outside */
   private skip = false;
 

diff --git a/packages/akita/src/lib/queryEntity.ts b/packages/akita/src/lib/queryEntity.ts
@@ -397,7 +397,7 @@ export class QueryEntity<S extends EntityState, EntityType = getEntityType<S>, I
 }
 
 // @internal
-export class EntityUIQuery<UIState, DEPRECATED = any> extends QueryEntity<UIState> {
+export class EntityUIQuery<UIState extends EntityState, DEPRECATED = any> extends QueryEntity<UIState> {
   constructor(store) {
     super(store);
   }

diff --git a/packages/akita/src/lib/runStoreAction.ts b/packages/akita/src/lib/runStoreAction.ts
@@ -4,7 +4,7 @@ import { isNil } from './isNil';
 import { Store } from './store';
 import { configKey } from './storeConfig';
 import { __stores__ } from './stores';
-import { Constructor } from './types';
+import { Constructor, EntityState } from './types';
 
 export enum StoreAction {
   Update = 'UPDATE',
@@ -60,15 +60,15 @@ export function getStoreByName<TStore extends Store<S>, S = TStore extends Store
  * Get a {@link EntityStore} from the global store registry.
  * @param storeClass The {@link EntityStore} class of the instance to be returned.
  */
-export function getEntityStore<TEntityStore extends EntityStore<S>, S = TEntityStore extends EntityStore<infer T> ? T : never>(storeClass: Constructor<TEntityStore>): TEntityStore {
+export function getEntityStore<TEntityStore extends EntityStore<S>, S extends EntityState = TEntityStore extends EntityStore<infer T> ? T : never>(storeClass: Constructor<TEntityStore>): TEntityStore {
   return getStore(storeClass as Constructor<Store<S>>) as TEntityStore;
 }
 
 /**
  * Get a {@link EntityStore} from the global store registry.
  * @param storeName The {@link EntityStore} name of the instance to be returned.
  */
-export function getEntityStoreByName<TEntityStore extends EntityStore<S>, S = TEntityStore extends EntityStore<infer T> ? T : never>(storeName: string): TEntityStore {
+export function getEntityStoreByName<TEntityStore extends EntityStore<S>, S extends EntityState = TEntityStore extends EntityStore<infer T> ? T : never>(storeName: string): TEntityStore {
   return getStoreByName<TEntityStore, S>(storeName) as TEntityStore;
 }
 
@@ -106,7 +106,7 @@ export function runStoreAction<TStore extends Store<S>, S = TStore extends Store
  *  runEntityStoreAction(BooksStore, EntityStoreAction.SetEntities, set => set([{ id: 1 }, { id: 2 }]));
  *
  */
-export function runEntityStoreAction<TEntityStore extends EntityStore<S>, S = TEntityStore extends EntityStore<infer T> ? T : any>(
+export function runEntityStoreAction<TEntityStore extends EntityStore<S>, S extends EntityState = TEntityStore extends EntityStore<infer T> ? T : any>(
   storeClassOrName: Constructor<TEntityStore> | string,
   action: EntityStoreAction.SetEntities,
   operation: (operator: TEntityStore['set']) => void
@@ -121,7 +121,7 @@ export function runEntityStoreAction<TEntityStore extends EntityStore<S>, S = TE
  *  runEntityStoreAction(BooksStore, EntityStoreAction.AddEntities, add => add({ id: 1 }));
  *
  */
-export function runEntityStoreAction<TEntityStore extends EntityStore<S>, S = TEntityStore extends EntityStore<infer T> ? T : any>(
+export function runEntityStoreAction<TEntityStore extends EntityStore<S>, S extends EntityState = TEntityStore extends EntityStore<infer T> ? T : any>(
   storeClassOrName: Constructor<TEntityStore> | string,
   action: EntityStoreAction.AddEntities,
   operation: (operator: TEntityStore['add']) => void
@@ -136,7 +136,7 @@ export function runEntityStoreAction<TEntityStore extends EntityStore<S>, S = TE
  *  runEntityStoreAction(BooksStore, EntityStoreAction.UpdateEntities, update => update(2, { title: 'New title' }));
  *
  */
-export function runEntityStoreAction<TEntityStore extends EntityStore<S>, S = TEntityStore extends EntityStore<infer T> ? T : any>(
+export function runEntityStoreAction<TEntityStore extends EntityStore<S>, S extends EntityState = TEntityStore extends EntityStore<infer T> ? T : any>(
   storeClassOrName: Constructor<TEntityStore> | string,
   action: EntityStoreAction.UpdateEntities,
   operation: (operator: TEntityStore['update']) => void
@@ -151,7 +151,7 @@ export function runEntityStoreAction<TEntityStore extends EntityStore<S>, S = TE
  *  runEntityStoreAction(BooksStore, EntityStoreAction.RemoveEntities, remove => remove(2));
  *
  */
-export function runEntityStoreAction<TEntityStore extends EntityStore<S>, S = TEntityStore extends EntityStore<infer T> ? T : any>(
+export function runEntityStoreAction<TEntityStore extends EntityStore<S>, S extends EntityState = TEntityStore extends EntityStore<infer T> ? T : any>(
   storeClassOrName: Constructor<TEntityStore> | string,
   action: EntityStoreAction.RemoveEntities,
   operation: (operator: TEntityStore['remove']) => void
@@ -166,7 +166,7 @@ export function runEntityStoreAction<TEntityStore extends EntityStore<S>, S = TE
  *  runEntityStoreAction(BooksStore, EntityStoreAction.UpsertEntities, upsert => upsert([2, 3], { title: 'New Title' }, (id, newState) => ({ id, ...newState, price: 0 })));
  *
  */
-export function runEntityStoreAction<TEntityStore extends EntityStore<S>, S = TEntityStore extends EntityStore<infer T> ? T : any>(
+export function runEntityStoreAction<TEntityStore extends EntityStore<S>, S extends EntityState = TEntityStore extends EntityStore<infer T> ? T : any>(
   storeClassOrName: Constructor<TEntityStore> | string,
   action: EntityStoreAction.UpsertEntities,
   operation: (operator: TEntityStore['upsert']) => void
@@ -183,12 +183,12 @@ export function runEntityStoreAction<TEntityStore extends EntityStore<S>, S = TE
  *    { id: 4, title: 'Another title', price: 0 },
  *  ));
  */
-export function runEntityStoreAction<TEntityStore extends EntityStore<S>, S = TEntityStore extends EntityStore<infer T> ? T : any>(
+export function runEntityStoreAction<TEntityStore extends EntityStore<S>, S extends EntityState = TEntityStore extends EntityStore<infer T> ? T : any>(
   storeClassOrName: Constructor<TEntityStore> | string,
   action: EntityStoreAction.UpsertManyEntities,
   operation: (operator: TEntityStore['upsertMany']) => void
 );
-export function runEntityStoreAction<TEntityStore extends EntityStore<S>, S = TEntityStore extends EntityStore<infer T> ? T : any>(
+export function runEntityStoreAction<TEntityStore extends EntityStore<S>, S extends EntityState = TEntityStore extends EntityStore<infer T> ? T : any>(
   storeClassOrName: Constructor<TEntityStore> | string,
   action: EntityStoreAction,
   operation: (operator: TEntityStore[keyof TEntityStore] & Function) => void