@aderis-erp/cli 1.1.1 → 1.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/commands/access-groups.d.ts +8 -0
- package/dist/commands/access-groups.js +54 -6
- package/dist/commands/account-transaction-allocations.d.ts +8 -0
- package/dist/commands/account-transaction-allocations.js +52 -5
- package/dist/commands/account-transactions.d.ts +8 -0
- package/dist/commands/account-transactions.js +55 -7
- package/dist/commands/accounts.d.ts +8 -0
- package/dist/commands/accounts.js +52 -5
- package/dist/commands/agent-platform.d.ts +8 -0
- package/dist/commands/agent-platform.js +52 -5
- package/dist/commands/agent-runs.d.ts +8 -0
- package/dist/commands/agent-runs.js +52 -5
- package/dist/commands/analytics.d.ts +8 -0
- package/dist/commands/analytics.js +52 -5
- package/dist/commands/api-keys.d.ts +8 -0
- package/dist/commands/api-keys.js +52 -5
- package/dist/commands/async-jobs.d.ts +8 -0
- package/dist/commands/async-jobs.js +52 -5
- package/dist/commands/audit-log.d.ts +8 -0
- package/dist/commands/audit-log.js +52 -5
- package/dist/commands/bank-accounts.d.ts +8 -0
- package/dist/commands/bank-accounts.js +52 -5
- package/dist/commands/bank-integrations.d.ts +8 -0
- package/dist/commands/bank-integrations.js +52 -5
- package/dist/commands/business-partners.d.ts +9 -0
- package/dist/commands/business-partners.js +64 -7
- package/dist/commands/chat.d.ts +8 -0
- package/dist/commands/chat.js +52 -5
- package/dist/commands/credit-card-accounts.d.ts +8 -0
- package/dist/commands/credit-card-accounts.js +52 -5
- package/dist/commands/delivery-notes.d.ts +8 -0
- package/dist/commands/delivery-notes.js +52 -5
- package/dist/commands/dunning-configs.d.ts +8 -0
- package/dist/commands/dunning-configs.js +52 -5
- package/dist/commands/dunning-reminders.d.ts +8 -0
- package/dist/commands/dunning-reminders.js +52 -5
- package/dist/commands/dunning-runs.d.ts +8 -0
- package/dist/commands/dunning-runs.js +52 -5
- package/dist/commands/email-transactions.d.ts +8 -0
- package/dist/commands/email-transactions.js +52 -5
- package/dist/commands/employees.d.ts +8 -0
- package/dist/commands/employees.js +52 -5
- package/dist/commands/entity-configurations.d.ts +8 -0
- package/dist/commands/entity-configurations.js +52 -5
- package/dist/commands/event-processor-mappings.d.ts +8 -0
- package/dist/commands/event-processor-mappings.js +52 -5
- package/dist/commands/files.d.ts +8 -0
- package/dist/commands/files.js +52 -5
- package/dist/commands/health.d.ts +8 -0
- package/dist/commands/health.js +52 -5
- package/dist/commands/imports.d.ts +8 -0
- package/dist/commands/imports.js +53 -8
- package/dist/commands/inbox.d.ts +8 -0
- package/dist/commands/inbox.js +53 -7
- package/dist/commands/integration-identities.d.ts +8 -0
- package/dist/commands/integration-identities.js +52 -5
- package/dist/commands/integrations.d.ts +8 -0
- package/dist/commands/integrations.js +52 -5
- package/dist/commands/item-categories.d.ts +8 -0
- package/dist/commands/item-categories.js +52 -5
- package/dist/commands/items.d.ts +8 -0
- package/dist/commands/items.js +52 -5
- package/dist/commands/journal-lines.d.ts +8 -0
- package/dist/commands/journal-lines.js +52 -5
- package/dist/commands/journals.d.ts +8 -0
- package/dist/commands/journals.js +52 -5
- package/dist/commands/ledgers.d.ts +8 -0
- package/dist/commands/ledgers.js +52 -5
- package/dist/commands/my-account.d.ts +8 -0
- package/dist/commands/my-account.js +52 -5
- package/dist/commands/office-locations.d.ts +8 -0
- package/dist/commands/office-locations.js +52 -5
- package/dist/commands/payment-methods.d.ts +8 -0
- package/dist/commands/payment-methods.js +52 -5
- package/dist/commands/payment-runs.d.ts +8 -0
- package/dist/commands/payment-runs.js +54 -6
- package/dist/commands/payment-terms.d.ts +8 -0
- package/dist/commands/payment-terms.js +52 -5
- package/dist/commands/payments.d.ts +8 -0
- package/dist/commands/payments.js +52 -5
- package/dist/commands/payroll-runs.d.ts +8 -0
- package/dist/commands/payroll-runs.js +52 -5
- package/dist/commands/permissions.d.ts +8 -0
- package/dist/commands/permissions.js +52 -5
- package/dist/commands/price-lists.d.ts +8 -0
- package/dist/commands/price-lists.js +52 -5
- package/dist/commands/processor-mappings.d.ts +8 -0
- package/dist/commands/processor-mappings.js +52 -5
- package/dist/commands/processors.d.ts +8 -0
- package/dist/commands/processors.js +52 -5
- package/dist/commands/purchase-order-types.d.ts +8 -0
- package/dist/commands/purchase-order-types.js +52 -5
- package/dist/commands/purchase-orders.d.ts +8 -0
- package/dist/commands/purchase-orders.js +52 -5
- package/dist/commands/reports.d.ts +8 -0
- package/dist/commands/reports.js +52 -5
- package/dist/commands/roles.d.ts +8 -0
- package/dist/commands/roles.js +52 -5
- package/dist/commands/salary-types.d.ts +8 -0
- package/dist/commands/salary-types.js +52 -5
- package/dist/commands/sales-invoices.d.ts +10 -0
- package/dist/commands/sales-invoices.js +62 -6
- package/dist/commands/sales-orders.d.ts +8 -0
- package/dist/commands/sales-orders.js +52 -5
- package/dist/commands/saved-views.d.ts +8 -0
- package/dist/commands/saved-views.js +52 -5
- package/dist/commands/scheduled-processor-mappings.d.ts +8 -0
- package/dist/commands/scheduled-processor-mappings.js +52 -5
- package/dist/commands/schedules.d.ts +8 -0
- package/dist/commands/schedules.js +52 -5
- package/dist/commands/tags.d.ts +8 -0
- package/dist/commands/tags.js +52 -5
- package/dist/commands/tax-codes.d.ts +8 -0
- package/dist/commands/tax-codes.js +52 -5
- package/dist/commands/tax-matrix.d.ts +8 -0
- package/dist/commands/tax-matrix.js +52 -5
- package/dist/commands/templates.d.ts +8 -0
- package/dist/commands/templates.js +52 -5
- package/dist/commands/tenants.d.ts +8 -0
- package/dist/commands/tenants.js +52 -5
- package/dist/commands/tools.d.ts +8 -0
- package/dist/commands/tools.js +52 -5
- package/dist/commands/users.d.ts +8 -0
- package/dist/commands/users.js +52 -5
- package/dist/commands/vat-declarations.d.ts +8 -0
- package/dist/commands/vat-declarations.js +52 -5
- package/dist/commands/vendor-invoices.d.ts +9 -0
- package/dist/commands/vendor-invoices.js +60 -8
- package/dist/commands/webhooks.d.ts +8 -0
- package/dist/commands/webhooks.js +52 -5
- package/dist/commands/workflows.d.ts +8 -0
- package/dist/commands/workflows.js +52 -5
- package/oclif.manifest.json +433 -10
- package/package.json +1 -1
|
@@ -42,6 +42,7 @@ export default class IntegrationIdentities extends Command {
|
|
|
42
42
|
query: Flags.string({ description: 'Additional query params as JSON' }),
|
|
43
43
|
fields: Flags.string({ description: 'Comma-separated list of fields to return, applied by the API (e.g. --fields=id,name,status)' }),
|
|
44
44
|
sanitize: Flags.boolean({ description: 'Remove null values, audit fields, and duplicate UUIDs from output' }),
|
|
45
|
+
meta: Flags.boolean({ description: 'Keep the API envelope in JSON output: data plus page, totals and sums' }),
|
|
45
46
|
'show-http-request': Flags.boolean({ description: 'Show HTTP request details (method, URL, body)' }),
|
|
46
47
|
};
|
|
47
48
|
async run() {
|
|
@@ -334,9 +335,15 @@ export default class IntegrationIdentities extends Command {
|
|
|
334
335
|
}
|
|
335
336
|
catch { /* keep as string */ }
|
|
336
337
|
}
|
|
337
|
-
//
|
|
338
|
+
// A paginated answer is { data, meta, links, totals }. The records are
|
|
339
|
+
// unwrapped for output, but what the API said about the page is kept:
|
|
340
|
+
// dropping it silently let a script read one page as the whole result
|
|
341
|
+
// (AderisERP/product#61).
|
|
342
|
+
let envelope;
|
|
338
343
|
if (output && typeof output === 'object' && !Array.isArray(output) && 'data' in output && Array.isArray(output.data)) {
|
|
339
|
-
|
|
344
|
+
const page = output;
|
|
345
|
+
envelope = page;
|
|
346
|
+
output = page.data;
|
|
340
347
|
}
|
|
341
348
|
// For table/csv on non-array responses, auto-extract the primary array
|
|
342
349
|
// e.g., { payments: [...], total: 3 } → extract payments array
|
|
@@ -353,12 +360,24 @@ export default class IntegrationIdentities extends Command {
|
|
|
353
360
|
output = this.sanitizeOutput(output);
|
|
354
361
|
}
|
|
355
362
|
const fieldList = flags.fields?.split(',').map(f => f.trim());
|
|
356
|
-
if (
|
|
363
|
+
if (envelope)
|
|
364
|
+
this.warnShortPage(envelope, flags.limit);
|
|
365
|
+
if (flags.csv || flags.output === 'csv') {
|
|
357
366
|
this.printCsv(output, fieldList);
|
|
358
|
-
|
|
367
|
+
}
|
|
368
|
+
else if (flags.table || flags.output === 'table') {
|
|
359
369
|
this.printTable(output, fieldList);
|
|
360
|
-
|
|
370
|
+
if (envelope)
|
|
371
|
+
this.printPageSummary(envelope);
|
|
372
|
+
}
|
|
373
|
+
else if (envelope && flags.meta) {
|
|
374
|
+
// The whole envelope, for a caller that asked for it; the default stays
|
|
375
|
+
// a bare array so existing scripts are unaffected.
|
|
376
|
+
this.log(JSON.stringify({ ...envelope, data: output }, null, 2));
|
|
377
|
+
}
|
|
378
|
+
else {
|
|
361
379
|
this.log(JSON.stringify(output, null, 2));
|
|
380
|
+
}
|
|
362
381
|
}
|
|
363
382
|
catch (error) {
|
|
364
383
|
if (error instanceof ApiError) {
|
|
@@ -987,6 +1006,34 @@ export default class IntegrationIdentities extends Command {
|
|
|
987
1006
|
return `\$${op}`;
|
|
988
1007
|
return opRe.test(rest) ? `\$${op}:${this.parseFilterValue(rest)}` : `\$${op}:${rest}`;
|
|
989
1008
|
}
|
|
1009
|
+
/** The page line under a table: which page, how many, and any sums the API returned. */
|
|
1010
|
+
printPageSummary(envelope) {
|
|
1011
|
+
const meta = envelope.meta;
|
|
1012
|
+
if (meta && typeof meta.currentPage === 'number' && typeof meta.totalPages === 'number') {
|
|
1013
|
+
const shown = Array.isArray(envelope.data) ? envelope.data.length : 0;
|
|
1014
|
+
this.log(`
|
|
1015
|
+
Page ${meta.currentPage}/${meta.totalPages} — ${shown} of ${meta.totalItems ?? '?'} records`);
|
|
1016
|
+
}
|
|
1017
|
+
for (const total of envelope.totals ?? []) {
|
|
1018
|
+
const { currency, ...sums } = total;
|
|
1019
|
+
const parts = Object.entries(sums).map(([column, value]) => `${column} ${value}`).join(', ');
|
|
1020
|
+
this.log(`Total ${currency ?? ''}: ${parts}`.trim());
|
|
1021
|
+
}
|
|
1022
|
+
}
|
|
1023
|
+
/**
|
|
1024
|
+
* The API caps how many records a page may hold. Asking for more and getting
|
|
1025
|
+
* fewer looks like "that is everything" unless it is said out loud.
|
|
1026
|
+
*/
|
|
1027
|
+
warnShortPage(envelope, requestedLimit) {
|
|
1028
|
+
const asked = requestedLimit === undefined ? undefined : Number(requestedLimit);
|
|
1029
|
+
const perPage = envelope.meta?.itemsPerPage;
|
|
1030
|
+
if (asked === undefined || Number.isNaN(asked) || typeof perPage !== 'number' || perPage >= asked)
|
|
1031
|
+
return;
|
|
1032
|
+
const pages = envelope.meta?.totalPages;
|
|
1033
|
+
const more = typeof pages === 'number' && pages > 1 ? ` Use --page, or the export action for every page.` : '';
|
|
1034
|
+
process.stderr.write(`! Asked for ${asked} records per page; the API returned at most ${perPage}.${more}
|
|
1035
|
+
`);
|
|
1036
|
+
}
|
|
990
1037
|
sanitizeOutput(data) {
|
|
991
1038
|
const auditFields = ['_type', 'tenantId', 'createdAt', 'updatedAt', 'createdBy', 'updatedBy'];
|
|
992
1039
|
const uuidRegex = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i;
|
|
@@ -24,6 +24,7 @@ export default class Integrations extends Command {
|
|
|
24
24
|
query: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
25
25
|
fields: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
26
26
|
sanitize: import("@oclif/core/interfaces").BooleanFlag<boolean>;
|
|
27
|
+
meta: import("@oclif/core/interfaces").BooleanFlag<boolean>;
|
|
27
28
|
'show-http-request': import("@oclif/core/interfaces").BooleanFlag<boolean>;
|
|
28
29
|
};
|
|
29
30
|
run(): Promise<void>;
|
|
@@ -32,6 +33,13 @@ export default class Integrations extends Command {
|
|
|
32
33
|
private runCamt053Import;
|
|
33
34
|
private runNestedImport;
|
|
34
35
|
private parseFilterValue;
|
|
36
|
+
/** The page line under a table: which page, how many, and any sums the API returned. */
|
|
37
|
+
private printPageSummary;
|
|
38
|
+
/**
|
|
39
|
+
* The API caps how many records a page may hold. Asking for more and getting
|
|
40
|
+
* fewer looks like "that is everything" unless it is said out loud.
|
|
41
|
+
*/
|
|
42
|
+
private warnShortPage;
|
|
35
43
|
private sanitizeOutput;
|
|
36
44
|
private getColumns;
|
|
37
45
|
private getValue;
|
|
@@ -40,6 +40,7 @@ export default class Integrations extends Command {
|
|
|
40
40
|
query: Flags.string({ description: 'Additional query params as JSON' }),
|
|
41
41
|
fields: Flags.string({ description: 'Comma-separated list of fields to return, applied by the API (e.g. --fields=id,name,status)' }),
|
|
42
42
|
sanitize: Flags.boolean({ description: 'Remove null values, audit fields, and duplicate UUIDs from output' }),
|
|
43
|
+
meta: Flags.boolean({ description: 'Keep the API envelope in JSON output: data plus page, totals and sums' }),
|
|
43
44
|
'show-http-request': Flags.boolean({ description: 'Show HTTP request details (method, URL, body)' }),
|
|
44
45
|
};
|
|
45
46
|
async run() {
|
|
@@ -332,9 +333,15 @@ export default class Integrations extends Command {
|
|
|
332
333
|
}
|
|
333
334
|
catch { /* keep as string */ }
|
|
334
335
|
}
|
|
335
|
-
//
|
|
336
|
+
// A paginated answer is { data, meta, links, totals }. The records are
|
|
337
|
+
// unwrapped for output, but what the API said about the page is kept:
|
|
338
|
+
// dropping it silently let a script read one page as the whole result
|
|
339
|
+
// (AderisERP/product#61).
|
|
340
|
+
let envelope;
|
|
336
341
|
if (output && typeof output === 'object' && !Array.isArray(output) && 'data' in output && Array.isArray(output.data)) {
|
|
337
|
-
|
|
342
|
+
const page = output;
|
|
343
|
+
envelope = page;
|
|
344
|
+
output = page.data;
|
|
338
345
|
}
|
|
339
346
|
// For table/csv on non-array responses, auto-extract the primary array
|
|
340
347
|
// e.g., { payments: [...], total: 3 } → extract payments array
|
|
@@ -351,12 +358,24 @@ export default class Integrations extends Command {
|
|
|
351
358
|
output = this.sanitizeOutput(output);
|
|
352
359
|
}
|
|
353
360
|
const fieldList = flags.fields?.split(',').map(f => f.trim());
|
|
354
|
-
if (
|
|
361
|
+
if (envelope)
|
|
362
|
+
this.warnShortPage(envelope, flags.limit);
|
|
363
|
+
if (flags.csv || flags.output === 'csv') {
|
|
355
364
|
this.printCsv(output, fieldList);
|
|
356
|
-
|
|
365
|
+
}
|
|
366
|
+
else if (flags.table || flags.output === 'table') {
|
|
357
367
|
this.printTable(output, fieldList);
|
|
358
|
-
|
|
368
|
+
if (envelope)
|
|
369
|
+
this.printPageSummary(envelope);
|
|
370
|
+
}
|
|
371
|
+
else if (envelope && flags.meta) {
|
|
372
|
+
// The whole envelope, for a caller that asked for it; the default stays
|
|
373
|
+
// a bare array so existing scripts are unaffected.
|
|
374
|
+
this.log(JSON.stringify({ ...envelope, data: output }, null, 2));
|
|
375
|
+
}
|
|
376
|
+
else {
|
|
359
377
|
this.log(JSON.stringify(output, null, 2));
|
|
378
|
+
}
|
|
360
379
|
}
|
|
361
380
|
catch (error) {
|
|
362
381
|
if (error instanceof ApiError) {
|
|
@@ -985,6 +1004,34 @@ export default class Integrations extends Command {
|
|
|
985
1004
|
return `\$${op}`;
|
|
986
1005
|
return opRe.test(rest) ? `\$${op}:${this.parseFilterValue(rest)}` : `\$${op}:${rest}`;
|
|
987
1006
|
}
|
|
1007
|
+
/** The page line under a table: which page, how many, and any sums the API returned. */
|
|
1008
|
+
printPageSummary(envelope) {
|
|
1009
|
+
const meta = envelope.meta;
|
|
1010
|
+
if (meta && typeof meta.currentPage === 'number' && typeof meta.totalPages === 'number') {
|
|
1011
|
+
const shown = Array.isArray(envelope.data) ? envelope.data.length : 0;
|
|
1012
|
+
this.log(`
|
|
1013
|
+
Page ${meta.currentPage}/${meta.totalPages} — ${shown} of ${meta.totalItems ?? '?'} records`);
|
|
1014
|
+
}
|
|
1015
|
+
for (const total of envelope.totals ?? []) {
|
|
1016
|
+
const { currency, ...sums } = total;
|
|
1017
|
+
const parts = Object.entries(sums).map(([column, value]) => `${column} ${value}`).join(', ');
|
|
1018
|
+
this.log(`Total ${currency ?? ''}: ${parts}`.trim());
|
|
1019
|
+
}
|
|
1020
|
+
}
|
|
1021
|
+
/**
|
|
1022
|
+
* The API caps how many records a page may hold. Asking for more and getting
|
|
1023
|
+
* fewer looks like "that is everything" unless it is said out loud.
|
|
1024
|
+
*/
|
|
1025
|
+
warnShortPage(envelope, requestedLimit) {
|
|
1026
|
+
const asked = requestedLimit === undefined ? undefined : Number(requestedLimit);
|
|
1027
|
+
const perPage = envelope.meta?.itemsPerPage;
|
|
1028
|
+
if (asked === undefined || Number.isNaN(asked) || typeof perPage !== 'number' || perPage >= asked)
|
|
1029
|
+
return;
|
|
1030
|
+
const pages = envelope.meta?.totalPages;
|
|
1031
|
+
const more = typeof pages === 'number' && pages > 1 ? ` Use --page, or the export action for every page.` : '';
|
|
1032
|
+
process.stderr.write(`! Asked for ${asked} records per page; the API returned at most ${perPage}.${more}
|
|
1033
|
+
`);
|
|
1034
|
+
}
|
|
988
1035
|
sanitizeOutput(data) {
|
|
989
1036
|
const auditFields = ['_type', 'tenantId', 'createdAt', 'updatedAt', 'createdBy', 'updatedBy'];
|
|
990
1037
|
const uuidRegex = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i;
|
|
@@ -23,6 +23,7 @@ export default class ItemCategories extends Command {
|
|
|
23
23
|
query: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
24
24
|
fields: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
25
25
|
sanitize: import("@oclif/core/interfaces").BooleanFlag<boolean>;
|
|
26
|
+
meta: import("@oclif/core/interfaces").BooleanFlag<boolean>;
|
|
26
27
|
'show-http-request': import("@oclif/core/interfaces").BooleanFlag<boolean>;
|
|
27
28
|
};
|
|
28
29
|
run(): Promise<void>;
|
|
@@ -31,6 +32,13 @@ export default class ItemCategories extends Command {
|
|
|
31
32
|
private runCamt053Import;
|
|
32
33
|
private runNestedImport;
|
|
33
34
|
private parseFilterValue;
|
|
35
|
+
/** The page line under a table: which page, how many, and any sums the API returned. */
|
|
36
|
+
private printPageSummary;
|
|
37
|
+
/**
|
|
38
|
+
* The API caps how many records a page may hold. Asking for more and getting
|
|
39
|
+
* fewer looks like "that is everything" unless it is said out loud.
|
|
40
|
+
*/
|
|
41
|
+
private warnShortPage;
|
|
34
42
|
private sanitizeOutput;
|
|
35
43
|
private getColumns;
|
|
36
44
|
private getValue;
|
|
@@ -45,6 +45,7 @@ export default class ItemCategories extends Command {
|
|
|
45
45
|
query: Flags.string({ description: 'Additional query params as JSON' }),
|
|
46
46
|
fields: Flags.string({ description: 'Comma-separated list of fields to return, applied by the API (e.g. --fields=id,name,status)' }),
|
|
47
47
|
sanitize: Flags.boolean({ description: 'Remove null values, audit fields, and duplicate UUIDs from output' }),
|
|
48
|
+
meta: Flags.boolean({ description: 'Keep the API envelope in JSON output: data plus page, totals and sums' }),
|
|
48
49
|
'show-http-request': Flags.boolean({ description: 'Show HTTP request details (method, URL, body)' }),
|
|
49
50
|
};
|
|
50
51
|
async run() {
|
|
@@ -337,9 +338,15 @@ export default class ItemCategories extends Command {
|
|
|
337
338
|
}
|
|
338
339
|
catch { /* keep as string */ }
|
|
339
340
|
}
|
|
340
|
-
//
|
|
341
|
+
// A paginated answer is { data, meta, links, totals }. The records are
|
|
342
|
+
// unwrapped for output, but what the API said about the page is kept:
|
|
343
|
+
// dropping it silently let a script read one page as the whole result
|
|
344
|
+
// (AderisERP/product#61).
|
|
345
|
+
let envelope;
|
|
341
346
|
if (output && typeof output === 'object' && !Array.isArray(output) && 'data' in output && Array.isArray(output.data)) {
|
|
342
|
-
|
|
347
|
+
const page = output;
|
|
348
|
+
envelope = page;
|
|
349
|
+
output = page.data;
|
|
343
350
|
}
|
|
344
351
|
// For table/csv on non-array responses, auto-extract the primary array
|
|
345
352
|
// e.g., { payments: [...], total: 3 } → extract payments array
|
|
@@ -356,12 +363,24 @@ export default class ItemCategories extends Command {
|
|
|
356
363
|
output = this.sanitizeOutput(output);
|
|
357
364
|
}
|
|
358
365
|
const fieldList = flags.fields?.split(',').map(f => f.trim());
|
|
359
|
-
if (
|
|
366
|
+
if (envelope)
|
|
367
|
+
this.warnShortPage(envelope, flags.limit);
|
|
368
|
+
if (flags.csv || flags.output === 'csv') {
|
|
360
369
|
this.printCsv(output, fieldList);
|
|
361
|
-
|
|
370
|
+
}
|
|
371
|
+
else if (flags.table || flags.output === 'table') {
|
|
362
372
|
this.printTable(output, fieldList);
|
|
363
|
-
|
|
373
|
+
if (envelope)
|
|
374
|
+
this.printPageSummary(envelope);
|
|
375
|
+
}
|
|
376
|
+
else if (envelope && flags.meta) {
|
|
377
|
+
// The whole envelope, for a caller that asked for it; the default stays
|
|
378
|
+
// a bare array so existing scripts are unaffected.
|
|
379
|
+
this.log(JSON.stringify({ ...envelope, data: output }, null, 2));
|
|
380
|
+
}
|
|
381
|
+
else {
|
|
364
382
|
this.log(JSON.stringify(output, null, 2));
|
|
383
|
+
}
|
|
365
384
|
}
|
|
366
385
|
catch (error) {
|
|
367
386
|
if (error instanceof ApiError) {
|
|
@@ -990,6 +1009,34 @@ export default class ItemCategories extends Command {
|
|
|
990
1009
|
return `\$${op}`;
|
|
991
1010
|
return opRe.test(rest) ? `\$${op}:${this.parseFilterValue(rest)}` : `\$${op}:${rest}`;
|
|
992
1011
|
}
|
|
1012
|
+
/** The page line under a table: which page, how many, and any sums the API returned. */
|
|
1013
|
+
printPageSummary(envelope) {
|
|
1014
|
+
const meta = envelope.meta;
|
|
1015
|
+
if (meta && typeof meta.currentPage === 'number' && typeof meta.totalPages === 'number') {
|
|
1016
|
+
const shown = Array.isArray(envelope.data) ? envelope.data.length : 0;
|
|
1017
|
+
this.log(`
|
|
1018
|
+
Page ${meta.currentPage}/${meta.totalPages} — ${shown} of ${meta.totalItems ?? '?'} records`);
|
|
1019
|
+
}
|
|
1020
|
+
for (const total of envelope.totals ?? []) {
|
|
1021
|
+
const { currency, ...sums } = total;
|
|
1022
|
+
const parts = Object.entries(sums).map(([column, value]) => `${column} ${value}`).join(', ');
|
|
1023
|
+
this.log(`Total ${currency ?? ''}: ${parts}`.trim());
|
|
1024
|
+
}
|
|
1025
|
+
}
|
|
1026
|
+
/**
|
|
1027
|
+
* The API caps how many records a page may hold. Asking for more and getting
|
|
1028
|
+
* fewer looks like "that is everything" unless it is said out loud.
|
|
1029
|
+
*/
|
|
1030
|
+
warnShortPage(envelope, requestedLimit) {
|
|
1031
|
+
const asked = requestedLimit === undefined ? undefined : Number(requestedLimit);
|
|
1032
|
+
const perPage = envelope.meta?.itemsPerPage;
|
|
1033
|
+
if (asked === undefined || Number.isNaN(asked) || typeof perPage !== 'number' || perPage >= asked)
|
|
1034
|
+
return;
|
|
1035
|
+
const pages = envelope.meta?.totalPages;
|
|
1036
|
+
const more = typeof pages === 'number' && pages > 1 ? ` Use --page, or the export action for every page.` : '';
|
|
1037
|
+
process.stderr.write(`! Asked for ${asked} records per page; the API returned at most ${perPage}.${more}
|
|
1038
|
+
`);
|
|
1039
|
+
}
|
|
993
1040
|
sanitizeOutput(data) {
|
|
994
1041
|
const auditFields = ['_type', 'tenantId', 'createdAt', 'updatedAt', 'createdBy', 'updatedBy'];
|
|
995
1042
|
const uuidRegex = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i;
|
package/dist/commands/items.d.ts
CHANGED
|
@@ -23,6 +23,7 @@ export default class Items extends Command {
|
|
|
23
23
|
query: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
24
24
|
fields: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
25
25
|
sanitize: import("@oclif/core/interfaces").BooleanFlag<boolean>;
|
|
26
|
+
meta: import("@oclif/core/interfaces").BooleanFlag<boolean>;
|
|
26
27
|
'show-http-request': import("@oclif/core/interfaces").BooleanFlag<boolean>;
|
|
27
28
|
};
|
|
28
29
|
run(): Promise<void>;
|
|
@@ -31,6 +32,13 @@ export default class Items extends Command {
|
|
|
31
32
|
private runCamt053Import;
|
|
32
33
|
private runNestedImport;
|
|
33
34
|
private parseFilterValue;
|
|
35
|
+
/** The page line under a table: which page, how many, and any sums the API returned. */
|
|
36
|
+
private printPageSummary;
|
|
37
|
+
/**
|
|
38
|
+
* The API caps how many records a page may hold. Asking for more and getting
|
|
39
|
+
* fewer looks like "that is everything" unless it is said out loud.
|
|
40
|
+
*/
|
|
41
|
+
private warnShortPage;
|
|
34
42
|
private sanitizeOutput;
|
|
35
43
|
private getColumns;
|
|
36
44
|
private getValue;
|
package/dist/commands/items.js
CHANGED
|
@@ -45,6 +45,7 @@ export default class Items extends Command {
|
|
|
45
45
|
query: Flags.string({ description: 'Additional query params as JSON' }),
|
|
46
46
|
fields: Flags.string({ description: 'Comma-separated list of fields to return, applied by the API (e.g. --fields=id,name,status)' }),
|
|
47
47
|
sanitize: Flags.boolean({ description: 'Remove null values, audit fields, and duplicate UUIDs from output' }),
|
|
48
|
+
meta: Flags.boolean({ description: 'Keep the API envelope in JSON output: data plus page, totals and sums' }),
|
|
48
49
|
'show-http-request': Flags.boolean({ description: 'Show HTTP request details (method, URL, body)' }),
|
|
49
50
|
};
|
|
50
51
|
async run() {
|
|
@@ -337,9 +338,15 @@ export default class Items extends Command {
|
|
|
337
338
|
}
|
|
338
339
|
catch { /* keep as string */ }
|
|
339
340
|
}
|
|
340
|
-
//
|
|
341
|
+
// A paginated answer is { data, meta, links, totals }. The records are
|
|
342
|
+
// unwrapped for output, but what the API said about the page is kept:
|
|
343
|
+
// dropping it silently let a script read one page as the whole result
|
|
344
|
+
// (AderisERP/product#61).
|
|
345
|
+
let envelope;
|
|
341
346
|
if (output && typeof output === 'object' && !Array.isArray(output) && 'data' in output && Array.isArray(output.data)) {
|
|
342
|
-
|
|
347
|
+
const page = output;
|
|
348
|
+
envelope = page;
|
|
349
|
+
output = page.data;
|
|
343
350
|
}
|
|
344
351
|
// For table/csv on non-array responses, auto-extract the primary array
|
|
345
352
|
// e.g., { payments: [...], total: 3 } → extract payments array
|
|
@@ -356,12 +363,24 @@ export default class Items extends Command {
|
|
|
356
363
|
output = this.sanitizeOutput(output);
|
|
357
364
|
}
|
|
358
365
|
const fieldList = flags.fields?.split(',').map(f => f.trim());
|
|
359
|
-
if (
|
|
366
|
+
if (envelope)
|
|
367
|
+
this.warnShortPage(envelope, flags.limit);
|
|
368
|
+
if (flags.csv || flags.output === 'csv') {
|
|
360
369
|
this.printCsv(output, fieldList);
|
|
361
|
-
|
|
370
|
+
}
|
|
371
|
+
else if (flags.table || flags.output === 'table') {
|
|
362
372
|
this.printTable(output, fieldList);
|
|
363
|
-
|
|
373
|
+
if (envelope)
|
|
374
|
+
this.printPageSummary(envelope);
|
|
375
|
+
}
|
|
376
|
+
else if (envelope && flags.meta) {
|
|
377
|
+
// The whole envelope, for a caller that asked for it; the default stays
|
|
378
|
+
// a bare array so existing scripts are unaffected.
|
|
379
|
+
this.log(JSON.stringify({ ...envelope, data: output }, null, 2));
|
|
380
|
+
}
|
|
381
|
+
else {
|
|
364
382
|
this.log(JSON.stringify(output, null, 2));
|
|
383
|
+
}
|
|
365
384
|
}
|
|
366
385
|
catch (error) {
|
|
367
386
|
if (error instanceof ApiError) {
|
|
@@ -990,6 +1009,34 @@ export default class Items extends Command {
|
|
|
990
1009
|
return `\$${op}`;
|
|
991
1010
|
return opRe.test(rest) ? `\$${op}:${this.parseFilterValue(rest)}` : `\$${op}:${rest}`;
|
|
992
1011
|
}
|
|
1012
|
+
/** The page line under a table: which page, how many, and any sums the API returned. */
|
|
1013
|
+
printPageSummary(envelope) {
|
|
1014
|
+
const meta = envelope.meta;
|
|
1015
|
+
if (meta && typeof meta.currentPage === 'number' && typeof meta.totalPages === 'number') {
|
|
1016
|
+
const shown = Array.isArray(envelope.data) ? envelope.data.length : 0;
|
|
1017
|
+
this.log(`
|
|
1018
|
+
Page ${meta.currentPage}/${meta.totalPages} — ${shown} of ${meta.totalItems ?? '?'} records`);
|
|
1019
|
+
}
|
|
1020
|
+
for (const total of envelope.totals ?? []) {
|
|
1021
|
+
const { currency, ...sums } = total;
|
|
1022
|
+
const parts = Object.entries(sums).map(([column, value]) => `${column} ${value}`).join(', ');
|
|
1023
|
+
this.log(`Total ${currency ?? ''}: ${parts}`.trim());
|
|
1024
|
+
}
|
|
1025
|
+
}
|
|
1026
|
+
/**
|
|
1027
|
+
* The API caps how many records a page may hold. Asking for more and getting
|
|
1028
|
+
* fewer looks like "that is everything" unless it is said out loud.
|
|
1029
|
+
*/
|
|
1030
|
+
warnShortPage(envelope, requestedLimit) {
|
|
1031
|
+
const asked = requestedLimit === undefined ? undefined : Number(requestedLimit);
|
|
1032
|
+
const perPage = envelope.meta?.itemsPerPage;
|
|
1033
|
+
if (asked === undefined || Number.isNaN(asked) || typeof perPage !== 'number' || perPage >= asked)
|
|
1034
|
+
return;
|
|
1035
|
+
const pages = envelope.meta?.totalPages;
|
|
1036
|
+
const more = typeof pages === 'number' && pages > 1 ? ` Use --page, or the export action for every page.` : '';
|
|
1037
|
+
process.stderr.write(`! Asked for ${asked} records per page; the API returned at most ${perPage}.${more}
|
|
1038
|
+
`);
|
|
1039
|
+
}
|
|
993
1040
|
sanitizeOutput(data) {
|
|
994
1041
|
const auditFields = ['_type', 'tenantId', 'createdAt', 'updatedAt', 'createdBy', 'updatedBy'];
|
|
995
1042
|
const uuidRegex = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i;
|
|
@@ -23,6 +23,7 @@ export default class JournalLines extends Command {
|
|
|
23
23
|
query: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
24
24
|
fields: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
25
25
|
sanitize: import("@oclif/core/interfaces").BooleanFlag<boolean>;
|
|
26
|
+
meta: import("@oclif/core/interfaces").BooleanFlag<boolean>;
|
|
26
27
|
'show-http-request': import("@oclif/core/interfaces").BooleanFlag<boolean>;
|
|
27
28
|
};
|
|
28
29
|
run(): Promise<void>;
|
|
@@ -31,6 +32,13 @@ export default class JournalLines extends Command {
|
|
|
31
32
|
private runCamt053Import;
|
|
32
33
|
private runNestedImport;
|
|
33
34
|
private parseFilterValue;
|
|
35
|
+
/** The page line under a table: which page, how many, and any sums the API returned. */
|
|
36
|
+
private printPageSummary;
|
|
37
|
+
/**
|
|
38
|
+
* The API caps how many records a page may hold. Asking for more and getting
|
|
39
|
+
* fewer looks like "that is everything" unless it is said out loud.
|
|
40
|
+
*/
|
|
41
|
+
private warnShortPage;
|
|
34
42
|
private sanitizeOutput;
|
|
35
43
|
private getColumns;
|
|
36
44
|
private getValue;
|
|
@@ -37,6 +37,7 @@ export default class JournalLines extends Command {
|
|
|
37
37
|
query: Flags.string({ description: 'Additional query params as JSON' }),
|
|
38
38
|
fields: Flags.string({ description: 'Comma-separated list of fields to return, applied by the API (e.g. --fields=id,name,status)' }),
|
|
39
39
|
sanitize: Flags.boolean({ description: 'Remove null values, audit fields, and duplicate UUIDs from output' }),
|
|
40
|
+
meta: Flags.boolean({ description: 'Keep the API envelope in JSON output: data plus page, totals and sums' }),
|
|
40
41
|
'show-http-request': Flags.boolean({ description: 'Show HTTP request details (method, URL, body)' }),
|
|
41
42
|
};
|
|
42
43
|
async run() {
|
|
@@ -329,9 +330,15 @@ export default class JournalLines extends Command {
|
|
|
329
330
|
}
|
|
330
331
|
catch { /* keep as string */ }
|
|
331
332
|
}
|
|
332
|
-
//
|
|
333
|
+
// A paginated answer is { data, meta, links, totals }. The records are
|
|
334
|
+
// unwrapped for output, but what the API said about the page is kept:
|
|
335
|
+
// dropping it silently let a script read one page as the whole result
|
|
336
|
+
// (AderisERP/product#61).
|
|
337
|
+
let envelope;
|
|
333
338
|
if (output && typeof output === 'object' && !Array.isArray(output) && 'data' in output && Array.isArray(output.data)) {
|
|
334
|
-
|
|
339
|
+
const page = output;
|
|
340
|
+
envelope = page;
|
|
341
|
+
output = page.data;
|
|
335
342
|
}
|
|
336
343
|
// For table/csv on non-array responses, auto-extract the primary array
|
|
337
344
|
// e.g., { payments: [...], total: 3 } → extract payments array
|
|
@@ -348,12 +355,24 @@ export default class JournalLines extends Command {
|
|
|
348
355
|
output = this.sanitizeOutput(output);
|
|
349
356
|
}
|
|
350
357
|
const fieldList = flags.fields?.split(',').map(f => f.trim());
|
|
351
|
-
if (
|
|
358
|
+
if (envelope)
|
|
359
|
+
this.warnShortPage(envelope, flags.limit);
|
|
360
|
+
if (flags.csv || flags.output === 'csv') {
|
|
352
361
|
this.printCsv(output, fieldList);
|
|
353
|
-
|
|
362
|
+
}
|
|
363
|
+
else if (flags.table || flags.output === 'table') {
|
|
354
364
|
this.printTable(output, fieldList);
|
|
355
|
-
|
|
365
|
+
if (envelope)
|
|
366
|
+
this.printPageSummary(envelope);
|
|
367
|
+
}
|
|
368
|
+
else if (envelope && flags.meta) {
|
|
369
|
+
// The whole envelope, for a caller that asked for it; the default stays
|
|
370
|
+
// a bare array so existing scripts are unaffected.
|
|
371
|
+
this.log(JSON.stringify({ ...envelope, data: output }, null, 2));
|
|
372
|
+
}
|
|
373
|
+
else {
|
|
356
374
|
this.log(JSON.stringify(output, null, 2));
|
|
375
|
+
}
|
|
357
376
|
}
|
|
358
377
|
catch (error) {
|
|
359
378
|
if (error instanceof ApiError) {
|
|
@@ -982,6 +1001,34 @@ export default class JournalLines extends Command {
|
|
|
982
1001
|
return `\$${op}`;
|
|
983
1002
|
return opRe.test(rest) ? `\$${op}:${this.parseFilterValue(rest)}` : `\$${op}:${rest}`;
|
|
984
1003
|
}
|
|
1004
|
+
/** The page line under a table: which page, how many, and any sums the API returned. */
|
|
1005
|
+
printPageSummary(envelope) {
|
|
1006
|
+
const meta = envelope.meta;
|
|
1007
|
+
if (meta && typeof meta.currentPage === 'number' && typeof meta.totalPages === 'number') {
|
|
1008
|
+
const shown = Array.isArray(envelope.data) ? envelope.data.length : 0;
|
|
1009
|
+
this.log(`
|
|
1010
|
+
Page ${meta.currentPage}/${meta.totalPages} — ${shown} of ${meta.totalItems ?? '?'} records`);
|
|
1011
|
+
}
|
|
1012
|
+
for (const total of envelope.totals ?? []) {
|
|
1013
|
+
const { currency, ...sums } = total;
|
|
1014
|
+
const parts = Object.entries(sums).map(([column, value]) => `${column} ${value}`).join(', ');
|
|
1015
|
+
this.log(`Total ${currency ?? ''}: ${parts}`.trim());
|
|
1016
|
+
}
|
|
1017
|
+
}
|
|
1018
|
+
/**
|
|
1019
|
+
* The API caps how many records a page may hold. Asking for more and getting
|
|
1020
|
+
* fewer looks like "that is everything" unless it is said out loud.
|
|
1021
|
+
*/
|
|
1022
|
+
warnShortPage(envelope, requestedLimit) {
|
|
1023
|
+
const asked = requestedLimit === undefined ? undefined : Number(requestedLimit);
|
|
1024
|
+
const perPage = envelope.meta?.itemsPerPage;
|
|
1025
|
+
if (asked === undefined || Number.isNaN(asked) || typeof perPage !== 'number' || perPage >= asked)
|
|
1026
|
+
return;
|
|
1027
|
+
const pages = envelope.meta?.totalPages;
|
|
1028
|
+
const more = typeof pages === 'number' && pages > 1 ? ` Use --page, or the export action for every page.` : '';
|
|
1029
|
+
process.stderr.write(`! Asked for ${asked} records per page; the API returned at most ${perPage}.${more}
|
|
1030
|
+
`);
|
|
1031
|
+
}
|
|
985
1032
|
sanitizeOutput(data) {
|
|
986
1033
|
const auditFields = ['_type', 'tenantId', 'createdAt', 'updatedAt', 'createdBy', 'updatedBy'];
|
|
987
1034
|
const uuidRegex = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i;
|
|
@@ -26,6 +26,7 @@ export default class Journals extends Command {
|
|
|
26
26
|
query: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
27
27
|
fields: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
|
|
28
28
|
sanitize: import("@oclif/core/interfaces").BooleanFlag<boolean>;
|
|
29
|
+
meta: import("@oclif/core/interfaces").BooleanFlag<boolean>;
|
|
29
30
|
'show-http-request': import("@oclif/core/interfaces").BooleanFlag<boolean>;
|
|
30
31
|
};
|
|
31
32
|
run(): Promise<void>;
|
|
@@ -34,6 +35,13 @@ export default class Journals extends Command {
|
|
|
34
35
|
private runCamt053Import;
|
|
35
36
|
private runNestedImport;
|
|
36
37
|
private parseFilterValue;
|
|
38
|
+
/** The page line under a table: which page, how many, and any sums the API returned. */
|
|
39
|
+
private printPageSummary;
|
|
40
|
+
/**
|
|
41
|
+
* The API caps how many records a page may hold. Asking for more and getting
|
|
42
|
+
* fewer looks like "that is everything" unless it is said out loud.
|
|
43
|
+
*/
|
|
44
|
+
private warnShortPage;
|
|
37
45
|
private sanitizeOutput;
|
|
38
46
|
private getColumns;
|
|
39
47
|
private getValue;
|
|
@@ -67,6 +67,7 @@ export default class Journals extends Command {
|
|
|
67
67
|
query: Flags.string({ description: 'Additional query params as JSON' }),
|
|
68
68
|
fields: Flags.string({ description: 'Comma-separated list of fields to return, applied by the API (e.g. --fields=id,name,status)' }),
|
|
69
69
|
sanitize: Flags.boolean({ description: 'Remove null values, audit fields, and duplicate UUIDs from output' }),
|
|
70
|
+
meta: Flags.boolean({ description: 'Keep the API envelope in JSON output: data plus page, totals and sums' }),
|
|
70
71
|
'show-http-request': Flags.boolean({ description: 'Show HTTP request details (method, URL, body)' }),
|
|
71
72
|
};
|
|
72
73
|
async run() {
|
|
@@ -359,9 +360,15 @@ export default class Journals extends Command {
|
|
|
359
360
|
}
|
|
360
361
|
catch { /* keep as string */ }
|
|
361
362
|
}
|
|
362
|
-
//
|
|
363
|
+
// A paginated answer is { data, meta, links, totals }. The records are
|
|
364
|
+
// unwrapped for output, but what the API said about the page is kept:
|
|
365
|
+
// dropping it silently let a script read one page as the whole result
|
|
366
|
+
// (AderisERP/product#61).
|
|
367
|
+
let envelope;
|
|
363
368
|
if (output && typeof output === 'object' && !Array.isArray(output) && 'data' in output && Array.isArray(output.data)) {
|
|
364
|
-
|
|
369
|
+
const page = output;
|
|
370
|
+
envelope = page;
|
|
371
|
+
output = page.data;
|
|
365
372
|
}
|
|
366
373
|
// For table/csv on non-array responses, auto-extract the primary array
|
|
367
374
|
// e.g., { payments: [...], total: 3 } → extract payments array
|
|
@@ -378,12 +385,24 @@ export default class Journals extends Command {
|
|
|
378
385
|
output = this.sanitizeOutput(output);
|
|
379
386
|
}
|
|
380
387
|
const fieldList = flags.fields?.split(',').map(f => f.trim());
|
|
381
|
-
if (
|
|
388
|
+
if (envelope)
|
|
389
|
+
this.warnShortPage(envelope, flags.limit);
|
|
390
|
+
if (flags.csv || flags.output === 'csv') {
|
|
382
391
|
this.printCsv(output, fieldList);
|
|
383
|
-
|
|
392
|
+
}
|
|
393
|
+
else if (flags.table || flags.output === 'table') {
|
|
384
394
|
this.printTable(output, fieldList);
|
|
385
|
-
|
|
395
|
+
if (envelope)
|
|
396
|
+
this.printPageSummary(envelope);
|
|
397
|
+
}
|
|
398
|
+
else if (envelope && flags.meta) {
|
|
399
|
+
// The whole envelope, for a caller that asked for it; the default stays
|
|
400
|
+
// a bare array so existing scripts are unaffected.
|
|
401
|
+
this.log(JSON.stringify({ ...envelope, data: output }, null, 2));
|
|
402
|
+
}
|
|
403
|
+
else {
|
|
386
404
|
this.log(JSON.stringify(output, null, 2));
|
|
405
|
+
}
|
|
387
406
|
}
|
|
388
407
|
catch (error) {
|
|
389
408
|
if (error instanceof ApiError) {
|
|
@@ -1012,6 +1031,34 @@ export default class Journals extends Command {
|
|
|
1012
1031
|
return `\$${op}`;
|
|
1013
1032
|
return opRe.test(rest) ? `\$${op}:${this.parseFilterValue(rest)}` : `\$${op}:${rest}`;
|
|
1014
1033
|
}
|
|
1034
|
+
/** The page line under a table: which page, how many, and any sums the API returned. */
|
|
1035
|
+
printPageSummary(envelope) {
|
|
1036
|
+
const meta = envelope.meta;
|
|
1037
|
+
if (meta && typeof meta.currentPage === 'number' && typeof meta.totalPages === 'number') {
|
|
1038
|
+
const shown = Array.isArray(envelope.data) ? envelope.data.length : 0;
|
|
1039
|
+
this.log(`
|
|
1040
|
+
Page ${meta.currentPage}/${meta.totalPages} — ${shown} of ${meta.totalItems ?? '?'} records`);
|
|
1041
|
+
}
|
|
1042
|
+
for (const total of envelope.totals ?? []) {
|
|
1043
|
+
const { currency, ...sums } = total;
|
|
1044
|
+
const parts = Object.entries(sums).map(([column, value]) => `${column} ${value}`).join(', ');
|
|
1045
|
+
this.log(`Total ${currency ?? ''}: ${parts}`.trim());
|
|
1046
|
+
}
|
|
1047
|
+
}
|
|
1048
|
+
/**
|
|
1049
|
+
* The API caps how many records a page may hold. Asking for more and getting
|
|
1050
|
+
* fewer looks like "that is everything" unless it is said out loud.
|
|
1051
|
+
*/
|
|
1052
|
+
warnShortPage(envelope, requestedLimit) {
|
|
1053
|
+
const asked = requestedLimit === undefined ? undefined : Number(requestedLimit);
|
|
1054
|
+
const perPage = envelope.meta?.itemsPerPage;
|
|
1055
|
+
if (asked === undefined || Number.isNaN(asked) || typeof perPage !== 'number' || perPage >= asked)
|
|
1056
|
+
return;
|
|
1057
|
+
const pages = envelope.meta?.totalPages;
|
|
1058
|
+
const more = typeof pages === 'number' && pages > 1 ? ` Use --page, or the export action for every page.` : '';
|
|
1059
|
+
process.stderr.write(`! Asked for ${asked} records per page; the API returned at most ${perPage}.${more}
|
|
1060
|
+
`);
|
|
1061
|
+
}
|
|
1015
1062
|
sanitizeOutput(data) {
|
|
1016
1063
|
const auditFields = ['_type', 'tenantId', 'createdAt', 'updatedAt', 'createdBy', 'updatedBy'];
|
|
1017
1064
|
const uuidRegex = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i;
|