@dtect/security-sdk-react 0.0.6 → 0.0.8

package/README.md

@@ -6,32 +6,22 @@ Security API SDK for React by dtect.
 <details>
   <summary>Table of Contents</summary>
   <ol>
-    <li>
-      <a href="#about-the-project">About The Project</a>
-    </li>
+
     <li>
       <a href="#getting-started">Getting Started</a>
       <ul>
-        <li><a href="#prerequisites">Prerequisites</a></li>
         <li><a href="#installation">Installation</a></li>
       </ul>
     </li>
-		<li>
+    <li>
       <a href="#implementation">Implementation</a>
     </li>
     <li><a href="#license">License</a></li>
     <li><a href="#contact">Contact</a></li>
+
   </ol>
 </details>
 
-<!-- ABOUT THE PROJECT -->
-
-## About The Project
-
-Security API SDK for React.
-
-<p align="right">(<a href="#readme-top">back to top</a>)</p>
-
 <!-- GETTING STARTED -->
 
 ## Getting Started
@@ -39,9 +29,9 @@ Security API SDK for React.
 The dtect Security API helps you gather valuable insights about your visitors, enhancing the quality of your survey data.
 This library is responsible for collecting data about the visitor's browser and behavior, send everything to our API and return a Security Result or a Security Token.
 
-### Prerequisites
+_Please refer to [our official documentation](https://docs.dtect.io) to read full documentation on security api_
 
-Get required Public Keys at [https://dtect.security.dashboard.com](https://dtect.security.dashboard.com)
+_**If you want to use our API, please [contact us](https://dtect.io/contact)**_
 
 ### Installation
 
@@ -63,10 +53,14 @@ yarn add @dtect/security-sdk-react
 
 ## Implementation
 
+_Read full documentation about implementation on [our official docs](https://docs.dtect.io/frontend/introduction)_
+
 ### 1. Wrap your application (or component) with `<SecurityAPIProvider>`.
 
-- Set `clientId` from your [dtect dashboard](https://dtect.security.dashboard.com/keys)
-- Set `apiKey` from your [dtect dashboard](https://dtect.security.dashboard.com/keys)
+- Set your public client id as `clientId`
+- Set your public api key as `apiKey`
+
+Read more about keys on our [official docs](https://docs.dtect.io/credentials)
 
 ```jsx
 // index.ts or app.tsx
@@ -143,6 +137,8 @@ export default Form;
 
 ## Errors
 
+_Read full documentation about errors on [our official docs](https://docs.dtect.io/errors)_
+
 Access the list of error enums from `SecurityAPIError`
 
 ### SecurityAPIProvider
@@ -155,6 +151,7 @@ You will see these errors on console
 | `INVALID_CREDENTIALS`      | Invalid Public Client ID or Public API Key      | Ensure you are using valid Public Client ID and Public API Key.                         |
 | `SDK_INIT_ERROR`           | Internal Server Error during SDK Initialization | An unexpected error occurred on our servers during SDK initialization.                  |
 | `DUPLICATE_INITIALIZATION` | Multiple SDK Initializations Detected           | You should initialize our package only once.                                            |
+| `MAINTENANCE_MODE`         | API Under Maintenance                           | The API is currently undergoing maintenance and will be available again shortly.        |
 
 ### getSecurityToken()/getSecurityResult()
 
@@ -164,6 +161,7 @@ You will see these errors on console
 | `INTERNAL_SERVER_ERROR`         | Internal Server Error during API Request | An unexpected error occurred on our servers during the API request. Check server logs for details. |
 | `FAILED_TO_GET_SECURITY_TOKEN`  | Failed to Generate Security Token        | An error occurred while generating the Security Token.                                             |
 | `FAILED_TO_GET_SECURITY_RESULT` | Failed to Retrieve Security Result       | An error occurred while retrieving the Security Result.                                            |
+| `MAINTENANCE_MODE`              | API Under Maintenance                    | The API is currently undergoing maintenance and will be available again shortly.                   |
 
 ```jsx
 // src/form.ts
@@ -208,13 +206,11 @@ function Form() {
 export default Form;
 ```
 
-_To see full documentation, please refer to the [Documentation](https://dtect.apidog.com)_
-
 <!-- LICENSE -->
 
-## License
+<!-- ## License
 
-<p align="right">(<a href="#readme-top">back to top</a>)</p>
+<p align="right">(<a href="#readme-top">back to top</a>)</p> -->
 
 <!-- CONTACT -->
 

package/dist/index.d.mts

@@ -18,6 +18,9 @@ interface ISecurityResultResponse {
         isDuplicateId: boolean;
         isLocationBlocked: boolean;
         isLocationInvalid: boolean;
+        isAutomationDetected: boolean;
+        isUntrustedBrowserOrOS: boolean;
+        isBlockedIP: boolean;
     };
 }
 interface ISecurityTokenResponse {
@@ -45,6 +48,7 @@ declare const SecurityAPIError: {
     NOT_INITIALIZED: string;
     INTERNAL_SERVER_ERROR: "Internal Server Error during API Request";
     MISSING_CREDENTIALS: "Missing Public Client ID or Public API Key";
+    MAINTENANCE_MODE: "API Under Maintenance";
 };
 
 export { SecurityAPIError, SecurityAPIProvider, useSecurityApi };

package/dist/index.d.ts

@@ -18,6 +18,9 @@ interface ISecurityResultResponse {
         isDuplicateId: boolean;
         isLocationBlocked: boolean;
         isLocationInvalid: boolean;
+        isAutomationDetected: boolean;
+        isUntrustedBrowserOrOS: boolean;
+        isBlockedIP: boolean;
     };
 }
 interface ISecurityTokenResponse {
@@ -45,6 +48,7 @@ declare const SecurityAPIError: {
     NOT_INITIALIZED: string;
     INTERNAL_SERVER_ERROR: "Internal Server Error during API Request";
     MISSING_CREDENTIALS: "Missing Public Client ID or Public API Key";
+    MAINTENANCE_MODE: "API Under Maintenance";
 };
 
 export { SecurityAPIError, SecurityAPIProvider, useSecurityApi };

package/dist/index.js

@@ -1,2 +1,2 @@
 "use client";
-"use strict";var k=Object.create;var u=Object.defineProperty;var D=Object.getOwnPropertyDescriptor;var N=Object.getOwnPropertyNames;var O=Object.getPrototypeOf,v=Object.prototype.hasOwnProperty;var L=(r,e)=>{for(var t in e)u(r,t,{get:e[t],enumerable:!0})},y=(r,e,t,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let o of N(e))!v.call(r,o)&&o!==t&&u(r,o,{get:()=>e[o],enumerable:!(n=D(e,o))||n.enumerable});return r};var a=(r,e,t)=>(t=r!=null?k(O(r)):{},y(e||!r||!r.__esModule?u(t,"default",{value:r,enumerable:!0}):t,r)),w=r=>y(u({},"__esModule",{value:!0}),r);var F={};L(F,{SecurityAPIError:()=>M,SecurityAPIProvider:()=>x,useSecurityApi:()=>U});module.exports=w(F);var I=require("react");var G={UNAUTHORIZED:"Unauthorized"},p={INTERNAL_SERVER_ERROR:"Internal Server Error during API Request",MISSING_CREDENTIALS:"Missing Public Client ID or Public API Key"},C={SDK_INIT_ERROR:"Internal Server Error during SDK Initialization",DUPLICATE_INITIALIZATION:"Multiple SDK Initializations Detected",NOT_INITIALIZED:"SDK Not Initialized"},R={INVALID_CREDENTIALS:"Invalid Public Client ID or Public API Key"},T={FAILED_TO_GET_SECURITY_RESULT:"Failed to Retrieve Security Result"},l={FAILED_TO_GET_SECURITY_TOKEN:"	Failed to Generate Security Token"},c={...G,...p,...C,...R,...T,...l},m={...p,...C,...R,...T,...l};var S=a(require("@dtect/security-sdk-js")),A=require("react/jsx-runtime"),f=(0,I.createContext)({}),P=({children:r})=>{let e=async({projectId:n,visitorId:o,securitySettings:s,metaData:E})=>{try{return await S.default.getSecurityResult({projectId:n,visitorId:o,securitySettings:s,metaData:E})}catch(i){throw i instanceof Error?new Error(i.message):new Error(c.FAILED_TO_GET_SECURITY_RESULT)}},t=async({projectId:n,visitorId:o,securitySettings:s,metaData:E})=>{try{return await S.default.getSecurityToken({projectId:n,visitorId:o,securitySettings:s,metaData:E})}catch(i){throw i instanceof Error?new Error(i.message):new Error(c.FAILED_TO_GET_SECURITY_TOKEN)}};return(0,A.jsx)(f.Provider,{value:{getSecurityResult:e,getSecurityToken:t},children:r})},h=()=>(0,I.useContext)(f);var _=require("react"),d=a(require("@dtect/security-sdk-js"));var g=require("react/jsx-runtime"),K=({clientId:r,apiKey:e,children:t,endpoint:n})=>{let o=async()=>{try{await d.default.init({apiKey:e,clientId:r,endpoint:n})}catch(s){if(s instanceof Error){console.error(s.message);return}console.error(c.SDK_INIT_ERROR)}};if((0,_.useEffect)(()=>{r&&e&&o()},[]),!r||!e)throw new Error(c.MISSING_CREDENTIALS);return(0,g.jsx)(P,{children:t})},x=K;var U=()=>{let{getSecurityResult:r,getSecurityToken:e}=h();return{getSecurityResult:r,getSecurityToken:e}},M=m;
+"use strict";var k=Object.create;var u=Object.defineProperty;var N=Object.getOwnPropertyDescriptor;var D=Object.getOwnPropertyNames;var O=Object.getPrototypeOf,v=Object.prototype.hasOwnProperty;var L=(r,e)=>{for(var t in e)u(r,t,{get:e[t],enumerable:!0})},a=(r,e,t,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let o of D(e))!v.call(r,o)&&o!==t&&u(r,o,{get:()=>e[o],enumerable:!(n=N(e,o))||n.enumerable});return r};var y=(r,e,t)=>(t=r!=null?k(O(r)):{},a(e||!r||!r.__esModule?u(t,"default",{value:r,enumerable:!0}):t,r)),w=r=>a(u({},"__esModule",{value:!0}),r);var F={};L(F,{SecurityAPIError:()=>K,SecurityAPIProvider:()=>x,useSecurityApi:()=>U});module.exports=w(F);var E=require("react");var M={UNAUTHORIZED:"Unauthorized"},p={INTERNAL_SERVER_ERROR:"Internal Server Error during API Request",MISSING_CREDENTIALS:"Missing Public Client ID or Public API Key",MAINTENANCE_MODE:"API Under Maintenance"},C={SDK_INIT_ERROR:"Internal Server Error during SDK Initialization",DUPLICATE_INITIALIZATION:"Multiple SDK Initializations Detected",NOT_INITIALIZED:"SDK Not Initialized"},T={INVALID_CREDENTIALS:"Invalid Public Client ID or Public API Key"},R={FAILED_TO_GET_SECURITY_RESULT:"Failed to Retrieve Security Result"},l={FAILED_TO_GET_SECURITY_TOKEN:"	Failed to Generate Security Token"},c={...M,...p,...C,...T,...R,...l},m={...p,...C,...T,...R,...l};var S=y(require("@dtect/security-sdk-js")),h=require("react/jsx-runtime"),f=(0,E.createContext)({}),P=({children:r})=>{let e=async({projectId:n,visitorId:o,securitySettings:s,metaData:I})=>{try{return await S.default.getSecurityResult({projectId:n,visitorId:o,securitySettings:s,metaData:I})}catch(i){throw i instanceof Error?new Error(i.message):new Error(c.FAILED_TO_GET_SECURITY_RESULT)}},t=async({projectId:n,visitorId:o,securitySettings:s,metaData:I})=>{try{return await S.default.getSecurityToken({projectId:n,visitorId:o,securitySettings:s,metaData:I})}catch(i){throw i instanceof Error?new Error(i.message):new Error(c.FAILED_TO_GET_SECURITY_TOKEN)}};return(0,h.jsx)(f.Provider,{value:{getSecurityResult:e,getSecurityToken:t},children:r})},A=()=>(0,E.useContext)(f);var _=require("react"),d=y(require("@dtect/security-sdk-js"));var g=require("react/jsx-runtime"),G=({clientId:r,apiKey:e,children:t,endpoint:n})=>{let o=async()=>{try{await d.default.init({apiKey:e,clientId:r,endpoint:n})}catch(s){if(s instanceof Error){console.error(s.message);return}console.error(c.SDK_INIT_ERROR)}};if((0,_.useEffect)(()=>{r&&e&&o()},[]),!r||!e)throw new Error(c.MISSING_CREDENTIALS);return(0,g.jsx)(P,{children:t})},x=G;var U=()=>{let{getSecurityResult:r,getSecurityToken:e}=A();return{getSecurityResult:r,getSecurityToken:e}},K=m;0&&(module.exports={SecurityAPIError,SecurityAPIProvider,useSecurityApi});

package/dist/index.mjs

@@ -1,2 +1,2 @@
 "use client";
-import{createContext as f,useContext as P}from"react";var m={UNAUTHORIZED:"Unauthorized"},I={INTERNAL_SERVER_ERROR:"Internal Server Error during API Request",MISSING_CREDENTIALS:"Missing Public Client ID or Public API Key"},E={SDK_INIT_ERROR:"Internal Server Error during SDK Initialization",DUPLICATE_INITIALIZATION:"Multiple SDK Initializations Detected",NOT_INITIALIZED:"SDK Not Initialized"},S={INVALID_CREDENTIALS:"Invalid Public Client ID or Public API Key"},y={FAILED_TO_GET_SECURITY_RESULT:"Failed to Retrieve Security Result"},a={FAILED_TO_GET_SECURITY_TOKEN:"	Failed to Generate Security Token"},n={...m,...I,...E,...S,...y,...a},p={...I,...E,...S,...y,...a};import C from"@dtect/security-sdk-js";import{jsx as h}from"react/jsx-runtime";var R=f({}),T=({children:r})=>{let e=async({projectId:i,visitorId:s,securitySettings:o,metaData:u})=>{try{return await C.getSecurityResult({projectId:i,visitorId:s,securitySettings:o,metaData:u})}catch(t){throw t instanceof Error?new Error(t.message):new Error(n.FAILED_TO_GET_SECURITY_RESULT)}},c=async({projectId:i,visitorId:s,securitySettings:o,metaData:u})=>{try{return await C.getSecurityToken({projectId:i,visitorId:s,securitySettings:o,metaData:u})}catch(t){throw t instanceof Error?new Error(t.message):new Error(n.FAILED_TO_GET_SECURITY_TOKEN)}};return h(R.Provider,{value:{getSecurityResult:e,getSecurityToken:c},children:r})},l=()=>P(R);import{useEffect as A}from"react";import _ from"@dtect/security-sdk-js";import{jsx as g}from"react/jsx-runtime";var d=({clientId:r,apiKey:e,children:c,endpoint:i})=>{let s=async()=>{try{await _.init({apiKey:e,clientId:r,endpoint:i})}catch(o){if(o instanceof Error){console.error(o.message);return}console.error(n.SDK_INIT_ERROR)}};if(A(()=>{r&&e&&s()},[]),!r||!e)throw new Error(n.MISSING_CREDENTIALS);return g(T,{children:c})},x=d;var er=()=>{let{getSecurityResult:r,getSecurityToken:e}=l();return{getSecurityResult:r,getSecurityToken:e}},tr=p;export{tr as SecurityAPIError,x as SecurityAPIProvider,er as useSecurityApi};
+import{createContext as f,useContext as P}from"react";var m={UNAUTHORIZED:"Unauthorized"},E={INTERNAL_SERVER_ERROR:"Internal Server Error during API Request",MISSING_CREDENTIALS:"Missing Public Client ID or Public API Key",MAINTENANCE_MODE:"API Under Maintenance"},I={SDK_INIT_ERROR:"Internal Server Error during SDK Initialization",DUPLICATE_INITIALIZATION:"Multiple SDK Initializations Detected",NOT_INITIALIZED:"SDK Not Initialized"},S={INVALID_CREDENTIALS:"Invalid Public Client ID or Public API Key"},a={FAILED_TO_GET_SECURITY_RESULT:"Failed to Retrieve Security Result"},y={FAILED_TO_GET_SECURITY_TOKEN:"	Failed to Generate Security Token"},n={...m,...E,...I,...S,...a,...y},p={...E,...I,...S,...a,...y};import C from"@dtect/security-sdk-js";import{jsx as A}from"react/jsx-runtime";var T=f({}),R=({children:r})=>{let e=async({projectId:i,visitorId:s,securitySettings:o,metaData:u})=>{try{return await C.getSecurityResult({projectId:i,visitorId:s,securitySettings:o,metaData:u})}catch(t){throw t instanceof Error?new Error(t.message):new Error(n.FAILED_TO_GET_SECURITY_RESULT)}},c=async({projectId:i,visitorId:s,securitySettings:o,metaData:u})=>{try{return await C.getSecurityToken({projectId:i,visitorId:s,securitySettings:o,metaData:u})}catch(t){throw t instanceof Error?new Error(t.message):new Error(n.FAILED_TO_GET_SECURITY_TOKEN)}};return A(T.Provider,{value:{getSecurityResult:e,getSecurityToken:c},children:r})},l=()=>P(T);import{useEffect as h}from"react";import _ from"@dtect/security-sdk-js";import{jsx as g}from"react/jsx-runtime";var d=({clientId:r,apiKey:e,children:c,endpoint:i})=>{let s=async()=>{try{await _.init({apiKey:e,clientId:r,endpoint:i})}catch(o){if(o instanceof Error){console.error(o.message);return}console.error(n.SDK_INIT_ERROR)}};if(h(()=>{r&&e&&s()},[]),!r||!e)throw new Error(n.MISSING_CREDENTIALS);return g(R,{children:c})},x=d;var er=()=>{let{getSecurityResult:r,getSecurityToken:e}=l();return{getSecurityResult:r,getSecurityToken:e}},tr=p;export{tr as SecurityAPIError,x as SecurityAPIProvider,er as useSecurityApi};

package/package.json

@@ -1,15 +1,16 @@
 {
   "name": "@dtect/security-sdk-react",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
   "scripts": {
+    "dev": "tsup src/index.ts --format cjs,esm --dts --watch",
     "build": "tsup src/index.ts --dts",
     "ts:check": "tsc --noEmit"
   },
   "dependencies": {
-    "@dtect/security-sdk-js": "^0.0.6",
+    "@dtect/security-sdk-js": "^0.0.7",
     "@tanstack/react-query": "^5.64.1",
     "react": "^19.0.0",
     "react-dom": "^19.0.0"

package/src/types/error.ts

@@ -6,6 +6,7 @@ const InternalError = {
 const GeneralError = {
   INTERNAL_SERVER_ERROR: "Internal Server Error during API Request",
   MISSING_CREDENTIALS: "Missing Public Client ID or Public API Key",
+  MAINTENANCE_MODE: "API Under Maintenance",
 } as const;
 
 const InitError = {

package/src/types/response.ts

@@ -6,6 +6,9 @@ export interface ISecurityResultResponse {
     isDuplicateId: boolean;
     isLocationBlocked: boolean;
     isLocationInvalid: boolean;
+    isAutomationDetected: boolean;
+    isUntrustedBrowserOrOS: boolean;
+    isBlockedIP: boolean;
   }
 }
 

package/tsup.config.ts

@@ -14,6 +14,5 @@ export default defineConfig({
   },
   outDir: "dist",
   format: ["cjs", "esm"],
-  minifyIdentifiers: true,
-  platform: "browser"
+  minifyIdentifiers: true
 })

package/.turbo/turbo-build.log

@@ -1,20 +0,0 @@
-
-yarn run v1.22.22
-$ tsup src/index.ts --dts
-CLI Building entry: src/index.ts
-CLI Using tsconfig: tsconfig.json
-CLI tsup v8.3.5
-CLI Using tsup config: /Users/dajungha/Projects/security-sdk-react/packages/sdk-react/tsup.config.ts
-CLI Target: es2022
-CLI Cleaning output folder
-CJS Build start
-ESM Build start
-ESM dist/index.mjs 1.98 KB
-ESM ⚡️ Build success in 10ms
-CJS dist/index.js 2.59 KB
-CJS ⚡️ Build success in 11ms
-DTS Build start
-DTS ⚡️ Build success in 650ms
-DTS dist/index.d.ts  1.55 KB
-DTS dist/index.d.mts 1.55 KB
-✨  Done in 1.15s.