@staffbase/plugins-client-sdk 2.0.0-beta.1 → 2.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@staffbase/plugins-client-sdk",
-  "version": "2.0.0-beta.1",
+  "version": "2.0.1",
   "description": "Staffbase plugins client SDK for JavaScript",
   "main": "dist/plugins-client-sdk.js",
   "module": "dist/plugins-client-sdk.esm.js",
@@ -16,7 +16,7 @@
     "lint-code": "yarn eslint src test",
     "lint-size": "yarn size-limit",
     "fix": "eslint --fix 'src/**/*.js' 'test/**/*.js'",
-    "doc": "mkdir -p doc && yarn jsdoc2md src/main.js > doc/api.md",
+    "doc": "mkdir -p doc && yarn --silent jsdoc2md src/main.js > doc/api.md",
     "release": "semantic-release"
   },
   "repository": "https://github.com/Staffbase/plugins-client-sdk.git",
@@ -51,45 +51,45 @@
     }
   ],
   "dependencies": {
-    "jsdoc": "^4.0.0",
+    "jsdoc": "^4.0.2",
     "loglevel": "^1.8.1",
     "object.entries-ponyfill": "1.0.1"
   },
   "devDependencies": {
-    "@amanda-mitchell/semantic-release-npm-multiple": "3.6.0",
-    "@babel/core": "7.20.12",
+    "@amanda-mitchell/semantic-release-npm-multiple": "3.7.0",
+    "@babel/core": "7.21.0",
     "@babel/plugin-external-helpers": "^7.18.6",
-    "@babel/plugin-transform-runtime": "7.19.6",
+    "@babel/plugin-transform-runtime": "7.21.0",
     "@babel/preset-env": "^7.20.2",
-    "@babel/register": "^7.18.9",
-    "@babel/runtime": "^7.20.13",
-    "@commitlint/cli": "17.4.2",
-    "@commitlint/config-conventional": "17.4.2",
+    "@babel/register": "^7.21.0",
+    "@babel/runtime": "^7.21.0",
+    "@commitlint/cli": "17.4.4",
+    "@commitlint/config-conventional": "17.4.4",
     "@rollup/plugin-babel": "6.0.3",
     "@rollup/plugin-commonjs": "24.0.1",
     "@rollup/plugin-node-resolve": "15.0.1",
     "@rollup/plugin-strip": "3.0.2",
-    "@rollup/plugin-terser": "^0.3.0",
-    "@size-limit/preset-small-lib": "8.1.2",
+    "@rollup/plugin-terser": "^0.4.0",
+    "@size-limit/preset-small-lib": "8.2.4",
     "@tmware/semantic-release-npm-github-publish": "^1.5.5",
-    "babel-jest": "29.3.1",
+    "babel-jest": "29.5.0",
     "babel-plugin-istanbul": "^6.1.1",
     "compare-versions": "^5.0.3",
-    "eslint": "^8.32.0",
-    "eslint-config-prettier": "^8.6.0",
+    "eslint": "^8.35.0",
+    "eslint-config-prettier": "^8.7.0",
     "eslint-plugin-prettier": "^4.2.1",
     "husky": "^8.0.3",
-    "jest": "29.3.1",
-    "jest-environment-jsdom": "^29.3.1",
-    "jest-extended": "3.2.3",
+    "jest": "29.5.0",
+    "jest-environment-jsdom": "^29.5.0",
+    "jest-extended": "3.2.4",
     "jsdoc-to-markdown": "^8.0.0",
-    "prettier": "^2.8.3",
+    "prettier": "^2.8.4",
     "regenerator-runtime": "0.13.11",
-    "rollup": "^3.10.1",
+    "rollup": "^3.18.0",
     "rollup-plugin-license": "3.0.1",
     "rollup-plugin-serve": "2.0.2",
     "rollup-plugin-strip-logger": "0.4.1",
     "rollup-plugin-template-html": "0.0.3",
-    "size-limit": "^8.1.2"
+    "size-limit": "^8.2.4"
   }
 }

package/README.md

@@ -1,65 +0,0 @@
-# plugins-client-sdk 
-
-[![Build Status](https://github.com/Staffbase/plugins-client-sdk/workflows/Continuous%20Integration/badge.svg?branch=master)](https://github.com/Staffbase/plugins-client-sdk/actions)
-[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
-[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
-
-If you are developing your own plugin for your Staffbase app you may want your plugin to communicate with our clients.
-In order to make this possible we implemented a Javascript based API and communication layer for all our apps.
-We want to provide a library to help you improve your plugin functionality.
-This SDK provides the basic functionality to get information provided by the Staffbase app to your plugin and trigger application events.
-
-## Installation
-
-We provide our Plugin Client SDK via [npm](https://www.npmjs.com/package/@staffbase/plugins-client-sdk). 
-Thus, you can just use yarn for installation:
-
-```
-yarn add @staffbase/plugins-client-sdk
-```
-
-
-## API Reference
-
-Please look into our [API documentation](https://github.com/Staffbase/plugins-client-sdk/blob/master/doc/api.md)
-
-## Usage
-
-Please look into our [Usage documentation](https://github.com/Staffbase/plugins-client-sdk/blob/master/doc/usage.md)
-
-
-## Contribution
-
-- Fork it
-- Create a branch `git checkout -b feature-description`
-- Put your name into AUTHORS.txt
-- Commit your changes
-    - As this repository is commitizen friendly you may use `yarn git-cz` to create a commit
-    - Your commit message is validated with a husky managed githook
-- Push to the branch `git push origin feature-description`
-- Open a Pull Request
-
-
-## Running Tests
-
-To run the tests a simple `# yarn jest` command in the root directory will suffice.
-
-## License
-
-Copyright 2018 Staffbase GmbH.
-
-Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0
-
-
-<table>
-  <tr>
-    <td>
-      <img src="docs/assets/images/staffbase.png" alt="Staffbase GmbH" width="96" />
-    </td>
-    <td>
-      <b>Staffbase GmbH</b>
-      <br />Staffbase is an internal communications platform built to revolutionize the way you work and unite your company. Staffbase is hiring: <a href="https://jobs.staffbase.com" target="_blank" rel="noreferrer">jobs.staffbase.com</a>
-      <br /><a href="https://github.com/Staffbase" target="_blank" rel="noreferrer">GitHub</a> | <a href="https://staffbase.com/" target="_blank" rel="noreferrer">Website</a> | <a href="https://jobs.staffbase.com" target="_blank" rel="noreferrer">Jobs</a>
-    </td>
-  </tr>
-</table>