npm package: @rio-cloud/rio-user-menu-component
Description: This library provides the User-Menu React component that can be embedded in the ApplicationHeader. The actual content of the user-menu -- the settings -- are embedded via an iFrame that references https://user-menu.iam.rio.cloud. Additionally, the compone
Author: TB Digital Services GmbH
Latest version: 4.0.0

# User Menu Component

This library provides the User-Menu React component that can be embedded in the ApplicationHeader.
The actual content of the user-menu -- the settings -- are embedded via an iFrame that
references https://user-menu.iam.rio.cloud.
Additionally, the component includes the cookie consent dialog.

#### Requirements

* `@rio-cloud/rio-uikit`: `1.0.0` or newer
* `react`/`react-dom`: `^18.2.0`
* `iframe-resizer-react`: `^1.0.0`

### Add it to your project

Simply install the NPM package via `npm install @rio-cloud/rio-user-menu-component`.

It can then be added to the application header as an actionBarItem:

```javascript
import {DefaultUserMenu} from '@rio-cloud/rio-user-menu-component';

// [...]

const userMenu = <DefaultUserMenu environment={process.env.NODE_ENV}/>;

// [...]

<ApplicationLayout.Header>
    <ApplicationHeader
        // [...]
        actionBarItems={[userMenu]}
    />
</ApplicationLayout.Header>

```

### Module exports

This package provides the exports `DefaultUserMenu`, `CookieDisclaimer`, `EVENT_USER_LANGUAGE_CHANGED`, `EVENT_USER_PROFILE_CHANGED`, `EVENT_USER_LOGGED_OUT`, and `GA_CONSENT_COOKIE`.

`DefaultUserMenu` is the React component that can be included in the Application Header. It includes the User Menu Dialog as well as the Cookie Consent Dialog It has the following props:

- `environment` (Required) - `string` <br>
  If set to `production`, the SPA https://user-menu.iam.rio.cloud is loaded as content of the component.
  For any other value some mock content is displayed. In Vite projects `import.meta.env.MODE` can be used.
- `localUserMenu` (Optional) - `boolean` <br>
  If set to true, and you run locally in not-production mode, a locally started version of `user-menu-web` is displayed.
- `logoutRedirectUri` (Optional) - `string` <br>
  **Deprecated** - Please use `postLogout` property instead. ]
  Lets you define the redirect_uri passed to the logout page (which is called after successful login).**Note**: This
  page has to be whitelisted in the authorization-server.
- `postLogout` (Optional) - `{redirectUri: string; idTokenHint: string;}` <br>
  Allows you to hand over the parameters `redirectUri` and `idTokenHint` to provide proper logout behavior defined
  by [OpenID Connect RP-Initiated Logout 1.0](https://openid.net/specs/openid-connect-rpinitiated-1_0.html). **Note**:
  The redirectUri has to be registered in client-registry for the intended client.
- `preventLogoutRedirect` (Optional) - `boolean` <br>
  Setting this value to true prevents the redirect to the logout page. Instead, the component publishes the event
  `EVENT_USER_LOGGED_OUT`, which needs to be handled by the SPA. The SPA that embeds the User-Menu-Component should
  listen to the other events, and act accordingly (e.g., run `userManager.signinSilent()` on
  `EVENT_USER_LANGUAGE_CHANGED` and `EVENT_USER_PROFILE_CHANGED`, if you are using the oidc-client).

`CookieDisclaimer` is a React component that provides a standalone Cookie Consent Dialog. In typical use-cases you do not have to use this component, since it is already included in the DefaultUserMenu.
It has the following props:

- `environment` (Required) - `string` <br>
  If set to `production`, the localized cookie disclaimer (eg. https://rio.cloud/en/cookie-disclaimer) is loaded as content of the component.
  For any other value some mock content is displayed. In Vite projects `import.meta.env.MODE` can be used.
- `locale` (Required) - `string` <br>
  The locale to be used for the Cookie Consent Dialog. This is used to load the correct translations.
- `setShowCookieDisclaimer` (Optional) - `(show: boolean) => void` <br>
  Callback function that is called when the user accepts or declines the cookie disclaimer. This prop is for internal use and not necessary when `CookieDisclaimer` is used as a standalone component.

`GA_CONSENT_COOKIE` is the name of the cookie that is set when the user accepts the cookie disclaimer. This is used to track the user's consent for Google Analytics.

`EulaConsent` is a React component that provides a dialog to accept the EULA. It has the following props:

- `environment` - `string` <br>
  If set to `production` or if not provided, the EULA page (eg. https://man-eula.iam.rio.cloud) is loaded as content of the component. If set to `development` the embedded EULA page is loaded from http://localhost:3000. The value `mock` can be used for local development, but has no effect in the production build.
- `disabled` - `boolean` <br>
  If set to `true`, the EULA dialog is not shown and the user is not required to accept the EULA.

## Development

### Project structure

The code for the library can be found in `src-lib/`. The example page that demonstrates the usage of the component is in
`src-demo-page/`.

### Running locally

#### Quick start

1. `npm install` - install dependencies
2. `npm run build` - transpile the library to javascript
3. `npm run dev` - start a local server that serves the example page including the component.
4. Visit `http://localhost:5173` to see the example page.

#### Details

When the `environment` is set to anything other than `production`, a mock page will be displayed instead of the actual
user-menu.
It is possible to test the component with actual content running locally. For that you have to get
the [user-menu](https://bitbucket.collaboration-man.com/projects/RIOIAM/repos/user-menu-web/browse)
and run it locally with `npm start`. Then, if you set the prop `localUserMenu` of `DefaultUserMenu` to `true`, it will
load the local
user-menu.

> Note, that while the CustomEvents will be triggered, there is no way to properly test a language change this way,
> since
> the language should be read from the IdToken, which this component does not have control over.
>
> The custom event `EVENT_USER_LANGUAGE_CHANGED` contains the new locale, but you would have to modify your local id
> token mock
> manually.

### Test bundling locally

To test how the component would be bundled into a regular SPA without having to publish to NPM follow these steps:

1. `npm run build` - transpile the library to javascript
2. `npm pack` - Generate a tarball of the package
3. In the SPA project in which you want to test
    - Reference the tarball in the `package.json` via
      `"@rio-cloud/rio-user-menu-component": "file:../relative/path/rio-cloud-rio-user-menu-component-x.x.x.tgz"`.
    - Run `npm install --cache /tmp/empty-cache` -- Sometimes caching causes issues with local files. Using a specific
      and new cache file guarantees that the cache is empty. Also, it might be necessary to delete the 'node_modules'
      folder.
    - You can now run the SPA locally to see if the component works as expected.
    - Run `npm run build` and check if the resulting js files are as expected (i.e. not too large).

## License

`@rio-cloud/rio-user-menu-component` is licensed under the Apache 2.0 license.

                                 Apache License
                           Version 2.0, January 2004
                        http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

   "License" shall mean the terms and conditions for use, reproduction,
   and distribution as defined by Sections 1 through 9 of this document.

   "Licensor" shall mean the copyright owner or entity authorized by
   the copyright owner that is granting the License.

   "Legal Entity" shall mean the union of the acting entity and all
   other entities that control, are controlled by, or are under common
   control with that entity. For the purposes of this definition,
   "control" means (i) the power, direct or indirect, to cause the
   direction or management of such entity, whether by contract or
   otherwise, or (ii) ownership of fifty percent (50%) or more of the
   outstanding shares, or (iii) beneficial ownership of such entity.

   "You" (or "Your") shall mean an individual or Legal Entity
   exercising permissions granted by this License.

   "Source" form shall mean the preferred form for making modifications,
   including but not limited to software source code, documentation
   source, and configuration files.

   "Object" form shall mean any form resulting from mechanical
   transformation or translation of a Source form, including but
   not limited to compiled object code, generated documentation,
   and conversions to other media types.

   "Work" shall mean the work of authorship, whether in Source or
   Object form, made available under the License, as indicated by a
   copyright notice that is included in or attached to the work
   (an example is provided in the Appendix below).

   "Derivative Works" shall mean any work, whether in Source or Object
   form, that is based on (or derived from) the Work and for which the
   editorial revisions, annotations, elaborations, or other modifications
   represent, as a whole, an original work of authorship. For the purposes
   of this License, Derivative Works shall not include works that remain
   separable from, or merely link (or bind by name) to the interfaces of,
   the Work and Derivative Works thereof.

   "Contribution" shall mean any work of authorship, including
   the original version of the Work and any modifications or additions
   to that Work or Derivative Works thereof, that is intentionally
   submitted to Licensor for inclusion in the Work by the copyright owner
   or by an individual or Legal Entity authorized to submit on behalf of
   the copyright owner. For the purposes of this definition, "submitted"
   means any form of electronic, verbal, or written communication sent
   to the Licensor or its representatives, including but not limited to
   communication on electronic mailing lists, source code control systems,
   and issue tracking systems that are managed by, or on behalf of, the
   Licensor for the purpose of discussing and improving the Work, but
   excluding communication that is conspicuously marked or otherwise
   designated in writing by the copyright owner as "Not a Contribution."

   "Contributor" shall mean Licensor and any individual or Legal Entity
   on behalf of whom a Contribution has been received by Licensor and
   subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
   this License, each Contributor hereby grants to You a perpetual,
   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
   copyright license to reproduce, prepare Derivative Works of,
   publicly display, publicly perform, sublicense, and distribute the
   Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
   this License, each Contributor hereby grants to You a perpetual,
   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
   (except as stated in this section) patent license to make, have made,
   use, offer to sell, sell, import, and otherwise transfer the Work,
   where such license applies only to those patent claims licensable
   by such Contributor that are necessarily infringed by their
   Contribution(s) alone or by combination of their Contribution(s)
   with the Work to which such Contribution(s) was submitted. If You
   institute patent litigation against any entity (including a
   cross-claim or counterclaim in a lawsuit) alleging that the Work
   or a Contribution incorporated within the Work constitutes direct
   or contributory patent infringement, then any patent licenses
   granted to You under this License for that Work shall terminate
   as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
   Work or Derivative Works thereof in any medium, with or without
   modifications, and in Source or Object form, provided that You
   meet the following conditions:

   (a) You must give any other recipients of the Work or
   Derivative Works a copy of this License; and

   (b) You must cause any modified files to carry prominent notices
   stating that You changed the files; and

   (c) You must retain, in the Source form of any Derivative Works
   that You distribute, all copyright, patent, trademark, and
   attribution notices from the Source form of the Work,
   excluding those notices that do not pertain to any part of
   the Derivative Works; and

   (d) If the Work includes a "NOTICE" text file as part of its
   distribution, then any Derivative Works that You distribute must
   include a readable copy of the attribution notices contained
   within such NOTICE file, excluding those notices that do not
   pertain to any part of the Derivative Works, in at least one
   of the following places: within a NOTICE text file distributed
   as part of the Derivative Works; within the Source form or
   documentation, if provided along with the Derivative Works; or,
   within a display generated by the Derivative Works, if and
   wherever such third-party notices normally appear. The contents
   of the NOTICE file are for informational purposes only and
   do not modify the License. You may add Your own attribution
   notices within Derivative Works that You distribute, alongside
   or as an addendum to the NOTICE text from the Work, provided
   that such additional attribution notices cannot be construed
   as modifying the License.

   You may add Your own copyright statement to Your modifications and
   may provide additional or different license terms and conditions
   for use, reproduction, or distribution of Your modifications, or
   for any such Derivative Works as a whole, provided Your use,
   reproduction, and distribution of the Work otherwise complies with
   the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
   any Contribution intentionally submitted for inclusion in the Work
   by You to the Licensor shall be under the terms and conditions of
   this License, without any additional terms or conditions.
   Notwithstanding the above, nothing herein shall supersede or modify
   the terms of any separate license agreement you may have executed
   with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
   names, trademarks, service marks, or product names of the Licensor,
   except as required for reasonable and customary use in describing the
   origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
   agreed to in writing, Licensor provides the Work (and each
   Contributor provides its Contributions) on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
   implied, including, without limitation, any warranties or conditions
   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
   PARTICULAR PURPOSE. You are solely responsible for determining the
   appropriateness of using or redistributing the Work and assume any
   risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
   whether in tort (including negligence), contract, or otherwise,
   unless required by applicable law (such as deliberate and grossly
   negligent acts) or agreed to in writing, shall any Contributor be
   liable to You for damages, including any direct, indirect, special,
   incidental, or consequential damages of any character arising as a
   result of this License or out of the use or inability to use the
   Work (including but not limited to damages for loss of goodwill,
   work stoppage, computer failure or malfunction, or any and all
   other commercial damages or losses), even if such Contributor
   has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
   the Work or Derivative Works thereof, You may choose to offer,
   and charge a fee for, acceptance of support, warranty, indemnity,
   or other liability obligations and/or rights consistent with this
   License. However, in accepting such obligations, You may act only
   on Your own behalf and on Your sole responsibility, not on behalf
   of any other Contributor, and only if You agree to indemnify,
   defend, and hold each Contributor harmless for any liability
   incurred by, or claims asserted against, such Contributor by reason
   of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

      To apply the Apache License to your work, attach the following
      boilerplate notice, with the fields enclosed by brackets "[]"
      replaced with your own identifying information. (Don't include
      the brackets!)  The text should be enclosed in the appropriate
      comment syntax for the file format. We also recommend that a
      file or class name and description of purpose be included on the
      same "printed page" as the copyright notice for easier
      identification within third-party archives.

Copyright 2021 TB Digital Services GmbH

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.