feat: Finalise plugin

.eslintrc.js

@@ -1,13 +1,14 @@
 module.exports = {
-    "env": {
-        "browser": true,
-        "es2021": true
+    parser: '@typescript-eslint/parser',
+    plugins: ['@typescript-eslint', 'simple-import-sort'],
+    extends: ['plugin:@typescript-eslint/recommended', 'prettier'],
+    ignorePatterns: ['bin', 'dist', 'node_modules'],
+    rules: {
+        'simple-import-sort/imports': 'error',
+        'simple-import-sort/exports': 'error',
+        '@typescript-eslint/no-non-null-assertion': 'off',
+        '@typescript-eslint/no-var-requires': 'off',
+        '@typescript-eslint/ban-ts-comment': 'off',
+        curly: 'error',
     },
-    "extends": "eslint:recommended",
-    "parserOptions": {
-        "ecmaVersion": "latest",
-        "sourceType": "module"
-    },
-    "rules": {
-    }
 }

.github/workflows/main.yml

@@ -1,23 +1,23 @@
 name: CI
 
 on:
-  push:
-    branches: [ main ]
-  pull_request:
-    branches: [ main ]
-  workflow_dispatch:
+    pull_request:
+    push:
+        branches: [main]
 
 jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Check out code
-        uses: actions/checkout@v2
-      - name: Set up node 
-        uses: actions/setup-node@v1
-        with:
-          node-version: '14'
-      - name: Install dependencies
-        run: npm install
-      - name: Run tests 
-        run: npm test
+    build:
+        runs-on: ubuntu-latest
+        steps:
+            - name: Check out code
+              uses: actions/checkout@v3
+            - name: Set up node
+              uses: actions/setup-node@v1
+              with:
+                  node-version: '16'
+            - name: Install dependencies
+              run: yarn install
+            - name: Typecheck
+              run: yarn typecheck
+            - name: Run tests
+              run: yarn test

README.md

@@ -2,39 +2,14 @@
 
 [![License: MIT](https://img.shields.io/badge/License-MIT-red.svg?style=flat-square)](https://opensource.org/licenses/MIT)
 
-This is a basic exemplary PostHog plugin. It adds property `"greeting"` to every event, with a configurable value (default: `"Hello world!"`).
-
-Feel free to use it as a base for your own plugins!
+This is a basic webhook app. 
 
 ## How to develop
 
 All of the plugin's code is located in the `index.js` file, which is JavaScript ran inside of PostHog.
-To get yourself up to speed with this environment, we sincerely recommend checking out our [Plugins overview in PostHog Docs]([the Plugins Overview](https://posthog.com/docs/plugins/build/overview).
-For a crash course, read our [plugin building tutorial in PostHog Docs](https://posthog.com/docs/plugins/build/tutorial).
-
-## How to test
-
-To test the plugin, you'll need to install a few `npm` dependencies already specified in `package.json`:
-```bash
-npm install
-```
-
-This will get you the testing library Jest and some our test helpers.
-Then to run tests it's just:
 
-```bash
-npm test
 ```
-
-## How to install
-
-1. Open PostHog.
-1. Open the Plugins page from the sidebar.
-1. Head to the Advanced tab.
-1. "Install from GitHub, GitLab or npm" using this repository's URL.
-
-## Questions?
-
-### [Join our Slack community.](https://join.slack.com/t/posthogusers/shared_invite/enQtOTY0MzU5NjAwMDY3LTc2MWQ0OTZlNjhkODk3ZDI3NDVjMDE1YjgxY2I4ZjI4MzJhZmVmNjJkN2NmMGJmMzc2N2U3Yjc3ZjI5NGFlZDQ)
-
-We're here to help you with anything PostHog!
+yarn install
+yarn typecheck
+yarn test
+```

index.test.ts

@@ -0,0 +1,25 @@
+import { PostHogEvent, Webhook } from '@posthog/plugin-scaffold'
+
+const { composeWebhook } = require('./index')
+
+test('creates the correct webhook body', async () => {
+    const event: PostHogEvent = {
+        uuid: '123',
+        team_id: 1,
+        distinct_id: 'alice',
+        event: 'pageview',
+        timestamp: new Date('2023-01-01T00:00:00.000Z'),
+        properties: {
+            prop: 'value',
+        },
+    }
+    const webhook: Webhook = composeWebhook(event, { config: { url: 'https://example.com' } })
+    expect(webhook).toEqual({
+        url: 'https://example.com',
+        body: '{"uuid":"123","team_id":1,"distinct_id":"alice","event":"pageview","timestamp":"2023-01-01T00:00:00.000Z","properties":{"prop":"value"}}',
+        headers: {
+            'Content-Type': 'application/json',
+        },
+        method: 'POST',
+    })
+})

index.ts

@@ -0,0 +1,13 @@
+import { PostHogEvent, Webhook } from '@posthog/plugin-scaffold'
+
+export function composeWebhook(event: PostHogEvent, { config }: any): Webhook {
+    return {
+        url: config.url,
+        body: JSON.stringify(config.payload || event),
+        headers: {
+            'Content-Type': 'application/json',
+            ...config.headers,
+        },
+        method: config.method || 'POST',
+    }
+}

jest.config.js

@@ -0,0 +1,15 @@
+module.exports = {
+    preset: 'ts-jest',
+    moduleDirectories: ['node_modules', 'src'],
+    transform: {
+        '^.+\\.(ts|tsx)?$': 'ts-jest',
+        '^.+\\.(js|jsx)$': 'babel-jest',
+    },
+    transformIgnorePatterns: [],
+    globals: {
+        'ts-jest': {
+            // Without isolatedModules, tests run realy slow, so we enable them
+            isolatedModules: true,
+        },
+    },
+}