@basiq/connect-auth 0.1.7 → 0.1.10

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 dushajni
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,2 +1,60 @@
-# BASIQ CONNECT AUTH
+# 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. 
+
+## Setup
+
+1. Install `@basiq/connect-auth` and import the component
+
+```
+$ npm install @basiq/basiq-connect-control
+```
+
+```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',
+        },
+      }
+    );
+
+    let auth_id = data.links.public.replace('https://connect.basiq.io/','');
+
+    return auth_id;
+
+  } 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 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>
+  );
+}
+```

package/dist/App.d.ts

@@ -0,0 +1,3 @@
+import { IBCProps } from "./components/BasiqConnect";
+declare function App(props: IBCProps): JSX.Element;
+export default App;

package/dist/actions/actions.d.ts

@@ -0,0 +1,40 @@
+export declare const verifySmsCode: ({ authRequestId, smsCode, test }: {
+    authRequestId: string;
+    smsCode: string;
+    test?: boolean;
+}) => Promise<{
+    data: any;
+    headers: Headers;
+    statusCode: number;
+    ok: boolean;
+    error?: undefined;
+} | {
+    headers: Headers;
+    statusCode: number;
+    error: string;
+    ok: boolean;
+    data?: undefined;
+}>;
+export declare const authUser: ({ authRequestId, method, test }: {
+    authRequestId: string;
+    method?: 'POST' | 'GET';
+    test?: boolean;
+}) => Promise<{
+    data: any;
+    headers: Headers;
+    statusCode: number;
+    ok: boolean;
+    error?: undefined;
+} | {
+    headers: Headers;
+    statusCode: number;
+    error: any;
+    ok: boolean;
+    data?: undefined;
+} | {
+    statusCode: number;
+    error: string;
+    ok: boolean;
+    data?: undefined;
+    headers?: undefined;
+}>;

package/dist/components/BasiqConnect.d.ts

@@ -0,0 +1,5 @@
+import '../locales/i18n';
+export interface IBCProps {
+    test?: boolean;
+}
+export declare function BasiqConnect(props: IBCProps): JSX.Element;

package/dist/components/modals/LoadingModal.d.ts

@@ -0,0 +1,7 @@
+interface IProps {
+    isOpen: boolean;
+    disableTransparency?: boolean;
+    loadingText?: string;
+}
+declare function LoadingModal(props: IProps): JSX.Element;
+export default LoadingModal;

package/{src/components/modals/index.ts → dist/components/modals/index.d.ts}

@@ -1 +1 @@
-export { default as LoadingModal } from './LoadingModal';
+export { default as LoadingModal } from './LoadingModal';

package/dist/components/pages/AuthScreen.d.ts

@@ -0,0 +1,9 @@
+interface IProps {
+    shadow: boolean;
+    onBack: () => void;
+    number: string;
+    authRequestId: string;
+    test?: boolean;
+}
+declare function AuthScreen({ onBack, number, authRequestId, shadow, test }: IProps): JSX.Element;
+export default AuthScreen;

package/dist/components/pages/NotFound.d.ts

@@ -0,0 +1,5 @@
+interface IProps {
+    messageCode?: string;
+}
+declare function NotFound({ messageCode }: IProps): JSX.Element;
+export default NotFound;

package/dist/components/pages/Page.d.ts

@@ -0,0 +1,18 @@
+import { ReactElement } from 'react';
+import { ButtonType } from '../ui/Button';
+interface IProps {
+    buttons?: IButton[];
+    children: ReactElement;
+    title?: string | ReactElement;
+    subTitle?: string;
+    shadow: boolean;
+    onBack?: () => void;
+}
+export interface IButton {
+    label: string;
+    onClick: () => void;
+    buttonType?: ButtonType;
+    disabled?: boolean;
+}
+declare function Page(props: IProps): JSX.Element;
+export default Page;

package/dist/components/pages/StartScreen.d.ts

@@ -0,0 +1,10 @@
+interface IProps {
+    onContinue: () => void;
+    showErrorScreen: (code: string) => void;
+    shadow: boolean;
+    appName: string;
+    authRequestId?: string;
+    test?: boolean;
+}
+declare function StartScreen(props: IProps): JSX.Element;
+export default StartScreen;

package/{src/components/pages/index.ts → dist/components/pages/index.d.ts}

@@ -1,4 +1,4 @@
-export { default as Page } from './Page';
-export { default as NotFound } from './NotFound';
-export { default as StartScreen } from './StartScreen';
-export { default as AuthScreen } from './AuthScreen';
+export { default as Page } from './Page';
+export { default as NotFound } from './NotFound';
+export { default as StartScreen } from './StartScreen';
+export { default as AuthScreen } from './AuthScreen';

package/dist/components/ui/Button.d.ts

@@ -0,0 +1,9 @@
+export declare type ButtonType = 'secondary' | 'tiny' | 'link' | 'back';
+interface Props {
+    onClick: () => void;
+    label: string;
+    buttonType?: ButtonType;
+    disabled?: boolean;
+}
+declare function Button(props: Props): JSX.Element;
+export default Button;

package/dist/components/ui/Modal.d.ts

@@ -0,0 +1,9 @@
+import { ReactElement } from 'react';
+interface IProps {
+    children: ReactElement;
+    onClose?: () => void;
+    isOpen: boolean;
+    disableTransparency: boolean;
+}
+declare function Modal(props: IProps): JSX.Element;
+export default Modal;

package/dist/components/ui/icon.d.ts

@@ -0,0 +1,6 @@
+interface IProps {
+    rotating: boolean;
+    img: string;
+}
+declare function Icon(props: IProps): JSX.Element;
+export default Icon;

package/{src/components/ui/index.ts → dist/components/ui/index.d.ts}

@@ -1 +1 @@
-export { default as Button } from './Button';
+export { default as Button } from './Button';