Skip to content

Commit

Permalink
#164: refactoring
Browse files Browse the repository at this point in the history
  • Loading branch information
@JoernBerkefeld
JoernBerkefeld committed Jan 29, 2024
1 parent 1dc5597 commit 50edae3
Show file tree
Hide file tree
Showing 9 changed files with 50 additions and 195 deletions.
128 changes: 25 additions & 103 deletions docs/dist/documentation.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1767,9 +1767,8 @@ ContentArea MetadataType

* [ContentArea](#ContentArea) ⇐ [<code>MetadataType</code>](#MetadataType)
* [.retrieve(retrieveDir, [_], [__], [key])](#ContentArea.retrieve) ⇒ <code>Promise.&lt;TYPE.MetadataTypeMapObj&gt;</code>
* [.postRetrieveTasks(metadata)](#ContentArea.postRetrieveTasks) ⇒ <code>TYPE.MetadataTypeItem</code>
* [.setFolderPath(metadata)](#ContentArea.setFolderPath)
* [.parseMetadata(metadata)](#ContentArea.parseMetadata) ⇒ <code>TYPE.MetadataTypeItem</code>
* [.postRetrieveTasks(metadata)](#ContentArea.postRetrieveTasks) ⇒ <code>TYPE.MetadataTypeItem</code>

<a name="ContentArea.retrieve"></a>

Expand All @@ -1786,18 +1785,6 @@ Retrieves SOAP based metadata of metadata type into local filesystem. executes c
| [__] | <code>void</code> | unused parameter |
| [key] | <code>string</code> | customer key of single item to retrieve |

<a name="ContentArea.postRetrieveTasks"></a>

### ContentArea.postRetrieveTasks(metadata) ⇒ <code>TYPE.MetadataTypeItem</code>
manages post retrieve steps

**Kind**: static method of [<code>ContentArea</code>](#ContentArea)
**Returns**: <code>TYPE.MetadataTypeItem</code> - parsed item

| Param | Type | Description |
| --- | --- | --- |
| metadata | <code>TYPE.MetadataTypeItem</code> | a single item |

<a name="ContentArea.setFolderPath"></a>

### ContentArea.setFolderPath(metadata)
Expand All @@ -1809,9 +1796,9 @@ generic script that retrieves the folder path from cache and updates the given m
| --- | --- | --- |
| metadata | <code>TYPE.MetadataTypeItem</code> | a single script activity definition |

<a name="ContentArea.parseMetadata"></a>
<a name="ContentArea.postRetrieveTasks"></a>

### ContentArea.parseMetadata(metadata) ⇒ <code>TYPE.MetadataTypeItem</code>
### ContentArea.postRetrieveTasks(metadata) ⇒ <code>TYPE.MetadataTypeItem</code>
parses retrieved Metadata before saving

**Kind**: static method of [<code>ContentArea</code>](#ContentArea)
Expand Down Expand Up @@ -2227,11 +2214,10 @@ DataExtract MetadataType
* [.retrieve(retrieveDir, [_], [__], [key])](#DataExtract.retrieve) ⇒ <code>Promise.&lt;TYPE.MetadataTypeMapObj&gt;</code>
* [.retrieveForCache()](#DataExtract.retrieveForCache) ⇒ <code>Promise.&lt;TYPE.MetadataTypeMapObj&gt;</code>
* [.retrieveAsTemplate(templateDir, name, templateVariables)](#DataExtract.retrieveAsTemplate) ⇒ <code>Promise.&lt;TYPE.MetadataTypeItemObj&gt;</code>
* [.postRetrieveTasks(fileTransfer)](#DataExtract.postRetrieveTasks) ⇒ <code>TYPE.MetadataTypeItem</code>
* [.create(dataExtract)](#DataExtract.create) ⇒ <code>Promise</code>
* [.update(dataExtract)](#DataExtract.update) ⇒ <code>Promise</code>
* [.preDeployTasks(metadata)](#DataExtract.preDeployTasks) ⇒ <code>TYPE.MetadataTypeItem</code>
* [.parseMetadata(metadata)](#DataExtract.parseMetadata) ⇒ <code>TYPE.MetadataTypeItem</code>
* [.postRetrieveTasks(metadata)](#DataExtract.postRetrieveTasks) ⇒ <code>TYPE.MetadataTypeItem</code>
* [.deleteByKey(customerKey)](#DataExtract.deleteByKey) ⇒ <code>boolean</code>

<a name="DataExtract.retrieve"></a>
Expand Down Expand Up @@ -2271,18 +2257,6 @@ Retrieve a specific dataExtract Definition by Name
| name | <code>string</code> | name of the metadata file |
| templateVariables | <code>TYPE.TemplateMap</code> | variables to be replaced in the metadata |

<a name="DataExtract.postRetrieveTasks"></a>

### DataExtract.postRetrieveTasks(fileTransfer) ⇒ <code>TYPE.MetadataTypeItem</code>
manages post retrieve steps

**Kind**: static method of [<code>DataExtract</code>](#DataExtract)
**Returns**: <code>TYPE.MetadataTypeItem</code> - metadata

| Param | Type | Description |
| --- | --- | --- |
| fileTransfer | <code>TYPE.MetadataTypeItem</code> | a single fileTransfer |

<a name="DataExtract.create"></a>

### DataExtract.create(dataExtract) ⇒ <code>Promise</code>
Expand Down Expand Up @@ -2319,17 +2293,17 @@ prepares a dataExtract for deployment
| --- | --- | --- |
| metadata | <code>TYPE.MetadataTypeItem</code> | a single dataExtract activity definition |

<a name="DataExtract.parseMetadata"></a>
<a name="DataExtract.postRetrieveTasks"></a>

### DataExtract.parseMetadata(metadata) ⇒ <code>TYPE.MetadataTypeItem</code>
parses retrieved Metadata before saving
### DataExtract.postRetrieveTasks(metadata) ⇒ <code>TYPE.MetadataTypeItem</code>
manages post retrieve steps

**Kind**: static method of [<code>DataExtract</code>](#DataExtract)
**Returns**: <code>TYPE.MetadataTypeItem</code> - Array with one metadata object and one sql string
**Returns**: <code>TYPE.MetadataTypeItem</code> - metadata

| Param | Type | Description |
| --- | --- | --- |
| metadata | <code>TYPE.MetadataTypeItem</code> | a single dataExtract activity definition |
| metadata | <code>TYPE.MetadataTypeItem</code> | a single item |

<a name="DataExtract.deleteByKey"></a>

Expand Down Expand Up @@ -2414,7 +2388,6 @@ Email MetadataType
* [.retrieve(retrieveDir, [_], [__], [key])](#Email.retrieve) ⇒ <code>Promise.&lt;TYPE.MetadataTypeMapObj&gt;</code>
* [.saveResults(results, retrieveDir, [overrideType], [templateVariables])](#Email.saveResults) ⇒ <code>Promise.&lt;TYPE.MetadataTypeMap&gt;</code>
* [.postRetrieveTasks(metadata)](#Email.postRetrieveTasks) ⇒ <code>TYPE.MetadataTypeItem</code>
* [.parseMetadata(metadata)](#Email.parseMetadata) ⇒ <code>TYPE.MetadataTypeItem</code>

<a name="Email.retrieve"></a>

Expand Down Expand Up @@ -2458,18 +2431,6 @@ manages post retrieve steps
| --- | --- | --- |
| metadata | <code>TYPE.MetadataTypeItem</code> | a single query |

<a name="Email.parseMetadata"></a>

### Email.parseMetadata(metadata) ⇒ <code>TYPE.MetadataTypeItem</code>
parses retrieved Metadata before saving

**Kind**: static method of [<code>Email</code>](#Email)
**Returns**: <code>TYPE.MetadataTypeItem</code> - Array with one metadata object and one sql string

| Param | Type | Description |
| --- | --- | --- |
| metadata | <code>TYPE.MetadataTypeItem</code> | a single query activity definition |

<a name="EmailSend"></a>

## EmailSend ⇐ [<code>MetadataType</code>](#MetadataType)
Expand Down Expand Up @@ -2752,11 +2713,10 @@ FileTransfer MetadataType
* [.retrieve(retrieveDir, [_], [__], [key])](#FileTransfer.retrieve) ⇒ <code>Promise.&lt;TYPE.MetadataTypeMapObj&gt;</code>
* [.retrieveForCache()](#FileTransfer.retrieveForCache) ⇒ <code>Promise.&lt;TYPE.MetadataTypeMapObj&gt;</code>
* [.retrieveAsTemplate(templateDir, name, templateVariables)](#FileTransfer.retrieveAsTemplate) ⇒ <code>Promise.&lt;TYPE.MetadataTypeItemObj&gt;</code>
* [.postRetrieveTasks(metadata)](#FileTransfer.postRetrieveTasks) ⇒ <code>Array.&lt;object&gt;</code>
* [.create(fileTransfer)](#FileTransfer.create) ⇒ <code>Promise</code>
* [.update(fileTransfer)](#FileTransfer.update) ⇒ <code>Promise</code>
* [.preDeployTasks(metadata)](#FileTransfer.preDeployTasks) ⇒ <code>Promise</code>
* [.parseMetadata(metadata)](#FileTransfer.parseMetadata) ⇒ <code>TYPE.MetadataTypeItem</code>
* [.postRetrieveTasks(metadata)](#FileTransfer.postRetrieveTasks) ⇒ <code>TYPE.MetadataTypeItem</code>
* [.deleteByKey(customerKey)](#FileTransfer.deleteByKey) ⇒ <code>boolean</code>

<a name="FileTransfer.retrieve"></a>
Expand Down Expand Up @@ -2796,18 +2756,6 @@ Retrieve a specific File Transfer Definition by Name
| name | <code>string</code> | name of the metadata file |
| templateVariables | <code>TYPE.TemplateMap</code> | variables to be replaced in the metadata |

<a name="FileTransfer.postRetrieveTasks"></a>

### FileTransfer.postRetrieveTasks(metadata) ⇒ <code>Array.&lt;object&gt;</code>
manages post retrieve steps

**Kind**: static method of [<code>FileTransfer</code>](#FileTransfer)
**Returns**: <code>Array.&lt;object&gt;</code> - metadata

| Param | Type | Description |
| --- | --- | --- |
| metadata | <code>TYPE.MetadataTypeItem</code> | a single fileTransfer activity definition |

<a name="FileTransfer.create"></a>

### FileTransfer.create(fileTransfer) ⇒ <code>Promise</code>
Expand Down Expand Up @@ -2844,10 +2792,10 @@ prepares a fileTransfer for deployment
| --- | --- | --- |
| metadata | <code>TYPE.MetadataTypeItem</code> | a single fileTransfer activity definition |

<a name="FileTransfer.parseMetadata"></a>
<a name="FileTransfer.postRetrieveTasks"></a>

### FileTransfer.parseMetadata(metadata) ⇒ <code>TYPE.MetadataTypeItem</code>
parses retrieved Metadata before saving
### FileTransfer.postRetrieveTasks(metadata) ⇒ <code>TYPE.MetadataTypeItem</code>
manages post retrieve steps

**Kind**: static method of [<code>FileTransfer</code>](#FileTransfer)
**Returns**: <code>TYPE.MetadataTypeItem</code> - parsed metadata
Expand Down Expand Up @@ -3056,11 +3004,10 @@ ImportFile MetadataType
* [.retrieve(retrieveDir, [_], [__], [key])](#ImportFile.retrieve) ⇒ <code>Promise.&lt;TYPE.MetadataTypeMapObj&gt;</code>
* [.retrieveForCache([_], [__], [key])](#ImportFile.retrieveForCache) ⇒ <code>Promise.&lt;TYPE.MetadataTypeMapObj&gt;</code>
* [.retrieveAsTemplate(templateDir, name, templateVariables)](#ImportFile.retrieveAsTemplate) ⇒ <code>Promise.&lt;TYPE.MetadataTypeItemObj&gt;</code>
* [.postRetrieveTasks(importDef)](#ImportFile.postRetrieveTasks) ⇒ <code>TYPE.MetadataTypeItem</code>
* [.create(importFile)](#ImportFile.create) ⇒ <code>Promise</code>
* [.update(importFile)](#ImportFile.update) ⇒ <code>Promise</code>
* [.preDeployTasks(metadata)](#ImportFile.preDeployTasks) ⇒ <code>Promise</code>
* [.parseMetadata(metadata)](#ImportFile.parseMetadata) ⇒ <code>TYPE.MetadataTypeItem</code>
* [.postRetrieveTasks(metadata)](#ImportFile.postRetrieveTasks) ⇒ <code>TYPE.MetadataTypeItem</code>
* [.deleteByKey(customerKey)](#ImportFile.deleteByKey) ⇒ <code>boolean</code>

<a name="ImportFile.retrieve"></a>
Expand Down Expand Up @@ -3108,18 +3055,6 @@ Retrieve a specific Import Definition by Name
| name | <code>string</code> | name of the metadata file |
| templateVariables | <code>TYPE.TemplateMap</code> | variables to be replaced in the metadata |

<a name="ImportFile.postRetrieveTasks"></a>

### ImportFile.postRetrieveTasks(importDef) ⇒ <code>TYPE.MetadataTypeItem</code>
manages post retrieve steps

**Kind**: static method of [<code>ImportFile</code>](#ImportFile)
**Returns**: <code>TYPE.MetadataTypeItem</code> - metadata

| Param | Type | Description |
| --- | --- | --- |
| importDef | <code>TYPE.MetadataTypeItem</code> | a single importDef |

<a name="ImportFile.create"></a>

### ImportFile.create(importFile) ⇒ <code>Promise</code>
Expand Down Expand Up @@ -3156,17 +3091,17 @@ prepares a import definition for deployment
| --- | --- | --- |
| metadata | <code>TYPE.MetadataTypeItem</code> | a single importDef |

<a name="ImportFile.parseMetadata"></a>
<a name="ImportFile.postRetrieveTasks"></a>

### ImportFile.parseMetadata(metadata) ⇒ <code>TYPE.MetadataTypeItem</code>
parses retrieved Metadata before saving
### ImportFile.postRetrieveTasks(metadata) ⇒ <code>TYPE.MetadataTypeItem</code>
manages post retrieve steps

**Kind**: static method of [<code>ImportFile</code>](#ImportFile)
**Returns**: <code>TYPE.MetadataTypeItem</code> - parsed metadata definition
**Returns**: <code>TYPE.MetadataTypeItem</code> - parsed metadata

| Param | Type | Description |
| --- | --- | --- |
| metadata | <code>TYPE.MetadataTypeItem</code> | a single import definition |
| metadata | <code>TYPE.MetadataTypeItem</code> | a single item |

<a name="ImportFile.deleteByKey"></a>

Expand Down Expand Up @@ -5243,15 +5178,14 @@ Script MetadataType
* [.retrieve(retrieveDir, [_], [__], [key])](#Script.retrieve) ⇒ <code>Promise.&lt;{metadata: TYPE.ScriptMap, type: string}&gt;</code>
* [.retrieveForCache()](#Script.retrieveForCache) ⇒ <code>Promise.&lt;{metadata: TYPE.ScriptMap, type: string}&gt;</code>
* [.retrieveAsTemplate(templateDir, name, templateVariables)](#Script.retrieveAsTemplate) ⇒ <code>Promise.&lt;{metadata: TYPE.Script, type: string}&gt;</code>
* [.postRetrieveTasks(metadata)](#Script.postRetrieveTasks) ⇒ <code>TYPE.CodeExtractItem</code>
* [.update(script)](#Script.update) ⇒ <code>Promise</code>
* [.create(script)](#Script.create) ⇒ <code>Promise</code>
* [._mergeCode(metadata, deployDir, [templateName])](#Script._mergeCode) ⇒ <code>Promise.&lt;string&gt;</code>
* [.preDeployTasks(metadata, dir)](#Script.preDeployTasks) ⇒ <code>TYPE.ScriptItem</code>
* [.buildDefinitionForNested(templateDir, targetDir, metadata, templateVariables, templateName)](#Script.buildDefinitionForNested) ⇒ <code>Promise.&lt;Array.&lt;Array.&lt;string&gt;&gt;&gt;</code>
* [.buildTemplateForNested(templateDir, targetDir, metadata, templateVariables, templateName)](#Script.buildTemplateForNested) ⇒ <code>Promise.&lt;Array.&lt;Array.&lt;string&gt;&gt;&gt;</code>
* [._buildForNested(templateDir, targetDir, metadata, templateVariables, templateName, mode)](#Script._buildForNested) ⇒ <code>Promise.&lt;Array.&lt;Array.&lt;string&gt;&gt;&gt;</code>
* [.parseMetadata(metadata)](#Script.parseMetadata) ⇒ <code>TYPE.CodeExtractItem</code>
* [.postRetrieveTasks(metadata)](#Script.postRetrieveTasks) ⇒ <code>TYPE.CodeExtractItem</code>
* [.prepExtractedCode(metadataScript, metadataName)](#Script.prepExtractedCode) ⇒ <code>Object</code>
* [.getFilesToCommit(keyArr)](#Script.getFilesToCommit) ⇒ <code>Array.&lt;string&gt;</code>
* [.deleteByKey(customerKey)](#Script.deleteByKey) ⇒ <code>boolean</code>
Expand Down Expand Up @@ -5294,18 +5228,6 @@ Retrieve a specific Script by Name
| name | <code>string</code> | name of the metadata file |
| templateVariables | <code>TYPE.TemplateMap</code> | variables to be replaced in the metadata |

<a name="Script.postRetrieveTasks"></a>

### Script.postRetrieveTasks(metadata) ⇒ <code>TYPE.CodeExtractItem</code>
manages post retrieve steps

**Kind**: static method of [<code>Script</code>](#Script)
**Returns**: <code>TYPE.CodeExtractItem</code> - Array with one metadata object and one ssjs string

| Param | Type | Description |
| --- | --- | --- |
| metadata | <code>TYPE.ScriptItem</code> | a single script |

<a name="Script.update"></a>

### Script.update(script) ⇒ <code>Promise</code>
Expand Down Expand Up @@ -5413,22 +5335,22 @@ handles extracted code if any are found for complex types
| templateName | <code>string</code> | name of the template to be built |
| mode | <code>&#x27;definition&#x27;</code> \| <code>&#x27;template&#x27;</code> | defines what we use this helper for |

<a name="Script.parseMetadata"></a>
<a name="Script.postRetrieveTasks"></a>

### Script.parseMetadata(metadata) ⇒ <code>TYPE.CodeExtractItem</code>
Splits the script metadata into two parts and parses in a standard manner
### Script.postRetrieveTasks(metadata) ⇒ <code>TYPE.CodeExtractItem</code>
manages post retrieve steps

**Kind**: static method of [<code>Script</code>](#Script)
**Returns**: <code>TYPE.CodeExtractItem</code> - a single item with code parts extracted

| Param | Type | Description |
| --- | --- | --- |
| metadata | <code>TYPE.ScriptItem</code> | a single script activity definition |
| metadata | <code>TYPE.ScriptItem</code> | a single item |

<a name="Script.prepExtractedCode"></a>

### Script.prepExtractedCode(metadataScript, metadataName) ⇒ <code>Object</code>
helper for [parseMetadata](#Script.parseMetadata) and [_buildForNested](#Script._buildForNested)
helper for [postRetrieveTasks](#Script.postRetrieveTasks) and [_buildForNested](#Script._buildForNested)

**Kind**: static method of [<code>Script</code>](#Script)
**Returns**: <code>Object</code> - returns found extension and file content
Expand Down
11 changes: 1 addition & 10 deletions lib/metadataTypes/ContentArea.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,15 +38,6 @@ class ContentArea extends MetadataType {
// !dont activate `await File.initPrettier('html');` as we only want to retrieve for migration and formatting might mess with the outcome
return super.retrieveSOAP(retrieveDir, requestParams, key);
}
/**
* manages post retrieve steps
*
* @param {TYPE.MetadataTypeItem} metadata a single item
* @returns {TYPE.MetadataTypeItem} parsed item
*/
static postRetrieveTasks(metadata) {
return this.parseMetadata(metadata);
}
/**
* generic script that retrieves the folder path from cache and updates the given metadata with it after retrieve
*
Expand Down Expand Up @@ -79,7 +70,7 @@ class ContentArea extends MetadataType {
* @param {TYPE.MetadataTypeItem} metadata a single item
* @returns {TYPE.MetadataTypeItem} parsed item
*/
static parseMetadata(metadata) {
static postRetrieveTasks(metadata) {
// folder
this.setFolderPath(metadata);

Expand Down
12 changes: 0 additions & 12 deletions lib/metadataTypes/DataExtensionField.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,18 +63,6 @@ class DataExtensionField extends MetadataType {
* @returns {TYPE.DataExtensionFieldItem} metadata
*/
static postRetrieveTasks(metadata, forDataExtension) {
return this._parseMetadata(metadata, forDataExtension);
}

/**
* parses retrieved Metadata before saving
*
* @private
* @param {TYPE.DataExtensionFieldItem} metadata a single record
* @param {boolean} forDataExtension when used by DataExtension class we remove more fields
* @returns {TYPE.DataExtensionFieldItem} parsed metadata definition
*/
static _parseMetadata(metadata, forDataExtension) {
if (forDataExtension) {
// remove fields according to definition
this.keepRetrieveFields(metadata);
Expand Down
20 changes: 5 additions & 15 deletions lib/metadataTypes/DataExtract.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ class DataExtract extends MetadataType {
const originalKey = extended[this.definition.keyField];
const val = JSON.parse(
Util.replaceByObject(
JSON.stringify(this.parseMetadata(extended)),
JSON.stringify(this.postRetrieveTasks(extended)),
templateVariables
)
);
Expand All @@ -86,16 +86,6 @@ class DataExtract extends MetadataType {
}
}

/**
* manages post retrieve steps
*
* @param {TYPE.MetadataTypeItem} fileTransfer a single fileTransfer
* @returns {TYPE.MetadataTypeItem} metadata
*/
static postRetrieveTasks(fileTransfer) {
return this.parseMetadata(fileTransfer);
}

/**
* Creates a single Data Extract
*
Expand Down Expand Up @@ -136,12 +126,12 @@ class DataExtract extends MetadataType {
return metadata;
}
/**
* parses retrieved Metadata before saving
* manages post retrieve steps
*
* @param {TYPE.MetadataTypeItem} metadata a single dataExtract activity definition
* @returns {TYPE.MetadataTypeItem} Array with one metadata object and one sql string
* @param {TYPE.MetadataTypeItem} metadata a single item
* @returns {TYPE.MetadataTypeItem} metadata
*/
static parseMetadata(metadata) {
static postRetrieveTasks(metadata) {
try {
metadata.r__dataExtractType_name = cache.searchForField(
'dataExtractType',
Expand Down
9 changes: 0 additions & 9 deletions lib/metadataTypes/Email.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,15 +59,6 @@ class Email extends MetadataType {
* @returns {TYPE.MetadataTypeItem} Array with one metadata object and one query string
*/
static postRetrieveTasks(metadata) {
return this.parseMetadata(metadata);
}
/**
* parses retrieved Metadata before saving
*
* @param {TYPE.MetadataTypeItem} metadata a single query activity definition
* @returns {TYPE.MetadataTypeItem} Array with one metadata object and one sql string
*/
static parseMetadata(metadata) {
// folder
super.setFolderPath(metadata);

Expand Down
Loading

0 comments on commit 50edae3

Please sign in to comment.