@luvio/adapter-test-library 0.138.2 → 0.138.4

package/dist/es/es2018/test-library.js

@@ -322,14 +322,15 @@ function overrideMockNetworkResponses(mockNetworkAdapter, responses) {
         return onNetworkStubCalled(stub, response);
     });
 }
-function resetMockNetworkAdapter(mockNetworkAdapter) {
+function resetMockNetworkAdapter(mockNetworkAdapter, newPayloads) {
     const stub = mockNetworkAdapter;
     // reset stub in case a test modified payload responses
     stub.reset();
     // reset call count
     callCountMap.set(stub, 0);
-    // set original mock payloads up
-    const payloads = mockPayloadsMap.get(stub);
+    // set mock payloads up - Allow for the test to provide a different set of payloads
+    // Default behavior is to reset to the original payloads.
+    const payloads = newPayloads ? newPayloads : mockPayloadsMap.get(stub);
     if (payloads) {
         setMockNetworkPayloads(stub, payloads);
     }
@@ -538,6 +539,7 @@ async function testAdapterCompletesRoundtrip(params) {
     expect(result).toEqualFulfilledSnapshotWithData(params.type === 'network'
         ? params.expectedData || params.network.response
         : params.expectedData, params.privateProperties);
+    return result;
 }
 function setupAdapter(params) {
     const luvio = params.type === 'network' ? buildLuvioWithNetwork(params.network).luvio : params.luvio;

package/dist/es/es2018/types/adapterRoundtrip.d.ts

@@ -1,33 +1,33 @@
-import type { AdapterFactory, NetworkAdapter } from '@luvio/engine';
+import type { AdapterFactory, NetworkAdapter, Snapshot } from '@luvio/engine';
 import { Luvio } from '@luvio/engine';
 import type { MockPayload } from './network';
 export declare function buildLuvioInstance(mockNetworkAdapter: NetworkAdapter): Luvio;
-declare type AdapterRoundtripTestParams<C, D> = AdapterNetworkRoundtripTestParams<C, D> | AdapterNetworkRoundtripWithLuvioTestParams<C, D> | AdapterCacheHitRoundtripTestParams<C, D>;
-declare type AdapterTest<C, D> = {
+type AdapterRoundtripTestParams<C, D> = AdapterNetworkRoundtripTestParams<C, D> | AdapterNetworkRoundtripWithLuvioTestParams<C, D> | AdapterCacheHitRoundtripTestParams<C, D>;
+type AdapterTest<C, D> = {
     adapterFactory: AdapterFactory<C, D>;
     adapterConfig: C;
     privateProperties?: string[];
 };
-declare type AdapterTestWithInjectedLuvio<C, D> = AdapterTest<C, D> & {
+type AdapterTestWithInjectedLuvio<C, D> = AdapterTest<C, D> & {
     luvio: Luvio;
     expectedData: D;
 };
-declare type NetworkConfig = {
+type NetworkConfig = {
     request: MockPayload['networkArgs'];
     response: any;
 };
-declare type AdapterNetworkRoundtripTestParams<C, D> = AdapterTest<C, D> & {
+type AdapterNetworkRoundtripTestParams<C, D> = AdapterTest<C, D> & {
     type: 'network';
     network: NetworkConfig;
     expectedData?: D;
 };
-declare type AdapterNetworkRoundtripWithLuvioTestParams<C, D> = AdapterTestWithInjectedLuvio<C, D> & {
+type AdapterNetworkRoundtripWithLuvioTestParams<C, D> = AdapterTestWithInjectedLuvio<C, D> & {
     type: 'injectedLuvioNetwork';
 };
-declare type AdapterCacheHitRoundtripTestParams<C, D> = AdapterTestWithInjectedLuvio<C, D> & {
+type AdapterCacheHitRoundtripTestParams<C, D> = AdapterTestWithInjectedLuvio<C, D> & {
     type: 'cache';
 };
-export declare function testAdapterCompletesRoundtrip<C = any, D = any>(params: AdapterRoundtripTestParams<C, D>): Promise<void>;
+export declare function testAdapterCompletesRoundtrip<C = any, D = any>(params: AdapterRoundtripTestParams<C, D>): Promise<Snapshot<D, unknown>>;
 export declare function buildLuvioWithNetwork(networkConfig: NetworkConfig): {
     luvio: Luvio;
     networkAdapter: NetworkAdapter;

package/dist/es/es2018/types/network.d.ts

@@ -31,7 +31,7 @@ export declare function setMockNetworkPayloads(mockNetworkAdapter: NetworkAdapte
  * until resetMockNetworkAdapter is called.
  */
 export declare function overrideMockNetworkResponses(mockNetworkAdapter: NetworkAdapter, responses: FetchResponse<any>[]): void;
-export declare function resetMockNetworkAdapter(mockNetworkAdapter: NetworkAdapter): void;
+export declare function resetMockNetworkAdapter(mockNetworkAdapter: NetworkAdapter, newPayloads?: MockPayload[]): void;
 export declare function getMockNetworkAdapterCallCount(mockNetworkAdapter: NetworkAdapter): number | undefined;
 export declare function buildFetchResponse<T>(body: T, status?: number, statusText?: string, headers?: Headers): FetchResponse<T>;
 export declare function buildSuccessMockPayload(networkArgs: Partial<ResourceRequest>, body: any, headers?: Headers): MockPayload;

package/dist/es/es2018/types/utils.d.ts

@@ -21,14 +21,14 @@ export declare function stripProperties(obj: {
 }, props: string[]): any;
 export declare function doesThrow(predicate: () => void): boolean;
 export declare function flushPromises(): Promise<unknown>;
-declare type MatcherResult = {
+type MatcherResult = {
     pass: boolean;
     message: () => string;
 };
 export declare const customMatchers: {
-    toEqualFulfilledSnapshotWithData: (snapshot: Snapshot<unknown, unknown>, expected: any, privateProperties?: string[] | undefined) => MatcherResult;
-    toEqualStaleSnapshotWithData: (snapshot: Snapshot<unknown, unknown>, expected: any, privateProperties?: string[] | undefined) => MatcherResult;
-    toEqualErrorSnapshot: (actual: Snapshot<unknown, unknown>, expectedStatus?: number | undefined) => MatcherResult;
+    toEqualFulfilledSnapshotWithData: (snapshot: Snapshot<unknown, unknown>, expected: any, privateProperties?: string[]) => MatcherResult;
+    toEqualStaleSnapshotWithData: (snapshot: Snapshot<unknown, unknown>, expected: any, privateProperties?: string[]) => MatcherResult;
+    toEqualErrorSnapshot: (actual: Snapshot<unknown, unknown>, expectedStatus?: number) => MatcherResult;
     toEqualOfflineErrorSnapshot: (actual: Snapshot<unknown, unknown>) => MatcherResult;
     toHaveBeenHitTimes: (mockNetworkAdapter: NetworkAdapter, expected: Number) => MatcherResult;
     toHaveBeenHitOnce: (mockNetworkAdapter: NetworkAdapter) => MatcherResult;

package/dist/umd/es2018/test-library.js

@@ -325,14 +325,15 @@
             return onNetworkStubCalled(stub, response);
         });
     }
-    function resetMockNetworkAdapter(mockNetworkAdapter) {
+    function resetMockNetworkAdapter(mockNetworkAdapter, newPayloads) {
         const stub = mockNetworkAdapter;
         // reset stub in case a test modified payload responses
         stub.reset();
         // reset call count
         callCountMap.set(stub, 0);
-        // set original mock payloads up
-        const payloads = mockPayloadsMap.get(stub);
+        // set mock payloads up - Allow for the test to provide a different set of payloads
+        // Default behavior is to reset to the original payloads.
+        const payloads = newPayloads ? newPayloads : mockPayloadsMap.get(stub);
         if (payloads) {
             setMockNetworkPayloads(stub, payloads);
         }
@@ -541,6 +542,7 @@
         expect(result).toEqualFulfilledSnapshotWithData(params.type === 'network'
             ? params.expectedData || params.network.response
             : params.expectedData, params.privateProperties);
+        return result;
     }
     function setupAdapter(params) {
         const luvio = params.type === 'network' ? buildLuvioWithNetwork(params.network).luvio : params.luvio;

package/dist/umd/es2018/types/adapterRoundtrip.d.ts

@@ -1,33 +1,33 @@
-import type { AdapterFactory, NetworkAdapter } from '@luvio/engine';
+import type { AdapterFactory, NetworkAdapter, Snapshot } from '@luvio/engine';
 import { Luvio } from '@luvio/engine';
 import type { MockPayload } from './network';
 export declare function buildLuvioInstance(mockNetworkAdapter: NetworkAdapter): Luvio;
-declare type AdapterRoundtripTestParams<C, D> = AdapterNetworkRoundtripTestParams<C, D> | AdapterNetworkRoundtripWithLuvioTestParams<C, D> | AdapterCacheHitRoundtripTestParams<C, D>;
-declare type AdapterTest<C, D> = {
+type AdapterRoundtripTestParams<C, D> = AdapterNetworkRoundtripTestParams<C, D> | AdapterNetworkRoundtripWithLuvioTestParams<C, D> | AdapterCacheHitRoundtripTestParams<C, D>;
+type AdapterTest<C, D> = {
     adapterFactory: AdapterFactory<C, D>;
     adapterConfig: C;
     privateProperties?: string[];
 };
-declare type AdapterTestWithInjectedLuvio<C, D> = AdapterTest<C, D> & {
+type AdapterTestWithInjectedLuvio<C, D> = AdapterTest<C, D> & {
     luvio: Luvio;
     expectedData: D;
 };
-declare type NetworkConfig = {
+type NetworkConfig = {
     request: MockPayload['networkArgs'];
     response: any;
 };
-declare type AdapterNetworkRoundtripTestParams<C, D> = AdapterTest<C, D> & {
+type AdapterNetworkRoundtripTestParams<C, D> = AdapterTest<C, D> & {
     type: 'network';
     network: NetworkConfig;
     expectedData?: D;
 };
-declare type AdapterNetworkRoundtripWithLuvioTestParams<C, D> = AdapterTestWithInjectedLuvio<C, D> & {
+type AdapterNetworkRoundtripWithLuvioTestParams<C, D> = AdapterTestWithInjectedLuvio<C, D> & {
     type: 'injectedLuvioNetwork';
 };
-declare type AdapterCacheHitRoundtripTestParams<C, D> = AdapterTestWithInjectedLuvio<C, D> & {
+type AdapterCacheHitRoundtripTestParams<C, D> = AdapterTestWithInjectedLuvio<C, D> & {
     type: 'cache';
 };
-export declare function testAdapterCompletesRoundtrip<C = any, D = any>(params: AdapterRoundtripTestParams<C, D>): Promise<void>;
+export declare function testAdapterCompletesRoundtrip<C = any, D = any>(params: AdapterRoundtripTestParams<C, D>): Promise<Snapshot<D, unknown>>;
 export declare function buildLuvioWithNetwork(networkConfig: NetworkConfig): {
     luvio: Luvio;
     networkAdapter: NetworkAdapter;

package/dist/umd/es2018/types/network.d.ts

@@ -31,7 +31,7 @@ export declare function setMockNetworkPayloads(mockNetworkAdapter: NetworkAdapte
  * until resetMockNetworkAdapter is called.
  */
 export declare function overrideMockNetworkResponses(mockNetworkAdapter: NetworkAdapter, responses: FetchResponse<any>[]): void;
-export declare function resetMockNetworkAdapter(mockNetworkAdapter: NetworkAdapter): void;
+export declare function resetMockNetworkAdapter(mockNetworkAdapter: NetworkAdapter, newPayloads?: MockPayload[]): void;
 export declare function getMockNetworkAdapterCallCount(mockNetworkAdapter: NetworkAdapter): number | undefined;
 export declare function buildFetchResponse<T>(body: T, status?: number, statusText?: string, headers?: Headers): FetchResponse<T>;
 export declare function buildSuccessMockPayload(networkArgs: Partial<ResourceRequest>, body: any, headers?: Headers): MockPayload;

package/dist/umd/es2018/types/utils.d.ts

@@ -21,14 +21,14 @@ export declare function stripProperties(obj: {
 }, props: string[]): any;
 export declare function doesThrow(predicate: () => void): boolean;
 export declare function flushPromises(): Promise<unknown>;
-declare type MatcherResult = {
+type MatcherResult = {
     pass: boolean;
     message: () => string;
 };
 export declare const customMatchers: {
-    toEqualFulfilledSnapshotWithData: (snapshot: Snapshot<unknown, unknown>, expected: any, privateProperties?: string[] | undefined) => MatcherResult;
-    toEqualStaleSnapshotWithData: (snapshot: Snapshot<unknown, unknown>, expected: any, privateProperties?: string[] | undefined) => MatcherResult;
-    toEqualErrorSnapshot: (actual: Snapshot<unknown, unknown>, expectedStatus?: number | undefined) => MatcherResult;
+    toEqualFulfilledSnapshotWithData: (snapshot: Snapshot<unknown, unknown>, expected: any, privateProperties?: string[]) => MatcherResult;
+    toEqualStaleSnapshotWithData: (snapshot: Snapshot<unknown, unknown>, expected: any, privateProperties?: string[]) => MatcherResult;
+    toEqualErrorSnapshot: (actual: Snapshot<unknown, unknown>, expectedStatus?: number) => MatcherResult;
     toEqualOfflineErrorSnapshot: (actual: Snapshot<unknown, unknown>) => MatcherResult;
     toHaveBeenHitTimes: (mockNetworkAdapter: NetworkAdapter, expected: Number) => MatcherResult;
     toHaveBeenHitOnce: (mockNetworkAdapter: NetworkAdapter) => MatcherResult;

package/dist/umd/es5/test-library.js

@@ -404,14 +404,15 @@
             return onNetworkStubCalled(stub, response);
         });
     }
-    function resetMockNetworkAdapter(mockNetworkAdapter) {
+    function resetMockNetworkAdapter(mockNetworkAdapter, newPayloads) {
         var stub = mockNetworkAdapter;
         // reset stub in case a test modified payload responses
         stub.reset();
         // reset call count
         callCountMap.set(stub, 0);
-        // set original mock payloads up
-        var payloads = mockPayloadsMap.get(stub);
+        // set mock payloads up - Allow for the test to provide a different set of payloads
+        // Default behavior is to reset to the original payloads.
+        var payloads = newPayloads ? newPayloads : mockPayloadsMap.get(stub);
         if (payloads) {
             setMockNetworkPayloads(stub, payloads);
         }
@@ -751,7 +752,7 @@
                         expect(result).toEqualFulfilledSnapshotWithData(params.type === 'network'
                             ? params.expectedData || params.network.response
                             : params.expectedData, params.privateProperties);
-                        return [2 /*return*/];
+                        return [2 /*return*/, result];
                 }
             });
         });

package/dist/umd/es5/types/adapterRoundtrip.d.ts

@@ -1,33 +1,33 @@
-import type { AdapterFactory, NetworkAdapter } from '@luvio/engine';
+import type { AdapterFactory, NetworkAdapter, Snapshot } from '@luvio/engine';
 import { Luvio } from '@luvio/engine';
 import type { MockPayload } from './network';
 export declare function buildLuvioInstance(mockNetworkAdapter: NetworkAdapter): Luvio;
-declare type AdapterRoundtripTestParams<C, D> = AdapterNetworkRoundtripTestParams<C, D> | AdapterNetworkRoundtripWithLuvioTestParams<C, D> | AdapterCacheHitRoundtripTestParams<C, D>;
-declare type AdapterTest<C, D> = {
+type AdapterRoundtripTestParams<C, D> = AdapterNetworkRoundtripTestParams<C, D> | AdapterNetworkRoundtripWithLuvioTestParams<C, D> | AdapterCacheHitRoundtripTestParams<C, D>;
+type AdapterTest<C, D> = {
     adapterFactory: AdapterFactory<C, D>;
     adapterConfig: C;
     privateProperties?: string[];
 };
-declare type AdapterTestWithInjectedLuvio<C, D> = AdapterTest<C, D> & {
+type AdapterTestWithInjectedLuvio<C, D> = AdapterTest<C, D> & {
     luvio: Luvio;
     expectedData: D;
 };
-declare type NetworkConfig = {
+type NetworkConfig = {
     request: MockPayload['networkArgs'];
     response: any;
 };
-declare type AdapterNetworkRoundtripTestParams<C, D> = AdapterTest<C, D> & {
+type AdapterNetworkRoundtripTestParams<C, D> = AdapterTest<C, D> & {
     type: 'network';
     network: NetworkConfig;
     expectedData?: D;
 };
-declare type AdapterNetworkRoundtripWithLuvioTestParams<C, D> = AdapterTestWithInjectedLuvio<C, D> & {
+type AdapterNetworkRoundtripWithLuvioTestParams<C, D> = AdapterTestWithInjectedLuvio<C, D> & {
     type: 'injectedLuvioNetwork';
 };
-declare type AdapterCacheHitRoundtripTestParams<C, D> = AdapterTestWithInjectedLuvio<C, D> & {
+type AdapterCacheHitRoundtripTestParams<C, D> = AdapterTestWithInjectedLuvio<C, D> & {
     type: 'cache';
 };
-export declare function testAdapterCompletesRoundtrip<C = any, D = any>(params: AdapterRoundtripTestParams<C, D>): Promise<void>;
+export declare function testAdapterCompletesRoundtrip<C = any, D = any>(params: AdapterRoundtripTestParams<C, D>): Promise<Snapshot<D, unknown>>;
 export declare function buildLuvioWithNetwork(networkConfig: NetworkConfig): {
     luvio: Luvio;
     networkAdapter: NetworkAdapter;

package/dist/umd/es5/types/network.d.ts

@@ -31,7 +31,7 @@ export declare function setMockNetworkPayloads(mockNetworkAdapter: NetworkAdapte
  * until resetMockNetworkAdapter is called.
  */
 export declare function overrideMockNetworkResponses(mockNetworkAdapter: NetworkAdapter, responses: FetchResponse<any>[]): void;
-export declare function resetMockNetworkAdapter(mockNetworkAdapter: NetworkAdapter): void;
+export declare function resetMockNetworkAdapter(mockNetworkAdapter: NetworkAdapter, newPayloads?: MockPayload[]): void;
 export declare function getMockNetworkAdapterCallCount(mockNetworkAdapter: NetworkAdapter): number | undefined;
 export declare function buildFetchResponse<T>(body: T, status?: number, statusText?: string, headers?: Headers): FetchResponse<T>;
 export declare function buildSuccessMockPayload(networkArgs: Partial<ResourceRequest>, body: any, headers?: Headers): MockPayload;

package/dist/umd/es5/types/utils.d.ts

@@ -21,14 +21,14 @@ export declare function stripProperties(obj: {
 }, props: string[]): any;
 export declare function doesThrow(predicate: () => void): boolean;
 export declare function flushPromises(): Promise<unknown>;
-declare type MatcherResult = {
+type MatcherResult = {
     pass: boolean;
     message: () => string;
 };
 export declare const customMatchers: {
-    toEqualFulfilledSnapshotWithData: (snapshot: Snapshot<unknown, unknown>, expected: any, privateProperties?: string[] | undefined) => MatcherResult;
-    toEqualStaleSnapshotWithData: (snapshot: Snapshot<unknown, unknown>, expected: any, privateProperties?: string[] | undefined) => MatcherResult;
-    toEqualErrorSnapshot: (actual: Snapshot<unknown, unknown>, expectedStatus?: number | undefined) => MatcherResult;
+    toEqualFulfilledSnapshotWithData: (snapshot: Snapshot<unknown, unknown>, expected: any, privateProperties?: string[]) => MatcherResult;
+    toEqualStaleSnapshotWithData: (snapshot: Snapshot<unknown, unknown>, expected: any, privateProperties?: string[]) => MatcherResult;
+    toEqualErrorSnapshot: (actual: Snapshot<unknown, unknown>, expectedStatus?: number) => MatcherResult;
     toEqualOfflineErrorSnapshot: (actual: Snapshot<unknown, unknown>) => MatcherResult;
     toHaveBeenHitTimes: (mockNetworkAdapter: NetworkAdapter, expected: Number) => MatcherResult;
     toHaveBeenHitOnce: (mockNetworkAdapter: NetworkAdapter) => MatcherResult;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@luvio/adapter-test-library",
-    "version": "0.138.2",
+    "version": "0.138.4",
     "description": "Test library for luvio adapters",
     "repository": {
         "type": "git",
@@ -21,8 +21,8 @@
         "sinon": "^14.0.0"
     },
     "devDependencies": {
-        "@luvio/engine": "^0.138.2",
-        "@luvio/environments": "^0.138.2",
+        "@luvio/engine": "^0.138.4",
+        "@luvio/environments": "^0.138.4",
         "@types/sinon": "^7.5.2"
     },
     "volta": {

package/src/adapterRoundtrip.ts

@@ -47,7 +47,7 @@ type AdapterCacheHitRoundtripTestParams<C, D> = AdapterTestWithInjectedLuvio<C,
 
 export async function testAdapterCompletesRoundtrip<C = any, D = any>(
     params: AdapterRoundtripTestParams<C, D>
-): Promise<void> {
+): Promise<Snapshot<D, unknown>> {
     const adapterSetup = setupAdapter<C, D>(params);
     const result = await callAdapter(adapterSetup, params);
 
@@ -58,6 +58,7 @@ export async function testAdapterCompletesRoundtrip<C = any, D = any>(
             : params.expectedData,
         params.privateProperties
     );
+    return result;
 }
 
 function setupAdapter<C = any, D = any>(params: AdapterRoundtripTestParams<C, D>): Adapter<C, D> {

package/src/network.ts

@@ -171,7 +171,10 @@ export function overrideMockNetworkResponses(
     });
 }
 
-export function resetMockNetworkAdapter(mockNetworkAdapter: NetworkAdapter): void {
+export function resetMockNetworkAdapter(
+    mockNetworkAdapter: NetworkAdapter,
+    newPayloads?: MockPayload[]
+): void {
     const stub = mockNetworkAdapter as sinon.SinonStub;
 
     // reset stub in case a test modified payload responses
@@ -180,8 +183,9 @@ export function resetMockNetworkAdapter(mockNetworkAdapter: NetworkAdapter): voi
     // reset call count
     callCountMap.set(stub, 0);
 
-    // set original mock payloads up
-    const payloads = mockPayloadsMap.get(stub);
+    // set mock payloads up - Allow for the test to provide a different set of payloads
+    // Default behavior is to reset to the original payloads.
+    const payloads = newPayloads ? newPayloads : mockPayloadsMap.get(stub);
     if (payloads) {
         setMockNetworkPayloads(stub, payloads);
     }