@aderis-erp/cli 1.1.4 → 1.1.5

package/dist/commands/files.js

@@ -1,6 +1,7 @@
 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';
+import { resolveUserPath } from '../lib/paths.js';
 // '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.
@@ -11,18 +12,18 @@ const SERVER_IMPORTS = [];
 const NESTED_UPSERTS = [];
 const SUBCOMMANDS = [...["list", "create", "download-all", "download", "get", "references", "update", "discard", "move", "retention", "hold", "reclassify"], ...(HAS_UPSERT ? ['upsert'] : []), ...(HAS_EXPORT ? ['export'] : []), ...NESTED_UPSERTS.map(n => `upsert-${n}`)];
 const ENDPOINTS = {
-    'list': { method: 'GET', path: '/v1/files', summary: 'List files (paginated, permission-scoped)', pathParams: [], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
-    'create': { method: 'POST', path: '/v1/files', summary: 'Upload a file (streaming, memory-efficient)', pathParams: [], hasBody: false, isMultipart: true, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
-    'download-all': { method: 'GET', path: '/v1/files/download/*', summary: 'Download file directly by storage key', pathParams: [], hasBody: false, isMultipart: false, isBinaryResponse: true, hasBinaryVariant: false, bodyArrayFields: [] },
-    'download': { method: 'GET', path: '/v1/files/{id}/download', summary: 'Get a signed download URL for a file', pathParams: ['id'], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
-    'get': { method: 'GET', path: '/v1/files/{id}', summary: 'Get a file by id (permission-scoped)', pathParams: ['id'], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
-    'references': { method: 'POST', path: '/v1/files/references', summary: 'Register a file reference to an existing storage object', pathParams: [], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
-    'update': { method: 'PATCH', path: '/v1/files/{fileId}', summary: 'Update file metadata (type, parent, sortOrder)', pathParams: ['fileId'], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: ['tagIds', 'tagCodes', 'references'] },
-    'discard': { method: 'POST', path: '/v1/files/{fileId}/discard', summary: 'Discard a file (sets status DISCARDED; stays readable by id)', pathParams: ['fileId'], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
-    'move': { method: 'POST', path: '/v1/files/{fileId}/move', summary: 'Move file between storage zones', pathParams: ['fileId'], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
-    'retention': { method: 'POST', path: '/v1/files/{fileId}/retention', summary: 'Set or override retention period on a file', pathParams: ['fileId'], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
-    'hold': { method: 'POST', path: '/v1/files/{fileId}/hold', summary: 'Set or release legal hold on a file', pathParams: ['fileId'], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
-    'reclassify': { method: 'POST', path: '/v1/files/{fileId}/reclassify', summary: 'Reclassify a file and reprocess it through the inbox pipeline', pathParams: ['fileId'], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [] },
+    'list': { method: 'GET', path: '/v1/files', summary: 'List files (paginated, permission-scoped)', pathParams: [], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [], bodyMediaType: '', specParams: [] },
+    'create': { method: 'POST', path: '/v1/files', summary: 'Upload a file (streaming, memory-efficient)', pathParams: [], hasBody: false, isMultipart: true, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [], bodyMediaType: '', specParams: [] },
+    'download-all': { method: 'GET', path: '/v1/files/download/*', summary: 'Download file directly by storage key', pathParams: [], hasBody: false, isMultipart: false, isBinaryResponse: true, hasBinaryVariant: false, bodyArrayFields: [], bodyMediaType: '', specParams: [] },
+    'download': { method: 'GET', path: '/v1/files/{id}/download', summary: 'Get a signed download URL for a file', pathParams: ['id'], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [], bodyMediaType: '', specParams: [] },
+    'get': { method: 'GET', path: '/v1/files/{id}', summary: 'Get a file by id (permission-scoped)', pathParams: ['id'], hasBody: false, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [], bodyMediaType: '', specParams: [] },
+    'references': { method: 'POST', path: '/v1/files/references', summary: 'Register a file reference to an existing storage object', pathParams: [], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [], bodyMediaType: '', specParams: [] },
+    'update': { method: 'PATCH', path: '/v1/files/{fileId}', summary: 'Update file metadata (type, parent, sortOrder)', pathParams: ['fileId'], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: ['tagIds', 'tagCodes', 'references'], bodyMediaType: '', specParams: [] },
+    'discard': { method: 'POST', path: '/v1/files/{fileId}/discard', summary: 'Discard a file (sets status DISCARDED; stays readable by id)', pathParams: ['fileId'], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [], bodyMediaType: '', specParams: [] },
+    'move': { method: 'POST', path: '/v1/files/{fileId}/move', summary: 'Move file between storage zones', pathParams: ['fileId'], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [], bodyMediaType: '', specParams: [] },
+    'retention': { method: 'POST', path: '/v1/files/{fileId}/retention', summary: 'Set or override retention period on a file', pathParams: ['fileId'], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [], bodyMediaType: '', specParams: [] },
+    'hold': { method: 'POST', path: '/v1/files/{fileId}/hold', summary: 'Set or release legal hold on a file', pathParams: ['fileId'], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [], bodyMediaType: '', specParams: [] },
+    'reclassify': { method: 'POST', path: '/v1/files/{fileId}/reclassify', summary: 'Reclassify a file and reprocess it through the inbox pipeline', pathParams: ['fileId'], hasBody: true, isMultipart: false, isBinaryResponse: false, hasBinaryVariant: false, bodyArrayFields: [], bodyMediaType: '', specParams: [] },
 };
 export default class Files extends Command {
     static description = 'Manage files';
@@ -44,7 +45,7 @@ export default class Files extends Command {
         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' }),
+        file: Flags.string({ char: 'f', description: 'Read request body from file', parse: async (input) => resolveUserPath(input) }),
         set: Flags.string({ char: 's', description: 'Set individual field (e.g. --set firstName=John)', multiple: true }),
         page: Flags.string({ description: 'Page number' }),
         limit: Flags.string({ description: 'Items per page' }),
@@ -175,6 +176,17 @@ export default class Files extends Command {
                 }
             }
         }
+        // Flags generated from this endpoint's own parameters. Raw-body endpoints
+        // have them: their body is not JSON, so --set cannot carry a value there.
+        for (const param of endpoint.specParams) {
+            const value = flags[param.flag];
+            if (value === undefined || value === '') {
+                if (param.required)
+                    this.error(`Missing required flag: --${param.flag}`);
+                continue;
+            }
+            queryParams[param.name] = value;
+        }
         let data;
         if (endpoint.isMultipart) {
             if (!flags.file)
@@ -195,6 +207,25 @@ export default class Files extends Command {
             }
             data = form;
         }
+        else if (endpoint.bodyMediaType) {
+            // The body is not JSON (today only application/x-ndjson): it is sent
+            // verbatim, under the content type the endpoint asks for.
+            if (flags.file) {
+                const fsModule = await import('node:fs');
+                try {
+                    data = fsModule.readFileSync(flags.file, 'utf-8');
+                }
+                catch {
+                    this.error(`Failed to read file: ${flags.file}`);
+                }
+            }
+            else if (flags.data) {
+                data = flags.data;
+            }
+            else {
+                this.error(`This endpoint takes its body as ${endpoint.bodyMediaType}. Pass the file with -f / --file, or the text with --data.`);
+            }
+        }
         else if (endpoint.hasBody) {
             // For binary-response endpoints, --file is the output path, not a JSON
             // input file — skip the read-as-body branch.
@@ -290,7 +321,7 @@ export default class Files extends Command {
                 process.stderr.write(`Body: [multipart/form-data file upload]\n`);
             }
             else if (data) {
-                process.stderr.write(`Body: ${JSON.stringify(data, null, 2)}\n`);
+                process.stderr.write(`Body: ${typeof data === 'string' ? data : JSON.stringify(data, null, 2)}\n`);
             }
             process.stderr.write('\n');
         }
@@ -304,6 +335,7 @@ export default class Files extends Command {
                 const binResponse = await apiRequest(endpoint.method, apiPath, {
                     params: Object.keys(queryParams).length > 0 ? queryParams : undefined,
                     data,
+                    contentType: endpoint.bodyMediaType || undefined,
                     contextName: flags.context,
                     binary: true,
                 });
@@ -329,6 +361,7 @@ export default class Files extends Command {
                 const raw = await apiRequest(endpoint.method, apiPath, {
                     params: Object.keys(queryParams).length > 0 ? queryParams : undefined,
                     data,
+                    contentType: endpoint.bodyMediaType || undefined,
                     contextName: flags.context,
                     binary: true,
                 });
@@ -349,6 +382,7 @@ export default class Files extends Command {
                 response = await apiRequest(endpoint.method, apiPath, {
                     params: Object.keys(queryParams).length > 0 ? queryParams : undefined,
                     data,
+                    contentType: endpoint.bodyMediaType || undefined,
                     contextName: flags.context,
                     acceptAny: true,
                 });

package/dist/commands/financial-instrument-transactions.d.ts

@@ -0,0 +1,56 @@
+import { Command } from '@oclif/core';
+export default class FinancialInstrumentTransactions extends Command {
+    static description: string;
+    static examples: string[];
+    static args: {
+        action: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+        id: import("@oclif/core/interfaces").Arg<string | undefined, Record<string, unknown>>;
+    };
+    static flags: {
+        context: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        output: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        table: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        csv: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        data: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        file: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        set: import("@oclif/core/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        page: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        limit: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        include: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        search: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'sort-by': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        filter: import("@oclif/core/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        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 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 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;
+    private printTable;
+    private printCsv;
+}