npm - @prosopo/procaptcha-bundle - Versions diffs - 0.2.11 → 0.2.14 - Mend

@prosopo/procaptcha-bundle 0.2.11 → 0.2.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
     "name": "@prosopo/procaptcha-bundle",
-    "version": "0.2.11",
+    "version": "0.2.14",
     "author": "PROSOPO LIMITED <info@prosopo.io>",
     "license": "Apache-2.0",
     "main": "./dist/index.js",
@@ -23,8 +23,8 @@
         "build": "tsc --build --verbose",
         "build:cjs": "npx vite --config vite.cjs.config.ts build",
         "start": "vite serve --mode development --host",
-        "build:dev": "npm run build && vite build --mode development --debug",
-        "build:prod": "npm run build && vite build --mode production",
+        "bundle:dev": "vite build --config vite.config.ts --mode development --debug",
+        "bundle:prod": "vite build --config vite.config.ts --mode production",
         "lint": "npx eslint .",
         "lint:fix": "npx eslint . --fix --config ../../.eslintrc.js"
     },
@@ -36,11 +36,11 @@
         "@emotion/styled": "^11.11.0",
         "@mui/icons-material": "^5.14.3",
         "@mui/material": "^5.14.5",
-        "@prosopo/common": "0.2.11",
-        "@prosopo/procaptcha": "0.2.11",
-        "@prosopo/procaptcha-react": "0.2.11",
-        "@prosopo/types": "0.2.11",
-        "@prosopo/util": "0.2.11"
+        "@prosopo/common": "0.2.14",
+        "@prosopo/procaptcha": "0.2.14",
+        "@prosopo/procaptcha-react": "0.2.14",
+        "@prosopo/types": "0.2.14",
+        "@prosopo/util": "0.2.14"
     },
     "repository": {
         "type": "git",
@@ -56,7 +56,7 @@
     },
     "devDependencies": {
         "@originjs/vite-plugin-commonjs": "^1.0.3",
-        "@prosopo/config": "0.2.11",
+        "@prosopo/config": "0.2.14",
         "@rollup/plugin-typescript": "^11.1.2",
         "@vitejs/plugin-react": "^4.0.4",
         "tslib": "2.6.2",

package/src/index.html ADDED Viewed

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8"/>
+    <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
+    <title>Prosopo CAPTCHA</title>
+  </head>
+  <body>
+    <div id="root"></div>
+  </body>
+</html>

package/src/index.tsx ADDED Viewed

@@ -0,0 +1,219 @@
+// Copyright 2021-2023 Prosopo (UK) Ltd.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+import {
+    ApiParams,
+    EnvironmentTypesSchema,
+    NetworkNamesSchema,
+    ProcaptchaConfigSchema,
+    ProcaptchaOutput,
+} from '@prosopo/types'
+import { Procaptcha } from '@prosopo/procaptcha-react'
+import { ProcaptchaConfigOptional } from '@prosopo/procaptcha'
+import { at } from '@prosopo/util'
+import { createRoot } from 'react-dom/client'
+interface ProcaptchaRenderOptions {
+    siteKey: string
+    theme?: 'light' | 'dark'
+    callback?: string
+    'challenge-valid-length'?: string // seconds for successful challenge to be valid
+    'chalexpired-callback'?: string
+    'expired-callback'?: string
+    'open-callback'?: string
+    'close-callback'?: string
+    'error-callback'?: string
+}
+type ProcaptchaUrlParams = {
+    onloadUrlCallback: string | undefined
+    renderExplicit: string | undefined
+}
+const BUNDLE_NAME = 'procaptcha.bundle.js'
+const getCurrentScript = () =>
+    document && document.currentScript && 'src' in document.currentScript && document.currentScript.src !== undefined
+        ? document.currentScript
+        : undefined
+const extractParams = (name: string): ProcaptchaUrlParams => {
+    const script = getCurrentScript()
+    if (script && script.src.indexOf(`${name}`) !== -1) {
+        const params = new URLSearchParams(script.src.split('?')[1])
+        return {
+            onloadUrlCallback: params.get('onload') || undefined,
+            renderExplicit: params.get('render') || undefined,
+        }
+    }
+    return { onloadUrlCallback: undefined, renderExplicit: undefined }
+}
+const getConfig = (siteKey?: string): ProcaptchaConfigOptional => {
+    if (!siteKey) {
+        siteKey = process.env.DAPP_SITE_KEY || process.env.PROSOPO_SITE_KEY || process.env.REACT_APP_DAPP_SITE_KEY || ''
+    }
+    return ProcaptchaConfigSchema.parse({
+        defaultEnvironment: process.env.DEFAULT_ENVIRONMENT
+            ? EnvironmentTypesSchema.parse(process.env.DEFAULT_ENVIRONMENT)
+            : EnvironmentTypesSchema.enum.development,
+        defaultNetwork: process.env.DEFAULT_NETWORK
+            ? NetworkNamesSchema.parse(process.env.DEFAULT_NETWORK)
+            : NetworkNamesSchema.enum.development,
+        userAccountAddress: '',
+        account: {
+            address: siteKey,
+        },
+        serverUrl: process.env.SERVER_URL || '',
+    })
+}
+const getParentForm = (element: Element): HTMLFormElement | null => element.closest('form') as HTMLFormElement
+const getWindowCallback = (callbackName: string) => {
+    const fn = (window as any)[callbackName.replace('window.', '')]
+    if (typeof fn !== 'function') {
+        throw new Error(`Callback ${callbackName} is not defined on the window object`)
+    }
+    return fn
+}
+const handleOnHuman = (element: Element, payload: ProcaptchaOutput) => {
+    const form = getParentForm(element)
+    if (!form) {
+        console.error('Parent form not found for the element:', element)
+        return
+    }
+    const input = document.createElement('input')
+    input.type = 'hidden'
+    input.name = ApiParams.procaptchaResponse
+    input.value = JSON.stringify(payload)
+    form.appendChild(input)
+}
+const customThemeSet = new Set(['light', 'dark'])
+const validateTheme = (themeAttribute: string): 'light' | 'dark' =>
+    customThemeSet.has(themeAttribute) ? (themeAttribute as 'light' | 'dark') : 'light'
+const renderLogic = (
+    elements: Element[],
+    config: ProcaptchaConfigOptional,
+    renderOptions?: ProcaptchaRenderOptions
+) => {
+    elements.forEach((element) => {
+        const callbackName = renderOptions?.callback || element.getAttribute('data-callback')
+        const chalExpiredCallbackName =
+            renderOptions?.['chalexpired-callback'] || element.getAttribute('data-chalexpired-callback')
+        const errorCallback = renderOptions?.['error-callback'] || element.getAttribute('data-error-callback')
+        const onCloseCallbackName = renderOptions?.['close-callback'] || element.getAttribute('data-close-callback')
+        const onOpenCallbackName = renderOptions?.['open-callback'] || element.getAttribute('data-open-callback')
+        const onExpiredCallbackName =
+            renderOptions?.['expired-callback'] || element.getAttribute('data-expired-callback')
+        // Setting up default callbacks object
+        const callbacks = {
+            onHuman: (payload: ProcaptchaOutput) => handleOnHuman(element, payload),
+            onChallengeExpired: () => {
+                console.log('Challenge expired')
+            },
+            onExpired: () => {
+                alert('Completed challenge has expired, please try again')
+            },
+            onError: (error: Error) => {
+                console.error(error)
+            },
+            onClose: () => {
+                console.log('Challenge closed')
+            },
+            onOpen: () => {
+                console.log('Challenge opened')
+            },
+        }
+        if (callbackName) callbacks.onHuman = getWindowCallback(callbackName)
+        if (chalExpiredCallbackName) callbacks.onChallengeExpired = getWindowCallback(chalExpiredCallbackName)
+        if (onExpiredCallbackName) callbacks.onExpired = getWindowCallback(onExpiredCallbackName)
+        if (errorCallback) callbacks.onError = getWindowCallback(errorCallback)
+        if (onCloseCallbackName) callbacks.onClose = getWindowCallback(onCloseCallbackName)
+        if (onOpenCallbackName) callbacks.onOpen = getWindowCallback(onOpenCallbackName)
+        // Getting and setting the theme
+        const themeAttribute = renderOptions?.theme || element.getAttribute('data-theme') || 'light'
+        config.theme = validateTheme(themeAttribute)
+        // Getting and setting the challenge valid length
+        const challengeValidLengthAttribute =
+            renderOptions?.['challenge-valid-length'] || element.getAttribute('data-challenge-valid-length')
+        if (challengeValidLengthAttribute) {
+            config.challengeValidLength = parseInt(challengeValidLengthAttribute)
+        }
+        createRoot(element).render(<Procaptcha config={config} callbacks={callbacks} />)
+    })
+}
+// Implicit render for targeting all elements with class 'procaptcha'
+const implicitRender = () => {
+    // Get elements with class 'procaptcha'
+    const elements: Element[] = Array.from(document.getElementsByClassName('procaptcha'))
+    // Set siteKey from renderOptions or from the first element's data-sitekey attribute
+    if (elements.length) {
+        const siteKey = at(elements, 0).getAttribute('data-sitekey') || undefined
+        const config = getConfig(siteKey)
+        renderLogic(elements, config)
+    }
+}
+// Explicit render for targeting specific elements
+export const render = (elementId: string, renderOptions: ProcaptchaRenderOptions) => {
+    const siteKey = renderOptions.siteKey
+    const config = getConfig(siteKey)
+    const element = document.getElementById(elementId)
+    if (!element) {
+        console.error('Element not found:', elementId)
+        return
+    }
+    renderLogic([element], config, renderOptions)
+}
+export default function ready(fn: () => void) {
+    if (document && document.readyState !== 'loading') {
+        console.log('document.readyState ready!')
+        fn()
+    } else {
+        console.log('DOMContentLoaded listener!')
+        document.addEventListener('DOMContentLoaded', fn)
+    }
+}
+// onLoadUrlCallback defines the name of the callback function to be called when the script is loaded
+// onRenderExplicit takes values of either explicit or implicit
+const { onloadUrlCallback, renderExplicit } = extractParams(BUNDLE_NAME)
+// Render the Procaptcha component implicitly if renderExplicit is not set to explicit
+if (renderExplicit !== 'explicit') {
+    ready(implicitRender)
+}
+if (onloadUrlCallback) {
+    const onloadCallback = getWindowCallback(onloadUrlCallback)
+    // Add event listener to the script tag to call the callback function when the script is loaded
+    getCurrentScript()?.addEventListener('load', () => {
+        ready(onloadCallback)
+    })
+}

package/tsconfig.cjs.json ADDED Viewed

@@ -0,0 +1,23 @@
+{
+    "extends": "../../tsconfig.cjs.json",
+    "compilerOptions": {
+        "rootDir": "./src",
+        "outDir": "./dist/cjs",
+        "lib": ["es6", "dom"]
+    },
+    "include": ["src/index.tsx", "src/index.html"],
+    "references": [
+        {
+            "path": "../../dev/config"
+        },
+        {
+            "path": "../procaptcha/tsconfig.cjs.json"
+        },
+        {
+            "path": "../procaptcha-react/tsconfig.cjs.json"
+        },
+        {
+            "path": "../util/tsconfig.cjs.json"
+        }
+    ]
+}

package/tsconfig.json ADDED Viewed

@@ -0,0 +1,23 @@
+{
+    "extends": "../../tsconfig.esm.json",
+    "compilerOptions": {
+        "rootDir": "./src",
+        "outDir": "./dist",
+        "lib": ["es6", "dom"]
+    },
+    "include": ["src", "src/**/*.json", "src/index.html"],
+    "references": [
+        {
+            "path": "../../dev/config"
+        },
+        {
+            "path": "../procaptcha"
+        },
+        {
+            "path": "../procaptcha-react"
+        },
+        {
+            "path": "../util"
+        }
+    ]
+}