mcdev 6.0.2 → 7.0.0

package/test/utils.js

@@ -36,10 +36,13 @@ export function getActualJson(customerKey, type, buName = 'testBU') {
  * @param {string} customerKey of metadata
  * @param {string} type of metadata
  * @param {string} [buName] used when we need to test on ParentBU
- * @returns {string} file path
+ * @returns {Promise.<string>} file path
  */
 export function getActualDoc(customerKey, type, buName = 'testBU') {
-    return `./retrieve/testInstance/${buName}/${type}/${customerKey}.${type}-doc.md`;
+    return File.readFile(
+        `./retrieve/testInstance/${buName}/${type}/${customerKey}.${type}-doc.md`,
+        'utf8'
+    );
 }
 /**
  * gets file from Retrieve folder
@@ -47,10 +50,17 @@ export function getActualDoc(customerKey, type, buName = 'testBU') {
  * @param {string} customerKey of metadata
  * @param {string} type of metadata
  * @param {string} ext file extension
- * @returns {string} file path
+ * @param {string} [buName] used when we need to test on ParentBU
+ * @returns {Promise.<string | null>} file in string form, null if not found
  */
-export function getActualFile(customerKey, type, ext) {
-    return `./retrieve/testInstance/testBU/${type}/${customerKey}.${type}-meta.${ext}`;
+export async function getActualFile(customerKey, type, ext, buName = 'testBU') {
+    const path = `./retrieve/testInstance/${buName}/${type}/${customerKey}.${type}-meta.${ext}`;
+    try {
+        return await File.readFile(path, 'utf8');
+    } catch {
+        console.log(`File not found: ${path}`); // eslint-disable-line no-console
+        return null;
+    }
 }
 /**
  * gets file from Deploy folder
@@ -58,7 +68,7 @@ export function getActualFile(customerKey, type, ext) {
  * @param {string} customerKey of metadata
  * @param {string} type of metadata
  * @param {string} [buName] used when we need to test on ParentBU
- * @returns {Promise.<string>} file in string form
+ * @returns {Promise.<string>} file in JSON form
  */
 export function getActualDeployJson(customerKey, type, buName = 'testBU') {
     return File.readJSON(
@@ -71,17 +81,21 @@ export function getActualDeployJson(customerKey, type, buName = 'testBU') {
  * @param {string} customerKey of metadata
  * @param {string} type of metadata
  * @param {string} ext file extension
- * @returns {string} file path
+ * @param {string} [buName] used when we need to test on ParentBU
+ * @returns {Promise.<string>} file in string form
  */
-export function getActualDeployFile(customerKey, type, ext) {
-    return `./deploy/testInstance/testBU/${type}/${customerKey}.${type}-meta.${ext}`;
+export function getActualDeployFile(customerKey, type, ext, buName = 'testBU') {
+    return File.readFile(
+        `./deploy/testInstance/${buName}/${type}/${customerKey}.${type}-meta.${ext}`,
+        'utf8'
+    );
 }
 /**
  * gets file from Template folder
  *
  * @param {string} customerKey of metadata
  * @param {string} type of metadata
- * @returns {Promise.<string>} file in string form
+ * @returns {Promise.<string>} file in JSON form
  */
 export function getActualTemplateJson(customerKey, type) {
     return File.readJSON(`./template/${type}/${customerKey}.${type}-meta.json`);
@@ -92,33 +106,33 @@ export function getActualTemplateJson(customerKey, type) {
  * @param {string} customerKey of metadata
  * @param {string} type of metadata
  * @param {string} ext file extension
- * @returns {string} file path
+ * @returns {Promise.<string>} file in string form
  */
 export function getActualTemplateFile(customerKey, type, ext) {
-    return `./template/${type}/${customerKey}.${type}-meta.${ext}`;
+    return File.readFile(`./template/${type}/${customerKey}.${type}-meta.${ext}`, 'utf8');
 }
 /**
  * gets file from resources folder which should be used for comparison
  *
- * @param {number} mid of Business Unit
+ * @param {string} mid of Business Unit
  * @param {string} type of metadata
  * @param {string} action of SOAP request
- * @returns {Promise.<string>} file in string form
+ * @returns {Promise.<string>} file in JSON form
  */
 export function getExpectedJson(mid, type, action) {
-    return File.readJSON(path.join('test', 'resources', mid, type, action + '-expected.json'));
+    return File.readJSON(`./test/resources/${mid}/${type}/${action}-expected.json`);
 }
 /**
  * gets file from resources folder which should be used for comparison
  *
- * @param {number} mid of Business Unit
+ * @param {string} mid of Business Unit
  * @param {string} type of metadata
  * @param {string} action of SOAP request
  * @param {string} ext file extension
- * @returns {string} file path
+ * @returns {Promise.<string>} file in string form
  */
 export function getExpectedFile(mid, type, action, ext) {
-    return path.join('test', 'resources', mid, type, action + '-expected.' + ext);
+    return File.readFile(`./test/resources/${mid}/${type}/${action}-expected.${ext}`, 'utf8');
 }
 /**
  * setup mocks for API and FS
@@ -127,10 +141,34 @@ export function getExpectedFile(mid, type, action, ext) {
  * @returns {void}
  */
 export function mockSetup(isDeploy) {
+    // no need to execute this again if we ran it a 2nd time for deploy - already done in standard setup
     if (!isDeploy) {
-        // no need to execute this again - already done in standard setup
-        handler.setOptions({ debug: true, noLogFile: true });
+        // reset all options to default
+        handler.setOptions({
+            // test config
+            debug: true,
+            noLogFile: true,
+            // reset
+            api: undefined,
+            keySuffix: undefined,
+            changeKeyField: undefined,
+            changeKeyValue: undefined,
+            commitHistory: undefined,
+            errorLog: undefined,
+            execute: undefined,
+            filter: undefined,
+            fixShared: undefined,
+            fromRetrieve: undefined,
+            json: undefined,
+            like: undefined,
+            noMidSuffix: undefined,
+            refresh: undefined,
+            _runningTest: undefined,
+            schedule: undefined,
+            skipInteraction: undefined,
+        });
     }
+    // @ts-expect-error somehow, MockAdapter does not expect type AxiosInstance
     apimock = new MockAdapter(axiosInstance, { onNoMatch: 'throwException' });
     // set access_token to mid to allow for autorouting of mock to correct resources
     apimock.onPost(authResources.success.url).reply((config) => {
@@ -142,6 +180,9 @@ export function mockSetup(isDeploy) {
         .onAny(new RegExp(`^${escapeRegExp(restUrl)}`))
         .reply((config) => handleRESTRequest(config));
     const fsMockConf = {
+        '.beautyamp.json': fsmock.load(
+            path.resolve(__dirname, '../boilerplate/files/.beautyamp.json')
+        ),
         '.prettierrc': fsmock.load(path.resolve(__dirname, '../boilerplate/files/.prettierrc')),
         '.eslintrc': fsmock.load(path.resolve(__dirname, '../boilerplate/files/.eslintrc')),
         '.eslintignore': fsmock.load(path.resolve(__dirname, '../boilerplate/files/.eslintignore')),
@@ -168,6 +209,7 @@ export function mockSetup(isDeploy) {
         'node_modules/sql-formatter': fsmock.load(
             path.resolve(__dirname, '../node_modules/sql-formatter')
         ),
+        'node_modules/jsox': fsmock.load(path.resolve(__dirname, '../node_modules/jsox')),
         'node_modules/nearley': fsmock.load(path.resolve(__dirname, '../node_modules/nearley')),
     };
     if (isDeploy) {
@@ -218,6 +260,19 @@ export function getAPIHistoryLength(includeToken) {
 export function getAPIHistory() {
     return apimock.history;
 }
+/**
+ *
+ * @param {'patch'|'delete'|'post'|'get'|'put'} method http method
+ * @param {string} url url without domain, end on % if you want to search with startsWith()
+ * @returns {object} json payload of the request
+ */
+export function getRestCallout(method, url) {
+    const subset = apimock.history[method];
+    const myCallout = subset.find((item) =>
+        url.endsWith('%') ? item.url.startsWith(url.slice(0, -1)) : item.url === url
+    );
+    return JSON.parse(myCallout.data);
+}
 /**
  * helper to return most important fields for each api call
  *
@@ -251,5 +306,5 @@ export function logAPIHistoryDebug() {
  * @returns {string} escaped string
  */
 function escapeRegExp(str) {
-    return str.replaceAll(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string
+    return str.replaceAll(/[.*+?^${}()|[\]\\]/g, String.raw`\$&`); // $& means the whole matched string
 }

package/tsconfig.json

@@ -0,0 +1,21 @@
+{
+    // Change this to match your project
+    "include": ["lib/**/*"],
+    "compilerOptions": {
+        // Tells TypeScript to read JS files, as
+        // normally they are ignored as source files
+        "allowJs": true,
+        // Generate d.ts files
+        "declaration": true,
+        // This compiler run should
+        // only output d.ts files
+        "emitDeclarationOnly": true,
+        // Types should go into this directory.
+        // Removing this would place the .d.ts files
+        // next to the .js files
+        "outDir": "@types",
+        // go to js file when using IDE functions like
+        // "Go to Definition" in VSCode
+        "declarationMap": true
+    }
+}

package/types/mcdev.d.js

@@ -1,28 +1,26 @@
-import SDK from '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} [clientId] installed package client id
+ * @property {string} [clientSecret] installed package client secret
+ * @property {string} [tenant] subdomain part of Authentication Base Uri
+ * @property {number} [eid] Enterprise ID = MID of the parent BU
+ * @property {number} [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'|'asset-archive'|'asset-asset'|'asset-audio'|'asset-block'|'asset-code'|'asset-document'|'asset-image'|'asset-message'|'asset-other'|'asset-rawimage'|'asset-template'|'asset-textfile'|'asset-video'|'attributeGroup'|'automation'|'campaign'|'contentArea'|'dataExtension'|'dataExtensionField'|'dataExtensionTemplate'|'dataExtract'|'dataExtractType'|'discovery'|'email'|'emailSend'|'event'|'fileTransfer'|'filter'|'folder'|'fileLocation'|'importFile'|'interaction'|'list'|'mobileCode'|'mobileKeyword'|'query'|'role'|'script'|'setDefinition'|'triggeredSend'} SupportedMetadataTypes
- * @typedef {Object.<SupportedMetadataTypes, string[]>} TypeKeyCombo object-key=metadata type, value=array of external keys
+ * @typedef {'asset'|'asset-archive'|'asset-asset'|'asset-audio'|'asset-block'|'asset-code'|'asset-document'|'asset-image'|'asset-message'|'asset-other'|'asset-rawimage'|'asset-template'|'asset-textfile'|'asset-video'|'attributeGroup'|'attributeSet'|'automation'|'campaign'|'contentArea'|'dataExtension'|'dataExtensionField'|'dataExtensionTemplate'|'dataExtract'|'dataExtractType'|'discovery'|'deliveryProfile'|'email'|'emailSend'|'event'|'fileLocation'|'fileTransfer'|'filter'|'folder'|'importFile'|'journey'|'list'|'mobileCode'|'mobileKeyword'|'mobileMessage'|'query'|'role'|'script'|'sendClassification'|'senderProfile'|'transactionalEmail'|'transactionalPush'|'transactionalSMS'|'triggeredSend'|'user'|'verification'} SupportedMetadataTypes
+ * @typedef {Object.<string, string[] | null>} TypeKeyCombo object-key=SupportedMetadataTypes, value=array of external keys
  */
 
 /**
- * @typedef {Object.<string, any>} MetadataTypeItem
+ * @typedef {Object.<any, any>} MetadataTypeItem generic metadata item
  * @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 {{metadata: MetadataTypeMap, type: string}} MetadataTypeMapObj
+ * @typedef {{metadata: MetadataTypeItem, type: string}} MetadataTypeItemObj
  * @typedef {Object.<number, MultiMetadataTypeMap>} Cache key=MID
  * @typedef {{before: MetadataTypeItem, after: MetadataTypeItem}} MetadataTypeItemDiff used during update
  */
@@ -46,22 +44,20 @@ import SDK from 'sfmc-sdk';
  * @property {string} name name
  * @property {string} key key
  * @property {string} description -
+ * @property {string} [targetId] Object ID of DE (removed before save)
  * @property {string} targetKey key of target data extension
+ * @property {string} r__dataExtension_key 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 {number} [targetUpdateTypeId] 0|1|2, mapped to targetUpdateTypeName via this.definition.targetUpdateTypeMapping
  * @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
+ * @property {string} [queryDefinitionId] Object ID of query
  * @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
@@ -90,10 +86,14 @@ import SDK from 'sfmc-sdk';
  * @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} [IsNullable] opposite of IsRequired
  * @property {true|false} IsPrimaryKey -
- * @property {string} Ordinal 1, 2, 3, ...
+ * @property {number} Ordinal 1, 2, 3, ...
  * @property {'Text'|'Number'|'Date'|'Boolean'|'Decimal'|'EmailAddress'|'Phone'|'Locale'} FieldType can only be set on create
+ * @property {number|string} MaxLength field length
  * @property {string} Scale the number of places after the decimal that the field can hold; example: "0","1", ...
+ */
+/**
  * @typedef {Object.<string, DataExtensionFieldItem>} DataExtensionFieldMap
  */
 /**
@@ -113,13 +113,25 @@ import SDK from 'sfmc-sdk';
  * @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 {string} [r__dataExtensionTemplate_name] name of optionally associated DE template
  * @property {object} [Template] -
  * @property {string} [Template.CustomerKey] key of optionally associated DE teplate
+ * @property {string} RetainUntil empty string or US date + 12:00:00 AM
+ * @property {string} c__retainUntil YYYY-MM-DD
+ * @property {'none'|'allRecordsAndDataextension'|'allRecords'|'individialRecords'} [c__retentionPolicy] readable name of retention policy
+ * @property {number} [DataRetentionPeriodLength] number of days/weeks/months/years before retention kicks in
+ * @property {number} [DataRetentionPeriodUnitOfMeasure] 3:Days, 4:Weeks, 5:Months, 6:Years
+ * @property {string} [c__dataRetentionPeriodUnitOfMeasure] 3:Days, 4:Weeks, 5:Months, 6:Years
+ * @property {boolean} [RowBasedRetention] true for retention policy individialRecords
+ * @property {boolean} ResetRetentionPeriodOnImport ?
+ * @property {boolean} [DeleteAtEndOfRetentionPeriod] true for retention policy allRecords
+ */
+/**
  * @typedef {Object.<string, DataExtensionItem>} DataExtensionMap
  */
 /**
  * @typedef {object} UserDocument
+ * @property {'User'|'Installed Package'|'Inactivated User'} TYPE -
  * @property {string} [ID] equal to UserID; optional in update/create calls
  * @property {string} UserID equal to ID; required in update/create calls
  * @property {number} [AccountUserID] user.AccountUserID
@@ -131,7 +143,7 @@ import SDK from 'sfmc-sdk';
  * @property {boolean} ActiveFlag user.ActiveFlag === true ? '✓' : '-'
  * @property {boolean} IsAPIUser user.IsAPIUser === true ? '✓' : '-'
  * @property {boolean} MustChangePassword user.MustChangePassword === true ? '✓' : '-'
- * @property {number} DefaultBusinessUnit defaultBUName
+ * @property {number} DefaultBusinessUnit default MID; BUName after we resolved it
  * @property {number[]} c__AssociatedBusinessUnits associatedBus
  * @property {object} [Roles] (API only)
  * @property {object[]} [Roles.Role] roles (API only)
@@ -142,27 +154,39 @@ import SDK from 'sfmc-sdk';
  * @property {string} ModifiedDate user.ModifiedDate
  * @property {object} Client -
  * @property {number} [Client.ID] EID e.g:7281698
- * @property {number} Client.ModifiedBy AccountUserID of user who last modified this user
+ * @property {number} [Client.ModifiedBy] AccountUserID of user who last modified this user
  * @property {'User'|'Installed Package'} c__type -
- * @property {boolean} [IsLocked] (API only)
+ * @property {boolean|string} [IsLocked] (API only)
  * @property {boolean} [Unlock] used to unlock a user that has IsLocked === true
  * @property {boolean} c__IsLocked_readOnly copy of IsLocked
  * @property {string} c__TimeZoneName name of timezone
  * @property {object} [TimeZone] (API only)
  * @property {string} [TimeZone.Name] (API only)
  * @property {string} [TimeZone.ID] (API only)
+ * @property {string} [Password] only used to set the password. cannot be retrieved
  * @property {'en-US'|'fr-CA'|'fr-FR'|'de-DE'|'it-IT'|'ja-JP'|'pt-BR'|'es-419'|'es-ES'} c__LocaleCode fr-CA, en-US, ...
  * @property {object} [Locale] (API only)
  * @property {'en-US'|'fr-CA'|'fr-FR'|'de-DE'|'it-IT'|'ja-JP'|'pt-BR'|'es-419'|'es-ES'} [Locale.LocaleCode] (API only)
+ * @property {object} [SsoIdentity] -
+ * @property {Array|object} [SsoIdentities] -
+ */
+/**
  * @typedef {{before:UserDocument,after:UserDocument}} UserDocumentDiff
  * @typedef {Object.<string, UserDocument>} UserDocumentMap key=customer key
  */
+/**
+ * @typedef {UserDocument & object} UserDocumentDocument
+ * @property {boolean | string} ActiveFlag user.ActiveFlag === true ? '✓' : '-'
+ * @property {boolean | string} IsAPIUser user.IsAPIUser === true ? '✓' : '-'
+ * @property {boolean | string} MustChangePassword user.MustChangePassword === true ? '✓' : '-'
+ * @property {number | string} DefaultBusinessUnit default MID; BUName after we resolved it
+ */
 /**
  * @typedef {object} AccountUserConfiguration
  * @property {object} Client wrapper
  * @property {number} Client.ID EID e.g:7281698
  * @property {string} [PartnerKey] empty string
- * @property {number} ID User ID e.g:717133502
+ * @property {number | string} ID User ID e.g:717133502
  * @property {string} [ObjectID] empty string
  * @property {number} [Delete] 0,1
  * @property {BusinessUnitAssignmentConfiguration} BusinessUnitAssignmentConfiguration -
@@ -174,8 +198,9 @@ import SDK from 'sfmc-sdk';
 
 /**
  * @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} r__key key of associated activity
+ * @property {string} [name] name (not key) of associated activity
+ * @property {number} [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
@@ -190,17 +215,23 @@ import SDK from 'sfmc-sdk';
  */
 /**
  * @typedef {object} AutomationSchedule REST format
- * @property {number} typeId ?
+ * @property {number} typeId equals schedule.scheduleTypeId; upsert endpoint requires scheduleTypeId. retrieve endpoint returns typeId
+ * @property {number} [scheduleTypeId] equals schedule.typeId; upsert endpoint requires scheduleTypeId. retrieve endpoint returns 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
+ * @property {number} [rangeTypeId] ?
+ * @property {any} [pattern] ?
+ * @property {any} [scheduledTime] ?
+ * @property {string} [scheduledStatus] ?
  */
 /**
  * @typedef {object} AutomationScheduleSoap SOAP format
+ * @property {string} [RecurrenceType] 'Minutely'|'Hourly'|'Daily'|'Weekly'|'Monthly'|'Yearly'
  * @property {object} Recurrence -
- * @property {object} Recurrence.$ {'xsi:type': keyStem + 'lyRecurrence'}
+ * @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 *
@@ -213,24 +244,32 @@ import SDK from 'sfmc-sdk';
  * @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 {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 {true} [TimeZone.IDSpecified] always true
+ * @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 {string} [_StartDateTime] AutomationSchedule.startDate; internal variable for CLI output only
+ * @property {string} [EndDateTime] AutomationSchedule.endDate
  * @property {'EndOn'|'EndAfter'} RecurrenceRangeType set to 'EndOn' if AutomationSchedule.icalRecur contains 'UNTIL'; otherwise to 'EndAfter'
- * @property {number} Occurrences only exists if RecurrenceRangeType=='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 {string} id Object Id
+ * @property {string} [legacyId] legacy Object Id - used for handling notifications
+ * @property {string} [ObjectID] Object Id as returned by SOAP API
+ * @property {string} [programId] legacy id
+ * @property {string} key key (Rest API)
+ * @property {string} [CustomerKey] key (SOAP API)
+ * @property {string} [name] name (Rest API)
+ * @property {string} [Name] name (SOAP API)
+ * @property {any} [notifications] notifications
+ * @property {string} [description] -
+ * @property {'scheduled'|'triggered'} [type] Starting Source = Schedule / File Drop
+ * @property {'Scheduled'|'Running'|'Ready'|'Building'|'PausedSchedule'|'InactiveTrigger'} [status] automation status
+ * @property {number} [statusId] automation 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
@@ -242,13 +281,13 @@ import SDK from 'sfmc-sdk';
  * @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.fileNamePattern file name with placeholders
+ * @property {number} 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 {AutomationStep[]} [steps] -
+ * @property {string} [r__folder_Path] folder path
  * @property {string} [categoryId] holds folder ID, replaced with r__folder_Path during retrieve
  */
 /**
@@ -262,14 +301,15 @@ import SDK from 'sfmc-sdk';
  * @property {string} notificationEmailAddress email address to send notification to; empty string if shouldEmailOnFailure=false
  * @property {string} notificationEmailMessage email message to send; empty string if shouldEmailOnFailure=false
  * @property {number} createdBy user id of creator
- * @property {string} r__dataExtension_CustomerKey key of target data extension
+ * @property {string} [targetObjectId] ObjectID of target data extension
+ * @property {string} r__dataExtension_key key of target data extension
  */
 
 /**
  * @typedef {Object.<string, AutomationItem>} AutomationMap
  * @typedef {{metadata:AutomationMap,type:string}} AutomationMapObj
- * @typedef {{metadata:AutomationItem,type:string}} AutomationItemObj
- * @typedef {object} DeltaPkgItem
+ * @typedef {{metadata:object | AutomationItem,type:string}} AutomationItemObj
+ * @typedef {object} McdevDeltaPkgItem
  * @property {string} file relative path to file
  * @property {number} changes changed lines
  * @property {number} insertions added lines
@@ -277,23 +317,39 @@ import SDK from 'sfmc-sdk';
  * @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} 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 {import('simple-git').DiffResultTextFile & McdevDeltaPkgItem} DeltaPkgItem
+ */
+/**
+ * @typedef {import('sfmc-sdk/auth').default} SDKauth
+ * @typedef {import('sfmc-sdk/rest').default} SDKrest
+ * @typedef {import('sfmc-sdk/soap').default} SDKsoap
+ * @typedef {import('sfmc-sdk/util').RestError} RestError
+ * @typedef {import('sfmc-sdk/util').SOAPError} SOAPError
+ * @typedef {SOAPError & RestError} SDKError
+ * @typedef {object} SDK
+ * @property {SDKauth} auth SDKauth
+ * @property {SDKrest} rest SDKrest
+ * @property {SDKsoap} soap SDKsoap
  */
 
 /**
- * @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} 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
+ * @property {boolean} [fixKeysReretrieve] will trigger re-downloading latest versions of dependent types after fixing keys
+ * @property {string} [gitPush] used by mcdev init to directly push to a remote
+ * @property {string} [developmentBu] used by mcdev init to directly push to a remote
+ * @property {string} [downloadBUs] used by mcdev init to directly push to a remote
  */
 
 /**
@@ -308,14 +364,62 @@ import SDK from 'sfmc-sdk';
  * @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
+ * @property {*} [clientIDs] ?
+ * @property {SoapSDKFilter} [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} SoapFilterSimple
+ * @property {string} property field
+ * @property {'equals'|'notEquals'|'isNull'|'isNotNull'|'greaterThan'|'lessThan'|'greaterThanOrEqual'|'lessThanOrEqual'|'between'|'IN'|'in'|'like'} simpleOperator various options
+ * @property {string | number | boolean | string[] | number[]} [value] field value
+ */
+/**
+ * @typedef {object} SoapFilterComplex
+ * @property {SoapSDKFilter} leftOperand string for simple or a new filter-object for complex
+ * @property {'AND'|'OR'} logicalOperator various options
+ * @property {SoapSDKFilter} rightOperand string for simple or a new filter-object for complex; omit for isNull and isNotNull
+ */
+/**
+ * @typedef {object} SoapSDKFilterSimple
+ * @property {SoapFilterSimple["property"]} leftOperand string for simple or a new filter-object for complex
+ * @property {SoapFilterSimple["simpleOperator"]} operator various options
+ * @property {SoapFilterSimple["value"]} [rightOperand] string for simple or a new filter-object for complex; omit for isNull and isNotNull
+ */
+/**
+ * @typedef {object} SoapSDKFilterComplex
+ * @property {SoapFilterComplex["leftOperand"]} leftOperand string for simple or a new filter-object for complex
+ * @property {SoapFilterComplex["logicalOperator"]} operator various options
+ * @property {SoapFilterComplex["rightOperand"]} rightOperand string for simple or a new filter-object for complex; omit for isNull and isNotNull
+ */
+/**
+ * @typedef {SoapSDKFilterSimple | SoapSDKFilterComplex} SoapSDKFilter
+ */
+
+/**
+ * @typedef {object} AssetRequestParams
+ * @property {string} [continueRequest] request id
+ * @property {object} [options] additional options (CallsInConversation, Client, ConversationID, Priority, RequestType, SaveOptions, ScheduledTime, SendResponseTo, SequenceCode)
+ * @property {*} [clientIDs] ?
+complex
+ * @property {object} [page] pagination
+ * @property {string[]} [fields] list of fields we want returned
+ * @property {{property:string, direction: 'ASC'|'DESC'}[]} [sort] pagination
+ * @property {AssetFilter | AssetFilterSimple} [query] simple or complex filter
+ */
+
+/**
+ * @typedef {object} AssetFilter
+ * @property {AssetFilter | AssetFilterSimple} leftOperand string for simple or a new filter-object for complex
+ * @property {'AND'|'OR'} logicalOperator various options
+ * @property {SoapSDKFilter | AssetFilterSimple} [rightOperand] string for simple or a new filter-object for complex; omit for isNull and isNotNull
+ */
+/**
+ * @typedef {object} AssetFilterSimple
+ * @property {string} property field
+ * @property {'equal'|'notEquals'|'isNull'|'isNotNull'|'greaterThan'|'lessThan'|'greaterThanOrEqual'|'lessThanOrEqual'|'between'|'IN'|'in'|'like'} simpleOperator various options
+ * @property {string | number | boolean | Array} value field value
  */
 
 /**
@@ -338,13 +442,33 @@ complex
  */
 
 /**
- * @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
+ * @typedef {'error'|'verbose'|'info'|'debug'} LoggerLevel
+ * @typedef {object} McdevLogger
+ * @property {LoggerLevel} [level] (msg) print info message
  * @property {Function} error (msg) print error message
  * @property {Function} errorStack (ex, msg) print error with trace message
+ * @typedef {import('winston').Logger & McdevLogger} Logger
+ */
+/**
+ * @typedef {{id: number, key: string, name: string}} AssetItemSimple
+ * @typedef {Object.<string, AssetItemSimple>} AssetItemSimpleMap
+ * @typedef {Object.<number, AssetItemSimple>} AssetItemIdSimpleMap
+ * @typedef {'id'|'key'|'name'} ContentBlockConversionTypes
+ */
+/**
+ * @typedef {object} ExplainType
+ * @property {string} name readable name of type
+ * @property {string} apiName api parameter name for type
+ * @property {string} description more info on what this type is about
+ * @property {boolean | string[]} retrieveByDefault is it retrieved by default OR list of subtypes that are retrieved by default
+ * @property {object} supports supported features
+ * @property {boolean} supports.retrieve can you download this type
+ * @property {boolean} supports.create can you create new records of this type
+ * @property {boolean} supports.update can you update records of this type
+ * @property {boolean} supports.delete can you delete records of this type
+ * @property {boolean} supports.changeKey can you change the key of existing records of this type
+ * @property {boolean} supports.buildTemplate can you apply templating on downloaded records of this type
+ * @property {boolean} supports.retrieveAsTemplate can you retrieve & template in one step
  */
 
 export default {};