@trackunit/react-core-contexts-test 0.1.78 → 0.1.80

package/index.cjs

@@ -29,6 +29,7 @@ exports.mockOemBrandingContext = index.mockOemBrandingContext;
 exports.mockToastContext = index.mockToastContext;
 exports.mockUserSubscriptionContext = index.mockUserSubscriptionContext;
 exports.queryFor = index.queryFor;
+exports.queryForHook = index.queryForHook;
 exports.trackunitProviders = index.trackunitProviders;
 exports.useDebugger = index.useDebugger;
 exports.validateIrisApp = index.validateIrisApp;

package/index.js

@@ -1,4 +1,4 @@
-export { D as Debugger, T as TrackunitProvidersMockBuilder, l as doNothing, f as flushPromises, n as flushPromisesInAct, m as mockAnalyticsContext, b as mockAssetSortingContext, e as mockCurrentUserContext, h as mockEnvironmentContext, i as mockOemBrandingContext, j as mockToastContext, k as mockUserSubscriptionContext, q as queryFor, t as trackunitProviders, u as useDebugger, v as validateIrisApp } from './index2.js';
+export { D as Debugger, T as TrackunitProvidersMockBuilder, l as doNothing, f as flushPromises, o as flushPromisesInAct, m as mockAnalyticsContext, b as mockAssetSortingContext, e as mockCurrentUserContext, h as mockEnvironmentContext, i as mockOemBrandingContext, j as mockToastContext, k as mockUserSubscriptionContext, q as queryFor, n as queryForHook, t as trackunitProviders, u as useDebugger, v as validateIrisApp } from './index2.js';
 import 'react/jsx-runtime';
 import 'react';
 import '@trackunit/react-core-contexts-api';

package/index2.cjs

@@ -43450,25 +43450,26 @@ const defaultOptions = {
         errorPolicy: "all",
     },
 };
+const isDebugging = !!process.env.VSCODE_INSPECTOR_OPTIONS || !!process.env.DEBUG;
 /**
  * This is a wrapper around the MockedProvider that logs errors to the console.
  */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 function ApolloMockedProviderWithError(props) {
     const { mocks } = props, otherProps = __rest(props, ["mocks"]);
-    const mockLink = new MockLink(mocks);
+    const mockLink = new MockLink(mocks, false, { showWarnings: isDebugging });
     const errorLoggingLink = onError(({ graphQLErrors, networkError }) => {
         if (graphQLErrors) {
             // eslint-disable-next-line array-callback-return
             graphQLErrors.map(({ message, locations, path }) => {
-                if (process.env.VSCODE_INSPECTOR_OPTIONS || process.env.DEBUG) {
+                if (isDebugging) {
                     // eslint-disable-next-line no-console
                     console.log(`[GraphQL error]: Message: ${message}, Location: ${locations}, Path: ${path}`);
                 }
             });
         }
         if (networkError) {
-            if (process.env.VSCODE_INSPECTOR_OPTIONS || process.env.DEBUG) {
+            if (isDebugging) {
                 // eslint-disable-next-line no-console
                 console.log(`[Network error]: ${networkError}`);
             }
@@ -43962,6 +43963,47 @@ const queryFor = (document, variables, data, error) => {
         },
     };
 };
+/**
+ *
+ * @param document Document that represents the specific GQL query / mutation schema.
+ * @param variables Variables that should be passed to the query / mutation.
+ * Note that an *exact* match between the mock and operation is necessary.
+ * @param data Data object to be returned.
+ * Note that *all* properties should be given a value, use `null` in place of `undefined`,
+ * otherwise nothing will be returned.
+ * @param error ApolloError object to be returned.
+ * @returns {MockedResponse} that can be passed to the mocked ApolloProvider.
+ * @see [Testing React components using MockedProvider and associated APIs](https://www.apollographql.com/docs/react/development-testing/testing/)
+ */
+const queryForHook = (hookFn, document, variables, data, error) => {
+    return {
+        request: {
+            query: document,
+            variables,
+        },
+        newData: () => {
+            if (process.env.VSCODE_INSPECTOR_OPTIONS || process.env.DEBUG) {
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                const name = document.definitions[0].name.value;
+                // eslint-disable-next-line no-console
+                console.log("Found Response for: " +
+                    name +
+                    " for variables: " +
+                    JSON.stringify(variables, null, 2) +
+                    " Returning: " +
+                    "{ data: " +
+                    JSON.stringify(data, null, 2) +
+                    ", error: " +
+                    JSON.stringify(error, null, 2) +
+                    "}");
+            }
+            return {
+                data,
+                errors: error ? [new GraphQLError(error.message)] : undefined,
+            };
+        },
+    };
+};
 
 /**
  * This helps validate the IrisApp is exposed correctly it must expose:
@@ -44018,6 +44060,7 @@ exports.mockOemBrandingContext = mockOemBrandingContext;
 exports.mockToastContext = mockToastContext;
 exports.mockUserSubscriptionContext = mockUserSubscriptionContext;
 exports.queryFor = queryFor;
+exports.queryForHook = queryForHook;
 exports.trackunitProviders = trackunitProviders;
 exports.useDebugger = useDebugger;
 exports.validateIrisApp = validateIrisApp;

package/index2.js

@@ -43422,25 +43422,26 @@ const defaultOptions = {
         errorPolicy: "all",
     },
 };
+const isDebugging = !!process.env.VSCODE_INSPECTOR_OPTIONS || !!process.env.DEBUG;
 /**
  * This is a wrapper around the MockedProvider that logs errors to the console.
  */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 function ApolloMockedProviderWithError(props) {
     const { mocks } = props, otherProps = __rest(props, ["mocks"]);
-    const mockLink = new MockLink(mocks);
+    const mockLink = new MockLink(mocks, false, { showWarnings: isDebugging });
     const errorLoggingLink = onError(({ graphQLErrors, networkError }) => {
         if (graphQLErrors) {
             // eslint-disable-next-line array-callback-return
             graphQLErrors.map(({ message, locations, path }) => {
-                if (process.env.VSCODE_INSPECTOR_OPTIONS || process.env.DEBUG) {
+                if (isDebugging) {
                     // eslint-disable-next-line no-console
                     console.log(`[GraphQL error]: Message: ${message}, Location: ${locations}, Path: ${path}`);
                 }
             });
         }
         if (networkError) {
-            if (process.env.VSCODE_INSPECTOR_OPTIONS || process.env.DEBUG) {
+            if (isDebugging) {
                 // eslint-disable-next-line no-console
                 console.log(`[Network error]: ${networkError}`);
             }
@@ -43934,6 +43935,47 @@ const queryFor = (document, variables, data, error) => {
         },
     };
 };
+/**
+ *
+ * @param document Document that represents the specific GQL query / mutation schema.
+ * @param variables Variables that should be passed to the query / mutation.
+ * Note that an *exact* match between the mock and operation is necessary.
+ * @param data Data object to be returned.
+ * Note that *all* properties should be given a value, use `null` in place of `undefined`,
+ * otherwise nothing will be returned.
+ * @param error ApolloError object to be returned.
+ * @returns {MockedResponse} that can be passed to the mocked ApolloProvider.
+ * @see [Testing React components using MockedProvider and associated APIs](https://www.apollographql.com/docs/react/development-testing/testing/)
+ */
+const queryForHook = (hookFn, document, variables, data, error) => {
+    return {
+        request: {
+            query: document,
+            variables,
+        },
+        newData: () => {
+            if (process.env.VSCODE_INSPECTOR_OPTIONS || process.env.DEBUG) {
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                const name = document.definitions[0].name.value;
+                // eslint-disable-next-line no-console
+                console.log("Found Response for: " +
+                    name +
+                    " for variables: " +
+                    JSON.stringify(variables, null, 2) +
+                    " Returning: " +
+                    "{ data: " +
+                    JSON.stringify(data, null, 2) +
+                    ", error: " +
+                    JSON.stringify(error, null, 2) +
+                    "}");
+            }
+            return {
+                data,
+                errors: error ? [new GraphQLError(error.message)] : undefined,
+            };
+        },
+    };
+};
 
 /**
  * This helps validate the IrisApp is exposed correctly it must expose:
@@ -43972,4 +44014,4 @@ const validateIrisApp = (irisApp) => __awaiter(void 0, void 0, void 0, function*
     return null;
 });
 
-export { Debugger as D, TrackunitProvidersMockBuilder as T, __awaiter as _, act as a, mockAssetSortingContext as b, commonjsGlobal as c, dom_esm as d, mockCurrentUserContext as e, flushPromises as f, getAugmentedNamespace as g, mockEnvironmentContext as h, mockOemBrandingContext as i, mockToastContext as j, mockUserSubscriptionContext as k, doNothing as l, mockAnalyticsContext as m, flushPromisesInAct as n, queryFor as q, trackunitProviders as t, useDebugger as u, validateIrisApp as v };
+export { Debugger as D, TrackunitProvidersMockBuilder as T, __awaiter as _, act as a, mockAssetSortingContext as b, commonjsGlobal as c, dom_esm as d, mockCurrentUserContext as e, flushPromises as f, getAugmentedNamespace as g, mockEnvironmentContext as h, mockOemBrandingContext as i, mockToastContext as j, mockUserSubscriptionContext as k, doNothing as l, mockAnalyticsContext as m, queryForHook as n, flushPromisesInAct as o, queryFor as q, trackunitProviders as t, useDebugger as u, validateIrisApp as v };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-core-contexts-test",
-  "version": "0.1.78",
+  "version": "0.1.80",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
@@ -12,8 +12,8 @@
   "types": "./src/index.d.ts",
   "dependencies": {
     "@apollo/client": "3.7.10",
-    "@trackunit/react-core-contexts-api": "0.2.42",
-    "@trackunit/react-core-hooks": "0.2.66",
+    "@trackunit/react-core-contexts-api": "0.2.44",
+    "@trackunit/react-core-hooks": "0.2.68",
     "@trackunit/tailwind-styled-components": "0.0.58",
     "graphql": "15.8.0",
     "lodash": "4.17.21",

package/src/utils/queryFor.d.ts

@@ -1,4 +1,4 @@
-import { ApolloError } from "@apollo/client";
+import { ApolloError, OperationVariables, QueryHookOptions, useLazyQuery, useQuery } from "@apollo/client";
 import { MockedResponse } from "@apollo/client/testing";
 import { DocumentNode } from "graphql";
 /**
@@ -13,6 +13,20 @@ import { DocumentNode } from "graphql";
  * @returns {MockedResponse} that can be passed to the mocked ApolloProvider.
  * @see [Testing React components using MockedProvider and associated APIs](https://www.apollographql.com/docs/react/development-testing/testing/)
  */
-export declare const queryFor: <Result extends {
-    __typename?: unknown;
-}, Variables>(document: DocumentNode, variables: Variables, data: Result | null, error?: ApolloError | Error) => MockedResponse;
+export declare const queryFor: <TData, TVariables extends OperationVariables = OperationVariables>(document: DocumentNode, variables: TVariables, data: TData | null, error?: ApolloError | Error) => MockedResponse;
+type QueryReturn<TData, TVariables extends OperationVariables = OperationVariables> = ReturnType<typeof useQuery<TData, TVariables>>;
+type QueryLazyReturn<TData, TVariables extends OperationVariables = OperationVariables> = ReturnType<typeof useLazyQuery<TData, TVariables>>;
+/**
+ *
+ * @param document Document that represents the specific GQL query / mutation schema.
+ * @param variables Variables that should be passed to the query / mutation.
+ * Note that an *exact* match between the mock and operation is necessary.
+ * @param data Data object to be returned.
+ * Note that *all* properties should be given a value, use `null` in place of `undefined`,
+ * otherwise nothing will be returned.
+ * @param error ApolloError object to be returned.
+ * @returns {MockedResponse} that can be passed to the mocked ApolloProvider.
+ * @see [Testing React components using MockedProvider and associated APIs](https://www.apollographql.com/docs/react/development-testing/testing/)
+ */
+export declare const queryForHook: <TData, TVariables extends OperationVariables = OperationVariables>(hookFn: (baseOptions: QueryHookOptions<TData, TVariables>) => import("@apollo/client").QueryResult<TData, TVariables> | import("@apollo/client").LazyQueryResultTuple<TData, TVariables>, document: DocumentNode, variables: TVariables, data: TData | null, error?: ApolloError | Error) => MockedResponse;
+export {};