@customerio/cdp-analytics-core 0.0.1

package/src/validation/assertions.ts

@@ -0,0 +1,43 @@
+import { CoreCustomerioEvent } from '../events'
+import { hasUser, isString, isPlainObject } from './helpers'
+
+export class ValidationError extends Error {
+  field: string
+
+  constructor(field: string, message: string) {
+    super(message)
+    this.field = field
+  }
+}
+
+export function validateEvent(event?: CoreCustomerioEvent | null) {
+  if (!event || typeof event !== 'object') {
+    throw new ValidationError('event', 'Event is missing')
+  }
+
+  if (!isString(event.type)) {
+    throw new ValidationError('type', 'type is not a string')
+  }
+
+  if (event.type === 'track') {
+    if (!isString(event.event)) {
+      throw new ValidationError('event', 'Event is not a string')
+    }
+    if (!isPlainObject(event.properties)) {
+      throw new ValidationError('properties', 'properties is not an object')
+    }
+  }
+
+  if (['group', 'identify'].includes(event.type)) {
+    if (!isPlainObject(event.traits)) {
+      throw new ValidationError('traits', 'traits is not an object')
+    }
+  }
+
+  if (!hasUser(event)) {
+    throw new ValidationError(
+      'userId/anonymousId/previousId/groupId',
+      'Must have userId or anonymousId or previousId or groupId'
+    )
+  }
+}

package/src/validation/helpers.ts

@@ -0,0 +1,27 @@
+import { CoreCustomerioEvent } from '../events'
+
+export function isString(obj: unknown): obj is string {
+  return typeof obj === 'string'
+}
+
+export function isNumber(obj: unknown): obj is number {
+  return typeof obj === 'number'
+}
+
+export function isFunction(obj: unknown): obj is Function {
+  return typeof obj === 'function'
+}
+
+export function isPlainObject(
+  obj: unknown
+): obj is Record<string | symbol | number, any> {
+  return (
+    Object.prototype.toString.call(obj).slice(8, -1).toLowerCase() === 'object'
+  )
+}
+
+export function hasUser(event: CoreCustomerioEvent): boolean {
+  const id =
+    event.userId ?? event.anonymousId ?? event.groupId ?? event.previousId
+  return isString(id)
+}