@chili-publish/studio-sdk 0.121.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 CHILI publish
+
+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.

package/README.md

@@ -0,0 +1,89 @@
+# studio-sdk
+
+![Coverage](https://img.shields.io/badge/coverage-96.50%25-brightgreen.svg)
+
+[![Build PR](https://github.com/chili-publish/studio-sdk/actions/workflows/pr-build.yml/badge.svg)](https://github.com/chili-publish/studio-sdk/actions/workflows/pr-build.yml) [![Publish Package](https://github.com/chili-publish/studio-sdk/actions/workflows/publish-package.yml/badge.svg)](https://github.com/chili-publish/studio-sdk/actions/workflows/publish-package.yml)
+
+This is the Open Source CHILI publisher Editor SDK which will make your life easier when you’re working on and integrating the new CHILI publisher Editor.
+
+The project is currently under active development, contributions are welcome in the form of [creating issues](https://github.com/chili-publish/studio-sdk/issues/new/choose) or in the form of actual contributions on the code. See our [CONTRIBUTING.md](https://github.com/chili-publish/studio-sdk/blob/develop/CONTRIBUTING.md) file to get started on your first contribution.
+
+## Alpha Program
+
+To integrate and start using the SDK, you need to be aware of our Alpha program, reach out to your contact @chili to receive more information. Once accepted, you will receive the needed credentials / way of authenticating to configure and setup the SDK on your integration.
+
+## Deprecation of old NPM package
+
+Due to a rename of the project, to align more with the product suite that is being offered, the old NPM package (editor-sdk) will be deprecated and a fresh package will be created called @chili-publish/studio-sdk.
+To update your existing projects, just simply rename the package and do a fresh npm or yarn install.
+
+## Documentation
+
+[Link to functional documentation and getting started](https://docs.chiligrafx.com)
+
+[Link to the official SDK documentation on GitHub](https://chili-publish.github.io/studio-sdk/)\*
+
+\*Note: the hosted documentation is always based on the latest version. To get the documentation of the release that you use, you can download the sourcecode of that release and open `/docs/index.html`.
+
+## Overview
+
+This repository includes the studio-sdk, the SDK is used to plugin to the CHILI publisher API and will handle the communication between integrations (workspace, etc) and editor engine.
+
+The goal for the SDK is to be as lightweight as possible. We don’t want to store state in here, that would be hard to maintain and keep in sync with the engine. In general the SDK is an abstraction layer for the editor engine, providing a fixed API for the integrators, and flexibility for the engine to evolve.
+
+Conceptually you can think of the SDK - Editor Engine relation as a client - server relation. The SDK will issue requests to the engine and expects a certain result. The other way around the analogy with WebSockets could be used to define how data flows from the engine to the SDK (and eventually consumers of the SDK).
+
+![architecture diagram](https://user-images.githubusercontent.com/956362/155481965-1d2fe57b-11ec-4327-bbc3-5b4e03a01f28.png)
+
+## Getting started
+
+There are 2 ways of getting the SDK.
+
+### NPM (with TS support)
+
+The most easy approach would be installing it using a package manager like `npm` or `yarn` just do:
+
+```bash
+npm install --save @chili-publish/studio-sdk
+```
+
+or
+
+```bash
+yarn add @chili-publish/studio-sdk
+```
+
+Then you can easily import the SDK in your JS and TS files, but also the typing is included with this approach.
+
+```typescript
+// TS example
+import EditorSDK from '@chili-publish/studio-sdk';
+import type { Variable } from '@chili-publish/studio-sdk';
+```
+
+### Load script
+
+The other way would be to include the sdk using the script tag just before the closure. of the body.
+
+```html
+<script src="https://path/to/sdk/latest/main.js"></script>
+```
+
+To really get started, there is a nice guide on [the official documentation page](https://chili-publish.github.io/studio-sdk/).
+And you can find basic integration examples in [one of our other repositories](https://github.com/chili-publish/studio-sdk-integration-examples).
+
+## Build documentation
+
+After installing all dependencies, you're able to build the typedoc documentation. You only need to run the following command
+
+```bash
+npx typedoc --hideBreadcrumbs
+```
+
+## Feedback?
+
+If you have any feedback on the technical parts of the application, a feature request, a bug to report or a general technical question, don’t hesitate to [create a new issue](https://github.com/chili-publish/studio-sdk/issues/new/choose).
+
+## License
+
+This project is [MIT licensed](https://github.com/chili-publish/studio-sdk/blob/develop/LICENSE)