@qore-id/web-sdk 1.0.0

package/README.md

@@ -0,0 +1,54 @@
+# QoreID Web SDK
+
+A clean, event-driven JavaScript SDK wrapper for integrating QoreID identity verification into your web applications.
+
+## Installation
+
+```bash
+npm install @qore-id/web-sdk
+```
+
+## Quick Start
+
+```javascript
+import QoreID from '@qore-id/web-sdk';
+
+
+// Listen for events
+QoreID.on('success', (data) => {
+  console.log('Verification successful:', data);
+});
+
+QoreID.on('error', (error) => {
+  console.error('Verification error:', error);
+});
+
+QoreID.on('close', (data) => {
+  console.error('Verification modal closed:', data);
+});
+
+QoreID.on('loading', (isLoading) => {
+  console.log('Loading:', isLoading);
+});
+
+// Start verification flow
+await QoreID.start({
+  clientId: 'your-client-id',
+  product: 'your-product',
+  customerReference: 'unique-reference',
+  applicantData: {
+    firstname: 'John',
+    lastname: 'Doe',
+    email: 'john@example.com',
+  },
+});
+```
+
+## Full Documentation
+
+For complete documentation, examples, and API reference, visit:
+[https://docs.qoreid.com/docs/qoreid-web-sdk]()
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,60 @@
+//#region src/index.d.ts
+type QoreidEvent = "success" | "error" | "close" | "loading";
+type QoreidEventPayloads = {
+  success: Record<string, any>;
+  error: any;
+  close: Record<string, any>;
+  loading: boolean;
+};
+type Handler<T extends QoreidEvent> = (payload: QoreidEventPayloads[T]) => void;
+interface InitConfig {
+  containerId?: string;
+  environment?: "sandbox" | "production";
+  scriptUrl?: string;
+}
+interface ApplicantData {
+  firstname: string;
+  middlename?: string;
+  lastname: string;
+  gender?: string;
+  /**YYYY-MM-DD */
+  dob?: string;
+  phone?: string;
+  email?: string;
+}
+interface IdentityData {
+  idType: string;
+  idNumber: string;
+}
+interface AddressData {
+  address: string;
+  city: string;
+  lgaName: string;
+}
+interface StartConfig {
+  clientId: string;
+  product: string;
+  customerReference: string;
+  flowId?: number;
+  applicantData: ApplicantData;
+  identityData?: IdentityData;
+  addressData?: AddressData;
+}
+declare class QoreidSDK {
+  private listeners;
+  private container;
+  private loadPromise;
+  private currentElement;
+  constructor();
+  init(config?: InitConfig): Promise<void>;
+  on<T extends QoreidEvent>(event: T, handler: Handler<T>): void;
+  off<T extends QoreidEvent>(event: T, handler: Handler<T>): void;
+  once<T extends QoreidEvent>(event: T, handler: Handler<T>): void;
+  removeAllListeners(event?: QoreidEvent): void;
+  private emit;
+  start(config: StartConfig): Promise<void>;
+}
+declare const QoreID: QoreidSDK;
+//#endregion
+export { QoreID as default };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/index.ts"],"mappings":";KAAK,WAAA;AAAA,KAEA,mBAAA;EACH,OAAA,EAAS,MAAA;EACT,KAAA;EACA,KAAA,EAAO,MAAA;EACP,OAAA;AAAA;AAAA,KAIG,OAAA,WAAkB,WAAA,KACrB,OAAA,EAAS,mBAAA,CAAoB,CAAA;AAAA,UAGrB,UAAA;EACR,WAAA;EACA,WAAA;EACA,SAAA;AAAA;AAAA,UAGQ,aAAA;EACR,SAAA;EACA,UAAA;EACA,QAAA;EACA,MAAA;EAdG;EAgBH,GAAA;EACA,KAAA;EACA,KAAA;AAAA;AAAA,UAGQ,YAAA;EACR,MAAA;EACA,QAAA;AAAA;AAAA,UAGQ,WAAA;EACR,OAAA;EACA,IAAA;EACA,OAAA;AAAA;AAAA,UAGQ,WAAA;EACR,QAAA;EACA,OAAA;EACA,iBAAA;EACA,MAAA;EACA,aAAA,EAAe,aAAA;EACf,YAAA,GAAe,YAAA;EACf,WAAA,GAAc,WAAA;AAAA;AAAA,cAGV,SAAA;EAAA,QACI,SAAA;EAAA,QACA,SAAA;EAAA,QACA,WAAA;EAAA,QACA,cAAA;;EAUR,IAAA,CAAK,MAAA,GAAS,UAAA,GAAU,OAAA;EA0CxB,EAAA,WAAa,WAAA,CAAA,CAAa,KAAA,EAAO,CAAA,EAAG,OAAA,EAAS,OAAA,CAAQ,CAAA;EAIrD,GAAA,WAAc,WAAA,CAAA,CAAa,KAAA,EAAO,CAAA,EAAG,OAAA,EAAS,OAAA,CAAQ,CAAA;EAItD,IAAA,WAAe,WAAA,CAAA,CAAa,KAAA,EAAO,CAAA,EAAG,OAAA,EAAS,OAAA,CAAQ,CAAA;EAQvD,kBAAA,CAAmB,KAAA,GAAQ,WAAA;EAAA,QAQnB,IAAA;EAUF,KAAA,CAAM,MAAA,EAAQ,WAAA,GAAW,OAAA;AAAA;AAAA,cAwE3B,MAAA,EAAM,SAAA"}

package/dist/index.js

@@ -0,0 +1,2 @@
+const e=new class{constructor(){this.listeners=new Map,this.loadPromise=null,this.currentElement=null,[`success`,`error`,`close`,`loading`].forEach(e=>{this.listeners.set(e,new Set)})}init(e){if(this.loadPromise)return this.loadPromise;let t=e?.scriptUrl||`https://dashboard.qoreid.com/qoreid-sdk/qoreid.js`;return this.loadPromise=new Promise((n,r)=>{if(e?.containerId){let t=document.getElementById(e.containerId);if(!t)throw Error(`Container not found`);this.container=t}else this.container=document.createElement(`div`),this.container.id=`qoreid-sdk-root`,document.body.appendChild(this.container);if(window.QoreIDWebSdk){n();return}let i=document.createElement(`script`);i.src=t,i.async=!0,i.onload=()=>{n()},i.onerror=r,document.body.appendChild(i)}),this.loadPromise}on(e,t){this.listeners.get(e)?.add(t)}off(e,t){this.listeners.get(e)?.delete(t)}once(e,t){let n=r=>{t(r),this.off(e,n)};this.on(e,n)}removeAllListeners(e){e?this.listeners.get(e)?.clear():this.listeners.forEach(e=>e.clear())}emit(e,t){this.listeners.get(e)?.forEach(e=>e(t))}async start(e){this.emit(`loading`,!0),await this.init(),this.currentElement&&=(this.currentElement.remove(),null);let t=document.createElement(`qoreid-button`);t.id=`QoreIDButton`,t.setAttribute(`clientId`,e.clientId),t.setAttribute(`productCode`,e.product),t.setAttribute(`customerReference`,e.customerReference),t.setAttribute(`hideButton`,`yes`),Object.entries(e).forEach(([e,n])=>{if(![`clientId`,`product`,`customerReference`].includes(e)&&n!==void 0){let r=[`string`,`number`].includes(typeof n)?String(n):JSON.stringify(n);t.setAttribute(e,r)}}),t.addEventListener(`qoreid:verificationSubmitted`,e=>{this.emit(`success`,e.detail)}),t.addEventListener(`qoreid:verificationError`,e=>{this.emit(`error`,e.detail)}),t.addEventListener(`qoreid:verificationClosed`,e=>{this.emit(`close`,e.detail)}),this.container.appendChild(t),this.currentElement=t;try{window.QoreIdRegenerateSDK?.(),window.QoreIDWebSdk?.start();let e=()=>{document.querySelector(`.sdkPopup`)?this.emit(`loading`,!1):setTimeout(e,1e3)};setTimeout(e,1e3)}catch(e){this.emit(`error`,e)}}};export{e as default};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["type QoreidEvent = \"success\" | \"error\" | \"close\" | \"loading\";\n\ntype QoreidEventPayloads = {\n  success: Record<string, any>;\n  error: any;\n  close: Record<string, any>;\n  loading: boolean;\n};\n\n// if the event is loading payload is boolean, otherwise it's the detail object\ntype Handler<T extends QoreidEvent> = (\n  payload: QoreidEventPayloads[T],\n) => void;\n\ninterface InitConfig {\n  containerId?: string;\n  environment?: \"sandbox\" | \"production\";\n  scriptUrl?: string;\n}\n\ninterface ApplicantData {\n  firstname: string;\n  middlename?: string;\n  lastname: string;\n  gender?: string;\n  /**YYYY-MM-DD */\n  dob?: string;\n  phone?: string;\n  email?: string;\n}\n\ninterface IdentityData {\n  idType: string;\n  idNumber: string;\n}\n\ninterface AddressData {\n  address: string;\n  city: string;\n  lgaName: string;\n}\n\ninterface StartConfig {\n  clientId: string;\n  product: string;\n  customerReference: string;\n  flowId?: number;\n  applicantData: ApplicantData;\n  identityData?: IdentityData;\n  addressData?: AddressData;\n}\n\nclass QoreidSDK {\n  private listeners = new Map<QoreidEvent, Set<Handler<QoreidEvent>>>();\n  private container!: HTMLElement;\n  private loadPromise: Promise<void> | null = null;\n  private currentElement: HTMLElement | null = null;\n  constructor() {\n    [\"success\", \"error\", \"close\", \"loading\"].forEach((event) => {\n      this.listeners.set(event as QoreidEvent, new Set());\n    });\n  }\n\n  // -------------------\n  // Init\n  // -------------------\n  init(config?: InitConfig) {\n    if (this.loadPromise) return this.loadPromise;\n    const scriptUrl =\n      config?.scriptUrl || \"https://dashboard.qoreid.com/qoreid-sdk/qoreid.js\";\n\n    this.loadPromise = new Promise((resolve, reject) => {\n      // 1. Setup container\n      if (config?.containerId) {\n        const el = document.getElementById(config.containerId);\n        if (!el) throw new Error(\"Container not found\");\n        this.container = el;\n      } else {\n        this.container = document.createElement(\"div\");\n        this.container.id = \"qoreid-sdk-root\";\n        document.body.appendChild(this.container);\n      }\n\n      // 2. Load script once\n      if ((window as any).QoreIDWebSdk) {\n        resolve();\n        return;\n      }\n\n      const script = document.createElement(\"script\");\n      script.src = scriptUrl;\n      script.async = true;\n\n      script.onload = () => {\n        resolve();\n      };\n\n      script.onerror = reject;\n\n      document.body.appendChild(script);\n    });\n\n    return this.loadPromise;\n  }\n\n  // -------------------\n  // Events\n  // -------------------\n  on<T extends QoreidEvent>(event: T, handler: Handler<T>) {\n    this.listeners.get(event)?.add(handler as Handler<QoreidEvent>);\n  }\n\n  off<T extends QoreidEvent>(event: T, handler: Handler<T>) {\n    this.listeners.get(event)?.delete(handler as Handler<QoreidEvent>);\n  }\n\n  once<T extends QoreidEvent>(event: T, handler: Handler<T>) {\n    const onceHandler: Handler<T> = (payload) => {\n      handler(payload);\n      this.off(event, onceHandler);\n    };\n    this.on(event, onceHandler);\n  }\n\n  removeAllListeners(event?: QoreidEvent) {\n    if (event) {\n      this.listeners.get(event)?.clear();\n    } else {\n      this.listeners.forEach((set) => set.clear());\n    }\n  }\n\n  private emit<T extends QoreidEvent>(\n    event: T,\n    payload?: QoreidEventPayloads[T],\n  ) {\n    this.listeners.get(event)?.forEach((h) => h(payload));\n  }\n\n  // -------------------\n  // Start\n  // -------------------\n  async start(config: StartConfig) {\n    this.emit(\"loading\", true);\n    await this.init();\n\n    // Cleanup previous instance (important)\n    if (this.currentElement) {\n      this.currentElement.remove();\n      this.currentElement = null;\n    }\n\n    // 1. Create web component\n    const el = document.createElement(\"qoreid-button\");\n\n    // 2. Map config → attributes\n    el.id = \"QoreIDButton\";\n    el.setAttribute(\"clientId\", config.clientId);\n    el.setAttribute(\"productCode\", config.product);\n    el.setAttribute(\"customerReference\", config.customerReference);\n    el.setAttribute(\"hideButton\", \"yes\");\n\n    // Optional passthrough config\n    Object.entries(config).forEach(([key, value]) => {\n      if (\n        ![\"clientId\", \"product\", \"customerReference\"].includes(key) &&\n        value !== undefined\n      ) {\n        const transformedValue = [\"string\", \"number\"].includes(typeof value)\n          ? String(value)\n          : JSON.stringify(value);\n        el.setAttribute(key, transformedValue);\n      }\n    });\n\n    // 3. Bind DOM events → SDK events\n    el.addEventListener(\"qoreid:verificationSubmitted\", (e: any) => {\n      this.emit(\"success\", e.detail);\n    });\n\n    el.addEventListener(\"qoreid:verificationError\", (e: any) => {\n      this.emit(\"error\", e.detail);\n    });\n\n    el.addEventListener(\"qoreid:verificationClosed\", (e: any) => {\n      this.emit(\"close\", e.detail);\n    });\n\n    // 4. Mount element\n    this.container.appendChild(el);\n    this.currentElement = el;\n\n    // 5. Trigger SDK\n    try {\n      (window as any).QoreIdRegenerateSDK?.();\n      (window as any).QoreIDWebSdk?.start();\n\n      // check for element with class sdkPopup in embedded iframe\n      const checkPopup = () => {\n        const popup = document.querySelector(\".sdkPopup\") as HTMLElement | null;\n        if (popup) {\n          this.emit(\"loading\", false);\n        } else {\n          setTimeout(checkPopup, 1000);\n        }\n      };\n      setTimeout(checkPopup, 1000);\n    } catch (err) {\n      this.emit(\"error\", err);\n    }\n  }\n}\n\n// Singleton export\nconst QoreID = new QoreidSDK();\nexport default QoreID;\n"],"mappings":"AAsNA,MAAM,EAAS,IAlKf,KAAgB,CAKd,aAAc,gBAJM,IAAI,qBAEoB,yBACC,KAE3C,CAAC,UAAW,QAAS,QAAS,UAAU,CAAC,QAAS,GAAU,CAC1D,KAAK,UAAU,IAAI,EAAsB,IAAI,IAAM,EACnD,CAMJ,KAAK,EAAqB,CACxB,GAAI,KAAK,YAAa,OAAO,KAAK,YAClC,IAAM,EACJ,GAAQ,WAAa,oDAiCvB,MA/BA,MAAK,YAAc,IAAI,SAAS,EAAS,IAAW,CAElD,GAAI,GAAQ,YAAa,CACvB,IAAM,EAAK,SAAS,eAAe,EAAO,YAAY,CACtD,GAAI,CAAC,EAAI,MAAU,MAAM,sBAAsB,CAC/C,KAAK,UAAY,OAEjB,KAAK,UAAY,SAAS,cAAc,MAAM,CAC9C,KAAK,UAAU,GAAK,kBACpB,SAAS,KAAK,YAAY,KAAK,UAAU,CAI3C,GAAK,OAAe,aAAc,CAChC,GAAS,CACT,OAGF,IAAM,EAAS,SAAS,cAAc,SAAS,CAC/C,EAAO,IAAM,EACb,EAAO,MAAQ,GAEf,EAAO,WAAe,CACpB,GAAS,EAGX,EAAO,QAAU,EAEjB,SAAS,KAAK,YAAY,EAAO,EACjC,CAEK,KAAK,YAMd,GAA0B,EAAU,EAAqB,CACvD,KAAK,UAAU,IAAI,EAAM,EAAE,IAAI,EAAgC,CAGjE,IAA2B,EAAU,EAAqB,CACxD,KAAK,UAAU,IAAI,EAAM,EAAE,OAAO,EAAgC,CAGpE,KAA4B,EAAU,EAAqB,CACzD,IAAM,EAA2B,GAAY,CAC3C,EAAQ,EAAQ,CAChB,KAAK,IAAI,EAAO,EAAY,EAE9B,KAAK,GAAG,EAAO,EAAY,CAG7B,mBAAmB,EAAqB,CAClC,EACF,KAAK,UAAU,IAAI,EAAM,EAAE,OAAO,CAElC,KAAK,UAAU,QAAS,GAAQ,EAAI,OAAO,CAAC,CAIhD,KACE,EACA,EACA,CACA,KAAK,UAAU,IAAI,EAAM,EAAE,QAAS,GAAM,EAAE,EAAQ,CAAC,CAMvD,MAAM,MAAM,EAAqB,CAC/B,KAAK,KAAK,UAAW,GAAK,CAC1B,MAAM,KAAK,MAAM,CAGjB,AAEE,KAAK,kBADL,KAAK,eAAe,QAAQ,CACN,MAIxB,IAAM,EAAK,SAAS,cAAc,gBAAgB,CAGlD,EAAG,GAAK,eACR,EAAG,aAAa,WAAY,EAAO,SAAS,CAC5C,EAAG,aAAa,cAAe,EAAO,QAAQ,CAC9C,EAAG,aAAa,oBAAqB,EAAO,kBAAkB,CAC9D,EAAG,aAAa,aAAc,MAAM,CAGpC,OAAO,QAAQ,EAAO,CAAC,SAAS,CAAC,EAAK,KAAW,CAC/C,GACE,CAAC,CAAC,WAAY,UAAW,oBAAoB,CAAC,SAAS,EAAI,EAC3D,IAAU,IAAA,GACV,CACA,IAAM,EAAmB,CAAC,SAAU,SAAS,CAAC,SAAS,OAAO,EAAM,CAChE,OAAO,EAAM,CACb,KAAK,UAAU,EAAM,CACzB,EAAG,aAAa,EAAK,EAAiB,GAExC,CAGF,EAAG,iBAAiB,+BAAiC,GAAW,CAC9D,KAAK,KAAK,UAAW,EAAE,OAAO,EAC9B,CAEF,EAAG,iBAAiB,2BAA6B,GAAW,CAC1D,KAAK,KAAK,QAAS,EAAE,OAAO,EAC5B,CAEF,EAAG,iBAAiB,4BAA8B,GAAW,CAC3D,KAAK,KAAK,QAAS,EAAE,OAAO,EAC5B,CAGF,KAAK,UAAU,YAAY,EAAG,CAC9B,KAAK,eAAiB,EAGtB,GAAI,CACD,OAAe,uBAAuB,CACtC,OAAe,cAAc,OAAO,CAGrC,IAAM,MAAmB,CACT,SAAS,cAAc,YAAY,CAE/C,KAAK,KAAK,UAAW,GAAM,CAE3B,WAAW,EAAY,IAAK,EAGhC,WAAW,EAAY,IAAK,OACrB,EAAK,CACZ,KAAK,KAAK,QAAS,EAAI"}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@qore-id/web-sdk",
+  "version": "1.0.0",
+  "description": "QoreID Web SDK wrapper with clean event-driven API",
+  "homepage": "https://docs.qoreid.com/docs/qoreid-web-sdk",
+  "license": "MIT",
+  "type": "module",
+  "exports": {
+    ".": "./dist/index.js",
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "package.json"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown --watch",
+    "clean": "rm -rf dist",
+    "prepublish": "npm run build"
+  },
+  "devDependencies": {
+    "tsdown": "^0.21.3",
+    "typescript": "^5.9.3"
+  },
+  "keywords": [
+    "qoreid",
+    "kyc",
+    "identity",
+    "sdk",
+    "verification"
+  ],
+  "types": "./dist/index.d.ts"
+}