notiformer 1.0.5 → 1.0.8

package/README.md

@@ -19,21 +19,21 @@ npm install notiformer
 ## Quick start
 
 ```ts
-import { Notiformer } from 'notiformer';
+import { Notiformer } from "notiformer";
 
 const n = new Notiformer({
-  apiKey: 'ntf_live_...', // from app.notiformer.com/projects
+  apiKey: "ntf_live_...", // from app.notiformer.com/projects
 });
 
 await n.event({
-  channel: 'payments',             // groups related events — auto-created on first use
-  event: 'payment_success',        // machine-readable event name
-  description: '$49.00 — john@example.com', // optional human-readable detail
-  icon: '💳',                      // optional emoji shown in the feed and notification
-  tags: { userId: 'usr_123', plan: 'pro' }, // optional key-value metadata
-  value: '$49.00',                 // optional value highlighted in the feed
-  notify: true,                    // true → push notification | false → silent log only
-  recipients: ['you@company.com'], // optional — notify specific people only (see below)
+  channel: "payments", // groups related events — auto-created on first use
+  event: "payment_success", // machine-readable event name
+  description: "$49.00 — john@example.com", // optional human-readable detail
+  icon: "💳", // optional emoji shown in the feed and notification
+  tags: { userId: "usr_123", plan: "pro" }, // optional key-value metadata
+  value: "$49.00", // optional value highlighted in the feed
+  notify: true, // true → push notification | false → silent log only
+  recipients: ["you@company.com"], // optional — notify specific people only (see below)
 });
 ```
 
@@ -54,24 +54,24 @@ await n.event({
 
 ```ts
 await n.event({
-  channel:     'payments',           // required — string, lowercase, a-z 0-9 - _
-  event:       'payment_success',    // required — machine-readable event name
-
-  description: '$49.00 — john@example.com',  // optional
-  icon:        '💳',                          // optional — emoji
-  tags:        { plan: 'pro', userId: '123' }, // optional — displayed in the event feed
-  value:       '$49.00',                      // optional — highlighted value in the feed
-  notify:      true,                          // optional — default: true
-  recipients:  ['alice@company.com'],         // optional — see "Targeting specific people"
+  channel: "payments", // required — string, lowercase, a-z 0-9 - _
+  event: "payment_success", // required — machine-readable event name
+
+  description: "$49.00 — john@example.com", // optional
+  icon: "💳", // optional — emoji
+  tags: { plan: "pro", userId: "123" }, // optional — displayed in the event feed
+  value: "$49.00", // optional — highlighted value in the feed
+  notify: true, // optional — default: true
+  recipients: ["alice@company.com"], // optional — see "Targeting specific people"
 });
 ```
 
 ### `notify`
 
-| Value | Behaviour |
-|---|---|
-| `true` (default) | Sends push notification to subscribed members |
-| `false` | Stores the event silently for analytics — no notification sent |
+| Value            | Behaviour                                                      |
+| ---------------- | -------------------------------------------------------------- |
+| `true` (default) | Sends push notification to subscribed members                  |
+| `false`          | Stores the event silently for analytics — no notification sent |
 
 ### Return value
 
@@ -93,27 +93,28 @@ You can override this and target specific people by email:
 
 ```ts
 await n.event({
-  channel:     'payments',
-  event:       'large_order',
-  description: '$2,400 — enterprise@client.com',
-  notify:      true,
-  recipients:  ['cto@company.com', 'billing@company.com'], // only these two are notified
+  channel: "payments",
+  event: "large_order",
+  description: "$2,400 — enterprise@client.com",
+  notify: true,
+  recipients: ["cto@company.com", "billing@company.com"], // only these two are notified
 });
 ```
 
 **How it works:**
+
 - If a recipient has a Notiformer account linked to that email and has installed the app, they receive a **push notification**
 - Email notifications are **coming soon** — recipients will receive emails once this feature launches
 - If you don't specify `recipients`, all project members subscribed to the channel are notified
 
 **Plan limits for `recipients`:**
 
-| Plan | Max recipients per event |
-|---|---|
-| Free | 1 |
-| Starter | 3 |
-| Pro | 10 |
-| Business | 30 |
+| Plan     | Max recipients per event |
+| -------- | ------------------------ |
+| Free     | 1                        |
+| Starter  | 3                        |
+| Pro      | 10                       |
+| Business | 30                       |
 
 > Members are managed from the project dashboard at [app.notiformer.com](https://app.notiformer.com/projects).
 
@@ -124,7 +125,7 @@ await n.event({
 Toggle features in your code remotely from the Notiformer dashboard — no redeploy needed.
 
 ```ts
-const isEnabled = await n.gate('new-checkout-flow');
+const isEnabled = await n.gate("new-checkout-flow");
 
 if (isEnabled) {
   // new behaviour
@@ -138,24 +139,24 @@ Gates are **cached locally for 30 seconds** by default to avoid hammering the AP
 ### Options
 
 ```ts
-const isEnabled = await n.gate('my-gate', {
-  fallback:  false, // optional — returned if the gate can't be fetched (default: false)
-  cacheTtl:  60,    // optional — cache duration in seconds (default: 30)
+const isEnabled = await n.gate("my-gate", {
+  fallback: false, // optional — returned if the gate can't be fetched (default: false)
+  cacheTtl: 60, // optional — cache duration in seconds (default: 30)
 });
 ```
 
 ### Full gate result
 
 ```ts
-const result = await n.gateDetails('my-gate');
+const result = await n.gateDetails("my-gate");
 // { key: 'my-gate', enabled: true, cached: false, fetchedAt: '2025-...' }
 ```
 
 ### Clear the cache
 
 ```ts
-n.clearGateCache('my-gate'); // clear a specific gate
-n.clearGateCache();          // clear all gates
+n.clearGateCache("my-gate"); // clear a specific gate
+n.clearGateCache(); // clear all gates
 ```
 
 ---
@@ -164,10 +165,11 @@ n.clearGateCache();          // clear all gates
 
 ```ts
 const n = new Notiformer({
-  apiKey:       'ntf_live_...',  // required — from app.notiformer.com/projects
-  silent:       false,           // optional — true = no API calls (great for local dev)
-  throwOnError: false,           // optional — true = throws instead of returning null
-  onError:      (err) => {       // optional — called when any call fails
+  apiKey: "ntf_live_...", // required — from app.notiformer.com/projects
+  silent: false, // optional — true = no API calls (great for local dev)
+  throwOnError: false, // optional — true = throws instead of returning null
+  onError: (err) => {
+    // optional — called when any call fails
     Sentry.captureException(err);
   },
 });
@@ -178,7 +180,7 @@ const n = new Notiformer({
 ```ts
 const n = new Notiformer({
   apiKey: process.env.NOTIFORMER_API_KEY!,
-  silent: process.env.NODE_ENV !== 'production', // no calls in dev/test
+  silent: process.env.NODE_ENV !== "production", // no calls in dev/test
 });
 ```
 
@@ -186,13 +188,13 @@ const n = new Notiformer({
 
 ## Rate limits & quotas
 
-| Limit | Value |
-|---|---|
-| Events per minute (per project) | 60 |
-| Events per month (Free plan) | 500 |
-| Events per month (Starter) | 20,000 |
-| Events per month (Pro) | 75,000 |
-| Events per month (Business) | 300,000 |
+| Limit                           | Value   |
+| ------------------------------- | ------- |
+| Events per minute (per project) | 60      |
+| Events per month (Free plan)    | 100     |
+| Events per month (Starter)      | 5,000   |
+| Events per month (Pro)          | 75,000  |
+| Events per month (Business)     | 300,000 |
 
 If you exceed **60 events/minute**: the event is stored and visible in your feed, but no notification is sent. The API response includes `rateLimited: true`.
 
@@ -206,12 +208,12 @@ If you exceed your **monthly quota**: the event is rejected with HTTP 429. Upgra
 
 ```ts
 await n.event({
-  channel:     'payments',
-  event:       'payment_success',
+  channel: "payments",
+  event: "payment_success",
   description: `${amount} — ${user.email}`,
-  icon:        '💳',
-  value:       amount,
-  notify:      true,
+  icon: "💳",
+  value: amount,
+  notify: true,
 });
 ```
 
@@ -221,14 +223,14 @@ await n.event({
 // Express error middleware
 app.use(async (err, req, res, next) => {
   await n.event({
-    channel:     'errors',
-    event:       'unhandled_error',
+    channel: "errors",
+    event: "unhandled_error",
     description: err.message,
-    icon:        '🔴',
-    tags:        { path: req.path, method: req.method },
-    notify:      true,
+    icon: "🔴",
+    tags: { path: req.path, method: req.method },
+    notify: true,
   });
-  res.status(500).json({ error: 'Internal server error' });
+  res.status(500).json({ error: "Internal server error" });
 });
 ```
 
@@ -236,10 +238,10 @@ app.use(async (err, req, res, next) => {
 
 ```ts
 await n.event({
-  channel: 'analytics',
-  event:   'page_view',
-  tags:    { path: req.path, userId: session.userId },
-  notify:  false, // stored in feed, no push notification sent
+  channel: "analytics",
+  event: "page_view",
+  tags: { path: req.path, userId: session.userId },
+  notify: false, // stored in feed, no push notification sent
 });
 ```
 
@@ -248,7 +250,7 @@ await n.event({
 ```ts
 // Next.js API route
 export async function POST(req: Request) {
-  const useNewFlow = await n.gate('new-checkout-flow');
+  const useNewFlow = await n.gate("new-checkout-flow");
 
   if (useNewFlow) {
     return newCheckoutHandler(req);
@@ -262,13 +264,13 @@ export async function POST(req: Request) {
 ```ts
 // Only notify the CTO for large orders
 await n.event({
-  channel:     'sales',
-  event:       'enterprise_signup',
+  channel: "sales",
+  event: "enterprise_signup",
   description: `${company} — ${mrr}/mo`,
-  icon:        '🏢',
-  value:       mrr,
-  notify:      true,
-  recipients:  ['cto@yourcompany.com'], // only they get the push
+  icon: "🏢",
+  value: mrr,
+  notify: true,
+  recipients: ["cto@yourcompany.com"], // only they get the push
 });
 ```
 
@@ -329,10 +331,11 @@ Content-Type: application/json
 ```
 
 Response:
+
 ```json
 {
-  "id":          "evt_abc123",
-  "createdAt":   "2025-01-15T10:30:00.000Z",
+  "id": "evt_abc123",
+  "createdAt": "2025-01-15T10:30:00.000Z",
   "rateLimited": false
 }
 ```

package/dist/index.js

@@ -164,7 +164,7 @@ class Notiformer {
                 headers: {
                     "Content-Type": "application/json",
                     Authorization: `Bearer ${this.apiKey}`,
-                    "X-SDK-Version": "1.0.5",
+                    "X-SDK-Version": "1.0.8",
                     ...((_a = init.headers) !== null && _a !== void 0 ? _a : {}),
                 },
             });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "notiformer",
-  "version": "1.0.5",
+  "version": "1.0.8",
   "description": "Real-time alerts, notifications and feature gates for your backend code",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -26,9 +26,12 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/notiformer/notiformer-node"
+    "url": "https://github.com/notiformer/notiformer"
+  },
+  "homepage": "https://docs.notiformer.com",
+  "bugs": {
+    "url": "https://github.com/notiformer/notiformer/issues"
   },
-  "homepage": "https://notiformer.com",
   "devDependencies": {
     "typescript": "^5.3.3"
   },