@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/item-categories', summary: 'Get all item categories with pagination', pathParams: [], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
12
15
  'create': { method: 'POST', path: '/v1/item-categories', summary: 'Create a new item category', pathParams: [], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
@@ -21,7 +24,7 @@ export default class ItemCategories extends Command {
21
24
  '<%= config.bin %> item-categories get <id>',
22
25
  '<%= config.bin %> item-categories create --data \'{...}\'',
23
26
  '<%= config.bin %> item-categories update <id> --set field=value',
24
- '<%= config.bin %> item-categories import --file data.json',
27
+ '<%= config.bin %> item-categories upsert --file data.json',
25
28
  '<%= config.bin %> item-categories export --csv > item-categories.csv',
26
29
  ];
27
30
  static args = {
@@ -30,7 +33,7 @@ export default class ItemCategories 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 ItemCategories extends Command {
50
53
  };
51
54
  async run() {
52
55
  const { args, flags } = await this.parse(ItemCategories);
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 item-categories 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 item-categories 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 ItemCategories 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 item-categories 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 ItemCategories 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 ItemCategories 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 ItemCategories 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 item-categories ${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 ItemCategories 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 item-categories import-${suffix} <parent-id> --file data.json`);
920
+ this.error(`Missing required argument: id. Usage: aderis item-categories 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 ItemCategories 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];
@@ -14,6 +14,10 @@ export default class Items 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
  page: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
18
22
  limit: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
19
23
  include: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
@@ -27,10 +31,19 @@ export default class Items extends Command {
27
31
  'show-http-request': import("@oclif/core/interfaces").BooleanFlag<boolean>;
28
32
  };
29
33
  run(): Promise<void>;
30
- 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;
31
44
  private runExport;
32
45
  private runCamt053Import;
33
- private runNestedImport;
46
+ private runNestedUpsert;
34
47
  private parseFilterValue;
35
48
  /** The page line under a table: which page, how many, and any sums the API returned. */
36
49
  private printPageSummary;
@@ -1,18 +1,22 @@
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 = [];
9
- const SUBCOMMANDS = [...["list", "create", "get", "update", "delete"], ...(HAS_IMPORT ? ['import'] : []), ...(HAS_EXPORT ? ['export'] : []), ...NESTED_IMPORTS.map(n => `import-${n}`)];
10
+ const SERVER_IMPORTS = ["import"];
11
+ const NESTED_UPSERTS = [];
12
+ const SUBCOMMANDS = [...["list", "create", "get", "update", "delete", "import"], ...(HAS_UPSERT ? ['upsert'] : []), ...(HAS_EXPORT ? ['export'] : []), ...NESTED_UPSERTS.map(n => `upsert-${n}`)];
10
13
  const ENDPOINTS = {
11
14
  'list': { method: 'GET', path: '/v1/items', summary: 'Get all items with pagination', pathParams: [], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
12
- 'create': { method: 'POST', path: '/v1/items', summary: 'Create a new item', pathParams: [], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: ['tagIds', 'tagCodes'] },
15
+ 'create': { method: 'POST', path: '/v1/items', summary: 'Create a new item', pathParams: [], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: ['replacedByIds', 'tagIds', 'tagCodes'] },
13
16
  'get': { method: 'GET', path: '/v1/items/{id}', summary: 'Get an item by ID', pathParams: ['id'], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
14
- 'update': { method: 'PATCH', path: '/v1/items/{id}', summary: 'Update an item', pathParams: ['id'], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: ['tagIds', 'tagCodes'] },
17
+ 'update': { method: 'PATCH', path: '/v1/items/{id}', summary: 'Update an item', pathParams: ['id'], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: ['replacedByIds', 'tagIds', 'tagCodes'] },
15
18
  'delete': { method: 'DELETE', path: '/v1/items/{id}', summary: 'Delete an item', pathParams: ['id'], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
19
+ 'import': { method: 'POST', path: '/v1/items/import', summary: 'Import items', pathParams: [], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
16
20
  };
17
21
  export default class Items extends Command {
18
22
  static description = 'Manage items';
@@ -21,7 +25,7 @@ export default class Items extends Command {
21
25
  '<%= config.bin %> items get <id>',
22
26
  '<%= config.bin %> items create --data \'{...}\'',
23
27
  '<%= config.bin %> items update <id> --set field=value',
24
- '<%= config.bin %> items import --file data.json',
28
+ '<%= config.bin %> items import --file data.json --mode upsert',
25
29
  '<%= config.bin %> items export --csv > items.csv',
26
30
  ];
27
31
  static args = {
@@ -30,12 +34,16 @@ export default class Items extends Command {
30
34
  };
31
35
  static flags = {
32
36
  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'] }),
37
+ output: Flags.string({ char: 'o', description: 'Output format (default: table for upsert, json for other commands)', options: ['json', 'table', 'csv'] }),
34
38
  table: Flags.boolean({ char: 't', description: 'Output as table (shortcut for --output table)' }),
35
39
  csv: Flags.boolean({ description: 'Output as CSV (shortcut for --output csv)' }),
36
40
  data: Flags.string({ char: 'd', description: 'JSON data for request body' }),
37
41
  file: Flags.string({ char: 'f', description: 'Read request body from file' }),
38
42
  set: Flags.string({ char: 's', description: 'Set individual field (e.g. --set firstName=John)', multiple: true }),
43
+ 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'] }),
44
+ reference: Flags.string({ description: 'Caller-defined text stored on the import run, for tracking and filtering' }),
45
+ async: Flags.boolean({ description: 'Import in the background: answers with a PENDING run to follow via "aderis imports get <id>"' }),
46
+ 'idempotency-key': Flags.string({ description: 'Repeating a key returns the earlier import run unchanged and imports nothing' }),
39
47
  page: Flags.string({ description: 'Page number' }),
40
48
  limit: Flags.string({ description: 'Items per page' }),
41
49
  include: Flags.string({ description: 'Relations to include' }),
@@ -50,11 +58,26 @@ export default class Items extends Command {
50
58
  };
51
59
  async run() {
52
60
  const { args, flags } = await this.parse(Items);
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);
61
+ // Bulk actions. 'import' is the API's own endpoint: one request, answered
62
+ // by a run that records what happened to every record. 'upsert' is the CLI
63
+ // looping create/update. A resource has one or the other, never both.
64
+ if (args.action === 'upsert') {
65
+ if (!HAS_UPSERT) {
66
+ this.error(SERVER_IMPORTS.includes('import')
67
+ ? 'This resource is imported by the API. Use: aderis items import --file data.json'
68
+ : 'Upsert needs both a create and an update endpoint, which this resource does not have');
69
+ }
70
+ await this.runUpsert(flags);
71
+ return;
72
+ }
73
+ if (args.action.startsWith('upsert-')) {
74
+ const suffix = args.action.replace('upsert-', '');
75
+ if (!NESTED_UPSERTS.includes(suffix)) {
76
+ this.error(SERVER_IMPORTS.includes('import-' + suffix)
77
+ ? `That resource is imported by the API. Use: aderis items import-${suffix} <id> --file data.json`
78
+ : `Unknown action: ${args.action}. Available: ${SUBCOMMANDS.join(', ')}`);
79
+ }
80
+ await this.runNestedUpsert(suffix, args.id, flags);
58
81
  return;
59
82
  }
60
83
  // Handle export action specially
@@ -71,12 +94,17 @@ export default class Items extends Command {
71
94
  await this.runCamt053Import(flags);
72
95
  return;
73
96
  }
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;
97
+ if (SERVER_IMPORTS.includes(args.action)) {
98
+ await this.runServerImport(args.action, args.id, flags);
99
+ return;
100
+ }
101
+ // 'import' used to name the CLI's create/update loop on every resource. It
102
+ // now names the API endpoint, which most resources do not have.
103
+ if (args.action === 'import' || args.action.startsWith('import-')) {
104
+ const suffix = args.action === 'import' ? '' : '-' + args.action.replace('import-', '');
105
+ const loops = args.action === 'import' ? HAS_UPSERT : NESTED_UPSERTS.includes(args.action.replace('import-', ''));
106
+ if (loops) {
107
+ this.error(`This resource has no import endpoint. Use: aderis items upsert${suffix}${suffix ? ' <id>' : ''} --file data.json`);
80
108
  }
81
109
  }
82
110
  const endpoint = ENDPOINTS[args.action];
@@ -391,7 +419,7 @@ export default class Items extends Command {
391
419
  throw error;
392
420
  }
393
421
  }
394
- async runImport(flags) {
422
+ async runUpsert(flags) {
395
423
  const context = flags.context ? getContext(flags.context) : getCurrentContext();
396
424
  if (!context)
397
425
  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 +483,12 @@ export default class Items extends Command {
455
483
  items = [item];
456
484
  }
457
485
  else {
458
- this.error('Import requires --file, --data, or --set flags');
486
+ this.error('Upsert requires --file, --data, or --set flags');
459
487
  }
460
488
  const createEndpoint = ENDPOINTS['create'];
461
489
  const updateEndpoint = ENDPOINTS['update'];
462
490
  if (!createEndpoint || !updateEndpoint) {
463
- this.error('Import requires both create and update endpoints');
491
+ this.error('Upsert requires both create and update endpoints');
464
492
  }
465
493
  // Helper to extract identifier from item (id, code, or xxxCode)
466
494
  const getItemIdentifier = (item) => {
@@ -603,6 +631,117 @@ export default class Items extends Command {
603
631
  this.log('');
604
632
  this.log(`Summary: ${created} created, ${updated} updated, ${errors.length} failed`);
605
633
  }
634
+ /**
635
+ * The API's own import: the whole array goes up in one request and comes
636
+ * back as an import run, which records what happened to every record. A bad
637
+ * record lands in errorLog and the rest are still applied, and the run stays
638
+ * readable afterwards with: aderis imports get <id>.
639
+ */
640
+ async runServerImport(action, parentId, flags) {
641
+ const endpoint = ENDPOINTS[action];
642
+ if (!endpoint)
643
+ this.error(`Unknown action: ${action}. Available: ${SUBCOMMANDS.join(', ')}`);
644
+ const context = flags.context ? getContext(flags.context) : getCurrentContext();
645
+ if (!context)
646
+ this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
647
+ if (!hasCredentials(context))
648
+ this.error(missingCredentialsMessage(context));
649
+ let apiPath = endpoint.path;
650
+ if (endpoint.pathParams.length > 0) {
651
+ if (!parentId)
652
+ this.error(`Missing required argument: id. Usage: aderis items ${action} <parent-id> --file data.json`);
653
+ apiPath = apiPath.replace(`{${endpoint.pathParams[0]}}`, parentId);
654
+ }
655
+ // The endpoint takes an array. A single object is wrapped, so importing
656
+ // one record reads the same as importing many.
657
+ let records = [];
658
+ if (flags.file) {
659
+ const fsModule = await import('node:fs');
660
+ try {
661
+ const content = JSON.parse(fsModule.readFileSync(flags.file, 'utf-8'));
662
+ records = Array.isArray(content) ? content : [content];
663
+ }
664
+ catch {
665
+ this.error(`Failed to read file: ${flags.file}`);
666
+ }
667
+ }
668
+ else if (flags.data) {
669
+ try {
670
+ const content = JSON.parse(flags.data);
671
+ records = Array.isArray(content) ? content : [content];
672
+ }
673
+ catch {
674
+ this.error('Invalid JSON in --data');
675
+ }
676
+ }
677
+ else {
678
+ this.error('Import requires --file or --data holding a JSON array of records');
679
+ }
680
+ if (records.length === 0)
681
+ this.error('Nothing to import: the input is an empty array');
682
+ const params = { format: 'json' };
683
+ if (flags.mode)
684
+ params.mode = flags.mode;
685
+ if (flags.reference)
686
+ params.reference = flags.reference;
687
+ if (flags.async)
688
+ params.async = true;
689
+ const headers = {};
690
+ if (flags['idempotency-key'])
691
+ headers['Idempotency-Key'] = flags['idempotency-key'];
692
+ if (flags['show-http-request']) {
693
+ const baseUrls = getBaseUrls(context.environment);
694
+ const queryString = '?' + Object.entries(params).map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(String(v))}`).join('&');
695
+ process.stderr.write(`\n${endpoint.method.toUpperCase()} ${baseUrls.api}${apiPath}${queryString}\n`);
696
+ process.stderr.write(`Body: [${records.length} record${records.length === 1 ? '' : 's'}]\n\n`);
697
+ }
698
+ try {
699
+ const response = await apiRequest(endpoint.method, apiPath, {
700
+ contextName: flags.context,
701
+ data: records,
702
+ headers,
703
+ params,
704
+ });
705
+ this.printImportRun(response.data, flags);
706
+ }
707
+ catch (error) {
708
+ if (error instanceof ApiError) {
709
+ this.error(`API Error (${error.status}): ${error.message}`);
710
+ }
711
+ throw error;
712
+ }
713
+ }
714
+ /** Renders an import run: its counts, then whatever the server refused. */
715
+ printImportRun(run, flags) {
716
+ if (flags.output === 'json') {
717
+ this.log(JSON.stringify(run, null, 2));
718
+ return;
719
+ }
720
+ const record = (run ?? {});
721
+ const count = (key) => (typeof record[key] === 'number' ? record[key] : 0);
722
+ const id = record.id ? String(record.id) : '';
723
+ this.log(`Import ${id} - ${String(record.status ?? 'UNKNOWN')}${record.async ? ' (background)' : ''}`);
724
+ this.log(` ${count('inputSize')} submitted, ${count('createdCount')} created, ${count('updatedCount')} updated, ${count('unchangedCount')} unchanged`);
725
+ if (count('errorCount') > 0)
726
+ this.log(` ${count('errorCount')} not applied: ${count('refusedCount')} refused, ${count('failedCount')} failed`);
727
+ if (count('warningCount') > 0)
728
+ this.log(` ${count('warningCount')} applied with a warning`);
729
+ // errorLog is keyed by the record's identifier, then by field name.
730
+ const errorLog = record.errorLog;
731
+ if (errorLog && Object.keys(errorLog).length > 0) {
732
+ this.log('');
733
+ for (const [key, fields] of Object.entries(errorLog)) {
734
+ for (const [field, messages] of Object.entries(fields ?? {})) {
735
+ for (const message of messages ?? [])
736
+ this.log(` ${key} ${field}: ${message}`);
737
+ }
738
+ }
739
+ }
740
+ if (record.async && id) {
741
+ this.log('');
742
+ this.log(`Follow it with: aderis imports get ${id}`);
743
+ }
744
+ }
606
745
  async runExport(flags) {
607
746
  const context = flags.context ? getContext(flags.context) : getCurrentContext();
608
747
  if (!context)
@@ -781,9 +920,9 @@ export default class Items extends Command {
781
920
  throw error;
782
921
  }
783
922
  }
784
- async runNestedImport(suffix, parentId, flags) {
923
+ async runNestedUpsert(suffix, parentId, flags) {
785
924
  if (!parentId) {
786
- this.error(`Missing required argument: id. Usage: aderis items import-${suffix} <parent-id> --file data.json`);
925
+ this.error(`Missing required argument: id. Usage: aderis items upsert-${suffix} <parent-id> --file data.json`);
787
926
  }
788
927
  const context = flags.context ? getContext(flags.context) : getCurrentContext();
789
928
  if (!context)
@@ -848,12 +987,12 @@ export default class Items extends Command {
848
987
  items = [item];
849
988
  }
850
989
  else {
851
- this.error(`Import requires --file, --data, or --set flags`);
990
+ this.error('Upsert requires --file, --data, or --set flags');
852
991
  }
853
992
  const createEndpoint = ENDPOINTS[`create-${suffix}`];
854
993
  const updateEndpoint = ENDPOINTS[`update-${suffix}`];
855
994
  if (!createEndpoint || !updateEndpoint) {
856
- this.error(`Import requires both create-${suffix} and update-${suffix} endpoints`);
995
+ this.error(`Upsert requires both create-${suffix} and update-${suffix} endpoints`);
857
996
  }
858
997
  // Build the base path with parent ID (first path param)
859
998
  const firstParam = createEndpoint.pathParams[0];
@@ -27,10 +27,19 @@ export default class JournalLines 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;