n8n-nodes-lemonsqueezy 0.4.0 → 0.5.0

package/dist/nodes/LemonSqueezy/resources/shared.js

@@ -0,0 +1,196 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.discountAdvancedOptions = exports.checkoutAdvancedOptions = exports.variantAdvancedOptions = exports.productAdvancedOptions = exports.licenseKeyAdvancedOptions = exports.customerAdvancedOptions = exports.subscriptionAdvancedOptions = exports.orderAdvancedOptions = exports.RESOURCE_INCLUDES = exports.COMMON_SORT_FIELDS = exports.SORT_DIRECTIONS = void 0;
+exports.createReturnAllField = createReturnAllField;
+exports.createLimitField = createLimitField;
+exports.createIdField = createIdField;
+exports.createAdvancedOptionsField = createAdvancedOptionsField;
+/**
+ * Shared field definitions for advanced query options
+ * Used across multiple resources for consistent sorting and relationship expansion
+ *
+ * This module reduces code duplication by providing reusable field definitions
+ * for common patterns like pagination (returnAll, limit), sorting, and filtering.
+ */
+// ============================================================================
+// Common Field Generators
+// ============================================================================
+/**
+ * Creates a 'Return All' toggle field for a resource
+ * @param resource - The resource name (e.g., 'product', 'order')
+ * @param operations - Operations where this field applies (default: ['getAll'])
+ */
+function createReturnAllField(resource, operations = ['getAll']) {
+    return {
+        displayName: 'Return All',
+        name: 'returnAll',
+        type: 'boolean',
+        default: false,
+        description: 'Whether to return all results or only up to a given limit',
+        displayOptions: {
+            show: { resource: [resource], operation: operations },
+        },
+    };
+}
+/**
+ * Creates a 'Limit' number field for a resource
+ * @param resource - The resource name
+ * @param operations - Operations where this field applies
+ */
+function createLimitField(resource, operations = ['getAll']) {
+    return {
+        displayName: 'Limit',
+        name: 'limit',
+        type: 'number',
+        default: 50,
+        description: 'Max number of results to return',
+        typeOptions: { minValue: 1, maxValue: 100 },
+        displayOptions: {
+            show: { resource: [resource], operation: operations, returnAll: [false] },
+        },
+    };
+}
+/**
+ * Creates a resource ID field
+ * @param resource - The resource name
+ * @param idName - The parameter name for the ID (e.g., 'productId')
+ * @param displayName - Display name shown in UI
+ * @param operations - Operations where this field applies
+ */
+function createIdField(resource, idName, displayName, operations = ['get', 'delete']) {
+    return {
+        displayName,
+        name: idName,
+        type: 'string',
+        required: true,
+        default: '',
+        description: `The ID of the ${resource}`,
+        displayOptions: {
+            show: { resource: [resource], operation: operations },
+        },
+    };
+}
+// ============================================================================
+// Sort Options
+// ============================================================================
+/**
+ * Sort direction options for API queries
+ */
+exports.SORT_DIRECTIONS = [
+    { name: 'Ascending', value: 'asc' },
+    { name: 'Descending', value: 'desc' },
+];
+/**
+ * Common sortable fields across resources
+ */
+exports.COMMON_SORT_FIELDS = [
+    { name: 'Created At', value: 'created_at' },
+    { name: 'Updated At', value: 'updated_at' },
+];
+/**
+ * Resource-specific includable relationships
+ */
+exports.RESOURCE_INCLUDES = {
+    order: [
+        { name: 'Store', value: 'store' },
+        { name: 'Customer', value: 'customer' },
+        { name: 'Order Items', value: 'order-items' },
+        { name: 'Subscriptions', value: 'subscriptions' },
+        { name: 'License Keys', value: 'license-keys' },
+        { name: 'Discount Redemptions', value: 'discount-redemptions' },
+    ],
+    subscription: [
+        { name: 'Store', value: 'store' },
+        { name: 'Customer', value: 'customer' },
+        { name: 'Order', value: 'order' },
+        { name: 'Order Item', value: 'order-item' },
+        { name: 'Product', value: 'product' },
+        { name: 'Variant', value: 'variant' },
+    ],
+    customer: [
+        { name: 'Store', value: 'store' },
+        { name: 'Orders', value: 'orders' },
+        { name: 'Subscriptions', value: 'subscriptions' },
+        { name: 'License Keys', value: 'license-keys' },
+    ],
+    licenseKey: [
+        { name: 'Store', value: 'store' },
+        { name: 'Customer', value: 'customer' },
+        { name: 'Order', value: 'order' },
+        { name: 'Order Item', value: 'order-item' },
+        { name: 'Product', value: 'product' },
+        { name: 'License Key Instances', value: 'license-key-instances' },
+    ],
+    product: [
+        { name: 'Store', value: 'store' },
+        { name: 'Variants', value: 'variants' },
+    ],
+    variant: [
+        { name: 'Product', value: 'product' },
+        { name: 'Files', value: 'files' },
+    ],
+    checkout: [
+        { name: 'Store', value: 'store' },
+        { name: 'Variant', value: 'variant' },
+    ],
+    discount: [
+        { name: 'Store', value: 'store' },
+        { name: 'Discount Redemptions', value: 'discount-redemptions' },
+    ],
+};
+/**
+ * Generate advanced options field for a specific resource
+ */
+function createAdvancedOptionsField(resource, operations = ['getAll']) {
+    const includes = exports.RESOURCE_INCLUDES[resource] || [];
+    const options = [
+        {
+            displayName: 'Sort Field',
+            name: 'sortField',
+            type: 'options',
+            options: exports.COMMON_SORT_FIELDS,
+            default: '',
+            description: 'Field to sort results by',
+        },
+        {
+            displayName: 'Sort Direction',
+            name: 'sortDirection',
+            type: 'options',
+            options: exports.SORT_DIRECTIONS,
+            default: 'desc',
+            description: 'Direction to sort results',
+        },
+    ];
+    if (includes.length > 0) {
+        options.push({
+            displayName: 'Include Related',
+            name: 'include',
+            type: 'multiOptions',
+            options: includes,
+            default: [],
+            description: 'Related resources to include in the response',
+        });
+    }
+    return {
+        displayName: 'Advanced Options',
+        name: 'advancedOptions',
+        type: 'collection',
+        placeholder: 'Add Option',
+        default: {},
+        displayOptions: {
+            show: { resource: [resource], operation: operations },
+        },
+        options,
+    };
+}
+/**
+ * Pre-built advanced options fields for each resource
+ */
+exports.orderAdvancedOptions = createAdvancedOptionsField('order');
+exports.subscriptionAdvancedOptions = createAdvancedOptionsField('subscription');
+exports.customerAdvancedOptions = createAdvancedOptionsField('customer');
+exports.licenseKeyAdvancedOptions = createAdvancedOptionsField('licenseKey');
+exports.productAdvancedOptions = createAdvancedOptionsField('product');
+exports.variantAdvancedOptions = createAdvancedOptionsField('variant');
+exports.checkoutAdvancedOptions = createAdvancedOptionsField('checkout');
+exports.discountAdvancedOptions = createAdvancedOptionsField('discount');

package/dist/nodes/LemonSqueezy/types.d.ts

@@ -344,15 +344,71 @@ export type LicenseKeyInstance = JsonApiResource<'license-key-instances', Licens
  */
 export type WebhookEventType = 'order_created' | 'order_refunded' | 'subscription_created' | 'subscription_updated' | 'subscription_cancelled' | 'subscription_resumed' | 'subscription_expired' | 'subscription_paused' | 'subscription_unpaused' | 'subscription_payment_success' | 'subscription_payment_failed' | 'subscription_payment_recovered' | 'subscription_payment_refunded' | 'license_key_created' | 'license_key_updated';
 /**
- * Webhook payload
+ * Webhook payload received from Lemon Squeezy
  */
-export interface WebhookPayload {
-    meta: {
-        event_name: WebhookEventType;
-        custom_data?: IDataObject;
-        test_mode: boolean;
+export interface WebhookPayload<T = IDataObject> {
+    meta: WebhookMeta;
+    data: T;
+}
+/**
+ * Webhook metadata
+ */
+export interface WebhookMeta {
+    event_name: WebhookEventType;
+    custom_data?: IDataObject;
+    test_mode: boolean;
+    webhook_id?: string;
+}
+/**
+ * API Error response structure
+ */
+export interface ApiError {
+    errors: ApiErrorDetail[];
+}
+/**
+ * Individual API error detail
+ */
+export interface ApiErrorDetail {
+    detail: string;
+    title?: string;
+    status?: string;
+    source?: {
+        pointer?: string;
+        parameter?: string;
     };
-    data: IDataObject;
+}
+/**
+ * Pagination metadata from API responses
+ */
+export interface PaginationMeta {
+    page: {
+        currentPage: number;
+        from: number;
+        lastPage: number;
+        perPage: number;
+        to: number;
+        total: number;
+    };
+}
+/**
+ * Pagination links from API responses
+ */
+export interface PaginationLinks {
+    first?: string;
+    last?: string;
+    next?: string;
+    prev?: string;
+}
+/**
+ * Options for paginated requests
+ */
+export interface PaginationOptions {
+    /** Maximum number of items to fetch (default: no limit) */
+    maxItems?: number;
+    /** Request timeout in milliseconds (default: 30000) */
+    timeout?: number;
+    /** Page size for each request (default: 100) */
+    pageSize?: number;
 }
 /**
  * Resource name to endpoint mapping

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "n8n-nodes-lemonsqueezy",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "n8n community node for Lemon Squeezy - digital products and subscriptions platform",
   "keywords": [
     "n8n-community-node-package",