@xaendar/common 0.5.3 → 0.5.4

package/dist/xaendar-common.es.d.ts

@@ -1,3 +1,18 @@
+/**
+ * Asserts that a given tag name is valid for use as a custom element name.
+ * A valid custom element name must:
+ * - contain a hyphen
+ * - no spaces.
+ * - start with a lowercase letter.
+ * - not contain uppercase letters.
+ * - not contain the following chars: '@', '#', '$', '%', '&', '*', '!', '?', '/', '\\', '|', "'", '"', '<', '>', '='
+ * - not be a native HTML tag name.
+ * - not be a reserved tag name.
+ * @param tagName The tag name to validate.
+ * @throws Will throw an error if the tag name is invalid.
+ */
+export declare function assertIsValidElementName(tagName: string): void;
+
 /**
  * Indents each line of a code block by two spaces.
  * @param lines The lines of code to indent.

package/dist/xaendar-common.es.js

@@ -55,4 +55,176 @@ function indent(...lines) {
 	return lines.map((line) => `  ${line}`);
 }
 //#endregion
-export { Stack, indent };
+//#region ../packages/common/src/costants/base-tags.constants.ts
+/**
+* List of all standard, valid HTML tags in Xaendar Components's Template
+* 
+* These are native HTML elements and should not be used as custom element names.
+*/
+var HTML_TAGS = [
+	"section",
+	"article",
+	"aside",
+	"nav",
+	"header",
+	"footer",
+	"address",
+	"h1",
+	"h2",
+	"h3",
+	"h4",
+	"h5",
+	"h6",
+	"p",
+	"hr",
+	"pre",
+	"blockquote",
+	"ol",
+	"ul",
+	"li",
+	"dl",
+	"dt",
+	"dd",
+	"figure",
+	"figcaption",
+	"div",
+	"a",
+	"span",
+	"br",
+	"wbr",
+	"b",
+	"strong",
+	"i",
+	"em",
+	"u",
+	"s",
+	"mark",
+	"small",
+	"sub",
+	"sup",
+	"abbr",
+	"cite",
+	"code",
+	"var",
+	"kbd",
+	"samp",
+	"time",
+	"data",
+	"dfn",
+	"q",
+	"ruby",
+	"rt",
+	"rp",
+	"bdi",
+	"bdo",
+	"ins",
+	"del",
+	"img",
+	"iframe",
+	"embed",
+	"object",
+	"param",
+	"picture",
+	"source",
+	"track",
+	"video",
+	"audio",
+	"map",
+	"area",
+	"table",
+	"caption",
+	"colgroup",
+	"col",
+	"tbody",
+	"thead",
+	"tfoot",
+	"tr",
+	"td",
+	"th",
+	"form",
+	"label",
+	"input",
+	"button",
+	"select",
+	"datalist",
+	"optgroup",
+	"option",
+	"textarea",
+	"output",
+	"progress",
+	"meter",
+	"fieldset",
+	"legend",
+	"details",
+	"summary",
+	"dialog",
+	"template",
+	"slot",
+	"canvas"
+];
+//#endregion
+//#region ../packages/common/src/costants/not-alllowed-tags.constants.ts
+/**
+* List of strings not allowed as names for CustomElements
+*/
+var NOT_ALLOWED_TAGS = [
+	"annotation-xml",
+	"color-profile",
+	"font-face",
+	"font-face-src",
+	"font-face-uri",
+	"font-face-format",
+	"font-face-name",
+	"missing-glyph"
+];
+//#endregion
+//#region ../packages/common/src/utils/tags/tags.utils.ts
+/**
+* Asserts that a given tag name is valid for use as a custom element name.
+* A valid custom element name must:
+* - contain a hyphen
+* - no spaces.
+* - start with a lowercase letter.
+* - not contain uppercase letters.
+* - not contain the following chars: '@', '#', '$', '%', '&', '*', '!', '?', '/', '\\', '|', "'", '"', '<', '>', '='
+* - not be a native HTML tag name.
+* - not be a reserved tag name.
+* @param tagName The tag name to validate.
+* @throws Will throw an error if the tag name is invalid.
+*/
+function assertIsValidElementName(tagName) {
+	if (!/^[a-z][a-z0-9._\-]*-[a-z0-9._\-]*$/.test(tagName)) throw new Error(`Tag <${tagName}> is not a valid custom element name. Custom element names must:
+- contain a hyphen
+- no spaces. 
+- start with a lowercase letter. 
+- not contain uppercase letters. 
+- not contain the following chars: '@', '#', '$', '%', '&', '*', '!', '?', '/', '\\', '|', "'", '"', '<', '>', '='
+`);
+	if (isNativeHTMLTag(tagName)) throw new Error(`Tag <${tagName}> is a native HTML tag and cannot be used as a custom element name.`);
+	if (isReservedTagName(tagName)) throw new Error(`Tag <${tagName}> is a reserved tag name and cannot be used as a custom element name.
+Reserved names are: 
+- ${NOT_ALLOWED_TAGS.join("\n- ")}`);
+}
+/**
+* Checks if a tag name is a native HTML tag.
+* 
+* @param tagName - The tag name to check.
+* @returns `true` if the tag name is a standard HTML tag, `false` otherwise.
+*/
+function isNativeHTMLTag(tagName) {
+	return HTML_TAGS.includes(tagName);
+}
+/**
+* Checks if a tag name is reserved and cannot be used for a custom element.
+* 
+* Reserved names include certain HTML, SVG, or other names that are forbidden by the specification.
+* https://html.spec.whatwg.org/multipage/custom-elements.html#valid-custom-element-name
+* 
+* @param tagName - The tag name to check.
+* @returns `true` if the tag name is reserved, `false` otherwise.
+*/
+function isReservedTagName(tagName) {
+	return NOT_ALLOWED_TAGS.includes(tagName);
+}
+//#endregion
+export { Stack, assertIsValidElementName, indent };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xaendar/common",
-  "version": "0.5.3",
+  "version": "0.5.4",
   "description": "A library containing common classes and utilities",
   "sideEffects": false,
   "type": "module",