RNAA Docusaurus v1 site (#981)

Co-authored-by: Charlie Brown <carbonrobot@gmail.com>

Author: wsparsons

.eslintignore

@@ -1 +1,2 @@
-Example
+Example
+docs/docusaurus.config.ts

README.md

@@ -1,5 +1,5 @@
 <a href="https://formidable.com/open-source/" target="_blank">
-  <img alt="React Native App Auth — Formidable, We build the modern web" src="https://raw.githubusercontent.com/FormidableLabs/react-native-app-auth/main/react-native-app-auth-Hero.png" />
+  <img alt="React Native App Auth — Formidable, We build the modern web" src="https://oss.nearform.com/api/banner?text=react+native+app+auth" />
 </a>
 <p align="center">
 <strong>React native bridge for AppAuth - an SDK for communicating with OAuth2 providers</strong>
@@ -124,7 +124,7 @@ with optional overrides.
   - **registrationEndpoint** - (`string`) fully formed url to your OAuth/OpenID Connect registration endpoint. Only necessary for servers that require client registration.
   - **endSessionEndpoint** - (`string`) fully formed url to your OpenID Connect end session endpoint. If you want to be able to end a user's session and no `issuer` is specified, this field is mandatory.
 - **clientId** - (`string`) _REQUIRED_ your client id on the auth server
-- **clientSecret** - (`string`) client secret to pass to token exchange requests. :warning: Read more about [client secrets](#note-about-client-secrets)
+- **clientSecret** - (`string`) client secret to pass to token exchange requests. :warning: Read more about [client secrets](/docs/client-secrets)
 - **redirectUrl** - (`string`) _REQUIRED_ the url that links back to your app with the auth code
 - **scopes** - (`array<string>`) the scopes for your token, e.g. `['email', 'offline_access']`.
 - **additionalParameters** - (`object`) additional parameters that will be passed in the authorization request.
@@ -548,6 +548,6 @@ Please see our [contributing guide](./.github/CONTRIBUTING.md).
 
 ## Maintenance Status
 
-**Active:** Formidable is actively working on this project, and we expect to continue for work for the foreseeable future. Bug reports, feature requests and pull requests are welcome.
+**Active:** Nearform is actively working on this project, and we expect to continue for work for the foreseeable future. Bug reports, feature requests and pull requests are welcome.
 
 [maintenance-image]: https://img.shields.io/badge/maintenance-active-green.svg

docs/.gitignore

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

docs/README.md

@@ -0,0 +1,29 @@
+# Website
+
+This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ yarn
+```
+
+### Local Development
+
+```
+$ yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+This site is deployed using Vercel, which will automatically detect the site config and deploy

docs/babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};

docs/docs/client-secrets.md

@@ -0,0 +1,11 @@
+---
+sidebar_position: 2
+---
+
+# Client Secrets
+
+Some authentication providers, including examples cited below, require you to provide a client secret. The authors of the AppAuth library
+
+> [strongly recommend](https://github.com/openid/AppAuth-Android#utilizing-client-secrets-dangerous) you avoid using static client secrets in your native applications whenever possible. Client secrets derived via a dynamic client registration are safe to use, but static client secrets can be easily extracted from your apps and allow others to impersonate your app and steal user data. If client secrets must be used by the OAuth2 provider you are integrating with, we strongly recommend performing the code exchange step on your backend, where the client secret can be kept hidden.
+
+Having said this, in some cases using client secrets is unavoidable. In these cases, a `clientSecret` parameter can be provided to `authorize`/`refresh` calls when performing a token request.

docs/docs/config-examples/_category_.json

@@ -0,0 +1,7 @@
+{
+  "label": "Config Examples",
+  "position": 3,
+  "link": {
+    "type": "generated-index"
+  }
+}

docs/config-examples/asgardeo.md renamed to docs/docs/config-examples/asgardeo.md

@@ -1,3 +1,5 @@
+# Asgardeo
+
 To add authentication to your app using Asgardeo, you will first need to [create an application](https://wso2.com/asgardeo/docs/guides/applications/register-mobile-app/) in the Asgardeo console. If you don't have an Asgardeo account, [you can signup for one free](https://asgardeo.io/signup).
 
 After creating an application, take note of the configuration values listed in the **Quick Start** and **Info** tabs. You will be using those values as follows.
@@ -7,7 +9,7 @@ export const config = {
   issuer: 'https://api.asgardeo.io/t/<your_org_name>/oauth2/token',
   clientId: '<your_application_id>',
   redirectUrl: '<your_appAuthRedirectScheme>://example',
-  scopes: ['openid', 'profile']
+  scopes: ['openid', 'profile'],
 };
 
 // Log in to get an authentication token
@@ -20,12 +22,12 @@ const refreshedState = await refresh(config, {
 
 // Revoke token
 await revoke(config, {
-  tokenToRevoke: refreshedState.refreshToken
+  tokenToRevoke: refreshedState.refreshToken,
 });
 
 // End session
 await logout(config, {
   idToken: authState.idToken,
-  postLogoutRedirectUrl: '<your_appAuthRedirectScheme>:/logout'
+  postLogoutRedirectUrl: '<your_appAuthRedirectScheme>:/logout',
 });
 ```

docs/config-examples/aws-cognito.md renamed to docs/docs/config-examples/aws-cognito.md

@@ -18,8 +18,8 @@ const config = {
   serviceConfiguration: {
     authorizationEndpoint: '<YOUR_DOMAIN_NAME>/oauth2/authorize',
     tokenEndpoint: '<YOUR_DOMAIN_NAME>/oauth2/token',
-    revocationEndpoint: '<YOUR_DOMAIN_NAME>/oauth2/revoke'
-  }
+    revocationEndpoint: '<YOUR_DOMAIN_NAME>/oauth2/revoke',
+  },
 };
 
 // Log in to get an authentication token
@@ -32,6 +32,6 @@ const refreshedState = await refresh(config, {
 
 // Revoke token
 await revoke(config, {
-  tokenToRevoke: refreshedState.refreshToken
+  tokenToRevoke: refreshedState.refreshToken,
 });
 ```

docs/config-examples/azure-active-directory-b2c.md renamed to docs/docs/config-examples/azure-active-directory-b2c.md

@@ -1,4 +1,4 @@
-## Azure Active Directory B2C
+# Azure Active Directory B2C
 
 Detailed documentation [here](https://docs.microsoft.com/en-us/azure/active-directory-b2c/openid-connect).
 
@@ -7,7 +7,7 @@ const config = {
   issuer: 'https://<TENANT_NAME>.b2clogin.com/<TENANT_NAME>.onmicrosoft.com/<USER_FLOW_NAME>/v2.0',
   clientId: '<APPLICATION_ID>',
   redirectUrl: 'com.myapp://redirect/url/', // the redirectUrl must end with a slash
-  scopes: ['openid', 'offline_access']
+  scopes: ['openid', 'offline_access'],
 };
 
 // Log in to get an authentication token