@nitra/cap 7.1.0 → 7.1.2

package/app-update/README.md

@@ -0,0 +1,23 @@
+# Проверка и установка новой версии приложение в маркете
+
+## API
+
+- [`updateApp(...)`](#updateapp)
+
+### updateApp(...)
+
+```typescript
+updateApp(isImmediate: boolean | undefined, isMandatory: boolean | undefined ) => Promise<void>
+```
+
+Проверка и установка новой версии приложение в маркете
+
+Для **Android**, через [In-app updates](https://developer.android.com/guide/playcore/in-app-updates)]  
+Для **IOS**, открываем App Store
+
+| Параметр          | Тип       | Описание                                                          |
+|-------------------|-----------|-------------------------------------------------------------------|
+| **`isImmediate`** | `boolean` | только Android, обновление "в полный" экран, по-умолчанию - false |
+| **`isMandatory`** | `boolean` | только Android, обязательно обновление, по-умолчанию - false      |
+
+---

package/app-update/index.js

@@ -0,0 +1,49 @@
+import { Capacitor } from '@capacitor/core'
+import {
+  AppUpdate,
+  AppUpdateAvailability,
+  FlexibleUpdateInstallStatus,
+  AppUpdateResultCode
+} from '@capawesome/capacitor-app-update'
+
+/**
+ * Проверка наличия обновления, для Android установка обновления, IOS - открытие AppStore
+ * @async
+ * @function updateApp
+ * @param {boolean} isImmediate - только Android, обновление "в полный" экран, по-умолчанию - false
+ * @param {boolean} isMandatory - только Android, обязательно обновление, по-умолчанию - false
+ */
+export async function updateApp(isImmediate, isMandatory) {
+  if (!Capacitor.isNativePlatform() || !Capacitor.isPluginAvailable('AppUpdate')) {
+    return
+  }
+  const { updateAvailability } = await AppUpdate.getAppUpdateInfo()
+  if (updateAvailability !== AppUpdateAvailability.UPDATE_AVAILABLE) {
+    return
+  }
+  if (Capacitor.getPlatform() === 'ios') {
+    await AppUpdate.openAppStore()
+    return
+  }
+  if (Capacitor.getPlatform() === 'android') {
+    if (isImmediate) {
+      const appUpdateResult = await AppUpdate.performImmediateUpdate()
+      if (
+        isMandatory &&
+        (appUpdateResult.code === AppUpdateResultCode.CANCELED ||
+          appUpdateResult.code === AppUpdateResultCode.NOT_ALLOWED)
+      ) {
+        await updateApp(isImmediate, isMandatory)
+      }
+    } else {
+      AppUpdate.addListener('onFlexibleUpdateStateChange', flexibleUpdateState => {
+        if (flexibleUpdateState.installStatus === FlexibleUpdateInstallStatus.DOWNLOADED) {
+          AppUpdate.removeAllListeners()
+          AppUpdate.completeFlexibleUpdate()
+        }
+      })
+      await AppUpdate.startFlexibleUpdate()
+    }
+    return
+  }
+}

package/auth/index.js

@@ -0,0 +1,6 @@
+export { default as NCapLoginApple } from './NCapLoginApple.vue'
+export { default as NCapLoginGoogle } from './NCapLoginGoogle.vue'
+export { default as NCapLoginMulti } from './NCapLoginMulti.vue'
+export { default as NDialog } from './NDialog.vue'
+export { default as NForgotPass } from './NForgotPass.vue'
+export { default as NLoginGoogle } from './NLoginGoogle.vue'

package/index.js

@@ -0,0 +1,3 @@
+export * from './app-update'
+export * from './save-token'
+export * from './auth'

package/package.json

@@ -1,11 +1,10 @@
 {
   "name": "@nitra/cap",
-  "version": "7.1.0",
+  "version": "7.1.2",
   "description": "Nitra capacitor components",
   "type": "module",
   "exports": {
-    ".": "./index.js",
-    "./auth/*": "./auth/*"
+    ".": "./index.js"
   },
   "scripts": {
     "fix": "yarn dlx eslint --fix . && npx prettier --write . "
@@ -31,8 +30,5 @@
     "@nitra/vite-boot": "^3.7.1",
     "@simplewebauthn/browser": "^11.0.0",
     "firebase": "^12.3.0"
-  },
-  "files": [
-    "auth"
-  ]
+  }
 }

package/save-token/README.md

@@ -0,0 +1,121 @@
+# Receiving and Saving User Push Tokens
+
+## Description
+
+This library is designed to handle obtaining and saving Firebase push tokens on the client side. It supports both mobile platforms (via Capacitor) and web platforms. The main function, `saveToken`, retrieves a push token from Firebase, stores it locally, and sends it to your server.
+
+This library interacts with Firebase for token management and Capacitor to check the platform and permissions. It ensures that push tokens are properly handled, regardless of whether the platform is iOS, Android, or Web.
+
+## API
+
+### `saveToken()`
+
+```typescript
+saveToken() => Promise<void>
+```
+
+## usage the library
+
+### To use this package, you should add this env to your project where you want to provide push notifications
+
+`VITE_APP=test`
+`VITE_PROJECT_ID=test`
+`VITE_VAPID_KEY=test`
+`VITE_API_KEY=test`
+`VITE_AUTH_DOMAIN=test`
+`VITE_STORAGE_BUCKET=test`
+`VITE_MESSAGING_SENDER_ID=test`
+`VITE_APP_ID=test`
+
+## example in node
+
+### Using function after login
+
+```jsx
+    <template>
+    <n-code :on-token-checked="saveToken" />
+    </template>
+
+    <script setup>
+    import NCode from '@nitra/abie-components/auth/NCode.vue'
+    import { saveToken } from '@nitra/cap'
+
+    await saveToken()
+    </script>
+
+    <route lang="yaml">
+    meta:
+    layout: blank
+    </route>
+
+```
+
+## Environment Variable Validation with Vite
+
+### 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_STORAGE_BUCKET',
+      'VITE_MESSAGING_SENDER_ID',
+      '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
+      }
+    }
+  }
+}
+```
+
+# For local test you can add this code
+if (process.env.npm_lifecycle_event === 'start-remote-dev') {
+  proxy['^/n-push/.*'] = ''
+} else {
+  proxy['^/n-push/.*'] = '<http://0.0.0.0:8090>'
+}
+
+/n-push/ - url of the notify project
+
+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.
+
+### Install the plugin in the project directory
+
+```typescript
+yarn add -D @nitra/vite-check-env
+```

package/save-token/index.js

@@ -0,0 +1,108 @@
+import { Capacitor } from '@capacitor/core'
+import { FirebaseMessaging } from '@capacitor-firebase/messaging'
+import { getToken } from '@nitra/vite-boot/token'
+import { initializeApp, getApps } from 'firebase/app'
+
+/**
+ * Save the Firebase push token for a given app and platform.
+ * @returns {Promise<void>}
+ */
+export async function saveToken() {
+  try {
+    if (localStorage.getItem(`pushToken_${import.meta.env.VITE_APP}`)) {
+      console.log('Push Token is already exists.')
+
+      return
+    }
+
+    // Check if Firebase is already initialized
+    if (getApps().length === 0) {
+      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
+      })
+    }
+
+    if (Capacitor.isNativePlatform() && !Capacitor.isPluginAvailable('FirebaseMessaging')) {
+      console.error('FirebaseMessaging plugin is not available')
+
+      return
+    }
+
+    let permissions = await FirebaseMessaging.checkPermissions()
+
+    if (permissions.receive !== 'granted') {
+      console.warn('Permissions are not granted, try to request permissions...')
+
+      let permissionsRequest = await FirebaseMessaging.requestPermissions()
+
+      if (permissionsRequest.receive !== 'granted') {
+        console.error('Permissions are not granted, exiting...')
+
+        return
+      }
+    }
+
+    const pushToken = Capacitor.isNativePlatform()
+      ? await FirebaseMessaging.getToken() // For iOS/Android
+      : await getWebPushToken()
+
+    if (!pushToken?.token && typeof pushToken?.token !== 'string') {
+      console.error('Token is undefined exiting...')
+
+      return
+    }
+
+    await sendTokenToServer(pushToken.token)
+  } catch (error) {
+    console.error('Error while saving push token:', error)
+  }
+}
+
+/**
+ * Get the Firebase push token for web platform.
+ * @returns {Promise<object>} Web Push token
+ */
+async function getWebPushToken() {
+  try {
+    const serviceWorkerRegistration = await navigator.serviceWorker.register('sw.js', {
+      type: 'module'
+    })
+
+    return await FirebaseMessaging.getToken({
+      vapidKey: import.meta.env.VITE_VAPID_KEY,
+      serviceWorkerRegistration
+    })
+  } catch (error) {
+    console.error('Error getting web push token:', error)
+    throw error
+  }
+}
+
+/**
+ * Send the Firebase push token to the server.
+ * @param {string} pushToken - The push token returned by Firebase Messaging.
+ * @returns {Promise<void>}
+ */
+async function sendTokenToServer(pushToken) {
+  const response = await fetch('/n-push/save-user', {
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/json',
+      authorization: `Bearer ${getToken()}`
+    },
+    body: JSON.stringify({
+      platform: Capacitor.getPlatform(),
+      app: import.meta.env.VITE_APP,
+      token: pushToken
+    })
+  })
+
+  if (response.ok) {
+    localStorage.setItem(`pushToken_${import.meta.env.VITE_APP}`, pushToken)
+  }
+}

package/save-token/sw.js

@@ -0,0 +1,13 @@
+import { getMessaging } from 'https://www.gstatic.com/firebasejs/10.13.2/firebase-messaging-sw.js'
+import { initializeApp } from 'https://www.gstatic.com/firebasejs/10.13.2/firebase-app.js'
+
+const firebaseApp = 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
+})
+
+export const messaging = getMessaging(firebaseApp)