feat: convert entity and router selectors interfaces to types (#3853)

Author: markostanimirovic

modules/entity/spec/types/entity_selectors.types.spec.ts

@@ -0,0 +1,31 @@
+import { expecter } from 'ts-snippet';
+import { compilerOptions } from './utils';
+
+describe('EntitySelectors', () => {
+  const expectSnippet = expecter(
+    (code) => `
+        import { Selector } from '@ngrx/store';
+        import { EntitySelectors } from './modules/entity/src/models';
+
+        ${code}
+      `,
+    compilerOptions()
+  );
+
+  it('is compatible with a dictionary of selectors', () => {
+    expectSnippet(`
+      type SelectorsDictionary = Record<
+        string,
+        | Selector<Record<string, any>, unknown>
+        | ((...args: any[]) => Selector<Record<string, any>, unknown>)
+      >;
+      type ExtendsSelectorsDictionary<T> = T extends SelectorsDictionary
+        ? true
+        : false;
+
+      let result: ExtendsSelectorsDictionary<
+        EntitySelectors<unknown, Record<string, any>>
+      >;
+    `).toInfer('result', 'true');
+  });
+});

modules/entity/spec/types/utils.ts

@@ -0,0 +1,11 @@
+export const compilerOptions = () => ({
+  moduleResolution: 'node',
+  target: 'ES2022',
+  baseUrl: '.',
+  experimentalDecorators: true,
+  strict: true,
+  paths: {
+    '@ngrx/entity': ['./modules/entity'],
+    '@ngrx/store': ['./modules/store'],
+  },
+});

modules/entity/src/models.ts

@@ -78,12 +78,12 @@ export interface EntityStateAdapter<T> {
   map<S extends EntityState<T>>(map: EntityMap<T>, state: S): S;
 }
 
-export interface EntitySelectors<T, V> {
+export type EntitySelectors<T, V> = {
   selectIds: (state: V) => string[] | number[];
   selectEntities: (state: V) => Dictionary<T>;
   selectAll: (state: V) => T[];
   selectTotal: (state: V) => number;
-}
+};
 
 export interface EntityAdapter<T> extends EntityStateAdapter<T> {
   selectId: IdSelector<T>;

modules/entity/src/state_selectors.ts

@@ -1,5 +1,5 @@
 import { createSelector } from '@ngrx/store';
-import { EntityState, EntitySelectors, Dictionary } from './models';
+import { EntityState, EntitySelectors } from './models';
 
 export function createSelectorsFactory<T>() {
   function getSelectors(): EntitySelectors<T, EntityState<T>>;

modules/router-store/spec/types/selectors.spec.ts renamed to modules/router-store/spec/types/router_selectors.types.spec.ts

@@ -1,7 +1,7 @@
 import { expecter } from 'ts-snippet';
 import { compilerOptions } from './utils';
 
-describe('router selectors', () => {
+describe('getRouterSelectors', () => {
   const expectSnippet = expecter(
     (code) => `
       import { getRouterSelectors, RouterReducerState } from '@ngrx/router-store';
@@ -124,3 +124,32 @@ describe('router selectors', () => {
     );
   });
 });
+
+describe('RouterStateSelectors', () => {
+  const expectSnippet = expecter(
+    (code) => `
+      import { Selector } from '@ngrx/store';
+      import { RouterStateSelectors } from './modules/router-store/src/models';
+
+      ${code}
+    `,
+    compilerOptions()
+  );
+
+  it('is compatible with a dictionary of selectors', () => {
+    expectSnippet(`
+      type SelectorsDictionary = Record<
+        string,
+        | Selector<Record<string, any>, unknown>
+        | ((...args: any[]) => Selector<Record<string, any>, unknown>)
+      >;
+      type ExtendsSelectorsDictionary<T> = T extends SelectorsDictionary
+        ? true
+        : false;
+
+      let result: ExtendsSelectorsDictionary<
+        RouterStateSelectors<Record<string, any>>
+      >;
+    `).toInfer('result', 'true');
+  });
+});

modules/router-store/src/models.ts

@@ -1,7 +1,7 @@
 import { Data, Params } from '@angular/router';
 import { MemoizedSelector } from '@ngrx/store';
 
-export interface RouterStateSelectors<V> {
+export type RouterStateSelectors<V> = {
   selectCurrentRoute: MemoizedSelector<V, any>;
   selectFragment: MemoizedSelector<V, string | undefined>;
   selectQueryParams: MemoizedSelector<V, Params>;
@@ -14,4 +14,4 @@ export interface RouterStateSelectors<V> {
   ) => MemoizedSelector<V, string | undefined>;
   selectUrl: MemoizedSelector<V, string>;
   selectTitle: MemoizedSelector<V, string | undefined>;
-}
+};