@etohq/analytics-posthog 1.5.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Etohq
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+declare const _default: import("@etohq/types").ModuleProviderExports;
+export default _default;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAKA,wBAEE"}

package/dist/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("@etohq/framework/utils");
+const posthog_analytics_1 = require("./services/posthog-analytics");
+const services = [posthog_analytics_1.PosthogAnalyticsService];
+exports.default = (0, utils_1.ModuleProvider)(utils_1.Modules.ANALYTICS, {
+    services,
+});
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;AAAA,kDAAgE;AAChE,oEAAsE;AAEtE,MAAM,QAAQ,GAAG,CAAC,2CAAuB,CAAC,CAAA;AAE1C,kBAAe,IAAA,sBAAc,EAAC,eAAO,CAAC,SAAS,EAAE;IAC/C,QAAQ;CACT,CAAC,CAAA"}

package/dist/services/posthog-analytics.d.ts

@@ -0,0 +1,18 @@
+import { PosthogAnalyticsServiceOptions, Logger, ProviderIdentifyAnalyticsEventDTO, ProviderTrackAnalyticsEventDTO } from "@etohq/framework/types";
+import { PostHog } from "posthog-node";
+import { AbstractAnalyticsProviderService } from "@etohq/framework/utils";
+type InjectedDependencies = {
+    logger: Logger;
+};
+export declare class PosthogAnalyticsService extends AbstractAnalyticsProviderService {
+    static identifier: string;
+    protected config_: PosthogAnalyticsServiceOptions;
+    protected logger_: Logger;
+    protected client_: PostHog;
+    constructor({ logger }: InjectedDependencies, options: PosthogAnalyticsServiceOptions);
+    track(data: ProviderTrackAnalyticsEventDTO): Promise<void>;
+    identify(data: ProviderIdentifyAnalyticsEventDTO): Promise<void>;
+    shutdown(): Promise<void>;
+}
+export {};
+//# sourceMappingURL=posthog-analytics.d.ts.map

package/dist/services/posthog-analytics.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"posthog-analytics.d.ts","sourceRoot":"","sources":["../../src/services/posthog-analytics.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,8BAA8B,EAC9B,MAAM,EACN,iCAAiC,EACjC,8BAA8B,EAC/B,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AACtC,OAAO,EAAE,gCAAgC,EAAE,MAAM,wBAAwB,CAAA;AAEzE,KAAK,oBAAoB,GAAG;IAC1B,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED,qBAAa,uBAAwB,SAAQ,gCAAgC;IAC3E,MAAM,CAAC,UAAU,SAAsB;IACvC,SAAS,CAAC,OAAO,EAAE,8BAA8B,CAAA;IACjD,SAAS,CAAC,OAAO,EAAE,MAAM,CAAA;IACzB,SAAS,CAAC,OAAO,EAAE,OAAO,CAAA;gBAGxB,EAAE,MAAM,EAAE,EAAE,oBAAoB,EAChC,OAAO,EAAE,8BAA8B;IAenC,KAAK,CAAC,IAAI,EAAE,8BAA8B,GAAG,OAAO,CAAC,IAAI,CAAC;IA6B1D,QAAQ,CAAC,IAAI,EAAE,iCAAiC,GAAG,OAAO,CAAC,IAAI,CAAC;IAoBhE,QAAQ;CAGf"}

package/dist/services/posthog-analytics.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PosthogAnalyticsService = void 0;
+const posthog_node_1 = require("posthog-node");
+const utils_1 = require("@etohq/framework/utils");
+class PosthogAnalyticsService extends utils_1.AbstractAnalyticsProviderService {
+    constructor({ logger }, options) {
+        super();
+        this.config_ = options;
+        this.logger_ = logger;
+        if (!options.posthogEventsKey) {
+            throw new Error("Posthog API key is not set, but is required");
+        }
+        this.client_ = new posthog_node_1.PostHog(options.posthogEventsKey, {
+            host: options.posthogHost || "https://eu.i.posthog.com",
+        });
+    }
+    async track(data) {
+        if (!data.event) {
+            throw new Error("Event name is required when tracking an event with Posthog");
+        }
+        if (!data.actor_id) {
+            throw new Error("Actor ID is required when tracking an event with Posthog");
+        }
+        if (data.group?.id && !data.group?.type) {
+            throw new Error("Group type is required if passing group id when tracking an event with Posthog");
+        }
+        this.client_.capture({
+            event: data.event,
+            distinctId: data.actor_id,
+            properties: data.properties,
+            groups: data.group?.id
+                ? { [data.group.type]: data.group.id }
+                : undefined,
+        });
+    }
+    async identify(data) {
+        if ("group" in data) {
+            this.client_.groupIdentify({
+                groupKey: data.group.id,
+                groupType: data.group.type,
+                properties: data.properties,
+                distinctId: data.actor_id,
+            });
+        }
+        else if (data.actor_id) {
+            this.client_.identify({
+                distinctId: data.actor_id,
+                properties: data.properties,
+            });
+        }
+        throw new Error("Actor or group is required when identifying an entity with Posthog");
+    }
+    async shutdown() {
+        await this.client_.shutdown();
+    }
+}
+exports.PosthogAnalyticsService = PosthogAnalyticsService;
+PosthogAnalyticsService.identifier = "analytics-posthog";
+//# sourceMappingURL=posthog-analytics.js.map

package/dist/services/posthog-analytics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"posthog-analytics.js","sourceRoot":"","sources":["../../src/services/posthog-analytics.ts"],"names":[],"mappings":";;;AAMA,+CAAsC;AACtC,kDAAyE;AAMzE,MAAa,uBAAwB,SAAQ,wCAAgC;IAM3E,YACE,EAAE,MAAM,EAAwB,EAChC,OAAuC;QAEvC,KAAK,EAAE,CAAA;QACP,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAA;QAErB,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAA;QAChE,CAAC;QAED,IAAI,CAAC,OAAO,GAAG,IAAI,sBAAO,CAAC,OAAO,CAAC,gBAAgB,EAAE;YACnD,IAAI,EAAE,OAAO,CAAC,WAAW,IAAI,0BAA0B;SACxD,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,IAAoC;QAC9C,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CACb,4DAA4D,CAC7D,CAAA;QACH,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CACb,0DAA0D,CAC3D,CAAA;QACH,CAAC;QAED,IAAI,IAAI,CAAC,KAAK,EAAE,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC;YACxC,MAAM,IAAI,KAAK,CACb,gFAAgF,CACjF,CAAA;QACH,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;YACnB,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,UAAU,EAAE,IAAI,CAAC,QAAQ;YACzB,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,MAAM,EAAE,IAAI,CAAC,KAAK,EAAE,EAAE;gBACpB,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAK,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE,EAAE;gBACvC,CAAC,CAAC,SAAS;SACd,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,IAAuC;QACpD,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;YACpB,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC;gBACzB,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,EAAG;gBACxB,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,IAAK;gBAC3B,UAAU,EAAE,IAAI,CAAC,UAAU;gBAC3B,UAAU,EAAE,IAAI,CAAC,QAAQ;aAC1B,CAAC,CAAA;QACJ,CAAC;aAAM,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YACzB,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;gBACpB,UAAU,EAAE,IAAI,CAAC,QAAQ;gBACzB,UAAU,EAAE,IAAI,CAAC,UAAU;aAC5B,CAAC,CAAA;QACJ,CAAC;QAED,MAAM,IAAI,KAAK,CACb,oEAAoE,CACrE,CAAA;IACH,CAAC;IAED,KAAK,CAAC,QAAQ;QACZ,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAA;IAC/B,CAAC;;AA1EH,0DA2EC;AA1EQ,kCAAU,GAAG,mBAAmB,CAAA"}

package/dist/tsconfig.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["../src/index.ts","../src/services/posthog-analytics.ts"],"version":"5.8.3"}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@etohq/analytics-posthog",
+  "version": "1.5.0",
+  "description": "Posthog analytics provider for Eto",
+  "main": "dist/index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/etohq/eto",
+    "directory": "packages/core/modules/providers/analytics-posthog"
+  },
+  "files": [
+    "dist",
+    "!dist/**/__tests__",
+    "!dist/**/__mocks__",
+    "!dist/**/__fixtures__"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
+  "author": "Eto",
+  "license": "MIT",
+  "devDependencies": {
+    "@swc/core": "1.7.28",
+    "@swc/jest": "0.2.36",
+    "@types/jest": "29.5.14",
+    "jest": "29.7.0",
+    "rimraf": "5.0.2",
+    "tsc-alias": "1.8.6",
+    "typescript": "5.8.3",
+    "posthog-node": "^4.17.1",
+    "@etohq/framework": "1.5.0"
+  },
+  "peerDependencies": {
+    "posthog-node": "^4.17.1",
+    "@etohq/framework": "1.5.0"
+  },
+  "keywords": [
+    "eto-plugin",
+    "eto-plugin-analytics"
+  ],
+  "scripts": {
+    "test": "jest --passWithNoTests src",
+    "build": "rimraf dist && tsc --build ./tsconfig.json",
+    "watch": "tsc --watch"
+  }
+}