Patched /private/var/folders/19/08z9_xys69v3f1xfqtyn9jyw0000gn/T/tmp9nchm_3p/README.md

Author: patched.codes[bot]

README.md

@@ -1,14 +1,104 @@
-# [:] Example Python 2 Project
+# File: sw.js
 
-An example Python project to demonstrate [srcclr](https://www.srcclr.com) scans.
+## Overview
 
-Check out the [python3](https://github.com/srcclr/example-python/tree/python3) branch for a project that builds with Python 3.
+This JavaScript file is a Service Worker (SW) script that provides caching strategies for CSS, JS, fonts, images, and videos. The caching is managed using the Workbox library, which is conditionally loaded either from a CDN or locally based on the current location URL.
 
-## Try me!
+## Inputs
 
-```
-brew tap srcclr/srcclr
-brew install srcclr
-srcclr activate
-srcclr scan --url https://github.com/srcclr/example-python
-```
+- **location.href**: Determines whether to load Workbox from a CDN or locally.
+- **Workbox**: A library for caching resources and managing service workers.
+- **Cache configuration objects**: Define strategies for caching specific types of requests.
+
+## Outputs
+
+- **Service Worker registration**: The script installs and activates a service worker that caches resources according to predefined strategies.
+
+## Usage
+
+### Functionality
+
+1. **Conditional Workbox Import**:
+   - The script checks if the current page URL includes 'howdz.xyz'. If so, it loads Workbox from a CDN. Otherwise, it loads it locally.
+
+2. **Caching Strategies**:
+   - **CSS/JS/Font Caching**: Uses `CacheFirst` strategy to cache these assets, with a maximum of 50 entries, each valid for 7 days.
+   - **Image Caching**: Uses `StaleWhileRevalidate` strategy, allowing immediate response while updating the cache in the background, also with a maximum of 50 entries, each valid for 7 days.
+   - **Video Caching**: Uses `CacheFirst` strategy with range requests support, allowing partial content caching for better video streaming performance.
+
+### Key Components
+
+- **Conditionally Importing Workbox**:
+  ```javascript
+  if (location.href.includes('howdz.xyz')) {
+    importScripts('https://cdn.staticfile.org/workbox-sw/7.0.0/workbox-sw.js')
+    workbox.setConfig({
+      debug: false,
+    });
+    console.log('sw.js is load by CDN!')
+  } else {
+    importScripts('./workbox/workbox-sw.js')
+    workbox.setConfig({
+      debug: false,
+      modulePathPrefix: './workbox/'
+    });
+    console.log('sw.js is load by local!')
+  }
+  ```
+
+- **Registering Routes for Caching**:
+  ```javascript
+  // Cache css/js/font.
+  workbox.routing.registerRoute(
+    ({ request }) => request.destination === 'style' || request.destination === 'script' || request.destination === 'font',
+    new workbox.strategies.CacheFirst({
+      cacheName: 'css-js-font',
+      plugins: [
+        new workbox.cacheableResponse.CacheableResponsePlugin({
+          statuses: [200],
+        }),
+        new workbox.expiration.ExpirationPlugin({
+          maxEntries: 50,
+          maxAgeSeconds: 60 * 60 * 24 * 7, // 7 Days
+        }),
+      ]
+    })
+  );
+
+  // Cache image.
+  workbox.routing.registerRoute(
+    ({ request }) => request.destination === 'image',
+    new workbox.strategies.StaleWhileRevalidate({
+      cacheName: 'image',
+      plugins: [
+        new workbox.cacheableResponse.CacheableResponsePlugin({
+          statuses: [200],
+        }),
+        new workbox.expiration.ExpirationPlugin({
+          maxEntries: 50,
+          maxAgeSeconds: 60 * 60 * 24 * 7, // 7 Days
+        })
+      ]
+    })
+  );
+
+  // Cache video
+  workbox.routing.registerRoute(
+    ({ request }) => request.destination === 'video',
+    new workbox.strategies.CacheFirst({
+      cacheName: 'video',
+      plugins: [
+        new workbox.cacheableResponse.CacheableResponsePlugin({
+          statuses: [200],
+        }),
+        new workbox.expiration.ExpirationPlugin({
+          maxEntries: 50,
+          maxAgeSeconds: 60 * 60 * 24 * 7, // 7 Days
+        }),
+        new workbox.rangeRequests.RangeRequestsPlugin()
+      ]
+    })
+  );
+  ```
+
+By using this `sw.js` script, a web application can effectively cache its resources, resulting in better performance and offline capabilities. This is particularly useful for Progressive Web Apps (PWAs) that aim to provide a seamless user experience even in intermittent network conditions.