@dtect/security-sdk-react 0.0.1

package/.turbo/turbo-build.log

@@ -0,0 +1,20 @@
+
+yarn run v1.22.22
+$ tsup src/index.ts --format esm,cjs --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
+ESM Build start
+CJS Build start
+ESM dist/index.mjs 1.97 KB
+ESM ⚡️ Build success in 11ms
+CJS dist/index.js 2.65 KB
+CJS ⚡️ Build success in 11ms
+DTS Build start
+DTS ⚡️ Build success in 779ms
+DTS dist/index.d.mts 1.55 KB
+DTS dist/index.d.ts  1.55 KB
+✨  Done in 1.35s.

package/CHANGELOG.md

@@ -0,0 +1,5 @@
+# @dtect/security-sdk
+
+## 0.0.0
+
+### First release

package/README.md

@@ -0,0 +1,225 @@
+# Security SDK React
+
+Security API SDK for React by dtect.
+
+<!-- TABLE OF CONTENTS -->
+<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>
+      <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
+
+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
+
+Get required Public Keys at [https://dtect.security.dashboard.com](https://dtect.security.dashboard.com)
+
+### Installation
+
+Install package
+
+```sh
+npm install @dtect/security-sdk-react
+```
+
+or
+
+```sh
+yarn add @dtect/security-sdk-react
+```
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- USAGE EXAMPLES -->
+
+## Implementation
+
+### 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)
+
+```jsx
+// index.ts or app.tsx
+import React from "react";
+import { SecurityAPIProvider } from "@dtect/security-sdk-react";
+import App from "./App";
+import Form from "./src/form";
+
+function MyPage() {
+  return (
+    <SecurityAPIProvider
+      clientId={"your-public-client-id-from-dashboard"} // required
+      apiKey={"your-public-api-key-from-dashboard"} // required
+    >
+      <Form />
+    </SecurityAPIProvider>
+  );
+}
+```
+
+| Prop       | Type     | Description                    |
+| :--------- | :------- | :----------------------------- |
+| `clientId` | `string` | **Required**. public client id |
+| `apiKey`   | `string` | **Required**. public api key   |
+
+### 2. Use `useSecurityApi` hook inside your component to check for visitor data
+
+`useSecurityApi` has `getSecurityToken` and `getSecurityResult` functions to validate visitor.
+We recommend you to get `securityToken` from `getSecurityToken` then consult `securityResult`.
+
+```jsx
+// src/form.ts
+import React from "react";
+import { useSecurityApi } from "@dtect/security-sdk-react";
+import App from "./App";
+
+function Form() {
+  const { getSecurityToken } = useSecurityApi();
+
+  const handleSubmit = async () => {
+    const response = await getSecurityToken({
+      projectId: "your-project-id-for-deduplication", // required
+      visitorId: "your-visitor-id",
+      securitySettings: {
+        countriesAllowed: ["usa", "can"],
+      },
+    });
+
+    if (response?.securityToken) {
+      // send securityToken to your backend server then consult dtect's securityResult API to get result with security
+    }
+  };
+
+  return (
+    <form>
+      {/* ...some inputs */}
+      <button type="submit" onClick={handleSubmit}>
+        Submit
+      </button>
+    </form>
+  );
+}
+
+export default Form;
+```
+
+| Prop               | Type       | Description                                                                                                                             |
+| :----------------- | :--------- | :-------------------------------------------------------------------------------------------------------------------------------------- |
+| `projectId`        | `string`   | **Required**. A unique identifier for your project, study or survey. It allows our system to group visitor data and identify duplicates |
+| `visitorId`        | `string`   | Id to identify the visitor that is being evaluated                                                                                      |
+| `metaData`         | `object`   | Any additional information you want to add to each request                                                                              |
+| `securitySettings` | `object`   | Configures security settings. Includes `countriesAllowed`                                                                               |
+| `countriesAllowed` | `string[]` | List of countries allowed for your project, survey, or study.                                                                           |
+
+## Errors
+
+Access the list of error enums from `SecurityAPIError`
+
+### SecurityAPIProvider
+
+You will see these errors on console
+
+| Enum                       | Message                                         | Description                                                                             |
+| :------------------------- | :---------------------------------------------- | :-------------------------------------------------------------------------------------- |
+| `MISSING_CREDENTIALS`      | Missing Public Client ID or Public API Key      | Please provide valid Public Client ID and Public API Key when initializing our package. |
+| `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.                                            |
+
+### getSecurityToken()/getSecurityResult()
+
+| Error                           | Message                                  | Description                                                                                        |
+| :------------------------------ | :--------------------------------------- | :------------------------------------------------------------------------------------------------- |
+| `NOT_INITIALIZED`               | SDK Not Initialized                      | The SDK must be initialized before calling this function.                                          |
+| `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.                                            |
+
+```jsx
+// src/form.ts
+import React from "react";
+import { useSecurityApi, SecurityAPIError } from "@dtect/security-sdk-react";
+import App from "./App";
+
+function Form() {
+  const { getSecurityToken } = useSecurityApi();
+
+  const handleSubmit = async () => {
+    try {
+      const response = await getSecurityToken({
+        projectId: "your-project-id-for-deduplication", // required
+        visitorId: "your-visitor-id",
+        securitySettings: {
+          countriesAllowed: ["usa", "can"],
+        },
+      });
+
+      if (response?.securityToken) {
+        // send securityToken to your backend server then consult dtect's securityResult API to get result with security
+      }
+    } catch (error) {
+      switch (error.message) {
+        case SecurityAPIError.FAILED_TO_GET_SECURITY_TOKEN:
+        // log internally
+      }
+    }
+  };
+
+  return (
+    <form>
+      {/* ...some inputs */}
+      <button type="submit" onClick={handleSubmit}>
+        Submit
+      </button>
+    </form>
+  );
+}
+
+export default Form;
+```
+
+_To see full documentation, please refer to the [Documentation](https://dtect.apidog.com)_
+
+<!-- LICENSE -->
+
+## License
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- CONTACT -->
+
+## Contact
+
+dtect - [Contact us](https://dtect.io/contact) - support@dtect.io
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>

package/dist/index.d.mts

@@ -0,0 +1,50 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { PropsWithChildren } from 'react';
+
+interface ISecurityCheckInput {
+    projectId: string;
+    visitorId?: string;
+    securitySettings?: {
+        countriesAllowed?: string[];
+    };
+    metaData?: any;
+}
+
+interface ISecurityResultResponse {
+    results: {
+        dtectScore: string;
+        isDuplicateDevice: boolean;
+        isDuplicateIp: boolean;
+        isDuplicateId: boolean;
+        isLocationBlocked: boolean;
+        isLocationInvalid: boolean;
+    };
+}
+interface ISecurityTokenResponse {
+    token: string;
+}
+
+interface SecurityAPIProviderProps extends PropsWithChildren {
+    clientId: string;
+    apiKey: string;
+    endpoint?: string;
+}
+declare const SecurityAPIProvider: ({ clientId, apiKey, children, endpoint, }: SecurityAPIProviderProps) => react_jsx_runtime.JSX.Element;
+
+declare const useSecurityApi: () => {
+    getSecurityResult: (props: ISecurityCheckInput) => Promise<ISecurityResultResponse | Error>;
+    getSecurityToken: (props: ISecurityCheckInput) => Promise<ISecurityTokenResponse | Error>;
+};
+
+declare const SecurityAPIError: {
+    FAILED_TO_GET_SECURITY_TOKEN: string;
+    FAILED_TO_GET_SECURITY_RESULT: string;
+    INVALID_CREDENTIALS: "Invalid Public Client ID or Public API Key";
+    SDK_INIT_ERROR: string;
+    DUPLICATE_INITIALIZATION: string;
+    NOT_INITIALIZED: string;
+    INTERNAL_SERVER_ERROR: "Internal Server Error during API Request";
+    MISSING_CREDENTIALS: "Missing Public Client ID or Public API Key";
+};
+
+export { SecurityAPIError, SecurityAPIProvider, useSecurityApi };

package/dist/index.d.ts

@@ -0,0 +1,50 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { PropsWithChildren } from 'react';
+
+interface ISecurityCheckInput {
+    projectId: string;
+    visitorId?: string;
+    securitySettings?: {
+        countriesAllowed?: string[];
+    };
+    metaData?: any;
+}
+
+interface ISecurityResultResponse {
+    results: {
+        dtectScore: string;
+        isDuplicateDevice: boolean;
+        isDuplicateIp: boolean;
+        isDuplicateId: boolean;
+        isLocationBlocked: boolean;
+        isLocationInvalid: boolean;
+    };
+}
+interface ISecurityTokenResponse {
+    token: string;
+}
+
+interface SecurityAPIProviderProps extends PropsWithChildren {
+    clientId: string;
+    apiKey: string;
+    endpoint?: string;
+}
+declare const SecurityAPIProvider: ({ clientId, apiKey, children, endpoint, }: SecurityAPIProviderProps) => react_jsx_runtime.JSX.Element;
+
+declare const useSecurityApi: () => {
+    getSecurityResult: (props: ISecurityCheckInput) => Promise<ISecurityResultResponse | Error>;
+    getSecurityToken: (props: ISecurityCheckInput) => Promise<ISecurityTokenResponse | Error>;
+};
+
+declare const SecurityAPIError: {
+    FAILED_TO_GET_SECURITY_TOKEN: string;
+    FAILED_TO_GET_SECURITY_RESULT: string;
+    INVALID_CREDENTIALS: "Invalid Public Client ID or Public API Key";
+    SDK_INIT_ERROR: string;
+    DUPLICATE_INITIALIZATION: string;
+    NOT_INITIALIZED: string;
+    INTERNAL_SERVER_ERROR: "Internal Server Error during API Request";
+    MISSING_CREDENTIALS: "Missing Public Client ID or Public API Key";
+};
+
+export { SecurityAPIError, SecurityAPIProvider, useSecurityApi };

package/dist/index.js

@@ -0,0 +1,2 @@
+"use client";
+"use strict";var k=Object.create;var u=Object.defineProperty;var D=Object.getOwnPropertyDescriptor;var N=Object.getOwnPropertyNames;var w=Object.getPrototypeOf,O=Object.prototype.hasOwnProperty;var v=(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))!O.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(w(r)):{},y(e||!r||!r.__esModule?u(t,"default",{value:r,enumerable:!0}):t,r)),L=r=>y(u({},"__esModule",{value:!0}),r);var F={};v(F,{SecurityAPIError:()=>M,SecurityAPIProvider:()=>x,useSecurityApi:()=>U});module.exports=L(F);var E=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"},m={FAILED_TO_GET_SECURITY_TOKEN:"	Failed to Generate Security Token"},c={...G,...p,...C,...R,...T,...m},f={...p,...C,...R,...T,...m};var S=a(require("@dtect/security-sdk-js")),A=require("react/jsx-runtime"),l=(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,A.jsx)(l.Provider,{value:{getSecurityResult:e,getSecurityToken:t},children:r})},h=()=>(0,E.useContext)(l);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){throw s instanceof Error?new Error(s.message):new 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=f;0&&(module.exports={SecurityAPIError,SecurityAPIProvider,useSecurityApi});

package/dist/index.mjs

@@ -0,0 +1,2 @@
+"use client";
+import{createContext as l,useContext as P}from"react";var f={UNAUTHORIZED:"Unauthorized"},E={INTERNAL_SERVER_ERROR:"Internal Server Error during API Request",MISSING_CREDENTIALS:"Missing Public Client ID or Public API Key"},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"},y={FAILED_TO_GET_SECURITY_RESULT:"Failed to Retrieve Security Result"},a={FAILED_TO_GET_SECURITY_TOKEN:"	Failed to Generate Security Token"},n={...f,...E,...I,...S,...y,...a},p={...E,...I,...S,...y,...a};import C from"@dtect/security-sdk-js";import{jsx as h}from"react/jsx-runtime";var R=l({}),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})},m=()=>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){throw o instanceof Error?new Error(o.message):new 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}=m();return{getSecurityResult:r,getSecurityToken:e}},tr=p;export{tr as SecurityAPIError,x as SecurityAPIProvider,er as useSecurityApi};

package/eslint.config.js

@@ -0,0 +1,4 @@
+import { config } from "@repo/eslint-config/next";
+
+/** @type {import("eslint").Linter.Config} */
+export default config;

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@dtect/security-sdk-react",
+  "version": "0.0.1",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsup src/index.ts --format esm,cjs --dts",
+    "ts:check": "tsc --noEmit"
+  },
+  "dependencies": {
+    "@dtect/security-sdk-js": "*",
+    "@tanstack/react-query": "^5.64.1",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.17.0",
+    "@types/react": "^19.0.2",
+    "eslint": "^9.17.0",
+    "eslint-plugin-react-hooks": "^5.1.0",
+    "tsup": "^8.3.5",
+    "typescript": "^5.7.2",
+    "typescript-eslint": "^8.19.0"
+  },
+  "author": "dtect",
+  "license": "MIT",
+  "description": "",
+  "exports": {
+    ".": "./src/index.ts"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/context/index.tsx

@@ -0,0 +1 @@
+export * from "./securityCheckContext";

package/src/context/securityCheckContext.tsx

@@ -0,0 +1,76 @@
+import React, { createContext, useContext } from "react";
+import {
+  ErrorMessageEnum,
+  ISecurityCheckContext,
+  ISecurityCheckInput,
+  ISecurityResultResponse,
+  ISecurityTokenResponse,
+} from "../types";
+import dtect from "@dtect/security-sdk-js";
+
+const SecurityCheckContext = createContext<ISecurityCheckContext>(
+  {} as ISecurityCheckContext
+);
+
+export const SecurityCheckContextProvider = ({
+  children,
+}: React.PropsWithChildren) => {
+  const getSecurityResult = async ({
+    projectId,
+    visitorId,
+    securitySettings,
+    metaData,
+  }: ISecurityCheckInput): Promise<ISecurityResultResponse | Error> => {
+    try {
+      const response = await dtect.getSecurityResult({
+        projectId,
+        visitorId,
+        securitySettings,
+        metaData,
+      });
+
+      return response;
+    } catch (error) {
+      if (error instanceof Error) {
+        throw new Error(error.message);
+      }
+      throw new Error(ErrorMessageEnum.FAILED_TO_GET_SECURITY_RESULT);
+    }
+  };
+
+  const getSecurityToken = async ({
+    projectId,
+    visitorId,
+    securitySettings,
+    metaData,
+  }: ISecurityCheckInput): Promise<ISecurityTokenResponse | Error> => {
+    try {
+      const response = await dtect.getSecurityToken({
+        projectId,
+        visitorId,
+        securitySettings,
+        metaData,
+      });
+
+      return response;
+    } catch (error) {
+      if (error instanceof Error) {
+        throw new Error(error.message);
+      }
+      throw new Error(ErrorMessageEnum.FAILED_TO_GET_SECURITY_TOKEN);
+    }
+  };
+
+  return (
+    <SecurityCheckContext.Provider
+      value={{
+        getSecurityResult,
+        getSecurityToken,
+      }}
+    >
+      {children}
+    </SecurityCheckContext.Provider>
+  );
+};
+
+export const useSecurityCheckContext = () => useContext(SecurityCheckContext);

package/src/index.ts

@@ -0,0 +1,19 @@
+import React from "react";
+
+import { useSecurityCheckContext } from "./context";
+import { SecurityAPIErrorsEnum } from "./types"
+
+export const useSecurityApi = () => {
+  const { getSecurityResult, getSecurityToken } = useSecurityCheckContext();
+
+
+  return {
+    getSecurityResult,
+		getSecurityToken
+  };
+};
+
+export { default as SecurityAPIProvider } from "./provider";
+
+
+export const SecurityAPIError = SecurityAPIErrorsEnum

package/src/provider/index.tsx

@@ -0,0 +1,51 @@
+"use client";
+
+import {  useEffect, PropsWithChildren } from "react";
+import dtect from "@dtect/security-sdk-js";
+import { SecurityCheckContextProvider } from "../context";
+import { ErrorMessageEnum } from "../types";
+
+interface SecurityAPIProviderProps extends PropsWithChildren {
+  clientId: string;
+  apiKey: string;
+  endpoint?: string;
+}
+
+const SecurityAPIProvider = ({
+  clientId,
+  apiKey,
+  children,
+  endpoint,
+}: SecurityAPIProviderProps) => {
+
+  const getKeysHandler = async () => {
+    try {
+      await dtect.init({ apiKey, clientId, endpoint });
+
+    } catch (error) {
+      if (error instanceof Error) {
+        console.error(error.message);
+        return;
+      }
+
+      console.error(ErrorMessageEnum.SDK_INIT_ERROR)
+    }
+  };
+
+  useEffect(() => {
+    if (clientId && apiKey) {
+      getKeysHandler();
+    }
+  }, []);
+
+  if (!clientId || !apiKey) {
+    throw new Error(ErrorMessageEnum.MISSING_CREDENTIALS);
+  }
+
+
+  return (
+    <SecurityCheckContextProvider>{children}</SecurityCheckContextProvider>
+  );
+};
+
+export default SecurityAPIProvider;

package/src/types/context.ts

@@ -0,0 +1,19 @@
+import {  ISecurityCheckInput, ISecurityResultResponse, ISecurityTokenResponse } from ".";
+
+export interface ISecurityCheckContext {
+  getSecurityResult: (
+    props: ISecurityCheckInput
+  ) => Promise<ISecurityResultResponse | Error>;
+  getSecurityToken: (
+    props: ISecurityCheckInput
+  ) => Promise<ISecurityTokenResponse | Error>;
+}
+
+
+export interface ISecurityAppContext {
+	isReady: boolean;
+	isHcaptchaReady: boolean;
+	isKeysReady: boolean;
+	setIsHcaptchaReady: (isHcaptchaReady: boolean) => void;
+	setIsKeysReady:(isKeysReady: boolean) => void;
+}

package/src/types/error.ts

@@ -0,0 +1,51 @@
+
+const InternalError = {
+  UNAUTHORIZED: "Unauthorized",
+}
+
+const GeneralError = {
+  INTERNAL_SERVER_ERROR: "Internal Server Error during API Request",
+  MISSING_CREDENTIALS: "Missing Public Client ID or Public API Key",
+} as const;
+
+const InitError = {
+  SDK_INIT_ERROR: "Internal Server Error during SDK Initialization",
+  DUPLICATE_INITIALIZATION:
+    "Multiple SDK Initializations Detected",
+  NOT_INITIALIZED: "SDK Not Initialized"
+}
+
+const GetKeysError = {
+  INVALID_CREDENTIALS: "Invalid Public Client ID or Public API Key",
+} as const;
+
+const GetSecurityResultError = {
+  FAILED_TO_GET_SECURITY_RESULT: "Failed to Retrieve Security Result",
+};
+
+const GetSecurityTokenError = {
+  FAILED_TO_GET_SECURITY_TOKEN: "	Failed to Generate Security Token",
+};
+
+export const ErrorMessageEnum = {
+  ...InternalError,
+  ...GeneralError,
+  ...InitError,
+  ...GetKeysError,
+  ...GetSecurityResultError,
+  ...GetSecurityTokenError,
+} as const;
+
+export const SecurityAPIErrorsEnum = {
+  ...GeneralError,
+  ...InitError,
+  ...GetKeysError,
+  ...GetSecurityResultError,
+  ...GetSecurityTokenError,
+}
+
+type ValueOf<T> = T[keyof T];
+
+export type IErrorMessage = ValueOf<typeof ErrorMessageEnum>;
+
+export type SecurityAPIErrors = ValueOf<typeof SecurityAPIErrorsEnum>

package/src/types/index.ts

@@ -0,0 +1,4 @@
+export * from "./context";
+export * from "./error";
+export * from "./input";
+export * from "./response"

package/src/types/input.ts

@@ -0,0 +1,19 @@
+export interface ISecurityCheckInput {
+  projectId: string;
+  visitorId?: string;
+  securitySettings?: {
+    countriesAllowed?: string[];
+  };
+  metaData?: any;
+}
+
+export interface ISecurityCheckVisitorDataInput {
+  visitorData: {
+    behaviorToken: string;
+    automationToken: string;
+    behaviorRequestId: string;
+    browserLocale: string;
+    entryLink: string;
+  };
+}
+

package/src/types/response.ts

@@ -0,0 +1,20 @@
+export interface ISecurityResultResponse {
+  results: {
+    dtectScore: string;
+    isDuplicateDevice: boolean;
+    isDuplicateIp: boolean;
+    isDuplicateId: boolean;
+    isLocationBlocked: boolean;
+    isLocationInvalid: boolean;
+  }
+}
+
+export interface ISecurityTokenResponse {
+  token: string;
+}
+
+export interface IGetKeysResponse {
+	behaviorKey: string;
+	automationKey: string;
+}
+

package/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "target": "es6",
+    "lib": ["dom", "dom.iterable", "esnext"],
+    "jsx": "react-jsx",
+    "module": "esnext",
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "allowJs": true,
+    "noEmit": true,
+    "isolatedModules": true,
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "skipLibCheck": true
+  },
+  "include": ["src"],
+  "exclude": ["node_modules"]
+}

package/tsup.config.ts

@@ -0,0 +1,18 @@
+import { defineConfig } from 'tsup'
+
+export default defineConfig({
+  entry: ["src/index.ts", "src/**/*.ts", "src/**/*.tsx"],
+  target: "es2022",
+  external: ["react", "react-dom", "react/jsx-runtime"],
+  sourcemap: false,
+  clean: true,
+	minify: true,
+	dts: true,
+	tsconfig: "tsconfig.json",
+  banner: {
+    js:  `"use client";`
+  },
+  outDir: "dist",
+  format: ["cjs", "esm"],
+  minifyIdentifiers: true
+})