@things-factory/notification 8.0.0-beta.0 → 8.0.0-beta.2

package/client/viewparts/notification-setting-let.ts

@@ -1,222 +0,0 @@
-import '@material/web/icon/icon.js'
-import '@material/web/switch/switch.js'
-import '@operato/i18n/ox-i18n.js'
-import '@things-factory/setting-base'
-import './notification-sender'
-
-import Clipboard from 'clipboard'
-import { css, html, LitElement } from 'lit'
-import { customElement, property } from 'lit/decorators.js'
-
-import { notify, openPopup } from '@operato/layout'
-import { i18next, localize } from '@operato/i18n'
-
-import { getSubscriptionToken, isSupportingMessaging, subscribe, unsubscribe } from '../actions/notification-fcm'
-
-@customElement('notification-setting-let')
-export class NotificationSettingLet extends localize(i18next)(LitElement) {
-  static styles = [
-    css`
-      div[onoff] {
-        display: flex;
-        align-items: center;
-        border-bottom: var(--border-dim-color);
-        margin-bottom: var(--spacing-medium);
-        padding-bottom: var(--spacing-medium);
-      }
-
-      div[info] {
-        display: flex;
-        flex-direction: column;
-        position: relative;
-      }
-
-      label {
-        display: flex;
-        gap: 10px;
-        align-items: center;
-
-        font: var(--label-font);
-        color: var(--md-sys-color-on-surface);
-        text-transform: var(--label-text-transform);
-      }
-
-      [test] {
-        margin-left: auto;
-      }
-
-      input {
-        border: var(--border-dim-color);
-        border-radius: var(--border-radius);
-        margin: var(--input-margin);
-        padding: var(--input-padding);
-        font: var(--input-font);
-
-        flex: 1;
-      }
-
-      [button-in-field] {
-        --md-icon-size: 18px;
-        position: absolute;
-        top: 24px;
-        right: 4px;
-        width: 30px;
-        padding: 2px;
-        border-radius: var(--border-radius, 5px);
-        color: var(--md-sys-color-on-secondary, #fff);
-        background-color: var(--md-sys-color-secondary, #394e64);
-      }
-    `
-  ]
-
-  @property({ type: Object }) subscription?: any
-  @property({ type: Boolean }) supported?: boolean
-
-  clipboard: any
-
-  render() {
-    const supported = !!this.supported
-
-    return html`
-      <setting-let>
-        <ox-i18n slot="title" msgid="title.notification subscription"></ox-i18n>
-
-        ${supported
-          ? html`
-              <div slot="content" onoff>
-                <label>
-                  <md-switch
-                    label="allow message"
-                    ?selected=${!!this.subscription}
-                    @click=${e => this.onClickSwitch(e)}
-                  ></md-switch>
-                  ${String(i18next.t('label.allow push message'))}
-                </label>
-                <md-outlined-button test @click=${e => this.ontest()}
-                  >${String(i18next.t('button.push message test'))}</md-outlined-button
-                >
-              </div>
-
-              <div slot="content" info>
-                <label for="subscription-token"><ox-i18n msgid="label.subscription token"></ox-i18n></label>
-                <input
-                  id="subscription-token"
-                  type="text"
-                  name="subscription-token"
-                  .value=${this.subscription || ''}
-                  readonly
-                />
-                <md-icon button-in-field clipboard-copy @click=${e => e.preventDefault()}>content_copy</md-icon>
-              </div>
-            `
-          : html` <div slot="content">${i18next.t('text.push notification is not supported in your browser')}</div>`}
-      </setting-let>
-    `
-  }
-
-  updated(changes) {
-    if (changes.has('supported') && this.supported) {
-      const copybuttons = this.renderRoot.querySelectorAll('[clipboard-copy]')
-
-      this.clipboard = new Clipboard(copybuttons, {
-        target: trigger => trigger.parentElement!.querySelector('input')!
-      })
-    }
-  }
-
-  async connectedCallback() {
-    super.connectedCallback()
-
-    if (!('Notification' in window)) {
-      return
-    }
-
-    this.supported = await isSupportingMessaging()
-    this.subscription = await getSubscriptionToken()
-  }
-
-  async onClickSwitch(e) {
-    const target = e.target
-    const on = target.selected
-
-    if (!('Notification' in window)) {
-      notify({
-        level: 'error',
-        message: i18next.t('This browser does not support desktop notification')
-      })
-
-      return
-    }
-
-    try {
-      if (Notification.permission !== 'granted') {
-        const permission = await Notification.requestPermission()
-        if (permission === 'denied') {
-          notify({
-            level: 'error',
-            message: i18next.t('text.web push notification unblock guide')
-          })
-        }
-        return
-      }
-
-      if (Notification.permission === 'granted') {
-        if (on) {
-          const subscription = await getSubscriptionToken()
-
-          if (subscription) {
-            this.subscription = subscription
-            notify({
-              level: 'info',
-              message: i18next.t('text.notification subscribed already')
-            })
-          } else {
-            this.subscription = await subscribe()
-
-            this.subscription &&
-              notify({
-                level: 'info',
-                message: i18next.t('text.notification subscribe started')
-              })
-          }
-        } else {
-          if (this.subscription) {
-            await unsubscribe()
-
-            this.subscription = await getSubscriptionToken()
-
-            notify({
-              level: 'info',
-              message: i18next.t('text.notification unsubscribed')
-            })
-          } else {
-            notify({
-              level: 'info',
-              message: i18next.t('text.notification unsubscribed already')
-            })
-          }
-        }
-      } else {
-        notify({
-          level: 'error',
-          message: i18next.t('text.notification subscribing failed')
-        })
-      }
-    } catch (err) {
-      notify({
-        level: 'error',
-        message: String(err)
-      })
-    } finally {
-      target.checked = !!this.subscription
-    }
-  }
-
-  ontest() {
-    openPopup(html` <notification-sender></notification-sender> `, {
-      backdrop: true,
-      size: 'large',
-      title: i18next.t('title.notification-sender')
-    })
-  }
-}

package/server/controllers/fcm.ts

@@ -1,214 +0,0 @@
-import fetch from 'node-fetch'
-
-import { config, logger } from '@things-factory/env'
-
-import { initializeApp, cert } from 'firebase-admin/app'
-import { getMessaging } from 'firebase-admin/messaging'
-
-const notificationConfig = config.get('notification') || {}
-const { fcm, vapidKey } = notificationConfig
-const { serviceAccount, appConfig, serverKey } = fcm || {}
-const { publicKey } = vapidKey || {}
-
-var messaging
-
-if (serviceAccount) {
-  try {
-    const app = initializeApp({
-      credential: cert(serviceAccount)
-    })
-
-    messaging = getMessaging(app)
-  } catch (err) {
-    logger.error('incorrect notification configuration')
-    logger.error(err)
-  }
-}
-
-export function getConfig() {
-  return messaging
-    ? {
-        appConfig,
-        vapidPublicKey: publicKey
-      }
-    : {}
-}
-
-/**
- * sendNotification
- *
- * @param receiver user.id who will receive notification
- * @param message message object to be sent
- */
-export async function sendNotification({ receivers, message }) {
-  if (!messaging) {
-    return
-  }
-
-  notify({
-    receivers,
-    ...message
-  })
-}
-
-export async function register(user, { subscription }) {
-  if (!messaging || !subscription || !user) {
-    return false
-  }
-
-  try {
-    var notification_key = await getDeviceGroup(user.id)
-
-    if (!notification_key) {
-      await postDeviceGroup({
-        operation: 'create',
-        notification_key_name: user.id,
-        registration_ids: [subscription]
-      })
-    } else {
-      await postDeviceGroup({
-        operation: 'add',
-        notification_key_name: user.id,
-        notification_key,
-        registration_ids: [subscription]
-      })
-    }
-
-    return true
-  } catch (err) {
-    return
-  }
-}
-
-export async function unregister(user, { subscription }) {
-  if (!messaging || !subscription || !user) {
-    return false
-  }
-
-  try {
-    var notification_key = await getDeviceGroup(user.id)
-
-    if (notification_key) {
-      await postDeviceGroup({
-        operation: 'remove',
-        notification_key_name: user.id,
-        notification_key,
-        registration_ids: [subscription]
-      })
-    }
-
-    return true
-  } catch (err) {
-    return
-  }
-}
-
-export async function notify({ receivers, privileges, tokens, topic, title, body, data, image, actions }) {
-  if (!messaging) {
-    return
-  }
-
-  // Caution: non-string attributes are not allowed in FCM payload validation
-  var notification = {
-    title: title || '',
-    body: body || '',
-    image: image || ''
-  }
-
-  if (tokens && tokens instanceof Array && tokens.length > 0) {
-    if (tokens.length > 1) {
-      const response = await messaging.sendMulticast({
-        notification,
-        data,
-        tokens
-      })
-
-      if (response.failureCount > 0) {
-        const failedTokens = []
-        response.responses.forEach((resp, idx) => {
-          if (!resp.success) {
-            failedTokens.push(tokens[idx])
-          }
-        })
-        logger.error('List of tokens that caused failures: ' + failedTokens)
-      }
-    } else {
-      const token = tokens[0]
-
-      try {
-        const response = await messaging.send({
-          notification,
-          data,
-          token
-        })
-        logger.log('Successfully sent message:', response)
-      } catch (err) {
-        logger.error('Error sending message:', err)
-      }
-    }
-  }
-
-  if (topic) {
-    try {
-      const response = await messaging.send({
-        notification,
-        data,
-        topic
-      })
-      logger.log('Successfully sent message:', response)
-    } catch (err) {
-      logger.error('Error sending message:', err)
-    }
-  }
-
-  if (receivers && receivers instanceof Array) {
-    for (let receiver of receivers) {
-      const notification_key = await getDeviceGroup(receiver)
-
-      if (notification_key) {
-        await messaging.sendToDeviceGroup(notification_key, {
-          notification,
-          data
-        })
-      }
-    }
-  }
-}
-
-async function postDeviceGroup(body) {
-  var response = await fetch('https://fcm.googleapis.com/fcm/notification', {
-    method: 'POST',
-    headers: {
-      'Content-Type': 'application/json',
-      Authorization: `key=${serverKey}`,
-      project_id: appConfig.messagingSenderId
-    },
-    body: JSON.stringify(body)
-  })
-
-  if (response.ok) {
-    const { notification_key } = await response.json()
-    return notification_key
-  } else {
-    console.error('postDeviceGroup-notok', response.status, await response.text())
-  }
-}
-
-async function getDeviceGroup(notificationKeyName) {
-  const response = await fetch(
-    `https://fcm.googleapis.com/fcm/notification?notification_key_name=${notificationKeyName}`,
-    {
-      method: 'GET',
-      headers: {
-        'Content-Type': 'application/json',
-        Authorization: `key=${serverKey}`,
-        project_id: appConfig.messagingSenderId
-      }
-    }
-  )
-
-  if (response.ok) {
-    const { notification_key } = await response.json()
-    return notification_key
-  }
-}

package/server/controllers/index.ts

@@ -1 +0,0 @@
-export * from './fcm'

package/server/index.ts

@@ -1,5 +0,0 @@
-export * from './service'
-export * from './middlewares'
-export * from './controllers'
-
-import './routes'

package/server/middlewares/index.ts

@@ -1,5 +0,0 @@
-import { notificationMiddleware } from './notification-middleware'
-
-export function initMiddlewares(app) {
-  app.use(notificationMiddleware)
-}

package/server/middlewares/notification-middleware.ts

@@ -1,73 +0,0 @@
-import { pubsub } from '@things-factory/shell'
-import { logger } from '@things-factory/env'
-
-import { notify } from '../controllers/fcm'
-
-const debug = require('debug')('things-factory:notification:notification-middleware')
-
-function notifier(context) {
-  return async function ({
-    receivers,
-    privileges,
-    tokens,
-    topic,
-    type,
-    subject = 'info',
-    title,
-    body,
-    image,
-    url,
-    actions,
-    timestamp = Date.now(),
-    mode = 'background'
-  }) {
-    const { domain, user } = context.state
-
-    try {
-      if (mode === 'background') {
-        /* for send webpush notification message */
-
-        await notify({
-          receivers,
-          privileges,
-          tokens,
-          topic,
-          title,
-          body,
-          data: {
-            type,
-            url,
-            timestamp: String(timestamp)
-          },
-          image,
-          actions
-        })
-      } else {
-        /* for send publish notification to clients */
-        // TODO CONFIRM data format
-        await pubsub.publish('notification', {
-          notification: {
-            domain,
-            subject,
-            type,
-            title,
-            body,
-            image,
-            url,
-            timestamp
-          }
-        })
-      }
-    } catch (err) {
-      logger.error(err)
-    }
-  }
-}
-
-export async function notificationMiddleware(context: any, next: any) {
-  if (!context.state.notify) {
-    context.state.notify = notifier(context)
-  }
-
-  await next()
-}

package/server/routers/notification-router.ts

@@ -1,67 +0,0 @@
-import Router from 'koa-router'
-import { ILike } from 'typeorm'
-
-import { User } from '@things-factory/auth-base'
-import { getRepository } from '@things-factory/shell'
-
-import { getConfig, register, unregister } from '../controllers/fcm'
-
-const debug = require('debug')('things-factory:notification:notification-router')
-
-export const notificationRouter = new Router({
-  prefix: '/notification'
-})
-
-notificationRouter.get('/config', async (context, next) => {
-  const config = getConfig()
-
-  context.type = 'application/json'
-  context.body = config
-})
-
-notificationRouter.post('/register', async (context, next) => {
-  const { user } = context.state
-  const { body } = context.request
-  context.body = await register(user, body)
-  context.status = 200
-})
-
-notificationRouter.post('/unregister', async (context, next) => {
-  const { user } = context.state
-  const { body } = context.request
-  context.body = await unregister(user, body)
-  context.status = 200
-})
-
-notificationRouter.post('/notify', async (context, next) => {
-  const { user, domain, notify } = context.state
-  const repository = getRepository(User)
-
-  var { receivers, ...options } = context.request.body
-
-  debug('post:/notify', receivers, receivers.split(','), options)
-
-  // TODO filter only users having current domain privilege
-  receivers = (
-    await Promise.all(
-      receivers
-        .split(',')
-        .map(email => email.trim())
-        .map(async email => {
-          var receiver: User = await repository.findOneBy({ email: ILike(email) })
-          return receiver && receiver.id
-        })
-    )
-  ).filter(receiver => !!receiver)
-
-  debug('post:/notify', receivers, user.id)
-
-  await notify({
-    receivers: receivers.length > 0 ? receivers : [user.id],
-    ...options
-  })
-
-  context.body = {
-    success: true
-  }
-})

package/server/routes.ts

@@ -1,11 +0,0 @@
-import { notificationRouter } from './routers/notification-router'
-
-process.on('bootstrap-module-global-public-route' as any, (app, globalPublicRouter) => {})
-
-process.on('bootstrap-module-global-private-route' as any, (app, globalPrivateRouter) => {})
-
-process.on('bootstrap-module-domain-public-route' as any, (app, domainPublicRouter) => {})
-
-process.on('bootstrap-module-domain-private-route' as any, (app, domainPrivateRouter) => {
-  domainPrivateRouter.use('', notificationRouter.routes(), notificationRouter.allowedMethods())
-})

package/server/service/index.ts

@@ -1,42 +0,0 @@
-/* EXPORT ENTITY TYPES */
-export * from './notification-rule/notification-rule'
-export * from './notification/notification'
-
-/* IMPORT ENTITIES AND RESOLVERS */
-import {
-  entities as NotificationRuleEntities,
-  resolvers as NotificationRuleResolvers,
-  subscribers as NotificationRuleSubscribers
-} from './notification-rule'
-import {
-  entities as NotificationEntities,
-  typeDefs as NotificationTypeDefs,
-  resolvers as NotificationResolvers,
-  directives as NotificationDirectives
-} from './notification'
-
-export const entities = [
-  /* ENTITIES */
-  ...NotificationRuleEntities,
-  ...NotificationEntities
-]
-
-export const subscribers = [
-  /* SUBSCRIBERS */
-  ...NotificationRuleSubscribers
-]
-
-export const schema = {
-  typeDefs: {
-    ...NotificationTypeDefs
-  },
-  resolverClasses: [
-    /* RESOLVER CLASSES */
-    ...NotificationRuleResolvers,
-    ...NotificationResolvers,
-    ...NotificationResolvers
-  ],
-  directives: {
-    ...NotificationDirectives
-  }
-}