ampscript-data 2.0.0 → 2.0.2

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.
Files changed (2) hide show
  1. package/package.json +1 -1
  2. package/src/index.js +24 -10
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ampscript-data",
3
- "version": "2.0.0",
3
+ "version": "2.0.2",
4
4
  "description": "Canonical AMPscript function catalog, keywords, and personalization strings for SFMC tooling",
5
5
  "type": "module",
6
6
  "main": "src/index.js",
package/src/index.js CHANGED
@@ -365,7 +365,7 @@ export const FUNCTIONS = [
365
365
  ],
366
366
  returnType: 'string',
367
367
  returnDescription: 'A URL that renders the requested barcode image.',
368
- syntax: 'BarcodeURL(valueToConvert, barcodeType, width, height, checksumValue, boolShowText, altText, rotation, boolTransparentBG)',
368
+ syntax: 'BarcodeURL(valueToConvert, barcodeType, width, height, checksumValue, showText, altText, rotation, transparentBG)',
369
369
  example: "%%=BarcodeURL('12345', 'qr', 150, 150, 0, 0, '', 0, 0)=%%",
370
370
  },
371
371
  {
@@ -795,7 +795,7 @@ export const FUNCTIONS = [
795
795
  returnType: 'string',
796
796
  returnDescription: 'The concatenation of all supplied values as a single string.',
797
797
  repeat: [{ startIndex: 0, groupSize: 1, minGroups: 2 }],
798
- syntax: 'Concat(string1, string2[, ...])',
798
+ syntax: 'Concat(string1, string2[, stringN, ...])',
799
799
  example: "%%=Concat('Hello', ' ', 'World')=%%",
800
800
  },
801
801
  {
@@ -857,7 +857,7 @@ export const FUNCTIONS = [
857
857
  syntax: 'ContentArea(contentAreaId[, impressionRegionName, errorOnMissingContentArea, errorMessage, statusCode])',
858
858
  example: '%%=ContentArea(12345)=%%',
859
859
  deprecated: true,
860
- deprecatedReplacement: 'ContentBlockById',
860
+ deprecatedReplacement: 'ContentBlockByID',
861
861
  deprecatedReason:
862
862
  'ContentArea references classic content areas, which are no longer supported. Use Content Builder content blocks instead.',
863
863
  },
@@ -1103,7 +1103,7 @@ export const FUNCTIONS = [
1103
1103
  mcnNotes: null,
1104
1104
  docUrl: 'https://developer.salesforce.com/docs/marketing/marketing-cloud-ampscript/references/mc-ampscript-content/mc-ampscript-reference-content-image-by-id.html',
1105
1105
  guideUrl: 'https://ampscript.guide/contentimagebyid/',
1106
- minArgs: 1,
1106
+ minArgs: 2,
1107
1107
  maxArgs: 2,
1108
1108
  category: 'Content',
1109
1109
  description: 'Returns the URL of a Content Builder image asset by its numeric ID.',
@@ -1423,12 +1423,24 @@ export const FUNCTIONS = [
1423
1423
  mcnNotes: null,
1424
1424
  description: 'The date part to extract from the string',
1425
1425
  type: 'string',
1426
- enum: ['Y', 'M', 'D', 'H', 'MI'],
1426
+ enum: [
1427
+ 'year',
1428
+ 'Y',
1429
+ 'month',
1430
+ 'M',
1431
+ 'monthName',
1432
+ 'day',
1433
+ 'D',
1434
+ 'hour',
1435
+ 'H',
1436
+ 'minute',
1437
+ 'MI',
1438
+ ],
1427
1439
  },
1428
1440
  ],
1429
- returnType: 'number',
1441
+ returnType: 'string',
1430
1442
  returnDescription:
1431
- 'The requested component of the date as a number (month name is returned as text).',
1443
+ 'The requested component of the date. Most parts return a numeric value as a string; `monthName` returns the full month name as text.',
1432
1444
  syntax: 'DatePart(dateString, datePart)',
1433
1445
  example: "%%=DatePart('2026-01-15', 'Y')=%%",
1434
1446
  },
@@ -2053,7 +2065,9 @@ export const FUNCTIONS = [
2053
2065
  maxArgs: 1,
2054
2066
  category: 'Social',
2055
2067
  description: 'Retrieves published social media content by its identifier.',
2056
- params: [{ name: 'socialContentId', description: 'Social content ID', type: 'string' }],
2068
+ params: [
2069
+ { name: 'socialContentId', description: 'Social content ID', type: 'string|number' },
2070
+ ],
2057
2071
  returnType: 'string',
2058
2072
  returnDescription: 'The published social content for the supplied identifier.',
2059
2073
  syntax: 'GetPublishedSocialContent(socialContentId)',
@@ -2100,7 +2114,7 @@ export const FUNCTIONS = [
2100
2114
  {
2101
2115
  name: 'socialNetworkCode',
2102
2116
  description: 'The number code of the social network to share to',
2103
- type: 'string',
2117
+ type: 'number',
2104
2118
  },
2105
2119
  {
2106
2120
  name: 'contentRegion',
@@ -2136,7 +2150,7 @@ export const FUNCTIONS = [
2136
2150
  returnDescription: 'HTML that publishes the social-forward content for the region.',
2137
2151
  repeat: [{ startIndex: 2, groupSize: 2, minGroups: 0 }],
2138
2152
  syntax: 'GetSocialPublishURL(socialNetworkCode, contentRegion[, socialNetworkParamKey1, socialNetworkParamValue1, ...])',
2139
- example: "%%=GetSocialPublishURL('1', 'Shared content region 1')=%%",
2153
+ example: "%%=GetSocialPublishURL(1, 'Shared content region 1')=%%",
2140
2154
  },
2141
2155
  {
2142
2156
  name: 'GetSocialPublishURLByName',