@contentstack/utils - npm Package Compare versions

Comparing version 1.8.0 to 1.9.0

dist/lib/variant-aliases.js

+function assertPlainObject(value, message) {
+    if (value === null || value === undefined) {
+        throw new TypeError(message);
+    }
+    if (typeof value !== 'object' || Array.isArray(value)) {
+        throw new TypeError(message);
+    }
+}
+function requireEntryUid(entry) {
+    var uid = entry.uid;
+    if (typeof uid !== 'string' || uid.length === 0) {
+        throw new Error('Entry uid is required. The entry must include a non-empty uid string.');
+    }
+    return uid;
+}
+function resolveContentTypeUid(entry, contentTypeUid) {
+    var fromEntry = entry._content_type_uid;
+    if (typeof fromEntry === 'string' && fromEntry.length > 0) {
+        return fromEntry;
+    }
+    if (typeof contentTypeUid === 'string' && contentTypeUid.length > 0) {
+        return contentTypeUid;
+    }
+    return '';
+}
+function collectVariantAliases(entry) {
+    var publishDetails = entry.publish_details;
+    if (!publishDetails || typeof publishDetails !== 'object' || Array.isArray(publishDetails)) {
+        return [];
+    }
+    var variants = publishDetails.variants;
+    if (!variants || typeof variants !== 'object' || Array.isArray(variants)) {
+        return [];
+    }
+    var out = [];
+    var map = variants;
+    for (var _i = 0, _a = Object.keys(map); _i < _a.length; _i++) {
+        var key = _a[_i];
+        var v = map[key];
+        if (!v || typeof v !== 'object' || Array.isArray(v)) {
+            continue;
+        }
+        var alias = v.alias;
+        if (typeof alias === 'string' && alias.length > 0) {
+            out.push(alias);
+        }
+    }
+    return out;
+}
+function mapEntryToResult(entry, contentTypeUid) {
+    return {
+        entry_uid: requireEntryUid(entry),
+        contenttype_uid: resolveContentTypeUid(entry, contentTypeUid),
+        variants: collectVariantAliases(entry),
+    };
+}
+export function getVariantAliases(entryOrEntries, contentTypeUid) {
+    if (Array.isArray(entryOrEntries)) {
+        return entryOrEntries.map(function (e) {
+            assertPlainObject(e, 'Each entry must be a plain object with a uid.');
+            return mapEntryToResult(e, contentTypeUid);
+        });
+    }
+    assertPlainObject(entryOrEntries, 'Entry is required. Provide a CDA entry object with a uid.');
+    return mapEntryToResult(entryOrEntries, contentTypeUid);
+}
+/**
+ * Serialises variant alias results for use as an HTML `data-csvariants` attribute value.
+ *
+ * @param entries - CDA entries to process (same rules as {@link getVariantAliases} for each item).
+ * @param contentTypeUid - Applied when an entry lacks `_content_type_uid`.
+ * @returns `{ "data-csvariants": "<JSON string of VariantAliasesResult[]>" }`.
+ * @throws TypeError if `entries` is null/undefined or not an array, or any element is not a plain object.
+ * @throws Error if any entry has no non-empty `uid`.
+ */
+export function getVariantMetadataTags(entries, contentTypeUid) {
+    if (entries === null || entries === undefined) {
+        throw new TypeError('Entries array is required. Provide an array of CDA entry objects.');
+    }
+    if (!Array.isArray(entries)) {
+        throw new TypeError('Entries must be an array of CDA entry objects.');
+    }
+    var payload = getVariantAliases(entries, contentTypeUid);
+    return { 'data-csvariants': JSON.stringify(payload) };
+}
+//# sourceMappingURL=variant-aliases.js.map

dist/lib/variant-aliases.js.map

+{"version":3,"file":"variant-aliases.js","sourceRoot":"","sources":["../../src/variant-aliases.ts"],"names":[],"mappings":"AAYA,SAAS,iBAAiB,CAAC,KAAc,EAAE,OAAe;IACxD,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE;QACzC,MAAM,IAAI,SAAS,CAAC,OAAO,CAAC,CAAC;KAC9B;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;QACrD,MAAM,IAAI,SAAS,CAAC,OAAO,CAAC,CAAC;KAC9B;AACH,CAAC;AAED,SAAS,eAAe,CAAC,KAA8B;IACrD,IAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC;IACtB,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,EAAE;QAC/C,MAAM,IAAI,KAAK,CAAC,uEAAuE,CAAC,CAAC;KAC1F;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,SAAS,qBAAqB,CAAC,KAA8B,EAAE,cAAuB;IACpF,IAAM,SAAS,GAAG,KAAK,CAAC,iBAAiB,CAAC;IAC1C,IAAI,OAAO,SAAS,KAAK,QAAQ,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE;QACzD,OAAO,SAAS,CAAC;KAClB;IACD,IAAI,OAAO,cAAc,KAAK,QAAQ,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE;QACnE,OAAO,cAAc,CAAC;KACvB;IACD,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,SAAS,qBAAqB,CAAC,KAA8B;IAC3D,IAAM,cAAc,GAAG,KAAK,CAAC,eAAe,CAAC;IAC7C,IAAI,CAAC,cAAc,IAAI,OAAO,cAAc,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE;QAC1F,OAAO,EAAE,CAAC;KACX;IACD,IAAM,QAAQ,GAAI,cAA0C,CAAC,QAAQ,CAAC;IACtE,IAAI,CAAC,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;QACxE,OAAO,EAAE,CAAC;KACX;IACD,IAAM,GAAG,GAAa,EAAE,CAAC;IACzB,IAAM,GAAG,GAAG,QAAmC,CAAC;IAChD,KAAkB,UAAgB,EAAhB,KAAA,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAhB,cAAgB,EAAhB,IAAgB,EAAE;QAA/B,IAAM,GAAG,SAAA;QACZ,IAAM,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;QACnB,IAAI,CAAC,CAAC,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;YACnD,SAAS;SACV;QACD,IAAM,KAAK,GAAI,CAAyB,CAAC,KAAK,CAAC;QAC/C,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;YACjD,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;SACjB;KACF;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,SAAS,gBAAgB,CAAC,KAA8B,EAAE,cAAuB;IAC/E,OAAO;QACL,SAAS,EAAE,eAAe,CAAC,KAAK,CAAC;QACjC,eAAe,EAAE,qBAAqB,CAAC,KAAK,EAAE,cAAc,CAAC;QAC7D,QAAQ,EAAE,qBAAqB,CAAC,KAAK,CAAC;KACvC,CAAC;AACJ,CAAC;AAyBD,MAAM,UAAU,iBAAiB,CAC/B,cAA6C,EAC7C,cAAuB;IAEvB,IAAI,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE;QACjC,OAAO,cAAc,CAAC,GAAG,CAAC,UAAC,CAAC;YAC1B,iBAAiB,CAAC,CAAC,EAAE,+CAA+C,CAAC,CAAC;YACtE,OAAO,gBAAgB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;KACJ;IACD,iBAAiB,CAAC,cAAc,EAAE,2DAA2D,CAAC,CAAC;IAC/F,OAAO,gBAAgB,CAAC,cAAc,EAAE,cAAc,CAAC,CAAC;AAC1D,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,sBAAsB,CACpC,OAAuB,EACvB,cAAuB;IAEvB,IAAI,OAAO,KAAK,IAAI,IAAI,OAAO,KAAK,SAAS,EAAE;QAC7C,MAAM,IAAI,SAAS,CAAC,mEAAmE,CAAC,CAAC;KAC1F;IACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;QAC3B,MAAM,IAAI,SAAS,CAAC,gDAAgD,CAAC,CAAC;KACvE;IACD,IAAM,OAAO,GAAG,iBAAiB,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;IAC3D,OAAO,EAAE,iBAAiB,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC;AACxD,CAAC"}

dist/types/variant-aliases.d.ts

+/**
+ * Shape returned by {@link getVariantAliases} for interoperability with other Utils SDKs (snake_case JSON keys).
+ */
+export interface VariantAliasesResult {
+    entry_uid: string;
+    contenttype_uid: string;
+    variants: string[];
+}
+/** CDA entry JSON: at minimum includes `uid`; may include `_content_type_uid` and `publish_details.variants`. */
+export type CDAEntryLike = Record<string, unknown>;
+/**
+ * Extracts variant **alias** strings from `publish_details.variants` on a CDA entry.
+ * Only present when the entry was fetched with the `x-cs-variant-uid` header set to variant **aliases** (not UIDs).
+ *
+ * @param entry - Single CDA entry object (must include `uid`).
+ * @param contentTypeUid - Used when `entry._content_type_uid` is missing. Otherwise omitted or empty string yields `contenttype_uid: ""`.
+ * @returns `{ entry_uid, contenttype_uid, variants }` with snake_case keys for cross-SDK JSON parity.
+ * @throws TypeError if `entry` is null/undefined or not a plain object.
+ * @throws Error if `entry` has no non-empty `uid`.
+ */
+export declare function getVariantAliases(entry: CDAEntryLike, contentTypeUid?: string): VariantAliasesResult;
+/**
+ * Extracts variant aliases for each entry in order.
+ *
+ * @param entries - Array of CDA entry objects.
+ * @param contentTypeUid - Applied when an entry lacks `_content_type_uid`.
+ * @returns One result object per input entry.
+ * @throws TypeError if `entries` is null/undefined or not an array, or any element is not a plain object.
+ * @throws Error if any entry has no non-empty `uid`.
+ */
+export declare function getVariantAliases(entries: CDAEntryLike[], contentTypeUid?: string): VariantAliasesResult[];
+/**
+ * Serialises variant alias results for use as an HTML `data-csvariants` attribute value.
+ *
+ * @param entries - CDA entries to process (same rules as {@link getVariantAliases} for each item).
+ * @param contentTypeUid - Applied when an entry lacks `_content_type_uid`.
+ * @returns `{ "data-csvariants": "<JSON string of VariantAliasesResult[]>" }`.
+ * @throws TypeError if `entries` is null/undefined or not an array, or any element is not a plain object.
+ * @throws Error if any entry has no non-empty `uid`.
+ */
+export declare function getVariantMetadataTags(entries: CDAEntryLike[], contentTypeUid?: string): {
+    'data-csvariants': string;
+};

dist/lib/index.js

@@ -14,2 +14,3 @@ export { attributeToString } from './Models/metadata-model';
 export { getContentstackEndpoint } from './endpoints';
+export { getVariantAliases, getVariantMetadataTags } from './variant-aliases';
 //# sourceMappingURL=index.js.map

dist/lib/index.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAwB,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAClF,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAGlE,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AACvD,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AACvD,OAAO,EAAE,OAAO,IAAI,IAAI,EAAC,MAAM,cAAc,CAAA;AAC7C,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,kBAAkB,CAAA;AACtD,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAC3C,OAAO,EAAE,GAAG,EAAE,MAAM,OAAO,CAAA;AAC3B,OAAO,EAAE,OAAO,IAAI,eAAe,EAAE,MAAM,kBAAkB,CAAA;AAC7D,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAC7D,OAAO,EAAE,uBAAuB,EAAyB,MAAM,aAAa,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAwB,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAClF,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAGlE,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AACvD,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AACvD,OAAO,EAAE,OAAO,IAAI,IAAI,EAAC,MAAM,cAAc,CAAA;AAC7C,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,kBAAkB,CAAA;AACtD,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAC3C,OAAO,EAAE,GAAG,EAAE,MAAM,OAAO,CAAA;AAC3B,OAAO,EAAE,OAAO,IAAI,eAAe,EAAE,MAAM,kBAAkB,CAAA;AAC7D,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAC7D,OAAO,EAAE,uBAAuB,EAAyB,MAAM,aAAa,CAAA;AAC5E,OAAO,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAA"}

dist/types/index.d.ts

@@ -17,1 +17,3 @@ export { Next, Option, RenderNode, RenderMark, RenderItem, RenderContentType, RenderOption } from './options/index';
 export { getContentstackEndpoint, ContentstackEndpoints } from './endpoints';
+export { getVariantAliases, getVariantMetadataTags } from './variant-aliases';
+export type { VariantAliasesResult, CDAEntryLike } from './variant-aliases';

package.json

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

No alert changes

Improved metrics

Total package byte prevSize

358237

6.05%

Number of package files

90

3.45%

Lines of code

3718

6.23%

No dependency changes