fix(ngxs): upgrade to NGXS 18.1.3 (#1527)

hakimio · web-flow · commit abb2b854d249 · 2024-10-22T19:45:13.000+03:00
diff --git a/libs/ngxs/decorators/data-action/data-action.ts b/libs/ngxs/decorators/data-action/data-action.ts
@@ -17,11 +17,11 @@ import {
     DataStateClass,
     DispatchedResult,
     ImmutableDataRepository,
+    type MappedStore,
     NgxsDataOperation,
     NgxsRepositoryMeta,
     RepositoryActionOptions,
 } from '@angular-ru/ngxs/typings';
-import {MappedStore} from '@ngxs/store/src/internal/internals';
 import {isObservable, Observable, of} from 'rxjs';
 import {map} from 'rxjs/operators';
 
@@ -48,11 +48,12 @@ export function DataAction(options: RepositoryActionOptions = {}): MethodDecorat
                 NgxsDataFactory.getRepositoryByInstance(instance);
             const operations: PlainObjectOf<NgxsDataOperation> = repository.operations!;
             let operation: NgxsDataOperation | undefined = operations[key];
+            const operationNotSet = isNil(operation);
             const stateMeta: any = repository.stateMeta;
             const registry: MethodArgsRegistry | undefined =
                 getMethodArgsRegistry(originalMethod);
 
-            if (isNil(operation)) {
+            if (operationNotSet) {
                 // Note: late init operation when first invoke action method
                 const argumentsNames: string[] = $args(originalMethod);
                 const type: string = actionNameCreator({
@@ -67,15 +68,13 @@ export function DataAction(options: RepositoryActionOptions = {}): MethodDecorat
                     options: {cancelUncompleted: config.cancelUncompleted ?? false},
                 };
 
-                if (isNotNil(operation)) {
-                    stateMeta.actions[operation.type] = [
-                        {
-                            type: operation.type,
-                            options: operation.options,
-                            fn: operation.type,
-                        },
-                    ];
-                }
+                stateMeta.actions[operation.type] = [
+                    {
+                        type: operation.type,
+                        options: operation.options,
+                        fn: operation.type,
+                    },
+                ];
             }
 
             const mapped: MappedStore = NgxsDataFactory.ensureMappedState(stateMeta)!;
@@ -98,8 +97,19 @@ export function DataAction(options: RepositoryActionOptions = {}): MethodDecorat
                     : result;
             };
 
+            if (operationNotSet) {
+                const factory = NgxsDataInjector.factory!;
+
+                factory.hydrateActionMetasMap({
+                    ...mapped,
+                    actions: {
+                        [operation.type]: mapped.actions[operation.type],
+                    },
+                });
+            }
+
             const event: ActionEvent = NgxsDataFactory.createAction(
-                operation,
+                operation.type,
                 args,
                 registry,
             );
diff --git a/libs/ngxs/internals/services/ngxs-data-factory.service.ts b/libs/ngxs/internals/services/ngxs-data-factory.service.ts
@@ -6,12 +6,11 @@ import {
     ActionEvent,
     DataStateClass,
     MappedState,
-    NgxsDataOperation,
+    MappedStore,
     NgxsRepositoryMeta,
     PayloadName,
 } from '@angular-ru/ngxs/typings';
 import {StateContext} from '@ngxs/store';
-import {MappedStore} from '@ngxs/store/src/internal/internals';
 
 import {dynamicActionByType} from '../utils/action/dynamic-action';
 import {MethodArgsRegistry} from '../utils/method-args-registry/method-args-registry';
@@ -26,8 +25,8 @@ export class NgxsDataFactory {
         NgxsDataFactory.statesCachedMeta.clear();
     }
 
-    public static createStateContext<T>(metadata: MappedStore): StateContext<T> {
-        return NgxsDataInjector.context.createStateContext(metadata);
+    public static createStateContext<T>(path: string): StateContext<T> {
+        return NgxsDataInjector.context.createStateContext(path);
     }
 
     public static ensureMappedState(stateMeta: any | undefined): MappedState | never {
@@ -93,22 +92,22 @@ export class NgxsDataFactory {
     }
 
     public static createAction(
-        operation: NgxsDataOperation,
+        type: string,
         args: any[],
         registry?: MethodArgsRegistry,
     ): ActionEvent {
         const payload: PlainObjectOf<any> | null = NgxsDataFactory.createPayload(
             args,
             registry,
         );
-        const dynamicActionByTypeFactory: Type<any> = dynamicActionByType(operation.type);
+        const dynamicActionByTypeFactory: Type<any> = dynamicActionByType(type);
 
         return new dynamicActionByTypeFactory(payload);
     }
 
     private static ensureMeta(stateMeta: any): MappedStore | null | undefined {
         const meta: MappedState = isNotNil(stateMeta.name)
-            ? (NgxsDataInjector.factory.states as MappedStore[])?.find(
+            ? NgxsDataInjector.factory!.states?.find(
                   (state: MappedStore): boolean => state.name === stateMeta.name,
               )
             : null;
diff --git a/libs/ngxs/internals/services/ngxs-data-injector.service.ts b/libs/ngxs/internals/services/ngxs-data-injector.service.ts
@@ -1,4 +1,5 @@
 import {Inject, Injectable, Injector, NgZone} from '@angular/core';
+import type {StateFactory} from '@angular-ru/ngxs/typings';
 import {Store} from '@ngxs/store';
 import {
     ɵNGXS_STATE_CONTEXT_FACTORY as NGXS_STATE_CONTEXT_FACTORY,
@@ -12,7 +13,7 @@ export class NgxsDataInjector {
     public static store: Store | null = null;
     public static computed: NgxsDataSequence | null = null;
     public static context: any | null = null;
-    public static factory: any | null = null;
+    public static factory: StateFactory | null = null;
     public static ngZone: NgZone | null = null;
     public static injector: Injector | null = null;
 
diff --git a/libs/ngxs/internals/utils/state-context/create-context.ts b/libs/ngxs/internals/utils/state-context/create-context.ts
@@ -1,6 +1,5 @@
-import {DataStateClass, NgxsRepositoryMeta} from '@angular-ru/ngxs/typings';
+import {DataStateClass, MappedStore, NgxsRepositoryMeta} from '@angular-ru/ngxs/typings';
 import {StateContext} from '@ngxs/store';
-import {MappedStore} from '@ngxs/store/src/internal/internals';
 
 import {NgxsDataFactory} from '../../services/ngxs-data-factory.service';
 import {getRepository} from '../repository/get-repository';
@@ -15,7 +14,7 @@ export function createContext(stateClass: DataStateClass): PropertyDescriptor {
                 meta.stateMeta,
             )!;
 
-            return NgxsDataFactory.createStateContext(mappedMeta);
+            return NgxsDataFactory.createStateContext(mappedMeta.path);
         },
     };
 }
diff --git a/libs/ngxs/package.json b/libs/ngxs/package.json
@@ -8,7 +8,7 @@
     "license": "MIT",
     "author": "angular-ru@yandex.ru",
     "peerDependencies": {
-        "@ngxs/store": ">=18.0.0"
+        "@ngxs/store": ">=18.1.3"
     },
     "publishConfig": {
         "access": "public"
diff --git a/libs/ngxs/storage/utils/rehydrate.ts b/libs/ngxs/storage/utils/rehydrate.ts
@@ -23,8 +23,7 @@ export function rehydrate<T>(params: RehydrateInfoOptions<T>): RehydrateInfo {
     const prevData: T = getValue(states, path);
 
     if (isTruthy(info.versionMismatch)) {
-        const stateInstance: any = provider.stateInstance;
-        const instance: NgxsDataMigrateStorage = stateInstance;
+        const instance: NgxsDataMigrateStorage = provider.stateInstance;
         const migrateFn: MigrateFn =
             provider.migrate ??
             instance.ngxsDataStorageMigrate?.bind(provider.stateInstance);
diff --git a/libs/ngxs/testing/platform/ngxs-data-testing.module.ts b/libs/ngxs/testing/platform/ngxs-data-testing.module.ts
@@ -6,7 +6,7 @@ import {
     NGXS_DATA_STORAGE_EXTENSION,
 } from '@angular-ru/ngxs/storage';
 import {NgxsModule} from '@ngxs/store';
-import {ɵStateClass as StateClass} from '@ngxs/store/internals/symbols';
+import {ɵStateClass as StateClass} from '@ngxs/store/internals';
 
 import {createInternalNgxsRootElement} from './internal/create-internal-ngxs-root-element';
 import {NgxsAppMockModule} from './ngxs-app-mock.module';
diff --git a/libs/ngxs/testing/platform/ngxs-platform.ts b/libs/ngxs/testing/platform/ngxs-platform.ts
@@ -3,7 +3,7 @@ import {TestBed, TestModuleMetadata} from '@angular/core/testing';
 import {isNil} from '@angular-ru/cdk/utils';
 import {getStateMetadata} from '@angular-ru/ngxs/internals';
 import {Store} from '@ngxs/store';
-import {ɵStateClass as StateClass} from '@ngxs/store/internals/symbols';
+import {ɵStateClass as StateClass} from '@ngxs/store/internals';
 
 import {TestSpec} from './internal/types';
 import {NgxsDataTestingModule} from './ngxs-data-testing.module';
diff --git a/libs/ngxs/tests/common-extensions/action-decorator.spec.ts b/libs/ngxs/tests/common-extensions/action-decorator.spec.ts
@@ -10,7 +10,7 @@ import {NgxsModule, State} from '@ngxs/store';
 describe('[TEST]: Action decorator', () => {
     afterEach(() => TestBed.resetTestingModule());
 
-    it("don't should be working without @StateRepository decorator", () => {
+    it('should not be working without @StateRepository decorator', () => {
         let message: string | null = null;
 
         try {
@@ -41,7 +41,7 @@ describe('[TEST]: Action decorator', () => {
         expect(message).toEqual(NGXS_DATA_EXCEPTIONS.NGXS_DATA_STATE_DECORATOR);
     });
 
-    it.skip("don't should be working without @StateRepository and @State decorator", () => {
+    it.skip('should not be working without @StateRepository and @State decorator', () => {
         let message: string | null = null;
 
         try {
@@ -73,7 +73,7 @@ describe('[TEST]: Action decorator', () => {
         );
     });
 
-    it.skip("don't should be working without provided meta information", () => {
+    it.skip('should not be working without provided meta information', () => {
         let message: string | null = null;
 
         try {
@@ -104,7 +104,7 @@ describe('[TEST]: Action decorator', () => {
         expect(message).toEqual(NGXS_DATA_EXCEPTIONS.NGXS_DATA_STATE_DECORATOR);
     });
 
-    it.skip("don't should be working when register as service", () => {
+    it.skip('should not be working when register as service', () => {
         let message: string | null = null;
 
         try {
diff --git a/libs/ngxs/tests/common-extensions/state-context.spec.ts b/libs/ngxs/tests/common-extensions/state-context.spec.ts
@@ -9,7 +9,10 @@ import {
 } from '@angular-ru/ngxs/internals';
 import {NgxsImmutableDataRepository} from '@angular-ru/ngxs/repositories';
 import {NgxsModule, State, Store} from '@ngxs/store';
-import {MetaDataModel, SharedSelectorOptions} from '@ngxs/store/src/internal/internals';
+import {
+    ɵMetaDataModel as MetaDataModel,
+    ɵSharedSelectorOptions as SharedSelectorOptions,
+} from '@ngxs/store/internals';
 import {isObservable} from 'rxjs';
 
 describe('[TEST]: Utils', () => {
diff --git a/libs/ngxs/tests/entity/primary-key-or-unique-id.spec.ts b/libs/ngxs/tests/entity/primary-key-or-unique-id.spec.ts
@@ -220,6 +220,7 @@ describe('[TEST]: Entity - primary key or unique id', () => {
             name: 'student',
             defaults: createEntityCollections(),
         })
+        @Injectable()
         class StudentEntitiesState extends NgxsDataEntityCollectionsRepository<
             StudentEntity,
             string
diff --git a/libs/ngxs/tests/inheritance-extensions/children.spec.ts b/libs/ngxs/tests/inheritance-extensions/children.spec.ts
@@ -5,7 +5,7 @@ import {NgxsDataPluginModule} from '@angular-ru/ngxs';
 import {StateRepository} from '@angular-ru/ngxs/decorators';
 import {NgxsImmutableDataRepository} from '@angular-ru/ngxs/repositories';
 import {Action, NgxsModule, State, StateContext, Store} from '@ngxs/store';
-import {PlainObjectOf} from '@ngxs/store/internals';
+import {ɵPlainObjectOf as PlainObjectOf} from '@ngxs/store/internals';
 
 describe('check correct deep instance', () => {
     let app: AppState;
diff --git a/libs/ngxs/typings/common/data-state-class.ts b/libs/ngxs/typings/common/data-state-class.ts
@@ -1,7 +1,7 @@
 /* istanbul ignore next */
 
 import {NGXS_DATA_META, NGXS_META_KEY} from '@angular-ru/ngxs/tokens';
-import {ɵStateClass as StateClass} from '@ngxs/store/internals/symbols';
+import {ɵStateClass as StateClass} from '@ngxs/store/internals';
 
 import {NgxsRepositoryMeta} from './repository';
 
diff --git a/libs/ngxs/typings/common/mapped-state.ts b/libs/ngxs/typings/common/mapped-state.ts
@@ -1,3 +1,3 @@
-import {MappedStore} from '@ngxs/store/src/internal/internals';
+import type {MappedStore} from './mapped-store';
 
 export type MappedState = MappedStore | null | undefined;
diff --git a/libs/ngxs/typings/common/mapped-store.ts b/libs/ngxs/typings/common/mapped-store.ts
@@ -0,0 +1,13 @@
+import {
+    ɵActionHandlerMetaData as ActionHandlerMetaData,
+    ɵPlainObjectOf as PlainObjectOf,
+} from '@ngxs/store/internals';
+
+export interface MappedStore {
+    name: string;
+    isInitialised: boolean;
+    actions: PlainObjectOf<ActionHandlerMetaData[]>;
+    defaults: any;
+    instance: any;
+    path: string;
+}
diff --git a/libs/ngxs/typings/common/state-factory.ts b/libs/ngxs/typings/common/state-factory.ts
@@ -0,0 +1,6 @@
+import type {MappedStore} from './mapped-store';
+
+export interface StateFactory {
+    hydrateActionMetasMap(mappedStore: MappedStore): void;
+    states: MappedStore[];
+}
diff --git a/libs/ngxs/typings/index.ts b/libs/ngxs/typings/index.ts
@@ -17,6 +17,7 @@ export {
 export {DispatchedResult} from './common/dispatched-result';
 export {NgxsDataExtension} from './common/extension';
 export {MappedState} from './common/mapped-state';
+export {MappedStore} from './common/mapped-store';
 export {NgxsDataAfterReset, NgxsDataDoCheck} from './common/ngxs-data-lifecycle';
 export {
     DataRepository,
@@ -30,6 +31,7 @@ export {
     PatchValue,
     StateValue,
 } from './common/repository';
+export {StateFactory} from './common/state-factory';
 export {EntityContext} from './entity/entity-context';
 export {EntityRepository} from './entity/entity-repository';
 export {
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -108,7 +108,7 @@
         "@ng-web-apis/universal": "4.1.2",
         "@ngx-translate/core": "15.0.0",
         "@ngx-translate/http-loader": "8.0.0",
-        "@ngxs/logger-plugin": "18.0.0",
+        "@ngxs/logger-plugin": "18.1.3",
         "@nx/workspace": "19.4.1",
         "@release-it-plugins/workspaces": "4.2.0",
         "@release-it/conventional-changelog": "8.0.1",
