@luigi-project/plugin-auth-oauth2 1.16.2 → 1.19.0

package/README.md

@@ -16,7 +16,7 @@ meta -->
 
 ## Overview
 
-This project contains a library that allows your application to extend the [Luigi framework](https://github.com/SAP/luigi/tree/master/core) with an OAuth2 authorization provider. 
+This [authorization plugin](https://github.com/SAP/luigi/tree/master/plugins/auth/public/auth-oauth2) contains a library that allows your application to extend the [Luigi framework](https://github.com/SAP/luigi/tree/master/core) with an OAuth2 authorization provider.
 Further configuration details can be found in the [main documentation](https://docs.luigi-project.io/docs/authorization-configuration#oauth2-implicit-grant-configuration).
 
 ## Installation
@@ -49,7 +49,11 @@ Luigi.setConfig({
 })
 ```
 
-The `callback.html` needs to be copied to a folder in your Luigi Core installation, which is the return path for the IdP provider, configured through the `redirect_uri` setting. The default location of `redirect_uri` is `/assets/auth-oauth2/callback.html`.
+ We provide a `callback.html` file through our `plugin-auth-oauth2` package. This `callback.html` file resides in `node_modules/@luigi-project/plugin-auth-oauth2/callback.html` and needs to be copied to a folder in your Luigi Core installation, which is the return path for the IdP provider, configured through the `redirect_uri` setting. The default location of `redirect_uri` is `/assets/auth-oauth2/callback.html`.
+
+The examples given below give some alternatives on how to copy this file in your project. However, you may choose your own way of copying the `callback.html` file to the default location depending on your environment.
+
+For applications involving a webpack configuration, one way to copy the `callback.html` file is using packages such as [copy-webpack-plugin](https://www.npmjs.com/package/copy-webpack-plugin) and then including the following in your webpack configuration file:
 
 ```javascript
 const CopyWebpackPlugin = require('copy-webpack-plugin');
@@ -63,3 +67,13 @@ const CopyWebpackPlugin = require('copy-webpack-plugin');
   ]
 }
 ```
+
+If your application does not use webpack or you installed Luigi without a framework, you can use any copy plugin to copy the `callback.html` file and then modify the `package.json` script to copy the file when building. One package that could be helpful is [copyfiles](https://www.npmjs.com/package/copyfiles). Following is an example:
+
+```javascript
+"buildConfig": "webpack --entry ./src/luigi-config/luigi-config.es6.js --output-path ./public/assets --output-filename luigi-config.js --mode production",
+"build": "npm run buildConfig && npm run copyCallbackOAuth",
+"copyCallbackOAuth": "copyfiles -f node_modules/@luigi-project/plugin-auth-oauth2/callback.html public/assets/auth-oauth2"
+```
+
+Running `npm run build` should then suffice to bundle the config and also copy the callback file.

package/package.json

@@ -1,6 +1,5 @@
 {
   "name": "@luigi-project/plugin-auth-oauth2",
-  "version": "1.16.2",
   "description": "OAuth2 implicit grant provider plugin for @luigi-project/core",
   "license": "Apache-2.0",
   "main": "plugin.js",
@@ -16,5 +15,6 @@
     "core",
     "oauth2",
     "provider"
-  ]
+  ],
+  "version": "1.19.0"
 }