n8n-nodes-miroapp 1.0.1

package/LICENSE.md

@@ -0,0 +1,19 @@
+Copyright 2022 n8n
+
+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,349 @@
+# n8n-nodes-miroapp  
+
+This is an n8n community node. It lets you interact with Miro in your n8n workflows.  
+
+Miro is a visual collaboration platform where distributed teams work together on an infinite canvas: they run workshops and retrospectives on sticky notes, map processes as diagrams and flowcharts, build mind maps and customer journeys, organise work on cards and in frames, and keep everything in shared boards that can be tagged, grouped and embedded elsewhere.
+
+[n8n](https://n8n.io/) is a [fair-code licensed](https://docs.n8n.io/reference/license/) workflow automation platform.  
+
+[Installation](#installation)  
+[Credentials](#credentials)    
+[Operations](#operations)   
+[Pagination](#pagination)  
+[File uploads](#file-uploads)  
+[No trigger node](#no-trigger-node)  
+[Using as a Tool](#using-as-a-tool)  
+[Compatibility](#compatibility)  
+[Resources](#resources)  
+
+## Installation  
+
+Follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) in the n8n community nodes documentation.  
+
+Alternatively, you can manually install it:  
+
+```sh  
+git clone https://github.com/Elevate-Agency/n8n-nodes-miro.git 
+cd n8n-nodes-miro 
+npm install  
+```  
+
+Then, place the node file in the `~/.n8n/custom-nodes` directory (or follow instructions specific to your n8n installation).   
+
+## Credentials  
+
+This node covers version 2 of the Miro REST API and supports two ways to authenticate.
+
+**Miro API (access token)** — the simplest option, and the default. In Miro, go to *Profile settings → Your apps → Create new app*, grant the app the scopes you need, then use **Install app and get OAuth token** and paste the token into the credential. The token does not expire.
+
+**Miro OAuth2 API** — for the standard authorization code flow. Create an app the same way, add your n8n OAuth callback URL to the app's redirect URIs, then connect the credential. Note that Miro does **not** accept a `scope` parameter on the authorization URL: the permissions granted to the token are the ones ticked on the app's *Permissions* page, so set them there before connecting.
+
+Which scopes you need depends on the operations you call. `boards:read` and `boards:write` cover boards and every item type; the `Governance - *` and `Organization - *` resources need the matching enterprise scopes (`organizations:read`, `organizations:teams:write`, `projects:read`, `auditlogs:read`, `boards:export`, and so on). Each operation's required scope is listed on its page in the [Miro API reference](https://developers.miro.com/reference), and the full list is on [Permission scopes](https://developers.miro.com/reference/scopes).
+
+## Operations  
+
+This node supports the following operations within Miro:  
+* **Apps - Metric**
+    - Gets app metrics
+    - Gets total app metrics
+* **Authentication - Token**
+    - Revokes token
+* **Boards - Board**
+    - Copies board
+    - Creates board
+    - Deletes board
+    - Gets boards
+    - Gets specific board
+    - Updates board
+* **Boards - Export Job**
+    - Creates board export job
+    - Creates task export link
+    - Gets board export job status
+    - Gets board export job tasks list
+    - Gets board export jobs list
+    - Gets results for board export job
+    - Updates board export job status
+* **Boards - Member**
+    - Gets all board members
+    - Gets specific board member
+    - Removes board member
+    - Shares board
+    - Updates board member
+* **Boards - User Group Assignment**
+    - Creates board user group assignments
+    - Deletes board user group assignment
+    - Gets board user group assignments
+* **Governance - AI Interaction Log**
+    - Gets AI interaction logs
+* **Governance - Audit Log**
+    - Gets audit logs
+* **Governance - Board Content Log**
+    - Gets content change logs of board items
+* **Governance - Board Data Classification**
+    - Gets board classification
+    - Updates board classification
+* **Governance - Legal Hold**
+    - Closes case
+    - Closes legal hold
+    - Creates case
+    - Creates legal hold
+    - Edits case
+    - Edits legal hold
+    - Gets all cases
+    - Gets all legal holds within a case
+    - Gets board export jobs of a case
+    - Gets case
+    - Gets content items under legal hold
+    - Gets legal hold information
+* **Governance - Organization Data Classification**
+    - Gets organization settings
+* **Governance - Team Data Classification**
+    - Bulk updates boards classification
+    - Gets team settings
+    - Updates team settings
+* **Governance - User Session**
+    - Resets all sessions of a user
+* **Items - App Card**
+    - Creates app card item
+    - Deletes app card item
+    - Gets app card item
+    - Updates app card item
+* **Items - Card**
+    - Creates card item
+    - Deletes card item
+    - Gets card item
+    - Updates card item
+* **Items - Code Widget**
+    - Creates code widget item
+    - Deletes code widget item
+    - Gets code widget item
+    - Gets code widget items
+    - Moves code widget item
+    - Updates code widget item
+* **Items - Connector**
+    - Creates connector
+    - Deletes connector
+    - Gets connectors
+    - Gets specific connector
+    - Updates connector
+* **Items - Doc Format**
+    - Creates doc format item
+    - Deletes doc format item
+    - Gets doc format item
+* **Items - Document**
+    - Creates document item using file from device
+    - Creates document item using URL
+    - Deletes document item
+    - Gets document item
+    - Updates document item using file from device
+    - Updates document item using URL
+* **Items - Embed**
+    - Creates embed item
+    - Deletes embed item
+    - Gets embed item
+    - Updates embed item
+* **Items - Flowchart Shape**
+    - Creates shape item
+    - Deletes shape item
+    - Gets shape item
+    - Updates shape item
+* **Items - Frame**
+    - Creates frame
+    - Deletes frame
+    - Gets frame
+    - Gets items within frame
+    - Updates frame
+* **Items - Group**
+    - Creates group
+    - Deletes group and its items
+    - Gets a group by its ID
+    - Gets all groups on a board
+    - Gets items of a group by ID
+    - Ungroups items
+    - Updates group with new items
+* **Items - Image**
+    - Creates image item using file from device
+    - Creates image item using URL
+    - Deletes image item
+    - Gets image item
+    - Updates image item using file from device
+    - Updates image item using URL
+* **Items - Item**
+    - Creates items in bulk
+    - Creates items in bulk using file from device
+    - Deletes experimental item
+    - Deletes item
+    - Gets experimental items on board
+    - Gets items on board
+    - Gets specific experimental item on board
+    - Gets specific item on board
+    - Updates item position or parent
+* **Items - Mind Map Node**
+    - Creates mind map node
+    - Deletes mind map node
+    - Gets mind map nodes
+    - Gets specific mind map node
+* **Items - Shape**
+    - Creates shape item
+    - Deletes shape item
+    - Gets shape item
+    - Updates shape item
+* **Items - Sticky Note**
+    - Creates sticky note item
+    - Deletes sticky note item
+    - Gets sticky note item
+    - Updates sticky note item
+* **Items - Tag**
+    - Attaches tag to item
+    - Creates tag
+    - Deletes tag
+    - Gets items by tag
+    - Gets tag
+    - Gets tags from board
+    - Gets tags from item
+    - Removes tag from item
+    - Updates tag
+* **Items - Text**
+    - Creates text item
+    - Deletes text item
+    - Gets text item
+    - Updates text item
+* **Organization - Member**
+    - Gets organization member
+    - Gets organization members
+* **Organization - Organization**
+    - Gets organization info
+* **Organization - Project**
+    - Creates project
+    - Deletes project
+    - Gets project
+    - Gets projects
+    - Updates project
+* **Organization - Project Member**
+    - Adds member in a project
+    - Gets project member
+    - Gets project members
+    - Removes project member
+    - Updates project member
+* **Organization - Project Setting**
+    - Gets project settings
+    - Updates project settings
+* **Organization - Project User Group Assignment**
+    - Creates project user group assignments
+    - Deletes project user group assignment
+    - Gets project user group assignments
+* **Organization - Team**
+    - Creates team
+    - Deletes team
+    - Gets team
+    - Gets teams
+    - Updates team
+* **Organization - Team Member**
+    - Deletes team member from team
+    - Gets team member
+    - Gets team members
+    - Invites team members
+    - Updates team member
+* **Organization - Team Setting**
+    - Gets default team settings
+    - Gets team settings
+    - Updates team settings
+* **Organization - Team User Group**
+    - Creates user group to team connection
+    - Deletes user group to team connection
+    - Gets user group of a team
+    - Gets user group to team connections
+* **Organization - User Group**
+    - Creates user group
+    - Deletes user group
+    - Gets user group
+    - Gets user groups
+    - Updates user group
+* **Organization - User Group Member**
+    - Bulk edits of membership in user group
+    - Creates user group member
+    - Deletes user group member
+    - Gets user group member
+    - Gets user group members
+* **Organization - User Group Team**
+    - Gets teams of a user group
+    - Gets user group team
+
+Retrieve information from the [Miro REST API](https://developers.miro.com/docs/rest-api-reference-guide). 
+
+Resources prefixed `Governance - ` and `Organization - `, plus `Boards - Export Job` and `Boards - User Group Assignment`, call `/v2/orgs/...` endpoints that require a Miro **Enterprise** plan (a few also require Enterprise Guard). Resources marked *experimental* call `/v2-experimental/...` endpoints, which Miro may change or remove without notice.
+
+## Pagination
+
+This node does not paginate for you: it sends exactly one request per input item, so you stay in control of how many API credits you spend. Miro uses two conventions, and both are driven from the **Query Parameters** collection:
+
+- **Cursor** (items, connectors, groups, mind map nodes, code widgets, teams, projects, audit logs, export jobs): set `Limit`, then feed the `cursor` field of the response back into the `Cursor` parameter on the next call. Stop when the response has no `cursor`.
+- **Offset** (`Get Boards`, `Get All Board Members`, `Get Tags from Board`, `Get Items by Tag`): set `Limit` and `Offset`. Stop when `offset + size >= total`.
+
+To collect every page, wrap the node in a loop: a **Loop Over Items** node, or an **If** node testing whether the response still carries a `cursor`, feeding the value back into the Miro node.
+
+## File uploads
+
+Five operations upload a file instead of sending JSON, and expect binary data on the input item:
+
+- `Items - Document → Create Document Item Using File from Device` / `Update Document Item Using File from Device`
+- `Items - Image → Create Image Item Using File from Device` / `Update Image Item Using File from Device`
+- `Items - Item → Create Items in Bulk Using File from Device`
+
+Set **Binary Property** to the name of the binary property holding the file. For the bulk operation, **Binary Property** holds the JSON manifest and **Resource Binary Properties** lists the files to create, up to 20. **Miro rejects uploads larger than 6 MB.**
+
+## No trigger node
+
+There is deliberately no Miro Trigger node. Miro removed its experimental webhooks (`/v2-experimental/webhooks/board_subscriptions`) on 5 December 2025 and has not announced a replacement, so no webhook-based trigger can work today.
+
+To react to changes, poll instead: a **Schedule Trigger** followed by `Boards - Board → Get Boards` with `Sort` set to `Last Modified`, or `Items - Item → Get Items on Board`, comparing against what you saw last run.
+
+## Using as a Tool
+
+This node can be used as a tool in n8n AI Agents. To enable community nodes as tools, you need to set the `N8N_COMMUNITY_PACKAGES_ALLOW_TOOL_USAGE` environment variable to `true`.
+
+### Setting the Environment Variable
+
+**If you're using a bash/zsh shell:**
+```bash
+export N8N_COMMUNITY_PACKAGES_ALLOW_TOOL_USAGE=true
+n8n start
+```
+
+**If you're using Docker:**
+Add to your docker-compose.yml file:
+```yaml
+environment:
+  - N8N_COMMUNITY_PACKAGES_ALLOW_TOOL_USAGE=true
+```
+
+**If you're using the desktop app:**
+Create a `.env` file in the n8n directory:
+```
+N8N_COMMUNITY_PACKAGES_ALLOW_TOOL_USAGE=true
+```
+
+**If you want to set it permanently on Mac/Linux:**
+Add to your `~/.zshrc` or `~/.bash_profile`:
+```bash
+export N8N_COMMUNITY_PACKAGES_ALLOW_TOOL_USAGE=true
+```
+
+## Compatibility  
+
+- Tested with: TBD
+
+The 181 operations have been exercised against the live API: 100 on a Miro developer team,
+the remaining 81 on an Enterprise organization with the Company Admin role.
+
+Two prerequisites sit on your own tenant rather than on the node. The board classification
+operations need at least one data-classification label defined in the organization, which is
+created in the admin console and has no API. The two `Apps - Metric` operations need an app
+management API token from Developer Hub instead of the install token the rest of the node uses.
+
+## Resources  
+
+- [n8n community nodes documentation](https://docs.n8n.io/integrations/community-nodes/)  
+- [Miro REST API documentation](https://developers.miro.com/docs/rest-api-reference-guide)
+- [Miro permission scopes](https://developers.miro.com/reference/scopes)
+- [Miro rate limiting](https://developers.miro.com/reference/rate-limiting)

package/dist/credentials/MiroApi.credentials.d.ts

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

package/dist/credentials/MiroApi.credentials.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MiroApi = void 0;
+class MiroApi {
+    constructor() {
+        this.name = 'miroApi';
+        this.displayName = 'Miro API';
+        this.documentationUrl = 'https://developers.miro.com/docs/getting-started-with-oauth';
+        this.icon = { light: 'file:icons/miro.svg', dark: 'file:icons/miro.dark.svg' };
+        this.properties = [
+            {
+                displayName: 'Miro Access Token',
+                name: 'miroAccessToken',
+                type: 'string',
+                typeOptions: { password: true },
+                default: '',
+                required: true,
+                description: 'Access token of your Miro app installation. Create an app in Miro (Profile settings, Your apps), then use "Install app and get OAuth token"',
+            },
+        ];
+        this.authenticate = {
+            type: 'generic',
+            properties: {
+                headers: {
+                    Accept: 'application/json',
+                    Authorization: '=Bearer {{$credentials.miroAccessToken}}',
+                },
+            },
+        };
+        this.test = {
+            request: {
+                method: 'GET',
+                baseURL: 'https://api.miro.com',
+                url: '/v2/boards',
+                qs: { limit: 1 },
+            },
+        };
+    }
+}
+exports.MiroApi = MiroApi;
+//# sourceMappingURL=MiroApi.credentials.js.map

package/dist/credentials/MiroApi.credentials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MiroApi.credentials.js","sourceRoot":"","sources":["../../credentials/MiroApi.credentials.ts"],"names":[],"mappings":";;;AAQA,MAAa,OAAO;IAApB;QACC,SAAI,GAAG,SAAS,CAAC;QACjB,gBAAW,GAAG,UAAU,CAAC;QACzB,qBAAgB,GAAG,6DAA6D,CAAC;QAGjF,SAAI,GAAS,EAAE,KAAK,EAAE,qBAAqB,EAAE,IAAI,EAAE,0BAA0B,EAAE,CAAC;QAChF,eAAU,GAAsB;YAC/B;gBACC,WAAW,EAAE,mBAAmB;gBAChC,IAAI,EAAE,iBAAiB;gBACvB,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE;gBAC/B,OAAO,EAAE,EAAE;gBACX,QAAQ,EAAE,IAAI;gBACd,WAAW,EACV,6IAA6I;aAC9I;SACD,CAAC;QAKF,iBAAY,GAAyB;YACpC,IAAI,EAAE,SAAS;YACf,UAAU,EAAE;gBACX,OAAO,EAAE;oBACR,MAAM,EAAE,kBAAkB;oBAC1B,aAAa,EAAE,0CAA0C;iBACzD;aACD;SACD,CAAC;QAEF,SAAI,GAA2B;YAC9B,OAAO,EAAE;gBACR,MAAM,EAAE,KAAK;gBACb,OAAO,EAAE,sBAAsB;gBAC/B,GAAG,EAAE,YAAY;gBACjB,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE;aAChB;SACD,CAAC;IACH,CAAC;CAAA;AAzCD,0BAyCC"}

package/dist/credentials/MiroOAuth2Api.credentials.d.ts

@@ -0,0 +1,9 @@
+import { ICredentialType, INodeProperties, Icon } from 'n8n-workflow';
+export declare class MiroOAuth2Api implements ICredentialType {
+    name: string;
+    extends: string[];
+    displayName: string;
+    documentationUrl: string;
+    icon: Icon;
+    properties: INodeProperties[];
+}

package/dist/credentials/MiroOAuth2Api.credentials.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MiroOAuth2Api = void 0;
+class MiroOAuth2Api {
+    constructor() {
+        this.name = 'miroOAuth2Api';
+        this.extends = ['oAuth2Api'];
+        this.displayName = 'Miro OAuth2 API';
+        this.documentationUrl = 'https://developers.miro.com/docs/getting-started-with-oauth';
+        this.icon = { light: 'file:icons/miro.svg', dark: 'file:icons/miro.dark.svg' };
+        this.properties = [
+            {
+                displayName: 'Grant Type',
+                name: 'grantType',
+                type: 'hidden',
+                default: 'authorizationCode',
+            },
+            {
+                displayName: 'Authorization URL',
+                name: 'authUrl',
+                type: 'hidden',
+                default: 'https://miro.com/oauth/authorize',
+            },
+            {
+                displayName: 'Access Token URL',
+                name: 'accessTokenUrl',
+                type: 'hidden',
+                default: 'https://api.miro.com/v1/oauth/token',
+            },
+            {
+                displayName: 'Scope',
+                name: 'scope',
+                type: 'hidden',
+                default: '',
+            },
+            {
+                displayName: 'Auth URI Query Parameters',
+                name: 'authQueryParameters',
+                type: 'hidden',
+                default: '',
+            },
+            {
+                displayName: 'Authentication',
+                name: 'authentication',
+                type: 'hidden',
+                default: 'body',
+            },
+        ];
+    }
+}
+exports.MiroOAuth2Api = MiroOAuth2Api;
+//# sourceMappingURL=MiroOAuth2Api.credentials.js.map

package/dist/credentials/MiroOAuth2Api.credentials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MiroOAuth2Api.credentials.js","sourceRoot":"","sources":["../../credentials/MiroOAuth2Api.credentials.ts"],"names":[],"mappings":";;;AAEA,MAAa,aAAa;IAA1B;QACC,SAAI,GAAG,eAAe,CAAC;QACvB,YAAO,GAAG,CAAC,WAAW,CAAC,CAAC;QACxB,gBAAW,GAAG,iBAAiB,CAAC;QAChC,qBAAgB,GAAG,6DAA6D,CAAC;QAGjF,SAAI,GAAS,EAAE,KAAK,EAAE,qBAAqB,EAAE,IAAI,EAAE,0BAA0B,EAAE,CAAC;QAChF,eAAU,GAAsB;YAC/B;gBACC,WAAW,EAAE,YAAY;gBACzB,IAAI,EAAE,WAAW;gBACjB,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,mBAAmB;aAC5B;YACD;gBACC,WAAW,EAAE,mBAAmB;gBAChC,IAAI,EAAE,SAAS;gBACf,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,kCAAkC;aAC3C;YACD;gBACC,WAAW,EAAE,kBAAkB;gBAC/B,IAAI,EAAE,gBAAgB;gBACtB,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,qCAAqC;aAC9C;YACD;gBAGC,WAAW,EAAE,OAAO;gBACpB,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,EAAE;aACX;YACD;gBACC,WAAW,EAAE,2BAA2B;gBACxC,IAAI,EAAE,qBAAqB;gBAC3B,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,EAAE;aACX;YACD;gBACC,WAAW,EAAE,gBAAgB;gBAC7B,IAAI,EAAE,gBAAgB;gBACtB,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,MAAM;aACf;SACD,CAAC;IACH,CAAC;CAAA;AAhDD,sCAgDC"}

package/dist/credentials/icons/miro.dark.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="24" height="24" role="img" aria-label="Miro"><path fill="#FFD02F" d="M17.392 0H13.9L17 4.808 10.444 0H6.949l3.102 6.3L3.494 0H0l3.05 8.131L0 24h3.494L10.05 6.985 6.949 24h3.494L17 5.494 13.899 24h3.493L24 3.672 17.392 0z"/></svg>

package/dist/credentials/icons/miro.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="24" height="24" role="img" aria-label="Miro"><path fill="#050038" d="M17.392 0H13.9L17 4.808 10.444 0H6.949l3.102 6.3L3.494 0H0l3.05 8.131L0 24h3.494L10.05 6.985 6.949 24h3.494L17 5.494 13.899 24h3.493L24 3.672 17.392 0z"/></svg>

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

@@ -0,0 +1,6 @@
+import { IExecuteFunctions, INodeExecutionData, INodeType, INodeTypeDescription } from 'n8n-workflow';
+export declare class Miro implements INodeType {
+    description: INodeTypeDescription;
+    execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]>;
+}
+export declare function executeItem(this: IExecuteFunctions, i: number): Promise<INodeExecutionData[]>;