@salesforce/plugin-custom-metadata 1.1.0 → 2.0.0

package/lib/lib/helpers/metadataUtil.js

@@ -6,136 +6,60 @@
  * 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.MetadataUtil = void 0;
-const ts_types_1 = require("@salesforce/ts-types");
-class MetadataUtil {
-    constructor(conn) {
-        this.conn = conn;
-    }
-    /**
-     * 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
-     */
-    async describeObj(objName) {
-        const result = await this.conn.metadata.read('CustomObject', objName, (err, meta) => {
-            if (err) {
-                const errorResponse = {
-                    errorCode: '',
-                    errorMessage: '',
-                };
-                errorResponse.errorCode = err.name;
-                errorResponse.errorMessage = err.message;
-                return errorResponse;
-            }
-            return meta;
-        });
-        return (0, ts_types_1.toAnyJson)(result);
-    }
-    /**
-     * 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
-     */
-    async queryObject(soqlStr) {
-        const result = await this.conn.query(soqlStr, {}, (err, meta) => {
-            if (err) {
-                const errorResponse = { errorCode: '', errorMessage: '' };
-                errorResponse.errorCode = err.name;
-                errorResponse.errorMessage = err.message;
-                return errorResponse;
-            }
-            return meta;
-        });
-        return (0, ts_types_1.toAnyJson)(result);
-    }
-    /**
-     * Returns an array of object records
-     *
-     * @param  describeResult object describe result
-     * @returns Promise - Promise - Array of records in JSON format
-     */
-    async queryRecords(describeResult) {
-        const query = await this._getSoqlQuery(describeResult['fields'], describeResult['fullName']);
-        const queryResult = await this.queryObject(query);
-        return (0, ts_types_1.toAnyJson)(queryResult);
-    }
-    /**
-     * 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, fieldName) {
-        const fieldsDescribe = objDescribe['fields'];
-        let fieldsDescribeResult;
-        fieldsDescribe.map((field) => {
-            if (field.fullName === fieldName) {
-                fieldsDescribeResult = field;
-            }
-        });
-        return fieldsDescribeResult;
-    }
-    /**
-     * 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) {
-        const fieldsDescribe = objDescribe['fields'];
-        return fieldsDescribe;
-    }
-    /**
-     * 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) {
-        if (objDescribe['customSettingsType'] === 'List' &&
-            objDescribe['visibility'] === 'Public') {
-            return true;
+exports.cleanQueryResponse = exports.describeObjFields = exports.validCustomSettingType = exports.describeField = void 0;
+/**
+ * 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
+ */
+const describeField = (objDescribe, fieldName) => {
+    return (0, exports.describeObjFields)(objDescribe).find((field) => field.fullName === fieldName);
+};
+exports.describeField = describeField;
+/**
+ * Returns true if the object name you specify is a list type custom setting
+ *
+ * @param  objName object describe JSON
+ * @returns boolean
+ */
+const validCustomSettingType = (objDescribe) => objDescribe.customSettingsType === 'List' && objDescribe.visibility === 'Public';
+exports.validCustomSettingType = validCustomSettingType;
+/**
+ * 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
+ */
+const describeObjFields = (objDescribe) => {
+    return objDescribe.fields;
+};
+exports.describeObjFields = describeObjFields;
+const cleanQueryResponse = (sObjectRecord, objectDescribe) => {
+    return Object.fromEntries(Object.entries(sObjectRecord)
+        .filter(([fieldName]) => fieldName !== 'attributes' && fieldName !== 'Name')
+        .flatMap(([fieldName, value]) => {
+        const fieldDescribe = (0, exports.describeField)(objectDescribe, fieldName);
+        // everything but location returns as is
+        if (fieldDescribe.type !== 'Location') {
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+            return [[fieldName, value]];
+        }
+        const fieldValue = JSON.stringify(value);
+        if (fieldValue.includes('latitude') || fieldValue.includes('longitude')) {
+            return [
+                [`Lat_${fieldName}`, fieldValue.slice(fieldValue.indexOf(':') + 1, fieldValue.indexOf(','))],
+                [`Long_${fieldName}`, fieldValue.slice(fieldValue.lastIndexOf(':') + 1, fieldValue.indexOf('}'))],
+            ];
+        }
+        else {
+            return [
+                [`Lat_${fieldName}`, ''],
+                [`Long_${fieldName}`, ''],
+            ];
         }
-        return false;
-    }
-    cleanQueryResponse(sObjecRecord, objectDescribe) {
-        const record = {};
-        Object.keys(sObjecRecord).forEach((fieldName) => {
-            if (fieldName !== 'attributes' && fieldName !== 'Name') {
-                const fieldDescribe = this.describeField(objectDescribe, fieldName);
-                const fieldType = fieldDescribe['type'];
-                const fieldValue = JSON.stringify(sObjecRecord[fieldName]);
-                if (fieldType === 'Location') {
-                    if (fieldValue.includes('latitude') ||
-                        fieldValue.includes('longitude')) {
-                        record['Lat_' + fieldName] = fieldValue.slice(fieldValue.indexOf(':') + 1, fieldValue.indexOf(','));
-                        record['Long_' + fieldName] = fieldValue.slice(fieldValue.lastIndexOf(':') + 1, fieldValue.indexOf('}'));
-                    }
-                    else {
-                        record['Lat_' + fieldName] = '';
-                        record['Long_' + fieldName] = '';
-                    }
-                }
-                else {
-                    record[fieldName] = sObjecRecord[fieldName];
-                }
-            }
-        });
-        return record;
-    }
-    _getSoqlQuery(arr, objName) {
-        const fieldNames = arr
-            .map((field) => {
-            return field.fullName;
-        })
-            .join(',');
-        // Added Name hardcoded as Name field is not retreived as part of object describe.
-        return `SELECT Name, ${fieldNames} FROM ${objName}`;
-    }
-}
-exports.MetadataUtil = MetadataUtil;
+    }));
+};
+exports.cleanQueryResponse = cleanQueryResponse;
 //# sourceMappingURL=metadataUtil.js.map

package/lib/lib/helpers/metadataUtil.js.map

@@ -1 +1 @@
-{"version":3,"file":"metadataUtil.js","sourceRoot":"","sources":["../../../src/lib/helpers/metadataUtil.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAGH,mDAA0D;AAG1D,MAAa,YAAY;IACvB,YAAoB,IAAgB;QAAhB,SAAI,GAAJ,IAAI,CAAY;IAAG,CAAC;IAExC;;;;;OAKG;IACI,KAAK,CAAC,WAAW,CAAC,OAAe;QACtC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAC1C,cAAc,EACd,OAAO,EACP,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;YACZ,IAAI,GAAG,EAAE;gBACP,MAAM,aAAa,GAAiB;oBAClC,SAAS,EAAE,EAAE;oBACb,YAAY,EAAE,EAAE;iBACjB,CAAC;gBACF,aAAa,CAAC,SAAS,GAAG,GAAG,CAAC,IAAI,CAAC;gBACnC,aAAa,CAAC,YAAY,GAAG,GAAG,CAAC,OAAO,CAAC;gBACzC,OAAO,aAAa,CAAC;aACtB;YACD,OAAO,IAAI,CAAC;QACd,CAAC,CACF,CAAC;QAEF,OAAO,IAAA,oBAAS,EAAC,MAAM,CAAC,CAAC;IAC3B,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,WAAW,CAAC,OAAe;QACtC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,EAAE,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;YAC9D,IAAI,GAAG,EAAE;gBACP,MAAM,aAAa,GAAiB,EAAE,SAAS,EAAE,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE,CAAC;gBACxE,aAAa,CAAC,SAAS,GAAG,GAAG,CAAC,IAAI,CAAC;gBACnC,aAAa,CAAC,YAAY,GAAG,GAAG,CAAC,OAAO,CAAC;gBACzC,OAAO,aAAa,CAAC;aACtB;YAED,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC;QAEH,OAAO,IAAA,oBAAS,EAAC,MAAM,CAAC,CAAC;IAC3B,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,YAAY,CAAC,cAAuB;QAC/C,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,aAAa,CACpC,cAAc,CAAC,QAAQ,CAAC,EACxB,cAAc,CAAC,UAAU,CAAC,CAC3B,CAAC;QACF,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAElD,OAAO,IAAA,oBAAS,EAAC,WAAW,CAAC,CAAC;IAChC,CAAC;IAED;;;;;;OAMG;IACI,aAAa,CAAC,WAAoB,EAAE,SAAiB;QAC1D,MAAM,cAAc,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC;QAC7C,IAAI,oBAAoB,CAAC;QACzB,cAAc,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;YAC3B,IAAI,KAAK,CAAC,QAAQ,KAAK,SAAS,EAAE;gBAChC,oBAAoB,GAAG,KAAK,CAAC;aAC9B;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,oBAAoB,CAAC;IAC9B,CAAC;IAED;;;;;OAKG;IACI,iBAAiB,CAAC,WAAoB;QAC3C,MAAM,cAAc,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC;QAE7C,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;;;OAKG;IACI,sBAAsB,CAAC,WAAoB;QAChD,IACE,WAAW,CAAC,oBAAoB,CAAC,KAAK,MAAM;YAC5C,WAAW,CAAC,YAAY,CAAC,KAAK,QAAQ,EACtC;YACA,OAAO,IAAI,CAAC;SACb;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAEM,kBAAkB,CAAC,YAAqB,EAAE,cAAuB;QACtE,MAAM,MAAM,GAAY,EAAE,CAAC;QAC3B,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;YAC9C,IAAI,SAAS,KAAK,YAAY,IAAI,SAAS,KAAK,MAAM,EAAE;gBACtD,MAAM,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE,SAAS,CAAC,CAAC;gBACpE,MAAM,SAAS,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;gBACxC,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC;gBAC3D,IAAI,SAAS,KAAK,UAAU,EAAE;oBAC5B,IACE,UAAU,CAAC,QAAQ,CAAC,UAAU,CAAC;wBAC/B,UAAU,CAAC,QAAQ,CAAC,WAAW,CAAC,EAChC;wBACA,MAAM,CAAC,MAAM,GAAG,SAAS,CAAC,GAAG,UAAU,CAAC,KAAK,CAC3C,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAC3B,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CACxB,CAAC;wBACF,MAAM,CAAC,OAAO,GAAG,SAAS,CAAC,GAAG,UAAU,CAAC,KAAK,CAC5C,UAAU,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,EAC/B,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CACxB,CAAC;qBACH;yBAAM;wBACL,MAAM,CAAC,MAAM,GAAG,SAAS,CAAC,GAAG,EAAE,CAAC;wBAChC,MAAM,CAAC,OAAO,GAAG,SAAS,CAAC,GAAG,EAAE,CAAC;qBAClC;iBACF;qBAAM;oBACL,MAAM,CAAC,SAAS,CAAC,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC;iBAC7C;aACF;QACH,CAAC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,aAAa,CAAC,GAAG,EAAE,OAAO;QAChC,MAAM,UAAU,GAAG,GAAG;aACnB,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;YACb,OAAO,KAAK,CAAC,QAAQ,CAAC;QACxB,CAAC,CAAC;aACD,IAAI,CAAC,GAAG,CAAC,CAAC;QACb,kFAAkF;QAClF,OAAO,gBAAgB,UAAU,SAAS,OAAO,EAAE,CAAC;IACtD,CAAC;CACF;AA3JD,oCA2JC"}
+{"version":3,"file":"metadataUtil.js","sourceRoot":"","sources":["../../../src/lib/helpers/metadataUtil.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAIH;;;;;;GAMG;AACI,MAAM,aAAa,GAAG,CAAC,WAAyB,EAAE,SAAiB,EAAe,EAAE;IACzF,OAAO,IAAA,yBAAiB,EAAC,WAAW,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC;AACtF,CAAC,CAAC;AAFW,QAAA,aAAa,iBAExB;AAEF;;;;;GAKG;AACI,MAAM,sBAAsB,GAAG,CAAC,WAAyB,EAAW,EAAE,CAC3E,WAAW,CAAC,kBAAkB,KAAK,MAAM,IAAI,WAAW,CAAC,UAAU,KAAK,QAAQ,CAAC;AADtE,QAAA,sBAAsB,0BACgD;AAEnF;;;;;GAKG;AACI,MAAM,iBAAiB,GAAG,CAAC,WAAyB,EAAiB,EAAE;IAC5E,OAAO,WAAW,CAAC,MAAM,CAAC;AAC5B,CAAC,CAAC;AAFW,QAAA,iBAAiB,qBAE5B;AAEK,MAAM,kBAAkB,GAAG,CAAC,aAAqB,EAAE,cAA4B,EAAU,EAAE;IAChG,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC;SAC1B,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE,EAAE,CAAC,SAAS,KAAK,YAAY,IAAI,SAAS,KAAK,MAAM,CAAC;SAC3E,OAAO,CAAC,CAAC,CAAC,SAAS,EAAE,KAAK,CAAC,EAAE,EAAE;QAC9B,MAAM,aAAa,GAAG,IAAA,qBAAa,EAAC,cAAc,EAAE,SAAS,CAAC,CAAC;QAC/D,wCAAwC;QACxC,IAAI,aAAa,CAAC,IAAI,KAAK,UAAU,EAAE;YACrC,+DAA+D;YAC/D,OAAO,CAAC,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC;SAC7B;QACD,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACzC,IAAI,UAAU,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,UAAU,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE;YACvE,OAAO;gBACL,CAAC,OAAO,SAAS,EAAE,EAAE,UAAU,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;gBAC5F,CAAC,QAAQ,SAAS,EAAE,EAAE,UAAU,CAAC,KAAK,CAAC,UAAU,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;aAClG,CAAC;SACH;aAAM;YACL,OAAO;gBACL,CAAC,OAAO,SAAS,EAAE,EAAE,EAAE,CAAC;gBACxB,CAAC,QAAQ,SAAS,EAAE,EAAE,EAAE,CAAC;aAC1B,CAAC;SACH;IACH,CAAC,CAAC,CACL,CAAC;AACJ,CAAC,CAAC;AAzBW,QAAA,kBAAkB,sBAyB7B"}

package/lib/lib/helpers/validationUtil.d.ts

@@ -1,26 +1,25 @@
-export declare class ValidationUtil {
-    /**
-     * Returns true if the fieldname is a valid api name
-     *
-     * @param  fieldName API name of the object
-     */
-    validateAPIName(fieldName: any): boolean;
-    /**
-     * Returns true if the fieldname is a valid metadata object name
-     *
-     * @param  fieldName API name of the field
-     */
-    validateMetadataTypeName(typeName: any): boolean;
-    /**
-     * Returns true if the fieldname is a valid metadata record name
-     *
-     * @param  fieldName record name of a metadata record
-     */
-    validateMetadataRecordName(typeName: any): boolean;
-    /**
-     * Returns true if name is below 40 characters
-     *
-     * @param  name label name or plural label
-     */
-    validateLessThanForty(name: any): boolean;
-}
+/**
+ * Returns true if the name is a valid api name for an sobject/field
+ *
+ * @param  name API name of the object
+ */
+export declare const validateAPIName: (name: string, message?: string) => string;
+/**
+ * Returns true if the fieldname is a valid metadata object name
+ *
+ * @param  fieldName API name of the field
+ */
+export declare const validateMetadataTypeName: (typeName: string) => string;
+export declare const isValidMetadataRecordName: (recordName: string) => boolean;
+/**
+ * Returns true if the fieldname is a valid metadata record name
+ *
+ * @param  fieldName record name of a metadata record
+ */
+export declare const validateMetadataRecordName: (typeName: string) => string;
+/**
+ * Returns true if name is below 40 characters
+ *
+ * @param  name label name or plural label
+ */
+export declare const validateLessThanForty: (name: string, message: string) => string;

package/lib/lib/helpers/validationUtil.js

@@ -1,55 +1,78 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateLessThanForty = exports.validateMetadataRecordName = exports.isValidMetadataRecordName = exports.validateMetadataTypeName = exports.validateAPIName = 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.ValidationUtil = void 0;
-class ValidationUtil {
-    /**
-     * Returns true if the fieldname is a valid api name
-     *
-     * @param  fieldName API name of the object
-     */
-    validateAPIName(fieldName) {
-        // trimming the __c from the field during character count since it does not count towards the limit
-        // Regex makes sure that the field name is alpha numeric, doesn't end in an underscore
-        // and optionally if it ends in __c
-        return (fieldName.replace('__c', '').replace('__C', '').length <= 40 &&
-            /^[a-zA-Z][a-zA-Z0-9]*(_[a-zA-Z0-9]+)*(__[cC])?$/.test(fieldName));
+const core_1 = require("@salesforce/core");
+core_1.Messages.importMessagesDirectory(__dirname);
+const messages = core_1.Messages.load('@salesforce/plugin-custom-metadata', 'validation', [
+    'sobjectnameFlagError',
+    'invalidCMDTApiName',
+    'notAValidRecordNameError',
+]);
+/**
+ * Returns true if the name is a valid api name for an sobject/field
+ *
+ * @param  name API name of the object
+ */
+const validateAPIName = (name, message) => {
+    // trimming the __c from the field during character count since it does not count towards the limit
+    // Regex makes sure that the field name is alpha numeric, doesn't end in an underscore
+    // and optionally if it ends in __c
+    const cleanedValue = name.replace('__c', '').replace('__C', '');
+    if (cleanedValue.length > 40 || !/^[a-zA-Z][a-zA-Z0-9]*(_[a-zA-Z0-9]+)*(__[cC])?$/.test(cleanedValue)) {
+        throw new core_1.SfError(message !== null && message !== void 0 ? message : messages.getMessage('sobjectnameFlagError', [name]));
     }
-    /**
-     * Returns true if the fieldname is a valid metadata object name
-     *
-     * @param  fieldName API name of the field
-     */
-    validateMetadataTypeName(typeName) {
-        // trimming the __mdt from the field during character count since it does not count towards the limit
-        // Regex makes sure that the field name is alpha numeric, doesn't end in an underscore
-        // and optionally if it ends in __mdt
-        return (typeName.replace('__mdt', '').length <= 40 &&
-            /^[a-zA-Z][a-zA-Z0-9]*(_[a-zA-Z0-9]+)*(__mdt)?$/.test(typeName));
+    return name;
+};
+exports.validateAPIName = validateAPIName;
+/**
+ * Returns true if the fieldname is a valid metadata object name
+ *
+ * @param  fieldName API name of the field
+ */
+const validateMetadataTypeName = (typeName) => {
+    // trimming the __mdt from the field during character count since it does not count towards the limit
+    // Regex makes sure that the field name is alpha numeric, doesn't end in an underscore
+    // and optionally if it ends in __mdt
+    const trimmedValue = typeName.replace(/__mdt$/gi, '');
+    if (trimmedValue.length > 40 || !/^[a-zA-Z][a-zA-Z0-9]*(_[a-zA-Z0-9]+)*(__[mdtT])?$/.test(trimmedValue)) {
+        throw new core_1.SfError(messages.getMessage('invalidCMDTApiName', [typeName]));
     }
-    /**
-     * Returns true if the fieldname is a valid metadata record name
-     *
-     * @param  fieldName record name of a metadata record
-     */
-    validateMetadataRecordName(typeName) {
-        // Regex makes sure that the field name is alpha numeric, doesn't end in an underscore
-        return (typeName.length <= 40 &&
-            /^[a-zA-Z][a-zA-Z0-9]*(_[a-zA-Z0-9]+)*$/.test(typeName));
+    return trimmedValue;
+};
+exports.validateMetadataTypeName = validateMetadataTypeName;
+const isValidMetadataRecordName = (recordName) => {
+    return recordName.length <= 40 && /^[a-zA-Z][a-zA-Z0-9]*(_[a-zA-Z0-9]+)*$/.test(recordName);
+};
+exports.isValidMetadataRecordName = isValidMetadataRecordName;
+/**
+ * Returns true if the fieldname is a valid metadata record name
+ *
+ * @param  fieldName record name of a metadata record
+ */
+const validateMetadataRecordName = (typeName) => {
+    // Regex makes sure that the field name is alpha numeric, doesn't end in an underscore
+    if (!(0, exports.isValidMetadataRecordName)(typeName)) {
+        throw new core_1.SfError(messages.getMessage('notAValidRecordNameError', [typeName]));
     }
-    /**
-     * Returns true if name is below 40 characters
-     *
-     * @param  name label name or plural label
-     */
-    validateLessThanForty(name) {
-        return name.length <= 40;
+    return typeName;
+};
+exports.validateMetadataRecordName = validateMetadataRecordName;
+/**
+ * Returns true if name is below 40 characters
+ *
+ * @param  name label name or plural label
+ */
+const validateLessThanForty = (name, message) => {
+    if (name.length > 40) {
+        throw new core_1.SfError(message);
     }
-}
-exports.ValidationUtil = ValidationUtil;
+    return name;
+};
+exports.validateLessThanForty = validateLessThanForty;
 //# sourceMappingURL=validationUtil.js.map

package/lib/lib/helpers/validationUtil.js.map

@@ -1 +1 @@
-{"version":3,"file":"validationUtil.js","sourceRoot":"","sources":["../../../src/lib/helpers/validationUtil.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,MAAa,cAAc;IACzB;;;;OAIG;IACI,eAAe,CAAC,SAAS;QAC9B,mGAAmG;QACnG,sFAAsF;QACtF,mCAAmC;QACnC,OAAO,CACL,SAAS,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,MAAM,IAAI,EAAE;YAC5D,iDAAiD,CAAC,IAAI,CAAC,SAAS,CAAC,CAClE,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,wBAAwB,CAAC,QAAQ;QACtC,qGAAqG;QACrG,sFAAsF;QACtF,qCAAqC;QACrC,OAAO,CACL,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,MAAM,IAAI,EAAE;YAC1C,gDAAgD,CAAC,IAAI,CAAC,QAAQ,CAAC,CAChE,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,0BAA0B,CAAC,QAAQ;QACxC,sFAAsF;QACtF,OAAO,CACL,QAAQ,CAAC,MAAM,IAAI,EAAE;YACrB,wCAAwC,CAAC,IAAI,CAAC,QAAQ,CAAC,CACxD,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,qBAAqB,CAAC,IAAI;QAC/B,OAAO,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC;IAC3B,CAAC;CACF;AApDD,wCAoDC"}
+{"version":3,"file":"validationUtil.js","sourceRoot":"","sources":["../../../src/lib/helpers/validationUtil.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACH,2CAAqD;AACrD,eAAQ,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;AAC5C,MAAM,QAAQ,GAAG,eAAQ,CAAC,IAAI,CAAC,oCAAoC,EAAE,YAAY,EAAE;IACjF,sBAAsB;IACtB,oBAAoB;IACpB,0BAA0B;CAC3B,CAAC,CAAC;AAEH;;;;GAIG;AACI,MAAM,eAAe,GAAG,CAAC,IAAY,EAAE,OAAgB,EAAU,EAAE;IACxE,mGAAmG;IACnG,sFAAsF;IACtF,mCAAmC;IACnC,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IAChE,IAAI,YAAY,CAAC,MAAM,GAAG,EAAE,IAAI,CAAC,iDAAiD,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE;QACrG,MAAM,IAAI,cAAO,CAAC,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,QAAQ,CAAC,UAAU,CAAC,sBAAsB,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACnF;IACD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AATW,QAAA,eAAe,mBAS1B;AAEF;;;;GAIG;AACI,MAAM,wBAAwB,GAAG,CAAC,QAAgB,EAAU,EAAE;IACnE,qGAAqG;IACrG,sFAAsF;IACtF,qCAAqC;IACrC,MAAM,YAAY,GAAG,QAAQ,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;IACtD,IAAI,YAAY,CAAC,MAAM,GAAG,EAAE,IAAI,CAAC,mDAAmD,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE;QACvG,MAAM,IAAI,cAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,oBAAoB,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;KAC1E;IACD,OAAO,YAAY,CAAC;AACtB,CAAC,CAAC;AATW,QAAA,wBAAwB,4BASnC;AAEK,MAAM,yBAAyB,GAAG,CAAC,UAAkB,EAAW,EAAE;IACvE,OAAO,UAAU,CAAC,MAAM,IAAI,EAAE,IAAI,wCAAwC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;AAC9F,CAAC,CAAC;AAFW,QAAA,yBAAyB,6BAEpC;AACF;;;;GAIG;AACI,MAAM,0BAA0B,GAAG,CAAC,QAAgB,EAAU,EAAE;IACrE,sFAAsF;IACtF,IAAI,CAAC,IAAA,iCAAyB,EAAC,QAAQ,CAAC,EAAE;QACxC,MAAM,IAAI,cAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,0BAA0B,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;KAChF;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AANW,QAAA,0BAA0B,8BAMrC;AAEF;;;;GAIG;AACI,MAAM,qBAAqB,GAAG,CAAC,IAAY,EAAE,OAAe,EAAU,EAAE;IAC7E,IAAI,IAAI,CAAC,MAAM,GAAG,EAAE,EAAE;QACpB,MAAM,IAAI,cAAO,CAAC,OAAO,CAAC,CAAC;KAC5B;IACD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AALW,QAAA,qBAAqB,yBAKhC"}

package/lib/lib/interfaces/createConfig.d.ts

@@ -1,4 +1,5 @@
-import { CustomField } from './customField';
+import { Record } from 'jsforce';
+import { CustomField } from 'jsforce/api/metadata';
 export interface CreateConfig {
     typename: string;
     recordname: string;
@@ -6,7 +7,7 @@ export interface CreateConfig {
     inputdir: string;
     outputdir: string;
     protected?: boolean;
-    varargs?: object;
+    varargs?: Record;
     fileData?: CustomField[];
     ignorefields?: boolean;
 }

package/lib/lib/templates/templates.d.ts

@@ -1,3 +1,4 @@
+import { CustomField } from 'jsforce/api/metadata';
 export declare class Templates {
     /**
      * Using the given data and visibility, creates the body of a type metadata file
@@ -5,110 +6,19 @@ export declare class Templates {
      * @param data
      * @param visibility
      */
-    createObjectXML(data: any, visibility: any): string;
+    createObjectXML({ label, pluralLabel }: {
+        label: string;
+        pluralLabel: string;
+    }, visibility: string): string;
     /**
      * Using the given data and defaultToString, creates the body for a field file.
      *
      * @param data Record details
      * @param defaultToString If the defaultToString set type to Text for unsupported field types
      */
-    createFieldXML(data: any, defaultToString: boolean): string;
-    createDefaultTypeStructure(fullName: string, type: string, label: string, picklistValues: string[], decimalplaces?: number): {
-        fullName: string;
-        defaultValue: string;
-        type: "Checkbox";
-        label: string;
-        unique?: undefined;
-        precision?: undefined;
-        scale?: undefined;
-        valueSet?: undefined;
-        length?: undefined;
-        visibleLines?: undefined;
-    } | {
-        fullName: string;
-        type: "Email";
-        label: string;
-        unique: string;
-        defaultValue?: undefined;
-        precision?: undefined;
-        scale?: undefined;
-        valueSet?: undefined;
-        length?: undefined;
-        visibleLines?: undefined;
-    } | {
-        fullName: string;
-        type: "Number";
-        label: string;
-        precision: number;
-        scale: number;
-        unique: string;
-        defaultValue?: undefined;
-        valueSet?: undefined;
-        length?: undefined;
-        visibleLines?: undefined;
-    } | {
-        fullName: string;
-        type: "Percent";
-        label: string;
-        precision: number;
-        scale: number;
-        defaultValue?: undefined;
-        unique?: undefined;
-        valueSet?: undefined;
-        length?: undefined;
-        visibleLines?: undefined;
-    } | {
-        fullName: string;
-        type: "Picklist";
-        label: string;
-        valueSet: {
-            restricted: string;
-            valueSetDefinition: {
-                sorted: string;
-                value: any[];
-            };
-        };
-        defaultValue?: undefined;
-        unique?: undefined;
-        precision?: undefined;
-        scale?: undefined;
-        length?: undefined;
-        visibleLines?: undefined;
-    } | {
-        fullName: string;
-        type: "Text";
-        label: string;
-        unique: string;
-        length: string;
-        defaultValue?: undefined;
-        precision?: undefined;
-        scale?: undefined;
-        valueSet?: undefined;
-        visibleLines?: undefined;
-    } | {
-        fullName: string;
-        type: "LongTextArea";
-        label: string;
-        length: string;
-        visibleLines: number;
-        defaultValue?: undefined;
-        unique?: undefined;
-        precision?: undefined;
-        scale?: undefined;
-        valueSet?: undefined;
-    } | {
-        fullName: string;
-        type: string;
-        label: string;
-        defaultValue?: undefined;
-        unique?: undefined;
-        precision?: undefined;
-        scale?: undefined;
-        valueSet?: undefined;
-        length?: undefined;
-        visibleLines?: undefined;
-    };
-    canConvert(type: any): boolean;
+    createFieldXML(data: CustomField, defaultToString: boolean): string;
+    createDefaultTypeStructure(fullName: string, type: string, label: string, picklistValues: string[], decimalplaces?: number): CustomField;
+    canConvert(type: string): boolean;
     private getType;
     private getConvertType;
     private getFullName;
@@ -124,5 +34,4 @@ export declare class Templates {
     private getVisibleLines;
     private getDefaultValue;
     private getValueSet;
-    private createPicklistValues;
 }