@darajs/ui-utils 1.0.0-a.1

package/dist/request-utils.d.ts

@@ -0,0 +1,83 @@
+/**
+ * Copyright 2023 Impulse Innovations Limited
+ *
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { BehaviorSubject } from 'rxjs';
+export interface SortingRule {
+    desc?: boolean;
+    id: string;
+}
+export interface FilterRule {
+    id: string;
+    value: string | Array<string>;
+}
+/** Standard interface for any additional request options that are required */
+export interface RequestOptions {
+    filter?: Array<FilterRule>;
+    limit?: number;
+    searchTerm?: string;
+    sort?: Array<SortingRule>;
+    startIndex?: number;
+}
+/** Error class for request errors that allow them to be caught more easily */
+export declare class RequestError extends Error {
+    requestParams: {
+        [k: string]: any;
+    };
+    status: number;
+    constructor(status: number, message: string, requestParams?: {
+        [k: string]: any;
+    });
+}
+/**
+ * Request helper for converting an options object into a valid query string
+ *
+ * @param options The request options object to convert, will handle it being undefined
+ */
+export declare const getQueryStr: (options?: RequestOptions, extras?: {
+    [k: string]: string | number | boolean;
+}) => string;
+/**
+ * Request helper for checking valid response status
+ *
+ * @param res The response to check
+ */
+export declare const isValidResponse: (res: Response) => boolean;
+/**
+ * Request helper to check whether a response is valid and throw a Service error instance if it is not.
+ *
+ * @param res the response to check
+ * @param fallbackMessage a fallback error message if one is not provided
+ */
+export declare function validateResponse(res: Response, fallbackMessage: string, requestParams?: {
+    [k: string]: any;
+}): Promise<void>;
+export declare const CHUNK_SIZE = 5000000;
+/**
+ * An async function that loops over a file and uploads it chunk by chunk, whilst notifying the calling function of it's
+ * progress via an Rx stream.
+ *
+ * @param url the url to upload too
+ * @param file the file to upload
+ * @param authHeaders the authHeaders to upload with
+ * @param extras a dict of extras to also set on the form
+ * @param sub an optional subject notify the calling code of current progress
+ */
+export declare function chunkedFileUpload(url: string, file: File, authHeaders: {
+    [k: string]: string;
+}, extras?: {
+    [k: string]: string;
+}, sub?: BehaviorSubject<number>): Promise<void>;
+//# sourceMappingURL=request-utils.d.ts.map

package/dist/request-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"request-utils.d.ts","sourceRoot":"","sources":["../src/request-utils.tsx"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,OAAO,EAAE,eAAe,EAAE,MAAM,MAAM,CAAC;AAKvC,MAAM,WAAW,WAAW;IACxB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,EAAE,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,UAAU;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;CACjC;AAED,8EAA8E;AAC9E,MAAM,WAAW,cAAc;IAC3B,MAAM,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IAC1B,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,8EAA8E;AAC9E,qBAAa,YAAa,SAAQ,KAAK;IACnC,aAAa,EAAE;QAAE,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IAEpC,MAAM,EAAE,MAAM,CAAC;gBAEH,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE;QAAE,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE;CAMpF;AAED;;;;GAIG;AACH,eAAO,MAAM,WAAW,aAAc,cAAc;;MAAwD,MA0C3G,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,eAAe,QAAS,QAAQ,KAAG,OAE/C,CAAC;AAEF;;;;;GAKG;AACH,wBAAsB,gBAAgB,CAClC,GAAG,EAAE,QAAQ,EACb,eAAe,EAAE,MAAM,EACvB,aAAa,CAAC,EAAE;IAAE,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,GACrC,OAAO,CAAC,IAAI,CAAC,CAiBf;AAED,eAAO,MAAM,UAAU,UAAM,CAAC;AAE9B;;;;;;;;;GASG;AACH,wBAAsB,iBAAiB,CACnC,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,IAAI,EACV,WAAW,EAAE;IAAE,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,EACpC,MAAM,CAAC,EAAE;IAAE,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,EAChC,GAAG,CAAC,EAAE,eAAe,CAAC,MAAM,CAAC,GAC9B,OAAO,CAAC,IAAI,CAAC,CA4Cf"}

package/dist/request-utils.js

@@ -0,0 +1,161 @@
+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());
+    });
+};
+import shortid from 'shortid';
+import { HTTP_METHOD } from './constants';
+/** Error class for request errors that allow them to be caught more easily */
+export class RequestError extends Error {
+    constructor(status, message, requestParams) {
+        super(message);
+        this.name = 'ServiceError';
+        this.status = status;
+        this.requestParams = requestParams;
+    }
+}
+/**
+ * Request helper for converting an options object into a valid query string
+ *
+ * @param options The request options object to convert, will handle it being undefined
+ */
+export const getQueryStr = (options, extras) => {
+    if (!options && !extras) {
+        return '';
+    }
+    let query = '?';
+    if (Number.isInteger(options.startIndex)) {
+        query += `offset=${options.startIndex}&`;
+    }
+    if (Number.isInteger(options.limit)) {
+        query += `limit=${options.limit}&`;
+    }
+    if (options.searchTerm) {
+        query += `query=${options.searchTerm}&`;
+    }
+    if (options.sort && options.sort.length > 0) {
+        // Handle all items in array of sorting rules
+        query += `order_by=${options.sort.map((sort) => `${sort.desc ? '-' : ''}${sort.id}`).join(',')}&`;
+    }
+    if (options.filter && options.filter.length > 0) {
+        for (const filter of options.filter) {
+            // Handle single filters or arrays of filter terms
+            if (typeof filter.value === 'string') {
+                query += `${filter.id}=${filter.value}&`;
+            }
+            else {
+                for (const val of filter.value) {
+                    query += `${filter.id}=${val}&`;
+                }
+            }
+        }
+    }
+    try {
+        Object.keys(extras).forEach((key) => {
+            query += `${key}=${String(extras[key])}&`;
+        });
+    }
+    catch (_a) {
+        // Do nothing as it was probably empty
+    }
+    return query.replace(/&$/, '');
+};
+/**
+ * Request helper for checking valid response status
+ *
+ * @param res The response to check
+ */
+export const isValidResponse = (res) => {
+    return res.status >= 100 && res.status < 400;
+};
+/**
+ * Request helper to check whether a response is valid and throw a Service error instance if it is not.
+ *
+ * @param res the response to check
+ * @param fallbackMessage a fallback error message if one is not provided
+ */
+export function validateResponse(res, fallbackMessage, requestParams) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!isValidResponse(res)) {
+            let message = fallbackMessage;
+            try {
+                const json = yield res.json();
+                message = (json === null || json === void 0 ? void 0 : json.message) || (json === null || json === void 0 ? void 0 : json.detail) || fallbackMessage;
+            }
+            catch (e) {
+                if (fallbackMessage) {
+                    try {
+                        message = (yield res.text()) || fallbackMessage;
+                    }
+                    catch (_a) {
+                        // do nothing, use fallback message
+                    }
+                }
+            }
+            throw new RequestError(res.status, message, requestParams);
+        }
+    });
+}
+export const CHUNK_SIZE = 5e6;
+/**
+ * An async function that loops over a file and uploads it chunk by chunk, whilst notifying the calling function of it's
+ * progress via an Rx stream.
+ *
+ * @param url the url to upload too
+ * @param file the file to upload
+ * @param authHeaders the authHeaders to upload with
+ * @param extras a dict of extras to also set on the form
+ * @param sub an optional subject notify the calling code of current progress
+ */
+export function chunkedFileUpload(url, file, authHeaders, extras, sub) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const totalChunks = Math.ceil(file.size / CHUNK_SIZE);
+        let currentPointer = 0;
+        let currentChunk = 0;
+        const uploadId = shortid.generate();
+        /* eslint-disable no-await-in-loop */
+        // We need to process sequentially thus await in a loop
+        while (currentPointer < file.size) {
+            const fd = new FormData();
+            if (extras) {
+                for (const extra of Object.keys(extras)) {
+                    fd.append(extra, extras[extra]);
+                }
+            }
+            fd.append('upload_id', uploadId);
+            fd.append('file_total_size', `${file.size}`);
+            fd.append('file_chunk_offset', `${currentPointer}`);
+            fd.append('file_chunk_index', `${currentChunk}`);
+            fd.append('file_total_chunks', `${totalChunks}`);
+            fd.append('file', new File([file.slice(currentPointer, currentPointer + CHUNK_SIZE)], file.name));
+            try {
+                const res = yield fetch(url, {
+                    body: fd,
+                    headers: Object.assign(Object.assign({}, authHeaders), { Accept: 'application/json' }),
+                    method: HTTP_METHOD.POST,
+                });
+                yield validateResponse(res, `Failed to upload file: ${file.name}`);
+                if (sub) {
+                    sub.next(Math.round(((currentChunk + 1) / totalChunks) * 100));
+                }
+                currentPointer += CHUNK_SIZE;
+                currentChunk += 1;
+            }
+            catch (err) {
+                if (sub) {
+                    sub.error(err.message);
+                }
+                else {
+                    throw err;
+                }
+                break;
+            }
+        }
+        /* eslint-enable no-await-in-loop */
+    });
+}
+//# sourceMappingURL=request-utils.js.map

package/dist/request-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request-utils.js","sourceRoot":"","sources":["../src/request-utils.tsx"],"names":[],"mappings":";;;;;;;;;AAiBA,OAAO,OAAO,MAAM,SAAS,CAAC;AAE9B,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAqB1C,8EAA8E;AAC9E,MAAM,OAAO,YAAa,SAAQ,KAAK;IAKnC,YAAY,MAAc,EAAE,OAAe,EAAE,aAAoC;QAC7E,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,cAAc,CAAC;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;IACvC,CAAC;CACJ;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,OAAwB,EAAE,MAAmD,EAAU,EAAE;IACjH,IAAI,CAAC,OAAO,IAAI,CAAC,MAAM,EAAE;QACrB,OAAO,EAAE,CAAC;KACb;IAED,IAAI,KAAK,GAAG,GAAG,CAAC;IAEhB,IAAI,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;QACtC,KAAK,IAAI,UAAU,OAAO,CAAC,UAAU,GAAG,CAAC;KAC5C;IACD,IAAI,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;QACjC,KAAK,IAAI,SAAS,OAAO,CAAC,KAAK,GAAG,CAAC;KACtC;IACD,IAAI,OAAO,CAAC,UAAU,EAAE;QACpB,KAAK,IAAI,SAAS,OAAO,CAAC,UAAU,GAAG,CAAC;KAC3C;IACD,IAAI,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;QACzC,6CAA6C;QAC7C,KAAK,IAAI,YAAY,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;KACrG;IACD,IAAI,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;QAC7C,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,MAAM,EAAE;YACjC,kDAAkD;YAClD,IAAI,OAAO,MAAM,CAAC,KAAK,KAAK,QAAQ,EAAE;gBAClC,KAAK,IAAI,GAAG,MAAM,CAAC,EAAE,IAAI,MAAM,CAAC,KAAK,GAAG,CAAC;aAC5C;iBAAM;gBACH,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,KAAK,EAAE;oBAC5B,KAAK,IAAI,GAAG,MAAM,CAAC,EAAE,IAAI,GAAG,GAAG,CAAC;iBACnC;aACJ;SACJ;KACJ;IAED,IAAI;QACA,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YAChC,KAAK,IAAI,GAAG,GAAG,IAAI,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC;QAC9C,CAAC,CAAC,CAAC;KACN;IAAC,WAAM;QACJ,sCAAsC;KACzC;IAED,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;AACnC,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,GAAa,EAAW,EAAE;IACtD,OAAO,GAAG,CAAC,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC;AACjD,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,UAAgB,gBAAgB,CAClC,GAAa,EACb,eAAuB,EACvB,aAAoC;;QAEpC,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE;YACvB,IAAI,OAAO,GAAG,eAAe,CAAC;YAC9B,IAAI;gBACA,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;gBAC9B,OAAO,GAAG,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO,MAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,CAAA,IAAI,eAAe,CAAC;aAC9D;YAAC,OAAO,CAAC,EAAE;gBACR,IAAI,eAAe,EAAE;oBACjB,IAAI;wBACA,OAAO,GAAG,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC,IAAI,eAAe,CAAC;qBACnD;oBAAC,WAAM;wBACJ,mCAAmC;qBACtC;iBACJ;aACJ;YACD,MAAM,IAAI,YAAY,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE,aAAa,CAAC,CAAC;SAC9D;IACL,CAAC;CAAA;AAED,MAAM,CAAC,MAAM,UAAU,GAAG,GAAG,CAAC;AAE9B;;;;;;;;;GASG;AACH,MAAM,UAAgB,iBAAiB,CACnC,GAAW,EACX,IAAU,EACV,WAAoC,EACpC,MAAgC,EAChC,GAA6B;;QAE7B,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC,CAAC;QACtD,IAAI,cAAc,GAAG,CAAC,CAAC;QACvB,IAAI,YAAY,GAAG,CAAC,CAAC;QACrB,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;QAEpC,qCAAqC;QACrC,uDAAuD;QACvD,OAAO,cAAc,GAAG,IAAI,CAAC,IAAI,EAAE;YAC/B,MAAM,EAAE,GAAG,IAAI,QAAQ,EAAE,CAAC;YAC1B,IAAI,MAAM,EAAE;gBACR,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;oBACrC,EAAE,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;iBACnC;aACJ;YACD,EAAE,CAAC,MAAM,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;YACjC,EAAE,CAAC,MAAM,CAAC,iBAAiB,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;YAC7C,EAAE,CAAC,MAAM,CAAC,mBAAmB,EAAE,GAAG,cAAc,EAAE,CAAC,CAAC;YACpD,EAAE,CAAC,MAAM,CAAC,kBAAkB,EAAE,GAAG,YAAY,EAAE,CAAC,CAAC;YACjD,EAAE,CAAC,MAAM,CAAC,mBAAmB,EAAE,GAAG,WAAW,EAAE,CAAC,CAAC;YACjD,EAAE,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc,EAAE,cAAc,GAAG,UAAU,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;YAElG,IAAI;gBACA,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;oBACzB,IAAI,EAAE,EAAE;oBACR,OAAO,kCAAO,WAAW,KAAE,MAAM,EAAE,kBAAkB,GAAE;oBACvD,MAAM,EAAE,WAAW,CAAC,IAAI;iBAC3B,CAAC,CAAC;gBACH,MAAM,gBAAgB,CAAC,GAAG,EAAE,0BAA0B,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;gBACnE,IAAI,GAAG,EAAE;oBACL,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,YAAY,GAAG,CAAC,CAAC,GAAG,WAAW,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;iBAClE;gBACD,cAAc,IAAI,UAAU,CAAC;gBAC7B,YAAY,IAAI,CAAC,CAAC;aACrB;YAAC,OAAO,GAAG,EAAE;gBACV,IAAI,GAAG,EAAE;oBACL,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;iBAC1B;qBAAM;oBACH,MAAM,GAAG,CAAC;iBACb;gBACD,MAAM;aACT;SACJ;QACD,oCAAoC;IACxC,CAAC;CAAA"}

package/dist/rx-utils.d.ts

@@ -0,0 +1,9 @@
+import { Subscription } from 'rxjs';
+/**
+ * A helper hook that wraps a subscription and makes sure that it is properly cleaned up at the end of the component
+ * lifecycle, returns a function that should wrap the call to subscribe
+ *
+ * @param sub the subscription to cleanup
+ */
+export declare function useSubscription(): (sub: Subscription) => void;
+//# sourceMappingURL=rx-utils.d.ts.map

package/dist/rx-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rx-utils.d.ts","sourceRoot":"","sources":["../src/rx-utils.tsx"],"names":[],"mappings":"AAiBA,OAAO,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAEpC;;;;;GAKG;AACH,wBAAgB,eAAe,IAAI,CAAC,GAAG,EAAE,YAAY,KAAK,IAAI,CAU7D"}

package/dist/rx-utils.js

@@ -0,0 +1,33 @@
+/**
+ * Copyright 2023 Impulse Innovations Limited
+ *
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { useEffect, useState } from 'react';
+/**
+ * A helper hook that wraps a subscription and makes sure that it is properly cleaned up at the end of the component
+ * lifecycle, returns a function that should wrap the call to subscribe
+ *
+ * @param sub the subscription to cleanup
+ */
+export function useSubscription() {
+    const [subscription, setSubscription] = useState();
+    useEffect(() => {
+        if (subscription) {
+            return () => subscription.unsubscribe();
+        }
+    }, [subscription]);
+    return setSubscription;
+}
+//# sourceMappingURL=rx-utils.js.map

package/dist/rx-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rx-utils.js","sourceRoot":"","sources":["../src/rx-utils.tsx"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAG5C;;;;;GAKG;AACH,MAAM,UAAU,eAAe;IAC3B,MAAM,CAAC,YAAY,EAAE,eAAe,CAAC,GAAG,QAAQ,EAAgB,CAAC;IAEjE,SAAS,CAAC,GAAG,EAAE;QACX,IAAI,YAAY,EAAE;YACd,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,WAAW,EAAE,CAAC;SAC3C;IACL,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC;IAEnB,OAAO,eAAe,CAAC;AAC3B,CAAC"}

package/dist/use-d3-axis.d.ts

@@ -0,0 +1,45 @@
+export type AxisDomain = string | number | 'auto' | 'dataMin' | 'dataMax';
+interface AxisProps<T> {
+    domain?: [T, T];
+    tickFormatter: (tick?: number) => string;
+    ticks?: Array<number>;
+    type: 'number' | 'category';
+}
+/**
+ * An underlying helper hook that uses d3 to create a function for getting the axis properties for an axis based
+ * on the pixel size of that axis. This hook should not be used directly, use one of the wrappers for it,
+ * e.g. useD3LinearAxis or useD3TimeAxis
+ *
+ * @param data the underlying data for the axis
+ * @param domain the target domain for the axis
+ * @param getScale a function to get the d3Scale instance with domain applied
+ * @param domainFormatter a function to translate the d3 domain back into a recharts domain
+ */
+export declare function useD3Axis<T>(data: Array<T>, getScale: (data: Array<T>, domain?: [T, T]) => any, domainFormatter: (domain: [any, any]) => [T, T], domain?: [T, T]): (width?: number) => AxisProps<T>;
+/**
+ * Hook that returns a function that generates the props for a linearly scaled axis based on the size in pixels of the
+ * axis
+ *
+ * @param data the underlying data for the axis
+ * @param domain the target domain for the axis
+ */
+export declare function useD3LinearAxis(data: Array<number>, domain?: [number, number]): (axisSize?: number) => AxisProps<number>;
+/**
+ * Hook that returns a function that generates the props for a time scaled axis based on the size in pixels of the
+ * axis
+ *
+ * @param data the underlying data for the axis
+ * @param domain the target domain for the axis
+ */
+export declare function useD3TimeAxis(data: Array<Date>, domain?: [Date, Date]): (axisSize?: number) => AxisProps<Date>;
+/**
+ * Hook that returns a function that generates the props for an ordinal (categorical) scaled axis, doesn't actually use
+ * the ordinal scale as it doesn't need to, but has the same returned api as the others so it can be substituted in.
+ *
+ * @param mapping a mapping dict that translates the numeric value to a label
+ */
+export declare function useD3OrdinalAxis(mapping: {
+    [k: number]: string;
+}): (axisSize?: number) => AxisProps<string>;
+export {};
+//# sourceMappingURL=use-d3-axis.d.ts.map

package/dist/use-d3-axis.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-d3-axis.d.ts","sourceRoot":"","sources":["../src/use-d3-axis.tsx"],"names":[],"mappings":"AAsBA,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,GAAG,SAAS,CAAC;AAE1E,UAAU,SAAS,CAAC,CAAC;IACjB,MAAM,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAChB,aAAa,EAAE,CAAC,IAAI,CAAC,EAAE,MAAM,KAAK,MAAM,CAAC;IACzC,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACtB,IAAI,EAAE,QAAQ,GAAG,UAAU,CAAC;CAC/B;AAED;;;;;;;;;GASG;AACH,wBAAgB,SAAS,CAAC,CAAC,EACvB,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EACd,QAAQ,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,GAAG,EAClD,eAAe,EAAE,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAC/C,MAAM,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,GAChB,CAAC,KAAK,CAAC,EAAE,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,CAelC;AAOD;;;;;;GAMG;AACH,wBAAgB,eAAe,CAC3B,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,EACnB,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,GAC1B,CAAC,QAAQ,CAAC,EAAE,MAAM,KAAK,SAAS,CAAC,MAAM,CAAC,CAE1C;AAOD;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,MAAM,KAAK,SAAS,CAAC,IAAI,CAAC,CAE9G;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE;IAAE,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,GAAG,CAAC,QAAQ,CAAC,EAAE,MAAM,KAAK,SAAS,CAAC,MAAM,CAAC,CAO3G"}

package/dist/use-d3-axis.js

@@ -0,0 +1,84 @@
+/**
+ * Copyright 2023 Impulse Innovations Limited
+ *
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { scaleLinear, scaleTime } from 'd3-scale';
+import { useCallback, useMemo } from 'react';
+import useDeepCompare from './use-deep-compare';
+/**
+ * An underlying helper hook that uses d3 to create a function for getting the axis properties for an axis based
+ * on the pixel size of that axis. This hook should not be used directly, use one of the wrappers for it,
+ * e.g. useD3LinearAxis or useD3TimeAxis
+ *
+ * @param data the underlying data for the axis
+ * @param domain the target domain for the axis
+ * @param getScale a function to get the d3Scale instance with domain applied
+ * @param domainFormatter a function to translate the d3 domain back into a recharts domain
+ */
+export function useD3Axis(data, getScale, domainFormatter, domain) {
+    const valueScale = useMemo(() => getScale(data, domain), useDeepCompare([data, domain]));
+    return useCallback((axisSize) => {
+        const scale = valueScale.range([0, axisSize]).nice();
+        return {
+            domain: domainFormatter(scale.domain()),
+            tickFormatter: scale.tickFormat(),
+            ticks: scale.ticks(),
+            type: 'number',
+        };
+    }, [valueScale]);
+}
+/** Helper function for getting a linear d3Scale instance, based on data and domain */
+const getLinearScale = (data, domain) => {
+    return scaleLinear().domain([data ? Math.min(...data) : domain[0], data ? Math.max(...data) : domain[1]]);
+};
+/**
+ * Hook that returns a function that generates the props for a linearly scaled axis based on the size in pixels of the
+ * axis
+ *
+ * @param data the underlying data for the axis
+ * @param domain the target domain for the axis
+ */
+export function useD3LinearAxis(data, domain) {
+    return useD3Axis(data, getLinearScale, (dm) => dm, domain);
+}
+/** Helper function for getting a time d3Scale instance, based on data and domain */
+const getTimeScale = (data, domain) => {
+    return scaleTime().domain([data ? data[0] : domain[0], data ? data[data.length - 1] : domain[1]]);
+};
+/**
+ * Hook that returns a function that generates the props for a time scaled axis based on the size in pixels of the
+ * axis
+ *
+ * @param data the underlying data for the axis
+ * @param domain the target domain for the axis
+ */
+export function useD3TimeAxis(data, domain) {
+    return useD3Axis(data, getTimeScale, (dm) => dm, domain);
+}
+/**
+ * Hook that returns a function that generates the props for an ordinal (categorical) scaled axis, doesn't actually use
+ * the ordinal scale as it doesn't need to, but has the same returned api as the others so it can be substituted in.
+ *
+ * @param mapping a mapping dict that translates the numeric value to a label
+ */
+export function useD3OrdinalAxis(mapping) {
+    return () => {
+        return {
+            tickFormatter: (tick) => mapping[tick],
+            type: 'category',
+        };
+    };
+}
+//# sourceMappingURL=use-d3-axis.js.map

package/dist/use-d3-axis.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-d3-axis.js","sourceRoot":"","sources":["../src/use-d3-axis.tsx"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,OAAO,EAA0B,WAAW,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAC1E,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAE7C,OAAO,cAAc,MAAM,oBAAoB,CAAC;AAYhD;;;;;;;;;GASG;AACH,MAAM,UAAU,SAAS,CACrB,IAAc,EACd,QAAkD,EAClD,eAA+C,EAC/C,MAAe;IAEf,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,cAAc,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAEzF,OAAO,WAAW,CACd,CAAC,QAAgB,EAAgB,EAAE;QAC/B,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QACrD,OAAO;YACH,MAAM,EAAE,eAAe,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;YACvC,aAAa,EAAE,KAAK,CAAC,UAAU,EAAE;YACjC,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE;YACpB,IAAI,EAAE,QAAQ;SACjB,CAAC;IACN,CAAC,EACD,CAAC,UAAU,CAAC,CACf,CAAC;AACN,CAAC;AAED,sFAAsF;AACtF,MAAM,cAAc,GAAG,CAAC,IAAmB,EAAE,MAAwB,EAA+B,EAAE;IAClG,OAAO,WAAW,EAAE,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC9G,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,UAAU,eAAe,CAC3B,IAAmB,EACnB,MAAyB;IAEzB,OAAO,SAAS,CAAS,IAAI,EAAE,cAAc,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;AACvE,CAAC;AAED,oFAAoF;AACpF,MAAM,YAAY,GAAG,CAAC,IAAiB,EAAE,MAAoB,EAA6B,EAAE;IACxF,OAAO,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACtG,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAAC,IAAiB,EAAE,MAAqB;IAClE,OAAO,SAAS,CAAC,IAAI,EAAE,YAAY,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;AAC7D,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAAC,OAAgC;IAC7D,OAAO,GAAsB,EAAE;QAC3B,OAAO;YACH,aAAa,EAAE,CAAC,IAAY,EAAU,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;YACtD,IAAI,EAAE,UAAU;SACnB,CAAC;IACN,CAAC,CAAC;AACN,CAAC"}

package/dist/use-deep-compare.d.ts

@@ -0,0 +1,13 @@
+/**
+ * A helper hook that allows for objects to be deeply compared rather than being compared by reference.
+ *
+ * An example usage with useEffect, where deepObject is a complex object, would be:
+ *
+ * useEffect(() => {
+ *     doSomethingHeavy(deepObject)
+ * }, useDeepCompare([deepObject]))
+ *
+ * @param value - an array of values to check the equality of
+ */
+export default function useDeepCompare<T>(value: T): T;
+//# sourceMappingURL=use-deep-compare.d.ts.map

package/dist/use-deep-compare.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-deep-compare.d.ts","sourceRoot":"","sources":["../src/use-deep-compare.tsx"],"names":[],"mappings":"AAmBA;;;;;;;;;;GAUG;AACH,MAAM,CAAC,OAAO,UAAU,cAAc,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CAQrD"}

package/dist/use-deep-compare.js

@@ -0,0 +1,37 @@
+/**
+ * Copyright 2023 Impulse Innovations Limited
+ *
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import isEqual from 'lodash/isEqual';
+import { useRef } from 'react';
+/**
+ * A helper hook that allows for objects to be deeply compared rather than being compared by reference.
+ *
+ * An example usage with useEffect, where deepObject is a complex object, would be:
+ *
+ * useEffect(() => {
+ *     doSomethingHeavy(deepObject)
+ * }, useDeepCompare([deepObject]))
+ *
+ * @param value - an array of values to check the equality of
+ */
+export default function useDeepCompare(value) {
+    const ref = useRef();
+    if (!isEqual(value, ref.current)) {
+        ref.current = value;
+    }
+    return ref.current;
+}
+//# sourceMappingURL=use-deep-compare.js.map

package/dist/use-deep-compare.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-deep-compare.js","sourceRoot":"","sources":["../src/use-deep-compare.tsx"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,OAAO,OAAO,MAAM,gBAAgB,CAAC;AACrC,OAAO,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAE/B;;;;;;;;;;GAUG;AACH,MAAM,CAAC,OAAO,UAAU,cAAc,CAAI,KAAQ;IAC9C,MAAM,GAAG,GAAG,MAAM,EAAK,CAAC;IAExB,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,EAAE;QAC9B,GAAG,CAAC,OAAO,GAAG,KAAK,CAAC;KACvB;IAED,OAAO,GAAG,CAAC,OAAO,CAAC;AACvB,CAAC"}

package/dist/use-dimensions.d.ts

@@ -0,0 +1,22 @@
+export interface DimensionObject {
+    bottom: number;
+    height: number;
+    left: number;
+    right: number;
+    top: number;
+    width: number;
+    x: number;
+    y: number;
+}
+export type UseDimensionsHook<T extends HTMLElement> = [(node: T) => void, {
+    [k: string]: number;
+}, T];
+/**
+ * The useDimensions hook allows for a component to track the dimensions of a given element by passing the returned ref
+ * to it.
+ *
+ * @param liveMeasure whether to recalculate dimensions when the user scrolls or resizes the page.
+ */
+declare function useDimensions<T extends HTMLElement>(liveMeasure?: boolean): UseDimensionsHook<T>;
+export default useDimensions;
+//# sourceMappingURL=use-dimensions.d.ts.map

package/dist/use-dimensions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-dimensions.d.ts","sourceRoot":"","sources":["../src/use-dimensions.tsx"],"names":[],"mappings":"AAkBA,MAAM,WAAW,eAAe;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,WAAW,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI,EAAE;IAAE,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,EAAE,CAAC,CAAC,CAAC;AAEvG;;;;;GAKG;AACH,iBAAS,aAAa,CAAC,CAAC,SAAS,WAAW,EAAE,WAAW,UAAO,GAAG,iBAAiB,CAAC,CAAC,CAAC,CA2BtF;AAED,eAAe,aAAa,CAAC"}

package/dist/use-dimensions.js

@@ -0,0 +1,47 @@
+/**
+ * Copyright 2023 Impulse Innovations Limited
+ *
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { useCallback, useLayoutEffect, useState } from 'react';
+/**
+ * The useDimensions hook allows for a component to track the dimensions of a given element by passing the returned ref
+ * to it.
+ *
+ * @param liveMeasure whether to recalculate dimensions when the user scrolls or resizes the page.
+ */
+function useDimensions(liveMeasure = true) {
+    const [dimensions, setDimensions] = useState({});
+    const [node, setNode] = useState(null);
+    const ref = useCallback((_node) => {
+        setNode(_node);
+    }, []);
+    useLayoutEffect(() => {
+        if (node) {
+            const measure = () => window.requestAnimationFrame(() => setDimensions(node.getBoundingClientRect()));
+            measure();
+            if (liveMeasure) {
+                window.addEventListener('resize', measure);
+                window.addEventListener('scroll', measure);
+                return () => {
+                    window.removeEventListener('resize', measure);
+                    window.removeEventListener('scroll', measure);
+                };
+            }
+        }
+    }, [node]);
+    return [ref, dimensions, node];
+}
+export default useDimensions;
+//# sourceMappingURL=use-dimensions.js.map

package/dist/use-dimensions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-dimensions.js","sourceRoot":"","sources":["../src/use-dimensions.tsx"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAe/D;;;;;GAKG;AACH,SAAS,aAAa,CAAwB,WAAW,GAAG,IAAI;IAC5D,MAAM,CAAC,UAAU,EAAE,aAAa,CAAC,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAC;IACjD,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,GAAG,QAAQ,CAAI,IAAI,CAAC,CAAC;IAE1C,MAAM,GAAG,GAAG,WAAW,CAAC,CAAC,KAAQ,EAAE,EAAE;QACjC,OAAO,CAAC,KAAK,CAAC,CAAC;IACnB,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,eAAe,CAAC,GAAG,EAAE;QACjB,IAAI,IAAI,EAAE;YACN,MAAM,OAAO,GAAG,GAAW,EAAE,CACzB,MAAM,CAAC,qBAAqB,CAAC,GAAG,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,qBAAqB,EAAE,CAAC,CAAC,CAAC;YACpF,OAAO,EAAE,CAAC;YAEV,IAAI,WAAW,EAAE;gBACb,MAAM,CAAC,gBAAgB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;gBAC3C,MAAM,CAAC,gBAAgB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;gBAE3C,OAAO,GAAG,EAAE;oBACR,MAAM,CAAC,mBAAmB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;oBAC9C,MAAM,CAAC,mBAAmB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;gBAClD,CAAC,CAAC;aACL;SACJ;IACL,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;IAEX,OAAO,CAAC,GAAG,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;AACnC,CAAC;AAED,eAAe,aAAa,CAAC"}

package/dist/use-intersection-observer.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Copyright 2023 Impulse Innovations Limited
+ *
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { MutableRefObject } from 'react';
+/**
+ * The useIntersectionObserver hook allows a component to track whether an element is intersecting with an ancestor
+ * element or with a top-level document's viewport.
+ *
+ * @param ref the ref to the element that is to be observed
+ * @param rootMargin the amount of the element that is to be intersecting for the observer's callback to be executed.
+ * @param threshold Either a single number or an array of numbers which indicate at what percentage of the target's
+ * visibility the observer's callback should be executed.
+ * @returns boolean indicating whether element is intersecting or not
+ */
+declare function useIntersectionObserver<T extends Element>(ref: MutableRefObject<T>, rootMargin?: string, threshold?: number): boolean;
+export default useIntersectionObserver;
+//# sourceMappingURL=use-intersection-observer.d.ts.map

package/dist/use-intersection-observer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-intersection-observer.d.ts","sourceRoot":"","sources":["../src/use-intersection-observer.tsx"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,OAAO,EAAE,gBAAgB,EAAuB,MAAM,OAAO,CAAC;AAE9D;;;;;;;;;GASG;AAEH,iBAAS,uBAAuB,CAAC,CAAC,SAAS,OAAO,EAC9C,GAAG,EAAE,gBAAgB,CAAC,CAAC,CAAC,EACxB,UAAU,SAAQ,EAClB,SAAS,SAAM,GAChB,OAAO,CAiBT;AAED,eAAe,uBAAuB,CAAC"}