@aderis-erp/cli 1.1.2 → 1.1.4
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/README.md +1 -0
- 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-clients.d.ts +58 -0
- package/dist/commands/api-clients.js +1341 -0
- 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 +159 -25
- 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 +15 -2
- package/dist/commands/credit-card-accounts.js +163 -24
- package/dist/commands/currencies.d.ts +56 -0
- package/dist/commands/currencies.js +1327 -0
- package/dist/commands/custody-accounts.d.ts +56 -0
- package/dist/commands/custody-accounts.js +1335 -0
- package/dist/commands/dashboards.d.ts +57 -0
- package/dist/commands/dashboards.js +1347 -0
- package/dist/commands/delivery-notes.d.ts +11 -2
- package/dist/commands/delivery-notes.js +158 -24
- package/dist/commands/{integration-identities.d.ts → document-checksums.d.ts} +12 -4
- package/dist/commands/{integration-identities.js → document-checksums.js} +162 -36
- 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/financial-instrument-types.d.ts +56 -0
- package/dist/commands/financial-instrument-types.js +1335 -0
- package/dist/commands/financial-instruments.d.ts +56 -0
- package/dist/commands/financial-instruments.js +1335 -0
- 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/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 +165 -26
- 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/{workflows.d.ts → kpis.d.ts} +12 -3
- package/dist/commands/kpis.js +1337 -0
- package/dist/commands/ledgers.d.ts +11 -2
- package/dist/commands/ledgers.js +159 -25
- package/dist/commands/my-account.d.ts +11 -2
- package/dist/commands/my-account.js +157 -23
- package/dist/commands/notifications.d.ts +56 -0
- package/dist/commands/notifications.js +1326 -0
- 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 +159 -25
- 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/settings.d.ts +56 -0
- package/dist/commands/settings.js +1327 -0
- 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 +163 -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 +162 -24
- package/dist/commands/webhooks.d.ts +11 -2
- package/dist/commands/webhooks.js +158 -24
- package/dist/commands/work-summary.d.ts +56 -0
- package/dist/commands/{workflows.js → work-summary.js} +164 -33
- package/dist/lib/api-client.d.ts +1 -0
- package/dist/lib/api-client.js +3 -0
- package/dist/lib/auth/index.js +5 -0
- package/dist/lib/production-guard.d.ts +42 -0
- package/dist/lib/production-guard.js +92 -0
- package/oclif.manifest.json +2358 -442
- package/package.json +1 -1
|
@@ -27,10 +27,19 @@ export default class ApiKeys 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", "create", "api-keys-rotate", "delete"], ...(HAS_UPSERT ? ['upsert'] : []), ...(HAS_EXPORT ? ['export'] : []), ...NESTED_UPSERTS.map(n => `upsert-${n}`)];
|
|
10
13
|
const ENDPOINTS = {
|
|
11
14
|
'list': { method: 'GET', path: '/v1/auth/api-keys', summary: 'List the tenant\'s API keys', pathParams: [], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
|
|
12
15
|
'create': { method: 'POST', path: '/v1/auth/api-keys', summary: 'Create an API key for the tenant', pathParams: [], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: ['permissions'] },
|
|
@@ -26,7 +29,7 @@ export default class ApiKeys extends Command {
|
|
|
26
29
|
};
|
|
27
30
|
static flags = {
|
|
28
31
|
context: Flags.string({ char: 'c', aliases: ['config'], env: 'ADERIS_CONTEXT', description: 'Context to use for this command, overriding the current context (alias: --config)' }),
|
|
29
|
-
output: Flags.string({ char: 'o', description: 'Output format (default: table for
|
|
32
|
+
output: Flags.string({ char: 'o', description: 'Output format (default: table for upsert, json for other commands)', options: ['json', 'table', 'csv'] }),
|
|
30
33
|
table: Flags.boolean({ char: 't', description: 'Output as table (shortcut for --output table)' }),
|
|
31
34
|
csv: Flags.boolean({ description: 'Output as CSV (shortcut for --output csv)' }),
|
|
32
35
|
data: Flags.string({ char: 'd', description: 'JSON data for request body' }),
|
|
@@ -46,11 +49,26 @@ export default class ApiKeys extends Command {
|
|
|
46
49
|
};
|
|
47
50
|
async run() {
|
|
48
51
|
const { args, flags } = await this.parse(ApiKeys);
|
|
49
|
-
//
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
52
|
+
// Bulk actions. 'import' is the API's own endpoint: one request, answered
|
|
53
|
+
// by a run that records what happened to every record. 'upsert' is the CLI
|
|
54
|
+
// looping create/update. A resource has one or the other, never both.
|
|
55
|
+
if (args.action === 'upsert') {
|
|
56
|
+
if (!HAS_UPSERT) {
|
|
57
|
+
this.error(SERVER_IMPORTS.includes('import')
|
|
58
|
+
? 'This resource is imported by the API. Use: aderis api-keys import --file data.json'
|
|
59
|
+
: 'Upsert needs both a create and an update endpoint, which this resource does not have');
|
|
60
|
+
}
|
|
61
|
+
await this.runUpsert(flags);
|
|
62
|
+
return;
|
|
63
|
+
}
|
|
64
|
+
if (args.action.startsWith('upsert-')) {
|
|
65
|
+
const suffix = args.action.replace('upsert-', '');
|
|
66
|
+
if (!NESTED_UPSERTS.includes(suffix)) {
|
|
67
|
+
this.error(SERVER_IMPORTS.includes('import-' + suffix)
|
|
68
|
+
? `That resource is imported by the API. Use: aderis api-keys import-${suffix} <id> --file data.json`
|
|
69
|
+
: `Unknown action: ${args.action}. Available: ${SUBCOMMANDS.join(', ')}`);
|
|
70
|
+
}
|
|
71
|
+
await this.runNestedUpsert(suffix, args.id, flags);
|
|
54
72
|
return;
|
|
55
73
|
}
|
|
56
74
|
// Handle export action specially
|
|
@@ -67,12 +85,17 @@ export default class ApiKeys extends Command {
|
|
|
67
85
|
await this.runCamt053Import(flags);
|
|
68
86
|
return;
|
|
69
87
|
}
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
88
|
+
if (SERVER_IMPORTS.includes(args.action)) {
|
|
89
|
+
await this.runServerImport(args.action, args.id, flags);
|
|
90
|
+
return;
|
|
91
|
+
}
|
|
92
|
+
// 'import' used to name the CLI's create/update loop on every resource. It
|
|
93
|
+
// now names the API endpoint, which most resources do not have.
|
|
94
|
+
if (args.action === 'import' || args.action.startsWith('import-')) {
|
|
95
|
+
const suffix = args.action === 'import' ? '' : '-' + args.action.replace('import-', '');
|
|
96
|
+
const loops = args.action === 'import' ? HAS_UPSERT : NESTED_UPSERTS.includes(args.action.replace('import-', ''));
|
|
97
|
+
if (loops) {
|
|
98
|
+
this.error(`This resource has no import endpoint. Use: aderis api-keys upsert${suffix}${suffix ? ' <id>' : ''} --file data.json`);
|
|
76
99
|
}
|
|
77
100
|
}
|
|
78
101
|
const endpoint = ENDPOINTS[args.action];
|
|
@@ -387,7 +410,7 @@ export default class ApiKeys extends Command {
|
|
|
387
410
|
throw error;
|
|
388
411
|
}
|
|
389
412
|
}
|
|
390
|
-
async
|
|
413
|
+
async runUpsert(flags) {
|
|
391
414
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
392
415
|
if (!context)
|
|
393
416
|
this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
|
|
@@ -451,12 +474,12 @@ export default class ApiKeys extends Command {
|
|
|
451
474
|
items = [item];
|
|
452
475
|
}
|
|
453
476
|
else {
|
|
454
|
-
this.error('
|
|
477
|
+
this.error('Upsert requires --file, --data, or --set flags');
|
|
455
478
|
}
|
|
456
479
|
const createEndpoint = ENDPOINTS['create'];
|
|
457
480
|
const updateEndpoint = ENDPOINTS['update'];
|
|
458
481
|
if (!createEndpoint || !updateEndpoint) {
|
|
459
|
-
this.error('
|
|
482
|
+
this.error('Upsert requires both create and update endpoints');
|
|
460
483
|
}
|
|
461
484
|
// Helper to extract identifier from item (id, code, or xxxCode)
|
|
462
485
|
const getItemIdentifier = (item) => {
|
|
@@ -599,6 +622,117 @@ export default class ApiKeys extends Command {
|
|
|
599
622
|
this.log('');
|
|
600
623
|
this.log(`Summary: ${created} created, ${updated} updated, ${errors.length} failed`);
|
|
601
624
|
}
|
|
625
|
+
/**
|
|
626
|
+
* The API's own import: the whole array goes up in one request and comes
|
|
627
|
+
* back as an import run, which records what happened to every record. A bad
|
|
628
|
+
* record lands in errorLog and the rest are still applied, and the run stays
|
|
629
|
+
* readable afterwards with: aderis imports get <id>.
|
|
630
|
+
*/
|
|
631
|
+
async runServerImport(action, parentId, flags) {
|
|
632
|
+
const endpoint = ENDPOINTS[action];
|
|
633
|
+
if (!endpoint)
|
|
634
|
+
this.error(`Unknown action: ${action}. Available: ${SUBCOMMANDS.join(', ')}`);
|
|
635
|
+
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
636
|
+
if (!context)
|
|
637
|
+
this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
|
|
638
|
+
if (!hasCredentials(context))
|
|
639
|
+
this.error(missingCredentialsMessage(context));
|
|
640
|
+
let apiPath = endpoint.path;
|
|
641
|
+
if (endpoint.pathParams.length > 0) {
|
|
642
|
+
if (!parentId)
|
|
643
|
+
this.error(`Missing required argument: id. Usage: aderis api-keys ${action} <parent-id> --file data.json`);
|
|
644
|
+
apiPath = apiPath.replace(`{${endpoint.pathParams[0]}}`, parentId);
|
|
645
|
+
}
|
|
646
|
+
// The endpoint takes an array. A single object is wrapped, so importing
|
|
647
|
+
// one record reads the same as importing many.
|
|
648
|
+
let records = [];
|
|
649
|
+
if (flags.file) {
|
|
650
|
+
const fsModule = await import('node:fs');
|
|
651
|
+
try {
|
|
652
|
+
const content = JSON.parse(fsModule.readFileSync(flags.file, 'utf-8'));
|
|
653
|
+
records = Array.isArray(content) ? content : [content];
|
|
654
|
+
}
|
|
655
|
+
catch {
|
|
656
|
+
this.error(`Failed to read file: ${flags.file}`);
|
|
657
|
+
}
|
|
658
|
+
}
|
|
659
|
+
else if (flags.data) {
|
|
660
|
+
try {
|
|
661
|
+
const content = JSON.parse(flags.data);
|
|
662
|
+
records = Array.isArray(content) ? content : [content];
|
|
663
|
+
}
|
|
664
|
+
catch {
|
|
665
|
+
this.error('Invalid JSON in --data');
|
|
666
|
+
}
|
|
667
|
+
}
|
|
668
|
+
else {
|
|
669
|
+
this.error('Import requires --file or --data holding a JSON array of records');
|
|
670
|
+
}
|
|
671
|
+
if (records.length === 0)
|
|
672
|
+
this.error('Nothing to import: the input is an empty array');
|
|
673
|
+
const params = { format: 'json' };
|
|
674
|
+
if (flags.mode)
|
|
675
|
+
params.mode = flags.mode;
|
|
676
|
+
if (flags.reference)
|
|
677
|
+
params.reference = flags.reference;
|
|
678
|
+
if (flags.async)
|
|
679
|
+
params.async = true;
|
|
680
|
+
const headers = {};
|
|
681
|
+
if (flags['idempotency-key'])
|
|
682
|
+
headers['Idempotency-Key'] = flags['idempotency-key'];
|
|
683
|
+
if (flags['show-http-request']) {
|
|
684
|
+
const baseUrls = getBaseUrls(context.environment);
|
|
685
|
+
const queryString = '?' + Object.entries(params).map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(String(v))}`).join('&');
|
|
686
|
+
process.stderr.write(`\n${endpoint.method.toUpperCase()} ${baseUrls.api}${apiPath}${queryString}\n`);
|
|
687
|
+
process.stderr.write(`Body: [${records.length} record${records.length === 1 ? '' : 's'}]\n\n`);
|
|
688
|
+
}
|
|
689
|
+
try {
|
|
690
|
+
const response = await apiRequest(endpoint.method, apiPath, {
|
|
691
|
+
contextName: flags.context,
|
|
692
|
+
data: records,
|
|
693
|
+
headers,
|
|
694
|
+
params,
|
|
695
|
+
});
|
|
696
|
+
this.printImportRun(response.data, flags);
|
|
697
|
+
}
|
|
698
|
+
catch (error) {
|
|
699
|
+
if (error instanceof ApiError) {
|
|
700
|
+
this.error(`API Error (${error.status}): ${error.message}`);
|
|
701
|
+
}
|
|
702
|
+
throw error;
|
|
703
|
+
}
|
|
704
|
+
}
|
|
705
|
+
/** Renders an import run: its counts, then whatever the server refused. */
|
|
706
|
+
printImportRun(run, flags) {
|
|
707
|
+
if (flags.output === 'json') {
|
|
708
|
+
this.log(JSON.stringify(run, null, 2));
|
|
709
|
+
return;
|
|
710
|
+
}
|
|
711
|
+
const record = (run ?? {});
|
|
712
|
+
const count = (key) => (typeof record[key] === 'number' ? record[key] : 0);
|
|
713
|
+
const id = record.id ? String(record.id) : '';
|
|
714
|
+
this.log(`Import ${id} - ${String(record.status ?? 'UNKNOWN')}${record.async ? ' (background)' : ''}`);
|
|
715
|
+
this.log(` ${count('inputSize')} submitted, ${count('createdCount')} created, ${count('updatedCount')} updated, ${count('unchangedCount')} unchanged`);
|
|
716
|
+
if (count('errorCount') > 0)
|
|
717
|
+
this.log(` ${count('errorCount')} not applied: ${count('refusedCount')} refused, ${count('failedCount')} failed`);
|
|
718
|
+
if (count('warningCount') > 0)
|
|
719
|
+
this.log(` ${count('warningCount')} applied with a warning`);
|
|
720
|
+
// errorLog is keyed by the record's identifier, then by field name.
|
|
721
|
+
const errorLog = record.errorLog;
|
|
722
|
+
if (errorLog && Object.keys(errorLog).length > 0) {
|
|
723
|
+
this.log('');
|
|
724
|
+
for (const [key, fields] of Object.entries(errorLog)) {
|
|
725
|
+
for (const [field, messages] of Object.entries(fields ?? {})) {
|
|
726
|
+
for (const message of messages ?? [])
|
|
727
|
+
this.log(` ${key} ${field}: ${message}`);
|
|
728
|
+
}
|
|
729
|
+
}
|
|
730
|
+
}
|
|
731
|
+
if (record.async && id) {
|
|
732
|
+
this.log('');
|
|
733
|
+
this.log(`Follow it with: aderis imports get ${id}`);
|
|
734
|
+
}
|
|
735
|
+
}
|
|
602
736
|
async runExport(flags) {
|
|
603
737
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
604
738
|
if (!context)
|
|
@@ -777,9 +911,9 @@ export default class ApiKeys extends Command {
|
|
|
777
911
|
throw error;
|
|
778
912
|
}
|
|
779
913
|
}
|
|
780
|
-
async
|
|
914
|
+
async runNestedUpsert(suffix, parentId, flags) {
|
|
781
915
|
if (!parentId) {
|
|
782
|
-
this.error(`Missing required argument: id. Usage: aderis api-keys
|
|
916
|
+
this.error(`Missing required argument: id. Usage: aderis api-keys upsert-${suffix} <parent-id> --file data.json`);
|
|
783
917
|
}
|
|
784
918
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
785
919
|
if (!context)
|
|
@@ -844,12 +978,12 @@ export default class ApiKeys extends Command {
|
|
|
844
978
|
items = [item];
|
|
845
979
|
}
|
|
846
980
|
else {
|
|
847
|
-
this.error(
|
|
981
|
+
this.error('Upsert requires --file, --data, or --set flags');
|
|
848
982
|
}
|
|
849
983
|
const createEndpoint = ENDPOINTS[`create-${suffix}`];
|
|
850
984
|
const updateEndpoint = ENDPOINTS[`update-${suffix}`];
|
|
851
985
|
if (!createEndpoint || !updateEndpoint) {
|
|
852
|
-
this.error(`
|
|
986
|
+
this.error(`Upsert requires both create-${suffix} and update-${suffix} endpoints`);
|
|
853
987
|
}
|
|
854
988
|
// Build the base path with parent ID (first path param)
|
|
855
989
|
const firstParam = createEndpoint.pathParams[0];
|
|
@@ -27,10 +27,19 @@ export default class AsyncJobs 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", "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;
|