@jobber/hooks 2.0.3-pre1.55 → 2.0.3-pre2.52

package/dist/index.d.ts

@@ -1,7 +1,10 @@
-export * from "./useAssert/index.js";
-export * from "./useFocusTrap/index.js";
-export * from "./useFormState/index.js";
-export * from "./useIsMounted/index.js";
-export * from "./useLiveAnnounce/index.js";
-export * from "./usePasswordStrength/index.js";
-export * from "./useRefocusOnActivator/index.js";
+export * from "./useAssert";
+export * from "./useCollectionQuery";
+export * from "./useFocusTrap";
+export * from "./useFormState";
+export * from "./useIsMounted";
+export * from "./useLiveAnnounce";
+export * from "./useOnKeyDown";
+export * from "./usePasswordStrength";
+export * from "./useRefocusOnActivator";
+export * from "./useResizeObserver";

package/dist/index.js

@@ -14,11 +14,13 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-/* eslint-disable import/no-internal-modules */
-__exportStar(require("./useAssert/index.js"), exports);
-__exportStar(require("./useFocusTrap/index.js"), exports);
-__exportStar(require("./useFormState/index.js"), exports);
-__exportStar(require("./useIsMounted/index.js"), exports);
-__exportStar(require("./useLiveAnnounce/index.js"), exports);
-__exportStar(require("./usePasswordStrength/index.js"), exports);
-__exportStar(require("./useRefocusOnActivator/index.js"), exports);
+__exportStar(require("./useAssert"), exports);
+__exportStar(require("./useCollectionQuery"), exports);
+__exportStar(require("./useFocusTrap"), exports);
+__exportStar(require("./useFormState"), exports);
+__exportStar(require("./useIsMounted"), exports);
+__exportStar(require("./useLiveAnnounce"), exports);
+__exportStar(require("./useOnKeyDown"), exports);
+__exportStar(require("./usePasswordStrength"), exports);
+__exportStar(require("./useRefocusOnActivator"), exports);
+__exportStar(require("./useResizeObserver"), exports);

package/dist/useAssert/index.d.ts

@@ -1 +1 @@
-export { useAssert } from "./useAssert.js";
+export { useAssert } from "./useAssert";

package/dist/useAssert/index.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.useAssert = void 0;
-var useAssert_js_1 = require("./useAssert.js");
-Object.defineProperty(exports, "useAssert", { enumerable: true, get: function () { return useAssert_js_1.useAssert; } });
+var useAssert_1 = require("./useAssert");
+Object.defineProperty(exports, "useAssert", { enumerable: true, get: function () { return useAssert_1.useAssert; } });

package/dist/useCollectionQuery/index.d.ts

@@ -0,0 +1 @@
+export { useCollectionQuery } from "./useCollectionQuery";

package/dist/useCollectionQuery/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useCollectionQuery = void 0;
+var useCollectionQuery_1 = require("./useCollectionQuery");
+Object.defineProperty(exports, "useCollectionQuery", { enumerable: true, get: function () { return useCollectionQuery_1.useCollectionQuery; } });

package/dist/useCollectionQuery/mdxUtils.d.ts

@@ -0,0 +1,53 @@
+import { ApolloClient } from "@apollo/client";
+export interface ListQueryType {
+    allPlanets: {
+        __typename?: "PlanetsConnection";
+        pageInfo: {
+            hasNextPage: boolean;
+            endCursor: string;
+        };
+        edges: Array<{
+            __typename?: "PlanetsEdge";
+            node: {
+                __typename?: "Planet";
+                name: "string";
+                id: "string";
+            };
+            cursor: string;
+        }>;
+        totalCount?: number;
+    };
+}
+export declare const LIST_QUERY: import("@apollo/client").DocumentNode;
+export declare const apolloClient: ApolloClient<import("@apollo/client").NormalizedCacheObject>;
+interface LoadingState {
+    loadingStatus: string;
+    loading: boolean;
+}
+export declare function getLoadingState(loadingInitialContent: boolean, loadingRefresh: boolean, loadingNextPage: boolean): LoadingState;
+export declare const propsList: ({
+    id: number;
+    title: string;
+    caption: string;
+    value: string;
+    url?: undefined;
+} | {
+    id: number;
+    title: string;
+    caption: string;
+    url: string;
+    value: string;
+})[];
+export declare const subscriptionPropsList: {
+    id: number;
+    title: string;
+    caption: string;
+    value: string;
+}[];
+export declare const returnValues: {
+    id: number;
+    title: string;
+    caption: string;
+    value: string;
+}[];
+export {};

package/dist/useCollectionQuery/mdxUtils.js

@@ -0,0 +1,152 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.returnValues = exports.subscriptionPropsList = exports.propsList = exports.getLoadingState = exports.apolloClient = exports.LIST_QUERY = void 0;
+const client_1 = require("@apollo/client");
+exports.LIST_QUERY = (0, client_1.gql) `
+  query ListQuery($cursor: String) {
+    allPlanets(first: 4, after: $cursor) {
+      pageInfo {
+        hasNextPage
+        endCursor
+      }
+      edges {
+        node {
+          name
+          id
+        }
+        cursor
+      }
+    }
+  }
+`;
+exports.apolloClient = new client_1.ApolloClient({
+    uri: "https://swapi-graphql.netlify.app/.netlify/functions/index",
+    cache: new client_1.InMemoryCache(),
+});
+function getLoadingState(loadingInitialContent, loadingRefresh, loadingNextPage) {
+    if (loadingInitialContent) {
+        return {
+            loading: true,
+            loadingStatus: "Initial Loading",
+        };
+    }
+    if (loadingRefresh) {
+        return {
+            loading: true,
+            loadingStatus: "Refreshing",
+        };
+    }
+    if (loadingNextPage) {
+        return {
+            loading: true,
+            loadingStatus: "Fetching More",
+        };
+    }
+    return {
+        loading: false,
+        loadingStatus: "Loaded",
+    };
+}
+exports.getLoadingState = getLoadingState;
+exports.propsList = [
+    {
+        id: 0,
+        title: "query",
+        caption: "The graphQL query that fetches the collection",
+        value: "DocumentNode",
+    },
+    {
+        id: 1,
+        title: "queryOptions",
+        caption: "A list of options for us to pass into the apollo `useQuery` hook. \
+       Click to see more query options!",
+        url: "https://www.apollographql.com/docs/react/data/queries/#options",
+        value: "QueryHookOptions",
+    },
+    {
+        id: 2,
+        title: "getCollectionByPath",
+        caption: "A function that returns the location where the \
+      {@link Collection} is located. The collection is the part of the \
+      result that needs to be paginated.",
+        value: "GetCollectionByPathFunction<TQuery>",
+    },
+    {
+        id: 3,
+        title: "subscription (optional)",
+        caption: "A list of subscription options if \
+      you want to create a GraphQL subscription to listen for more content.",
+        value: "SubscriptionProps",
+    },
+];
+exports.subscriptionPropsList = [
+    {
+        id: 0,
+        title: "document",
+        caption: "The graphQL subscription that listens for more data. This query \
+      should return a single Node that matches the data structure in \
+      getCollectionByPath<TQuery>(...).edges.node and \
+      getCollectionByPath<TQuery>(...).nodes",
+        value: "DocumentNode",
+    },
+    {
+        id: 1,
+        title: "options",
+        caption: " A list of variables to pass into the apollo `subscribeToMore` function.",
+        value: "SubscribeToMoreOptions<TSubscription>",
+    },
+    {
+        id: 2,
+        title: "getNodeByPath",
+        caption: " A function that returns the location where the `Node` is \
+      located on the TSubscription object. It should return a single Node \
+      that matches the data structure in \
+      getCollectionByPath<TQuery>(...).edges.node and \
+      getCollectionByPath<TQuery>(...).nodes",
+        value: "GetNodeByPath<TSubscription>",
+    },
+];
+exports.returnValues = [
+    {
+        id: 0,
+        title: "data",
+        caption: "The payload returned from the query",
+        value: "ListQueryType | undefined",
+    },
+    {
+        id: 1,
+        title: "error",
+        caption: "Any errors returned from the query",
+        value: "ApolloError | undefined",
+    },
+    {
+        id: 2,
+        title: "refresh",
+        caption: "A funtion that enables you to re-execute the query",
+        value: "() => void",
+    },
+    {
+        id: 3,
+        title: "nextPage",
+        caption: "A funtion that helps you fetch the next set of results for a paginated list",
+        value: "() => void",
+    },
+    {
+        id: 4,
+        title: "loadingRefresh",
+        caption: "An indicator that a refresh is in progress",
+        value: "boolean",
+    },
+    {
+        id: 5,
+        title: "loadingNextPage",
+        caption: "An indicator that a fetch more is in progress",
+        value: "boolean",
+    },
+    {
+        id: 6,
+        title: "loadingInitialContent",
+        caption: "An indicator that the initial content is being fetched",
+        value: "boolean",
+    },
+];

package/dist/useCollectionQuery/test-utilities/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./queries";
+export * from "./utils";
+export * from "./mocks";

package/dist/useCollectionQuery/test-utilities/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./queries"), exports);
+__exportStar(require("./utils"), exports);
+__exportStar(require("./mocks"), exports);

package/dist/useCollectionQuery/test-utilities/mocks.d.ts

@@ -0,0 +1,107 @@
+/// <reference types="jest" />
+import { DocumentNode } from "@apollo/client";
+import { MockedResponse } from "@apollo/react-testing";
+import React from "react";
+export declare function wrapper(mocks: MockedResponse[]): React.FunctionComponent<{}>;
+export declare const listQueryResponseMock: jest.Mock<{
+    data: {
+        conversation: {
+            __typename: string;
+            smsMessages: {
+                __typename: string;
+                edges: {
+                    __typename: string;
+                    node: {
+                        __typename: string;
+                        id: any;
+                    };
+                }[];
+                nodes: {
+                    __typename: string;
+                    id: any;
+                }[];
+                pageInfo: {
+                    __typename: string;
+                    endCursor: string;
+                    hasNextPage: boolean;
+                };
+            };
+        };
+    };
+}, [id: any], any>;
+export declare const listQueryWithTotalCountResponseMock: jest.Mock<{
+    data: {
+        conversation: {
+            __typename: string;
+            smsMessages: {
+                __typename: string;
+                edges: {
+                    __typename: string;
+                    node: {
+                        __typename: string;
+                        id: any;
+                    };
+                }[];
+                nodes: {
+                    __typename: string;
+                    id: any;
+                }[];
+                pageInfo: {
+                    __typename: string;
+                    endCursor: string;
+                    hasNextPage: boolean;
+                };
+                totalCount: number;
+            };
+        };
+    };
+}, [id: any], any>;
+export declare const subscriptionQueryMock: jest.Mock<{
+    data: {
+        conversationMessage: {
+            __typename: string;
+            id: string;
+            smsMessage: {
+                __typename: string;
+                id: any;
+            };
+        };
+    };
+}, [id: any], any>;
+export declare function buildListRequestMock(query: DocumentNode, responseMock: jest.Mock, id?: string | undefined, searchTerm?: string | undefined): {
+    request: {
+        query: DocumentNode;
+        variables: {
+            searchTerm: string | undefined;
+        };
+    };
+    result: () => any;
+};
+export declare function buildSubscriptionRequestMock(id?: string | undefined): {
+    request: {
+        query: DocumentNode;
+    };
+    result: () => {
+        data: {
+            conversationMessage: {
+                __typename: string;
+                id: string;
+                smsMessage: {
+                    __typename: string;
+                    id: any;
+                };
+            };
+        };
+    };
+    delay: number;
+};
+export declare function buildListRequestMockForNextPage(query: DocumentNode, responseMock: jest.Mock, id?: string | undefined): {
+    request: {
+        query: DocumentNode;
+        variables: {
+            cursor: string;
+        };
+    };
+    result: () => any;
+};
+export declare function setListQueryMockHasNextPage(hasNextPage: boolean): void;

package/dist/useCollectionQuery/test-utilities/mocks.js

@@ -0,0 +1,131 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setListQueryMockHasNextPage = exports.buildListRequestMockForNextPage = exports.buildSubscriptionRequestMock = exports.buildListRequestMock = exports.subscriptionQueryMock = exports.listQueryWithTotalCountResponseMock = exports.listQueryResponseMock = exports.wrapper = void 0;
+const react_testing_1 = require("@apollo/react-testing");
+const react_1 = __importDefault(require("react"));
+const uuid_1 = require("uuid");
+const queries_1 = require("./queries");
+function wrapper(mocks) {
+    function ApolloMockedProvider({ children, }) {
+        return (react_1.default.createElement(react_testing_1.MockedProvider, { addTypename: true, mocks: mocks }, children));
+    }
+    return ApolloMockedProvider;
+}
+exports.wrapper = wrapper;
+let listQueryHasNextPage = true;
+exports.listQueryResponseMock = jest.fn(id => {
+    return {
+        data: {
+            conversation: {
+                __typename: "Conversation",
+                smsMessages: {
+                    __typename: "SMSMessageConnection",
+                    edges: [
+                        {
+                            __typename: "SMSMessageEdge",
+                            node: {
+                                __typename: "SMSMessage",
+                                id: id || (0, uuid_1.v1)(),
+                            },
+                        },
+                    ],
+                    nodes: [
+                        {
+                            __typename: "SMSMessage",
+                            id: id || (0, uuid_1.v1)(),
+                        },
+                    ],
+                    pageInfo: {
+                        __typename: "PageInfo",
+                        endCursor: "MZ",
+                        hasNextPage: listQueryHasNextPage,
+                    },
+                },
+            },
+        },
+    };
+});
+exports.listQueryWithTotalCountResponseMock = jest.fn(id => {
+    return {
+        data: {
+            conversation: {
+                __typename: "Conversation",
+                smsMessages: {
+                    __typename: "SMSMessageConnection",
+                    edges: [
+                        {
+                            __typename: "SMSMessageEdge",
+                            node: {
+                                __typename: "SMSMessage",
+                                id: id || (0, uuid_1.v1)(),
+                            },
+                        },
+                    ],
+                    nodes: [
+                        {
+                            __typename: "SMSMessage",
+                            id: id || (0, uuid_1.v1)(),
+                        },
+                    ],
+                    pageInfo: {
+                        __typename: "PageInfo",
+                        endCursor: "MZ",
+                        hasNextPage: listQueryHasNextPage,
+                    },
+                    totalCount: 42,
+                },
+            },
+        },
+    };
+});
+exports.subscriptionQueryMock = jest.fn(id => {
+    return {
+        data: {
+            conversationMessage: {
+                __typename: "conversationMessage",
+                id: "other stuff",
+                smsMessage: {
+                    __typename: "SMSMessageData",
+                    id: id,
+                },
+            },
+        },
+    };
+});
+function buildListRequestMock(query, responseMock, id, searchTerm) {
+    return {
+        request: {
+            query: query,
+            variables: { searchTerm: searchTerm },
+        },
+        result: () => responseMock(id),
+    };
+}
+exports.buildListRequestMock = buildListRequestMock;
+function buildSubscriptionRequestMock(id) {
+    return {
+        request: {
+            query: queries_1.SUBSCRIPTION_QUERY,
+        },
+        result: () => (0, exports.subscriptionQueryMock)(id),
+        delay: 100,
+    };
+}
+exports.buildSubscriptionRequestMock = buildSubscriptionRequestMock;
+function buildListRequestMockForNextPage(query, responseMock, id) {
+    return {
+        request: {
+            query: query,
+            variables: { cursor: "MZ" },
+        },
+        result: () => responseMock(id),
+    };
+}
+exports.buildListRequestMockForNextPage = buildListRequestMockForNextPage;
+function setListQueryMockHasNextPage(hasNextPage) {
+    listQueryHasNextPage = hasNextPage;
+}
+exports.setListQueryMockHasNextPage = setListQueryMockHasNextPage;

package/dist/useCollectionQuery/test-utilities/queries.d.ts

@@ -0,0 +1,37 @@
+export declare const LIST_QUERY: import("@apollo/client").DocumentNode;
+export declare const LIST_QUERY_WITH_TOTAL_COUNT: import("@apollo/client").DocumentNode;
+export interface ListQueryType {
+    __typename?: "Query";
+    conversation?: {
+        __typename?: "Conversation";
+        smsMessages: {
+            edges: Array<{
+                __typename?: "SMSMessageConnection";
+                node: {
+                    __typename?: "SMSMessage";
+                    id: string;
+                };
+                cursor: string;
+            }>;
+            nodes: Array<{
+                __typename?: "SMSMessage";
+                id: string;
+            }>;
+            pageInfo: {
+                endCursor: string;
+                hasNextPage: boolean;
+            };
+            totalCount?: number;
+        };
+    };
+}
+export declare const SUBSCRIPTION_QUERY: import("@apollo/client").DocumentNode;
+export interface SubscriptionQueryType {
+    __typename?: "Subscription";
+    conversationMessage?: {
+        smsMessage: {
+            __typename?: "SMSMessage";
+            id: string;
+        };
+    };
+}

package/dist/useCollectionQuery/test-utilities/queries.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SUBSCRIPTION_QUERY = exports.LIST_QUERY_WITH_TOTAL_COUNT = exports.LIST_QUERY = void 0;
+const client_1 = require("@apollo/client");
+exports.LIST_QUERY = (0, client_1.gql) `
+  query ConversationMessages($cursor: string, $searchTerm: string) {
+    conversation(id: "MQ==") {
+      smsMessages(first: 1, after: $cursor, searchTerm: $searchTerm) {
+        edges {
+          node {
+            __typename
+            id
+          }
+        }
+        nodes {
+          __typename
+          id
+        }
+        pageInfo {
+          endCursor
+          hasNextPage
+        }
+      }
+    }
+  }
+`;
+exports.LIST_QUERY_WITH_TOTAL_COUNT = (0, client_1.gql) `
+  query ConversationMessages($cursor: string, $searchTerm: string) {
+    conversation(id: "MQ==") {
+      smsMessages(first: 1, after: $cursor, searchTerm: $searchTerm) {
+        edges {
+          node {
+            __typename
+            id
+          }
+        }
+        nodes {
+          __typename
+          id
+        }
+        pageInfo {
+          endCursor
+          hasNextPage
+        }
+        totalCount
+      }
+    }
+  }
+`;
+exports.SUBSCRIPTION_QUERY = (0, client_1.gql) `
+  subscription ConversationMessage($conversationId: EncodedId!) {
+    conversationMessage(conversationId: $conversationId) {
+      smsMessage {
+        __typename
+        id
+      }
+    }
+  }
+`;

package/dist/useCollectionQuery/test-utilities/utils.d.ts

@@ -0,0 +1 @@
+export declare function wait(milliseconds?: number): Promise<void>;

package/dist/useCollectionQuery/test-utilities/utils.js

@@ -0,0 +1,18 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.wait = void 0;
+function wait(milliseconds = 0) {
+    return __awaiter(this, void 0, void 0, function* () {
+        yield new Promise(resolve => setTimeout(resolve, milliseconds));
+    });
+}
+exports.wait = wait;

package/dist/useCollectionQuery/uniqueEdges.d.ts

@@ -0,0 +1,8 @@
+import { Node } from "./uniqueNodes";
+export interface Edge {
+    __typename?: unknown;
+    node: Node;
+    cursor: string;
+}
+export declare function createEdge(node: Node): Edge;
+export declare function uniqueEdges(edges: Edge[]): Edge[];

package/dist/useCollectionQuery/uniqueEdges.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.uniqueEdges = exports.createEdge = void 0;
+function createEdge(node) {
+    return {
+        node: node,
+        cursor: "",
+        __typename: `${node.__typename}Edge`,
+    };
+}
+exports.createEdge = createEdge;
+function uniqueEdges(edges) {
+    const result = new Map();
+    edges.forEach(edge => {
+        result.set(`${edge.__typename}-${edge.node.__typename}-${edge.node.id}`, edge);
+    });
+    return Array.from(result.values());
+}
+exports.uniqueEdges = uniqueEdges;