@orchesty/connector-google-sheet 1.0.2 → 2.0.0

package/README.md

@@ -1,22 +1,77 @@
-# [Google Sheet](https://developers.google.com/sheets/api/reference/rest)
+# Google Sheets Connector
 
-## OAuth 2.0
+[![npm](https://img.shields.io/npm/v/@orchesty/connector-google-sheet?color=15ba68)](https://www.npmjs.com/package/@orchesty/connector-google-sheet)
+[![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 Google Sheets, a web-based spreadsheet application that enables users to create, edit, and collaborate on spreadsheets in real time.
 
-### How to get
+## Application Type
 
-- Go to [Google console](https://console.cloud.google.com/apis/api/sheets.googleapis.com/credentials)
+**OAuth 2.0**
 
-### Example data for create sheet
+This connector uses Google OAuth 2.0 with the `auth/spreadsheets` scope. After entering your credentials in Orchesty, you will be redirected to Google to authorize access.
 
-```json
-{
-  "data": "A1,B1,C1\nA2,B2,C2",  
-  "name": "Name of file",  
-  "userName": "asdrvt15e21as51ce"
-}
+| Field | Description |
+|---|---|
+| `client_id` | OAuth Client ID from the Google Cloud Console |
+| `client_secret` | OAuth Client Secret from the Google Cloud Console |
+
+## Components
+
+| Class | Type | Description |
+|---|---|---|
+| `GoogleSheetCreateSpreadsheetConnector` | Connector | Creates a new Google Sheets spreadsheet with an initial sheet populated from a 2D data array via `POST /v4/spreadsheets` |
+
+## Setup
+
+### Credentials
+
+1. Go to the [Google Cloud Console](https://console.cloud.google.com) and open your project.
+2. Navigate to **APIs & Services → Credentials**.
+3. Create an **OAuth 2.0 Client ID** (type: Web application).
+4. Add the Orchesty OAuth callback URL to **Authorized redirect URIs**.
+5. Copy the **Client ID** and **Client Secret**.
+6. Enable the **Google Sheets API** under **APIs & Services → Library**.
+7. In Orchesty, open the Google Sheets application settings, enter the credentials, and complete the OAuth authorization flow.
+
+### API Documentation
+
+Google Sheets REST API: [https://developers.google.com/sheets/api/reference/rest](https://developers.google.com/sheets/api/reference/rest)
+
+## Installation & Usage
+
+Install the package:
+
+```bash
+npm install @orchesty/connector-google-sheet @orchesty/nodejs-sdk
+# or
+pnpm add @orchesty/connector-google-sheet @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 GoogleSheetApplication from '@orchesty/connector-google-sheet/dist/GoogleSheetApplication';
+import GoogleSheetCreateSpreadsheetConnector from '@orchesty/connector-google-sheet/dist/Connector/GoogleSheetCreateSpreadsheetConnector';
+
+const app = new GoogleSheetApplication(container.get(OAuth2Provider));
+container.setApplication(app);
+container.setNode(new GoogleSheetCreateSpreadsheetConnector(), 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-google-sheet",
     "description": "",
-    "version": "1.0.1",
+    "version": "1.0.2",
     "license": "Apache-2.0",
     "url": "https://github.com/Orchesty/orchesty-nodejs-connectors",
     "repository": "https://github.com/Orchesty/orchesty-nodejs-connectors",
@@ -18,7 +18,7 @@
     "author": "info@hanaboso.com",
     "dependencies": {
         "@orchesty/connector-google-common": "workspace:*",
-        "@orchesty/nodejs-sdk": "^4.3.6"
+        "@orchesty/nodejs-sdk": "^5.0.8"
     },
     "engines": {
         "node": ">=24"

package/package.json

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