mcdev 3.1.1 → 4.0.0

package/test/utils.js

@@ -0,0 +1,107 @@
+const File = require('../lib/util/file');
+const path = require('node:path');
+const axios = require('axios');
+const MockAdapter = require('axios-mock-adapter');
+const auth = require('../lib/util/auth');
+const Util = require('../lib/util/util');
+
+// for some reason doesnt realize below reference
+// eslint-disable-next-line no-unused-vars
+const fsmock = require('mock-fs');
+let apimock;
+const authResources = require('./resources/auth.json');
+const resourceFactory = require('./resourceFactory');
+
+/**
+ * gets file from Retrieve folder
+ *
+ * @param {string} customerKey of metadata
+ * @param {string} type of metadata
+ * @returns {Promise.<string>} file in string form
+ */
+exports.getActualFile = (customerKey, type) =>
+    File.readJSON(`./retrieve/testInstance/testBU/${type}/${customerKey}.${type}-meta.json`);
+/**
+ * gets file from Deploy folder
+ *
+ * @param {string} customerKey of metadata
+ * @param {string} type of metadata
+ * @returns {Promise.<string>} file in string form
+ */
+exports.getActualDeployFile = (customerKey, type) =>
+    File.readJSON(`./deploy/testInstance/testBU/${type}/${customerKey}.${type}-meta.json`);
+/**
+ * gets file from Template folder
+ *
+ * @param {string} customerKey of metadata
+ * @param {string} type of metadata
+ * @returns {Promise.<string>} file in string form
+ */
+exports.getActualTemplate = (customerKey, type) =>
+    File.readJSON(`./template/${type}/${customerKey}.${type}-meta.json`);
+
+/**
+ * gets file from resources folder which should be used for comparison
+ *
+ * @param {number} mid of Business Unit
+ * @param {string} type of metadata
+ * @param {string} action of SOAP request
+ * @returns {Promise.<string>} file in string form
+ */
+exports.getExpectedFile = (mid, type, action) =>
+    File.readJSON(path.join('test', 'resources', mid, type, action + '-expected.json'));
+/**
+ * setup mocks for API and FS
+ *
+ * @returns {void}
+ */
+exports.mockSetup = () => {
+    Util.setLoggingLevel({ debug: true });
+    apimock = new MockAdapter(axios, { onNoMatch: 'throwException' });
+    // set access_token to mid to allow for autorouting of mock to correct resources
+    apimock.onPost(authResources.success.url).reply((config) => {
+        authResources.success.response.access_token = JSON.parse(config.data).account_id;
+        return [authResources.success.status, authResources.success.response];
+    });
+    apimock
+        .onPost(resourceFactory.soapUrl)
+        .reply((config) => resourceFactory.handleSOAPRequest(config));
+    apimock
+        .onAny(new RegExp(`^${escapeRegExp(resourceFactory.restUrl)}`))
+        .reply((config) => resourceFactory.handleRESTRequest(config));
+    fsmock({
+        '.prettierrc': fsmock.load(path.resolve(__dirname, '../boilerplate/files/.prettierrc')),
+        '.mcdevrc.json': fsmock.load(path.resolve(__dirname, 'mockRoot/.mcdevrc.json')),
+        '.mcdev-auth.json': fsmock.load(path.resolve(__dirname, 'mockRoot/.mcdev-auth.json')),
+        'boilerplate/config.json': fsmock.load(
+            path.resolve(__dirname, '../boilerplate/config.json')
+        ),
+        deploy: fsmock.load(path.resolve(__dirname, 'mockRoot/deploy')),
+        test: fsmock.load(path.resolve(__dirname)),
+    });
+};
+/**
+ * resets mocks for API and FS
+ *
+ * @returns {void}
+ */
+exports.mockReset = () => {
+    auth.clearSessions();
+    apimock.restore();
+};
+/**
+ * helper to return api history
+ *
+ * @returns {object} of API history
+ */
+exports.getAPIHistory = () => apimock.history;
+
+/**
+ * escapes string for regex
+ *
+ * @param {string} str to escape
+ * @returns {string} escaped string
+ */
+function escapeRegExp(str) {
+    return str.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string
+}

package/types/mcdev.d.js

@@ -0,0 +1,301 @@
+const SDK = require('sfmc-sdk');
+/**
+ * @ignore
+ * @typedef {object} BuObject
+ * @property {string} clientId installed package client id
+ * @property {string} clientSecret installed package client secret
+ * @property {string} tenant subdomain part of Authentication Base Uri
+ * @property {string} [eid] Enterprise ID = MID of the parent BU
+ * @property {string} [mid] MID of the BU to work with
+ * @property {string} [businessUnit] name of the BU to interact with
+ * @property {string} [credential] name of the credential to interact with
+ */
+/**
+ * @typedef {Object.<string, string>} TemplateMap
+ * @typedef {'accountUser'|'asset'|'attributeGroup'|'automation'|'campaign'|'contentArea'|'dataExtension'|'dataExtensionField'|'dataExtensionTemplate'|'dataExtract'|'dataExtractType'|'discovery'|'email'|'emailSendDefinition'|'eventDefinition'|'fileTransfer'|'filter'|'folder'|'ftpLocation'|'importFile'|'interaction'|'list'|'mobileCode'|'mobileKeyword'|'query'|'role'|'script'|'setDefinition'|'triggeredSendDefinition'} SupportedMetadataTypes
+ */
+
+/**
+ * @typedef {Object.<string, any>} MetadataTypeItem
+ * @typedef {Object.<string, MetadataTypeItem>} MetadataTypeMap key=customer key
+ * @typedef {Object.<string, MetadataTypeMap>} MultiMetadataTypeMap key=Supported MetadataType
+ * @typedef {Object.<string, MetadataTypeItem[]>} MultiMetadataTypeList key=Supported MetadataType
+ * @typedef {{metadata:MetadataTypeMap,type:SupportedMetadataTypes}} MetadataTypeMapObj
+ * @typedef {{metadata:MetadataTypeItem,type:SupportedMetadataTypes}} MetadataTypeItemObj
+ * @typedef {Object.<number, MultiMetadataTypeMap>} Cache key=MID
+ */
+
+/**
+ * @typedef {object} CodeExtractItem
+ * @property {MetadataTypeItem} json metadata of one item w/o code
+ * @property {CodeExtract[]} codeArr list of code snippets in this item
+ * @property {string[]} subFolder mostly set to null, otherwise list of subfolders
+ */
+/**
+ * @typedef {object} CodeExtract
+ * @property {string[]} subFolder mostly set to null, otherwise subfolders path split into elements
+ * @property {string} fileName name of file w/o extension
+ * @property {string} fileExt file extension
+ * @property {string} content file content
+ * @property {'base64'} [encoding] optional for binary files
+ */
+/**
+ * @typedef {object} QueryItem
+ * @property {string} name name
+ * @property {string} key key
+ * @property {string} description -
+ * @property {string} targetKey key of target data extension
+ * @property {string} createdDate e.g. "2020-09-14T01:42:03.017"
+ * @property {string} modifiedDate e.g. "2020-09-14T01:42:03.017"
+ * @property {'Overwrite'|'Update'|'Append'} targetUpdateTypeName defines how the query writes into the target data extension
+ * @property {0|1|2} [targetUpdateTypeId] mapped to targetUpdateTypeName via this.definition.targetUpdateTypeMapping
+ * @property {string} [targetId] Object ID of DE (removed before save)
+ * @property {string} [targetDescription] Description DE (removed before save)
+ * @property {boolean} isFrozen looks like this is always set to false
+ * @property {string} [queryText] contains SQL query with line breaks converted to '\n'. The content is extracted during retrieval and written into a separate *.sql file
+ * @property {string} [categoryId] holds folder ID, replaced with r__folder_Path during retrieve
+ * @property {string} r__folder_Path folder path in which this DE is saved
+ * @typedef {Object.<string, QueryItem>} QueryMap
+ * @typedef {object} CodeExtractItem
+ * @property {QueryItem} json metadata of one item w/o code
+ * @property {CodeExtract[]} codeArr list of code snippets in this item
+ * @property {string[]} subFolder mostly set to null, otherwise list of subfolders
+ */
+/**
+ * @typedef {object} ScriptItem
+ * @property {string} name name
+ * @property {string} key key
+ * @property {string} description -
+ * @property {string} createdDate e.g. "2020-09-14T01:42:03.017"
+ * @property {string} modifiedDate e.g. "2020-09-14T01:42:03.017"
+ * @property {string} [script] contains script with line breaks converted to '\n'. The content is extracted during retrieval and written into a separate *.ssjs file
+ * @property {string} [categoryId] holds folder ID, replaced with r__folder_Path during retrieve
+ * @property {string} r__folder_Path folder path in which this DE is saved
+ * @typedef {Object.<string, ScriptItem>} ScriptMap
+ */
+/**
+ * @typedef {Object.<string, any>} AssetItem
+ * @typedef {Object.<string, AssetItem>} AssetMap
+ * @typedef {'archive'|'asset'|'audio'|'block'|'code'|'document'|'image'|'message'|'other'|'rawimage'|'template'|'textfile'|'video'} AssetSubType
+ */
+/**
+ * @typedef {object} DataExtensionFieldItem
+ * @property {string} [ObjectID] id
+ * @property {string} [CustomerKey] key in format [DEkey].[FieldName]
+ * @property {object} [DataExtension] -
+ * @property {string} DataExtension.CustomerKey key of DE
+ * @property {string} Name name of field
+ * @property {string} [Name_new] custom attribute that is only used when trying to rename a field from Name to Name_new
+ * @property {string} DefaultValue empty string for not set
+ * @property {true|false} IsRequired -
+ * @property {true|false} IsPrimaryKey -
+ * @property {string} Ordinal 1, 2, 3, ...
+ * @property {'Text'|'Number'|'Date'|'Boolean'|'Decimal'|'EmailAddress'|'Phone'|'Locale'} FieldType can only be set on create
+ * @property {string} Scale the number of places after the decimal that the field can hold; example: "0","1", ...
+ * @typedef {Object.<string, DataExtensionFieldItem>} DataExtensionFieldMap
+ */
+/**
+ * @typedef {object} DataExtensionItem
+ * @property {string} CustomerKey key
+ * @property {string} Name name
+ * @property {string} Description -
+ * @property {string} [CreatedDate] iso format
+ * @property {string} [ModifiedDate] iso format
+ * @property {true|false} IsSendable -
+ * @property {true|false} IsTestable -
+ * @property {object} SendableDataExtensionField -
+ * @property {string} SendableDataExtensionField.Name -
+ * @property {object} SendableSubscriberField -
+ * @property {string} SendableSubscriberField.Name -
+ * @property {DataExtensionFieldItem[]} Fields list of DE fields
+ * @property {'dataextension'|'salesforcedataextension'|'synchronizeddataextension'|'shared_dataextension'|'shared_salesforcedataextension'} r__folder_ContentType retrieved from associated folder
+ * @property {string} r__folder_Path folder path in which this DE is saved
+ * @property {string} [CategoryID] holds folder ID, replaced with r__folder_Path during retrieve
+ * @property {string} [r__dataExtensionTemplate_Name] name of optionally associated DE template
+ * @property {object} [Template] -
+ * @property {string} [Template.CustomerKey] key of optionally associated DE teplate
+ * @typedef {Object.<string, DataExtensionItem>} DataExtensionMap
+ */
+/**
+ * @typedef {object} AccountUserDocument
+ * @property {string} TYPE user.type__c
+ * @property {string} UserID user.UserID
+ * @property {string} AccountUserID user.AccountUserID
+ * @property {string} CustomerKey user.CustomerKey
+ * @property {string} Name user.Name
+ * @property {string} Email user.Email
+ * @property {string} NotificationEmailAddress user.NotificationEmailAddress
+ * @property {string} ActiveFlag user.ActiveFlag === true ? '✓' : '-'
+ * @property {string} IsAPIUser user.IsAPIUser === true ? '✓' : '-'
+ * @property {string} MustChangePassword user.MustChangePassword === true ? '✓' : '-'
+ * @property {string} DefaultBusinessUnit defaultBUName
+ * @property {string} AssociatedBusinessUnits__c associatedBus
+ * @property {string} Roles roles
+ * @property {string} UserPermissions userPermissions
+ * @property {string} LastSuccessfulLogin this.timeSinceDate(user.LastSuccessfulLogin)
+ * @property {string} CreatedDate user.CreatedDate
+ * @property {string} ModifiedDate user.ModifiedDate
+ */
+
+/**
+ * @typedef {object} AutomationActivity
+ * @property {string} name name (not key) of activity
+ * @property {string} [objectTypeId] Id of assoicated activity type; see this.definition.activityTypeMapping
+ * @property {string} [activityObjectId] Object Id of assoicated metadata item
+ * @property {number} [displayOrder] order within step; starts with 1 or higher number
+ * @property {string} r__type see this.definition.activityTypeMapping
+ */
+/**
+ * @typedef {object}  AutomationStep
+ * @property {string} name description
+ * @property {string} [annotation] equals AutomationStep.name
+ * @property {number} [step] step iterator; starts with 1
+ * @property {number} [stepNumber] step iterator, automatically set during deployment
+ * @property {AutomationActivity[]} activities -
+ */
+/**
+ * @typedef {object} AutomationSchedule REST format
+ * @property {number} typeId ?
+ * @property {string} startDate example: '2021-05-07T09:00:00'
+ * @property {string} endDate example: '2021-05-07T09:00:00'
+ * @property {string} icalRecur example: 'FREQ=DAILY;UNTIL=20790606T160000;INTERVAL=1'
+ * @property {string} timezoneName example: 'W. Europe Standard Time'; see this.definition.timeZoneMapping
+ * @property {number} [timezoneId] see this.definition.timeZoneMapping
+ */
+/**
+ * @typedef {object} AutomationScheduleSoap SOAP format
+ * @property {object} Recurrence -
+ * @property {object} Recurrence.$ {'xsi:type': keyStem + 'lyRecurrence'}
+ * @property {'ByYear'} [Recurrence.YearlyRecurrencePatternType] * currently not supported by tool *
+ * @property {'ByMonth'} [Recurrence.MonthlyRecurrencePatternType] * currently not supported by tool *
+ * @property {'ByWeek'} [Recurrence.WeeklyRecurrencePatternType] * currently not supported by tool *
+ * @property {'ByDay'} [Recurrence.DailyRecurrencePatternType] -
+ * @property {'Interval'} [Recurrence.MinutelyRecurrencePatternType] -
+ * @property {'Interval'} [Recurrence.HourlyRecurrencePatternType] -
+ * @property {number} [Recurrence.YearInterval] 1..n * currently not supported by tool *
+ * @property {number} [Recurrence.MonthInterval] 1..n * currently not supported by tool *
+ * @property {number} [Recurrence.WeekInterval] 1..n * currently not supported by tool *
+ * @property {number} [Recurrence.DayInterval] 1..n
+ * @property {number} [Recurrence.HourInterval] 1..n
+ * @property {number} [Recurrence.MinuteInterval] 1..n
+ * @property {number} _interval internal variable for CLI output only
+ * @property {object} TimeZone -
+ * @property {number} TimeZone.ID AutomationSchedule.timezoneId
+ * @property {string} _timezoneString internal variable for CLI output only
+ * @property {string} StartDateTime AutomationSchedule.startDate
+ * @property {string} EndDateTime AutomationSchedule.endDate
+ * @property {string} _StartDateTime AutomationSchedule.startDate; internal variable for CLI output only
+ * @property {'EndOn'|'EndAfter'} RecurrenceRangeType set to 'EndOn' if AutomationSchedule.icalRecur contains 'UNTIL'; otherwise to 'EndAfter'
+ * @property {number} Occurrences only exists if RecurrenceRangeType=='EndAfter'
+ */
+/**
+ * @typedef {object} AutomationItem
+ * @property {string} [id] Object Id
+ * @property {string} key key
+ * @property {string} name name
+ * @property {string} description -
+ * @property {'scheduled'|'triggered'} type Starting Source = Schedule / File Drop
+ * @property {'Scheduled'|'Running'|'Ready'|'Building'|'PausedSchedule'|'InactiveTrigger'} status -
+ * @property {AutomationSchedule} [schedule] only existing if type=scheduled
+ * @property {object} [fileTrigger] only existing if type=triggered
+ * @property {string} fileTrigger.fileNamingPattern file name with placeholders
+ * @property {number} fileTrigger.fileNamePatternTypeId -
+ * @property {string} fileTrigger.folderLocationText where to look for the fileNamingPattern
+ * @property {boolean} fileTrigger.isPublished ?
+ * @property {boolean} fileTrigger.queueFiles ?
+ * @property {boolean} fileTrigger.triggerActive -
+ * @property {object} [startSource] -
+ * @property {AutomationSchedule} [startSource.schedule] rewritten to AutomationItem.schedule
+ * @property {object} [startSource.fileDrop] rewritten to AutomationItem.fileTrigger
+ * @property {string} startSource.fileDrop.fileNamingPattern file name with placeholders
+ * @property {string} startSource.fileDrop.fileNamePatternTypeId -
+ * @property {string} startSource.fileDrop.folderLocation -
+ * @property {boolean} startSource.fileDrop.queueFiles -
+ * @property {number} startSource.typeId -
+ * @property {AutomationStep[]} steps -
+ * @property {string} r__folder_Path folder path
+ * @property {string} [categoryId] holds folder ID, replaced with r__folder_Path during retrieve
+ */
+/**
+ * @typedef {Object.<string, AutomationItem>} AutomationMap
+ * @typedef {{metadata:AutomationMap,type:string}} AutomationMapObj
+ * @typedef {{metadata:AutomationItem,type:string}} AutomationItemObj
+ * @typedef {object} DeltaPkgItem
+ * @property {string} file relative path to file
+ * @property {number} changes changed lines
+ * @property {number} insertions added lines
+ * @property {number} deletions deleted lines
+ * @property {boolean} binary is a binary file
+ * @property {boolean} moved git thinks this file was moved
+ * @property {string} [fromPath] git thinks this relative path is where the file was before
+ * @property {SupportedMetadataTypes} type metadata type
+ * @property {string} externalKey key
+ * @property {string} name name
+ * @property {'move'|'add/update'|'delete'} gitAction what git recognized as an action
+ * @property {string} _credential mcdev credential name
+ * @property {string} _businessUnit mcdev business unit name inside of _credential
+ * @typedef {SDK} SDK
+ */
+
+/**
+ * @typedef {object} skipInteraction signals what to insert automatically for things usually asked via wizard
+ * @property {string} client_id client id of installed package
+ * @property {string} client_secret client secret of installed package
+ * @property {string} auth_url tenant specific auth url of installed package
+ * @property {number} account_id MID of the Parent Business Unit
+ * @property {string} credentialName how you would like the credential to be named
+ * @property {string} gitRemoteUrl URL of Git remote server
+ */
+
+/**
+ * @typedef {object} AuthObject
+ * @property {string} client_id client_id client_id for sfmc-sdk auth
+ * @property {string} client_secret client_secret for sfmc-sdk auth
+ * @property {number} account_id mid of business unit to auth against
+ * @property {string} auth_url authentication base url
+ */
+
+/**
+ * @typedef {object} SoapRequestParams
+ * @property {string} [continueRequest] request id
+ * @property {object} [options] additional options (CallsInConversation, Client, ConversationID, Priority, RequestType, SaveOptions, ScheduledTime, SendResponseTo, SequenceCode)
+ * @property {*} clientIDs ?
+ * @property {SoapFilter} [filter] simple or complex
+complex
+ * @property {boolean} [QueryAllAccounts] all BUs or just one
+ * @typedef {object} SoapFilter
+ * @property {string|SoapFilter} leftOperand string for simple or a new filter-object for complex
+ * @property {'AND'|'OR'|'equals'|'notEquals'|'isNull'|'isNotNull'|'greaterThan'|'lessThan'|'greaterThanOrEqual'|'lessThanOrEqual'|'between'|'IN'|'like'} operator various options
+ * @property {string|number|boolean|Array|SoapFilter} [rightOperand] string for simple or a new filter-object for complex; omit for isNull and isNotNull
+ */
+
+/**
+ * @typedef {object} Mcdevrc
+ * @property {object} credentials list of credentials
+ * @property {object} options configure options for mcdev
+ * @property {object} directories configure directories for mcdev to read/write to
+ * @property {string} directories.businessUnits "businessUnits/"
+ * @property {string} directories.deploy "deploy/"
+ * @property {string} directories.docs "docs/"
+ * @property {string} directories.retrieve "retrieve/"
+ * @property {string} directories.template "template/"
+ * @property {string} directories.templateBuilds ["retrieve/", "deploy/"]
+ * @property {Object.<string, object>} markets templating variables grouped by markets
+ * @property {object} marketList combination of markets and BUs for streamlined deployments
+ * @property {object} metaDataTypes templating variables grouped by markets
+ * @property {string[]} metaDataTypes.retrieve define what types shall be downloaded by default during retrieve
+ * @property {string[]} metaDataTypes.documentOnRetrieve which types should be parsed & documented after retrieve
+ * @property {string} version mcdev version that last updated the config file
+ */
+
+/**
+ * @typedef {object} Logger
+ * @property {Function} info (msg) print info message
+ * @property {Function} warn (msg) print warning message
+ * @property {Function} verbose (msg) additional messages that are not important
+ * @property {Function} debug (msg) print debug message
+ * @property {Function} error (msg) print error message
+ * @property {Function} errorStack (ex, msg) print error with trace message
+ */
+
+module.exports = {};

package/CHANGELOG.md

@@ -1,126 +0,0 @@
-# Changelog
-
-Accenture SFMC DevTools follows [semantic versioning](https://semver.org/).
-
----
-
-## [3.1.1](https://github.com/Accenture/sfmc-devtools/compare/v3.1.0...v3.1.1) - 2022-01-10
-
-**Bugfixes:**
-
-- [#160](https://github.com/Accenture/sfmc-devtools/issues/160) mcdev outputs bogus text since dependency colorjs got corrupted ( [background story](https://www.theverge.com/2022/1/9/22874949/developer-corrupts-open-source-libraries-projects-affected))
-
-**Chores:**
-
-- bumped cli-progress to 3.10.0 (removes colors dependency)
-- bumped winston to 3.3.4 (removes colors dependency)
-
----
-
-## [3.1.0](https://github.com/Accenture/sfmc-devtools/compare/v3.0.3...v3.1.0) - 2021-12-27
-
-**Features:**
-
-- [#55](https://github.com/Accenture/sfmc-devtools/issues/55) added user / roles documentation
-- [#64](https://github.com/Accenture/sfmc-devtools/issues/64) Added `accountUser` (system users) support (retrieve)
-- [#103](https://github.com/Accenture/sfmc-devtools/issues/103) Add rename `dataExtensionField` option (via Name_new)
-- [#130](https://github.com/Accenture/sfmc-devtools/issues/130) offer `retrieveChangelog` option to other node packages including mcdev (see [retrieveChangelog.js](/lib/retrieveChangelog.js) for a how-to)
-- [#133](https://github.com/Accenture/sfmc-devtools/issues/133) `dataExtensionField` validation during DE update (see [README](README.md#722-addingupdating-fields-on-existing-data-extensions) for details)
-- [#136](https://github.com/Accenture/sfmc-devtools/issues/136) enable including mcdev in other node packages (see [README](README.md#26-using-mcdev-in-other-node-packages) for a how-to)
-- [#144](https://github.com/Accenture/sfmc-devtools/issues/144) added file type .ai to `asset` - thanks to @fbellgr
-
-**Bugfixes:**
-
-- [#112](https://github.com/Accenture/sfmc-devtools/issues/112) add (unknown) new type 783 to defintion of `importFile`
-- [#117](https://github.com/Accenture/sfmc-devtools/issues/117) `queries` not deployable when target is `shared DE`
-- [#118](https://github.com/Accenture/sfmc-devtools/issues/118) `automation` start not auto-retried during deploy
-- [#119](https://github.com/Accenture/sfmc-devtools/issues/119) fixed `list` dependency for importFile
-- [#122](https://github.com/Accenture/sfmc-devtools/issues/122) ECONNRESET on caching metadata during deploy
-- [#128](https://github.com/Accenture/sfmc-devtools/issues/128) `dataExtension` json not equal for retrieve/deploy
-- [#129](https://github.com/Accenture/sfmc-devtools/issues/129) `script` json not equal for retrieve/deploy
-- [#140](https://github.com/Accenture/sfmc-devtools/issues/140) avoid issues when retrieving `dataExtensions` that do not have a folder ID (edge case) - thanks to @fbellgr
-- [#144](https://github.com/Accenture/sfmc-devtools/issues/144) improved handling high volumes of `asset` - thanks to @fbellgr
-- [#149](https://github.com/Accenture/sfmc-devtools/issues/149) handle errors on upsert of data extensions gracefully
-
-**Chores:**
-
-- [#5](https://github.com/Accenture/sfmc-devtools/issues/5) removed postinstall msg after npm 7 dropped support for that
-- [#127](https://github.com/Accenture/sfmc-devtools/issues/127) bad message "info: updated automation: undefined"
-- [#132](https://github.com/Accenture/sfmc-devtools/issues/132) `dataExtension.SendableSubscriberField.Name` now has a slightly more readable value
-- [#137](https://github.com/Accenture/sfmc-devtools/issues/137) docs for installing a specific version were incorrect
-- [#138](https://github.com/Accenture/sfmc-devtools/issues/138) make issues and pull requests clickable in gitfork
-- change `mcdev document` to take the cred/BU first and then the type to align it with other commands
-- improved error handling of `document role` command
-- bumped cli-progress to 3.9.1
-- bumped eslint to 8.4.1
-- bumped eslint-plugin-mocha to 10.0.1
-- bumped eslint-plugin-prettier to 4.0.0
-- bumped fs-extra to 10.0.0
-- bumped husky to 7.0.4
-- bumped inquirer to 8.2.0
-- bumped jsdoc-to-markdown to 7.1.0
-- bumped lint-staged to 12.1.2
-- bumped mocha to 9.1.3
-- bumped mustache to 4.2.0
-- bumped prettier to 2.5.1
-- bumped semver to 7.3.5
-- bumped simple-git to 2.48.0
-- bumped yargs to 17.3.0
-- [#146](https://github.com/Accenture/sfmc-devtools/issues/146) remove AccountUser retrieve as a default retrieve option
-
----
-
-## [3.0.3](https://github.com/Accenture/sfmc-devtools/compare/v3.0.2...v3.0.3) - 2021-08-11
-
-**Bugfixes:**
-
-- [#100](https://github.com/Accenture/sfmc-devtools/issues/100) Handle ECONNRESET errors across various types (incl. Data Extensions)
-- [#102](https://github.com/Accenture/sfmc-devtools/issues/102) block deployment attempt for synchronized Data Extensions with proper error message
-- [#104](https://github.com/Accenture/sfmc-devtools/issues/104) block deployment of shared data extensions on child BUs (existing solution broke somewhere down the line)
-
-**Chores:**
-
-- [#107](https://github.com/Accenture/sfmc-devtools/issues/107) rewrite folder to use generic update/create to help with ECONNRESET issue
-- [#108](https://github.com/Accenture/sfmc-devtools/issues/108) return full API error messages for create & update via SOAP
-- [#110](https://github.com/Accenture/sfmc-devtools/issues/110) improve error message for missing dependencies
-- bumped jsdoc-to-markdown to 7.0.1
-- bumped eslint-plugin-mocha to 9.0.0
-- bumped eslint-plugin-prettier to 3.4.0
-- bumped eslint-config-prettier to 8.3.0
-- bumped eslint to 7.32.0
-- enhanced Pull Request Template with note on `npm run docs`
-
----
-
-## [3.0.2](https://github.com/Accenture/sfmc-devtools/compare/v3.0.1...v3.0.2) - 2021-08-03
-
-**Bugfixes:**
-
-- [#26](https://github.com/Accenture/sfmc-devtools/issues/26) retrieving asset subtypes via r ... asset-xyz actually saves result to disk
-- [#45](https://github.com/Accenture/sfmc-devtools/issues/45) connection errors for automations fixed
-- [#46](https://github.com/Accenture/sfmc-devtools/issues/46) (temp fix) campaigns break entire retrieve - disabled for now
-- [#48](https://github.com/Accenture/sfmc-devtools/issues/48) connection errors for dataExtensions and other types are now handled gracefully
-- [#49](https://github.com/Accenture/sfmc-devtools/issues/49) connection errors for asset subtypes no longer restart downloading all subtypes
-- [#51](https://github.com/Accenture/sfmc-devtools/issues/51) retrieving asset subtypes now always uses the default list of subtypes
-- [#52](https://github.com/Accenture/sfmc-devtools/issues/52) no more endless retries in case of connection errors
-
----
-
-## [3.0.1](https://github.com/Accenture/sfmc-devtools/compare/v3.0.0...v3.0.1) - 2021-04-11
-
-**Bugfixes:**
-
-- fix [#4](https://github.com/Accenture/sfmc-devtools/issues/4): retrieveAsTemplate led to fatal error if target metadata was not found
-- migration from prior internal version was not handled gracefully before
-
----
-
-## 3.0.0 - 2021-03-26
-
-Initial public release.
-
----
-
-## 2.0.0 - 2020-02-03
-
-Initial Accenture-wide release.

package/PULL_REQUEST_TEMPLATE.md

@@ -1,19 +0,0 @@
-# PR details
-
-## What is the purpose of this pull request? (put an "X" next to an item)
-
-- [ ] Documentation update
-- [ ] Bug fix
-- [ ] New metadata support
-- [ ] Enhanced metadata
-- [ ] Add a CLI option
-- [ ] Add something to the core
-- [ ] Other, please explain:
-
-## What changes did you make? (Give an overview)
-
-...
-
-## Is there anything you'd like reviewers to focus on?
-
-...

package/test/util/file.js

@@ -1,51 +0,0 @@
-const assert = require('chai').assert;
-const File = require('../../lib/util/file');
-const fs = require('fs-extra');
-const path = require('path');
-
-const dataDir = 'test_tmp/file/';
-
-describe('File', () => {
-    after(() => {
-        fs.removeSync(dataDir);
-    });
-    describe('#writeJSONToFile()', () => {
-        it('should create json file and directory', async () => {
-            assert.strictEqual(fs.existsSync(dataDir + 'test1.json'), false);
-            const jsonContent = {
-                string: 'abc',
-                boolean: true,
-                number: 5,
-                array: ['asd', 4, 'asdf'],
-                obj: {
-                    name: 'object',
-                },
-            };
-            await File.writeJSONToFile(dataDir, 'test1', jsonContent);
-            assert.deepEqual(fs.readJSONSync(dataDir + 'test1.json'), jsonContent);
-        });
-    });
-    describe('#copyFile()', () => {
-        it('should copy file from one path to another', async () => {
-            const source = path.join(dataDir, 'sourceFile.txt');
-            const target = path.join(dataDir, 'targetFile.txt');
-            fs.writeFileSync(source, 'filecontent');
-            assert.strictEqual(fs.existsSync(source), true);
-            await File.copyFile(source, target);
-            assert.strictEqual(fs.existsSync(target), true);
-            assert.deepEqual(fs.readFileSync(source), fs.readFileSync(target));
-        });
-        it("should skip copy if source file doesn't exist", async () => {
-            const source = path.join(dataDir, 'doesnt_exist_source.txt');
-            const target = path.join(dataDir, 'doesnt_exist_target.txt');
-            assert.strictEqual(fs.existsSync(source), false);
-            const result = await File.copyFile(source, target);
-            assert.strictEqual(fs.existsSync(target), false);
-            assert.deepEqual(result, {
-                status: 'skipped',
-                statusMessage: 'deleted from repository',
-                file: source,
-            });
-        });
-    });
-});