@trackunit/react-core-contexts-test 0.1.112 → 0.1.114

package/index.cjs2.js

@@ -43995,8 +43995,22 @@ const trackunitProviders = () => new TrackunitProvidersMockBuilder();
  * 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.
+ * @returns {MockedResponse} with data attached, this response 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/)
+ * @example
+ *  it("should show the brand fetched from graphql", async () => {
+ *   const mock = queryFor(GetDemoAssetDocument, {
+ *    assetId: "assetId",
+ *   });
+ *
+ *   AssetRuntime.getAssetInfo = jest.fn().mockResolvedValue({ assetId: "assetId" });
+ *   await trackunitProviders()
+ *     .apollo([mock])
+ *     .render(<App />);
+ *
+ *   # mock.data is the combined result of what is passed in from queryFor and what is generated by generateMockData
+ *   expect(screen.getByText(`Brand: ${mock.data.asset?.brand}`)).toBeInTheDocument();
+ * });
  */
 const queryFor = (document, variables, data, error) => {
     return {
@@ -44004,6 +44018,7 @@ const queryFor = (document, variables, data, error) => {
             query: document,
             variables,
         },
+        data,
         newData: () => {
             if (process.env.VSCODE_INSPECTOR_OPTIONS || process.env.DEBUG) {
                 // eslint-disable-next-line @typescript-eslint/no-explicit-any

package/index.esm2.js

@@ -43967,8 +43967,22 @@ const trackunitProviders = () => new TrackunitProvidersMockBuilder();
  * 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.
+ * @returns {MockedResponse} with data attached, this response 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/)
+ * @example
+ *  it("should show the brand fetched from graphql", async () => {
+ *   const mock = queryFor(GetDemoAssetDocument, {
+ *    assetId: "assetId",
+ *   });
+ *
+ *   AssetRuntime.getAssetInfo = jest.fn().mockResolvedValue({ assetId: "assetId" });
+ *   await trackunitProviders()
+ *     .apollo([mock])
+ *     .render(<App />);
+ *
+ *   # mock.data is the combined result of what is passed in from queryFor and what is generated by generateMockData
+ *   expect(screen.getByText(`Brand: ${mock.data.asset?.brand}`)).toBeInTheDocument();
+ * });
  */
 const queryFor = (document, variables, data, error) => {
     return {
@@ -43976,6 +43990,7 @@ const queryFor = (document, variables, data, error) => {
             query: document,
             variables,
         },
+        data,
         newData: () => {
             if (process.env.VSCODE_INSPECTOR_OPTIONS || process.env.DEBUG) {
                 // eslint-disable-next-line @typescript-eslint/no-explicit-any

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-core-contexts-test",
-  "version": "0.1.112",
+  "version": "0.1.114",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
@@ -10,8 +10,8 @@
   "main": "./index.cjs.js",
   "dependencies": {
     "@apollo/client": "3.7.10",
-    "@trackunit/react-core-contexts-api": "0.2.59",
-    "@trackunit/react-core-hooks": "0.2.98",
+    "@trackunit/react-core-contexts-api": "0.2.60",
+    "@trackunit/react-core-hooks": "0.2.99",
     "graphql": "15.8.0",
     "lodash": "4.17.21",
     "react": "18.2.0",

package/src/utils/queryFor.d.ts

@@ -1,6 +1,9 @@
-import { ApolloError, OperationVariables, QueryHookOptions, useLazyQuery, useQuery } from "@apollo/client";
+import { ApolloError, OperationVariables, QueryHookOptions, TypedDocumentNode, useLazyQuery, useQuery } from "@apollo/client";
 import { MockedResponse } from "@apollo/client/testing";
-import { DocumentNode } from "graphql";
+export type DeepPartialNullable<T> = T extends any[] ? DeepPartialNullableArray<T[number]> : T extends object ? {
+    [P in keyof T]?: DeepPartialNullable<T[P]> | null;
+} : T | null;
+type DeepPartialNullableArray<T> = DeepPartialNullable<T>[];
 /**
  *
  * @param document Document that represents the specific GQL query / mutation schema.
@@ -10,10 +13,26 @@ import { DocumentNode } from "graphql";
  * 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.
+ * @returns {MockedResponse} with data attached, this response 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/)
+ * @example
+ *  it("should show the brand fetched from graphql", async () => {
+ *   const mock = queryFor(GetDemoAssetDocument, {
+ *    assetId: "assetId",
+ *   });
+ *
+ *   AssetRuntime.getAssetInfo = jest.fn().mockResolvedValue({ assetId: "assetId" });
+ *   await trackunitProviders()
+ *     .apollo([mock])
+ *     .render(<App />);
+ *
+ *   # mock.data is the combined result of what is passed in from queryFor and what is generated by generateMockData
+ *   expect(screen.getByText(`Brand: ${mock.data.asset?.brand}`)).toBeInTheDocument();
+ * });
  */
-export declare const queryFor: <TData, TVariables extends OperationVariables = OperationVariables>(document: DocumentNode, variables: TVariables, data: TData | null, error?: ApolloError | Error) => MockedResponse;
+export declare const queryFor: <TData, TVariables extends OperationVariables = OperationVariables>(document: TypedDocumentNode<TData, TVariables>, variables: TVariables, data?: TData | null | undefined, error?: ApolloError | Error) => MockedResponse<TData, Record<string, any>> & {
+    data: NonNullable<TData>;
+};
 type QueryReturn<TData, TVariables extends OperationVariables = OperationVariables> = ReturnType<typeof useQuery<TData, TVariables>>;
 type QueryLazyReturn<TData, TVariables extends OperationVariables = OperationVariables> = ReturnType<typeof useLazyQuery<TData, TVariables>>;
 /**
@@ -28,5 +47,5 @@ type QueryLazyReturn<TData, TVariables extends OperationVariables = OperationVar
  * @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 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: TypedDocumentNode<TData, TVariables>, variables: TVariables, data: TData | null, error?: ApolloError | Error) => MockedResponse;
 export {};