@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.
Files changed (160) hide show
  1. package/README.md +1 -0
  2. package/dist/commands/access-groups.d.ts +11 -2
  3. package/dist/commands/access-groups.js +158 -24
  4. package/dist/commands/account-transaction-allocations.d.ts +11 -2
  5. package/dist/commands/account-transaction-allocations.js +157 -23
  6. package/dist/commands/account-transactions.d.ts +15 -2
  7. package/dist/commands/account-transactions.js +162 -24
  8. package/dist/commands/accounts.d.ts +11 -2
  9. package/dist/commands/accounts.js +158 -24
  10. package/dist/commands/agent-platform.d.ts +11 -3
  11. package/dist/commands/agent-platform.js +157 -32
  12. package/dist/commands/agent-runs.d.ts +11 -2
  13. package/dist/commands/agent-runs.js +157 -23
  14. package/dist/commands/analytics.d.ts +11 -2
  15. package/dist/commands/analytics.js +157 -23
  16. package/dist/commands/api-clients.d.ts +58 -0
  17. package/dist/commands/api-clients.js +1341 -0
  18. package/dist/commands/api-keys.d.ts +11 -2
  19. package/dist/commands/api-keys.js +157 -23
  20. package/dist/commands/async-jobs.d.ts +11 -2
  21. package/dist/commands/async-jobs.js +158 -24
  22. package/dist/commands/audit-log.d.ts +11 -2
  23. package/dist/commands/audit-log.js +157 -23
  24. package/dist/commands/bank-accounts.d.ts +11 -2
  25. package/dist/commands/bank-accounts.js +159 -25
  26. package/dist/commands/bank-integrations.d.ts +11 -2
  27. package/dist/commands/bank-integrations.js +158 -24
  28. package/dist/commands/business-partners.d.ts +11 -2
  29. package/dist/commands/business-partners.js +158 -24
  30. package/dist/commands/chat.d.ts +11 -2
  31. package/dist/commands/chat.js +158 -24
  32. package/dist/commands/credit-card-accounts.d.ts +15 -2
  33. package/dist/commands/credit-card-accounts.js +163 -24
  34. package/dist/commands/currencies.d.ts +56 -0
  35. package/dist/commands/currencies.js +1327 -0
  36. package/dist/commands/custody-accounts.d.ts +56 -0
  37. package/dist/commands/custody-accounts.js +1335 -0
  38. package/dist/commands/dashboards.d.ts +57 -0
  39. package/dist/commands/dashboards.js +1347 -0
  40. package/dist/commands/delivery-notes.d.ts +11 -2
  41. package/dist/commands/delivery-notes.js +158 -24
  42. package/dist/commands/{integration-identities.d.ts → document-checksums.d.ts} +12 -4
  43. package/dist/commands/{integration-identities.js → document-checksums.js} +162 -36
  44. package/dist/commands/dunning-configs.d.ts +11 -2
  45. package/dist/commands/dunning-configs.js +158 -24
  46. package/dist/commands/dunning-reminders.d.ts +11 -2
  47. package/dist/commands/dunning-reminders.js +157 -23
  48. package/dist/commands/dunning-runs.d.ts +11 -2
  49. package/dist/commands/dunning-runs.js +157 -23
  50. package/dist/commands/email-transactions.d.ts +11 -2
  51. package/dist/commands/email-transactions.js +157 -23
  52. package/dist/commands/employees.d.ts +13 -2
  53. package/dist/commands/employees.js +169 -24
  54. package/dist/commands/entity-configurations.d.ts +11 -2
  55. package/dist/commands/entity-configurations.js +157 -23
  56. package/dist/commands/event-mapping-rules.d.ts +56 -0
  57. package/dist/commands/event-mapping-rules.js +1324 -0
  58. package/dist/commands/event-processor-mappings.d.ts +11 -2
  59. package/dist/commands/event-processor-mappings.js +158 -24
  60. package/dist/commands/files.d.ts +11 -2
  61. package/dist/commands/files.js +158 -24
  62. package/dist/commands/financial-instrument-types.d.ts +56 -0
  63. package/dist/commands/financial-instrument-types.js +1335 -0
  64. package/dist/commands/financial-instruments.d.ts +56 -0
  65. package/dist/commands/financial-instruments.js +1335 -0
  66. package/dist/commands/health.d.ts +11 -2
  67. package/dist/commands/health.js +157 -23
  68. package/dist/commands/imports.d.ts +11 -2
  69. package/dist/commands/imports.js +157 -23
  70. package/dist/commands/inbox.d.ts +11 -2
  71. package/dist/commands/inbox.js +157 -23
  72. package/dist/commands/integrations.d.ts +11 -2
  73. package/dist/commands/integrations.js +157 -23
  74. package/dist/commands/item-categories.d.ts +11 -2
  75. package/dist/commands/item-categories.js +158 -24
  76. package/dist/commands/items.d.ts +15 -2
  77. package/dist/commands/items.js +165 -26
  78. package/dist/commands/journal-lines.d.ts +11 -2
  79. package/dist/commands/journal-lines.js +157 -23
  80. package/dist/commands/journals.d.ts +15 -2
  81. package/dist/commands/journals.js +163 -24
  82. package/dist/commands/{workflows.d.ts → kpis.d.ts} +12 -3
  83. package/dist/commands/kpis.js +1337 -0
  84. package/dist/commands/ledgers.d.ts +11 -2
  85. package/dist/commands/ledgers.js +159 -25
  86. package/dist/commands/my-account.d.ts +11 -2
  87. package/dist/commands/my-account.js +157 -23
  88. package/dist/commands/notifications.d.ts +56 -0
  89. package/dist/commands/notifications.js +1326 -0
  90. package/dist/commands/office-locations.d.ts +11 -2
  91. package/dist/commands/office-locations.js +158 -24
  92. package/dist/commands/payment-methods.d.ts +11 -2
  93. package/dist/commands/payment-methods.js +158 -24
  94. package/dist/commands/payment-runs.d.ts +11 -2
  95. package/dist/commands/payment-runs.js +158 -24
  96. package/dist/commands/payment-terms.d.ts +11 -2
  97. package/dist/commands/payment-terms.js +159 -25
  98. package/dist/commands/payments.d.ts +11 -2
  99. package/dist/commands/payments.js +158 -24
  100. package/dist/commands/payroll-runs.d.ts +11 -2
  101. package/dist/commands/payroll-runs.js +158 -24
  102. package/dist/commands/permissions.d.ts +11 -2
  103. package/dist/commands/permissions.js +157 -23
  104. package/dist/commands/price-lists.d.ts +15 -2
  105. package/dist/commands/price-lists.js +164 -24
  106. package/dist/commands/processor-mappings.d.ts +11 -2
  107. package/dist/commands/processor-mappings.js +158 -24
  108. package/dist/commands/processors.d.ts +11 -2
  109. package/dist/commands/processors.js +158 -24
  110. package/dist/commands/purchase-order-types.d.ts +11 -2
  111. package/dist/commands/purchase-order-types.js +158 -24
  112. package/dist/commands/purchase-orders.d.ts +11 -2
  113. package/dist/commands/purchase-orders.js +158 -24
  114. package/dist/commands/reports.d.ts +11 -2
  115. package/dist/commands/reports.js +157 -23
  116. package/dist/commands/roles.d.ts +11 -2
  117. package/dist/commands/roles.js +158 -24
  118. package/dist/commands/salary-types.d.ts +11 -2
  119. package/dist/commands/salary-types.js +158 -24
  120. package/dist/commands/sales-invoices.d.ts +11 -2
  121. package/dist/commands/sales-invoices.js +161 -24
  122. package/dist/commands/sales-orders.d.ts +11 -2
  123. package/dist/commands/sales-orders.js +159 -25
  124. package/dist/commands/saved-views.d.ts +11 -2
  125. package/dist/commands/saved-views.js +157 -23
  126. package/dist/commands/scheduled-processor-mappings.d.ts +11 -2
  127. package/dist/commands/scheduled-processor-mappings.js +158 -24
  128. package/dist/commands/schedules.d.ts +11 -2
  129. package/dist/commands/schedules.js +158 -24
  130. package/dist/commands/settings.d.ts +56 -0
  131. package/dist/commands/settings.js +1327 -0
  132. package/dist/commands/tags.d.ts +11 -2
  133. package/dist/commands/tags.js +158 -24
  134. package/dist/commands/tax-codes.d.ts +11 -2
  135. package/dist/commands/tax-codes.js +158 -24
  136. package/dist/commands/tax-matrix.d.ts +11 -2
  137. package/dist/commands/tax-matrix.js +158 -24
  138. package/dist/commands/templates.d.ts +11 -2
  139. package/dist/commands/templates.js +163 -24
  140. package/dist/commands/tenants.d.ts +11 -2
  141. package/dist/commands/tenants.js +158 -24
  142. package/dist/commands/tools.d.ts +11 -2
  143. package/dist/commands/tools.js +157 -23
  144. package/dist/commands/users.d.ts +11 -2
  145. package/dist/commands/users.js +158 -24
  146. package/dist/commands/vat-declarations.d.ts +11 -2
  147. package/dist/commands/vat-declarations.js +158 -24
  148. package/dist/commands/vendor-invoices.d.ts +11 -2
  149. package/dist/commands/vendor-invoices.js +162 -24
  150. package/dist/commands/webhooks.d.ts +11 -2
  151. package/dist/commands/webhooks.js +158 -24
  152. package/dist/commands/work-summary.d.ts +56 -0
  153. package/dist/commands/{workflows.js → work-summary.js} +164 -33
  154. package/dist/lib/api-client.d.ts +1 -0
  155. package/dist/lib/api-client.js +3 -0
  156. package/dist/lib/auth/index.js +5 -0
  157. package/dist/lib/production-guard.d.ts +42 -0
  158. package/dist/lib/production-guard.js +92 -0
  159. package/oclif.manifest.json +2358 -442
  160. 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
- // Add 'import' action if both create and update exist
5
- const HAS_IMPORT = false;
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 NESTED_IMPORTS = [];
9
- const SUBCOMMANDS = [...["list"], ...(HAS_IMPORT ? ['import'] : []), ...(HAS_EXPORT ? ['export'] : []), ...NESTED_IMPORTS.map(n => `import-${n}`)];
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/journal-lines', summary: 'List all journal lines (global view across all journals)', pathParams: [], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
12
15
  };
@@ -22,7 +25,7 @@ export default class JournalLines 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 import, json for other commands)', options: ['json', 'table', 'csv'] }),
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 JournalLines extends Command {
42
45
  };
43
46
  async run() {
44
47
  const { args, flags } = await this.parse(JournalLines);
45
- // Handle import action specially
46
- if (args.action === 'import') {
47
- if (!HAS_IMPORT)
48
- this.error('Import not available for this resource');
49
- await this.runImport(flags);
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 journal-lines 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 journal-lines 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 JournalLines extends Command {
63
81
  await this.runCamt053Import(flags);
64
82
  return;
65
83
  }
66
- // Handle nested resource imports (e.g., import-prices)
67
- if (args.action.startsWith('import-')) {
68
- const suffix = args.action.replace('import-', '');
69
- if (NESTED_IMPORTS.includes(suffix)) {
70
- await this.runNestedImport(suffix, args.id, flags);
71
- return;
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 journal-lines 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 JournalLines extends Command {
383
406
  throw error;
384
407
  }
385
408
  }
386
- async runImport(flags) {
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 JournalLines extends Command {
447
470
  items = [item];
448
471
  }
449
472
  else {
450
- this.error('Import requires --file, --data, or --set flags');
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('Import requires both create and update endpoints');
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 JournalLines 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 journal-lines ${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 JournalLines extends Command {
773
907
  throw error;
774
908
  }
775
909
  }
776
- async runNestedImport(suffix, parentId, flags) {
910
+ async runNestedUpsert(suffix, parentId, flags) {
777
911
  if (!parentId) {
778
- this.error(`Missing required argument: id. Usage: aderis journal-lines import-${suffix} <parent-id> --file data.json`);
912
+ this.error(`Missing required argument: id. Usage: aderis journal-lines 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 JournalLines extends Command {
840
974
  items = [item];
841
975
  }
842
976
  else {
843
- this.error(`Import requires --file, --data, or --set flags`);
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(`Import requires both create-${suffix} and update-${suffix} endpoints`);
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 Journals 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
  'line-id': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
18
22
  'note-id': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
19
23
  'file-id': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
@@ -30,10 +34,19 @@ export default class Journals extends Command {
30
34
  'show-http-request': import("@oclif/core/interfaces").BooleanFlag<boolean>;
31
35
  };
32
36
  run(): Promise<void>;
33
- private runImport;
37
+ private runUpsert;
38
+ /**
39
+ * The API's own import: the whole array goes up in one request and comes
40
+ * back as an import run, which records what happened to every record. A bad
41
+ * record lands in errorLog and the rest are still applied, and the run stays
42
+ * readable afterwards with: aderis imports get <id>.
43
+ */
44
+ private runServerImport;
45
+ /** Renders an import run: its counts, then whatever the server refused. */
46
+ private printImportRun;
34
47
  private runExport;
35
48
  private runCamt053Import;
36
- private runNestedImport;
49
+ private runNestedUpsert;
37
50
  private parseFilterValue;
38
51
  /** The page line under a table: which page, how many, and any sums the API returned. */
39
52
  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
- // Add 'import' action if both create and update exist
5
- const HAS_IMPORT = true;
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 NESTED_IMPORTS = ["notes", "files"];
9
- const SUBCOMMANDS = [...["list", "create", "stats", "get", "update", "delete", "post", "approve", "cancel", "reverse", "update-lines", "get-deferrals", "create-deferrals", "list-notes", "create-notes", "get-notes", "update-notes", "delete-notes", "list-files", "create-files", "get-files", "update-files", "delete-files", "files-download"], ...(HAS_IMPORT ? ['import'] : []), ...(HAS_EXPORT ? ['export'] : []), ...NESTED_IMPORTS.map(n => `import-${n}`)];
10
+ const SERVER_IMPORTS = ["import"];
11
+ const NESTED_UPSERTS = ["notes", "files"];
12
+ const SUBCOMMANDS = [...["list", "create", "stats", "get", "update", "delete", "post", "approve", "cancel", "reverse", "update-lines", "get-deferrals", "create-deferrals", "list-notes", "create-notes", "get-notes", "update-notes", "delete-notes", "list-files", "create-files", "get-files", "update-files", "delete-files", "files-download", "import"], ...(HAS_UPSERT ? ['upsert'] : []), ...(HAS_EXPORT ? ['export'] : []), ...NESTED_UPSERTS.map(n => `upsert-${n}`)];
10
13
  const ENDPOINTS = {
11
14
  'list': { method: 'GET', path: '/v1/journals', summary: 'List all journals', pathParams: [], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
12
15
  'create': { method: 'POST', path: '/v1/journals', summary: 'Create a new journal (with embedded lines)', pathParams: [], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: ['lines', 'files', 'notes'] },
@@ -32,6 +35,7 @@ const ENDPOINTS = {
32
35
  'update-files': { method: 'PATCH', path: '/v1/journals/{parentId}/files/{fileId}', summary: 'Update file attachment metadata for a journal', pathParams: ['parentId', 'fileId'], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
33
36
  'delete-files': { method: 'DELETE', path: '/v1/journals/{parentId}/files/{fileId}', summary: 'Delete a file attachment from a journal', pathParams: ['parentId', 'fileId'], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
34
37
  'files-download': { method: 'GET', path: '/v1/journals/{parentId}/files/{fileId}/download', summary: 'Download a file attachment from a journal', pathParams: ['parentId', 'fileId'], hasBody: false, isMultipart: false, isBinaryResponse: true, hasBinaryVariant: false, bodyArrayFields: [] },
38
+ 'import': { method: 'POST', path: '/v1/journals/import', summary: 'Import journals', pathParams: [], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
35
39
  };
36
40
  export default class Journals extends Command {
37
41
  static description = 'Manage journals';
@@ -40,7 +44,7 @@ export default class Journals extends Command {
40
44
  '<%= config.bin %> journals get <id>',
41
45
  '<%= config.bin %> journals create --data \'{...}\'',
42
46
  '<%= config.bin %> journals update <id> --set field=value',
43
- '<%= config.bin %> journals import --file data.json',
47
+ '<%= config.bin %> journals import --file data.json --mode upsert',
44
48
  '<%= config.bin %> journals export --csv > journals.csv',
45
49
  ];
46
50
  static args = {
@@ -49,12 +53,16 @@ export default class Journals extends Command {
49
53
  };
50
54
  static flags = {
51
55
  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 import, json for other commands)', options: ['json', 'table', 'csv'] }),
56
+ output: Flags.string({ char: 'o', description: 'Output format (default: table for upsert, json for other commands)', options: ['json', 'table', 'csv'] }),
53
57
  table: Flags.boolean({ char: 't', description: 'Output as table (shortcut for --output table)' }),
54
58
  csv: Flags.boolean({ description: 'Output as CSV (shortcut for --output csv)' }),
55
59
  data: Flags.string({ char: 'd', description: 'JSON data for request body' }),
56
60
  file: Flags.string({ char: 'f', description: 'Read request body from file' }),
57
61
  set: Flags.string({ char: 's', description: 'Set individual field (e.g. --set firstName=John)', multiple: true }),
62
+ 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'] }),
63
+ reference: Flags.string({ description: 'Caller-defined text stored on the import run, for tracking and filtering' }),
64
+ async: Flags.boolean({ description: 'Import in the background: answers with a PENDING run to follow via "aderis imports get <id>"' }),
65
+ 'idempotency-key': Flags.string({ description: 'Repeating a key returns the earlier import run unchanged and imports nothing' }),
58
66
  'line-id': Flags.string({ description: 'Path param: lineId' }),
59
67
  'note-id': Flags.string({ description: 'Path param: noteId' }),
60
68
  'file-id': Flags.string({ description: 'Path param: fileId' }),
@@ -72,11 +80,26 @@ export default class Journals extends Command {
72
80
  };
73
81
  async run() {
74
82
  const { args, flags } = await this.parse(Journals);
75
- // Handle import action specially
76
- if (args.action === 'import') {
77
- if (!HAS_IMPORT)
78
- this.error('Import not available for this resource');
79
- await this.runImport(flags);
83
+ // Bulk actions. 'import' is the API's own endpoint: one request, answered
84
+ // by a run that records what happened to every record. 'upsert' is the CLI
85
+ // looping create/update. A resource has one or the other, never both.
86
+ if (args.action === 'upsert') {
87
+ if (!HAS_UPSERT) {
88
+ this.error(SERVER_IMPORTS.includes('import')
89
+ ? 'This resource is imported by the API. Use: aderis journals import --file data.json'
90
+ : 'Upsert needs both a create and an update endpoint, which this resource does not have');
91
+ }
92
+ await this.runUpsert(flags);
93
+ return;
94
+ }
95
+ if (args.action.startsWith('upsert-')) {
96
+ const suffix = args.action.replace('upsert-', '');
97
+ if (!NESTED_UPSERTS.includes(suffix)) {
98
+ this.error(SERVER_IMPORTS.includes('import-' + suffix)
99
+ ? `That resource is imported by the API. Use: aderis journals import-${suffix} <id> --file data.json`
100
+ : `Unknown action: ${args.action}. Available: ${SUBCOMMANDS.join(', ')}`);
101
+ }
102
+ await this.runNestedUpsert(suffix, args.id, flags);
80
103
  return;
81
104
  }
82
105
  // Handle export action specially
@@ -93,12 +116,17 @@ export default class Journals extends Command {
93
116
  await this.runCamt053Import(flags);
94
117
  return;
95
118
  }
96
- // Handle nested resource imports (e.g., import-prices)
97
- if (args.action.startsWith('import-')) {
98
- const suffix = args.action.replace('import-', '');
99
- if (NESTED_IMPORTS.includes(suffix)) {
100
- await this.runNestedImport(suffix, args.id, flags);
101
- return;
119
+ if (SERVER_IMPORTS.includes(args.action)) {
120
+ await this.runServerImport(args.action, args.id, flags);
121
+ return;
122
+ }
123
+ // 'import' used to name the CLI's create/update loop on every resource. It
124
+ // now names the API endpoint, which most resources do not have.
125
+ if (args.action === 'import' || args.action.startsWith('import-')) {
126
+ const suffix = args.action === 'import' ? '' : '-' + args.action.replace('import-', '');
127
+ const loops = args.action === 'import' ? HAS_UPSERT : NESTED_UPSERTS.includes(args.action.replace('import-', ''));
128
+ if (loops) {
129
+ this.error(`This resource has no import endpoint. Use: aderis journals upsert${suffix}${suffix ? ' <id>' : ''} --file data.json`);
102
130
  }
103
131
  }
104
132
  const endpoint = ENDPOINTS[args.action];
@@ -413,7 +441,7 @@ export default class Journals extends Command {
413
441
  throw error;
414
442
  }
415
443
  }
416
- async runImport(flags) {
444
+ async runUpsert(flags) {
417
445
  const context = flags.context ? getContext(flags.context) : getCurrentContext();
418
446
  if (!context)
419
447
  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 +505,12 @@ export default class Journals extends Command {
477
505
  items = [item];
478
506
  }
479
507
  else {
480
- this.error('Import requires --file, --data, or --set flags');
508
+ this.error('Upsert requires --file, --data, or --set flags');
481
509
  }
482
510
  const createEndpoint = ENDPOINTS['create'];
483
511
  const updateEndpoint = ENDPOINTS['update'];
484
512
  if (!createEndpoint || !updateEndpoint) {
485
- this.error('Import requires both create and update endpoints');
513
+ this.error('Upsert requires both create and update endpoints');
486
514
  }
487
515
  // Helper to extract identifier from item (id, code, or xxxCode)
488
516
  const getItemIdentifier = (item) => {
@@ -625,6 +653,117 @@ export default class Journals extends Command {
625
653
  this.log('');
626
654
  this.log(`Summary: ${created} created, ${updated} updated, ${errors.length} failed`);
627
655
  }
656
+ /**
657
+ * The API's own import: the whole array goes up in one request and comes
658
+ * back as an import run, which records what happened to every record. A bad
659
+ * record lands in errorLog and the rest are still applied, and the run stays
660
+ * readable afterwards with: aderis imports get <id>.
661
+ */
662
+ async runServerImport(action, parentId, flags) {
663
+ const endpoint = ENDPOINTS[action];
664
+ if (!endpoint)
665
+ this.error(`Unknown action: ${action}. Available: ${SUBCOMMANDS.join(', ')}`);
666
+ const context = flags.context ? getContext(flags.context) : getCurrentContext();
667
+ if (!context)
668
+ this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
669
+ if (!hasCredentials(context))
670
+ this.error(missingCredentialsMessage(context));
671
+ let apiPath = endpoint.path;
672
+ if (endpoint.pathParams.length > 0) {
673
+ if (!parentId)
674
+ this.error(`Missing required argument: id. Usage: aderis journals ${action} <parent-id> --file data.json`);
675
+ apiPath = apiPath.replace(`{${endpoint.pathParams[0]}}`, parentId);
676
+ }
677
+ // The endpoint takes an array. A single object is wrapped, so importing
678
+ // one record reads the same as importing many.
679
+ let records = [];
680
+ if (flags.file) {
681
+ const fsModule = await import('node:fs');
682
+ try {
683
+ const content = JSON.parse(fsModule.readFileSync(flags.file, 'utf-8'));
684
+ records = Array.isArray(content) ? content : [content];
685
+ }
686
+ catch {
687
+ this.error(`Failed to read file: ${flags.file}`);
688
+ }
689
+ }
690
+ else if (flags.data) {
691
+ try {
692
+ const content = JSON.parse(flags.data);
693
+ records = Array.isArray(content) ? content : [content];
694
+ }
695
+ catch {
696
+ this.error('Invalid JSON in --data');
697
+ }
698
+ }
699
+ else {
700
+ this.error('Import requires --file or --data holding a JSON array of records');
701
+ }
702
+ if (records.length === 0)
703
+ this.error('Nothing to import: the input is an empty array');
704
+ const params = { format: 'json' };
705
+ if (flags.mode)
706
+ params.mode = flags.mode;
707
+ if (flags.reference)
708
+ params.reference = flags.reference;
709
+ if (flags.async)
710
+ params.async = true;
711
+ const headers = {};
712
+ if (flags['idempotency-key'])
713
+ headers['Idempotency-Key'] = flags['idempotency-key'];
714
+ if (flags['show-http-request']) {
715
+ const baseUrls = getBaseUrls(context.environment);
716
+ const queryString = '?' + Object.entries(params).map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(String(v))}`).join('&');
717
+ process.stderr.write(`\n${endpoint.method.toUpperCase()} ${baseUrls.api}${apiPath}${queryString}\n`);
718
+ process.stderr.write(`Body: [${records.length} record${records.length === 1 ? '' : 's'}]\n\n`);
719
+ }
720
+ try {
721
+ const response = await apiRequest(endpoint.method, apiPath, {
722
+ contextName: flags.context,
723
+ data: records,
724
+ headers,
725
+ params,
726
+ });
727
+ this.printImportRun(response.data, flags);
728
+ }
729
+ catch (error) {
730
+ if (error instanceof ApiError) {
731
+ this.error(`API Error (${error.status}): ${error.message}`);
732
+ }
733
+ throw error;
734
+ }
735
+ }
736
+ /** Renders an import run: its counts, then whatever the server refused. */
737
+ printImportRun(run, flags) {
738
+ if (flags.output === 'json') {
739
+ this.log(JSON.stringify(run, null, 2));
740
+ return;
741
+ }
742
+ const record = (run ?? {});
743
+ const count = (key) => (typeof record[key] === 'number' ? record[key] : 0);
744
+ const id = record.id ? String(record.id) : '';
745
+ this.log(`Import ${id} - ${String(record.status ?? 'UNKNOWN')}${record.async ? ' (background)' : ''}`);
746
+ this.log(` ${count('inputSize')} submitted, ${count('createdCount')} created, ${count('updatedCount')} updated, ${count('unchangedCount')} unchanged`);
747
+ if (count('errorCount') > 0)
748
+ this.log(` ${count('errorCount')} not applied: ${count('refusedCount')} refused, ${count('failedCount')} failed`);
749
+ if (count('warningCount') > 0)
750
+ this.log(` ${count('warningCount')} applied with a warning`);
751
+ // errorLog is keyed by the record's identifier, then by field name.
752
+ const errorLog = record.errorLog;
753
+ if (errorLog && Object.keys(errorLog).length > 0) {
754
+ this.log('');
755
+ for (const [key, fields] of Object.entries(errorLog)) {
756
+ for (const [field, messages] of Object.entries(fields ?? {})) {
757
+ for (const message of messages ?? [])
758
+ this.log(` ${key} ${field}: ${message}`);
759
+ }
760
+ }
761
+ }
762
+ if (record.async && id) {
763
+ this.log('');
764
+ this.log(`Follow it with: aderis imports get ${id}`);
765
+ }
766
+ }
628
767
  async runExport(flags) {
629
768
  const context = flags.context ? getContext(flags.context) : getCurrentContext();
630
769
  if (!context)
@@ -803,9 +942,9 @@ export default class Journals extends Command {
803
942
  throw error;
804
943
  }
805
944
  }
806
- async runNestedImport(suffix, parentId, flags) {
945
+ async runNestedUpsert(suffix, parentId, flags) {
807
946
  if (!parentId) {
808
- this.error(`Missing required argument: id. Usage: aderis journals import-${suffix} <parent-id> --file data.json`);
947
+ this.error(`Missing required argument: id. Usage: aderis journals upsert-${suffix} <parent-id> --file data.json`);
809
948
  }
810
949
  const context = flags.context ? getContext(flags.context) : getCurrentContext();
811
950
  if (!context)
@@ -870,12 +1009,12 @@ export default class Journals extends Command {
870
1009
  items = [item];
871
1010
  }
872
1011
  else {
873
- this.error(`Import requires --file, --data, or --set flags`);
1012
+ this.error('Upsert requires --file, --data, or --set flags');
874
1013
  }
875
1014
  const createEndpoint = ENDPOINTS[`create-${suffix}`];
876
1015
  const updateEndpoint = ENDPOINTS[`update-${suffix}`];
877
1016
  if (!createEndpoint || !updateEndpoint) {
878
- this.error(`Import requires both create-${suffix} and update-${suffix} endpoints`);
1017
+ this.error(`Upsert requires both create-${suffix} and update-${suffix} endpoints`);
879
1018
  }
880
1019
  // Build the base path with parent ID (first path param)
881
1020
  const firstParam = createEndpoint.pathParams[0];
@@ -1,5 +1,5 @@
1
1
  import { Command } from '@oclif/core';
2
- export default class Workflows extends Command {
2
+ export default class Kpis extends Command {
3
3
  static description: string;
4
4
  static examples: string[];
5
5
  static args: {
@@ -27,10 +27,19 @@ export default class Workflows extends Command {
27
27
  'show-http-request': import("@oclif/core/interfaces").BooleanFlag<boolean>;
28
28
  };
29
29
  run(): Promise<void>;
30
- private runImport;
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 runNestedImport;
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;