@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
package/dist/commands/tools.js
CHANGED
|
@@ -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", "find"], ...(HAS_UPSERT ? ['upsert'] : []), ...(HAS_EXPORT ? ['export'] : []), ...NESTED_UPSERTS.map(n => `upsert-${n}`)];
|
|
10
13
|
const ENDPOINTS = {
|
|
11
14
|
'list': { method: 'GET', path: '/v1/tools', summary: 'List all available tools', pathParams: [], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
|
|
12
15
|
'find': { method: 'GET', path: '/v1/tools/{name}', summary: 'Get a single tool by canonical name', pathParams: ['name'], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
|
|
@@ -23,7 +26,7 @@ export default class Tools extends Command {
|
|
|
23
26
|
};
|
|
24
27
|
static flags = {
|
|
25
28
|
context: Flags.string({ char: 'c', aliases: ['config'], env: 'ADERIS_CONTEXT', description: 'Context to use for this command, overriding the current context (alias: --config)' }),
|
|
26
|
-
output: Flags.string({ char: 'o', description: 'Output format (default: table for
|
|
29
|
+
output: Flags.string({ char: 'o', description: 'Output format (default: table for upsert, json for other commands)', options: ['json', 'table', 'csv'] }),
|
|
27
30
|
table: Flags.boolean({ char: 't', description: 'Output as table (shortcut for --output table)' }),
|
|
28
31
|
csv: Flags.boolean({ description: 'Output as CSV (shortcut for --output csv)' }),
|
|
29
32
|
data: Flags.string({ char: 'd', description: 'JSON data for request body' }),
|
|
@@ -43,11 +46,26 @@ export default class Tools extends Command {
|
|
|
43
46
|
};
|
|
44
47
|
async run() {
|
|
45
48
|
const { args, flags } = await this.parse(Tools);
|
|
46
|
-
//
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
49
|
+
// Bulk actions. 'import' is the API's own endpoint: one request, answered
|
|
50
|
+
// by a run that records what happened to every record. 'upsert' is the CLI
|
|
51
|
+
// looping create/update. A resource has one or the other, never both.
|
|
52
|
+
if (args.action === 'upsert') {
|
|
53
|
+
if (!HAS_UPSERT) {
|
|
54
|
+
this.error(SERVER_IMPORTS.includes('import')
|
|
55
|
+
? 'This resource is imported by the API. Use: aderis tools import --file data.json'
|
|
56
|
+
: 'Upsert needs both a create and an update endpoint, which this resource does not have');
|
|
57
|
+
}
|
|
58
|
+
await this.runUpsert(flags);
|
|
59
|
+
return;
|
|
60
|
+
}
|
|
61
|
+
if (args.action.startsWith('upsert-')) {
|
|
62
|
+
const suffix = args.action.replace('upsert-', '');
|
|
63
|
+
if (!NESTED_UPSERTS.includes(suffix)) {
|
|
64
|
+
this.error(SERVER_IMPORTS.includes('import-' + suffix)
|
|
65
|
+
? `That resource is imported by the API. Use: aderis tools import-${suffix} <id> --file data.json`
|
|
66
|
+
: `Unknown action: ${args.action}. Available: ${SUBCOMMANDS.join(', ')}`);
|
|
67
|
+
}
|
|
68
|
+
await this.runNestedUpsert(suffix, args.id, flags);
|
|
51
69
|
return;
|
|
52
70
|
}
|
|
53
71
|
// Handle export action specially
|
|
@@ -64,12 +82,17 @@ export default class Tools extends Command {
|
|
|
64
82
|
await this.runCamt053Import(flags);
|
|
65
83
|
return;
|
|
66
84
|
}
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
85
|
+
if (SERVER_IMPORTS.includes(args.action)) {
|
|
86
|
+
await this.runServerImport(args.action, args.id, flags);
|
|
87
|
+
return;
|
|
88
|
+
}
|
|
89
|
+
// 'import' used to name the CLI's create/update loop on every resource. It
|
|
90
|
+
// now names the API endpoint, which most resources do not have.
|
|
91
|
+
if (args.action === 'import' || args.action.startsWith('import-')) {
|
|
92
|
+
const suffix = args.action === 'import' ? '' : '-' + args.action.replace('import-', '');
|
|
93
|
+
const loops = args.action === 'import' ? HAS_UPSERT : NESTED_UPSERTS.includes(args.action.replace('import-', ''));
|
|
94
|
+
if (loops) {
|
|
95
|
+
this.error(`This resource has no import endpoint. Use: aderis tools upsert${suffix}${suffix ? ' <id>' : ''} --file data.json`);
|
|
73
96
|
}
|
|
74
97
|
}
|
|
75
98
|
const endpoint = ENDPOINTS[args.action];
|
|
@@ -384,7 +407,7 @@ export default class Tools extends Command {
|
|
|
384
407
|
throw error;
|
|
385
408
|
}
|
|
386
409
|
}
|
|
387
|
-
async
|
|
410
|
+
async runUpsert(flags) {
|
|
388
411
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
389
412
|
if (!context)
|
|
390
413
|
this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
|
|
@@ -448,12 +471,12 @@ export default class Tools extends Command {
|
|
|
448
471
|
items = [item];
|
|
449
472
|
}
|
|
450
473
|
else {
|
|
451
|
-
this.error('
|
|
474
|
+
this.error('Upsert requires --file, --data, or --set flags');
|
|
452
475
|
}
|
|
453
476
|
const createEndpoint = ENDPOINTS['create'];
|
|
454
477
|
const updateEndpoint = ENDPOINTS['update'];
|
|
455
478
|
if (!createEndpoint || !updateEndpoint) {
|
|
456
|
-
this.error('
|
|
479
|
+
this.error('Upsert requires both create and update endpoints');
|
|
457
480
|
}
|
|
458
481
|
// Helper to extract identifier from item (id, code, or xxxCode)
|
|
459
482
|
const getItemIdentifier = (item) => {
|
|
@@ -596,6 +619,117 @@ export default class Tools extends Command {
|
|
|
596
619
|
this.log('');
|
|
597
620
|
this.log(`Summary: ${created} created, ${updated} updated, ${errors.length} failed`);
|
|
598
621
|
}
|
|
622
|
+
/**
|
|
623
|
+
* The API's own import: the whole array goes up in one request and comes
|
|
624
|
+
* back as an import run, which records what happened to every record. A bad
|
|
625
|
+
* record lands in errorLog and the rest are still applied, and the run stays
|
|
626
|
+
* readable afterwards with: aderis imports get <id>.
|
|
627
|
+
*/
|
|
628
|
+
async runServerImport(action, parentId, flags) {
|
|
629
|
+
const endpoint = ENDPOINTS[action];
|
|
630
|
+
if (!endpoint)
|
|
631
|
+
this.error(`Unknown action: ${action}. Available: ${SUBCOMMANDS.join(', ')}`);
|
|
632
|
+
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
633
|
+
if (!context)
|
|
634
|
+
this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
|
|
635
|
+
if (!hasCredentials(context))
|
|
636
|
+
this.error(missingCredentialsMessage(context));
|
|
637
|
+
let apiPath = endpoint.path;
|
|
638
|
+
if (endpoint.pathParams.length > 0) {
|
|
639
|
+
if (!parentId)
|
|
640
|
+
this.error(`Missing required argument: id. Usage: aderis tools ${action} <parent-id> --file data.json`);
|
|
641
|
+
apiPath = apiPath.replace(`{${endpoint.pathParams[0]}}`, parentId);
|
|
642
|
+
}
|
|
643
|
+
// The endpoint takes an array. A single object is wrapped, so importing
|
|
644
|
+
// one record reads the same as importing many.
|
|
645
|
+
let records = [];
|
|
646
|
+
if (flags.file) {
|
|
647
|
+
const fsModule = await import('node:fs');
|
|
648
|
+
try {
|
|
649
|
+
const content = JSON.parse(fsModule.readFileSync(flags.file, 'utf-8'));
|
|
650
|
+
records = Array.isArray(content) ? content : [content];
|
|
651
|
+
}
|
|
652
|
+
catch {
|
|
653
|
+
this.error(`Failed to read file: ${flags.file}`);
|
|
654
|
+
}
|
|
655
|
+
}
|
|
656
|
+
else if (flags.data) {
|
|
657
|
+
try {
|
|
658
|
+
const content = JSON.parse(flags.data);
|
|
659
|
+
records = Array.isArray(content) ? content : [content];
|
|
660
|
+
}
|
|
661
|
+
catch {
|
|
662
|
+
this.error('Invalid JSON in --data');
|
|
663
|
+
}
|
|
664
|
+
}
|
|
665
|
+
else {
|
|
666
|
+
this.error('Import requires --file or --data holding a JSON array of records');
|
|
667
|
+
}
|
|
668
|
+
if (records.length === 0)
|
|
669
|
+
this.error('Nothing to import: the input is an empty array');
|
|
670
|
+
const params = { format: 'json' };
|
|
671
|
+
if (flags.mode)
|
|
672
|
+
params.mode = flags.mode;
|
|
673
|
+
if (flags.reference)
|
|
674
|
+
params.reference = flags.reference;
|
|
675
|
+
if (flags.async)
|
|
676
|
+
params.async = true;
|
|
677
|
+
const headers = {};
|
|
678
|
+
if (flags['idempotency-key'])
|
|
679
|
+
headers['Idempotency-Key'] = flags['idempotency-key'];
|
|
680
|
+
if (flags['show-http-request']) {
|
|
681
|
+
const baseUrls = getBaseUrls(context.environment);
|
|
682
|
+
const queryString = '?' + Object.entries(params).map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(String(v))}`).join('&');
|
|
683
|
+
process.stderr.write(`\n${endpoint.method.toUpperCase()} ${baseUrls.api}${apiPath}${queryString}\n`);
|
|
684
|
+
process.stderr.write(`Body: [${records.length} record${records.length === 1 ? '' : 's'}]\n\n`);
|
|
685
|
+
}
|
|
686
|
+
try {
|
|
687
|
+
const response = await apiRequest(endpoint.method, apiPath, {
|
|
688
|
+
contextName: flags.context,
|
|
689
|
+
data: records,
|
|
690
|
+
headers,
|
|
691
|
+
params,
|
|
692
|
+
});
|
|
693
|
+
this.printImportRun(response.data, flags);
|
|
694
|
+
}
|
|
695
|
+
catch (error) {
|
|
696
|
+
if (error instanceof ApiError) {
|
|
697
|
+
this.error(`API Error (${error.status}): ${error.message}`);
|
|
698
|
+
}
|
|
699
|
+
throw error;
|
|
700
|
+
}
|
|
701
|
+
}
|
|
702
|
+
/** Renders an import run: its counts, then whatever the server refused. */
|
|
703
|
+
printImportRun(run, flags) {
|
|
704
|
+
if (flags.output === 'json') {
|
|
705
|
+
this.log(JSON.stringify(run, null, 2));
|
|
706
|
+
return;
|
|
707
|
+
}
|
|
708
|
+
const record = (run ?? {});
|
|
709
|
+
const count = (key) => (typeof record[key] === 'number' ? record[key] : 0);
|
|
710
|
+
const id = record.id ? String(record.id) : '';
|
|
711
|
+
this.log(`Import ${id} - ${String(record.status ?? 'UNKNOWN')}${record.async ? ' (background)' : ''}`);
|
|
712
|
+
this.log(` ${count('inputSize')} submitted, ${count('createdCount')} created, ${count('updatedCount')} updated, ${count('unchangedCount')} unchanged`);
|
|
713
|
+
if (count('errorCount') > 0)
|
|
714
|
+
this.log(` ${count('errorCount')} not applied: ${count('refusedCount')} refused, ${count('failedCount')} failed`);
|
|
715
|
+
if (count('warningCount') > 0)
|
|
716
|
+
this.log(` ${count('warningCount')} applied with a warning`);
|
|
717
|
+
// errorLog is keyed by the record's identifier, then by field name.
|
|
718
|
+
const errorLog = record.errorLog;
|
|
719
|
+
if (errorLog && Object.keys(errorLog).length > 0) {
|
|
720
|
+
this.log('');
|
|
721
|
+
for (const [key, fields] of Object.entries(errorLog)) {
|
|
722
|
+
for (const [field, messages] of Object.entries(fields ?? {})) {
|
|
723
|
+
for (const message of messages ?? [])
|
|
724
|
+
this.log(` ${key} ${field}: ${message}`);
|
|
725
|
+
}
|
|
726
|
+
}
|
|
727
|
+
}
|
|
728
|
+
if (record.async && id) {
|
|
729
|
+
this.log('');
|
|
730
|
+
this.log(`Follow it with: aderis imports get ${id}`);
|
|
731
|
+
}
|
|
732
|
+
}
|
|
599
733
|
async runExport(flags) {
|
|
600
734
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
601
735
|
if (!context)
|
|
@@ -774,9 +908,9 @@ export default class Tools extends Command {
|
|
|
774
908
|
throw error;
|
|
775
909
|
}
|
|
776
910
|
}
|
|
777
|
-
async
|
|
911
|
+
async runNestedUpsert(suffix, parentId, flags) {
|
|
778
912
|
if (!parentId) {
|
|
779
|
-
this.error(`Missing required argument: id. Usage: aderis tools
|
|
913
|
+
this.error(`Missing required argument: id. Usage: aderis tools upsert-${suffix} <parent-id> --file data.json`);
|
|
780
914
|
}
|
|
781
915
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
782
916
|
if (!context)
|
|
@@ -841,12 +975,12 @@ export default class Tools extends Command {
|
|
|
841
975
|
items = [item];
|
|
842
976
|
}
|
|
843
977
|
else {
|
|
844
|
-
this.error(
|
|
978
|
+
this.error('Upsert requires --file, --data, or --set flags');
|
|
845
979
|
}
|
|
846
980
|
const createEndpoint = ENDPOINTS[`create-${suffix}`];
|
|
847
981
|
const updateEndpoint = ENDPOINTS[`update-${suffix}`];
|
|
848
982
|
if (!createEndpoint || !updateEndpoint) {
|
|
849
|
-
this.error(`
|
|
983
|
+
this.error(`Upsert requires both create-${suffix} and update-${suffix} endpoints`);
|
|
850
984
|
}
|
|
851
985
|
// Build the base path with parent ID (first path param)
|
|
852
986
|
const firstParam = createEndpoint.pathParams[0];
|
package/dist/commands/users.d.ts
CHANGED
|
@@ -30,10 +30,19 @@ export default class Users extends Command {
|
|
|
30
30
|
'show-http-request': import("@oclif/core/interfaces").BooleanFlag<boolean>;
|
|
31
31
|
};
|
|
32
32
|
run(): Promise<void>;
|
|
33
|
-
private
|
|
33
|
+
private runUpsert;
|
|
34
|
+
/**
|
|
35
|
+
* The API's own import: the whole array goes up in one request and comes
|
|
36
|
+
* back as an import run, which records what happened to every record. A bad
|
|
37
|
+
* record lands in errorLog and the rest are still applied, and the run stays
|
|
38
|
+
* readable afterwards with: aderis imports get <id>.
|
|
39
|
+
*/
|
|
40
|
+
private runServerImport;
|
|
41
|
+
/** Renders an import run: its counts, then whatever the server refused. */
|
|
42
|
+
private printImportRun;
|
|
34
43
|
private runExport;
|
|
35
44
|
private runCamt053Import;
|
|
36
|
-
private
|
|
45
|
+
private runNestedUpsert;
|
|
37
46
|
private parseFilterValue;
|
|
38
47
|
/** The page line under a table: which page, how many, and any sums the API returned. */
|
|
39
48
|
private printPageSummary;
|
package/dist/commands/users.js
CHANGED
|
@@ -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 = ["roles"];
|
|
12
|
+
const SUBCOMMANDS = [...["list-invitations", "create-invitations", "send-invitations-resend", "delete-invitations", "list", "create", "get", "update", "delete", "get-credentials", "password-reset", "delete-credentials-mfa", "delete-credentials-otp", "delete-credentials-passkeys", "delete-identity-providers", "permissions", "list-roles", "create-roles", "update-roles", "delete-roles", "disable", "enable"], ...(HAS_UPSERT ? ['upsert'] : []), ...(HAS_EXPORT ? ['export'] : []), ...NESTED_UPSERTS.map(n => `upsert-${n}`)];
|
|
10
13
|
const ENDPOINTS = {
|
|
11
14
|
'list-invitations': { method: 'GET', path: '/v1/users/invitations', summary: 'List the invitations still waiting to be accepted', pathParams: [], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
|
|
12
15
|
'create-invitations': { method: 'POST', path: '/v1/users/invitations', summary: 'Invite a person who has no Aderis login yet', pathParams: [], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
|
|
@@ -38,7 +41,7 @@ export default class Users extends Command {
|
|
|
38
41
|
'<%= config.bin %> users get <id>',
|
|
39
42
|
'<%= config.bin %> users create --data \'{...}\'',
|
|
40
43
|
'<%= config.bin %> users update <id> --set field=value',
|
|
41
|
-
'<%= config.bin %> users
|
|
44
|
+
'<%= config.bin %> users upsert --file data.json',
|
|
42
45
|
'<%= config.bin %> users export --csv > users.csv',
|
|
43
46
|
];
|
|
44
47
|
static args = {
|
|
@@ -47,7 +50,7 @@ export default class Users extends Command {
|
|
|
47
50
|
};
|
|
48
51
|
static flags = {
|
|
49
52
|
context: Flags.string({ char: 'c', aliases: ['config'], env: 'ADERIS_CONTEXT', description: 'Context to use for this command, overriding the current context (alias: --config)' }),
|
|
50
|
-
output: Flags.string({ char: 'o', description: 'Output format (default: table for
|
|
53
|
+
output: Flags.string({ char: 'o', description: 'Output format (default: table for upsert, json for other commands)', options: ['json', 'table', 'csv'] }),
|
|
51
54
|
table: Flags.boolean({ char: 't', description: 'Output as table (shortcut for --output table)' }),
|
|
52
55
|
csv: Flags.boolean({ description: 'Output as CSV (shortcut for --output csv)' }),
|
|
53
56
|
data: Flags.string({ char: 'd', description: 'JSON data for request body' }),
|
|
@@ -70,11 +73,26 @@ export default class Users extends Command {
|
|
|
70
73
|
};
|
|
71
74
|
async run() {
|
|
72
75
|
const { args, flags } = await this.parse(Users);
|
|
73
|
-
//
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
76
|
+
// Bulk actions. 'import' is the API's own endpoint: one request, answered
|
|
77
|
+
// by a run that records what happened to every record. 'upsert' is the CLI
|
|
78
|
+
// looping create/update. A resource has one or the other, never both.
|
|
79
|
+
if (args.action === 'upsert') {
|
|
80
|
+
if (!HAS_UPSERT) {
|
|
81
|
+
this.error(SERVER_IMPORTS.includes('import')
|
|
82
|
+
? 'This resource is imported by the API. Use: aderis users import --file data.json'
|
|
83
|
+
: 'Upsert needs both a create and an update endpoint, which this resource does not have');
|
|
84
|
+
}
|
|
85
|
+
await this.runUpsert(flags);
|
|
86
|
+
return;
|
|
87
|
+
}
|
|
88
|
+
if (args.action.startsWith('upsert-')) {
|
|
89
|
+
const suffix = args.action.replace('upsert-', '');
|
|
90
|
+
if (!NESTED_UPSERTS.includes(suffix)) {
|
|
91
|
+
this.error(SERVER_IMPORTS.includes('import-' + suffix)
|
|
92
|
+
? `That resource is imported by the API. Use: aderis users import-${suffix} <id> --file data.json`
|
|
93
|
+
: `Unknown action: ${args.action}. Available: ${SUBCOMMANDS.join(', ')}`);
|
|
94
|
+
}
|
|
95
|
+
await this.runNestedUpsert(suffix, args.id, flags);
|
|
78
96
|
return;
|
|
79
97
|
}
|
|
80
98
|
// Handle export action specially
|
|
@@ -91,12 +109,17 @@ export default class Users extends Command {
|
|
|
91
109
|
await this.runCamt053Import(flags);
|
|
92
110
|
return;
|
|
93
111
|
}
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
112
|
+
if (SERVER_IMPORTS.includes(args.action)) {
|
|
113
|
+
await this.runServerImport(args.action, args.id, flags);
|
|
114
|
+
return;
|
|
115
|
+
}
|
|
116
|
+
// 'import' used to name the CLI's create/update loop on every resource. It
|
|
117
|
+
// now names the API endpoint, which most resources do not have.
|
|
118
|
+
if (args.action === 'import' || args.action.startsWith('import-')) {
|
|
119
|
+
const suffix = args.action === 'import' ? '' : '-' + args.action.replace('import-', '');
|
|
120
|
+
const loops = args.action === 'import' ? HAS_UPSERT : NESTED_UPSERTS.includes(args.action.replace('import-', ''));
|
|
121
|
+
if (loops) {
|
|
122
|
+
this.error(`This resource has no import endpoint. Use: aderis users upsert${suffix}${suffix ? ' <id>' : ''} --file data.json`);
|
|
100
123
|
}
|
|
101
124
|
}
|
|
102
125
|
const endpoint = ENDPOINTS[args.action];
|
|
@@ -411,7 +434,7 @@ export default class Users extends Command {
|
|
|
411
434
|
throw error;
|
|
412
435
|
}
|
|
413
436
|
}
|
|
414
|
-
async
|
|
437
|
+
async runUpsert(flags) {
|
|
415
438
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
416
439
|
if (!context)
|
|
417
440
|
this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
|
|
@@ -475,12 +498,12 @@ export default class Users extends Command {
|
|
|
475
498
|
items = [item];
|
|
476
499
|
}
|
|
477
500
|
else {
|
|
478
|
-
this.error('
|
|
501
|
+
this.error('Upsert requires --file, --data, or --set flags');
|
|
479
502
|
}
|
|
480
503
|
const createEndpoint = ENDPOINTS['create'];
|
|
481
504
|
const updateEndpoint = ENDPOINTS['update'];
|
|
482
505
|
if (!createEndpoint || !updateEndpoint) {
|
|
483
|
-
this.error('
|
|
506
|
+
this.error('Upsert requires both create and update endpoints');
|
|
484
507
|
}
|
|
485
508
|
// Helper to extract identifier from item (id, code, or xxxCode)
|
|
486
509
|
const getItemIdentifier = (item) => {
|
|
@@ -623,6 +646,117 @@ export default class Users extends Command {
|
|
|
623
646
|
this.log('');
|
|
624
647
|
this.log(`Summary: ${created} created, ${updated} updated, ${errors.length} failed`);
|
|
625
648
|
}
|
|
649
|
+
/**
|
|
650
|
+
* The API's own import: the whole array goes up in one request and comes
|
|
651
|
+
* back as an import run, which records what happened to every record. A bad
|
|
652
|
+
* record lands in errorLog and the rest are still applied, and the run stays
|
|
653
|
+
* readable afterwards with: aderis imports get <id>.
|
|
654
|
+
*/
|
|
655
|
+
async runServerImport(action, parentId, flags) {
|
|
656
|
+
const endpoint = ENDPOINTS[action];
|
|
657
|
+
if (!endpoint)
|
|
658
|
+
this.error(`Unknown action: ${action}. Available: ${SUBCOMMANDS.join(', ')}`);
|
|
659
|
+
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
660
|
+
if (!context)
|
|
661
|
+
this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
|
|
662
|
+
if (!hasCredentials(context))
|
|
663
|
+
this.error(missingCredentialsMessage(context));
|
|
664
|
+
let apiPath = endpoint.path;
|
|
665
|
+
if (endpoint.pathParams.length > 0) {
|
|
666
|
+
if (!parentId)
|
|
667
|
+
this.error(`Missing required argument: id. Usage: aderis users ${action} <parent-id> --file data.json`);
|
|
668
|
+
apiPath = apiPath.replace(`{${endpoint.pathParams[0]}}`, parentId);
|
|
669
|
+
}
|
|
670
|
+
// The endpoint takes an array. A single object is wrapped, so importing
|
|
671
|
+
// one record reads the same as importing many.
|
|
672
|
+
let records = [];
|
|
673
|
+
if (flags.file) {
|
|
674
|
+
const fsModule = await import('node:fs');
|
|
675
|
+
try {
|
|
676
|
+
const content = JSON.parse(fsModule.readFileSync(flags.file, 'utf-8'));
|
|
677
|
+
records = Array.isArray(content) ? content : [content];
|
|
678
|
+
}
|
|
679
|
+
catch {
|
|
680
|
+
this.error(`Failed to read file: ${flags.file}`);
|
|
681
|
+
}
|
|
682
|
+
}
|
|
683
|
+
else if (flags.data) {
|
|
684
|
+
try {
|
|
685
|
+
const content = JSON.parse(flags.data);
|
|
686
|
+
records = Array.isArray(content) ? content : [content];
|
|
687
|
+
}
|
|
688
|
+
catch {
|
|
689
|
+
this.error('Invalid JSON in --data');
|
|
690
|
+
}
|
|
691
|
+
}
|
|
692
|
+
else {
|
|
693
|
+
this.error('Import requires --file or --data holding a JSON array of records');
|
|
694
|
+
}
|
|
695
|
+
if (records.length === 0)
|
|
696
|
+
this.error('Nothing to import: the input is an empty array');
|
|
697
|
+
const params = { format: 'json' };
|
|
698
|
+
if (flags.mode)
|
|
699
|
+
params.mode = flags.mode;
|
|
700
|
+
if (flags.reference)
|
|
701
|
+
params.reference = flags.reference;
|
|
702
|
+
if (flags.async)
|
|
703
|
+
params.async = true;
|
|
704
|
+
const headers = {};
|
|
705
|
+
if (flags['idempotency-key'])
|
|
706
|
+
headers['Idempotency-Key'] = flags['idempotency-key'];
|
|
707
|
+
if (flags['show-http-request']) {
|
|
708
|
+
const baseUrls = getBaseUrls(context.environment);
|
|
709
|
+
const queryString = '?' + Object.entries(params).map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(String(v))}`).join('&');
|
|
710
|
+
process.stderr.write(`\n${endpoint.method.toUpperCase()} ${baseUrls.api}${apiPath}${queryString}\n`);
|
|
711
|
+
process.stderr.write(`Body: [${records.length} record${records.length === 1 ? '' : 's'}]\n\n`);
|
|
712
|
+
}
|
|
713
|
+
try {
|
|
714
|
+
const response = await apiRequest(endpoint.method, apiPath, {
|
|
715
|
+
contextName: flags.context,
|
|
716
|
+
data: records,
|
|
717
|
+
headers,
|
|
718
|
+
params,
|
|
719
|
+
});
|
|
720
|
+
this.printImportRun(response.data, flags);
|
|
721
|
+
}
|
|
722
|
+
catch (error) {
|
|
723
|
+
if (error instanceof ApiError) {
|
|
724
|
+
this.error(`API Error (${error.status}): ${error.message}`);
|
|
725
|
+
}
|
|
726
|
+
throw error;
|
|
727
|
+
}
|
|
728
|
+
}
|
|
729
|
+
/** Renders an import run: its counts, then whatever the server refused. */
|
|
730
|
+
printImportRun(run, flags) {
|
|
731
|
+
if (flags.output === 'json') {
|
|
732
|
+
this.log(JSON.stringify(run, null, 2));
|
|
733
|
+
return;
|
|
734
|
+
}
|
|
735
|
+
const record = (run ?? {});
|
|
736
|
+
const count = (key) => (typeof record[key] === 'number' ? record[key] : 0);
|
|
737
|
+
const id = record.id ? String(record.id) : '';
|
|
738
|
+
this.log(`Import ${id} - ${String(record.status ?? 'UNKNOWN')}${record.async ? ' (background)' : ''}`);
|
|
739
|
+
this.log(` ${count('inputSize')} submitted, ${count('createdCount')} created, ${count('updatedCount')} updated, ${count('unchangedCount')} unchanged`);
|
|
740
|
+
if (count('errorCount') > 0)
|
|
741
|
+
this.log(` ${count('errorCount')} not applied: ${count('refusedCount')} refused, ${count('failedCount')} failed`);
|
|
742
|
+
if (count('warningCount') > 0)
|
|
743
|
+
this.log(` ${count('warningCount')} applied with a warning`);
|
|
744
|
+
// errorLog is keyed by the record's identifier, then by field name.
|
|
745
|
+
const errorLog = record.errorLog;
|
|
746
|
+
if (errorLog && Object.keys(errorLog).length > 0) {
|
|
747
|
+
this.log('');
|
|
748
|
+
for (const [key, fields] of Object.entries(errorLog)) {
|
|
749
|
+
for (const [field, messages] of Object.entries(fields ?? {})) {
|
|
750
|
+
for (const message of messages ?? [])
|
|
751
|
+
this.log(` ${key} ${field}: ${message}`);
|
|
752
|
+
}
|
|
753
|
+
}
|
|
754
|
+
}
|
|
755
|
+
if (record.async && id) {
|
|
756
|
+
this.log('');
|
|
757
|
+
this.log(`Follow it with: aderis imports get ${id}`);
|
|
758
|
+
}
|
|
759
|
+
}
|
|
626
760
|
async runExport(flags) {
|
|
627
761
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
628
762
|
if (!context)
|
|
@@ -801,9 +935,9 @@ export default class Users extends Command {
|
|
|
801
935
|
throw error;
|
|
802
936
|
}
|
|
803
937
|
}
|
|
804
|
-
async
|
|
938
|
+
async runNestedUpsert(suffix, parentId, flags) {
|
|
805
939
|
if (!parentId) {
|
|
806
|
-
this.error(`Missing required argument: id. Usage: aderis users
|
|
940
|
+
this.error(`Missing required argument: id. Usage: aderis users upsert-${suffix} <parent-id> --file data.json`);
|
|
807
941
|
}
|
|
808
942
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
809
943
|
if (!context)
|
|
@@ -868,12 +1002,12 @@ export default class Users extends Command {
|
|
|
868
1002
|
items = [item];
|
|
869
1003
|
}
|
|
870
1004
|
else {
|
|
871
|
-
this.error(
|
|
1005
|
+
this.error('Upsert requires --file, --data, or --set flags');
|
|
872
1006
|
}
|
|
873
1007
|
const createEndpoint = ENDPOINTS[`create-${suffix}`];
|
|
874
1008
|
const updateEndpoint = ENDPOINTS[`update-${suffix}`];
|
|
875
1009
|
if (!createEndpoint || !updateEndpoint) {
|
|
876
|
-
this.error(`
|
|
1010
|
+
this.error(`Upsert requires both create-${suffix} and update-${suffix} endpoints`);
|
|
877
1011
|
}
|
|
878
1012
|
// Build the base path with parent ID (first path param)
|
|
879
1013
|
const firstParam = createEndpoint.pathParams[0];
|
|
@@ -32,10 +32,19 @@ export default class VatDeclarations extends Command {
|
|
|
32
32
|
'show-http-request': import("@oclif/core/interfaces").BooleanFlag<boolean>;
|
|
33
33
|
};
|
|
34
34
|
run(): Promise<void>;
|
|
35
|
-
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;
|
|
36
45
|
private runExport;
|
|
37
46
|
private runCamt053Import;
|
|
38
|
-
private
|
|
47
|
+
private runNestedUpsert;
|
|
39
48
|
private parseFilterValue;
|
|
40
49
|
/** The page line under a table: which page, how many, and any sums the API returned. */
|
|
41
50
|
private printPageSummary;
|