@interopio/desktop 6.0.0

package/package.json

@@ -0,0 +1,74 @@
+{
+    "name": "@interopio/desktop",
+    "description": "JavaScript library for io.Connect Desktop clients.",
+    "version": "6.0.0",
+    "main": "dist/desktop.umd.js",
+    "module": "dist/desktop.es.js",
+    "browser": "dist/desktop.browser.js",
+    "types": "./desktop.d.ts",
+    "homepage": "https://interop.io/",
+    "keywords": [
+        "glue",
+        "glue42",
+        "desktop",
+        "interop",
+        "context"
+    ],
+    "scripts": {
+        "eslint": "eslint -c .eslintrc.js ./src/**/*.ts ./desktop.d.ts",
+        "eslint:fix": "eslint --fix -c .eslintrc.js ./src/**/*.ts",
+        "validate-changelog": "node ./build/validate-config.js",
+        "docs": "typedoc --options typedoc.json ./src",
+        "auditPackage": "npm audit --registry=https://registry.npmjs.com",
+        "postinstall": "npm i @interopio/workspaces-api@latest",
+        "prepublishOnly": "npm i && npm run validate-changelog && npm run auditPackage && npm run test && npm run build",
+        "test": "npm run build:tests && mocha ./tests/ --recursive --exit",
+        "test:only": "mocha ./tests/ --recursive --exit",
+        "publish:beta": "npm publish --tag beta",
+        "prebuild": "npm run eslint && tsc -p ./tsconfig.json",
+        "build": "npm run prebuild && rollup -c",
+        "build:gd": "npm run prebuild && rollup --config rollup.config.gd.js",
+        "build:tests": "tsc -p ./tsconfig.test.json"
+    },
+    "author": {
+        "name": "interop.io",
+        "url": "https://interop.io/"
+    },
+    "license": "MIT",
+    "dependencies": {
+        "@glue42/schemas": "^3.22.0",
+        "@interopio/core": "^6.0.2",
+        "@interopio/workspaces-api": "^3.0.2",
+        "callback-registry": "^2.7.1",
+        "shortid": "2.2.8"
+    },
+    "devDependencies": {
+        "@glue42/gateway-ws": "^3.0.13-beta.3",
+        "@rollup/plugin-replace": "^2.3.4",
+        "@types/chai": "^4.2.9",
+        "@types/json-stable-stringify": "1.0.32",
+        "@types/mocha": "5.2.7",
+        "@types/node": "12.11.1",
+        "@types/shortid": "0.0.29",
+        "@typescript-eslint/eslint-plugin": "^5.60.1",
+        "@typescript-eslint/parser": "^5.60.1",
+        "chai": "4.1.0",
+        "eslint": "^8.43.0",
+        "eslint-plugin-jsdoc": "^46.4.0",
+        "eslint-plugin-prefer-arrow": "^1.2.3",
+        "husky": "^8.0.3",
+        "mocha": "^9.1.3",
+        "rollup": "^2.79.1",
+        "rollup-plugin-commonjs": "^10.1.0",
+        "rollup-plugin-json": "^4.0.0",
+        "rollup-plugin-node-resolve": "^5.2.0",
+        "rollup-plugin-terser": "^7.0.2",
+        "rollup-plugin-typescript2": "^0.23.0",
+        "typescript": "^4.9.5"
+    },
+    "husky": {
+        "hooks": {
+            "pre-commit": "npm run build"
+        }
+    }
+}

package/readme.md

@@ -0,0 +1,56 @@
+# io.Connect Desktop JavaScript Library
+
+The [`@interopio/desktop`](https://www.npmjs.com/package/@interopio/desktop)` library enables web apps to participate in **io.Connect Desktop** and use io.Connect functionalities via a set of APIs.
+
+## Features
+
+The io.Connect Desktop library includes the following APIs:
+
+- App Management API - manage and monitor interop-enabled apps and their instances;
+- App Preferences API - store custom user-specific data and retrieve it when necessary;
+- Intents API - raise requests for other apps to handle predefined actions (Intents), register apps as Intent handlers, provide users programmatically with options for handling raised Intents via the Intents Resolver UI app;
+- Data sharing:
+    - Shared Contexts API - create, update and track named data objects shared by all interop-enabled apps;
+    - Channels API - globally accessed named shared contexts that allow users to dynamically group apps from an UI, instructing them to work over the same shared data object;
+    - Interop API - offer and consume functionality from other interop-enabled apps by registering Interop methods and streams;
+    - Pub/Sub API - basic API that allows apps to publish and subscribe for messages on a specific topic;
+- Windows:
+    - Window Management API - create and manipulate various types of io.Connect windows;
+    - Layouts API - save and restore the arrangement of any set of apps running in io.Connect Desktop;
+    - Themes API - control the available io.Connect themes programmatically;
+- Notifications API - raise notifications, handle notification and action clicks via Interop methods, control the Notification Panel and subscribe for notification events;
+- Metrics API - assess the life cycle of a certain process (app performance, business process, employee productivity, and more) by acquiring, recording and monitoring specific data over time;
+- Hotkeys API - register key combinations and receive notifications when a key combination is pressed by the user, regardless of whether the app is on focus or not;
+- Displays API - capture programmatically screenshots of the available monitors, of windows and window groups;
+- Cookies API - enables web apps to manage cookies;
+
+For more information, see the **io.Connect Desktop** [documentation](https://docs.interop.io/desktop/).
+
+## Usage
+
+The [`@interopio/desktop`](https://www.npmjs.com/package/@interopio/desktop) library attaches a factory function called `IODesktop()` to the global `window` object. Call the factory function to initialize the library and access the io.Connect functionalities from the returned API object:
+
+```javascript
+import IODesktop from "@interopio/desktop";
+
+const io = await IODesktop();
+```
+
+Optionally, provide a configuration object for the library initialization. The following example demonstrates enabling the Channels API, which is disabled by default, and additionally initializing the io.Connect Workspaces API:
+
+```javascript
+import IODesktop from "@interopio/desktop";
+import IOWorkspaces from "@interopio/workspaces-api";
+
+const config = {
+    channels: true,
+    libraries: [IOWorkspaces]
+};
+
+const io = await IODesktop(config);
+
+// Accessing the io.Connect APIs.
+const allChannelNames = await io.channels.all();
+
+await io.workspaces.restoreWorkspace("My Workspace");
+```