-
Notifications
You must be signed in to change notification settings - Fork 34
/
replaceContentBlockReference.js
278 lines (263 loc) · 11.7 KB
/
replaceContentBlockReference.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
'use strict';
import auth from './auth.js';
import cache from './cache.js';
import { Util } from '../util/util.js';
import Folder from '../metadataTypes/Folder.js';
import Asset from '../metadataTypes/Asset.js';
/**
* @typedef {import('../../types/mcdev.d.js').AuthObject} AuthObject
* @typedef {import('../../types/mcdev.d.js').BuObject} BuObject
* @typedef {import('../../types/mcdev.d.js').Cache} Cache
* @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').McdevLogger} McdevLogger
* @typedef {import('../../types/mcdev.d.js').Logger} Logger
* @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').SDKError} SDKError
* @typedef {import('../../types/mcdev.d.js').AssetItemSimple} AssetItemSimple
* @typedef {import('../../types/mcdev.d.js').AssetItemSimpleMap} AssetItemSimpleMap
* @typedef {import('../../types/mcdev.d.js').AssetItemIdSimpleMap} AssetItemIdSimpleMap
* @typedef {import('../../types/mcdev.d.js').ContentBlockConversionTypes} ContentBlockConversionTypes
*/
/**
* Util that contains logger and simple util methods
*/
export default class ReplaceContentBlockReference {
/** @type {{id: AssetItemIdSimpleMap, key: AssetItemSimpleMap, name: AssetItemSimpleMap}} */
static assetCacheMap = {
id: {},
key: {},
name: {},
};
/** @type {{id: RegExp[], key: RegExp[], name: RegExp[]}} */
static #regexBy = {
// TODO: handle cases in which variables or functions are passed into ContentBlockByX
amp: {
id: [
/ContentBlockById\(\s*"([0-9]+)"\s*\)/gim,
/ContentBlockById\(\s*'([0-9]+)'\s*\)/gim,
/ContentBlockById\(\s*([0-9]+)\s*\)/gim,
],
key: [
/ContentBlockByKey\(\s*"([a-z0-9-/._]+)"\s*\)/gim,
/ContentBlockByKey\(\s*'([a-z0-9-/._]+)'\s*\)/gim,
],
name: [
/ContentBlockByName\(\s*"([ a-z0-9-\\._)(]+)"\s*\)/gim,
/ContentBlockByName\(\s*'([ a-z0-9-\\._)(]+)'\s*\)/gim,
],
},
ssjs: {
id: [
/Platform.Function.ContentBlockById\(\s*"([0-9]+)"\s*\)/gim,
/Platform.Function.ContentBlockById\(\s*'([0-9]+)'\s*\)/gim,
/Platform.Function.ContentBlockById\(\s*([0-9]+)\s*\)/gim,
],
key: [
/Platform.Function.ContentBlockByKey\(\s*"([a-z0-9-/._]+)"\s*\)/gim,
/Platform.Function.ContentBlockByKey\(\s*'([a-z0-9-/._]+)'\s*\)/gim,
],
name: [
/Platform.Function.ContentBlockByName\(\s*"([ a-z0-9-\\._)(]+)"\s*\)/gim,
/Platform.Function.ContentBlockByName\(\s*'([ a-z0-9-\\._)(]+)'\s*\)/gim,
],
},
};
/**
* used to equalize the reference in the code to whatever is set in the "to" field
*
* @param {string} str full code string
* @param {string} parentName name of the object that was passed in; used in error message only
* @param {ContentBlockConversionTypes[]} [fromList] what to replace
* @param {ContentBlockConversionTypes} [to] what to replace with
* @returns {string} replaced string
*/
static replaceReference(str, parentName, fromList, to) {
if (!str) {
const ex = new Error('No string provided');
ex.code = 200;
throw ex;
}
fromList ||= Util.OPTIONS.referenceFrom;
to ||= Util.OPTIONS.referenceTo;
let result = str;
let changes = 0;
const languages = [
{ name: 'ssjs', isSsjs: true },
{ name: 'amp', isSsjs: false },
];
for (const from of fromList) {
for (const lang of languages) {
for (const regex of this.#regexBy[lang.name][from]) {
result = result.replaceAll(regex, (match, identifier) => {
const referencedAsset = this.#getAssetBy(
from,
identifier,
parentName,
lang.isSsjs
);
if (referencedAsset && referencedAsset[to]) {
// make sure we not only found the asset but also have a replacement for it (folder issue could block swap to ContentBlockByName)
changes++;
return this.#replaceWith(referencedAsset, to, lang.isSsjs);
} else {
if (referencedAsset && !referencedAsset[to]) {
// this is expected to only happen if to=="name"
Util.logger.error(
` - ${parentName}: Asset ${from} ${identifier} has no valid ${to} reference`
);
}
return match;
}
});
}
}
}
if (!changes) {
const ex = new Error('No changes made to the code.');
ex.code = 200;
throw ex;
}
return result;
}
/**
*
* @private
* @param {ContentBlockConversionTypes} from replace with
* @param {string|number} identifier id, key or name of asset
* @param {string} parentName name of the object that was passed in; used in error message only
* @param {boolean} [isSsjs] replaces backslashes with double backslashes in name if true
* @returns {AssetItemSimple} asset object
*/
static #getAssetBy(from, identifier, parentName, isSsjs = false) {
let reference;
switch (from) {
case 'id': {
reference = ReplaceContentBlockReference.assetCacheMap.id[identifier];
break;
}
case 'key': {
reference = ReplaceContentBlockReference.assetCacheMap.key[identifier];
break;
}
case 'name': {
if (isSsjs) {
identifier = identifier.replaceAll('\\\\', '\\');
}
reference = ReplaceContentBlockReference.assetCacheMap.name[identifier];
break;
}
}
if (!reference) {
Util.logger.error(` - ${parentName}: Asset not found for ${from} ${identifier}`);
}
return reference;
}
/**
*
* @param {AssetItemSimple} asset asset object
* @param {ContentBlockConversionTypes} to replace with
* @param {boolean} [isSsjs] replaces backslashes with double backslashes in name if true
* @returns {string} replaced string
*/
static #replaceWith(asset, to, isSsjs = false) {
switch (to) {
case 'id': {
return `${isSsjs ? 'Platform.Function.' : ''}ContentBlockById(${asset.id})`;
}
case 'key': {
return `${isSsjs ? 'Platform.Function.' : ''}ContentBlockByKey("${asset.key}")`;
}
case 'name': {
return `${isSsjs ? 'Platform.Function.' : ''}ContentBlockByName("${isSsjs ? asset.name.replaceAll('\\', '\\\\') : asset.name}")`;
}
}
}
/**
*
* @param {Mcdevrc} properties properties for auth
saved
* @param {BuObject} buObject properties for auth
*/
static async createCacheMap(properties, buObject) {
const client = auth.getSDK(buObject);
if (!cache.getCache()) {
cache.initCache(buObject);
}
Util.logger.info('Caching folders');
Folder.buObject = buObject;
Folder.properties = properties;
Folder.client = client;
const resultFolder = await Folder.retrieveForCache(null, ['asset', 'asset-shared']);
cache.setMetadata('folder', resultFolder.metadata);
Util.logger.info('Caching assets');
Asset.buObject = buObject;
Asset.properties = properties;
Asset.client = client;
const resultAsset = await Asset.retrieveForCache(undefined, [
'asset',
'code',
'textfile',
'block',
'other',
]);
for (const element of Object.values(resultAsset.metadata)) {
// ensure we got the folder-path in our cache
Asset.setFolderPath(element);
// create actual cache map
const simpleAsset = {
id: element.id,
key: element.customerKey,
name: element.r__folder_Path
? element.r__folder_Path.replaceAll('/', '\\') + '\\' + element.name
: null,
};
// ! note that ContentBlockByName expects backslashes between folders and file name, not forward slashes
ReplaceContentBlockReference.assetCacheMap.id[simpleAsset.id] = simpleAsset;
ReplaceContentBlockReference.assetCacheMap.key[simpleAsset.key] = simpleAsset;
if (simpleAsset.name) {
// while asset without path could still be found via search, it would no longer referencable via ContentBlockByName
ReplaceContentBlockReference.assetCacheMap.name[simpleAsset.name] = simpleAsset;
}
}
cache.setMetadata('asset', resultAsset.metadata);
Util.logger.info('Caching shared assets');
const resultAssetShared = await Asset.retrieveForCache(
undefined,
['asset', 'code', 'textfile', 'block', 'other'],
true
);
for (const element of Object.values(resultAssetShared.metadata)) {
// ensure we got the folder-path in our cache
Asset.setFolderPath(element);
// create actual cache map
const simpleAsset = {
id: element.id,
key: element.customerKey,
name: element.r__folder_Path
? element.r__folder_Path.replaceAll('/', '\\') + '\\' + element.name
: null,
};
// ! note that ContentBlockByName expects backslashes between folders and file name, not forward slashes
ReplaceContentBlockReference.assetCacheMap.id[simpleAsset.id] = simpleAsset;
ReplaceContentBlockReference.assetCacheMap.key[simpleAsset.key] = simpleAsset;
if (simpleAsset.name) {
// while asset without path could still be found via search, it would no longer referencable via ContentBlockByName
ReplaceContentBlockReference.assetCacheMap.name[simpleAsset.name] = simpleAsset;
}
}
// lets not put the shared assets into our cache to avoid confusing the system...
}
}