@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"], ...(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"], ...(HAS_UPSERT ? ['upsert'] : []), ...(HAS_EXPORT ? ['export'] : []), ...NESTED_UPSERTS.map(n => `upsert-${n}`)];
10
13
  const ENDPOINTS = {
11
14
  'list': { method: 'GET', path: '/v1/tax/tax-matrix', summary: 'Get all tax matrix mappings with pagination', pathParams: [], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
12
15
  'create': { method: 'POST', path: '/v1/tax/tax-matrix', summary: 'Create a new tax matrix mapping', pathParams: [], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
@@ -21,7 +24,7 @@ export default class TaxMatrix extends Command {
21
24
  '<%= config.bin %> tax-matrix get <id>',
22
25
  '<%= config.bin %> tax-matrix create --data \'{...}\'',
23
26
  '<%= config.bin %> tax-matrix update <id> --set field=value',
24
- '<%= config.bin %> tax-matrix import --file data.json',
27
+ '<%= config.bin %> tax-matrix upsert --file data.json',
25
28
  '<%= config.bin %> tax-matrix export --csv > tax-matrix.csv',
26
29
  ];
27
30
  static args = {
@@ -30,7 +33,7 @@ export default class TaxMatrix extends Command {
30
33
  };
31
34
  static flags = {
32
35
  context: Flags.string({ char: 'c', aliases: ['config'], env: 'ADERIS_CONTEXT', description: 'Context to use for this command, overriding the current context (alias: --config)' }),
33
- output: Flags.string({ char: 'o', description: 'Output format (default: table for import, json for other commands)', options: ['json', 'table', 'csv'] }),
36
+ output: Flags.string({ char: 'o', description: 'Output format (default: table for upsert, json for other commands)', options: ['json', 'table', 'csv'] }),
34
37
  table: Flags.boolean({ char: 't', description: 'Output as table (shortcut for --output table)' }),
35
38
  csv: Flags.boolean({ description: 'Output as CSV (shortcut for --output csv)' }),
36
39
  data: Flags.string({ char: 'd', description: 'JSON data for request body' }),
@@ -50,11 +53,26 @@ export default class TaxMatrix extends Command {
50
53
  };
51
54
  async run() {
52
55
  const { args, flags } = await this.parse(TaxMatrix);
53
- // Handle import action specially
54
- if (args.action === 'import') {
55
- if (!HAS_IMPORT)
56
- this.error('Import not available for this resource');
57
- await this.runImport(flags);
56
+ // Bulk actions. 'import' is the API's own endpoint: one request, answered
57
+ // by a run that records what happened to every record. 'upsert' is the CLI
58
+ // looping create/update. A resource has one or the other, never both.
59
+ if (args.action === 'upsert') {
60
+ if (!HAS_UPSERT) {
61
+ this.error(SERVER_IMPORTS.includes('import')
62
+ ? 'This resource is imported by the API. Use: aderis tax-matrix import --file data.json'
63
+ : 'Upsert needs both a create and an update endpoint, which this resource does not have');
64
+ }
65
+ await this.runUpsert(flags);
66
+ return;
67
+ }
68
+ if (args.action.startsWith('upsert-')) {
69
+ const suffix = args.action.replace('upsert-', '');
70
+ if (!NESTED_UPSERTS.includes(suffix)) {
71
+ this.error(SERVER_IMPORTS.includes('import-' + suffix)
72
+ ? `That resource is imported by the API. Use: aderis tax-matrix import-${suffix} <id> --file data.json`
73
+ : `Unknown action: ${args.action}. Available: ${SUBCOMMANDS.join(', ')}`);
74
+ }
75
+ await this.runNestedUpsert(suffix, args.id, flags);
58
76
  return;
59
77
  }
60
78
  // Handle export action specially
@@ -71,12 +89,17 @@ export default class TaxMatrix extends Command {
71
89
  await this.runCamt053Import(flags);
72
90
  return;
73
91
  }
74
- // Handle nested resource imports (e.g., import-prices)
75
- if (args.action.startsWith('import-')) {
76
- const suffix = args.action.replace('import-', '');
77
- if (NESTED_IMPORTS.includes(suffix)) {
78
- await this.runNestedImport(suffix, args.id, flags);
79
- return;
92
+ if (SERVER_IMPORTS.includes(args.action)) {
93
+ await this.runServerImport(args.action, args.id, flags);
94
+ return;
95
+ }
96
+ // 'import' used to name the CLI's create/update loop on every resource. It
97
+ // now names the API endpoint, which most resources do not have.
98
+ if (args.action === 'import' || args.action.startsWith('import-')) {
99
+ const suffix = args.action === 'import' ? '' : '-' + args.action.replace('import-', '');
100
+ const loops = args.action === 'import' ? HAS_UPSERT : NESTED_UPSERTS.includes(args.action.replace('import-', ''));
101
+ if (loops) {
102
+ this.error(`This resource has no import endpoint. Use: aderis tax-matrix upsert${suffix}${suffix ? ' <id>' : ''} --file data.json`);
80
103
  }
81
104
  }
82
105
  const endpoint = ENDPOINTS[args.action];
@@ -391,7 +414,7 @@ export default class TaxMatrix extends Command {
391
414
  throw error;
392
415
  }
393
416
  }
394
- async runImport(flags) {
417
+ async runUpsert(flags) {
395
418
  const context = flags.context ? getContext(flags.context) : getCurrentContext();
396
419
  if (!context)
397
420
  this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
@@ -455,12 +478,12 @@ export default class TaxMatrix extends Command {
455
478
  items = [item];
456
479
  }
457
480
  else {
458
- this.error('Import requires --file, --data, or --set flags');
481
+ this.error('Upsert requires --file, --data, or --set flags');
459
482
  }
460
483
  const createEndpoint = ENDPOINTS['create'];
461
484
  const updateEndpoint = ENDPOINTS['update'];
462
485
  if (!createEndpoint || !updateEndpoint) {
463
- this.error('Import requires both create and update endpoints');
486
+ this.error('Upsert requires both create and update endpoints');
464
487
  }
465
488
  // Helper to extract identifier from item (id, code, or xxxCode)
466
489
  const getItemIdentifier = (item) => {
@@ -603,6 +626,117 @@ export default class TaxMatrix extends Command {
603
626
  this.log('');
604
627
  this.log(`Summary: ${created} created, ${updated} updated, ${errors.length} failed`);
605
628
  }
629
+ /**
630
+ * The API's own import: the whole array goes up in one request and comes
631
+ * back as an import run, which records what happened to every record. A bad
632
+ * record lands in errorLog and the rest are still applied, and the run stays
633
+ * readable afterwards with: aderis imports get <id>.
634
+ */
635
+ async runServerImport(action, parentId, flags) {
636
+ const endpoint = ENDPOINTS[action];
637
+ if (!endpoint)
638
+ this.error(`Unknown action: ${action}. Available: ${SUBCOMMANDS.join(', ')}`);
639
+ const context = flags.context ? getContext(flags.context) : getCurrentContext();
640
+ if (!context)
641
+ this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
642
+ if (!hasCredentials(context))
643
+ this.error(missingCredentialsMessage(context));
644
+ let apiPath = endpoint.path;
645
+ if (endpoint.pathParams.length > 0) {
646
+ if (!parentId)
647
+ this.error(`Missing required argument: id. Usage: aderis tax-matrix ${action} <parent-id> --file data.json`);
648
+ apiPath = apiPath.replace(`{${endpoint.pathParams[0]}}`, parentId);
649
+ }
650
+ // The endpoint takes an array. A single object is wrapped, so importing
651
+ // one record reads the same as importing many.
652
+ let records = [];
653
+ if (flags.file) {
654
+ const fsModule = await import('node:fs');
655
+ try {
656
+ const content = JSON.parse(fsModule.readFileSync(flags.file, 'utf-8'));
657
+ records = Array.isArray(content) ? content : [content];
658
+ }
659
+ catch {
660
+ this.error(`Failed to read file: ${flags.file}`);
661
+ }
662
+ }
663
+ else if (flags.data) {
664
+ try {
665
+ const content = JSON.parse(flags.data);
666
+ records = Array.isArray(content) ? content : [content];
667
+ }
668
+ catch {
669
+ this.error('Invalid JSON in --data');
670
+ }
671
+ }
672
+ else {
673
+ this.error('Import requires --file or --data holding a JSON array of records');
674
+ }
675
+ if (records.length === 0)
676
+ this.error('Nothing to import: the input is an empty array');
677
+ const params = { format: 'json' };
678
+ if (flags.mode)
679
+ params.mode = flags.mode;
680
+ if (flags.reference)
681
+ params.reference = flags.reference;
682
+ if (flags.async)
683
+ params.async = true;
684
+ const headers = {};
685
+ if (flags['idempotency-key'])
686
+ headers['Idempotency-Key'] = flags['idempotency-key'];
687
+ if (flags['show-http-request']) {
688
+ const baseUrls = getBaseUrls(context.environment);
689
+ const queryString = '?' + Object.entries(params).map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(String(v))}`).join('&');
690
+ process.stderr.write(`\n${endpoint.method.toUpperCase()} ${baseUrls.api}${apiPath}${queryString}\n`);
691
+ process.stderr.write(`Body: [${records.length} record${records.length === 1 ? '' : 's'}]\n\n`);
692
+ }
693
+ try {
694
+ const response = await apiRequest(endpoint.method, apiPath, {
695
+ contextName: flags.context,
696
+ data: records,
697
+ headers,
698
+ params,
699
+ });
700
+ this.printImportRun(response.data, flags);
701
+ }
702
+ catch (error) {
703
+ if (error instanceof ApiError) {
704
+ this.error(`API Error (${error.status}): ${error.message}`);
705
+ }
706
+ throw error;
707
+ }
708
+ }
709
+ /** Renders an import run: its counts, then whatever the server refused. */
710
+ printImportRun(run, flags) {
711
+ if (flags.output === 'json') {
712
+ this.log(JSON.stringify(run, null, 2));
713
+ return;
714
+ }
715
+ const record = (run ?? {});
716
+ const count = (key) => (typeof record[key] === 'number' ? record[key] : 0);
717
+ const id = record.id ? String(record.id) : '';
718
+ this.log(`Import ${id} - ${String(record.status ?? 'UNKNOWN')}${record.async ? ' (background)' : ''}`);
719
+ this.log(` ${count('inputSize')} submitted, ${count('createdCount')} created, ${count('updatedCount')} updated, ${count('unchangedCount')} unchanged`);
720
+ if (count('errorCount') > 0)
721
+ this.log(` ${count('errorCount')} not applied: ${count('refusedCount')} refused, ${count('failedCount')} failed`);
722
+ if (count('warningCount') > 0)
723
+ this.log(` ${count('warningCount')} applied with a warning`);
724
+ // errorLog is keyed by the record's identifier, then by field name.
725
+ const errorLog = record.errorLog;
726
+ if (errorLog && Object.keys(errorLog).length > 0) {
727
+ this.log('');
728
+ for (const [key, fields] of Object.entries(errorLog)) {
729
+ for (const [field, messages] of Object.entries(fields ?? {})) {
730
+ for (const message of messages ?? [])
731
+ this.log(` ${key} ${field}: ${message}`);
732
+ }
733
+ }
734
+ }
735
+ if (record.async && id) {
736
+ this.log('');
737
+ this.log(`Follow it with: aderis imports get ${id}`);
738
+ }
739
+ }
606
740
  async runExport(flags) {
607
741
  const context = flags.context ? getContext(flags.context) : getCurrentContext();
608
742
  if (!context)
@@ -781,9 +915,9 @@ export default class TaxMatrix extends Command {
781
915
  throw error;
782
916
  }
783
917
  }
784
- async runNestedImport(suffix, parentId, flags) {
918
+ async runNestedUpsert(suffix, parentId, flags) {
785
919
  if (!parentId) {
786
- this.error(`Missing required argument: id. Usage: aderis tax-matrix import-${suffix} <parent-id> --file data.json`);
920
+ this.error(`Missing required argument: id. Usage: aderis tax-matrix upsert-${suffix} <parent-id> --file data.json`);
787
921
  }
788
922
  const context = flags.context ? getContext(flags.context) : getCurrentContext();
789
923
  if (!context)
@@ -848,12 +982,12 @@ export default class TaxMatrix extends Command {
848
982
  items = [item];
849
983
  }
850
984
  else {
851
- this.error(`Import requires --file, --data, or --set flags`);
985
+ this.error('Upsert requires --file, --data, or --set flags');
852
986
  }
853
987
  const createEndpoint = ENDPOINTS[`create-${suffix}`];
854
988
  const updateEndpoint = ENDPOINTS[`update-${suffix}`];
855
989
  if (!createEndpoint || !updateEndpoint) {
856
- this.error(`Import requires both create-${suffix} and update-${suffix} endpoints`);
990
+ this.error(`Upsert requires both create-${suffix} and update-${suffix} endpoints`);
857
991
  }
858
992
  // Build the base path with parent ID (first path param)
859
993
  const firstParam = createEndpoint.pathParams[0];
@@ -27,10 +27,19 @@ export default class Templates 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;
@@ -1,13 +1,21 @@
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", "usage", "duplicate", "preview"], ...(HAS_IMPORT ? ['import'] : []), ...(HAS_EXPORT ? ['export'] : []), ...NESTED_IMPORTS.map(n => `import-${n}`)];
10
+ const SERVER_IMPORTS = [];
11
+ const NESTED_UPSERTS = [];
12
+ const SUBCOMMANDS = [...["rule-fields", "rule-order", "replace-rule", "delete-rule", "pdf-fields", "list", "create", "get", "update", "delete", "usage", "duplicate", "preview"], ...(HAS_UPSERT ? ['upsert'] : []), ...(HAS_EXPORT ? ['export'] : []), ...NESTED_UPSERTS.map(n => `upsert-${n}`)];
10
13
  const ENDPOINTS = {
14
+ 'rule-fields': { method: 'GET', path: '/v1/templates/rule-fields', summary: 'List the fields a TEXT module’s template rules may test', pathParams: [], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
15
+ 'rule-order': { method: 'POST', path: '/v1/templates/rule-order', summary: 'Order the template rules of a TEXT module', pathParams: [], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: ['templateIds'] },
16
+ 'replace-rule': { method: 'PUT', path: '/v1/templates/{id}/rule', summary: 'Set the rule of a TEXT template', pathParams: ['id'], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
17
+ 'delete-rule': { method: 'DELETE', path: '/v1/templates/{id}/rule', summary: 'Remove the rule of a template', pathParams: ['id'], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
18
+ 'pdf-fields': { method: 'GET', path: '/v1/templates/pdf-fields', summary: 'List the values a PDF template of a document type can print', pathParams: [], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
11
19
  'list': { method: 'GET', path: '/v1/templates', summary: 'Get all templates with pagination', pathParams: [], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
12
20
  'create': { method: 'POST', path: '/v1/templates', summary: 'Create a new template', pathParams: [], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: ['includes'] },
13
21
  'get': { method: 'GET', path: '/v1/templates/{id}', summary: 'Get a template by ID', pathParams: ['id'], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
@@ -24,7 +32,7 @@ export default class Templates extends Command {
24
32
  '<%= config.bin %> templates get <id>',
25
33
  '<%= config.bin %> templates create --data \'{...}\'',
26
34
  '<%= config.bin %> templates update <id> --set field=value',
27
- '<%= config.bin %> templates import --file data.json',
35
+ '<%= config.bin %> templates upsert --file data.json',
28
36
  '<%= config.bin %> templates export --csv > templates.csv',
29
37
  ];
30
38
  static args = {
@@ -33,7 +41,7 @@ export default class Templates extends Command {
33
41
  };
34
42
  static flags = {
35
43
  context: Flags.string({ char: 'c', aliases: ['config'], env: 'ADERIS_CONTEXT', description: 'Context to use for this command, overriding the current context (alias: --config)' }),
36
- output: Flags.string({ char: 'o', description: 'Output format (default: table for import, json for other commands)', options: ['json', 'table', 'csv'] }),
44
+ output: Flags.string({ char: 'o', description: 'Output format (default: table for upsert, json for other commands)', options: ['json', 'table', 'csv'] }),
37
45
  table: Flags.boolean({ char: 't', description: 'Output as table (shortcut for --output table)' }),
38
46
  csv: Flags.boolean({ description: 'Output as CSV (shortcut for --output csv)' }),
39
47
  data: Flags.string({ char: 'd', description: 'JSON data for request body' }),
@@ -53,11 +61,26 @@ export default class Templates extends Command {
53
61
  };
54
62
  async run() {
55
63
  const { args, flags } = await this.parse(Templates);
56
- // Handle import action specially
57
- if (args.action === 'import') {
58
- if (!HAS_IMPORT)
59
- this.error('Import not available for this resource');
60
- await this.runImport(flags);
64
+ // Bulk actions. 'import' is the API's own endpoint: one request, answered
65
+ // by a run that records what happened to every record. 'upsert' is the CLI
66
+ // looping create/update. A resource has one or the other, never both.
67
+ if (args.action === 'upsert') {
68
+ if (!HAS_UPSERT) {
69
+ this.error(SERVER_IMPORTS.includes('import')
70
+ ? 'This resource is imported by the API. Use: aderis templates import --file data.json'
71
+ : 'Upsert needs both a create and an update endpoint, which this resource does not have');
72
+ }
73
+ await this.runUpsert(flags);
74
+ return;
75
+ }
76
+ if (args.action.startsWith('upsert-')) {
77
+ const suffix = args.action.replace('upsert-', '');
78
+ if (!NESTED_UPSERTS.includes(suffix)) {
79
+ this.error(SERVER_IMPORTS.includes('import-' + suffix)
80
+ ? `That resource is imported by the API. Use: aderis templates import-${suffix} <id> --file data.json`
81
+ : `Unknown action: ${args.action}. Available: ${SUBCOMMANDS.join(', ')}`);
82
+ }
83
+ await this.runNestedUpsert(suffix, args.id, flags);
61
84
  return;
62
85
  }
63
86
  // Handle export action specially
@@ -74,12 +97,17 @@ export default class Templates extends Command {
74
97
  await this.runCamt053Import(flags);
75
98
  return;
76
99
  }
77
- // Handle nested resource imports (e.g., import-prices)
78
- if (args.action.startsWith('import-')) {
79
- const suffix = args.action.replace('import-', '');
80
- if (NESTED_IMPORTS.includes(suffix)) {
81
- await this.runNestedImport(suffix, args.id, flags);
82
- return;
100
+ if (SERVER_IMPORTS.includes(args.action)) {
101
+ await this.runServerImport(args.action, args.id, flags);
102
+ return;
103
+ }
104
+ // 'import' used to name the CLI's create/update loop on every resource. It
105
+ // now names the API endpoint, which most resources do not have.
106
+ if (args.action === 'import' || args.action.startsWith('import-')) {
107
+ const suffix = args.action === 'import' ? '' : '-' + args.action.replace('import-', '');
108
+ const loops = args.action === 'import' ? HAS_UPSERT : NESTED_UPSERTS.includes(args.action.replace('import-', ''));
109
+ if (loops) {
110
+ this.error(`This resource has no import endpoint. Use: aderis templates upsert${suffix}${suffix ? ' <id>' : ''} --file data.json`);
83
111
  }
84
112
  }
85
113
  const endpoint = ENDPOINTS[args.action];
@@ -394,7 +422,7 @@ export default class Templates extends Command {
394
422
  throw error;
395
423
  }
396
424
  }
397
- async runImport(flags) {
425
+ async runUpsert(flags) {
398
426
  const context = flags.context ? getContext(flags.context) : getCurrentContext();
399
427
  if (!context)
400
428
  this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
@@ -458,12 +486,12 @@ export default class Templates extends Command {
458
486
  items = [item];
459
487
  }
460
488
  else {
461
- this.error('Import requires --file, --data, or --set flags');
489
+ this.error('Upsert requires --file, --data, or --set flags');
462
490
  }
463
491
  const createEndpoint = ENDPOINTS['create'];
464
492
  const updateEndpoint = ENDPOINTS['update'];
465
493
  if (!createEndpoint || !updateEndpoint) {
466
- this.error('Import requires both create and update endpoints');
494
+ this.error('Upsert requires both create and update endpoints');
467
495
  }
468
496
  // Helper to extract identifier from item (id, code, or xxxCode)
469
497
  const getItemIdentifier = (item) => {
@@ -606,6 +634,117 @@ export default class Templates extends Command {
606
634
  this.log('');
607
635
  this.log(`Summary: ${created} created, ${updated} updated, ${errors.length} failed`);
608
636
  }
637
+ /**
638
+ * The API's own import: the whole array goes up in one request and comes
639
+ * back as an import run, which records what happened to every record. A bad
640
+ * record lands in errorLog and the rest are still applied, and the run stays
641
+ * readable afterwards with: aderis imports get <id>.
642
+ */
643
+ async runServerImport(action, parentId, flags) {
644
+ const endpoint = ENDPOINTS[action];
645
+ if (!endpoint)
646
+ this.error(`Unknown action: ${action}. Available: ${SUBCOMMANDS.join(', ')}`);
647
+ const context = flags.context ? getContext(flags.context) : getCurrentContext();
648
+ if (!context)
649
+ this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
650
+ if (!hasCredentials(context))
651
+ this.error(missingCredentialsMessage(context));
652
+ let apiPath = endpoint.path;
653
+ if (endpoint.pathParams.length > 0) {
654
+ if (!parentId)
655
+ this.error(`Missing required argument: id. Usage: aderis templates ${action} <parent-id> --file data.json`);
656
+ apiPath = apiPath.replace(`{${endpoint.pathParams[0]}}`, parentId);
657
+ }
658
+ // The endpoint takes an array. A single object is wrapped, so importing
659
+ // one record reads the same as importing many.
660
+ let records = [];
661
+ if (flags.file) {
662
+ const fsModule = await import('node:fs');
663
+ try {
664
+ const content = JSON.parse(fsModule.readFileSync(flags.file, 'utf-8'));
665
+ records = Array.isArray(content) ? content : [content];
666
+ }
667
+ catch {
668
+ this.error(`Failed to read file: ${flags.file}`);
669
+ }
670
+ }
671
+ else if (flags.data) {
672
+ try {
673
+ const content = JSON.parse(flags.data);
674
+ records = Array.isArray(content) ? content : [content];
675
+ }
676
+ catch {
677
+ this.error('Invalid JSON in --data');
678
+ }
679
+ }
680
+ else {
681
+ this.error('Import requires --file or --data holding a JSON array of records');
682
+ }
683
+ if (records.length === 0)
684
+ this.error('Nothing to import: the input is an empty array');
685
+ const params = { format: 'json' };
686
+ if (flags.mode)
687
+ params.mode = flags.mode;
688
+ if (flags.reference)
689
+ params.reference = flags.reference;
690
+ if (flags.async)
691
+ params.async = true;
692
+ const headers = {};
693
+ if (flags['idempotency-key'])
694
+ headers['Idempotency-Key'] = flags['idempotency-key'];
695
+ if (flags['show-http-request']) {
696
+ const baseUrls = getBaseUrls(context.environment);
697
+ const queryString = '?' + Object.entries(params).map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(String(v))}`).join('&');
698
+ process.stderr.write(`\n${endpoint.method.toUpperCase()} ${baseUrls.api}${apiPath}${queryString}\n`);
699
+ process.stderr.write(`Body: [${records.length} record${records.length === 1 ? '' : 's'}]\n\n`);
700
+ }
701
+ try {
702
+ const response = await apiRequest(endpoint.method, apiPath, {
703
+ contextName: flags.context,
704
+ data: records,
705
+ headers,
706
+ params,
707
+ });
708
+ this.printImportRun(response.data, flags);
709
+ }
710
+ catch (error) {
711
+ if (error instanceof ApiError) {
712
+ this.error(`API Error (${error.status}): ${error.message}`);
713
+ }
714
+ throw error;
715
+ }
716
+ }
717
+ /** Renders an import run: its counts, then whatever the server refused. */
718
+ printImportRun(run, flags) {
719
+ if (flags.output === 'json') {
720
+ this.log(JSON.stringify(run, null, 2));
721
+ return;
722
+ }
723
+ const record = (run ?? {});
724
+ const count = (key) => (typeof record[key] === 'number' ? record[key] : 0);
725
+ const id = record.id ? String(record.id) : '';
726
+ this.log(`Import ${id} - ${String(record.status ?? 'UNKNOWN')}${record.async ? ' (background)' : ''}`);
727
+ this.log(` ${count('inputSize')} submitted, ${count('createdCount')} created, ${count('updatedCount')} updated, ${count('unchangedCount')} unchanged`);
728
+ if (count('errorCount') > 0)
729
+ this.log(` ${count('errorCount')} not applied: ${count('refusedCount')} refused, ${count('failedCount')} failed`);
730
+ if (count('warningCount') > 0)
731
+ this.log(` ${count('warningCount')} applied with a warning`);
732
+ // errorLog is keyed by the record's identifier, then by field name.
733
+ const errorLog = record.errorLog;
734
+ if (errorLog && Object.keys(errorLog).length > 0) {
735
+ this.log('');
736
+ for (const [key, fields] of Object.entries(errorLog)) {
737
+ for (const [field, messages] of Object.entries(fields ?? {})) {
738
+ for (const message of messages ?? [])
739
+ this.log(` ${key} ${field}: ${message}`);
740
+ }
741
+ }
742
+ }
743
+ if (record.async && id) {
744
+ this.log('');
745
+ this.log(`Follow it with: aderis imports get ${id}`);
746
+ }
747
+ }
609
748
  async runExport(flags) {
610
749
  const context = flags.context ? getContext(flags.context) : getCurrentContext();
611
750
  if (!context)
@@ -784,9 +923,9 @@ export default class Templates extends Command {
784
923
  throw error;
785
924
  }
786
925
  }
787
- async runNestedImport(suffix, parentId, flags) {
926
+ async runNestedUpsert(suffix, parentId, flags) {
788
927
  if (!parentId) {
789
- this.error(`Missing required argument: id. Usage: aderis templates import-${suffix} <parent-id> --file data.json`);
928
+ this.error(`Missing required argument: id. Usage: aderis templates upsert-${suffix} <parent-id> --file data.json`);
790
929
  }
791
930
  const context = flags.context ? getContext(flags.context) : getCurrentContext();
792
931
  if (!context)
@@ -851,12 +990,12 @@ export default class Templates extends Command {
851
990
  items = [item];
852
991
  }
853
992
  else {
854
- this.error(`Import requires --file, --data, or --set flags`);
993
+ this.error('Upsert requires --file, --data, or --set flags');
855
994
  }
856
995
  const createEndpoint = ENDPOINTS[`create-${suffix}`];
857
996
  const updateEndpoint = ENDPOINTS[`update-${suffix}`];
858
997
  if (!createEndpoint || !updateEndpoint) {
859
- this.error(`Import requires both create-${suffix} and update-${suffix} endpoints`);
998
+ this.error(`Upsert requires both create-${suffix} and update-${suffix} endpoints`);
860
999
  }
861
1000
  // Build the base path with parent ID (first path param)
862
1001
  const firstParam = createEndpoint.pathParams[0];
@@ -27,10 +27,19 @@ export default class Tenants 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;