n8n-nodes-shortio 0.1.1 → 1.0.1

package/README.md

@@ -1,78 +1,150 @@
 # Table of Contents
+
 - [Table of Contents](#table-of-contents)
 - [Overview of Community Short.io n8n Node](#overview-of-community-shortio-n8n-node)
-- [If you want a custom node](#if-you-want-a-custom-node)
 - [Bugs/Contributing/Feature Request](#bugscontributingfeature-request)
 - [Documentation](#documentation)
-	- [Installation](#installation)
-	- [Credentials](#credentials)
-	- [Links](#links)
-		- [List Links](#list-links)
-		- [Get Link Info](#get-link-info)
-		- [Create Link](#create-link)
-		- [Update Existing Link](#update-existing-link)
-		- [Delete Link](#delete-link)
+  - [Installation](#installation)
+  - [Credentials](#credentials)
+  - [Links](#links)
+    - [List Links](#list-links)
+    - [Get Link Info](#get-link-info)
+    - [Create Link](#create-link)
+    - [Update Existing Link](#update-existing-link)
+    - [Delete Link](#delete-link)
+    - [Generate QR For Link](#generate-qr-for-link)
+  - [Statistics](#statistics)
+    - [Get Link Statistics](#get-link-statistics)
+    - [Get Domain Statistics](#get-domain-statistics)
 
 # Overview of Community Short.io n8n Node
-I have no affiliation with short.io beyond being a user.
-
-I created this node for use within my company as well as for our clients. I left out a few features, but I included the options for them so people can see what is possible. Feel free to submit a PR with the updated functionality, or get in touch to discuss us completing it.
 
-# If you want a custom node
-Please reach out to me using the info on [my GitHub page](https://github.com/liamdmcgarrigle).  \
-Nodes can be built for the community as well as privately just for one organization.
+I have no affiliation with short.io beyond being a user. I work for n8n but this is not an official node.
 
 # Bugs/Contributing/Feature Request
 
 If you have a bug to report or a feature request, please [submit a GitHub issue](https://github.com/liamdmcgarrigle/n8n-nodes-shortio/issues/new) with as much detail as you're able to give.
 
-Feel free to submit PRs, but please get in touch with me first to make sure I am willing to add the feature before you spend the time on it.
-
 # Documentation
 
 ## Installation
 
-This can only be installed if you are self-hosting n8n.
+This is now available on cloud as a verified community node. Simply search for shortio in the node panel.
 
-Follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) in the n8n community nodes documentation.
+Or follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) in the n8n community nodes documentation.
 
 ## Credentials
 
 To use this node you will need to set up short.io credentials with a key from short.io. You also will need an account and may need a paid account.
 
 1. Go to https://app.short.io/settings/integrations/api-key and click on "Create API Key"
-![Screenshot1](/readme_files/step-1.jpeg)
+   ![Screenshot1](/readme_files/step-1.jpeg)
 
 2. Add a description, pick the domain to use, and press "Create"
-![Screenshot2](/readme_files/step-2.jpeg)
+   ![Screenshot2](/readme_files/step-2.jpeg)
 
 3. Copy your new token. It will only be shown once
 
 4. Go to the credential page in n8n, in add credentials add "Short.io API", then paste in your token. Then add the domain you chose in the previous step and press save
-![Screenshot3](/readme_files/step-3.png)
+   ![Screenshot3](/readme_files/step-3.png)
 
 ## Links
 
 ### List Links
-Get a list of your short links. These will only be links from the domain in your credential. 
 
-You will need to choose how many results are returned. Anything over 150 is automatically paginationed. 
+Get a list of your short links. These will only be links from the domain in your credential.
+
+You will need to choose how many results are returned. Anything over 150 is automatically paginationed.
 
 You can filter the results by adding:
-Before date: returns links before the listed date
-After date: returns links after the listed date
-Date Sort Order: changes the order the links are in based on the date
+
+- **Before date**: returns links before the listed date
+- **After date**: returns links after the listed date
+- **Date Sort Order**: changes the order the links are in based on the date
 
 ### Get Link Info
-Get link details from the domain in your credential and the path.
 
+Get link details from the domain in your credential and the path.
 
 ### Create Link
-Create a link. There are many options. Please see the descriptions I added to n8n's interface.
+
+Create a link. There are many options available in the additional fields:
+
+- **Path**: Custom path for the short link
+- **Folder**: Assign the link to a folder (select from list or enter folder ID)
+- **Allow Duplicates**: Allow multiple links with the same original URL
+- **Title**: Title shown in the short.io admin panel
+- **Expiration settings**: Set expiry date and redirect URL for expired links
+- **Device-specific URLs**: Separate URLs for iPhone and Android users
+- **Cloaking**: Hide the original URL in the browser address bar
+- **Redirect Type**: Choose HTTP redirect code (301, 302, etc.)
+- **Password**: Password-protect the link (requires Personal plan)
+- **UTM Parameters**: Add tracking parameters (source, medium, campaign, term, content)
+- **Tags**: Add tags to organize your links
 
 ### Update Existing Link
-You can update an existing short link by using the path or the link `idString`. 
-You can change anything about the link including the full long URL.
+
+You can update an existing short link by using the path or the link `idString`.
+You can change anything about the link including the full long URL and folder assignment.
 
 ### Delete Link
-You can delete an existing short link by using the path or the link `idString`. 
+
+You can delete an existing short link by using the path or the link `idString`.
+
+### Generate QR For Link
+
+Generate a QR code image for any short link. You can identify the link by path or `idString`.
+
+Options available:
+
+- **Color**: QR code foreground color
+- **Background Color**: QR code background color
+- **Size**: QR code size (1-99)
+- **Type**: Image format (PNG or SVG)
+
+The operation returns binary data that can be used with other n8n nodes (e.g., save to file, send via email, upload to cloud storage).
+
+## Statistics
+
+Get detailed analytics for your links and domain.
+
+### Get Link Statistics
+
+Get detailed statistics for a specific link. Identify the link by path or `idString`.
+
+**Period options:**
+
+- Today
+- Yesterday
+- Last 7 Days
+- Last 30 Days
+- Last Month
+- All Time
+- Custom (specify start and end dates)
+
+**Additional options:**
+
+- **Clicks Chart Interval**: Data granularity for the clicks chart (hour, day, week, month)
+- **Skip Top Records**: Skip top records like referer, browser, and country breakdowns
+
+Returns detailed statistics including total clicks, human clicks, click trends, and breakdowns by referer, browser, country, and more.
+
+### Get Domain Statistics
+
+Get detailed statistics for your entire domain (as configured in your credentials).
+
+**Period options:**
+
+- Today
+- Yesterday
+- Last 7 Days
+- Last 30 Days
+- Last Month
+- All Time
+- Custom (specify start and end dates)
+
+**Additional options:**
+
+- **Clicks Chart Interval**: Data granularity for the clicks chart (hour, day, week, month)
+
+Returns domain-wide statistics including total clicks, link counts, clicks per link averages, and breakdowns by referer, browser, country, and more.

package/dist/nodes/Shortio/Descriptions/LinkDescription.d.ts

@@ -1,3 +1,3 @@
-import { INodeProperties } from "n8n-workflow";
+import { INodeProperties } from 'n8n-workflow';
 export declare const linkOperations: INodeProperties[];
 export declare const linkFields: INodeProperties[];

package/dist/nodes/Shortio/Descriptions/LinkDescription.js

@@ -42,9 +42,7 @@ exports.linkOperations = [
         default: 'getLinkList',
         displayOptions: {
             show: {
-                resource: [
-                    'links',
-                ]
+                resource: ['links'],
             },
         },
     },
@@ -63,13 +61,9 @@ exports.linkFields = [
         description: 'The number of domains that will be returned',
         displayOptions: {
             show: {
-                resource: [
-                    'links',
-                ],
-                operation: [
-                    'getLinkList'
-                ]
-            }
+                resource: ['links'],
+                operation: ['getLinkList'],
+            },
         },
     },
     {
@@ -80,13 +74,9 @@ exports.linkFields = [
         placeholder: 'Add Field',
         displayOptions: {
             show: {
-                resource: [
-                    'links',
-                ],
-                operation: [
-                    'getLinkList'
-                ]
-            }
+                resource: ['links'],
+                operation: ['getLinkList'],
+            },
         },
         options: [
             {
@@ -118,26 +108,22 @@ exports.linkFields = [
                     },
                 ],
                 default: 'asc',
-            }
+            },
         ],
     },
     {
         displayName: 'Path',
         name: 'path',
-        description: "The path of the link",
+        description: 'The path of the link',
         type: 'string',
         required: true,
         default: '',
-        placeholder: "6fzQYy",
+        placeholder: '6fzQYy',
         displayOptions: {
             show: {
-                resource: [
-                    'links',
-                ],
-                operation: [
-                    'getLinkInfo'
-                ]
-            }
+                resource: ['links'],
+                operation: ['getLinkInfo'],
+            },
         },
     },
     {
@@ -146,16 +132,12 @@ exports.linkFields = [
         type: 'string',
         required: true,
         default: '',
-        placeholder: "https://iAmALongURL.com",
+        placeholder: 'https://iAmALongURL.com',
         displayOptions: {
             show: {
-                resource: [
-                    'links',
-                ],
-                operation: [
-                    'createLink'
-                ]
-            }
+                resource: ['links'],
+                operation: ['createLink'],
+            },
         },
     },
     {
@@ -166,37 +148,33 @@ exports.linkFields = [
         placeholder: 'Add Field',
         displayOptions: {
             show: {
-                resource: [
-                    'links',
-                ],
-                operation: [
-                    'createLink'
-                ]
-            }
+                resource: ['links'],
+                operation: ['createLink'],
+            },
         },
         options: [
             {
                 displayName: 'Path',
                 name: 'path',
-                description: "The path of the link",
+                description: 'The path of the link',
                 type: 'string',
                 default: '',
-                placeholder: "6fzQYy",
+                placeholder: '6fzQYy',
             },
             {
                 displayName: 'Allow Duplicates',
                 name: 'allowDuplicates',
-                description: "Whether you can create multiple links with the same original URL",
+                description: 'Whether you can create multiple links with the same original URL',
                 type: 'boolean',
                 default: false,
             },
             {
                 displayName: 'Title',
                 name: 'title',
-                description: "Title of created URL to be shown in short.io admin panel",
+                description: 'Title of created URL to be shown in short.io admin panel',
                 type: 'string',
                 default: '',
-                placeholder: "Short Link From n8n",
+                placeholder: 'Short Link From n8n',
             },
             {
                 displayName: 'Expires At (Unix Miliseconds)',
@@ -214,31 +192,31 @@ exports.linkFields = [
             {
                 displayName: 'Expired URL',
                 name: 'expiredURL',
-                description: "URL to redirect when the link is expired",
+                description: 'URL to redirect when the link is expired',
                 type: 'string',
                 default: '',
-                placeholder: "https://example.com/expired",
+                placeholder: 'https://example.com/expired',
             },
             {
                 displayName: 'iphone URL',
                 name: 'iphoneURL',
-                description: "If users open the URL with iPhone, they will be redirected to this URL",
+                description: 'If users open the URL with iPhone, they will be redirected to this URL',
                 type: 'string',
                 default: '',
-                placeholder: "https://iAmALongURL.com",
+                placeholder: 'https://iAmALongURL.com',
             },
             {
                 displayName: 'Android URL',
                 name: 'androidURL',
-                description: "If users open the URL with Android, they will be redirected to this URL",
+                description: 'If users open the URL with Android, they will be redirected to this URL',
                 type: 'string',
                 default: '',
-                placeholder: "https://iAmALongURL.com",
+                placeholder: 'https://iAmALongURL.com',
             },
             {
                 displayName: 'Cloaking',
                 name: 'cloaking',
-                description: "Whether the link will be cloaked. Cloaked links will redirect to the original URL, but will not show the original URL in the browser address bar.",
+                description: 'Whether the link will be cloaked. Cloaked links will redirect to the original URL, but will not show the original URL in the browser address bar.',
                 type: 'boolean',
                 default: false,
             },
@@ -282,13 +260,13 @@ exports.linkFields = [
             {
                 displayName: 'Password',
                 name: 'password',
-                description: "Requires Personal plan. Password to be asked when user visits a link. This password will not be stored in plain text, we will hash it with salt.",
+                description: 'Requires Personal plan. Password to be asked when user visits a link. This password will not be stored in plain text, we will hash it with salt.',
                 type: 'string',
                 typeOptions: {
-                    password: true
+                    password: true,
                 },
                 default: '',
-                placeholder: "Password123!",
+                placeholder: 'Password123!',
             },
             {
                 displayName: 'Deletes At (Unix Miliseconds)',
@@ -296,43 +274,43 @@ exports.linkFields = [
                 description: "The date and time when the link will delete in unix miliseconds. If not set, link will never expire. Unlike expiresAt the link will be deleted and won't be counted in account link limit. TTL can not be earlier than 1 week from the current time.",
                 type: 'string',
                 default: '',
-                placeholder: "1714442044236",
+                placeholder: '1714442044236',
             },
             {
                 displayName: 'UTM Source',
                 name: 'utmSource',
-                description: "The referrer: (e.g. google, newsletter)",
+                description: 'The referrer: (e.g. google, newsletter)',
                 type: 'string',
                 default: '',
-                placeholder: "Google",
+                placeholder: 'Google',
             },
             {
                 displayName: 'UTM Medium',
                 name: 'utmMedium',
-                description: "Marketing medium: (e.g. cpc, banner, email)",
+                description: 'Marketing medium: (e.g. cpc, banner, email)',
                 type: 'string',
                 default: '',
-                placeholder: "banner_ad",
+                placeholder: 'banner_ad',
             },
             {
                 displayName: 'UTM Campaign',
                 name: 'utmCampaign',
-                description: "Product, promo code, or slogan (e.g. spring_sale)",
+                description: 'Product, promo code, or slogan (e.g. spring_sale)',
                 type: 'string',
                 default: '',
-                placeholder: "spring_sale",
+                placeholder: 'spring_sale',
             },
             {
                 displayName: 'UTM Term',
                 name: 'utmTerm',
-                description: "Identify the paid keywords",
+                description: 'Identify the paid keywords',
                 type: 'string',
                 default: '',
             },
             {
                 displayName: 'UTM Content',
                 name: 'utmContent',
-                description: "Use to differentiate ads",
+                description: 'Use to differentiate ads',
                 type: 'string',
                 default: '',
             },
@@ -358,7 +336,7 @@ exports.linkFields = [
                         ],
                     },
                 ],
-            }
+            },
         ],
     },
     {
@@ -385,13 +363,9 @@ exports.linkFields = [
         ],
         displayOptions: {
             show: {
-                resource: [
-                    'links',
-                ],
-                operation: [
-                    'updateExistingLink'
-                ]
-            }
+                resource: ['links'],
+                operation: ['updateExistingLink'],
+            },
         },
     },
     {
@@ -399,16 +373,12 @@ exports.linkFields = [
         name: 'originalURL',
         type: 'string',
         default: '',
-        placeholder: "https://iAmALongURL.com",
+        placeholder: 'https://iAmALongURL.com',
         displayOptions: {
             show: {
-                resource: [
-                    'links',
-                ],
-                operation: [
-                    'updateExistingLink'
-                ]
-            }
+                resource: ['links'],
+                operation: ['updateExistingLink'],
+            },
         },
     },
     {
@@ -419,37 +389,33 @@ exports.linkFields = [
         placeholder: 'Add Field',
         displayOptions: {
             show: {
-                resource: [
-                    'links',
-                ],
-                operation: [
-                    'updateExistingLink'
-                ]
-            }
+                resource: ['links'],
+                operation: ['updateExistingLink'],
+            },
         },
         options: [
             {
                 displayName: 'Path',
                 name: 'path',
-                description: "The path of the link",
+                description: 'The path of the link',
                 type: 'string',
                 default: '',
-                placeholder: "6fzQYy",
+                placeholder: '6fzQYy',
             },
             {
                 displayName: 'Allow Duplicates',
                 name: 'allowDuplicates',
-                description: "Whether you can create multiple links with the same original URL",
+                description: 'Whether you can create multiple links with the same original URL',
                 type: 'boolean',
                 default: false,
             },
             {
                 displayName: 'Title',
                 name: 'title',
-                description: "Title of created URL to be shown in short.io admin panel",
+                description: 'Title of created URL to be shown in short.io admin panel',
                 type: 'string',
                 default: '',
-                placeholder: "Short Link From n8n",
+                placeholder: 'Short Link From n8n',
             },
             {
                 displayName: 'Expires At (Unix Miliseconds)',
@@ -467,31 +433,31 @@ exports.linkFields = [
             {
                 displayName: 'Expired URL',
                 name: 'expiredURL',
-                description: "URL to redirect when the link is expired",
+                description: 'URL to redirect when the link is expired',
                 type: 'string',
                 default: '',
-                placeholder: "https://example.com/expired",
+                placeholder: 'https://example.com/expired',
             },
             {
                 displayName: 'iphone URL',
                 name: 'iphoneURL',
-                description: "If users open the URL with iPhone, they will be redirected to this URL",
+                description: 'If users open the URL with iPhone, they will be redirected to this URL',
                 type: 'string',
                 default: '',
-                placeholder: "https://iAmALongURL.com",
+                placeholder: 'https://iAmALongURL.com',
             },
             {
                 displayName: 'Android URL',
                 name: 'androidURL',
-                description: "If users open the URL with Android, they will be redirected to this URL",
+                description: 'If users open the URL with Android, they will be redirected to this URL',
                 type: 'string',
                 default: '',
-                placeholder: "https://iAmALongURL.com",
+                placeholder: 'https://iAmALongURL.com',
             },
             {
                 displayName: 'Cloaking',
                 name: 'cloaking',
-                description: "Whether the link will be cloaked. Cloaked links will redirect to the original URL, but will not show the original URL in the browser address bar.",
+                description: 'Whether the link will be cloaked. Cloaked links will redirect to the original URL, but will not show the original URL in the browser address bar.',
                 type: 'boolean',
                 default: false,
             },
@@ -535,13 +501,13 @@ exports.linkFields = [
             {
                 displayName: 'Password',
                 name: 'password',
-                description: "Requires Personal plan. Password to be asked when user visits a link. This password will not be stored in plain text, we will hash it with salt.",
+                description: 'Requires Personal plan. Password to be asked when user visits a link. This password will not be stored in plain text, we will hash it with salt.',
                 type: 'string',
                 typeOptions: {
-                    password: true
+                    password: true,
                 },
                 default: '',
-                placeholder: "Password123!",
+                placeholder: 'Password123!',
             },
             {
                 displayName: 'Deletes At (Unix Miliseconds)',
@@ -549,43 +515,43 @@ exports.linkFields = [
                 description: "The date and time when the link will delete in unix miliseconds. If not set, link will never expire. Unlike expiresAt the link will be deleted and won't be counted in account link limit. TTL can not be earlier than 1 week from the current time.",
                 type: 'string',
                 default: '',
-                placeholder: "1714442044236",
+                placeholder: '1714442044236',
             },
             {
                 displayName: 'UTM Source',
                 name: 'utmSource',
-                description: "The referrer: (e.g. google, newsletter)",
+                description: 'The referrer: (e.g. google, newsletter)',
                 type: 'string',
                 default: '',
-                placeholder: "Google",
+                placeholder: 'Google',
             },
             {
                 displayName: 'UTM Medium',
                 name: 'utmMedium',
-                description: "Marketing medium: (e.g. cpc, banner, email)",
+                description: 'Marketing medium: (e.g. cpc, banner, email)',
                 type: 'string',
                 default: '',
-                placeholder: "banner_ad",
+                placeholder: 'banner_ad',
             },
             {
                 displayName: 'UTM Campaign',
                 name: 'utmCampaign',
-                description: "Product, promo code, or slogan (e.g. spring_sale)",
+                description: 'Product, promo code, or slogan (e.g. spring_sale)',
                 type: 'string',
                 default: '',
-                placeholder: "spring_sale",
+                placeholder: 'spring_sale',
             },
             {
                 displayName: 'UTM Term',
                 name: 'utmTerm',
-                description: "Identify the paid keywords",
+                description: 'Identify the paid keywords',
                 type: 'string',
                 default: '',
             },
             {
                 displayName: 'UTM Content',
                 name: 'utmContent',
-                description: "Use to differentiate ads",
+                description: 'Use to differentiate ads',
                 type: 'string',
                 default: '',
             },
@@ -611,7 +577,7 @@ exports.linkFields = [
                         ],
                     },
                 ],
-            }
+            },
         ],
     },
     {
@@ -638,13 +604,9 @@ exports.linkFields = [
         ],
         displayOptions: {
             show: {
-                resource: [
-                    'links',
-                ],
-                operation: [
-                    'deleteLink'
-                ]
-            }
+                resource: ['links'],
+                operation: ['deleteLink'],
+            },
         },
     },
 ];