Merge pull request #12 from journy-io/id-mods

added identification object to upsertUser, upsertAccount, link, addEv…

Author: hansott

.github/workflows/build-and-release.yml

@@ -13,18 +13,6 @@ jobs:
           node-version: "12.x"
           registry-url: "https://registry.npmjs.org"
           scope: "@journyio"
-      - name: Cache node modules
-        uses: actions/cache@v2
-        env:
-          cache-name: cache-node-modules
-        with:
-          # npm cache files are stored in `~/.npm` on Linux/macOS
-          path: ~/.npm
-          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-build-${{ env.cache-name }}-
-            ${{ runner.os }}-build-
-            ${{ runner.os }}-
       - run: npm install
       - run: npm run lint
       - run: npm run test

.github/workflows/lint-and-test.yml

@@ -9,18 +9,6 @@ jobs:
         node-version: [12.x, 13.x, 14.x]
     steps:
       - uses: actions/checkout@v2
-      - name: Cache node modules
-        uses: actions/cache@v2
-        env:
-          cache-name: cache-node-modules
-        with:
-          # npm cache files are stored in `~/.npm` on Linux/macOS
-          path: ~/.npm
-          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-build-${{ env.cache-name }}-
-            ${{ runner.os }}-build-
-            ${{ runner.os }}-
       - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v1
         with:

README.md

@@ -67,14 +67,16 @@ _Note: when sending an empty value (`""`) as value for a property, the property
 
 ```ts
 await client.upsertUser({
-  // required
+  // Must provide either an email or userId or both
   userId: "userId", // Unique identifier for the user in your database
-  email: "name@domain.tld",
+  email: "john@doe.tld",
 
   // optional
   properties: {
+    full_name: "John Doe",
+    first_name: "John",
+    last_name: "Doe",
     age: 26,
-    name: "John Doe",
     is_developer: true,
     registered_at: new Date(/* ... */),
     this_property_will_be_deleted: "",
@@ -88,33 +90,39 @@ _Note: when sending an empty value (`""`) as value for a property, the property
 
 ```ts
 await client.upsertAccount({
-  // required
+  // Must provide either an domain or accountId or both
   accountId: "accountId", // Unique identifier for the account in your database
-  name: "journy.io",
+  domain: "acme-inc.com",
 
   // optional
   properties: {
-    age: 26,
-    name: "John Doe",
-    is_developer: true,
+    name: "ACME, Inc",
+    total_amount_of_users: 53,
+    is_paying_account: true,
     registered_at: new Date(/* ... */),
     this_property_will_be_deleted: "",
   },
 
   // optional
-  members: ["userId", "userId"], // Unique identifier for the user in your database
+  members: [
+    { userId: "userId" }, // userID: Unique identifier for the user in your database
+    { userId: "userId" }
+  ]
 });
 ```
 
-#### Link web visitor to an app user
+#### Link web activity to a user
 
-You can link a web visitor to a user in your application when you have our snippet installed on your website. The snippet sets a cookie named `__journey`. If the cookie exists, you can link the web visitor to the user that is currently logged in:
+You can link web activity to a user in your application when you have our snippet installed on your website. The snippet sets a cookie named `__journey`. If the cookie exists, you can link the web activity to the user that is currently logged in:
 
 ```ts
 if (request.cookies["__journey"]) {
   const result = await client.link({
     deviceId: request.cookies["__journey"],
+
     userId: request.user.id, // Unique identifier for the user in your database
+    // or
+    email: request.user.email,
   });
 }
 ```
@@ -124,16 +132,29 @@ if (request.cookies["__journey"]) {
 #### Add event
 
 ```ts
+import { AccountIdentified } from "./AccountIdentified";
 import { Event } from "./Client";
-
-event = Event.forUser("login", "userId");
-event = Event.forUser("some_historic_event", "userId").happenedAt(new Date(...));
-event = Event.forAccount("reached_monthly_volume", "accountId").withMetadata({
-  "number": 1313,
-  "string": "string",
-  "boolean": true,
-});
-event = Event.forUserInAccount("updated_settings", "userId", "accountId");
+import { UserIdentified } from "./UserIdentified";
+
+event = Event.forUser("login", UserIdentified.byUserId("userId"));
+
+event = Event.forUser("some_historic_event", UserIdentified.byUserId("userId"))
+  .happenedAt(new Date(...))
+;
+
+event = Event.forAccount("reached_monthly_volume", AccountIdentified.byAccountId("accountId"))
+  .withMetadata({
+    "number": 1313,
+    "string": "string",
+    "boolean": true,
+  })
+;
+
+event = Event.forUserInAccount(
+  "updated_settings",
+  UserIdentified.byUserId("userId"),
+  AccountIdentified.byAccountId("accountId")
+);
 
 await client.addEvent(event);
 ```

lib/AccountIdentified.ts

@@ -0,0 +1,26 @@
+export class AccountIdentified {
+  constructor(
+    private readonly accountId: string | undefined,
+    private readonly domain: string | undefined
+  ) {
+    if (!this.accountId && !this.domain) {
+      throw new Error("Account ID or domain needs to set!");
+    }
+  }
+
+  getAccountId() {
+    return this.accountId;
+  }
+
+  getDomain() {
+    return this.domain;
+  }
+
+  static byAccountId(accountId: string) {
+    return new AccountIdentified(accountId, undefined);
+  }
+
+  static byDomain(domain: string) {
+    return new AccountIdentified(undefined, domain);
+  }
+}