@nitra/cap 1.0.3 → 1.0.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nitra/cap",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "Nitra capacitor components",
   "type": "module",
   "scripts": {

package/save-token/README.md

@@ -15,30 +15,38 @@ saveToken() => Promise<void>
 ```
 
 ## usage with Vite
-### Set vapid key : ``` import.meta.env.VITE_VAPID_KEY ```
-### Set host url of the notify project: ``` import.meta.env.VITE_NOTIFY_URL ```
-The ```notify project``` is a server-side component designed to handle API requests for saving user push tokens. It uses the Fastify framework and JWT-based security for authentication.
-### Or set for local dev: ```import.meta.env.VITE_LOCALHOST```
 
-### Set the name of your app: ```import.meta.env.VITE_APP```
+### Set vapid key : `import.meta.env.VITE_VAPID_KEY`
+
+### Set host url of the notify project: `import.meta.env.VITE_NOTIFY_URL`
+
+The `notify project` is a server-side component designed to handle API requests for saving user push tokens. It uses the Fastify framework and JWT-based security for authentication.
+
+### Or set for local dev: `import.meta.env.VITE_LOCALHOST`
+
+### Set the name of your app: `import.meta.env.VITE_APP`
 
 ## usage the library
+
 ### To use this package, you should add this code to your project where you want to provide push notifications
 
 ```typescript
 initializeApp({
-    apiKey: import.meta.env.VITE_API_KEY,
-    authDomain: import.meta.env.VITE_AUTH_DOMAIN,
-    projectId: import.meta.env.VITE_PROJECT_ID,
-    storageBucket: import.meta.env.VITE_STORAGE_BUCKET,
-    messagingSenderId: import.meta.env.VITE_MESSAGING_SENDER_ID,
-    appId: import.meta.env.VITE_APP_ID
+  apiKey: import.meta.env.VITE_API_KEY,
+  authDomain: import.meta.env.VITE_AUTH_DOMAIN,
+  projectId: import.meta.env.VITE_PROJECT_ID,
+  storageBucket: import.meta.env.VITE_STORAGE_BUCKET,
+  messagingSenderId: import.meta.env.VITE_MESSAGING_SENDER_ID,
+  appId: import.meta.env.VITE_APP_ID
 })
 ```
+
 ### This code will initialize firebase
 
 ## example in node
+
 ### Using function after login
+
 ```jsx
     <template>
     <n-code @token-checked="saveToken" />
@@ -59,26 +67,60 @@ initializeApp({
 ```
 
 ## Environment Variable Validation with Vite
-### To ensure that required environment variables are set, add the following to your vite.config.js
+
+### To ensure that the required environment variables are set and the sw.js file is added to the project, add the following to your vite.config.js
+
 ```typescript
 import { requireEnvVar } from '@nitra/vite-check-env'
+import { defineConfig, loadEnv } from 'vite'
+import { build } from 'esbuild'
 
 export default {
   plugins: [
+    {
+      name: 'nitra-service-worker-transform',
+      apply: 'build',
+      transformIndexHtml() {
+        build({
+          plugins: [env(loadEnv(mode, '.'))],
+          format: 'esm',
+          entryPoints: [path.join(process.cwd(), '../node_modules/@nitra/cap/save-token/sw.js')],
+          outfile: path.join(process.cwd(), 'dist', 'sw.js')
+        })
+      }
+    },
     requireEnvVar([
+      'VITE_VAPID_KEY',
+      'VITE_APP',
       'VITE_API_KEY',
       'VITE_AUTH_DOMAIN',
-      'VITE_PROJECT_ID'
+      'VITE_PROJECT_ID',
       'VITE_STORAGE_BUCKET',
       'VITE_MESSAGING_SENDER_ID',
-      'VITE_APP_ID',
-      'VITE_VAPID_KEY',
-      'VITE_NOTIFY_URL',
-      'VITE_APP'])
+      'VITE_APP_ID'
+    ])
   ]
 }
+
+function env(props) {
+  return {
+    name: 'env',
+    setup: build => {
+      const options = build.initialOptions
+      const define = options.define ?? {}
+      for (const k in props) {
+        define[`import.meta.env.${k}`] = JSON.stringify(props[k])
+      }
+      options.define = {
+        ...define
+      }
+    }
+  }
+}
 ```
+
 ### Install the plugin in the project directory
+
 ```typescript
 yarn add -D @nitra/vite-check-env
 ```

package/save-token/index.js

@@ -1,7 +1,7 @@
 import { Capacitor } from '@capacitor/core'
 import { FirebaseMessaging } from '@capacitor-firebase/messaging'
 import { getToken } from '@nitra/vite-boot/token'
-import { initializeApp } from "firebase/app"
+import { initializeApp } from 'firebase/app'
 
 /**
  * Save the Firebase push token for a given app and platform.
@@ -65,7 +65,7 @@ export async function saveToken() {
  * @returns {Promise<object>} Web Push token
  */
 async function getWebPushToken() {
-  const serviceWorkerRegistration = await navigator.serviceWorker.register('src/firebase-messaging-sw.js', {
+  const serviceWorkerRegistration = await navigator.serviceWorker.register('/sw.js', {
     type: 'module'
   })