Merge pull request #1428 from Accenture/develop

release 7.1.0

.github/ISSUE_TEMPLATE/bug.yml

@@ -39,6 +39,7 @@ body:
           label: Version
           description: What version of our software are you running? (mcdev --version)
           options:
+              - 7.1.0
               - 7.0.4
               - 7.0.3
               - 7.0.2

.husky/post-checkout

@@ -21,7 +21,7 @@ NEWHEAD=$1
 OLDHEAD=$2
 # extract all paths to package-lock.json files
 PACKAGE_LOCK_REGEX="(^package-lock\.json)"
-PACKAGES=$(git diff --name-only $NEWHEAD $OLDHEAD | grep -E $PACKAGE_LOCK_REGEX || true)
+PACKAGES=$(git diff --name-only $OLDHEAD $NEWHEAD | grep -E $PACKAGE_LOCK_REGEX || true)
 
 if [[ ${PACKAGES[@]} ]]; then
   for package in $PACKAGES; do

.husky/post-merge

@@ -1,8 +1,14 @@
+# ### run npm install ###
 echo "[POST-MERGE] 📦 Checking for changes to dependencies"
-
+# define how to split strings into array elements
 IFS=$'\n'
 # extract all paths to package-lock.json files
 PACKAGE_LOCK_REGEX="(^package-lock\.json)"
+echo "[POST-MERGE] running git diff --name-only HEAD^1 HEAD"
+echo "[POST-MERGE] 0 $0"
+echo "[POST-MERGE] 1 $1"
+echo "[POST-MERGE] 2 $2"
+echo "[POST-MERGE] 3 $3"
 PACKAGES=$(git diff --name-only HEAD^1 HEAD | grep -E $PACKAGE_LOCK_REGEX || true)
 
 if [[ ${PACKAGES[@]} ]]; then

.husky/pre-commit

@@ -1,6 +1,8 @@
 # run lint-staged hooks
+echo "[PRE-COMMIT] Run lint-staged"
 npx --no lint-staged
 
 # update typescript type declarations
+echo "[PRE-COMMIT] Run typescript validation and create/update d.ts files"
 npx tsc -p tsconfig.precommit.json
 git add @types

@types/lib/Deployer.d.ts

@@ -13,6 +13,7 @@ export type SoapRequestParams = import("../types/mcdev.d.js").SoapRequestParams;
 export type TemplateMap = import("../types/mcdev.d.js").TemplateMap;
 export type MultiMetadataTypeMap = import("../types/mcdev.d.js").MultiMetadataTypeMap;
 export type TypeKeyCombo = import("../types/mcdev.d.js").TypeKeyCombo;
+export type ListMap = import("../types/mcdev.d.js").ListMap;
 /**
  * @typedef {import('../types/mcdev.d.js').BuObject} BuObject
  * @typedef {import('../types/mcdev.d.js').CodeExtract} CodeExtract
@@ -28,6 +29,8 @@ export type TypeKeyCombo = import("../types/mcdev.d.js").TypeKeyCombo;
  * @typedef {import('../types/mcdev.d.js').TemplateMap} TemplateMap
  * @typedef {import('../types/mcdev.d.js').MultiMetadataTypeMap} MultiMetadataTypeMap
  * @typedef {import('../types/mcdev.d.js').TypeKeyCombo} TypeKeyCombo
+ *
+ * @typedef {import('../types/mcdev.d.js').ListMap} ListMap
  */
 /**
  * Reads metadata from local directory and deploys it to specified target business unit.

@types/lib/index.d.ts

@@ -197,6 +197,14 @@ declare class Mcdev {
      * @returns {Promise.<void>} -
      */
     static refresh(businessUnit: string, type: string, keyArr?: string[]): Promise<void>;
+    /**
+     * method for contributors to get details on SOAP objects
+     *
+     * @param {string} type references credentials from properties.json
+     * @param {string} [businessUnit] defaults to first credential's ParentBU
+     * @returns {Promise.<void>} -
+     */
+    static describeSoap(type: string, businessUnit?: string): Promise<void>;
     /**
      * Converts metadata to legacy format. Output is saved in 'converted' directory
      *
@@ -214,6 +222,19 @@ declare class Mcdev {
      * @returns {Promise.<MultiMetadataTypeList>} -
      */
     static retrieveAsTemplate(businessUnit: string, selectedType: string, name: string[], market: string): Promise<MultiMetadataTypeList>;
+    /**
+     * @param {string} businessUnit references credentials from properties.json
+     * @param {TypeKeyCombo} selectedTypes limit retrieval to given metadata type
+     * @returns {Promise.<TypeKeyCombo>} selected types including dependencies
+     */
+    static addDependentCbReferences(businessUnit: string, selectedTypes: TypeKeyCombo): Promise<TypeKeyCombo>;
+    /**
+     *
+     * @param {string} businessUnit references credentials from properties.json
+     * @param {TypeKeyCombo} selectedTypes limit retrieval to given metadata type
+     * @returns {Promise.<TypeKeyCombo>} dependencies
+     */
+    static addDependencies(businessUnit: string, selectedTypes: TypeKeyCombo): Promise<TypeKeyCombo>;
     /**
      * Build a template based on a list of metadata files in the retrieve folder.
      *
@@ -236,6 +257,15 @@ declare class Mcdev {
      * @returns {Promise.<MultiMetadataTypeList>} -
      */
     static buildTemplate(businessUnit: string, selectedTypes: string | TypeKeyCombo, keyArr: string[] | undefined, market: string): Promise<MultiMetadataTypeList>;
+    /**
+     * Build a specific metadata file based on a template.
+     *
+     * @param {string} businessUnit references credentials from properties.json
+     * @param {boolean} [alwaysAsk] by default this code only runs if --retrieve is set; this flag allows to always ask
+     * @param {TypeKeyCombo} [selectedTypes] limit retrieval to given metadata type
+     * @returns {Promise.<void>} -
+     */
+    static _reRetrieve(businessUnit: string, alwaysAsk?: boolean, selectedTypes?: TypeKeyCombo): Promise<void>;
     /**
      * Build a specific metadata file based on a template.
      *
@@ -267,34 +297,53 @@ declare class Mcdev {
      * Schedule an item (shortcut for execute --schedule)
      *
      * @param {string} businessUnit name of BU
-     * @param {string} [selectedType] limit to given metadata types
+     * @param {string[] | TypeKeyCombo} [selectedTypes] limit to given metadata types
+     * @param {string[]} [keys] customerkey of the metadata
+     * @returns {Promise.<Object.<string, Object.<string, string[]>>>} key: business unit name, key2: type, value: list of affected item keys
+     */
+    static schedule(businessUnit: string, selectedTypes?: string[] | TypeKeyCombo, keys?: string[]): Promise<{
+        [x: string]: {
+            [x: string]: string[];
+        };
+    }>;
+    /**
+     * Publish an item
+     *
+     * @param {string} businessUnit name of BU
+     * @param {string[] | TypeKeyCombo} selectedTypes limit to given metadata types
      * @param {string[]} [keys] customerkey of the metadata
-     * @returns {Promise.<Object.<string, string[]>>} key: business unit name, value: list of scheduled item keys
+     * @returns {Promise.<Object.<string, Object.<string, string[]>>>} key: business unit name, key2: type, value: list of affected item keys
      */
-    static schedule(businessUnit: string, selectedType?: string, keys?: string[]): Promise<{
-        [x: string]: string[];
+    static publish(businessUnit: string, selectedTypes: string[] | TypeKeyCombo, keys?: string[]): Promise<{
+        [x: string]: {
+            [x: string]: string[];
+        };
     }>;
     /**
      * Start/execute an item
      *
      * @param {string} businessUnit name of BU
-     * @param {string} [selectedType] limit to given metadata types
+     * @param {string[] | TypeKeyCombo} [selectedTypes] limit to given metadata types
      * @param {string[]} [keys] customerkey of the metadata
-     * @returns {Promise.<Object.<string, string[]>>} key: business unit name, value: list of executed item keys
+     * @returns {Promise.<Object.<string, Object.<string, string[]>>>} key: business unit name, key2: type, value: list of affected item keys
      */
-    static execute(businessUnit: string, selectedType?: string, keys?: string[]): Promise<{
-        [x: string]: string[];
+    static execute(businessUnit: string, selectedTypes?: string[] | TypeKeyCombo, keys?: string[]): Promise<{
+        [x: string]: {
+            [x: string]: string[];
+        };
     }>;
     /**
      * pause an item
      *
      * @param {string} businessUnit name of BU
-     * @param {string} [selectedType] limit to given metadata types
+     * @param {string[] | TypeKeyCombo} [selectedTypes] limit to given metadata types
      * @param {string[]} [keys] customerkey of the metadata
-     * @returns {Promise.<Object.<string, string[]>>} key: business unit name, value: list of paused item keys
+     * @returns {Promise.<Object.<string, Object.<string, string[]>>>} key: business unit name, key2: type, value: list of affected item keys
      */
-    static pause(businessUnit: string, selectedType?: string, keys?: string[]): Promise<{
-        [x: string]: string[];
+    static pause(businessUnit: string, selectedTypes?: string[] | TypeKeyCombo, keys?: string[]): Promise<{
+        [x: string]: {
+            [x: string]: string[];
+        };
     }>;
     /**
      * Updates the key to match the name field
@@ -322,26 +371,28 @@ declare class Mcdev {
     /**
      * run a method across BUs
      *
-     * @param {'execute'|'pause'|'fixKeys'|'replaceCbReference'} methodName what to run
+     * @param {'execute'|'pause'|'publish'|'fixKeys'|'replaceCbReference'} methodName what to run
      * @param {string} businessUnit name of BU
-     * @param {string} [selectedType] limit to given metadata types
+     * @param {string[] | TypeKeyCombo} [selectedTypes] limit to given metadata types
      * @param {string[]} [keys] customerkey of the metadata
-     * @returns {Promise.<Object.<string, string[]>>} key: business unit name, value: list of affected item keys
+     * @returns {Promise.<Object.<string, Object.<string, string[]>>>} key: business unit name, key2: type, value: list of affected item keys
      */
-    static "__#8@#runMethod"(methodName: "execute" | "pause" | "fixKeys" | "replaceCbReference", businessUnit: string, selectedType?: string, keys?: string[]): Promise<{
-        [x: string]: string[];
+    static "__#8@#runMethod"(methodName: "execute" | "pause" | "publish" | "fixKeys" | "replaceCbReference", businessUnit: string, selectedTypes?: string[] | TypeKeyCombo, keys?: string[]): Promise<{
+        [x: string]: {
+            [x: string]: string[];
+        };
     }>;
     /**
      * helper for Mcdev.#runMethod
      *
-     * @param {'execute'|'pause'|'fixKeys'|'replaceCbReference'} methodName what to run
+     * @param {'execute'|'pause'|'publish'|'fixKeys'|'replaceCbReference'} methodName what to run
      * @param {string} cred name of Credential
      * @param {string} bu name of BU
      * @param {string} [type] limit execution to given metadata type
      * @param {string[]} [keyArr] customerkey of the metadata
      * @returns {Promise.<string[]>} list of keys that were affected
      */
-    static "__#8@#runOnBU"(methodName: "execute" | "pause" | "fixKeys" | "replaceCbReference", cred: string, bu: string, type?: string, keyArr?: string[]): Promise<string[]>;
+    static "__#8@#runOnBU"(methodName: "execute" | "pause" | "publish" | "fixKeys" | "replaceCbReference", cred: string, bu: string, type?: string, keyArr?: string[]): Promise<string[]>;
     /**
      * helper for Mcdev.#runOnBU
      *