utneque 1.0.0

package/packages/browser/src/tester/ajs-tester.ts

@@ -0,0 +1,119 @@
+import { Analytics } from '../core/analytics'
+import { SerializedContext } from '../core/context'
+import mem from 'micro-memoize'
+import playwright from 'playwright'
+
+type BrowserType = 'chromium' | 'firefox' | 'webkit'
+
+// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+function makeStub(page: playwright.Page) {
+  const stub = {
+    async register(
+      ...args: Parameters<Analytics['register']>
+    ): Promise<SerializedContext> {
+      return await page.evaluate((innerArgs) => {
+        return (
+          // @ts-ignore
+          window.htevents
+            .register(...innerArgs)
+            // @ts-ignore
+            .then((ctx) => ctx.toJSON())
+        )
+      }, args)
+    },
+    async track(
+      ...args: Parameters<Analytics['track']>
+    ): Promise<SerializedContext> {
+      // @ts-expect-error
+      const ctx = await page.evaluate((innerArgs) => {
+        // @ts-ignore
+        return window.htevents.track(...innerArgs).then((ctx) => {
+          return ctx.toJSON()
+        })
+        // @ts-ignore
+      }, args)
+
+      return ctx
+    },
+    async page(
+      ...args: Parameters<Analytics['page']>
+    ): Promise<SerializedContext> {
+      const ctx = await page.evaluate((innerArgs) => {
+        // @ts-ignore
+        return window.htevents.page(...innerArgs).then((ctx) => {
+          return ctx.toJSON()
+        })
+        // @ts-ignore
+      }, args)
+
+      return ctx
+    },
+
+    async identify(
+      ...args: Parameters<Analytics['identify']>
+    ): Promise<SerializedContext> {
+      const ctx = await page.evaluate((innerArgs) => {
+        // @ts-ignore
+        return window.htevents.identify(...innerArgs).then((ctx) => {
+          return ctx.toJSON()
+        })
+        // @ts-ignore
+      }, args)
+
+      return ctx
+    },
+
+    browserPage: page,
+  }
+
+  return stub
+}
+
+export const getBrowser = mem(
+  async (browserType?: BrowserType, remoteDebug?: boolean) => {
+    const browser = await playwright[browserType ?? 'chromium'].launch({
+      headless: true,
+      devtools: true,
+      args: [
+        '--no-sandbox',
+        '--disable-setuid-sandbox',
+        remoteDebug ? '--remote-debugging-port=9222' : '',
+      ],
+    })
+
+    process.on('unhandledRejection', () => {
+      browser && browser.close()
+    })
+
+    return browser
+  }
+)
+
+export async function testerTeardown(): Promise<void> {
+  const browser = await getBrowser()
+  await browser.close()
+}
+
+export async function tester(
+  _writeKey: string,
+  url?: string,
+  browserType?: BrowserType,
+  remoteDebug?: boolean
+): Promise<ReturnType<typeof makeStub>> {
+  const browser = await getBrowser(browserType, remoteDebug)
+  const page = await browser.newPage()
+
+  await page.goto(
+    url || `file://${process.cwd()}/src/tester/__fixtures__/index.html`
+  )
+  await page.evaluate(`
+    window.AnalyticsNext.HtEventsBrowser.load({
+      writeKey: '${_writeKey}',
+    }).then(loaded => {
+      window.htevents = loaded[0]
+    })
+  `)
+
+  await page.waitForFunction('window.htevents !== undefined')
+  return makeStub(page)
+}

package/packages/browser/src/tester/server.js

@@ -0,0 +1,16 @@
+const path = require('path')
+const express = require('express')
+const port = 3001
+
+const app = express()
+
+app.get('*.js', function (req, res, next) {
+  req.url = req.url + '.gz'
+  res.set('Content-Encoding', 'gzip')
+  res.set('Content-Type', 'text/javascript')
+  next()
+})
+app.use('/', express.static(path.join(__dirname, '__fixtures__')))
+app.use('/dist/umd', express.static(path.join(__dirname, '../../dist/umd')))
+
+app.listen(port)

package/packages/browser/tsconfig.build.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.json",
+  "include": ["src"],
+  "exclude": ["**/__tests__/**", "**/test-helpers/**", "**/tester/**"],
+  "compilerOptions": {
+    "outDir": "./dist/pkg",
+    "declarationDir": "./dist/types"
+  }
+}

package/packages/browser/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "module": "esnext",
+    "target": "ES5",
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "lib": ["es2020", "DOM", "DOM.Iterable"],
+    "baseUrl": "./src",
+    "keyofStringsOnly": true
+  },
+  "exclude": ["node_modules", "dist"]
+}

package/packages/browser/webpack.config.js

@@ -0,0 +1,106 @@
+const path = require('path')
+const webpack = require('webpack')
+const TerserPlugin = require('terser-webpack-plugin')
+const CompressionPlugin = require('compression-webpack-plugin')
+const BundleAnalyzerPlugin =
+  require('webpack-bundle-analyzer').BundleAnalyzerPlugin
+const CircularDependencyPlugin = require('circular-dependency-plugin')
+
+const isProd = process.env.NODE_ENV === 'production'
+// See release.js and pathPrefix / PATH_PREFIX
+const PATH_PREFIX = process.env.PATH_PREFIX ?? 'browser/candidate'
+const PATH_VERSION = process.env.PATH_VERSION ?? 'bundles'
+const ASSET_PATH = isProd
+  ? `https://cdn.hightouch-events.com/${PATH_PREFIX}/${PATH_VERSION}/`
+  : '/dist/umd/'
+
+const plugins = [
+  new CompressionPlugin({}),
+  new webpack.EnvironmentPlugin({
+    ASSET_PATH,
+    PATH_PREFIX,
+    PATH_VERSION,
+  }),
+  new CircularDependencyPlugin({
+    failOnError: true,
+  }),
+]
+
+if (process.env.ANALYZE) {
+  plugins.push(new BundleAnalyzerPlugin())
+}
+
+/** @type { import('webpack').Configuration } */
+const config = {
+  stats: process.env.WATCH === 'true' ? 'errors-warnings' : 'normal',
+  node: {
+    global: false, // do not polyfill global object, we can use getGlobal function if needed.
+  },
+  mode: process.env.NODE_ENV || 'development',
+  devtool: 'source-map',
+  entry: {
+    index: {
+      import: path.resolve(__dirname, 'src/browser/browser-umd.ts'),
+      library: {
+        name: 'HtEvents',
+        type: 'umd',
+      },
+    },
+    'events.min': {
+      import: path.resolve(__dirname, 'src/browser/standalone.ts'),
+      library: {
+        name: 'HtEvents',
+        type: 'window',
+      },
+    },
+  },
+  output: {
+    publicPath: '', // Hack - we're overriding publicPath but IE needs this set or it won't load.
+    filename: '[name].js',
+    path: path.resolve(__dirname, 'dist/umd'),
+    chunkFilename: '[name].bundle.[contenthash].js',
+  },
+  target: ['web', 'es5'],
+  module: {
+    rules: [
+      {
+        test: /\.tsx?$/,
+        use: [
+          {
+            loader: 'ts-loader',
+            options: {
+              configFile: 'tsconfig.build.json',
+              transpileOnly: true,
+            },
+          },
+        ],
+      },
+    ],
+  },
+  resolve: {
+    extensions: ['.ts', '.js'],
+  },
+  devServer: {
+    contentBase: path.resolve(__dirname, 'dist/umd'),
+  },
+  optimization: {
+    moduleIds: 'deterministic',
+    minimize: isProd,
+    minimizer: [
+      new TerserPlugin({
+        extractComments: false,
+        terserOptions: {
+          ecma: '2015',
+          mangle: true,
+          compress: true,
+          output: {
+            comments: false,
+          },
+        },
+      }),
+    ],
+  },
+  plugins,
+}
+
+module.exports = config

package/packages/config/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "@internal/config",
+  "version": "0.0.0",
+  "private": true,
+  "main": "./src",
+  "packageManager": "yarn@3.4.1",
+  "devDependencies": {
+    "app-root-path": "^3.1.0"
+  }
+}

package/packages/config/src/index.js

@@ -0,0 +1,4 @@
+module.exports = {
+  createJestTSConfig: require('./jest/config').createJestTSConfig,
+  lintStagedConfig: require('./lint-staged/config'),
+}

package/packages/config/src/jest/config.js

@@ -0,0 +1,50 @@
+const { getJestModuleMap } = require('./get-module-map')
+const path = require('path')
+
+/**
+ * Create Config
+ * @param {string} dirname - __dirname from the package that's importing this config.
+ * @param {import('jest').Config} Overrides.
+ * @returns {import('jest').Config}
+ */
+const createJestTSConfig = (
+  dirname,
+  { modulePathIgnorePatterns, testMatch, ...overridesToMerge } = {}
+) => {
+  if (typeof dirname !== 'string') {
+    throw new Error('Please pass __dirname as the first argument.')
+  }
+  const isRootConfig = dirname === process.cwd()
+  const moduleMap = getJestModuleMap(dirname, isRootConfig)
+  return {
+    ...(isRootConfig ? {} : { displayName: path.basename(process.cwd()) }),
+    /**
+     * No need to manually run yarn build all the time.
+     * This resolve packages for ts-jest so typescript compilation happens in-memory.
+     */
+    moduleNameMapper: moduleMap,
+    preset: 'ts-jest',
+    modulePathIgnorePatterns: [
+      '<rootDir>/dist/',
+      ...(modulePathIgnorePatterns || []),
+    ],
+    testEnvironment: 'node',
+    testMatch: ['**/?(*.)+(test).[jt]s?(x)', ...(testMatch || [])],
+    /**
+     * No need to call jest.clearAllMocks() or jest.resetMocks() manually.
+     * Automatically clear mock calls, instances and results before every test.
+     * Equivalent to calling jest.clearAllMocks() before each test.
+     */
+    clearMocks: true,
+    globals: {
+      'ts-jest': {
+        isolatedModules: true,
+      },
+    },
+    ...(overridesToMerge || {}),
+  }
+}
+
+module.exports = {
+  createJestTSConfig,
+}

package/packages/config/src/jest/get-module-map.js

@@ -0,0 +1,34 @@
+const getPackages = require('get-monorepo-packages')
+const appRootPath = require('app-root-path')
+const path = require('path')
+
+/**
+ * Create module mapping that resolve packages for ts-jest so typescript compilation happens in-memory
+ */
+const getJestModuleMap = (configDirname, isRootConfig) => {
+  // for the sake of getPackages working correctly during a project-wide test run, the working directory must be hardcoded to the root
+  const packageRoot = isRootConfig
+    ? '.'
+    : path.relative(configDirname, appRootPath.path)
+
+  const packages = getPackages(configDirname, packageRoot)
+
+  const createPackageMappedPath = (packagePath) => {
+    const pathToMappedPackage = path.relative(configDirname, packagePath)
+    // alert: yes, this _does_ expect all modules to be in src, and it's completely ignorant of export maps.
+    const result = `<rootDir>/${pathToMappedPackage}/src/$1`
+    return result
+  }
+
+  const moduleMap = packages.reduce(
+    (acc, pkg) => ({
+      ...acc,
+      [`${pkg.package.name}(.*)$`]: createPackageMappedPath(pkg.location),
+    }),
+    {}
+  )
+
+  return moduleMap
+}
+
+module.exports = { getJestModuleMap }

package/packages/config/src/lint-staged/config.js

@@ -0,0 +1,4 @@
+module.exports = {
+  '*.{js,jsx,ts,tsx}': ['eslint --fix'],
+  '*.json*': ['prettier --write'],
+}

package/packages/config-webpack/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@internal/config-webpack",
+  "version": "0.0.0",
+  "private": true,
+  "packageManager": "yarn@3.4.1",
+  "devDependencies": {
+    "@babel/cli": "^7.22.10",
+    "@babel/core": "^7.22.11",
+    "@babel/preset-env": "^7.22.10",
+    "@babel/preset-typescript": "^7.22.11",
+    "@types/circular-dependency-plugin": "^5",
+    "babel-loader": "^8.0.0",
+    "circular-dependency-plugin": "^5.2.2",
+    "ecma-version-validator-webpack-plugin": "^1.2.1",
+    "terser-webpack-plugin": "^5.1.4",
+    "webpack": "^5.76.0",
+    "webpack-cli": "^4.8.0",
+    "webpack-merge": "^5.9.0"
+  }
+}

package/packages/config-webpack/webpack.config.common.js

@@ -0,0 +1,75 @@
+const TerserPlugin = require('terser-webpack-plugin')
+const CircularDependencyPlugin = require('circular-dependency-plugin')
+const {
+  ECMAVersionValidatorPlugin,
+} = require('ecma-version-validator-webpack-plugin')
+
+const isProd = process.env.NODE_ENV === 'production'
+const isWatch = process.env.WATCH === 'true'
+
+/**
+ * This is a base webpack config that is used for all generic web packages.
+ * It should contain the same support as analytics.js (e.g. es5, minified, etc)
+ *
+ *
+ * @type { import('webpack').Configuration }
+ */
+module.exports = {
+  devtool: 'source-map',
+  stats: isWatch ? 'errors-warnings' : 'normal',
+  mode: isProd ? 'production' : 'development',
+  target: ['web', 'es5'], // target es5 for ie11 support (generates module boilerplate in es5)
+  module: {
+    rules: [
+      {
+        test: /\.(ts|js)$/,
+        use: [
+          {
+            loader: 'babel-loader',
+            options: {
+              presets: [
+                ['@babel/preset-typescript'],
+                [
+                  '@babel/preset-env',
+                  {
+                    targets: {
+                      ie: 11,
+                    },
+                  },
+                ],
+              ],
+            },
+          },
+        ],
+      },
+    ],
+  },
+  optimization: {
+    moduleIds: 'deterministic',
+    minimize: isProd,
+    minimizer: [
+      new TerserPlugin({
+        extractComments: false,
+        terserOptions: {
+          // not sure why, if we target es5, we  can set ecma to 2015 here without breaking ie11.
+          // this from the original webpack config had that netto set up, so leaving it as is.
+          ecma: '2015',
+          mangle: true,
+          compress: true,
+          output: {
+            comments: false,
+          },
+        },
+      }),
+    ],
+  },
+  resolve: {
+    extensions: ['.ts', '.js'],
+  },
+  plugins: [
+    new CircularDependencyPlugin({
+      failOnError: true,
+    }),
+    new ECMAVersionValidatorPlugin({ ecmaVersion: 5 }), // ensure our js bundle only contains syntax supported in ie11. This does not check polyfills.
+  ],
+}

package/packages/consent/consent-tools/.eslintrc.js

@@ -0,0 +1,7 @@
+/** @type { import('eslint').Linter.Config } */
+module.exports = {
+  extends: ['../../../.eslintrc'],
+  env: {
+    browser: true,
+  },
+}

package/packages/consent/consent-tools/.lintstagedrc.js

@@ -0,0 +1 @@
+module.exports = require("@internal/config").lintStagedConfig

package/packages/consent/consent-tools/LICENSE

@@ -0,0 +1,45 @@
+The MIT License (MIT)
+
+Copyright © 2023 Hightouch
+
+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.
+
+---
+
+The MIT License (MIT)
+
+Copyright © 2023 Segment
+
+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/packages/consent/consent-tools/README.md

@@ -0,0 +1,104 @@
+# @ht-sdks/events-sdk-js-consent-tools
+
+## Quick Start
+
+```ts
+// wrapper.js
+import { createWrapper, resolveWhen } from '@ht-sdks/events-sdk-js-consent-tools'
+
+export const withCMP = createWrapper({
+
+  // Wrapper waits to load hightouch / get categories until this function returns / resolves
+  shouldLoad: async (ctx) => {
+    const CMP = await getCMP()
+    await resolveWhen(
+      () => !CMP.popUpVisible(),
+      500
+    )
+
+    // Optional -- for granular control of initialization
+    if (noConsentNeeded) {
+      ctx.abort({ loadHightouchNormally: true })
+    } else if (allTrackingDisabled) {
+      ctx.abort({ loadHightouchNormally: false })
+    }
+  },
+
+  getCategories: async () => {
+    const CMP = await getCMP()
+    return normalizeCategories(CMP.consentedCategories()) // Expected format: { foo: true, bar: false }
+  },
+
+  registerOnConsentChanged: async (setCategories) => {
+    const CMP = await getCMP()
+    CMP.onConsentChanged((event) => {
+      setCategories(normalizeCategories(event.detail))
+    })
+  },
+})
+
+
+const getCMP = async () => {
+ await resolveWhen(() => window.CMP !== undefined, 500)
+ return window.CMP
+}
+```
+
+## Wrapper Usage API
+
+## `npm`
+
+```js
+import { withCMP } from './wrapper'
+import { HtEventsBrowser } from '@ht-sdks/events-sdk-js-browser'
+
+export const htevents = new HtEventsBrowser()
+
+withCMP(htevents).load({
+  writeKey: '<MY_WRITE_KEY'>
+})
+
+```
+
+## Snippet users (window.htevents)
+### Note: This assumes a project that can consume the library via es6 imports, using a like Webpack.
+
+1. Delete the `htevents.load()` line from the snippet
+
+```diff
+- htevents.load("<MY_WRITE_KEY>");
+```
+
+2. Import Analytics
+
+```js
+import { withCMP } from './wrapper'
+
+withCMP(window.htevents).load('<MY_WRITE_KEY')
+```
+
+## Wrapper Examples
+
+- [OneTrust](../consent-wrapper-onetrust) (beta)
+
+## Settings / Options / Configuration
+
+See the complete list of settings in the **[Settings interface](src/types/settings.ts)**
+
+## Special Requirements
+
+- For npm users, this library expects a version of `@ht-sdks/events-sdk-js-browser` >= **1.53.1**. Note: If your library depends on this library, you should have the appropriate peer dependency declaration. See our `package.json` for an example.
+
+## Development
+
+1. Build this package + all dependencies
+
+```sh
+yarn . build
+```
+
+2. Run tests
+
+```
+yarn test
+```

package/packages/consent/consent-tools/jest.config.js

@@ -0,0 +1,6 @@
+const { createJestTSConfig } = require('@internal/config')
+
+module.exports = createJestTSConfig(__dirname, {
+  testEnvironment: 'jsdom',
+  setupFilesAfterEnv: ['./jest.setup.js'],
+})

package/packages/consent/consent-tools/jest.setup.js

@@ -0,0 +1,4 @@
+const fetch = require('node-fetch')
+
+// eslint-disable-next-line no-undef
+globalThis.fetch = fetch // polyfill fetch so nock will work correctly on node 18 (https://github.com/nock/nock/issues/2336)