@interface-technologies/check-for-js-bundle-update-saga 2.0.0-alpha.7 → 4.0.0-alpha.0

package/LICENSE

@@ -1,7 +1,7 @@
-Copyright 2018 Interface Technologies, Inc.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
+Copyright 2018 Interface Technologies, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1 +1 @@
-See https://srmagura.github.io/iti-react/.
+See https://srmagura.github.io/iti-react/.

package/dist/checkForJsBundleUpdateSaga.d.ts

@@ -0,0 +1,65 @@
+import moment from 'moment-timezone';
+import { SagaIterator } from 'redux-saga';
+/** @internal */
+export declare function getIndexHtml(): Promise<string | undefined>;
+/** @internal */
+export declare function reload(): void;
+export interface CheckForJsBundleUpdateSagaOptions {
+    delayDuration?: moment.Duration;
+    onError(e: unknown): void;
+}
+/**
+ * Peridoically fetches `/` (`index.html`) to check if a new JavaScript bundle has been
+ * released.
+ *
+ * If the bundle has been updated, the user is prompted to refresh the page.
+ * After 3 alerts are shown, the page is forcibly refreshed.
+ *
+ * Don't enable this in development!
+ *
+ * Your `index.html` must contain a hidden element with the ID `jsBundleHash` that
+ * contains a hash of the JavaScript bundle's entry point. Here's how to do this
+ * in ASP.NET Core:
+ *
+ * ```razor
+ * var path = $"dist/{bundleName}.js";
+ * string jsBundleHash;
+ *
+ * using (var sha256 = SHA256.Create())
+ * {
+ *     var fullPath = System.IO.Path.Combine("wwwroot", path);
+ *     using (var readStream = File.OpenRead(fullPath))
+ *     {
+ *         var hashBytes = sha256.ComputeHash(readStream);
+ *         jsBundleHash = WebEncoders.Base64UrlEncode(hashBytes);
+ *     }
+ * }
+ *
+ * <script src=@path asp-append-version="true"></script>
+ * <span id="jsBundleHash" style="display: none">
+ *     @jsBundleHash
+ * </span>
+ * ```
+ *
+ * And example of using `checkForJsBundleUpdateSaga` from your TypeScript code:
+ *
+ * ```
+ * export function* myCheckForJsBundleUpdateSaga(): SagaIterator<void> {
+ *     if (process.env.NODE_ENV === 'development') return
+ *
+ *     function onError(e: unknown): void {
+ *         console.error(e)
+ *
+ *         const ierror = processError(e)
+ *
+ *         // Never show the user an error because of this
+ *         if (shouldLogError(ierror)) {
+ *             Bugsnag.notify(ierror)
+ *         }
+ *     }
+ *
+ *     yield call(checkForJsBundleUpdateSaga, { onError })
+ * }
+ * ```
+ */
+export declare function checkForJsBundleUpdateSaga({ delayDuration, onError, }: CheckForJsBundleUpdateSagaOptions): SagaIterator<void>;

package/dist/checkForJsBundleUpdateSaga.js

@@ -0,0 +1,127 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkForJsBundleUpdateSaga = exports.reload = exports.getIndexHtml = void 0;
+const react_1 = __importDefault(require("react"));
+const moment_timezone_1 = __importDefault(require("moment-timezone"));
+const effects_1 = require("redux-saga/effects");
+const iti_react_1 = require("@interface-technologies/iti-react");
+const hashElementId = 'jsBundleHash';
+const defaultDelayDuration = moment_timezone_1.default.duration(4, 'minutes');
+const forceRefreshAfterAlertCount = 3;
+/** @internal */
+function getIndexHtml() {
+    return (fetch('/')
+        .then((response) => {
+        if (!response.ok)
+            return undefined;
+        return response.text();
+    })
+        // If fetch throws a TypeError for some weird reason, also return undefined
+        .catch(() => undefined));
+}
+exports.getIndexHtml = getIndexHtml;
+/** @internal */
+function reload() {
+    window.location.reload();
+}
+exports.reload = reload;
+/**
+ * Peridoically fetches `/` (`index.html`) to check if a new JavaScript bundle has been
+ * released.
+ *
+ * If the bundle has been updated, the user is prompted to refresh the page.
+ * After 3 alerts are shown, the page is forcibly refreshed.
+ *
+ * Don't enable this in development!
+ *
+ * Your `index.html` must contain a hidden element with the ID `jsBundleHash` that
+ * contains a hash of the JavaScript bundle's entry point. Here's how to do this
+ * in ASP.NET Core:
+ *
+ * ```razor
+ * var path = $"dist/{bundleName}.js";
+ * string jsBundleHash;
+ *
+ * using (var sha256 = SHA256.Create())
+ * {
+ *     var fullPath = System.IO.Path.Combine("wwwroot", path);
+ *     using (var readStream = File.OpenRead(fullPath))
+ *     {
+ *         var hashBytes = sha256.ComputeHash(readStream);
+ *         jsBundleHash = WebEncoders.Base64UrlEncode(hashBytes);
+ *     }
+ * }
+ *
+ * <script src=@path asp-append-version="true"></script>
+ * <span id="jsBundleHash" style="display: none">
+ *     @jsBundleHash
+ * </span>
+ * ```
+ *
+ * And example of using `checkForJsBundleUpdateSaga` from your TypeScript code:
+ *
+ * ```
+ * export function* myCheckForJsBundleUpdateSaga(): SagaIterator<void> {
+ *     if (process.env.NODE_ENV === 'development') return
+ *
+ *     function onError(e: unknown): void {
+ *         console.error(e)
+ *
+ *         const ierror = processError(e)
+ *
+ *         // Never show the user an error because of this
+ *         if (shouldLogError(ierror)) {
+ *             Bugsnag.notify(ierror)
+ *         }
+ *     }
+ *
+ *     yield call(checkForJsBundleUpdateSaga, { onError })
+ * }
+ * ```
+ */
+function* checkForJsBundleUpdateSaga({ delayDuration = defaultDelayDuration, onError, }) {
+    var _a, _b, _c;
+    const jsBundleHash = (_b = (_a = document.getElementById(hashElementId)) === null || _a === void 0 ? void 0 : _a.innerText) === null || _b === void 0 ? void 0 : _b.trim();
+    if (!jsBundleHash) {
+        onError(new Error('Could not get jsBundleHash.'));
+        return;
+    }
+    yield (0, effects_1.delay)(delayDuration.asMilliseconds());
+    let alertShownCount = 0;
+    for (;;) {
+        try {
+            const indexHtml = (yield (0, effects_1.call)(getIndexHtml));
+            if (indexHtml) {
+                const document = new DOMParser().parseFromString(indexHtml, 'text/html');
+                const hashEl = document.getElementById(hashElementId);
+                if (hashEl) {
+                    // innerText doesn't work here for some reason
+                    const newJsBundleHash = (_c = hashEl.innerHTML) === null || _c === void 0 ? void 0 : _c.trim();
+                    if (jsBundleHash !== newJsBundleHash) {
+                        const content = (react_1.default.createElement("div", null,
+                            react_1.default.createElement("p", null, "Please save your work and refresh the page."),
+                            react_1.default.createElement("p", { className: "mb-0" }, "You may encounter errors if you do not refresh the page.")));
+                        if (alertShownCount >= forceRefreshAfterAlertCount) {
+                            window.onbeforeunload = null;
+                            yield (0, effects_1.call)(reload);
+                            return;
+                        }
+                        yield (0, effects_1.call)(iti_react_1.alert, content, { title: 'Website Update Available!' });
+                        alertShownCount += 1;
+                    }
+                }
+                else {
+                    onError(new Error('Could not get jsBundleHash in fetched document.'));
+                }
+            }
+        }
+        catch (e) {
+            onError(e);
+        }
+        yield (0, effects_1.delay)(delayDuration.asMilliseconds());
+    }
+}
+exports.checkForJsBundleUpdateSaga = checkForJsBundleUpdateSaga;

package/dist/checkForJsBundleUpdateSaga.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"checkForJsBundleUpdateSaga.js","sourceRoot":"","sources":["../src/checkForJsBundleUpdateSaga.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,MAAM,MAAM,iBAAiB,CAAA;AAEpC,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAA;AAChD,OAAO,EAAE,KAAK,EAAE,MAAM,mCAAmC,CAAA;AAEzD,MAAM,aAAa,GAAG,cAAc,CAAA;AACpC,MAAM,oBAAoB,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,SAAS,CAAC,CAAA;AAC1D,MAAM,2BAA2B,GAAG,CAAC,CAAA;AAErC,gBAAgB;AAChB,MAAM,UAAU,YAAY;IACxB,OAAO,CACH,KAAK,CAAC,GAAG,CAAC;SACL,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;QACf,IAAI,CAAC,QAAQ,CAAC,EAAE;YAAE,OAAO,SAAS,CAAA;QAElC,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAA;IAC1B,CAAC,CAAC;QACF,2EAA2E;SAC1E,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAC9B,CAAA;AACL,CAAC;AAED,gBAAgB;AAChB,MAAM,UAAU,MAAM;IAClB,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAA;AAC5B,CAAC;AAOD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqDG;AACH,MAAM,SAAS,CAAC,CAAC,0BAA0B,CAAC,EACxC,aAAa,GAAG,oBAAoB,EACpC,OAAO,GACyB;;IAChC,MAAM,YAAY,GAAG,MAAA,MAAA,QAAQ,CAAC,cAAc,CAAC,aAAa,CAAC,0CAAE,SAAS,0CAAE,IAAI,EAAE,CAAA;IAE9E,IAAI,CAAC,YAAY,EAAE;QACf,OAAO,CAAC,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC,CAAA;QACjD,OAAM;KACT;IAED,MAAM,KAAK,CAAC,aAAa,CAAC,cAAc,EAAE,CAAC,CAAA;IAE3C,IAAI,eAAe,GAAG,CAAC,CAAA;IAEvB,SAAS;QACL,IAAI;YACA,MAAM,SAAS,GAAG,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,CAAuB,CAAA;YAClE,IAAI,SAAS,EAAE;gBACX,MAAM,QAAQ,GAAG,IAAI,SAAS,EAAE,CAAC,eAAe,CAAC,SAAS,EAAE,WAAW,CAAC,CAAA;gBACxE,MAAM,MAAM,GAAG,QAAQ,CAAC,cAAc,CAAC,aAAa,CAAC,CAAA;gBAErD,IAAI,MAAM,EAAE;oBACR,8CAA8C;oBAC9C,MAAM,eAAe,GAAG,MAAA,MAAM,CAAC,SAAS,0CAAE,IAAI,EAAE,CAAA;oBAEhD,IAAI,YAAY,KAAK,eAAe,EAAE;wBAClC,MAAM,OAAO,GAAG,CACZ;4BACI,6EAAkD;4BAClD,2BAAG,SAAS,EAAC,MAAM,+DAGf,CACF,CACT,CAAA;wBAED,IAAI,eAAe,IAAI,2BAA2B,EAAE;4BAChD,MAAM,CAAC,cAAc,GAAG,IAAI,CAAA;4BAC5B,MAAM,IAAI,CAAC,MAAM,CAAC,CAAA;4BAClB,OAAM;yBACT;wBAED,MAAM,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,2BAA2B,EAAE,CAAC,CAAA;wBAClE,eAAe,IAAI,CAAC,CAAA;qBACvB;iBACJ;qBAAM;oBACH,OAAO,CAAC,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC,CAAA;iBACxE;aACJ;SACJ;QAAC,OAAO,CAAC,EAAE;YACR,OAAO,CAAC,CAAC,CAAC,CAAA;SACb;QAED,MAAM,KAAK,CAAC,aAAa,CAAC,cAAc,EAAE,CAAC,CAAA;KAC9C;AACL,CAAC"}

package/dist/checkForJsBundleUpdateSaga.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/checkForJsBundleUpdateSaga.test.js

@@ -0,0 +1,65 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const moment_timezone_1 = __importDefault(require("moment-timezone"));
+const redux_saga_test_plan_1 = require("redux-saga-test-plan");
+const effects_1 = require("redux-saga/effects");
+const iti_react_1 = require("@interface-technologies/iti-react");
+const checkForJsBundleUpdateSaga_1 = require("./checkForJsBundleUpdateSaga");
+jest.mock('@interface-technologies/iti-react');
+// Mock window.location.reload since it not implemented in jsdom
+// eslint-disable-next-line
+delete window.location;
+window.location = { reload: jest.fn() };
+const jsBundleHash = 'hash0';
+const newJsBundleHash = 'hash1';
+beforeEach(() => {
+    jest.useRealTimers();
+    const jsBundleHashElement = document.createElement('span');
+    jsBundleHashElement.innerText = jsBundleHash;
+    jsBundleHashElement.id = 'jsBundleHash';
+    document.body.appendChild(jsBundleHashElement);
+});
+function getHtml(hash) {
+    return `
+<html>
+<head></head>
+<body>
+    <span id="jsBundleHash">${hash}</span>
+</body>
+</html>
+`;
+}
+const delayDuration = moment_timezone_1.default.duration(0, 'seconds');
+it('does not show alert if hash matches', async () => {
+    const onError = jest.fn();
+    await (0, redux_saga_test_plan_1.expectSaga)(checkForJsBundleUpdateSaga_1.checkForJsBundleUpdateSaga, { delayDuration, onError })
+        .provide([[(0, effects_1.call)(checkForJsBundleUpdateSaga_1.getIndexHtml), getHtml(jsBundleHash)]])
+        .not.call.fn(iti_react_1.alert)
+        .not.call.fn(checkForJsBundleUpdateSaga_1.reload)
+        .silentRun();
+    expect(onError).not.toHaveBeenCalled();
+});
+it('does not call onError if getIndexHtml returns undefined', async () => {
+    const onError = jest.fn();
+    await (0, redux_saga_test_plan_1.expectSaga)(checkForJsBundleUpdateSaga_1.checkForJsBundleUpdateSaga, { delayDuration, onError })
+        .provide([[(0, effects_1.call)(checkForJsBundleUpdateSaga_1.getIndexHtml), undefined]])
+        .not.call.fn(iti_react_1.alert)
+        .not.call.fn(checkForJsBundleUpdateSaga_1.reload)
+        .silentRun();
+    expect(onError).not.toHaveBeenCalled();
+});
+it('shows alert several times and then refreshes page', async () => {
+    const onError = jest.fn((e) => console.error(e));
+    await (0, redux_saga_test_plan_1.expectSaga)(checkForJsBundleUpdateSaga_1.checkForJsBundleUpdateSaga, { delayDuration, onError })
+        .provide([[(0, effects_1.call)(checkForJsBundleUpdateSaga_1.getIndexHtml), getHtml(newJsBundleHash)]])
+        .call.fn(iti_react_1.alert)
+        .call.fn(iti_react_1.alert)
+        .call.fn(iti_react_1.alert)
+        .call(checkForJsBundleUpdateSaga_1.reload)
+        .run();
+    expect(onError).not.toHaveBeenCalled();
+    expect(window.location.reload).toHaveBeenCalled();
+});

package/dist/checkForJsBundleUpdateSaga.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"checkForJsBundleUpdateSaga.test.js","sourceRoot":"","sources":["../src/checkForJsBundleUpdateSaga.test.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,iBAAiB,CAAA;AACpC,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACjD,OAAO,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAA;AACzC,OAAO,EAAE,KAAK,EAAE,MAAM,mCAAmC,CAAA;AACzD,OAAO,EACH,YAAY,EACZ,0BAA0B,EAC1B,MAAM,GACT,MAAM,8BAA8B,CAAA;AAErC,IAAI,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAA;AAE9C,gEAAgE;AAChE,2BAA2B;AAC3B,OAAQ,MAAc,CAAC,QAAQ,CAAA;AAC/B,MAAM,CAAC,QAAQ,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE,EAAyB,CAAA;AAE9D,MAAM,YAAY,GAAG,OAAO,CAAA;AAC5B,MAAM,eAAe,GAAG,OAAO,CAAA;AAE/B,UAAU,CAAC,GAAG,EAAE;IACZ,IAAI,CAAC,aAAa,EAAE,CAAA;IAEpB,MAAM,mBAAmB,GAAG,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,CAAA;IAC1D,mBAAmB,CAAC,SAAS,GAAG,YAAY,CAAA;IAC5C,mBAAmB,CAAC,EAAE,GAAG,cAAc,CAAA;IACvC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,mBAAmB,CAAC,CAAA;AAClD,CAAC,CAAC,CAAA;AAEF,SAAS,OAAO,CAAC,IAAY;IACzB,OAAO;;;;8BAImB,IAAI;;;CAGjC,CAAA;AACD,CAAC;AAED,MAAM,aAAa,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,SAAS,CAAC,CAAA;AAEnD,EAAE,CAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE;IACjD,MAAM,OAAO,GAAG,IAAI,CAAC,EAAE,EAAE,CAAA;IAEzB,MAAM,UAAU,CAAC,0BAA0B,EAAE,EAAE,aAAa,EAAE,OAAO,EAAE,CAAC;SACnE,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;SACtD,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC;SAClB,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC;SACnB,SAAS,EAAE,CAAA;IAEhB,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAA;AAC1C,CAAC,CAAC,CAAA;AAEF,EAAE,CAAC,yDAAyD,EAAE,KAAK,IAAI,EAAE;IACrE,MAAM,OAAO,GAAG,IAAI,CAAC,EAAE,EAAE,CAAA;IAEzB,MAAM,UAAU,CAAC,0BAA0B,EAAE,EAAE,aAAa,EAAE,OAAO,EAAE,CAAC;SACnE,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC;SAC1C,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC;SAClB,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC;SACnB,SAAS,EAAE,CAAA;IAEhB,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAA;AAC1C,CAAC,CAAC,CAAA;AAEF,EAAE,CAAC,mDAAmD,EAAE,KAAK,IAAI,EAAE;IAC/D,MAAM,OAAO,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;IAEhD,MAAM,UAAU,CAAC,0BAA0B,EAAE,EAAE,aAAa,EAAE,OAAO,EAAE,CAAC;SACnE,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;SACzD,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC;SACd,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC;SACd,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC;SACd,IAAI,CAAC,MAAM,CAAC;SACZ,GAAG,EAAE,CAAA;IAEV,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAA;IACtC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,gBAAgB,EAAE,CAAA;AACrD,CAAC,CAAC,CAAA"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { checkForJsBundleUpdateSaga } from './checkForJsBundleUpdateSaga';
+export type { CheckForJsBundleUpdateSagaOptions } from './checkForJsBundleUpdateSaga';

package/dist/index.js

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

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAA"}

package/package.json

@@ -1,70 +1,39 @@
 {
   "name": "@interface-technologies/check-for-js-bundle-update-saga",
-  "version": "2.0.0-alpha.7",
+  "version": "4.0.0-alpha.0",
   "description": "Redux saga for checking if a JavaScript app has been deployed.",
-  "homepage": "https://bitbucket.org/itidev/iti.react",
+  "homepage": "https://github.com/srmagura/iti-react",
   "repository": {
     "type": "git",
-    "url": "git+https://bitbucket.org/itidev/iti.react.git"
+    "url": "git+https://github.com/srmagura/iti-react.git"
   },
   "license": "MIT",
   "author": "Interface Technologies, Inc.",
-  "main": "src/index.ts",
-  "scripts": {
-    "lint": "eslint",
-    "lint-staged": "lint-staged --no-stash",
-    "test": "jest",
-    "tsc": "tsc",
-    "prettier": "prettier"
-  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "typedocMain": "src/index.ts",
+  "files": [
+    "dist"
+  ],
+  "prettier": "@interface-technologies/prettier-config",
   "dependencies": {
-    "@types/react": "^17.0.22",
-    "moment-timezone": "^0.5.33",
+    "@types/react": "^17.0.35",
+    "moment-timezone": "^0.5.34",
     "redux-saga": "^1.1.3"
   },
-  "peerDependencies": {
-    "@interface-technologies/iti-react": "^3.0.0-alpha.6",
-    "@popperjs/core": "^2.10.1",
-    "bootstrap": "^5.1.1",
-    "react": "^17.0.2"
-  },
   "devDependencies": {
-    "@babel/core": "^7.15.5",
-    "@babel/preset-env": "^7.15.6",
-    "@babel/preset-react": "^7.14.5",
-    "@babel/preset-typescript": "^7.15.0",
-    "@interface-technologies/eslint-config": "0.3.0",
-    "@interface-technologies/iti-react": "3.0.0-alpha.6",
-    "@interface-technologies/prettier-config": "0.1.0",
-    "@interface-technologies/tsconfig": "0.1.1",
+    "@interface-technologies/iti-react": "4.0.0-alpha.0",
+    "@interface-technologies/tsconfig": "4.0.0-alpha.0",
     "@redux-saga/is": "^1.1.2",
     "@redux-saga/symbols": "^1.1.2",
     "@testing-library/react-hooks": "^7.0.2",
-    "@types/jest": "27.0.1",
-    "@typescript-eslint/eslint-plugin": "^4.31.2",
-    "@typescript-eslint/parser": "^4.31.2",
-    "babel-jest": "^27.2.1",
-    "eslint": "^7.32.0",
-    "eslint-config-airbnb": "^18.2.1",
-    "eslint-config-airbnb-typescript": "^14.0.0",
-    "eslint-config-prettier": "^8.3.0",
-    "eslint-import-resolver-typescript": "^2.5.0",
-    "eslint-plugin-import": "^2.24.2",
-    "eslint-plugin-jsx-a11y": "^6.4.1",
-    "eslint-plugin-promise": "^5.1.0",
-    "eslint-plugin-react": "^7.25.3",
-    "eslint-plugin-react-hooks": "^4.2.0",
-    "eslint-plugin-redux-saga": "^1.2.1",
-    "jest": "^27.2.1",
-    "jest-haste-map": "^27.2.0",
-    "jest-resolve": "^27.2.0",
-    "lint-staged": "^11.1.2",
-    "prettier": "^2.4.1",
     "react": "^17.0.2",
-    "react-test-renderer": "^17.0.2",
-    "redux-saga-test-plan": "^4.0.3",
-    "ts-jest": "^27.0.5",
-    "typescript": "~4.4.3"
+    "redux-saga-test-plan": "^4.0.4"
   },
-  "prettier": "@interface-technologies/prettier-config"
+  "peerDependencies": {
+    "@interface-technologies/iti-react": "^4.0.0-alpha.0",
+    "@popperjs/core": "^2.10.2",
+    "bootstrap": "^5.1.2",
+    "react": "^17.0.2"
+  }
 }

package/babel.config.js

@@ -1,10 +0,0 @@
-// For Jest tests only
-module.exports = {
-    presets: [
-        ['@babel/preset-env', { targets: { node: 'current' } }],
-        '@babel/preset-typescript',
-        ["@babel/preset-react", {
-            "runtime": "automatic"
-        }]
-    ],
-}

package/lint-staged.config.js

@@ -1,17 +0,0 @@
-const micromatch = require('micromatch')
-
-module.exports = {
-    '*.ts?(x)': files => {
-        const tasks = []
-
-        // Don't lint files in .eslintignore
-        notIgnored = micromatch.not(files, '**/__tests__/**/*')
-
-        if (notIgnored.length > 0) {
-            tasks.push(`eslint --fix --max-warnings 0 ${notIgnored.join(' ')}`)
-        }
-
-        tasks.push(`prettier --write ${files.join(' ')}`)
-        return tasks
-    }
-}

package/src/CheckForJsBundleUpdateSaga.tsx

@@ -1,145 +0,0 @@
-import moment from 'moment-timezone'
-import { SagaIterator } from 'redux-saga'
-import { delay, call } from 'redux-saga/effects'
-import { alert } from '@interface-technologies/iti-react'
-
-const hashElementId = 'jsBundleHash'
-const defaultDelayDuration = moment.duration(4, 'minutes')
-const forceRefreshAfterAlertCount = 3
-
-/** @internal */
-export function getIndexHtml(): Promise<string | undefined> {
-    return (
-        fetch('/')
-            .then((response) => {
-                if (!response.ok) return undefined
-
-                return response.text()
-            })
-            // If fetch throws a TypeError for some weird reason, also return undefined
-            .catch(() => undefined)
-    )
-}
-
-/** @internal */
-export function reload(): void {
-    window.location.reload()
-}
-
-export interface CheckForJsBundleUpdateSagaOptions {
-    delayDuration?: moment.Duration
-    onError(e: unknown): void
-}
-
-/**
- * Peridoically fetches `/` (`index.html`) to check if a new JavaScript bundle has been
- * released.
- *
- * If the bundle has been updated, the user is prompted to refresh the page.
- * After 3 alerts are shown, the page is forcibly refreshed.
- *
- * Don't enable this in development!
- *
- * Your `index.html` must contain a hidden element with the ID `jsBundleHash` that
- * contains a hash of the JavaScript bundle's entry point. Here's how to do this
- * in ASP.NET Core:
- *
- * # TODO:SAM change langauge to razor once shiki bug fix released (https://github.com/shikijs/shiki/issues/219)
- * ```text
- * var path = $"dist/{bundleName}.js";
- * string jsBundleHash;
- *
- * using (var sha256 = SHA256.Create())
- * {
- *     var fullPath = System.IO.Path.Combine("wwwroot", path);
- *     using (var readStream = File.OpenRead(fullPath))
- *     {
- *         var hashBytes = sha256.ComputeHash(readStream);
- *         jsBundleHash = WebEncoders.Base64UrlEncode(hashBytes);
- *     }
- * }
- *
- * <script src=@path asp-append-version="true"></script>
- * <span id="jsBundleHash" style="display: none">
- *     @jsBundleHash
- * </span>
- * ```
- *
- * And example of using `checkForJsBundleUpdateSaga` from your TypeScript code:
- *
- * ```
- * export function* myCheckForJsBundleUpdateSaga(): SagaIterator<void> {
- *     if ((window as unknown as WindowWithGlobals).isDebug) return
- *
- *     function onError(e: unknown): void {
- *         console.error(e)
- *
- *         const ierror = processError(e)
- *
- *         // Never show the user an error because of this
- *         if (shouldLogError(ierror)) {
- *             Bugsnag.notify(ierror)
- *         }
- *     }
- *
- *     yield call(checkForJsBundleUpdateSaga, { onError })
- * }
- * ```
- */
-export function* checkForJsBundleUpdateSaga({
-    delayDuration = defaultDelayDuration,
-    onError,
-}: CheckForJsBundleUpdateSagaOptions): SagaIterator<void> {
-    const jsBundleHash = document.getElementById(hashElementId)?.innerText?.trim()
-
-    if (!jsBundleHash) {
-        onError(new Error('Could not get jsBundleHash.'))
-        return
-    }
-
-    yield delay(delayDuration.asMilliseconds())
-
-    let alertShownCount = 0
-
-    for (;;) {
-        try {
-            const indexHtml = (yield call(getIndexHtml)) as string | undefined
-            if (indexHtml) {
-                const document = new DOMParser().parseFromString(indexHtml, 'text/html')
-                const hashEl = document.getElementById(hashElementId)
-
-                if (hashEl) {
-                    // innerText doesn't work here for some reason
-                    const newJsBundleHash = hashEl.innerHTML?.trim()
-
-                    if (jsBundleHash !== newJsBundleHash) {
-                        const content = (
-                            <div>
-                                <p>Please save your work and refresh the page.</p>
-                                <p className="mb-0">
-                                    You may encounter errors if you do not refresh the
-                                    page.
-                                </p>
-                            </div>
-                        )
-
-                        if (alertShownCount >= forceRefreshAfterAlertCount) {
-                            window.onbeforeunload = null
-                            yield call(reload)
-                            return
-                        }
-
-                        yield call(alert, content, { title: 'Website Update Available!' })
-                        alertShownCount++
-                    }
-                } else {
-                    onError(new Error('Could not get jsBundleHash in fetched document.'))
-                }
-            }
-        } catch (e) {
-            onError(e)
-        }
-
-        yield delay(delayDuration.asMilliseconds())
-    }
-}

package/src/index.ts

@@ -1,2 +0,0 @@
-export { checkForJsBundleUpdateSaga } from './CheckForJsBundleUpdateSaga'
-export type { CheckForJsBundleUpdateSagaOptions } from './CheckForJsBundleUpdateSaga'