Features

• Token Registration: Securely associate notification tokens with authenticated customers.
• Device Metadata: Store device information (OS, model, platform) alongside tokens.
• Token Management: List and revoke tokens directly through the Storefront API.
• Smart Updates: Automatically handles token ownership changes if a device is shared.
• Storefront Helpers: Built-in TypeScript helpers for easy integration with your frontend.

Compatibility

• Medusa v2 (>= 2.4.0)
• PostgreSQL

Installation

# Using npm
npm install medusa-notification-token-management

# Using yarn
yarn add medusa-notification-token-management

Configuration

Add the plugin to your medusa-config.ts:

module.exports = defineConfig({
  // ... rest of config
  modules: {
    notification_tokens: {
      resolve: "medusa-notification-token-management",
    },
  },
})

Database Migrations

Run the following command to create the necessary tables:

npx medusa db:migrate

API Reference

Storefront API

All endpoints require customer authentication (Bearer JWT or Session Cookie).

Register/Update Token

POST /store/notification-tokens

Payload:

{
  "token": "fcm-token-123456",
  "device_info": {
    "platform": "ios",
    "os_version": "17.2"
  }
}

List Tokens

GET /store/notification-tokens

Revoke Token

DELETE /store/notification-tokens/:id

Using Helpers

The plugin exports typed helpers for your storefront:

import { registerNotificationToken } from "medusa-notification-token-management/helpers"

const result = await registerNotificationToken({
  token: "my-fcm-token",
  device_info: { platform: "android" }
}, {
  baseUrl: "https://api.myapp.com",
  publishableApiKey: "pk_..."
})

License

MIT