@orchesty/connector-zoom 1.0.1 → 2.0.1

package/README.md

@@ -1,28 +1,79 @@
-# [Zoom](https://marketplace.zoom.us/docs/api-reference/zoom-api/)
+# Zoom Connector
 
-## OAuth 2.0
+[![npm](https://img.shields.io/npm/v/@orchesty/connector-zoom?color=15ba68)](https://www.npmjs.com/package/@orchesty/connector-zoom)
+[![License](https://img.shields.io/badge/license-Apache--2.0-15ba68)](https://github.com/Orchesty/orchesty-nodejs-connectors/blob/master/LICENSE)
 
-- Client id
-- Client secret
+An [Orchesty](https://orchesty.io) connector for Zoom, a video communications and team chat platform for sending messages to channels and users.
 
-### How to get
+## Application Type
 
-- Go to [https://marketplace.zoom.us/user/build](https://marketplace.zoom.us/user/build)
+**OAuth 2.0**
 
-### Data example for [ZoomSendMessageConnector](Connector/ZoomSendMessageConnector.ts)
+This connector uses the Zoom OAuth 2.0 authorization flow. After entering your credentials in Orchesty, you will be redirected to Zoom to authorize access.
 
-- `userName` from MongoDb
-- `userId` Zoom user id
-- `toChannel` Zoom channel id
-- `message` Zoom content message
+| Field | Description |
+|---|---|
+| `client_id` | Your Zoom app Client ID |
+| `client_secret` | Your Zoom app Client Secret |
 
-```json
-{
-    "message": "zoom example message",
-    "toChannel": "d87f0b9bd5434d3fb75153a42ddb9ce2",
-    "userId": "d87f0b9bd5434d3fb75153a42ddb9ce2",
-    
-    
-    "userName": "d87f0b9bd5434d3fb75153a42ddb9ce2"
-}
+## Components
+
+| Class | Type | Description |
+|---|---|---|
+| `ZoomSendMessageConnector` | Connector | Sends a chat message to a Zoom channel via `POST /v2/chat/users/{userId}/messages`; requires `userId` and `toChannel` in the input payload |
+
+## Setup
+
+### Credentials
+
+1. Log in to the [Zoom Marketplace](https://marketplace.zoom.us/) and navigate to **Develop → Build App**.
+2. Choose **OAuth** as the app type and create the app.
+3. Under **App Credentials**, copy the **Client ID** and **Client Secret**.
+4. Add the Orchesty redirect URL to the **Redirect URL for OAuth** list.
+5. In Orchesty, open the Zoom application settings, enter both values, and complete the OAuth authorization flow.
+
+### Required Scopes
+
+`chat_message:write:admin`
+
+### API Documentation
+
+Zoom Team Chat API: [https://developers.zoom.us/docs/api/rest/reference/chat/methods/](https://developers.zoom.us/docs/api/rest/reference/chat/methods/)
+
+## Installation & Usage
+
+Install the package:
+
+```bash
+npm install @orchesty/connector-zoom @orchesty/nodejs-sdk
+# or
+pnpm add @orchesty/connector-zoom @orchesty/nodejs-sdk
 ```
+
+Register the application and nodes in your Orchesty DI container:
+
+```typescript
+import { container } from '@orchesty/nodejs-sdk';
+import { OAuth2Provider } from '@orchesty/nodejs-sdk/dist/lib/Authorization/Provider/OAuth2/OAuth2Provider';
+import ZoomApplication from '@orchesty/connector-zoom/dist/ZoomApplication';
+import ZoomSendMessageConnector from '@orchesty/connector-zoom/dist/Connector/ZoomSendMessageConnector';
+
+const app = new ZoomApplication(container.get(OAuth2Provider));
+container.setApplication(app);
+container.setNode(new ZoomSendMessageConnector(), app);
+```
+
+## License
+
+This connector is released under the **Apache License 2.0**. See the [LICENSE](https://github.com/Orchesty/orchesty-nodejs-connectors/blob/master/LICENSE) file for the full license text.
+
+## Contributing
+
+Contributions are welcome! This connector is part of the open-source [Orchesty Node.js Connectors](https://github.com/Orchesty/orchesty-nodejs-connectors) monorepo.
+
+For guidelines on how to create or update connectors — including project setup, coding conventions, and how to write tests — please refer to the **[Contributing to Connectors](https://orchesty.io/community/contributing-to-connectors)** guide.
+
+All contributions should include:
+- Source code in `src/` following the existing connector structure
+- Tests in `src/**/__tests__/` with `input.json`, `mock.json`, and `output.json` fixtures
+- An updated `CHANGELOG.md` entry

package/dist/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@orchesty/connector-zoom",
     "description": "",
-    "version": "1.0.0",
+    "version": "2.0.0",
     "license": "Apache-2.0",
     "url": "https://github.com/Orchesty/orchesty-nodejs-connectors",
     "repository": "https://github.com/Orchesty/orchesty-nodejs-connectors",
@@ -17,7 +17,7 @@
     "keywords": [],
     "author": "info@hanaboso.com",
     "dependencies": {
-        "@orchesty/nodejs-sdk": "^4.3.6"
+        "@orchesty/nodejs-sdk": "^5.0.13"
     },
     "engines": {
         "node": ">=24"

package/package.json

@@ -1,17 +1,20 @@
 {
   "name": "@orchesty/connector-zoom",
   "description": "",
-  "version": "1.0.1",
+  "version": "2.0.1",
   "license": "Apache-2.0",
   "url": "https://github.com/Orchesty/orchesty-nodejs-connectors",
-  "repository": "https://github.com/Orchesty/orchesty-nodejs-connectors",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Orchesty/orchesty-nodejs-connectors"
+  },
   "files": [
     "dist"
   ],
   "keywords": [],
   "author": "info@hanaboso.com",
   "dependencies": {
-    "@orchesty/nodejs-sdk": "^4.3.6"
+    "@orchesty/nodejs-sdk": "^5.0.13"
   },
   "engines": {
     "node": ">=24"