n8n-nodes-steyi-ss 1.0.0

package/README.md

@@ -0,0 +1,192 @@
+# n8n-nodes-steyi-ss
+
+An n8n community node for integrating with the Smartsheet API.
+
+## Features
+
+This node provides the following operations:
+
+### Sheet Operations
+- **List Sheets** - Get a list of all sheets in your Smartsheet account
+- **Get Sheet** - Retrieve detailed information about a specific sheet
+- **Create Sheet** - Create a new sheet
+- **Update Sheet** - Update a sheet name
+- **Delete Sheet** - Delete a sheet
+
+### Row Operations
+- **Add Row** - Add a new row to a sheet (with optional discussions, comments, and attachments)
+- **Update Row** - Update an existing row in a sheet (with optional discussions, comments, and attachments)
+- **Delete Row** - Delete a row from a sheet
+
+### Column Operations
+- **Get Columns** - Get all columns from a sheet
+
+### Webhook Operations
+- **List Webhooks** - List all webhooks in your account
+- **Create Webhook** - Create a new webhook for a sheet
+- **Update Webhook** - Update webhook settings (name, enabled status, events)
+- **Delete Webhook** - Delete a webhook
+
+### Webhook Trigger
+- **Smartsheet Trigger** - A trigger node that starts workflows when Smartsheet events occur
+
+## Installation
+
+### Using npm
+
+```bash
+npm install n8n-nodes-steyi-ss
+```
+
+### Manual Installation
+
+1. Clone this repository
+2. Install dependencies:
+   ```bash
+   npm install
+   ```
+3. Build the node:
+   ```bash
+   npm run build
+   ```
+4. Copy the `dist/` directory to your n8n custom nodes directory:
+   ```bash
+   # For n8n installed via npm
+   cp -r dist ~/.n8n/custom/n8n-nodes-steyi-ss/
+   cp package.json ~/.n8n/custom/n8n-nodes-steyi-ss/
+   
+   # Then restart n8n
+   ```
+
+For detailed deployment instructions, see [DEPLOYMENT.md](./DEPLOYMENT.md).
+4. Link the node to your n8n installation:
+   ```bash
+   npm link
+   ```
+5. In your n8n installation directory, link the node:
+   ```bash
+   npm link n8n-nodes-steyi-ss
+   ```
+
+## Configuration
+
+### Credentials
+
+1. Go to your n8n credentials settings
+2. Add a new "Smartsheet API" credential
+3. Enter your Smartsheet API access token
+
+To get your API token:
+1. Log in to Smartsheet
+2. Go to Account → Apps & Integrations → API Access
+3. Generate a new access token
+
+## Usage
+
+### List Sheets
+
+Use this operation to retrieve all sheets in your account. No additional parameters are required.
+
+### Get Sheet
+
+Retrieve detailed information about a specific sheet:
+- **Sheet ID**: The ID of the sheet you want to retrieve
+- **Include** (optional): Additional fields to include (attachments, discussions, format, etc.)
+
+### Get Columns
+
+Get all columns from a specific sheet:
+- **Sheet ID**: The ID of the sheet
+
+### Add Row
+
+Add a new row to a sheet:
+- **Sheet ID**: The ID of the sheet
+- **Cells**: Array of cells with Column ID and Value
+- **To Top** (optional): Whether to add the row to the top of the sheet
+
+### Update Row
+
+Update an existing row:
+- **Sheet ID**: The ID of the sheet
+- **Row ID**: The ID of the row to update
+- **Cells**: Array of cells with Column ID and Value to update
+
+### Delete Row
+
+Delete a row from a sheet:
+- **Sheet ID**: The ID of the sheet
+- **Row ID**: The ID of the row to delete
+
+### Webhook Operations
+
+#### List Webhooks
+List all webhooks in your account. No additional parameters required.
+
+#### Create Webhook
+Create a new webhook for a sheet:
+- **Sheet ID**: The ID of the sheet to monitor
+- **Callback URL**: The publicly accessible URL that Smartsheet will call (see note below)
+- **Webhook Name** (optional): Name for the webhook
+- **Events**: Events to subscribe to (default: all events)
+
+#### Update Webhook
+Update an existing webhook:
+- **Webhook ID**: The ID of the webhook to update
+- **Update Fields**: Fields to update (name, enabled status, events)
+
+#### Delete Webhook
+Delete a webhook:
+- **Webhook ID**: The ID of the webhook to delete
+
+### Webhook Trigger
+
+The Smartsheet Trigger node allows workflows to start automatically when Smartsheet events occur:
+- **Type**: Type of webhook (currently supports Sheet)
+- **Sheet ID**: The ID of the sheet to monitor
+
+**Important Note about Webhooks and Localhost:**
+
+Smartsheet webhooks require a publicly accessible URL. If you're running n8n on localhost, webhooks will return 400 errors because Smartsheet cannot reach your local machine. To use webhooks with a local n8n instance, you need to:
+
+1. **Use a tunneling service** like ngrok:
+   ```bash
+   ngrok http 5678
+   ```
+   Then use the ngrok URL (e.g., `https://abc123.ngrok.io`) as your webhook URL.
+
+2. **Deploy n8n to a public server** or use n8n Cloud.
+
+3. **Configure n8n's WEBHOOK_URL environment variable** to point to your public URL.
+
+For the trigger node, n8n automatically generates the webhook URL, but it must be publicly accessible for Smartsheet to reach it.
+
+## API Documentation
+
+For more information about the Smartsheet API, visit:
+https://smartsheet-platform.github.io/api-docs/
+
+## Development
+
+### Building
+
+```bash
+npm run build
+```
+
+### Linting
+
+```bash
+npm run lint
+```
+
+### Formatting
+
+```bash
+npm run format
+```
+
+## License
+
+MIT
+

package/dist/credentials/SteyiSmartsheetCreds.credentials.d.ts

@@ -0,0 +1,9 @@
+import { IAuthenticateGeneric, ICredentialTestRequest, ICredentialType, INodeProperties } from 'n8n-workflow';
+export declare class SteyiSmartsheetCreds implements ICredentialType {
+    name: string;
+    displayName: string;
+    documentationUrl: string;
+    properties: INodeProperties[];
+    authenticate: IAuthenticateGeneric;
+    test: ICredentialTestRequest;
+}

package/dist/credentials/SteyiSmartsheetCreds.credentials.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SteyiSmartsheetCreds = void 0;
+class SteyiSmartsheetCreds {
+    constructor() {
+        this.name = 'steyiSmartsheetCreds';
+        this.displayName = 'Steyi Smartsheet API';
+        this.documentationUrl = 'https://smartsheet-platform.github.io/api-docs/';
+        this.properties = [
+            {
+                displayName: 'API Token',
+                name: 'apiToken',
+                type: 'string',
+                typeOptions: {
+                    password: true,
+                },
+                default: '',
+                description: 'Your Smartsheet API access token',
+                required: true,
+            },
+        ];
+        this.authenticate = {
+            type: 'generic',
+            properties: {
+                headers: {
+                    Authorization: '=Bearer {{$credentials.apiToken}}',
+                },
+            },
+        };
+        this.test = {
+            request: {
+                baseURL: 'https://api.smartsheet.com/2.0',
+                url: '/users/me',
+            },
+        };
+    }
+}
+exports.SteyiSmartsheetCreds = SteyiSmartsheetCreds;

package/dist/nodes/SteyiSmartsheet/SteyiGenericFunction.d.ts

@@ -0,0 +1,3 @@
+import { IExecuteFunctions } from 'n8n-workflow';
+export declare function smartsheetApiRequest(this: IExecuteFunctions, method: string, endpoint: string, body?: any, itemIndex?: number): Promise<any>;
+export declare function smartsheetFileUpload(this: IExecuteFunctions, endpoint: string, fileName: string, fileData: any, mimeType: string, itemIndex?: number): Promise<any>;

package/dist/nodes/SteyiSmartsheet/SteyiGenericFunction.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.smartsheetFileUpload = exports.smartsheetApiRequest = void 0;
+async function smartsheetApiRequest(method, endpoint, body = {}, itemIndex = 0) {
+    const credentials = await this.getCredentials('steyiSmartsheetCreds');
+    const baseURL = 'https://api.smartsheet.com/2.0';
+    const url = endpoint.startsWith('http') ? endpoint : `${baseURL}${endpoint}`;
+    const options = {
+        method,
+        url,
+        headers: {
+            'Accept': 'application/json',
+            'Authorization': `Bearer ${credentials.apiToken}`,
+        },
+    };
+    if (Object.keys(body).length > 0) {
+        options.headers['Content-Type'] = 'application/json';
+        options.body = body;
+    }
+    return await this.helpers.httpRequest(options);
+}
+exports.smartsheetApiRequest = smartsheetApiRequest;
+async function smartsheetFileUpload(endpoint, fileName, fileData, mimeType, itemIndex = 0) {
+    const credentials = await this.getCredentials('steyiSmartsheetCreds');
+    const baseURL = 'https://api.smartsheet.com/2.0';
+    const url = endpoint.startsWith('http') ? endpoint : `${baseURL}${endpoint}`;
+    // Verify fileData is a Buffer
+    if (!fileData || typeof fileData === 'string') {
+        throw new Error(`Invalid file data. Expected Buffer, got ${typeof fileData}`);
+    }
+    // Get file size from buffer - Buffer.length is already in bytes
+    // This is the raw byte count, not a formatted string like "7.98 MB"
+    const fileSizeInBytes = fileData.length;
+    // Validate file size is a number
+    if (typeof fileSizeInBytes !== 'number' || isNaN(fileSizeInBytes)) {
+        throw new Error(`Invalid file size. Expected number of bytes, got ${typeof fileSizeInBytes}`);
+    }
+    // Smartsheet API expects raw binary data with specific headers (not multipart/form-data)
+    // Format: --data-binary with Content-Type, Content-Disposition, and Content-Length headers
+    // Content-Length must be in bytes (as a string representation of the number)
+    // The endpoint determines if it's a proof (/proofs) or regular attachment (/attachments)
+    const options = {
+        method: 'POST',
+        url,
+        headers: {
+            'Accept': 'application/json',
+            'Authorization': `Bearer ${credentials.apiToken}`,
+            'Content-Type': mimeType,
+            'Content-Disposition': `attachment; filename="${fileName}"`,
+            'Content-Length': fileSizeInBytes.toString(), // Convert number to string (e.g., "8364032" for ~8MB)
+        },
+        body: fileData, // Send raw binary data
+        returnFullResponse: false,
+    };
+    // Use httpRequest for raw binary upload
+    return await this.helpers.httpRequest(options);
+}
+exports.smartsheetFileUpload = smartsheetFileUpload;

package/dist/nodes/SteyiSmartsheet/SteyiSmartsheet.node.d.ts

@@ -0,0 +1,19 @@
+import { IExecuteFunctions, ILoadOptionsFunctions, INodeExecutionData, INodePropertyOptions, INodeType, INodeTypeDescription } from 'n8n-workflow';
+export declare class SteyiSmartsheet implements INodeType {
+    description: INodeTypeDescription;
+    methods: {
+        loadOptions: {
+            getSheets(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]>;
+            getColumns(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]>;
+            getDiscussions(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]>;
+            getWebhooks(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]>;
+            getReports(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]>;
+            getWorkspaces(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]>;
+            getFolders(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]>;
+            getUsers(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]>;
+            getGroups(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]>;
+            getGroupMembers(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]>;
+        };
+    };
+    execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]>;
+}