@aderis-erp/cli 1.1.2 → 1.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/commands/access-groups.d.ts +11 -2
- package/dist/commands/access-groups.js +158 -24
- package/dist/commands/account-transaction-allocations.d.ts +11 -2
- package/dist/commands/account-transaction-allocations.js +157 -23
- package/dist/commands/account-transactions.d.ts +15 -2
- package/dist/commands/account-transactions.js +162 -24
- package/dist/commands/accounts.d.ts +11 -2
- package/dist/commands/accounts.js +158 -24
- package/dist/commands/agent-platform.d.ts +11 -3
- package/dist/commands/agent-platform.js +157 -32
- package/dist/commands/agent-runs.d.ts +11 -2
- package/dist/commands/agent-runs.js +157 -23
- package/dist/commands/analytics.d.ts +11 -2
- package/dist/commands/analytics.js +157 -23
- package/dist/commands/api-keys.d.ts +11 -2
- package/dist/commands/api-keys.js +157 -23
- package/dist/commands/async-jobs.d.ts +11 -2
- package/dist/commands/async-jobs.js +158 -24
- package/dist/commands/audit-log.d.ts +11 -2
- package/dist/commands/audit-log.js +157 -23
- package/dist/commands/bank-accounts.d.ts +11 -2
- package/dist/commands/bank-accounts.js +158 -24
- package/dist/commands/bank-integrations.d.ts +11 -2
- package/dist/commands/bank-integrations.js +158 -24
- package/dist/commands/business-partners.d.ts +11 -2
- package/dist/commands/business-partners.js +158 -24
- package/dist/commands/chat.d.ts +11 -2
- package/dist/commands/chat.js +158 -24
- package/dist/commands/credit-card-accounts.d.ts +11 -2
- package/dist/commands/credit-card-accounts.js +158 -24
- package/dist/commands/delivery-notes.d.ts +11 -2
- package/dist/commands/delivery-notes.js +158 -24
- package/dist/commands/dunning-configs.d.ts +11 -2
- package/dist/commands/dunning-configs.js +158 -24
- package/dist/commands/dunning-reminders.d.ts +11 -2
- package/dist/commands/dunning-reminders.js +157 -23
- package/dist/commands/dunning-runs.d.ts +11 -2
- package/dist/commands/dunning-runs.js +157 -23
- package/dist/commands/email-transactions.d.ts +11 -2
- package/dist/commands/email-transactions.js +157 -23
- package/dist/commands/employees.d.ts +13 -2
- package/dist/commands/employees.js +169 -24
- package/dist/commands/entity-configurations.d.ts +11 -2
- package/dist/commands/entity-configurations.js +157 -23
- package/dist/commands/event-mapping-rules.d.ts +56 -0
- package/dist/commands/event-mapping-rules.js +1324 -0
- package/dist/commands/event-processor-mappings.d.ts +11 -2
- package/dist/commands/event-processor-mappings.js +158 -24
- package/dist/commands/files.d.ts +11 -2
- package/dist/commands/files.js +158 -24
- package/dist/commands/health.d.ts +11 -2
- package/dist/commands/health.js +157 -23
- package/dist/commands/imports.d.ts +11 -2
- package/dist/commands/imports.js +157 -23
- package/dist/commands/inbox.d.ts +11 -2
- package/dist/commands/inbox.js +157 -23
- package/dist/commands/integration-identities.d.ts +11 -2
- package/dist/commands/integration-identities.js +157 -23
- package/dist/commands/integrations.d.ts +11 -2
- package/dist/commands/integrations.js +157 -23
- package/dist/commands/item-categories.d.ts +11 -2
- package/dist/commands/item-categories.js +158 -24
- package/dist/commands/items.d.ts +15 -2
- package/dist/commands/items.js +163 -24
- package/dist/commands/journal-lines.d.ts +11 -2
- package/dist/commands/journal-lines.js +157 -23
- package/dist/commands/journals.d.ts +15 -2
- package/dist/commands/journals.js +163 -24
- package/dist/commands/ledgers.d.ts +11 -2
- package/dist/commands/ledgers.js +158 -24
- package/dist/commands/my-account.d.ts +11 -2
- package/dist/commands/my-account.js +157 -23
- package/dist/commands/office-locations.d.ts +11 -2
- package/dist/commands/office-locations.js +158 -24
- package/dist/commands/payment-methods.d.ts +11 -2
- package/dist/commands/payment-methods.js +158 -24
- package/dist/commands/payment-runs.d.ts +11 -2
- package/dist/commands/payment-runs.js +158 -24
- package/dist/commands/payment-terms.d.ts +11 -2
- package/dist/commands/payment-terms.js +159 -25
- package/dist/commands/payments.d.ts +11 -2
- package/dist/commands/payments.js +158 -24
- package/dist/commands/payroll-runs.d.ts +11 -2
- package/dist/commands/payroll-runs.js +158 -24
- package/dist/commands/permissions.d.ts +11 -2
- package/dist/commands/permissions.js +157 -23
- package/dist/commands/price-lists.d.ts +15 -2
- package/dist/commands/price-lists.js +164 -24
- package/dist/commands/processor-mappings.d.ts +11 -2
- package/dist/commands/processor-mappings.js +158 -24
- package/dist/commands/processors.d.ts +11 -2
- package/dist/commands/processors.js +158 -24
- package/dist/commands/purchase-order-types.d.ts +11 -2
- package/dist/commands/purchase-order-types.js +158 -24
- package/dist/commands/purchase-orders.d.ts +11 -2
- package/dist/commands/purchase-orders.js +158 -24
- package/dist/commands/reports.d.ts +11 -2
- package/dist/commands/reports.js +157 -23
- package/dist/commands/roles.d.ts +11 -2
- package/dist/commands/roles.js +158 -24
- package/dist/commands/salary-types.d.ts +11 -2
- package/dist/commands/salary-types.js +158 -24
- package/dist/commands/sales-invoices.d.ts +11 -2
- package/dist/commands/sales-invoices.js +161 -24
- package/dist/commands/sales-orders.d.ts +11 -2
- package/dist/commands/sales-orders.js +158 -24
- package/dist/commands/saved-views.d.ts +11 -2
- package/dist/commands/saved-views.js +157 -23
- package/dist/commands/scheduled-processor-mappings.d.ts +11 -2
- package/dist/commands/scheduled-processor-mappings.js +158 -24
- package/dist/commands/schedules.d.ts +11 -2
- package/dist/commands/schedules.js +158 -24
- package/dist/commands/tags.d.ts +11 -2
- package/dist/commands/tags.js +158 -24
- package/dist/commands/tax-codes.d.ts +11 -2
- package/dist/commands/tax-codes.js +158 -24
- package/dist/commands/tax-matrix.d.ts +11 -2
- package/dist/commands/tax-matrix.js +158 -24
- package/dist/commands/templates.d.ts +11 -2
- package/dist/commands/templates.js +162 -24
- package/dist/commands/tenants.d.ts +11 -2
- package/dist/commands/tenants.js +158 -24
- package/dist/commands/tools.d.ts +11 -2
- package/dist/commands/tools.js +157 -23
- package/dist/commands/users.d.ts +11 -2
- package/dist/commands/users.js +158 -24
- package/dist/commands/vat-declarations.d.ts +11 -2
- package/dist/commands/vat-declarations.js +158 -24
- package/dist/commands/vendor-invoices.d.ts +11 -2
- package/dist/commands/vendor-invoices.js +161 -24
- package/dist/commands/webhooks.d.ts +11 -2
- package/dist/commands/webhooks.js +158 -24
- package/dist/commands/workflows.d.ts +11 -2
- package/dist/commands/workflows.js +157 -23
- package/dist/lib/api-client.d.ts +1 -0
- package/dist/lib/api-client.js +3 -0
- package/oclif.manifest.json +466 -162
- package/package.json +1 -1
|
@@ -1,12 +1,15 @@
|
|
|
1
1
|
import { Command, Args, Flags } from '@oclif/core';
|
|
2
2
|
import { apiRequest, ApiError, isTextualMediaType, normalizeSortBy } from '../lib/api-client.js';
|
|
3
3
|
import { getCurrentContext, getContext, getBaseUrls, hasCredentials, missingCredentialsMessage } from '../lib/config.js';
|
|
4
|
-
//
|
|
5
|
-
|
|
4
|
+
// 'upsert' loops create/update from the CLI, one request per record. It exists
|
|
5
|
+
// only where the API has no import endpoint of its own; those keep the name
|
|
6
|
+
// 'import' and are listed in SERVER_IMPORTS.
|
|
7
|
+
const HAS_UPSERT = true;
|
|
6
8
|
const HAS_EXPORT = true;
|
|
7
9
|
const HAS_CAMT053 = false;
|
|
8
|
-
const
|
|
9
|
-
const
|
|
10
|
+
const SERVER_IMPORTS = [];
|
|
11
|
+
const NESTED_UPSERTS = ["line-items", "notes", "files"];
|
|
12
|
+
const SUBCOMMANDS = [...["list", "create", "get", "update", "delete", "submit", "approve", "copy", "decline", "cancel", "create-line-items", "update-line-items", "delete-line-items", "list-notes", "create-notes", "get-notes", "update-notes", "delete-notes", "list-files", "create-files", "get-files", "update-files", "delete-files", "files-download"], ...(HAS_UPSERT ? ['upsert'] : []), ...(HAS_EXPORT ? ['export'] : []), ...NESTED_UPSERTS.map(n => `upsert-${n}`)];
|
|
10
13
|
const ENDPOINTS = {
|
|
11
14
|
'list': { method: 'GET', path: '/v1/purchase-orders', summary: 'Get all purchase orders with pagination', pathParams: [], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
|
|
12
15
|
'create': { method: 'POST', path: '/v1/purchase-orders', summary: 'Create a new purchase order', pathParams: [], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: ['tagIds', 'tagCodes', 'files', 'notes', 'discounts', 'lineItems'] },
|
|
@@ -40,7 +43,7 @@ export default class PurchaseOrders extends Command {
|
|
|
40
43
|
'<%= config.bin %> purchase-orders get <id>',
|
|
41
44
|
'<%= config.bin %> purchase-orders create --data \'{...}\'',
|
|
42
45
|
'<%= config.bin %> purchase-orders update <id> --set field=value',
|
|
43
|
-
'<%= config.bin %> purchase-orders
|
|
46
|
+
'<%= config.bin %> purchase-orders upsert --file data.json',
|
|
44
47
|
'<%= config.bin %> purchase-orders export --csv > purchase-orders.csv',
|
|
45
48
|
];
|
|
46
49
|
static args = {
|
|
@@ -49,7 +52,7 @@ export default class PurchaseOrders extends Command {
|
|
|
49
52
|
};
|
|
50
53
|
static flags = {
|
|
51
54
|
context: Flags.string({ char: 'c', aliases: ['config'], env: 'ADERIS_CONTEXT', description: 'Context to use for this command, overriding the current context (alias: --config)' }),
|
|
52
|
-
output: Flags.string({ char: 'o', description: 'Output format (default: table for
|
|
55
|
+
output: Flags.string({ char: 'o', description: 'Output format (default: table for upsert, json for other commands)', options: ['json', 'table', 'csv'] }),
|
|
53
56
|
table: Flags.boolean({ char: 't', description: 'Output as table (shortcut for --output table)' }),
|
|
54
57
|
csv: Flags.boolean({ description: 'Output as CSV (shortcut for --output csv)' }),
|
|
55
58
|
data: Flags.string({ char: 'd', description: 'JSON data for request body' }),
|
|
@@ -72,11 +75,26 @@ export default class PurchaseOrders extends Command {
|
|
|
72
75
|
};
|
|
73
76
|
async run() {
|
|
74
77
|
const { args, flags } = await this.parse(PurchaseOrders);
|
|
75
|
-
//
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
78
|
+
// Bulk actions. 'import' is the API's own endpoint: one request, answered
|
|
79
|
+
// by a run that records what happened to every record. 'upsert' is the CLI
|
|
80
|
+
// looping create/update. A resource has one or the other, never both.
|
|
81
|
+
if (args.action === 'upsert') {
|
|
82
|
+
if (!HAS_UPSERT) {
|
|
83
|
+
this.error(SERVER_IMPORTS.includes('import')
|
|
84
|
+
? 'This resource is imported by the API. Use: aderis purchase-orders import --file data.json'
|
|
85
|
+
: 'Upsert needs both a create and an update endpoint, which this resource does not have');
|
|
86
|
+
}
|
|
87
|
+
await this.runUpsert(flags);
|
|
88
|
+
return;
|
|
89
|
+
}
|
|
90
|
+
if (args.action.startsWith('upsert-')) {
|
|
91
|
+
const suffix = args.action.replace('upsert-', '');
|
|
92
|
+
if (!NESTED_UPSERTS.includes(suffix)) {
|
|
93
|
+
this.error(SERVER_IMPORTS.includes('import-' + suffix)
|
|
94
|
+
? `That resource is imported by the API. Use: aderis purchase-orders import-${suffix} <id> --file data.json`
|
|
95
|
+
: `Unknown action: ${args.action}. Available: ${SUBCOMMANDS.join(', ')}`);
|
|
96
|
+
}
|
|
97
|
+
await this.runNestedUpsert(suffix, args.id, flags);
|
|
80
98
|
return;
|
|
81
99
|
}
|
|
82
100
|
// Handle export action specially
|
|
@@ -93,12 +111,17 @@ export default class PurchaseOrders extends Command {
|
|
|
93
111
|
await this.runCamt053Import(flags);
|
|
94
112
|
return;
|
|
95
113
|
}
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
114
|
+
if (SERVER_IMPORTS.includes(args.action)) {
|
|
115
|
+
await this.runServerImport(args.action, args.id, flags);
|
|
116
|
+
return;
|
|
117
|
+
}
|
|
118
|
+
// 'import' used to name the CLI's create/update loop on every resource. It
|
|
119
|
+
// now names the API endpoint, which most resources do not have.
|
|
120
|
+
if (args.action === 'import' || args.action.startsWith('import-')) {
|
|
121
|
+
const suffix = args.action === 'import' ? '' : '-' + args.action.replace('import-', '');
|
|
122
|
+
const loops = args.action === 'import' ? HAS_UPSERT : NESTED_UPSERTS.includes(args.action.replace('import-', ''));
|
|
123
|
+
if (loops) {
|
|
124
|
+
this.error(`This resource has no import endpoint. Use: aderis purchase-orders upsert${suffix}${suffix ? ' <id>' : ''} --file data.json`);
|
|
102
125
|
}
|
|
103
126
|
}
|
|
104
127
|
const endpoint = ENDPOINTS[args.action];
|
|
@@ -413,7 +436,7 @@ export default class PurchaseOrders extends Command {
|
|
|
413
436
|
throw error;
|
|
414
437
|
}
|
|
415
438
|
}
|
|
416
|
-
async
|
|
439
|
+
async runUpsert(flags) {
|
|
417
440
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
418
441
|
if (!context)
|
|
419
442
|
this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
|
|
@@ -477,12 +500,12 @@ export default class PurchaseOrders extends Command {
|
|
|
477
500
|
items = [item];
|
|
478
501
|
}
|
|
479
502
|
else {
|
|
480
|
-
this.error('
|
|
503
|
+
this.error('Upsert requires --file, --data, or --set flags');
|
|
481
504
|
}
|
|
482
505
|
const createEndpoint = ENDPOINTS['create'];
|
|
483
506
|
const updateEndpoint = ENDPOINTS['update'];
|
|
484
507
|
if (!createEndpoint || !updateEndpoint) {
|
|
485
|
-
this.error('
|
|
508
|
+
this.error('Upsert requires both create and update endpoints');
|
|
486
509
|
}
|
|
487
510
|
// Helper to extract identifier from item (id, code, or xxxCode)
|
|
488
511
|
const getItemIdentifier = (item) => {
|
|
@@ -625,6 +648,117 @@ export default class PurchaseOrders extends Command {
|
|
|
625
648
|
this.log('');
|
|
626
649
|
this.log(`Summary: ${created} created, ${updated} updated, ${errors.length} failed`);
|
|
627
650
|
}
|
|
651
|
+
/**
|
|
652
|
+
* The API's own import: the whole array goes up in one request and comes
|
|
653
|
+
* back as an import run, which records what happened to every record. A bad
|
|
654
|
+
* record lands in errorLog and the rest are still applied, and the run stays
|
|
655
|
+
* readable afterwards with: aderis imports get <id>.
|
|
656
|
+
*/
|
|
657
|
+
async runServerImport(action, parentId, flags) {
|
|
658
|
+
const endpoint = ENDPOINTS[action];
|
|
659
|
+
if (!endpoint)
|
|
660
|
+
this.error(`Unknown action: ${action}. Available: ${SUBCOMMANDS.join(', ')}`);
|
|
661
|
+
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
662
|
+
if (!context)
|
|
663
|
+
this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
|
|
664
|
+
if (!hasCredentials(context))
|
|
665
|
+
this.error(missingCredentialsMessage(context));
|
|
666
|
+
let apiPath = endpoint.path;
|
|
667
|
+
if (endpoint.pathParams.length > 0) {
|
|
668
|
+
if (!parentId)
|
|
669
|
+
this.error(`Missing required argument: id. Usage: aderis purchase-orders ${action} <parent-id> --file data.json`);
|
|
670
|
+
apiPath = apiPath.replace(`{${endpoint.pathParams[0]}}`, parentId);
|
|
671
|
+
}
|
|
672
|
+
// The endpoint takes an array. A single object is wrapped, so importing
|
|
673
|
+
// one record reads the same as importing many.
|
|
674
|
+
let records = [];
|
|
675
|
+
if (flags.file) {
|
|
676
|
+
const fsModule = await import('node:fs');
|
|
677
|
+
try {
|
|
678
|
+
const content = JSON.parse(fsModule.readFileSync(flags.file, 'utf-8'));
|
|
679
|
+
records = Array.isArray(content) ? content : [content];
|
|
680
|
+
}
|
|
681
|
+
catch {
|
|
682
|
+
this.error(`Failed to read file: ${flags.file}`);
|
|
683
|
+
}
|
|
684
|
+
}
|
|
685
|
+
else if (flags.data) {
|
|
686
|
+
try {
|
|
687
|
+
const content = JSON.parse(flags.data);
|
|
688
|
+
records = Array.isArray(content) ? content : [content];
|
|
689
|
+
}
|
|
690
|
+
catch {
|
|
691
|
+
this.error('Invalid JSON in --data');
|
|
692
|
+
}
|
|
693
|
+
}
|
|
694
|
+
else {
|
|
695
|
+
this.error('Import requires --file or --data holding a JSON array of records');
|
|
696
|
+
}
|
|
697
|
+
if (records.length === 0)
|
|
698
|
+
this.error('Nothing to import: the input is an empty array');
|
|
699
|
+
const params = { format: 'json' };
|
|
700
|
+
if (flags.mode)
|
|
701
|
+
params.mode = flags.mode;
|
|
702
|
+
if (flags.reference)
|
|
703
|
+
params.reference = flags.reference;
|
|
704
|
+
if (flags.async)
|
|
705
|
+
params.async = true;
|
|
706
|
+
const headers = {};
|
|
707
|
+
if (flags['idempotency-key'])
|
|
708
|
+
headers['Idempotency-Key'] = flags['idempotency-key'];
|
|
709
|
+
if (flags['show-http-request']) {
|
|
710
|
+
const baseUrls = getBaseUrls(context.environment);
|
|
711
|
+
const queryString = '?' + Object.entries(params).map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(String(v))}`).join('&');
|
|
712
|
+
process.stderr.write(`\n${endpoint.method.toUpperCase()} ${baseUrls.api}${apiPath}${queryString}\n`);
|
|
713
|
+
process.stderr.write(`Body: [${records.length} record${records.length === 1 ? '' : 's'}]\n\n`);
|
|
714
|
+
}
|
|
715
|
+
try {
|
|
716
|
+
const response = await apiRequest(endpoint.method, apiPath, {
|
|
717
|
+
contextName: flags.context,
|
|
718
|
+
data: records,
|
|
719
|
+
headers,
|
|
720
|
+
params,
|
|
721
|
+
});
|
|
722
|
+
this.printImportRun(response.data, flags);
|
|
723
|
+
}
|
|
724
|
+
catch (error) {
|
|
725
|
+
if (error instanceof ApiError) {
|
|
726
|
+
this.error(`API Error (${error.status}): ${error.message}`);
|
|
727
|
+
}
|
|
728
|
+
throw error;
|
|
729
|
+
}
|
|
730
|
+
}
|
|
731
|
+
/** Renders an import run: its counts, then whatever the server refused. */
|
|
732
|
+
printImportRun(run, flags) {
|
|
733
|
+
if (flags.output === 'json') {
|
|
734
|
+
this.log(JSON.stringify(run, null, 2));
|
|
735
|
+
return;
|
|
736
|
+
}
|
|
737
|
+
const record = (run ?? {});
|
|
738
|
+
const count = (key) => (typeof record[key] === 'number' ? record[key] : 0);
|
|
739
|
+
const id = record.id ? String(record.id) : '';
|
|
740
|
+
this.log(`Import ${id} - ${String(record.status ?? 'UNKNOWN')}${record.async ? ' (background)' : ''}`);
|
|
741
|
+
this.log(` ${count('inputSize')} submitted, ${count('createdCount')} created, ${count('updatedCount')} updated, ${count('unchangedCount')} unchanged`);
|
|
742
|
+
if (count('errorCount') > 0)
|
|
743
|
+
this.log(` ${count('errorCount')} not applied: ${count('refusedCount')} refused, ${count('failedCount')} failed`);
|
|
744
|
+
if (count('warningCount') > 0)
|
|
745
|
+
this.log(` ${count('warningCount')} applied with a warning`);
|
|
746
|
+
// errorLog is keyed by the record's identifier, then by field name.
|
|
747
|
+
const errorLog = record.errorLog;
|
|
748
|
+
if (errorLog && Object.keys(errorLog).length > 0) {
|
|
749
|
+
this.log('');
|
|
750
|
+
for (const [key, fields] of Object.entries(errorLog)) {
|
|
751
|
+
for (const [field, messages] of Object.entries(fields ?? {})) {
|
|
752
|
+
for (const message of messages ?? [])
|
|
753
|
+
this.log(` ${key} ${field}: ${message}`);
|
|
754
|
+
}
|
|
755
|
+
}
|
|
756
|
+
}
|
|
757
|
+
if (record.async && id) {
|
|
758
|
+
this.log('');
|
|
759
|
+
this.log(`Follow it with: aderis imports get ${id}`);
|
|
760
|
+
}
|
|
761
|
+
}
|
|
628
762
|
async runExport(flags) {
|
|
629
763
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
630
764
|
if (!context)
|
|
@@ -803,9 +937,9 @@ export default class PurchaseOrders extends Command {
|
|
|
803
937
|
throw error;
|
|
804
938
|
}
|
|
805
939
|
}
|
|
806
|
-
async
|
|
940
|
+
async runNestedUpsert(suffix, parentId, flags) {
|
|
807
941
|
if (!parentId) {
|
|
808
|
-
this.error(`Missing required argument: id. Usage: aderis purchase-orders
|
|
942
|
+
this.error(`Missing required argument: id. Usage: aderis purchase-orders upsert-${suffix} <parent-id> --file data.json`);
|
|
809
943
|
}
|
|
810
944
|
const context = flags.context ? getContext(flags.context) : getCurrentContext();
|
|
811
945
|
if (!context)
|
|
@@ -870,12 +1004,12 @@ export default class PurchaseOrders extends Command {
|
|
|
870
1004
|
items = [item];
|
|
871
1005
|
}
|
|
872
1006
|
else {
|
|
873
|
-
this.error(
|
|
1007
|
+
this.error('Upsert requires --file, --data, or --set flags');
|
|
874
1008
|
}
|
|
875
1009
|
const createEndpoint = ENDPOINTS[`create-${suffix}`];
|
|
876
1010
|
const updateEndpoint = ENDPOINTS[`update-${suffix}`];
|
|
877
1011
|
if (!createEndpoint || !updateEndpoint) {
|
|
878
|
-
this.error(`
|
|
1012
|
+
this.error(`Upsert requires both create-${suffix} and update-${suffix} endpoints`);
|
|
879
1013
|
}
|
|
880
1014
|
// Build the base path with parent ID (first path param)
|
|
881
1015
|
const firstParam = createEndpoint.pathParams[0];
|
|
@@ -27,10 +27,19 @@ export default class Reports 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;
|
package/dist/commands/reports.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 = false;
|
|
7
9
|
const HAS_CAMT053 = false;
|
|
8
|
-
const
|
|
9
|
-
const
|
|
10
|
+
const SERVER_IMPORTS = [];
|
|
11
|
+
const NESTED_UPSERTS = [];
|
|
12
|
+
const SUBCOMMANDS = [...["profit-and-loss", "balance-sheet", "gl-detail", "gl-detail-export-xlsx", "gl-detail-export-pdf"], ...(HAS_UPSERT ? ['upsert'] : []), ...(HAS_EXPORT ? ['export'] : []), ...NESTED_UPSERTS.map(n => `upsert-${n}`)];
|
|
10
13
|
const ENDPOINTS = {
|
|
11
14
|
'profit-and-loss': { method: 'POST', path: '/v1/reports/profit-and-loss', summary: 'Get Profit & Loss report', pathParams: [], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: true, bodyArrayFields: ['ledgerIds', 'periods'] },
|
|
12
15
|
'balance-sheet': { method: 'GET', path: '/v1/reports/balance-sheet', summary: 'Generate Balance Sheet report', pathParams: [], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
|
|
@@ -23,7 +26,7 @@ export default class Reports 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 Reports extends Command {
|
|
|
43
46
|
};
|
|
44
47
|
async run() {
|
|
45
48
|
const { args, flags } = await this.parse(Reports);
|
|
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 reports 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 reports 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 Reports 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 reports 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 Reports 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 Reports 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 Reports 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 reports ${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 Reports 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 reports
|
|
913
|
+
this.error(`Missing required argument: id. Usage: aderis reports 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 Reports 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/roles.d.ts
CHANGED
|
@@ -27,10 +27,19 @@ export default class Roles 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;
|