mcdev 6.0.1 → 7.0.0

package/@types/lib/MetadataTypeInfo.d.ts

@@ -0,0 +1,78 @@
+declare namespace _default {
+    export { asset };
+    export { attributeGroup };
+    export { attributeSet };
+    export { automation };
+    export { campaign };
+    export { contentArea };
+    export { dataExtension };
+    export { dataExtensionField };
+    export { dataExtensionTemplate };
+    export { dataExtract };
+    export { dataExtractType };
+    export { deliveryProfile };
+    export { discovery };
+    export { email };
+    export { emailSend };
+    export { event };
+    export { fileLocation };
+    export { fileTransfer };
+    export { filter };
+    export { folder };
+    export { importFile };
+    export { journey };
+    export { list };
+    export { mobileCode };
+    export { mobileKeyword };
+    export { mobileMessage };
+    export { query };
+    export { role };
+    export { script };
+    export { sendClassification };
+    export { senderProfile };
+    export { transactionalEmail };
+    export { transactionalPush };
+    export { transactionalSMS };
+    export { triggeredSend };
+    export { user };
+    export { verification };
+}
+export default _default;
+import asset from './metadataTypes/Asset.js';
+import attributeGroup from './metadataTypes/AttributeGroup.js';
+import attributeSet from './metadataTypes/AttributeSet.js';
+import automation from './metadataTypes/Automation.js';
+import campaign from './metadataTypes/Campaign.js';
+import contentArea from './metadataTypes/ContentArea.js';
+import dataExtension from './metadataTypes/DataExtension.js';
+import dataExtensionField from './metadataTypes/DataExtensionField.js';
+import dataExtensionTemplate from './metadataTypes/DataExtensionTemplate.js';
+import dataExtract from './metadataTypes/DataExtract.js';
+import dataExtractType from './metadataTypes/DataExtractType.js';
+import deliveryProfile from './metadataTypes/DeliveryProfile.js';
+import discovery from './metadataTypes/Discovery.js';
+import email from './metadataTypes/Email.js';
+import emailSend from './metadataTypes/EmailSend.js';
+import event from './metadataTypes/Event.js';
+import fileLocation from './metadataTypes/FileLocation.js';
+import fileTransfer from './metadataTypes/FileTransfer.js';
+import filter from './metadataTypes/Filter.js';
+import folder from './metadataTypes/Folder.js';
+import importFile from './metadataTypes/ImportFile.js';
+import journey from './metadataTypes/Journey.js';
+import list from './metadataTypes/List.js';
+import mobileCode from './metadataTypes/MobileCode.js';
+import mobileKeyword from './metadataTypes/MobileKeyword.js';
+import mobileMessage from './metadataTypes/MobileMessage.js';
+import query from './metadataTypes/Query.js';
+import role from './metadataTypes/Role.js';
+import script from './metadataTypes/Script.js';
+import sendClassification from './metadataTypes/SendClassification.js';
+import senderProfile from './metadataTypes/SenderProfile.js';
+import transactionalEmail from './metadataTypes/TransactionalEmail.js';
+import transactionalPush from './metadataTypes/TransactionalPush.js';
+import transactionalSMS from './metadataTypes/TransactionalSMS.js';
+import triggeredSend from './metadataTypes/TriggeredSend.js';
+import user from './metadataTypes/User.js';
+import verification from './metadataTypes/Verification.js';
+//# sourceMappingURL=MetadataTypeInfo.d.ts.map

package/@types/lib/MetadataTypeInfo.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MetadataTypeInfo.d.ts","sourceRoot":"","sources":["../../lib/MetadataTypeInfo.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAEkB,0BAA0B;2BACjB,mCAAmC;yBACrC,iCAAiC;uBACnC,+BAA+B;qBACjC,6BAA6B;wBAC1B,gCAAgC;0BAC9B,kCAAkC;+BAC7B,uCAAuC;kCACpC,0CAA0C;wBACpD,gCAAgC;4BAC5B,oCAAoC;4BACpC,oCAAoC;sBAC1C,8BAA8B;kBAClC,0BAA0B;sBACtB,8BAA8B;kBAClC,0BAA0B;yBACnB,iCAAiC;yBACjC,iCAAiC;mBACvC,2BAA2B;mBAC3B,2BAA2B;uBACvB,+BAA+B;oBAClC,4BAA4B;iBAC/B,yBAAyB;uBACnB,+BAA+B;0BAC5B,kCAAkC;0BAClC,kCAAkC;kBAC1C,0BAA0B;iBAC3B,yBAAyB;mBACvB,2BAA2B;+BACf,uCAAuC;0BAC5C,kCAAkC;+BAC7B,uCAAuC;8BACxC,sCAAsC;6BACvC,qCAAqC;0BACxC,kCAAkC;iBAC3C,yBAAyB;yBACjB,iCAAiC"}

package/@types/lib/Retriever.d.ts

@@ -0,0 +1,66 @@
+export default Retriever;
+export type BuObject = import('../types/mcdev.d.js').BuObject;
+export type CodeExtract = import('../types/mcdev.d.js').CodeExtract;
+export type CodeExtractItem = import('../types/mcdev.d.js').CodeExtractItem;
+export type Mcdevrc = import('../types/mcdev.d.js').Mcdevrc;
+export type MetadataTypeItem = import('../types/mcdev.d.js').MetadataTypeItem;
+export type MetadataTypeItemDiff = import('../types/mcdev.d.js').MetadataTypeItemDiff;
+export type MetadataTypeItemObj = import('../types/mcdev.d.js').MetadataTypeItemObj;
+export type MetadataTypeMap = import('../types/mcdev.d.js').MetadataTypeMap;
+export type MetadataTypeMapObj = import('../types/mcdev.d.js').MetadataTypeMapObj;
+export type MultiMetadataTypeList = import('../types/mcdev.d.js').MultiMetadataTypeList;
+export type MultiMetadataTypeMap = import('../types/mcdev.d.js').MultiMetadataTypeMap;
+export type SoapRequestParams = import('../types/mcdev.d.js').SoapRequestParams;
+export type TemplateMap = import('../types/mcdev.d.js').TemplateMap;
+export type TypeKeyCombo = import('../types/mcdev.d.js').TypeKeyCombo;
+/**
+ * @typedef {import('../types/mcdev.d.js').BuObject} BuObject
+ * @typedef {import('../types/mcdev.d.js').CodeExtract} CodeExtract
+ * @typedef {import('../types/mcdev.d.js').CodeExtractItem} CodeExtractItem
+ * @typedef {import('../types/mcdev.d.js').Mcdevrc} Mcdevrc
+ * @typedef {import('../types/mcdev.d.js').MetadataTypeItem} MetadataTypeItem
+ * @typedef {import('../types/mcdev.d.js').MetadataTypeItemDiff} MetadataTypeItemDiff
+ * @typedef {import('../types/mcdev.d.js').MetadataTypeItemObj} MetadataTypeItemObj
+ * @typedef {import('../types/mcdev.d.js').MetadataTypeMap} MetadataTypeMap
+ * @typedef {import('../types/mcdev.d.js').MetadataTypeMapObj} MetadataTypeMapObj
+ * @typedef {import('../types/mcdev.d.js').MultiMetadataTypeList} MultiMetadataTypeList
+ * @typedef {import('../types/mcdev.d.js').MultiMetadataTypeMap} MultiMetadataTypeMap
+ * @typedef {import('../types/mcdev.d.js').SoapRequestParams} SoapRequestParams
+ * @typedef {import('../types/mcdev.d.js').TemplateMap} TemplateMap
+ * @typedef {import('../types/mcdev.d.js').TypeKeyCombo} TypeKeyCombo
+ */
+/**
+ * Retrieves metadata from a business unit and saves it to the local filesystem.
+ */
+declare class Retriever {
+    /**
+     * Creates a Retriever, uses v2 auth if v2AuthOptions are passed.
+     *
+     * @param {Mcdevrc} properties General configuration to be used in retrieve
+     * @param {BuObject} buObject properties for auth
+     */
+    constructor(properties: Mcdevrc, buObject: BuObject);
+    buObject: import("../types/mcdev.d.js").BuObject;
+    properties: import("../types/mcdev.d.js").Mcdevrc;
+    retrieveDir: string;
+    templateDir: string;
+    savePath: any;
+    /**
+     * Retrieve metadata of specified types into local file system and Retriever.metadata
+     *
+     * @param {string[]} metadataTypes list of metadata types to retrieve; can include subtypes!
+     * @param {string[] | TypeKeyCombo} [namesOrKeys] name of Metadata to retrieveAsTemplate or list of keys for normal retrieval
+     * @param {TemplateMap} [templateVariables] Object of values which can be replaced (in case of templating)
+     * @param {boolean} [changelogOnly] skip saving, only create json in memory
+     * @returns {Promise.<MultiMetadataTypeList>} Promise of a list of retrieved items grouped by type {automation:[...], query:[...]}
+     */
+    retrieve(metadataTypes: string[], namesOrKeys?: string[] | TypeKeyCombo, templateVariables?: TemplateMap, changelogOnly?: boolean): Promise<MultiMetadataTypeList>;
+    /**
+     * helper for Retriever.retrieve to get all dependencies of the given types
+     *
+     * @param {string[]} metadataTypes list of metadata types to retrieve; can include subtypes!
+     * @returns {string[]} unique list dependent metadata types
+     */
+    _getTypeDependencies(metadataTypes: string[]): string[];
+}
+//# sourceMappingURL=Retriever.d.ts.map

package/@types/lib/Retriever.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Retriever.d.ts","sourceRoot":"","sources":["../../lib/Retriever.js"],"names":[],"mappings":";uBAUa,OAAO,qBAAqB,EAAE,QAAQ;0BACtC,OAAO,qBAAqB,EAAE,WAAW;8BACzC,OAAO,qBAAqB,EAAE,eAAe;sBAC7C,OAAO,qBAAqB,EAAE,OAAO;+BACrC,OAAO,qBAAqB,EAAE,gBAAgB;mCAC9C,OAAO,qBAAqB,EAAE,oBAAoB;kCAClD,OAAO,qBAAqB,EAAE,mBAAmB;8BACjD,OAAO,qBAAqB,EAAE,eAAe;iCAC7C,OAAO,qBAAqB,EAAE,kBAAkB;oCAChD,OAAO,qBAAqB,EAAE,qBAAqB;mCACnD,OAAO,qBAAqB,EAAE,oBAAoB;gCAClD,OAAO,qBAAqB,EAAE,iBAAiB;0BAC/C,OAAO,qBAAqB,EAAE,WAAW;2BACzC,OAAO,qBAAqB,EAAE,YAAY;AAdvD;;;;;;;;;;;;;;;GAeG;AAEH;;GAEG;AACH;IACI;;;;;OAKG;IACH,wBAHW,OAAO,YACP,QAAQ,EAYlB;IATG,iDAAwB;IACxB,kDAA4B;IAC5B,oBAAkD;IAClD,oBAAkD;IAClD,cAIE;IAGN;;;;;;;;OAQG;IACH,wBANW,MAAM,EAAE,gBACR,MAAM,EAAE,GAAG,YAAY,sBACvB,WAAW,kBACX,OAAO,GACL,QAAS,qBAAqB,CAAC,CA4I3C;IAED;;;;;OAKG;IACH,oCAHW,MAAM,EAAE,GACN,MAAM,EAAE,CAepB;CACJ"}

package/@types/lib/cli.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export type TypeKeyCombo = import('../types/mcdev.d.js').TypeKeyCombo;
+//# sourceMappingURL=cli.d.ts.map

package/@types/lib/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../../lib/cli.js"],"names":[],"mappings":";2BAaa,OAAO,qBAAqB,EAAE,YAAY"}

package/@types/lib/index.d.ts

@@ -0,0 +1,383 @@
+export default Mcdev;
+export type BuObject = import('../types/mcdev.d.js').BuObject;
+export type CodeExtract = import('../types/mcdev.d.js').CodeExtract;
+export type CodeExtractItem = import('../types/mcdev.d.js').CodeExtractItem;
+export type DeltaPkgItem = import('../types/mcdev.d.js').DeltaPkgItem;
+export type Mcdevrc = import('../types/mcdev.d.js').Mcdevrc;
+export type MetadataTypeItem = import('../types/mcdev.d.js').MetadataTypeItem;
+export type MetadataTypeItemDiff = import('../types/mcdev.d.js').MetadataTypeItemDiff;
+export type MetadataTypeItemObj = import('../types/mcdev.d.js').MetadataTypeItemObj;
+export type MetadataTypeMap = import('../types/mcdev.d.js').MetadataTypeMap;
+export type MetadataTypeMapObj = import('../types/mcdev.d.js').MetadataTypeMapObj;
+export type MultiMetadataTypeList = import('../types/mcdev.d.js').MultiMetadataTypeList;
+export type MultiMetadataTypeMap = import('../types/mcdev.d.js').MultiMetadataTypeMap;
+export type SkipInteraction = import('../types/mcdev.d.js').SkipInteraction;
+export type SoapRequestParams = import('../types/mcdev.d.js').SoapRequestParams;
+export type TemplateMap = import('../types/mcdev.d.js').TemplateMap;
+export type TypeKeyCombo = import('../types/mcdev.d.js').TypeKeyCombo;
+export type ExplainType = import('../types/mcdev.d.js').ExplainType;
+export type ContentBlockConversionTypes = import('../types/mcdev.d.js').ContentBlockConversionTypes;
+/**
+ * @typedef {import('../types/mcdev.d.js').BuObject} BuObject
+ * @typedef {import('../types/mcdev.d.js').CodeExtract} CodeExtract
+ * @typedef {import('../types/mcdev.d.js').CodeExtractItem} CodeExtractItem
+ * @typedef {import('../types/mcdev.d.js').DeltaPkgItem} DeltaPkgItem
+ * @typedef {import('../types/mcdev.d.js').Mcdevrc} Mcdevrc
+ * @typedef {import('../types/mcdev.d.js').MetadataTypeItem} MetadataTypeItem
+ * @typedef {import('../types/mcdev.d.js').MetadataTypeItemDiff} MetadataTypeItemDiff
+ * @typedef {import('../types/mcdev.d.js').MetadataTypeItemObj} MetadataTypeItemObj
+ * @typedef {import('../types/mcdev.d.js').MetadataTypeMap} MetadataTypeMap
+ * @typedef {import('../types/mcdev.d.js').MetadataTypeMapObj} MetadataTypeMapObj
+ * @typedef {import('../types/mcdev.d.js').MultiMetadataTypeList} MultiMetadataTypeList
+ * @typedef {import('../types/mcdev.d.js').MultiMetadataTypeMap} MultiMetadataTypeMap
+ * @typedef {import('../types/mcdev.d.js').SkipInteraction} SkipInteraction
+ * @typedef {import('../types/mcdev.d.js').SoapRequestParams} SoapRequestParams
+ * @typedef {import('../types/mcdev.d.js').TemplateMap} TemplateMap
+ * @typedef {import('../types/mcdev.d.js').TypeKeyCombo} TypeKeyCombo
+ * @typedef {import('../types/mcdev.d.js').ExplainType} ExplainType
+ * @typedef {import('../types/mcdev.d.js').ContentBlockConversionTypes} ContentBlockConversionTypes
+ */
+/**
+ * main class
+ */
+declare class Mcdev {
+    /**
+     * @returns {string} current version of mcdev
+     */
+    static version(): string;
+    /**
+     * helper method to use unattended mode when including mcdev as a package
+     *
+     * @param {SkipInteraction} [skipInteraction] signals what to insert automatically for things usually asked via wizard
+     * @returns {void}
+     */
+    static setSkipInteraction(skipInteraction?: SkipInteraction): void;
+    /**
+     * configures what is displayed in the console
+     *
+     * @param {object} argv list of command line parameters given by user
+     * @param {boolean} [argv.silent] only errors printed to CLI
+     * @param {boolean} [argv.verbose] chatty user CLI output
+     * @param {boolean} [argv.debug] enables developer output & features
+     * @returns {void}
+     */
+    static setLoggingLevel(argv: {
+        silent?: boolean;
+        verbose?: boolean;
+        debug?: boolean;
+    }): void;
+    /**
+     * allows setting system wide / command related options
+     *
+     * @param {object} argv list of command line parameters given by user
+     * @returns {void}
+     */
+    static setOptions(argv: object): void;
+    /**
+     * handler for 'mcdev createDeltaPkg
+     *
+     * @param {object} argv yargs parameters
+     * @param {string} [argv.range] git commit range
+    into deploy directory
+     * @param {string} [argv.filter] filter file paths that start with any
+     * @param {number} [argv.commitHistory] filter file paths that start with any
+     * @param {DeltaPkgItem[]} [argv.diffArr] list of files to include in delta package (skips git diff when provided)
+     * @returns {Promise.<DeltaPkgItem[]>} list of changed items
+     */
+    static createDeltaPkg(argv: {
+        range?: string;
+        filter?: string;
+        commitHistory?: number;
+        diffArr?: DeltaPkgItem[];
+    }): Promise<DeltaPkgItem[]>;
+    /**
+     * @returns {Promise} .
+     */
+    static selectTypes(): Promise<any>;
+    /**
+     * @returns {ExplainType[]} list of supported types with their apiNames
+     */
+    static explainTypes(): ExplainType[];
+    /**
+     * @returns {Promise.<boolean>} success flag
+     */
+    static upgrade(): Promise<boolean>;
+    /**
+     * helper to show an off-the-logs message to users
+     */
+    static "__#7@#welcomeMessage"(): void;
+    /**
+     * Retrieve all metadata from the specified business unit into the local file system.
+     *
+     * @param {string} businessUnit references credentials from properties.json
+     * @param {string[] | TypeKeyCombo} [selectedTypesArr] limit retrieval to given metadata type
+     * @param {string[]} [keys] limit retrieval to given metadata key
+     * @param {boolean} [changelogOnly] skip saving, only create json in memory
+     * @returns {Promise.<object>} -
+     */
+    static retrieve(businessUnit: string, selectedTypesArr?: string[] | TypeKeyCombo, keys?: string[], changelogOnly?: boolean): Promise<object>;
+    /**
+     * helper for {@link Mcdev.retrieve}
+     *
+     * @param {string} cred name of Credential
+     * @param {string} bu name of BU
+     * @param {string[] | TypeKeyCombo} [selectedTypesArr] limit retrieval to given metadata type/subtype
+     * @param {string[]} [keys] limit retrieval to given metadata key
+     * @param {boolean} [changelogOnly] skip saving, only create json in memory
+     * @returns {Promise.<object>} ensure that BUs are worked on sequentially
+     */
+    static "__#7@#retrieveBU"(cred: string, bu: string, selectedTypesArr?: string[] | TypeKeyCombo, keys?: string[], changelogOnly?: boolean): Promise<object>;
+    /**
+     * Deploys all metadata located in the 'deploy' directory to the specified business unit
+     *
+     * @param {string} businessUnit references credentials from properties.json
+     * @param {string[] | TypeKeyCombo} [selectedTypesArr] limit deployment to given metadata type
+     * @param {string[]} [keyArr] limit deployment to given metadata keys
+     * @returns {Promise.<Object.<string, MultiMetadataTypeMap>>} deployed metadata per BU (first key: bu name, second key: metadata type)
+     */
+    static deploy(businessUnit: string, selectedTypesArr?: string[] | TypeKeyCombo, keyArr?: string[]): Promise<{
+        [x: string]: MultiMetadataTypeMap;
+    }>;
+    /**
+     * Creates template file for properties.json
+     *
+     * @param {string} [credentialsName] identifying name of the installed package / project
+     * @returns {Promise.<void>} -
+     */
+    static initProject(credentialsName?: string): Promise<void>;
+    /**
+     * Clones an existing project from git repository and installs it
+     *
+     * @returns {Promise.<void>} -
+     */
+    static joinProject(): Promise<void>;
+    /**
+     * Refreshes BU names and ID's from MC instance
+     *
+     * @param {string} credentialsName identifying name of the installed package / project
+     * @returns {Promise.<void>} -
+     */
+    static findBUs(credentialsName: string): Promise<void>;
+    /**
+     * Creates docs for supported metadata types in Markdown and/or HTML format
+     *
+     * @param {string} businessUnit references credentials from properties.json
+     * @param {string} type metadata type
+     * @returns {Promise.<void>} -
+     */
+    static document(businessUnit: string, type: string): Promise<void>;
+    /**
+     * deletes metadata from MC instance by key
+     *
+     * @param {string} businessUnit references credentials from properties.json
+     * @param {string} type supported metadata type
+     * @param {string} customerKey Identifier of metadata
+     * @returns {Promise.<boolean>} true if successful, false otherwise
+     */
+    static deleteByKey(businessUnit: string, type: string, customerKey: string): Promise<boolean>;
+    /**
+     * get name & key for provided id
+     *
+     * @param {string} businessUnit references credentials from properties.json
+     * @param {string} type supported metadata type
+     * @param {string} id Identifier of metadata
+     * @returns {Promise.<{key:string, name:string, path:string}>} key, name and path of metadata; null if not found
+     */
+    static resolveId(businessUnit: string, type: string, id: string): Promise<{
+        key: string;
+        name: string;
+        path: string;
+    }>;
+    /**
+     * ensures triggered sends are restarted to ensure they pick up on changes of the underlying emails
+     *
+     * @param {string} businessUnit references credentials from properties.json
+     * @param {string} type references credentials from properties.json
+     * @param {string[]} [keyArr] metadata keys
+     * @returns {Promise.<void>} -
+     */
+    static refresh(businessUnit: string, type: string, keyArr?: string[]): Promise<void>;
+    /**
+     * Converts metadata to legacy format. Output is saved in 'converted' directory
+     *
+     * @param {string} businessUnit references credentials from properties.json
+     * @returns {Promise.<void>} -
+     */
+    static badKeys(businessUnit: string): Promise<void>;
+    /**
+     * Retrieve a specific metadata file and templatise.
+     *
+     * @param {string} businessUnit references credentials from properties.json
+     * @param {string} selectedType supported metadata type
+     * @param {string[]} name name of the metadata
+     * @param {string} market market which should be used to revert template
+     * @returns {Promise.<MultiMetadataTypeList>} -
+     */
+    static retrieveAsTemplate(businessUnit: string, selectedType: string, name: string[], market: string): Promise<MultiMetadataTypeList>;
+    /**
+     * Build a template based on a list of metadata files in the retrieve folder.
+     *
+     * @param {string} businessUnitTemplate references credentials from properties.json
+     * @param {string} businessUnitDefinition references credentials from properties.json
+     * @param {TypeKeyCombo} typeKeyCombo limit retrieval to given metadata type
+     * @param {string} marketTemplate market localizations
+     * @param {string} marketDefinition market localizations
+     * @param {boolean} [bulk] runs buildDefinitionBulk instead of buildDefinition; requires marketList to be defined and given via marketDefinition
+     * @returns {Promise.<MultiMetadataTypeList | object>} response from buildDefinition
+     */
+    static build(businessUnitTemplate: string, businessUnitDefinition: string, typeKeyCombo: TypeKeyCombo, marketTemplate: string, marketDefinition: string, bulk?: boolean): Promise<MultiMetadataTypeList | object>;
+    /**
+     * Build a template based on a list of metadata files in the retrieve folder.
+     *
+     * @param {string} businessUnit references credentials from properties.json
+     * @param {string | TypeKeyCombo} selectedTypes limit retrieval to given metadata type
+     * @param {string[] | undefined} keyArr customerkey of the metadata
+     * @param {string} market market localizations
+     * @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 {string | TypeKeyCombo} selectedTypes limit retrieval to given metadata type
+     * @param {string[] | undefined} nameArr name of the metadata
+     * @param {string} market market localizations
+     * @returns {Promise.<MultiMetadataTypeList>} -
+     */
+    static buildDefinition(businessUnit: string, selectedTypes: string | TypeKeyCombo, nameArr: string[] | undefined, market: string): Promise<MultiMetadataTypeList>;
+    /**
+     * Build a specific metadata file based on a template using a list of bu-market combos
+     *
+     * @param {string} listName name of list of BU-market combos
+     * @param {string | TypeKeyCombo} selectedTypes supported metadata type
+     * @param {string[]} [nameArr] name of the metadata
+     * @returns {Promise.<object>} -
+     */
+    static buildDefinitionBulk(listName: string, selectedTypes: string | TypeKeyCombo, nameArr?: string[]): Promise<object>;
+    /**
+     *
+     * @param {string} businessUnit references credentials from properties.json
+     * @param {string} selectedType supported metadata type
+     * @param {string[]} keyArr customerkey of the metadata
+     * @returns {Promise.<string[]>} list of all files that need to be committed in a flat array ['path/file1.ext', 'path/file2.ext']
+     */
+    static getFilesToCommit(businessUnit: string, selectedType: string, keyArr: string[]): Promise<string[]>;
+    /**
+     * Schedule an item (shortcut for execute --schedule)
+     *
+     * @param {string} businessUnit name of BU
+     * @param {string} [selectedType] 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
+     */
+    static schedule(businessUnit: string, selectedType?: string, keys?: string[]): Promise<{
+        [x: string]: string[];
+    }>;
+    /**
+     * Start/execute an item
+     *
+     * @param {string} businessUnit name of BU
+     * @param {string} [selectedType] 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
+     */
+    static execute(businessUnit: string, selectedType?: string, keys?: string[]): Promise<{
+        [x: string]: string[];
+    }>;
+    /**
+     * pause an item
+     *
+     * @param {string} businessUnit name of BU
+     * @param {string} [selectedType] 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
+     */
+    static pause(businessUnit: string, selectedType?: string, keys?: string[]): Promise<{
+        [x: string]: string[];
+    }>;
+    /**
+     * Updates the key to match the name field
+     *
+     * @param {string} businessUnit name of BU
+     * @param {TypeKeyCombo|undefined} selectedTypesArr limit retrieval to given metadata type
+     * @param {ContentBlockConversionTypes} to what to replace with
+     * @param {ContentBlockConversionTypes[]} [fromList] what to replace
+     * @returns {Promise.<Object.<string, object>>} key1: business unit name, key2:type value: list of fixed item keys
+     */
+    static replaceCbReference(businessUnit: string, selectedTypesArr: TypeKeyCombo | undefined, to: ContentBlockConversionTypes, fromList?: ContentBlockConversionTypes[]): Promise<{
+        [x: string]: object;
+    }>;
+    /**
+     * Updates the key to match the name field
+     *
+     * @param {string} businessUnit name of BU
+     * @param {string[] | TypeKeyCombo} selectedTypesArr limit retrieval to given metadata type
+     * @param {string[]} [keys] customerkey of the metadata
+     * @returns {Promise.<Object.<string, object>>} key1: business unit name, key2:type value: list of fixed item keys
+     */
+    static fixKeys(businessUnit: string, selectedTypesArr: string[] | TypeKeyCombo, keys?: string[]): Promise<{
+        [x: string]: object;
+    }>;
+    /**
+     * run a method across BUs
+     *
+     * @param {'execute'|'pause'|'fixKeys'|'replaceCbReference'} methodName what to run
+     * @param {string} businessUnit name of BU
+     * @param {string} [selectedType] 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
+     */
+    static "__#7@#runMethod"(methodName: 'execute' | 'pause' | 'fixKeys' | 'replaceCbReference', businessUnit: string, selectedType?: string, keys?: string[]): Promise<{
+        [x: string]: string[];
+    }>;
+    /**
+     * helper for Mcdev.#runMethod
+     *
+     * @param {'execute'|'pause'|'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 "__#7@#runOnBU"(methodName: 'execute' | 'pause' | 'fixKeys' | 'replaceCbReference', cred: string, bu: string, type?: string, keyArr?: string[]): Promise<string[]>;
+    /**
+     * helper for Mcdev.#runOnBU
+     *
+     * @param {string} selectedType limit execution to given metadata type
+     * @param {BuObject} buObject properties for auth
+     * @returns {Promise.<string[]>} keyArr
+     */
+    static "__#7@#retrieveKeysWithLike"(selectedType: string, buObject: BuObject): Promise<string[]>;
+    /**
+     * Updates the key to match the name field
+     *
+     * @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 "__#7@#fixKeys"(cred: string, bu: string, type: string, keyArr?: string[]): Promise<string[]>;
+    /**
+     * Updates the key to match the name field
+     *
+     * @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 "__#7@#replaceCbReference"(cred: string, bu: string, type: string, keyArr?: string[]): Promise<string[]>;
+    /**
+     * helper to convert CSVs into an array. if only one value was given, it's also returned as an array
+     *
+     * @param {string|string[]|undefined} metadataOption potentially comma-separated value or null
+     * @param {string[]} [allowedIdentifiers] 'key', 'id', 'name'
+     * @param {boolean} [firstOnly] removes all but the first entry if enabled
+     * @returns {TypeKeyCombo} values split into an array.
+     */
+    static metadataToTypeKey(metadataOption: string | string[] | undefined, allowedIdentifiers?: string[], firstOnly?: boolean): TypeKeyCombo;
+}
+//# sourceMappingURL=index.d.ts.map

package/@types/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../lib/index.js"],"names":[],"mappings":";uBAoBa,OAAO,qBAAqB,EAAE,QAAQ;0BACtC,OAAO,qBAAqB,EAAE,WAAW;8BACzC,OAAO,qBAAqB,EAAE,eAAe;2BAC7C,OAAO,qBAAqB,EAAE,YAAY;sBAC1C,OAAO,qBAAqB,EAAE,OAAO;+BACrC,OAAO,qBAAqB,EAAE,gBAAgB;mCAC9C,OAAO,qBAAqB,EAAE,oBAAoB;kCAClD,OAAO,qBAAqB,EAAE,mBAAmB;8BACjD,OAAO,qBAAqB,EAAE,eAAe;iCAC7C,OAAO,qBAAqB,EAAE,kBAAkB;oCAChD,OAAO,qBAAqB,EAAE,qBAAqB;mCACnD,OAAO,qBAAqB,EAAE,oBAAoB;8BAClD,OAAO,qBAAqB,EAAE,eAAe;gCAC7C,OAAO,qBAAqB,EAAE,iBAAiB;0BAC/C,OAAO,qBAAqB,EAAE,WAAW;2BACzC,OAAO,qBAAqB,EAAE,YAAY;0BAC1C,OAAO,qBAAqB,EAAE,WAAW;0CACzC,OAAO,qBAAqB,EAAE,2BAA2B;AAlBtE;;;;;;;;;;;;;;;;;;;GAmBG;AAEH;;GAEG;AACH;IACI;;OAEG;IACH,kBAFa,MAAM,CAKlB;IACD;;;;;OAKG;IACH,4CAHW,eAAe,GACb,IAAI,CAIhB;IACD;;;;;;;;OAQG;IACH;QAL0B,MAAM,GAArB,OAAO;QACQ,OAAO,GAAtB,OAAO;QACQ,KAAK,GAApB,OAAO;QACL,IAAI,CAIhB;IACD;;;;;OAKG;IACH,wBAHW,MAAM,GACJ,IAAI,CA6ChB;IACD;;;;;;;;;;OAUG;IACH;QAPyB,KAAK,GAAnB,MAAM;QAEQ,MAAM,GAApB,MAAM;QACQ,aAAa,GAA3B,MAAM;QACgB,OAAO,GAA7B,YAAY,EAAE;QACZ,QAAS,YAAY,EAAE,CAAC,CAoBpC;IAED;;OAEG;IACH,mCAOC;IACD;;OAEG;IACH,uBAFa,WAAW,EAAE,CAIzB;IACD;;OAEG;IACH,kBAFa,QAAS,OAAO,CAAC,CAc7B;IAED;;OAEG;IACH,sCAyBC;IACD;;;;;;;;OAQG;IACH,8BANW,MAAM,qBACN,MAAM,EAAE,GAAG,YAAY,SACvB,MAAM,EAAE,kBACR,OAAO,GACL,QAAS,MAAM,CAAC,CAuH5B;IACD;;;;;;;;;OASG;IACH,gCAPW,MAAM,MACN,MAAM,qBACN,MAAM,EAAE,GAAG,YAAY,SACvB,MAAM,EAAE,kBACR,OAAO,GACL,QAAS,MAAM,CAAC,CAqG5B;IAED;;;;;;;OAOG;IACH,4BALW,MAAM,qBACN,MAAM,EAAE,GAAG,YAAY,WACvB,MAAM,EAAE,GACN;YAAiB,MAAM,GAAE,oBAAoB;MAAE,CAS3D;IAED;;;;;OAKG;IACH,qCAHW,MAAM,GACJ,QAAS,IAAI,CAAC,CAO1B;IACD;;;;OAIG;IACH,sBAFa,QAAS,IAAI,CAAC,CAM1B;IAED;;;;;OAKG;IACH,gCAHW,MAAM,GACJ,QAAS,IAAI,CAAC,CAa1B;IAED;;;;;;OAMG;IACH,8BAJW,MAAM,QACN,MAAM,GACJ,QAAS,IAAI,CAAC,CAgC1B;IAED;;;;;;;OAOG;IACH,iCALW,MAAM,QACN,MAAM,eACN,MAAM,GACJ,QAAS,OAAO,CAAC,CA+B7B;IACD;;;;;;;OAOG;IACH,+BALW,MAAM,QACN,MAAM,MACN,MAAM,GACJ,QAAS;QAAC,GAAG,EAAC,MAAM,CAAC;QAAC,IAAI,EAAC,MAAM,CAAC;QAAC,IAAI,EAAC,MAAM,CAAA;KAAC,CAAC,CAmC5D;IAED;;;;;;;OAOG;IACH,6BALW,MAAM,QACN,MAAM,WACN,MAAM,EAAE,GACN,QAAS,IAAI,CAAC,CA8B1B;IAED;;;;;OAKG;IACH,6BAHW,MAAM,GACJ,QAAS,IAAI,CAAC,CAiE1B;IAED;;;;;;;;OAQG;IACH,wCANW,MAAM,gBACN,MAAM,QACN,MAAM,EAAE,UACR,MAAM,GACJ,QAAS,qBAAqB,CAAC,CAmC3C;IAED;;;;;;;;;;OAUG;IACH,mCARW,MAAM,0BACN,MAAM,gBACN,YAAY,kBACZ,MAAM,oBACN,MAAM,SACN,OAAO,GACL,QAAS,qBAAqB,GAAG,MAAM,CAAC,CAsBpD;IACD;;;;;;;;OAQG;IACH,mCANW,MAAM,iBACN,MAAM,GAAG,YAAY,UACrB,MAAM,EAAE,GAAG,SAAS,UACpB,MAAM,GACJ,QAAS,qBAAqB,CAAC,CAiC3C;IACD;;;;;;;;OAQG;IACH,qCANW,MAAM,iBACN,MAAM,GAAG,YAAY,WACrB,MAAM,EAAE,GAAG,SAAS,UACpB,MAAM,GACJ,QAAS,qBAAqB,CAAC,CAiC3C;IAED;;;;;;;OAOG;IACH,qCALW,MAAM,iBACN,MAAM,GAAG,YAAY,YACrB,MAAM,EAAE,GACN,QAAS,MAAM,CAAC,CAmC5B;IACD;;;;;;OAMG;IACH,sCALW,MAAM,gBACN,MAAM,UACN,MAAM,EAAE,GACN,QAAS,MAAM,EAAE,CAAC,CAsB9B;IACD;;;;;;;OAOG;IACH,8BALW,MAAM,iBACN,MAAM,SACN,MAAM,EAAE,GACN;YAAiB,MAAM,GAAE,MAAM,EAAE;MAAE,CAK/C;IACD;;;;;;;OAOG;IACH,6BALW,MAAM,iBACN,MAAM,SACN,MAAM,EAAE,GACN;YAAiB,MAAM,GAAE,MAAM,EAAE;MAAE,CAI/C;IACD;;;;;;;OAOG;IACH,2BALW,MAAM,iBACN,MAAM,SACN,MAAM,EAAE,GACN;YAAiB,MAAM,GAAE,MAAM,EAAE;MAAE,CAI/C;IACD;;;;;;;;OAQG;IACH,wCANW,MAAM,oBACN,YAAY,GAAC,SAAS,MACtB,2BAA2B,aAC3B,2BAA2B,EAAE,GAC3B;YAAiB,MAAM,GAAE,MAAM;MAAE,CAuF7C;IAED;;;;;;;OAOG;IACH,6BALW,MAAM,oBACN,MAAM,EAAE,GAAG,YAAY,SACvB,MAAM,EAAE,GACN;YAAiB,MAAM,GAAE,MAAM;MAAE,CAwE7C;IACD;;;;;;;;OAQG;IACH,qCANW,SAAS,GAAC,OAAO,GAAC,SAAS,GAAC,oBAAoB,gBAChD,MAAM,iBACN,MAAM,SACN,MAAM,EAAE,GACN;YAAiB,MAAM,GAAE,MAAM,EAAE;MAAE,CAmK/C;IACD;;;;;;;;;OASG;IACH,mCAPW,SAAS,GAAC,OAAO,GAAC,SAAS,GAAC,oBAAoB,QAChD,MAAM,MACN,MAAM,SACN,MAAM,WACN,MAAM,EAAE,GACN,QAAS,MAAM,EAAE,CAAC,CAuD9B;IAED;;;;;;OAMG;IACH,kDAJW,MAAM,YACN,QAAQ,GACN,QAAS,MAAM,EAAE,CAAC,CA0D9B;IACD;;;;;;;;OAQG;IACH,6BANW,MAAM,MACN,MAAM,QACN,MAAM,WACN,MAAM,EAAE,GACN,QAAS,MAAM,EAAE,CAAC,CA0E9B;IACD;;;;;;;;OAQG;IACH,wCANW,MAAM,MACN,MAAM,QACN,MAAM,WACN,MAAM,EAAE,GACN,QAAS,MAAM,EAAE,CAAC,CAyE9B;IACD;;;;;;;OAOG;IACH,yCALW,MAAM,GAAC,MAAM,EAAE,GAAC,SAAS,uBACzB,MAAM,EAAE,cACR,OAAO,GACL,YAAY,CA2ExB;CACJ"}