Skip to content

📈 Open source, privacy-first web analytics — a cookie-less Google Analytics alternative with built-in error tracking and performance monitoring. Self-host it or use our cloud. Get started for free!

migrated scripts to typescript & using rollup

Blue Mouse78822fa93599
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 000000000..84eba26f5
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,108 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# Next.js build output
+.next
+
+# Nuxt.js build / generate output
+.nuxt
+# dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and *not* Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+package-lock.json
+
+.DS_Store
+pnpm-lock.yaml
diff --git a/captcha-loader.js b/captcha-loader.js
index 38b137ddb..5d124aa38 100644
--- a/captcha-loader.js
+++ b/captcha-loader.js
@@ -166,8 +166,8 @@ const generateHiddenInput = (params) => {
const input = document.createElement('input')
input.type = 'hidden'
- input.name = params.respName,
- input.value = ''
+ input.name = params.respName
+ input.value = ''
input.id = cid
return input
diff --git a/captcha.css b/captcha.css
deleted file mode 100644
index e69de29bb..000000000
diff --git a/package.json b/package.json
new file mode 100644
index 000000000..d58c93b8f
--- /dev/null
+++ b/package.json
@@ -0,0 +1,49 @@
+{
+ "name": "@swetrix/captcha",
+ "version": "1.0.0",
+ "description": "Swetrix CAPTCHA",
+ "captchaloader": "dist/captcha-loader.js",
+ "captcha": "dist/captcha.js",
+ "esnext": "dist/esnext/index.js",
+ "typings": "dist/esnext/index.d.ts",
+ "scripts": {
+ "prebuild": "rimraf dist",
+ "prepublish": "npm run build",
+ "build": "rollup -c && tsc -p tsconfig.esnext.json",
+ "start": "rollup -c -w",
+ "tsc": "tsc -p tsconfig.esnext.json"
+ },
+ "keywords": [
+ "swetrix",
+ "analytics",
+ "monitoring",
+ "metrics",
+ "privacy"
+ ],
+ "repository": {
+ "type": "git",
+ "url": "git+https://github.com/Swetrix/swetrix-js.git"
+ },
+ "author": "Andrii R. <[email protected]>",
+ "funding": "https://ko-fi.com/andriir",
+ "license": "MIT",
+ "bugs": {
+ "url": "https://github.com/Swetrix/swetrix-js/issues"
+ },
+ "homepage": "https://swetrix.com/docs",
+ "dependencies": {
+ "@types/node": "^18.13.0",
+ "tslib": "^2.5.0"
+ },
+ "devDependencies": {
+ "@rollup/plugin-commonjs": "^24.0.1",
+ "@rollup/plugin-node-resolve": "^15.0.1",
+ "rimraf": "^4.1.2",
+ "rollup": "^2.79.1",
+ "rollup-plugin-node-resolve": "^5.2.0",
+ "rollup-plugin-sourcemaps": "^0.6.3",
+ "rollup-plugin-typescript2": "^0.34.1",
+ "rollup-plugin-uglify": "^6.0.4",
+ "typescript": "^4.9.5"
+ }
+}
diff --git a/rollup.config.js b/rollup.config.js
new file mode 100644
index 000000000..4af034492
--- /dev/null
+++ b/rollup.config.js
@@ -0,0 +1,47 @@
+// import { nodeResolve } from '@rollup/plugin-node-resolve'
+// import commonjs from '@rollup/plugin-commonjs'
+import sourceMaps from 'rollup-plugin-sourcemaps'
+import typescript from 'rollup-plugin-typescript2'
+import { uglify } from 'rollup-plugin-uglify'
+import pkg from './package.json'
+
+const CAPTCHA_PATH = 'src/captcha.ts'
+const CAPTCHA_LOADER_PATH = 'src/captcha-loader.ts'
+
+export default [
+ {
+ input: CAPTCHA_PATH,
+ output: [
+ // { file: pkg.main, format: 'cjs' },
+ // { file: pkg.module, format: 'es' },
+ {
+ file: pkg.captcha,
+ format: 'umd',
+ name: 'captcha',
+ },
+ ],
+ plugins: [
+ typescript(),
+ // nodeResolve(),
+ // commonjs(),
+ uglify(),
+ ]
+ },
+ {
+ input: CAPTCHA_LOADER_PATH,
+ output: [
+ {
+ file: pkg.captchaloader,
+ format: 'umd',
+ name: 'captcha-loader',
+ },
+ ],
+ plugins: [
+ typescript(),
+ // nodeResolve(),
+ // commonjs(),
+ sourceMaps(),
+ uglify(),
+ ]
+ }
+]
diff --git a/logo_blue.svg b/src/assets/logo_blue.svg
similarity index 100%
rename from logo_blue.svg
rename to src/assets/logo_blue.svg
diff --git a/logo_white.svg b/src/assets/logo_white.svg
similarity index 100%
rename from logo_white.svg
rename to src/assets/logo_white.svg
diff --git a/src/captcha-loader.ts b/src/captcha-loader.ts
new file mode 100644
index 000000000..2eb705829
--- /dev/null
+++ b/src/captcha-loader.ts
@@ -0,0 +1,232 @@
+const CAPTCHA_SELECTOR = '.swecaptcha'
+const LIGHT_CAPTCHA_IFRAME_URL = './light.html'
+const DARK_CAPTCHA_IFRAME_URL = './dark.html'
+const DEFAULT_RESPONSE_INPUT_NAME = 'swetrix-captcha-response'
+const MESSAGE_IDENTIFIER = 'swetrix-captcha'
+const ID_PREFIX = 'swetrix-captcha-'
+const THEMES = ['light', 'dark']
+const PID_REGEX = /^(?!.*--)[a-zA-Z0-9-]{12}$/
+
+enum LOG_ACTIONS {
+ log = 'log',
+ error = 'error',
+ warn = 'warn',
+ info = 'info',
+}
+
+const isValidPID = (pid: string) => PID_REGEX.test(pid)
+
+const FRAME_HEIGHT_MAPPING = {
+ default: '66px',
+ manual: '200px',
+}
+
+const getFrameID = (cid: string) => `${cid}-frame`
+
+const ids: string[] = []
+
+const log = (status: LOG_ACTIONS, text: string) => {
+ console[status](`[Swetrix Captcha] ${text}`)
+}
+
+const appendParamsToURL = (url: string, params: any) => {
+ const queryString = Object.keys(params).map((key) => {
+ return `${encodeURIComponent(key)}=${encodeURIComponent(params[key])}`
+ }).join('&')
+
+ return `${url}?${queryString}`
+}
+
+const renderCaptcha = (container: Element, params: any) => {
+ const cid = generateRandomID()
+ const cParams = {
+ ...params,
+ cid, // CAPTCHA ID
+ }
+
+ const frame = generateCaptchaFrame(cParams)
+ const input = generateHiddenInput(cParams)
+
+ container.appendChild(frame)
+ container.appendChild(input)
+}
+
+const generateRandomID = (): string => {
+ const randomID = ID_PREFIX + Math.random().toString(36).substr(2, 6)
+
+ if (ids.includes(randomID)) {
+ return generateRandomID()
+ }
+
+ ids.push(randomID)
+
+ return randomID
+}
+
+const postMessageCallback = (pmEvent: MessageEvent) => {
+ // TODO: Validate origin
+
+ const { data } = pmEvent
+
+ if (!data) {
+ return
+ }
+
+ const {
+ type, cid, event,
+ } = data
+
+ if (type !== MSG_IDENTIFIER) {
+ return
+ }
+
+ if (!cid || !ids.includes(cid)) {
+ return
+ }
+
+ const input = document.getElementById(cid)
+ const inputExists = input !== null
+
+ switch (event) {
+ case 'success': {
+ const { token } = data
+
+ if (!inputExists) {
+ log(LOG_ACTIONS.error, '[PM -> success] Input element does not exist.')
+ return
+ }
+
+ // @ts-ignore
+ input.value = token
+
+ break
+ }
+
+ case 'failure': {
+ if (!inputExists) {
+ log(LOG_ACTIONS.error, '[PM -> failure] Input element does not exist.')
+ return
+ }
+
+ // @ts-ignore
+ input.value = ''
+
+ break
+ }
+
+ case 'tokenExpired': {
+ if (!inputExists) {
+ log(LOG_ACTIONS.error, '[PM -> failure] Input element does not exist.')
+ return
+ }
+
+ // @ts-ignore
+ input.value = ''
+
+ break
+ }
+
+ case 'manualStarted': {
+ const frame = document.getElementById(getFrameID(cid))
+
+ if (!frame) {
+ log(LOG_ACTIONS.error, '[PM -> manualStarted] Frame does not exist.')
+ return
+ }
+
+ frame.style.height = FRAME_HEIGHT_MAPPING.manual
+
+ break
+ }
+
+ case 'manualFinished': {
+ const frame = document.getElementById(getFrameID(cid))
+
+ if (!frame) {
+ log(LOG_ACTIONS.error, '[PM -> manualFinished] Frame does not exist.')
+ return
+ }
+
+ frame.style.height = FRAME_HEIGHT_MAPPING.default
+
+ break
+ }
+ }
+}
+
+const generateCaptchaFrame = (params: any) => {
+ const { theme } = params
+ const captchaFrame = document.createElement('iframe')
+
+ captchaFrame.id = getFrameID(params.cid)
+ captchaFrame.src = theme === 'dark'
+ ? appendParamsToURL(DARK_CAPTCHA_IFRAME_URL, params)
+ : appendParamsToURL(LIGHT_CAPTCHA_IFRAME_URL, params)
+ captchaFrame.style.height = FRAME_HEIGHT_MAPPING.default
+ captchaFrame.title = 'Swetrix Captcha'
+ captchaFrame.style.border = 'none'
+ captchaFrame.style.width = '302px'
+ captchaFrame.style.overflow = 'visible'
+
+ return captchaFrame
+}
+
+const generateHiddenInput = (params: any) => {
+ const { cid } = params
+ const input = document.createElement('input')
+
+ input.type = 'hidden'
+ input.name = params.respName
+ input.value = ''
+ input.id = cid
+
+ return input
+}
+
+const validateParams = (params: any) => {
+ const { theme, pid } = params
+
+ if (theme && !THEMES.includes(theme)) {
+ log(LOG_ACTIONS.error, `Invalid data-theme parameter: ${theme}`)
+ return false
+ }
+
+ if (!pid || !isValidPID(pid)) {
+ log(LOG_ACTIONS.error, `Invalid data-project-id parameter: ${pid}`)
+ return false
+ }
+
+ return true
+}
+
+const parseParams = (container: Element): object => ({
+ pid: container.getAttribute('data-project-id'),
+ respName: container.getAttribute('data-response-input-name') || DEFAULT_RESPONSE_INPUT_NAME,
+ theme: container.getAttribute('data-theme'),
+})
+
+const main = () => {
+ if ('swecaptcha' in window) {
+ log(LOG_ACTIONS.warn, 'Captcha is already loaded.')
+ }
+
+ // TODO: Add some callbacks here
+ // @ts-ignore
+ window.swecaptcha = true
+ window.addEventListener('message', postMessageCallback)
+
+ const containers = Array.from(document.querySelectorAll(CAPTCHA_SELECTOR))
+
+ for (const container of containers) {
+ const params = parseParams(container)
+
+ if (!validateParams(params)) {
+ log(LOG_ACTIONS.error, 'Aborting captcha rendering due to invalid parameters.')
+ return
+ }
+
+ renderCaptcha(container, params)
+ }
+}
+
+document.addEventListener('DOMContentLoaded', main)
diff --git a/src/captcha.ts b/src/captcha.ts
new file mode 100644
index 000000000..8b0316236
--- /dev/null
+++ b/src/captcha.ts
@@ -0,0 +1,281 @@
+const API_URL = 'http://localhost:5005/v1/captcha'
+const MSG_IDENTIFIER = 'swetrix-captcha'
+const DEFAULT_THEME = 'light'
+const CAPTCHA_TOKEN_LIFETIME = 300 // seconds (5 minutes).
+let TOKEN = ''
+let HASH = ''
+
+const ENDPOINTS = {
+ VERIFY: '/verify',
+ GENERATE: '/generate',
+ VERIFY_MANUAL: '/verify-manual',
+}
+
+enum IFRAME_MESSAGE_TYPES {
+ SUCCESS = 'success',
+ FAILURE = 'failure',
+ TOKEN_EXPIRED = 'tokenExpired',
+ MANUAL_STARTED = 'manualStarted',
+ MANUAL_FINISHED = 'manualFinished',
+}
+
+enum ACTION {
+ checkbox = 'checkbox',
+ failure = 'failure',
+ completed = 'completed',
+ loading = 'loading',
+}
+
+let activeAction: ACTION = ACTION.checkbox
+
+const sendMessageToLoader = (event: IFRAME_MESSAGE_TYPES, data = {}) => {
+ window.parent.postMessage({
+ event,
+ type: MSG_IDENTIFIER,
+ // @ts-ignore
+ cid: window.__SWETRIX_CAPTCHA_ID,
+ ...data,
+ }, '*')
+}
+
+/**
+ * Sets the provided action visible and the rest hidden
+ * @param {*} action checkbox | failure | completed | loading
+ */
+const activateAction = (action: ACTION) => {
+ activeAction = action
+
+ const statusDefault = document.querySelector('#status-default')
+ const statusFailure = document.querySelector('#status-failure')
+
+ const actions = {
+ checkbox: document.querySelector('#checkbox'),
+ failure: document.querySelector('#failure'),
+ completed: document.querySelector('#completed'),
+ loading: document.querySelector('#loading'),
+ }
+
+ // Apply hidden class to all actions
+ actions.checkbox?.classList.add('hidden')
+ actions.failure?.classList.add('hidden')
+ actions.completed?.classList.add('hidden')
+ actions.loading?.classList.add('hidden')
+
+ // Change the status text
+ if (action === 'failure') {
+ statusDefault?.classList.add('hidden')
+ statusFailure?.classList.remove('hidden')
+ } else {
+ statusDefault?.classList.remove('hidden')
+ statusFailure?.classList.add('hidden')
+ }
+
+ // Remove hidden class from the provided action
+ actions[action]?.classList.remove('hidden')
+}
+
+const setLifetimeTimeout = () => {
+ setTimeout(() => {
+ sendMessageToLoader(IFRAME_MESSAGE_TYPES.TOKEN_EXPIRED)
+ activateAction(ACTION.checkbox)
+ }, CAPTCHA_TOKEN_LIFETIME * 1000)
+}
+
+const enableManualChallenge = (svg: string) => {
+ const manualChallenge = document.querySelector('#manual-challenge')
+ const svgCaptcha = document.querySelector('#svg-captcha')
+
+ if (!svgCaptcha) {
+ return
+ }
+
+ if (!svg) {
+ const error = document.createElement('p')
+ error.innerText = 'Error loading captcha'
+ error.style.color = '#d6292a'
+ svgCaptcha?.appendChild(error)
+ } else {
+ svgCaptcha.innerHTML = svg
+ }
+
+ sendMessageToLoader(IFRAME_MESSAGE_TYPES.MANUAL_STARTED)
+ manualChallenge?.classList.remove('hidden')
+}
+
+const disableManualChallenge = () => {
+ const manualChallenge = document.querySelector('#manual-challenge')
+ const svgCaptcha = document.querySelector('#svg-captcha')
+
+ if (!svgCaptcha) {
+ return
+ }
+
+ sendMessageToLoader(IFRAME_MESSAGE_TYPES.MANUAL_FINISHED)
+ svgCaptcha.innerHTML = ''
+ manualChallenge?.classList.add('hidden')
+}
+
+const generateCaptcha = async () => {
+ try {
+ const response = await fetch(`${API_URL}${ENDPOINTS.GENERATE}`, {
+ method: 'POST',
+ headers: {
+ 'Content-Type': 'application/json',
+ },
+ body: JSON.stringify({
+ // @ts-ignore
+ theme: window.__SWETRIX_CAPTCHA_THEME || DEFAULT_THEME,
+ // @ts-ignore
+ pid: window.__SWETRIX_PROJECT_ID,
+ }),
+ })
+
+ if (!response.ok) {
+ throw ''
+ }
+
+ const data = await response.json()
+ return data
+ } catch (e) {
+ sendMessageToLoader(IFRAME_MESSAGE_TYPES.FAILURE)
+ activateAction(ACTION.failure)
+ return {}
+ }
+}
+
+const verify = async () => {
+ try {
+ const response = await fetch(`${API_URL}${ENDPOINTS.VERIFY}`, {
+ method: 'POST',
+ headers: {
+ 'Content-Type': 'application/json',
+ },
+ body: JSON.stringify({
+ // @ts-ignore
+ pid: window.__SWETRIX_PROJECT_ID,
+ }),
+ })
+
+ if (!response.ok) {
+ return {}
+ }
+
+ const data = await response.json()
+ return data
+ } catch (e) {
+ sendMessageToLoader(IFRAME_MESSAGE_TYPES.FAILURE)
+ activateAction(ACTION.failure)
+ return {}
+ }
+}
+
+document.addEventListener('DOMContentLoaded', () => {
+ const captchaComponent = document.querySelector('#swetrix-captcha')
+ const branding = document.querySelector('#branding')
+ const svgCaptchaInput = document.querySelector('#svg-captcha-input')
+ const manualSubmitBtn = document.querySelector('#manual-submit-btn')
+
+ branding?.addEventListener('click', (e: Event) => {
+ e.stopPropagation()
+ })
+
+ manualSubmitBtn?.addEventListener('click', async (e: Event) => {
+ e.stopPropagation()
+
+ if (!svgCaptchaInput) {
+ return
+ }
+
+ // @ts-ignore
+ const code = svgCaptchaInput.value
+
+ if (!code) {
+ return
+ }
+
+ let response
+
+ try {
+ response = await fetch(`${API_URL}${ENDPOINTS.VERIFY_MANUAL}`, {
+ method: 'POST',
+ body: JSON.stringify({
+ hash: HASH,
+ code,
+ // @ts-ignore
+ pid: window.__SWETRIX_PROJECT_ID,
+ }),
+ headers: {
+ 'Content-Type': 'application/json',
+ },
+ })
+ } catch (e) {
+ disableManualChallenge()
+ sendMessageToLoader(IFRAME_MESSAGE_TYPES.FAILURE)
+ activateAction(ACTION.failure)
+ // @ts-ignore
+ svgCaptchaInput.value = ''
+ return
+ }
+
+ if (!response.ok) {
+ disableManualChallenge()
+ sendMessageToLoader(IFRAME_MESSAGE_TYPES.FAILURE)
+ activateAction(ACTION.failure)
+ // @ts-ignore
+ svgCaptchaInput.value = ''
+ return
+ }
+
+ const { success, token } = await response.json()
+
+ if (!success) {
+ disableManualChallenge()
+ sendMessageToLoader(IFRAME_MESSAGE_TYPES.FAILURE)
+ activateAction(ACTION.failure)
+ // @ts-ignore
+ svgCaptchaInput.value = ''
+ return
+ }
+
+ // @ts-ignore
+ svgCaptchaInput.value = ''
+
+ sendMessageToLoader(IFRAME_MESSAGE_TYPES.SUCCESS, { token })
+ setLifetimeTimeout()
+ activateAction(ACTION.completed)
+ disableManualChallenge()
+ })
+
+ captchaComponent?.addEventListener('click', async () => {
+ if (activeAction === ACTION.loading || activeAction === ACTION.completed) {
+ return
+ }
+
+ if (activeAction === ACTION.failure) {
+ activateAction(ACTION.checkbox)
+ return
+ }
+
+ activateAction(ACTION.loading)
+
+ try {
+ const { token } = await verify()
+
+ if (!token) {
+ throw ''
+ }
+
+ TOKEN = token
+ sendMessageToLoader(IFRAME_MESSAGE_TYPES.SUCCESS, { token })
+ setLifetimeTimeout()
+ activateAction(ACTION.completed)
+ return
+ } catch (e) {
+ const { data, hash } = await generateCaptcha()
+
+ HASH = hash
+ enableManualChallenge(data)
+ return
+ }
+ })
+})
diff --git a/dark.html b/src/pages/dark.html
similarity index 100%
rename from dark.html
rename to src/pages/dark.html
diff --git a/light.html b/src/pages/light.html
similarity index 100%
rename from light.html
rename to src/pages/light.html
diff --git a/tsconfig.esnext.json b/tsconfig.esnext.json
new file mode 100644
index 000000000..901fb91ab
--- /dev/null
+++ b/tsconfig.esnext.json
@@ -0,0 +1,17 @@
+{
+ "compilerOptions": {
+ "moduleResolution": "node",
+ "target": "es2020",
+ "module": "es2015",
+ "lib": ["dom"],
+ "strict": true,
+ "sourceMap": true,
+ "declaration": true,
+ "allowSyntheticDefaultImports": true,
+ "experimentalDecorators": true,
+ "emitDecoratorMetadata": true,
+ "outDir": "dist/esnext",
+ "typeRoots": ["node_modules/@types"]
+ },
+ "include": ["src"]
+}
diff --git a/tsconfig.json b/tsconfig.json
new file mode 100644
index 000000000..3fe10f8db
--- /dev/null
+++ b/tsconfig.json
@@ -0,0 +1,17 @@
+{
+ "compilerOptions": {
+ "moduleResolution": "node",
+ "target": "es5",
+ "module": "es2015",
+ "lib": ["es2015", "es2016", "es2017", "dom"],
+ "strict": true,
+ "allowSyntheticDefaultImports": true,
+ "experimentalDecorators": true,
+ "emitDecoratorMetadata": true,
+ "sourceMap": true,
+ "declaration": false,
+ "outDir": "dist/lib",
+ "typeRoots": ["node_modules/@types"]
+ },
+ "include": ["src"]
+}