@openmrs/esm-app-shell 5.3.3-pre.1231 → 5.3.3-pre.1247

package/src/service-worker/routing.ts

@@ -1,36 +1,29 @@
-import { RouteHandlerCallbackOptions } from "workbox-core";
-import { registerRoute } from "workbox-routing";
-import { getOrCreateDefaultRouter } from "workbox-routing/utils/getOrCreateDefaultRouter";
-import { validMethods } from "workbox-routing/utils/constants";
-import { CacheOnly, NetworkFirst, NetworkOnly } from "workbox-strategies";
-import {
-  indexUrl,
-  omrsCacheName,
-  omrsOfflineCachingStrategyHttpHeaderName,
-} from "./constants";
-import { ServiceWorkerDb } from "./storage";
+import { RouteHandlerCallbackOptions } from 'workbox-core';
+import { registerRoute } from 'workbox-routing';
+import { getOrCreateDefaultRouter } from 'workbox-routing/utils/getOrCreateDefaultRouter';
+import { validMethods } from 'workbox-routing/utils/constants';
+import { CacheOnly, NetworkFirst, NetworkOnly } from 'workbox-strategies';
+import { indexUrl, omrsCacheName, omrsOfflineCachingStrategyHttpHeaderName } from './constants';
+import { ServiceWorkerDb } from './storage';
 import {
   getOmrsHeader,
   parseOmrsOfflineResponseBodyHeader,
   parseOmrsOfflineResponseStatusHeader,
-} from "./http-header-utils";
-import type { OmrsOfflineCachingStrategy } from "@openmrs/esm-offline";
-import uniq from "lodash-es/uniq";
+} from './http-header-utils';
+import type { OmrsOfflineCachingStrategy } from '@openmrs/esm-offline';
+import uniq from 'lodash-es/uniq';
 
 const networkOnly = new NetworkOnly();
 const cacheOnly = new CacheOnly({ cacheName: omrsCacheName });
 const networkFirst = new NetworkFirst({ cacheName: omrsCacheName });
 
-const defaultStrategy: OmrsOfflineCachingStrategy =
-  "network-only-or-cache-only";
+const defaultStrategy: OmrsOfflineCachingStrategy = 'network-only-or-cache-only';
 const knownStrategyHandlers: Record<
   OmrsOfflineCachingStrategy,
   (options: RouteHandlerCallbackOptions) => Promise<Response>
 > = {
-  ["network-first"]: (options) => networkFirst.handle(options),
-  ["network-only-or-cache-only"]: async (
-    options: RouteHandlerCallbackOptions
-  ) => {
+  ['network-first']: (options) => networkFirst.handle(options),
+  ['network-only-or-cache-only']: async (options: RouteHandlerCallbackOptions) => {
     try {
       return await networkOnly.handle(options);
     } catch (e) {
@@ -47,10 +40,7 @@ export function registerAllOmrsRoutes() {
   // to the SPA's index (which should always be precached).
   // This ensures that the page loads correctly when a new navigation occurs to pages
   // like `/openmrs/spa/anything/nested`.
-  registerRoute(
-    ({ request }) => request.mode === "navigate",
-    navigationHandler
-  );
+  registerRoute(({ request }) => request.mode === 'navigate', navigationHandler);
 
   // Fallback routing behavior.
   // Checks if a dynamic route registration exists and, if so, handles it using a Network First approach.
@@ -77,22 +67,13 @@ async function navigationHandler(options: RouteHandlerCallbackOptions) {
 
 async function defaultHandler(options: RouteHandlerCallbackOptions) {
   const { request } = options;
-  const handlerKey =
-    options.request.method === "GET"
-      ? await getHandlerKey(options)
-      : defaultStrategy;
-  const handler =
-    knownStrategyHandlers[handlerKey] ?? knownStrategyHandlers[defaultStrategy];
+  const handlerKey = options.request.method === 'GET' ? await getHandlerKey(options) : defaultStrategy;
+  const handler = knownStrategyHandlers[handlerKey] ?? knownStrategyHandlers[defaultStrategy];
 
   try {
     return await handler(options);
   } catch (e) {
-    console.warn(
-      "[SW] Could not handle the request to %s (using handler %s).",
-      request.url,
-      handlerKey,
-      e
-    );
+    console.warn('[SW] Could not handle the request to %s (using handler %s).', request.url, handlerKey, e);
 
     return new Response(parseOmrsOfflineResponseBodyHeader(request.headers), {
       status: parseOmrsOfflineResponseStatusHeader(request.headers),
@@ -101,10 +82,7 @@ async function defaultHandler(options: RouteHandlerCallbackOptions) {
 }
 
 async function getHandlerKey({ request }: RouteHandlerCallbackOptions) {
-  return (
-    getHandlerKeyFromHeaders(request.headers) ??
-    (await getHandlerKeyFromDynamicRouteRegistrations(request.url))
-  );
+  return getHandlerKeyFromHeaders(request.headers) ?? (await getHandlerKeyFromDynamicRouteRegistrations(request.url));
 }
 
 function getHandlerKeyFromHeaders(headers: Headers) {
@@ -113,12 +91,11 @@ function getHandlerKeyFromHeaders(headers: Headers) {
 
 async function getHandlerKeyFromDynamicRouteRegistrations(url: string) {
   const db = new ServiceWorkerDb();
-  const allDynamicRouteRegistrations =
-    await db.dynamicRouteRegistrations.toArray();
+  const allDynamicRouteRegistrations = await db.dynamicRouteRegistrations.toArray();
   const strategies = uniq(
     allDynamicRouteRegistrations
       .filter((route) => new RegExp(route.pattern).test(url))
-      .map((route) => route.strategy ?? "network-first")
+      .map((route) => route.strategy ?? 'network-first'),
   );
 
   if (strategies.length <= 1) {
@@ -126,15 +103,11 @@ async function getHandlerKeyFromDynamicRouteRegistrations(url: string) {
   } else {
     // Multiple routes can match the URL (multiple RegExps can match).
     // In that case, prioritize the available strategies. When in doubt, cache the resource again.
-    const priorities: Array<OmrsOfflineCachingStrategy> = [
-      "network-first",
-      "network-only-or-cache-only",
-    ];
+    const priorities: Array<OmrsOfflineCachingStrategy> = ['network-first', 'network-only-or-cache-only'];
 
     return (
-      priorities.find((prioritizedStrategy) =>
-        strategies.some((strategy) => strategy === prioritizedStrategy)
-      ) ?? defaultStrategy
+      priorities.find((prioritizedStrategy) => strategies.some((strategy) => strategy === prioritizedStrategy)) ??
+      defaultStrategy
     );
   }
 }

package/src/service-worker/storage.ts

@@ -1,5 +1,5 @@
-import type { OmrsOfflineCachingStrategy } from "@openmrs/esm-offline";
-import Dexie, { Table } from "dexie";
+import type { OmrsOfflineCachingStrategy } from '@openmrs/esm-offline';
+import Dexie, { Table } from 'dexie';
 
 /**
  * Contains information about dynamic route registrations.
@@ -28,9 +28,9 @@ export class ServiceWorkerDb extends Dexie {
   dynamicRouteRegistrations: Table<DynamicRouteRegistration, number>;
 
   constructor() {
-    super("ServiceWorker");
-    this.version(1).stores({ dynamicRouteRegistrations: "++,&pattern" });
+    super('ServiceWorker');
+    this.version(1).stores({ dynamicRouteRegistrations: '++,&pattern' });
 
-    this.dynamicRouteRegistrations = this.table("dynamicRouteRegistrations");
+    this.dynamicRouteRegistrations = this.table('dynamicRouteRegistrations');
   }
 }

package/src/service-worker/types.ts

@@ -1,4 +1,4 @@
-import type { PrecacheEntry } from "workbox-precaching/_types";
+import type { PrecacheEntry } from 'workbox-precaching/_types';
 
 // Globals injected by Workbox at build time.
 declare global {

package/src/ui/breadcrumbs.tsx

@@ -1,10 +1,6 @@
-import React, { useEffect, useState } from "react";
-import { Breadcrumb, BreadcrumbItem, InlineLoading } from "@carbon/react";
-import {
-  getBreadcrumbsFor,
-  ConfigurableLink,
-  BreadcrumbRegistration,
-} from "@openmrs/esm-framework";
+import React, { useEffect, useState } from 'react';
+import { Breadcrumb, BreadcrumbItem, InlineLoading } from '@carbon/react';
+import { getBreadcrumbsFor, ConfigurableLink, BreadcrumbRegistration } from '@openmrs/esm-framework';
 
 function getPath(path: string, params: Array<string>) {
   const parts = [...params];
@@ -18,11 +14,11 @@ function getParams(path: string, matcher: RegExp) {
     const [, ...params] = match;
     return params;
   } else {
-    const segments = path.split("/");
+    const segments = path.split('/');
     segments.pop();
 
     if (segments.length > 1) {
-      const newPath = segments.join("/");
+      const newPath = segments.join('/');
       return getParams(newPath, matcher);
     }
   }
@@ -35,17 +31,12 @@ interface CustomBreadcrumbItemProps {
   params: any;
 }
 
-export const CustomBreadcrumbItem: React.FC<CustomBreadcrumbItemProps> = ({
-  breadcrumbRegistration,
-  params,
-}) => {
-  const [title, setTitle] = useState("");
+export const CustomBreadcrumbItem: React.FC<CustomBreadcrumbItemProps> = ({ breadcrumbRegistration, params }) => {
+  const [title, setTitle] = useState('');
 
   useEffect(() => {
-    if (typeof breadcrumbRegistration.settings.title === "function") {
-      Promise.resolve(breadcrumbRegistration.settings.title(params)).then(
-        (res) => setTitle(res)
-      );
+    if (typeof breadcrumbRegistration.settings.title === 'function') {
+      Promise.resolve(breadcrumbRegistration.settings.title(params)).then((res) => setTitle(res));
     } else {
       setTitle(breadcrumbRegistration.settings.title);
     }
@@ -53,9 +44,7 @@ export const CustomBreadcrumbItem: React.FC<CustomBreadcrumbItemProps> = ({
 
   return (
     <BreadcrumbItem key={breadcrumbRegistration.settings.path}>
-      <ConfigurableLink
-        to={getPath(breadcrumbRegistration.settings.path, params)}
-      >
+      <ConfigurableLink to={getPath(breadcrumbRegistration.settings.path, params)}>
         {title ? title : <InlineLoading />}
       </ConfigurableLink>
     </BreadcrumbItem>
@@ -70,8 +59,8 @@ export const Breadcrumbs: React.FC = () => {
 
   useEffect(() => {
     const handler = () => setPath(location.pathname);
-    window.addEventListener("popstate", handler);
-    return () => window.removeEventListener("popstate", handler);
+    window.addEventListener('popstate', handler);
+    return () => window.removeEventListener('popstate', handler);
   }, []);
 
   if (breadcrumbs.length > 4) {
@@ -79,7 +68,7 @@ export const Breadcrumbs: React.FC = () => {
       ...breadcrumbs[1],
       settings: {
         ...breadcrumbs[1].settings,
-        title: "...",
+        title: '...',
       },
     });
   }
@@ -87,11 +76,7 @@ export const Breadcrumbs: React.FC = () => {
   return (
     <Breadcrumb className="breadcrumbs-container">
       {breadcrumbs.map((bc, index) => (
-        <CustomBreadcrumbItem
-          key={`breadcrumb-item-${index}`}
-          breadcrumbRegistration={bc}
-          params={params}
-        />
+        <CustomBreadcrumbItem key={`breadcrumb-item-${index}`} breadcrumbRegistration={bc} params={params} />
       ))}
     </Breadcrumb>
   );

package/src/ui/index.ts

@@ -1,18 +1,18 @@
-import { getAsyncLifecycle } from "@openmrs/esm-framework";
+import { getAsyncLifecycle } from '@openmrs/esm-framework';
 
-export const appName = "@openmrs/esm-app-shell";
+export const appName = '@openmrs/esm-app-shell';
 
 export function getCoreExtensions() {
   const options = {
-    featureName: "app-shell",
+    featureName: 'app-shell',
     moduleName: appName,
   };
 
   return [
     {
-      name: "breadcrumbs-widget",
-      slot: "breadcrumbs-slot",
-      load: getAsyncLifecycle(() => import("./breadcrumbs"), options),
+      name: 'breadcrumbs-widget',
+      slot: 'breadcrumbs-slot',
+      load: getAsyncLifecycle(() => import('./breadcrumbs'), options),
       online: true,
       offline: true,
     },

package/tools/helpers.js

@@ -6,9 +6,7 @@
  */
 exports.removeTrailingSlash = (path) => {
   const i = path.length - 1;
-  return path[i] === "/"
-    ? exports.removeTrailingSlash(path.substr(0, i))
-    : path;
+  return path[i] === '/' ? exports.removeTrailingSlash(path.substr(0, i)) : path;
 };
 
 /**
@@ -18,13 +16,11 @@ exports.removeTrailingSlash = (path) => {
  * @returns {string} The number as a string, padded to two places
  */
 const padToTwoDigits = (num) => {
-  return num.toString().padStart(2, "0");
+  return num.toString().padStart(2, '0');
 };
 
 exports.getTimestamp = () => {
   const today = new Date();
   const dd = padToTwoDigits;
-  return `${today.getFullYear()}${dd(today.getMonth() + 1)}${dd(
-    today.getDate()
-  )}`;
+  return `${today.getFullYear()}${dd(today.getMonth() + 1)}${dd(today.getDate())}`;
 };