@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 = 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 = true;
6
8
  const HAS_EXPORT = true;
7
9
  const HAS_CAMT053 = false;
8
- const NESTED_IMPORTS = [];
9
- const SUBCOMMANDS = [...["list", "create", "get", "update", "delete", "approve", "cancel"], ...(HAS_IMPORT ? ['import'] : []), ...(HAS_EXPORT ? ['export'] : []), ...NESTED_IMPORTS.map(n => `import-${n}`)];
10
+ const SERVER_IMPORTS = [];
11
+ const NESTED_UPSERTS = [];
12
+ const SUBCOMMANDS = [...["list", "create", "get", "update", "delete", "approve", "cancel"], ...(HAS_UPSERT ? ['upsert'] : []), ...(HAS_EXPORT ? ['export'] : []), ...NESTED_UPSERTS.map(n => `upsert-${n}`)];
10
13
  const ENDPOINTS = {
11
14
  'list': { method: 'GET', path: '/v1/payments', summary: 'List payments', pathParams: [], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
12
15
  'create': { method: 'POST', path: '/v1/payments', summary: 'Create a standalone payment', pathParams: [], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
@@ -23,7 +26,7 @@ export default class Payments extends Command {
23
26
  '<%= config.bin %> payments get <id>',
24
27
  '<%= config.bin %> payments create --data \'{...}\'',
25
28
  '<%= config.bin %> payments update <id> --set field=value',
26
- '<%= config.bin %> payments import --file data.json',
29
+ '<%= config.bin %> payments upsert --file data.json',
27
30
  '<%= config.bin %> payments export --csv > payments.csv',
28
31
  ];
29
32
  static args = {
@@ -32,7 +35,7 @@ export default class Payments extends Command {
32
35
  };
33
36
  static flags = {
34
37
  context: Flags.string({ char: 'c', aliases: ['config'], env: 'ADERIS_CONTEXT', description: 'Context to use for this command, overriding the current context (alias: --config)' }),
35
- output: Flags.string({ char: 'o', description: 'Output format (default: table for import, json for other commands)', options: ['json', 'table', 'csv'] }),
38
+ output: Flags.string({ char: 'o', description: 'Output format (default: table for upsert, json for other commands)', options: ['json', 'table', 'csv'] }),
36
39
  table: Flags.boolean({ char: 't', description: 'Output as table (shortcut for --output table)' }),
37
40
  csv: Flags.boolean({ description: 'Output as CSV (shortcut for --output csv)' }),
38
41
  data: Flags.string({ char: 'd', description: 'JSON data for request body' }),
@@ -52,11 +55,26 @@ export default class Payments extends Command {
52
55
  };
53
56
  async run() {
54
57
  const { args, flags } = await this.parse(Payments);
55
- // Handle import action specially
56
- if (args.action === 'import') {
57
- if (!HAS_IMPORT)
58
- this.error('Import not available for this resource');
59
- await this.runImport(flags);
58
+ // Bulk actions. 'import' is the API's own endpoint: one request, answered
59
+ // by a run that records what happened to every record. 'upsert' is the CLI
60
+ // looping create/update. A resource has one or the other, never both.
61
+ if (args.action === 'upsert') {
62
+ if (!HAS_UPSERT) {
63
+ this.error(SERVER_IMPORTS.includes('import')
64
+ ? 'This resource is imported by the API. Use: aderis payments import --file data.json'
65
+ : 'Upsert needs both a create and an update endpoint, which this resource does not have');
66
+ }
67
+ await this.runUpsert(flags);
68
+ return;
69
+ }
70
+ if (args.action.startsWith('upsert-')) {
71
+ const suffix = args.action.replace('upsert-', '');
72
+ if (!NESTED_UPSERTS.includes(suffix)) {
73
+ this.error(SERVER_IMPORTS.includes('import-' + suffix)
74
+ ? `That resource is imported by the API. Use: aderis payments import-${suffix} <id> --file data.json`
75
+ : `Unknown action: ${args.action}. Available: ${SUBCOMMANDS.join(', ')}`);
76
+ }
77
+ await this.runNestedUpsert(suffix, args.id, flags);
60
78
  return;
61
79
  }
62
80
  // Handle export action specially
@@ -73,12 +91,17 @@ export default class Payments extends Command {
73
91
  await this.runCamt053Import(flags);
74
92
  return;
75
93
  }
76
- // Handle nested resource imports (e.g., import-prices)
77
- if (args.action.startsWith('import-')) {
78
- const suffix = args.action.replace('import-', '');
79
- if (NESTED_IMPORTS.includes(suffix)) {
80
- await this.runNestedImport(suffix, args.id, flags);
81
- return;
94
+ if (SERVER_IMPORTS.includes(args.action)) {
95
+ await this.runServerImport(args.action, args.id, flags);
96
+ return;
97
+ }
98
+ // 'import' used to name the CLI's create/update loop on every resource. It
99
+ // now names the API endpoint, which most resources do not have.
100
+ if (args.action === 'import' || args.action.startsWith('import-')) {
101
+ const suffix = args.action === 'import' ? '' : '-' + args.action.replace('import-', '');
102
+ const loops = args.action === 'import' ? HAS_UPSERT : NESTED_UPSERTS.includes(args.action.replace('import-', ''));
103
+ if (loops) {
104
+ this.error(`This resource has no import endpoint. Use: aderis payments upsert${suffix}${suffix ? ' <id>' : ''} --file data.json`);
82
105
  }
83
106
  }
84
107
  const endpoint = ENDPOINTS[args.action];
@@ -393,7 +416,7 @@ export default class Payments extends Command {
393
416
  throw error;
394
417
  }
395
418
  }
396
- async runImport(flags) {
419
+ async runUpsert(flags) {
397
420
  const context = flags.context ? getContext(flags.context) : getCurrentContext();
398
421
  if (!context)
399
422
  this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
@@ -457,12 +480,12 @@ export default class Payments extends Command {
457
480
  items = [item];
458
481
  }
459
482
  else {
460
- this.error('Import requires --file, --data, or --set flags');
483
+ this.error('Upsert requires --file, --data, or --set flags');
461
484
  }
462
485
  const createEndpoint = ENDPOINTS['create'];
463
486
  const updateEndpoint = ENDPOINTS['update'];
464
487
  if (!createEndpoint || !updateEndpoint) {
465
- this.error('Import requires both create and update endpoints');
488
+ this.error('Upsert requires both create and update endpoints');
466
489
  }
467
490
  // Helper to extract identifier from item (id, code, or xxxCode)
468
491
  const getItemIdentifier = (item) => {
@@ -605,6 +628,117 @@ export default class Payments extends Command {
605
628
  this.log('');
606
629
  this.log(`Summary: ${created} created, ${updated} updated, ${errors.length} failed`);
607
630
  }
631
+ /**
632
+ * The API's own import: the whole array goes up in one request and comes
633
+ * back as an import run, which records what happened to every record. A bad
634
+ * record lands in errorLog and the rest are still applied, and the run stays
635
+ * readable afterwards with: aderis imports get <id>.
636
+ */
637
+ async runServerImport(action, parentId, flags) {
638
+ const endpoint = ENDPOINTS[action];
639
+ if (!endpoint)
640
+ this.error(`Unknown action: ${action}. Available: ${SUBCOMMANDS.join(', ')}`);
641
+ const context = flags.context ? getContext(flags.context) : getCurrentContext();
642
+ if (!context)
643
+ this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
644
+ if (!hasCredentials(context))
645
+ this.error(missingCredentialsMessage(context));
646
+ let apiPath = endpoint.path;
647
+ if (endpoint.pathParams.length > 0) {
648
+ if (!parentId)
649
+ this.error(`Missing required argument: id. Usage: aderis payments ${action} <parent-id> --file data.json`);
650
+ apiPath = apiPath.replace(`{${endpoint.pathParams[0]}}`, parentId);
651
+ }
652
+ // The endpoint takes an array. A single object is wrapped, so importing
653
+ // one record reads the same as importing many.
654
+ let records = [];
655
+ if (flags.file) {
656
+ const fsModule = await import('node:fs');
657
+ try {
658
+ const content = JSON.parse(fsModule.readFileSync(flags.file, 'utf-8'));
659
+ records = Array.isArray(content) ? content : [content];
660
+ }
661
+ catch {
662
+ this.error(`Failed to read file: ${flags.file}`);
663
+ }
664
+ }
665
+ else if (flags.data) {
666
+ try {
667
+ const content = JSON.parse(flags.data);
668
+ records = Array.isArray(content) ? content : [content];
669
+ }
670
+ catch {
671
+ this.error('Invalid JSON in --data');
672
+ }
673
+ }
674
+ else {
675
+ this.error('Import requires --file or --data holding a JSON array of records');
676
+ }
677
+ if (records.length === 0)
678
+ this.error('Nothing to import: the input is an empty array');
679
+ const params = { format: 'json' };
680
+ if (flags.mode)
681
+ params.mode = flags.mode;
682
+ if (flags.reference)
683
+ params.reference = flags.reference;
684
+ if (flags.async)
685
+ params.async = true;
686
+ const headers = {};
687
+ if (flags['idempotency-key'])
688
+ headers['Idempotency-Key'] = flags['idempotency-key'];
689
+ if (flags['show-http-request']) {
690
+ const baseUrls = getBaseUrls(context.environment);
691
+ const queryString = '?' + Object.entries(params).map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(String(v))}`).join('&');
692
+ process.stderr.write(`\n${endpoint.method.toUpperCase()} ${baseUrls.api}${apiPath}${queryString}\n`);
693
+ process.stderr.write(`Body: [${records.length} record${records.length === 1 ? '' : 's'}]\n\n`);
694
+ }
695
+ try {
696
+ const response = await apiRequest(endpoint.method, apiPath, {
697
+ contextName: flags.context,
698
+ data: records,
699
+ headers,
700
+ params,
701
+ });
702
+ this.printImportRun(response.data, flags);
703
+ }
704
+ catch (error) {
705
+ if (error instanceof ApiError) {
706
+ this.error(`API Error (${error.status}): ${error.message}`);
707
+ }
708
+ throw error;
709
+ }
710
+ }
711
+ /** Renders an import run: its counts, then whatever the server refused. */
712
+ printImportRun(run, flags) {
713
+ if (flags.output === 'json') {
714
+ this.log(JSON.stringify(run, null, 2));
715
+ return;
716
+ }
717
+ const record = (run ?? {});
718
+ const count = (key) => (typeof record[key] === 'number' ? record[key] : 0);
719
+ const id = record.id ? String(record.id) : '';
720
+ this.log(`Import ${id} - ${String(record.status ?? 'UNKNOWN')}${record.async ? ' (background)' : ''}`);
721
+ this.log(` ${count('inputSize')} submitted, ${count('createdCount')} created, ${count('updatedCount')} updated, ${count('unchangedCount')} unchanged`);
722
+ if (count('errorCount') > 0)
723
+ this.log(` ${count('errorCount')} not applied: ${count('refusedCount')} refused, ${count('failedCount')} failed`);
724
+ if (count('warningCount') > 0)
725
+ this.log(` ${count('warningCount')} applied with a warning`);
726
+ // errorLog is keyed by the record's identifier, then by field name.
727
+ const errorLog = record.errorLog;
728
+ if (errorLog && Object.keys(errorLog).length > 0) {
729
+ this.log('');
730
+ for (const [key, fields] of Object.entries(errorLog)) {
731
+ for (const [field, messages] of Object.entries(fields ?? {})) {
732
+ for (const message of messages ?? [])
733
+ this.log(` ${key} ${field}: ${message}`);
734
+ }
735
+ }
736
+ }
737
+ if (record.async && id) {
738
+ this.log('');
739
+ this.log(`Follow it with: aderis imports get ${id}`);
740
+ }
741
+ }
608
742
  async runExport(flags) {
609
743
  const context = flags.context ? getContext(flags.context) : getCurrentContext();
610
744
  if (!context)
@@ -783,9 +917,9 @@ export default class Payments extends Command {
783
917
  throw error;
784
918
  }
785
919
  }
786
- async runNestedImport(suffix, parentId, flags) {
920
+ async runNestedUpsert(suffix, parentId, flags) {
787
921
  if (!parentId) {
788
- this.error(`Missing required argument: id. Usage: aderis payments import-${suffix} <parent-id> --file data.json`);
922
+ this.error(`Missing required argument: id. Usage: aderis payments upsert-${suffix} <parent-id> --file data.json`);
789
923
  }
790
924
  const context = flags.context ? getContext(flags.context) : getCurrentContext();
791
925
  if (!context)
@@ -850,12 +984,12 @@ export default class Payments extends Command {
850
984
  items = [item];
851
985
  }
852
986
  else {
853
- this.error(`Import requires --file, --data, or --set flags`);
987
+ this.error('Upsert requires --file, --data, or --set flags');
854
988
  }
855
989
  const createEndpoint = ENDPOINTS[`create-${suffix}`];
856
990
  const updateEndpoint = ENDPOINTS[`update-${suffix}`];
857
991
  if (!createEndpoint || !updateEndpoint) {
858
- this.error(`Import requires both create-${suffix} and update-${suffix} endpoints`);
992
+ this.error(`Upsert requires both create-${suffix} and update-${suffix} endpoints`);
859
993
  }
860
994
  // Build the base path with parent ID (first path param)
861
995
  const firstParam = createEndpoint.pathParams[0];
@@ -31,10 +31,19 @@ export default class PayrollRuns extends Command {
31
31
  'show-http-request': import("@oclif/core/interfaces").BooleanFlag<boolean>;
32
32
  };
33
33
  run(): Promise<void>;
34
- private runImport;
34
+ private runUpsert;
35
+ /**
36
+ * The API's own import: the whole array goes up in one request and comes
37
+ * back as an import run, which records what happened to every record. A bad
38
+ * record lands in errorLog and the rest are still applied, and the run stays
39
+ * readable afterwards with: aderis imports get <id>.
40
+ */
41
+ private runServerImport;
42
+ /** Renders an import run: its counts, then whatever the server refused. */
43
+ private printImportRun;
35
44
  private runExport;
36
45
  private runCamt053Import;
37
- private runNestedImport;
46
+ private runNestedUpsert;
38
47
  private parseFilterValue;
39
48
  /** The page line under a table: which page, how many, and any sums the API returned. */
40
49
  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 = true;
6
8
  const HAS_EXPORT = true;
7
9
  const HAS_CAMT053 = false;
8
- const NESTED_IMPORTS = ["notes", "files", "files-parentId"];
9
- const SUBCOMMANDS = [...["list-notes", "create-notes", "update-notes", "delete-notes", "notices-dismiss", "notices-restore", "list", "create", "get", "update", "delete", "list-files", "create-files", "get-files", "update-files", "delete-files", "files-download", "list-bookings", "update-bookings", "list-entries", "get-entries", "update-entries", "entries-exclude", "entries-include", "list-files-parentId", "create-files-parentId", "get-files-parentId", "update-files-parentId", "delete-files-parentId", "files-download-parentId", "approve", "cancel", "payments", "recalculate-payment-status", "payslips-send"], ...(HAS_IMPORT ? ['import'] : []), ...(HAS_EXPORT ? ['export'] : []), ...NESTED_IMPORTS.map(n => `import-${n}`)];
10
+ const SERVER_IMPORTS = [];
11
+ const NESTED_UPSERTS = ["notes", "files", "files-parentId"];
12
+ const SUBCOMMANDS = [...["list-notes", "create-notes", "update-notes", "delete-notes", "notices-dismiss", "notices-restore", "list", "create", "get", "update", "delete", "list-files", "create-files", "get-files", "update-files", "delete-files", "files-download", "list-bookings", "update-bookings", "list-entries", "get-entries", "update-entries", "entries-exclude", "entries-include", "list-files-parentId", "create-files-parentId", "get-files-parentId", "update-files-parentId", "delete-files-parentId", "files-download-parentId", "approve", "cancel", "payments", "recalculate-payment-status", "payslips-send"], ...(HAS_UPSERT ? ['upsert'] : []), ...(HAS_EXPORT ? ['export'] : []), ...NESTED_UPSERTS.map(n => `upsert-${n}`)];
10
13
  const ENDPOINTS = {
11
14
  'list-notes': { method: 'GET', path: '/v1/payroll-runs/notes', summary: 'List payroll notes (paginated), newest effectiveDate first', pathParams: [], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
12
15
  'create-notes': { method: 'POST', path: '/v1/payroll-runs/notes', summary: 'Create a payroll note', pathParams: [], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
@@ -51,7 +54,7 @@ export default class PayrollRuns extends Command {
51
54
  '<%= config.bin %> payroll-runs get <id>',
52
55
  '<%= config.bin %> payroll-runs create --data \'{...}\'',
53
56
  '<%= config.bin %> payroll-runs update <id> --set field=value',
54
- '<%= config.bin %> payroll-runs import --file data.json',
57
+ '<%= config.bin %> payroll-runs upsert --file data.json',
55
58
  '<%= config.bin %> payroll-runs export --csv > payroll-runs.csv',
56
59
  ];
57
60
  static args = {
@@ -60,7 +63,7 @@ export default class PayrollRuns extends Command {
60
63
  };
61
64
  static flags = {
62
65
  context: Flags.string({ char: 'c', aliases: ['config'], env: 'ADERIS_CONTEXT', description: 'Context to use for this command, overriding the current context (alias: --config)' }),
63
- output: Flags.string({ char: 'o', description: 'Output format (default: table for import, json for other commands)', options: ['json', 'table', 'csv'] }),
66
+ output: Flags.string({ char: 'o', description: 'Output format (default: table for upsert, json for other commands)', options: ['json', 'table', 'csv'] }),
64
67
  table: Flags.boolean({ char: 't', description: 'Output as table (shortcut for --output table)' }),
65
68
  csv: Flags.boolean({ description: 'Output as CSV (shortcut for --output csv)' }),
66
69
  data: Flags.string({ char: 'd', description: 'JSON data for request body' }),
@@ -84,11 +87,26 @@ export default class PayrollRuns extends Command {
84
87
  };
85
88
  async run() {
86
89
  const { args, flags } = await this.parse(PayrollRuns);
87
- // Handle import action specially
88
- if (args.action === 'import') {
89
- if (!HAS_IMPORT)
90
- this.error('Import not available for this resource');
91
- await this.runImport(flags);
90
+ // Bulk actions. 'import' is the API's own endpoint: one request, answered
91
+ // by a run that records what happened to every record. 'upsert' is the CLI
92
+ // looping create/update. A resource has one or the other, never both.
93
+ if (args.action === 'upsert') {
94
+ if (!HAS_UPSERT) {
95
+ this.error(SERVER_IMPORTS.includes('import')
96
+ ? 'This resource is imported by the API. Use: aderis payroll-runs import --file data.json'
97
+ : 'Upsert needs both a create and an update endpoint, which this resource does not have');
98
+ }
99
+ await this.runUpsert(flags);
100
+ return;
101
+ }
102
+ if (args.action.startsWith('upsert-')) {
103
+ const suffix = args.action.replace('upsert-', '');
104
+ if (!NESTED_UPSERTS.includes(suffix)) {
105
+ this.error(SERVER_IMPORTS.includes('import-' + suffix)
106
+ ? `That resource is imported by the API. Use: aderis payroll-runs import-${suffix} <id> --file data.json`
107
+ : `Unknown action: ${args.action}. Available: ${SUBCOMMANDS.join(', ')}`);
108
+ }
109
+ await this.runNestedUpsert(suffix, args.id, flags);
92
110
  return;
93
111
  }
94
112
  // Handle export action specially
@@ -105,12 +123,17 @@ export default class PayrollRuns extends Command {
105
123
  await this.runCamt053Import(flags);
106
124
  return;
107
125
  }
108
- // Handle nested resource imports (e.g., import-prices)
109
- if (args.action.startsWith('import-')) {
110
- const suffix = args.action.replace('import-', '');
111
- if (NESTED_IMPORTS.includes(suffix)) {
112
- await this.runNestedImport(suffix, args.id, flags);
113
- return;
126
+ if (SERVER_IMPORTS.includes(args.action)) {
127
+ await this.runServerImport(args.action, args.id, flags);
128
+ return;
129
+ }
130
+ // 'import' used to name the CLI's create/update loop on every resource. It
131
+ // now names the API endpoint, which most resources do not have.
132
+ if (args.action === 'import' || args.action.startsWith('import-')) {
133
+ const suffix = args.action === 'import' ? '' : '-' + args.action.replace('import-', '');
134
+ const loops = args.action === 'import' ? HAS_UPSERT : NESTED_UPSERTS.includes(args.action.replace('import-', ''));
135
+ if (loops) {
136
+ this.error(`This resource has no import endpoint. Use: aderis payroll-runs upsert${suffix}${suffix ? ' <id>' : ''} --file data.json`);
114
137
  }
115
138
  }
116
139
  const endpoint = ENDPOINTS[args.action];
@@ -425,7 +448,7 @@ export default class PayrollRuns extends Command {
425
448
  throw error;
426
449
  }
427
450
  }
428
- async runImport(flags) {
451
+ async runUpsert(flags) {
429
452
  const context = flags.context ? getContext(flags.context) : getCurrentContext();
430
453
  if (!context)
431
454
  this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
@@ -489,12 +512,12 @@ export default class PayrollRuns extends Command {
489
512
  items = [item];
490
513
  }
491
514
  else {
492
- this.error('Import requires --file, --data, or --set flags');
515
+ this.error('Upsert requires --file, --data, or --set flags');
493
516
  }
494
517
  const createEndpoint = ENDPOINTS['create'];
495
518
  const updateEndpoint = ENDPOINTS['update'];
496
519
  if (!createEndpoint || !updateEndpoint) {
497
- this.error('Import requires both create and update endpoints');
520
+ this.error('Upsert requires both create and update endpoints');
498
521
  }
499
522
  // Helper to extract identifier from item (id, code, or xxxCode)
500
523
  const getItemIdentifier = (item) => {
@@ -637,6 +660,117 @@ export default class PayrollRuns extends Command {
637
660
  this.log('');
638
661
  this.log(`Summary: ${created} created, ${updated} updated, ${errors.length} failed`);
639
662
  }
663
+ /**
664
+ * The API's own import: the whole array goes up in one request and comes
665
+ * back as an import run, which records what happened to every record. A bad
666
+ * record lands in errorLog and the rest are still applied, and the run stays
667
+ * readable afterwards with: aderis imports get <id>.
668
+ */
669
+ async runServerImport(action, parentId, flags) {
670
+ const endpoint = ENDPOINTS[action];
671
+ if (!endpoint)
672
+ this.error(`Unknown action: ${action}. Available: ${SUBCOMMANDS.join(', ')}`);
673
+ const context = flags.context ? getContext(flags.context) : getCurrentContext();
674
+ if (!context)
675
+ this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
676
+ if (!hasCredentials(context))
677
+ this.error(missingCredentialsMessage(context));
678
+ let apiPath = endpoint.path;
679
+ if (endpoint.pathParams.length > 0) {
680
+ if (!parentId)
681
+ this.error(`Missing required argument: id. Usage: aderis payroll-runs ${action} <parent-id> --file data.json`);
682
+ apiPath = apiPath.replace(`{${endpoint.pathParams[0]}}`, parentId);
683
+ }
684
+ // The endpoint takes an array. A single object is wrapped, so importing
685
+ // one record reads the same as importing many.
686
+ let records = [];
687
+ if (flags.file) {
688
+ const fsModule = await import('node:fs');
689
+ try {
690
+ const content = JSON.parse(fsModule.readFileSync(flags.file, 'utf-8'));
691
+ records = Array.isArray(content) ? content : [content];
692
+ }
693
+ catch {
694
+ this.error(`Failed to read file: ${flags.file}`);
695
+ }
696
+ }
697
+ else if (flags.data) {
698
+ try {
699
+ const content = JSON.parse(flags.data);
700
+ records = Array.isArray(content) ? content : [content];
701
+ }
702
+ catch {
703
+ this.error('Invalid JSON in --data');
704
+ }
705
+ }
706
+ else {
707
+ this.error('Import requires --file or --data holding a JSON array of records');
708
+ }
709
+ if (records.length === 0)
710
+ this.error('Nothing to import: the input is an empty array');
711
+ const params = { format: 'json' };
712
+ if (flags.mode)
713
+ params.mode = flags.mode;
714
+ if (flags.reference)
715
+ params.reference = flags.reference;
716
+ if (flags.async)
717
+ params.async = true;
718
+ const headers = {};
719
+ if (flags['idempotency-key'])
720
+ headers['Idempotency-Key'] = flags['idempotency-key'];
721
+ if (flags['show-http-request']) {
722
+ const baseUrls = getBaseUrls(context.environment);
723
+ const queryString = '?' + Object.entries(params).map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(String(v))}`).join('&');
724
+ process.stderr.write(`\n${endpoint.method.toUpperCase()} ${baseUrls.api}${apiPath}${queryString}\n`);
725
+ process.stderr.write(`Body: [${records.length} record${records.length === 1 ? '' : 's'}]\n\n`);
726
+ }
727
+ try {
728
+ const response = await apiRequest(endpoint.method, apiPath, {
729
+ contextName: flags.context,
730
+ data: records,
731
+ headers,
732
+ params,
733
+ });
734
+ this.printImportRun(response.data, flags);
735
+ }
736
+ catch (error) {
737
+ if (error instanceof ApiError) {
738
+ this.error(`API Error (${error.status}): ${error.message}`);
739
+ }
740
+ throw error;
741
+ }
742
+ }
743
+ /** Renders an import run: its counts, then whatever the server refused. */
744
+ printImportRun(run, flags) {
745
+ if (flags.output === 'json') {
746
+ this.log(JSON.stringify(run, null, 2));
747
+ return;
748
+ }
749
+ const record = (run ?? {});
750
+ const count = (key) => (typeof record[key] === 'number' ? record[key] : 0);
751
+ const id = record.id ? String(record.id) : '';
752
+ this.log(`Import ${id} - ${String(record.status ?? 'UNKNOWN')}${record.async ? ' (background)' : ''}`);
753
+ this.log(` ${count('inputSize')} submitted, ${count('createdCount')} created, ${count('updatedCount')} updated, ${count('unchangedCount')} unchanged`);
754
+ if (count('errorCount') > 0)
755
+ this.log(` ${count('errorCount')} not applied: ${count('refusedCount')} refused, ${count('failedCount')} failed`);
756
+ if (count('warningCount') > 0)
757
+ this.log(` ${count('warningCount')} applied with a warning`);
758
+ // errorLog is keyed by the record's identifier, then by field name.
759
+ const errorLog = record.errorLog;
760
+ if (errorLog && Object.keys(errorLog).length > 0) {
761
+ this.log('');
762
+ for (const [key, fields] of Object.entries(errorLog)) {
763
+ for (const [field, messages] of Object.entries(fields ?? {})) {
764
+ for (const message of messages ?? [])
765
+ this.log(` ${key} ${field}: ${message}`);
766
+ }
767
+ }
768
+ }
769
+ if (record.async && id) {
770
+ this.log('');
771
+ this.log(`Follow it with: aderis imports get ${id}`);
772
+ }
773
+ }
640
774
  async runExport(flags) {
641
775
  const context = flags.context ? getContext(flags.context) : getCurrentContext();
642
776
  if (!context)
@@ -815,9 +949,9 @@ export default class PayrollRuns extends Command {
815
949
  throw error;
816
950
  }
817
951
  }
818
- async runNestedImport(suffix, parentId, flags) {
952
+ async runNestedUpsert(suffix, parentId, flags) {
819
953
  if (!parentId) {
820
- this.error(`Missing required argument: id. Usage: aderis payroll-runs import-${suffix} <parent-id> --file data.json`);
954
+ this.error(`Missing required argument: id. Usage: aderis payroll-runs upsert-${suffix} <parent-id> --file data.json`);
821
955
  }
822
956
  const context = flags.context ? getContext(flags.context) : getCurrentContext();
823
957
  if (!context)
@@ -882,12 +1016,12 @@ export default class PayrollRuns extends Command {
882
1016
  items = [item];
883
1017
  }
884
1018
  else {
885
- this.error(`Import requires --file, --data, or --set flags`);
1019
+ this.error('Upsert requires --file, --data, or --set flags');
886
1020
  }
887
1021
  const createEndpoint = ENDPOINTS[`create-${suffix}`];
888
1022
  const updateEndpoint = ENDPOINTS[`update-${suffix}`];
889
1023
  if (!createEndpoint || !updateEndpoint) {
890
- this.error(`Import requires both create-${suffix} and update-${suffix} endpoints`);
1024
+ this.error(`Upsert requires both create-${suffix} and update-${suffix} endpoints`);
891
1025
  }
892
1026
  // Build the base path with parent ID (first path param)
893
1027
  const firstParam = createEndpoint.pathParams[0];
@@ -27,10 +27,19 @@ export default class Permissions 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;