Mock Plugin

What is Mock Plugin

The @simplens/mock plugin is a lightweight, zero-dependency provider designed specifically for testing and development within the SimpleNS ecosystem. It simulates notification delivery without actually sending anything.

How It Works

This plugin simulates notification delivery by logging to the console. When a notification is sent:

1. The plugin receives the notification payload
2. Validates the recipient.user_id and content.message fields
3. Logs the notification details to the console
4. Returns { success: true } immediately

Installation

npm run plugin:install @simplens/mock

Configuration

Add the plugin to your simplens.config.yaml if you used Config-first method from Plugin Installation Guide:

providers:
  - package: "@simplens/mock"
    id: mock
    credentials: {}
    options:
      priority: 1
      rateLimit:
        maxTokens: 100
        refillRate: 10

channels:
  mock:
    default: "mock"

Required Credentials

Rate Limit

Environment Variables

# No environment variables required for mock plugin

Notification Payload

• You can easily get and configure this request payload from Payload Studio in Admin Dashboard

{
  "request_id": "uuid-v4",
  "client_id": "uuid-v4",
  "channel": "mock",
  "recipient": {
    "user_id": "user-123"
  },
  "content": {
    "message": "Hello {{name}}, welcome to SimpleNS!"
  },
  "variables": {
    "name": "John"
  }
}

Features