@hawk.so/types 0.1.32 → 0.1.33

package/build/src/dbScheme/user.d.ts

@@ -1,6 +1,6 @@
-import { ObjectId } from "mongodb";
-import { UserNotificationsDBScheme } from "../../index";
-import { BankCard } from "./bankCard";
+import { ObjectId } from 'mongodb';
+import { UserNotificationsDBScheme } from '../../index';
+import { BankCard } from './bankCard';
 /**
  * Interface representing how user is stored in DB
  */
@@ -42,4 +42,29 @@ export interface UserDBScheme {
      * Saved bank cards for one-click payments
      */
     bankCards?: BankCard[];
+    /**
+     * UTM parameters from signup - Data form where user went to sign up. Used for analytics purposes
+     */
+    utm?: {
+        /**
+         * UTM source - identifies which site sent the traffic
+         */
+        source?: string;
+        /**
+         * UTM medium - identifies what type of link was used
+         */
+        medium?: string;
+        /**
+         * UTM campaign - identifies a specific product promotion or strategic campaign
+         */
+        campaign?: string;
+        /**
+         * UTM content - identifies what specifically was clicked to bring the user to the site
+         */
+        content?: string;
+        /**
+         * UTM term - identifies search terms
+         */
+        term?: string;
+    };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hawk.so/types",
-  "version": "0.1.32",
+  "version": "0.1.33",
   "description": "TypeScript definitions for Hawk",
   "types": "build/index.d.ts",
   "main": "build/index.js",

package/src/dbScheme/user.ts

@@ -1,54 +1,84 @@
-import { ObjectId } from "mongodb";
-import { UserNotificationsDBScheme } from "../../index";
-import { BankCard } from "./bankCard";
+import { ObjectId } from 'mongodb';
+import { UserNotificationsDBScheme } from '../../index';
+import { BankCard } from './bankCard';
 
 /**
  * Interface representing how user is stored in DB
  */
 export interface UserDBScheme {
-    /**
-     * User's id
-     */
-    _id: ObjectId;
+  /**
+   * User's id
+   */
+  _id: ObjectId;
 
-    /**
-     * User's email
-     */
-    email?: string;
+  /**
+   * User's email
+   */
+  email?: string;
 
-    /**
-     * User's password
-     */
-    password?: string;
+  /**
+   * User's password
+   */
+  password?: string;
 
-    /**
-     * User's image url
-     */
-    image?: string;
+  /**
+   * User's image url
+   */
+  image?: string;
+
+  /**
+   * User's name
+   */
+  name?: string;
+
+  /**
+   * User's GitHub profile id
+   */
+  githubId?: string;
+
+  /**
+   * User's original password (this field appears only after registration).
+   * Using to send password to user after registration
+   */
+  generatedPassword?: string;
+
+  /**
+   * User notifications settings
+   */
+  notifications?: UserNotificationsDBScheme;
+
+  /**
+   * Saved bank cards for one-click payments
+   */
+  bankCards?: BankCard[];
 
+  /**
+   * UTM parameters from signup - Data form where user went to sign up. Used for analytics purposes
+   */
+  utm?: {
     /**
-     * User's name
+     * UTM source - identifies which site sent the traffic
      */
-    name?: string;
+    source?: string;
 
     /**
-     * User's GitHub profile id
+     * UTM medium - identifies what type of link was used
      */
-    githubId?: string;
+    medium?: string;
 
     /**
-     * User's original password (this field appears only after registration).
-     * Using to send password to user after registration
+     * UTM campaign - identifies a specific product promotion or strategic campaign
      */
-    generatedPassword?: string;
+    campaign?: string;
 
     /**
-     * User notifications settings
+     * UTM content - identifies what specifically was clicked to bring the user to the site
      */
-    notifications?: UserNotificationsDBScheme;
+    content?: string;
 
     /**
-     * Saved bank cards for one-click payments
+     * UTM term - identifies search terms
      */
-    bankCards?: BankCard[];
+    term?: string;
+  };
 }