@trackunit/react-core-contexts-test 0.1.26 → 0.1.28

package/index.js

@@ -1,4 +1,4 @@
-export { M as MockContextProviderBuilder, d as doNothing, f as flushPromises, b as flushPromisesInAct, m as mockCurrentUserContext, a as mockEnvironmentContext, q as queryFor, r as rootContext } from './index2.js';
+export { M as MockContextProviderBuilder, d as doNothing, f as flushPromises, b as flushPromisesInAct, m as mockCurrentUserContext, a as mockEnvironmentContext, q as queryFor, r as rootContext, v as validateIrisApp } from './index2.js';
 import 'react/jsx-runtime';
 import '@testing-library/react';
 import '@trackunit/react-core-contexts-api';

package/index2.js

@@ -369,4 +369,41 @@ const queryFor = (document, variables, data, error) => {
     };
 };
 
-export { MockContextProviderBuilder as M, __awaiter as _, mockEnvironmentContext as a, flushPromisesInAct as b, doNothing as d, flushPromises as f, mockCurrentUserContext as m, queryFor as q, rootContext as r };
+/**
+ * This helps validate the IrisApp is exposed correctly it must expose:
+ * - bootstrap
+ * - mount
+ * - unmount
+ * According to the single spa spec.
+ *
+ * Your test could look like this
+ * @example
+ * import * as IrisApp from "./index";
+    describe("App", () => {
+      it("Should validate", async () => {
+        const result = await validateIrisApp(IrisApp);
+        expect(result).toBeNull();
+      });
+    });
+ *
+ * @param irisApp Import the index ts(x) file as above and pass it in.
+ * @returns null if everything is good - otherwise a string telling you what is wrong.
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const validateIrisApp = (irisApp) => __awaiter(void 0, void 0, void 0, function* () {
+    if (!irisApp.bootstrap || typeof irisApp.bootstrap !== "function") {
+        return "Missing a bootstrap function";
+    }
+    if (!irisApp.mount || typeof irisApp.mount !== "function") {
+        return "Missing a mount function";
+    }
+    if (!irisApp.unmount || typeof irisApp.unmount !== "function") {
+        return "Missing an unmount function";
+    }
+    if (irisApp.update && typeof irisApp.update !== "function") {
+        return "Update must be a function";
+    }
+    return null;
+});
+
+export { MockContextProviderBuilder as M, __awaiter as _, mockEnvironmentContext as a, flushPromisesInAct as b, doNothing as d, flushPromises as f, mockCurrentUserContext as m, queryFor as q, rootContext as r, validateIrisApp as v };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-core-contexts-test",
-  "version": "0.1.26",
+  "version": "0.1.28",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "module": "./index.js",
@@ -11,7 +11,7 @@
     "@apollo/client": "3.6.9",
     "react": "18.2.0",
     "@trackunit/react-core-contexts-api": "0.2.14",
-    "@trackunit/react-core-hooks": "0.2.25",
+    "@trackunit/react-core-hooks": "0.2.26",
     "@trackunit/tailwind-styled-components": "0.0.53",
     "react-router-dom": "6.4.5",
     "graphql": "15.8.0"

package/src/index.d.ts

@@ -3,4 +3,5 @@ export * from "./mocks/mockCurrentUserContext";
 export * from "./mocks/mockEnvironmentContext";
 export * from "./utils/doNothing";
 export * from "./utils/queryFor";
+export * from "./utils/validateIrisApp";
 export * from "./utils/wait";

package/src/utils/validateIrisApp.d.ts

@@ -0,0 +1,21 @@
+/**
+ * This helps validate the IrisApp is exposed correctly it must expose:
+ * - bootstrap
+ * - mount
+ * - unmount
+ * According to the single spa spec.
+ *
+ * Your test could look like this
+ * @example
+ * import * as IrisApp from "./index";
+    describe("App", () => {
+      it("Should validate", async () => {
+        const result = await validateIrisApp(IrisApp);
+        expect(result).toBeNull();
+      });
+    });
+ *
+ * @param irisApp Import the index ts(x) file as above and pass it in.
+ * @returns null if everything is good - otherwise a string telling you what is wrong.
+ */
+export declare const validateIrisApp: (irisApp: any) => Promise<"Missing a bootstrap function" | "Missing a mount function" | "Missing an unmount function" | "Update must be a function" | null>;