mod-arch-shared 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

package/README.md

@@ -0,0 +1,115 @@
+# Modular Architecture Shared Library
+
+## Overview
+
+`mod-arch-shared` is a shared library providing common UI components and utilities for micro-frontend projects following a modular architecture. This library follows a modular design to ensure reusability and maintainability across various projects. The library is versioned to facilitate consistent updates and integration.
+
+## Installation
+
+```bash
+npm install mod-arch-shared
+```
+
+## Usage
+
+Import components and utilities as needed:
+
+```jsx
+import { DashboardSearchField, useNamespaces, ToastNotification } from 'mod-arch-shared';
+
+const MyComponent = () => {
+  const { namespaces, loading } = useNamespaces();
+  
+  return (
+    <>
+      <DashboardSearchField onChange={handleSearch} />
+      {/* Your component code */}
+      <ToastNotification title="Success" type="success" message="Operation completed" />
+    </>
+  );
+};
+```
+
+## Using Styles and Images
+
+This library exports both style files and image assets that can be imported and used in your application.
+
+### Importing Styles
+
+You can import specific styles or all styles at once:
+
+```javascript
+// Import all styles
+import { style } from 'mod-arch-shared';
+
+// Or import specific style components directly
+import 'mod-arch-shared/style';
+```
+
+### Importing Images
+
+Images can be imported in several ways:
+
+```javascript
+// Import specific images
+import { emptyStateNotebooks, iconRedHatStorage } from 'mod-arch-shared/images';
+
+// Or import all images as a namespace
+import * as Images from 'mod-arch-shared/images';
+
+// Then use them in your components
+<img src={emptyStateNotebooks} alt="Empty state notebooks" />
+```
+
+## Folder Structure
+
+The repository contains the following modules:
+
+- **api**: API utilities for making service calls and handling errors
+- **components**: Reusable UI components
+- **hooks**: Custom React hooks
+- **utilities**: Utility functions
+- **context**: Context providers
+- **style**: Global styles
+- **types**: TypeScript type definitions
+
+## Development
+
+### Prerequisites
+
+- Node.js >= 20.17
+- npm >= 10.8
+
+### Setup
+
+```bash
+git clone <repository-url>
+cd mod-arch-shared
+npm install
+```
+
+### Building
+
+```bash
+npm run build
+```
+
+### Testing
+
+```bash
+npm test
+```
+
+### Linting
+
+```bash
+npm run lint
+```
+
+## Contributing
+
+We welcome contributions to the project. Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information.
+
+## License
+
+This project is licensed under the Apache License 2.0. See the [LICENSE](LICENSE) file for details.

package/dist/__tests__/__mocks__/mockGenericResponse.d.ts

@@ -0,0 +1,8 @@
+type MockGenericResponse = {
+    id?: string;
+    name?: string;
+    description?: string;
+};
+export declare const mockGenericResponse: ({ name, description, id, }: MockGenericResponse) => MockGenericResponse;
+export {};
+//# sourceMappingURL=mockGenericResponse.d.ts.map

package/dist/__tests__/__mocks__/mockGenericResponse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mockGenericResponse.d.ts","sourceRoot":"","sources":["../../../__tests__/__mocks__/mockGenericResponse.ts"],"names":[],"mappings":"AAAA,KAAK,mBAAmB,GAAG;IACzB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,eAAO,MAAM,mBAAmB,GAAI,4BAIjC,mBAAmB,KAAG,mBAIvB,CAAC"}

package/dist/__tests__/__mocks__/mockGenericResponse.js

@@ -0,0 +1,9 @@
+export var mockGenericResponse = function (_a) {
+    var _b = _a.name, name = _b === void 0 ? 'test' : _b, _c = _a.description, description = _c === void 0 ? 'test' : _c, _d = _a.id, id = _d === void 0 ? '1' : _d;
+    return ({
+        name: name,
+        description: description,
+        id: id,
+    });
+};
+//# sourceMappingURL=mockGenericResponse.js.map

package/dist/__tests__/__mocks__/mockGenericResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mockGenericResponse.js","sourceRoot":"","sources":["../../../__tests__/__mocks__/mockGenericResponse.ts"],"names":[],"mappings":"AAMA,MAAM,CAAC,IAAM,mBAAmB,GAAG,UAAC,EAId;QAHpB,YAAa,EAAb,IAAI,mBAAG,MAAM,KAAA,EACb,mBAAoB,EAApB,WAAW,mBAAG,MAAM,KAAA,EACpB,UAAQ,EAAR,EAAE,mBAAG,GAAG,KAAA;IACsC,OAAA,CAAC;QAC/C,IAAI,MAAA;QACJ,WAAW,aAAA;QACX,EAAE,IAAA;KACH,CAAC;AAJ8C,CAI9C,CAAC"}

package/dist/__tests__/__mocks__/styleMock.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=styleMock.d.ts.map

package/dist/__tests__/__mocks__/styleMock.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"styleMock.d.ts","sourceRoot":"","sources":["../../../__tests__/__mocks__/styleMock.js"],"names":[],"mappings":""}

package/dist/__tests__/__mocks__/styleMock.js

@@ -0,0 +1,3 @@
+"use strict";
+module.exports = {};
+//# sourceMappingURL=styleMock.js.map

package/dist/__tests__/__mocks__/styleMock.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"styleMock.js","sourceRoot":"","sources":["../../../__tests__/__mocks__/styleMock.js"],"names":[],"mappings":";AAAA,MAAM,CAAC,OAAO,GAAG,EAAE,CAAC"}

package/dist/__tests__/unit/jest.setup.d.ts

@@ -0,0 +1,2 @@
+import 'core-js/actual/array/to-sorted';
+//# sourceMappingURL=jest.setup.d.ts.map

package/dist/__tests__/unit/jest.setup.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"jest.setup.d.ts","sourceRoot":"","sources":["../../../__tests__/unit/jest.setup.ts"],"names":[],"mappings":"AAEA,OAAO,gCAAgC,CAAC"}

package/dist/__tests__/unit/jest.setup.js

@@ -0,0 +1,57 @@
+import { __assign } from "tslib";
+import { TextEncoder } from 'util';
+import 'core-js/actual/array/to-sorted';
+import { createComparativeValue, } from '../../__tests__/unit/testUtils/hooks';
+global.TextEncoder = TextEncoder;
+var tryExpect = function (expectFn) {
+    try {
+        expectFn();
+    }
+    catch (e) {
+        var matcherResult_1 = e.matcherResult;
+        if (matcherResult_1) {
+            return __assign(__assign({}, matcherResult_1), { message: function () { return matcherResult_1.message; } });
+        }
+        throw e;
+    }
+    return {
+        pass: true,
+        message: function () { return ''; },
+    };
+};
+expect.extend({
+    // custom asymmetric matchers
+    /**
+     * Checks that a value is what you expect.
+     * It uses Object.is to check strict equality.
+     *
+     * Usage:
+     * expect.isIdentifyEqual(...)
+     */
+    isIdentityEqual: function (actual, expected) { return ({
+        pass: Object.is(actual, expected),
+        message: function () { return "expected ".concat(actual, " to be identity equal to ").concat(expected); },
+    }); },
+    // hook related custom matchers
+    hookToBe: function (actual, expected) {
+        return tryExpect(function () { return expect(actual.result.current).toBe(expected); });
+    },
+    hookToStrictEqual: function (actual, expected) {
+        return tryExpect(function () { return expect(actual.result.current).toStrictEqual(expected); });
+    },
+    hookToHaveUpdateCount: function (actual, expected) {
+        return tryExpect(function () { return expect(actual.getUpdateCount()).toBe(expected); });
+    },
+    hookToBeStable: function (actual, expected) {
+        if (actual.getUpdateCount() <= 1) {
+            throw new Error('Cannot assert stability as the hook has not run at least 2 times.');
+        }
+        if (typeof expected === 'undefined') {
+            return tryExpect(function () { return expect(actual.result.current).toBe(actual.getPreviousResult()); });
+        }
+        return tryExpect(function () {
+            return expect(actual.result.current).toStrictEqual(createComparativeValue(actual.getPreviousResult(), expected));
+        });
+    },
+});
+//# sourceMappingURL=jest.setup.js.map

package/dist/__tests__/unit/jest.setup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jest.setup.js","sourceRoot":"","sources":["../../../__tests__/unit/jest.setup.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,MAAM,CAAC;AAEnC,OAAO,gCAAgC,CAAC;AACxC,OAAO,EAGL,sBAAsB,GACvB,MAAM,kCAAkC,CAAC;AAE1C,MAAM,CAAC,WAAW,GAAG,WAAW,CAAC;AAEjC,IAAM,SAAS,GAAG,UAAC,QAAoB;IACrC,IAAI,CAAC;QACH,QAAQ,EAAE,CAAC;IACb,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACH,IAAA,eAAa,GAAK,CAAuB,cAA5B,CAA6B;QAClD,IAAI,eAAa,EAAE,CAAC;YAClB,6BAAY,eAAa,KAAE,OAAO,EAAE,cAAM,OAAA,eAAa,CAAC,OAAO,EAArB,CAAqB,IAAG;QACpE,CAAC;QACD,MAAM,CAAC,CAAC;IACV,CAAC;IACD,OAAO;QACL,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,cAAM,OAAA,EAAE,EAAF,CAAE;KAClB,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,CAAC;IACZ,6BAA6B;IAE7B;;;;;;OAMG;IACH,eAAe,EAAE,UAAC,MAAM,EAAE,QAAQ,IAAK,OAAA,CAAC;QACtC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC;QACjC,OAAO,EAAE,cAAM,OAAA,mBAAY,MAAM,sCAA4B,QAAQ,CAAE,EAAxD,CAAwD;KACxE,CAAC,EAHqC,CAGrC;IAEF,+BAA+B;IAC/B,QAAQ,EAAE,UAAC,MAA6C,EAAE,QAAQ;QAChE,OAAA,SAAS,CAAC,cAAM,OAAA,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,EAA5C,CAA4C,CAAC;IAA7D,CAA6D;IAE/D,iBAAiB,EAAE,UAAC,MAA6C,EAAE,QAAQ;QACzE,OAAA,SAAS,CAAC,cAAM,OAAA,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CAAC,QAAQ,CAAC,EAArD,CAAqD,CAAC;IAAtE,CAAsE;IAExE,qBAAqB,EAAE,UAAC,MAA6C,EAAE,QAAgB;QACrF,OAAA,SAAS,CAAC,cAAM,OAAA,MAAM,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,EAA9C,CAA8C,CAAC;IAA/D,CAA+D;IAEjE,cAAc,EAAE,UAAI,MAAuC,EAAE,QAA2B;QACtF,IAAI,MAAM,CAAC,cAAc,EAAE,IAAI,CAAC,EAAE,CAAC;YACjC,MAAM,IAAI,KAAK,CAAC,mEAAmE,CAAC,CAAC;QACvF,CAAC;QACD,IAAI,OAAO,QAAQ,KAAK,WAAW,EAAE,CAAC;YACpC,OAAO,SAAS,CAAC,cAAM,OAAA,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE,CAAC,EAA9D,CAA8D,CAAC,CAAC;QACzF,CAAC;QACD,OAAO,SAAS,CAAC;YACf,OAAA,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,CACzC,sBAAsB,CAAC,MAAM,CAAC,iBAAiB,EAAE,EAAE,QAAQ,CAAC,CAC7D;QAFD,CAEC,CACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC"}

package/dist/__tests__/unit/testUtils/hooks.d.ts

@@ -0,0 +1,80 @@
+import { RenderHookOptions, RenderHookResult, waitForOptions } from '@testing-library/react';
+import { queries, Queries } from '@testing-library/dom';
+export type BooleanValues<T> = T extends boolean | number | null | undefined | Function ? boolean | undefined : boolean | undefined | {
+    [K in keyof T]?: BooleanValues<T[K]>;
+};
+/**
+ * Extension of RTL RenderHookResult providing functions used query the current state of the result.
+ */
+export type RenderHookResultExt<Result, Props> = RenderHookResult<Result, Props> & {
+    /**
+     * Returns the previous result.
+     */
+    getPreviousResult: () => Result;
+    /**
+     * Get the update count for how many times the hook has been rendered.
+     * An update occurs initially on render, subsequently when re-rendered, and also whenever the hook itself triggers a re-render.
+     * eg. An `useEffect` triggering a state update.
+     */
+    getUpdateCount: () => number;
+    /**
+     * Returns a Promise that resolves the next time the hook renders, commonly when state is updated as the result of an asynchronous update.
+     *
+     * Since `waitForNextUpdate` works using interval checks (backed by `waitFor`), it's possible that multiple updates may occur while waiting.
+     */
+    waitForNextUpdate: (options?: Pick<waitForOptions, 'interval' | 'timeout'>) => Promise<void>;
+};
+/**
+ * Wrapper on top of RTL `renderHook` returning a result that implements the `RenderHookResultExt` interface.
+ *
+ * `renderHook` provides full control over the rendering of your hook including the ability to wrap the test component.
+ * This is usually used to add context providers from `React.createContext` for the hook to access with `useContext`.
+ * `initialProps` and props subsequently set by `rerender` will be provided to the wrapper.
+ *
+ * ```
+ * const renderResult = renderHook(({ who }: { who: string }) => useSayHello(who), { initialProps: { who: 'world' }});
+ * expect(renderResult).hookToBe('Hello world!');
+ * renderResult.rerender({ who: 'there' });
+ * expect(renderResult).hookToBe('Hello there!');
+ * ```
+ */
+export declare const renderHook: <Result, Props, Q extends Queries = typeof queries, Container extends Element | DocumentFragment = HTMLElement, BaseElement extends Element | DocumentFragment = Container>(render: (initialProps: Props) => Result, options?: RenderHookOptions<Props, Q, Container, BaseElement>) => RenderHookResultExt<Result, Props>;
+/**
+ * Lightweight API for testing a single hook.
+ *
+ * Prefer this method of testing over `renderHook` for simplicity.
+ *
+ * ```
+ * const renderResult = testHook(useSayHello)('world');
+ * expectHook(renderResult).toBe('Hello world!');
+ * renderResult.rerender('there');
+ * expectHook(renderResult).toBe('Hello there!');
+ * ```
+ */
+export declare const testHook: <Result, P extends unknown[]>(hook: (...params: P) => Result) => (...initialParams: P) => Omit<RenderHookResultExt<Result, {
+    $params: typeof initialParams;
+}>, "rerender"> & {
+    rerender: (...params: typeof initialParams) => void;
+};
+/**
+ * A helper function for asserting the return value of hooks based on `useFetchState`.
+ *
+ * eg.
+ * ```
+ * expectHook(renderResult).isStrictEqual(standardUseFetchState('test value', true))
+ * ```
+ * is equivalent to:
+ * ```
+ * expectHook(renderResult).isStrictEqual(['test value', true, undefined, expect.any(Function)])
+ * ```
+ */
+export declare const standardUseFetchState: <D>(data: D, loaded?: boolean, error?: Error) => [data: D, loaded: boolean, loadError: Error | undefined, refresh: () => Promise<D | undefined>];
+/**
+ * Extracts a subset of values from the source that can be used to compare equality.
+ *
+ * Recursively traverses the `booleanTarget`. For every property or array index equal to `true`,
+ * adds the value of the source to the result wrapped in custom matcher `expect.isIdentityEqual`.
+ * If the entry is `false` or `undefined`, add an everything matcher to the result.
+ */
+export declare const createComparativeValue: <T>(source: T, booleanTarget: BooleanValues<T>) => unknown;
+//# sourceMappingURL=hooks.d.ts.map

package/dist/__tests__/unit/testUtils/hooks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hooks.d.ts","sourceRoot":"","sources":["../../../../__tests__/unit/testUtils/hooks.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,iBAAiB,EACjB,gBAAgB,EAEhB,cAAc,EACf,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAGxD,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI,CAAC,SAAS,OAAO,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,QAAQ,GACnF,OAAO,GAAG,SAAS,GACnB,OAAO,GAAG,SAAS,GAAG;KAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAAE,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,mBAAmB,CAAC,MAAM,EAAE,KAAK,IAAI,gBAAgB,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG;IACjF;;OAEG;IACH,iBAAiB,EAAE,MAAM,MAAM,CAAC;IAEhC;;;;OAIG;IACH,cAAc,EAAE,MAAM,MAAM,CAAC;IAE7B;;;;OAIG;IACH,iBAAiB,EAAE,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,EAAE,UAAU,GAAG,SAAS,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9F,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,UAAU,GACrB,MAAM,EACN,KAAK,EACL,CAAC,SAAS,OAAO,GAAG,OAAO,OAAO,EAClC,SAAS,SAAS,OAAO,GAAG,gBAAgB,GAAG,WAAW,EAC1D,WAAW,SAAS,OAAO,GAAG,gBAAgB,GAAG,SAAS,EAE1D,QAAQ,CAAC,YAAY,EAAE,KAAK,KAAK,MAAM,EACvC,UAAU,iBAAiB,CAAC,KAAK,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,CAAC,KAC5D,mBAAmB,CAAC,MAAM,EAAE,KAAK,CA8BnC,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,QAAQ,GAClB,MAAM,EAAE,CAAC,SAAS,OAAO,EAAE,EAAE,MAAM,CAAC,GAAG,MAAM,EAAE,CAAC,KAAK,MAAM,MAG1D,GAAG,eAAe,CAAC,KAClB,IAAI,CAAC,mBAAmB,CAAC,MAAM,EAAE;IAAE,OAAO,EAAE,OAAO,aAAa,CAAA;CAAE,CAAC,EAAE,UAAU,CAAC,GAAG;IACpF,QAAQ,EAAE,CAAC,GAAG,MAAM,EAAE,OAAO,aAAa,KAAK,IAAI,CAAC;CAerD,CAAC;AAEJ;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,qBAAqB,GAAI,CAAC,EACrC,MAAM,CAAC,EACP,gBAAc,EACd,QAAQ,KAAK,KACZ,CACD,IAAI,EAAE,CAAC,EACP,MAAM,EAAE,OAAO,EACf,SAAS,EAAE,KAAK,GAAG,SAAS,EAC5B,OAAO,EAAE,MAAM,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,CACS,CAAC;AASjD;;;;;;GAMG;AACH,eAAO,MAAM,sBAAsB,GAAI,CAAC,EAAE,QAAQ,CAAC,EAAE,eAAe,aAAa,CAAC,CAAC,CAAC,KAAG,OAC/B,CAAC"}

package/dist/__tests__/unit/testUtils/hooks.js

@@ -0,0 +1,149 @@
+import { __assign, __awaiter, __generator, __read, __spreadArray } from "tslib";
+import { renderHook as renderHookRTL, waitFor, } from '@testing-library/react';
+/**
+ * Wrapper on top of RTL `renderHook` returning a result that implements the `RenderHookResultExt` interface.
+ *
+ * `renderHook` provides full control over the rendering of your hook including the ability to wrap the test component.
+ * This is usually used to add context providers from `React.createContext` for the hook to access with `useContext`.
+ * `initialProps` and props subsequently set by `rerender` will be provided to the wrapper.
+ *
+ * ```
+ * const renderResult = renderHook(({ who }: { who: string }) => useSayHello(who), { initialProps: { who: 'world' }});
+ * expect(renderResult).hookToBe('Hello world!');
+ * renderResult.rerender({ who: 'there' });
+ * expect(renderResult).hookToBe('Hello there!');
+ * ```
+ */
+export var renderHook = function (render, options) {
+    var updateCount = 0;
+    var prevResult;
+    var currentResult;
+    var renderResult = renderHookRTL(function (props) {
+        updateCount++;
+        prevResult = currentResult;
+        currentResult = render(props);
+        return currentResult;
+    }, options);
+    var renderResultExt = __assign(__assign({}, renderResult), { getPreviousResult: function () { return (updateCount > 1 ? prevResult : renderResult.result.current); }, getUpdateCount: function () { return updateCount; }, waitForNextUpdate: function (currentOptions) { return __awaiter(void 0, void 0, void 0, function () {
+            var expected, _a;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        expected = updateCount;
+                        _b.label = 1;
+                    case 1:
+                        _b.trys.push([1, 3, , 4]);
+                        return [4 /*yield*/, waitFor(function () { return expect(updateCount).toBeGreaterThan(expected); }, currentOptions)];
+                    case 2:
+                        _b.sent();
+                        return [3 /*break*/, 4];
+                    case 3:
+                        _a = _b.sent();
+                        throw new Error('waitForNextUpdate timed out');
+                    case 4: return [2 /*return*/];
+                }
+            });
+        }); } });
+    return renderResultExt;
+};
+/**
+ * Lightweight API for testing a single hook.
+ *
+ * Prefer this method of testing over `renderHook` for simplicity.
+ *
+ * ```
+ * const renderResult = testHook(useSayHello)('world');
+ * expectHook(renderResult).toBe('Hello world!');
+ * renderResult.rerender('there');
+ * expectHook(renderResult).toBe('Hello there!');
+ * ```
+ */
+export var testHook = function (hook) {
+    // not ideal to nest functions in terms of API but cannot find a better way to infer P from hook and not initialParams
+    return function () {
+        var initialParams = [];
+        for (var _i = 0; _i < arguments.length; _i++) {
+            initialParams[_i] = arguments[_i];
+        }
+        var renderResult = renderHook(function (_a) {
+            var $params = _a.$params;
+            return hook.apply(void 0, __spreadArray([], __read($params), false));
+        }, {
+            initialProps: {
+                $params: initialParams,
+            },
+        });
+        return __assign(__assign({}, renderResult), { rerender: function () {
+                var params = [];
+                for (var _i = 0; _i < arguments.length; _i++) {
+                    params[_i] = arguments[_i];
+                }
+                return renderResult.rerender({ $params: params });
+            } });
+    };
+};
+/**
+ * A helper function for asserting the return value of hooks based on `useFetchState`.
+ *
+ * eg.
+ * ```
+ * expectHook(renderResult).isStrictEqual(standardUseFetchState('test value', true))
+ * ```
+ * is equivalent to:
+ * ```
+ * expectHook(renderResult).isStrictEqual(['test value', true, undefined, expect.any(Function)])
+ * ```
+ */
+export var standardUseFetchState = function (data, loaded, error) {
+    if (loaded === void 0) { loaded = false; }
+    return [data, loaded, error, expect.any(Function)];
+};
+// create a new asymmetric matcher that matches everything
+var everything = function () {
+    var r = expect.anything();
+    r.asymmetricMatch = function () { return true; };
+    return r;
+};
+/**
+ * Extracts a subset of values from the source that can be used to compare equality.
+ *
+ * Recursively traverses the `booleanTarget`. For every property or array index equal to `true`,
+ * adds the value of the source to the result wrapped in custom matcher `expect.isIdentityEqual`.
+ * If the entry is `false` or `undefined`, add an everything matcher to the result.
+ */
+export var createComparativeValue = function (source, booleanTarget) {
+    return createComparativeValueRecursive(source, booleanTarget);
+};
+var createComparativeValueRecursive = function (source, 
+// eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
+booleanTarget) {
+    if (typeof booleanTarget === 'boolean') {
+        return booleanTarget ? expect.isIdentityEqual(source) : everything();
+    }
+    if (Array.isArray(booleanTarget)) {
+        if (Array.isArray(source)) {
+            var r_1 = new Array(source.length).fill(everything());
+            booleanTarget.forEach(function (b, i) {
+                if (b != null) {
+                    r_1[i] = createComparativeValueRecursive(source[i], b);
+                }
+            });
+            return r_1;
+        }
+        return undefined;
+    }
+    if (source == null ||
+        typeof source === 'string' ||
+        typeof source === 'number' ||
+        typeof source === 'function') {
+        return source;
+    }
+    var obj = {};
+    var btObj = booleanTarget;
+    Object.keys(btObj).forEach(function (key) {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        obj[key] = createComparativeValueRecursive(source[key], btObj[key]);
+    });
+    return expect.objectContaining(obj);
+};
+//# sourceMappingURL=hooks.js.map