@drosenthal/n8n-nodes-ynab 0.1.2 → 0.2.0

package/dist/nodes/Ynab/descriptions/TransactionDescription.js

@@ -0,0 +1,463 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transactionFields = exports.transactionOperations = void 0;
+const FLAG_COLOR_OPTIONS = [
+    { name: '(None)', value: '' },
+    { name: 'Red', value: 'red' },
+    { name: 'Orange', value: 'orange' },
+    { name: 'Yellow', value: 'yellow' },
+    { name: 'Green', value: 'green' },
+    { name: 'Blue', value: 'blue' },
+    { name: 'Purple', value: 'purple' },
+];
+const CLEARED_OPTIONS = [
+    { name: 'Cleared', value: 'cleared' },
+    { name: 'Uncleared', value: 'uncleared' },
+    { name: 'Reconciled', value: 'reconciled' },
+];
+const TRANSACTION_FILTER_TYPES = [
+    { name: '(None)', value: '' },
+    { name: 'Uncategorized', value: 'uncategorized' },
+    { name: 'Unapproved', value: 'unapproved' },
+];
+exports.transactionOperations = [
+    {
+        displayName: 'Operation',
+        name: 'operation',
+        type: 'options',
+        noDataExpression: true,
+        displayOptions: { show: { resource: ['transaction'] } },
+        options: [
+            {
+                name: 'Get All',
+                value: 'getAll',
+                action: 'Get all transactions',
+                routing: {
+                    request: { method: 'GET', url: '=/plans/{{$parameter.plan_id}}/transactions' },
+                },
+            },
+            {
+                name: 'Get',
+                value: 'get',
+                action: 'Get a transaction',
+                routing: {
+                    request: {
+                        method: 'GET',
+                        url: '=/plans/{{$parameter.plan_id}}/transactions/{{$parameter.transaction_id}}',
+                    },
+                },
+            },
+            {
+                name: 'Create',
+                value: 'create',
+                action: 'Create a transaction',
+                routing: {
+                    request: { method: 'POST', url: '=/plans/{{$parameter.plan_id}}/transactions' },
+                },
+            },
+            {
+                name: 'Update',
+                value: 'update',
+                action: 'Update a transaction',
+                routing: {
+                    request: {
+                        method: 'PUT',
+                        url: '=/plans/{{$parameter.plan_id}}/transactions/{{$parameter.transaction_id}}',
+                    },
+                },
+            },
+            {
+                name: 'Delete',
+                value: 'delete',
+                action: 'Delete a transaction',
+                routing: {
+                    request: {
+                        method: 'DELETE',
+                        url: '=/plans/{{$parameter.plan_id}}/transactions/{{$parameter.transaction_id}}',
+                    },
+                },
+            },
+            {
+                name: 'Update Many',
+                value: 'updateMany',
+                action: 'Update multiple transactions',
+                routing: {
+                    request: { method: 'PATCH', url: '=/plans/{{$parameter.plan_id}}/transactions' },
+                },
+            },
+            {
+                name: 'Import',
+                value: 'import',
+                action: 'Import transactions',
+                routing: {
+                    request: {
+                        method: 'POST',
+                        url: '=/plans/{{$parameter.plan_id}}/transactions/import',
+                    },
+                },
+            },
+            {
+                name: 'Get All By Account',
+                value: 'getAllByAccount',
+                action: 'Get transactions for an account',
+                routing: {
+                    request: {
+                        method: 'GET',
+                        url: '=/plans/{{$parameter.plan_id}}/accounts/{{$parameter.account_id}}/transactions',
+                    },
+                },
+            },
+            {
+                name: 'Get All By Category',
+                value: 'getAllByCategory',
+                action: 'Get transactions for a category',
+                routing: {
+                    request: {
+                        method: 'GET',
+                        url: '=/plans/{{$parameter.plan_id}}/categories/{{$parameter.category_id}}/transactions',
+                    },
+                },
+            },
+            {
+                name: 'Get All By Payee',
+                value: 'getAllByPayee',
+                action: 'Get transactions for a payee',
+                routing: {
+                    request: {
+                        method: 'GET',
+                        url: '=/plans/{{$parameter.plan_id}}/payees/{{$parameter.payee_id}}/transactions',
+                    },
+                },
+            },
+            {
+                name: 'Get All By Month',
+                value: 'getAllByMonth',
+                action: 'Get transactions for a month',
+                routing: {
+                    request: {
+                        method: 'GET',
+                        url: '=/plans/{{$parameter.plan_id}}/months/{{$parameter.month}}/transactions',
+                    },
+                },
+            },
+        ],
+        default: 'getAll',
+    },
+];
+const getAllOps = [
+    'getAll',
+    'getAllByAccount',
+    'getAllByCategory',
+    'getAllByPayee',
+    'getAllByMonth',
+];
+exports.transactionFields = [
+    {
+        displayName: 'Plan Name or ID',
+        name: 'plan_id',
+        type: 'options',
+        required: true,
+        default: '',
+        description: 'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code/expressions/">expression</a>',
+        typeOptions: { loadOptionsMethod: 'getPlans' },
+        displayOptions: { show: { resource: ['transaction'] } },
+    },
+    {
+        displayName: 'Transaction ID',
+        name: 'transaction_id',
+        type: 'string',
+        required: true,
+        default: '',
+        displayOptions: {
+            show: { resource: ['transaction'], operation: ['get', 'update', 'delete'] },
+        },
+    },
+    {
+        displayName: 'Account Name or ID',
+        name: 'account_id',
+        type: 'options',
+        required: true,
+        default: '',
+        description: 'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code/expressions/">expression</a>',
+        typeOptions: { loadOptionsMethod: 'getAccounts', loadOptionsDependsOn: ['plan_id'] },
+        displayOptions: { show: { resource: ['transaction'], operation: ['getAllByAccount'] } },
+    },
+    {
+        displayName: 'Category Name or ID',
+        name: 'category_id',
+        type: 'options',
+        required: true,
+        default: '',
+        description: 'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code/expressions/">expression</a>',
+        typeOptions: { loadOptionsMethod: 'getCategories', loadOptionsDependsOn: ['plan_id'] },
+        displayOptions: { show: { resource: ['transaction'], operation: ['getAllByCategory'] } },
+    },
+    {
+        displayName: 'Payee ID',
+        name: 'payee_id',
+        type: 'string',
+        required: true,
+        default: '',
+        displayOptions: { show: { resource: ['transaction'], operation: ['getAllByPayee'] } },
+    },
+    {
+        displayName: 'Month',
+        name: 'month',
+        type: 'string',
+        required: true,
+        default: 'current',
+        placeholder: 'current or YYYY-MM-01',
+        description: 'ISO-formatted month (e.g. 2024-03-01) or "current"',
+        displayOptions: { show: { resource: ['transaction'], operation: ['getAllByMonth'] } },
+    },
+    // Query filters for all getAll variants
+    {
+        displayName: 'Filters',
+        name: 'filters',
+        type: 'collection',
+        placeholder: 'Add Filter',
+        default: {},
+        displayOptions: { show: { resource: ['transaction'], operation: getAllOps } },
+        options: [
+            {
+                displayName: 'Since Date',
+                name: 'since_date',
+                type: 'string',
+                default: '',
+                placeholder: 'YYYY-MM-DD',
+                description: 'Only include transactions on or after this date',
+                routing: { request: { qs: { since_date: '={{ $value || undefined }}' } } },
+            },
+            {
+                displayName: 'Type',
+                name: 'type',
+                type: 'options',
+                default: '',
+                options: TRANSACTION_FILTER_TYPES,
+                routing: { request: { qs: { type: '={{ $value || undefined }}' } } },
+            },
+            {
+                displayName: 'Last Knowledge of Server',
+                name: 'last_knowledge_of_server',
+                type: 'number',
+                default: 0,
+                description: 'Returns entities changed since this knowledge value',
+                routing: {
+                    request: {
+                        qs: { last_knowledge_of_server: '={{ $value > 0 ? $value : undefined }}' },
+                    },
+                },
+            },
+        ],
+    },
+    // CREATE: single transaction required fields
+    {
+        displayName: 'Account Name or ID',
+        name: 'create_account_id',
+        type: 'options',
+        required: true,
+        default: '',
+        description: 'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code/expressions/">expression</a>',
+        typeOptions: { loadOptionsMethod: 'getAccounts', loadOptionsDependsOn: ['plan_id'] },
+        displayOptions: { show: { resource: ['transaction'], operation: ['create'] } },
+        routing: { send: { type: 'body', property: 'transaction.account_id' } },
+    },
+    {
+        displayName: 'Date',
+        name: 'create_date',
+        type: 'string',
+        required: true,
+        default: '',
+        placeholder: 'YYYY-MM-DD',
+        description: 'Transaction date in ISO format. Future dates are not permitted.',
+        displayOptions: { show: { resource: ['transaction'], operation: ['create'] } },
+        routing: { send: { type: 'body', property: 'transaction.date' } },
+    },
+    {
+        displayName: 'Amount (Milliunits)',
+        name: 'create_amount',
+        type: 'number',
+        required: true,
+        default: 0,
+        description: 'Transaction amount in milliunits format (multiply dollars by 1000, negative for outflow)',
+        displayOptions: { show: { resource: ['transaction'], operation: ['create'] } },
+        routing: { send: { type: 'body', property: 'transaction.amount' } },
+    },
+    {
+        displayName: 'Additional Fields',
+        name: 'createAdditionalFields',
+        type: 'collection',
+        placeholder: 'Add Field',
+        default: {},
+        displayOptions: { show: { resource: ['transaction'], operation: ['create'] } },
+        options: [
+            {
+                displayName: 'Payee ID',
+                name: 'payee_id',
+                type: 'string',
+                default: '',
+                description: 'UUID of the payee. Leave empty to use Payee Name instead.',
+                routing: { send: { type: 'body', property: 'transaction.payee_id' } },
+            },
+            {
+                displayName: 'Payee Name',
+                name: 'payee_name',
+                type: 'string',
+                default: '',
+                description: 'Used if Payee ID is empty. Creates a new payee if no match found (max 200 chars).',
+                routing: { send: { type: 'body', property: 'transaction.payee_name' } },
+            },
+            {
+                displayName: 'Category Name or ID',
+                name: 'category_id',
+                type: 'options',
+                default: '',
+                description: 'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code/expressions/">expression</a>',
+                typeOptions: { loadOptionsMethod: 'getCategories', loadOptionsDependsOn: ['plan_id'] },
+                routing: { send: { type: 'body', property: 'transaction.category_id' } },
+            },
+            {
+                displayName: 'Memo',
+                name: 'memo',
+                type: 'string',
+                default: '',
+                description: 'Transaction memo (max 500 chars)',
+                routing: { send: { type: 'body', property: 'transaction.memo' } },
+            },
+            {
+                displayName: 'Cleared',
+                name: 'cleared',
+                type: 'options',
+                default: 'uncleared',
+                options: CLEARED_OPTIONS,
+                routing: { send: { type: 'body', property: 'transaction.cleared' } },
+            },
+            {
+                displayName: 'Approved',
+                name: 'approved',
+                type: 'boolean',
+                default: false,
+                routing: { send: { type: 'body', property: 'transaction.approved' } },
+            },
+            {
+                displayName: 'Flag Color',
+                name: 'flag_color',
+                type: 'options',
+                default: '',
+                options: FLAG_COLOR_OPTIONS,
+                routing: {
+                    send: { type: 'body', property: 'transaction.flag_color' },
+                },
+            },
+            {
+                displayName: 'Import ID',
+                name: 'import_id',
+                type: 'string',
+                default: '',
+                description: 'Custom import ID (max 36 chars). Used for deduplication.',
+                routing: { send: { type: 'body', property: 'transaction.import_id' } },
+            },
+        ],
+    },
+    // UPDATE (PUT single): all fields optional
+    {
+        displayName: 'Update Fields',
+        name: 'updateFields',
+        type: 'collection',
+        placeholder: 'Add Field',
+        default: {},
+        displayOptions: { show: { resource: ['transaction'], operation: ['update'] } },
+        options: [
+            {
+                displayName: 'Account Name or ID',
+                name: 'account_id',
+                type: 'options',
+                default: '',
+                description: 'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code/expressions/">expression</a>',
+                typeOptions: { loadOptionsMethod: 'getAccounts', loadOptionsDependsOn: ['plan_id'] },
+                routing: { send: { type: 'body', property: 'transaction.account_id' } },
+            },
+            {
+                displayName: 'Date',
+                name: 'date',
+                type: 'string',
+                default: '',
+                placeholder: 'YYYY-MM-DD',
+                routing: { send: { type: 'body', property: 'transaction.date' } },
+            },
+            {
+                displayName: 'Amount (Milliunits)',
+                name: 'amount',
+                type: 'number',
+                default: 0,
+                routing: { send: { type: 'body', property: 'transaction.amount' } },
+            },
+            {
+                displayName: 'Payee ID',
+                name: 'payee_id',
+                type: 'string',
+                default: '',
+                description: 'UUID of the payee. Leave empty to use Payee Name instead.',
+                routing: { send: { type: 'body', property: 'transaction.payee_id' } },
+            },
+            {
+                displayName: 'Payee Name',
+                name: 'payee_name',
+                type: 'string',
+                default: '',
+                routing: { send: { type: 'body', property: 'transaction.payee_name' } },
+            },
+            {
+                displayName: 'Category Name or ID',
+                name: 'category_id',
+                type: 'options',
+                default: '',
+                description: 'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code/expressions/">expression</a>',
+                typeOptions: { loadOptionsMethod: 'getCategories', loadOptionsDependsOn: ['plan_id'] },
+                routing: { send: { type: 'body', property: 'transaction.category_id' } },
+            },
+            {
+                displayName: 'Memo',
+                name: 'memo',
+                type: 'string',
+                default: '',
+                routing: { send: { type: 'body', property: 'transaction.memo' } },
+            },
+            {
+                displayName: 'Cleared',
+                name: 'cleared',
+                type: 'options',
+                default: 'uncleared',
+                options: CLEARED_OPTIONS,
+                routing: { send: { type: 'body', property: 'transaction.cleared' } },
+            },
+            {
+                displayName: 'Approved',
+                name: 'approved',
+                type: 'boolean',
+                default: false,
+                routing: { send: { type: 'body', property: 'transaction.approved' } },
+            },
+            {
+                displayName: 'Flag Color',
+                name: 'flag_color',
+                type: 'options',
+                default: '',
+                options: FLAG_COLOR_OPTIONS,
+                routing: { send: { type: 'body', property: 'transaction.flag_color' } },
+            },
+        ],
+    },
+    // UPDATE MANY (PATCH): expect array via expression
+    {
+        displayName: 'Transactions',
+        name: 'transactionsArray',
+        type: 'json',
+        required: true,
+        default: '=[]',
+        description: 'Array of transaction objects. Each must include either an "id" or "import_id" plus any fields to update.',
+        displayOptions: { show: { resource: ['transaction'], operation: ['updateMany'] } },
+        routing: { send: { type: 'body', property: 'transactions' } },
+    },
+    // IMPORT: no body required, but endpoint returns imported transaction_ids
+];

package/dist/nodes/Ynab/descriptions/UserDescription.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.userFields = exports.userOperations = void 0;
+exports.userOperations = [
+    {
+        displayName: 'Operation',
+        name: 'operation',
+        type: 'options',
+        noDataExpression: true,
+        displayOptions: { show: { resource: ['user'] } },
+        options: [
+            {
+                name: 'Get',
+                value: 'get',
+                action: 'Get authenticated user',
+                routing: { request: { method: 'GET', url: '/user' } },
+            },
+        ],
+        default: 'get',
+    },
+];
+exports.userFields = [];

package/dist/nodes/Ynab/descriptions/index.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.allProperties = exports.resourceProperty = void 0;
+const UserDescription_1 = require("./UserDescription");
+const PlanDescription_1 = require("./PlanDescription");
+const AccountDescription_1 = require("./AccountDescription");
+const CategoryDescription_1 = require("./CategoryDescription");
+const PayeeDescription_1 = require("./PayeeDescription");
+const PayeeLocationDescription_1 = require("./PayeeLocationDescription");
+const MonthDescription_1 = require("./MonthDescription");
+const MoneyMovementDescription_1 = require("./MoneyMovementDescription");
+const TransactionDescription_1 = require("./TransactionDescription");
+const ScheduledTransactionDescription_1 = require("./ScheduledTransactionDescription");
+exports.resourceProperty = {
+    displayName: 'Resource',
+    name: 'resource',
+    type: 'options',
+    noDataExpression: true,
+    default: 'transaction',
+    options: [
+        { name: 'Account', value: 'account' },
+        { name: 'Category', value: 'category' },
+        { name: 'Money Movement', value: 'moneyMovement' },
+        { name: 'Month', value: 'month' },
+        { name: 'Payee', value: 'payee' },
+        { name: 'Payee Location', value: 'payeeLocation' },
+        { name: 'Plan', value: 'plan' },
+        { name: 'Scheduled Transaction', value: 'scheduledTransaction' },
+        { name: 'Transaction', value: 'transaction' },
+        { name: 'User', value: 'user' },
+    ],
+};
+exports.allProperties = [
+    exports.resourceProperty,
+    ...UserDescription_1.userOperations,
+    ...UserDescription_1.userFields,
+    ...PlanDescription_1.planOperations,
+    ...PlanDescription_1.planFields,
+    ...AccountDescription_1.accountOperations,
+    ...AccountDescription_1.accountFields,
+    ...CategoryDescription_1.categoryOperations,
+    ...CategoryDescription_1.categoryFields,
+    ...PayeeDescription_1.payeeOperations,
+    ...PayeeDescription_1.payeeFields,
+    ...PayeeLocationDescription_1.payeeLocationOperations,
+    ...PayeeLocationDescription_1.payeeLocationFields,
+    ...MonthDescription_1.monthOperations,
+    ...MonthDescription_1.monthFields,
+    ...MoneyMovementDescription_1.moneyMovementOperations,
+    ...MoneyMovementDescription_1.moneyMovementFields,
+    ...TransactionDescription_1.transactionOperations,
+    ...TransactionDescription_1.transactionFields,
+    ...ScheduledTransactionDescription_1.scheduledTransactionOperations,
+    ...ScheduledTransactionDescription_1.scheduledTransactionFields,
+];

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@drosenthal/n8n-nodes-ynab",
-    "version": "0.1.2",
+    "version": "0.2.0",
     "description": "n8n community node for YNAB (You Need A Budget)",
     "keywords": [
         "n8n-community-node-package"
@@ -25,11 +25,8 @@
     },
     "devDependencies": {
         "@types/node": "^18.0.0",
-        "typescript": "^5.0.0",
-        "n8n-workflow": "*"
-    },
-    "dependencies": {
-        "@devlikeapro/n8n-openapi-node": "*"
+        "n8n-workflow": "*",
+        "typescript": "^5.0.0"
     },
     "peerDependencies": {
         "n8n-workflow": "*"