feat: 🎸 Login plugin

Author: Ondřej Baše

Diff for: packages/plugin-login/.npmignore

@@ -0,0 +1,17 @@
+/src
+/coverage
+.babelrc
+.eslintrc.js
+.gitignore
+.npmignore
+.npmrc
+.prettierignore
+.travis.yml
+.DS_Store
+README.md
+CHANGELOG.md
+commitlint.config.js
+rollup.config.js
+babel.config.js
+jest.config.js
+setupJest.js

Diff for: packages/plugin-login/.npmrc

@@ -0,0 +1 @@
+registry = "https://registry.npmjs.org/"

Diff for: packages/plugin-login/CHANGELOG.md

@@ -0,0 +1,7 @@
+Copyright 2023 Miroslav Jancarik [email protected]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Diff for: packages/plugin-login/LICENSE

@@ -0,0 +1,77 @@
+# Merkur - plugin-login
+
+[![Build Status](https://github.com/mjancarik/merkur/workflows/CI/badge.svg)](https://travis-ci.com/mjancarik/merkur)
+[![NPM package version](https://img.shields.io/npm/v/@merkur/plugin-login/latest.svg)](https://www.npmjs.com/package/@merkur/plugin-login)
+![npm bundle size (scoped version)](https://img.shields.io/bundlephobia/minzip/@merkur/plugin-login/latest)
+[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
+
+The Login plugin adds `login` property to your widget with the `listenToUserEvents` and `unlistenUserEvents` methods. On the server side, these methods do nothing. It has two dependencies: [API Login JS library version 3+](https://gitlab.seznam.net/rus/login/-/wikis/widget#js-api-knihovny) and Merkur Session Storage plugin.
+
+## About Merkur
+
+The [Merkur](https://merkur.js.org/) is tiny extensible javascript library for front-end microservices. It allows by default server side rendering for loading performance boost. You can connect it with other frameworks or languages because merkur defines easy API. You can use one of four predefined template's library [Preact](https://preactjs.com/), [µhtml](https://github.com/WebReflection/uhtml#readme), [Svelte](https://svelte.dev/) and [vanilla](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals) but you can easily extend for others.
+
+## Installation
+
+We must import `loginPlugin` and register it to `$plugins` property of the widget. We also need to install the Session Storage plugin ([documentation for @merkur/plugin-session-storage](https://merkur.js.org/docs/session-storage-plugin)).
+
+```javascript
+// ./src/widget.js
+import { loginPlugin } from '@merkur/plugin-login';
+
+export const widgetProperties = {
+  name,
+  version,
+  $plugins: [loginPlugin],
+  // ... other properties
+};
+
+// ./src/polyfill.js
+import 'whatwg-fetch';
+import 'abort-controller/polyfill';
+```
+
+## Methods
+
+### `listenToUserEvents`
+
+- `userApiCall` - `function`
+- `[listener]` - `function` (optional)
+
+The `listenToUserEvents` method returns an array of listeners bounded to user events (`badge`, `login`, `logout` and `forget`). This method binds the original listener to user events. If we omit listener parameter, it will use a default implementation, which will try to load a user data from `sessionStorage` cache or from an API using `userApiCall` function (which is a required parameter of this method). A loaded user object will be saved in the widget state under the `user` key with these properties:
+- `isLoggedIn` - `boolean`
+- `isVerified` - `boolean`
+- `firstname` - `string`
+- `lastname` - `string`
+
+If you want to implement a custom event listener, it will receive these values as arguments in this specific order:
+- `widget` - `object`
+- `userApiCall` - `function`
+- `event` - `string` (an event name)
+- `eventData` - `*` (an event data)
+
+```javascript
+// widget.userService.user() is our custom function which loads an user data from and API
+let listeners = widget.login.listenToUserEvents(widget.userService.user);
+```
+
+### `unlistenUserEvents`
+- `listeners` - `function[]`
+
+The `unlistenUserEvents` method unbinds listeners which where previously bounded using `listenToUserEvents` method.
+
+```javascript
+let listeners = widget.login.listenToUserEvents(widget.userService.user);
+
+widget.login.unlistenUserEvents(listeners)
+```
+
+### `openLoginWindow`
+
+The `openLoginWindow` opens a login window.
+
+```javascript
+if (!widget.state.user.isLoggedIn) {
+    widget.login.openLoginWindow();
+}
+```

Diff for: packages/plugin-login/README.md

@@ -0,0 +1,3 @@
+module.exports = {
+  plugins: ['@babel/plugin-transform-modules-commonjs'],
+};

Diff for: packages/plugin-login/babel.config.js

@@ -0,0 +1,3 @@
+const defaultConfig = require('../../jest.config.js');
+
+module.exports = { ...defaultConfig };

Diff for: packages/plugin-login/jest.config.js

@@ -0,0 +1,57 @@
+{
+  "name": "@merkur/plugin-login",
+  "version": "0.0.9",
+  "description": "Merkur Login.",
+  "main": "lib/index",
+  "module": "lib/index",
+  "unpkg": "lib/index.umd.js",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "import": "./lib/index.mjs",
+      "require": "./lib/index.cjs"
+    },
+    "./lib/index.es9.mjs": "./lib/index.es9.mjs",
+    "./lib/index.es9.cjs": "./lib/index.es9.cjs"
+  },
+  "browser": {
+    "./lib/index.js": "./lib/index.js",
+    "./lib/index.cjs": "./lib/index.cjs",
+    "./lib/index.mjs": "./lib/index.mjs",
+    "./lib/index.es9.mjs": "./lib/index.es9.mjs"
+  },
+  "scripts": {
+    "preversion": "npm test",
+    "test": "jest --no-watchman -c ./jest.config.js",
+    "test:es:version": "es-check es11 ./lib/index.mjs --module && es-check es9 ./lib/index.es9.mjs --module && es-check es9 ./lib/index.es9.cjs --module",
+    "build": "rollup -c rollup.config.mjs",
+    "prepare": "npm run build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mjancarik/merkur.git"
+  },
+  "keywords": [
+    "merkur",
+    "plugin",
+    "microservices",
+    "microfrontends"
+  ],
+  "author": "Ondřej Baše",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/mjancarik/merkur/issues"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "homepage": "https://merkur.js.org/",
+  "devDependencies": {
+    "@merkur/core": "^0.31.0"
+  },
+  "peerDependencies": {
+    "@merkur/core": "*"
+  },
+  "dependencies": {}
+}

Diff for: packages/plugin-login/package.json

@@ -0,0 +1,11 @@
+import {
+  createRollupESConfig,
+  createRollupES9Config,
+  createRollupUMDConfig,
+} from '../../createRollupConfig.mjs';
+
+let esConfig = createRollupESConfig();
+let es9Config = createRollupES9Config();
+let umdConfig = createRollupUMDConfig();
+
+export default [esConfig, es9Config, umdConfig];