@basiq/connect-auth 0.1.88 → 1.0.0

package/README.md

@@ -1,160 +1,60 @@
-# TSDX React User Guide
+# BASIQ CONNECT COMPONENT
 
-Congrats! You just saved yourself hours of work by bootstrapping this project with TSDX. Let’s get you oriented with what’s here and how to use it.
+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.
 
-> This TSDX setup is meant for developing React component libraries (not apps!) that can be published to NPM. If you’re looking to build a React-based app, you should use `create-react-app`, `razzle`, `nextjs`, `gatsby`, or `react-static`.
+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. 
 
-> If you’re new to TypeScript and React, checkout [this handy cheatsheet](https://github.com/sw-yx/react-typescript-cheatsheet/)
+## Setup
 
-## Commands
+1. Install `@basiq/connect-auth` and import the component
 
-TSDX scaffolds your new library inside `/src`, and also sets up a [Parcel-based](https://parceljs.org) playground for it inside `/example`.
-
-The recommended workflow is to run TSDX in one terminal:
-
-```bash
-npm start # or yarn start
 ```
-
-This builds to `/dist` and runs the project in watch mode so any edits you save inside `src` causes a rebuild to `/dist`.
-
-Then run the example inside another:
-
-```bash
-cd example
-npm i # or yarn to install dependencies
-npm start # or yarn start
+$ npm install @basiq/basiq-connect-control
 ```
 
-The default example imports and live reloads whatever is in `/dist`, so if you are seeing an out of date component, make sure TSDX is running in watch mode like we recommend above. **No symlinking required**, we use [Parcel's aliasing](https://parceljs.org/module_resolution.html#aliases).
-
-To do a one-off build, use `npm run build` or `yarn build`.
-
-To run tests, use `npm test` or `yarn test`.
-
-## Configuration
-
-Code quality is set up for you with `prettier`, `husky`, and `lint-staged`. Adjust the respective fields in `package.json` accordingly.
-
-### Jest
-
-Jest tests are set up to run with `npm test` or `yarn test`.
-
-### Bundle analysis
-
-Calculates the real cost of your library using [size-limit](https://github.com/ai/size-limit) with `npm run size` and visulize it with `npm run analyze`.
-
-#### Setup Files
-
-This is the folder structure we set up for you:
-
-```txt
-/example
-  index.html
-  index.tsx       # test your component here in a demo app
-  package.json
-  tsconfig.json
-/src
-  index.tsx       # EDIT THIS
-/test
-  blah.test.tsx   # EDIT THIS
-.gitignore
-package.json
-README.md         # EDIT THIS
-tsconfig.json
-```
-
-#### React Testing Library
-
-We do not set up `react-testing-library` for you yet, we welcome contributions and documentation on this.
-
-### Rollup
-
-TSDX uses [Rollup](https://rollupjs.org) as a bundler and generates multiple rollup configs for various module formats and build settings. See [Optimizations](#optimizations) for details.
-
-### TypeScript
-
-`tsconfig.json` is set up to interpret `dom` and `esnext` types, as well as `react` for `jsx`. Adjust according to your needs.
-
-## Continuous Integration
-
-### GitHub Actions
-
-Two actions are added by default:
-
-- `main` which installs deps w/ cache, lints, tests, and builds on all pushes against a Node and OS matrix
-- `size` which comments cost comparison of your library on every pull request using [`size-limit`](https://github.com/ai/size-limit)
-
-## Optimizations
-
-Please see the main `tsdx` [optimizations docs](https://github.com/palmerhq/tsdx#optimizations). In particular, know that you can take advantage of development-only optimizations:
-
 ```js
-// ./types/index.d.ts
-declare var __DEV__: boolean;
-
-// inside your code...
-if (__DEV__) {
-  console.log('foo');
-}
+import { BasiqConnect } from "@basiq/connect-auth";
 ```
 
-You can also choose to install and use [invariant](https://github.com/palmerhq/tsdx#invariant) and [warning](https://github.com/palmerhq/tsdx#warning) functions.
-
-## Module Formats
-
-CJS, ESModules, and UMD module formats are supported.
-
-The appropriate paths are configured in `package.json` and `dist/index.js` accordingly. Please report if any issues are found.
-
-## Deploying the Example Playground
-
-The Playground is just a simple [Parcel](https://parceljs.org) app, you can deploy it anywhere you would normally deploy that. Here are some guidelines for **manually** deploying with the Netlify CLI (`npm i -g netlify-cli`):
+2. Generate a new Auth Link, and retrieve the auth link ID from the public URL that is returned.
 
-```bash
-cd example # if not already in the example folder
-npm run build # builds to dist
-netlify deploy # deploy the dist folder
-```
-
-Alternatively, if you already have a git repo connected, you can set up continuous deployment with Netlify:
+```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)
+  }
 
-```bash
-netlify init
-# build command: yarn build && cd example && yarn && yarn build
-# directory to deploy: example/dist
-# pick yes for netlify.toml
 ```
 
-## Named Exports
-
-Per Palmer Group guidelines, [always use named exports.](https://github.com/palmerhq/typescript#exports) Code split inside your React app instead of your React library.
-
-## Including Styles
-
-There are many ways to ship styles, including with CSS-in-JS. TSDX has no opinion on this, configure how you like.
+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)
 
-For vanilla CSS, you can include it at the root directory and add it to the `files` section in your `package.json`, so that it can be imported separately by your users and run through their bundler's loader.
 
-## Publishing to NPM
+```jsx
 
-We recommend using [np](https://github.com/sindresorhus/np).
+// Component rendered at /auth-link/:auth_id
 
-## Usage with Lerna
-
-When creating a new package with TSDX within a project set up with Lerna, you might encounter a `Cannot resolve dependency` error when trying to run the `example` project. To fix that you will need to make changes to the `package.json` file _inside the `example` directory_.
-
-The problem is that due to the nature of how dependencies are installed in Lerna projects, the aliases in the example project's `package.json` might not point to the right place, as those dependencies might have been installed in the root of your Lerna project.
-
-Change the `alias` to point to where those packages are actually installed. This depends on the directory structure of your Lerna project, so the actual path might be different from the diff below.
-
-```diff
-   "alias": {
--    "react": "../node_modules/react",
--    "react-dom": "../node_modules/react-dom"
-+    "react": "../../../node_modules/react",
-+    "react-dom": "../../../node_modules/react-dom"
-   },
+export default function Auth() {
+  return (
+      <main>
+        <BasiqConnect />
+      </main>
+  );
+}
 ```
-
-An alternative to fixing this problem would be to remove aliases altogether and define the dependencies referenced as aliases as dev dependencies instead. [However, that might cause other problems.](https://github.com/palmerhq/tsdx/issues/64)

package/dist/App.d.ts

@@ -1,3 +1,4 @@
 /// <reference types="react" />
-declare function App(): JSX.Element;
+import { IBCProps } from "./components/BasiqConnect";
+declare function App(props: IBCProps): JSX.Element;
 export default App;

package/dist/actions/actions.d.ts

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

package/dist/components/BasiqConnect.d.ts

@@ -1,3 +1,6 @@
 /// <reference types="react" />
 import '../locales/i18n';
-export declare function BasiqConnect(): JSX.Element;
+export interface IBCProps {
+    test?: boolean;
+}
+export declare function BasiqConnect(props: IBCProps): JSX.Element;

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

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

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

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