@salesforce/plugin-custom-metadata 1.1.0 → 2.0.0

package/lib/lib/helpers/createUtil.js

@@ -1,35 +1,34 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateUtil = void 0;
 /*
  * Copyright (c) 2020, salesforce.com, inc.
  * All rights reserved.
  * Licensed under the BSD 3-Clause license.
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CreateUtil = void 0;
-const core_1 = require("@salesforce/core");
-const xml2js_1 = require("xml2js");
+const fs = require("fs");
+const path = require("path");
+const fast_xml_parser_1 = require("fast-xml-parser");
 const templates_1 = require("../templates/templates");
+const fieldTypeMap = {
+    Checkbox: 'boolean',
+    Date: 'date',
+    DateTime: 'dateTime',
+    Email: 'string',
+    Phone: 'string',
+    Picklist: 'string',
+    Text: 'string',
+    TextArea: 'string',
+    LongTextArea: 'string',
+    Url: 'string',
+};
 // NOTE: the template string indentation is important to output well-formatted XML. Altering that whitespace will change the whitespace of the output.
 class CreateUtil {
     /**
      * Number and Percent types will be int or double depending on their respective scale values.
      * If the scale === 0, it is an int, otherwise it is a double
      */
-    constructor() {
-        this.fieldTypeMap = {
-            Checkbox: 'boolean',
-            Date: 'date',
-            DateTime: 'dateTime',
-            Email: 'string',
-            Phone: 'string',
-            Picklist: 'string',
-            Text: 'string',
-            TextArea: 'string',
-            LongTextArea: 'string',
-            Url: 'string',
-        };
-    }
     /**
      * Creates the Custom Metadata Record
      *
@@ -37,24 +36,24 @@ class CreateUtil {
      * @return void
      */
     async createRecord(createConfig) {
-        const outputFilePath = `${createConfig.outputdir}/${createConfig.typename}.${createConfig.recordname}.md-meta.xml`;
+        const outputFilePath = path.join(createConfig.outputdir, `${createConfig.typename}.${createConfig.recordname}.md-meta.xml`);
         const newRecordContent = this.getRecordTemplate(createConfig.label, createConfig.protected, this.buildCustomFieldXml(createConfig.fileData, createConfig.varargs, createConfig.ignorefields));
-        return core_1.fs.writeFile(outputFilePath, newRecordContent);
+        return fs.promises.writeFile(outputFilePath, newRecordContent);
     }
+    /**
+     *
+     * @param fieldDirPath path to a /fields folder that contains all the fields to read
+     * @param fileNames filenames in that folder that should be read
+     * @returns CustomField[]
+     */
     async getFileData(fieldDirPath, fileNames) {
-        const ret = [];
-        let filePath = '';
-        let fileData;
-        let str = '';
-        for (const file of fileNames) {
-            filePath = `${fieldDirPath}/${file}`;
-            fileData = await core_1.fs.readFile(filePath);
-            str = fileData.toString('utf8');
-            (0, xml2js_1.parseString)(str, (err, res) => {
-                ret.push(res);
-            });
-        }
-        return ret;
+        const parser = new fast_xml_parser_1.XMLParser();
+        return Promise.all(fileNames
+            .map((file) => path.join(fieldDirPath, file))
+            .map(async (filePath) => {
+            const fileData = await fs.promises.readFile(filePath, 'utf8');
+            return parser.parse(fileData).CustomField;
+        }));
     }
     /**
      * Filenames should have the suffix of '__mdt'. This will append that suffix if it does not exist.
@@ -62,12 +61,7 @@ class CreateUtil {
      * @param  typename Name of file
      */
     appendDirectorySuffix(typename) {
-        if (typename.endsWith('__mdt')) {
-            return typename;
-        }
-        else {
-            return typename + '__mdt';
-        }
+        return typename.endsWith('__mdt') ? typename : `${typename}__mdt`;
     }
     /**
      * Get the field primitive type from the custom metadata type that has a matching field name.
@@ -76,24 +70,12 @@ class CreateUtil {
      * @param  fieldName Name of the field
      * @return {string} Type used by a custom metadata record
      */
-    getFieldPrimitiveType(fileData = [], fieldName = '') {
-        let thisFieldName = '';
-        let type = '';
-        let ret = 'string';
-        for (const file of fileData) {
-            thisFieldName = file.CustomField.fullName[0];
-            type = file.CustomField.type[0];
-            if (type === 'Number' || type === 'Percent') {
-                ret = this.getNumberType(type, file.CustomField.scale[0]);
-            }
-            else {
-                ret = this.fieldTypeMap[type];
-            }
-            if (thisFieldName === fieldName) {
-                return ret;
-            }
-        }
-        return ret;
+    getFieldPrimitiveType(fileData = [], fieldName) {
+        var _a;
+        const matchingFile = fileData.find((file) => file.fullName === fieldName);
+        return matchingFile && ['Number', 'Percent'].includes(matchingFile.type)
+            ? this.getNumberType(matchingFile.type, matchingFile.scale)
+            : (_a = fieldTypeMap[matchingFile === null || matchingFile === void 0 ? void 0 : matchingFile.type]) !== null && _a !== void 0 ? _a : 'string';
     }
     /**
      * Get the field type from the custom metadata type that has a matching field name.
@@ -103,15 +85,8 @@ class CreateUtil {
      * @return {string} Data Type of the field.
      */
     getFieldDataType(fileData = [], fieldName = '') {
-        let thisFieldName = '';
-        let type = '';
-        for (const file of fileData) {
-            thisFieldName = file.CustomField.fullName[0];
-            type = file.CustomField.type[0];
-            if (thisFieldName === fieldName) {
-                return type;
-            }
-        }
+        var _a;
+        return (_a = fileData.find((file) => file.fullName === fieldName)) === null || _a === void 0 ? void 0 : _a.type;
     }
     /**
      * Goes through the file data that has been genreated and gets all of the field names and adds the
@@ -122,13 +97,7 @@ class CreateUtil {
      * @return [] Array of field names
      */
     getFieldNames(fileData, nameField) {
-        const metadataTypeFields = [];
-        for (const file of fileData) {
-            const fullName = file.CustomField.fullName[0];
-            metadataTypeFields.push(fullName);
-        }
-        metadataTypeFields.push(nameField);
-        return metadataTypeFields;
+        return [...fileData.map((file) => file.fullName), nameField];
     }
     /**
      * Takes JSON representation of CLI varargs and converts them to xml with help
@@ -140,21 +109,14 @@ class CreateUtil {
      */
     buildCustomFieldXml(fileData, cliParams, ignoreFields) {
         let ret = '';
-        let type = '';
-        let dataType = '';
         const templates = new templates_1.Templates();
         for (const fieldName of Object.keys(cliParams)) {
-            type = this.getFieldPrimitiveType(fileData, fieldName);
-            dataType = this.getFieldDataType(fileData, fieldName);
+            const type = this.getFieldPrimitiveType(fileData, fieldName);
+            const dataType = this.getFieldDataType(fileData, fieldName);
             // Added functionality to handle the igonre fields scenario.
-            if (templates.canConvert(dataType)) {
+            if (templates.canConvert(dataType) || !ignoreFields) {
                 ret += this.getFieldTemplate(fieldName, cliParams[fieldName], type);
             }
-            else {
-                if (!ignoreFields) {
-                    ret += this.getFieldTemplate(fieldName, cliParams[fieldName], type);
-                }
-            }
         }
         return ret;
     }
@@ -167,11 +129,7 @@ class CreateUtil {
      * @return {string} int or double
      */
     getNumberType(type, scale) {
-        if ((type === 'Number' && parseFloat(scale) === 0) ||
-            (type === 'Percent' && parseFloat(scale) === 0)) {
-            return 'int';
-        }
-        return 'double';
+        return ['Number', 'Percent'].includes(type) && scale === 0 ? 'int' : 'double';
     }
     /**
      * Template for a single customMetadata record value. This is used by helper.getRecordTemplate.
@@ -182,18 +140,8 @@ class CreateUtil {
      * @return {string} String representation of XML
      */
     getFieldTemplate(fieldName, val, type) {
-        // update to handle the null situation
-        let value = '';
-        const cleanValue = String(val)
-            .replace(/&/g, '&')
-            .replace(/</g, '&lt;')
-            .replace(/>/g, '&gt;');
-        if (val === null || val === '') {
-            value = '<value xsi:nil="true"/>';
-        }
-        else {
-            value = `<value xsi:type="xsd:${type}">${cleanValue}</value>`;
-        }
+        const cleanValue = String(val).replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;');
+        const value = val === null || val === '' ? '<value xsi:nil="true"/>' : `<value xsi:type="xsd:${type}">${cleanValue}</value>`;
         return `
     <values>
         <field>${fieldName}</field>

package/lib/lib/helpers/createUtil.js.map

@@ -1 +1 @@
-{"version":3,"file":"createUtil.js","sourceRoot":"","sources":["../../../src/lib/helpers/createUtil.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,2CAAsC;AACtC,mCAAqC;AAGrC,sDAAmD;AAEnD,sJAAsJ;AACtJ,MAAa,UAAU;IAGrB;;;OAGG;IACH;QACE,IAAI,CAAC,YAAY,GAAG;YAClB,QAAQ,EAAE,SAAS;YACnB,IAAI,EAAE,MAAM;YACZ,QAAQ,EAAE,UAAU;YACpB,KAAK,EAAE,QAAQ;YACf,KAAK,EAAE,QAAQ;YACf,QAAQ,EAAE,QAAQ;YAClB,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,QAAQ;YAClB,YAAY,EAAE,QAAQ;YACtB,GAAG,EAAE,QAAQ;SACd,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,YAAY,CAAC,YAA0B;QAClD,MAAM,cAAc,GAAG,GAAG,YAAY,CAAC,SAAS,IAAI,YAAY,CAAC,QAAQ,IAAI,YAAY,CAAC,UAAU,cAAc,CAAC;QACnH,MAAM,gBAAgB,GAAG,IAAI,CAAC,iBAAiB,CAC7C,YAAY,CAAC,KAAK,EAClB,YAAY,CAAC,SAAS,EACtB,IAAI,CAAC,mBAAmB,CACtB,YAAY,CAAC,QAAQ,EACrB,YAAY,CAAC,OAAO,EACpB,YAAY,CAAC,YAAY,CAC1B,CACF,CAAC;QAEF,OAAO,SAAE,CAAC,SAAS,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAAC;IACxD,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,YAAY,EAAE,SAAS;QAC9C,MAAM,GAAG,GAAG,EAAE,CAAC;QACf,IAAI,QAAQ,GAAG,EAAE,CAAC;QAClB,IAAI,QAAQ,CAAC;QACb,IAAI,GAAG,GAAG,EAAE,CAAC;QAEb,KAAK,MAAM,IAAI,IAAI,SAAS,EAAE;YAC5B,QAAQ,GAAG,GAAG,YAAY,IAAI,IAAI,EAAE,CAAC;YACrC,QAAQ,GAAG,MAAM,SAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;YACvC,GAAG,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YAEhC,IAAA,oBAAW,EAAC,GAAG,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;gBAC5B,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAChB,CAAC,CAAC,CAAC;SACJ;QAED,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;;OAIG;IACI,qBAAqB,CAAC,QAAgB;QAC3C,IAAI,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;YAC9B,OAAO,QAAQ,CAAC;SACjB;aAAM;YACL,OAAO,QAAQ,GAAG,OAAO,CAAC;SAC3B;IACH,CAAC;IAED;;;;;;OAMG;IACI,qBAAqB,CAAC,WAA0B,EAAE,EAAE,SAAS,GAAG,EAAE;QACvE,IAAI,aAAa,GAAG,EAAE,CAAC;QACvB,IAAI,IAAI,GAAG,EAAE,CAAC;QACd,IAAI,GAAG,GAAG,QAAQ,CAAC;QAEnB,KAAK,MAAM,IAAI,IAAI,QAAQ,EAAE;YAC3B,aAAa,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;YAC7C,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAEhC,IAAI,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,SAAS,EAAE;gBAC3C,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;aAC3D;iBAAM;gBACL,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;aAC/B;YAED,IAAI,aAAa,KAAK,SAAS,EAAE;gBAC/B,OAAO,GAAG,CAAC;aACZ;SACF;QAED,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;;;;OAMG;IACI,gBAAgB,CAAC,WAA0B,EAAE,EAAE,SAAS,GAAG,EAAE;QAClE,IAAI,aAAa,GAAG,EAAE,CAAC;QACvB,IAAI,IAAI,GAAG,EAAE,CAAC;QAEd,KAAK,MAAM,IAAI,IAAI,QAAQ,EAAE;YAC3B,aAAa,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;YAC7C,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAEhC,IAAI,aAAa,KAAK,SAAS,EAAE;gBAC/B,OAAO,IAAI,CAAC;aACb;SACF;IACH,CAAC;IACD;;;;;;;OAOG;IACI,aAAa,CAAC,QAAQ,EAAE,SAAS;QACtC,MAAM,kBAAkB,GAAG,EAAE,CAAC;QAC9B,KAAK,MAAM,IAAI,IAAI,QAAQ,EAAE;YAC3B,MAAM,QAAQ,GAAW,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;YACtD,kBAAkB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SACnC;QACD,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAEnC,OAAO,kBAAkB,CAAC;IAC5B,CAAC;IAED;;;;;;;OAOG;IACK,mBAAmB,CACzB,QAAuB,EACvB,SAAiB,EACjB,YAAqB;QAErB,IAAI,GAAG,GAAG,EAAE,CAAC;QACb,IAAI,IAAI,GAAG,EAAE,CAAC;QACd,IAAI,QAAQ,GAAG,EAAE,CAAC;QAClB,MAAM,SAAS,GAAG,IAAI,qBAAS,EAAE,CAAC;QAClC,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;YAC9C,IAAI,GAAG,IAAI,CAAC,qBAAqB,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;YACvD,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;YACtD,4DAA4D;YAC5D,IAAI,SAAS,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;gBAClC,GAAG,IAAI,IAAI,CAAC,gBAAgB,CAAC,SAAS,EAAE,SAAS,CAAC,SAAS,CAAC,EAAE,IAAI,CAAC,CAAC;aACrE;iBAAM;gBACL,IAAI,CAAC,YAAY,EAAE;oBACjB,GAAG,IAAI,IAAI,CAAC,gBAAgB,CAAC,SAAS,EAAE,SAAS,CAAC,SAAS,CAAC,EAAE,IAAI,CAAC,CAAC;iBACrE;aACF;SACF;QAED,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;;;;;OAOG;IACK,aAAa,CAAC,IAAY,EAAE,KAAa;QAC/C,IACE,CAAC,IAAI,KAAK,QAAQ,IAAI,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC9C,CAAC,IAAI,KAAK,SAAS,IAAI,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAC/C;YACA,OAAO,KAAK,CAAC;SACd;QAED,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;;;;OAOG;IACK,gBAAgB,CAAC,SAAiB,EAAE,GAAW,EAAE,IAAY;QACnE,sCAAsC;QACtC,IAAI,KAAK,GAAG,EAAE,CAAC;QACf,MAAM,UAAU,GAAG,MAAM,CAAC,GAAG,CAAC;aAC3B,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC;aACtB,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC;aACrB,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACzB,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,EAAE,EAAE;YAC9B,KAAK,GAAG,yBAAyB,CAAC;SACnC;aAAM;YACL,KAAK,GAAG,wBAAwB,IAAI,KAAK,UAAU,UAAU,CAAC;SAC/D;QACD,OAAO;;iBAEM,SAAS;UAChB,KAAK;cACD,CAAC;IACb,CAAC;IAED;;;;;;;OAOG;IACK,iBAAiB,CACvB,KAAa,EACb,UAAmB,EACnB,MAAc;QAEd,OAAO;;;aAGE,KAAK;iBACD,UAAU,eAAe,MAAM;kBAC9B,CAAC,IAAI,EAAE,CAAC;IACxB,CAAC;CACF;AAnPD,gCAmPC"}
+{"version":3,"file":"createUtil.js","sourceRoot":"","sources":["../../../src/lib/helpers/createUtil.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACH,yBAAyB;AACzB,6BAA6B;AAE7B,qDAA4C;AAE5C,sDAAmD;AAMnD,MAAM,YAAY,GAAG;IACnB,QAAQ,EAAE,SAAS;IACnB,IAAI,EAAE,MAAM;IACZ,QAAQ,EAAE,UAAU;IACpB,KAAK,EAAE,QAAQ;IACf,KAAK,EAAE,QAAQ;IACf,QAAQ,EAAE,QAAQ;IAClB,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,QAAQ;IAClB,YAAY,EAAE,QAAQ;IACtB,GAAG,EAAE,QAAQ;CACd,CAAC;AACF,sJAAsJ;AACtJ,MAAa,UAAU;IACrB;;;OAGG;IAEH;;;;;OAKG;IACI,KAAK,CAAC,YAAY,CAAC,YAA0B;QAClD,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,CAC9B,YAAY,CAAC,SAAS,EACtB,GAAG,YAAY,CAAC,QAAQ,IAAI,YAAY,CAAC,UAAU,cAAc,CAClE,CAAC;QACF,MAAM,gBAAgB,GAAG,IAAI,CAAC,iBAAiB,CAC7C,YAAY,CAAC,KAAK,EAClB,YAAY,CAAC,SAAS,EACtB,IAAI,CAAC,mBAAmB,CAAC,YAAY,CAAC,QAAQ,EAAE,YAAY,CAAC,OAAO,EAAE,YAAY,CAAC,YAAY,CAAC,CACjG,CAAC;QAEF,OAAO,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,cAAc,EAAE,gBAAgB,CAAC,CAAC;IACjE,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,WAAW,CAAC,YAAoB,EAAE,SAAmB;QAChE,MAAM,MAAM,GAAG,IAAI,2BAAS,EAAE,CAAC;QAC/B,OAAO,OAAO,CAAC,GAAG,CAChB,SAAS;aACN,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;aAC5C,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE;YACtB,MAAM,QAAQ,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YAC9D,OAAQ,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAqB,CAAC,WAAW,CAAC;QACjE,CAAC,CAAC,CACL,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,qBAAqB,CAAC,QAAgB;QAC3C,OAAO,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,QAAQ,OAAO,CAAC;IACpE,CAAC;IAED;;;;;;OAMG;IACI,qBAAqB,CAAC,WAA0B,EAAE,EAAE,SAAkB;;QAC3E,MAAM,YAAY,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC;QAC1E,OAAO,YAAY,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC;YACtE,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,IAAI,EAAE,YAAY,CAAC,KAAK,CAAC;YAC3D,CAAC,CAAC,MAAC,YAAY,CAAC,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,IAAI,CAAY,mCAAI,QAAQ,CAAC;IAC/D,CAAC;IAED;;;;;;OAMG;IACI,gBAAgB,CAAC,WAA0B,EAAE,EAAE,SAAS,GAAG,EAAE;;QAClE,OAAO,MAAA,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,KAAK,SAAS,CAAC,0CAAE,IAAI,CAAC;IACpE,CAAC;IAED;;;;;;;OAOG;IACI,aAAa,CAAC,QAAuB,EAAE,SAAiB;QAC7D,OAAO,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;OAOG;IACK,mBAAmB,CACzB,QAAuB,EACvB,SAAiC,EACjC,YAAqB;QAErB,IAAI,GAAG,GAAG,EAAE,CAAC;QACb,MAAM,SAAS,GAAG,IAAI,qBAAS,EAAE,CAAC;QAClC,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;YAC9C,MAAM,IAAI,GAAG,IAAI,CAAC,qBAAqB,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;YAC7D,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;YAC5D,4DAA4D;YAC5D,IAAI,SAAS,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,EAAE;gBACnD,GAAG,IAAI,IAAI,CAAC,gBAAgB,CAAC,SAAS,EAAE,SAAS,CAAC,SAAS,CAAC,EAAE,IAAI,CAAC,CAAC;aACrE;SACF;QAED,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;;;;;OAOG;IACK,aAAa,CAAC,IAAY,EAAE,KAAa;QAC/C,OAAO,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC;IAChF,CAAC;IAED;;;;;;;OAOG;IACK,gBAAgB,CAAC,SAAiB,EAAE,GAAW,EAAE,IAAY;QACnE,MAAM,UAAU,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAClG,MAAM,KAAK,GACT,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,yBAAyB,CAAC,CAAC,CAAC,wBAAwB,IAAI,KAAK,UAAU,UAAU,CAAC;QAEjH,OAAO;;iBAEM,SAAS;UAChB,KAAK;cACD,CAAC;IACb,CAAC;IAED;;;;;;;OAOG;IACK,iBAAiB,CAAC,KAAa,EAAE,UAAmB,EAAE,MAAc;QAC1E,OAAO;;;aAGE,KAAK;iBACD,UAAU,eAAe,MAAM;kBAC9B,CAAC,IAAI,EAAE,CAAC;IACxB,CAAC;CACF;AArKD,gCAqKC"}

package/lib/lib/helpers/fileWriter.d.ts

@@ -1,3 +1,10 @@
+/// <reference types="node" />
+import * as fs from 'fs';
+interface FileWriterResult {
+    dir: string;
+    fileName: string;
+    updated: boolean;
+}
 export declare class FileWriter {
     /**
      * Using the given file system, creates a file representing a new custom metadata type.
@@ -6,11 +13,7 @@ export declare class FileWriter {
      * @param devname
      * @param objectXML
      */
-    writeTypeFile(corefs: any, dir: string, devName: string, objectXML: string): Promise<{
-        dir: string;
-        fileName: string;
-        updated: boolean;
-    }>;
+    writeTypeFile(corefs: typeof fs, dir: string, devName: string, objectXML: string): Promise<FileWriterResult>;
     /**
      * Using the given file system, creates a file representing a new field for the given custom metadata type
      *
@@ -18,10 +21,7 @@ export declare class FileWriter {
      * @param fieldname
      * @param fieldXML
      */
-    writeFieldFile(corefs: any, dir: any, fieldName: any, fieldXML: any): Promise<{
-        dir: string;
-        fileName: string;
-        updated: boolean;
-    }>;
-    createDir(dir: any): any;
+    writeFieldFile(corefs: typeof fs, dir: string, fieldName: string, fieldXML: string): Promise<FileWriterResult>;
 }
+export declare const removeTrailingSlash: (dir: string) => string;
+export {};

package/lib/lib/helpers/fileWriter.js

@@ -6,8 +6,9 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FileWriter = void 0;
+exports.removeTrailingSlash = exports.FileWriter = void 0;
 const fs = require("fs");
+const path = require("path");
 class FileWriter {
     /**
      * Using the given file system, creates a file representing a new custom metadata type.
@@ -16,9 +17,8 @@ class FileWriter {
      * @param devname
      * @param objectXML
      */
-    async writeTypeFile(corefs, dir, devName, objectXML) {
+    async writeTypeFile(corefs = fs, dir, devName, objectXML) {
         let apiName = devName;
-        const dirName = this.createDir(dir);
         // replace __c with __mdt
         if (apiName.endsWith('__c')) {
             apiName = apiName.replace('__c', '__mdt');
@@ -27,11 +27,11 @@ class FileWriter {
         if (!apiName.endsWith('__mdt')) {
             apiName += '__mdt';
         }
-        const outputFilePath = `${dirName}${apiName}/`;
+        const outputFilePath = path.join((0, exports.removeTrailingSlash)(dir), apiName);
         const fileName = `${apiName}.object-meta.xml`;
-        const updated = fs.existsSync(outputFilePath + fileName);
-        await corefs.mkdirp(`${dirName}${apiName}`);
-        await corefs.writeFile(outputFilePath + fileName, objectXML);
+        const updated = fs.existsSync(path.join(outputFilePath, fileName));
+        await corefs.promises.mkdir(outputFilePath, { recursive: true });
+        await corefs.promises.writeFile(path.join(outputFilePath, fileName), objectXML);
         return { dir: outputFilePath, fileName, updated };
     }
     /**
@@ -42,30 +42,20 @@ class FileWriter {
      * @param fieldXML
      */
     // /fields/{fieldAPI}.field-meta.xml
-    async writeFieldFile(corefs, dir, fieldName, fieldXML) {
-        const dirName = this.createDir(dir);
+    async writeFieldFile(corefs = fs, dir, fieldName, fieldXML) {
         // appending __c if its not already there
         if (fieldName.endsWith('__c') === false) {
             fieldName += '__c';
         }
-        const outputFilePath = `${dirName}fields/`;
+        const outputFilePath = path.join((0, exports.removeTrailingSlash)(dir), 'fields');
         const fileName = `${fieldName}.field-meta.xml`;
-        const updated = fs.existsSync(outputFilePath + fileName);
-        await corefs.mkdirp(`${dirName}fields`);
-        await corefs.writeFile(outputFilePath + fileName, fieldXML);
+        const updated = fs.existsSync(path.join(outputFilePath, fileName));
+        await corefs.promises.mkdir(outputFilePath, { recursive: true });
+        await corefs.promises.writeFile(path.join(outputFilePath, fileName), fieldXML);
         return { dir: outputFilePath, fileName, updated };
     }
-    createDir(dir) {
-        if (dir) {
-            if (dir.endsWith('/')) {
-                return dir;
-            }
-            else {
-                return dir + '/';
-            }
-        }
-        return '';
-    }
 }
 exports.FileWriter = FileWriter;
+const removeTrailingSlash = (dir) => dir.replace(/\/+$/, '');
+exports.removeTrailingSlash = removeTrailingSlash;
 //# sourceMappingURL=fileWriter.js.map

package/lib/lib/helpers/fileWriter.js.map

@@ -1 +1 @@
-{"version":3,"file":"fileWriter.js","sourceRoot":"","sources":["../../../src/lib/helpers/fileWriter.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,yBAAyB;AAEzB,MAAa,UAAU;IACrB;;;;;;OAMG;IACI,KAAK,CAAC,aAAa,CACxB,MAAM,EACN,GAAW,EACX,OAAe,EACf,SAAiB;QAEjB,IAAI,OAAO,GAAG,OAAO,CAAC;QACtB,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAEpC,yBAAyB;QACzB,IAAI,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;SAC3C;QAED,8CAA8C;QAC9C,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;YAC9B,OAAO,IAAI,OAAO,CAAC;SACpB;QAED,MAAM,cAAc,GAAG,GAAG,OAAO,GAAG,OAAO,GAAG,CAAC;QAC/C,MAAM,QAAQ,GAAG,GAAG,OAAO,kBAAkB,CAAC;QAC9C,MAAM,OAAO,GAAG,EAAE,CAAC,UAAU,CAAC,cAAc,GAAG,QAAQ,CAAC,CAAC;QAEzD,MAAM,MAAM,CAAC,MAAM,CAAC,GAAG,OAAO,GAAG,OAAO,EAAE,CAAC,CAAC;QAC5C,MAAM,MAAM,CAAC,SAAS,CAAC,cAAc,GAAG,QAAQ,EAAE,SAAS,CAAC,CAAC;QAE7D,OAAO,EAAE,GAAG,EAAE,cAAc,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpD,CAAC;IAED;;;;;;OAMG;IACH,oCAAoC;IAC7B,KAAK,CAAC,cAAc,CAAC,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,QAAQ;QAC1D,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAEpC,yCAAyC;QACzC,IAAI,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,KAAK,EAAE;YACvC,SAAS,IAAI,KAAK,CAAC;SACpB;QACD,MAAM,cAAc,GAAG,GAAG,OAAO,SAAS,CAAC;QAC3C,MAAM,QAAQ,GAAG,GAAG,SAAS,iBAAiB,CAAC;QAC/C,MAAM,OAAO,GAAG,EAAE,CAAC,UAAU,CAAC,cAAc,GAAG,QAAQ,CAAC,CAAC;QACzD,MAAM,MAAM,CAAC,MAAM,CAAC,GAAG,OAAO,QAAQ,CAAC,CAAC;QACxC,MAAM,MAAM,CAAC,SAAS,CAAC,cAAc,GAAG,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAE5D,OAAO,EAAE,GAAG,EAAE,cAAc,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpD,CAAC;IAEM,SAAS,CAAC,GAAG;QAClB,IAAI,GAAG,EAAE;YACP,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;gBACrB,OAAO,GAAG,CAAC;aACZ;iBAAM;gBACL,OAAO,GAAG,GAAG,GAAG,CAAC;aAClB;SACF;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;CACF;AAvED,gCAuEC"}
+{"version":3,"file":"fileWriter.js","sourceRoot":"","sources":["../../../src/lib/helpers/fileWriter.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,yBAAyB;AACzB,6BAA6B;AAQ7B,MAAa,UAAU;IACrB;;;;;;OAMG;IACI,KAAK,CAAC,aAAa,CAAC,MAAM,GAAG,EAAE,EAAE,GAAW,EAAE,OAAe,EAAE,SAAiB;QACrF,IAAI,OAAO,GAAG,OAAO,CAAC;QAEtB,yBAAyB;QACzB,IAAI,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;YAC3B,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;SAC3C;QAED,8CAA8C;QAC9C,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;YAC9B,OAAO,IAAI,OAAO,CAAC;SACpB;QAED,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,CAAC,IAAA,2BAAmB,EAAC,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC;QACpE,MAAM,QAAQ,GAAG,GAAG,OAAO,kBAAkB,CAAC;QAC9C,MAAM,OAAO,GAAG,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC,CAAC;QAEnE,MAAM,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACjE,MAAM,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAC,EAAE,SAAS,CAAC,CAAC;QAEhF,OAAO,EAAE,GAAG,EAAE,cAAc,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpD,CAAC;IAED;;;;;;OAMG;IACH,oCAAoC;IAC7B,KAAK,CAAC,cAAc,CACzB,MAAM,GAAG,EAAE,EACX,GAAW,EACX,SAAiB,EACjB,QAAgB;QAEhB,yCAAyC;QACzC,IAAI,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,KAAK,EAAE;YACvC,SAAS,IAAI,KAAK,CAAC;SACpB;QACD,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,CAAC,IAAA,2BAAmB,EAAC,GAAG,CAAC,EAAE,QAAQ,CAAC,CAAC;QACrE,MAAM,QAAQ,GAAG,GAAG,SAAS,iBAAiB,CAAC;QAC/C,MAAM,OAAO,GAAG,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC,CAAC;QACnE,MAAM,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACjE,MAAM,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAC,EAAE,QAAQ,CAAC,CAAC;QAE/E,OAAO,EAAE,GAAG,EAAE,cAAc,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpD,CAAC;CACF;AAzDD,gCAyDC;AAEM,MAAM,mBAAmB,GAAG,CAAC,GAAW,EAAU,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AAAvE,QAAA,mBAAmB,uBAAoD"}

package/lib/lib/helpers/metadataUtil.d.ts

@@ -1,51 +1,25 @@
-import { Connection } from '@salesforce/core';
-import { AnyJson } from '@salesforce/ts-types';
-export declare class MetadataUtil {
-    private conn;
-    constructor(conn: Connection);
-    /**
-     * Returns a describe object from the API name you specify
-     *
-     * @param  objName API name of the object
-     * @returns Promise - JSON representation of the describe object
-     */
-    describeObj(objName: string): Promise<AnyJson>;
-    /**
-     * Returns an array of object records from a SOQL query
-     *
-     * @param  soqlStr String representation of the SOQL query
-     * @returns Promise - Array of records in JSON format
-     */
-    queryObject(soqlStr: string): Promise<AnyJson>;
-    /**
-     * Returns an array of object records
-     *
-     * @param  describeResult object describe result
-     * @returns Promise - Promise - Array of records in JSON format
-     */
-    queryRecords(describeResult: AnyJson): Promise<AnyJson>;
-    /**
-     * Returns describe object for the field API name from the Object API name you specify
-     *
-     * @param  objDescribe  describe object JSON
-     * @param  fieldName API name of the field to query
-     * @returns Promise - Promise - record in JSON format
-     */
-    describeField(objDescribe: AnyJson, fieldName: string): AnyJson;
-    /**
-     * Returns describe object for all fields from the object  API name you specify
-     *
-     * @param  objDescribe object describe JSON
-     * @returns Promise - Promise - record in JSON format
-     */
-    describeObjFields(objDescribe: AnyJson): AnyJson;
-    /**
-     * Returns true if the object name you specify is a list type custom setting
-     *
-     * @param  objName API name of the object to query
-     * @returns boolean
-     */
-    validCustomSettingType(objDescribe: AnyJson): boolean;
-    cleanQueryResponse(sObjecRecord: AnyJson, objectDescribe: AnyJson): import("@salesforce/ts-types").JsonMap;
-    private _getSoqlQuery;
-}
+import { CustomObject, CustomField } from 'jsforce/api/metadata';
+import { Record } from 'jsforce';
+/**
+ * Returns describe object for the field API name from the Object API name you specify
+ *
+ * @param  objDescribe  describe object JSON
+ * @param  fieldName API name of the field to query
+ * @returns Promise - Promise - record in JSON format
+ */
+export declare const describeField: (objDescribe: CustomObject, fieldName: string) => CustomField;
+/**
+ * Returns true if the object name you specify is a list type custom setting
+ *
+ * @param  objName object describe JSON
+ * @returns boolean
+ */
+export declare const validCustomSettingType: (objDescribe: CustomObject) => boolean;
+/**
+ * Returns describe object for all fields from the object  API name you specify
+ *
+ * @param  objDescribe object describe JSON
+ * @returns Promise - Promise - record in JSON format
+ */
+export declare const describeObjFields: (objDescribe: CustomObject) => CustomField[];
+export declare const cleanQueryResponse: (sObjectRecord: Record, objectDescribe: CustomObject) => Record;