simplify

silesky · silesky · commit fe72fc5e2505 · 2023-01-03T02:40:57.000-06:00
diff --git a/packages/browser/src/core/events/interfaces.ts b/packages/browser/src/core/events/interfaces.ts
@@ -1,5 +1,4 @@
 import {
-  CoreTraits,
   CoreOptions,
   CoreSegmentEvent,
   Callback,
@@ -11,27 +10,14 @@ import {
   JSONValue,
   JSONPrimitive,
   JSONObject,
-  CoreGroupTraits,
-  CoreUserTraits,
+  GroupTraits,
+  UserTraits,
+  Traits,
 } from '@segment/analytics-core'
 
 export interface Options extends CoreOptions {}
 
-export interface Traits extends CoreTraits {}
-
-/**
- * Traits are pieces of information you know about a group.
- * This interface represents reserved traits that Segment has standardized.
- * @link https://segment.com/docs/connections/spec/group/#traits
- */
-export interface GroupTraits extends CoreGroupTraits {}
-
-/**
- * Traits are pieces of information you know about a user.
- * This interface represents reserved traits that Segment has standardized.
- * @link https://segment.com/docs/connections/spec/identify/#traits
- */
-export interface UserTraits extends CoreUserTraits {}
+export type { GroupTraits, UserTraits, Traits }
 
 export type EventProperties = Record<string, any>
 
diff --git a/packages/core-integration-tests/src/typedef-tests.ts b/packages/core-integration-tests/src/typedef-tests.ts
@@ -1,4 +1,4 @@
-import { CoreTraits, CoreExtraContext } from '@segment/analytics-core'
+import { Traits, CoreExtraContext } from '@segment/analytics-core'
 
 class TestClass {
   name = 'hello'
@@ -8,8 +8,8 @@ class TestClass {
 }
 
 export default {
-  'CoreTraits test': () => {
-    let traits: CoreTraits = {}
+  'Traits test': () => {
+    let traits: Traits = {}
 
     // should accept a class
     traits = new TestClass()
diff --git a/packages/core/src/events/index.ts b/packages/core/src/events/index.ts
@@ -7,8 +7,8 @@ import {
   CoreSegmentEvent,
   CoreOptions,
   CoreExtraContext,
-  CoreUserTraits,
-  CoreGroupTraits,
+  UserTraits,
+  GroupTraits,
 } from './interfaces'
 import { pickBy } from '../utils/pick'
 import { validateEvent } from '../validation/assertions'
@@ -104,7 +104,7 @@ export class EventFactory {
 
   identify(
     userId: ID,
-    traits?: CoreUserTraits,
+    traits?: UserTraits,
     options?: CoreOptions,
     globalIntegrations?: Integrations
   ): CoreSegmentEvent {
@@ -120,7 +120,7 @@ export class EventFactory {
 
   group(
     groupId: ID,
-    traits?: CoreGroupTraits,
+    traits?: GroupTraits,
     options?: CoreOptions,
     globalIntegrations?: Integrations
   ): CoreSegmentEvent {
diff --git a/packages/core/src/events/interfaces.ts b/packages/core/src/events/interfaces.ts
@@ -32,9 +32,8 @@ export interface CoreOptions {
   context?: CoreExtraContext
   anonymousId?: string
   userId?: string
-  traits?: CoreUserTraits
+  traits?: Traits
   // ugh, this is ugly, but we allow literally any property to be passed to options (which get spread onto the event)
-  // we may want to remove this...
   [key: string]: any
 }
 
@@ -142,7 +141,7 @@ export interface CoreExtraContext {
    * but also associate information from a previous identify call.
    * You should fill this object the same way you would fill traits in an identify call.
    */
-  traits?: CoreUserTraits
+  traits?: Traits
 
   /**
    * Dictionary of information about the campaign that resulted in the API call, containing name, source, medium, term, content, and any other custom UTM parameter.
@@ -187,7 +186,7 @@ export interface CoreSegmentEvent {
 
   properties?: EventProperties
 
-  traits?: CoreTraits // Traits is only defined in 'identify' and 'group', even if it can be passed in other calls.
+  traits?: Traits // Traits is only defined in 'identify' and 'group', even if it can be passed in other calls.
 
   integrations?: Integrations
   context?: CoreExtraContext
@@ -257,30 +256,30 @@ type PhoneNumber = string | number // TODO: the docs say this can only be a stri
  * This interface represents reserved traits that Segment has standardized.
  * @link https://segment.com/docs/connections/spec/group/#traits
  */
-type BaseCoreGroupTraits = DeepNullable<{
+type BaseGroupTraits = DeepNullable<{
   /**
    * Street address of a group.
    */
-  address?: BaseCoreUserTraits['address']
+  address?: BaseUserTraits['address']
 
   /**
    * URL to an avatar image for the group.
    */
-  avatar?: BaseCoreUserTraits['avatar']
+  avatar?: BaseUserTraits['avatar']
 
   /**
    * Date the group's account was first created. Segment recommends ISO-8601 date strings.
    */
-  createdAt?: BaseCoreUserTraits['createdAt']
+  createdAt?: BaseUserTraits['createdAt']
 
   /**
    * Description of a group
    */
-  description?: BaseCoreUserTraits['description']
+  description?: BaseUserTraits['description']
   /**
    * Email address of group.
    */
-  email?: BaseCoreUserTraits['email']
+  email?: BaseUserTraits['email']
   /**
    * Number of employees of a group, typically used for companies.
    */
@@ -289,40 +288,40 @@ type BaseCoreGroupTraits = DeepNullable<{
   /**
    * Unique ID in your database for a group.
    */
-  id?: BaseCoreUserTraits['id']
+  id?: BaseUserTraits['id']
 
   /**
    * Industry a group is part of.
    */
-  industry?: BaseCoreUserTraits['industry']
+  industry?: BaseUserTraits['industry']
 
   /**
    * Name of a group.
    */
-  name?: BaseCoreUserTraits['name']
+  name?: BaseUserTraits['name']
 
   /**
    * Phone number of a group
    */
-  phone?: BaseCoreUserTraits['phone']
+  phone?: BaseUserTraits['phone']
 
   /**
    * Website of a group.
    */
-  website?: BaseCoreUserTraits['website']
+  website?: BaseUserTraits['website']
 
   /**
    * 	Plan that a group is in.
    */
-  plan?: BaseCoreUserTraits['plan']
+  plan?: BaseUserTraits['plan']
 }>
 
 /**
  * Traits are pieces of information you know about a user.
  * This interface represents reserved traits that Segment has standardized.
  * @link https://segment.com/docs/connections/spec/identify/#traits
  */
-type BaseCoreUserTraits = DeepNullable<{
+type BaseUserTraits = DeepNullable<{
   /**
    * Unique ID in your database for a user
    */
@@ -400,9 +399,9 @@ type BaseCoreUserTraits = DeepNullable<{
   company?: {
     name?: string
     id?: DbId
-    industry?: BaseCoreUserTraits['industry']
+    industry?: BaseUserTraits['industry']
     employee_count?: number
-    plan?: BaseCoreUserTraits['plan']
+    plan?: BaseUserTraits['plan']
   }
 
   /**
@@ -438,7 +437,7 @@ type BaseCoreUserTraits = DeepNullable<{
  * This interface represents reserved traits that Segment has standardized.
  * @link https://segment.com/docs/connections/spec/group/#traits
  */
-export type CoreGroupTraits = BaseCoreGroupTraits & {
+export type GroupTraits = BaseGroupTraits & {
   [customTrait: string]: any
 }
 
@@ -447,8 +446,11 @@ export type CoreGroupTraits = BaseCoreGroupTraits & {
  * This interface represents reserved traits that Segment has standardized.
  * @link https://segment.com/docs/connections/spec/identify/#traits
  */
-export type CoreUserTraits = BaseCoreUserTraits & {
+export type UserTraits = BaseUserTraits & {
   [customTrait: string]: any
 }
 
-export type CoreTraits = CoreUserTraits & CoreGroupTraits
+/**
+ * Traits are pieces of information you know about a user or group.
+ */
+export type Traits = UserTraits | GroupTraits
diff --git a/packages/node/src/__tests__/typedef-tests.ts b/packages/node/src/__tests__/typedef-tests.ts
@@ -1,5 +1,4 @@
-import { Analytics, Context, Plugin, GroupTraits } from '../'
-import { Traits, UserTraits } from '../app/types'
+import { Analytics, Context, Plugin, UserTraits, GroupTraits } from '../'
 
 /**
  * These are general typescript definition tests;
@@ -56,6 +55,5 @@ export default {
   'traits should be exported': () => {
     console.log({} as GroupTraits)
     console.log({} as UserTraits)
-    console.log({} as Traits)
   },
 }
diff --git a/packages/node/src/app/types/params.ts b/packages/node/src/app/types/params.ts
@@ -1,28 +1,13 @@
 import type {
-  CoreTraits,
-  CoreGroupTraits,
-  CoreUserTraits,
+  GroupTraits,
+  UserTraits,
   CoreExtraContext,
   EventProperties,
   Integrations,
   Timestamp,
 } from '@segment/analytics-core'
 
-export interface Traits extends CoreTraits {}
-
-/**
- * Traits are pieces of information you know about a group.
- * This interface represents reserved traits that Segment has standardized.
- * @link https://segment.com/docs/connections/spec/group/#traits
- */
-export interface GroupTraits extends CoreGroupTraits {}
-
-/**
- * Traits are pieces of information you know about a user.
- * This interface represents reserved traits that Segment has standardized.
- * @link https://segment.com/docs/connections/spec/identify/#traits
- */
-export interface UserTraits extends CoreUserTraits {}
+export type { GroupTraits, UserTraits }
 
 /**
  * A dictionary of extra context to attach to the call.
diff --git a/packages/node/src/index.ts b/packages/node/src/index.ts
@@ -1,6 +1,6 @@
 export { Analytics } from './app/analytics-node'
 export { Context } from './app/context'
-export { ExtraContext, Plugin, UserTraits, GroupTraits } from './app/types'
+export { Plugin, GroupTraits, UserTraits } from './app/types'
 export type { AnalyticsSettings } from './app/settings'
 
 // export Analytics as both a named export and a default export (for backwards-compat. reasons)
