staffbase / plugins-client-sdk Goto Github PK

Staffbase plugins client SDK for JavaScript

License: Apache License 2.0

JavaScript 63.60% Shell 0.11% HTML 36.29%

plugins-client-sdk's Introduction

plugins-client-sdk

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. Thus, you can just use yarn for installation:

yarn add @staffbase/plugins-client-sdk

API Reference

Please look into our API documentation

Usage

Please look into our Usage documentation

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

Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0

Staffbase GmbH
Staffbase is an internal communications platform built to revolutionize the way you work and unite your company. Staffbase is hiring: jobs.staffbase.com
GitHub | Website | Jobs

plugins-client-sdk's People

Contributors

Stargazers

Watchers

Forkers

kraiz bukra-xhamxhiu

plugins-client-sdk's Issues

feature request: access camera stream

Plugins for Staffbase are technically plain html5 web app. That's great - we love the web. It provide so many APIs. For 2 of our plugins there's already great potential for accessing the camera stream - usually done via MediaDevice-API. For example we like to provide QR-Code scanning (display the camera stream, continuously analyze and augment it with visual feedback).

I wonder if it's just the Iframe's Feature-Policy that need to be touched on Staffbase side.

@staffbase/create-widget not existing and not working

I was trying to create custom widget using your recommended guide https://developers.staffbase.com/frameworks/customwidget-development/#prerequisites and it always fails on creation. Also the create-widget repository is either not visible or does not exist.

Description

Project creation fails with NodeJS error

Expected Behavior

Custom widget should be created I assume

Actual Behavior

Nothing

Possible Fix

Steps to Reproduce

run npx @staffbase/create-widget

Context

Your Environment

Version used: latest
Browser Name and version: N/A
App version: N/A
Operating System and version (desktop or mobile): multiple computers, Win10/Linux
Npm version: all above 8.x.x
Link to your project:

The automated release is failing 🚨

🚨 The automated release from the `undefined` branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you could benefit from your bug fixes and new features.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can resolve this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the undefined branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here is some links that can help you:

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

The push permission to the Git repository is required.

semantic-release cannot push the version tag to the branch beta on remote Git repository with URL https://[secure]@github.com/Staffbase/plugins-client-sdk.git.

Please refer to the authentication configuration documentation to configure the Git credentials on your CI environment and make sure the repositoryUrl is configured with a valid Git URL.

Good luck with your project ✨

Your semantic-release bot 📦🚀