@segment/analytics-browser-actions-bucket 1.1.0

package/src/trackEvent/generated-types.ts

@@ -0,0 +1,18 @@
+// Generated file. DO NOT MODIFY IT BY HAND.
+
+export interface Payload {
+  /**
+   * The event name
+   */
+  name: string
+  /**
+   * Unique identifier for the user
+   */
+  userId: string
+  /**
+   * Object containing the properties of the event
+   */
+  properties?: {
+    [k: string]: unknown
+  }
+}

package/src/trackEvent/index.ts

@@ -0,0 +1,49 @@
+import type { BrowserActionDefinition } from '@segment/browser-destination-runtime/types'
+import type { Settings } from '../generated-types'
+import type { Payload } from './generated-types'
+import type { Bucket } from '../types'
+
+const action: BrowserActionDefinition<Settings, Bucket, Payload> = {
+  title: 'Track Event',
+  description: 'Map a Segment track() event to Bucket',
+  platform: 'web',
+  defaultSubscription: 'type = "track"',
+  fields: {
+    name: {
+      description: 'The event name',
+      label: 'Event name',
+      required: true,
+      type: 'string',
+      default: {
+        '@path': '$.event'
+      }
+    },
+    userId: {
+      type: 'string',
+      required: true,
+      allowNull: false,
+      description: 'Unique identifier for the user',
+      label: 'User ID',
+      default: {
+        '@path': '$.userId'
+      }
+    },
+    properties: {
+      type: 'object',
+      required: false,
+      description: 'Object containing the properties of the event',
+      label: 'Event Properties',
+      default: {
+        '@path': '$.properties'
+      }
+    }
+  },
+  perform: (bucket, { payload }) => {
+    // Ensure we never call Bucket.track() without a user ID
+    if (payload.userId) {
+      void bucket.track(payload.name, payload.properties, payload.userId)
+    }
+  }
+}
+
+export default action

package/src/types.ts

@@ -0,0 +1,3 @@
+import type bucket from '@bucketco/tracking-sdk'
+
+export type Bucket = typeof bucket

package/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.build.json",
+  "compilerOptions": {
+    "rootDir": "./src",
+    "baseUrl": "."
+  },
+  "include": ["src"],
+  "exclude": ["dist", "**/__tests__"]
+}