@rh-support/utils 2.1.1-beta.0 → 2.1.2

package/lib/cjs/customElementUtils.d.ts

@@ -0,0 +1,20 @@
+export declare enum CustomElements {
+    pfeTabs = "pfe-tabs",
+    pfeCollapse = "pfe-collapse"
+}
+interface RequireCustomElementObject {
+    /** The custom element you want to check if it has been defined */
+    element: CustomElements;
+    /** cb that will be called if the custom element has yet to be defined */
+    requireCb: () => void;
+}
+/**
+ * This function is to check if custom elements exist and require them if they do not.
+ * The check is needed because of how the packages are split and that patternfly elements
+ * use window.customElements.define without checking if it is already defined, which throws an
+ * error. Since our packages are split up and lazy loaded this check is necessary to make sure that
+ * the pfelement does not get defined twice.
+ */
+export declare function requireCustomElement(elements: RequireCustomElementObject[]): void;
+export {};
+//# sourceMappingURL=customElementUtils.d.ts.map

package/lib/cjs/customElementUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"customElementUtils.d.ts","sourceRoot":"","sources":["../../src/customElementUtils.ts"],"names":[],"mappings":"AAAA,oBAAY,cAAc;IACtB,OAAO,aAAa;IACpB,WAAW,iBAAiB;CAC/B;AAED,UAAU,0BAA0B;IAChC,kEAAkE;IAClE,OAAO,EAAE,cAAc,CAAC;IAExB,yEAAyE;IACzE,SAAS,EAAE,MAAM,IAAI,CAAC;CACzB;AAED;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,0BAA0B,EAAE,QAM1E"}

package/lib/cjs/customElementUtils.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.requireCustomElement = exports.CustomElements = void 0;
+var CustomElements;
+(function (CustomElements) {
+    CustomElements["pfeTabs"] = "pfe-tabs";
+    CustomElements["pfeCollapse"] = "pfe-collapse";
+})(CustomElements = exports.CustomElements || (exports.CustomElements = {}));
+/**
+ * This function is to check if custom elements exist and require them if they do not.
+ * The check is needed because of how the packages are split and that patternfly elements
+ * use window.customElements.define without checking if it is already defined, which throws an
+ * error. Since our packages are split up and lazy loaded this check is necessary to make sure that
+ * the pfelement does not get defined twice.
+ */
+function requireCustomElement(elements) {
+    elements.forEach((elementObj) => {
+        if (window.customElements.get(elementObj.element) === undefined) {
+            elementObj.requireCb();
+        }
+    });
+}
+exports.requireCustomElement = requireCustomElement;

package/lib/cjs/index.d.ts

@@ -19,6 +19,7 @@ export * from './searchApiUtils';
 export * from './scrollUtils';
 export * from './urlUtils';
 export * from './validatorUtils';
+export * from './customElementUtils';
 export * from './userUtils';
 export * from './styleUtils';
 export * from './translation-helper';

package/lib/cjs/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,yBAAyB,CAAC;AACxC,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,wBAAwB,CAAC;AACvC,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC;AAC5B,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,kBAAkB,CAAC;AACjC,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,gCAAgC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,yBAAyB,CAAC;AACxC,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,wBAAwB,CAAC;AACvC,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC;AAC5B,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,kBAAkB,CAAC;AACjC,cAAc,sBAAsB,CAAC;AACrC,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,gCAAgC,CAAC"}

package/lib/cjs/index.js

@@ -31,6 +31,7 @@ __exportStar(require("./searchApiUtils"), exports);
 __exportStar(require("./scrollUtils"), exports);
 __exportStar(require("./urlUtils"), exports);
 __exportStar(require("./validatorUtils"), exports);
+__exportStar(require("./customElementUtils"), exports);
 __exportStar(require("./userUtils"), exports);
 __exportStar(require("./styleUtils"), exports);
 __exportStar(require("./translation-helper"), exports);

package/lib/cjs/recommendationUtils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"recommendationUtils.d.ts","sourceRoot":"","sources":["../../src/recommendationUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,0CAA0C,CAAC;AAG7F,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,mBAAmB,GAAG,MAAM,CAEvE;AAED,wBAAgB,yBAAyB,CAAC,GAAG,EAAE,mBAAmB,GAAG,MAAM,CAE1E;AAED,wBAAgB,0BAA0B,CAAC,GAAG,EAAE,mBAAmB;;EAGlE;AACD,eAAO,MAAM,6BAA6B;;CAGzC,CAAC;AAEF,wBAAgB,uBAAuB,CACnC,IAAI,EAAE,mBAAmB,EAAE,EAC3B,YAAY,EAAE,YAAY,GAC3B,mBAAmB,EAAE,CAevB;AAED,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAKzD;AAED,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEjD;AAED,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,UAU1C"}
+{"version":3,"file":"recommendationUtils.d.ts","sourceRoot":"","sources":["../../src/recommendationUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,0CAA0C,CAAC;AAI7F,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,mBAAmB,GAAG,MAAM,CAEvE;AAED,wBAAgB,yBAAyB,CAAC,GAAG,EAAE,mBAAmB,GAAG,MAAM,CAE1E;AAED,wBAAgB,0BAA0B,CAAC,GAAG,EAAE,mBAAmB;;EAGlE;AACD,eAAO,MAAM,6BAA6B;;CAIzC,CAAC;AAEF,wBAAgB,uBAAuB,CACnC,IAAI,EAAE,mBAAmB,EAAE,EAC3B,YAAY,EAAE,YAAY,GAC3B,mBAAmB,EAAE,CAevB;AAED,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAKzD;AAED,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEjD;AAED,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,UAU1C"}

package/lib/cjs/recommendationUtils.js

@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.cleanupMarkDown = exports.decodeMarkTag = exports.truncate = exports.replaceHighlightingData = exports.computeRecommendationAbstract = exports.computeRecommendationTitle = exports.getRecommendationAbstract = exports.getRecommendationTitle = void 0;
+const dompurify_1 = __importDefault(require("dompurify"));
 const isEmpty_1 = __importDefault(require("lodash/isEmpty"));
 function getRecommendationTitle(doc) {
     return !isEmpty_1.default(doc.publishedTitle) ? doc.publishedTitle : doc.allTitle;
@@ -15,12 +16,13 @@ function getRecommendationAbstract(doc) {
 exports.getRecommendationAbstract = getRecommendationAbstract;
 function computeRecommendationTitle(doc) {
     const title = getRecommendationTitle(doc);
-    return { __html: decodeMarkTag(title) };
+    return { __html: dompurify_1.default.sanitize(decodeMarkTag(title)) };
 }
 exports.computeRecommendationTitle = computeRecommendationTitle;
 const computeRecommendationAbstract = (doc, truncateLen = 128) => {
     const abstract = getRecommendationAbstract(doc);
-    return { __html: truncate(cleanupMarkDown(decodeMarkTag(abstract)), truncateLen) };
+    const processedAbstract = truncate(cleanupMarkDown(decodeMarkTag(abstract)), truncateLen);
+    return { __html: dompurify_1.default.sanitize(processedAbstract) };
 };
 exports.computeRecommendationAbstract = computeRecommendationAbstract;
 function replaceHighlightingData(docs, highlighting) {

package/lib/esm/customElementUtils.d.ts

@@ -0,0 +1,20 @@
+export declare enum CustomElements {
+    pfeTabs = "pfe-tabs",
+    pfeCollapse = "pfe-collapse"
+}
+interface RequireCustomElementObject {
+    /** The custom element you want to check if it has been defined */
+    element: CustomElements;
+    /** cb that will be called if the custom element has yet to be defined */
+    requireCb: () => void;
+}
+/**
+ * This function is to check if custom elements exist and require them if they do not.
+ * The check is needed because of how the packages are split and that patternfly elements
+ * use window.customElements.define without checking if it is already defined, which throws an
+ * error. Since our packages are split up and lazy loaded this check is necessary to make sure that
+ * the pfelement does not get defined twice.
+ */
+export declare function requireCustomElement(elements: RequireCustomElementObject[]): void;
+export {};
+//# sourceMappingURL=customElementUtils.d.ts.map

package/lib/esm/customElementUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"customElementUtils.d.ts","sourceRoot":"","sources":["../../src/customElementUtils.ts"],"names":[],"mappings":"AAAA,oBAAY,cAAc;IACtB,OAAO,aAAa;IACpB,WAAW,iBAAiB;CAC/B;AAED,UAAU,0BAA0B;IAChC,kEAAkE;IAClE,OAAO,EAAE,cAAc,CAAC;IAExB,yEAAyE;IACzE,SAAS,EAAE,MAAM,IAAI,CAAC;CACzB;AAED;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,0BAA0B,EAAE,QAM1E"}

package/lib/esm/customElementUtils.js

@@ -0,0 +1,19 @@
+export var CustomElements;
+(function (CustomElements) {
+    CustomElements["pfeTabs"] = "pfe-tabs";
+    CustomElements["pfeCollapse"] = "pfe-collapse";
+})(CustomElements || (CustomElements = {}));
+/**
+ * This function is to check if custom elements exist and require them if they do not.
+ * The check is needed because of how the packages are split and that patternfly elements
+ * use window.customElements.define without checking if it is already defined, which throws an
+ * error. Since our packages are split up and lazy loaded this check is necessary to make sure that
+ * the pfelement does not get defined twice.
+ */
+export function requireCustomElement(elements) {
+    elements.forEach((elementObj) => {
+        if (window.customElements.get(elementObj.element) === undefined) {
+            elementObj.requireCb();
+        }
+    });
+}

package/lib/esm/index.d.ts

@@ -19,6 +19,7 @@ export * from './searchApiUtils';
 export * from './scrollUtils';
 export * from './urlUtils';
 export * from './validatorUtils';
+export * from './customElementUtils';
 export * from './userUtils';
 export * from './styleUtils';
 export * from './translation-helper';

package/lib/esm/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,yBAAyB,CAAC;AACxC,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,wBAAwB,CAAC;AACvC,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC;AAC5B,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,kBAAkB,CAAC;AACjC,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,gCAAgC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,yBAAyB,CAAC;AACxC,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,wBAAwB,CAAC;AACvC,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC;AAC5B,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,kBAAkB,CAAC;AACjC,cAAc,sBAAsB,CAAC;AACrC,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,gCAAgC,CAAC"}

package/lib/esm/index.js

@@ -19,6 +19,7 @@ export * from './searchApiUtils';
 export * from './scrollUtils';
 export * from './urlUtils';
 export * from './validatorUtils';
+export * from './customElementUtils';
 export * from './userUtils';
 export * from './styleUtils';
 export * from './translation-helper';

package/lib/esm/recommendationUtils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"recommendationUtils.d.ts","sourceRoot":"","sources":["../../src/recommendationUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,0CAA0C,CAAC;AAG7F,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,mBAAmB,GAAG,MAAM,CAEvE;AAED,wBAAgB,yBAAyB,CAAC,GAAG,EAAE,mBAAmB,GAAG,MAAM,CAE1E;AAED,wBAAgB,0BAA0B,CAAC,GAAG,EAAE,mBAAmB;;EAGlE;AACD,eAAO,MAAM,6BAA6B;;CAGzC,CAAC;AAEF,wBAAgB,uBAAuB,CACnC,IAAI,EAAE,mBAAmB,EAAE,EAC3B,YAAY,EAAE,YAAY,GAC3B,mBAAmB,EAAE,CAevB;AAED,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAKzD;AAED,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEjD;AAED,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,UAU1C"}
+{"version":3,"file":"recommendationUtils.d.ts","sourceRoot":"","sources":["../../src/recommendationUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,0CAA0C,CAAC;AAI7F,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,mBAAmB,GAAG,MAAM,CAEvE;AAED,wBAAgB,yBAAyB,CAAC,GAAG,EAAE,mBAAmB,GAAG,MAAM,CAE1E;AAED,wBAAgB,0BAA0B,CAAC,GAAG,EAAE,mBAAmB;;EAGlE;AACD,eAAO,MAAM,6BAA6B;;CAIzC,CAAC;AAEF,wBAAgB,uBAAuB,CACnC,IAAI,EAAE,mBAAmB,EAAE,EAC3B,YAAY,EAAE,YAAY,GAC3B,mBAAmB,EAAE,CAevB;AAED,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAKzD;AAED,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEjD;AAED,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,UAU1C"}

package/lib/esm/recommendationUtils.js

@@ -1,3 +1,4 @@
+import DOMPurify from 'dompurify';
 import isEmpty from 'lodash/isEmpty';
 export function getRecommendationTitle(doc) {
     return !isEmpty(doc.publishedTitle) ? doc.publishedTitle : doc.allTitle;
@@ -7,11 +8,12 @@ export function getRecommendationAbstract(doc) {
 }
 export function computeRecommendationTitle(doc) {
     const title = getRecommendationTitle(doc);
-    return { __html: decodeMarkTag(title) };
+    return { __html: DOMPurify.sanitize(decodeMarkTag(title)) };
 }
 export const computeRecommendationAbstract = (doc, truncateLen = 128) => {
     const abstract = getRecommendationAbstract(doc);
-    return { __html: truncate(cleanupMarkDown(decodeMarkTag(abstract)), truncateLen) };
+    const processedAbstract = truncate(cleanupMarkDown(decodeMarkTag(abstract)), truncateLen);
+    return { __html: DOMPurify.sanitize(processedAbstract) };
 };
 export function replaceHighlightingData(docs, highlighting) {
     return docs.map((doc) => {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rh-support/utils",
-    "version": "2.1.1-beta.0",
+    "version": "2.1.2",
     "description": "> TODO: description",
     "author": "Vikas Rathee <vrathee@redhat.com>",
     "license": "ISC",
@@ -88,5 +88,5 @@
         "defaults and supports es6-module",
         "maintained node versions"
     ],
-    "gitHead": "26b230a88e7957f7162cbd51622a640abaa328f8"
+    "gitHead": "8f7f0aee0461c78e8a5cc0e16777371c4ae1305d"
 }