From 9900d6ea6df88d4e4e1cb4c31a37cd6bd38e57bf Mon Sep 17 00:00:00 2001 From: goenning Date: Fri, 15 Dec 2023 20:03:17 +0000 Subject: [PATCH] refactor the packages to remove internal dependency --- .gitignore | 3 +- .vscode/settings.json | 7 +- README.md | 3 +- package-lock.json | 731 +++++++++++++++++++++++++++++++-- packages/react/CHANGELOG.md | 4 + packages/react/README.md | 8 +- packages/react/package.json | 5 +- packages/react/src/global.d.ts | 1 - packages/react/src/index.tsx | 53 ++- packages/shared.ts | 149 +++++++ packages/web/CHANGELOG.md | 4 + packages/web/README.md | 10 +- packages/web/package.json | 2 +- packages/web/src/global.d.ts | 1 - packages/web/src/index.ts | 128 +----- packages/web/src/session.ts | 8 - 16 files changed, 939 insertions(+), 178 deletions(-) delete mode 100644 packages/react/src/global.d.ts create mode 100644 packages/shared.ts delete mode 100644 packages/web/src/global.d.ts delete mode 100644 packages/web/src/session.ts diff --git a/.gitignore b/.gitignore index bee5a84..24f0c3e 100644 --- a/.gitignore +++ b/.gitignore @@ -28,4 +28,5 @@ npm-debug.log* # bundler output dist build -.next \ No newline at end of file +.next +.plasmo \ No newline at end of file diff --git a/.vscode/settings.json b/.vscode/settings.json index ac0d179..1451556 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -13,5 +13,10 @@ "source.organizeImports": true } }, - "files.eol": "\n" + "files.eol": "\n", + "[typescript][typescriptreact]": { + "editor.codeActionsOnSave": { + "source.organizeImports": "explicit" + } + } } diff --git a/README.md b/README.md index eae319d..f1376fe 100644 --- a/README.md +++ b/README.md @@ -3,4 +3,5 @@ This repository hosts the code for: - [SDK for React / Remix / Next.js](./packages/react/README.md) -- [SDK for JavaScript](./packages/web/README.md) +- [SDK for Web Apps](./packages/web/README.md) +- [SDK for Browser Extensions](./packages/browser/README.md) diff --git a/package-lock.json b/package-lock.json index 2e360c8..ef1980f 100644 --- a/package-lock.json +++ b/package-lock.json @@ -22,6 +22,14 @@ "npm": ">=7.0.0" } }, + "examples/browser-ext": { + "version": "1.0.0", + "extraneous": true, + "license": "ISC", + "dependencies": { + "@aptabase/browser": "*" + } + }, "examples/next-with-approuter": { "version": "0.0.0", "dependencies": { @@ -48,6 +56,22 @@ "typescript": "5.2.2" } }, + "examples/plasmo-browserext": { + "version": "0.0.1", + "extraneous": true, + "dependencies": { + "@aptabase/browser": "*", + "plasmo": "0.84.0", + "react": "18.2.0", + "react-dom": "18.2.0" + }, + "devDependencies": { + "@types/chrome": "0.0.254", + "@types/react": "18.2.45", + "@types/react-dom": "18.2.17", + "typescript": "5.3.3" + } + }, "examples/remix-app": { "dependencies": { "@aptabase/react": "*", @@ -3342,6 +3366,206 @@ "url": "https://github.com/sindresorhus/is?sponsor=1" } }, + "node_modules/@swc/core": { + "version": "1.3.100", + "resolved": "https://registry.npmjs.org/@swc/core/-/core-1.3.100.tgz", + "integrity": "sha512-7dKgTyxJjlrMwFZYb1auj3Xq0D8ZBe+5oeIgfMlRU05doXZypYJe0LAk0yjj3WdbwYzpF+T1PLxwTWizI0pckw==", + "dev": true, + "hasInstallScript": true, + "optional": true, + "peer": true, + "dependencies": { + "@swc/counter": "^0.1.1", + "@swc/types": "^0.1.5" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/swc" + }, + "optionalDependencies": { + "@swc/core-darwin-arm64": "1.3.100", + "@swc/core-darwin-x64": "1.3.100", + "@swc/core-linux-arm64-gnu": "1.3.100", + "@swc/core-linux-arm64-musl": "1.3.100", + "@swc/core-linux-x64-gnu": "1.3.100", + "@swc/core-linux-x64-musl": "1.3.100", + "@swc/core-win32-arm64-msvc": "1.3.100", + "@swc/core-win32-ia32-msvc": "1.3.100", + "@swc/core-win32-x64-msvc": "1.3.100" + }, + "peerDependencies": { + "@swc/helpers": "^0.5.0" + }, + "peerDependenciesMeta": { + "@swc/helpers": { + "optional": true + } + } + }, + "node_modules/@swc/core-darwin-arm64": { + "version": "1.3.100", + "resolved": "https://registry.npmjs.org/@swc/core-darwin-arm64/-/core-darwin-arm64-1.3.100.tgz", + "integrity": "sha512-XVWFsKe6ei+SsDbwmsuRkYck1SXRpO60Hioa4hoLwR8fxbA9eVp6enZtMxzVVMBi8ej5seZ4HZQeAWepbukiBw==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "darwin" + ], + "peer": true, + "engines": { + "node": ">=10" + } + }, + "node_modules/@swc/core-darwin-x64": { + "version": "1.3.100", + "resolved": "https://registry.npmjs.org/@swc/core-darwin-x64/-/core-darwin-x64-1.3.100.tgz", + "integrity": "sha512-KF/MXrnH1nakm1wbt4XV8FS7kvqD9TGmVxeJ0U4bbvxXMvzeYUurzg3AJUTXYmXDhH/VXOYJE5N5RkwZZPs5iA==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "darwin" + ], + "peer": true, + "engines": { + "node": ">=10" + } + }, + "node_modules/@swc/core-linux-arm64-gnu": { + "version": "1.3.100", + "resolved": "https://registry.npmjs.org/@swc/core-linux-arm64-gnu/-/core-linux-arm64-gnu-1.3.100.tgz", + "integrity": "sha512-p8hikNnAEJrw5vHCtKiFT4hdlQxk1V7vqPmvUDgL/qe2menQDK/i12tbz7/3BEQ4UqUPnvwpmVn2d19RdEMNxw==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "peer": true, + "engines": { + "node": ">=10" + } + }, + "node_modules/@swc/core-linux-arm64-musl": { + "version": "1.3.100", + "resolved": "https://registry.npmjs.org/@swc/core-linux-arm64-musl/-/core-linux-arm64-musl-1.3.100.tgz", + "integrity": "sha512-BWx/0EeY89WC4q3AaIaBSGfQxkYxIlS3mX19dwy2FWJs/O+fMvF9oLk/CyJPOZzbp+1DjGeeoGFuDYpiNO91JA==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "peer": true, + "engines": { + "node": ">=10" + } + }, + "node_modules/@swc/core-linux-x64-gnu": { + "version": "1.3.100", + "resolved": "https://registry.npmjs.org/@swc/core-linux-x64-gnu/-/core-linux-x64-gnu-1.3.100.tgz", + "integrity": "sha512-XUdGu3dxAkjsahLYnm8WijPfKebo+jHgHphDxaW0ovI6sTdmEGFDew7QzKZRlbYL2jRkUuuKuDGvD6lO5frmhA==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "peer": true, + "engines": { + "node": ">=10" + } + }, + "node_modules/@swc/core-linux-x64-musl": { + "version": "1.3.100", + "resolved": "https://registry.npmjs.org/@swc/core-linux-x64-musl/-/core-linux-x64-musl-1.3.100.tgz", + "integrity": "sha512-PhoXKf+f0OaNW/GCuXjJ0/KfK9EJX7z2gko+7nVnEA0p3aaPtbP6cq1Ubbl6CMoPL+Ci3gZ7nYumDqXNc3CtLQ==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "peer": true, + "engines": { + "node": ">=10" + } + }, + "node_modules/@swc/core-win32-arm64-msvc": { + "version": "1.3.100", + "resolved": "https://registry.npmjs.org/@swc/core-win32-arm64-msvc/-/core-win32-arm64-msvc-1.3.100.tgz", + "integrity": "sha512-PwLADZN6F9cXn4Jw52FeP/MCLVHm8vwouZZSOoOScDtihjY495SSjdPnlosMaRSR4wJQssGwiD/4MbpgQPqbAw==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "win32" + ], + "peer": true, + "engines": { + "node": ">=10" + } + }, + "node_modules/@swc/core-win32-ia32-msvc": { + "version": "1.3.100", + "resolved": "https://registry.npmjs.org/@swc/core-win32-ia32-msvc/-/core-win32-ia32-msvc-1.3.100.tgz", + "integrity": "sha512-0f6nicKSLlDKlyPRl2JEmkpBV4aeDfRQg6n8mPqgL7bliZIcDahG0ej+HxgNjZfS3e0yjDxsNRa6sAqWU2Z60A==", + "cpu": [ + "ia32" + ], + "dev": true, + "optional": true, + "os": [ + "win32" + ], + "peer": true, + "engines": { + "node": ">=10" + } + }, + "node_modules/@swc/core-win32-x64-msvc": { + "version": "1.3.100", + "resolved": "https://registry.npmjs.org/@swc/core-win32-x64-msvc/-/core-win32-x64-msvc-1.3.100.tgz", + "integrity": "sha512-b7J0rPoMkRTa3XyUGt8PwCaIBuYWsL2DqbirrQKRESzgCvif5iNpqaM6kjIjI/5y5q1Ycv564CB51YDpiS8EtQ==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "win32" + ], + "peer": true, + "engines": { + "node": ">=10" + } + }, + "node_modules/@swc/counter": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/@swc/counter/-/counter-0.1.2.tgz", + "integrity": "sha512-9F4ys4C74eSTEUNndnER3VJ15oru2NumfQxS8geE+f3eB5xvfxpWyqE5XlVnxb/R14uoXi6SLbBwwiDSkv+XEw==", + "dev": true, + "optional": true, + "peer": true + }, "node_modules/@swc/helpers": { "version": "0.5.1", "license": "Apache-2.0", @@ -3349,6 +3573,14 @@ "tslib": "^2.4.0" } }, + "node_modules/@swc/types": { + "version": "0.1.5", + "resolved": "https://registry.npmjs.org/@swc/types/-/types-0.1.5.tgz", + "integrity": "sha512-myfUej5naTBWnqOCc/MdVOLVjXUXtIA+NpDrDBKJtLLg2shUjBu3cZmB/85RyitKc55+lUUyl7oRfLOvkr2hsw==", + "dev": true, + "optional": true, + "peer": true + }, "node_modules/@szmarczak/http-timer": { "version": "4.0.6", "resolved": "https://registry.npmjs.org/@szmarczak/http-timer/-/http-timer-4.0.6.tgz", @@ -3462,9 +3694,9 @@ } }, "node_modules/@types/http-cache-semantics": { - "version": "4.0.1", - "resolved": "https://registry.npmjs.org/@types/http-cache-semantics/-/http-cache-semantics-4.0.1.tgz", - "integrity": "sha512-SZs7ekbP8CN0txVG2xVRH6EgKmEm31BOxA07vkFaETzZz1xh+cbt8BcI0slpymvwhx5dlFnQG2rTlPVQn+iRPQ==", + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/@types/http-cache-semantics/-/http-cache-semantics-4.0.4.tgz", + "integrity": "sha512-1m0bIFVc7eJWyve9S0RnuRgcQqF/Xd5QsUZAZeQFr1Q3/p9JWoQQEqmVy+DPTNpGXwhgIetAoYF8JSc33q29QA==", "dev": true }, "node_modules/@types/json-schema": { @@ -4021,7 +4253,7 @@ }, "node_modules/anymatch": { "version": "3.1.3", - "dev": true, + "devOptional": true, "license": "ISC", "dependencies": { "normalize-path": "^3.0.0", @@ -4364,7 +4596,7 @@ }, "node_modules/binary-extensions": { "version": "2.2.0", - "dev": true, + "devOptional": true, "license": "MIT", "engines": { "node": ">=8" @@ -4446,7 +4678,7 @@ }, "node_modules/braces": { "version": "3.0.2", - "dev": true, + "devOptional": true, "license": "MIT", "dependencies": { "fill-range": "^7.0.1" @@ -4767,7 +4999,7 @@ }, "node_modules/chokidar": { "version": "3.5.3", - "dev": true, + "devOptional": true, "funding": [ { "type": "individual", @@ -5009,6 +5241,20 @@ "node": ">=6.6.0" } }, + "node_modules/copy-anything": { + "version": "2.0.6", + "resolved": "https://registry.npmjs.org/copy-anything/-/copy-anything-2.0.6.tgz", + "integrity": "sha512-1j20GZTsvKNkc4BY3NpMOM8tt///wY3FpIzozTOFO2ffuZcV61nojHXVKIy3WM+7ADCy5FVhdZYHYDdgTU0yJw==", + "dev": true, + "optional": true, + "peer": true, + "dependencies": { + "is-what": "^3.14.1" + }, + "funding": { + "url": "https://github.com/sponsors/mesqueeb" + } + }, "node_modules/core-js-compat": { "version": "3.32.1", "resolved": "https://registry.npmjs.org/core-js-compat/-/core-js-compat-3.32.1.tgz", @@ -5291,6 +5537,20 @@ "node": ">=8" } }, + "node_modules/detect-libc": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/detect-libc/-/detect-libc-1.0.3.tgz", + "integrity": "sha512-pGjwhsmsp4kL2RTz08wcOlGN83otlqHeD/Z5T8GXZB+/YcpQ/dgo+lbU8ZsGxV0HIvqqxo9l7mqYwyYMD9bKDg==", + "dev": true, + "optional": true, + "peer": true, + "bin": { + "detect-libc": "bin/detect-libc.js" + }, + "engines": { + "node": ">=0.10" + } + }, "node_modules/detect-newline": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/detect-newline/-/detect-newline-3.1.0.tgz", @@ -5449,6 +5709,20 @@ "node": ">=10.13.0" } }, + "node_modules/errno": { + "version": "0.1.8", + "resolved": "https://registry.npmjs.org/errno/-/errno-0.1.8.tgz", + "integrity": "sha512-dJ6oBr5SQ1VSd9qkk7ByRgb/1SH4JZjCHSW/mr63/QcXO9zLVxvJ6Oy13nio03rxpSnVDDjFor75SjVeZWPW/A==", + "dev": true, + "optional": true, + "peer": true, + "dependencies": { + "prr": "~1.0.1" + }, + "bin": { + "errno": "cli.js" + } + }, "node_modules/es-abstract": { "version": "1.22.1", "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.22.1.tgz", @@ -6960,9 +7234,10 @@ "peer": true }, "node_modules/fast-glob": { - "version": "3.3.1", + "version": "3.3.2", + "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.3.2.tgz", + "integrity": "sha512-oX2ruAFQwf/Orj8m737Y5adxDQO0LAB7/S5MnxCdTNDd4p6BsyIVsv9JQsATbTSq8KHRpLwIHbVlUNatxd+1Ow==", "dev": true, - "license": "MIT", "dependencies": { "@nodelib/fs.stat": "^2.0.2", "@nodelib/fs.walk": "^1.2.3", @@ -7055,7 +7330,7 @@ }, "node_modules/fill-range": { "version": "7.0.1", - "dev": true, + "devOptional": true, "license": "MIT", "dependencies": { "to-regex-range": "^5.0.1" @@ -7415,7 +7690,7 @@ }, "node_modules/glob-parent": { "version": "5.1.2", - "dev": true, + "devOptional": true, "license": "ISC", "dependencies": { "is-glob": "^4.0.1" @@ -7786,6 +8061,27 @@ "node": ">= 4" } }, + "node_modules/image-size": { + "version": "0.5.5", + "resolved": "https://registry.npmjs.org/image-size/-/image-size-0.5.5.tgz", + "integrity": "sha512-6TDAlDPZxUFCv+fuOkIoXT/V/f3Qbq8e37p+YOiYrUv3v9cc3/6x78VdfPgFVaB9dZYeLUfKgHRebpkm/oP2VQ==", + "dev": true, + "optional": true, + "peer": true, + "bin": { + "image-size": "bin/image-size.js" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/immutable": { + "version": "4.3.4", + "resolved": "https://registry.npmjs.org/immutable/-/immutable-4.3.4.tgz", + "integrity": "sha512-fsXeu4J4i6WNWSikpI88v/PcVflZz+6kMhUfIwc5SY+poQRPnaf5V7qds6SUyUN3cVxEzuCab7QIoLOQ+DQ1wA==", + "optional": true, + "peer": true + }, "node_modules/import-fresh": { "version": "3.3.0", "resolved": "https://registry.npmjs.org/import-fresh/-/import-fresh-3.3.0.tgz", @@ -7992,7 +8288,7 @@ }, "node_modules/is-binary-path": { "version": "2.1.0", - "dev": true, + "devOptional": true, "license": "MIT", "dependencies": { "binary-extensions": "^2.0.0" @@ -8096,7 +8392,7 @@ }, "node_modules/is-extglob": { "version": "2.1.1", - "dev": true, + "devOptional": true, "license": "MIT", "engines": { "node": ">=0.10.0" @@ -8139,7 +8435,7 @@ }, "node_modules/is-glob": { "version": "4.0.3", - "dev": true, + "devOptional": true, "license": "MIT", "dependencies": { "is-extglob": "^2.1.1" @@ -8199,7 +8495,7 @@ }, "node_modules/is-number": { "version": "7.0.0", - "dev": true, + "devOptional": true, "license": "MIT", "engines": { "node": ">=0.12.0" @@ -8389,6 +8685,14 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/is-what": { + "version": "3.14.1", + "resolved": "https://registry.npmjs.org/is-what/-/is-what-3.14.1.tgz", + "integrity": "sha512-sNxgpk9793nzSs7bA6JQJGeIuRBQhAaNGG77kzYQgMkrID+lS6SlK07K5LaptscDlSaIgH+GPFzf+d75FVxozA==", + "dev": true, + "optional": true, + "peer": true + }, "node_modules/isarray": { "version": "2.0.5", "resolved": "https://registry.npmjs.org/isarray/-/isarray-2.0.5.tgz", @@ -8558,6 +8862,45 @@ "language-subtag-registry": "~0.3.2" } }, + "node_modules/less": { + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/less/-/less-4.2.0.tgz", + "integrity": "sha512-P3b3HJDBtSzsXUl0im2L7gTO5Ubg8mEN6G8qoTS77iXxXX4Hvu4Qj540PZDvQ8V6DmX6iXo98k7Md0Cm1PrLaA==", + "dev": true, + "optional": true, + "peer": true, + "dependencies": { + "copy-anything": "^2.0.1", + "parse-node-version": "^1.0.1", + "tslib": "^2.3.0" + }, + "bin": { + "lessc": "bin/lessc" + }, + "engines": { + "node": ">=6" + }, + "optionalDependencies": { + "errno": "^0.1.1", + "graceful-fs": "^4.1.2", + "image-size": "~0.5.0", + "make-dir": "^2.1.0", + "mime": "^1.4.1", + "needle": "^3.1.0", + "source-map": "~0.6.0" + } + }, + "node_modules/less/node_modules/source-map": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", + "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", + "dev": true, + "optional": true, + "peer": true, + "engines": { + "node": ">=0.10.0" + } + }, "node_modules/levn": { "version": "0.4.1", "resolved": "https://registry.npmjs.org/levn/-/levn-0.4.1.tgz", @@ -8572,6 +8915,224 @@ "node": ">= 0.8.0" } }, + "node_modules/lightningcss": { + "version": "1.22.1", + "resolved": "https://registry.npmjs.org/lightningcss/-/lightningcss-1.22.1.tgz", + "integrity": "sha512-Fy45PhibiNXkm0cK5FJCbfO8Y6jUpD/YcHf/BtuI+jvYYqSXKF4muk61jjE8YxCR9y+hDYIWSzHTc+bwhDE6rQ==", + "dev": true, + "optional": true, + "peer": true, + "dependencies": { + "detect-libc": "^1.0.3" + }, + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + }, + "optionalDependencies": { + "lightningcss-darwin-arm64": "1.22.1", + "lightningcss-darwin-x64": "1.22.1", + "lightningcss-freebsd-x64": "1.22.1", + "lightningcss-linux-arm-gnueabihf": "1.22.1", + "lightningcss-linux-arm64-gnu": "1.22.1", + "lightningcss-linux-arm64-musl": "1.22.1", + "lightningcss-linux-x64-gnu": "1.22.1", + "lightningcss-linux-x64-musl": "1.22.1", + "lightningcss-win32-x64-msvc": "1.22.1" + } + }, + "node_modules/lightningcss-darwin-arm64": { + "version": "1.22.1", + "resolved": "https://registry.npmjs.org/lightningcss-darwin-arm64/-/lightningcss-darwin-arm64-1.22.1.tgz", + "integrity": "sha512-ldvElu+R0QimNTjsKpaZkUv3zf+uefzLy/R1R19jtgOfSRM+zjUCUgDhfEDRmVqJtMwYsdhMI2aJtJChPC6Osg==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "darwin" + ], + "peer": true, + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-darwin-x64": { + "version": "1.22.1", + "resolved": "https://registry.npmjs.org/lightningcss-darwin-x64/-/lightningcss-darwin-x64-1.22.1.tgz", + "integrity": "sha512-5p2rnlVTv6Gpw4PlTLq925nTVh+HFh4MpegX8dPDYJae+NFVjQ67gY7O6iHIzQjLipDiYejFF0yHrhjU3XgLBQ==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "darwin" + ], + "peer": true, + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-freebsd-x64": { + "version": "1.22.1", + "resolved": "https://registry.npmjs.org/lightningcss-freebsd-x64/-/lightningcss-freebsd-x64-1.22.1.tgz", + "integrity": "sha512-1FaBtcFrZqB2hkFbAxY//Pnp8koThvyB6AhjbdVqKD4/pu13Rl91fKt2N9qyeQPUt3xy7ORUvSO+dPk3J6EjXg==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "freebsd" + ], + "peer": true, + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-linux-arm-gnueabihf": { + "version": "1.22.1", + "resolved": "https://registry.npmjs.org/lightningcss-linux-arm-gnueabihf/-/lightningcss-linux-arm-gnueabihf-1.22.1.tgz", + "integrity": "sha512-6rub98tYGfE5I5j0BP8t/2d4BZyu1S7Iz9vUkm0H26snAFHYxLfj3RbQn0xHHIePSetjLnhcg3QlfwUAkD/FYg==", + "cpu": [ + "arm" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "peer": true, + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-linux-arm64-gnu": { + "version": "1.22.1", + "resolved": "https://registry.npmjs.org/lightningcss-linux-arm64-gnu/-/lightningcss-linux-arm64-gnu-1.22.1.tgz", + "integrity": "sha512-nYO5qGtb/1kkTZu3FeTiM+2B2TAb7m2DkLCTgQIs2bk2o9aEs7I96fwySKcoHWQAiQDGR9sMux9vkV4KQXqPaQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "peer": true, + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-linux-arm64-musl": { + "version": "1.22.1", + "resolved": "https://registry.npmjs.org/lightningcss-linux-arm64-musl/-/lightningcss-linux-arm64-musl-1.22.1.tgz", + "integrity": "sha512-MCV6RuRpzXbunvzwY644iz8cw4oQxvW7oer9xPkdadYqlEyiJJ6wl7FyJOH7Q6ZYH4yjGAUCvxDBxPbnDu9ZVg==", + "cpu": [ + "arm64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "peer": true, + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-linux-x64-gnu": { + "version": "1.22.1", + "resolved": "https://registry.npmjs.org/lightningcss-linux-x64-gnu/-/lightningcss-linux-x64-gnu-1.22.1.tgz", + "integrity": "sha512-RjNgpdM20VUXgV7us/VmlO3Vn2ZRiDnc3/bUxCVvySZWPiVPprpqW/QDWuzkGa+NCUf6saAM5CLsZLSxncXJwg==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "peer": true, + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-linux-x64-musl": { + "version": "1.22.1", + "resolved": "https://registry.npmjs.org/lightningcss-linux-x64-musl/-/lightningcss-linux-x64-musl-1.22.1.tgz", + "integrity": "sha512-ZgO4C7Rd6Hv/5MnyY2KxOYmIlzk4rplVolDt3NbkNR8DndnyX0Q5IR4acJWNTBICQ21j3zySzKbcJaiJpk/4YA==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "linux" + ], + "peer": true, + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, + "node_modules/lightningcss-win32-x64-msvc": { + "version": "1.22.1", + "resolved": "https://registry.npmjs.org/lightningcss-win32-x64-msvc/-/lightningcss-win32-x64-msvc-1.22.1.tgz", + "integrity": "sha512-4pozV4eyD0MDET41ZLHAeBo+H04Nm2UEYIk5w/ts40231dRFV7E0cjwbnZvSoc1DXFgecAhiC0L16ruv/ZDCpg==", + "cpu": [ + "x64" + ], + "dev": true, + "optional": true, + "os": [ + "win32" + ], + "peer": true, + "engines": { + "node": ">= 12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/parcel" + } + }, "node_modules/lilconfig": { "version": "2.1.0", "dev": true, @@ -8722,6 +9283,32 @@ "lz-string": "bin/bin.js" } }, + "node_modules/make-dir": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/make-dir/-/make-dir-2.1.0.tgz", + "integrity": "sha512-LS9X+dc8KLxXCb8dni79fLIIUA5VyZoyjSMCwTluaXA0o27cCK0bhXkpgw+sTXVpPy/lSO57ilRixqk0vDmtRA==", + "dev": true, + "optional": true, + "peer": true, + "dependencies": { + "pify": "^4.0.1", + "semver": "^5.6.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/make-dir/node_modules/semver": { + "version": "5.7.2", + "resolved": "https://registry.npmjs.org/semver/-/semver-5.7.2.tgz", + "integrity": "sha512-cBznnQ9KjJqU67B52RMC65CMarK2600WFnbkcaiwWq3xy/5haFJlshgnpjovMVJ+Hff49d8GEn0b87C5pDQ10g==", + "dev": true, + "optional": true, + "peer": true, + "bin": { + "semver": "bin/semver" + } + }, "node_modules/markdown-extensions": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/markdown-extensions/-/markdown-extensions-1.1.1.tgz", @@ -9899,6 +10486,38 @@ "integrity": "sha512-Tj+HTDSJJKaZnfiuw+iaF9skdPpTo2GtEly5JHnWV/hfv2Qj/9RKsGISQtLh2ox3l5EAGw487hnBee0sIJ6v2g==", "dev": true }, + "node_modules/needle": { + "version": "3.3.1", + "resolved": "https://registry.npmjs.org/needle/-/needle-3.3.1.tgz", + "integrity": "sha512-6k0YULvhpw+RoLNiQCRKOl09Rv1dPLr8hHnVjHqdolKwDrdNyk+Hmrthi4lIGPPz3r39dLx0hsF5s40sZ3Us4Q==", + "dev": true, + "optional": true, + "peer": true, + "dependencies": { + "iconv-lite": "^0.6.3", + "sax": "^1.2.4" + }, + "bin": { + "needle": "bin/needle" + }, + "engines": { + "node": ">= 4.4.x" + } + }, + "node_modules/needle/node_modules/iconv-lite": { + "version": "0.6.3", + "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.6.3.tgz", + "integrity": "sha512-4fCk79wshMdzMp2rH06qWrJE4iolqLhCUH+OiuIgU++RB0+94NlDL81atO7GX55uUKueo0txHNtvEyI6D7WdMw==", + "dev": true, + "optional": true, + "peer": true, + "dependencies": { + "safer-buffer": ">= 2.1.2 < 3.0.0" + }, + "engines": { + "node": ">=0.10.0" + } + }, "node_modules/negotiator": { "version": "0.6.3", "resolved": "https://registry.npmjs.org/negotiator/-/negotiator-0.6.3.tgz", @@ -10026,7 +10645,7 @@ }, "node_modules/normalize-path": { "version": "3.0.0", - "dev": true, + "devOptional": true, "license": "MIT", "engines": { "node": ">=0.10.0" @@ -10419,6 +11038,17 @@ "node": ">=6" } }, + "node_modules/parse-node-version": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/parse-node-version/-/parse-node-version-1.0.1.tgz", + "integrity": "sha512-3YHlOa/JgH6Mnpr05jP9eDG254US9ek25LyIxZlDItp2iJtwyaXQb57lBYLdT3MowkUFYEV2XXNAYIPlESvJlA==", + "dev": true, + "optional": true, + "peer": true, + "engines": { + "node": ">= 0.10" + } + }, "node_modules/parseurl": { "version": "1.3.3", "resolved": "https://registry.npmjs.org/parseurl/-/parseurl-1.3.3.tgz", @@ -10505,7 +11135,7 @@ }, "node_modules/picomatch": { "version": "2.3.1", - "dev": true, + "devOptional": true, "license": "MIT", "engines": { "node": ">=8.6" @@ -10526,6 +11156,17 @@ "node": ">=0.10" } }, + "node_modules/pify": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/pify/-/pify-4.0.1.tgz", + "integrity": "sha512-uB80kBFb/tfd68bVleG9T5GGsGPjJrLAUpR5PZIrhBnIaRTQRjqdJSsIKkOP6OAIFbj7GOrcudc5pNjZ+geV2g==", + "dev": true, + "optional": true, + "peer": true, + "engines": { + "node": ">=6" + } + }, "node_modules/pirates": { "version": "4.0.6", "dev": true, @@ -10854,6 +11495,14 @@ "integrity": "sha512-D+zkORCbA9f1tdWRK0RaCR3GPv50cMxcrz4X8k5LTSUD1Dkw47mKJEZQNunItRTkWwgtaUSo1RVFRIG9ZXiFYg==", "dev": true }, + "node_modules/prr": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/prr/-/prr-1.0.1.tgz", + "integrity": "sha512-yPw4Sng1gWghHQWj0B3ZggWUm4qVbPwPFcRG8KyxiU7J2OHFSoEHKS+EZ3fv5l1t9CyCiop6l/ZYeWbrgoQejw==", + "dev": true, + "optional": true, + "peer": true + }, "node_modules/pump": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/pump/-/pump-2.0.1.tgz", @@ -11040,7 +11689,7 @@ }, "node_modules/readdirp": { "version": "3.6.0", - "dev": true, + "devOptional": true, "license": "MIT", "dependencies": { "picomatch": "^2.2.1" @@ -11497,6 +12146,32 @@ "resolved": "https://registry.npmjs.org/safer-buffer/-/safer-buffer-2.1.2.tgz", "integrity": "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==" }, + "node_modules/sass": { + "version": "1.69.5", + "resolved": "https://registry.npmjs.org/sass/-/sass-1.69.5.tgz", + "integrity": "sha512-qg2+UCJibLr2LCVOt3OlPhr/dqVHWOa9XtZf2OjbLs/T4VPSJ00udtgJxH3neXZm+QqX8B+3cU7RaLqp1iVfcQ==", + "optional": true, + "peer": true, + "dependencies": { + "chokidar": ">=3.0.0 <4.0.0", + "immutable": "^4.0.0", + "source-map-js": ">=0.6.2 <2.0.0" + }, + "bin": { + "sass": "sass.js" + }, + "engines": { + "node": ">=14.0.0" + } + }, + "node_modules/sax": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/sax/-/sax-1.3.0.tgz", + "integrity": "sha512-0s+oAmw9zLl1V1cS9BtZN7JAd0cW5e0QH4W3LWEK6a4LaLEA2OTpGYWDY+6XasBLtz6wkm3u1xRw95mRuJ59WA==", + "dev": true, + "optional": true, + "peer": true + }, "node_modules/scheduler": { "version": "0.23.0", "license": "MIT", @@ -12263,7 +12938,7 @@ }, "node_modules/to-regex-range": { "version": "5.0.1", - "dev": true, + "devOptional": true, "license": "MIT", "dependencies": { "is-number": "^7.0.0" @@ -13331,20 +14006,26 @@ "url": "https://github.com/sponsors/wooorm" } }, - "packages/react": { - "name": "@aptabase/react", - "version": "0.2.2", + "packages/browser": { + "name": "@aptabase/browser", + "version": "0.1.0", + "extraneous": true, "license": "MIT", "dependencies": { - "@aptabase/web": "^0.3.0" - }, + "@aptabase/web": "^0.4.0" + } + }, + "packages/react": { + "name": "@aptabase/react", + "version": "0.3.0", + "license": "MIT", "peerDependencies": { "react": "^18.0.0" } }, "packages/web": { "name": "@aptabase/web", - "version": "0.3.2", + "version": "0.4.0", "license": "MIT" } } diff --git a/packages/react/CHANGELOG.md b/packages/react/CHANGELOG.md index 8554bc6..d880e0b 100644 --- a/packages/react/CHANGELOG.md +++ b/packages/react/CHANGELOG.md @@ -1,3 +1,7 @@ +## 0.3.0 + +- Internal refactor + ## 0.2.2 - Updated dependencies diff --git a/packages/react/README.md b/packages/react/README.md index 3b5fe49..21ec726 100644 --- a/packages/react/README.md +++ b/packages/react/README.md @@ -1,12 +1,12 @@ ![Aptabase](https://aptabase.com/og.png) -# React SDK for Aptabase +# Aptabase SDK for React Apps A tiny SDK (1 kB) to instrument your React apps with Aptabase, an Open Source, Privacy-First and Simple Analytics for Mobile, Desktop and Web Apps. ## Setup -1. Install the SDK using your preferred JavaScript package manager +1. Install the SDK using npm or your preferred JavaScript package manager ```bash npm add @aptabase/react @@ -105,6 +105,8 @@ ReactDOM.createRoot(root).render( The `AptabaseProvider` also supports an optional second parameter, which is an object with the `appVersion` property. +It's up to you to decide how to get the version of your app, but it's generally recommended to use your bundler (like Webpack, Vite, Rollup, etc.) to inject the values at build time. Alternatively you can also pass it in manually. + It's up to you to decide what to get the version of your app, but it's generally recommended to use your bundler (like Webpack, Vite, Rollup, etc.) to inject the values at build time. ## Tracking Events with Aptabase @@ -145,7 +147,7 @@ export function Counter() { A few important notes: -1. The SDK will automatically enhance the event with some useful information, like the OS, the app version, and other things. +1. The SDK will automatically enhance the event with some useful information, like the OS and other properties. 2. You're in control of what gets sent to Aptabase. This SDK does not automatically track any events, you need to call `trackEvent` manually. - Because of this, it's generally recommended to at least track an event at startup 3. You do not need to await the `trackEvent` function, it'll run in the background. diff --git a/packages/react/package.json b/packages/react/package.json index 36c5680..2edf266 100644 --- a/packages/react/package.json +++ b/packages/react/package.json @@ -1,6 +1,6 @@ { "name": "@aptabase/react", - "version": "0.2.2", + "version": "0.3.0", "type": "module", "description": "React SDK for Aptabase: Open Source, Privacy-First and Simple Analytics for Mobile, Desktop and Web Apps", "main": "./dist/index.cjs", @@ -33,9 +33,6 @@ "dist", "package.json" ], - "dependencies": { - "@aptabase/web": "^0.3.0" - }, "peerDependencies": { "react": "^18.0.0" } diff --git a/packages/react/src/global.d.ts b/packages/react/src/global.d.ts deleted file mode 100644 index 4dbd621..0000000 --- a/packages/react/src/global.d.ts +++ /dev/null @@ -1 +0,0 @@ -declare var __APTABASE_SDK_VERSION__: string; diff --git a/packages/react/src/index.tsx b/packages/react/src/index.tsx index 6cd05a6..8bc9e4b 100644 --- a/packages/react/src/index.tsx +++ b/packages/react/src/index.tsx @@ -1,18 +1,40 @@ 'use client'; -import { init, trackEvent, type AptabaseOptions } from '@aptabase/web'; import { createContext, useContext, useEffect } from 'react'; +import { inMemorySessionId, sendEvent, validateAppKey, type AptabaseOptions } from '../../shared'; -globalThis.__APTABASE_SDK_VERSION__ = `aptabase-react@${process.env.PKG_VERSION}`; +// Session expires after 1 hour of inactivity +const SESSION_TIMEOUT = 1 * 60 * 60; +const sdkVersion = `aptabase-react@${process.env.PKG_VERSION}`; + +let _appKey = ''; +let _options: AptabaseOptions | undefined; type ContextProps = { appKey?: string; options?: AptabaseOptions; }; -export type AptabaseClient = { - trackEvent: typeof trackEvent; -}; +function init(appKey: string, options?: AptabaseOptions) { + if (!validateAppKey(appKey)) return; + + _appKey = appKey; + _options = options; +} + +async function trackEvent(eventName: string, props?: Record): Promise { + const sessionId = inMemorySessionId(SESSION_TIMEOUT); + + await sendEvent({ + sessionId, + appKey: _appKey, + isDebug: _options?.isDebug, + appVersion: _options?.appVersion, + sdkVersion, + eventName, + props, + }); +} const AptabaseContext = createContext({}); @@ -22,6 +44,12 @@ type Props = { children: React.ReactNode; }; +export { type AptabaseOptions }; + +export type AptabaseClient = { + trackEvent: typeof trackEvent; +}; + export function AptabaseProvider({ appKey, options, children }: Props) { useEffect(() => { init(appKey, options); @@ -33,17 +61,6 @@ export function AptabaseProvider({ appKey, options, children }: Props) { export function useAptabase(): AptabaseClient { const ctx = useContext(AptabaseContext); - if (typeof window === 'undefined') { - return { - trackEvent: (eventName: string) => { - console.warn( - `Aptabase: trackEvent can only be called from client components. Event '${eventName}' will be ignored.`, - ); - return Promise.resolve(); - }, - }; - } - if (!ctx.appKey) { return { trackEvent: () => { @@ -55,5 +72,7 @@ export function useAptabase(): AptabaseClient { }; } - return { trackEvent }; + return { + trackEvent, + }; } diff --git a/packages/shared.ts b/packages/shared.ts new file mode 100644 index 0000000..362b0cf --- /dev/null +++ b/packages/shared.ts @@ -0,0 +1,149 @@ +const defaultLocale = getBrowserLocale(); +const defaultIsDebug = getIsDebug(); +const isInBrowser = typeof window !== 'undefined' && typeof window.fetch !== 'undefined'; + +let _sessionId = newSessionId(); +let _lastTouched = new Date(); + +const apiUrl: Record = {}; + +const _hosts: { [region: string]: string } = { + US: 'https://us.aptabase.com', + EU: 'https://eu.aptabase.com', + DEV: 'http://localhost:3000', + SH: '', +}; + +export type AptabaseOptions = { + host?: string; + appVersion?: string; + isDebug?: boolean; +}; + +export function inMemorySessionId(timeout: number): string { + let now = new Date(); + const diffInMs = now.getTime() - _lastTouched.getTime(); + const diffInSec = Math.floor(diffInMs / 1000); + if (diffInSec > timeout) { + _sessionId = newSessionId(); + } + _lastTouched = now; + + return _sessionId; +} + +export function newSessionId(): string { + const epochInSeconds = Math.floor(Date.now() / 1000).toString(); + const random = Math.floor(Math.random() * 100000000) + .toString() + .padStart(8, '0'); + + return epochInSeconds + random; +} + +export function validateAppKey(appKey: string): boolean { + const parts = appKey.split('-'); + if (parts.length !== 3 || _hosts[parts[1]] === undefined) { + console.warn(`The Aptabase App Key "${appKey}" is invalid. Tracking will be disabled.`); + return false; + } + return true; +} + +function getApiUrl(appKey: string, options?: AptabaseOptions): string | undefined { + const url = apiUrl[appKey]; + if (url) url; + + const region = appKey.split('-')[1]; + let host = _hosts[region]; + if (region === 'SH') { + if (!options?.host) { + console.warn(`Host parameter must be defined when using Self-Hosted App Key. Tracking will be disabled.`); + return; + } + + host = options.host; + } + + apiUrl[appKey] = `${host}/api/v0/event`; + return apiUrl[appKey]; +} + +export async function sendEvent(opts: { + appKey?: string; + sessionId: string; + locale?: string; + isDebug?: boolean; + appVersion?: string; + sdkVersion: string; + eventName: string; + props?: Record; +}): Promise { + if (!isInBrowser) { + console.warn(`Aptabase: trackEvent requires a browser environment. Event "${opts.eventName}" will be discarded.`); + return; + } + + if (!opts.appKey) { + console.warn(`Aptabase: init must be called before trackEvent. Event "${opts.eventName}" will be discarded.`); + return; + } + + const apiUrl = getApiUrl(opts.appKey); + if (!apiUrl) return; + + try { + const response = await fetch(apiUrl, { + method: 'POST', + headers: { + 'Content-Type': 'application/json', + 'App-Key': opts.appKey, + }, + credentials: 'omit', + body: JSON.stringify({ + timestamp: new Date().toISOString(), + sessionId: opts.sessionId, + eventName: opts.eventName, + systemProps: { + locale: opts.locale ?? defaultLocale, + isDebug: opts.isDebug ?? defaultIsDebug, + appVersion: opts.appVersion ?? '', + sdkVersion: opts.sdkVersion, + }, + props: opts.props, + }), + }); + + if (response.status >= 300) { + const responseBody = await response.text(); + console.warn(`Failed to send event "${opts.eventName}": ${response.status} ${responseBody}`); + } + } catch (e) { + console.warn(`Failed to send event "${opts.eventName}"`); + console.warn(e); + } +} + +function getBrowserLocale(): string | undefined { + if (typeof navigator === 'undefined') { + return undefined; + } + + if (navigator.languages.length > 0) { + return navigator.languages[0]; + } + + return navigator.language; +} + +function getIsDebug(): boolean { + if (process.env.NODE_ENV === 'development') { + return true; + } + + if (typeof location === 'undefined') { + return false; + } + + return location.hostname === 'localhost'; +} diff --git a/packages/web/CHANGELOG.md b/packages/web/CHANGELOG.md index 741ec61..1996172 100644 --- a/packages/web/CHANGELOG.md +++ b/packages/web/CHANGELOG.md @@ -1,3 +1,7 @@ +## 0.4.0 + +- Internal refactor + ## 0.3.2 - better version of the session id generator diff --git a/packages/web/README.md b/packages/web/README.md index d73339a..d91308c 100644 --- a/packages/web/README.md +++ b/packages/web/README.md @@ -1,6 +1,6 @@ ![Aptabase](https://aptabase.com/og.png) -# JavaScript SDK for Aptabase +# Aptabase SDK for Web Apps A tiny SDK (1 kB) to instrument your web app with Aptabase, an Open Source, Privacy-First and Simple Analytics for Mobile, Desktop and Web Apps. @@ -12,7 +12,7 @@ Building a React app? Use the `@aptabase/react` package instead. ## Install -Install the SDK using your preferred JavaScript package manager +Install the SDK using npm or your preferred JavaScript package manager ```bash npm add @aptabase/web @@ -22,7 +22,7 @@ npm add @aptabase/web First you need to get your `App Key` from Aptabase, you can find it in the `Instructions` menu on the left side menu. -Initialized the SDK using your `App Key`: +Initialize the SDK using your `App Key`: ```js import { init } from '@aptabase/web'; @@ -32,7 +32,7 @@ init(''); // 👈 this is where you enter your App Key The init function also supports an optional second parameter, which is an object with the `appVersion` property. -It's up to you to decide what to get the version of your app, but it's generally recommended to use your bundler (like Webpack, Vite, Rollup, etc.) to inject the values at build time. +It's up to you to decide how to get the version of your app, but it's generally recommended to use your bundler (like Webpack, Vite, Rollup, etc.) to inject the values at build time. Alternatively you can also pass it in manually. Afterwards you can start tracking events with `trackEvent`: @@ -45,7 +45,7 @@ trackEvent('play_music', { name: 'Here comes the sun' }); // An event with a cus A few important notes: -1. The SDK will automatically enhance the event with some useful information, like the OS, the app version, and other things. +1. The SDK will automatically enhance the event with some useful information, like the OS and other properties. 2. You're in control of what gets sent to Aptabase. This SDK does not automatically track any events, you need to call `trackEvent` manually. - Because of this, it's generally recommended to at least track an event at startup 3. You do not need to await the `trackEvent` function, it'll run in the background. diff --git a/packages/web/package.json b/packages/web/package.json index 451c112..81033d3 100644 --- a/packages/web/package.json +++ b/packages/web/package.json @@ -1,6 +1,6 @@ { "name": "@aptabase/web", - "version": "0.3.2", + "version": "0.4.0", "type": "module", "description": "JavaScript SDK for Aptabase: Open Source, Privacy-First and Simple Analytics for Mobile, Desktop and Web Apps", "main": "./dist/index.cjs", diff --git a/packages/web/src/global.d.ts b/packages/web/src/global.d.ts deleted file mode 100644 index 4dbd621..0000000 --- a/packages/web/src/global.d.ts +++ /dev/null @@ -1 +0,0 @@ -declare var __APTABASE_SDK_VERSION__: string; diff --git a/packages/web/src/index.ts b/packages/web/src/index.ts index 246726b..fc6424b 100644 --- a/packages/web/src/index.ts +++ b/packages/web/src/index.ts @@ -1,123 +1,31 @@ -import { newSessionId } from './session'; - -export type AptabaseOptions = { - host?: string; - appVersion?: string; - isDebug?: boolean; -}; - -const locale = getBrowserLocale(); +import { inMemorySessionId, sendEvent, validateAppKey, type AptabaseOptions } from '../../shared'; // Session expires after 1 hour of inactivity const SESSION_TIMEOUT = 1 * 60 * 60; -let _sessionId = newSessionId(); -let _lastTouched = new Date(); -let _appKey = ''; -let _apiUrl = ''; -let _isDebug = false; -let _appVersion = ''; +const sdkVersion = `aptabase-web@${process.env.PKG_VERSION}`; -const _hosts: { [region: string]: string } = { - US: 'https://us.aptabase.com', - EU: 'https://eu.aptabase.com', - DEV: 'http://localhost:3000', - SH: '', -}; +let _appKey = ''; +let _options: AptabaseOptions | undefined; + +export { type AptabaseOptions }; export function init(appKey: string, options?: AptabaseOptions) { - const parts = appKey.split('-'); - if (parts.length !== 3 || _hosts[parts[1]] === undefined) { - console.warn(`The Aptabase App Key "${appKey}" is invalid. Tracking will be disabled.`); - return; - } + if (!validateAppKey(appKey)) return; - const baseUrl = getBaseUrl(parts[1], options); - _apiUrl = `${baseUrl}/api/v0/event`; _appKey = appKey; - _isDebug = options?.isDebug ?? getIsDebug(); - _appVersion = options?.appVersion ?? ''; + _options = options; } export async function trackEvent(eventName: string, props?: Record): Promise { - if (!_appKey) return; + const sessionId = inMemorySessionId(SESSION_TIMEOUT); - if (typeof window === 'undefined' || !window.fetch) { - console.warn(`Aptabase: trackEvent requires a browser environment. Event "${eventName}" will not be tracked.`); - return; - } - - let now = new Date(); - const diffInMs = now.getTime() - _lastTouched.getTime(); - const diffInSec = Math.floor(diffInMs / 1000); - if (diffInSec > SESSION_TIMEOUT) { - _sessionId = newSessionId(); - } - _lastTouched = now; - - try { - const response = await window.fetch(_apiUrl, { - method: 'POST', - headers: { - 'Content-Type': 'application/json', - 'App-Key': _appKey, - }, - credentials: 'omit', - body: JSON.stringify({ - timestamp: new Date().toISOString(), - sessionId: _sessionId, - eventName: eventName, - systemProps: { - locale, - isDebug: _isDebug, - appVersion: _appVersion, - sdkVersion: globalThis.__APTABASE_SDK_VERSION__ ?? `aptabase-web@${process.env.PKG_VERSION}`, - }, - props: props, - }), - }); - - if (response.status >= 300) { - const responseBody = await response.text(); - console.warn(`Failed to send event "${eventName}": ${response.status} ${responseBody}`); - } - } catch (e) { - console.warn(`Failed to send event "${eventName}"`); - console.warn(e); - } -} - -function getBaseUrl(region: string, options?: AptabaseOptions): string | undefined { - if (region === 'SH') { - if (!options?.host) { - console.warn(`Host parameter must be defined when using Self-Hosted App Key. Tracking will be disabled.`); - return; - } - return options.host; - } - - return _hosts[region]; -} - -function getBrowserLocale(): string | null { - if (typeof navigator === 'undefined') { - return null; - } - - if (navigator.languages.length > 0) { - return navigator.languages[0]; - } - - return navigator.language; -} - -function getIsDebug(): boolean { - if (process.env.NODE_ENV === 'development') { - return true; - } - - if (typeof location === 'undefined') { - return false; - } - - return location.hostname === 'localhost'; + await sendEvent({ + sessionId, + appKey: _appKey, + isDebug: _options?.isDebug, + appVersion: _options?.appVersion, + sdkVersion, + eventName, + props, + }); } diff --git a/packages/web/src/session.ts b/packages/web/src/session.ts deleted file mode 100644 index c14fc7b..0000000 --- a/packages/web/src/session.ts +++ /dev/null @@ -1,8 +0,0 @@ -export function newSessionId(): string { - const epochInSeconds = Math.floor(Date.now() / 1000).toString(); - const random = Math.floor(Math.random() * 100000000) - .toString() - .padStart(8, '0'); - - return epochInSeconds + random; -}