@trakoo/emitkit 1.0.0 → 1.1.0

package/README.md

@@ -32,6 +32,8 @@ export const serverAnalytics = createServerAnalytics({
 });
 ```
 
+Set `__emitkit_channel` or a boolean `__emitkit_notify` in an event's properties to send that event to another channel or to turn its push notification on or off. The provider strips both before sending.
+
 EmitKit is server-only. To send browser events to it, forward them through trakoo's [Proxy provider](https://trakoo.co/docs/providers/proxy).
 
 The provider also sends page views, as silent events. EmitKit allows 100 requests per minute per API key by default, so if you only want explicit events in your feeds, register it as `{ provider: new EmitKitServerProvider({ ... }), exclude: ['pageView'] }`.

package/dist/server.d.ts

@@ -39,7 +39,8 @@ export interface EmitKitServerConfig {
      */
     categoryChannelMap?: Record<string, string>;
     /**
-     * Send notification for events
+     * Send a push notification for events. An event overrides it with a boolean
+     * `__emitkit_notify` property.
      * @default true
      */
     notify?: boolean;

package/dist/server.js

@@ -81,8 +81,8 @@ export class EmitKitServerProvider extends BaseAnalyticsProvider {
         // Generate event title from action (convert snake_case to Title Case)
         const title = this.formatEventTitle(event.action);
         // Build metadata from event properties and context
-        // Strip __emitkit_channel from properties as it's internal routing metadata
-        const { __emitkit_channel, ...cleanProperties } = event.properties || {};
+        // Strip the __emitkit_* hints from properties: they are delivery settings
+        const { __emitkit_channel, __emitkit_notify, ...cleanProperties } = event.properties || {};
         const metadata = {
             ...cleanProperties,
             category: event.category,
@@ -113,7 +113,7 @@ export class EmitKitServerProvider extends BaseAnalyticsProvider {
                 tags: uniqueTags.length > 0 ? uniqueTags : undefined,
                 metadata: asJsonObject(metadata),
                 userId: userId || null,
-                notify: this.config.notify ?? true,
+                notify: notifyHint(__emitkit_notify, this.config.notify ?? true),
                 displayAs: this.config.displayAs || "notification",
                 source: EVENT_SOURCE,
             });
@@ -129,8 +129,8 @@ export class EmitKitServerProvider extends BaseAnalyticsProvider {
             return;
         // Page views may only use identity supplied in the current context.
         const userId = context?.user?.email || context?.user?.userId;
-        // Strip __emitkit_channel from properties if present
-        const { __emitkit_channel, ...cleanProperties } = properties || {};
+        // Strip the __emitkit_* hints from properties if present
+        const { __emitkit_channel, __emitkit_notify, ...cleanProperties } = properties || {};
         // Build page view metadata
         const metadata = {
             ...cleanProperties,
@@ -155,7 +155,8 @@ export class EmitKitServerProvider extends BaseAnalyticsProvider {
                 tags: ["page_view", "navigation"],
                 metadata: asJsonObject(metadata),
                 userId: userId || null,
-                notify: false, // Don't notify for page views by default
+                // Page views are silent unless the page view asks otherwise
+                notify: notifyHint(__emitkit_notify, false),
                 displayAs: "message",
                 source: EVENT_SOURCE,
             });
@@ -301,6 +302,10 @@ export class EmitKitServerProvider extends BaseAnalyticsProvider {
         return defaultChannel || this.config.channelName || "general";
     }
 }
+/** A boolean `__emitkit_notify` hint, or `fallback` when there is none. */
+function notifyHint(hint, fallback) {
+    return typeof hint === "boolean" ? hint : fallback;
+}
 /**
  * The SDK types metadata and properties as JSON values and serializes them
  * with `JSON.stringify`, so trakoo's properties pass through unchanged.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trakoo/emitkit",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "EmitKit provider for trakoo",
   "type": "module",
   "exports": {
@@ -41,11 +41,11 @@
   },
   "peerDependencies": {
     "@emitkit/js": "^3.0.0",
-    "trakoo": "^2.0.0"
+    "trakoo": "^2.1.0"
   },
   "devDependencies": {
     "@emitkit/js": "^3.0.0",
-    "trakoo": "2.0.0"
+    "trakoo": "2.1.0"
   },
   "scripts": {
     "build": "tsc -p tsconfig.build.json",