@unchainedshop/plugins/lib/worker/push-notification/adapter.js

Official plugin collection for the Unchained Engine with payment, delivery, and pricing adapters

import { WorkerAdapter } from '@unchainedshop/core';
import { createLogger } from '@unchainedshop/logger';
const logger = createLogger('unchained:worker:push-notification');
let webPush;
try {
    const module = await import('web-push');
    webPush = module.default;
}
catch {
    logger.warn(`optional peer npm package 'web-push' not installed, push notifications will not work`);
}
const { PUSH_NOTIFICATION_PUBLIC_KEY, PUSH_NOTIFICATION_PRIVATE_KEY } = process.env;
export const PushNotificationWorkerPlugin = {
    ...WorkerAdapter,
    key: 'shop.unchained.worker-plugin.push-notification',
    label: 'Push Notification',
    version: '1.0',
    type: 'PUSH',
    doWork: async ({ subscription, subject, payload, urgency = null, topic = null }) => {
        if (!webPush) {
            return {
                success: false,
                error: {
                    name: 'WEB_PUSH_NOT_INSTALLED',
                    message: 'npm dependency web-push is not installed, please install it to use this worker',
                },
            };
        }
        if (!PUSH_NOTIFICATION_PUBLIC_KEY)
            return {
                success: false,
                error: {
                    name: 'VAPID_PUBLIC_KEY_REQUIRED',
                    message: 'vapidPublicKey key required to send push notifications',
                },
            };
        if (!PUSH_NOTIFICATION_PRIVATE_KEY)
            return {
                success: false,
                error: {
                    name: 'VAPID_PRIVATE_KEY_REQUIRED',
                    message: 'vapidPrivateKey key are required to send push notifications',
                },
            };
        if (!subscription) {
            return {
                success: false,
                error: {
                    name: 'USER_SUBSCRIPTION_OBJECT_REQUIRED',
                    message: 'PUSH service subscription required',
                },
            };
        }
        const options = {
            vapidDetails: {
                subject,
                publicKey: PUSH_NOTIFICATION_PUBLIC_KEY,
                privateKey: PUSH_NOTIFICATION_PRIVATE_KEY,
            },
            TTL: 60,
        };
        if (urgency) {
            options.urgency = urgency;
        }
        if (topic) {
            options.topic = topic;
        }
        try {
            await webPush.sendNotification(subscription, payload, options);
            return {
                success: true,
                error: null,
            };
        }
        catch (err) {
            return {
                success: false,
                error: {
                    name: err.name,
                    message: err.message,
                    stack: err.stack,
                },
            };
        }
    },
};
export default PushNotificationWorkerPlugin;