mcdev 4.1.0 → 4.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -39,6 +39,9 @@ body:
39
39
  label: Version
40
40
  description: What version of our software are you running? (mcdev --version)
41
41
  options:
42
+ - 4.1.2
43
+ - 4.1.1
44
+ - 4.1.0
42
45
  - 4.0.2
43
46
  - 4.0.1
44
47
  - 4.0.0
@@ -4,30 +4,30 @@
4
4
  name: Publish NPM on Release
5
5
 
6
6
  on:
7
- release:
8
- types: [created]
7
+ release:
8
+ types: [published]
9
9
 
10
10
  jobs:
11
- build:
12
- runs-on: ubuntu-latest
13
- steps:
14
- - uses: actions/checkout@v2
15
- - uses: actions/setup-node@v1
16
- with:
17
- node-version: 14
18
- - run: npm ci
19
- - run: npm test
11
+ build:
12
+ runs-on: ubuntu-latest
13
+ steps:
14
+ - uses: actions/checkout@v2
15
+ - uses: actions/setup-node@v1
16
+ with:
17
+ node-version: 16
18
+ - run: npm ci
19
+ - run: npm test
20
20
 
21
- publish-npm:
22
- needs: build
23
- runs-on: ubuntu-latest
24
- steps:
25
- - uses: actions/checkout@v2
26
- - uses: actions/setup-node@v1
27
- with:
28
- node-version: 14
29
- registry-url: https://registry.npmjs.org/
30
- - run: npm ci
31
- - run: npm publish
32
- env:
33
- NODE_AUTH_TOKEN: ${{secrets.npm_token}}
21
+ publish-npm:
22
+ needs: build
23
+ runs-on: ubuntu-latest
24
+ steps:
25
+ - uses: actions/checkout@v2
26
+ - uses: actions/setup-node@v1
27
+ with:
28
+ node-version: 16
29
+ registry-url: https://registry.npmjs.org/
30
+ - run: npm ci
31
+ - run: npm publish
32
+ env:
33
+ NODE_AUTH_TOKEN: ${{secrets.npm_token}}
@@ -31,7 +31,7 @@
31
31
  "editor.defaultFormatter": "esbenp.prettier-vscode"
32
32
  },
33
33
  "[markdown]": {
34
- "editor.defaultFormatter": "yzhang.markdown-all-in-one"
34
+ "editor.defaultFormatter": "esbenp.prettier-vscode"
35
35
  },
36
36
  "[typescript]": {
37
37
  "editor.defaultFormatter": "esbenp.prettier-vscode"
package/README.md CHANGED
@@ -123,7 +123,7 @@ If you experience issues installing Accenture SFMC DevTools, please check out th
123
123
  1. Install Accenture SFMC DevTools by running `npm install -g mcdev` (prefix with `sudo` on MacOS)
124
124
  - If you get an error, please see the below troubleshooting section.
125
125
 
126
- When completed run `mcdev --version` and it will show you which version you installed (e.g. `4.1.0`).
126
+ When completed run `mcdev --version` and it will show you which version you installed (e.g. `4.1.2`).
127
127
 
128
128
  > **_Side note for proud nerds_:**
129
129
  >
@@ -146,7 +146,7 @@ After the successful installation, you will now need to setup the connection to
146
146
  5. Make sure you grant all available rights.
147
147
  6. Go to the access tab and grant it access to all Business Units that you want to use it for, but ensure that the Parent/Global Business Unit is among these.
148
148
  - _Why?_ Shared Data Extensions, roles, users, Business Unit info and some other metadata is internally stored solely on the parent Business Unit and hence can only be retrieved and updated via that BU.
149
- 7. Note down _EID_ (Parent MID), _Client Id_, _Client Secret_ and _Authentication Base URI_.
149
+ 7. Note down _EID_ (Parent MID), _Client Id_, _Client Secret_ and _Authentication Base URI_.
150
150
  2. In your project folder
151
151
  1. Open a CLI in your project folder (e.g. `C:\repos\MyProject\` on Windows or `~/repos/MyProject/` on Mac)
152
152
  2. Run `mcdev init` to start the interactive setup wizard.
@@ -277,10 +277,10 @@ _Note: Regardless of which tag or branch you install_
277
277
  **Install specific version (using a version tag on npm):**
278
278
 
279
279
  ```bash
280
- npm install -g mcdev@4.1.0
280
+ npm install -g mcdev@4.1.2
281
281
  ```
282
282
 
283
- **Warning**: When you used the above method to install Accenture SFMC DevTools for a specific version or tag, trying to [update Accenture SFMC DevTools](#updating-mcdev) might not download the most recently published official version but instead stay on the version or branch you previously selected (in the above examples: develop, 4.1.0)!
283
+ **Warning**: When you used the above method to install Accenture SFMC DevTools for a specific version or tag, trying to [update Accenture SFMC DevTools](#updating-mcdev) might not download the most recently published official version but instead stay on the version or branch you previously selected (in the above examples: develop, 4.1.2)!
284
284
 
285
285
  > **Note**: The version is currently _not_ updated on the developer branch until a new release is published. Hence, you will not see a change if you run `mcdev --version`.
286
286
 
@@ -407,7 +407,7 @@ The following metadata types are currently supported:
407
407
  | List | `list` | Yes | in backlog | - | Yes | Old way of storing data. Still used for central Email Subscriber DB. |
408
408
  | Mobile Connect Code | `mobileCode` | Yes | No | No | - | Mobile Connect Shore or Long Codes used for sending. First 50 per BU are retrieved |
409
409
  | Mobile Connect Keyword | `mobileKeyword` | Yes | Yes | Yes | - | Mobile Connect keywords configured within the Business UNit. First 50 per BU are retrieved |
410
- | Role | `role` | Yes | Yes | yes (`bt`) | Yes | User Roles define groups that are used to grant users access to SFMC systems. |
410
+ | Role | `role` | Yes | Yes | yes (`bt`) | Yes | User Roles define groups that are used to grant users access to SFMC systems. |
411
411
  | Triggered Send | `triggeredSendDefinition` | Yes | Yes | - | Yes | **DEPRECATED**: Sends emails via API or DataExtension Event. |
412
412
  | User | `accountUser` | Yes | in backlog | - | - | Users and Installed Packages including their assigned Roles, BUs and personal permissions |
413
413
 
@@ -478,7 +478,6 @@ Example url: `https://mcg123abcysykllg-0321cbs8bbt64.auth.marketingcloudapis.com
478
478
  > ```bash
479
479
  > mcdev init --y.credentialsName "yourCustomCredentialName" --y.client_id "yourClientIdHere" --y.client_secret "yourClientSecretHere" --y.auth_url "https://yourTenantSubdomainHere.auth.marketingcloudapis.com/" --y.gitRemoteUrl "https://my.git.server.com/myrepo.git" --y.account_id 00000000
480
480
  > ```
481
- >
482
481
 
483
482
  #### 6.1.2. upgrade
484
483
 
@@ -753,13 +752,13 @@ Deletes the given metadata from your server. This needs to be run with care as a
753
752
 
754
753
  Currently supported types:
755
754
 
756
- | Name | CLI Argument |
757
- | -------------- | --------------- |
758
- | Data Extension | `dataExtension` |
759
- | Data Extension Field | `dataExtensionField` |
760
- | Email Send Definition | `Email Send Definition` |
761
- | List | `list` |
762
- | Triggered Send | `triggeredSendDefinition` |
755
+ | Name | CLI Argument |
756
+ | --------------------- | ------------------------- |
757
+ | Data Extension | `dataExtension` |
758
+ | Data Extension Field | `dataExtensionField` |
759
+ | Email Send Definition | `Email Send Definition` |
760
+ | List | `list` |
761
+ | Triggered Send | `triggeredSendDefinition` |
763
762
 
764
763
  _Example:_
765
764
 
@@ -1103,13 +1102,13 @@ The central config in `.mcdevrc.json` holds multiple adjustable settings:
1103
1102
  | options.deployment.sourceTargetMapping | `{"deployment-source": "deployment-target"}` | Configuration of 1 or many source-target marketList combos for `mcdev createDeltaPkg` |
1104
1103
  | options.deployment.targetBranchBuMapping | `{"release/*": "...","master": ["..."]}` | Can be used by CI/CD pipelines to know what BUs shall be deployed to upon a merge into one of the specified branches |
1105
1104
  | options.documentType | 'md' | Defines the format for documentation ('md', 'html', 'both') |
1106
- | options.documentStandardRoles | false | Optionally skip standard role documentation by setting to false |
1105
+ | options.documentStandardRoles | false | Optionally skip standard role documentation by setting to false |
1107
1106
  | options.exclude.`type`.`field` | [] | Allows you to filter out metadata on retrieve based on their field values, e.g. CustomerKey (previously `options.filter`) |
1108
1107
  | options.include.`type`.`field` | [] | Allows you to filter out metadata on retrieve based on their field values, e.g. CustomerKey |
1109
1108
  | options.serverTimeOffset | -6 | Used to work around quirks in how SFMC handles timezones; For stack4: set to -7 (US Mountain time); others: -6 (US Central) |
1110
1109
  | directories.businessUnits | 'businessUnits/' | Directory to save BU base details in |
1111
1110
  | directories.deploy | 'deploy/' | Where `deploy` searches for files to deploy |
1112
- | directories.docs | 'docs/' | Directory for `document` output |
1111
+ | directories.docs | 'docs/' | Directory for `document` output |
1113
1112
  | directories.retrieve | 'retrieve/' | Where `retrieve` stores downloaded files |
1114
1113
  | directories.template | 'template/' | Where `rt` stores downloaded templates & `bd` retrieves them from |
1115
1114
  | directories.templateBuilds | ['retrieve/','deploy/'] | Where `bd` saves final deployment versions in. This can hold multiple directories, e.g. ['retrieve/','deploy/'] |
@@ -1126,8 +1125,8 @@ The central config in `.mcdevrc.json` holds multiple adjustable settings:
1126
1125
 
1127
1126
  The way retention policy is saved is a bit misleading and hence we wanted to provide a bit of guidance if you ever need to do a deep dive here.
1128
1127
 
1129
- | Field | Description | Values |
1130
- | ------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
1128
+ | Field | Description | Values |
1129
+ | ------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | ------------ |
1131
1130
  | **DataRetentionPeriod** | this field should print the value of the unit of measure but it unfortunately is off by one (e.g. showing "weeks" instead of "months"). Also, it seems to have no impact on what's stored.<br> We therefore excluded it from retrieve/deploy | - |
1132
1131
  | **DataRetentionPeriodUnitOfMeasure** | represents drop down for "period after" selection | 6: years<br>5: months<br>4: weeks<br>2: days |
1133
1132
  | **DataRetentionPeriodLength** | represents number field for "period after" selection | min: 1<br>max: 999 |
@@ -1494,7 +1493,7 @@ Assuming you cloned Accenture SFMC DevTools into `C:\repos\sfmc-devtools\` (or `
1494
1493
 
1495
1494
  This should tell npm to create a symlink to your cloned local directoty, allowing you to see updates you make in your mcdev repo instantly.
1496
1495
 
1497
- To test your new **global** developer setup, run `mcdev --version` in CLI which should return the current version (e.g. `4.1.0`). Then, go into your mcdev repo and update the version with the suffix `-dev`, e.g. to `4.1.0-dev` and then run `mcdev --version` again to verify that your change propagates instantly.
1496
+ To test your new **global** developer setup, run `mcdev --version` in CLI which should return the current version (e.g. `4.1.2`). Then, go into your mcdev repo and update the version with the suffix `-dev`, e.g. to `4.1.2-dev` and then run `mcdev --version` again to verify that your change propagates instantly.
1498
1497
 
1499
1498
  > **Not recommended:** Alternatively, you can install it locally only by opening a terminal in your project directory and executing `npm install --save-dev "C:\repos\sfmc-devtools"`
1500
1499
  > To run the local version you need to prepend "npx" before your commands, e.g. `npx mcdev --version`
@@ -1532,7 +1531,7 @@ The following explains how you _could_ install it locally for certain edge cases
1532
1531
  4. Afterwards, install Accenture SFMC DevTools by running `npm install --save-dev mcdev`
1533
1532
  - If you get an error, please see the below troubleshooting section.
1534
1533
 
1535
- When completed run `mcdev --version` and it will show you which version you installed (e.g. `4.1.0`).
1534
+ When completed run `mcdev --version` and it will show you which version you installed (e.g. `4.1.2`).
1536
1535
 
1537
1536
  ### 9.3. NPM Scripts
1538
1537
 
@@ -1,4 +1,7 @@
1
1
  {
2
+ "workbench.editorAssociations": {
3
+ "*.md": "vscode.markdown.preview.editor"
4
+ },
2
5
  "explorer.fileNesting.enabled": true,
3
6
  "explorer.fileNesting.expand": false,
4
7
  "explorer.fileNesting.patterns": {
@@ -1,4 +1,8 @@
1
1
  [
2
+ {
3
+ "version": "4.1.1",
4
+ "files": [".vscode/settings.json"]
5
+ },
2
6
  {
3
7
  "version": "4.0.0",
4
8
  "files": [".vscode/settings.json", ".vscode/extensions.json", ".prettierrc"]
@@ -346,10 +346,10 @@ Source and target business units are also compared before the deployment to appl
346
346
  * [new Deployer(properties, buObject)](#new_Deployer_new)
347
347
  * _instance_
348
348
  * [.metadata](#Deployer+metadata) : <code>TYPE.MultiMetadataTypeMap</code>
349
- * [._deploy([typeArr], [keyArr], [fromRetrieve])](#Deployer+_deploy) ⇒ <code>Promise</code>
349
+ * [._deploy([typeArr], [keyArr], [fromRetrieve])](#Deployer+_deploy) ⇒ <code>Promise.&lt;TYPE.MultiMetadataTypeMap&gt;</code>
350
350
  * _static_
351
- * [.deploy(businessUnit, [selectedTypesArr], [keyArr], [fromRetrieve])](#Deployer.deploy) ⇒ <code>Promise.&lt;void&gt;</code>
352
- * [._deployBU(cred, bu, properties, [typeArr], [keyArr], [fromRetrieve])](#Deployer._deployBU) ⇒ <code>Promise</code>
351
+ * [.deploy(businessUnit, [selectedTypesArr], [keyArr], [fromRetrieve])](#Deployer.deploy) ⇒ <code>Promise.&lt;Object.&lt;string, TYPE.MultiMetadataTypeMap&gt;&gt;</code>
352
+ * [._deployBU(cred, bu, properties, [typeArr], [keyArr], [fromRetrieve])](#Deployer._deployBU) ⇒ <code>Promise.&lt;TYPE.MultiMetadataTypeMap&gt;</code>
353
353
  * [.readBUMetadata(deployDir, [typeArr], [listBadKeys])](#Deployer.readBUMetadata) ⇒ <code>TYPE.MultiMetadataTypeMap</code>
354
354
  * [.createFolderDefinitions(deployDir, metadata, metadataTypeArr)](#Deployer.createFolderDefinitions) ⇒ <code>void</code>
355
355
 
@@ -370,11 +370,11 @@ Creates a Deployer, uses v2 auth if v2AuthOptions are passed.
370
370
  **Kind**: instance property of [<code>Deployer</code>](#Deployer)
371
371
  <a name="Deployer+_deploy"></a>
372
372
 
373
- ### deployer.\_deploy([typeArr], [keyArr], [fromRetrieve]) ⇒ <code>Promise</code>
373
+ ### deployer.\_deploy([typeArr], [keyArr], [fromRetrieve]) ⇒ <code>Promise.&lt;TYPE.MultiMetadataTypeMap&gt;</code>
374
374
  Deploy all metadata that is located in the deployDir
375
375
 
376
376
  **Kind**: instance method of [<code>Deployer</code>](#Deployer)
377
- **Returns**: <code>Promise</code> - Promise
377
+ **Returns**: <code>Promise.&lt;TYPE.MultiMetadataTypeMap&gt;</code> - Promise of all deployed metadata
378
378
 
379
379
  | Param | Type | Description |
380
380
  | --- | --- | --- |
@@ -384,11 +384,11 @@ Deploy all metadata that is located in the deployDir
384
384
 
385
385
  <a name="Deployer.deploy"></a>
386
386
 
387
- ### Deployer.deploy(businessUnit, [selectedTypesArr], [keyArr], [fromRetrieve]) ⇒ <code>Promise.&lt;void&gt;</code>
387
+ ### Deployer.deploy(businessUnit, [selectedTypesArr], [keyArr], [fromRetrieve]) ⇒ <code>Promise.&lt;Object.&lt;string, TYPE.MultiMetadataTypeMap&gt;&gt;</code>
388
388
  Deploys all metadata located in the 'deploy' directory to the specified business unit
389
389
 
390
390
  **Kind**: static method of [<code>Deployer</code>](#Deployer)
391
- **Returns**: <code>Promise.&lt;void&gt;</code> - -
391
+ **Returns**: <code>Promise.&lt;Object.&lt;string, TYPE.MultiMetadataTypeMap&gt;&gt;</code> - deployed metadata per BU (first key: bu name, second key: metadata type)
392
392
 
393
393
  | Param | Type | Description |
394
394
  | --- | --- | --- |
@@ -399,11 +399,11 @@ Deploys all metadata located in the 'deploy' directory to the specified business
399
399
 
400
400
  <a name="Deployer._deployBU"></a>
401
401
 
402
- ### Deployer.\_deployBU(cred, bu, properties, [typeArr], [keyArr], [fromRetrieve]) ⇒ <code>Promise</code>
402
+ ### Deployer.\_deployBU(cred, bu, properties, [typeArr], [keyArr], [fromRetrieve]) ⇒ <code>Promise.&lt;TYPE.MultiMetadataTypeMap&gt;</code>
403
403
  helper for deploy()
404
404
 
405
405
  **Kind**: static method of [<code>Deployer</code>](#Deployer)
406
- **Returns**: <code>Promise</code> - ensure that BUs are worked on sequentially
406
+ **Returns**: <code>Promise.&lt;TYPE.MultiMetadataTypeMap&gt;</code> - ensure that BUs are worked on sequentially
407
407
 
408
408
  | Param | Type | Description |
409
409
  | --- | --- | --- |
@@ -456,7 +456,7 @@ main class
456
456
  * [.explainTypes()](#Mcdev.explainTypes) ⇒ <code>void</code>
457
457
  * [.upgrade([skipInteraction])](#Mcdev.upgrade) ⇒ <code>Promise.&lt;boolean&gt;</code>
458
458
  * [.retrieve(businessUnit, [selectedTypesArr], [keys], [changelogOnly])](#Mcdev.retrieve) ⇒ <code>Promise.&lt;object&gt;</code>
459
- * [.deploy(businessUnit, [selectedTypesArr], [keyArr], [fromRetrieve])](#Mcdev.deploy) ⇒ <code>Promise.&lt;void&gt;</code>
459
+ * [.deploy(businessUnit, [selectedTypesArr], [keyArr], [fromRetrieve])](#Mcdev.deploy) ⇒ <code>Promise.&lt;Object.&lt;string, TYPE.MultiMetadataTypeMap&gt;&gt;</code>
460
460
  * [.initProject([credentialsName], [skipInteraction])](#Mcdev.initProject) ⇒ <code>Promise.&lt;void&gt;</code>
461
461
  * [.findBUs(credentialsName)](#Mcdev.findBUs) ⇒ <code>Promise.&lt;void&gt;</code>
462
462
  * [.document(businessUnit, type)](#Mcdev.document) ⇒ <code>Promise.&lt;void&gt;</code>
@@ -545,11 +545,11 @@ Retrieve all metadata from the specified business unit into the local file syste
545
545
 
546
546
  <a name="Mcdev.deploy"></a>
547
547
 
548
- ### Mcdev.deploy(businessUnit, [selectedTypesArr], [keyArr], [fromRetrieve]) ⇒ <code>Promise.&lt;void&gt;</code>
548
+ ### Mcdev.deploy(businessUnit, [selectedTypesArr], [keyArr], [fromRetrieve]) ⇒ <code>Promise.&lt;Object.&lt;string, TYPE.MultiMetadataTypeMap&gt;&gt;</code>
549
549
  Deploys all metadata located in the 'deploy' directory to the specified business unit
550
550
 
551
551
  **Kind**: static method of [<code>Mcdev</code>](#Mcdev)
552
- **Returns**: <code>Promise.&lt;void&gt;</code> - -
552
+ **Returns**: <code>Promise.&lt;Object.&lt;string, TYPE.MultiMetadataTypeMap&gt;&gt;</code> - deployed metadata per BU (first key: bu name, second key: metadata type)
553
553
 
554
554
  | Param | Type | Default | Description |
555
555
  | --- | --- | --- | --- |
@@ -2943,7 +2943,7 @@ Provides default functionality that can be overwritten by child metadata type cl
2943
2943
  * [.buObject](#MetadataType.buObject) : <code>TYPE.BuObject</code>
2944
2944
  * [.getJsonFromFS(dir, [listBadKeys])](#MetadataType.getJsonFromFS) ⇒ <code>TYPE.MetadataTypeMap</code>
2945
2945
  * [.getFieldNamesToRetrieve([additionalFields])](#MetadataType.getFieldNamesToRetrieve) ⇒ <code>Array.&lt;string&gt;</code>
2946
- * [.deploy(metadata, deployDir, retrieveDir, buObject)](#MetadataType.deploy) ⇒ <code>Promise.&lt;object&gt;</code>
2946
+ * [.deploy(metadata, deployDir, retrieveDir, buObject)](#MetadataType.deploy) ⇒ <code>Promise.&lt;TYPE.MetadataTypeMap&gt;</code>
2947
2947
  * [.postDeployTasks(metadata, originalMetadata)](#MetadataType.postDeployTasks) ⇒ <code>void</code>
2948
2948
  * [.postRetrieveTasks(metadata, targetDir, [isTemplating])](#MetadataType.postRetrieveTasks) ⇒ <code>TYPE.MetadataTypeItem</code>
2949
2949
  * [.retrieve(retrieveDir, [additionalFields], buObject, [subType], [key])](#MetadataType.retrieve) ⇒ <code>Promise.&lt;TYPE.MetadataTypeMapObj&gt;</code>
@@ -3030,11 +3030,11 @@ Returns fieldnames of Metadata Type. 'this.definition.fields' variable only set
3030
3030
 
3031
3031
  <a name="MetadataType.deploy"></a>
3032
3032
 
3033
- ### MetadataType.deploy(metadata, deployDir, retrieveDir, buObject) ⇒ <code>Promise.&lt;object&gt;</code>
3033
+ ### MetadataType.deploy(metadata, deployDir, retrieveDir, buObject) ⇒ <code>Promise.&lt;TYPE.MetadataTypeMap&gt;</code>
3034
3034
  Deploys metadata
3035
3035
 
3036
3036
  **Kind**: static method of [<code>MetadataType</code>](#MetadataType)
3037
- **Returns**: <code>Promise.&lt;object&gt;</code> - Promise of keyField => metadata map
3037
+ **Returns**: <code>Promise.&lt;TYPE.MetadataTypeMap&gt;</code> - Promise of keyField => metadata map
3038
3038
 
3039
3039
  | Param | Type | Description |
3040
3040
  | --- | --- | --- |
package/lib/Deployer.js CHANGED
@@ -48,10 +48,11 @@ class Deployer {
48
48
  * @param {TYPE.SupportedMetadataTypes[]} [selectedTypesArr] limit deployment to given metadata type
49
49
  * @param {string[]} [keyArr] limit deployment to given metadata keys
50
50
  * @param {boolean} [fromRetrieve] optionally deploy whats defined via selectedTypesArr + keyArr directly from retrieve folder instead of from deploy folder
51
- * @returns {Promise.<void>} -
51
+ * @returns {Promise.<Object.<string,TYPE.MultiMetadataTypeMap>>} deployed metadata per BU (first key: bu name, second key: metadata type)
52
52
  */
53
53
  static async deploy(businessUnit, selectedTypesArr, keyArr, fromRetrieve) {
54
54
  Util.logger.info('mcdev:: Deploy');
55
+ const buMultiMetadataTypeMap = {};
55
56
  const properties = await config.getProperties();
56
57
  if (!(await config.checkProperties(properties))) {
57
58
  return null;
@@ -87,9 +88,18 @@ class Deployer {
87
88
  2,
88
89
  false
89
90
  );
91
+
90
92
  for (const buPath of deployFolders.filter((r) => r.includes(path.sep))) {
91
93
  const [cred, bu] = buPath.split(path.sep);
92
- await this._deployBU(cred, bu, properties, selectedTypesArr, keyArr, fromRetrieve);
94
+ const multiMetadataTypeMap = await this._deployBU(
95
+ cred,
96
+ bu,
97
+ properties,
98
+ selectedTypesArr,
99
+ keyArr,
100
+ fromRetrieve
101
+ );
102
+ buMultiMetadataTypeMap[cred + '/' + bu] = multiMetadataTypeMap;
93
103
  counter_credBu++;
94
104
  Util.logger.info('');
95
105
  Util.restartLogger();
@@ -129,7 +139,7 @@ class Deployer {
129
139
  false
130
140
  );
131
141
  for (const buPath of deployFolders) {
132
- await this._deployBU(
142
+ const multiMetadataTypeMap = await this._deployBU(
133
143
  cred,
134
144
  buPath,
135
145
  properties,
@@ -137,6 +147,7 @@ class Deployer {
137
147
  keyArr,
138
148
  fromRetrieve
139
149
  );
150
+ buMultiMetadataTypeMap[cred + '/' + buPath] = multiMetadataTypeMap;
140
151
  counter_credBu++;
141
152
  Util.logger.info('');
142
153
  Util.restartLogger();
@@ -144,13 +155,22 @@ class Deployer {
144
155
  Util.logger.info(`\n :: ${counter_credBu} BUs for ${cred}\n`);
145
156
  } else {
146
157
  // either bad credential or specific BU or no BU given
147
- await this._deployBU(cred, bu, properties, selectedTypesArr, keyArr, fromRetrieve);
158
+ const multiMetadataTypeMap = await this._deployBU(
159
+ cred,
160
+ bu,
161
+ properties,
162
+ selectedTypesArr,
163
+ keyArr,
164
+ fromRetrieve
165
+ );
148
166
  counter_credBu++;
167
+ buMultiMetadataTypeMap[cred + '/' + bu] = multiMetadataTypeMap;
149
168
  }
150
169
  }
151
170
  if (counter_credBu !== 0) {
152
171
  Util.logger.info(`\n :: Deployed ${counter_credBu} BUs\n`);
153
172
  }
173
+ return buMultiMetadataTypeMap;
154
174
  }
155
175
  /**
156
176
  * helper for deploy()
@@ -161,22 +181,25 @@ class Deployer {
161
181
  * @param {TYPE.SupportedMetadataTypes[]} [typeArr] limit deployment to given metadata type
162
182
  * @param {string[]} [keyArr] limit deployment to given metadata keys
163
183
  * @param {boolean} [fromRetrieve] optionally deploy whats defined via selectedTypesArr + keyArr directly from retrieve folder instead of from deploy folder
164
- * @returns {Promise} ensure that BUs are worked on sequentially
184
+ * @returns {Promise.<TYPE.MultiMetadataTypeMap>} ensure that BUs are worked on sequentially
165
185
  */
166
186
  static async _deployBU(cred, bu, properties, typeArr, keyArr, fromRetrieve) {
167
187
  const buPath = `${cred}/${bu}`;
168
188
  Util.logger.info(`::Deploying ${buPath}`);
169
189
  const buObject = await Cli.getCredentialObject(properties, buPath, null, true);
190
+ let multiMetadataTypeMap;
191
+
170
192
  if (buObject !== null) {
171
193
  cache.initCache(buObject);
172
194
  const deployer = new Deployer(properties, buObject);
173
195
  try {
174
196
  // await is required or the calls end up conflicting
175
- await deployer._deploy(typeArr, keyArr, fromRetrieve);
197
+ multiMetadataTypeMap = await deployer._deploy(typeArr, keyArr, fromRetrieve);
176
198
  } catch (ex) {
177
199
  Util.logger.errorStack(ex, 'mcdev.deploy failed');
178
200
  }
179
201
  }
202
+ return multiMetadataTypeMap;
180
203
  }
181
204
 
182
205
  /**
@@ -185,7 +208,7 @@ class Deployer {
185
208
  * @param {TYPE.SupportedMetadataTypes[]} [typeArr] limit deployment to given metadata type (can include subtype)
186
209
  * @param {string[]} [keyArr] limit deployment to given metadata keys
187
210
  * @param {boolean} [fromRetrieve] if true, no folders will be updated/created
188
- * @returns {Promise} Promise
211
+ * @returns {Promise.<TYPE.MultiMetadataTypeMap>} Promise of all deployed metadata
189
212
  */
190
213
  async _deploy(typeArr, keyArr, fromRetrieve) {
191
214
  if (await File.pathExists(this.deployDir)) {
@@ -232,6 +255,8 @@ class Deployer {
232
255
  const result = await MetadataTypeInfo[type].retrieveForCache(this.buObject, subType);
233
256
  cache.setMetadata(type, result.metadata);
234
257
  }
258
+ /** @type {TYPE.MultiMetadataTypeMap} */
259
+ const multiMetadataTypeMap = {};
235
260
  // deploy metadata files, extending cache once deploys
236
261
  for (const metadataType of deployOrder) {
237
262
  // TODO rewrite to allow deploying only a specific sub-type
@@ -246,9 +271,11 @@ class Deployer {
246
271
  this.retrieveDir,
247
272
  this.buObject
248
273
  );
274
+ multiMetadataTypeMap[type] = result;
249
275
  cache.mergeMetadata(type, result);
250
276
  }
251
277
  }
278
+ return multiMetadataTypeMap;
252
279
  }
253
280
 
254
281
  /**
package/lib/index.js CHANGED
@@ -285,7 +285,7 @@ class Mcdev {
285
285
  * @param {TYPE.SupportedMetadataTypes[]} [selectedTypesArr] limit deployment to given metadata type
286
286
  * @param {string[]} [keyArr] limit deployment to given metadata keys
287
287
  * @param {boolean} [fromRetrieve] optionally deploy whats defined via selectedTypesArr + keyArr directly from retrieve folder instead of from deploy folder
288
- * @returns {Promise.<void>} -
288
+ * @returns {Promise.<Object.<string,TYPE.MultiMetadataTypeMap>>} deployed metadata per BU (first key: bu name, second key: metadata type)
289
289
  */
290
290
  static async deploy(businessUnit, selectedTypesArr, keyArr, fromRetrieve = false) {
291
291
  return Deployer.deploy(businessUnit, selectedTypesArr, keyArr, fromRetrieve);
@@ -527,7 +527,7 @@ class Asset extends MetadataType {
527
527
  if (
528
528
  buObject.mid &&
529
529
  metadata.memberId !== buObject.mid &&
530
- !metadata[this.definition.keyField].startsWith(buObject.mid)
530
+ !metadata[this.definition.keyField].endsWith(buObject.mid)
531
531
  ) {
532
532
  // #3 make sure customer key is unique by suffixing it with target MID (unless we are deploying to the same MID)
533
533
  // check if this suffixed with the source MID
@@ -134,23 +134,37 @@ class ImportFile extends MetadataType {
134
134
  delete metadata.r__ftpLocation_name;
135
135
 
136
136
  if (metadata.c__destinationType === 'DataExtension') {
137
- metadata.destinationObjectId = cache.searchForField(
138
- 'dataExtension',
139
- metadata.r__dataExtension_CustomerKey,
140
- 'CustomerKey',
141
- 'ObjectID'
142
- );
143
- delete metadata.r__dataExtension_CustomerKey;
137
+ if (metadata.r__dataExtension_CustomerKey) {
138
+ metadata.destinationObjectId = cache.searchForField(
139
+ 'dataExtension',
140
+ metadata.r__dataExtension_CustomerKey,
141
+ 'CustomerKey',
142
+ 'ObjectID'
143
+ );
144
+ delete metadata.r__dataExtension_CustomerKey;
145
+ } else {
146
+ throw new Error('Import Destination DataExtension not defined');
147
+ }
144
148
  } else if (metadata.c__destinationType === 'List') {
145
- metadata.destinationObjectId = cache.getListObjectId(
146
- metadata.r__list_PathName,
147
- 'ObjectID'
149
+ if (metadata.r__list_PathName) {
150
+ metadata.destinationObjectId = cache.getListObjectId(
151
+ metadata.r__list_PathName,
152
+ 'ObjectID'
153
+ );
154
+ // destinationId is also needed for List types
155
+ metadata.destinationId = cache.getListObjectId(metadata.r__list_PathName, 'ID');
156
+ delete metadata.r__list_PathName;
157
+ } else {
158
+ throw new Error('Import Destination List not defined');
159
+ }
160
+ } else {
161
+ Util.logger.debug(
162
+ ` - importFile ${metadata[this.definition.keyField]}: Import Destination Type ${
163
+ metadata.c__destinationType
164
+ } not fully supported. Deploy might fail.`
148
165
  );
149
- // destinationId is also needed for List types
150
- metadata.destinationId = cache.getListObjectId(metadata.r__list_PathName, 'ID');
151
- delete metadata.r__list_PathName;
152
166
  }
153
- // When the destinationObjectTypeId is 584 is refers to Mobile Connect which is not supported as an Import Type
167
+ // When the destinationObjectTypeId is 584 it refers to Mobile Connect which is not supported as an Import Type
154
168
  metadata.destinationObjectTypeId =
155
169
  this.definition.destinationObjectTypeMapping[metadata.c__destinationType];
156
170
  metadata.subscriberImportTypeId =
@@ -104,7 +104,7 @@ class MetadataType {
104
104
  * @param {string} deployDir directory where deploy metadata are saved
105
105
  * @param {string} retrieveDir directory where metadata after deploy should be saved
106
106
  * @param {TYPE.BuObject} buObject properties for auth
107
- * @returns {Promise.<object>} Promise of keyField => metadata map
107
+ * @returns {Promise.<TYPE.MetadataTypeMap>} Promise of keyField => metadata map
108
108
  */
109
109
  static async deploy(metadata, deployDir, retrieveDir, buObject) {
110
110
  const upsertResults = await this.upsert(metadata, deployDir, buObject);
@@ -260,17 +260,20 @@ class Query extends MetadataType {
260
260
  const targetDirArr = Array.isArray(targetDir) ? targetDir : [targetDir];
261
261
  const nestedFilePaths = [];
262
262
 
263
+ // keep old name if creating templates, otherwise use new name
264
+ const fileName = mode === 'definition' ? metadata[this.definition.keyField] : templateName;
265
+
263
266
  for (const targetDir of targetDirArr) {
264
267
  File.writeToFile(
265
268
  [targetDir, this.definition.type],
266
- templateName + '.' + this.definition.type + '-meta',
269
+ fileName + '.' + this.definition.type + '-meta',
267
270
  'sql',
268
271
  code
269
272
  );
270
273
  nestedFilePaths.push([
271
274
  targetDir,
272
275
  this.definition.type,
273
- templateName + '.' + this.definition.type + '-meta.sql',
276
+ fileName + '.' + this.definition.type + '-meta.sql',
274
277
  ]);
275
278
  }
276
279
  return nestedFilePaths;
@@ -234,17 +234,20 @@ class Script extends MetadataType {
234
234
  const targetDirArr = Array.isArray(targetDir) ? targetDir : [targetDir];
235
235
  const nestedFilePaths = [];
236
236
 
237
+ // keep old name if creating templates, otherwise use new name
238
+ const fileName = mode === 'definition' ? metadata[this.definition.keyField] : templateName;
239
+
237
240
  for (const targetDir of targetDirArr) {
238
241
  File.writeToFile(
239
242
  [targetDir, this.definition.type],
240
- templateName + '.' + this.definition.type + '-meta',
243
+ fileName + '.' + this.definition.type + '-meta',
241
244
  'ssjs',
242
245
  code
243
246
  );
244
247
  nestedFilePaths.push([
245
248
  targetDir,
246
249
  this.definition.type,
247
- templateName + '.' + this.definition.type + '-meta.ssjs',
250
+ fileName + '.' + this.definition.type + '-meta.ssjs',
248
251
  ]);
249
252
  }
250
253
  return nestedFilePaths;
@@ -407,7 +407,7 @@ const DevOps = {
407
407
  );
408
408
  }
409
409
  await Promise.all(bdPromises);
410
- Util.logger.info(`- ✔️ Deploy defintions created`);
410
+ Util.logger.info(`- ✔️ Deploy definitions created`);
411
411
  if (
412
412
  properties.directories.templateBuilds == properties.directories.deploy ||
413
413
  (Array.isArray(properties.directories.templateBuilds) &&
package/lib/util/util.js CHANGED
@@ -428,10 +428,20 @@ const Util = {
428
428
  * @returns {object} initiated logger for console and file
429
429
  */
430
430
  function createNewLoggerTransport() {
431
+ // {
432
+ // error: 0,
433
+ // warn: 1,
434
+ // info: 2,
435
+ // http: 3,
436
+ // verbose: 4,
437
+ // debug: 5,
438
+ // silly: 6
439
+ // }
440
+ const logFileName = new Date().toISOString().split(':').join('.');
431
441
  return {
432
442
  console: new winston.transports.Console({
433
443
  // Write logs to Console
434
- level: 'info',
444
+ level: 'info', // log error, warn, info
435
445
  format: winston.format.combine(
436
446
  winston.format.colorize(),
437
447
  winston.format.timestamp({ format: 'HH:mm:ss' }),
@@ -441,9 +451,18 @@ function createNewLoggerTransport() {
441
451
  }),
442
452
  file: new winston.transports.File({
443
453
  // Write logs to logfile
444
- filename: 'logs/' + new Date().toISOString().split(':').join('.') + '.log',
445
- // filename: 'logs/' + Math.floor(Date.now() / 1000) + '.log',
446
- level: 'debug',
454
+ filename: 'logs/' + logFileName + '.log',
455
+ level: 'debug', // log everything
456
+ format: winston.format.combine(
457
+ winston.format.timestamp({ format: 'HH:mm:ss.SSS' }),
458
+ winston.format.simple(),
459
+ winston.format.printf((info) => `${info.timestamp} ${info.level}: ${info.message}`)
460
+ ),
461
+ }),
462
+ fileError: new winston.transports.File({
463
+ // Write logs to additional error-logfile for better visibility of errors
464
+ filename: 'logs/' + logFileName + '-errors.log',
465
+ level: 'error', // only log errors
447
466
  format: winston.format.combine(
448
467
  winston.format.timestamp({ format: 'HH:mm:ss.SSS' }),
449
468
  winston.format.simple(),
@@ -461,7 +480,11 @@ function startLogger() {
461
480
  Util.loggerTransports = createNewLoggerTransport();
462
481
  const myWinston = winston.createLogger({
463
482
  levels: winston.config.npm.levels,
464
- transports: [Util.loggerTransports.console, Util.loggerTransports.file],
483
+ transports: [
484
+ Util.loggerTransports.console,
485
+ Util.loggerTransports.file,
486
+ Util.loggerTransports.fileError,
487
+ ],
465
488
  });
466
489
  const winstonError = myWinston.error;
467
490
  const winstonExtension = {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "mcdev",
3
- "version": "4.1.0",
3
+ "version": "4.1.2",
4
4
  "description": "Accenture Salesforce Marketing Cloud DevTools",
5
5
  "author": "joern.berkefeld, douglas.midgley, robert.zimmermann, maciej.barnas",
6
6
  "license": "MIT",
@@ -64,10 +64,10 @@
64
64
  "assert": "2.0.0",
65
65
  "axios-mock-adapter": "1.21.2",
66
66
  "chai": "4.3.6",
67
- "eslint": "8.25.0",
67
+ "eslint": "8.26.0",
68
68
  "eslint-config-prettier": "8.5.0",
69
69
  "eslint-config-ssjs": "1.1.11",
70
- "eslint-plugin-jsdoc": "39.3.13",
70
+ "eslint-plugin-jsdoc": "39.3.25",
71
71
  "eslint-plugin-mocha": "10.1.0",
72
72
  "eslint-plugin-prettier": "4.2.1",
73
73
  "eslint-plugin-unicorn": "44.0.2",
@@ -80,6 +80,9 @@
80
80
  "npm-run-all": "4.1.5",
81
81
  "prettier-eslint": "15.0.1"
82
82
  },
83
+ "optionalDependencies": {
84
+ "fsevents": "*"
85
+ },
83
86
  "lint-staged": {
84
87
  "*.{js,jsx,ts,tsx}": [
85
88
  "eslint --fix"
@@ -63,5 +63,5 @@
63
63
  "triggeredSendDefinition"
64
64
  ]
65
65
  },
66
- "version": "4.0.0"
66
+ "version": "4.1.2"
67
67
  }