Merge branch 'master' into dev

nuxt-community · May 24, 2019 · bf53d55 · bf53d55
2 parents aacb191 + 0729bd4
commit bf53d55
Show file tree

Hide file tree

Showing 23 changed files with 7,421 additions and 112 deletions.
diff --git a/.gitbook.yaml b/.gitbook.yaml
diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 <h1 align="center" >🔑 Auth Module</h1>
-<p align="center">Authentication module for Nuxt.js</p>
+<p align="center">Zero-boilerplate authentication support for Nuxt.js!</p>
 
 <p align="center">
 <a href="https://david-dm.org/nuxt-community/auth-module">
@@ -28,7 +28,7 @@
 </p>
 
 
-## Development 
+## Development
 
 Running demo for development:
 

diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -0,0 +1,59 @@
+module.exports = {
+  title: 'Auth Module',
+  description: 'Authentication module for Nuxt',
+  themeConfig: {
+    repo: 'nuxt-community/auth-module',
+    docsDir: 'docs',
+    editLinks: true,
+    editLinkText: 'Edit this page on GitHub',
+    sidebarDepth: 2,
+    sidebar: {
+      '/api/': [
+        '/api/auth',
+        '/api/options',
+        '/api/storage'
+      ],
+      '/': [
+        {
+          title: 'Guide',
+          collapsable: false,
+          children: [
+            '/',
+            '/guide/setup',
+            '/guide/scheme',
+            '/guide/provider',
+          ]
+        },
+        {
+          title: 'Schemes',
+          collapsable: false,
+          children: [
+            '/schemes/local',
+            '/schemes/oauth2'
+          ]
+        },
+        {
+          title: 'Providers',
+          collapsable: false,
+          children: [
+            '/providers/auth0',
+            '/providers/facebook',
+            '/providers/github',
+            '/providers/google',
+            '/providers/laravel-passport'
+          ]
+        }
+      ],
+    },
+    nav: [
+      {
+        text: 'Guide',
+        link: '/'
+      },
+      {
+        text: 'API',
+        link: '/api/'
+      }
+    ]
+  }
+}
diff --git a/docs/README.md b/docs/README.md
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
diff --git a/docs/api/auth.md b/docs/api/auth.md
@@ -1,4 +1,4 @@
-# $auth
+# auth
 
 [Source Code](https://github.com/nuxt-community/auth-module/blob/dev/lib/core/auth.js)
 

diff --git a/docs/options.md → docs/api/options.md b/docs/options.md → docs/api/options.md
@@ -1,8 +1,8 @@
-# Options
+# options
 
 General options shared with all strategies. See [defaults.js](https://github.com/nuxt-community/auth-module/blob/master/lib/module/defaults.js) for defaults.
 
-### `redirect`
+## `redirect`
 
 Default:
 
@@ -25,13 +25,13 @@ auth: {
 Each redirect path can be disabled by setting to `false`.
 Also you can disable all redirects by setting `redirect` to `false`
 
-### `watchLoggedIn`
+## `watchLoggedIn`
 
 - Default: `true`
 
 When enabled (default) user will be redirected on login/logouts.
 
-### `token`
+## `token`
 
 Auth tokens are stored in various storage providers (cookie, localStorage, vuex) on user login to provide a seamless auth experience across server-side rendering (SSR) and client-side rendering. Tokens are stored under with storage keys of the format: `{storageProvider.prefix}{token.prefix}{strategy}`. See [auth.js - Token helpers](https://github.com/nuxt-community/auth-module/blob/master/lib/core/auth.js#L160) and [storage.js](https://github.com/nuxt-community/auth-module/blob/master/lib/core/storage.js) for more details.
 
@@ -47,7 +47,7 @@ auth: {
 
 * **prefix** - Default prefix used in building a key for token storage across all storage providers.
 
-### `localStorage`
+## `localStorage`
 
 Default:
 
@@ -71,7 +71,7 @@ auth {
 
 Otherwise the auth token will be stored in localStorage at a default key of: `auth._token.{provider}`.
 
-### `cookie`
+## `cookie`
 
 Default:
 
@@ -105,39 +105,39 @@ auth: {
 
 Otherwise the auth token will be stored in a cookie named by default as: `auth._token.{provider}`.
 
-### `plugins`
+## `plugins`
 
 If you have any nuxt plugin that depends on `$auth` you have to specify it here instead of top-level `plugins` option in `nuxt.config.js`.
 
 See [Extending Auth Plugin](recipes/extend.md)
 
-### `resetOnError`
+## `resetOnError`
 
 * Default: `false`
 
 Either a boolean or a function is accepted. If a function is passed, it will take the same arguments as `onError` handlers and return `Boolean` to inform whether a reset should be performed.
 
 If enabled, user will be automatically logged out if an error happens. (For example when token expired)
 
-### `rewriteRedirects`
+## `rewriteRedirects`
 
 * Default: `true`
 
 If enabled, user will redirect back to the original guarded route instead of `redirect.home`.
 
-### `fullPathRedirect`
+## `fullPathRedirect`
 
 Default: `false`
 
 If true, use the full route path with query parameters for redirect
 
-### `vuex.namespace`
+## `vuex.namespace`
 
 * Default: `auth`
 
 Vuex store namespace for keeping state.
 
-### `scopeKey`
+## `scopeKey`
 
 * Default: `scope`
 

diff --git a/docs/api/readme.md b/docs/api/readme.md
@@ -0,0 +1,5 @@
+# API
+
+- [options](./options.md)
+- [auth](./auth.md)
+- [storage](./storage.md)
diff --git a/docs/api/storage.md b/docs/api/storage.md
@@ -1,10 +1,10 @@
-# $auth.$storage
+# storage
 
 [Source Code](https://github.com/nuxt-community/auth-module/blob/dev/lib/core/storage.js)
 
 Auth module has a built-in powerful and universal storage to keep tokens and profile data.
 
-### Universal Storage
+## Universal Storage
 
 Universally keep state in vuex, localStorage and Cookies:
 
@@ -14,7 +14,7 @@ this.$auth.$storage.getUniversal(key, isJson)
 this.$auth.$storage.syncUniversal(key, defaultValue, isJson)
 ```
 
-### Local State
+## Local State
 
 Access to local state:
 
@@ -32,14 +32,14 @@ this.$auth.$storage.getState(key)
 this.$auth.$storage.watchState('loggedIn', newValue => { })
 ```
 
-### Cookies
+## Cookies
 
 ```js
 this.$auth.$storage.setCookie(key, val, isJson)
 this.$auth.$storage.getCookie(key)
 ```
 
-### Local Storage
+## Local Storage
 
 ```js
 this.$auth.$storage.setLocalStorage(key, val, isJson)

diff --git a/docs/GLOSSARY.md → docs/glassory.md b/docs/GLOSSARY.md → docs/glassory.md
diff --git a/docs/providers/README.md → docs/guide/provider.md b/docs/providers/README.md → docs/guide/provider.md
@@ -3,3 +3,10 @@
 Providers are an abstraction on top of Schemes.
 They make it super easy to integrate with popular authentication services. They can do even more by provider required server-side changes such as token signing and you can also write your own provider.
 
+## Supported Providers
+
+- [Auth0](../providers/auth0.md)
+- [Facebook](../providers/facebook.md)
+- [Github](../providers/github.md)
+- [Google](../providers/google.md)
+- [Laravel Passport](../providers/laravel-passport.md)
diff --git a/docs/schemes/README.md → docs/guide/scheme.md b/docs/schemes/README.md → docs/guide/scheme.md
@@ -1,4 +1,4 @@
-# Schemes and Strategies
+# Schemes
 
 Schemes define authentication logic. Strategy is a configurated instance of Scheme. You can have multiple schemes and strategies in your project.
 
@@ -24,5 +24,3 @@ auth: {
   }
 }
 ```
-
-👉 Now that you have an idea what schemes and strategies are, you can configure the default [Local Scheme](local.md) or use a [Provider](../providers/README.md).
diff --git a/docs/setup.md → docs/guide/setup.md b/docs/setup.md → docs/guide/setup.md
@@ -25,4 +25,6 @@ auth: {
 }
 ```
 
-ℹ️ When adding `auth-module` to a new Nuxt project ensure you have activated the Vuex store. More information on how to do that can be found on the [Nuxt Getting Started Guide](https://nuxtjs.org/guide/vuex-store).
+::: warning IMPORTANT
+When adding `auth-module` to a new Nuxt project ensure you have activated the Vuex store. More information on how to do that can be found on the [Nuxt Getting Started Guide](https://nuxtjs.org/guide/vuex-store).
+:::
diff --git a/docs/package.json b/docs/package.json
@@ -0,0 +1,10 @@
+{
+  "private": true,
+  "scripts": {
+    "dev": "vuepress dev",
+    "build": "vuepress build"
+  },
+  "devDependencies": {
+    "vuepress": "^1.0.0-alpha.47"
+  }
+}
diff --git a/docs/providers/auth0.md b/docs/providers/auth0.md
@@ -1,4 +1,4 @@
-# Auth0 Provider
+# Auth0
 
 [Source Code](https://github.com/nuxt-community/auth-module/blob/dev/lib/providers/auth0.js)
 
@@ -31,7 +31,7 @@ User will be redirected to a page like this:
 
 💁 This provider is based on [oauth2 scheme](../schemes/oauth2.md) and supports all scheme options.
 
-### Obtaining `client_id`, `domain`, and `audience`
+## Obtaining `client_id`, `domain`, and `audience`
 
 `client_id` and `domain` are **REQUIRED**. Your application needs some details about this client to communicate with Auth0.
 

diff --git a/docs/providers/facebook.md b/docs/providers/facebook.md
@@ -1,4 +1,4 @@
-# Facebook Provider
+# Facebook
 
 [Source Code](https://github.com/nuxt-community/auth-module/blob/dev/lib/providers/facebook.js)
 
@@ -24,7 +24,7 @@ this.$auth.loginWith('facebook')
 
 💁 This provider is based on [oauth2 scheme](../schemes/oauth2.md) and supports all scheme options.
 
-### Obtaining `client_id`
+## Obtaining `client_id`
 
 This option is **REQUIRED**. To obtain one, create your app in [Facebook Developers](https://developers.facebook.com) and add "Facebook Login" product. Then set valid callback URLs. Client ID is same as your "App ID".
 
diff --git a/docs/providers/github.md b/docs/providers/github.md
@@ -23,7 +23,7 @@ this.$auth.loginWith('github')
 
 💁 This provider is based on [oauth2 scheme](../schemes/oauth2.md) and supports all scheme options.
 
-### Obtaining `client_id` and `client_secret`
+## Obtaining `client_id` and `client_secret`
 
 This option is **REQUIRED**. To obtain one, create your app in [Create a new Oauth APP](https://github.com/settings/applications/new) and use provided "Client ID" and "Client Secret".
 
diff --git a/docs/providers/google.md b/docs/providers/google.md
@@ -1,4 +1,8 @@
-# Google Provider
+---
+sidebarDepth: 0
+---
+
+# Google
 
 [Source Code](https://github.com/nuxt-community/auth-module/blob/dev/lib/providers/google.js)
 
@@ -22,7 +26,7 @@ this.$auth.loginWith('google')
 
 💁 This provider is based on [oauth2 scheme](../schemes/oauth2.md) and supports all scheme options.
 
-### Obtaining `client_id`
+## Obtaining `client_id`
 
 This option is **REQUIRED**. To obtain one, create your app in [Google API Console](https://console.developers.google.com), Create a new project and from Credentials tab, create a new "Oauth Client ID".
 
diff --git a/docs/providers/passport.md → docs/providers/laravel-passport.md b/docs/providers/passport.md → docs/providers/laravel-passport.md
@@ -16,8 +16,6 @@ auth: {
 }
 ```
 
-## Usage
-
 Anywhere in your application logic:
 
 ```js

diff --git a/docs/readme.md b/docs/readme.md
@@ -0,0 +1,22 @@
+# Auth Module
+
+Zero-boilerplate authentication support for Nuxt.js!
+
+## Getting Started
+
+If it is first time using this module, reading resources below in order is recommended:
+
+1. [Add auth and axios modules](./guide/setup.md)
+2. [Configure local scheme](./schemes/local.md)
+3. [Customize options](./api/options.md)
+4. [Use `$auth` service](./api/auth.md)
+
+## More Resources
+
+* [Glassory](./glassory.md)
+* [GitHub](https://github.com/nuxt-community/auth-module)
+* [Releases](https://github.com/nuxt-community/auth-module/releases)
+* [Migration Guide](./migration.md)
+* [Examples](https://github.com/nuxt-community/auth-module/tree/dev/examples)
+* [Demo](https://nuxt-auth.herokuapp.com)
+