@commercelayer/cli-plugin-provisioning 2.0.9 → 2.1.0

package/lib/commands/provisioning/update.js

@@ -1,59 +1,69 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-const base_1 = tslib_1.__importStar(require("../../base"));
 const cli_core_1 = require("@commercelayer/cli-core");
+const base_1 = tslib_1.__importStar(require("../../base"));
 const lang_1 = require("../../lang");
-const OPERATION = 'update';
+const OPERATION = "update";
 class ProvisioningUpdate extends base_1.default {
-    static description = 'update an existing resource';
-    static aliases = ['prov:update', 'pu', 'pupdate', 'pupd'];
+    static description = "update an existing resource";
+    static aliases = ["prov:update", "pu", "pupdate", "pupd"];
     static examples = [
-        '$ commercelayer provisioning:update roles/<roleId> -a reference=referenceId',
+        "$ commercelayer provisioning:update roles/<roleId> -a reference=referenceId",
         '$ commercelayer prov:update roles <roleId> -a reference_origin="Ref Origin"',
         '$ cl prov:update roles/<roleId> -m meta_key="meta value"',
         '$ cl pu roles <roleId> -M meta_key="metadata overwrite',
-        '$ clayer prov:update roles <roleId> -D /path/to/data/file/data.json',
+        "$ clayer prov:update roles <roleId> -D /path/to/data/file/data.json",
     ];
     static flags = {
         ...base_1.default.flags,
         attribute: base_1.Flags.string({
-            char: 'a',
-            description: 'define a resource attribute',
+            char: "a",
+            description: "define a resource attribute",
             multiple: true,
         }),
         object: base_1.Flags.string({
-            char: 'O',
-            description: 'define a resource object attribute',
+            char: "O",
+            description: "define a resource object attribute",
             multiple: true,
         }),
         relationship: base_1.Flags.string({
-            char: 'r',
-            description: 'define a relationship with another resource',
+            char: "r",
+            description: "define a relationship with another resource",
             multiple: true,
         }),
         metadata: base_1.Flags.string({
-            char: 'm',
-            description: 'define a metadata attribute and merge it with the metadata already present in the remote resource',
+            char: "m",
+            description: "define a metadata attribute and merge it with the metadata already present in the remote resource",
             multiple: true,
-            exclusive: ['metadata-replace'],
+            exclusive: ["metadata-replace"],
         }),
-        'metadata-replace': base_1.Flags.string({
-            char: 'M',
-            description: 'define a metadata attribute and replace every item already present in the remote resource',
+        "metadata-replace": base_1.Flags.string({
+            char: "M",
+            description: "define a metadata attribute and replace every item already present in the remote resource",
             multiple: true,
-            exclusive: ['metadata'],
+            exclusive: ["metadata"],
         }),
         data: base_1.Flags.string({
-            char: 'D',
-            description: 'the data file to use as request body',
+            char: "D",
+            description: "the data file to use as request body",
             multiple: false,
-            exclusive: ['attribute', 'relationship', 'metadata', 'metadata-replace', 'doc' /*, FLAG_LOAD_PARAMS, FLAG_SAVE_PARAMS */],
-        })
+            exclusive: [
+                "attribute",
+                "relationship",
+                "metadata",
+                "metadata-replace",
+                "doc" /*, FLAG_LOAD_PARAMS, FLAG_SAVE_PARAMS */,
+            ],
+        }),
     };
     static args = {
         ...base_1.default.args,
-        id: base_1.Args.string({ name: 'id', description: 'id of the resource to update', required: false }),
+        id: base_1.Args.string({
+            name: "id",
+            description: "id of the resource to update",
+            required: false,
+        }),
     };
     async run() {
         const { args, flags } = await this.parse(ProvisioningUpdate);
@@ -62,16 +72,21 @@ class ProvisioningUpdate extends base_1.default {
         // const loadParams = flags[FLAG_LOAD_PARAMS]
         // const saveCmd = flags[FLAG_SAVE_PARAMS]
         // if (saveCmd) this.checkAlias(saveCmd, resource.api, OPERATION, this.config)
-        const showHeaders = flags.headers || flags['headers-only'];
+        const showHeaders = flags.headers || flags["headers-only"];
         // Raw request
         if (flags.data) {
             try {
-                const baseUrl = cli_core_1.clApi.baseURL('provisioning', undefined, flags.domain);
+                const baseUrl = cli_core_1.clApi.baseURL("provisioning", undefined, flags.domain);
                 const accessToken = flags.accessToken;
-                const rawRes = await cli_core_1.clApi.request.raw({ operation: cli_core_1.clApi.Operation.Update, baseUrl, accessToken, resource: resource.api }, cli_core_1.clApi.request.readDataFile(flags.data), id);
+                const rawRes = await cli_core_1.clApi.request.raw({
+                    operation: cli_core_1.clApi.Operation.Update,
+                    baseUrl,
+                    accessToken,
+                    resource: resource.api,
+                }, cli_core_1.clApi.request.readDataFile(flags.data), id);
                 const out = flags.raw ? rawRes : cli_core_1.clApi.response.denormalize(rawRes);
                 this.printOutput(out, flags);
-                this.log(`\n${cli_core_1.clColor.style.success('Successfully')} updated resource of type ${cli_core_1.clColor.style.resource(resource.api)} with id ${cli_core_1.clColor.style.id(rawRes.id)}\n`);
+                this.log(`\n${cli_core_1.clColor.style.success("Successfully")} updated resource of type ${cli_core_1.clColor.style.resource(resource.api)} with id ${cli_core_1.clColor.style.id(rawRes.id)}\n`);
                 return out;
             }
             catch (error) {
@@ -86,16 +101,16 @@ class ProvisioningUpdate extends base_1.default {
         // Relationships flags
         const relationships = this.relationshipFlag(flags.relationship);
         // Metadata flags
-        const metadata = this.metadataFlag(flags.metadata || flags['metadata-replace']);
+        const metadata = this.metadataFlag(flags.metadata || flags["metadata-replace"]);
         // Relationships
         if (relationships && Object.keys(relationships).length > 0)
             Object.entries(relationships).forEach(([key, value]) => {
                 const relSdk = cl[value.type];
-                const rel = relSdk.relationship(((value.id === null) || (value.id === 'null')) ? null : value);
+                const rel = relSdk.relationship(value.id === null || value.id === "null" ? null : value);
                 attributes[key] = rel;
             });
         // Objects
-        if (objects && (Object.keys(objects).length > 0)) {
+        if (objects && Object.keys(objects).length > 0) {
             for (const o of Object.keys(objects)) {
                 if (Object.keys(attributes).includes(o))
                     this.warn(`Object ${o} will overwrite attribute ${o}`);
@@ -104,31 +119,35 @@ class ProvisioningUpdate extends base_1.default {
             }
         }
         // Metadata
-        if (metadata && (Object.keys(metadata).length > 0)) {
+        if (metadata && Object.keys(metadata).length > 0) {
             if (attributes.metadata)
-                this.warn(`Attribute ${cli_core_1.clColor.style.attribute('metadata')} will be overwritten by the content defined with the flags ${cli_core_1.clColor.style.flag('-m/-M')}`);
+                this.warn(`Attribute ${cli_core_1.clColor.style.attribute("metadata")} will be overwritten by the content defined with the flags ${cli_core_1.clColor.style.flag("-m/-M")}`);
             attributes.metadata = metadata;
         }
         // Include flags
         const include = this.includeFlag(flags.include, relationships);
         // Fields flags
         const fields = this.fieldsFlag(flags.fields, resource.type);
-        const rawReader = flags.raw ? cl.addRawResponseReader({ headers: showHeaders }) : undefined;
+        const rawReader = flags.raw
+            ? cl.addRawResponseReader({ headers: showHeaders })
+            : undefined;
         const reqReader = flags.doc ? (0, lang_1.addRequestReader)(cl) : undefined;
         const params = {};
         try {
             const resSdk = cl[resource.api];
             this.checkOperation(resSdk, OPERATION, attributes);
-            if (include && (include.length > 0))
+            if (include && include.length > 0)
                 params.include = include;
-            if (fields && (Object.keys(fields).length > 0))
+            if (fields && Object.keys(fields).length > 0)
                 params.fields = fields;
             // Metadata attributes merge
             if (flags.metadata) {
-                const params = { fields: { [resource.api]: ['metadata'] } };
+                const params = {
+                    fields: { [resource.api]: ["metadata"] },
+                };
                 const remRes = await resSdk.retrieve(id, params);
                 const remMeta = remRes.metadata;
-                if (remMeta && (Object.keys(remMeta).length > 0))
+                if (remMeta && Object.keys(remMeta).length > 0)
                     attributes.metadata = { ...remMeta, ...metadata };
             }
             attributes.id = id;
@@ -138,10 +157,10 @@ class ProvisioningUpdate extends base_1.default {
             //   if (savedParams) mergeCommandParams(params, savedParams)
             // }
             const res = await resSdk.update(attributes, params);
-            const out = (flags.raw && rawReader) ? rawReader.rawResponse : res;
+            const out = flags.raw && rawReader ? rawReader.rawResponse : res;
             this.printHeaders(rawReader?.headers, flags);
             this.printOutput(out, flags);
-            this.log(`\n${cli_core_1.clColor.style.success('Successfully')} updated resource of type ${cli_core_1.clColor.style.resource(resource.type)} with id ${cli_core_1.clColor.style.id(res.id)}\n`);
+            this.log(`\n${cli_core_1.clColor.style.success("Successfully")} updated resource of type ${cli_core_1.clColor.style.resource(resource.type)} with id ${cli_core_1.clColor.style.id(res.id)}\n`);
             // Save command arguments
             // if (saveCmd) this.saveParams(saveCmd, { type: resource.api }, OPERATION, params)
             return out;
@@ -149,7 +168,7 @@ class ProvisioningUpdate extends base_1.default {
         catch (error) {
             if ((0, lang_1.isRequestInterrupted)(error) && reqReader) {
                 await this.showLiveDocumentation(reqReader.request, undefined, flags);
-                cl.removeInterceptor('request', reqReader.id);
+                cl.removeInterceptor("request", reqReader.id);
             }
             else
                 this.printError(error, flags, args);

package/lib/csv.d.ts

@@ -1,3 +1,3 @@
 declare const formatCsv: (obj: object[], flags?: any) => string;
 declare const exportCsv: (output: any, flags: any, path: string) => Promise<boolean>;
-export { formatCsv, exportCsv };
+export { exportCsv, formatCsv };

package/lib/csv.js

@@ -1,10 +1,10 @@
 "use strict";
 /* eslint-disable @typescript-eslint/no-unsafe-argument */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.exportCsv = exports.formatCsv = void 0;
-const json_2_csv_1 = require("json-2-csv");
-const fs_1 = require("fs");
+exports.formatCsv = exports.exportCsv = void 0;
+const node_fs_1 = require("node:fs");
 const cli_core_1 = require("@commercelayer/cli-core");
+const json_2_csv_1 = require("json-2-csv");
 const formatCsv = (obj, flags) => {
     return cli_core_1.clOutput.printCSV(obj, flags);
 };
@@ -15,30 +15,30 @@ const analyzeItem = (name, item, flags) => {
         if (Array.isArray(item)) {
             for (const i of item) {
                 const ks = analyzeItem(name, i, flags);
-                ks.forEach(k => keys.add(k));
+                ks.forEach((k) => { keys.add(k); });
             }
         }
-        else if (typeof item === 'object') {
+        else if (typeof item === "object") {
             const type = item.type;
             const fields = [];
             flags.fields.forEach((f) => {
-                if (!name && (!f.includes('/')))
-                    fields.push(...f.split(','));
-                else if (type && f.startsWith(type + '/'))
-                    fields.push(...f.substring(f.indexOf('/') + 1).split(','));
+                if (!name && !f.includes("/"))
+                    fields.push(...f.split(","));
+                else if (type && f.startsWith(type + "/"))
+                    fields.push(...f.substring(f.indexOf("/") + 1).split(","));
             });
             for (const [k, v] of Object.entries(item)) {
                 // exclude 'type' fields
-                if (k === 'type')
+                if (k === "type")
                     continue;
                 // exclude 'id' fields that are not explicitly included
-                if ((k === 'id') && !fields.includes(k))
+                if (k === "id" && !fields.includes(k))
                     continue;
-                const ks = analyzeItem(`${name ? name + '.' : ''}${k}`, v, flags);
-                ks.forEach(k => keys.add(k));
+                const ks = analyzeItem(`${name ? name + "." : ""}${k}`, v, flags);
+                ks.forEach((k) => { keys.add(k); });
             }
         }
-        else if (name && (name !== 'type') && !name.endsWith('.type')) {
+        else if (name && name !== "type" && !name.endsWith(".type")) {
             // 'type' field can't be included in CLI filter but is always included in API response
             keys.add(name);
         }
@@ -48,36 +48,39 @@ const exportCsv = async (output, flags, path) => {
     // Rename header fields
     const header = {};
     if (flags.header) {
-        flags.header.join(',').split(',').forEach((h) => {
-            const ft = h.split(':');
+        flags.header
+            .join(",")
+            .split(",")
+            .forEach((h) => {
+            const ft = h.split(":");
             header[ft[0]] = ft[1];
         });
     }
     // Include fields
     const keys = analyzeItem(undefined, output, flags);
-    const includeKeys = [...keys].map(k => {
+    const includeKeys = [...keys].map((k) => {
         return { field: k, title: header[k] || k };
     });
     // Exclude fields
     const excludeKeys = [];
     if (flags.fields) {
-        if (!flags.fields.includes('id'))
-            excludeKeys.push('id');
-        if (!flags.fields.includes('type'))
-            excludeKeys.push('type');
+        if (!flags.fields.includes("id"))
+            excludeKeys.push("id");
+        if (!flags.fields.includes("type"))
+            excludeKeys.push("type");
     }
     if (flags.include) {
         const include = [];
-        flags.include.forEach((i) => include.push(...i.split(',')));
+        flags.include.forEach((i) => { include.push(...i.split(",")); });
         include.forEach((i) => {
             // excludeKeys.push(`${i}.id`)
             excludeKeys.push(`${i}.type`);
         });
     }
     // Delimiter
-    let delimiter = flags.delimiter || ',';
-    if (delimiter && (delimiter === 'TAB'))
-        delimiter = '\t';
+    let delimiter = flags.delimiter || ",";
+    if (delimiter && delimiter === "TAB")
+        delimiter = "\t";
     const csv = (0, json_2_csv_1.json2csv)(output, {
         excelBOM: true,
         expandArrayObjects: true,
@@ -85,14 +88,14 @@ const exportCsv = async (output, flags, path) => {
         sortHeader: false,
         unwindArrays: true,
         useDateIso8601Format: true,
-        emptyFieldValue: '',
+        emptyFieldValue: "",
         // excludeKeys,
         keys: includeKeys,
         delimiter: {
             field: delimiter,
         },
     });
-    (0, fs_1.writeFileSync)(path, csv);
+    (0, node_fs_1.writeFileSync)(path, csv);
     return await Promise.resolve(true);
 };
 exports.exportCsv = exportCsv;

package/lib/lang/curl.d.ts

@@ -1,4 +1,4 @@
-import type { QueryParams } from '@commercelayer/provisioning-sdk';
-import { type RequestData } from './request';
+import type { QueryParams } from "@commercelayer/provisioning-sdk";
+import { type RequestData } from "./request";
 declare const buildCurl: (request: RequestData, _params?: QueryParams) => string;
 export { buildCurl };

package/lib/lang/curl.js

@@ -4,9 +4,11 @@ exports.buildCurl = void 0;
 const _1 = require(".");
 const request_1 = require("./request");
 const headers = (request) => {
-    return Object.entries((0, request_1.getHeaders)(request)).map(([h, v]) => {
+    return Object.entries((0, request_1.getHeaders)(request))
+        .map(([h, v]) => {
         return `-H '${h}: ${v}'`;
-    }).join(' \\\n  ');
+    })
+        .join(" \\\n  ");
 };
 const buildCurl = (request, _params) => {
     let cmd = `curl -g -X ${(0, request_1.getMethod)(request)} \\\n  '${(0, _1.getFullUrl)(request)}' \\\n  ${headers(request)}`;

package/lib/lang/index.d.ts

@@ -1,7 +1,7 @@
-import type { QueryParams } from '@commercelayer/provisioning-sdk';
-import type { RequestData } from './request';
-export { isRequestInterrupted } from './request';
-export * from './request';
+import type { QueryParams } from "@commercelayer/provisioning-sdk";
+import type { RequestData } from "./request";
+export * from "./request";
+export { isRequestInterrupted } from "./request";
 export declare const availableLanguages: string[];
 export declare const languageInfo: {
     curl: {
@@ -16,4 +16,4 @@ export declare const languageInfo: {
 declare const buildCommand: (lang: string, request: RequestData, params?: QueryParams, flags?: any) => string;
 declare const getLanguageArg: (flags: any) => string;
 declare const promptLanguage: () => Promise<string>;
-export { getLanguageArg, buildCommand, promptLanguage };
+export { buildCommand, getLanguageArg, promptLanguage };

package/lib/lang/index.js

@@ -1,29 +1,33 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.promptLanguage = exports.buildCommand = exports.getLanguageArg = exports.languageInfo = exports.availableLanguages = exports.isRequestInterrupted = void 0;
+exports.promptLanguage = exports.getLanguageArg = exports.buildCommand = exports.languageInfo = exports.availableLanguages = exports.isRequestInterrupted = void 0;
 const tslib_1 = require("tslib");
+const inquirer_1 = tslib_1.__importDefault(require("inquirer"));
 const curl_1 = require("./curl");
-const ruby_1 = require("./ruby");
 const node_1 = require("./node");
-const inquirer_1 = tslib_1.__importDefault(require("inquirer"));
+const ruby_1 = require("./ruby");
+tslib_1.__exportStar(require("./request"), exports);
 var request_1 = require("./request");
 Object.defineProperty(exports, "isRequestInterrupted", { enumerable: true, get: function () { return request_1.isRequestInterrupted; } });
-tslib_1.__exportStar(require("./request"), exports);
-exports.availableLanguages = ['curl', 'node'];
+exports.availableLanguages = ["curl", "node"];
 exports.languageInfo = {
-    curl: { name: 'cURL', label: 'cURL command' },
-    node: { name: 'Node', label: 'Node SDK source code' },
+    curl: { name: "cURL", label: "cURL command" },
+    node: { name: "Node", label: "Node SDK source code" },
 };
 const buildCommand = (lang, request, params, flags) => {
     if (lang)
         switch (lang.toLowerCase()) {
-            case 'curl': return (0, curl_1.buildCurl)(request, params);
-            case 'node': return (0, node_1.buildTypescript)(request, params, flags);
-            case 'ruby': return (0, ruby_1.buildRuby)(request, params);
-            default: return '';
+            case "curl":
+                return (0, curl_1.buildCurl)(request, params);
+            case "node":
+                return (0, node_1.buildTypescript)(request, params, flags);
+            case "ruby":
+                return (0, ruby_1.buildRuby)(request, params);
+            default:
+                return "";
         }
     else
-        return '';
+        return "";
 };
 exports.buildCommand = buildCommand;
 const getLanguageArg = (flags) => {
@@ -38,14 +42,18 @@ const getLanguageArg = (flags) => {
 };
 exports.getLanguageArg = getLanguageArg;
 const promptLanguage = async () => {
-    return await inquirer_1.default.prompt([{
-            type: 'list',
-            name: 'language',
-            message: 'Select a format to show the command live documentation:',
-            choices: exports.availableLanguages.map(l => {
+    return await inquirer_1.default
+        .prompt([
+        {
+            type: "list",
+            name: "language",
+            message: "Select a format to show the command live documentation:",
+            choices: exports.availableLanguages.map((l) => {
                 const info = exports.languageInfo[l];
                 return { name: info.label, value: l, short: info.name };
             }),
-        }]).then(answers => answers.language);
+        },
+    ])
+        .then((answers) => answers.language);
 };
 exports.promptLanguage = promptLanguage;

package/lib/lang/node.d.ts

@@ -1,4 +1,4 @@
-import type { QueryParams } from '@commercelayer/provisioning-sdk';
-import type { RequestData } from './request';
+import type { QueryParams } from "@commercelayer/provisioning-sdk";
+import type { RequestData } from "./request";
 declare const buildTypescript: (request: RequestData, params?: QueryParams, flags?: any) => string;
 export { buildTypescript };

package/lib/lang/node.js

@@ -1,26 +1,26 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.buildTypescript = void 0;
-const _1 = require(".");
 const cli_core_1 = require("@commercelayer/cli-core");
+const _1 = require(".");
 const buildTypescript = (request, params, flags) => {
-    const hasParams = params && (Object.keys(params).length > 0);
+    const hasParams = params && Object.keys(params).length > 0;
     const operation = (0, _1.getOperation)(request);
-    const qpSuffix = (operation.name === 'list') ? 'List' : 'Retrieve';
-    const paramsImport = hasParams ? `, { QueryParams${qpSuffix} }` : '';
+    const qpSuffix = operation.name === "list" ? "List" : "Retrieve";
+    const paramsImport = hasParams ? `, { QueryParams${qpSuffix} }` : "";
     let ts = `import commercelayer${paramsImport} from '@commercelayer/provisioning-sdk'`;
     ts += `\nconst accessToken = '${flags.accessToken}'`;
     if (flags.domain)
         ts += `\nconst domain = '${flags.domain}'`;
-    ts += `\n\nconst cl = commercelayer({ accessToken${flags.domain ? ', domain' : ''} })`;
+    ts += `\n\nconst cl = commercelayer({ accessToken${flags.domain ? ", domain" : ""} })`;
     if (hasParams)
         ts += `\n\nconst params: QueryParams${qpSuffix} = ${cli_core_1.clOutput.printObject(params, { color: false })}`;
     const args = [];
     if (operation.id)
         args.push(`'${operation.id}'`);
     if (hasParams)
-        args.push('params');
-    ts += `\n\ncl.${operation.resource}.${operation.name}(${args.join(', ')}).then(console.log)`;
+        args.push("params");
+    ts += `\n\ncl.${operation.resource}.${operation.name}(${args.join(", ")}).then(console.log)`;
     return ts;
 };
 exports.buildTypescript = buildTypescript;

package/lib/lang/request.d.ts

@@ -1,5 +1,5 @@
-import { type CommerceLayerProvisioningClient } from '@commercelayer/provisioning-sdk';
-import { type KeyValString } from '@commercelayer/cli-core';
+import { type KeyValString } from "@commercelayer/cli-core";
+import { type CommerceLayerProvisioningClient } from "@commercelayer/provisioning-sdk";
 type RequestData = {
     baseUrl: string;
     path: string;
@@ -22,8 +22,8 @@ type RequestReader = {
 };
 declare const addRequestReader: (cl: CommerceLayerProvisioningClient, interrupt?: boolean) => RequestReader;
 declare const isRequestInterrupted: (error: unknown) => boolean;
+export type { OperationData, RequestData, RequestReader };
 export { addRequestReader, isRequestInterrupted };
-export type { RequestReader, RequestData, OperationData };
 export declare const getMethod: (request: RequestData) => string;
 export declare const getFullUrl: (request: RequestData) => string;
 export declare const getResource: (request: RequestData) => string;