mcdev 7.0.3 → 7.0.4

package/test/utils.js

@@ -16,6 +16,17 @@ let apimock;
 import { handleSOAPRequest, handleRESTRequest, soapUrl, restUrl } from './resourceFactory.js';
 const authResources = File.readJsonSync(path.join(__dirname, './resources/auth.json'));
 
+/**
+ * gets file from Retrieve folder
+ *
+ * @param {string} from source path (starting in bu folder)
+ * @param {string} to target path (starting in bu folder)
+ * @param {string} [mid] used when we need to test on ParentBU
+ * @returns {Promise.<{status:'ok'|'skipped'|'failed', statusMessage:string, file:string}>} -
+ */
+export async function copyFile(from, to, mid = '9999999') {
+    return File.copyFileSimple(`./test/resources/${mid}/${from}`, `./test/resources/${mid}/${to}`);
+}
 /**
  * gets file from Retrieve folder
  *
@@ -168,7 +179,6 @@ export function mockSetup(isDeploy) {
             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) => {
@@ -280,7 +290,7 @@ export function getRestCallout(method, url) {
  * @param {string} [objectType] optionall filter requests by object
  * @returns {object[]} json payload of the requests
  */
-export function getSoapCallout(requestAction, objectType) {
+export function getSoapCallouts(requestAction, objectType) {
     const method = 'post';
     const url = '/Service.asmx';
     const subset = apimock.history[method];
@@ -290,10 +300,12 @@ export function getSoapCallout(requestAction, objectType) {
         // find soap requestst of the correct request type
         .filter((item) => item.headers.SOAPAction === requestAction)
         // find soap requestst of the correct request type
-        .filter(
-            (item) =>
-                !objectType ||
-                item.data.split('<ObjectType>')[1].split('</ObjectType>')[0] === objectType
+        .filter((item) =>
+            !objectType || item.data.includes('<ObjectType')
+                ? item.data.split('<ObjectType>')[1].split('</ObjectType>')[0] === objectType
+                : item.data.includes('<Objects xsi:type="')
+                  ? item.data.split('<Objects xsi:type="')[1].split('">')[0] === objectType
+                  : false
         )
         .map((item) => item.data);
     return myCallout;

package/tsconfig.json

@@ -1,7 +1,12 @@
 {
     // Change this to match your project
-    "include": ["lib/**/*"],
+    "include": ["lib/**/*.js", "types/**/*.js", "test/**/*.js"],
     "compilerOptions": {
+        "module": "nodenext",
+        "moduleResolution": "nodenext",
+        "checkJs": true,
+        "skipLibCheck": true,
+        "target": "es2022",
         // Tells TypeScript to read JS files, as
         // normally they are ignored as source files
         "allowJs": true,

package/{jsconfig.json → tsconfig.npmScripts.json}

@@ -2,7 +2,7 @@
     "include": ["lib/**/*.js", "types/**/*.js", "test/**/*.js"],
     "exclude": ["node_modules"],
     "compilerOptions": {
-        "module": "NodeNext",
+        "module": "nodenext",
         "moduleResolution": "nodenext",
         "target": "es2022",
         "checkJs": true,

package/tsconfig.precommit.json

@@ -0,0 +1,26 @@
+{
+    // Change this to match your project
+    "include": ["lib/**/*.js"],
+    "compilerOptions": {
+        "module": "nodenext",
+        "moduleResolution": "nodenext",
+        "target": "es2022",
+        "checkJs": true,
+        "skipLibCheck": true,
+        // 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

@@ -156,7 +156,7 @@
  * @property {number} [Client.ID] EID e.g:7281698
  * @property {number} [Client.ModifiedBy] AccountUserID of user who last modified this user
  * @property {'User'|'Installed Package'} c__type -
- * @property {boolean|string} [IsLocked] (API only)
+ * @property {boolean} [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
@@ -175,11 +175,17 @@
  * @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} UserDocumentDocumentHelper
+ * @property {string} ActiveFlagDocs docs: user.ActiveFlag === true ? '✓' : '-'
+ * @property {string} IsAPIUserDocs docs: user.IsAPIUser === true ? '✓' : '-'
+ * @property {string} MustChangePasswordDocs docs: user.MustChangePassword === true ? '✓' : '-'
+ * @property {string} DefaultBusinessUnitDocs docs: default MID; BUName after we resolved it
+ * @property {string} RolesDocs docs: list of roles as concatenated string
+ * @property {string} AssociatedBusDocs docs: list of associated BUs as concatenated string
+ * @property {string | number} ModifiedBy docs: user name who last modified this user
+ * @property {string} TimeZoneName docs: name of timezone
+ * @property {string} IsLockedDocs docs: if the user cannot login
+ * @typedef {UserDocument & UserDocumentDocumentHelper} UserDocumentDocument
  */
 /**
  * @typedef {object} AccountUserConfiguration
@@ -326,16 +332,9 @@
  * @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
  */
 
 /**