@aderis-erp/cli 1.1.2 → 1.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/commands/access-groups.d.ts +11 -2
- package/dist/commands/access-groups.js +158 -24
- package/dist/commands/account-transaction-allocations.d.ts +11 -2
- package/dist/commands/account-transaction-allocations.js +157 -23
- package/dist/commands/account-transactions.d.ts +15 -2
- package/dist/commands/account-transactions.js +162 -24
- package/dist/commands/accounts.d.ts +11 -2
- package/dist/commands/accounts.js +158 -24
- package/dist/commands/agent-platform.d.ts +11 -3
- package/dist/commands/agent-platform.js +157 -32
- package/dist/commands/agent-runs.d.ts +11 -2
- package/dist/commands/agent-runs.js +157 -23
- package/dist/commands/analytics.d.ts +11 -2
- package/dist/commands/analytics.js +157 -23
- package/dist/commands/api-keys.d.ts +11 -2
- package/dist/commands/api-keys.js +157 -23
- package/dist/commands/async-jobs.d.ts +11 -2
- package/dist/commands/async-jobs.js +158 -24
- package/dist/commands/audit-log.d.ts +11 -2
- package/dist/commands/audit-log.js +157 -23
- package/dist/commands/bank-accounts.d.ts +11 -2
- package/dist/commands/bank-accounts.js +158 -24
- package/dist/commands/bank-integrations.d.ts +11 -2
- package/dist/commands/bank-integrations.js +158 -24
- package/dist/commands/business-partners.d.ts +11 -2
- package/dist/commands/business-partners.js +158 -24
- package/dist/commands/chat.d.ts +11 -2
- package/dist/commands/chat.js +158 -24
- package/dist/commands/credit-card-accounts.d.ts +11 -2
- package/dist/commands/credit-card-accounts.js +158 -24
- package/dist/commands/delivery-notes.d.ts +11 -2
- package/dist/commands/delivery-notes.js +158 -24
- package/dist/commands/dunning-configs.d.ts +11 -2
- package/dist/commands/dunning-configs.js +158 -24
- package/dist/commands/dunning-reminders.d.ts +11 -2
- package/dist/commands/dunning-reminders.js +157 -23
- package/dist/commands/dunning-runs.d.ts +11 -2
- package/dist/commands/dunning-runs.js +157 -23
- package/dist/commands/email-transactions.d.ts +11 -2
- package/dist/commands/email-transactions.js +157 -23
- package/dist/commands/employees.d.ts +13 -2
- package/dist/commands/employees.js +169 -24
- package/dist/commands/entity-configurations.d.ts +11 -2
- package/dist/commands/entity-configurations.js +157 -23
- package/dist/commands/event-mapping-rules.d.ts +56 -0
- package/dist/commands/event-mapping-rules.js +1324 -0
- package/dist/commands/event-processor-mappings.d.ts +11 -2
- package/dist/commands/event-processor-mappings.js +158 -24
- package/dist/commands/files.d.ts +11 -2
- package/dist/commands/files.js +158 -24
- package/dist/commands/health.d.ts +11 -2
- package/dist/commands/health.js +157 -23
- package/dist/commands/imports.d.ts +11 -2
- package/dist/commands/imports.js +157 -23
- package/dist/commands/inbox.d.ts +11 -2
- package/dist/commands/inbox.js +157 -23
- package/dist/commands/integration-identities.d.ts +11 -2
- package/dist/commands/integration-identities.js +157 -23
- package/dist/commands/integrations.d.ts +11 -2
- package/dist/commands/integrations.js +157 -23
- package/dist/commands/item-categories.d.ts +11 -2
- package/dist/commands/item-categories.js +158 -24
- package/dist/commands/items.d.ts +15 -2
- package/dist/commands/items.js +163 -24
- package/dist/commands/journal-lines.d.ts +11 -2
- package/dist/commands/journal-lines.js +157 -23
- package/dist/commands/journals.d.ts +15 -2
- package/dist/commands/journals.js +163 -24
- package/dist/commands/ledgers.d.ts +11 -2
- package/dist/commands/ledgers.js +158 -24
- package/dist/commands/my-account.d.ts +11 -2
- package/dist/commands/my-account.js +157 -23
- package/dist/commands/office-locations.d.ts +11 -2
- package/dist/commands/office-locations.js +158 -24
- package/dist/commands/payment-methods.d.ts +11 -2
- package/dist/commands/payment-methods.js +158 -24
- package/dist/commands/payment-runs.d.ts +11 -2
- package/dist/commands/payment-runs.js +158 -24
- package/dist/commands/payment-terms.d.ts +11 -2
- package/dist/commands/payment-terms.js +159 -25
- package/dist/commands/payments.d.ts +11 -2
- package/dist/commands/payments.js +158 -24
- package/dist/commands/payroll-runs.d.ts +11 -2
- package/dist/commands/payroll-runs.js +158 -24
- package/dist/commands/permissions.d.ts +11 -2
- package/dist/commands/permissions.js +157 -23
- package/dist/commands/price-lists.d.ts +15 -2
- package/dist/commands/price-lists.js +164 -24
- package/dist/commands/processor-mappings.d.ts +11 -2
- package/dist/commands/processor-mappings.js +158 -24
- package/dist/commands/processors.d.ts +11 -2
- package/dist/commands/processors.js +158 -24
- package/dist/commands/purchase-order-types.d.ts +11 -2
- package/dist/commands/purchase-order-types.js +158 -24
- package/dist/commands/purchase-orders.d.ts +11 -2
- package/dist/commands/purchase-orders.js +158 -24
- package/dist/commands/reports.d.ts +11 -2
- package/dist/commands/reports.js +157 -23
- package/dist/commands/roles.d.ts +11 -2
- package/dist/commands/roles.js +158 -24
- package/dist/commands/salary-types.d.ts +11 -2
- package/dist/commands/salary-types.js +158 -24
- package/dist/commands/sales-invoices.d.ts +11 -2
- package/dist/commands/sales-invoices.js +161 -24
- package/dist/commands/sales-orders.d.ts +11 -2
- package/dist/commands/sales-orders.js +158 -24
- package/dist/commands/saved-views.d.ts +11 -2
- package/dist/commands/saved-views.js +157 -23
- package/dist/commands/scheduled-processor-mappings.d.ts +11 -2
- package/dist/commands/scheduled-processor-mappings.js +158 -24
- package/dist/commands/schedules.d.ts +11 -2
- package/dist/commands/schedules.js +158 -24
- package/dist/commands/tags.d.ts +11 -2
- package/dist/commands/tags.js +158 -24
- package/dist/commands/tax-codes.d.ts +11 -2
- package/dist/commands/tax-codes.js +158 -24
- package/dist/commands/tax-matrix.d.ts +11 -2
- package/dist/commands/tax-matrix.js +158 -24
- package/dist/commands/templates.d.ts +11 -2
- package/dist/commands/templates.js +162 -24
- package/dist/commands/tenants.d.ts +11 -2
- package/dist/commands/tenants.js +158 -24
- package/dist/commands/tools.d.ts +11 -2
- package/dist/commands/tools.js +157 -23
- package/dist/commands/users.d.ts +11 -2
- package/dist/commands/users.js +158 -24
- package/dist/commands/vat-declarations.d.ts +11 -2
- package/dist/commands/vat-declarations.js +158 -24
- package/dist/commands/vendor-invoices.d.ts +11 -2
- package/dist/commands/vendor-invoices.js +161 -24
- package/dist/commands/webhooks.d.ts +11 -2
- package/dist/commands/webhooks.js +158 -24
- package/dist/commands/workflows.d.ts +11 -2
- package/dist/commands/workflows.js +157 -23
- package/dist/lib/api-client.d.ts +1 -0
- package/dist/lib/api-client.js +3 -0
- package/oclif.manifest.json +466 -162
- package/package.json +1 -1
|
@@ -1,12 +1,15 @@
|
|
|
1
1
|
import { Command, Args, Flags } from '@oclif/core';
|
|
2
2
|
import { apiRequest, ApiError, isTextualMediaType, normalizeSortBy } from '../lib/api-client.js';
|
|
3
3
|
import { getCurrentContext, getContext, getBaseUrls, hasCredentials, missingCredentialsMessage } from '../lib/config.js';
|
|
4
|
-
//
|
|
5
|
-
|
|
4
|
+
// 'upsert' loops create/update from the CLI, one request per record. It exists
|
|
5
|
+
// only where the API has no import endpoint of its own; those keep the name
|
|
6
|
+
// 'import' and are listed in SERVER_IMPORTS.
|
|
7
|
+
const HAS_UPSERT = true;
|
|
6
8
|
const HAS_EXPORT = true;
|
|
7
9
|
const HAS_CAMT053 = false;
|
|
8
|
-
const
|
|
9
|
-
const
|
|
10
|
+
const SERVER_IMPORTS = [];
|
|
11
|
+
const NESTED_UPSERTS = [];
|
|
12
|
+
const SUBCOMMANDS = [...["list", "create", "get", "update", "delete", "submit", "list-attempts", "list-items", "payload"], ...(HAS_UPSERT ? ['upsert'] : []), ...(HAS_EXPORT ? ['export'] : []), ...NESTED_UPSERTS.map(n => `upsert-${n}`)];
|
|
10
13
|
const ENDPOINTS = {
|
|
11
14
|
'list': { method: 'GET', path: '/v1/async-jobs', summary: 'List the jobs the caller may see', pathParams: [], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
|
|
12
15
|
'create': { method: 'POST', path: '/v1/async-jobs', summary: 'Create a draft job', pathParams: [], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
|
|
@@ -25,7 +28,7 @@ export default class AsyncJobs extends Command {
|
|
|
25
28
|
'<%= config.bin %> async-jobs get <id>',
|
|
26
29
|
'<%= config.bin %> async-jobs create --data \'{...}\'',
|
|
27
30
|
'<%= config.bin %> async-jobs update <id> --set field=value',
|
|
28
|
-
'<%= config.bin %> async-jobs
|
|
31
|
+
'<%= config.bin %> async-jobs upsert --file data.json',
|
|
29
32
|
'<%= config.bin %> async-jobs export --csv > async-jobs.csv',
|
|
30
33
|
];
|
|
31
34
|
static args = {
|
|
@@ -34,7 +37,7 @@ export default class AsyncJobs extends Command {
|
|
|
34
37
|
};
|
|
35
38
|
static flags = {
|
|
36
39
|
context: Flags.string({ char: 'c', aliases: ['config'], env: 'ADERIS_CONTEXT', description: 'Context to use for this command, overriding the current context (alias: --config)' }),
|
|
37
|
-
output: Flags.string({ char: 'o', description: 'Output format (default: table for
|
|
40
|
+
output: Flags.string({ char: 'o', description: 'Output format (default: table for upsert, json for other commands)', options: ['json', 'table', 'csv'] }),
|
|
38
41
|
table: Flags.boolean({ char: 't', description: 'Output as table (shortcut for --output table)' }),
|
|
39
42
|
csv: Flags.boolean({ description: 'Output as CSV (shortcut for --output csv)' }),
|
|
40
43
|
data: Flags.string({ char: 'd', description: 'JSON data for request body' }),
|
|
@@ -54,11 +57,26 @@ export default class AsyncJobs extends Command {
|
|
|
54
57
|
};
|
|
55
58
|
async run() {
|
|
56
59
|
const { args, flags } = await this.parse(AsyncJobs);
|
|
57
|
-
//
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
60
|
+
// Bulk actions. 'import' is the API's own endpoint: one request, answered
|
|
61
|
+
// by a run that records what happened to every record. 'upsert' is the CLI
|
|
62
|
+
// looping create/update. A resource has one or the other, never both.
|
|
63
|
+
if (args.action === 'upsert') {
|
|
64
|
+
if (!HAS_UPSERT) {
|
|
65
|
+
this.error(SERVER_IMPORTS.includes('import')
|
|
66
|
+
? 'This resource is imported by the API. Use: aderis async-jobs import --file data.json'
|
|
67
|
+
: 'Upsert needs both a create and an update endpoint, which this resource does not have');
|
|
68
|
+
}
|
|
69
|
+
await this.runUpsert(flags);
|
|
70
|
+
return;
|
|
71
|
+
}
|
|
72
|
+
if (args.action.startsWith('upsert-')) {
|
|
73
|
+
const suffix = args.action.replace('upsert-', '');
|
|
74
|
+
if (!NESTED_UPSERTS.includes(suffix)) {
|
|
75
|
+
this.error(SERVER_IMPORTS.includes('import-' + suffix)
|
|
76
|
+
? `That resource is imported by the API. Use: aderis async-jobs import-${suffix} <id> --file data.json`
|
|
77
|
+
: `Unknown action: ${args.action}. Available: ${SUBCOMMANDS.join(', ')}`);
|
|
78
|
+
}
|
|
79
|
+
await this.runNestedUpsert(suffix, args.id, flags);
|
|
62
80
|
return;
|
|
63
81
|
}
|
|
64
82
|
// Handle export action specially
|
|
@@ -75,12 +93,17 @@ export default class AsyncJobs extends Command {
|
|
|
75
93
|
await this.runCamt053Import(flags);
|
|
76
94
|
return;
|
|
77
95
|
}
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
96
|
+
if (SERVER_IMPORTS.includes(args.action)) {
|
|
97
|
+
await this.runServerImport(args.action, args.id, flags);
|
|
98
|
+
return;
|
|
99
|
+
}
|
|
100
|
+
// 'import' used to name the CLI's create/update loop on every resource. It
|
|
101
|
+
// now names the API endpoint, which most resources do not have.
|
|
102
|
+
if (args.action === 'import' || args.action.startsWith('import-')) {
|
|
103
|
+
const suffix = args.action === 'import' ? '' : '-' + args.action.replace('import-', '');
|
|
104
|
+
const loops = args.action === 'import' ? HAS_UPSERT : NESTED_UPSERTS.includes(args.action.replace('import-', ''));
|
|
105
|
+
if (loops) {
|
|
106
|
+
this.error(`This resource has no import endpoint. Use: aderis async-jobs upsert${suffix}${suffix ? ' <id>' : ''} --file data.json`);
|
|
84
107
|
}
|
|
85
108
|
}
|
|
86
109
|
const endpoint = ENDPOINTS[args.action];
|
|
@@ -395,7 +418,7 @@ export default class AsyncJobs extends Command {
|
|
|
395
418
|
throw error;
|
|
396
419
|
}
|
|
397
420
|
}
|
|
398
|
-
async
|
|
421
|
+
async runUpsert(flags) {
|
|
399
422
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
400
423
|
if (!context)
|
|
401
424
|
this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
|
|
@@ -459,12 +482,12 @@ export default class AsyncJobs extends Command {
|
|
|
459
482
|
items = [item];
|
|
460
483
|
}
|
|
461
484
|
else {
|
|
462
|
-
this.error('
|
|
485
|
+
this.error('Upsert requires --file, --data, or --set flags');
|
|
463
486
|
}
|
|
464
487
|
const createEndpoint = ENDPOINTS['create'];
|
|
465
488
|
const updateEndpoint = ENDPOINTS['update'];
|
|
466
489
|
if (!createEndpoint || !updateEndpoint) {
|
|
467
|
-
this.error('
|
|
490
|
+
this.error('Upsert requires both create and update endpoints');
|
|
468
491
|
}
|
|
469
492
|
// Helper to extract identifier from item (id, code, or xxxCode)
|
|
470
493
|
const getItemIdentifier = (item) => {
|
|
@@ -607,6 +630,117 @@ export default class AsyncJobs extends Command {
|
|
|
607
630
|
this.log('');
|
|
608
631
|
this.log(`Summary: ${created} created, ${updated} updated, ${errors.length} failed`);
|
|
609
632
|
}
|
|
633
|
+
/**
|
|
634
|
+
* The API's own import: the whole array goes up in one request and comes
|
|
635
|
+
* back as an import run, which records what happened to every record. A bad
|
|
636
|
+
* record lands in errorLog and the rest are still applied, and the run stays
|
|
637
|
+
* readable afterwards with: aderis imports get <id>.
|
|
638
|
+
*/
|
|
639
|
+
async runServerImport(action, parentId, flags) {
|
|
640
|
+
const endpoint = ENDPOINTS[action];
|
|
641
|
+
if (!endpoint)
|
|
642
|
+
this.error(`Unknown action: ${action}. Available: ${SUBCOMMANDS.join(', ')}`);
|
|
643
|
+
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
644
|
+
if (!context)
|
|
645
|
+
this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
|
|
646
|
+
if (!hasCredentials(context))
|
|
647
|
+
this.error(missingCredentialsMessage(context));
|
|
648
|
+
let apiPath = endpoint.path;
|
|
649
|
+
if (endpoint.pathParams.length > 0) {
|
|
650
|
+
if (!parentId)
|
|
651
|
+
this.error(`Missing required argument: id. Usage: aderis async-jobs ${action} <parent-id> --file data.json`);
|
|
652
|
+
apiPath = apiPath.replace(`{${endpoint.pathParams[0]}}`, parentId);
|
|
653
|
+
}
|
|
654
|
+
// The endpoint takes an array. A single object is wrapped, so importing
|
|
655
|
+
// one record reads the same as importing many.
|
|
656
|
+
let records = [];
|
|
657
|
+
if (flags.file) {
|
|
658
|
+
const fsModule = await import('node:fs');
|
|
659
|
+
try {
|
|
660
|
+
const content = JSON.parse(fsModule.readFileSync(flags.file, 'utf-8'));
|
|
661
|
+
records = Array.isArray(content) ? content : [content];
|
|
662
|
+
}
|
|
663
|
+
catch {
|
|
664
|
+
this.error(`Failed to read file: ${flags.file}`);
|
|
665
|
+
}
|
|
666
|
+
}
|
|
667
|
+
else if (flags.data) {
|
|
668
|
+
try {
|
|
669
|
+
const content = JSON.parse(flags.data);
|
|
670
|
+
records = Array.isArray(content) ? content : [content];
|
|
671
|
+
}
|
|
672
|
+
catch {
|
|
673
|
+
this.error('Invalid JSON in --data');
|
|
674
|
+
}
|
|
675
|
+
}
|
|
676
|
+
else {
|
|
677
|
+
this.error('Import requires --file or --data holding a JSON array of records');
|
|
678
|
+
}
|
|
679
|
+
if (records.length === 0)
|
|
680
|
+
this.error('Nothing to import: the input is an empty array');
|
|
681
|
+
const params = { format: 'json' };
|
|
682
|
+
if (flags.mode)
|
|
683
|
+
params.mode = flags.mode;
|
|
684
|
+
if (flags.reference)
|
|
685
|
+
params.reference = flags.reference;
|
|
686
|
+
if (flags.async)
|
|
687
|
+
params.async = true;
|
|
688
|
+
const headers = {};
|
|
689
|
+
if (flags['idempotency-key'])
|
|
690
|
+
headers['Idempotency-Key'] = flags['idempotency-key'];
|
|
691
|
+
if (flags['show-http-request']) {
|
|
692
|
+
const baseUrls = getBaseUrls(context.environment);
|
|
693
|
+
const queryString = '?' + Object.entries(params).map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(String(v))}`).join('&');
|
|
694
|
+
process.stderr.write(`\n${endpoint.method.toUpperCase()} ${baseUrls.api}${apiPath}${queryString}\n`);
|
|
695
|
+
process.stderr.write(`Body: [${records.length} record${records.length === 1 ? '' : 's'}]\n\n`);
|
|
696
|
+
}
|
|
697
|
+
try {
|
|
698
|
+
const response = await apiRequest(endpoint.method, apiPath, {
|
|
699
|
+
contextName: flags.context,
|
|
700
|
+
data: records,
|
|
701
|
+
headers,
|
|
702
|
+
params,
|
|
703
|
+
});
|
|
704
|
+
this.printImportRun(response.data, flags);
|
|
705
|
+
}
|
|
706
|
+
catch (error) {
|
|
707
|
+
if (error instanceof ApiError) {
|
|
708
|
+
this.error(`API Error (${error.status}): ${error.message}`);
|
|
709
|
+
}
|
|
710
|
+
throw error;
|
|
711
|
+
}
|
|
712
|
+
}
|
|
713
|
+
/** Renders an import run: its counts, then whatever the server refused. */
|
|
714
|
+
printImportRun(run, flags) {
|
|
715
|
+
if (flags.output === 'json') {
|
|
716
|
+
this.log(JSON.stringify(run, null, 2));
|
|
717
|
+
return;
|
|
718
|
+
}
|
|
719
|
+
const record = (run ?? {});
|
|
720
|
+
const count = (key) => (typeof record[key] === 'number' ? record[key] : 0);
|
|
721
|
+
const id = record.id ? String(record.id) : '';
|
|
722
|
+
this.log(`Import ${id} - ${String(record.status ?? 'UNKNOWN')}${record.async ? ' (background)' : ''}`);
|
|
723
|
+
this.log(` ${count('inputSize')} submitted, ${count('createdCount')} created, ${count('updatedCount')} updated, ${count('unchangedCount')} unchanged`);
|
|
724
|
+
if (count('errorCount') > 0)
|
|
725
|
+
this.log(` ${count('errorCount')} not applied: ${count('refusedCount')} refused, ${count('failedCount')} failed`);
|
|
726
|
+
if (count('warningCount') > 0)
|
|
727
|
+
this.log(` ${count('warningCount')} applied with a warning`);
|
|
728
|
+
// errorLog is keyed by the record's identifier, then by field name.
|
|
729
|
+
const errorLog = record.errorLog;
|
|
730
|
+
if (errorLog && Object.keys(errorLog).length > 0) {
|
|
731
|
+
this.log('');
|
|
732
|
+
for (const [key, fields] of Object.entries(errorLog)) {
|
|
733
|
+
for (const [field, messages] of Object.entries(fields ?? {})) {
|
|
734
|
+
for (const message of messages ?? [])
|
|
735
|
+
this.log(` ${key} ${field}: ${message}`);
|
|
736
|
+
}
|
|
737
|
+
}
|
|
738
|
+
}
|
|
739
|
+
if (record.async && id) {
|
|
740
|
+
this.log('');
|
|
741
|
+
this.log(`Follow it with: aderis imports get ${id}`);
|
|
742
|
+
}
|
|
743
|
+
}
|
|
610
744
|
async runExport(flags) {
|
|
611
745
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
612
746
|
if (!context)
|
|
@@ -785,9 +919,9 @@ export default class AsyncJobs extends Command {
|
|
|
785
919
|
throw error;
|
|
786
920
|
}
|
|
787
921
|
}
|
|
788
|
-
async
|
|
922
|
+
async runNestedUpsert(suffix, parentId, flags) {
|
|
789
923
|
if (!parentId) {
|
|
790
|
-
this.error(`Missing required argument: id. Usage: aderis async-jobs
|
|
924
|
+
this.error(`Missing required argument: id. Usage: aderis async-jobs upsert-${suffix} <parent-id> --file data.json`);
|
|
791
925
|
}
|
|
792
926
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
793
927
|
if (!context)
|
|
@@ -852,12 +986,12 @@ export default class AsyncJobs extends Command {
|
|
|
852
986
|
items = [item];
|
|
853
987
|
}
|
|
854
988
|
else {
|
|
855
|
-
this.error(
|
|
989
|
+
this.error('Upsert requires --file, --data, or --set flags');
|
|
856
990
|
}
|
|
857
991
|
const createEndpoint = ENDPOINTS[`create-${suffix}`];
|
|
858
992
|
const updateEndpoint = ENDPOINTS[`update-${suffix}`];
|
|
859
993
|
if (!createEndpoint || !updateEndpoint) {
|
|
860
|
-
this.error(`
|
|
994
|
+
this.error(`Upsert requires both create-${suffix} and update-${suffix} endpoints`);
|
|
861
995
|
}
|
|
862
996
|
// Build the base path with parent ID (first path param)
|
|
863
997
|
const firstParam = createEndpoint.pathParams[0];
|
|
@@ -27,10 +27,19 @@ export default class AuditLog extends Command {
|
|
|
27
27
|
'show-http-request': import("@oclif/core/interfaces").BooleanFlag<boolean>;
|
|
28
28
|
};
|
|
29
29
|
run(): Promise<void>;
|
|
30
|
-
private
|
|
30
|
+
private runUpsert;
|
|
31
|
+
/**
|
|
32
|
+
* The API's own import: the whole array goes up in one request and comes
|
|
33
|
+
* back as an import run, which records what happened to every record. A bad
|
|
34
|
+
* record lands in errorLog and the rest are still applied, and the run stays
|
|
35
|
+
* readable afterwards with: aderis imports get <id>.
|
|
36
|
+
*/
|
|
37
|
+
private runServerImport;
|
|
38
|
+
/** Renders an import run: its counts, then whatever the server refused. */
|
|
39
|
+
private printImportRun;
|
|
31
40
|
private runExport;
|
|
32
41
|
private runCamt053Import;
|
|
33
|
-
private
|
|
42
|
+
private runNestedUpsert;
|
|
34
43
|
private parseFilterValue;
|
|
35
44
|
/** The page line under a table: which page, how many, and any sums the API returned. */
|
|
36
45
|
private printPageSummary;
|
|
@@ -1,12 +1,15 @@
|
|
|
1
1
|
import { Command, Args, Flags } from '@oclif/core';
|
|
2
2
|
import { apiRequest, ApiError, isTextualMediaType, normalizeSortBy } from '../lib/api-client.js';
|
|
3
3
|
import { getCurrentContext, getContext, getBaseUrls, hasCredentials, missingCredentialsMessage } from '../lib/config.js';
|
|
4
|
-
//
|
|
5
|
-
|
|
4
|
+
// 'upsert' loops create/update from the CLI, one request per record. It exists
|
|
5
|
+
// only where the API has no import endpoint of its own; those keep the name
|
|
6
|
+
// 'import' and are listed in SERVER_IMPORTS.
|
|
7
|
+
const HAS_UPSERT = false;
|
|
6
8
|
const HAS_EXPORT = true;
|
|
7
9
|
const HAS_CAMT053 = false;
|
|
8
|
-
const
|
|
9
|
-
const
|
|
10
|
+
const SERVER_IMPORTS = [];
|
|
11
|
+
const NESTED_UPSERTS = [];
|
|
12
|
+
const SUBCOMMANDS = [...["list", "get"], ...(HAS_UPSERT ? ['upsert'] : []), ...(HAS_EXPORT ? ['export'] : []), ...NESTED_UPSERTS.map(n => `upsert-${n}`)];
|
|
10
13
|
const ENDPOINTS = {
|
|
11
14
|
'list': { method: 'GET', path: '/v1/audit-logs', summary: 'Get audit log entries', pathParams: [], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
|
|
12
15
|
'get': { method: 'GET', path: '/v1/audit-logs/{id}', summary: 'Get a single audit log entry', pathParams: ['id'], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
|
|
@@ -24,7 +27,7 @@ export default class AuditLog extends Command {
|
|
|
24
27
|
};
|
|
25
28
|
static flags = {
|
|
26
29
|
context: Flags.string({ char: 'c', aliases: ['config'], env: 'ADERIS_CONTEXT', description: 'Context to use for this command, overriding the current context (alias: --config)' }),
|
|
27
|
-
output: Flags.string({ char: 'o', description: 'Output format (default: table for
|
|
30
|
+
output: Flags.string({ char: 'o', description: 'Output format (default: table for upsert, json for other commands)', options: ['json', 'table', 'csv'] }),
|
|
28
31
|
table: Flags.boolean({ char: 't', description: 'Output as table (shortcut for --output table)' }),
|
|
29
32
|
csv: Flags.boolean({ description: 'Output as CSV (shortcut for --output csv)' }),
|
|
30
33
|
data: Flags.string({ char: 'd', description: 'JSON data for request body' }),
|
|
@@ -44,11 +47,26 @@ export default class AuditLog extends Command {
|
|
|
44
47
|
};
|
|
45
48
|
async run() {
|
|
46
49
|
const { args, flags } = await this.parse(AuditLog);
|
|
47
|
-
//
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
50
|
+
// Bulk actions. 'import' is the API's own endpoint: one request, answered
|
|
51
|
+
// by a run that records what happened to every record. 'upsert' is the CLI
|
|
52
|
+
// looping create/update. A resource has one or the other, never both.
|
|
53
|
+
if (args.action === 'upsert') {
|
|
54
|
+
if (!HAS_UPSERT) {
|
|
55
|
+
this.error(SERVER_IMPORTS.includes('import')
|
|
56
|
+
? 'This resource is imported by the API. Use: aderis audit-log import --file data.json'
|
|
57
|
+
: 'Upsert needs both a create and an update endpoint, which this resource does not have');
|
|
58
|
+
}
|
|
59
|
+
await this.runUpsert(flags);
|
|
60
|
+
return;
|
|
61
|
+
}
|
|
62
|
+
if (args.action.startsWith('upsert-')) {
|
|
63
|
+
const suffix = args.action.replace('upsert-', '');
|
|
64
|
+
if (!NESTED_UPSERTS.includes(suffix)) {
|
|
65
|
+
this.error(SERVER_IMPORTS.includes('import-' + suffix)
|
|
66
|
+
? `That resource is imported by the API. Use: aderis audit-log import-${suffix} <id> --file data.json`
|
|
67
|
+
: `Unknown action: ${args.action}. Available: ${SUBCOMMANDS.join(', ')}`);
|
|
68
|
+
}
|
|
69
|
+
await this.runNestedUpsert(suffix, args.id, flags);
|
|
52
70
|
return;
|
|
53
71
|
}
|
|
54
72
|
// Handle export action specially
|
|
@@ -65,12 +83,17 @@ export default class AuditLog extends Command {
|
|
|
65
83
|
await this.runCamt053Import(flags);
|
|
66
84
|
return;
|
|
67
85
|
}
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
86
|
+
if (SERVER_IMPORTS.includes(args.action)) {
|
|
87
|
+
await this.runServerImport(args.action, args.id, flags);
|
|
88
|
+
return;
|
|
89
|
+
}
|
|
90
|
+
// 'import' used to name the CLI's create/update loop on every resource. It
|
|
91
|
+
// now names the API endpoint, which most resources do not have.
|
|
92
|
+
if (args.action === 'import' || args.action.startsWith('import-')) {
|
|
93
|
+
const suffix = args.action === 'import' ? '' : '-' + args.action.replace('import-', '');
|
|
94
|
+
const loops = args.action === 'import' ? HAS_UPSERT : NESTED_UPSERTS.includes(args.action.replace('import-', ''));
|
|
95
|
+
if (loops) {
|
|
96
|
+
this.error(`This resource has no import endpoint. Use: aderis audit-log upsert${suffix}${suffix ? ' <id>' : ''} --file data.json`);
|
|
74
97
|
}
|
|
75
98
|
}
|
|
76
99
|
const endpoint = ENDPOINTS[args.action];
|
|
@@ -385,7 +408,7 @@ export default class AuditLog extends Command {
|
|
|
385
408
|
throw error;
|
|
386
409
|
}
|
|
387
410
|
}
|
|
388
|
-
async
|
|
411
|
+
async runUpsert(flags) {
|
|
389
412
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
390
413
|
if (!context)
|
|
391
414
|
this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
|
|
@@ -449,12 +472,12 @@ export default class AuditLog extends Command {
|
|
|
449
472
|
items = [item];
|
|
450
473
|
}
|
|
451
474
|
else {
|
|
452
|
-
this.error('
|
|
475
|
+
this.error('Upsert requires --file, --data, or --set flags');
|
|
453
476
|
}
|
|
454
477
|
const createEndpoint = ENDPOINTS['create'];
|
|
455
478
|
const updateEndpoint = ENDPOINTS['update'];
|
|
456
479
|
if (!createEndpoint || !updateEndpoint) {
|
|
457
|
-
this.error('
|
|
480
|
+
this.error('Upsert requires both create and update endpoints');
|
|
458
481
|
}
|
|
459
482
|
// Helper to extract identifier from item (id, code, or xxxCode)
|
|
460
483
|
const getItemIdentifier = (item) => {
|
|
@@ -597,6 +620,117 @@ export default class AuditLog extends Command {
|
|
|
597
620
|
this.log('');
|
|
598
621
|
this.log(`Summary: ${created} created, ${updated} updated, ${errors.length} failed`);
|
|
599
622
|
}
|
|
623
|
+
/**
|
|
624
|
+
* The API's own import: the whole array goes up in one request and comes
|
|
625
|
+
* back as an import run, which records what happened to every record. A bad
|
|
626
|
+
* record lands in errorLog and the rest are still applied, and the run stays
|
|
627
|
+
* readable afterwards with: aderis imports get <id>.
|
|
628
|
+
*/
|
|
629
|
+
async runServerImport(action, parentId, flags) {
|
|
630
|
+
const endpoint = ENDPOINTS[action];
|
|
631
|
+
if (!endpoint)
|
|
632
|
+
this.error(`Unknown action: ${action}. Available: ${SUBCOMMANDS.join(', ')}`);
|
|
633
|
+
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
634
|
+
if (!context)
|
|
635
|
+
this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
|
|
636
|
+
if (!hasCredentials(context))
|
|
637
|
+
this.error(missingCredentialsMessage(context));
|
|
638
|
+
let apiPath = endpoint.path;
|
|
639
|
+
if (endpoint.pathParams.length > 0) {
|
|
640
|
+
if (!parentId)
|
|
641
|
+
this.error(`Missing required argument: id. Usage: aderis audit-log ${action} <parent-id> --file data.json`);
|
|
642
|
+
apiPath = apiPath.replace(`{${endpoint.pathParams[0]}}`, parentId);
|
|
643
|
+
}
|
|
644
|
+
// The endpoint takes an array. A single object is wrapped, so importing
|
|
645
|
+
// one record reads the same as importing many.
|
|
646
|
+
let records = [];
|
|
647
|
+
if (flags.file) {
|
|
648
|
+
const fsModule = await import('node:fs');
|
|
649
|
+
try {
|
|
650
|
+
const content = JSON.parse(fsModule.readFileSync(flags.file, 'utf-8'));
|
|
651
|
+
records = Array.isArray(content) ? content : [content];
|
|
652
|
+
}
|
|
653
|
+
catch {
|
|
654
|
+
this.error(`Failed to read file: ${flags.file}`);
|
|
655
|
+
}
|
|
656
|
+
}
|
|
657
|
+
else if (flags.data) {
|
|
658
|
+
try {
|
|
659
|
+
const content = JSON.parse(flags.data);
|
|
660
|
+
records = Array.isArray(content) ? content : [content];
|
|
661
|
+
}
|
|
662
|
+
catch {
|
|
663
|
+
this.error('Invalid JSON in --data');
|
|
664
|
+
}
|
|
665
|
+
}
|
|
666
|
+
else {
|
|
667
|
+
this.error('Import requires --file or --data holding a JSON array of records');
|
|
668
|
+
}
|
|
669
|
+
if (records.length === 0)
|
|
670
|
+
this.error('Nothing to import: the input is an empty array');
|
|
671
|
+
const params = { format: 'json' };
|
|
672
|
+
if (flags.mode)
|
|
673
|
+
params.mode = flags.mode;
|
|
674
|
+
if (flags.reference)
|
|
675
|
+
params.reference = flags.reference;
|
|
676
|
+
if (flags.async)
|
|
677
|
+
params.async = true;
|
|
678
|
+
const headers = {};
|
|
679
|
+
if (flags['idempotency-key'])
|
|
680
|
+
headers['Idempotency-Key'] = flags['idempotency-key'];
|
|
681
|
+
if (flags['show-http-request']) {
|
|
682
|
+
const baseUrls = getBaseUrls(context.environment);
|
|
683
|
+
const queryString = '?' + Object.entries(params).map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(String(v))}`).join('&');
|
|
684
|
+
process.stderr.write(`\n${endpoint.method.toUpperCase()} ${baseUrls.api}${apiPath}${queryString}\n`);
|
|
685
|
+
process.stderr.write(`Body: [${records.length} record${records.length === 1 ? '' : 's'}]\n\n`);
|
|
686
|
+
}
|
|
687
|
+
try {
|
|
688
|
+
const response = await apiRequest(endpoint.method, apiPath, {
|
|
689
|
+
contextName: flags.context,
|
|
690
|
+
data: records,
|
|
691
|
+
headers,
|
|
692
|
+
params,
|
|
693
|
+
});
|
|
694
|
+
this.printImportRun(response.data, flags);
|
|
695
|
+
}
|
|
696
|
+
catch (error) {
|
|
697
|
+
if (error instanceof ApiError) {
|
|
698
|
+
this.error(`API Error (${error.status}): ${error.message}`);
|
|
699
|
+
}
|
|
700
|
+
throw error;
|
|
701
|
+
}
|
|
702
|
+
}
|
|
703
|
+
/** Renders an import run: its counts, then whatever the server refused. */
|
|
704
|
+
printImportRun(run, flags) {
|
|
705
|
+
if (flags.output === 'json') {
|
|
706
|
+
this.log(JSON.stringify(run, null, 2));
|
|
707
|
+
return;
|
|
708
|
+
}
|
|
709
|
+
const record = (run ?? {});
|
|
710
|
+
const count = (key) => (typeof record[key] === 'number' ? record[key] : 0);
|
|
711
|
+
const id = record.id ? String(record.id) : '';
|
|
712
|
+
this.log(`Import ${id} - ${String(record.status ?? 'UNKNOWN')}${record.async ? ' (background)' : ''}`);
|
|
713
|
+
this.log(` ${count('inputSize')} submitted, ${count('createdCount')} created, ${count('updatedCount')} updated, ${count('unchangedCount')} unchanged`);
|
|
714
|
+
if (count('errorCount') > 0)
|
|
715
|
+
this.log(` ${count('errorCount')} not applied: ${count('refusedCount')} refused, ${count('failedCount')} failed`);
|
|
716
|
+
if (count('warningCount') > 0)
|
|
717
|
+
this.log(` ${count('warningCount')} applied with a warning`);
|
|
718
|
+
// errorLog is keyed by the record's identifier, then by field name.
|
|
719
|
+
const errorLog = record.errorLog;
|
|
720
|
+
if (errorLog && Object.keys(errorLog).length > 0) {
|
|
721
|
+
this.log('');
|
|
722
|
+
for (const [key, fields] of Object.entries(errorLog)) {
|
|
723
|
+
for (const [field, messages] of Object.entries(fields ?? {})) {
|
|
724
|
+
for (const message of messages ?? [])
|
|
725
|
+
this.log(` ${key} ${field}: ${message}`);
|
|
726
|
+
}
|
|
727
|
+
}
|
|
728
|
+
}
|
|
729
|
+
if (record.async && id) {
|
|
730
|
+
this.log('');
|
|
731
|
+
this.log(`Follow it with: aderis imports get ${id}`);
|
|
732
|
+
}
|
|
733
|
+
}
|
|
600
734
|
async runExport(flags) {
|
|
601
735
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
602
736
|
if (!context)
|
|
@@ -775,9 +909,9 @@ export default class AuditLog extends Command {
|
|
|
775
909
|
throw error;
|
|
776
910
|
}
|
|
777
911
|
}
|
|
778
|
-
async
|
|
912
|
+
async runNestedUpsert(suffix, parentId, flags) {
|
|
779
913
|
if (!parentId) {
|
|
780
|
-
this.error(`Missing required argument: id. Usage: aderis audit-log
|
|
914
|
+
this.error(`Missing required argument: id. Usage: aderis audit-log upsert-${suffix} <parent-id> --file data.json`);
|
|
781
915
|
}
|
|
782
916
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
783
917
|
if (!context)
|
|
@@ -842,12 +976,12 @@ export default class AuditLog extends Command {
|
|
|
842
976
|
items = [item];
|
|
843
977
|
}
|
|
844
978
|
else {
|
|
845
|
-
this.error(
|
|
979
|
+
this.error('Upsert requires --file, --data, or --set flags');
|
|
846
980
|
}
|
|
847
981
|
const createEndpoint = ENDPOINTS[`create-${suffix}`];
|
|
848
982
|
const updateEndpoint = ENDPOINTS[`update-${suffix}`];
|
|
849
983
|
if (!createEndpoint || !updateEndpoint) {
|
|
850
|
-
this.error(`
|
|
984
|
+
this.error(`Upsert requires both create-${suffix} and update-${suffix} endpoints`);
|
|
851
985
|
}
|
|
852
986
|
// Build the base path with parent ID (first path param)
|
|
853
987
|
const firstParam = createEndpoint.pathParams[0];
|
|
@@ -29,10 +29,19 @@ export default class BankAccounts extends Command {
|
|
|
29
29
|
'show-http-request': import("@oclif/core/interfaces").BooleanFlag<boolean>;
|
|
30
30
|
};
|
|
31
31
|
run(): Promise<void>;
|
|
32
|
-
private
|
|
32
|
+
private runUpsert;
|
|
33
|
+
/**
|
|
34
|
+
* The API's own import: the whole array goes up in one request and comes
|
|
35
|
+
* back as an import run, which records what happened to every record. A bad
|
|
36
|
+
* record lands in errorLog and the rest are still applied, and the run stays
|
|
37
|
+
* readable afterwards with: aderis imports get <id>.
|
|
38
|
+
*/
|
|
39
|
+
private runServerImport;
|
|
40
|
+
/** Renders an import run: its counts, then whatever the server refused. */
|
|
41
|
+
private printImportRun;
|
|
33
42
|
private runExport;
|
|
34
43
|
private runCamt053Import;
|
|
35
|
-
private
|
|
44
|
+
private runNestedUpsert;
|
|
36
45
|
private parseFilterValue;
|
|
37
46
|
/** The page line under a table: which page, how many, and any sums the API returned. */
|
|
38
47
|
private printPageSummary;
|