React Native "native" SDK

.eslintrc.js

@@ -0,0 +1,101 @@
+/* global module */
+module.exports = {
+  ignorePatterns: ['node_modules', 'examples', 'lib'],
+  env: {
+    browser: true,
+    es6: true,
+  },
+  settings: {
+    react: {
+      version: 'detect',
+    },
+  },
+  extends: ['plugin:@typescript-eslint/recommended', 'plugin:react/recommended', 'prettier'],
+  globals: {
+    Atomics: 'readonly',
+    SharedArrayBuffer: 'readonly',
+  },
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaFeatures: {
+      jsx: true,
+    },
+    ecmaVersion: 2018,
+    sourceType: 'module',
+  },
+  plugins: ['prettier', 'react', '@typescript-eslint'],
+  rules: {
+    'react/prop-types': [0],
+    'react/no-unescaped-entities': [0],
+    'react/jsx-no-target-blank': [0],
+    'react/self-closing-comp': [
+      'error',
+      {
+        component: true,
+        html: true,
+      },
+    ],
+    'no-unused-vars': 'off',
+    '@typescript-eslint/no-unused-vars': [
+      'error',
+      {
+        ignoreRestSiblings: true,
+      },
+    ],
+    '@typescript-eslint/prefer-ts-expect-error': 'error',
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+    '@typescript-eslint/no-empty-function': 'off',
+    '@typescript-eslint/no-inferrable-types': 'off',
+    '@typescript-eslint/ban-ts-comment': 'off',
+    '@typescript-eslint/no-non-null-assertion': 'error',
+    curly: 'error',
+    'no-restricted-imports': [
+      'error',
+      {
+        paths: [
+          {
+            name: 'dayjs',
+            message: 'Do not directly import dayjs. Only import the dayjs exported from lib/dayjs.',
+          },
+        ],
+      },
+    ],
+  },
+  overrides: [
+    {
+      // enable the rule specifically for TypeScript files
+      files: ['*Type.ts', '*Type.tsx'],
+      rules: {
+        '@typescript-eslint/no-explicit-any': ['off'],
+        '@typescript-eslint/ban-types': ['off'],
+      },
+    },
+    {
+      // enable the rule specifically for TypeScript files
+      files: ['*.ts', '*.tsx'],
+      rules: {
+        '@typescript-eslint/no-explicit-any': ['off'],
+        '@typescript-eslint/explicit-function-return-type': [
+          'error',
+          {
+            allowExpressions: true,
+          },
+        ],
+        '@typescript-eslint/explicit-module-boundary-types': [
+          'error',
+          {
+            allowArgumentsExplicitlyTypedAsAny: true,
+          },
+        ],
+      },
+    },
+    {
+      files: ['*.js'],
+      rules: {
+        '@typescript-eslint/no-var-requires': 'off',
+      },
+    },
+  ],
+  reportUnusedDisableDirectives: true,
+}

.github/disabled_workflows/ci-e2e.yml

@@ -0,0 +1,45 @@
+name: CI - E2E
+
+on:
+  - pull_request
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  e2e:
+    runs-on: macos-latest
+    timeout-minutes: 15
+
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 16
+
+      - uses: actions/cache@v2
+        with:
+          path: '**/node_modules'
+          key: ${{ runner.os }}-modules-${{ hashFiles('**/yarn.lock') }}
+
+      - name: Install Global Dependencies
+        run: yarn install
+
+      - working-directory: examples/example-expo
+        run: ls -al && ./e2e/tools/downloadApp.sh
+
+      - name: Install Dependencies
+        working-directory: examples/example-expo
+        run: |
+          yarn global add yalc 
+          yarn global add expo-cli
+          yarn global add detox-cli
+          yarn install
+
+      - run: brew tap wix/brew
+      - run: brew install applesimutils
+      - working-directory: examples/example-expo
+        run: |
+          open -a simulator
+          yarn start & yarn test

.github/workflows/ci.yml

@@ -0,0 +1,36 @@
+name: CI
+
+on:
+  - pull_request
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  tests:
+    timeout-minutes: 3
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 16
+
+      - run: yarn install
+      - run: yarn test
+      - run: yarn test:rn
+
+  lint:
+    timeout-minutes: 3
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 16
+
+      - run: yarn install
+      - run: yarn compile
+      - run: yarn lint
+      - run: yarn prettier:check

.github/workflows/release.yml

@@ -0,0 +1,73 @@
+name: 'Release'
+
+on:
+  push:
+    branches:
+      - main
+      - master
+      - feat/multi-domain-support # TODO: Remove this once merged
+
+jobs:
+  release:
+    name: Publish
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        package:
+          - name: posthog-react-native
+            npm_token_secret: NPM_TOKEN_BEN_WHITE # TODO: Change to standard token once able
+          - name: posthog-node
+            npm_token_secret: NPM_TOKEN_BEN_WHITE # TODO: Change to standard token once able
+          - name: posthog-web
+            npm_token_secret: NPM_TOKEN # TODO: Change to standard token once able
+
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v2
+
+      - name: Check package version and detect an update
+        id: check-package-version
+        uses: PostHog/check-package-version@v2
+        with:
+          path: ${{ matrix.package.name }}
+
+      - name: Set up Node 14
+        uses: actions/setup-node@v2
+        if: steps.check-package-version.outputs.is-new-version == 'true'
+        with:
+          node-version: 14
+          registry-url: https://registry.npmjs.org
+
+      - name: Install dependencies
+        if: steps.check-package-version.outputs.is-new-version == 'true'
+        run: yarn --frozen-lockfile
+
+      - name: Build
+        if: steps.check-package-version.outputs.is-new-version == 'true'
+        run: yarn build
+
+      - name: Publish the package in the npm registry
+        id: publish-package
+        if: steps.check-package-version.outputs.is-new-version == 'true'
+        working-directory: ${{ matrix.package.name }}
+        run: |
+          tag="alpha"
+          echo ::set-output name=is_latest::alpha
+          if [[ $VERSION =~ ^[0-9]+(\.[0-9]+){2,3}$ ]]; then
+            echo ::set-output name=is_latest::latest
+            tag="latest"
+          fi
+
+          npm publish --access public --tag $tag
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets[matrix.package.npm_token_secret] }}
+          VERSION: ${{ steps.check-package-version.outputs.committed-version }}
+
+      - name: Create GitHub release
+        if: steps.check-package-version.outputs.is-new-version == 'true' && steps.publish-package.outputs.tag == 'latest'
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ matrix.package.name }}-v${{ steps.check-package-version.outputs.committed-version }}
+          release_name: ${{ matrix.package.name }}-${{ steps.check-package-version.outputs.committed-version }}

.gitignore

@@ -3,3 +3,8 @@ node_modules
 .vscode
 dist/
 yarn-error.log
+*.tsbuildinfo
+coverage/
+lib/
+.yalc
+yalc.lock

.prettierignore

@@ -0,0 +1 @@
+lib

.prettierrc

@@ -1,6 +1,6 @@
 {
   "trailingComma": "es5",
-  "tabWidth": 4,
+  "tabWidth": 2,
   "semi": false,
   "singleQuote": true,
   "printWidth": 120

LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2022 PostHog (part of Hiberly Inc)
+
+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.

README.md

@@ -1,29 +1,50 @@
-[![NPM Version](https://img.shields.io/npm/v/posthog-js-lite.svg)](https://www.npmjs.com/package/posthog-js-lite)
-[![minified](https://badgen.net/bundlephobia/min/posthog-js-lite)](https://bundlephobia.com/result?p=posthog-js-lite)
-[![minified + gzipped](https://badgen.net/bundlephobia/minzip/posthog-js-lite)](https://bundlephobia.com/result?p=posthog-js-lite)
-
 **This library is still a work in progress!**
 
-Reimplementation of posthog-js to be as light and modular as possible.
+# posthog-js-lite
+
+The next generation of PostHog client libraries within the JS/TS ecosystem.
+
+The lofty goals of this codebase is to solve the core client logic of our various JS based libraries in one place (web, node, React Native).
+
+The short-term goal is to have a dedicated React Native library free from any platform-specific installations (the previous client library is a wrapper for the `posthog-ios` and `posthog-android` libraries). This enables a few things:
+
+1. Installation to Expo managed projects without any separate compilation / ejecting
+2. Tighter integration to RN enabling hooks, context, autocapture etc.
+
+## Development
+
+This repository is broken into different packages
+
+- **/posthog-core** > All common code goes here.
+- **/posthog-node** > Node.js specific code
+- **/posthog-react-native** > React Native specific code
+- **/posthog-web** > Web (DOM) specific code
+
+## Running tests
+
+```sh
+yarn test
+# Run the RN tests - these are separate due to specific babel configs
+yarn test:rn
+```
+
+### Running E2E tests with Detox
+
+See [Example Expo Readme](./examples/example-expo/README.md)
 
-Goals:
-- simple api
-- can do autocapture, but enabled via a plugin (not yet)
-- runs in the oldest browsers (not yet)
-- might break some APIs (if not now, then when?)
+### Examples
 
-Supports already:
-- very simple api
-- capture & identify calls
-- $context from window
-- only send events after optin if needed
-- payload compression
-- 10kb (includes 5kb compression code)
+#### React Native
 
-Browser support:
-- This library ES6 compatible browsers (everything except IE). If you need to support IE, 
-  feel free to transpile the source to ES5 after including it in your bundle. 
+```sh
+cd examples/example-expo
+yarn && yarn start
+```
 
-## Questions?
+#### Node.js
 
-### [Join our Slack community.](https://join.slack.com/t/posthogusers/shared_invite/enQtOTY0MzU5NjAwMDY3LTc2MWQ0OTZlNjhkODk3ZDI3NDVjMDE1YjgxY2I4ZjI4MzJhZmVmNjJkN2NmMGJmMzc2N2U3Yjc3ZjI5NGFlZDQ)
+```sh
+cd examples/example-node
+yarn && yarn start
+# example-expo has some buttons that will talk to this server
+```