n8n-nodes-userpilot 1.0.0

package/COMMERCIAL_LICENSE.md

@@ -0,0 +1,31 @@
+# Commercial License
+
+Velocity BPA, LLC offers commercial licenses for its n8n community nodes.
+
+## When a Commercial License Is Required
+
+A commercial license is required if you:
+- Use this node within a SaaS, PaaS, or hosted platform that is sold or monetized
+- Offer this node as part of a managed services or consulting engagement
+- Bundle or redistribute this node with a paid product
+- Resell, sublicense, or white-label this node
+- Embed this node into a commercial automation or integration platform
+
+## What the Commercial License Provides
+
+- Legal authorization for commercial deployment
+- Organization-wide usage rights
+- Rights to deploy across multiple environments
+- Optional priority support and maintenance
+- Optional custom development or feature extensions
+
+## Licensing Model
+
+Licenses are issued on a per-organization basis.
+
+Enterprise, OEM, and platform licensing terms are available upon request.
+
+## Contact
+
+Email: licensing@velobpa.com  
+Website: https://velobpa.com

package/LICENSE

@@ -0,0 +1,46 @@
+Business Source License 1.1
+
+License text copyright (c) 2017 MariaDB Corporation Ab.
+
+Licensor:
+Velocity BPA, LLC
+https://velobpa.com
+
+Licensed Work:
+This repository and all source code, documentation, and associated artifacts
+contained herein, including all n8n community nodes published by Velocity BPA.
+
+Additional Use Grant:
+You may use, modify, and run the Licensed Work free of charge for:
+- Personal use
+- Educational use
+- Research use
+- Internal business use, provided such use does not involve resale,
+  redistribution, or offering the Licensed Work as part of a commercial
+  product or service.
+
+Commercial Use Restriction:
+Commercial Use of the Licensed Work is prohibited without a valid
+Commercial License issued by the Licensor.
+
+Commercial Use includes, but is not limited to:
+- Use of the Licensed Work within any Software-as-a-Service (SaaS),
+  Platform-as-a-Service (PaaS), or hosted application that is sold,
+  licensed, or monetized in any form
+- Offering the Licensed Work as part of a managed services engagement
+- Bundling or redistributing the Licensed Work with a paid product
+- Reselling, sublicensing, or white-labeling the Licensed Work
+- Embedding the Licensed Work into any commercial automation platform,
+  integration product, or solution offering
+
+Change Date:
+January 1, 2030
+
+Change License:
+Apache License, Version 2.0
+
+For commercial licensing inquiries:
+licensing@velobpa.com
+
+Business Source License 1.1 full text:
+https://mariadb.com/bsl11/

package/LICENSING_FAQ.md

@@ -0,0 +1,18 @@
+## Licensing FAQ
+
+### Is internal SaaS infrastructure considered internal use?
+No. If the infrastructure supports a revenue-generating service,
+it is considered commercial use.
+
+### What if customers never see the node?
+Visibility is irrelevant. Revenue enablement constitutes commercial use.
+
+### What if we are a startup?
+Startups are commercial entities and require a commercial license.
+
+### What if we only use one workflow?
+Scope does not change license requirements.
+
+### Do proof-of-concepts require a license?
+Internal, non-customer-facing POCs are permitted.
+Production SaaS deployments require a license.

package/README.md

@@ -0,0 +1,186 @@
+# n8n-nodes-userpilot
+
+> **NOTICE:** This software is licensed under the Business Source License 1.1 (BSL-1.1).  
+> Commercial use requires a separate commercial license from Velocity BPA.  
+> Contact: licensing@velobpa.com
+
+This is an n8n community node for [UserPilot](https://userpilot.com/), the product growth and user onboarding platform.
+
+UserPilot helps product teams increase user adoption through targeted in-app experiences, surveys, and analytics without code changes.
+
+## Installation
+
+Follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) in the n8n community nodes documentation.
+
+## Credentials
+
+To use this node, you need a UserPilot API token:
+
+1. Log in to your UserPilot account
+2. Navigate to Settings > Environment Page
+3. Copy your API Token (also called Write Token)
+4. Create credentials in n8n using this token
+
+For Enterprise/EU deployments, you can specify a custom endpoint URL.
+
+## Supported Resources (12)
+
+### User
+- **Identify** - Identify or create a user
+- **Update** - Update user properties
+- **Get** - Get user details
+- **Delete** - Delete a user
+- **List** - List all users
+- **Search** - Search users by property
+- **Bulk Update** - Batch update multiple users
+- **Bulk Import** - Import users from CSV
+- **Get Events** - Get user event history
+- **Get Flows** - Get user flow interactions
+- **Merge** - Merge duplicate users
+
+### Company
+- **Identify** - Identify or create a company
+- **Update** - Update company properties
+- **Get** - Get company details
+- **Delete** - Delete a company
+- **List** - List all companies
+- **Search** - Search companies by property
+- **Bulk Update** - Batch update multiple companies
+- **Get Users** - Get users in company
+- **Get Analytics** - Get company engagement data
+
+### Event
+- **Track** - Track a custom event
+- **Bulk Track** - Batch track multiple events
+- **Bulk Import** - Import events from CSV
+- **List Definitions** - List all tracked event types
+- **Get Definition** - Get event type details
+- **Create Definition** - Define a new event type
+- **Get Analytics** - Get event metrics
+
+### Flow
+- **List** - List all flows
+- **Get** - Get flow details
+- **Create** - Create a new flow
+- **Update** - Update flow settings
+- **Delete** - Delete a flow
+- **Trigger** - Trigger a flow for a user
+- **Publish** - Publish a flow
+- **Unpublish** - Unpublish a flow
+- **Get Analytics** - Get flow metrics
+- **Duplicate** - Clone a flow
+
+### NPS Survey
+- **List** - List all NPS surveys
+- **Get** - Get NPS survey details
+- **Create** - Create an NPS survey
+- **Update** - Update NPS settings
+- **Delete** - Delete an NPS survey
+- **Get Responses** - Get NPS responses
+- **Publish** - Publish a survey
+- **Unpublish** - Unpublish a survey
+- **Get Analytics** - Get NPS trends
+- **Export Data** - Export NPS data
+
+### Checklist
+- **List** - List all checklists
+- **Get** - Get checklist details
+- **Create** - Create a checklist
+- **Update** - Update a checklist
+- **Delete** - Delete a checklist
+- **Publish** - Publish a checklist
+- **Unpublish** - Unpublish a checklist
+- **Get Analytics** - Get completion metrics
+- **Get User Progress** - Get user checklist progress
+
+### Resource Center
+- **Get** - Get resource center config
+- **Update** - Update resource center
+- **List Modules** - List resource center modules
+- **Create Module** - Create a module
+- **Update Module** - Update a module
+- **Delete Module** - Delete a module
+- **Reorder Modules** - Reorder modules
+- **Get Module Analytics** - Get module engagement
+
+### Segment
+- **List** - List all segments
+- **Get** - Get segment details
+- **Create** - Create a segment
+- **Update** - Update a segment
+- **Delete** - Delete a segment
+- **Get Users** - Get users in segment
+- **Get Size** - Get segment member count
+
+### Data Export
+- **Create** - Create an export job
+- **Get Status** - Check export status
+- **Download** - Download export file
+- **List** - List export jobs
+- **Cancel** - Cancel pending export
+
+### Job
+- **Get Status** - Get job status
+- **List** - List recent jobs
+- **Cancel** - Cancel pending job
+- **Retry** - Retry failed job
+- **Get Errors** - Get job error details
+
+### Spotlight
+- **List** - List all spotlights
+- **Get** - Get spotlight details
+- **Create** - Create a spotlight
+- **Update** - Update a spotlight
+- **Delete** - Delete a spotlight
+- **Publish** - Publish a spotlight
+- **Unpublish** - Unpublish a spotlight
+- **Get Analytics** - Get spotlight metrics
+
+### Banner
+- **List** - List all banners
+- **Get** - Get banner details
+- **Create** - Create a banner
+- **Update** - Update a banner
+- **Delete** - Delete a banner
+- **Publish** - Publish a banner
+- **Unpublish** - Unpublish a banner
+- **Get Analytics** - Get banner metrics
+
+## Trigger Node
+
+The **UserPilot Trigger** node listens for webhook events:
+
+- `user.identified` - New user identified
+- `user.updated` - User properties changed
+- `event.tracked` - Custom event tracked
+- `flow.started` - User started flow
+- `flow.completed` - User completed flow
+- `flow.dismissed` - User dismissed flow
+- `nps.submitted` - NPS response received
+- `checklist.completed` - Checklist completed
+- `checklist.item.completed` - Checklist item completed
+- `segment.entered` - User entered segment
+- `segment.exited` - User exited segment
+
+Configure webhooks in your UserPilot dashboard pointing to the webhook URL provided by n8n.
+
+## Rate Limits
+
+- Real-time API: Standard HTTP rate limiting
+- Bulk operations: 1,200 rows per minute
+- File upload: Max 50 MB, 10,000 rows
+
+## Resources
+
+- [UserPilot Documentation](https://docs.userpilot.com/)
+- [n8n Community Nodes](https://docs.n8n.io/integrations/community-nodes/)
+
+## License
+
+This project is licensed under the Business Source License 1.1 (BSL-1.1).
+
+**For commercial use, you must obtain a commercial license from Velocity BPA.**
+
+See [LICENSE](LICENSE), [COMMERCIAL_LICENSE.md](COMMERCIAL_LICENSE.md), and [LICENSING_FAQ.md](LICENSING_FAQ.md) for details.
+
+Contact: licensing@velobpa.com

package/dist/credentials/UserPilotApi.credentials.d.ts

@@ -0,0 +1,10 @@
+import type { IAuthenticateGeneric, ICredentialTestRequest, ICredentialType, INodeProperties } from 'n8n-workflow';
+export declare class UserPilotApi implements ICredentialType {
+    name: string;
+    displayName: string;
+    documentationUrl: string;
+    properties: INodeProperties[];
+    authenticate: IAuthenticateGeneric;
+    test: ICredentialTestRequest;
+}
+//# sourceMappingURL=UserPilotApi.credentials.d.ts.map

package/dist/credentials/UserPilotApi.credentials.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"UserPilotApi.credentials.d.ts","sourceRoot":"","sources":["../../credentials/UserPilotApi.credentials.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EACV,oBAAoB,EACpB,sBAAsB,EACtB,eAAe,EACf,eAAe,EAChB,MAAM,cAAc,CAAC;AAEtB,qBAAa,YAAa,YAAW,eAAe;IAClD,IAAI,SAAkB;IACtB,WAAW,SAAmB;IAC9B,gBAAgB,SAAiC;IAEjD,UAAU,EAAE,eAAe,EAAE,CAoB3B;IAEF,YAAY,EAAE,oBAAoB,CAOhC;IAEF,IAAI,EAAE,sBAAsB,CAM1B;CACH"}

package/dist/credentials/UserPilotApi.credentials.js

@@ -0,0 +1,54 @@
+"use strict";
+/*
+ * Copyright (c) Velocity BPA, LLC
+ * Licensed under the Business Source License 1.1
+ * Commercial use requires a separate commercial license.
+ * See LICENSE file for details.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserPilotApi = void 0;
+class UserPilotApi {
+    constructor() {
+        this.name = 'userPilotApi';
+        this.displayName = 'UserPilot API';
+        this.documentationUrl = 'https://docs.userpilot.com/';
+        this.properties = [
+            {
+                displayName: 'API Token',
+                name: 'apiToken',
+                type: 'string',
+                typeOptions: {
+                    password: true,
+                },
+                default: '',
+                required: true,
+                description: 'Your UserPilot API Token. Found in Environment Page in your UserPilot application.',
+            },
+            {
+                displayName: 'Custom Endpoint (Optional)',
+                name: 'endpoint',
+                type: 'string',
+                default: '',
+                placeholder: 'https://analytex.userpilot.io',
+                description: 'Custom endpoint URL for Enterprise/EU deployments. Leave empty to use the default endpoint.',
+            },
+        ];
+        this.authenticate = {
+            type: 'generic',
+            properties: {
+                headers: {
+                    Authorization: '=Token {{$credentials.apiToken}}',
+                },
+            },
+        };
+        this.test = {
+            request: {
+                baseURL: '={{$credentials.endpoint || "https://analytex.userpilot.io"}}',
+                url: '/v1/users',
+                method: 'GET',
+            },
+        };
+    }
+}
+exports.UserPilotApi = UserPilotApi;
+//# sourceMappingURL=UserPilotApi.credentials.js.map

package/dist/credentials/UserPilotApi.credentials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UserPilotApi.credentials.js","sourceRoot":"","sources":["../../credentials/UserPilotApi.credentials.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AASH,MAAa,YAAY;IAAzB;QACE,SAAI,GAAG,cAAc,CAAC;QACtB,gBAAW,GAAG,eAAe,CAAC;QAC9B,qBAAgB,GAAG,6BAA6B,CAAC;QAEjD,eAAU,GAAsB;YAC9B;gBACE,WAAW,EAAE,WAAW;gBACxB,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE;oBACX,QAAQ,EAAE,IAAI;iBACf;gBACD,OAAO,EAAE,EAAE;gBACX,QAAQ,EAAE,IAAI;gBACd,WAAW,EAAE,oFAAoF;aAClG;YACD;gBACE,WAAW,EAAE,4BAA4B;gBACzC,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,EAAE;gBACX,WAAW,EAAE,+BAA+B;gBAC5C,WAAW,EAAE,6FAA6F;aAC3G;SACF,CAAC;QAEF,iBAAY,GAAyB;YACnC,IAAI,EAAE,SAAS;YACf,UAAU,EAAE;gBACV,OAAO,EAAE;oBACP,aAAa,EAAE,kCAAkC;iBAClD;aACF;SACF,CAAC;QAEF,SAAI,GAA2B;YAC7B,OAAO,EAAE;gBACP,OAAO,EAAE,+DAA+D;gBACxE,GAAG,EAAE,WAAW;gBAChB,MAAM,EAAE,KAAK;aACd;SACF,CAAC;IACJ,CAAC;CAAA;AA3CD,oCA2CC"}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './credentials/UserPilotApi.credentials';
+export * from './nodes/UserPilot/UserPilot.node';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAOA,cAAc,wCAAwC,CAAC;AACvD,cAAc,kCAAkC,CAAC"}

package/dist/index.js

@@ -0,0 +1,25 @@
+"use strict";
+/*
+ * Copyright (c) Velocity BPA, LLC
+ * Licensed under the Business Source License 1.1
+ * Commercial use requires a separate commercial license.
+ * See LICENSE file for details.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./credentials/UserPilotApi.credentials"), exports);
+__exportStar(require("./nodes/UserPilot/UserPilot.node"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;;;;;;;;;;;;;AAEH,yEAAuD;AACvD,mEAAiD"}

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

@@ -0,0 +1,6 @@
+import type { IExecuteFunctions, INodeExecutionData, INodeType, INodeTypeDescription } from 'n8n-workflow';
+export declare class UserPilot implements INodeType {
+    description: INodeTypeDescription;
+    execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]>;
+}
+//# sourceMappingURL=UserPilot.node.d.ts.map

package/dist/nodes/UserPilot/UserPilot.node.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"UserPilot.node.d.ts","sourceRoot":"","sources":["../../../nodes/UserPilot/UserPilot.node.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EACV,iBAAiB,EACjB,kBAAkB,EAClB,SAAS,EACT,oBAAoB,EACrB,MAAM,cAAc,CAAC;AAetB,qBAAa,SAAU,YAAW,SAAS;IACzC,WAAW,EAAE,oBAAoB,CA87B/B;IAEI,OAAO,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC;CAmExE"}