feat(service-worker): add service worker utilities and logging support (#18)

* feat(service-worker): add service worker utilities and logging support

* feat(service-worker): refactor imports and add version-checker utility

* refactor(service-worker): enhance PWA installation handling with type definitions and improved comments

* feat(service-worker): add beforeinstallprompt option and integrate snackbar package

* refactor(snackbar): optimize logger and signal instantiation with pure annotations

* feat(snackbar): allow 'infinite' duration option for snackbar display

* doc(snackbar): update documentation to clarify 'infinite' duration option

* refactor(service-worker): update snackbar duration to 'infinite' for service worker notifications

* refactor(service-worker): improve AlwatrSignal instantiation with pure annotations

* refactor(service-worker): update version and repository directory in package.json

* feat(service-worker): add an empty test file for initial setup

* refactor(snackbar): simplify default duration assignment in showSnackbar function

* doc(service-worker): remove unnecessary comment in main.ts

* refactor(service-worker): remove install-pwa.ts file and related functionality

* refactor(logger): simplify logger initialization by removing package tracer and package details

* refactor(service-worker): remove serviceWorkerNotifyHandler and related functionality

* refactor(version-checker): remove isVersionLarger function and related logger usage

* refactor(service-worker): remove unused exports from main.ts

* refactor(service-worker): clean up package.json and yarn.lock by removing unused dependencies

* doc(service-worker): write installation

* chore: set correct owner homepage

* refactor(service-worker): review and enhance

Co-authored-by: arashagp <[email protected]>

* lint: make happy

---------

Co-authored-by: S. Amir Mohammad Najafi <[email protected]>

Author: arashagp

.vscode/settings.json

@@ -54,6 +54,7 @@
     "argb",
     "backorder",
     "backordering",
+    "beforeinstallprompt",
     "colspan",
     "cssnano",
     "endmacro",

package.json

@@ -4,7 +4,7 @@
   "description": "Necessary library for all ECMAScript (JavaScript/TypeScript) projects.",
   "repository": "https://github.com/the-nexim/nanolib",
   "license": "AGPL-3.0-only",
-  "author": "S. Amir Mohammad Najafi <[email protected]> (www.njfamirm.ir)",
+  "author": "S. Amir Mohammad Najafi <[email protected]> (https://www.njfamirm.ir)",
   "contributors": [
     "Arash Ghardashpoor <[email protected]> (https://www.agpagp.ir)"
   ],

packages/snackbar/package.json

@@ -19,7 +19,7 @@
     "directory": "packages/snackbar"
   },
   "license": "AGPL-3.0-only",
-  "author": "S. Amir Mohammad Najafi <[email protected]> (www.njfamirm.ir)",
+  "author": "S. Amir Mohammad Najafi <[email protected]> (https://www.njfamirm.ir)",
   "contributors": [
     "Arash Ghardashpoor <[email protected]> (https://www.agpagp.ir)"
   ],

packages/snackbar/src/lib/handler.ts

@@ -5,16 +5,16 @@ import {waitForTimeout} from '@alwatr/wait';
 
 import type {SnackbarComponent} from './element.js';
 
-const logger = createLogger(`${__package_name__}/handler`);
+const logger = /* @__PURE__ */ createLogger(`${__package_name__}/handler`);
 
 /**
  * @property content - Content to be displayed in the snackbar.
  * @property {action} - The action button configuration.
  * @property action.label - The label for the action button.
  * @property action.handler - The handler function for the action button.
- * @property duration - Duration for which the snackbar is displayed. `-1` for infinite duration.
+ * @property duration - Duration for which the snackbar is displayed. `infinite` for infinite duration.
  * Duration for which the snackbar is displayed.
- * `-1` for infinite duration.
+ * `infinite` for infinite duration.
  * @property addCloseButton - Whether to add a close button to the snackbar.
  */
 export type SnackbarOptions = {
@@ -23,7 +23,7 @@ export type SnackbarOptions = {
     label: string;
     handler: () => void;
   };
-  duration?: Duration;
+  duration?: Duration | 'infinite';
   addCloseButton?: boolean;
 };
 
@@ -53,7 +53,7 @@ export const snackbarActionButtonClickedSignal = new AlwatrTrigger({
  *   addCloseButton: true,
  * });
  */
-export const snackbarSignal = new AlwatrSignal<SnackbarOptions>({name: 'snackbar'});
+export const snackbarSignal = /* @__PURE__ */ new AlwatrSignal<SnackbarOptions>({name: 'snackbar'});
 
 // Subscribe to the snackbar signal to show the snackbar when the signal is emitted.
 snackbarSignal.subscribe((options) => {
@@ -71,10 +71,9 @@ async function showSnackbar(options: SnackbarOptions): Promise<void> {
   logger.logMethodArgs?.('showSnackbar', {options});
 
   // Parse the duration
-  if (options.duration != null) options.duration = parseDuration(options.duration);
 
   // Set default duration if not provided
-  options.duration = parseDuration('4s');
+  options.duration ??= '4s';
 
   const element = document.createElement('snack-bar') as SnackbarComponent;
 
@@ -111,7 +110,7 @@ async function showSnackbar(options: SnackbarOptions): Promise<void> {
   document.body.appendChild(element);
 
   // Set a timeout to close the snackbar if duration is not infinite
-  if (options.duration !== -1) {
+  if (options.duration !== 'infinite') {
     waitForTimeout(parseDuration(options.duration)).then(closeSnackbar_);
   }
 }

tsconfig.json

@@ -15,6 +15,12 @@
     },
     {
       "path": "./packages/alpine"
+    },
+    {
+      "path": "./packages/service-worker"
+    },
+    {
+      "path": "./packages/snackbar"
     }
   ]
 }

yarn.lock

@@ -1072,6 +1072,21 @@ __metadata:
   languageName: unknown
   linkType: soft
 
+"@nexim/service-worker@workspace:packages/service-worker":
+  version: 0.0.0-use.local
+  resolution: "@nexim/service-worker@workspace:packages/service-worker"
+  dependencies:
+    "@alwatr/flux": "npm:^4.0.2"
+    "@alwatr/logger": "npm:^5.0.0"
+    "@alwatr/nano-build": "npm:^5.0.0"
+    "@alwatr/package-tracer": "npm:^5.0.0"
+    "@alwatr/type-helper": "npm:^5.0.0"
+    "@nexim/typescript-config": "workspace:^"
+    ava: "npm:^6.2.0"
+    typescript: "npm:^5.6.3"
+  languageName: unknown
+  linkType: soft
+
 "@nexim/snackbar@workspace:packages/snackbar":
   version: 0.0.0-use.local
   resolution: "@nexim/snackbar@workspace:packages/snackbar"