utneque 1.0.0

package/.editorconfig

@@ -0,0 +1,10 @@
+; editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

package/.eslintrc.isomorphic.js

@@ -0,0 +1,26 @@
+/** @type { import('eslint').Linter.Config } */
+module.exports = {
+  extends: ['./.eslintrc'],
+  plugins: ['import'],
+  overrides: [
+    {
+      // this library should not have any node OR browser runtime dependencies.
+      // In particular, nextjs and vercel edge functions will break if _any_ node dependencies are introduced.
+      files: ['src/**'],
+      excludedFiles: ['**/__tests__/**'],
+      rules: {
+        'no-restricted-globals': [
+          'error',
+          'document',
+          'window',
+          'self',
+          'process',
+          'global',
+          'navigator',
+          'location',
+        ],
+        'import/no-nodejs-modules': 'error',
+      },
+    },
+  ],
+}

package/.eslintrc.js

@@ -0,0 +1,86 @@
+/** @type { import('eslint').Linter.Config } */
+module.exports = {
+  root: true,
+  ignorePatterns: ['node_modules', 'dist'],
+  parserOptions: {
+    ecmaVersion: 2020,
+  },
+  extends: [
+    // Turn on on eslint recommended rules https://github.com/eslint/eslint/blob/main/conf/eslint-recommended.js
+    'eslint:recommended',
+    // Turn off eslint rules that conflict with prettier https://github.com/prettier/eslint-config-prettier/blob/main/index.js
+    'prettier',
+  ],
+  overrides: [
+    {
+      files: ['*.{ts,tsx}'],
+      parser: '@typescript-eslint/parser',
+      parserOptions: {
+        project: [
+          './tsconfig.json',
+          './packages/*/tsconfig.json',
+          './examples/*/tsconfig.json',
+        ],
+      },
+      extends: [
+        // Disable rules from eslint:recommended which are already handled by TypeScript. Enables eslint (@not typescript-eslint) rules that make sense due to TS's typechecking / transpilation.
+        // https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/eslint-recommended.ts
+        'plugin:@typescript-eslint/eslint-recommended',
+        // Enable recommended rules from @typescript-eslint
+        // https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/src/configs/recommended.ts
+        'plugin:@typescript-eslint/recommended',
+        // Handle prettier rules through eslint https://github.com/prettier/eslint-plugin-prettier/blob/master/eslint-plugin-prettier.js#L65
+        'plugin:prettier/recommended',
+        // add special jest rules https://github.com/jest-community/eslint-plugin-jest#rules
+        'plugin:jest/recommended',
+      ],
+      rules: {
+        '@typescript-eslint/explicit-function-return-type': 'off',
+        '@typescript-eslint/ban-ts-ignore': 'off',
+        '@typescript-eslint/ban-ts-comment': 'off',
+        '@typescript-eslint/no-unused-vars': 'off',
+        '@typescript-eslint/no-empty-interface': 'off',
+        '@typescript-eslint/no-explicit-any': 'off',
+        '@typescript-eslint/no-non-null-assertion': 'off',
+        '@typescript-eslint/no-floating-promises': [
+          'error',
+          {
+            ignoreVoid: true,
+          },
+        ],
+        'require-await': 'off',
+        '@typescript-eslint/require-await': 'error',
+        '@typescript-eslint/no-empty-function': 'off',
+        '@typescript-eslint/ban-types': 'off', // TODO: turn on
+        /** jest */
+        'jest/valid-title': 'off', // allow functions to be used as describe titles
+        'jest/no-conditional-expect': 'off', // best practice, but TODO
+        'jest/no-alias-methods': 'off', // best practice, but TODO
+        'jest/expect-expect': 'off', // sometimes we compose assertion functions
+        'jest/no-disabled-tests': 'off',
+        'jest/no-focused-tests': process.env.CI ? 'error' : 'off',
+      },
+      overrides: [
+        {
+          files: ['**/__tests__/**', '**/scripts/**'],
+          rules: {
+            'require-await': 'off',
+            '@typescript-eslint/require-await': 'off',
+          },
+        },
+      ],
+    },
+    {
+      files: ['*.{js,mjs}'],
+      env: {
+        // Config files and possible scripts. Allow anything, we don't really care.
+        browser: true,
+        node: true,
+      },
+      extends: [
+        // Handle prettier rules through eslint https://github.com/prettier/eslint-plugin-prettier/blob/master/eslint-plugin-prettier.js#L65
+        'plugin:prettier/recommended',
+      ],
+    },
+  ],
+}

package/.gitattributes

@@ -0,0 +1 @@
+* text=auto

package/.github/workflows/ci.yml

@@ -0,0 +1,33 @@
+name: CI
+on:
+  push:
+env:
+  HUSKY: 0
+  PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: 1
+jobs:
+  sdk-ci:
+    name: 'SDK CI'
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [18]
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'yarn'
+      - run: yarn install --immutable
+      - name: Turbo cache
+        uses: actions/cache@v3
+        with:
+          path: node_modules/.cache/turbo
+          key: ${{ runner.os }}-turbo-${{ github.sha }}
+          restore-keys: |
+            ${{ runner.os }}-turbo-
+      - run: yarn turbo run --filter='./packages/core*' lint
+      - run: yarn turbo run --filter='./packages/core*' test
+      - run: yarn turbo run --filter='./packages/node*' lint
+      - run: yarn turbo run --filter='./packages/node*' test
+      - run: yarn turbo run --filter='./packages/browser*' lint
+      - run: yarn turbo run --filter='./packages/browser*' test

package/.github/workflows/deploy-browser-cdn-candidate.yml

@@ -0,0 +1,51 @@
+name: Deploy browser candidate to CDN
+
+on:
+  push:
+    # Pattern matched against refs/tags
+    tags:
+      - 'browser@*'
+
+env:
+  HUSKY: 0
+  PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: 1
+  PROD_BUCKET: 'hightouch-events'
+
+permissions:
+  id-token: write # allows the JWT to be requested from GitHub's OIDC provider
+  contents: read # This is required for actions/checkout
+
+jobs:
+  deploy-cdn:
+    name: Deploy to CDN
+    runs-on: ubuntu-latest
+    steps:
+      - name: Get tag version
+        id: get_tag_version
+        env:
+          TAG: ${{ github.ref_name }}
+        run: echo "PATH_VERSION=${TAG##browser@}" >> $GITHUB_OUTPUT
+
+      - name: Configure AWS Credentials
+        uses: aws-actions/configure-aws-credentials@v3
+        with:
+          role-to-assume: arn:aws:iam::${{ secrets.AWS_PROD_ACCOUNT_ID }}:role/${{ secrets.AWS_PROD_S3_SYNC_ROLE }}
+          aws-region: us-east-1
+
+      - name: Checkout source branch
+        uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: |
+          yarn install --immutable
+      - name: Release to CDN
+        env:
+          PATH_VERSION: '${{ steps.get_tag_version.outputs.PATH_VERSION }}'
+        run: |
+          yarn run -T browser candidate:cdn

package/.github/workflows/deploy-releases.yml

@@ -0,0 +1,178 @@
+name: Deploy Releases
+
+on:
+  release:
+    types: [published]
+
+env:
+  HUSKY: 0
+  PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: 1
+  PROD_BUCKET: 'hightouch-events'
+
+permissions:
+  id-token: write # allows the JWT to be requested from GitHub's OIDC provider
+  contents: read # This is required for actions/checkout
+
+jobs:
+  deploy-core:
+    if: "startsWith( github.ref_name, 'core@' )"
+    name: Deploy Core to NPM
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout source branch
+        uses: actions/checkout@v4
+
+      - name: Get tag version
+        id: get_tag_version
+        env:
+          TAG: ${{ github.ref_name }}
+        run: echo "PATH_VERSION=${TAG##core@}" >> $GITHUB_OUTPUT
+
+      - name: Get package version
+        id: get_package_version
+        run: echo "PACKAGE_VERSION=$(jq -r '.version' < ./packages/core/package.json)" >> $GITHUB_OUTPUT
+
+      - name: Check package.json version
+        shell: bash
+        env:
+          PATH_VERSION: '${{ steps.get_tag_version.outputs.PATH_VERSION }}'
+          PACKAGE_VERSION: '${{ steps.get_package_version.outputs.PACKAGE_VERSION }}'
+        run: |
+          node -e 'process.env.PATH_VERSION === process.env.PACKAGE_VERSION ? process.exit() : process.exit(1)'
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: |
+          yarn install --immutable
+
+      - name: Build core for npm
+        env:
+          PATH_VERSION: '${{ steps.get_tag_version.outputs.PATH_VERSION }}'
+        run: |
+          cd packages/core && yarn . build
+
+      - name: Publish core package to NPM
+        env:
+          HUSKY: 0
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: |
+          npm set //registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}
+          cd packages/core && npm publish --access=public
+
+  deploy-browser:
+    if: "startsWith( github.ref_name, 'browser@' )"
+    name: Deploy Browser to NPM and CDN
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout source branch
+        uses: actions/checkout@v4
+
+      - name: Get tag version
+        id: get_tag_version
+        env:
+          TAG: ${{ github.ref_name }}
+        run: echo "PATH_VERSION=${TAG##browser@}" >> $GITHUB_OUTPUT
+
+      - name: Get package version
+        id: get_package_version
+        run: echo "PACKAGE_VERSION=$(jq -r '.version' < ./packages/browser/package.json)" >> $GITHUB_OUTPUT
+
+      - name: Check package.json version
+        shell: bash
+        env:
+          PATH_VERSION: '${{ steps.get_tag_version.outputs.PATH_VERSION }}'
+          PACKAGE_VERSION: '${{ steps.get_package_version.outputs.PACKAGE_VERSION }}'
+        run: |
+          node -e 'process.env.PATH_VERSION === process.env.PACKAGE_VERSION ? process.exit() : process.exit(1)'
+
+      - name: Configure AWS Credentials
+        uses: aws-actions/configure-aws-credentials@v3
+        with:
+          role-to-assume: arn:aws:iam::${{ secrets.AWS_PROD_ACCOUNT_ID }}:role/${{ secrets.AWS_PROD_S3_SYNC_ROLE }}
+          aws-region: us-east-1
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: |
+          yarn install --immutable
+
+      - name: Release browser to CDN
+        env:
+          PATH_VERSION: '${{ steps.get_tag_version.outputs.PATH_VERSION }}'
+        run: |
+          yarn run -T browser release:cdn
+      
+      - name: Build browser for npm
+        env:
+          PATH_VERSION: '${{ steps.get_tag_version.outputs.PATH_VERSION }}'
+        run: |
+          cd packages/browser && yarn . build
+
+      - name: Publish browser package to NPM
+        env:
+          HUSKY: 0
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: |
+          npm set //registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}
+          cd packages/browser && npm publish --access=public
+
+  deploy-node:
+    if: "startsWith( github.ref_name, 'node@' )"
+    name: Deploy Node to NPM
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout source branch
+        uses: actions/checkout@v4
+
+      - name: Get tag version
+        id: get_tag_version
+        env:
+          TAG: ${{ github.ref_name }}
+        run: echo "PATH_VERSION=${TAG##node@}" >> $GITHUB_OUTPUT
+
+      - name: Get package version
+        id: get_package_version
+        run: echo "PACKAGE_VERSION=$(jq -r '.version' < ./packages/node/package.json)" >> $GITHUB_OUTPUT
+
+      - name: Check package.json version
+        shell: bash
+        env:
+          PATH_VERSION: '${{ steps.get_tag_version.outputs.PATH_VERSION }}'
+          PACKAGE_VERSION: '${{ steps.get_package_version.outputs.PACKAGE_VERSION }}'
+        run: |
+          node -e 'process.env.PATH_VERSION === process.env.PACKAGE_VERSION ? process.exit() : process.exit(1)'
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: |
+          yarn install --immutable
+      
+      - name: Build node for npm
+        env:
+          PATH_VERSION: '${{ steps.get_tag_version.outputs.PATH_VERSION }}'
+        run: |
+          cd packages/node && yarn . build
+
+      - name: Publish node package to NPM
+        env:
+          HUSKY: 0
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: |
+          npm set //registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}
+          cd packages/node && npm publish --access=public
+

package/.nvmrc

@@ -0,0 +1 @@
+16.16

package/.prettierrc

@@ -0,0 +1,7 @@
+{
+  "semi": false,
+  "singleQuote": true,
+  "printWidth": 80,
+  "tabWidth": 2,
+  "arrowParens": "always"
+}

package/.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+  "recommendations": ["esbenp.prettier-vscode", "dbaeumer.vscode-eslint", "wix.vscode-import-cost"]
+}

package/.vscode/launch.json

@@ -0,0 +1,81 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Jest Current File",
+      "program": "${workspaceFolder}/node_modules/.bin/jest",
+      "args": [
+        "--testTimeout=100000",
+        "--findRelatedTests",
+        "${relativeFile}"
+      ],
+      "console": "integratedTerminal",
+      "internalConsoleOptions": "neverOpen",
+      "skipFiles": [
+        "<node_internals>/**"
+      ]
+    },
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Jest Watch Current File",
+      "program": "${workspaceFolder}/node_modules/.bin/jest",
+      "args": [
+        "--testTimeout=100000",
+        "--watch",
+        "--findRelatedTests",
+        "${relativeFile}"
+      ],
+      "console": "integratedTerminal",
+      "internalConsoleOptions": "neverOpen",
+      "skipFiles": [
+        "<node_internals>/**"
+      ]
+    },
+    {
+      "type": "node",
+      "name": "Jest All",
+      "request": "launch",
+      "args": [
+        "--testTimeout=100000",
+        "-c",
+        "${workspaceFolder}/jest.config.js"
+      ],
+      "cwd": "${workspaceFolder}",
+      "console": "integratedTerminal",
+      "internalConsoleOptions": "neverOpen",
+      "program": "${workspaceFolder}/node_modules/jest/bin/jest",
+      "skipFiles": [
+        "<node_internals>/**"
+      ]
+    },
+    {
+      "type": "node",
+      "name": "Jest All: Browser",
+      "request": "launch",
+      "args": [
+        "--testTimeout=100000",
+        "-c",
+        "${workspaceFolder}/packages/browser/jest.config.js"
+      ],
+      "cwd": "${workspaceFolder}",
+      "console": "integratedTerminal",
+      "internalConsoleOptions": "neverOpen",
+      "program": "${workspaceFolder}/node_modules/jest/bin/jest",
+      "skipFiles": [
+        "<node_internals>/**"
+      ]
+    },
+    {
+      "name": "ts-node Current File",
+      "type": "node",
+      "request": "launch",
+      "args": ["${relativeFile}"],
+      "runtimeArgs": ["-r", "ts-node/register"],
+      "cwd": "${workspaceRoot}",
+      "internalConsoleOptions": "openOnSessionStart"
+    }
+  ]
+}

package/.vscode/settings.json

@@ -0,0 +1,41 @@
+{
+  "eslint.validate": [
+    "javascript",
+    "javascriptreact",
+    "typescript",
+    "typescriptreact"
+  ],
+  "typescript.tsdk": "node_modules/typescript/lib",
+  "typescript.preferences.importModuleSpecifier": "relative",
+  "[json]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[json5]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[jsonc]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  // prettier-plugin-eslint uses eslint to format, so vscode-eslint is the 'formatter'.
+  "[javascript]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[javascriptreact]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[typescript]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[typescriptreact]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "editor.formatOnSave": false,
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": true
+  },
+  "eslint.codeActionsOnSave.mode": "all",
+  "eslint.format.enable": true,
+  "yaml.schemas": {
+    "https://json.schemastore.org/yamllint.json": "file:///Users/nickstefan/src/events-sdk-js-seg/.github/workflows/deploy-releases.yml"
+  },
+}