@aderis-erp/cli 1.1.1 → 1.1.3

package/dist/commands/items.js

@@ -1,18 +1,22 @@
 import { Command, Args, Flags } from '@oclif/core';
 import { apiRequest, ApiError, isTextualMediaType, normalizeSortBy } from '../lib/api-client.js';
 import { getCurrentContext, getContext, getBaseUrls, hasCredentials, missingCredentialsMessage } from '../lib/config.js';
-// Add 'import' action if both create and update exist
-const HAS_IMPORT = true;
+// 'upsert' loops create/update from the CLI, one request per record. It exists
+// only where the API has no import endpoint of its own; those keep the name
+// 'import' and are listed in SERVER_IMPORTS.
+const HAS_UPSERT = false;
 const HAS_EXPORT = true;
 const HAS_CAMT053 = false;
-const NESTED_IMPORTS = [];
-const SUBCOMMANDS = [...["list", "create", "get", "update", "delete"], ...(HAS_IMPORT ? ['import'] : []), ...(HAS_EXPORT ? ['export'] : []), ...NESTED_IMPORTS.map(n => `import-${n}`)];
+const SERVER_IMPORTS = ["import"];
+const NESTED_UPSERTS = [];
+const SUBCOMMANDS = [...["list", "create", "get", "update", "delete", "import"], ...(HAS_UPSERT ? ['upsert'] : []), ...(HAS_EXPORT ? ['export'] : []), ...NESTED_UPSERTS.map(n => `upsert-${n}`)];
 const ENDPOINTS = {
     'list': { method: 'GET', path: '/v1/items', summary: 'Get all items with pagination', pathParams: [], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
     'create': { method: 'POST', path: '/v1/items', summary: 'Create a new item', pathParams: [], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: ['tagIds', 'tagCodes'] },
     'get': { method: 'GET', path: '/v1/items/{id}', summary: 'Get an item by ID', pathParams: ['id'], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
     'update': { method: 'PATCH', path: '/v1/items/{id}', summary: 'Update an item', pathParams: ['id'], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: ['tagIds', 'tagCodes'] },
     'delete': { method: 'DELETE', path: '/v1/items/{id}', summary: 'Delete an item', pathParams: ['id'], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
+    'import': { method: 'POST', path: '/v1/items/import', summary: 'Import items', pathParams: [], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
 };
 export default class Items extends Command {
     static description = 'Manage items';
@@ -21,7 +25,7 @@ export default class Items extends Command {
         '<%= config.bin %> items get <id>',
         '<%= config.bin %> items create --data \'{...}\'',
         '<%= config.bin %> items update <id> --set field=value',
-        '<%= config.bin %> items import --file data.json',
+        '<%= config.bin %> items import --file data.json --mode upsert',
         '<%= config.bin %> items export --csv > items.csv',
     ];
     static args = {
@@ -30,12 +34,16 @@ export default class Items extends Command {
     };
     static flags = {
         context: Flags.string({ char: 'c', aliases: ['config'], env: 'ADERIS_CONTEXT', description: 'Context to use for this command, overriding the current context (alias: --config)' }),
-        output: Flags.string({ char: 'o', description: 'Output format (default: table for import, json for other commands)', options: ['json', 'table', 'csv'] }),
+        output: Flags.string({ char: 'o', description: 'Output format (default: table for upsert, json for other commands)', options: ['json', 'table', 'csv'] }),
         table: Flags.boolean({ char: 't', description: 'Output as table (shortcut for --output table)' }),
         csv: Flags.boolean({ description: 'Output as CSV (shortcut for --output csv)' }),
         data: Flags.string({ char: 'd', description: 'JSON data for request body' }),
         file: Flags.string({ char: 'f', description: 'Read request body from file' }),
         set: Flags.string({ char: 's', description: 'Set individual field (e.g. --set firstName=John)', multiple: true }),
+        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'] }),
+        reference: Flags.string({ description: 'Caller-defined text stored on the import run, for tracking and filtering' }),
+        async: Flags.boolean({ description: 'Import in the background: answers with a PENDING run to follow via "aderis imports get <id>"' }),
+        'idempotency-key': Flags.string({ description: 'Repeating a key returns the earlier import run unchanged and imports nothing' }),
         page: Flags.string({ description: 'Page number' }),
         limit: Flags.string({ description: 'Items per page' }),
         include: Flags.string({ description: 'Relations to include' }),
@@ -45,15 +53,31 @@ export default class Items extends Command {
         query: Flags.string({ description: 'Additional query params as JSON' }),
         fields: Flags.string({ description: 'Comma-separated list of fields to return, applied by the API (e.g. --fields=id,name,status)' }),
         sanitize: Flags.boolean({ description: 'Remove null values, audit fields, and duplicate UUIDs from output' }),
+        meta: Flags.boolean({ description: 'Keep the API envelope in JSON output: data plus page, totals and sums' }),
         'show-http-request': Flags.boolean({ description: 'Show HTTP request details (method, URL, body)' }),
     };
     async run() {
         const { args, flags } = await this.parse(Items);
-        // Handle import action specially
-        if (args.action === 'import') {
-            if (!HAS_IMPORT)
-                this.error('Import not available for this resource');
-            await this.runImport(flags);
+        // Bulk actions. 'import' is the API's own endpoint: one request, answered
+        // by a run that records what happened to every record. 'upsert' is the CLI
+        // looping create/update. A resource has one or the other, never both.
+        if (args.action === 'upsert') {
+            if (!HAS_UPSERT) {
+                this.error(SERVER_IMPORTS.includes('import')
+                    ? 'This resource is imported by the API. Use: aderis items import --file data.json'
+                    : 'Upsert needs both a create and an update endpoint, which this resource does not have');
+            }
+            await this.runUpsert(flags);
+            return;
+        }
+        if (args.action.startsWith('upsert-')) {
+            const suffix = args.action.replace('upsert-', '');
+            if (!NESTED_UPSERTS.includes(suffix)) {
+                this.error(SERVER_IMPORTS.includes('import-' + suffix)
+                    ? `That resource is imported by the API. Use: aderis items import-${suffix} <id> --file data.json`
+                    : `Unknown action: ${args.action}. Available: ${SUBCOMMANDS.join(', ')}`);
+            }
+            await this.runNestedUpsert(suffix, args.id, flags);
             return;
         }
         // Handle export action specially
@@ -70,12 +94,17 @@ export default class Items extends Command {
             await this.runCamt053Import(flags);
             return;
         }
-        // Handle nested resource imports (e.g., import-prices)
-        if (args.action.startsWith('import-')) {
-            const suffix = args.action.replace('import-', '');
-            if (NESTED_IMPORTS.includes(suffix)) {
-                await this.runNestedImport(suffix, args.id, flags);
-                return;
+        if (SERVER_IMPORTS.includes(args.action)) {
+            await this.runServerImport(args.action, args.id, flags);
+            return;
+        }
+        // 'import' used to name the CLI's create/update loop on every resource. It
+        // now names the API endpoint, which most resources do not have.
+        if (args.action === 'import' || args.action.startsWith('import-')) {
+            const suffix = args.action === 'import' ? '' : '-' + args.action.replace('import-', '');
+            const loops = args.action === 'import' ? HAS_UPSERT : NESTED_UPSERTS.includes(args.action.replace('import-', ''));
+            if (loops) {
+                this.error(`This resource has no import endpoint. Use: aderis items upsert${suffix}${suffix ? ' <id>' : ''} --file data.json`);
             }
         }
         const endpoint = ENDPOINTS[args.action];
@@ -337,9 +366,15 @@ export default class Items extends Command {
                 }
                 catch { /* keep as string */ }
             }
-            // Extract data array from paginated wrapper (e.g., { data: [...], total: 3 })
+            // A paginated answer is { data, meta, links, totals }. The records are
+            // unwrapped for output, but what the API said about the page is kept:
+            // dropping it silently let a script read one page as the whole result
+            // (AderisERP/product#61).
+            let envelope;
             if (output && typeof output === 'object' && !Array.isArray(output) && 'data' in output && Array.isArray(output.data)) {
-                output = output.data;
+                const page = output;
+                envelope = page;
+                output = page.data;
             }
             // For table/csv on non-array responses, auto-extract the primary array
             // e.g., { payments: [...], total: 3 } → extract payments array
@@ -356,12 +391,24 @@ export default class Items extends Command {
                 output = this.sanitizeOutput(output);
             }
             const fieldList = flags.fields?.split(',').map(f => f.trim());
-            if (flags.csv || flags.output === 'csv')
+            if (envelope)
+                this.warnShortPage(envelope, flags.limit);
+            if (flags.csv || flags.output === 'csv') {
                 this.printCsv(output, fieldList);
-            else if (flags.table || flags.output === 'table')
+            }
+            else if (flags.table || flags.output === 'table') {
                 this.printTable(output, fieldList);
-            else
+                if (envelope)
+                    this.printPageSummary(envelope);
+            }
+            else if (envelope && flags.meta) {
+                // The whole envelope, for a caller that asked for it; the default stays
+                // a bare array so existing scripts are unaffected.
+                this.log(JSON.stringify({ ...envelope, data: output }, null, 2));
+            }
+            else {
                 this.log(JSON.stringify(output, null, 2));
+            }
         }
         catch (error) {
             if (error instanceof ApiError) {
@@ -372,7 +419,7 @@ export default class Items extends Command {
             throw error;
         }
     }
-    async runImport(flags) {
+    async runUpsert(flags) {
         const context = flags.context ? getContext(flags.context) : getCurrentContext();
         if (!context)
             this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
@@ -436,12 +483,12 @@ export default class Items extends Command {
             items = [item];
         }
         else {
-            this.error('Import requires --file, --data, or --set flags');
+            this.error('Upsert requires --file, --data, or --set flags');
         }
         const createEndpoint = ENDPOINTS['create'];
         const updateEndpoint = ENDPOINTS['update'];
         if (!createEndpoint || !updateEndpoint) {
-            this.error('Import requires both create and update endpoints');
+            this.error('Upsert requires both create and update endpoints');
         }
         // Helper to extract identifier from item (id, code, or xxxCode)
         const getItemIdentifier = (item) => {
@@ -584,6 +631,117 @@ export default class Items extends Command {
         this.log('');
         this.log(`Summary: ${created} created, ${updated} updated, ${errors.length} failed`);
     }
+    /**
+     * The API's own import: the whole array goes up in one request and comes
+     * back as an import run, which records what happened to every record. A bad
+     * record lands in errorLog and the rest are still applied, and the run stays
+     * readable afterwards with: aderis imports get <id>.
+     */
+    async runServerImport(action, parentId, flags) {
+        const endpoint = ENDPOINTS[action];
+        if (!endpoint)
+            this.error(`Unknown action: ${action}. Available: ${SUBCOMMANDS.join(', ')}`);
+        const context = flags.context ? getContext(flags.context) : getCurrentContext();
+        if (!context)
+            this.error(flags.context ? `Context "${flags.context}" not found. List contexts with: aderis config list` : 'No context configured. Run: aderis auth login --new');
+        if (!hasCredentials(context))
+            this.error(missingCredentialsMessage(context));
+        let apiPath = endpoint.path;
+        if (endpoint.pathParams.length > 0) {
+            if (!parentId)
+                this.error(`Missing required argument: id. Usage: aderis items ${action} <parent-id> --file data.json`);
+            apiPath = apiPath.replace(`{${endpoint.pathParams[0]}}`, parentId);
+        }
+        // The endpoint takes an array. A single object is wrapped, so importing
+        // one record reads the same as importing many.
+        let records = [];
+        if (flags.file) {
+            const fsModule = await import('node:fs');
+            try {
+                const content = JSON.parse(fsModule.readFileSync(flags.file, 'utf-8'));
+                records = Array.isArray(content) ? content : [content];
+            }
+            catch {
+                this.error(`Failed to read file: ${flags.file}`);
+            }
+        }
+        else if (flags.data) {
+            try {
+                const content = JSON.parse(flags.data);
+                records = Array.isArray(content) ? content : [content];
+            }
+            catch {
+                this.error('Invalid JSON in --data');
+            }
+        }
+        else {
+            this.error('Import requires --file or --data holding a JSON array of records');
+        }
+        if (records.length === 0)
+            this.error('Nothing to import: the input is an empty array');
+        const params = { format: 'json' };
+        if (flags.mode)
+            params.mode = flags.mode;
+        if (flags.reference)
+            params.reference = flags.reference;
+        if (flags.async)
+            params.async = true;
+        const headers = {};
+        if (flags['idempotency-key'])
+            headers['Idempotency-Key'] = flags['idempotency-key'];
+        if (flags['show-http-request']) {
+            const baseUrls = getBaseUrls(context.environment);
+            const queryString = '?' + Object.entries(params).map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(String(v))}`).join('&');
+            process.stderr.write(`\n${endpoint.method.toUpperCase()} ${baseUrls.api}${apiPath}${queryString}\n`);
+            process.stderr.write(`Body: [${records.length} record${records.length === 1 ? '' : 's'}]\n\n`);
+        }
+        try {
+            const response = await apiRequest(endpoint.method, apiPath, {
+                contextName: flags.context,
+                data: records,
+                headers,
+                params,
+            });
+            this.printImportRun(response.data, flags);
+        }
+        catch (error) {
+            if (error instanceof ApiError) {
+                this.error(`API Error (${error.status}): ${error.message}`);
+            }
+            throw error;
+        }
+    }
+    /** Renders an import run: its counts, then whatever the server refused. */
+    printImportRun(run, flags) {
+        if (flags.output === 'json') {
+            this.log(JSON.stringify(run, null, 2));
+            return;
+        }
+        const record = (run ?? {});
+        const count = (key) => (typeof record[key] === 'number' ? record[key] : 0);
+        const id = record.id ? String(record.id) : '';
+        this.log(`Import ${id} - ${String(record.status ?? 'UNKNOWN')}${record.async ? ' (background)' : ''}`);
+        this.log(`  ${count('inputSize')} submitted, ${count('createdCount')} created, ${count('updatedCount')} updated, ${count('unchangedCount')} unchanged`);
+        if (count('errorCount') > 0)
+            this.log(`  ${count('errorCount')} not applied: ${count('refusedCount')} refused, ${count('failedCount')} failed`);
+        if (count('warningCount') > 0)
+            this.log(`  ${count('warningCount')} applied with a warning`);
+        // errorLog is keyed by the record's identifier, then by field name.
+        const errorLog = record.errorLog;
+        if (errorLog && Object.keys(errorLog).length > 0) {
+            this.log('');
+            for (const [key, fields] of Object.entries(errorLog)) {
+                for (const [field, messages] of Object.entries(fields ?? {})) {
+                    for (const message of messages ?? [])
+                        this.log(`  ${key}  ${field}: ${message}`);
+                }
+            }
+        }
+        if (record.async && id) {
+            this.log('');
+            this.log(`Follow it with: aderis imports get ${id}`);
+        }
+    }
     async runExport(flags) {
         const context = flags.context ? getContext(flags.context) : getCurrentContext();
         if (!context)
@@ -762,9 +920,9 @@ export default class Items extends Command {
             throw error;
         }
     }
-    async runNestedImport(suffix, parentId, flags) {
+    async runNestedUpsert(suffix, parentId, flags) {
         if (!parentId) {
-            this.error(`Missing required argument: id. Usage: aderis items import-${suffix} <parent-id> --file data.json`);
+            this.error(`Missing required argument: id. Usage: aderis items upsert-${suffix} <parent-id> --file data.json`);
         }
         const context = flags.context ? getContext(flags.context) : getCurrentContext();
         if (!context)
@@ -829,12 +987,12 @@ export default class Items extends Command {
             items = [item];
         }
         else {
-            this.error(`Import requires --file, --data, or --set flags`);
+            this.error('Upsert requires --file, --data, or --set flags');
         }
         const createEndpoint = ENDPOINTS[`create-${suffix}`];
         const updateEndpoint = ENDPOINTS[`update-${suffix}`];
         if (!createEndpoint || !updateEndpoint) {
-            this.error(`Import requires both create-${suffix} and update-${suffix} endpoints`);
+            this.error(`Upsert requires both create-${suffix} and update-${suffix} endpoints`);
         }
         // Build the base path with parent ID (first path param)
         const firstParam = createEndpoint.pathParams[0];
@@ -990,6 +1148,34 @@ export default class Items extends Command {
             return `\$${op}`;
         return opRe.test(rest) ? `\$${op}:${this.parseFilterValue(rest)}` : `\$${op}:${rest}`;
     }
+    /** The page line under a table: which page, how many, and any sums the API returned. */
+    printPageSummary(envelope) {
+        const meta = envelope.meta;
+        if (meta && typeof meta.currentPage === 'number' && typeof meta.totalPages === 'number') {
+            const shown = Array.isArray(envelope.data) ? envelope.data.length : 0;
+            this.log(`
+Page ${meta.currentPage}/${meta.totalPages} — ${shown} of ${meta.totalItems ?? '?'} records`);
+        }
+        for (const total of envelope.totals ?? []) {
+            const { currency, ...sums } = total;
+            const parts = Object.entries(sums).map(([column, value]) => `${column} ${value}`).join(', ');
+            this.log(`Total ${currency ?? ''}: ${parts}`.trim());
+        }
+    }
+    /**
+     * The API caps how many records a page may hold. Asking for more and getting
+     * fewer looks like "that is everything" unless it is said out loud.
+     */
+    warnShortPage(envelope, requestedLimit) {
+        const asked = requestedLimit === undefined ? undefined : Number(requestedLimit);
+        const perPage = envelope.meta?.itemsPerPage;
+        if (asked === undefined || Number.isNaN(asked) || typeof perPage !== 'number' || perPage >= asked)
+            return;
+        const pages = envelope.meta?.totalPages;
+        const more = typeof pages === 'number' && pages > 1 ? ` Use --page, or the export action for every page.` : '';
+        process.stderr.write(`! Asked for ${asked} records per page; the API returned at most ${perPage}.${more}
+`);
+    }
     sanitizeOutput(data) {
         const auditFields = ['_type', 'tenantId', 'createdAt', 'updatedAt', 'createdBy', 'updatedBy'];
         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/journal-lines.d.ts

@@ -23,14 +23,31 @@ export default class JournalLines extends Command {
         query: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         fields: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         sanitize: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        meta: import("@oclif/core/interfaces").BooleanFlag<boolean>;
         'show-http-request': import("@oclif/core/interfaces").BooleanFlag<boolean>;
     };
     run(): Promise<void>;
-    private runImport;
+    private runUpsert;
+    /**
+     * The API's own import: the whole array goes up in one request and comes
+     * back as an import run, which records what happened to every record. A bad
+     * record lands in errorLog and the rest are still applied, and the run stays
+     * readable afterwards with: aderis imports get <id>.
+     */
+    private runServerImport;
+    /** Renders an import run: its counts, then whatever the server refused. */
+    private printImportRun;
     private runExport;
     private runCamt053Import;
-    private runNestedImport;
+    private runNestedUpsert;
     private parseFilterValue;
+    /** The page line under a table: which page, how many, and any sums the API returned. */
+    private printPageSummary;
+    /**
+     * The API caps how many records a page may hold. Asking for more and getting
+     * fewer looks like "that is everything" unless it is said out loud.
+     */
+    private warnShortPage;
     private sanitizeOutput;
     private getColumns;
     private getValue;