@learnpress/utils 0.2.0 → 0.3.0

package/README.md

@@ -8,8 +8,28 @@ Shared utility helpers for LearnPress packages.
 npm install @learnpress/utils
 ```
 
-## Usage
+## API
+
+### `stripHtml(html: string): string`
+
+Strip all HTML tags and decode HTML entities, returning trimmed plain text. Useful for titles, excerpts, or any place you need a clean text version of rendered HTML.
 
 ```ts
-import { isString, isObject } from "@learnpress/utils";
+import { stripHtml } from "@learnpress/utils";
+
+stripHtml("<p>Hello &amp; <strong>world</strong></p>");
+// "Hello & world"
+```
+
+### `sanitizeHtml(html: string): string`
+
+Sanitize an HTML string for safe rendering. Allows a curated set of tags and attributes commonly used in WordPress post content (`img`, `figure`, `iframe`, `video`, `audio`, `source`, `track`, …), plus safe iframe embeds from YouTube and Vimeo. External links with `target="_blank"` automatically get `rel="noopener noreferrer"`.
+
+```tsx
+import parse from "html-react-parser";
+import { sanitizeHtml } from "@learnpress/utils";
+
+export function HtmlContent({ html }: { html: string }) {
+  return <div>{parse(sanitizeHtml(html))}</div>;
+}
 ```

package/dist/index.cjs

@@ -16,7 +16,7 @@ var __copyProps = (to, from, except, desc) => {
 	}
 	return to;
 };
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule || !__hasOwnProp.call(mod, "default") ? __defProp(target, "default", {
 	value: mod,
 	enumerable: true
 }) : target, mod));
@@ -24,6 +24,7 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 let entities = require("entities");
 let sanitize_html = require("sanitize-html");
 sanitize_html = __toESM(sanitize_html, 1);
+let tailwind_variants = require("tailwind-variants");
 //#region src/html.ts
 const stripHtml = (html) => (0, entities.decodeHTML)(html.replace(/<[^>]*>/g, "")).trim();
 const sanitizeHtml = (html) => (0, sanitize_html.default)(html, {
@@ -127,15 +128,17 @@ const sanitizeHtml = (html) => (0, sanitize_html.default)(html, {
 	}) }
 });
 //#endregion
-//#region src/is.ts
-const isString = (value) => typeof value === "string";
-const isNumber = (value) => typeof value === "number" && !Number.isNaN(value);
-const isObject = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
-const isNil = (value) => value == null;
-//#endregion
-exports.isNil = isNil;
-exports.isNumber = isNumber;
-exports.isObject = isObject;
-exports.isString = isString;
+Object.defineProperty(exports, "cn", {
+	enumerable: true,
+	get: function() {
+		return tailwind_variants.cn;
+	}
+});
 exports.sanitizeHtml = sanitizeHtml;
 exports.stripHtml = stripHtml;
+Object.defineProperty(exports, "tv", {
+	enumerable: true,
+	get: function() {
+		return tailwind_variants.tv;
+	}
+});

package/dist/index.d.cts

@@ -1,12 +1,7 @@
+import { VariantProps, cn, tv } from "tailwind-variants";
 //#region src/html.d.ts
-declare const stripHtml: (html: string) => string;
-declare const sanitizeHtml: (html: string) => string;
+export declare const stripHtml: (html: string) => string;
+export declare const sanitizeHtml: (html: string) => string;
 //#endregion
-//#region src/is.d.ts
-declare const isString: (value: unknown) => value is string;
-declare const isNumber: (value: unknown) => value is number;
-declare const isObject: (value: unknown) => value is Record<string, unknown>;
-declare const isNil: (value: unknown) => value is null | undefined;
-//#endregion
-export { isNil, isNumber, isObject, isString, sanitizeHtml, stripHtml };
+export { type VariantProps, cn, tv };
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","names":[],"sources":["../src/html.ts","../src/is.ts"],"mappings":";cAGa,SAAA,GAAa,IAAA;AAAA,cAEb,YAAA,GAAgB,IAAA;;;cCLhB,QAAA,GAAY,KAAA,cAAiB,KAAA;AAAA,cAE7B,QAAA,GAAY,KAAA,cAAiB,KAAA;AAAA,cAG7B,QAAA,GAAY,KAAA,cAAiB,KAAA,IAAS,MAAA;AAAA,cAGtC,KAAA,GAAS,KAAA,cAAiB,KAAA"}
+{"version":3,"file":"index.d.cts","names":[],"sources":["../src/html.ts"],"mappings":";;qBAGa,YAAS;qBAET,eAAY"}

package/dist/index.d.ts

@@ -1,12 +1,7 @@
+import { VariantProps, cn, tv } from "tailwind-variants";
 //#region src/html.d.ts
-declare const stripHtml: (html: string) => string;
-declare const sanitizeHtml: (html: string) => string;
+export declare const stripHtml: (html: string) => string;
+export declare const sanitizeHtml: (html: string) => string;
 //#endregion
-//#region src/is.d.ts
-declare const isString: (value: unknown) => value is string;
-declare const isNumber: (value: unknown) => value is number;
-declare const isObject: (value: unknown) => value is Record<string, unknown>;
-declare const isNil: (value: unknown) => value is null | undefined;
-//#endregion
-export { isNil, isNumber, isObject, isString, sanitizeHtml, stripHtml };
+export { type VariantProps, cn, tv };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","names":[],"sources":["../src/html.ts","../src/is.ts"],"mappings":";cAGa,SAAA,GAAa,IAAA;AAAA,cAEb,YAAA,GAAgB,IAAA;;;cCLhB,QAAA,GAAY,KAAA,cAAiB,KAAA;AAAA,cAE7B,QAAA,GAAY,KAAA,cAAiB,KAAA;AAAA,cAG7B,QAAA,GAAY,KAAA,cAAiB,KAAA,IAAS,MAAA;AAAA,cAGtC,KAAA,GAAS,KAAA,cAAiB,KAAA"}
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/html.ts"],"mappings":";;qBAGa,YAAS;qBAET,eAAY"}

package/dist/index.js

@@ -1,5 +1,6 @@
 import { decodeHTML } from "entities";
 import sanitizeHtmlLib from "sanitize-html";
+import { cn, tv } from "tailwind-variants";
 //#region src/html.ts
 const stripHtml = (html) => decodeHTML(html.replace(/<[^>]*>/g, "")).trim();
 const sanitizeHtml = (html) => sanitizeHtmlLib(html, {
@@ -103,12 +104,6 @@ const sanitizeHtml = (html) => sanitizeHtmlLib(html, {
 	}) }
 });
 //#endregion
-//#region src/is.ts
-const isString = (value) => typeof value === "string";
-const isNumber = (value) => typeof value === "number" && !Number.isNaN(value);
-const isObject = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
-const isNil = (value) => value == null;
-//#endregion
-export { isNil, isNumber, isObject, isString, sanitizeHtml, stripHtml };
+export { cn, sanitizeHtml, stripHtml, tv };
 
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../src/html.ts","../src/is.ts"],"sourcesContent":["import { decodeHTML } from \"entities\";\nimport sanitizeHtmlLib from \"sanitize-html\";\n\nexport const stripHtml = (html: string): string => decodeHTML(html.replace(/<[^>]*>/g, \"\")).trim();\n\nexport const sanitizeHtml = (html: string): string =>\n  sanitizeHtmlLib(html, {\n    allowedTags: sanitizeHtmlLib.defaults.allowedTags.concat([\n      \"img\",\n      \"figure\",\n      \"figcaption\",\n      \"iframe\",\n      \"video\",\n      \"audio\",\n      \"source\",\n      \"track\",\n    ]),\n    allowedAttributes: {\n      ...sanitizeHtmlLib.defaults.allowedAttributes,\n      \"*\": [\"class\", \"id\", \"style\"],\n      img: [\"src\", \"srcset\", \"sizes\", \"alt\", \"width\", \"height\", \"loading\", \"decoding\"],\n      a: [\"href\", \"name\", \"target\", \"rel\", \"title\"],\n      iframe: [\"src\", \"width\", \"height\", \"frameborder\", \"allow\", \"allowfullscreen\"],\n      video: [\n        \"src\",\n        \"controls\",\n        \"poster\",\n        \"width\",\n        \"height\",\n        \"preload\",\n        \"playsinline\",\n        \"muted\",\n        \"loop\",\n        \"autoplay\",\n      ],\n      audio: [\"src\", \"controls\", \"preload\", \"loop\", \"autoplay\"],\n      source: [\"src\", \"type\", \"media\"],\n      track: [\"src\", \"kind\", \"srclang\", \"label\", \"default\"],\n    },\n    allowedSchemes: [\"http\", \"https\", \"mailto\", \"tel\", \"data\"],\n    allowedSchemesByTag: { img: [\"http\", \"https\", \"data\"] },\n    allowedIframeHostnames: [\"www.youtube.com\", \"youtube.com\", \"player.vimeo.com\"],\n    transformTags: {\n      a: (tagName, attribs) => ({\n        tagName,\n        attribs: {\n          ...attribs,\n          ...(attribs.target === \"_blank\" ? { rel: \"noopener noreferrer\" } : {}),\n        },\n      }),\n    },\n  });\n","export const isString = (value: unknown): value is string => typeof value === \"string\";\n\nexport const isNumber = (value: unknown): value is number =>\n  typeof value === \"number\" && !Number.isNaN(value);\n\nexport const isObject = (value: unknown): value is Record<string, unknown> =>\n  typeof value === \"object\" && value !== null && !Array.isArray(value);\n\nexport const isNil = (value: unknown): value is null | undefined => value == null;\n"],"mappings":";;;AAGA,MAAa,aAAa,SAAyB,WAAW,KAAK,QAAQ,YAAY,GAAG,CAAC,CAAC,MAAM;AAElG,MAAa,gBAAgB,SAC3B,gBAAgB,MAAM;CACpB,aAAa,gBAAgB,SAAS,YAAY,OAAO;EACvD;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACD,CAAC;CACF,mBAAmB;EACjB,GAAG,gBAAgB,SAAS;EAC5B,KAAK;GAAC;GAAS;GAAM;GAAQ;EAC7B,KAAK;GAAC;GAAO;GAAU;GAAS;GAAO;GAAS;GAAU;GAAW;GAAW;EAChF,GAAG;GAAC;GAAQ;GAAQ;GAAU;GAAO;GAAQ;EAC7C,QAAQ;GAAC;GAAO;GAAS;GAAU;GAAe;GAAS;GAAkB;EAC7E,OAAO;GACL;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACD;EACD,OAAO;GAAC;GAAO;GAAY;GAAW;GAAQ;GAAW;EACzD,QAAQ;GAAC;GAAO;GAAQ;GAAQ;EAChC,OAAO;GAAC;GAAO;GAAQ;GAAW;GAAS;GAAU;EACtD;CACD,gBAAgB;EAAC;EAAQ;EAAS;EAAU;EAAO;EAAO;CAC1D,qBAAqB,EAAE,KAAK;EAAC;EAAQ;EAAS;EAAO,EAAE;CACvD,wBAAwB;EAAC;EAAmB;EAAe;EAAmB;CAC9E,eAAe,EACb,IAAI,SAAS,aAAa;EACxB;EACA,SAAS;GACP,GAAG;GACH,GAAI,QAAQ,WAAW,WAAW,EAAE,KAAK,uBAAuB,GAAG,EAAE;GACtE;EACF,GACF;CACF,CAAC;;;ACnDJ,MAAa,YAAY,UAAoC,OAAO,UAAU;AAE9E,MAAa,YAAY,UACvB,OAAO,UAAU,YAAY,CAAC,OAAO,MAAM,MAAM;AAEnD,MAAa,YAAY,UACvB,OAAO,UAAU,YAAY,UAAU,QAAQ,CAAC,MAAM,QAAQ,MAAM;AAEtE,MAAa,SAAS,UAA8C,SAAS"}
+{"version":3,"file":"index.js","names":[],"sources":["../src/html.ts"],"sourcesContent":["import { decodeHTML } from \"entities\";\nimport sanitizeHtmlLib from \"sanitize-html\";\n\nexport const stripHtml = (html: string): string => decodeHTML(html.replace(/<[^>]*>/g, \"\")).trim();\n\nexport const sanitizeHtml = (html: string): string =>\n  sanitizeHtmlLib(html, {\n    allowedTags: sanitizeHtmlLib.defaults.allowedTags.concat([\n      \"img\",\n      \"figure\",\n      \"figcaption\",\n      \"iframe\",\n      \"video\",\n      \"audio\",\n      \"source\",\n      \"track\",\n    ]),\n    allowedAttributes: {\n      ...sanitizeHtmlLib.defaults.allowedAttributes,\n      \"*\": [\"class\", \"id\", \"style\"],\n      img: [\"src\", \"srcset\", \"sizes\", \"alt\", \"width\", \"height\", \"loading\", \"decoding\"],\n      a: [\"href\", \"name\", \"target\", \"rel\", \"title\"],\n      iframe: [\"src\", \"width\", \"height\", \"frameborder\", \"allow\", \"allowfullscreen\"],\n      video: [\n        \"src\",\n        \"controls\",\n        \"poster\",\n        \"width\",\n        \"height\",\n        \"preload\",\n        \"playsinline\",\n        \"muted\",\n        \"loop\",\n        \"autoplay\",\n      ],\n      audio: [\"src\", \"controls\", \"preload\", \"loop\", \"autoplay\"],\n      source: [\"src\", \"type\", \"media\"],\n      track: [\"src\", \"kind\", \"srclang\", \"label\", \"default\"],\n    },\n    allowedSchemes: [\"http\", \"https\", \"mailto\", \"tel\", \"data\"],\n    allowedSchemesByTag: { img: [\"http\", \"https\", \"data\"] },\n    allowedIframeHostnames: [\"www.youtube.com\", \"youtube.com\", \"player.vimeo.com\"],\n    transformTags: {\n      a: (tagName, attribs) => ({\n        tagName,\n        attribs: {\n          ...attribs,\n          ...(attribs.target === \"_blank\" ? { rel: \"noopener noreferrer\" } : {}),\n        },\n      }),\n    },\n  });\n"],"mappings":";;;;AAGA,MAAa,aAAa,SAAyB,WAAW,KAAK,QAAQ,YAAY,EAAE,CAAC,CAAC,CAAC,KAAK;AAEjG,MAAa,gBAAgB,SAC3B,gBAAgB,MAAM;CACpB,aAAa,gBAAgB,SAAS,YAAY,OAAO;EACvD;EACA;EACA;EACA;EACA;EACA;EACA;EACA;CACF,CAAC;CACD,mBAAmB;EACjB,GAAG,gBAAgB,SAAS;EAC5B,KAAK;GAAC;GAAS;GAAM;EAAO;EAC5B,KAAK;GAAC;GAAO;GAAU;GAAS;GAAO;GAAS;GAAU;GAAW;EAAU;EAC/E,GAAG;GAAC;GAAQ;GAAQ;GAAU;GAAO;EAAO;EAC5C,QAAQ;GAAC;GAAO;GAAS;GAAU;GAAe;GAAS;EAAiB;EAC5E,OAAO;GACL;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;EACF;EACA,OAAO;GAAC;GAAO;GAAY;GAAW;GAAQ;EAAU;EACxD,QAAQ;GAAC;GAAO;GAAQ;EAAO;EAC/B,OAAO;GAAC;GAAO;GAAQ;GAAW;GAAS;EAAS;CACtD;CACA,gBAAgB;EAAC;EAAQ;EAAS;EAAU;EAAO;CAAM;CACzD,qBAAqB,EAAE,KAAK;EAAC;EAAQ;EAAS;CAAM,EAAE;CACtD,wBAAwB;EAAC;EAAmB;EAAe;CAAkB;CAC7E,eAAe,EACb,IAAI,SAAS,aAAa;EACxB;EACA,SAAS;GACP,GAAG;GACH,GAAI,QAAQ,WAAW,WAAW,EAAE,KAAK,sBAAsB,IAAI,CAAC;EACtE;CACF,GACF;AACF,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@learnpress/utils",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Shared utility helpers for LearnPress packages",
   "keywords": [
     "learnpress",
@@ -41,7 +41,9 @@
   },
   "dependencies": {
     "entities": "^8.0.0",
-    "sanitize-html": "^2.17.3"
+    "sanitize-html": "^2.17.7",
+    "tailwind-merge": "^3.6.0",
+    "tailwind-variants": "^3.3.1"
   },
   "devDependencies": {
     "@types/sanitize-html": "^2.16.1",