ampscript-data 4.1.0 → 4.3.0

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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ampscript-data",
3
- "version": "4.1.0",
3
+ "version": "4.3.0",
4
4
  "description": "Canonical AMPscript function catalog, keywords, and personalization strings for SFMC tooling",
5
5
  "type": "module",
6
6
  "main": "src/index.js",
@@ -182,9 +182,11 @@ export const CONTENT_FUNCTIONS = [
182
182
  name: 'BeginImpressionRegion',
183
183
  supportedInCloudPage: true,
184
184
  supportedInEmail: true,
185
- mcnSince: null,
186
- handlebarsEquivalent: null,
187
- mcnNotes: null,
185
+ mcnSince: 68,
186
+ handlebarsEquivalent: 'impressionRegion',
187
+ handlebarsExact: false,
188
+ mcnNotes:
189
+ 'In Handlebars, the block helper impressionRegion replaces this function together with EndImpressionRegion: the region name goes on the opening tag and the closing tag ends the region.',
188
190
  docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-content/mc-ampscript-reference-content-begin-impression-region.html',
189
191
  guideUrl: 'https://ampscript.guide/beginimpressionregion/',
190
192
  sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/beginimpressionregion/',
@@ -315,8 +317,9 @@ export const CONTENT_FUNCTIONS = [
315
317
  name: 'BuildRowSetFromString',
316
318
  supportedInCloudPage: true,
317
319
  supportedInEmail: true,
318
- mcnSince: null,
319
- handlebarsEquivalent: null,
320
+ mcnSince: 68,
321
+ handlebarsEquivalent: 'buildRowSetFromString',
322
+ handlebarsExact: true,
320
323
  mcnNotes: null,
321
324
  docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-content/mc-ampscript-reference-content-build-rowset-from-string.html',
322
325
  guideUrl: 'https://ampscript.guide/buildrowsetfromstring/',
@@ -350,8 +353,9 @@ export const CONTENT_FUNCTIONS = [
350
353
  name: 'BuildRowSetFromXML',
351
354
  supportedInCloudPage: true,
352
355
  supportedInEmail: true,
353
- mcnSince: null,
354
- handlebarsEquivalent: null,
356
+ mcnSince: 68,
357
+ handlebarsEquivalent: 'buildRowSetFromXml',
358
+ handlebarsExact: false,
355
359
  mcnNotes: null,
356
360
  docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-content/mc-ampscript-reference-content-build-rowset-from-xml.html',
357
361
  guideUrl: 'https://ampscript.guide/buildrowsetfromxml/',
@@ -808,9 +812,11 @@ export const CONTENT_FUNCTIONS = [
808
812
  name: 'EndImpressionRegion',
809
813
  supportedInCloudPage: true,
810
814
  supportedInEmail: true,
811
- mcnSince: null,
812
- handlebarsEquivalent: null,
813
- mcnNotes: null,
815
+ mcnSince: 68,
816
+ handlebarsEquivalent: 'impressionRegion',
817
+ handlebarsExact: false,
818
+ mcnNotes:
819
+ 'In Handlebars, the closing tag of the impressionRegion block helper ends its region; there is no argument for ending every open region at once.',
814
820
  docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-content/mc-ampscript-reference-content-end-impression-region.html',
815
821
  guideUrl: 'https://ampscript.guide/endimpressionregion/',
816
822
  sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/endimpressionregion/',
@@ -8,8 +8,9 @@ export const DATA_EXTENSION_FUNCTIONS = [
8
8
  name: 'ClaimRow',
9
9
  supportedInCloudPage: true,
10
10
  supportedInEmail: true,
11
- mcnSince: null,
12
- handlebarsEquivalent: null,
11
+ mcnSince: 68,
12
+ handlebarsEquivalent: 'claimRow',
13
+ handlebarsExact: false,
13
14
  mcnNotes: null,
14
15
  docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-data-extension/mc-ampscript-reference-data-extension-claim-row.html',
15
16
  guideUrl: 'https://ampscript.guide/claimrow/',
@@ -79,9 +80,11 @@ export const DATA_EXTENSION_FUNCTIONS = [
79
80
  name: 'ClaimRowValue',
80
81
  supportedInCloudPage: true,
81
82
  supportedInEmail: true,
82
- mcnSince: null,
83
- handlebarsEquivalent: null,
84
- mcnNotes: null,
83
+ mcnSince: 68,
84
+ handlebarsEquivalent: 'claimRow',
85
+ handlebarsExact: false,
86
+ mcnNotes:
87
+ 'Handlebars has no one-call counterpart: claimRow takes named arguments and returns the whole row, so read the wanted column from that row and wrap the call in fallback to supply a default when no row is left.',
85
88
  docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-data-extension/mc-ampscript-reference-data-extension-claim-row-value.html',
86
89
  guideUrl: 'https://ampscript.guide/claimrowvalue/',
87
90
  sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/claimrowvalue/',
@@ -556,7 +559,7 @@ export const DATA_EXTENSION_FUNCTIONS = [
556
559
  name: 'LookupOrderedRows',
557
560
  supportedInCloudPage: true,
558
561
  supportedInEmail: true,
559
- mcnSince: null,
562
+ mcnSince: 68,
560
563
  handlebarsEquivalent: 'query',
561
564
  handlebarsExact: false,
562
565
  mcnNotes: null,
@@ -675,7 +678,7 @@ export const DATA_EXTENSION_FUNCTIONS = [
675
678
  name: 'LookupRows',
676
679
  supportedInCloudPage: true,
677
680
  supportedInEmail: true,
678
- mcnSince: null,
681
+ mcnSince: 68,
679
682
  handlebarsEquivalent: 'query',
680
683
  handlebarsExact: false,
681
684
  mcnNotes: null,
@@ -139,8 +139,9 @@ export const DATE_TIME_FUNCTIONS = [
139
139
  name: 'DatePart',
140
140
  supportedInCloudPage: true,
141
141
  supportedInEmail: true,
142
- mcnSince: null,
143
- handlebarsEquivalent: null,
142
+ mcnSince: 68,
143
+ handlebarsEquivalent: 'datePart',
144
+ handlebarsExact: true,
144
145
  mcnNotes: null,
145
146
  docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-date-time/mc-ampscript-reference-date-time-date-part.html',
146
147
  guideUrl: 'https://ampscript.guide/datepart/',
@@ -8,8 +8,9 @@ export const ENCRYPTION_ENCODING_FUNCTIONS = [
8
8
  name: 'Base64Decode',
9
9
  supportedInCloudPage: true,
10
10
  supportedInEmail: true,
11
- mcnSince: null,
12
- handlebarsEquivalent: null,
11
+ mcnSince: 68,
12
+ handlebarsEquivalent: 'base64Decode',
13
+ handlebarsExact: false,
13
14
  mcnNotes: null,
14
15
  docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-utilities/mc-ampscript-reference-utilities-base64-decode.html',
15
16
  guideUrl: 'https://ampscript.guide/base64decode/',
@@ -56,8 +57,9 @@ export const ENCRYPTION_ENCODING_FUNCTIONS = [
56
57
  name: 'Base64Encode',
57
58
  supportedInCloudPage: true,
58
59
  supportedInEmail: true,
59
- mcnSince: null,
60
- handlebarsEquivalent: null,
60
+ mcnSince: 68,
61
+ handlebarsEquivalent: 'base64Encode',
62
+ handlebarsExact: false,
61
63
  mcnNotes: null,
62
64
  docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-utilities/mc-ampscript-reference-utilities-base64-encode.html',
63
65
  guideUrl: 'https://ampscript.guide/base64encode/',
@@ -299,8 +301,9 @@ export const ENCRYPTION_ENCODING_FUNCTIONS = [
299
301
  name: 'MD5',
300
302
  supportedInCloudPage: true,
301
303
  supportedInEmail: true,
302
- mcnSince: null,
303
- handlebarsEquivalent: null,
304
+ mcnSince: 68,
305
+ handlebarsEquivalent: 'md5',
306
+ handlebarsExact: false,
304
307
  mcnNotes: null,
305
308
  docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-encryption/mc-ampscript-reference-encryption-md5.html',
306
309
  guideUrl: 'https://ampscript.guide/md5/',
@@ -340,8 +343,9 @@ export const ENCRYPTION_ENCODING_FUNCTIONS = [
340
343
  name: 'SHA1',
341
344
  supportedInCloudPage: true,
342
345
  supportedInEmail: true,
343
- mcnSince: null,
344
- handlebarsEquivalent: null,
346
+ mcnSince: 68,
347
+ handlebarsEquivalent: 'sha1',
348
+ handlebarsExact: false,
345
349
  mcnNotes: null,
346
350
  docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-encryption/mc-ampscript-reference-encryption-sha1.html',
347
351
  guideUrl: 'https://ampscript.guide/sha1/',
@@ -381,8 +385,9 @@ export const ENCRYPTION_ENCODING_FUNCTIONS = [
381
385
  name: 'SHA256',
382
386
  supportedInCloudPage: true,
383
387
  supportedInEmail: true,
384
- mcnSince: null,
385
- handlebarsEquivalent: null,
388
+ mcnSince: 68,
389
+ handlebarsEquivalent: 'sha256',
390
+ handlebarsExact: false,
386
391
  mcnNotes: null,
387
392
  docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-encryption/mc-ampscript-reference-encryption-sha256.html',
388
393
  guideUrl: 'https://ampscript.guide/sha256/',
@@ -422,8 +427,9 @@ export const ENCRYPTION_ENCODING_FUNCTIONS = [
422
427
  name: 'SHA512',
423
428
  supportedInCloudPage: true,
424
429
  supportedInEmail: true,
425
- mcnSince: null,
426
- handlebarsEquivalent: null,
430
+ mcnSince: 68,
431
+ handlebarsEquivalent: 'sha512',
432
+ handlebarsExact: false,
427
433
  mcnNotes: null,
428
434
  docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-encryption/mc-ampscript-reference-encryption-sha512.html',
429
435
  guideUrl: 'https://ampscript.guide/sha512/',
@@ -463,8 +469,9 @@ export const ENCRYPTION_ENCODING_FUNCTIONS = [
463
469
  name: 'StringToHex',
464
470
  supportedInCloudPage: true,
465
471
  supportedInEmail: true,
466
- mcnSince: null,
467
- handlebarsEquivalent: null,
472
+ mcnSince: 68,
473
+ handlebarsEquivalent: 'stringToHex',
474
+ handlebarsExact: false,
468
475
  mcnNotes: null,
469
476
  docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-string/mc-ampscript-reference-string-to-hex.html',
470
477
  guideUrl: 'https://ampscript.guide/stringtohex/',
@@ -503,9 +510,11 @@ export const ENCRYPTION_ENCODING_FUNCTIONS = [
503
510
  name: 'URLEncode',
504
511
  supportedInCloudPage: true,
505
512
  supportedInEmail: true,
506
- mcnSince: null,
507
- handlebarsEquivalent: null,
508
- mcnNotes: null,
513
+ mcnSince: 68,
514
+ handlebarsEquivalent: 'encodeURIComponent',
515
+ handlebarsExact: false,
516
+ mcnNotes:
517
+ 'In Handlebars, encodeURIComponent encodes only what follows the address, such as a query string, which is what this function does by default; use encodeURI to encode a whole string. Neither helper takes the two switches of this function.',
509
518
  docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-http/mc-ampscript-reference-http-url-encode.html',
510
519
  guideUrl: 'https://ampscript.guide/urlencode/',
511
520
  minArgs: 1,
@@ -8,7 +8,7 @@ export const STRING_FUNCTIONS = [
8
8
  name: 'Char',
9
9
  supportedInCloudPage: true,
10
10
  supportedInEmail: true,
11
- mcnSince: null,
11
+ mcnSince: 68,
12
12
  handlebarsEquivalent: 'char',
13
13
  handlebarsExact: true,
14
14
  mcnNotes: null,
@@ -208,9 +208,11 @@ export const STRING_FUNCTIONS = [
208
208
  name: 'RegExMatch',
209
209
  supportedInCloudPage: true,
210
210
  supportedInEmail: true,
211
- mcnSince: null,
212
- handlebarsEquivalent: null,
213
- mcnNotes: null,
211
+ mcnSince: 68,
212
+ handlebarsEquivalent: 'regExMatch',
213
+ handlebarsExact: false,
214
+ mcnNotes:
215
+ 'MC Next uses a different regex engine that excludes .NET-only constructs. Options must be literal comma-separated text and can only be IgnoreCase, Multiline, Singleline, IgnorePatternWhitespace, or ExplicitCapture.',
214
216
  docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-string/mc-ampscript-reference-string-regex-match.html',
215
217
  guideUrl: 'https://ampscript.guide/regexmatch/',
216
218
  sfmcGuideUrl: 'https://sfmc.guide/engagement/ampscript/functions/regexmatch/',
@@ -244,8 +244,9 @@ export const UTILITY_FUNCTIONS = [
244
244
  name: 'Domain',
245
245
  supportedInCloudPage: true,
246
246
  supportedInEmail: true,
247
- mcnSince: null,
248
- handlebarsEquivalent: null,
247
+ mcnSince: 68,
248
+ handlebarsEquivalent: 'domain',
249
+ handlebarsExact: true,
249
250
  mcnNotes: null,
250
251
  docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-utilities/mc-ampscript-reference-utilities-domain.html',
251
252
  guideUrl: 'https://ampscript.guide/domain/',
@@ -461,8 +462,9 @@ export const UTILITY_FUNCTIONS = [
461
462
  name: 'GUID',
462
463
  supportedInCloudPage: true,
463
464
  supportedInEmail: true,
464
- mcnSince: null,
465
- handlebarsEquivalent: null,
465
+ mcnSince: 68,
466
+ handlebarsEquivalent: 'guid',
467
+ handlebarsExact: true,
466
468
  mcnNotes: null,
467
469
  docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-utilities/mc-ampscript-reference-utilities-guid.html',
468
470
  guideUrl: 'https://ampscript.guide/guid/',
@@ -559,8 +561,9 @@ export const UTILITY_FUNCTIONS = [
559
561
  name: 'IsEmailAddress',
560
562
  supportedInCloudPage: true,
561
563
  supportedInEmail: true,
562
- mcnSince: null,
563
- handlebarsEquivalent: null,
564
+ mcnSince: 68,
565
+ handlebarsEquivalent: 'isEmailAddress',
566
+ handlebarsExact: true,
564
567
  mcnNotes: null,
565
568
  docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-utilities/mc-ampscript-reference-utilities-is-email-address.html',
566
569
  guideUrl: 'https://ampscript.guide/isemailaddress/',
@@ -627,9 +630,9 @@ export const UTILITY_FUNCTIONS = [
627
630
  name: 'IsNullDefault',
628
631
  supportedInCloudPage: true,
629
632
  supportedInEmail: true,
630
- mcnSince: null,
631
- handlebarsEquivalent: 'fallback',
632
- handlebarsExact: false,
633
+ mcnSince: 68,
634
+ handlebarsEquivalent: 'isNullDefault',
635
+ handlebarsExact: true,
633
636
  mcnNotes: null,
634
637
  docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-sites/mc-ampscript-reference-sites-is-null-default.html',
635
638
  guideUrl: 'https://ampscript.guide/isnulldefault/',