@aderis-erp/cli 1.0.14 → 1.0.17

package/README.md

@@ -4,8 +4,8 @@ Command-line interface for Aderis Finance ERP. Manage your Aderis account, execu
 
 ## Features
 
-- **OAuth Authentication** - Secure login with PKCE flow
-- **Multi-Environment Support** - Switch between dev, test, and production environments
+- **OAuth Authentication** - Secure browser login with PKCE flow, through Keycloak
+- **Multi-Environment Support** - Switch between dev, test, staging and production environments
 - **Multi-Client Support** - Manage multiple clients with named contexts
 - **Multi-Tenant Support** - Switch between tenants within a single login
 - **Full API Access** - Execute all Aderis API endpoints from the command line
@@ -104,6 +104,26 @@ aderis auth login --context my-client
 aderis auth login --new --name my-client --environment dev --client-id YOUR_CLIENT_ID
 ```
 
+### Logging in via Keycloak
+
+Keycloak is the only identity provider; an OAuth context needs no provider flag:
+
+```bash
+aderis config add --environment test --name test-kc
+aderis auth login --context test-kc
+```
+
+The CLI logs in with the public `aderis-cli-login` client (Authorization Code + PKCE, `state` + `nonce`, scopes `openid profile email offline_access`) against the realm of the context's environment:
+
+| Environment | Keycloak host | Realm |
+|-------------|---------------|-------|
+| dev | https://iam-dev.aderis.com | dev |
+| test | https://iam-test.aderis.com | test |
+| staging | https://iam-staging.aderis.com | staging |
+| live | https://iam.aderis.com | prod |
+
+Tenants come from the token (`tenantId`, `availableTenants`); switching is one refresh-token request carrying `tenant_id=<uuid>`, with no browser. `--keycloak-url <https origin>` on `config add` points a context at another allowlisted Keycloak host, e.g. `https://aderis-erp-nonprod.cloud-iam.com`. Requires [infrastructure-stacks#152](https://github.com/AderisERP/infrastructure-stacks/issues/152) for tokens from the `iam-<env>.aderis.com` hosts to be accepted by the API. See [docs/getting-started/authentication.md](docs/getting-started/authentication.md#logging-in-via-keycloak).
+
 ### Logout
 
 ```bash
@@ -216,12 +236,14 @@ Configuration is stored in `~/.aderis/config.json`.
 
 ### Environments
 
-| Environment | Auth URL | API URL |
-|-------------|----------|---------|
-| dev | https://auth-dev.aderis.com | https://api-dev.aderis.com |
-| test | https://auth-test.aderis.com | https://api-test.aderis.com |
-| staging | https://auth-staging.aderis.com | https://api-staging.aderis.com |
-| live | https://auth.aderis.com | https://api.aderis.com |
+| Environment | API URL | Keycloak host / realm |
+|-------------|---------|-----------------------|
+| dev | https://api-dev.aderis.com | https://iam-dev.aderis.com / dev |
+| test | https://api-test.aderis.com | https://iam-test.aderis.com / test |
+| staging | https://api-staging.aderis.com | https://iam-staging.aderis.com / staging |
+| live | https://api.aderis.com | https://iam.aderis.com / prod |
+
+Set `ADERIS_CONFIG_DIR` (an absolute path) to keep `config.json` somewhere other than `~/.aderis`.
 
 ## Development
 

package/dist/commands/access-groups.d.ts

@@ -31,7 +31,6 @@ export default class AccessGroups extends Command {
     private runCamt053Import;
     private runNestedImport;
     private parseFilterValue;
-    private filterFields;
     private sanitizeOutput;
     private getColumns;
     private getValue;

package/dist/commands/access-groups.js

@@ -1,6 +1,6 @@
 import { Command, Args, Flags } from '@oclif/core';
 import { apiRequest, ApiError, normalizeSortBy } from '../lib/api-client.js';
-import { getCurrentContext, getContext, getBaseUrls } from '../lib/config.js';
+import { getCurrentContext, getContext, getBaseUrls, hasCredentials, missingCredentialsMessage } from '../lib/config.js';
 // Add 'import' action if both create and update exist
 const HAS_IMPORT = true;
 const HAS_EXPORT = true;
@@ -29,7 +29,7 @@ export default class AccessGroups extends Command {
         id: Args.string({ description: 'Resource ID (for get, update, delete operations)', required: false }),
     };
     static flags = {
-        context: Flags.string({ char: 'c', description: 'Context to use' }),
+        context: Flags.string({ char: 'c', aliases: ['config'], env: 'ADERIS_CONTEXT', description: 'Context to use for this command, overriding the current context (alias: --config)' }),
         output: Flags.string({ char: 'o', description: 'Output format (default: table for import, json for other commands)', options: ['json', 'table', 'csv'] }),
         table: Flags.boolean({ char: 't', description: 'Output as table (shortcut for --output table)' }),
         csv: Flags.boolean({ description: 'Output as CSV (shortcut for --output csv)' }),
@@ -43,7 +43,7 @@ export default class AccessGroups extends Command {
         'sort-by': Flags.string({ description: 'Sort field(s), comma-separated. Direction (:ASC/:DESC) is optional; date-like fields default to DESC, others to ASC.' }),
         filter: Flags.string({ description: 'Filter (e.g. --filter status=ACTIVE). Operators: in:A,B, like:%, gt:, lt:, null:', multiple: true }),
         query: Flags.string({ description: 'Additional query params as JSON' }),
-        fields: Flags.string({ description: 'Comma-separated list of fields to show (e.g. --fields=id,name,status)' }),
+        fields: Flags.string({ description: 'Comma-separated list of fields to return, applied by the API (e.g. --fields=id,name,status)' }),
         sanitize: Flags.boolean({ description: 'Remove null values, audit fields, and duplicate UUIDs from output' }),
         'show-http-request': Flags.boolean({ description: 'Show HTTP request details (method, URL, body)' }),
     };
@@ -101,9 +101,9 @@ export default class AccessGroups extends Command {
         }
         const context = flags.context ? getContext(flags.context) : getCurrentContext();
         if (!context)
-            this.error('No context configured. Run: aderis auth login --new');
-        if (!context.tokens)
-            this.error('Not logged in. Run: aderis auth login');
+            this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
+        if (!hasCredentials(context))
+            this.error(missingCredentialsMessage(context));
         const queryParams = {};
         if (flags.page)
             queryParams.page = flags.page;
@@ -115,6 +115,8 @@ export default class AccessGroups extends Command {
             queryParams.search = flags.search;
         if (flags['sort-by'])
             queryParams.sortBy = normalizeSortBy(flags['sort-by']);
+        if (flags.fields)
+            queryParams.fields = flags.fields;
         if (flags.query) {
             try {
                 Object.assign(queryParams, JSON.parse(flags.query));
@@ -317,11 +319,6 @@ export default class AccessGroups extends Command {
                     output = obj[arrayKeys[0]];
                 }
             }
-            // Filter fields if --fields flag is provided
-            if (flags.fields) {
-                const fieldList = flags.fields.split(',').map(f => f.trim());
-                output = this.filterFields(output, fieldList);
-            }
             // Sanitize output if requested
             if (flags.sanitize) {
                 output = this.sanitizeOutput(output);
@@ -346,9 +343,9 @@ export default class AccessGroups extends Command {
     async runImport(flags) {
         const context = flags.context ? getContext(flags.context) : getCurrentContext();
         if (!context)
-            this.error('No context configured. Run: aderis auth login --new');
-        if (!context.tokens)
-            this.error('Not logged in. Run: aderis auth login');
+            this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
+        if (!hasCredentials(context))
+            this.error(missingCredentialsMessage(context));
         // Get data from file, --data, or --set flags
         let items = [];
         if (flags.file) {
@@ -558,9 +555,9 @@ export default class AccessGroups extends Command {
     async runExport(flags) {
         const context = flags.context ? getContext(flags.context) : getCurrentContext();
         if (!context)
-            this.error('No context configured. Run: aderis auth login --new');
-        if (!context.tokens)
-            this.error('Not logged in. Run: aderis auth login');
+            this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
+        if (!hasCredentials(context))
+            this.error(missingCredentialsMessage(context));
         const listEndpoint = ENDPOINTS['list'];
         if (!listEndpoint)
             this.error('Export requires a list endpoint');
@@ -576,6 +573,8 @@ export default class AccessGroups extends Command {
             baseParams.sortBy = normalizeSortBy(flags['sort-by']);
         if (flags.include)
             baseParams.include = flags.include;
+        if (flags.fields)
+            baseParams.fields = flags.fields;
         if (flags.query) {
             try {
                 Object.assign(baseParams, JSON.parse(flags.query));
@@ -630,12 +629,7 @@ export default class AccessGroups extends Command {
             }
         }
         process.stderr.write(' done\n');
-        // Filter fields if specified
         let output = allItems;
-        if (flags.fields) {
-            const fieldList = flags.fields.split(',').map(f => f.trim());
-            output = this.filterFields(allItems, fieldList);
-        }
         // Sanitize output if requested
         if (flags.sanitize) {
             output = this.sanitizeOutput(output);
@@ -652,9 +646,9 @@ export default class AccessGroups extends Command {
     async runCamt053Import(flags) {
         const context = flags.context ? getContext(flags.context) : getCurrentContext();
         if (!context)
-            this.error('No context configured. Run: aderis auth login --new');
-        if (!context.tokens)
-            this.error('Not logged in. Run: aderis auth login');
+            this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
+        if (!hasCredentials(context))
+            this.error(missingCredentialsMessage(context));
         if (!flags.file) {
             this.error('CAMT.053 import requires --file (-f) flag with path to XML file');
         }
@@ -742,9 +736,9 @@ export default class AccessGroups extends Command {
         }
         const context = flags.context ? getContext(flags.context) : getCurrentContext();
         if (!context)
-            this.error('No context configured. Run: aderis auth login --new');
-        if (!context.tokens)
-            this.error('Not logged in. Run: aderis auth login');
+            this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
+        if (!hasCredentials(context))
+            this.error(missingCredentialsMessage(context));
         // Get data from file, --data, or --set flags
         let items = [];
         if (flags.file) {
@@ -964,56 +958,6 @@ export default class AccessGroups extends Command {
             return `\$${op}`;
         return opRe.test(rest) ? `\$${op}:${this.parseFilterValue(rest)}` : `\$${op}:${rest}`;
     }
-    filterFields(data, fields) {
-        const isUnsafeKey = (k) => k === '__proto__' || k === 'constructor' || k === 'prototype';
-        const pick = (obj, keys) => {
-            // Group keys by their first segment so sibling sub-paths
-            // (e.g. 'items.amount' + 'items._type') resolve in one recursive pass
-            // and don't clobber each other on merge.
-            const directKeys = new Set();
-            const nestedKeys = new Map();
-            for (const key of keys) {
-                if (key.split('.').some(isUnsafeKey))
-                    continue;
-                if (key.includes('.')) {
-                    const [first, ...rest] = key.split('.');
-                    if (isUnsafeKey(first))
-                        continue;
-                    const list = nestedKeys.get(first);
-                    if (list) {
-                        list.push(rest.join('.'));
-                    }
-                    else {
-                        nestedKeys.set(first, [rest.join('.')]);
-                    }
-                }
-                else {
-                    directKeys.add(key);
-                }
-            }
-            const result = {};
-            for (const key of directKeys) {
-                if (key in obj)
-                    result[key] = obj[key];
-            }
-            for (const [first, restKeys] of nestedKeys) {
-                const val = obj[first];
-                if (!val || typeof val !== 'object')
-                    continue;
-                if (Array.isArray(val)) {
-                    result[first] = val.map(item => pick(item, restKeys));
-                }
-                else {
-                    result[first] = pick(val, restKeys);
-                }
-            }
-            return result;
-        };
-        if (Array.isArray(data)) {
-            return data.map(item => pick(item, fields));
-        }
-        return pick(data, fields);
-    }
     sanitizeOutput(data) {
         const auditFields = ['_type', 'tenantId', 'createdAt', 'updatedAt', 'createdBy', 'updatedBy'];
         const uuidRegex = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i;

package/dist/commands/account-transaction-allocations.d.ts

@@ -31,7 +31,6 @@ export default class AccountTransactionAllocations extends Command {
     private runCamt053Import;
     private runNestedImport;
     private parseFilterValue;
-    private filterFields;
     private sanitizeOutput;
     private getColumns;
     private getValue;

package/dist/commands/account-transaction-allocations.js

@@ -1,6 +1,6 @@
 import { Command, Args, Flags } from '@oclif/core';
 import { apiRequest, ApiError, normalizeSortBy } from '../lib/api-client.js';
-import { getCurrentContext, getContext, getBaseUrls } from '../lib/config.js';
+import { getCurrentContext, getContext, getBaseUrls, hasCredentials, missingCredentialsMessage } from '../lib/config.js';
 // Add 'import' action if both create and update exist
 const HAS_IMPORT = false;
 const HAS_EXPORT = true;
@@ -23,7 +23,7 @@ export default class AccountTransactionAllocations extends Command {
         id: Args.string({ description: 'Resource ID (for get, update, delete operations)', required: false }),
     };
     static flags = {
-        context: Flags.string({ char: 'c', description: 'Context to use' }),
+        context: Flags.string({ char: 'c', aliases: ['config'], env: 'ADERIS_CONTEXT', description: 'Context to use for this command, overriding the current context (alias: --config)' }),
         output: Flags.string({ char: 'o', description: 'Output format (default: table for import, json for other commands)', options: ['json', 'table', 'csv'] }),
         table: Flags.boolean({ char: 't', description: 'Output as table (shortcut for --output table)' }),
         csv: Flags.boolean({ description: 'Output as CSV (shortcut for --output csv)' }),
@@ -37,7 +37,7 @@ export default class AccountTransactionAllocations extends Command {
         'sort-by': Flags.string({ description: 'Sort field(s), comma-separated. Direction (:ASC/:DESC) is optional; date-like fields default to DESC, others to ASC.' }),
         filter: Flags.string({ description: 'Filter (e.g. --filter status=ACTIVE). Operators: in:A,B, like:%, gt:, lt:, null:', multiple: true }),
         query: Flags.string({ description: 'Additional query params as JSON' }),
-        fields: Flags.string({ description: 'Comma-separated list of fields to show (e.g. --fields=id,name,status)' }),
+        fields: Flags.string({ description: 'Comma-separated list of fields to return, applied by the API (e.g. --fields=id,name,status)' }),
         sanitize: Flags.boolean({ description: 'Remove null values, audit fields, and duplicate UUIDs from output' }),
         'show-http-request': Flags.boolean({ description: 'Show HTTP request details (method, URL, body)' }),
     };
@@ -95,9 +95,9 @@ export default class AccountTransactionAllocations extends Command {
         }
         const context = flags.context ? getContext(flags.context) : getCurrentContext();
         if (!context)
-            this.error('No context configured. Run: aderis auth login --new');
-        if (!context.tokens)
-            this.error('Not logged in. Run: aderis auth login');
+            this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
+        if (!hasCredentials(context))
+            this.error(missingCredentialsMessage(context));
         const queryParams = {};
         if (flags.page)
             queryParams.page = flags.page;
@@ -109,6 +109,8 @@ export default class AccountTransactionAllocations extends Command {
             queryParams.search = flags.search;
         if (flags['sort-by'])
             queryParams.sortBy = normalizeSortBy(flags['sort-by']);
+        if (flags.fields)
+            queryParams.fields = flags.fields;
         if (flags.query) {
             try {
                 Object.assign(queryParams, JSON.parse(flags.query));
@@ -311,11 +313,6 @@ export default class AccountTransactionAllocations extends Command {
                     output = obj[arrayKeys[0]];
                 }
             }
-            // Filter fields if --fields flag is provided
-            if (flags.fields) {
-                const fieldList = flags.fields.split(',').map(f => f.trim());
-                output = this.filterFields(output, fieldList);
-            }
             // Sanitize output if requested
             if (flags.sanitize) {
                 output = this.sanitizeOutput(output);
@@ -340,9 +337,9 @@ export default class AccountTransactionAllocations extends Command {
     async runImport(flags) {
         const context = flags.context ? getContext(flags.context) : getCurrentContext();
         if (!context)
-            this.error('No context configured. Run: aderis auth login --new');
-        if (!context.tokens)
-            this.error('Not logged in. Run: aderis auth login');
+            this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
+        if (!hasCredentials(context))
+            this.error(missingCredentialsMessage(context));
         // Get data from file, --data, or --set flags
         let items = [];
         if (flags.file) {
@@ -552,9 +549,9 @@ export default class AccountTransactionAllocations extends Command {
     async runExport(flags) {
         const context = flags.context ? getContext(flags.context) : getCurrentContext();
         if (!context)
-            this.error('No context configured. Run: aderis auth login --new');
-        if (!context.tokens)
-            this.error('Not logged in. Run: aderis auth login');
+            this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
+        if (!hasCredentials(context))
+            this.error(missingCredentialsMessage(context));
         const listEndpoint = ENDPOINTS['list'];
         if (!listEndpoint)
             this.error('Export requires a list endpoint');
@@ -570,6 +567,8 @@ export default class AccountTransactionAllocations extends Command {
             baseParams.sortBy = normalizeSortBy(flags['sort-by']);
         if (flags.include)
             baseParams.include = flags.include;
+        if (flags.fields)
+            baseParams.fields = flags.fields;
         if (flags.query) {
             try {
                 Object.assign(baseParams, JSON.parse(flags.query));
@@ -624,12 +623,7 @@ export default class AccountTransactionAllocations extends Command {
             }
         }
         process.stderr.write(' done\n');
-        // Filter fields if specified
         let output = allItems;
-        if (flags.fields) {
-            const fieldList = flags.fields.split(',').map(f => f.trim());
-            output = this.filterFields(allItems, fieldList);
-        }
         // Sanitize output if requested
         if (flags.sanitize) {
             output = this.sanitizeOutput(output);
@@ -646,9 +640,9 @@ export default class AccountTransactionAllocations extends Command {
     async runCamt053Import(flags) {
         const context = flags.context ? getContext(flags.context) : getCurrentContext();
         if (!context)
-            this.error('No context configured. Run: aderis auth login --new');
-        if (!context.tokens)
-            this.error('Not logged in. Run: aderis auth login');
+            this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
+        if (!hasCredentials(context))
+            this.error(missingCredentialsMessage(context));
         if (!flags.file) {
             this.error('CAMT.053 import requires --file (-f) flag with path to XML file');
         }
@@ -736,9 +730,9 @@ export default class AccountTransactionAllocations extends Command {
         }
         const context = flags.context ? getContext(flags.context) : getCurrentContext();
         if (!context)
-            this.error('No context configured. Run: aderis auth login --new');
-        if (!context.tokens)
-            this.error('Not logged in. Run: aderis auth login');
+            this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
+        if (!hasCredentials(context))
+            this.error(missingCredentialsMessage(context));
         // Get data from file, --data, or --set flags
         let items = [];
         if (flags.file) {
@@ -958,56 +952,6 @@ export default class AccountTransactionAllocations extends Command {
             return `\$${op}`;
         return opRe.test(rest) ? `\$${op}:${this.parseFilterValue(rest)}` : `\$${op}:${rest}`;
     }
-    filterFields(data, fields) {
-        const isUnsafeKey = (k) => k === '__proto__' || k === 'constructor' || k === 'prototype';
-        const pick = (obj, keys) => {
-            // Group keys by their first segment so sibling sub-paths
-            // (e.g. 'items.amount' + 'items._type') resolve in one recursive pass
-            // and don't clobber each other on merge.
-            const directKeys = new Set();
-            const nestedKeys = new Map();
-            for (const key of keys) {
-                if (key.split('.').some(isUnsafeKey))
-                    continue;
-                if (key.includes('.')) {
-                    const [first, ...rest] = key.split('.');
-                    if (isUnsafeKey(first))
-                        continue;
-                    const list = nestedKeys.get(first);
-                    if (list) {
-                        list.push(rest.join('.'));
-                    }
-                    else {
-                        nestedKeys.set(first, [rest.join('.')]);
-                    }
-                }
-                else {
-                    directKeys.add(key);
-                }
-            }
-            const result = {};
-            for (const key of directKeys) {
-                if (key in obj)
-                    result[key] = obj[key];
-            }
-            for (const [first, restKeys] of nestedKeys) {
-                const val = obj[first];
-                if (!val || typeof val !== 'object')
-                    continue;
-                if (Array.isArray(val)) {
-                    result[first] = val.map(item => pick(item, restKeys));
-                }
-                else {
-                    result[first] = pick(val, restKeys);
-                }
-            }
-            return result;
-        };
-        if (Array.isArray(data)) {
-            return data.map(item => pick(item, fields));
-        }
-        return pick(data, fields);
-    }
     sanitizeOutput(data) {
         const auditFields = ['_type', 'tenantId', 'createdAt', 'updatedAt', 'createdBy', 'updatedBy'];
         const uuidRegex = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i;

package/dist/commands/account-transactions.d.ts

@@ -33,7 +33,6 @@ export default class AccountTransactions extends Command {
     private runCamt053Import;
     private runNestedImport;
     private parseFilterValue;
-    private filterFields;
     private sanitizeOutput;
     private getColumns;
     private getValue;