@sfirew/minecraft-motd-parser 1.1.4 → 1.1.5-dev.1

package/package.json

@@ -1,13 +1,18 @@
 {
   "name": "@sfirew/minecraft-motd-parser",
   "description": "Minecraft Server MOTD Parser, can convert to html, json, text.",
-  "version": "1.1.4",
+  "version": "1.1.5-dev.1",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
   "types": "types/index.d.ts",
   "license": "MIT",
   "scripts": {
     "test": "jest",
+    "test:coverage": "jest --coverage",
+    "test:watch": "jest --watch",
+    "test:performance": "jest --testNamePattern=\"Performance test|Stress test\"",
+    "test:security": "jest --testNamePattern=\"Security Tests\"",
+    "test:all": "jest --coverage --verbose",
     "test-self": "ts-node ./src/test.ts",
     "build": "yarn build:dist && yarn build:declarations",
     "build:dist": "tsup --format cjs,esm",

package/types/utils.d.ts

@@ -1,24 +1,31 @@
 import { motdJsonType } from "./types";
-export declare function isMotdJSONType(object: object): object is motdJsonType;
 /**
- *
- * replace all html tags to &...
+ * Base color code regex
+ */
+export declare const baseColorCodeRegex: RegExp;
+export declare function isMotdJSONType(object: any): object is motdJsonType;
+/**
+ * Replace all HTML special characters with HTML entities
+ * Prevents HTML injection by safely encoding special characters
  */
 export declare function htmlStringFormatting(text: string): string;
 /**
- * clean html tags
+ * Clean HTML tags safely
+ *
+ * Safely removes HTML tags and prevents HTML injection vulnerabilities.
  *
- * @param text
- * example: `<span>hello world</span>`
+ * @param text - Input text that may contain HTML tags
+ * @example `<span>hello world</span>` → `hello world`
  *
- * result: `hello world`
+ * @returns Clean text without HTML tags
  */
 export declare function cleanHtmlTags(text: string): string;
 /**
- * clean motd codes
+ * Clean MOTD color codes
  *
- * Clean all codes from motd source string.
+ * Clean all formatting codes from MOTD source string.
  *
- * @param {string} text - motd string include tag § will remove
+ * @param {string} text - MOTD string with § formatting codes to be removed
+ * @returns {string} Text without MOTD formatting codes
  */
 export declare function cleanCodes(text: string): string;

package/jest.config.js

@@ -1,5 +0,0 @@
-/** @type {import('ts-jest').JestConfigWithTsJest} */
-module.exports = {
-  preset: 'ts-jest',
-  testEnvironment: 'node',
-};