@basiq/connect-auth 1.0.13 → 1.1.1

package/README.md

@@ -1,60 +1,66 @@
-# BASIQ CONNECT COMPONENT
+# Basiq Connect Component
 
 The Basiq Connect Auth is a ReactJS UI component exposed to partners who prefer to implement the auth flow as an external component with an SMS OTP built in. When rendered, it will take the user through an SMS OTP flow and then proceed to redirect them to the [Basiq Consent UI](https://api.basiq.io/docs/consent-ui) flow to connect their accounts.
 
-Note: This has been offered as interim solution for partners who require access to v3 of the API before we have released the upgrades to `https://connect.basiq.io/`. If you have any questions regarding this please reach out to support@basiq.io. 
+**Note**: This has been offered as an interim solution for partners who require access to v3 of the API before we have released the upgrades to `https://connect.basiq.io/`. If you have any questions regarding this, please reach out to support@basiq.io.
 
 ## Setup
 
 1. Install `@basiq/connect-auth` and import the component
 
-```
-$ npm install @basiq/basiq-connect-control
-```
+    ```bash
+    $ npm install @basiq/connect-auth
+    ```
 
-```js
-import { BasiqConnect } from "@basiq/connect-auth";
-```
+    ```js
+    import { BasiqConnect } from "@basiq/connect-auth";
+    ```
 
 2. Generate a new Auth Link, and retrieve the auth link ID from the public URL that is returned.
 
-```js
-    
-  try {
-    const { data } = await axios.get(
-      `https://au-api.basiq.io/users/{userId}/auth_link`,
-      {
-        method: 'post',
-        headers: {
-          Authorization: `Bearer ${YOUR_SERVER_ACCESS_TOKEN}`,
-          Accept: 'application/json',
-          'Content-Type': 'application/json',
-        },
-      }
-    );
+    ```js
+    try {
+      const { data } = await axios.get(
+        `https://au-api.basiq.io/users/{userId}/auth_link`,
+        {
+          method: 'post',
+          headers: {
+            Authorization: `Bearer ${YOUR_SERVER_ACCESS_TOKEN}`,
+            Accept: 'application/json',
+            'Content-Type': 'application/json',
+          },
+        }
+      );
 
-    let auth_id = data.links.public.replace('https://connect.basiq.io/','');
+      let auth_id = data.links.public.replace('https://connect.basiq.io/','');
 
-    return auth_id;
+      return auth_id;
 
-  } catch (error) {
-    console.log(error)
-  }
+    } catch (error) {
+      console.log(error)
+    }
+    ```
 
-```
+3. Drop the component in your code on the page you wish to call it. The component will retrieve the `auth_id` from the URL, so failing to include it there will result in an error. **Note** that the component is full page and will eventually handle the redirect to the Basiq Consent UI, so it should be rendered on its own page (or conditionally, after appending an `auth_link` ID).
 
-3. Drop the component in your code on the page you wish to call it. The component will retrieve the auth_id from the URL so failing to include it there will result in an error. **Note** that the component is full page and will eventually handle the redirect to the Basiq Consent UI, so it should be rendered on it's own page (or conditionally, after appending an auth_link ID)
+    ```jsx
+    // Component rendered at /auth-link/:auth_id
 
+    export default function Auth() {
+      return (
+          <main>
+            <BasiqConnect />
+          </main>
+      );
+    }
+    ```
 
-```jsx
+## Updates
 
-// Component rendered at /auth-link/:auth_id
+**OTP Code Length Increased**: The OTP code length has been increased from 4 to 6 characters to enhance security. 
 
-export default function Auth() {
-  return (
-      <main>
-        <BasiqConnect />
-      </main>
-  );
-}
-```
+## Demo
+
+You can see a demo of the Basiq Connect Auth component in action below:
+
+<div style="position: relative; padding-bottom: calc(50.161117078410314% + 41px); height: 0; width: 100%;"><iframe src="https://demo.arcade.software/DhU1AMDeKC4f6PxNmJcP?embed" title="Basiq | OTP Demo" frameborder="0" loading="lazy" webkitallowfullscreen mozallowfullscreen allowfullscreen allow="clipboard-write" style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;color-scheme: light;"></iframe></div>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@basiq/connect-auth",
-  "version": "1.0.13",
+  "version": "1.1.1",
   "description": "",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -12,7 +12,6 @@
     "build": "tsup",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
-
   "license": "ISC",
   "typings": "dist/index.d.ts",
   "engines": {
@@ -27,7 +26,6 @@
     "singleQuote": true,
     "trailingComma": "es5"
   },
-
   "author": "Basiq",
   "size-limit": [
     {

package/dist/index.d.mts

@@ -1,8 +0,0 @@
-import React from 'react';
-
-interface IBCProps {
-    test?: boolean;
-}
-declare function BasiqConnect(props: IBCProps): React.JSX.Element;
-
-export { BasiqConnect };

package/dist/index.d.ts

@@ -1,8 +0,0 @@
-import React from 'react';
-
-interface IBCProps {
-    test?: boolean;
-}
-declare function BasiqConnect(props: IBCProps): React.JSX.Element;
-
-export { BasiqConnect };