@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
|
@@ -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"], ...(HAS_UPSERT ? ['upsert'] : []), ...(HAS_EXPORT ? ['export'] : []), ...NESTED_UPSERTS.map(n => `upsert-${n}`)];
|
|
10
13
|
const ENDPOINTS = {
|
|
11
14
|
'list': { method: 'GET', path: '/v1/permissions', summary: 'List permissions selectable for tenant-created roles', pathParams: [], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
|
|
12
15
|
};
|
|
@@ -22,7 +25,7 @@ export default class Permissions extends Command {
|
|
|
22
25
|
};
|
|
23
26
|
static flags = {
|
|
24
27
|
context: Flags.string({ char: 'c', aliases: ['config'], env: 'ADERIS_CONTEXT', description: 'Context to use for this command, overriding the current context (alias: --config)' }),
|
|
25
|
-
output: Flags.string({ char: 'o', description: 'Output format (default: table for
|
|
28
|
+
output: Flags.string({ char: 'o', description: 'Output format (default: table for upsert, json for other commands)', options: ['json', 'table', 'csv'] }),
|
|
26
29
|
table: Flags.boolean({ char: 't', description: 'Output as table (shortcut for --output table)' }),
|
|
27
30
|
csv: Flags.boolean({ description: 'Output as CSV (shortcut for --output csv)' }),
|
|
28
31
|
data: Flags.string({ char: 'd', description: 'JSON data for request body' }),
|
|
@@ -42,11 +45,26 @@ export default class Permissions extends Command {
|
|
|
42
45
|
};
|
|
43
46
|
async run() {
|
|
44
47
|
const { args, flags } = await this.parse(Permissions);
|
|
45
|
-
//
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
48
|
+
// Bulk actions. 'import' is the API's own endpoint: one request, answered
|
|
49
|
+
// by a run that records what happened to every record. 'upsert' is the CLI
|
|
50
|
+
// looping create/update. A resource has one or the other, never both.
|
|
51
|
+
if (args.action === 'upsert') {
|
|
52
|
+
if (!HAS_UPSERT) {
|
|
53
|
+
this.error(SERVER_IMPORTS.includes('import')
|
|
54
|
+
? 'This resource is imported by the API. Use: aderis permissions import --file data.json'
|
|
55
|
+
: 'Upsert needs both a create and an update endpoint, which this resource does not have');
|
|
56
|
+
}
|
|
57
|
+
await this.runUpsert(flags);
|
|
58
|
+
return;
|
|
59
|
+
}
|
|
60
|
+
if (args.action.startsWith('upsert-')) {
|
|
61
|
+
const suffix = args.action.replace('upsert-', '');
|
|
62
|
+
if (!NESTED_UPSERTS.includes(suffix)) {
|
|
63
|
+
this.error(SERVER_IMPORTS.includes('import-' + suffix)
|
|
64
|
+
? `That resource is imported by the API. Use: aderis permissions import-${suffix} <id> --file data.json`
|
|
65
|
+
: `Unknown action: ${args.action}. Available: ${SUBCOMMANDS.join(', ')}`);
|
|
66
|
+
}
|
|
67
|
+
await this.runNestedUpsert(suffix, args.id, flags);
|
|
50
68
|
return;
|
|
51
69
|
}
|
|
52
70
|
// Handle export action specially
|
|
@@ -63,12 +81,17 @@ export default class Permissions extends Command {
|
|
|
63
81
|
await this.runCamt053Import(flags);
|
|
64
82
|
return;
|
|
65
83
|
}
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
84
|
+
if (SERVER_IMPORTS.includes(args.action)) {
|
|
85
|
+
await this.runServerImport(args.action, args.id, flags);
|
|
86
|
+
return;
|
|
87
|
+
}
|
|
88
|
+
// 'import' used to name the CLI's create/update loop on every resource. It
|
|
89
|
+
// now names the API endpoint, which most resources do not have.
|
|
90
|
+
if (args.action === 'import' || args.action.startsWith('import-')) {
|
|
91
|
+
const suffix = args.action === 'import' ? '' : '-' + args.action.replace('import-', '');
|
|
92
|
+
const loops = args.action === 'import' ? HAS_UPSERT : NESTED_UPSERTS.includes(args.action.replace('import-', ''));
|
|
93
|
+
if (loops) {
|
|
94
|
+
this.error(`This resource has no import endpoint. Use: aderis permissions upsert${suffix}${suffix ? ' <id>' : ''} --file data.json`);
|
|
72
95
|
}
|
|
73
96
|
}
|
|
74
97
|
const endpoint = ENDPOINTS[args.action];
|
|
@@ -383,7 +406,7 @@ export default class Permissions extends Command {
|
|
|
383
406
|
throw error;
|
|
384
407
|
}
|
|
385
408
|
}
|
|
386
|
-
async
|
|
409
|
+
async runUpsert(flags) {
|
|
387
410
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
388
411
|
if (!context)
|
|
389
412
|
this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
|
|
@@ -447,12 +470,12 @@ export default class Permissions extends Command {
|
|
|
447
470
|
items = [item];
|
|
448
471
|
}
|
|
449
472
|
else {
|
|
450
|
-
this.error('
|
|
473
|
+
this.error('Upsert requires --file, --data, or --set flags');
|
|
451
474
|
}
|
|
452
475
|
const createEndpoint = ENDPOINTS['create'];
|
|
453
476
|
const updateEndpoint = ENDPOINTS['update'];
|
|
454
477
|
if (!createEndpoint || !updateEndpoint) {
|
|
455
|
-
this.error('
|
|
478
|
+
this.error('Upsert requires both create and update endpoints');
|
|
456
479
|
}
|
|
457
480
|
// Helper to extract identifier from item (id, code, or xxxCode)
|
|
458
481
|
const getItemIdentifier = (item) => {
|
|
@@ -595,6 +618,117 @@ export default class Permissions extends Command {
|
|
|
595
618
|
this.log('');
|
|
596
619
|
this.log(`Summary: ${created} created, ${updated} updated, ${errors.length} failed`);
|
|
597
620
|
}
|
|
621
|
+
/**
|
|
622
|
+
* The API's own import: the whole array goes up in one request and comes
|
|
623
|
+
* back as an import run, which records what happened to every record. A bad
|
|
624
|
+
* record lands in errorLog and the rest are still applied, and the run stays
|
|
625
|
+
* readable afterwards with: aderis imports get <id>.
|
|
626
|
+
*/
|
|
627
|
+
async runServerImport(action, parentId, flags) {
|
|
628
|
+
const endpoint = ENDPOINTS[action];
|
|
629
|
+
if (!endpoint)
|
|
630
|
+
this.error(`Unknown action: ${action}. Available: ${SUBCOMMANDS.join(', ')}`);
|
|
631
|
+
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
632
|
+
if (!context)
|
|
633
|
+
this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
|
|
634
|
+
if (!hasCredentials(context))
|
|
635
|
+
this.error(missingCredentialsMessage(context));
|
|
636
|
+
let apiPath = endpoint.path;
|
|
637
|
+
if (endpoint.pathParams.length > 0) {
|
|
638
|
+
if (!parentId)
|
|
639
|
+
this.error(`Missing required argument: id. Usage: aderis permissions ${action} <parent-id> --file data.json`);
|
|
640
|
+
apiPath = apiPath.replace(`{${endpoint.pathParams[0]}}`, parentId);
|
|
641
|
+
}
|
|
642
|
+
// The endpoint takes an array. A single object is wrapped, so importing
|
|
643
|
+
// one record reads the same as importing many.
|
|
644
|
+
let records = [];
|
|
645
|
+
if (flags.file) {
|
|
646
|
+
const fsModule = await import('node:fs');
|
|
647
|
+
try {
|
|
648
|
+
const content = JSON.parse(fsModule.readFileSync(flags.file, 'utf-8'));
|
|
649
|
+
records = Array.isArray(content) ? content : [content];
|
|
650
|
+
}
|
|
651
|
+
catch {
|
|
652
|
+
this.error(`Failed to read file: ${flags.file}`);
|
|
653
|
+
}
|
|
654
|
+
}
|
|
655
|
+
else if (flags.data) {
|
|
656
|
+
try {
|
|
657
|
+
const content = JSON.parse(flags.data);
|
|
658
|
+
records = Array.isArray(content) ? content : [content];
|
|
659
|
+
}
|
|
660
|
+
catch {
|
|
661
|
+
this.error('Invalid JSON in --data');
|
|
662
|
+
}
|
|
663
|
+
}
|
|
664
|
+
else {
|
|
665
|
+
this.error('Import requires --file or --data holding a JSON array of records');
|
|
666
|
+
}
|
|
667
|
+
if (records.length === 0)
|
|
668
|
+
this.error('Nothing to import: the input is an empty array');
|
|
669
|
+
const params = { format: 'json' };
|
|
670
|
+
if (flags.mode)
|
|
671
|
+
params.mode = flags.mode;
|
|
672
|
+
if (flags.reference)
|
|
673
|
+
params.reference = flags.reference;
|
|
674
|
+
if (flags.async)
|
|
675
|
+
params.async = true;
|
|
676
|
+
const headers = {};
|
|
677
|
+
if (flags['idempotency-key'])
|
|
678
|
+
headers['Idempotency-Key'] = flags['idempotency-key'];
|
|
679
|
+
if (flags['show-http-request']) {
|
|
680
|
+
const baseUrls = getBaseUrls(context.environment);
|
|
681
|
+
const queryString = '?' + Object.entries(params).map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(String(v))}`).join('&');
|
|
682
|
+
process.stderr.write(`\n${endpoint.method.toUpperCase()} ${baseUrls.api}${apiPath}${queryString}\n`);
|
|
683
|
+
process.stderr.write(`Body: [${records.length} record${records.length === 1 ? '' : 's'}]\n\n`);
|
|
684
|
+
}
|
|
685
|
+
try {
|
|
686
|
+
const response = await apiRequest(endpoint.method, apiPath, {
|
|
687
|
+
contextName: flags.context,
|
|
688
|
+
data: records,
|
|
689
|
+
headers,
|
|
690
|
+
params,
|
|
691
|
+
});
|
|
692
|
+
this.printImportRun(response.data, flags);
|
|
693
|
+
}
|
|
694
|
+
catch (error) {
|
|
695
|
+
if (error instanceof ApiError) {
|
|
696
|
+
this.error(`API Error (${error.status}): ${error.message}`);
|
|
697
|
+
}
|
|
698
|
+
throw error;
|
|
699
|
+
}
|
|
700
|
+
}
|
|
701
|
+
/** Renders an import run: its counts, then whatever the server refused. */
|
|
702
|
+
printImportRun(run, flags) {
|
|
703
|
+
if (flags.output === 'json') {
|
|
704
|
+
this.log(JSON.stringify(run, null, 2));
|
|
705
|
+
return;
|
|
706
|
+
}
|
|
707
|
+
const record = (run ?? {});
|
|
708
|
+
const count = (key) => (typeof record[key] === 'number' ? record[key] : 0);
|
|
709
|
+
const id = record.id ? String(record.id) : '';
|
|
710
|
+
this.log(`Import ${id} - ${String(record.status ?? 'UNKNOWN')}${record.async ? ' (background)' : ''}`);
|
|
711
|
+
this.log(` ${count('inputSize')} submitted, ${count('createdCount')} created, ${count('updatedCount')} updated, ${count('unchangedCount')} unchanged`);
|
|
712
|
+
if (count('errorCount') > 0)
|
|
713
|
+
this.log(` ${count('errorCount')} not applied: ${count('refusedCount')} refused, ${count('failedCount')} failed`);
|
|
714
|
+
if (count('warningCount') > 0)
|
|
715
|
+
this.log(` ${count('warningCount')} applied with a warning`);
|
|
716
|
+
// errorLog is keyed by the record's identifier, then by field name.
|
|
717
|
+
const errorLog = record.errorLog;
|
|
718
|
+
if (errorLog && Object.keys(errorLog).length > 0) {
|
|
719
|
+
this.log('');
|
|
720
|
+
for (const [key, fields] of Object.entries(errorLog)) {
|
|
721
|
+
for (const [field, messages] of Object.entries(fields ?? {})) {
|
|
722
|
+
for (const message of messages ?? [])
|
|
723
|
+
this.log(` ${key} ${field}: ${message}`);
|
|
724
|
+
}
|
|
725
|
+
}
|
|
726
|
+
}
|
|
727
|
+
if (record.async && id) {
|
|
728
|
+
this.log('');
|
|
729
|
+
this.log(`Follow it with: aderis imports get ${id}`);
|
|
730
|
+
}
|
|
731
|
+
}
|
|
598
732
|
async runExport(flags) {
|
|
599
733
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
600
734
|
if (!context)
|
|
@@ -773,9 +907,9 @@ export default class Permissions extends Command {
|
|
|
773
907
|
throw error;
|
|
774
908
|
}
|
|
775
909
|
}
|
|
776
|
-
async
|
|
910
|
+
async runNestedUpsert(suffix, parentId, flags) {
|
|
777
911
|
if (!parentId) {
|
|
778
|
-
this.error(`Missing required argument: id. Usage: aderis permissions
|
|
912
|
+
this.error(`Missing required argument: id. Usage: aderis permissions upsert-${suffix} <parent-id> --file data.json`);
|
|
779
913
|
}
|
|
780
914
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
781
915
|
if (!context)
|
|
@@ -840,12 +974,12 @@ export default class Permissions extends Command {
|
|
|
840
974
|
items = [item];
|
|
841
975
|
}
|
|
842
976
|
else {
|
|
843
|
-
this.error(
|
|
977
|
+
this.error('Upsert requires --file, --data, or --set flags');
|
|
844
978
|
}
|
|
845
979
|
const createEndpoint = ENDPOINTS[`create-${suffix}`];
|
|
846
980
|
const updateEndpoint = ENDPOINTS[`update-${suffix}`];
|
|
847
981
|
if (!createEndpoint || !updateEndpoint) {
|
|
848
|
-
this.error(`
|
|
982
|
+
this.error(`Upsert requires both create-${suffix} and update-${suffix} endpoints`);
|
|
849
983
|
}
|
|
850
984
|
// Build the base path with parent ID (first path param)
|
|
851
985
|
const firstParam = createEndpoint.pathParams[0];
|
|
@@ -14,6 +14,10 @@ export default class PriceLists extends Command {
|
|
|
14
14
|
data: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
15
15
|
file: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
16
16
|
set: import("@oclif/core/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
17
|
+
mode: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
18
|
+
reference: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
19
|
+
async: import("@oclif/core/interfaces").BooleanFlag<boolean>;
|
|
20
|
+
'idempotency-key': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
17
21
|
'price-id': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
18
22
|
page: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
19
23
|
limit: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
@@ -28,10 +32,19 @@ export default class PriceLists extends Command {
|
|
|
28
32
|
'show-http-request': import("@oclif/core/interfaces").BooleanFlag<boolean>;
|
|
29
33
|
};
|
|
30
34
|
run(): Promise<void>;
|
|
31
|
-
private
|
|
35
|
+
private runUpsert;
|
|
36
|
+
/**
|
|
37
|
+
* The API's own import: the whole array goes up in one request and comes
|
|
38
|
+
* back as an import run, which records what happened to every record. A bad
|
|
39
|
+
* record lands in errorLog and the rest are still applied, and the run stays
|
|
40
|
+
* readable afterwards with: aderis imports get <id>.
|
|
41
|
+
*/
|
|
42
|
+
private runServerImport;
|
|
43
|
+
/** Renders an import run: its counts, then whatever the server refused. */
|
|
44
|
+
private printImportRun;
|
|
32
45
|
private runExport;
|
|
33
46
|
private runCamt053Import;
|
|
34
|
-
private
|
|
47
|
+
private runNestedUpsert;
|
|
35
48
|
private parseFilterValue;
|
|
36
49
|
/** The page line under a table: which page, how many, and any sums the API returned. */
|
|
37
50
|
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 = ["import", "import-prices"];
|
|
11
|
+
const NESTED_UPSERTS = [];
|
|
12
|
+
const SUBCOMMANDS = [...["list", "create", "get", "update", "delete", "list-prices", "create-prices", "get-prices", "update-prices", "delete-prices", "import", "import-prices"], ...(HAS_UPSERT ? ['upsert'] : []), ...(HAS_EXPORT ? ['export'] : []), ...NESTED_UPSERTS.map(n => `upsert-${n}`)];
|
|
10
13
|
const ENDPOINTS = {
|
|
11
14
|
'list': { method: 'GET', path: '/v1/price-lists', summary: 'Get all price lists with pagination', pathParams: [], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
|
|
12
15
|
'create': { method: 'POST', path: '/v1/price-lists', summary: 'Create a new price list', pathParams: [], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
|
|
@@ -18,6 +21,8 @@ const ENDPOINTS = {
|
|
|
18
21
|
'get-prices': { method: 'GET', path: '/v1/price-lists/{id}/prices/{priceId}', summary: 'Get a price by ID', pathParams: ['id', 'priceId'], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
|
|
19
22
|
'update-prices': { method: 'PATCH', path: '/v1/price-lists/{id}/prices/{priceId}', summary: 'Update a price', pathParams: ['id', 'priceId'], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
|
|
20
23
|
'delete-prices': { method: 'DELETE', path: '/v1/price-lists/{id}/prices/{priceId}', summary: 'Delete a price', pathParams: ['id', 'priceId'], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
|
|
24
|
+
'import': { method: 'POST', path: '/v1/price-lists/import', summary: 'Import price lists', pathParams: [], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
|
|
25
|
+
'import-prices': { method: 'POST', path: '/v1/price-lists/{priceListId}/prices/import', summary: 'Import prices into a price list', pathParams: ['priceListId'], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
|
|
21
26
|
};
|
|
22
27
|
export default class PriceLists extends Command {
|
|
23
28
|
static description = 'Manage price lists';
|
|
@@ -26,7 +31,7 @@ export default class PriceLists extends Command {
|
|
|
26
31
|
'<%= config.bin %> price-lists get <id>',
|
|
27
32
|
'<%= config.bin %> price-lists create --data \'{...}\'',
|
|
28
33
|
'<%= config.bin %> price-lists update <id> --set field=value',
|
|
29
|
-
'<%= config.bin %> price-lists import --file data.json',
|
|
34
|
+
'<%= config.bin %> price-lists import --file data.json --mode upsert',
|
|
30
35
|
'<%= config.bin %> price-lists export --csv > price-lists.csv',
|
|
31
36
|
];
|
|
32
37
|
static args = {
|
|
@@ -35,12 +40,16 @@ export default class PriceLists extends Command {
|
|
|
35
40
|
};
|
|
36
41
|
static flags = {
|
|
37
42
|
context: Flags.string({ char: 'c', aliases: ['config'], env: 'ADERIS_CONTEXT', description: 'Context to use for this command, overriding the current context (alias: --config)' }),
|
|
38
|
-
output: Flags.string({ char: 'o', description: 'Output format (default: table for
|
|
43
|
+
output: Flags.string({ char: 'o', description: 'Output format (default: table for upsert, json for other commands)', options: ['json', 'table', 'csv'] }),
|
|
39
44
|
table: Flags.boolean({ char: 't', description: 'Output as table (shortcut for --output table)' }),
|
|
40
45
|
csv: Flags.boolean({ description: 'Output as CSV (shortcut for --output csv)' }),
|
|
41
46
|
data: Flags.string({ char: 'd', description: 'JSON data for request body' }),
|
|
42
47
|
file: Flags.string({ char: 'f', description: 'Read request body from file' }),
|
|
43
48
|
set: Flags.string({ char: 's', description: 'Set individual field (e.g. --set firstName=John)', multiple: true }),
|
|
49
|
+
mode: Flags.string({ description: 'Import mode: upsert (default) creates, updates or skips each record; create refuses records that already exist; update refuses records that do not', options: ['upsert', 'create', 'update'] }),
|
|
50
|
+
reference: Flags.string({ description: 'Caller-defined text stored on the import run, for tracking and filtering' }),
|
|
51
|
+
async: Flags.boolean({ description: 'Import in the background: answers with a PENDING run to follow via "aderis imports get <id>"' }),
|
|
52
|
+
'idempotency-key': Flags.string({ description: 'Repeating a key returns the earlier import run unchanged and imports nothing' }),
|
|
44
53
|
'price-id': Flags.string({ description: 'Path param: priceId' }),
|
|
45
54
|
page: Flags.string({ description: 'Page number' }),
|
|
46
55
|
limit: Flags.string({ description: 'Items per page' }),
|
|
@@ -56,11 +65,26 @@ export default class PriceLists extends Command {
|
|
|
56
65
|
};
|
|
57
66
|
async run() {
|
|
58
67
|
const { args, flags } = await this.parse(PriceLists);
|
|
59
|
-
//
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
68
|
+
// Bulk actions. 'import' is the API's own endpoint: one request, answered
|
|
69
|
+
// by a run that records what happened to every record. 'upsert' is the CLI
|
|
70
|
+
// looping create/update. A resource has one or the other, never both.
|
|
71
|
+
if (args.action === 'upsert') {
|
|
72
|
+
if (!HAS_UPSERT) {
|
|
73
|
+
this.error(SERVER_IMPORTS.includes('import')
|
|
74
|
+
? 'This resource is imported by the API. Use: aderis price-lists import --file data.json'
|
|
75
|
+
: 'Upsert needs both a create and an update endpoint, which this resource does not have');
|
|
76
|
+
}
|
|
77
|
+
await this.runUpsert(flags);
|
|
78
|
+
return;
|
|
79
|
+
}
|
|
80
|
+
if (args.action.startsWith('upsert-')) {
|
|
81
|
+
const suffix = args.action.replace('upsert-', '');
|
|
82
|
+
if (!NESTED_UPSERTS.includes(suffix)) {
|
|
83
|
+
this.error(SERVER_IMPORTS.includes('import-' + suffix)
|
|
84
|
+
? `That resource is imported by the API. Use: aderis price-lists import-${suffix} <id> --file data.json`
|
|
85
|
+
: `Unknown action: ${args.action}. Available: ${SUBCOMMANDS.join(', ')}`);
|
|
86
|
+
}
|
|
87
|
+
await this.runNestedUpsert(suffix, args.id, flags);
|
|
64
88
|
return;
|
|
65
89
|
}
|
|
66
90
|
// Handle export action specially
|
|
@@ -77,12 +101,17 @@ export default class PriceLists extends Command {
|
|
|
77
101
|
await this.runCamt053Import(flags);
|
|
78
102
|
return;
|
|
79
103
|
}
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
104
|
+
if (SERVER_IMPORTS.includes(args.action)) {
|
|
105
|
+
await this.runServerImport(args.action, args.id, flags);
|
|
106
|
+
return;
|
|
107
|
+
}
|
|
108
|
+
// 'import' used to name the CLI's create/update loop on every resource. It
|
|
109
|
+
// now names the API endpoint, which most resources do not have.
|
|
110
|
+
if (args.action === 'import' || args.action.startsWith('import-')) {
|
|
111
|
+
const suffix = args.action === 'import' ? '' : '-' + args.action.replace('import-', '');
|
|
112
|
+
const loops = args.action === 'import' ? HAS_UPSERT : NESTED_UPSERTS.includes(args.action.replace('import-', ''));
|
|
113
|
+
if (loops) {
|
|
114
|
+
this.error(`This resource has no import endpoint. Use: aderis price-lists upsert${suffix}${suffix ? ' <id>' : ''} --file data.json`);
|
|
86
115
|
}
|
|
87
116
|
}
|
|
88
117
|
const endpoint = ENDPOINTS[args.action];
|
|
@@ -397,7 +426,7 @@ export default class PriceLists extends Command {
|
|
|
397
426
|
throw error;
|
|
398
427
|
}
|
|
399
428
|
}
|
|
400
|
-
async
|
|
429
|
+
async runUpsert(flags) {
|
|
401
430
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
402
431
|
if (!context)
|
|
403
432
|
this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
|
|
@@ -461,12 +490,12 @@ export default class PriceLists extends Command {
|
|
|
461
490
|
items = [item];
|
|
462
491
|
}
|
|
463
492
|
else {
|
|
464
|
-
this.error('
|
|
493
|
+
this.error('Upsert requires --file, --data, or --set flags');
|
|
465
494
|
}
|
|
466
495
|
const createEndpoint = ENDPOINTS['create'];
|
|
467
496
|
const updateEndpoint = ENDPOINTS['update'];
|
|
468
497
|
if (!createEndpoint || !updateEndpoint) {
|
|
469
|
-
this.error('
|
|
498
|
+
this.error('Upsert requires both create and update endpoints');
|
|
470
499
|
}
|
|
471
500
|
// Helper to extract identifier from item (id, code, or xxxCode)
|
|
472
501
|
const getItemIdentifier = (item) => {
|
|
@@ -609,6 +638,117 @@ export default class PriceLists extends Command {
|
|
|
609
638
|
this.log('');
|
|
610
639
|
this.log(`Summary: ${created} created, ${updated} updated, ${errors.length} failed`);
|
|
611
640
|
}
|
|
641
|
+
/**
|
|
642
|
+
* The API's own import: the whole array goes up in one request and comes
|
|
643
|
+
* back as an import run, which records what happened to every record. A bad
|
|
644
|
+
* record lands in errorLog and the rest are still applied, and the run stays
|
|
645
|
+
* readable afterwards with: aderis imports get <id>.
|
|
646
|
+
*/
|
|
647
|
+
async runServerImport(action, parentId, flags) {
|
|
648
|
+
const endpoint = ENDPOINTS[action];
|
|
649
|
+
if (!endpoint)
|
|
650
|
+
this.error(`Unknown action: ${action}. Available: ${SUBCOMMANDS.join(', ')}`);
|
|
651
|
+
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
652
|
+
if (!context)
|
|
653
|
+
this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
|
|
654
|
+
if (!hasCredentials(context))
|
|
655
|
+
this.error(missingCredentialsMessage(context));
|
|
656
|
+
let apiPath = endpoint.path;
|
|
657
|
+
if (endpoint.pathParams.length > 0) {
|
|
658
|
+
if (!parentId)
|
|
659
|
+
this.error(`Missing required argument: id. Usage: aderis price-lists ${action} <parent-id> --file data.json`);
|
|
660
|
+
apiPath = apiPath.replace(`{${endpoint.pathParams[0]}}`, parentId);
|
|
661
|
+
}
|
|
662
|
+
// The endpoint takes an array. A single object is wrapped, so importing
|
|
663
|
+
// one record reads the same as importing many.
|
|
664
|
+
let records = [];
|
|
665
|
+
if (flags.file) {
|
|
666
|
+
const fsModule = await import('node:fs');
|
|
667
|
+
try {
|
|
668
|
+
const content = JSON.parse(fsModule.readFileSync(flags.file, 'utf-8'));
|
|
669
|
+
records = Array.isArray(content) ? content : [content];
|
|
670
|
+
}
|
|
671
|
+
catch {
|
|
672
|
+
this.error(`Failed to read file: ${flags.file}`);
|
|
673
|
+
}
|
|
674
|
+
}
|
|
675
|
+
else if (flags.data) {
|
|
676
|
+
try {
|
|
677
|
+
const content = JSON.parse(flags.data);
|
|
678
|
+
records = Array.isArray(content) ? content : [content];
|
|
679
|
+
}
|
|
680
|
+
catch {
|
|
681
|
+
this.error('Invalid JSON in --data');
|
|
682
|
+
}
|
|
683
|
+
}
|
|
684
|
+
else {
|
|
685
|
+
this.error('Import requires --file or --data holding a JSON array of records');
|
|
686
|
+
}
|
|
687
|
+
if (records.length === 0)
|
|
688
|
+
this.error('Nothing to import: the input is an empty array');
|
|
689
|
+
const params = { format: 'json' };
|
|
690
|
+
if (flags.mode)
|
|
691
|
+
params.mode = flags.mode;
|
|
692
|
+
if (flags.reference)
|
|
693
|
+
params.reference = flags.reference;
|
|
694
|
+
if (flags.async)
|
|
695
|
+
params.async = true;
|
|
696
|
+
const headers = {};
|
|
697
|
+
if (flags['idempotency-key'])
|
|
698
|
+
headers['Idempotency-Key'] = flags['idempotency-key'];
|
|
699
|
+
if (flags['show-http-request']) {
|
|
700
|
+
const baseUrls = getBaseUrls(context.environment);
|
|
701
|
+
const queryString = '?' + Object.entries(params).map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(String(v))}`).join('&');
|
|
702
|
+
process.stderr.write(`\n${endpoint.method.toUpperCase()} ${baseUrls.api}${apiPath}${queryString}\n`);
|
|
703
|
+
process.stderr.write(`Body: [${records.length} record${records.length === 1 ? '' : 's'}]\n\n`);
|
|
704
|
+
}
|
|
705
|
+
try {
|
|
706
|
+
const response = await apiRequest(endpoint.method, apiPath, {
|
|
707
|
+
contextName: flags.context,
|
|
708
|
+
data: records,
|
|
709
|
+
headers,
|
|
710
|
+
params,
|
|
711
|
+
});
|
|
712
|
+
this.printImportRun(response.data, flags);
|
|
713
|
+
}
|
|
714
|
+
catch (error) {
|
|
715
|
+
if (error instanceof ApiError) {
|
|
716
|
+
this.error(`API Error (${error.status}): ${error.message}`);
|
|
717
|
+
}
|
|
718
|
+
throw error;
|
|
719
|
+
}
|
|
720
|
+
}
|
|
721
|
+
/** Renders an import run: its counts, then whatever the server refused. */
|
|
722
|
+
printImportRun(run, flags) {
|
|
723
|
+
if (flags.output === 'json') {
|
|
724
|
+
this.log(JSON.stringify(run, null, 2));
|
|
725
|
+
return;
|
|
726
|
+
}
|
|
727
|
+
const record = (run ?? {});
|
|
728
|
+
const count = (key) => (typeof record[key] === 'number' ? record[key] : 0);
|
|
729
|
+
const id = record.id ? String(record.id) : '';
|
|
730
|
+
this.log(`Import ${id} - ${String(record.status ?? 'UNKNOWN')}${record.async ? ' (background)' : ''}`);
|
|
731
|
+
this.log(` ${count('inputSize')} submitted, ${count('createdCount')} created, ${count('updatedCount')} updated, ${count('unchangedCount')} unchanged`);
|
|
732
|
+
if (count('errorCount') > 0)
|
|
733
|
+
this.log(` ${count('errorCount')} not applied: ${count('refusedCount')} refused, ${count('failedCount')} failed`);
|
|
734
|
+
if (count('warningCount') > 0)
|
|
735
|
+
this.log(` ${count('warningCount')} applied with a warning`);
|
|
736
|
+
// errorLog is keyed by the record's identifier, then by field name.
|
|
737
|
+
const errorLog = record.errorLog;
|
|
738
|
+
if (errorLog && Object.keys(errorLog).length > 0) {
|
|
739
|
+
this.log('');
|
|
740
|
+
for (const [key, fields] of Object.entries(errorLog)) {
|
|
741
|
+
for (const [field, messages] of Object.entries(fields ?? {})) {
|
|
742
|
+
for (const message of messages ?? [])
|
|
743
|
+
this.log(` ${key} ${field}: ${message}`);
|
|
744
|
+
}
|
|
745
|
+
}
|
|
746
|
+
}
|
|
747
|
+
if (record.async && id) {
|
|
748
|
+
this.log('');
|
|
749
|
+
this.log(`Follow it with: aderis imports get ${id}`);
|
|
750
|
+
}
|
|
751
|
+
}
|
|
612
752
|
async runExport(flags) {
|
|
613
753
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
614
754
|
if (!context)
|
|
@@ -787,9 +927,9 @@ export default class PriceLists extends Command {
|
|
|
787
927
|
throw error;
|
|
788
928
|
}
|
|
789
929
|
}
|
|
790
|
-
async
|
|
930
|
+
async runNestedUpsert(suffix, parentId, flags) {
|
|
791
931
|
if (!parentId) {
|
|
792
|
-
this.error(`Missing required argument: id. Usage: aderis price-lists
|
|
932
|
+
this.error(`Missing required argument: id. Usage: aderis price-lists upsert-${suffix} <parent-id> --file data.json`);
|
|
793
933
|
}
|
|
794
934
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
795
935
|
if (!context)
|
|
@@ -854,12 +994,12 @@ export default class PriceLists extends Command {
|
|
|
854
994
|
items = [item];
|
|
855
995
|
}
|
|
856
996
|
else {
|
|
857
|
-
this.error(
|
|
997
|
+
this.error('Upsert requires --file, --data, or --set flags');
|
|
858
998
|
}
|
|
859
999
|
const createEndpoint = ENDPOINTS[`create-${suffix}`];
|
|
860
1000
|
const updateEndpoint = ENDPOINTS[`update-${suffix}`];
|
|
861
1001
|
if (!createEndpoint || !updateEndpoint) {
|
|
862
|
-
this.error(`
|
|
1002
|
+
this.error(`Upsert requires both create-${suffix} and update-${suffix} endpoints`);
|
|
863
1003
|
}
|
|
864
1004
|
// Build the base path with parent ID (first path param)
|
|
865
1005
|
const firstParam = createEndpoint.pathParams[0];
|
|
@@ -27,10 +27,19 @@ export default class ProcessorMappings 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;
|