@momentum-design/components 0.25.2 → 0.25.4

package/dist/react/iconprovider/index.js

@@ -10,11 +10,15 @@ import { TAG_NAME } from '../../components/iconprovider/iconprovider.constants';
  * that only a url has to be passed in from which the icons will be
  * fetched.
  *
- * If `shouldCache` is set to true, the IconProvider will cache the icons
- * in a Map to avoid fetching the same icon multiple times over the network.
+ * If `cacheStrategy` is provided, the IconProvider will cache the icons
+ * in the selected cache (either web-api-cache or in-memory-cache),
+ * to avoid fetching the same icon multiple times over the network.
  * This is useful when the same icon is used multiple times in the application.
- * Keep in mind that this cache is not persisted and will be lost when the
+ * To consider:
+ * - The `in-memory-cache` is not persisted and will be lost when the
  * IconProvider is removed from the DOM.
+ * - The `web-api-cache` is persisted, but only works in https environments
+ * (https://developer.mozilla.org/en-US/docs/Web/API/Cache).
  *
  * @tagname mdc-iconprovider
  *

package/dist/react/index.d.ts

@@ -4,8 +4,8 @@ export { default as Badge } from './badge';
 export { default as Bullet } from './bullet';
 export { default as Button } from './button';
 export { default as Buttonsimple } from './buttonsimple';
-export { default as Divider } from './divider';
 export { default as Checkbox } from './checkbox';
+export { default as Divider } from './divider';
 export { default as FormfieldGroup } from './formfieldgroup';
 export { default as FormfieldWrapper } from './formfieldwrapper';
 export { default as Icon } from './icon';

package/dist/react/index.js

@@ -4,8 +4,8 @@ export { default as Badge } from './badge';
 export { default as Bullet } from './bullet';
 export { default as Button } from './button';
 export { default as Buttonsimple } from './buttonsimple';
-export { default as Divider } from './divider';
 export { default as Checkbox } from './checkbox';
+export { default as Divider } from './divider';
 export { default as FormfieldGroup } from './formfieldgroup';
 export { default as FormfieldWrapper } from './formfieldwrapper';
 export { default as Icon } from './icon';

package/dist/utils/icon-cache/index.d.ts

@@ -0,0 +1,32 @@
+export type CacheStrategy = 'in-memory-cache' | 'web-cache-api';
+/**
+ * Cache, using In-Memory Cache (Map)
+ * @param name - name of the cache (used as an identifier)
+ * @returns Object with set, get and delete methods
+ */
+export declare const inMemoryCache: (name: string) => Promise<{
+    set(request: Request, response: Response): Promise<void>;
+    get(request: Request): Promise<string | undefined>;
+    delete(request: Request): Promise<void>;
+}>;
+/**
+ * Cache, using Web API Cache
+ * @param name - name of the cache (used as an identifier)
+ * @returns Object with set, get and delete methods
+ */
+export declare const webAPIIconsCache: (name: string) => Promise<{
+    set: (request: Request, response: Response) => Promise<void>;
+    get: (request: Request) => Promise<string | undefined>;
+    delete: (request: Request) => Promise<void>;
+}>;
+/**
+ * Function to return the cache based on the cache strategy
+ * @param cacheName - name of the cache to be used
+ * @param cacheStrategy - strategy to be used for caching
+ * @returns the cache based on the strategy
+ */
+export declare const iconsCache: (cacheName: string, cacheStrategy: CacheStrategy) => Promise<{
+    set(request: Request, response: Response): Promise<void>;
+    get(request: Request): Promise<string | undefined>;
+    delete(request: Request): Promise<void>;
+}>;

package/dist/utils/icon-cache/index.js

@@ -0,0 +1,54 @@
+const registry = {};
+/**
+ * Cache, using In-Memory Cache (Map)
+ * @param name - name of the cache (used as an identifier)
+ * @returns Object with set, get and delete methods
+ */
+export const inMemoryCache = async (name) => {
+    if (registry[name] === undefined) {
+        registry[name] = new Map();
+    }
+    return {
+        async set(request, response) {
+            registry[name].set(request.url, await response.text());
+        },
+        async get(request) {
+            return registry[name].get(request.url);
+        },
+        async delete(request) {
+            registry[name].delete(request.url);
+        },
+    };
+};
+/**
+ * Cache, using Web API Cache
+ * @param name - name of the cache (used as an identifier)
+ * @returns Object with set, get and delete methods
+ */
+export const webAPIIconsCache = async (name) => {
+    const cache = await caches.open(name);
+    return {
+        set: async (request, response) => {
+            await cache.put(request, response);
+        },
+        get: async (request) => {
+            const response = await cache.match(request);
+            return response === null || response === void 0 ? void 0 : response.text();
+        },
+        delete: async (request) => {
+            await cache.delete(request);
+        },
+    };
+};
+/**
+ * Function to return the cache based on the cache strategy
+ * @param cacheName - name of the cache to be used
+ * @param cacheStrategy - strategy to be used for caching
+ * @returns the cache based on the strategy
+ */
+export const iconsCache = async (cacheName, cacheStrategy) => {
+    if (cacheStrategy === 'in-memory-cache') {
+        return inMemoryCache(cacheName);
+    }
+    return webAPIIconsCache(cacheName);
+};

package/package.json

@@ -37,5 +37,5 @@
     "lit": "^3.2.0",
     "uuid": "^11.0.5"
   },
-  "version": "0.25.2"
+  "version": "0.25.4"
 }