ngssm-remote-data 20.0.4 → 20.0.5

package/fesm2022/ngssm-remote-data-testing.mjs

@@ -0,0 +1,88 @@
+import * as i0 from '@angular/core';
+import { inject, Injectable, makeEnvironmentProviders, provideAppInitializer } from '@angular/core';
+import { updateNgssmRemoteCallState, NgssmRemoteCallStateSpecification, NgssmRemoteCallStateInitializer } from 'ngssm-remote-data';
+import { Store, Logger } from 'ngssm-store';
+import { StoreMock } from 'ngssm-store/testing';
+
+/**
+ * Utility service for setting and updating remote call status and errors in the StoreMock during tests.
+ * Provides methods to set the status or error of a remote call.
+ */
+class NgssmRemoteCallSetter {
+    constructor() {
+        this.store = inject(Store);
+    }
+    /**
+     * Sets the status of a remote call in the StoreMock.
+     * @param remoteCallId The identifier of the remote call.
+     * @param status The new status to set.
+     * @returns The NgssmRemoteCallSetter instance for chaining.
+     */
+    setRemoteCallStatus(remoteCallId, status) {
+        this.store.stateValue = updateNgssmRemoteCallState(this.store.stateValue, {
+            remoteCalls: {
+                [remoteCallId]: {
+                    status: { $set: status }
+                }
+            }
+        });
+        return this;
+    }
+    /**
+     * Sets the error of a remote call in the StoreMock.
+     * @param remoteCallId The identifier of the remote call.
+     * @param error The error to set (optional).
+     * @returns The NgssmRemoteCallSetter instance for chaining.
+     */
+    setRemoteCallError(remoteCallId, error) {
+        this.store.stateValue = updateNgssmRemoteCallState(this.store.stateValue, {
+            remoteCalls: {
+                [remoteCallId]: {
+                    error: { $set: error }
+                }
+            }
+        });
+        return this;
+    }
+    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "20.0.2", ngImport: i0, type: NgssmRemoteCallSetter, deps: [], target: i0.ɵɵFactoryTarget.Injectable }); }
+    static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "20.0.2", ngImport: i0, type: NgssmRemoteCallSetter }); }
+}
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.0.2", ngImport: i0, type: NgssmRemoteCallSetter, decorators: [{
+            type: Injectable
+        }] });
+
+/**
+ * App initializer that sets up the NgssmRemoteCall state and sources in the StoreMock for testing purposes.
+ * Throws an error if StoreMock is not registered.
+ */
+const ngssmRemoteCallStateAndRemoteCallsInitializer = () => {
+    const logger = inject(Logger);
+    logger.information('[ngssm-remote-call-testing] Initialization of state and sources');
+    const store = inject(Store);
+    if (!(store instanceof StoreMock)) {
+        throw new Error('StoreMock is not registered.');
+    }
+    store.stateValue = {
+        ...store.stateValue,
+        [NgssmRemoteCallStateSpecification.featureStateKey]: NgssmRemoteCallStateSpecification.initialState
+    };
+    const stateInitializer = inject(NgssmRemoteCallStateInitializer);
+    store.stateValue = stateInitializer.initializeState(store.stateValue);
+};
+/**
+ * Provides environment providers for remote call testing, including the state initializer and helper services.
+ */
+const provideNgssmRemoteCallTesting = () => {
+    return makeEnvironmentProviders([
+        provideAppInitializer(ngssmRemoteCallStateAndRemoteCallsInitializer),
+        NgssmRemoteCallStateInitializer,
+        NgssmRemoteCallSetter
+    ]);
+};
+
+/**
+ * Generated bundle index. Do not edit.
+ */
+
+export { NgssmRemoteCallSetter, ngssmRemoteCallStateAndRemoteCallsInitializer, provideNgssmRemoteCallTesting };
+//# sourceMappingURL=ngssm-remote-data-testing.mjs.map

package/fesm2022/ngssm-remote-data-testing.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ngssm-remote-data-testing.mjs","sources":["../../../projects/ngssm-remote-data/testing/src/ngssm-remote-call-setter.ts","../../../projects/ngssm-remote-data/testing/src/provide-ngssm-remote-call-testing.ts","../../../projects/ngssm-remote-data/testing/ngssm-remote-data-testing.ts"],"sourcesContent":["import { inject, Injectable } from '@angular/core';\n\nimport { RemoteCallError, RemoteCallStatus, updateNgssmRemoteCallState } from 'ngssm-remote-data';\nimport { Store } from 'ngssm-store';\nimport { StoreMock } from 'ngssm-store/testing';\n\n/**\n * Utility service for setting and updating remote call status and errors in the StoreMock during tests.\n * Provides methods to set the status or error of a remote call.\n */\n@Injectable()\nexport class NgssmRemoteCallSetter {\n  public readonly store = inject(Store) as unknown as StoreMock;\n\n  /**\n   * Sets the status of a remote call in the StoreMock.\n   * @param remoteCallId The identifier of the remote call.\n   * @param status The new status to set.\n   * @returns The NgssmRemoteCallSetter instance for chaining.\n   */\n  public setRemoteCallStatus(remoteCallId: string, status: RemoteCallStatus): NgssmRemoteCallSetter {\n    this.store.stateValue = updateNgssmRemoteCallState(this.store.stateValue, {\n      remoteCalls: {\n        [remoteCallId]: {\n          status: { $set: status }\n        }\n      }\n    });\n\n    return this;\n  }\n\n  /**\n   * Sets the error of a remote call in the StoreMock.\n   * @param remoteCallId The identifier of the remote call.\n   * @param error The error to set (optional).\n   * @returns The NgssmRemoteCallSetter instance for chaining.\n   */\n  public setRemoteCallError(remoteCallId: string, error?: RemoteCallError): NgssmRemoteCallSetter {\n    this.store.stateValue = updateNgssmRemoteCallState(this.store.stateValue, {\n      remoteCalls: {\n        [remoteCallId]: {\n          error: { $set: error }\n        }\n      }\n    });\n\n    return this;\n  }\n}\n","import { EnvironmentProviders, inject, makeEnvironmentProviders, provideAppInitializer } from '@angular/core';\n\nimport { Logger, Store } from 'ngssm-store';\nimport { StoreMock } from 'ngssm-store/testing';\n\nimport { NgssmRemoteCallStateSpecification, NgssmRemoteCallStateInitializer } from 'ngssm-remote-data';\nimport { NgssmRemoteCallSetter } from './ngssm-remote-call-setter';\n\n/**\n * App initializer that sets up the NgssmRemoteCall state and sources in the StoreMock for testing purposes.\n * Throws an error if StoreMock is not registered.\n */\nexport const ngssmRemoteCallStateAndRemoteCallsInitializer = () => {\n  const logger = inject(Logger);\n  logger.information('[ngssm-remote-call-testing] Initialization of state and sources');\n  const store = inject(Store);\n  if (!(store instanceof StoreMock)) {\n    throw new Error('StoreMock is not registered.');\n  }\n\n  store.stateValue = {\n    ...store.stateValue,\n    [NgssmRemoteCallStateSpecification.featureStateKey]: NgssmRemoteCallStateSpecification.initialState\n  };\n\n  const stateInitializer = inject(NgssmRemoteCallStateInitializer);\n  store.stateValue = stateInitializer.initializeState(store.stateValue);\n};\n\n/**\n * Provides environment providers for remote call testing, including the state initializer and helper services.\n */\nexport const provideNgssmRemoteCallTesting = (): EnvironmentProviders => {\n  return makeEnvironmentProviders([\n    provideAppInitializer(ngssmRemoteCallStateAndRemoteCallsInitializer),\n    NgssmRemoteCallStateInitializer,\n    NgssmRemoteCallSetter\n  ]);\n};\n","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './public_api';\n"],"names":[],"mappings":";;;;;;AAMA;;;AAGG;MAEU,qBAAqB,CAAA;AADlC,IAAA,WAAA,GAAA;AAEkB,QAAA,IAAA,CAAA,KAAK,GAAG,MAAM,CAAC,KAAK,CAAyB;AAqC9D;AAnCC;;;;;AAKG;IACI,mBAAmB,CAAC,YAAoB,EAAE,MAAwB,EAAA;AACvE,QAAA,IAAI,CAAC,KAAK,CAAC,UAAU,GAAG,0BAA0B,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE;AACxE,YAAA,WAAW,EAAE;gBACX,CAAC,YAAY,GAAG;AACd,oBAAA,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM;AACvB;AACF;AACF,SAAA,CAAC;AAEF,QAAA,OAAO,IAAI;;AAGb;;;;;AAKG;IACI,kBAAkB,CAAC,YAAoB,EAAE,KAAuB,EAAA;AACrE,QAAA,IAAI,CAAC,KAAK,CAAC,UAAU,GAAG,0BAA0B,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE;AACxE,YAAA,WAAW,EAAE;gBACX,CAAC,YAAY,GAAG;AACd,oBAAA,KAAK,EAAE,EAAE,IAAI,EAAE,KAAK;AACrB;AACF;AACF,SAAA,CAAC;AAEF,QAAA,OAAO,IAAI;;8GApCF,qBAAqB,EAAA,IAAA,EAAA,EAAA,EAAA,MAAA,EAAA,EAAA,CAAA,eAAA,CAAA,UAAA,EAAA,CAAA,CAAA;kHAArB,qBAAqB,EAAA,CAAA,CAAA;;2FAArB,qBAAqB,EAAA,UAAA,EAAA,CAAA;kBADjC;;;ACFD;;;AAGG;AACI,MAAM,6CAA6C,GAAG,MAAK;AAChE,IAAA,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;AAC7B,IAAA,MAAM,CAAC,WAAW,CAAC,iEAAiE,CAAC;AACrF,IAAA,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;AAC3B,IAAA,IAAI,EAAE,KAAK,YAAY,SAAS,CAAC,EAAE;AACjC,QAAA,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC;;IAGjD,KAAK,CAAC,UAAU,GAAG;QACjB,GAAG,KAAK,CAAC,UAAU;AACnB,QAAA,CAAC,iCAAiC,CAAC,eAAe,GAAG,iCAAiC,CAAC;KACxF;AAED,IAAA,MAAM,gBAAgB,GAAG,MAAM,CAAC,+BAA+B,CAAC;IAChE,KAAK,CAAC,UAAU,GAAG,gBAAgB,CAAC,eAAe,CAAC,KAAK,CAAC,UAAU,CAAC;AACvE;AAEA;;AAEG;AACI,MAAM,6BAA6B,GAAG,MAA2B;AACtE,IAAA,OAAO,wBAAwB,CAAC;QAC9B,qBAAqB,CAAC,6CAA6C,CAAC;QACpE,+BAA+B;QAC/B;AACD,KAAA,CAAC;AACJ;;ACtCA;;AAEG;;;;"}

package/fesm2022/ngssm-remote-data.mjs

@@ -643,5 +643,5 @@ const atLeastOneLoadingOrInProgress = (state, remoteDataKeys, remoteCallIds) =>
  * Generated bundle index. Do not edit.
  */
 
-export { DataStatus, LoadRemoteDataAction, NGSSM_REMOTE_CALL_CONFIG, NGSSM_REMOTE_DATA_PROVIDER, NgssmCachesComponent, NgssmCachesDisplayButtonComponent, NgssmRemoteCallActionType, NgssmRemoteCallDirective, NgssmRemoteCallErrorComponent, NgssmRemoteCallResultAction, NgssmRemoteCallStateSpecification, NgssmRemoteDataOverlayDirective, NgssmRemoteDataReloadButtonComponent, RegisterLoadedRemoteDataAction, RemoteCallStatus, RemoteDataActionType, RemoteDataLoadingGuard, RemoteDataStateSpecification, SetRemoteCallAction, atLeastOneLoadingOrInProgress, getDefaultRemoteCall, getDefaultRemoteData, isNgssmRemoteCallInProgress, ngssmReloadRemoteData, processRemoteCallError, provideNgssmRemoteCall, provideNgssmRemoteCallConfig, provideNgssmRemoteData, provideRemoteDataFunc, provideRemoteDataProviders, selectNgssmRemoteCallState, selectRemoteCall, selectRemoteData, selectRemoteDataState, updateNgssmRemoteCallState, updateRemoteDataState };
+export { DataStatus, LoadRemoteDataAction, NGSSM_REMOTE_CALL_CONFIG, NGSSM_REMOTE_DATA_PROVIDER, NgssmCachesComponent, NgssmCachesDisplayButtonComponent, NgssmRemoteCallActionType, NgssmRemoteCallDirective, NgssmRemoteCallErrorComponent, NgssmRemoteCallResultAction, NgssmRemoteCallStateInitializer, NgssmRemoteCallStateSpecification, NgssmRemoteDataOverlayDirective, NgssmRemoteDataReloadButtonComponent, RegisterLoadedRemoteDataAction, RemoteCallStatus, RemoteDataActionType, RemoteDataLoadingGuard, RemoteDataStateSpecification, SetRemoteCallAction, atLeastOneLoadingOrInProgress, getDefaultRemoteCall, getDefaultRemoteData, isNgssmRemoteCallInProgress, ngssmReloadRemoteData, processRemoteCallError, provideNgssmRemoteCall, provideNgssmRemoteCallConfig, provideNgssmRemoteData, provideRemoteDataFunc, provideRemoteDataProviders, selectNgssmRemoteCallState, selectRemoteCall, selectRemoteData, selectRemoteDataState, updateNgssmRemoteCallState, updateRemoteDataState };
 //# sourceMappingURL=ngssm-remote-data.mjs.map

package/index.d.ts

@@ -2,7 +2,7 @@ import * as i0 from '@angular/core';
 import { InjectionToken, Type, EnvironmentProviders, Provider } from '@angular/core';
 import { Observable } from 'rxjs';
 import { Spec } from 'immutability-helper';
-import { ActionDispatcher, Logger, State, Action } from 'ngssm-store';
+import { ActionDispatcher, Logger, State, Action, StateInitializer } from 'ngssm-store';
 import { ActivatedRouteSnapshot, UrlTree } from '@angular/router';
 import { HttpErrorResponse } from '@angular/common/http';
 import { NgssmNotifierService } from 'ngssm-toolkit';
@@ -232,7 +232,14 @@ declare const selectRemoteCall: (state: State, id: string) => RemoteCall;
  */
 declare const isNgssmRemoteCallInProgress: (state: State, remoteCallId: string) => boolean;
 
+declare class NgssmRemoteCallStateInitializer implements StateInitializer {
+    private readonly remoteCallConfigs;
+    initializeState(state: State): State;
+    static ɵfac: i0.ɵɵFactoryDeclaration<NgssmRemoteCallStateInitializer, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<NgssmRemoteCallStateInitializer>;
+}
+
 declare const atLeastOneLoadingOrInProgress: (state: State, remoteDataKeys: string[], remoteCallIds: string[]) => boolean;
 
-export { DataStatus, LoadRemoteDataAction, NGSSM_REMOTE_CALL_CONFIG, NGSSM_REMOTE_DATA_PROVIDER, NgssmCachesComponent, NgssmCachesDisplayButtonComponent, NgssmRemoteCallActionType, NgssmRemoteCallDirective, NgssmRemoteCallErrorComponent, NgssmRemoteCallResultAction, NgssmRemoteCallStateSpecification, NgssmRemoteDataOverlayDirective, NgssmRemoteDataReloadButtonComponent, RegisterLoadedRemoteDataAction, RemoteCallStatus, RemoteDataActionType, RemoteDataLoadingGuard, RemoteDataStateSpecification, SetRemoteCallAction, atLeastOneLoadingOrInProgress, getDefaultRemoteCall, getDefaultRemoteData, isNgssmRemoteCallInProgress, ngssmReloadRemoteData, processRemoteCallError, provideNgssmRemoteCall, provideNgssmRemoteCallConfig, provideNgssmRemoteData, provideRemoteDataFunc, provideRemoteDataProviders, selectNgssmRemoteCallState, selectRemoteCall, selectRemoteData, selectRemoteDataState, updateNgssmRemoteCallState, updateRemoteDataState };
+export { DataStatus, LoadRemoteDataAction, NGSSM_REMOTE_CALL_CONFIG, NGSSM_REMOTE_DATA_PROVIDER, NgssmCachesComponent, NgssmCachesDisplayButtonComponent, NgssmRemoteCallActionType, NgssmRemoteCallDirective, NgssmRemoteCallErrorComponent, NgssmRemoteCallResultAction, NgssmRemoteCallStateInitializer, NgssmRemoteCallStateSpecification, NgssmRemoteDataOverlayDirective, NgssmRemoteDataReloadButtonComponent, RegisterLoadedRemoteDataAction, RemoteCallStatus, RemoteDataActionType, RemoteDataLoadingGuard, RemoteDataStateSpecification, SetRemoteCallAction, atLeastOneLoadingOrInProgress, getDefaultRemoteCall, getDefaultRemoteData, isNgssmRemoteCallInProgress, ngssmReloadRemoteData, processRemoteCallError, provideNgssmRemoteCall, provideNgssmRemoteCallConfig, provideNgssmRemoteData, provideRemoteDataFunc, provideRemoteDataProviders, selectNgssmRemoteCallState, selectRemoteCall, selectRemoteData, selectRemoteDataState, updateNgssmRemoteCallState, updateRemoteDataState };
 export type { NgssmRemoteCallState, ReloadParams, RemoteCall, RemoteCallConfig, RemoteCallError, RemoteData, RemoteDataGetterParams, RemoteDataLoadingFunc, RemoteDataLoadingGuardItem, RemoteDataLoadingGuardParameters, RemoteDataProvider, RemoteDataState };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ngssm-remote-data",
-  "version": "20.0.4",
+  "version": "20.0.5",
   "description": "NgSsm - Utilities to manage data loaded from remote services with the store.",
   "author": "Lion Marc",
   "license": "MIT",
@@ -26,6 +26,10 @@
     ".": {
       "types": "./index.d.ts",
       "default": "./fesm2022/ngssm-remote-data.mjs"
+    },
+    "./testing": {
+      "types": "./testing/index.d.ts",
+      "default": "./fesm2022/ngssm-remote-data-testing.mjs"
     }
   },
   "sideEffects": false

package/testing/index.d.ts

@@ -0,0 +1,40 @@
+import { RemoteCallStatus, RemoteCallError } from 'ngssm-remote-data';
+import { StoreMock } from 'ngssm-store/testing';
+import * as i0 from '@angular/core';
+import { EnvironmentProviders } from '@angular/core';
+
+/**
+ * Utility service for setting and updating remote call status and errors in the StoreMock during tests.
+ * Provides methods to set the status or error of a remote call.
+ */
+declare class NgssmRemoteCallSetter {
+    readonly store: StoreMock;
+    /**
+     * Sets the status of a remote call in the StoreMock.
+     * @param remoteCallId The identifier of the remote call.
+     * @param status The new status to set.
+     * @returns The NgssmRemoteCallSetter instance for chaining.
+     */
+    setRemoteCallStatus(remoteCallId: string, status: RemoteCallStatus): NgssmRemoteCallSetter;
+    /**
+     * Sets the error of a remote call in the StoreMock.
+     * @param remoteCallId The identifier of the remote call.
+     * @param error The error to set (optional).
+     * @returns The NgssmRemoteCallSetter instance for chaining.
+     */
+    setRemoteCallError(remoteCallId: string, error?: RemoteCallError): NgssmRemoteCallSetter;
+    static ɵfac: i0.ɵɵFactoryDeclaration<NgssmRemoteCallSetter, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<NgssmRemoteCallSetter>;
+}
+
+/**
+ * App initializer that sets up the NgssmRemoteCall state and sources in the StoreMock for testing purposes.
+ * Throws an error if StoreMock is not registered.
+ */
+declare const ngssmRemoteCallStateAndRemoteCallsInitializer: () => void;
+/**
+ * Provides environment providers for remote call testing, including the state initializer and helper services.
+ */
+declare const provideNgssmRemoteCallTesting: () => EnvironmentProviders;
+
+export { NgssmRemoteCallSetter, ngssmRemoteCallStateAndRemoteCallsInitializer, provideNgssmRemoteCallTesting };