posthog-node 1.2.0 → 1.3.0

package/event-validation.js

@@ -24,6 +24,8 @@ function eventValidation(event, type) {
             return validateAliasEvent(event)
         case 'groupIdentify':
             return validateGroupIdentifyEvent(event)
+        case 'isFeatureEnabled':
+            return validateIsFeatureEnabled(event)
         default:
             assert(0, 'Invalid event type: "' + type + '"')
     }
@@ -64,6 +66,20 @@ function validateAliasEvent(event) {
     assert(event.groupKey, 'You must pass a "groupKey".')
 }
 
+/**
+ * Validate a "isFeatureEnabled" call
+ */
+
+ function validateIsFeatureEnabled(event) {
+    assert(event.key, 'You must pass a "key".')
+    assert(event.distinctId, 'You must pass a "distinctId".')
+    assert(type(event.defaultResult) == 'boolean', '"defaultResult" must be a boolean.')
+    if (event.groups) {
+        assert(type(event.groups) == 'object', 'You must pass an object for "groups".')
+    }
+}
+
+
 /**
  * Validation rules.
  */

package/feature-flags.js

@@ -32,7 +32,7 @@ class FeatureFlagsPoller {
         void this.loadFeatureFlags()
     }
 
-    async isFeatureEnabled(key, distinctId, defaultResult = false) {
+    async isFeatureEnabled(key, distinctId, defaultResult = false, groups = {}) {
         await this.loadFeatureFlags()
 
         if (!this.loadedSuccessfullyOnce) {
@@ -61,7 +61,7 @@ class FeatureFlagsPoller {
                 rolloutPercentage: featureFlag.rolloutPercentage,
             })
         } else {
-            const res = await this._request({ path: 'decide', method: 'POST', data: { distinct_id: distinctId } })
+            const res = await this._request({ path: 'decide', method: 'POST', data: { groups, distinct_id: distinctId } })
             isFlagEnabledResponse = res.data.featureFlags.indexOf(key) >= 0
         }
 
@@ -147,7 +147,7 @@ class FeatureFlagsPoller {
 
         let res
         try {
-            res = await axios(req)
+            res = await axios.request(req)
         } catch (err) {
             throw new Error(`Request to ${path} failed with error: ${err.message}`)
         }

package/index.d.ts

@@ -20,9 +20,12 @@ declare module 'posthog-node' {
         groups?: Record<string, string | number> // Mapping of group type to group id
     }
 
+    type GroupType = string
+    type GroupKey = string
+
     interface GroupIdentifyMessage {
-        groupType: string
-        groupKey: string // Unique identifier for the group
+        groupType: GroupType
+        groupKey: GroupKey // Unique identifier for the group
         properties?: Record<string | number, any>
     }
 
@@ -72,8 +75,9 @@ declare module 'posthog-node' {
          * @param key the unique key of your feature flag
          * @param distinctId the current unique id
          * @param defaultResult optional - default value to be returned if the feature flag is not on for the user
+         * @param groups optional - what groups are currently active (group analytics)
         */
-        isFeatureEnabled(key: string, distinctId: string, defaultResult?: boolean): Promise<boolean>
+        isFeatureEnabled(key: string, distinctId: string, defaultResult?: boolean, groups?: Record<GroupType, GroupKey>): Promise<boolean>
 
 
         /**

package/index.js

@@ -247,9 +247,11 @@ class PostHog {
         }
     }
 
-    async isFeatureEnabled(key, distinctId, defaultResult) {
+    async isFeatureEnabled(key, distinctId, defaultResult = false, groups = {}) {
+        this._validate({ key, distinctId, defaultResult, groups }, 'isFeatureEnabled')
         assert(this.personalApiKey, 'You have to specify the option personalApiKey to use feature flags.')
-        return await this.featureFlagsPoller.isFeatureEnabled(key, distinctId, defaultResult)
+
+        return await this.featureFlagsPoller.isFeatureEnabled(key, distinctId, defaultResult, groups)
     }
 
     async reloadFeatureFlags() {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "posthog-node",
-    "version": "1.2.0",
+    "version": "1.3.0",
     "description": "PostHog Node.js integration",
     "license": "MIT",
     "repository": "PostHog/posthog-node",
@@ -52,7 +52,7 @@
         "uuid": "^8.3.2"
     },
     "devDependencies": {
-        "ava": "^0.25.0",
+        "ava": "^3.15.0",
         "basic-auth": "^2.0.1",
         "body-parser": "^1.17.1",
         "codecov": "^3.0.0",