@contentstack/utils - npm Package Compare versions

Comparing version 1.6.3 to 1.7.0

dist/lib/assets/regions.json

@@ -35,3 +35,4 @@ {
                 "personalizeManagement": "https://personalize-api.contentstack.com",
-                "personalizeEdge": "https://personalize-edge.contentstack.com"
+                "personalizeEdge": "https://personalize-edge.contentstack.com",
+                "composableStudio": "https://composable-studio-api.contentstack.com"
             }
@@ -69,3 +70,4 @@ },
                 "personalizeManagement": "https://eu-personalize-api.contentstack.com",
-                "personalizeEdge": "https://eu-personalize-edge.contentstack.com"
+                "personalizeEdge": "https://eu-personalize-edge.contentstack.com",
+                "composableStudio": "https://eu-composable-studio-api.contentstack.com"
             }
@@ -103,3 +105,4 @@ },
                 "personalizeManagement": "https://au-personalize-api.contentstack.com",
-                "personalizeEdge": "https://au-personalize-edge.contentstack.com"
+                "personalizeEdge": "https://au-personalize-edge.contentstack.com",
+                "composableStudio": "https://au-composable-studio-api.contentstack.com"
             }
@@ -135,3 +138,4 @@ },
                 "personalizeManagement": "https://azure-na-personalize-api.contentstack.com",
-                "personalizeEdge": "https://azure-na-personalize-edge.contentstack.com"
+                "personalizeEdge": "https://azure-na-personalize-edge.contentstack.com",
+                "composableStudio": "https://azure-na-composable-studio-api.contentstack.com"
             }
@@ -167,3 +171,4 @@ },
                 "personalizeManagement": "https://azure-eu-personalize-api.contentstack.com",
-                "personalizeEdge": "https://azure-eu-personalize-edge.contentstack.com"
+                "personalizeEdge": "https://azure-eu-personalize-edge.contentstack.com",
+                "composableStudio": "https://azure-eu-composable-studio-api.contentstack.com"
             }
@@ -199,3 +204,4 @@ },
                 "personalizeManagement": "https://gcp-na-personalize-api.contentstack.com",
-                "personalizeEdge": "https://gcp-na-personalize-edge.contentstack.com"
+                "personalizeEdge": "https://gcp-na-personalize-edge.contentstack.com",
+                "composableStudio": "https://gcp-na-composable-studio-api.contentstack.com"
             }
@@ -231,3 +237,4 @@ },
                 "personalizeManagement": "https://gcp-eu-personalize-api.contentstack.com",
-                "personalizeEdge": "https://gcp-eu-personalize-edge.contentstack.com"
+                "personalizeEdge": "https://gcp-eu-personalize-edge.contentstack.com",
+                "composableStudio": "https://gcp-eu-composable-studio-api.contentstack.com"
             }
@@ -234,0 +241,0 @@ }

dist/lib/endpoints.js

 import regionsData from './assets/regions.json';
+/**
+ * Returns the Contentstack API endpoint(s) for a given region and optional service.
+ * Region can be an ID (e.g. `'us'`, `'eu'`) or an alias. Throws if the region is
+ * invalid or empty.
+ *
+ * @param region - Region ID or alias (e.g. `'us'`, `'eu'`). Default: `'us'`.
+ * @param service - Optional service name to return a single endpoint (e.g. `'delivery'`). If empty, returns all endpoints for the region.
+ * @param omitHttps - If true, strips the `https://` prefix from the returned URL(s). Default: false.
+ * @returns A single endpoint URL string if `service` is provided, otherwise the full endpoints object for the region.
+ * @throws Error if region is empty, invalid, or if the requested service is not found.
+ */
 export function getContentstackEndpoint(region, service, omitHttps) {
@@ -3,0 +14,0 @@ if (region === void 0) { region = 'us'; }

dist/lib/endpoints.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"endpoints.js","sourceRoot":"","sources":["../../src/endpoints.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,uBAAuB,CAAC;AAoBhD,MAAM,UAAU,uBAAuB,CAAC,MAAqB,EAAE,OAAoB,EAAE,SAA0B;IAAvE,uBAAA,EAAA,aAAqB;IAAE,wBAAA,EAAA,YAAoB;IAAE,0BAAA,EAAA,iBAA0B;IAC7G,8CAA8C;IAC9C,IAAI,MAAM,KAAK,EAAE,EAAE;QACjB,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;KACpE;IAED,IAAM,OAAO,GAAoB,WAA8B,CAAC;IAEhE,6BAA6B;IAC7B,IAAM,gBAAgB,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,IAAI,IAAI,CAAC;IAE7D,qCAAqC;IACrC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;QACnC,MAAM,IAAI,KAAK,CAAC,uEAAuE,CAAC,CAAC;KAC1F;IAED,iCAAiC;IACjC,IAAM,UAAU,GAAG,qBAAqB,CAAC,OAAO,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;IAE5E,IAAI,CAAC,UAAU,EAAE;QACf,MAAM,IAAI,KAAK,CAAC,0BAAmB,MAAM,CAAE,CAAC,CAAC;KAC9C;IAED,sBAAsB;IACtB,IAAI,OAAO,EAAE;QACX,mCAAmC;QACnC,IAAM,QAAQ,GAAG,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAE/C,IAAI,CAAC,QAAQ,EAAE;YACb,MAAM,IAAI,KAAK,CAAC,oBAAY,OAAO,uCAA2B,UAAU,CAAC,EAAE,OAAG,CAAC,CAAC;SACjF;QACD,OAAO,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;KACpD;SAAM;QACL,OAAO,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,SAAS,CAAC;KAC5E;AACH,CAAC;AAED,SAAS,qBAAqB,CAAC,OAAqB,EAAE,WAAmB;IACvE,sCAAsC;IACtC,IAAI,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,UAAA,CAAC,IAAI,OAAA,CAAC,CAAC,EAAE,KAAK,WAAW,EAApB,CAAoB,CAAC,CAAC;IACrD,IAAI,MAAM,EAAE;QACV,OAAO,MAAM,CAAC;KACf;IAED,4BAA4B;IAC5B,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,UAAA,CAAC;QACrB,OAAA,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,UAAA,KAAK,IAAI,OAAA,KAAK,CAAC,WAAW,EAAE,KAAK,WAAW,CAAC,WAAW,EAAE,EAAjD,CAAiD,CAAC;IAAxE,CAAwE,CACzE,CAAC;IAEF,OAAO,MAAM,IAAI,IAAI,CAAC;AACxB,CAAC;AAED,SAAS,UAAU,CAAC,QAAwC;IAC1D,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE;QAChC,OAAO,QAAQ,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;KAC7C;SAAM;QACL,IAAM,MAAM,GAA0B,EAAE,CAAC;QACzC,KAAK,IAAM,GAAG,IAAI,QAAQ,EAAE;YAC1B,MAAM,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;SACzC;QACD,OAAO,MAAM,CAAC;KACf;AACH,CAAC"}
+{"version":3,"file":"endpoints.js","sourceRoot":"","sources":["../../src/endpoints.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,uBAAuB,CAAC;AAoBhD;;;;;;;;;;GAUG;AACH,MAAM,UAAU,uBAAuB,CAAC,MAAqB,EAAE,OAAoB,EAAE,SAA0B;IAAvE,uBAAA,EAAA,aAAqB;IAAE,wBAAA,EAAA,YAAoB;IAAE,0BAAA,EAAA,iBAA0B;IAC7G,8CAA8C;IAC9C,IAAI,MAAM,KAAK,EAAE,EAAE;QACjB,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;KACpE;IAED,IAAM,OAAO,GAAoB,WAA8B,CAAC;IAEhE,6BAA6B;IAC7B,IAAM,gBAAgB,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,IAAI,IAAI,CAAC;IAE7D,qCAAqC;IACrC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;QACnC,MAAM,IAAI,KAAK,CAAC,uEAAuE,CAAC,CAAC;KAC1F;IAED,iCAAiC;IACjC,IAAM,UAAU,GAAG,qBAAqB,CAAC,OAAO,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;IAE5E,IAAI,CAAC,UAAU,EAAE;QACf,MAAM,IAAI,KAAK,CAAC,0BAAmB,MAAM,CAAE,CAAC,CAAC;KAC9C;IAED,sBAAsB;IACtB,IAAI,OAAO,EAAE;QACX,mCAAmC;QACnC,IAAM,QAAQ,GAAG,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAE/C,IAAI,CAAC,QAAQ,EAAE;YACb,MAAM,IAAI,KAAK,CAAC,oBAAY,OAAO,uCAA2B,UAAU,CAAC,EAAE,OAAG,CAAC,CAAC;SACjF;QACD,OAAO,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;KACpD;SAAM;QACL,OAAO,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,SAAS,CAAC;KAC5E;AACH,CAAC;AAED,SAAS,qBAAqB,CAAC,OAAqB,EAAE,WAAmB;IACvE,sCAAsC;IACtC,IAAI,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,UAAA,CAAC,IAAI,OAAA,CAAC,CAAC,EAAE,KAAK,WAAW,EAApB,CAAoB,CAAC,CAAC;IACrD,IAAI,MAAM,EAAE;QACV,OAAO,MAAM,CAAC;KACf;IAED,4BAA4B;IAC5B,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,UAAA,CAAC;QACrB,OAAA,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,UAAA,KAAK,IAAI,OAAA,KAAK,CAAC,WAAW,EAAE,KAAK,WAAW,CAAC,WAAW,EAAE,EAAjD,CAAiD,CAAC;IAAxE,CAAwE,CACzE,CAAC;IAEF,OAAO,MAAM,IAAI,IAAI,CAAC;AACxB,CAAC;AAED,SAAS,UAAU,CAAC,QAAwC;IAC1D,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE;QAChC,OAAO,QAAQ,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;KAC7C;SAAM;QACL,IAAM,MAAM,GAA0B,EAAE,CAAC;QACzC,KAAK,IAAM,GAAG,IAAI,QAAQ,EAAE;YAC1B,MAAM,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;SACzC;QACD,OAAO,MAAM,CAAC;KACf;AACH,CAAC"}

dist/lib/entry-editable.js

@@ -1,8 +0,22 @@
-export function addTags(entry, contentTypeUid, tagsAsObject, locale) {
+/**
+ * Adds Contentstack Live Preview (CSLP) data tags to an entry for editable UIs.
+ * Mutates the entry by attaching a `$` property with tag strings or objects
+ * (e.g. `data-cslp` / `data-cslp-parent-field`) for each field, including nested
+ * objects and references. Supports variant-aware tagging when the entry has
+ * applied variants.
+ *
+ * @param entry - The entry (EmbeddedItem) to tag. Must have uid and optional system/applied variants.
+ * @param contentTypeUid - Content type UID (e.g. `blog_post`). Used as part of the tag path.
+ * @param tagsAsObject - If true, tags are stored as objects (e.g. `{ "data-cslp": "..." }`); if false, as strings (e.g. `data-cslp=...`).
+ * @param locale - Locale code for the tag path (default: `'en-us'`).
+ * @param options.useLowerCaseLocale - Optional boolean to make locale case-insensitive.
+ */
+export function addTags(entry, contentTypeUid, tagsAsObject, locale, options) {
     var _a;
     if (locale === void 0) { locale = 'en-us'; }
+    var _b = (options || {}).useLowerCaseLocale, useLowerCaseLocale = _b === void 0 ? true : _b;
     if (entry) {
         // handle case senstivity for contentTypeUid and locale
         contentTypeUid = contentTypeUid.toLowerCase();
-        locale = locale.toLowerCase();
+        locale = useLowerCaseLocale ? locale.toLowerCase() : locale;
         var appliedVariants = entry._applied_variants || ((_a = entry === null || entry === void 0 ? void 0 : entry.system) === null || _a === void 0 ? void 0 : _a.applied_variants) || null;
@@ -9,0 +23,0 @@ entry.$ = getTag(entry, "".concat(contentTypeUid, ".").concat(entry.uid, ".").concat(locale), tagsAsObject, locale, { _applied_variants: appliedVariants, shouldApplyVariant: !!appliedVariants, metaKey: '' });

dist/lib/entry-editable.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"entry-editable.js","sourceRoot":"","sources":["../../src/entry-editable.ts"],"names":[],"mappings":"AAQA,MAAM,UAAU,OAAO,CAAC,KAAiB,EAAE,cAAsB,EAAE,YAAqB,EAAE,MAAwB;;IAAxB,uBAAA,EAAA,gBAAwB;IAC9G,IAAI,KAAK,EAAE;QACP,uDAAuD;QACvD,cAAc,GAAG,cAAc,CAAC,WAAW,EAAE,CAAC;QAC9C,MAAM,GAAG,MAAM,CAAC,WAAW,EAAE,CAAC;QAE9B,IAAM,eAAe,GAAG,KAAK,CAAC,iBAAiB,KAAI,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,MAAM,0CAAE,gBAAgB,CAAA,IAAI,IAAI,CAAC;QAC3F,KAAK,CAAC,CAAC,GAAG,MAAM,CAAC,KAAK,EAAE,UAAG,cAAc,cAAI,KAAK,CAAC,GAAG,cAAI,MAAM,CAAE,EAAE,YAAY,EAAE,MAAM,EAAE,EAAE,iBAAiB,EAAE,eAAe,EAAE,kBAAkB,EAAE,CAAC,CAAC,eAAe,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAA;KACxL;AACL,CAAC;AAED,SAAS,MAAM,CAAC,OAAe,EAAE,MAAc,EAAE,YAAqB,EAAE,MAAc,EAAE,eAAgC;IACpH,IAAM,IAAI,GAAQ,EAAE,CAAA;IACZ,IAAA,OAAO,GAA4C,eAAe,QAA3D,EAAE,kBAAkB,GAAwB,eAAe,mBAAvC,EAAE,iBAAiB,GAAK,eAAe,kBAApB,CAAoB;IAC1E,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,UAAC,EAAY;YAAX,GAAG,QAAA,EAAE,KAAK,QAAA;QACxC,IAAI,GAAG,KAAK,GAAG;YAAE,OAAM;QACvB,IAAI,OAAO,GAAG,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,SAAS,IAAI,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QACxI,IAAI,cAAc,GAAG,eAAe,CAAC,kBAAkB,CAAC,CAAC,CAAC,UAAG,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC,OAAO,GAAG,GAAG,CAAC,CAAC,CAAC,EAAE,SAAG,GAAG,CAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACvI,IAAI,OAAO,IAAI,cAAc;YAAE,cAAc,GAAG,cAAc,GAAG,GAAG,GAAG,OAAO,CAAC;QAC/E,QAAQ,OAAO,KAAK,EAAE;YAClB,KAAK,QAAQ;gBACT,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;oBACtB,KAAK,CAAC,OAAO,CAAC,UAAC,GAAG,EAAE,KAAK;;wBACrB,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,SAAS,EAAE;4BACnC,OAAO;yBACV;wBACD,IAAM,QAAQ,GAAG,UAAG,GAAG,eAAK,KAAK,CAAE,CAAA;wBACnC,IAAM,SAAS,GAAG,UAAG,GAAG,aAAU,CAAA;wBAClC,OAAO,GAAG,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,CAAC,SAAS,IAAI,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;wBAC5H,cAAc,GAAG,eAAe,CAAC,kBAAkB,CAAC,CAAC,CAAC,UAAG,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC,OAAO,GAAG,GAAG,CAAC,CAAC,CAAC,EAAE,SAAG,GAAG,CAAE,CAAC,CAAC,CAAC,EAAE,CAAC;wBACnI,IAAI,OAAO,IAAI,cAAc;4BAAE,cAAc,GAAG,cAAc,GAAG,GAAG,GAAG,OAAO,CAAC;wBAC/E;;;;;;;;;;2BAUG;wBACH,IAAI,CAAC,QAAQ,CAAC,GAAG,YAAY,CAAC,UAAG,MAAM,cAAI,GAAG,cAAI,KAAK,CAAE,EAAE,YAAY,EAAE,EAAE,iBAAiB,mBAAA,EAAE,kBAAkB,oBAAA,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC,CAAA;wBAC5I,IAAI,CAAC,SAAS,CAAC,GAAG,kBAAkB,CAAC,UAAG,MAAM,cAAI,GAAG,CAAE,EAAE,YAAY,CAAC,CAAA;wBACtE,IAAI,OAAO,GAAG,KAAK,WAAW,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,CAAC,iBAAiB,KAAK,SAAS,IAAI,GAAG,CAAC,GAAG,KAAK,SAAS,EAAE;4BAC5G;;;;;;;;;;+BAUG;4BACH,IAAM,kBAAkB,GAAG,GAAG,CAAC,iBAAiB,KAAI,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,MAAM,0CAAE,gBAAgB,CAAA,IAAI,IAAI,CAAA,CAAC,0HAA0H;4BACpN,IAAM,qBAAqB,GAAG,CAAC,CAAC,kBAAkB,CAAA;4BAClD,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,GAAG,EAAE,UAAG,GAAG,CAAC,iBAAiB,cAAI,GAAG,CAAC,GAAG,cAAI,GAAG,CAAC,MAAM,IAAI,MAAM,CAAE,EAAE,YAAY,EAAE,MAAM,EAAE,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAA;yBACvN;6BAAM,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;4BAChC;;;;;;;;+BAQG;4BACH,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,GAAG,EAAE,UAAG,MAAM,cAAI,GAAG,cAAI,KAAK,CAAE,EAAE,YAAY,EAAE,MAAM,EAAE,EAAE,iBAAiB,mBAAA,EAAE,kBAAkB,oBAAA,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC,CAAA;yBAC7I;oBACL,CAAC,CAAC,CAAA;iBACL;qBAAM;oBACH,IAAI,KAAK,EAAE;wBACP;;;;;;;;;;2BAUG;wBACH,KAAK,CAAC,CAAC,GAAG,MAAM,CAAC,KAAK,EAAE,UAAG,MAAM,cAAI,GAAG,CAAE,EAAE,YAAY,EAAE,MAAM,EAAE,EAAE,iBAAiB,mBAAA,EAAE,kBAAkB,oBAAA,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC,CAAA;qBACxI;iBACJ;gBACD;;;;;;;;;;;mBAWG;gBAEH,IAAI,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC,UAAG,MAAM,cAAI,GAAG,CAAE,EAAE,YAAY,EAAE,EAAE,iBAAiB,mBAAA,EAAE,kBAAkB,oBAAA,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC,CAAA;gBAC9H,MAAM;YACV;gBACI;;;;;;mBAMG;gBACH,IAAI,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC,UAAG,MAAM,cAAI,GAAG,CAAE,EAAE,YAAY,EAAE,EAAE,iBAAiB,mBAAA,EAAE,kBAAkB,oBAAA,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC,CAAA;SACrI;IACL,CAAC,CAAC,CAAA;IACF,OAAO,IAAI,CAAA;AACf,CAAC;AAED,SAAS,YAAY,CAAC,SAAiB,EAAE,YAAqB,EAAE,eAA4G;IACxK,IAAI,eAAe,CAAC,kBAAkB,IAAI,eAAe,CAAC,iBAAiB,EAAE;QAC3E,IAAM,kBAAkB,GAAG,eAAe,CAAC,iBAAiB,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;QACtF,IAAG,kBAAkB,EAAE;YACrB,IAAM,OAAO,GAAG,eAAe,CAAC,iBAAiB,CAAC,eAAe,CAAC,OAAO,CAAC,CAAA;YAC1E,mHAAmH;YACnH,IAAM,iBAAiB,GAAG,CAAC,KAAK,GAAG,SAAS,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACzD,iBAAiB,CAAC,CAAC,CAAC,GAAG,iBAAiB,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,OAAO,CAAC;YAC5D,SAAS,GAAG,iBAAiB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SACzC;aACI;YACH,IAAM,qBAAqB,GAAG,wBAAwB,CAAC,eAAe,CAAC,CAAC;YACxE,IAAG,qBAAqB,EAAE;gBACxB,IAAM,OAAO,GAAG,eAAe,CAAC,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;gBACzE,IAAM,iBAAiB,GAAG,CAAC,KAAK,GAAG,SAAS,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBACzD,iBAAiB,CAAC,CAAC,CAAC,GAAG,iBAAiB,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,OAAO,CAAC;gBAC5D,SAAS,GAAG,iBAAiB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aACzC;SACF;KACF;IACD,IAAI,YAAY,EAAE;QACd,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC;KACrC;SAAM;QACH,OAAO,oBAAa,SAAS,CAAE,CAAC;KACnC;AACL,CAAC;AAED,SAAS,kBAAkB,CAAC,SAAiB,EAAE,YAAqB;IAChE,IAAI,YAAY,EAAE;QACd,OAAO,EAAE,wBAAwB,EAAE,SAAS,EAAE,CAAC;KAClD;SAAM;QACH,OAAO,iCAA0B,SAAS,CAAE,CAAC;KAChD;AACL,CAAC;AAED,SAAS,wBAAwB,CAAC,eAAgC;;IAC9D,IAAI;QACA,kBAAkB;QAClB,IAAG,CAAC,eAAe,CAAC,iBAAiB;YAAE,OAAO,EAAE,CAAC;QACjD,IAAM,qBAAqB,GAAG,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAAC,IAAI,CAAC,UAAC,CAAC,EAAE,CAAC;YACnF,OAAO,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC;QAC/B,CAAC,CAAC,CAAC;QACH,IAAM,oBAAkB,GAAG,eAAe,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC9D,kBAAkB;QAClB,IAAG,oBAAkB,CAAC,MAAM,KAAK,CAAC,IAAI,qBAAqB,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,EAAE,CAAC;QACpF,IAAM,qBAAqB,GAAG,MAAA,qBAAqB,CAAC,IAAI,CAAC,UAAA,IAAI;YACzD,IAAM,eAAe,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACxC,IAAG,eAAe,CAAC,MAAM,GAAG,oBAAkB,CAAC,MAAM;gBAAE,OAAO,KAAK,CAAC;YACpE,OAAO,eAAe,CAAC,KAAK,CAAC,UAAC,QAAQ,EAAE,KAAK,IAAK,OAAA,oBAAkB,CAAC,KAAK,CAAC,KAAK,QAAQ,EAAtC,CAAsC,CAAC,CAAC;QAC9F,CAAC,CAAC,mCAAI,EAAE,CAAC;QACT,OAAO,qBAAqB,CAAC;KAChC;IACD,OAAM,CAAC,EAAE;QACL,OAAO,EAAE,CAAC;KACb;AACL,CAAC"}
+{"version":3,"file":"entry-editable.js","sourceRoot":"","sources":["../../src/entry-editable.ts"],"names":[],"mappings":"AAQA;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,OAAO,CAAC,KAAiB,EAAE,cAAsB,EAAE,YAAqB,EAAE,MAAwB,EAAE,OAEnH;;IAFyF,uBAAA,EAAA,gBAAwB;IAGtG,IAAA,KAA8B,CAAA,OAAO,IAAI,EAAE,CAAA,mBAAlB,EAAzB,kBAAkB,mBAAG,IAAI,KAAA,CAAmB;IACpD,IAAI,KAAK,EAAE;QACP,uDAAuD;QACvD,cAAc,GAAG,cAAc,CAAC,WAAW,EAAE,CAAC;QAC9C,MAAM,GAAG,kBAAkB,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC;QAE5D,IAAM,eAAe,GAAG,KAAK,CAAC,iBAAiB,KAAI,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,MAAM,0CAAE,gBAAgB,CAAA,IAAI,IAAI,CAAC;QAC3F,KAAK,CAAC,CAAC,GAAG,MAAM,CAAC,KAAK,EAAE,UAAG,cAAc,cAAI,KAAK,CAAC,GAAG,cAAI,MAAM,CAAE,EAAE,YAAY,EAAE,MAAM,EAAE,EAAE,iBAAiB,EAAE,eAAe,EAAE,kBAAkB,EAAE,CAAC,CAAC,eAAe,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAA;KACxL;AACL,CAAC;AAED,SAAS,MAAM,CAAC,OAAe,EAAE,MAAc,EAAE,YAAqB,EAAE,MAAc,EAAE,eAAgC;IACpH,IAAM,IAAI,GAAQ,EAAE,CAAA;IACZ,IAAA,OAAO,GAA4C,eAAe,QAA3D,EAAE,kBAAkB,GAAwB,eAAe,mBAAvC,EAAE,iBAAiB,GAAK,eAAe,kBAApB,CAAoB;IAC1E,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,UAAC,EAAY;YAAX,GAAG,QAAA,EAAE,KAAK,QAAA;QACxC,IAAI,GAAG,KAAK,GAAG;YAAE,OAAM;QACvB,IAAI,OAAO,GAAG,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,SAAS,IAAI,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QACxI,IAAI,cAAc,GAAG,eAAe,CAAC,kBAAkB,CAAC,CAAC,CAAC,UAAG,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC,OAAO,GAAG,GAAG,CAAC,CAAC,CAAC,EAAE,SAAG,GAAG,CAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACvI,IAAI,OAAO,IAAI,cAAc;YAAE,cAAc,GAAG,cAAc,GAAG,GAAG,GAAG,OAAO,CAAC;QAC/E,QAAQ,OAAO,KAAK,EAAE;YAClB,KAAK,QAAQ;gBACT,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;oBACtB,KAAK,CAAC,OAAO,CAAC,UAAC,GAAG,EAAE,KAAK;;wBACrB,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,SAAS,EAAE;4BACnC,OAAO;yBACV;wBACD,IAAM,QAAQ,GAAG,UAAG,GAAG,eAAK,KAAK,CAAE,CAAA;wBACnC,IAAM,SAAS,GAAG,UAAG,GAAG,aAAU,CAAA;wBAClC,OAAO,GAAG,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,CAAC,SAAS,IAAI,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;wBAC5H,cAAc,GAAG,eAAe,CAAC,kBAAkB,CAAC,CAAC,CAAC,UAAG,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC,OAAO,GAAG,GAAG,CAAC,CAAC,CAAC,EAAE,SAAG,GAAG,CAAE,CAAC,CAAC,CAAC,EAAE,CAAC;wBACnI,IAAI,OAAO,IAAI,cAAc;4BAAE,cAAc,GAAG,cAAc,GAAG,GAAG,GAAG,OAAO,CAAC;wBAC/E;;;;;;;;;;2BAUG;wBACH,IAAI,CAAC,QAAQ,CAAC,GAAG,YAAY,CAAC,UAAG,MAAM,cAAI,GAAG,cAAI,KAAK,CAAE,EAAE,YAAY,EAAE,EAAE,iBAAiB,mBAAA,EAAE,kBAAkB,oBAAA,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC,CAAA;wBAC5I,IAAI,CAAC,SAAS,CAAC,GAAG,kBAAkB,CAAC,UAAG,MAAM,cAAI,GAAG,CAAE,EAAE,YAAY,CAAC,CAAA;wBACtE,IAAI,OAAO,GAAG,KAAK,WAAW,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,CAAC,iBAAiB,KAAK,SAAS,IAAI,GAAG,CAAC,GAAG,KAAK,SAAS,EAAE;4BAC5G;;;;;;;;;;+BAUG;4BACH,IAAM,kBAAkB,GAAG,GAAG,CAAC,iBAAiB,KAAI,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,MAAM,0CAAE,gBAAgB,CAAA,IAAI,IAAI,CAAA,CAAC,0HAA0H;4BACpN,IAAM,qBAAqB,GAAG,CAAC,CAAC,kBAAkB,CAAA;4BAClD,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,GAAG,EAAE,UAAG,GAAG,CAAC,iBAAiB,cAAI,GAAG,CAAC,GAAG,cAAI,GAAG,CAAC,MAAM,IAAI,MAAM,CAAE,EAAE,YAAY,EAAE,MAAM,EAAE,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAA;yBACvN;6BAAM,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;4BAChC;;;;;;;;+BAQG;4BACH,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,GAAG,EAAE,UAAG,MAAM,cAAI,GAAG,cAAI,KAAK,CAAE,EAAE,YAAY,EAAE,MAAM,EAAE,EAAE,iBAAiB,mBAAA,EAAE,kBAAkB,oBAAA,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC,CAAA;yBAC7I;oBACL,CAAC,CAAC,CAAA;iBACL;qBAAM;oBACH,IAAI,KAAK,EAAE;wBACP;;;;;;;;;;2BAUG;wBACH,KAAK,CAAC,CAAC,GAAG,MAAM,CAAC,KAAK,EAAE,UAAG,MAAM,cAAI,GAAG,CAAE,EAAE,YAAY,EAAE,MAAM,EAAE,EAAE,iBAAiB,mBAAA,EAAE,kBAAkB,oBAAA,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC,CAAA;qBACxI;iBACJ;gBACD;;;;;;;;;;;mBAWG;gBAEH,IAAI,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC,UAAG,MAAM,cAAI,GAAG,CAAE,EAAE,YAAY,EAAE,EAAE,iBAAiB,mBAAA,EAAE,kBAAkB,oBAAA,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC,CAAA;gBAC9H,MAAM;YACV;gBACI;;;;;;mBAMG;gBACH,IAAI,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC,UAAG,MAAM,cAAI,GAAG,CAAE,EAAE,YAAY,EAAE,EAAE,iBAAiB,mBAAA,EAAE,kBAAkB,oBAAA,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC,CAAA;SACrI;IACL,CAAC,CAAC,CAAA;IACF,OAAO,IAAI,CAAA;AACf,CAAC;AAED,SAAS,YAAY,CAAC,SAAiB,EAAE,YAAqB,EAAE,eAA4G;IACxK,IAAI,eAAe,CAAC,kBAAkB,IAAI,eAAe,CAAC,iBAAiB,EAAE;QAC3E,IAAM,kBAAkB,GAAG,eAAe,CAAC,iBAAiB,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;QACtF,IAAG,kBAAkB,EAAE;YACrB,IAAM,OAAO,GAAG,eAAe,CAAC,iBAAiB,CAAC,eAAe,CAAC,OAAO,CAAC,CAAA;YAC1E,mHAAmH;YACnH,IAAM,iBAAiB,GAAG,CAAC,KAAK,GAAG,SAAS,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACzD,iBAAiB,CAAC,CAAC,CAAC,GAAG,iBAAiB,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,OAAO,CAAC;YAC5D,SAAS,GAAG,iBAAiB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SACzC;aACI;YACH,IAAM,qBAAqB,GAAG,wBAAwB,CAAC,eAAe,CAAC,CAAC;YACxE,IAAG,qBAAqB,EAAE;gBACxB,IAAM,OAAO,GAAG,eAAe,CAAC,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;gBACzE,IAAM,iBAAiB,GAAG,CAAC,KAAK,GAAG,SAAS,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBACzD,iBAAiB,CAAC,CAAC,CAAC,GAAG,iBAAiB,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,OAAO,CAAC;gBAC5D,SAAS,GAAG,iBAAiB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aACzC;SACF;KACF;IACD,IAAI,YAAY,EAAE;QACd,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC;KACrC;SAAM;QACH,OAAO,oBAAa,SAAS,CAAE,CAAC;KACnC;AACL,CAAC;AAED,SAAS,kBAAkB,CAAC,SAAiB,EAAE,YAAqB;IAChE,IAAI,YAAY,EAAE;QACd,OAAO,EAAE,wBAAwB,EAAE,SAAS,EAAE,CAAC;KAClD;SAAM;QACH,OAAO,iCAA0B,SAAS,CAAE,CAAC;KAChD;AACL,CAAC;AAED,SAAS,wBAAwB,CAAC,eAAgC;;IAC9D,IAAI;QACA,kBAAkB;QAClB,IAAG,CAAC,eAAe,CAAC,iBAAiB;YAAE,OAAO,EAAE,CAAC;QACjD,IAAM,qBAAqB,GAAG,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAAC,IAAI,CAAC,UAAC,CAAC,EAAE,CAAC;YACnF,OAAO,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC;QAC/B,CAAC,CAAC,CAAC;QACH,IAAM,oBAAkB,GAAG,eAAe,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC9D,kBAAkB;QAClB,IAAG,oBAAkB,CAAC,MAAM,KAAK,CAAC,IAAI,qBAAqB,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,EAAE,CAAC;QACpF,IAAM,qBAAqB,GAAG,MAAA,qBAAqB,CAAC,IAAI,CAAC,UAAA,IAAI;YACzD,IAAM,eAAe,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACxC,IAAG,eAAe,CAAC,MAAM,GAAG,oBAAkB,CAAC,MAAM;gBAAE,OAAO,KAAK,CAAC;YACpE,OAAO,eAAe,CAAC,KAAK,CAAC,UAAC,QAAQ,EAAE,KAAK,IAAK,OAAA,oBAAkB,CAAC,KAAK,CAAC,KAAK,QAAQ,EAAtC,CAAsC,CAAC,CAAC;QAC9F,CAAC,CAAC,mCAAI,EAAE,CAAC;QACT,OAAO,qBAAqB,CAAC;KAChC;IACD,OAAM,CAAC,EAAE;QACL,OAAO,EAAE,CAAC;KACb;AACL,CAAC"}

dist/lib/gql.js

@@ -33,5 +33,20 @@ import { findRenderContent } from './helper/find-render-content';
 }
+/**
+ * GraphQL API utilities for Contentstack. Provides methods to work with
+ * content fetched via the GraphQL API, including rendering Supercharged RTE
+ * (JSON) with embedded items from the GQL response.
+ */
 export var GQL = {
+    /**
+     * Converts Supercharged RTE (JSON) content to HTML for entries from a GraphQL response.
+     * Uses `embedded_itemsConnection.edges` to resolve embedded items. Mutates the entry
+     * JSON in-place by replacing JSON RTE content with the generated HTML.
+     *
+     * @param option - Configuration for conversion.
+     * @param option.entry - Entry or array of entries (EmbeddedItem) from a GQL response with JSON RTE and embedded_itemsConnection.
+     * @param option.paths - Key paths to the JSON RTE fields on the entry.
+     * @param option.renderOption - Optional render options to customize how nodes and embedded items are rendered to HTML.
+     */
     jsonToHTML: jsonToHTML
 };
 //# sourceMappingURL=gql.js.map

dist/lib/gql.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"gql.js","sourceRoot":"","sources":["../../src/gql.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AAEpE,OAAO,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAI1E,SAAS,UAAU,CAAC,MAInB;IACG,IAAI,MAAM,CAAC,KAAK,YAAY,KAAK,EAAE;QAC/B,SAAS,CAAC,MAAM,CAAC,KAAK,EAAE,UAAC,KAAmB;YACxC,UAAU,CAAC,EAAC,KAAK,OAAA,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,YAAY,EAAE,MAAM,CAAC,YAAY,EAAC,CAAC,CAAA;QAC/E,CAAC,CAAC,CAAA;KACL;SAAM;QACH,aAAa,CAAC;YACV,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,YAAY,EAAE,MAAM,CAAC,YAAY;SACpC,CAAC,CAAA;KACL;AACL,CAAC;AAED,SAAS,aAAa,CAAC,MAItB;IACG,KAAkB,UAAY,EAAZ,KAAA,MAAM,CAAC,KAAK,EAAZ,cAAY,EAAZ,IAAY,EAAE;QAA3B,IAAM,GAAG,SAAA;QACV,iBAAiB,CAAC,GAAG,EACjB,MAAM,CAAC,KAAK,EACZ,CAAC,UAAC,OAAgB;YAClB,IAAI,OAAO,IAAI,OAAO,CAAC,IAAI,EAAE;gBACzB,IAAM,KAAK,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAAC,CAAC,OAAO,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAA;gBAC5F,IAAM,OAAK,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,UAAC,WAAW,EAAE,KAAK,IAAK,OAAA,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAA9B,CAA8B,EAAE,EAAE,CAAC,CAAA;gBAC3G,OAAO,iBAAiB,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,YAAY,EAAE,UAAC,QAAkB;oBAC3E,OAAO,oBAAoB,CAAC,QAAQ,EAAE,OAAK,CAAC,CAAC,CAAC,CAAC,CAAA;gBACnD,CAAC,CAAC,CAAA;aACL;YACD,OAAO,OAA4B,CAAA;QACvC,CAAC,CAAC,CAAC,CAAA;KACN;AACL,CAAC;AACD,MAAM,CAAC,IAAM,GAAG,GAAG;IACf,UAAU,YAAA;CACb,CAAA"}
+{"version":3,"file":"gql.js","sourceRoot":"","sources":["../../src/gql.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AAEpE,OAAO,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAI1E,SAAS,UAAU,CAAC,MAInB;IACG,IAAI,MAAM,CAAC,KAAK,YAAY,KAAK,EAAE;QAC/B,SAAS,CAAC,MAAM,CAAC,KAAK,EAAE,UAAC,KAAmB;YACxC,UAAU,CAAC,EAAC,KAAK,OAAA,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,YAAY,EAAE,MAAM,CAAC,YAAY,EAAC,CAAC,CAAA;QAC/E,CAAC,CAAC,CAAA;KACL;SAAM;QACH,aAAa,CAAC;YACV,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,YAAY,EAAE,MAAM,CAAC,YAAY;SACpC,CAAC,CAAA;KACL;AACL,CAAC;AAED,SAAS,aAAa,CAAC,MAItB;IACG,KAAkB,UAAY,EAAZ,KAAA,MAAM,CAAC,KAAK,EAAZ,cAAY,EAAZ,IAAY,EAAE;QAA3B,IAAM,GAAG,SAAA;QACV,iBAAiB,CAAC,GAAG,EACjB,MAAM,CAAC,KAAK,EACZ,CAAC,UAAC,OAAgB;YAClB,IAAI,OAAO,IAAI,OAAO,CAAC,IAAI,EAAE;gBACzB,IAAM,KAAK,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAAC,CAAC,OAAO,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAA;gBAC5F,IAAM,OAAK,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,UAAC,WAAW,EAAE,KAAK,IAAK,OAAA,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAA9B,CAA8B,EAAE,EAAE,CAAC,CAAA;gBAC3G,OAAO,iBAAiB,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,YAAY,EAAE,UAAC,QAAkB;oBAC3E,OAAO,oBAAoB,CAAC,QAAQ,EAAE,OAAK,CAAC,CAAC,CAAC,CAAC,CAAA;gBACnD,CAAC,CAAC,CAAA;aACL;YACD,OAAO,OAA4B,CAAA;QACvC,CAAC,CAAC,CAAC,CAAA;KACN;AACL,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,IAAM,GAAG,GAAG;IACf;;;;;;;;;OASG;IACH,UAAU,YAAA;CACb,CAAA"}

dist/lib/json-to-html.js

 import { findRenderContent } from './helper/find-render-content';
 import { findEmbeddedItems } from './helper/find-embeded-object';
 import { enumerate, enumerateContents } from './helper/enumerate-entries';
+/**
+ * Converts Supercharged RTE (JSON) content to HTML for one or more entries.
+ * Walks the given paths on each entry, finds JSON RTE content, resolves embedded
+ * items from the entry, and renders nodes using the optional renderOption. Mutates
+ * the entry JSON in-place by replacing content with the generated HTML.
+ *
+ * @param option - Configuration for conversion.
+ * @param option.entry - Entry or array of entries that contain Supercharged RTE (JSON) fields.
+ * @param option.paths - Key paths to the JSON RTE fields (e.g. `['rte_field_uid', 'group.rte_uid']`).
+ * @param option.renderOption - Optional render options to customize how nodes and embedded items are rendered to HTML.
+ */
 export function jsonToHTML(option) {
@@ -5,0 +16,0 @@ if (option.entry instanceof Array) {

dist/lib/json-to-html.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"json-to-html.js","sourceRoot":"","sources":["../../src/json-to-html.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAEjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAI1E,MAAM,UAAU,UAAU,CAAC,MAI1B;IACG,IAAI,MAAM,CAAC,KAAK,YAAY,KAAK,EAAE;QAC/B,SAAS,CAAC,MAAM,CAAC,KAAK,EAAE,UAAC,KAAqB;YAC1C,UAAU,CAAC,EAAC,KAAK,OAAA,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,YAAY,EAAE,MAAM,CAAC,YAAY,EAAC,CAAC,CAAA;QAC/E,CAAC,CAAC,CAAA;KACL;SAAM;QACH,aAAa,CAAC;YACV,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,YAAY,EAAE,MAAM,CAAC,YAAY;SACpC,CAAC,CAAA;KACL;AACL,CAAC;AAED,SAAS,aAAa,CAAC,MAItB;IACG,KAAkB,UAAY,EAAZ,KAAA,MAAM,CAAC,KAAK,EAAZ,cAAY,EAAZ,IAAY,EAAE;QAA3B,IAAM,GAAG,SAAA;QACV,iBAAiB,CACb,GAAG,EACH,MAAM,CAAC,KAAK,EACZ,CAAC,UAAC,OAA8B;YAC5B,OAAO,iBAAiB,CACpB,OAAO,EACP,MAAM,CAAC,YAAY,EACnB,UAAC,QAAkB;gBACf,OAAO,iBAAiB,CAAC,QAAQ,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;YACvD,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CACL,CAAA;KACJ;AACL,CAAC"}
+{"version":3,"file":"json-to-html.js","sourceRoot":"","sources":["../../src/json-to-html.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAEjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAI1E;;;;;;;;;;GAUG;AACH,MAAM,UAAU,UAAU,CAAC,MAI1B;IACG,IAAI,MAAM,CAAC,KAAK,YAAY,KAAK,EAAE;QAC/B,SAAS,CAAC,MAAM,CAAC,KAAK,EAAE,UAAC,KAAqB;YAC1C,UAAU,CAAC,EAAC,KAAK,OAAA,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,YAAY,EAAE,MAAM,CAAC,YAAY,EAAC,CAAC,CAAA;QAC/E,CAAC,CAAC,CAAA;KACL;SAAM;QACH,aAAa,CAAC;YACV,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,YAAY,EAAE,MAAM,CAAC,YAAY;SACpC,CAAC,CAAA;KACL;AACL,CAAC;AAED,SAAS,aAAa,CAAC,MAItB;IACG,KAAkB,UAAY,EAAZ,KAAA,MAAM,CAAC,KAAK,EAAZ,cAAY,EAAZ,IAAY,EAAE;QAA3B,IAAM,GAAG,SAAA;QACV,iBAAiB,CACb,GAAG,EACH,MAAM,CAAC,KAAK,EACZ,CAAC,UAAC,OAA8B;YAC5B,OAAO,iBAAiB,CACpB,OAAO,EACP,MAAM,CAAC,YAAY,EACnB,UAAC,QAAkB;gBACf,OAAO,iBAAiB,CAAC,QAAQ,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;YACvD,CAAC,CACJ,CAAA;QACL,CAAC,CAAC,CACL,CAAA;KACJ;AACL,CAAC"}

dist/lib/Models/metadata-model.js

@@ -22,2 +22,11 @@ import { replaceHtmlEntities, forbiddenAttrChars } from '../helper/string-utils';
 }
+/**
+ * Serializes an Attributes object to a string of HTML attribute key-value pairs
+ * (e.g. ` key1="value1" key2="value2"`). Keys containing forbidden characters
+ * are skipped. Values are HTML-entity-encoded. Arrays are joined with `, `;
+ * nested objects are serialized as `key:value;` pairs.
+ *
+ * @param attributes - The attributes object to serialize (e.g. from a node or metadata).
+ * @returns A string starting with a space, followed by `key="value"` pairs suitable for inclusion in an HTML tag.
+ */
 export function attributeToString(attributes) {
@@ -24,0 +33,0 @@ var result = '';

dist/lib/Models/metadata-model.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"metadata-model.js","sourceRoot":"","sources":["../../../src/Models/metadata-model.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAkCjF,MAAM,UAAU,cAAc,CAAC,SAAqB;IAClD,OAAO;QACL,IAAI,EAAE,SAAS,CAAC,OAAO,CAAC;QACxB,OAAO,EAAE,SAAS,CAAC,oBAAoB,CAAC,IAAI,SAAS,CAAC,oBAAoB,CAAC;QAC3E,QAAQ,EAAE,SAAS,CAAC,IAAI;QACxB,SAAS,EAAE,SAAS,CAAC,gBAAgB,CAAc;QACnD,UAAU,EAAE,SAAS;QACrB,cAAc,EAAE,SAAS,CAAC,2BAA2B,CAAC;KACvD,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,SAAqB,EAAE,QAAkB;IACtE,OAAO;QACL,IAAI,EAAE,QAAQ,CAAC,IAAI;QACnB,OAAO,EAAE,SAAS,CAAC,WAAW,CAAC,IAAI,SAAS,CAAC,WAAW,CAAC;QACzD,QAAQ,EAAE,SAAS,CAAC,IAAI;QACxB,SAAS,EAAE,SAAS,CAAC,cAAc,CAAc;QACjD,UAAU,EAAE,SAAS;QACrB,cAAc,EAAE,SAAS,CAAC,kBAAkB,CAAC;KAC9C,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,UAAsB;IACtD,IAAI,MAAM,GAAG,EAAE,CAAC;4BACL,GAAG;QACZ,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,CAAC,EAAE;YACzD,IAAI,kBAAkB,CAAC,IAAI,CAAC,UAAA,IAAI,IAAI,OAAA,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAlB,CAAkB,CAAC,EAAE;;aAExD;YACD,IAAI,KAAK,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC;YAC5B,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;gBACxB,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aAC1B;iBAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;gBACpC,IAAI,aAAa,GAAG,EAAE,CAAC;gBACvB,KAAK,IAAM,MAAM,IAAI,KAAK,EAAE;oBAC1B,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE;wBACvD,IAAM,QAAQ,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;wBAC/B,IAAI,QAAQ,IAAI,IAAI,IAAI,QAAQ,KAAK,EAAE,EAAE;4BACvC,aAAa,IAAI,UAAG,MAAM,cAAI,QAAQ,OAAI,CAAC;yBAC5C;qBACF;iBACF;gBACD,KAAK,GAAG,aAAa,CAAC;aACvB;YACD,MAAM,IAAI,WAAI,GAAG,gBAAK,mBAAmB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAG,CAAC;SAC7D;;IArBH,KAAK,IAAM,GAAG,IAAI,UAAU;gBAAjB,GAAG;KAsBb;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}
+{"version":3,"file":"metadata-model.js","sourceRoot":"","sources":["../../../src/Models/metadata-model.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAkCjF,MAAM,UAAU,cAAc,CAAC,SAAqB;IAClD,OAAO;QACL,IAAI,EAAE,SAAS,CAAC,OAAO,CAAC;QACxB,OAAO,EAAE,SAAS,CAAC,oBAAoB,CAAC,IAAI,SAAS,CAAC,oBAAoB,CAAC;QAC3E,QAAQ,EAAE,SAAS,CAAC,IAAI;QACxB,SAAS,EAAE,SAAS,CAAC,gBAAgB,CAAc;QACnD,UAAU,EAAE,SAAS;QACrB,cAAc,EAAE,SAAS,CAAC,2BAA2B,CAAC;KACvD,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,SAAqB,EAAE,QAAkB;IACtE,OAAO;QACL,IAAI,EAAE,QAAQ,CAAC,IAAI;QACnB,OAAO,EAAE,SAAS,CAAC,WAAW,CAAC,IAAI,SAAS,CAAC,WAAW,CAAC;QACzD,QAAQ,EAAE,SAAS,CAAC,IAAI;QACxB,SAAS,EAAE,SAAS,CAAC,cAAc,CAAc;QACjD,UAAU,EAAE,SAAS;QACrB,cAAc,EAAE,SAAS,CAAC,kBAAkB,CAAC;KAC9C,CAAC;AACJ,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,iBAAiB,CAAC,UAAsB;IACtD,IAAI,MAAM,GAAG,EAAE,CAAC;4BACL,GAAG;QACZ,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,CAAC,EAAE;YACzD,IAAI,kBAAkB,CAAC,IAAI,CAAC,UAAA,IAAI,IAAI,OAAA,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAlB,CAAkB,CAAC,EAAE;;aAExD;YACD,IAAI,KAAK,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC;YAC5B,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;gBACxB,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aAC1B;iBAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;gBACpC,IAAI,aAAa,GAAG,EAAE,CAAC;gBACvB,KAAK,IAAM,MAAM,IAAI,KAAK,EAAE;oBAC1B,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE;wBACvD,IAAM,QAAQ,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;wBAC/B,IAAI,QAAQ,IAAI,IAAI,IAAI,QAAQ,KAAK,EAAE,EAAE;4BACvC,aAAa,IAAI,UAAG,MAAM,cAAI,QAAQ,OAAI,CAAC;yBAC5C;qBACF;iBACF;gBACD,KAAK,GAAG,aAAa,CAAC;aACvB;YACD,MAAM,IAAI,WAAI,GAAG,gBAAK,mBAAmB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAG,CAAC;SAC7D;;IArBH,KAAK,IAAM,GAAG,IAAI,UAAU;gBAAjB,GAAG;KAsBb;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}

dist/lib/render-embedded-objects.js

@@ -16,6 +16,10 @@ var __assign = (this && this.__assign) || function () {
 /**
+ * Renders RTE (Rich Text Editor) content with embedded objects in-place.
+ * Mutates the entry/entries by replacing embedded item tags with HTML produced
+ * by the provided render options. Works with a single entry or an array of entries.
  *
- * @param {EntryEmbedable| EntryEmbedable[]} entry - Objects that contains RTE with embedded objects
- * @param {string[]} paths - Key paths for RTE contents in Entry object
- * @param {RenderOption?} renderOption -  Optional render options to render content
+ * @param option - Configuration for rendering.
+ * @param option.entry - Entry or array of entries containing RTE fields with embedded objects.
+ * @param option.renderOption - Optional render options (node/item handlers) to produce HTML for embedded content.
+ * @param option.paths - Optional key paths to specific RTE fields. If omitted, all RTE paths on the entry are rendered.
  */
@@ -50,6 +54,9 @@ export function render(option) {
 /**
+ * Renders a single RTE content string or array of strings by replacing embedded
+ * item tags with HTML. Uses the entry and renderOption from the given option to
+ * resolve embedded references and produce output.
  *
- * @param {string | string[]} content - RTE content to render
- * @param {EntryEmbedable} options.entry - Entry object containing embedded objects
- * @param {RenderOption?} options.renderOption - Optional render options to render content
+ * @param content - RTE content string or array of strings containing embedded item tags.
+ * @param option - Must include the entry (for resolving embedded items) and optionally renderOption.
+ * @returns The same shape as content: a string or array of strings with embedded tags replaced by rendered HTML.
  */
@@ -56,0 +63,0 @@ export function renderContent(content, option) {

dist/lib/render-embedded-objects.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"render-embedded-objects.js","sourceRoot":"","sources":["../../src/render-embedded-objects.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,OAAO,cAAc,CAAA;AAGrB,OAAO,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAEnF,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE;;;;;GAKG;AACH,MAAM,UAAU,MAAM,CAAC,MAItB;IAEG,SAAS,WAAW,CAAC,IAAY,EAAE,KAAqB;QACpD,iBAAiB,CAAC,IAAI,EAAE,KAAK,EAAE,UAAC,OAAyB;YACrD,OAAO,aAAa,CAAC,OAAO,EAAE,EAAE,KAAK,OAAA,EAAE,YAAY,EAAE,MAAM,CAAC,YAAY,EAAE,CAAC,CAAA;QAC/E,CAAC,CAAC,CAAA;IACN,CAAC;IAED,SAAS,aAAa,CAAE,KAAqB;QACzC,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;YAC5C,MAAM,CAAC,IAAI,cACJ,KAAK,CAAC,eAAe,EAC1B,CAAC,OAAO,CAAC,UAAC,IAAI;gBACZ,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;YAC5B,CAAC,CAAC,CAAA;SACL;aAAM;YACH,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,UAAC,IAAI;gBACtB,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;YAC5B,CAAC,CAAC,CAAA;SACL;IACL,CAAC;IAED,IAAI,MAAM,CAAC,KAAK,YAAY,KAAK,EAAE;QAC/B,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,UAAC,KAAK;YACvB,aAAa,CAAC,KAAK,CAAC,CAAA;QACxB,CAAC,CAAC,CAAA;KACL;SAAK;QACF,aAAa,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;KAC9B;AACL,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,OAA4B,EAAE,MAAc;IACtE,sCAAsC;IACtC,IAAI,CAAC,OAAO,IAAI,OAAO,KAAK,SAAS,EAAE;QACnC,OAAO,EAAE,CAAA;KACZ;IAED,gCAAgC;IAChC,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;QAC7B,IAAI,kBAAgB,GAAG,OAAO,CAAA;QAC9B,OAAO,CAAC,mBAAmB,CAAC,UAAC,gBAAwB,EAAE,MAAgB;YACnE,kBAAgB,GAAG,0BAA0B,CACzC,kBAAgB,EAChB,gBAAgB,EAChB,MAAM,EACN,MAAM,CAAC,CAAA;QACf,CAAC,CAAC,CAAA;QACF,OAAO,kBAAgB,CAAA;KAC1B;IAED,yCAAyC;IACzC,IAAM,aAAa,GAAa,EAAE,CAAA;IAClC,OAAO,CAAC,OAAO,CAAC,UAAC,OAAO;QACpB,aAAa,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,MAAM,CAAW,CAAC,CAAA;IAChE,CAAC,CAAC,CAAA;IACF,OAAO,aAAa,CAAA;AACxB,CAAC;AAED,SAAS,0BAA0B,CAAC,OAAc,EAAE,gBAAwB,EAAE,QAAkB,EAAE,MAAc;IAC5G,IAAM,eAAe,GAAG,iBAAiB,CAAC,QAAQ,EAAE,MAAM,CAAC,KAAK,CAAC,CAAA;IACjE,IAAM,YAAY,GAAG,gBAAgB,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,YAAY,CAAC,CAAA;IACxF,OAAO,OAAO,CAAC,OAAO,CAAC,gBAAgB,EAAE,YAAY,CAAC,CAAA;AAC1D,CAAC"}
+{"version":3,"file":"render-embedded-objects.js","sourceRoot":"","sources":["../../src/render-embedded-objects.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,OAAO,cAAc,CAAA;AAGrB,OAAO,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAEnF,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE;;;;;;;;;GASG;AACH,MAAM,UAAU,MAAM,CAAC,MAItB;IAEG,SAAS,WAAW,CAAC,IAAY,EAAE,KAAqB;QACpD,iBAAiB,CAAC,IAAI,EAAE,KAAK,EAAE,UAAC,OAAyB;YACrD,OAAO,aAAa,CAAC,OAAO,EAAE,EAAE,KAAK,OAAA,EAAE,YAAY,EAAE,MAAM,CAAC,YAAY,EAAE,CAAC,CAAA;QAC/E,CAAC,CAAC,CAAA;IACN,CAAC;IAED,SAAS,aAAa,CAAE,KAAqB;QACzC,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;YAC5C,MAAM,CAAC,IAAI,cACJ,KAAK,CAAC,eAAe,EAC1B,CAAC,OAAO,CAAC,UAAC,IAAI;gBACZ,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;YAC5B,CAAC,CAAC,CAAA;SACL;aAAM;YACH,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,UAAC,IAAI;gBACtB,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;YAC5B,CAAC,CAAC,CAAA;SACL;IACL,CAAC;IAED,IAAI,MAAM,CAAC,KAAK,YAAY,KAAK,EAAE;QAC/B,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,UAAC,KAAK;YACvB,aAAa,CAAC,KAAK,CAAC,CAAA;QACxB,CAAC,CAAC,CAAA;KACL;SAAK;QACF,aAAa,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;KAC9B;AACL,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,aAAa,CAAC,OAA4B,EAAE,MAAc;IACtE,sCAAsC;IACtC,IAAI,CAAC,OAAO,IAAI,OAAO,KAAK,SAAS,EAAE;QACnC,OAAO,EAAE,CAAA;KACZ;IAED,gCAAgC;IAChC,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;QAC7B,IAAI,kBAAgB,GAAG,OAAO,CAAA;QAC9B,OAAO,CAAC,mBAAmB,CAAC,UAAC,gBAAwB,EAAE,MAAgB;YACnE,kBAAgB,GAAG,0BAA0B,CACzC,kBAAgB,EAChB,gBAAgB,EAChB,MAAM,EACN,MAAM,CAAC,CAAA;QACf,CAAC,CAAC,CAAA;QACF,OAAO,kBAAgB,CAAA;KAC1B;IAED,yCAAyC;IACzC,IAAM,aAAa,GAAa,EAAE,CAAA;IAClC,OAAO,CAAC,OAAO,CAAC,UAAC,OAAO;QACpB,aAAa,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,MAAM,CAAW,CAAC,CAAA;IAChE,CAAC,CAAC,CAAA;IACF,OAAO,aAAa,CAAA;AACxB,CAAC;AAED,SAAS,0BAA0B,CAAC,OAAc,EAAE,gBAAwB,EAAE,QAAkB,EAAE,MAAc;IAC5G,IAAM,eAAe,GAAG,iBAAiB,CAAC,QAAQ,EAAE,MAAM,CAAC,KAAK,CAAC,CAAA;IACjE,IAAM,YAAY,GAAG,gBAAgB,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,YAAY,CAAC,CAAA;IACxF,OAAO,OAAO,CAAC,OAAO,CAAC,gBAAgB,EAAE,YAAY,CAAC,CAAA;AAC1D,CAAC"}

dist/lib/updateAssetURLForGQL.js

@@ -0,1 +1,10 @@
+/**
+ * Updates asset URLs in a GraphQL response in-place. Walks the response data,
+ * finds RTE fields that have `embedded_itemsConnection`, and sets each
+ * embedded asset's `asset-link` attribute in the JSON to the asset's `url`
+ * from the response. Use after fetching content via GraphQL so RTE JSON
+ * contains correct asset URLs for rendering.
+ *
+ * @param gqlResponse - The raw GraphQL response object (e.g. `{ data: { ... } }`). Modified in place.
+ */
 export function updateAssetURLForGQL(gqlResponse) {
@@ -2,0 +11,0 @@ try {

dist/lib/updateAssetURLForGQL.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"updateAssetURLForGQL.js","sourceRoot":"","sources":["../../src/updateAssetURLForGQL.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,oBAAoB,CAAC,WAAe;IAClD,IAAI;QACF,IAAM,QAAQ,GAAG,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,IAAI,CAAC;QACnC,KAAK,IAAI,WAAW,IAAI,QAAQ,EAAE;YAChC,IAAI,OAAO,IAAI,QAAQ,CAAC,WAAW,CAAC,EAAE;gBACpC,IAAM,OAAO,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC;gBAE5C,OAAO,CAAC,OAAO,CAAC,UAAC,KAAS;oBACxB,YAAY,CAAC,KAAK,CAAC,CAAC;gBACtB,CAAC,CAAC,CAAC;aACJ;iBAAM;gBACL,YAAY,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC;aACpC;SACH;KACF;IAAC,OAAO,KAAK,EAAE;QACd,OAAO,CAAC,KAAK,CAAC,8CAA8C,EAAE,KAAK,CAAC,CAAC;KACtE;AACH,CAAC;AAED,SAAS,YAAY,CAAC,KAAS;IAC7B,KAAK,IAAI,KAAK,IAAI,KAAK,EAAE;QACvB,IAAM,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;QAC/B,IAAI,SAAS,YAAY,KAAK,EAAE;YAC9B,SAAS,CAAC,OAAO,CAAC,UAAC,IAAQ;gBACzB,wBAAwB,CAAC,IAAI,CAAC,CAAC;YACjC,CAAC,CAAC,CAAC;SACJ;aAAM,IAAI,SAAS,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE;YACrD,wBAAwB,CAAC,SAAS,CAAC,CAAC;SACrC;KACF;AACH,CAAC;AAED,SAAS,wBAAwB,CAAC,SAAa;;IAC7C,IAAM,QAAQ,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC;IAEzC,IAAI,CAAC,QAAQ;QAAE,OAAO;IAEtB,IAAM,KAAK,GAAG,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,wBAAwB,0CAAE,KAAK,CAAC;IACxD,KAAK,CAAC,OAAO,CAAC,UAAC,IAAQ;;QACrB,IAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACvB,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,GAAG,MAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ,CAAA,EAAE;YAE/B,IAAI,CAAC,CAAA,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,0CAAE,GAAG,CAAA;gBAAE,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;YAE/E,IAAM,kBAAkB,GAAG,MAAA,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,IAAI,0CAAE,QAAQ,0CAAE,IAAI,CAAC,UAAC,KAAS,IAAK,OAAA,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,GAAG,EAA5C,CAA4C,CAAC,CAAC;YACvH,kBAAkB,CAAC,KAAK,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC;SACnD;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,YAAY,CAAC,SAAc;IAClC,IAAI,SAAS,IAAI,SAAS,CAAC,wBAAwB,EAAE;QACnD,OAAO,SAAS,CAAC;KAClB;IACD,KAAK,IAAM,GAAG,IAAI,SAAS,EAAE;QAC3B,IAAI,SAAS,CAAC,GAAG,CAAC,IAAI,OAAO,SAAS,CAAC,GAAG,CAAC,KAAK,QAAQ,EAAE;YACxD,IAAM,KAAK,GAAG,YAAY,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;YAC3C,IAAI,KAAK,EAAE;gBACT,OAAO,KAAK,CAAC;aACd;SACF;KACF;AACH,CAAC"}
+{"version":3,"file":"updateAssetURLForGQL.js","sourceRoot":"","sources":["../../src/updateAssetURLForGQL.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,MAAM,UAAU,oBAAoB,CAAC,WAAe;IAClD,IAAI;QACF,IAAM,QAAQ,GAAG,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,IAAI,CAAC;QACnC,KAAK,IAAI,WAAW,IAAI,QAAQ,EAAE;YAChC,IAAI,OAAO,IAAI,QAAQ,CAAC,WAAW,CAAC,EAAE;gBACpC,IAAM,OAAO,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC;gBAE5C,OAAO,CAAC,OAAO,CAAC,UAAC,KAAS;oBACxB,YAAY,CAAC,KAAK,CAAC,CAAC;gBACtB,CAAC,CAAC,CAAC;aACJ;iBAAM;gBACL,YAAY,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC;aACpC;SACH;KACF;IAAC,OAAO,KAAK,EAAE;QACd,OAAO,CAAC,KAAK,CAAC,8CAA8C,EAAE,KAAK,CAAC,CAAC;KACtE;AACH,CAAC;AAED,SAAS,YAAY,CAAC,KAAS;IAC7B,KAAK,IAAI,KAAK,IAAI,KAAK,EAAE;QACvB,IAAM,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;QAC/B,IAAI,SAAS,YAAY,KAAK,EAAE;YAC9B,SAAS,CAAC,OAAO,CAAC,UAAC,IAAQ;gBACzB,wBAAwB,CAAC,IAAI,CAAC,CAAC;YACjC,CAAC,CAAC,CAAC;SACJ;aAAM,IAAI,SAAS,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE;YACrD,wBAAwB,CAAC,SAAS,CAAC,CAAC;SACrC;KACF;AACH,CAAC;AAED,SAAS,wBAAwB,CAAC,SAAa;;IAC7C,IAAM,QAAQ,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC;IAEzC,IAAI,CAAC,QAAQ;QAAE,OAAO;IAEtB,IAAM,KAAK,GAAG,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,wBAAwB,0CAAE,KAAK,CAAC;IACxD,KAAK,CAAC,OAAO,CAAC,UAAC,IAAQ;;QACrB,IAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACvB,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,GAAG,MAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ,CAAA,EAAE;YAE/B,IAAI,CAAC,CAAA,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,0CAAE,GAAG,CAAA;gBAAE,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;YAE/E,IAAM,kBAAkB,GAAG,MAAA,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,IAAI,0CAAE,QAAQ,0CAAE,IAAI,CAAC,UAAC,KAAS,IAAK,OAAA,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,GAAG,EAA5C,CAA4C,CAAC,CAAC;YACvH,kBAAkB,CAAC,KAAK,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC;SACnD;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,YAAY,CAAC,SAAc;IAClC,IAAI,SAAS,IAAI,SAAS,CAAC,wBAAwB,EAAE;QACnD,OAAO,SAAS,CAAC;KAClB;IACD,KAAK,IAAM,GAAG,IAAI,SAAS,EAAE;QAC3B,IAAI,SAAS,CAAC,GAAG,CAAC,IAAI,OAAO,SAAS,CAAC,GAAG,CAAC,KAAK,QAAQ,EAAE;YACxD,IAAM,KAAK,GAAG,YAAY,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;YAC3C,IAAI,KAAK,EAAE;gBACT,OAAO,KAAK,CAAC;aACd;SACF;KACF;AACH,CAAC"}

dist/types/endpoints.d.ts

@@ -16,2 +16,13 @@ export interface ContentstackEndpoints {
 }
+/**
+ * Returns the Contentstack API endpoint(s) for a given region and optional service.
+ * Region can be an ID (e.g. `'us'`, `'eu'`) or an alias. Throws if the region is
+ * invalid or empty.
+ *
+ * @param region - Region ID or alias (e.g. `'us'`, `'eu'`). Default: `'us'`.
+ * @param service - Optional service name to return a single endpoint (e.g. `'delivery'`). If empty, returns all endpoints for the region.
+ * @param omitHttps - If true, strips the `https://` prefix from the returned URL(s). Default: false.
+ * @returns A single endpoint URL string if `service` is provided, otherwise the full endpoints object for the region.
+ * @throws Error if region is empty, invalid, or if the requested service is not found.
+ */
 export declare function getContentstackEndpoint(region?: string, service?: string, omitHttps?: boolean): string | ContentstackEndpoints;

dist/types/entry-editable.d.ts

 import { EntryModel } from ".";
-export declare function addTags(entry: EntryModel, contentTypeUid: string, tagsAsObject: boolean, locale?: string): void;
+/**
+ * Adds Contentstack Live Preview (CSLP) data tags to an entry for editable UIs.
+ * Mutates the entry by attaching a `$` property with tag strings or objects
+ * (e.g. `data-cslp` / `data-cslp-parent-field`) for each field, including nested
+ * objects and references. Supports variant-aware tagging when the entry has
+ * applied variants.
+ *
+ * @param entry - The entry (EmbeddedItem) to tag. Must have uid and optional system/applied variants.
+ * @param contentTypeUid - Content type UID (e.g. `blog_post`). Used as part of the tag path.
+ * @param tagsAsObject - If true, tags are stored as objects (e.g. `{ "data-cslp": "..." }`); if false, as strings (e.g. `data-cslp=...`).
+ * @param locale - Locale code for the tag path (default: `'en-us'`).
+ * @param options.useLowerCaseLocale - Optional boolean to make locale case-insensitive.
+ */
+export declare function addTags(entry: EntryModel, contentTypeUid: string, tagsAsObject: boolean, locale?: string, options?: {
+    useLowerCaseLocale?: boolean;
+}): void;

dist/types/gql.d.ts

@@ -11,5 +11,20 @@ import Node from './nodes/node';
 }): void;
+/**
+ * GraphQL API utilities for Contentstack. Provides methods to work with
+ * content fetched via the GraphQL API, including rendering Supercharged RTE
+ * (JSON) with embedded items from the GQL response.
+ */
 export declare const GQL: {
+    /**
+     * Converts Supercharged RTE (JSON) content to HTML for entries from a GraphQL response.
+     * Uses `embedded_itemsConnection.edges` to resolve embedded items. Mutates the entry
+     * JSON in-place by replacing JSON RTE content with the generated HTML.
+     *
+     * @param option - Configuration for conversion.
+     * @param option.entry - Entry or array of entries (EmbeddedItem) from a GQL response with JSON RTE and embedded_itemsConnection.
+     * @param option.paths - Key paths to the JSON RTE fields on the entry.
+     * @param option.renderOption - Optional render options to customize how nodes and embedded items are rendered to HTML.
+     */
     jsonToHTML: typeof jsonToHTML;
 };
 export {};

dist/types/json-to-html.d.ts

@@ -6,2 +6,13 @@ import Node from './nodes/node';
 export type AnyNode = TextNode | Node;
+/**
+ * Converts Supercharged RTE (JSON) content to HTML for one or more entries.
+ * Walks the given paths on each entry, finds JSON RTE content, resolves embedded
+ * items from the entry, and renders nodes using the optional renderOption. Mutates
+ * the entry JSON in-place by replacing content with the generated HTML.
+ *
+ * @param option - Configuration for conversion.
+ * @param option.entry - Entry or array of entries that contain Supercharged RTE (JSON) fields.
+ * @param option.paths - Key paths to the JSON RTE fields (e.g. `['rte_field_uid', 'group.rte_uid']`).
+ * @param option.renderOption - Optional render options to customize how nodes and embedded items are rendered to HTML.
+ */
 export declare function jsonToHTML(option: {
@@ -8,0 +19,0 @@ entry: EntryEmbedable | EntryEmbedable[];

dist/types/Models/metadata-model.d.ts

@@ -34,2 +34,11 @@ import StyleType from '../embedded-types/style-type';
 export declare function nodeToMetadata(attribute: Attributes, textNode: TextNode): Metadata;
+/**
+ * Serializes an Attributes object to a string of HTML attribute key-value pairs
+ * (e.g. ` key1="value1" key2="value2"`). Keys containing forbidden characters
+ * are skipped. Values are HTML-entity-encoded. Arrays are joined with `, `;
+ * nested objects are serialized as `key:value;` pairs.
+ *
+ * @param attributes - The attributes object to serialize (e.g. from a node or metadata).
+ * @returns A string starting with a space, followed by `key="value"` pairs suitable for inclusion in an HTML tag.
+ */
 export declare function attributeToString(attributes: Attributes): string;

dist/types/render-embedded-objects.d.ts

@@ -5,6 +5,10 @@ import './extensions';
 /**
+ * Renders RTE (Rich Text Editor) content with embedded objects in-place.
+ * Mutates the entry/entries by replacing embedded item tags with HTML produced
+ * by the provided render options. Works with a single entry or an array of entries.
  *
- * @param {EntryEmbedable| EntryEmbedable[]} entry - Objects that contains RTE with embedded objects
- * @param {string[]} paths - Key paths for RTE contents in Entry object
- * @param {RenderOption?} renderOption -  Optional render options to render content
+ * @param option - Configuration for rendering.
+ * @param option.entry - Entry or array of entries containing RTE fields with embedded objects.
+ * @param option.renderOption - Optional render options (node/item handlers) to produce HTML for embedded content.
+ * @param option.paths - Optional key paths to specific RTE fields. If omitted, all RTE paths on the entry are rendered.
  */
@@ -17,7 +21,10 @@ export declare function render(option: {
 /**
+ * Renders a single RTE content string or array of strings by replacing embedded
+ * item tags with HTML. Uses the entry and renderOption from the given option to
+ * resolve embedded references and produce output.
  *
- * @param {string | string[]} content - RTE content to render
- * @param {EntryEmbedable} options.entry - Entry object containing embedded objects
- * @param {RenderOption?} options.renderOption - Optional render options to render content
+ * @param content - RTE content string or array of strings containing embedded item tags.
+ * @param option - Must include the entry (for resolving embedded items) and optionally renderOption.
+ * @returns The same shape as content: a string or array of strings with embedded tags replaced by rendered HTML.
  */
 export declare function renderContent(content: (string | string[]), option: Option): (string | string[]);

dist/types/updateAssetURLForGQL.d.ts

@@ -0,1 +1,10 @@
+/**
+ * Updates asset URLs in a GraphQL response in-place. Walks the response data,
+ * finds RTE fields that have `embedded_itemsConnection`, and sets each
+ * embedded asset's `asset-link` attribute in the JSON to the asset's `url`
+ * from the response. Use after fetching content via GraphQL so RTE JSON
+ * contains correct asset URLs for rendering.
+ *
+ * @param gqlResponse - The raw GraphQL response object (e.g. `{ data: { ... } }`). Modified in place.
+ */
 export declare function updateAssetURLForGQL(gqlResponse: any): void;

LICENSE

@@ -1,6 +0,5 @@
-The MIT License (MIT)
+MIT License
 
+Copyright (c) 2016-2026 Contentstack
 
-Copyright (c) 2016-2025 Contentstack
-
 Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -13,4 +12,4 @@ of this software and associated documentation files (the "Software"), to deal
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
@@ -22,3 +21,3 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package.json

 {
   "name": "@contentstack/utils",
-  "version": "1.6.3",
+  "version": "1.7.0",
   "description": "Contentstack utilities for Javascript",
@@ -5,0 +5,0 @@ "main": "dist/index.es.js",

New alerts

URL strings

Supply chain risk

Package contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.

Found 1 instance in 1 package

Fixed alerts

URL strings

Supply chain risk

Package contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

326080

7.04%

Lines of code

3393

7.71%

No dependency changes