@artisan-commerce/analytics-rn 0.2.0-canary.27 → 0.2.0-canary.28

package/CHANGELOG.md

@@ -3,6 +3,15 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.2.0-canary.28](https://bitbucket.org/tradesystem/artisan_sdk/compare/@artisan-commerce/analytics-rn@0.2.0-canary.27...@artisan-commerce/analytics-rn@0.2.0-canary.28) (2021-06-23)
+
+
+### Features
+
+* **analytics:** add identify functionality for segment ([9497750](https://bitbucket.org/tradesystem/artisan_sdk/commit/9497750a67c19165bfdc13f602cdc9c3ad4bbc37))
+
+
+
 ## [0.2.0-canary.27](https://bitbucket.org/tradesystem/artisan_sdk/compare/@artisan-commerce/analytics-rn@0.2.0-canary.26...@artisan-commerce/analytics-rn@0.2.0-canary.27) (2021-06-18)
 
 **Note:** Version bump only for package @artisan-commerce/analytics-rn

package/build/analytics-rn/src/index.d.ts

@@ -7,3 +7,4 @@ export * from "./lib/providers/GoogleAnalytics/GoogleAnalytics.types";
 export { default as events } from "./lib/events/events";
 export * from "./types/common.types";
 export { updateActiveVendor } from "./utils/state.utils";
+export { identifyUser } from "./utils/segment.utils";

package/build/analytics-rn/src/lib/initAnalytics/initAnalytics.types.d.ts

@@ -19,6 +19,18 @@ export interface InitAnalyticsConfig {
     debug?: boolean;
     meta: InitAnalyticsConfigMeta;
 }
+/**
+ * Commerce's metadata
+ *
+ * @interface InitAnalyticsConfigMeta
+ * @since 0.5.14
+ * @extends AnalyticsMeta
+ * @property {string} vendorName The name of the active vendor
+ * @property {number} storeId The id of the active store
+ * @property {string} storeName The name of the active store
+ * @property {number} catalogueId The id of the active catalogue
+ * @property {string} catalogueName The name of the active catalogue
+ */
 export interface InitAnalyticsConfigMeta extends Omit<AnalyticsMeta, "vendorId" | "versionSDK" | "platform" | "vendorName" | "storeId" | "storeName" | "catalogueId" | "catalogueName"> {
     vendorName?: AnalyticsMeta["vendorName"] | undefined;
     storeId?: AnalyticsMeta["storeId"] | undefined;

package/build/analytics-rn/src/lib/providers/Segment/Segment.types.d.ts

@@ -55,4 +55,40 @@ export declare namespace Segment {
         url?: string;
         image_url?: string;
     }
+    interface Address {
+        city?: string;
+        country?: string;
+        postalCode?: string;
+        state?: string;
+        street?: string;
+        [key: string]: any;
+    }
+    interface Company {
+        name?: string;
+        id?: string | number;
+        industry?: string;
+        employee_count?: number;
+        plan?: string;
+        [key: string]: any;
+    }
+    interface Traits {
+        id: string;
+        address?: Address;
+        age?: number;
+        avatar?: string;
+        bithday?: string;
+        company?: Company;
+        createdAt?: string;
+        description?: string;
+        email?: string;
+        firstName?: string;
+        gender?: string;
+        lastName?: string;
+        name?: string;
+        phone?: string;
+        title?: string;
+        username?: string;
+        website?: string;
+        [key: string]: any;
+    }
 }

package/build/analytics-rn/src/lib/providers/Segment/events/auth/signIn/signIn.types.d.ts

@@ -1,5 +1,5 @@
 import { SignInCommonParams } from "../../../../../events/auth/signIn/signIn.types";
-import { SegmentCommonEventParams } from "../../../Segment.types";
+import { Segment, SegmentCommonEventParams } from "../../../Segment.types";
 import { SegmentCustomEventParams } from "../../../Segment.types";
 /**
  * Event allowed parameters.
@@ -10,7 +10,9 @@ import { SegmentCustomEventParams } from "../../../Segment.types";
  * @extends SegmentCustomEventParams
  * @extends SignInCommonParams
  * @property {string} name The user's name
+ * @property {Segment.Traits} identify Pieces of information you know about a user that are included in an identify call
  */
 export interface SignInParams extends SegmentCommonEventParams, SegmentCustomEventParams, SignInCommonParams {
     name: string;
+    identify?: Segment.Traits;
 }

package/build/analytics-rn/src/lib/providers/Segment/events/auth/signUp/signUp.types.d.ts

@@ -1,5 +1,5 @@
 import { SignUpCommonParams } from "../../../../../events/auth/signUp/signUp.types";
-import { SegmentCommonEventParams } from "../../../Segment.types";
+import { Segment, SegmentCommonEventParams } from "../../../Segment.types";
 import { SegmentCustomEventParams } from "../../../Segment.types";
 /**
  * Event allowed parameters.
@@ -11,8 +11,10 @@ import { SegmentCustomEventParams } from "../../../Segment.types";
  * @extends SignUpCommonParams
  * @property {string} name The user's name
  * @property {string} email The user's email
+ * @property {Segment.Traits} identify Pieces of information you know about a user that are included in an identify call
  */
 export interface SignUpParams extends SegmentCommonEventParams, SegmentCustomEventParams, SignUpCommonParams {
     name: string;
     email: string;
+    identify?: Segment.Traits;
 }

package/build/analytics-rn/src/lib/providers/Segment/events/shipping/addShippingAddress/addShippingAddress.types.d.ts

@@ -1,5 +1,5 @@
 import { AddShippingAddressCommonParams } from "../../../../../events/shipping/addShippingAddress/addShippingAddress.types";
-import { SegmentCommonEventParams } from "../../../Segment.types";
+import { Segment, SegmentCommonEventParams } from "../../../Segment.types";
 import { SegmentCustomEventParams } from "../../../Segment.types";
 /**
  * Event allowed parameters.
@@ -9,6 +9,8 @@ import { SegmentCustomEventParams } from "../../../Segment.types";
  * @extends SegmentCommonEventParams
  * @extends SegmentCustomEventParams
  * @extends AddShippingAddressCommonParams
+ * @property {Segment.Traits} identify Pieces of information you know about a user that are included in an identify call
  */
 export interface AddShippingAddressParams extends SegmentCommonEventParams, SegmentCustomEventParams, AddShippingAddressCommonParams {
+    identify?: Segment.Traits;
 }

package/build/analytics-rn/src/lib/providers/Segment/events/shipping/selectShippingAddress/selectShippingAddress.types.d.ts

@@ -1,5 +1,5 @@
 import { SelectShippingAddressCommonParams } from "../../../../../events/shipping/selectShippingAddress/selectShippingAddress.types";
-import { SegmentCommonEventParams } from "../../../Segment.types";
+import { Segment, SegmentCommonEventParams } from "../../../Segment.types";
 import { SegmentCustomEventParams } from "../../../Segment.types";
 /**
  * Event allowed parameters.
@@ -9,6 +9,8 @@ import { SegmentCustomEventParams } from "../../../Segment.types";
  * @extends SegmentCommonEventParams
  * @extends SegmentCustomEventParams
  * @extends SelectShippingAddressCommonParams
+ * @property {Segment.Traits} identify Pieces of information you know about a user that are included in an identify call
  */
 export interface SelectShippingAddressParams extends SegmentCommonEventParams, SegmentCustomEventParams, SelectShippingAddressCommonParams {
+    identify?: Segment.Traits;
 }

package/build/analytics-rn/src/lib/providers/Segment/events/shipping/updateShippingAddress/updateShippingAddress.types.d.ts

@@ -1,5 +1,5 @@
 import { UpdateShippingAddressCommonParams } from "../../../../../events/shipping/updateShippingAddress/updateShippingAddress.types";
-import { SegmentCommonEventParams } from "../../../Segment.types";
+import { Segment, SegmentCommonEventParams } from "../../../Segment.types";
 import { SegmentCustomEventParams } from "../../../Segment.types";
 /**
  * Event allowed parameters.
@@ -9,6 +9,8 @@ import { SegmentCustomEventParams } from "../../../Segment.types";
  * @extends SegmentCommonEventParams
  * @extends SegmentCustomEventParams
  * @extends UpdateShippingAddressCommonParams
+ * @property {Segment.Traits} identify Pieces of information you know about a user that are included in an identify call
  */
 export interface UpdateShippingAddressParams extends SegmentCommonEventParams, SegmentCustomEventParams, UpdateShippingAddressCommonParams {
+    identify?: Segment.Traits;
 }

package/build/analytics-rn/src/lib/providers/Segment/events/user/setUserInfo/setUserInfo.types.d.ts

@@ -1,5 +1,5 @@
 import { SetUserInfoCommonParams } from "../../../../../events/user/setUserInfo/setUserInfo.types";
-import { SegmentCommonEventParams } from "../../../Segment.types";
+import { Segment, SegmentCommonEventParams } from "../../../Segment.types";
 import { SegmentCustomEventParams } from "../../../Segment.types";
 /**
  * Event allowed parameters.
@@ -9,6 +9,8 @@ import { SegmentCustomEventParams } from "../../../Segment.types";
  * @extends SegmentCommonEventParams
  * @extends SegmentCustomEventParams
  * @extends SetUserInfoCommonParams
+ * @property {Segment.Traits} identify Pieces of information you know about a user that are included in an identify call
  */
 export interface SetUserInfoParams extends SegmentCommonEventParams, SegmentCustomEventParams, SetUserInfoCommonParams {
+    identify?: Segment.Traits;
 }

package/build/analytics-rn/src/lib/providers/Segment/events/user/updateUserInfo/updateUserInfo.types.d.ts

@@ -1,5 +1,5 @@
 import { UpdateUserInfoCommonParams } from "../../../../../events/user/updateUserInfo/updateUserInfo.types";
-import { SegmentCommonEventParams } from "../../../Segment.types";
+import { Segment, SegmentCommonEventParams } from "../../../Segment.types";
 import { SegmentCustomEventParams } from "../../../Segment.types";
 /**
  * Event allowed parameters.
@@ -9,6 +9,8 @@ import { SegmentCustomEventParams } from "../../../Segment.types";
  * @extends SegmentCommonEventParams
  * @extends SegmentCustomEventParams
  * @extends UpdateUserInfoCommonParams
+ * @property {Segment.Traits} identify Pieces of information you know about a user that are included in an identify call
  */
 export interface UpdateUserInfoParams extends SegmentCommonEventParams, SegmentCustomEventParams, UpdateUserInfoCommonParams {
+    identify?: Segment.Traits;
 }

package/build/analytics-rn/src/utils/segment.utils.d.ts

@@ -0,0 +1,8 @@
+import { Segment } from "../lib/providers/Segment/Segment.types";
+/**
+ * Utility function to identify a user across Segment destinations.
+ *
+ * @since 0.5.14
+ * @param {Segment.Traits} identify Pieces of information you know about a user that are included in an identify call
+ */
+export declare const identifyUser: (identify: Segment.Traits) => void;