@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 = false;
|
|
6
8
|
const HAS_EXPORT = false;
|
|
7
9
|
const HAS_CAMT053 = false;
|
|
8
|
-
const
|
|
9
|
-
const
|
|
10
|
+
const SERVER_IMPORTS = [];
|
|
11
|
+
const NESTED_UPSERTS = [];
|
|
12
|
+
const SUBCOMMANDS = [...["get", "create", "delete"], ...(HAS_UPSERT ? ['upsert'] : []), ...(HAS_EXPORT ? ['export'] : []), ...NESTED_UPSERTS.map(n => `upsert-${n}`)];
|
|
10
13
|
const ENDPOINTS = {
|
|
11
14
|
'get': { method: 'GET', path: '/v1/saved-views', summary: 'List saved views for a page', pathParams: [], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
|
|
12
15
|
'create': { method: 'POST', path: '/v1/saved-views', summary: 'Create a saved view', pathParams: [], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
|
|
@@ -24,7 +27,7 @@ export default class SavedViews 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 SavedViews extends Command {
|
|
|
44
47
|
};
|
|
45
48
|
async run() {
|
|
46
49
|
const { args, flags } = await this.parse(SavedViews);
|
|
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 saved-views 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 saved-views 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 SavedViews 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 saved-views 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 SavedViews 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 SavedViews 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 SavedViews 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 saved-views ${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 SavedViews 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 saved-views
|
|
914
|
+
this.error(`Missing required argument: id. Usage: aderis saved-views 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 SavedViews 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];
|
|
@@ -27,10 +27,19 @@ export default class ScheduledProcessorMappings 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 = 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"], ...(HAS_UPSERT ? ['upsert'] : []), ...(HAS_EXPORT ? ['export'] : []), ...NESTED_UPSERTS.map(n => `upsert-${n}`)];
|
|
10
13
|
const ENDPOINTS = {
|
|
11
14
|
'list': { method: 'GET', path: '/v1/scheduled-processor-mappings', summary: 'List all scheduled processor mappings for the tenant', pathParams: [], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
|
|
12
15
|
'create': { method: 'POST', path: '/v1/scheduled-processor-mappings', summary: 'Schedule a processor to run on a cron expression', pathParams: [], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
|
|
@@ -21,7 +24,7 @@ export default class ScheduledProcessorMappings extends Command {
|
|
|
21
24
|
'<%= config.bin %> scheduled-processor-mappings get <id>',
|
|
22
25
|
'<%= config.bin %> scheduled-processor-mappings create --data \'{...}\'',
|
|
23
26
|
'<%= config.bin %> scheduled-processor-mappings update <id> --set field=value',
|
|
24
|
-
'<%= config.bin %> scheduled-processor-mappings
|
|
27
|
+
'<%= config.bin %> scheduled-processor-mappings upsert --file data.json',
|
|
25
28
|
'<%= config.bin %> scheduled-processor-mappings export --csv > scheduled-processor-mappings.csv',
|
|
26
29
|
];
|
|
27
30
|
static args = {
|
|
@@ -30,7 +33,7 @@ export default class ScheduledProcessorMappings extends Command {
|
|
|
30
33
|
};
|
|
31
34
|
static flags = {
|
|
32
35
|
context: Flags.string({ char: 'c', aliases: ['config'], env: 'ADERIS_CONTEXT', description: 'Context to use for this command, overriding the current context (alias: --config)' }),
|
|
33
|
-
output: Flags.string({ char: 'o', description: 'Output format (default: table for
|
|
36
|
+
output: Flags.string({ char: 'o', description: 'Output format (default: table for upsert, json for other commands)', options: ['json', 'table', 'csv'] }),
|
|
34
37
|
table: Flags.boolean({ char: 't', description: 'Output as table (shortcut for --output table)' }),
|
|
35
38
|
csv: Flags.boolean({ description: 'Output as CSV (shortcut for --output csv)' }),
|
|
36
39
|
data: Flags.string({ char: 'd', description: 'JSON data for request body' }),
|
|
@@ -50,11 +53,26 @@ export default class ScheduledProcessorMappings extends Command {
|
|
|
50
53
|
};
|
|
51
54
|
async run() {
|
|
52
55
|
const { args, flags } = await this.parse(ScheduledProcessorMappings);
|
|
53
|
-
//
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
56
|
+
// Bulk actions. 'import' is the API's own endpoint: one request, answered
|
|
57
|
+
// by a run that records what happened to every record. 'upsert' is the CLI
|
|
58
|
+
// looping create/update. A resource has one or the other, never both.
|
|
59
|
+
if (args.action === 'upsert') {
|
|
60
|
+
if (!HAS_UPSERT) {
|
|
61
|
+
this.error(SERVER_IMPORTS.includes('import')
|
|
62
|
+
? 'This resource is imported by the API. Use: aderis scheduled-processor-mappings import --file data.json'
|
|
63
|
+
: 'Upsert needs both a create and an update endpoint, which this resource does not have');
|
|
64
|
+
}
|
|
65
|
+
await this.runUpsert(flags);
|
|
66
|
+
return;
|
|
67
|
+
}
|
|
68
|
+
if (args.action.startsWith('upsert-')) {
|
|
69
|
+
const suffix = args.action.replace('upsert-', '');
|
|
70
|
+
if (!NESTED_UPSERTS.includes(suffix)) {
|
|
71
|
+
this.error(SERVER_IMPORTS.includes('import-' + suffix)
|
|
72
|
+
? `That resource is imported by the API. Use: aderis scheduled-processor-mappings import-${suffix} <id> --file data.json`
|
|
73
|
+
: `Unknown action: ${args.action}. Available: ${SUBCOMMANDS.join(', ')}`);
|
|
74
|
+
}
|
|
75
|
+
await this.runNestedUpsert(suffix, args.id, flags);
|
|
58
76
|
return;
|
|
59
77
|
}
|
|
60
78
|
// Handle export action specially
|
|
@@ -71,12 +89,17 @@ export default class ScheduledProcessorMappings extends Command {
|
|
|
71
89
|
await this.runCamt053Import(flags);
|
|
72
90
|
return;
|
|
73
91
|
}
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
92
|
+
if (SERVER_IMPORTS.includes(args.action)) {
|
|
93
|
+
await this.runServerImport(args.action, args.id, flags);
|
|
94
|
+
return;
|
|
95
|
+
}
|
|
96
|
+
// 'import' used to name the CLI's create/update loop on every resource. It
|
|
97
|
+
// now names the API endpoint, which most resources do not have.
|
|
98
|
+
if (args.action === 'import' || args.action.startsWith('import-')) {
|
|
99
|
+
const suffix = args.action === 'import' ? '' : '-' + args.action.replace('import-', '');
|
|
100
|
+
const loops = args.action === 'import' ? HAS_UPSERT : NESTED_UPSERTS.includes(args.action.replace('import-', ''));
|
|
101
|
+
if (loops) {
|
|
102
|
+
this.error(`This resource has no import endpoint. Use: aderis scheduled-processor-mappings upsert${suffix}${suffix ? ' <id>' : ''} --file data.json`);
|
|
80
103
|
}
|
|
81
104
|
}
|
|
82
105
|
const endpoint = ENDPOINTS[args.action];
|
|
@@ -391,7 +414,7 @@ export default class ScheduledProcessorMappings extends Command {
|
|
|
391
414
|
throw error;
|
|
392
415
|
}
|
|
393
416
|
}
|
|
394
|
-
async
|
|
417
|
+
async runUpsert(flags) {
|
|
395
418
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
396
419
|
if (!context)
|
|
397
420
|
this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
|
|
@@ -455,12 +478,12 @@ export default class ScheduledProcessorMappings extends Command {
|
|
|
455
478
|
items = [item];
|
|
456
479
|
}
|
|
457
480
|
else {
|
|
458
|
-
this.error('
|
|
481
|
+
this.error('Upsert requires --file, --data, or --set flags');
|
|
459
482
|
}
|
|
460
483
|
const createEndpoint = ENDPOINTS['create'];
|
|
461
484
|
const updateEndpoint = ENDPOINTS['update'];
|
|
462
485
|
if (!createEndpoint || !updateEndpoint) {
|
|
463
|
-
this.error('
|
|
486
|
+
this.error('Upsert requires both create and update endpoints');
|
|
464
487
|
}
|
|
465
488
|
// Helper to extract identifier from item (id, code, or xxxCode)
|
|
466
489
|
const getItemIdentifier = (item) => {
|
|
@@ -603,6 +626,117 @@ export default class ScheduledProcessorMappings extends Command {
|
|
|
603
626
|
this.log('');
|
|
604
627
|
this.log(`Summary: ${created} created, ${updated} updated, ${errors.length} failed`);
|
|
605
628
|
}
|
|
629
|
+
/**
|
|
630
|
+
* The API's own import: the whole array goes up in one request and comes
|
|
631
|
+
* back as an import run, which records what happened to every record. A bad
|
|
632
|
+
* record lands in errorLog and the rest are still applied, and the run stays
|
|
633
|
+
* readable afterwards with: aderis imports get <id>.
|
|
634
|
+
*/
|
|
635
|
+
async runServerImport(action, parentId, flags) {
|
|
636
|
+
const endpoint = ENDPOINTS[action];
|
|
637
|
+
if (!endpoint)
|
|
638
|
+
this.error(`Unknown action: ${action}. Available: ${SUBCOMMANDS.join(', ')}`);
|
|
639
|
+
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
640
|
+
if (!context)
|
|
641
|
+
this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
|
|
642
|
+
if (!hasCredentials(context))
|
|
643
|
+
this.error(missingCredentialsMessage(context));
|
|
644
|
+
let apiPath = endpoint.path;
|
|
645
|
+
if (endpoint.pathParams.length > 0) {
|
|
646
|
+
if (!parentId)
|
|
647
|
+
this.error(`Missing required argument: id. Usage: aderis scheduled-processor-mappings ${action} <parent-id> --file data.json`);
|
|
648
|
+
apiPath = apiPath.replace(`{${endpoint.pathParams[0]}}`, parentId);
|
|
649
|
+
}
|
|
650
|
+
// The endpoint takes an array. A single object is wrapped, so importing
|
|
651
|
+
// one record reads the same as importing many.
|
|
652
|
+
let records = [];
|
|
653
|
+
if (flags.file) {
|
|
654
|
+
const fsModule = await import('node:fs');
|
|
655
|
+
try {
|
|
656
|
+
const content = JSON.parse(fsModule.readFileSync(flags.file, 'utf-8'));
|
|
657
|
+
records = Array.isArray(content) ? content : [content];
|
|
658
|
+
}
|
|
659
|
+
catch {
|
|
660
|
+
this.error(`Failed to read file: ${flags.file}`);
|
|
661
|
+
}
|
|
662
|
+
}
|
|
663
|
+
else if (flags.data) {
|
|
664
|
+
try {
|
|
665
|
+
const content = JSON.parse(flags.data);
|
|
666
|
+
records = Array.isArray(content) ? content : [content];
|
|
667
|
+
}
|
|
668
|
+
catch {
|
|
669
|
+
this.error('Invalid JSON in --data');
|
|
670
|
+
}
|
|
671
|
+
}
|
|
672
|
+
else {
|
|
673
|
+
this.error('Import requires --file or --data holding a JSON array of records');
|
|
674
|
+
}
|
|
675
|
+
if (records.length === 0)
|
|
676
|
+
this.error('Nothing to import: the input is an empty array');
|
|
677
|
+
const params = { format: 'json' };
|
|
678
|
+
if (flags.mode)
|
|
679
|
+
params.mode = flags.mode;
|
|
680
|
+
if (flags.reference)
|
|
681
|
+
params.reference = flags.reference;
|
|
682
|
+
if (flags.async)
|
|
683
|
+
params.async = true;
|
|
684
|
+
const headers = {};
|
|
685
|
+
if (flags['idempotency-key'])
|
|
686
|
+
headers['Idempotency-Key'] = flags['idempotency-key'];
|
|
687
|
+
if (flags['show-http-request']) {
|
|
688
|
+
const baseUrls = getBaseUrls(context.environment);
|
|
689
|
+
const queryString = '?' + Object.entries(params).map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(String(v))}`).join('&');
|
|
690
|
+
process.stderr.write(`\n${endpoint.method.toUpperCase()} ${baseUrls.api}${apiPath}${queryString}\n`);
|
|
691
|
+
process.stderr.write(`Body: [${records.length} record${records.length === 1 ? '' : 's'}]\n\n`);
|
|
692
|
+
}
|
|
693
|
+
try {
|
|
694
|
+
const response = await apiRequest(endpoint.method, apiPath, {
|
|
695
|
+
contextName: flags.context,
|
|
696
|
+
data: records,
|
|
697
|
+
headers,
|
|
698
|
+
params,
|
|
699
|
+
});
|
|
700
|
+
this.printImportRun(response.data, flags);
|
|
701
|
+
}
|
|
702
|
+
catch (error) {
|
|
703
|
+
if (error instanceof ApiError) {
|
|
704
|
+
this.error(`API Error (${error.status}): ${error.message}`);
|
|
705
|
+
}
|
|
706
|
+
throw error;
|
|
707
|
+
}
|
|
708
|
+
}
|
|
709
|
+
/** Renders an import run: its counts, then whatever the server refused. */
|
|
710
|
+
printImportRun(run, flags) {
|
|
711
|
+
if (flags.output === 'json') {
|
|
712
|
+
this.log(JSON.stringify(run, null, 2));
|
|
713
|
+
return;
|
|
714
|
+
}
|
|
715
|
+
const record = (run ?? {});
|
|
716
|
+
const count = (key) => (typeof record[key] === 'number' ? record[key] : 0);
|
|
717
|
+
const id = record.id ? String(record.id) : '';
|
|
718
|
+
this.log(`Import ${id} - ${String(record.status ?? 'UNKNOWN')}${record.async ? ' (background)' : ''}`);
|
|
719
|
+
this.log(` ${count('inputSize')} submitted, ${count('createdCount')} created, ${count('updatedCount')} updated, ${count('unchangedCount')} unchanged`);
|
|
720
|
+
if (count('errorCount') > 0)
|
|
721
|
+
this.log(` ${count('errorCount')} not applied: ${count('refusedCount')} refused, ${count('failedCount')} failed`);
|
|
722
|
+
if (count('warningCount') > 0)
|
|
723
|
+
this.log(` ${count('warningCount')} applied with a warning`);
|
|
724
|
+
// errorLog is keyed by the record's identifier, then by field name.
|
|
725
|
+
const errorLog = record.errorLog;
|
|
726
|
+
if (errorLog && Object.keys(errorLog).length > 0) {
|
|
727
|
+
this.log('');
|
|
728
|
+
for (const [key, fields] of Object.entries(errorLog)) {
|
|
729
|
+
for (const [field, messages] of Object.entries(fields ?? {})) {
|
|
730
|
+
for (const message of messages ?? [])
|
|
731
|
+
this.log(` ${key} ${field}: ${message}`);
|
|
732
|
+
}
|
|
733
|
+
}
|
|
734
|
+
}
|
|
735
|
+
if (record.async && id) {
|
|
736
|
+
this.log('');
|
|
737
|
+
this.log(`Follow it with: aderis imports get ${id}`);
|
|
738
|
+
}
|
|
739
|
+
}
|
|
606
740
|
async runExport(flags) {
|
|
607
741
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
608
742
|
if (!context)
|
|
@@ -781,9 +915,9 @@ export default class ScheduledProcessorMappings extends Command {
|
|
|
781
915
|
throw error;
|
|
782
916
|
}
|
|
783
917
|
}
|
|
784
|
-
async
|
|
918
|
+
async runNestedUpsert(suffix, parentId, flags) {
|
|
785
919
|
if (!parentId) {
|
|
786
|
-
this.error(`Missing required argument: id. Usage: aderis scheduled-processor-mappings
|
|
920
|
+
this.error(`Missing required argument: id. Usage: aderis scheduled-processor-mappings upsert-${suffix} <parent-id> --file data.json`);
|
|
787
921
|
}
|
|
788
922
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
789
923
|
if (!context)
|
|
@@ -848,12 +982,12 @@ export default class ScheduledProcessorMappings extends Command {
|
|
|
848
982
|
items = [item];
|
|
849
983
|
}
|
|
850
984
|
else {
|
|
851
|
-
this.error(
|
|
985
|
+
this.error('Upsert requires --file, --data, or --set flags');
|
|
852
986
|
}
|
|
853
987
|
const createEndpoint = ENDPOINTS[`create-${suffix}`];
|
|
854
988
|
const updateEndpoint = ENDPOINTS[`update-${suffix}`];
|
|
855
989
|
if (!createEndpoint || !updateEndpoint) {
|
|
856
|
-
this.error(`
|
|
990
|
+
this.error(`Upsert requires both create-${suffix} and update-${suffix} endpoints`);
|
|
857
991
|
}
|
|
858
992
|
// Build the base path with parent ID (first path param)
|
|
859
993
|
const firstParam = createEndpoint.pathParams[0];
|
|
@@ -27,10 +27,19 @@ export default class Schedules 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;
|