diff --git a/packages/cognito-auth/README.md b/packages/cognito-auth/README.md index 3dc617b853..b922e18766 100644 --- a/packages/cognito-auth/README.md +++ b/packages/cognito-auth/README.md @@ -2,9 +2,9 @@ ![lines](/packages/cognito-auth/src/tests/badges/badge-lines.svg) ![functions](/packages/cognito-auth/src/tests/badges/badge-functions.svg) ![branches](/packages/cognito-auth/src/tests/badges/badge-branches.svg) ![statements](/packages/cognito-auth/src/tests/badges/badge-statements.svg) -A thin wrapper around the AWS SDK and OAuth flow to take the pain out of authenticating your App with Reapit Connect. Usage see: [here](https://foundations-documentation.reapit.cloud/open-source/packages#cognito-auth). +A thin wrapper around the AWS SDK and OAuth flow to take the pain out of authenticating your App with Reapit Connect. -## DEPRECATED +## DEPRECATED - Please use https://www.npmjs.com/package/@reapit/connect-session -We will continue to offer patches and bugfixes for this package however, we strongly suggest that you migrate to `@reapit/connect-session` for a lighter weight solution when working with Reapit Connect; a more comprehensive, simpler API and better developer experience. +We will continue to offer patches and bugfixes for this package however, we strongly suggest that you migrate to `@reapit/connect-session` for a light-weight solution when working with Reapit Connect; a more comprehensive, simpler API and better developer experience. diff --git a/packages/cognito-auth/package.json b/packages/cognito-auth/package.json index 6c4436129b..1091d9be8a 100644 --- a/packages/cognito-auth/package.json +++ b/packages/cognito-auth/package.json @@ -1,6 +1,6 @@ { "name": "@reapit/cognito-auth", - "version": "2.1.11", + "version": "3.0.0", "description": "Simple wrapper around AWS Cognito for basic authentication flow", "keywords": [], "homepage": "https://github.com/reapit/foundations#readme", diff --git a/packages/connect-session/README.md b/packages/connect-session/README.md index 3c9597c879..a196cb43f3 100644 --- a/packages/connect-session/README.md +++ b/packages/connect-session/README.md @@ -2,9 +2,13 @@ ![lines](/packages/connect-session/src/tests/badges/badge-lines.svg) ![functions](/packages/connect-session/src/tests/badges/badge-functions.svg) ![branches](/packages/connect-session/src/tests/badges/badge-branches.svg) ![statements](/packages/connect-session/src/tests/badges/badge-statements.svg) -A thin wrapper around the Reapit Connect (AWS Congnito) OAuth API. Takes the pain away from managing refreshing sessions and re-directing to the OAuth endpoints. [here](https://foundations-documentation.reapit.cloud/api/web#connect-session) and [here](https://foundations-documentation.reapit.cloud/open-source/packages#connect-session). +A thin wrapper around the Reapit Connect OAuth API. -- **Production**: https://www.npmjs.com/package/@reapit/connect-session +Managing OAuth flows can be tricky, especially redirecting, keeping sessions refreshed and cached. To make this process easier, we have built the Connect Session module for any JavaScript app. + +To get started run `yarn add @reapit/connect-session` + +Then follow the steps for either browsers, React or NodeJS below. For full documentaion [here](https://foundations-documentation.reapit.cloud/app-development/connect-session). ## Basic Browser Usage @@ -24,7 +28,7 @@ export const reapitConnectBrowserSession = new ReapitConnectBrowserSession({ // The url to the Reapit Connect instance. While in beta this is the below URL but will need to be context aware in full prod/ connectOAuthUrl: 'https://dev.connect.reapit.cloud', // The relative path you want to re-direct in your application after a successful login. You will have supplied this when you registered your app. - // Defaults to '' or the route of your project if not supplied + // Defaults to '' or the root of your project if not supplied connectLoginRedirectPath: '/some-redirect-path', // The relative path you want to re-direct in your application after a successful logout. You will have supplied this when you registered your app. // Defaults to '/login' if not supplied @@ -126,7 +130,7 @@ export const SomeComponent: React.FC = () => { ## Sign In With Reapit Button -Perhaps the simplest way to authenticate on the client side is to embed the "Sign In With Reapit Button" on your page. This is a single script served from our CDN, you instantiate with a target div, your client credentials as per the browser API and pass in a callback to receive your session object. As per the NPM module, all caching, redirection and refreshing is taken care of by the package. When you have a session, the button will change function to be a logout which will clear your cache and end yourr session in Reapit Connect. +Perhaps the simplest way to authenticate on the client side is to embed the "Sign In With Reapit Button" on your page. This is a single script served from our CDN, you instantiate with a target div, your client credentials as per the browser API and pass in a callback to receive your session object. As per the NPM module, all caching, redirection and refreshing is taken care of by the package. When you have a session, the button will change function to be a logout which will clear your cache and end your session in Reapit Connect. The below example shows how to embed on any static or dynamic page with a single script. In the connectHasSessionCallback function we fetch a list of appointments from the Platform API to demonstrate the full flow. diff --git a/packages/connect-session/package.json b/packages/connect-session/package.json index a2ebe9f0f8..8a5c65a57b 100644 --- a/packages/connect-session/package.json +++ b/packages/connect-session/package.json @@ -1,6 +1,6 @@ { "name": "@reapit/connect-session", - "version": "1.0.0", + "version": "1.0.1", "description": "OAuth Flow for Reapit Connect", "keywords": [], "homepage": "https://github.com/reapit/foundations#readme", diff --git a/packages/cra-template-foundations/README.md b/packages/cra-template-foundations/README.md index 701df6929a..d536671bac 100644 --- a/packages/cra-template-foundations/README.md +++ b/packages/cra-template-foundations/README.md @@ -2,7 +2,10 @@ A quick start Create React App template for use with the Reapit Foundations Platform made with [Create-React-App](https://create-react-app.dev/) +For full documentaion [here](https://foundations-documentation.reapit.cloud/app-development/create-react-app-template). + ## Basic Usage + 1. Install the packages `npm install -g create-react-app @reapit/cra-template-foundations` 2. Execute `npx create-react-app <> --template @reapit/cra-template-foundations` 3. Open the project in your text editor and insert your Reapit Connect ClientId from the Developer Portal into the `src/reapit.config.json` file. diff --git a/packages/cra-template-foundations/package.json b/packages/cra-template-foundations/package.json index a9396595b7..bb1e7afe26 100644 --- a/packages/cra-template-foundations/package.json +++ b/packages/cra-template-foundations/package.json @@ -1,6 +1,6 @@ { "name": "@reapit/cra-template-foundations", - "version": "1.0.0", + "version": "1.0.1", "main": "./template.json", "license": "MIT", "scripts": { diff --git a/packages/elements/README.md b/packages/elements/README.md index c04f97385b..4ea5369449 100644 --- a/packages/elements/README.md +++ b/packages/elements/README.md @@ -6,4 +6,4 @@ A UI toolkit for building web applications in the Reapit Marketplace. Exports a For the React Component Storybook visit [here](https://elements.reapit.cloud). -For detailed documentation [visit here](https://foundations-documentation.reapit.cloud/web/elements). +For detailed documentation and usage [visit here](https://foundations-documentation.reapit.cloud/app-development/elements). diff --git a/packages/elements/package.json b/packages/elements/package.json index 7c41cf0239..854a30c4f0 100644 --- a/packages/elements/package.json +++ b/packages/elements/package.json @@ -1,6 +1,6 @@ { "name": "@reapit/elements", - "version": "1.0.0", + "version": "1.0.1", "description": "A collection of React components and utilities for building apps for Reapit Marketplace", "homepage": "https://github.com/reapit/foundations#readme", "bugs": { diff --git a/packages/foundations-ts-definitions/README.md b/packages/foundations-ts-definitions/README.md index afdb43e664..103f8ca3f3 100644 --- a/packages/foundations-ts-definitions/README.md +++ b/packages/foundations-ts-definitions/README.md @@ -1,9 +1,5 @@ # Foundations TS Definitions: -Automated TypeScript definitions for the Foundations API Platform. Automatically generates up to date TypeScript type definitions from Platform API swagger documentation. For usage visit [here](https://foundations-documentation.reapit.cloud/api/web#foundations-ts-definitions). +Automated TypeScript definitions for the Foundations API Platform. Automatically generates up to date TypeScript type definitions from Platform API swagger documentation. -- **Tech Stack**: NodeJS -- **Cloud Services**: NPM -- **Production**: https://www.npmjs.com/package/@reapit/foundations-ts-definitions - -For detailed documentation [visit here](https://foundations-documentation.reapit.cloud/open-source/packages#foundations-ts-definitions). +For detailed documentation [visit here](https://foundations-documentation.reapit.cloud/app-development/foundations-ts-defintions). diff --git a/packages/react-app-scaffolder/README.md b/packages/react-app-scaffolder/README.md index 4133c99c71..2e6c52348b 100644 --- a/packages/react-app-scaffolder/README.md +++ b/packages/react-app-scaffolder/README.md @@ -2,12 +2,9 @@ A CLI for generating React Apps, optimised for the marketplace, including Reapit Connect authentication and Elements. -For detailed documentation [visit here](https://foundations-documentation.reapit.cloud/open-source/packages#react-app-scaffolder). - For internal scaffolds, navigate to project folder and execute `yarn scaffold` to load the CLI. -## DEPRECATED +## DEPRECATED - Please use https://www.npmjs.com/package/@reapit/cra-template-foundations We will continue to offer patches and bugfixes for this package for internal Reapit Users however, for Reapit Partner Developers we strongly suggest that you migrate to `@reapit/cra-template-foundations` for a better developer experience and the LTS benefits of Facebook's React Scripts package. - diff --git a/packages/react-app-scaffolder/package.json b/packages/react-app-scaffolder/package.json index d19d6705fe..a0cd1baac7 100644 --- a/packages/react-app-scaffolder/package.json +++ b/packages/react-app-scaffolder/package.json @@ -1,6 +1,6 @@ { "name": "@reapit/generator-react-app-scaffolder", - "version": "1.0.0", + "version": "1.0.1", "description": "An opinionated gnerator for scaffolding TypeScript React Redux apps", "keywords": [ "yeoman-generator"