{"_id":"@azakawcompliance/azakaw-web-sdk","_rev":"6-75550571f6d8ef8978cef2ba88eeff94","name":"@azakawcompliance/azakaw-web-sdk","dist-tags":{"latest":"1.2.1"},"versions":{"1.0.0":{"name":"@azakawcompliance/azakaw-web-sdk","version":"1.0.0","author":{"name":"Azakaw"},"license":"ISC","_id":"@azakawcompliance/azakaw-web-sdk@1.0.0","maintainers":[{"name":"azakaw","email":"cristiano@azakaw.com"},{"name":"tareqazakaw","email":"tareq@azakaw.com"},{"name":"maaz-siddiqui-azakaw","email":"maaz.siddiqui@azakaw.com"}],"dist":{"shasum":"0284864cf2035cc0c09c654748cdaf43a769b45b","tarball":"https://registry.npmjs.org/@azakawcompliance/azakaw-web-sdk/-/azakaw-web-sdk-1.0.0.tgz","fileCount":4,"integrity":"sha512-p8P9iR3aUbs9rqjBmAxq0RySrKRfjnQVfBY/7EU99L9OdCDCNFjAX0hOnO5t4CWnA9hEjG2pTj+2QvaYMoc1TQ==","signatures":[{"sig":"MEQCIDTIdUIfR4d9U1Ek7nvsibUTADtcFSPkYVcbInffONW9AiBoh6dWKj6AVHD0SVRzDUUhR8jNaRvX9zV+mLStLEtMBA==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":155352},"main":"./dist/main.js","type":"module","types":"./dist/index.d.ts","module":"./dist/main.js","exports":{"types":"./dist/index.d.ts","import":"./dist/main.js"},"gitHead":"58081b9ea946ddf79c362df3e14d7a29223c6b32","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"_npmUser":{"name":"maaz-siddiqui-azakaw","email":"maaz.siddiqui@azakaw.com"},"_npmVersion":"8.19.2","description":"Azakaw web sdk includes the web components required for customer onboarding.","directories":{},"_nodeVersion":"18.12.0","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/azakaw-web-sdk_1.0.0_1738072785355_0.6645927391357684","host":"s3://npm-registry-packages-npm-production"}},"1.0.1":{"name":"@azakawcompliance/azakaw-web-sdk","version":"1.0.1","author":{"name":"Azakaw"},"license":"ISC","_id":"@azakawcompliance/azakaw-web-sdk@1.0.1","maintainers":[{"name":"azakaw","email":"cristiano@azakaw.com"},{"name":"tareqazakaw","email":"tareq@azakaw.com"},{"name":"maaz-siddiqui-azakaw","email":"maaz.siddiqui@azakaw.com"}],"dist":{"shasum":"1d2ab231dd5b7957e06d0cd6310de0ae1057167f","tarball":"https://registry.npmjs.org/@azakawcompliance/azakaw-web-sdk/-/azakaw-web-sdk-1.0.1.tgz","fileCount":4,"integrity":"sha512-KkhrdjVowsioFNvINXAduNIitdX8oSWDkZQ7kujP6GwKwNOjPDzFHOCT650DpifvJ1ZmGhe/5FZjQOkCp312wA==","signatures":[{"sig":"MEUCICrXJtuZTSQg6oeAvTiOqmUpE8js3Jssg36O+EJOufvpAiEA22jR+YKxN6VwmOtjIjaEv/r22WAzUkyl7dglfxQ2OA8=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":155336},"main":"./dist/main.js","type":"module","types":"./dist/index.d.ts","module":"./dist/main.js","exports":{"types":"./dist/index.d.ts","import":"./dist/main.js"},"gitHead":"d9b5f3007dd067c79dda0de4c70b1943e14e487b","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"_npmUser":{"name":"maaz-siddiqui-azakaw","email":"maaz.siddiqui@azakaw.com"},"_npmVersion":"8.19.2","description":"Azakaw web sdk includes the web components required for customer onboarding.","directories":{},"_nodeVersion":"18.12.0","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/azakaw-web-sdk_1.0.1_1739882875533_0.2565795435709901","host":"s3://npm-registry-packages-npm-production"}},"1.0.2":{"name":"@azakawcompliance/azakaw-web-sdk","version":"1.0.2","author":{"name":"Azakaw"},"license":"ISC","_id":"@azakawcompliance/azakaw-web-sdk@1.0.2","maintainers":[{"name":"azakaw","email":"cristiano@azakaw.com"},{"name":"tareqazakaw","email":"tareq@azakaw.com"},{"name":"maaz-siddiqui-azakaw","email":"maaz.siddiqui@azakaw.com"}],"dist":{"shasum":"2dbcbfc62977d7f1a317678ec10ae6719e910717","tarball":"https://registry.npmjs.org/@azakawcompliance/azakaw-web-sdk/-/azakaw-web-sdk-1.0.2.tgz","fileCount":4,"integrity":"sha512-H2FseO+7/9doR06N3tWUNmGDcD6A9N70bAbQDa+V7BmchFKZoHBwmv5Ts0QBWDbCuyuq1dv5jpU19VF0/N02EQ==","signatures":[{"sig":"MEYCIQDLCLWwAlOTLz3AiJr4SZwvZY8y00yG4W5u0rCBd5RNmAIhAM0MfFUWK/PYdm8aRgtfTJOmKLwZ9lqYFxHmu0//jJNv","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":311641},"main":"./dist/main.js","type":"module","types":"./dist/index.d.ts","module":"./dist/main.js","exports":{"types":"./dist/index.d.ts","import":"./dist/main.js"},"gitHead":"ec24c9c1a62343e741c010f0b3a77d7cc5c20f34","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"_npmUser":{"name":"maaz-siddiqui-azakaw","email":"maaz.siddiqui@azakaw.com"},"_npmVersion":"8.19.2","description":"Azakaw web sdk includes the web components required for customer onboarding.","directories":{},"_nodeVersion":"18.12.0","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/azakaw-web-sdk_1.0.2_1740140896646_0.37576834048957286","host":"s3://npm-registry-packages-npm-production"}},"1.1.0":{"name":"@azakawcompliance/azakaw-web-sdk","version":"1.1.0","author":{"name":"Azakaw"},"license":"ISC","_id":"@azakawcompliance/azakaw-web-sdk@1.1.0","maintainers":[{"name":"azakaw","email":"cristiano@azakaw.com"},{"name":"tareqazakaw","email":"tareq@azakaw.com"},{"name":"maaz-siddiqui-azakaw","email":"maaz.siddiqui@azakaw.com"}],"dist":{"shasum":"052d15990063a072943362130ae2155fd66e1e84","tarball":"https://registry.npmjs.org/@azakawcompliance/azakaw-web-sdk/-/azakaw-web-sdk-1.1.0.tgz","fileCount":5,"integrity":"sha512-rIg/Bw8kEk9fHsaWoof49A5No1G2Ek+qr6eh0u1SggqfIDIG8wbg1+W/W/sjwf+JNHGgjHp3oWtVBhBvXWOl0w==","signatures":[{"sig":"MEYCIQCKW8GmXOO9/P1e3CkP18wJtUbN+tNaUTDAOhRQMJBR7wIhAOLYXXQ3d6OSqE6xuMfLyyKgfTc106VWpRA97zK1yPja","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":171425},"main":"./dist/main.js","type":"module","types":"./dist/index.d.ts","module":"./dist/main.js","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/main.js"},"./react":{"types":"./dist/react.d.ts"}},"gitHead":"06c65d19204e08643031e3fb307b855ac243158a","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"_npmUser":{"name":"maaz-siddiqui-azakaw","email":"maaz.siddiqui@azakaw.com"},"_npmVersion":"10.9.3","description":"Azakaw web sdk includes the web components required for customer onboarding.","directories":{},"_nodeVersion":"22.20.0","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/azakaw-web-sdk_1.1.0_1784811198156_0.42444097667241776","host":"s3://npm-registry-packages-npm-production"}},"1.1.1":{"name":"@azakawcompliance/azakaw-web-sdk","version":"1.1.1","author":{"name":"Azakaw"},"license":"ISC","_id":"@azakawcompliance/azakaw-web-sdk@1.1.1","maintainers":[{"name":"azakaw","email":"cristiano@azakaw.com"},{"name":"tareqazakaw","email":"tareq@azakaw.com"},{"name":"maaz-siddiqui-azakaw","email":"maaz.siddiqui@azakaw.com"}],"dist":{"shasum":"43ca2587e45dcc16e41ceff8b2eee479d4016b4e","tarball":"https://registry.npmjs.org/@azakawcompliance/azakaw-web-sdk/-/azakaw-web-sdk-1.1.1.tgz","fileCount":5,"integrity":"sha512-4OGJNLJ8gM+nwJh/twhijuChNmdsZrl1DgVtWmjeMxO2E5THipTl+0nIZytmhz4hX8TL0DOACibKD8QZ0J0oog==","signatures":[{"sig":"MEYCIQCSSLd1hnfsqNjuo3xXr2hR+7qiJ4+v/bgamjbh2vgFhQIhALCG9nMMQ4xts9dwJX4yX60teVKX8+AgeUP2nrOy8AR2","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":172291},"main":"./dist/main.js","type":"module","types":"./dist/index.d.ts","module":"./dist/main.js","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/main.js"},"./react":{"types":"./dist/react.d.ts"}},"gitHead":"7be6c152c892a3af3f25a61fc2464cbd943d3b64","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"_npmUser":{"name":"tareqazakaw","email":"tareq@azakaw.com"},"_npmVersion":"11.6.2","description":"Azakaw web sdk includes the web components required for customer onboarding.","directories":{},"_nodeVersion":"25.0.0","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/azakaw-web-sdk_1.1.1_1785507758813_0.11082962966658338","host":"s3://npm-registry-packages-npm-production"}},"1.2.1":{"_id":"@azakawcompliance/azakaw-web-sdk@1.2.1","dist":{"shasum":"a9980dbcd25a88132d55e26113ea78dcfac03d58","tarball":"https://registry.npmjs.org/@azakawcompliance/azakaw-web-sdk/-/azakaw-web-sdk-1.2.1.tgz","fileCount":5,"integrity":"sha512-O/VjTU32pdUMPkDSjWhY3bR0ZEZEiCpe6NNkJQWIW5I40PbT98Zp56zW93Se1cmdTG288cexKbrgobXMSWqPAQ==","signatures":[{"sig":"MEYCIQDvwUHsA2F17UWgAxL5M6RCvbwxpahNj4/ntnNTbwzFtAIhAKtgV24RzGT05qm8mAocZvGSlLtB84i7uBrCAW6gG0Mz","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"},{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQD5ilJ3KyvY/GOl8TC+qBaxv1w7mTvatYPYUpZjJi9PCwIgCtEFigYrYZ/EsGoWTNMbTo0VgS/vwQS4X273QbxVsFU="}],"unpackedSize":173054},"main":"./dist/main.js","name":"@azakawcompliance/azakaw-web-sdk","type":"module","types":"./dist/index.d.ts","author":{"name":"Azakaw"},"module":"./dist/main.js","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/main.js"},"./react":{"types":"./dist/react.d.ts"}},"gitHead":"b5512492a6bae014a17fc42f8098fb79f2061777","license":"ISC","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"version":"1.2.1","_npmUser":{"name":"tareqazakaw","email":"tareq@azakaw.com"},"_npmVersion":"11.6.2","description":"Azakaw web sdk includes the web components required for customer onboarding.","directories":{},"maintainers":[{"name":"azakaw","email":"cristiano@azakaw.com"},{"name":"tareqazakaw","email":"tareq@azakaw.com"},{"name":"maaz-siddiqui-azakaw","email":"maaz.siddiqui@azakaw.com"}],"_nodeVersion":"25.0.0","_hasShrinkwrap":false,"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/azakaw-web-sdk_1.2.1_1791202275812_0.6901597232540702"}}},"time":{"created":"2025-01-28T13:59:45.278Z","modified":"2026-10-05T12:11:16.097Z","1.0.0":"2025-01-28T13:59:45.557Z","1.0.1":"2025-02-18T12:47:55.737Z","1.0.2":"2025-02-21T12:28:16.866Z","1.1.0":"2026-07-23T12:53:18.291Z","1.1.1":"2026-07-31T14:22:38.954Z","1.2.1":"2026-10-05T12:11:15.918Z"},"author":{"name":"Azakaw"},"license":"ISC","description":"Azakaw web sdk includes the web components required for customer onboarding.","maintainers":[{"name":"azakaw","email":"cristiano@azakaw.com"},{"name":"tareqazakaw","email":"tareq@azakaw.com"},{"name":"maaz-siddiqui-azakaw","email":"maaz.siddiqui@azakaw.com"}],"readme":"# Table of contents\r\n\r\n- [Overview](#overview)\r\n- [Installation](#installation)\r\n- [Usage](#usage)\r\n- [API](#api)\r\n\r\n## Overview\r\n\r\nThe Azakaw web SDK allows you to add customer onboarding in your web application using web components. It provides you with a custom element that encapsulates the functionality of the customer onboarding.\r\n\r\n## Installation\r\n\r\n`npm install @azakawcompliance/azakaw-web-sdk`\r\n\r\n### Important Note\r\n\r\nThe web components are registered on the web page itself, so it is necessary that the library is imported on your website before using it in your code.\r\n\r\n## Usage\r\n\r\nImport @azakawcompliance/azakaw-web-sdk in your main javascript file.\r\n\r\n`import './node_modules/@azakawcompliance/azakaw-web-sdk/dist/main.js';`\r\n\r\nIn the HTML file you can then use the customer onboarding element, for example:\r\n\r\n```\r\n\r\n \r\n \r\n \r\n Document\r\n \r\n \r\n \r\n \r\n \r\n\r\n\r\n```\r\n\r\n### React\r\n\r\n#### Add the type declaration for JSX in the global.d.ts file\r\n\r\nAdd this single line to your `global.d.ts` file (or any `.d.ts` covered by your `tsconfig.json` `include`):\r\n\r\n```ts\r\n/// \r\n```\r\n\r\nThis registers `` on React's JSX types, so the element and all of its attributes — including the `SdkRegion` / `SdkEnvironment` enum values — are type-checked and autocompleted.\r\n\r\n#### Import the package and use the custom element inside your React component.\r\n\r\n```tsx\r\nimport { useEffect, useRef } from 'react';\r\nimport './App.css';\r\nimport '@azakawcompliance/azakaw-web-sdk';\r\nimport {\r\n CustomerOnboardingWebComponent,\r\n SdkEnvironment,\r\n SdkRegion,\r\n} from '@azakawcompliance/azakaw-web-sdk';\r\n\r\nfunction App() {\r\n const ref = useRef(null);\r\n\r\n useEffect(() => {\r\n if (!ref?.current) return;\r\n\r\n const azakawElemRef = ref?.current;\r\n\r\n const onOnboardingComplete = () => {\r\n console.log('Completed onboarding.');\r\n };\r\n\r\n azakawElemRef?.addEventListener(\r\n 'onboardingCompleted',\r\n onOnboardingComplete\r\n );\r\n\r\n return () => {\r\n azakawElemRef?.removeEventListener(\r\n 'onboardingCompleted',\r\n onOnboardingComplete\r\n );\r\n };\r\n }, []);\r\n\r\n return (\r\n <>\r\n
\r\n \r\n
\r\n \r\n );\r\n}\r\n\r\nexport default App;\r\n\r\n```\r\n\r\n### Angular\r\n\r\n#### Add CUSTOM_ELEMENTS_SCHEMA in the schemas property of AppModule\r\n\r\n```\r\nimport { CUSTOM_ELEMENTS_SCHEMA, NgModule } from '@angular/core';\r\nimport { BrowserModule } from '@angular/platform-browser';\r\n\r\nimport { AppRoutingModule } from './app-routing.module';\r\nimport { AppComponent } from './app.component';\r\n\r\n@NgModule({\r\n declarations: [AppComponent],\r\n imports: [BrowserModule, AppRoutingModule],\r\n providers: [],\r\n bootstrap: [AppComponent],\r\n schemas: [CUSTOM_ELEMENTS_SCHEMA],\r\n})\r\nexport class AppModule {}\r\n\r\n```\r\n\r\n#### Import the package and attach any event listeners to the customer onboarding web component\r\n\r\n```\r\nimport { Component, ElementRef, OnDestroy, ViewChild } from '@angular/core';\r\nimport '@azakawcompliance/azakaw-web-sdk';\r\nimport { CustomerOnboardingWebComponent } from '@azakawcompliance/azakaw-web-sdk';\r\n\r\n@Component({\r\n selector: 'app-root',\r\n templateUrl: './app.component.html',\r\n styleUrls: ['./app.component.scss'],\r\n})\r\nexport class AppComponent implements OnDestroy {\r\n @ViewChild('customerOnboardingElem')\r\n customerOnboardingElem!: ElementRef;\r\n\r\n ngAfterViewInit(): void {\r\n this.customerOnboardingElem?.nativeElement?.addEventListener(\r\n 'onboardingCompleted',\r\n this.onOnboardingCompleted\r\n );\r\n }\r\n\r\n ngOnDestroy(): void {\r\n this.customerOnboardingElem?.nativeElement?.removeEventListener(\r\n 'onboardingCompleted',\r\n this.onOnboardingCompleted\r\n );\r\n }\r\n\r\n private onOnboardingCompleted = () => {\r\n console.log('Completed onboarding');\r\n };\r\n}\r\n\r\n```\r\n\r\n#### Use the custom element in your template file\r\n\r\n```\r\n\r\n
\r\n \r\n
\r\n\r\n```\r\n\r\n## API\r\n\r\n### Inputs\r\n\r\n| Input | Type | Default | Required | Description |\r\n| ------------------------ | ------------------------- | --------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\r\n| session-id | `string` | `null` | yes | Session id against which the user onboarding will be performed. |\r\n| host-origin | `string` | `null` | yes | The url on which your web application is hosted. |\r\n| auto-resize | `boolean` | `false` | no | The Iframe height will resized dynamically based on the content that is shown inside it. |\r\n| hide-sidebar | `boolean` | `false` | no | It will hide the sidebar on the user onboarding page. |\r\n| hide-onboarding-sections | `boolean` | `false` | no | It will start the user onboarding from the first page of the form, user will only be allowed to see the onboarding sections page once the onboarding is completed. |\r\n| environment | `SdkEnvironment` (`Sandbox` \\| `Production`) | `Sandbox` | no | Target environment for the onboarding session. Case-sensitive; omit to use `Sandbox`. |\r\n| region | `SdkRegion` (`KSA` \\| `Kuwait` \\| `Qatar` \\| `UAE`) | `UAE` | no | Region in which the onboarding session is processed; selects the portal domain. Case-sensitive; omit to use `UAE`. |\r\n\r\n#### Region availability\r\n\r\n`region` selects the domain and `environment` selects the subdomain:\r\n\r\n| Region | Domain | Sandbox | Production |\r\n| --------------- | ----------------- | ------------------------- | --------------------- |\r\n| `UAE` (default) | `azakaw.com` | `sandbox.azakaw.com` | `app.azakaw.com` |\r\n| `KSA` | `azakawksa.com` | — not available | `app.azakawksa.com` |\r\n| `Qatar` | `azakawqatar.com` | — not available | `app.azakawqatar.com` |\r\n| `Kuwait` | `azakaw.com` | `kuwait-stg.azakaw.com` | `kuwait.azakaw.com` |\r\n\r\n> **Note**\r\n> Sandbox is available for `UAE` and `Kuwait`. `KSA` and `Qatar` are Production-only — pair them with `environment=\"Production\"`. There is no sandbox environment for those regions to test against yet.\r\n>\r\n> **`Kuwait` does not follow the `app` / `sandbox` naming.** It shares the `azakaw.com` domain with `UAE` and is separated by subdomain instead, so its hosts are `kuwait.azakaw.com` / `kuwait-stg.azakaw.com` (and `kuwait-api`, `kuwait-auth`, `kuwait-stg-api`, `kuwait-stg-auth`). Read the table rather than composing the host yourself.\r\n\r\n### Events\r\n\r\n| Event name | Returns | Description |\r\n| ------------------- | ------- | ----------------------------------------- |\r\n| onboardingCompleted | `void` | Fired when user completes the onboarding. |\r\n","readmeFilename":"README.md"}