Compare commits
7 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 4c60f52b5e | |||
| 35c14d01c2 | |||
| 92f36fdb5b | |||
| 721fe2dcf8 | |||
| 4dfd70f6a7 | |||
| af5054192e | |||
| b7df327cd5 |
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@ztimson/utils",
|
"name": "@ztimson/utils",
|
||||||
"version": "0.30.3",
|
"version": "0.30.8",
|
||||||
"description": "Utility library",
|
"description": "Utility library",
|
||||||
"author": "Zak Timson",
|
"author": "Zak Timson",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
|
|||||||
24
src/html.ts
24
src/html.ts
@@ -26,6 +26,9 @@ export function decodeHtml(html: string) {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Parse markdown headers
|
* Parse markdown headers
|
||||||
|
*
|
||||||
|
* **NOTE: frontmatter parsing only works 2 layers deep**
|
||||||
|
*
|
||||||
* @param {string} content
|
* @param {string} content
|
||||||
* @returns {{meta: any, content: string} | {meta: {}, content: string}}
|
* @returns {{meta: any, content: string} | {meta: {}, content: string}}
|
||||||
*/
|
*/
|
||||||
@@ -34,12 +37,29 @@ export function parseMarkdown(content: string) {
|
|||||||
if (!match) return {meta: {}, content};
|
if (!match) return {meta: {}, content};
|
||||||
|
|
||||||
const meta: any = {};
|
const meta: any = {};
|
||||||
for (const line of match[1].split('\n')) {
|
let currentParent: string | null = null;
|
||||||
|
|
||||||
|
for (const rawLine of match[1].split('\n')) {
|
||||||
|
if (!rawLine.trim()) continue;
|
||||||
|
const indented = /^\s+/.test(rawLine);
|
||||||
|
const line = rawLine.trim();
|
||||||
const colonIdx = line.indexOf(':');
|
const colonIdx = line.indexOf(':');
|
||||||
if (colonIdx === -1) continue;
|
if (colonIdx === -1) continue;
|
||||||
|
|
||||||
const key = line.slice(0, colonIdx).trim();
|
const key = line.slice(0, colonIdx).trim();
|
||||||
const value = line.slice(colonIdx + 1).trim();
|
const value = line.slice(colonIdx + 1).trim();
|
||||||
try { meta[key] = JSON.parse(value); } catch { meta[key] = value; }
|
|
||||||
|
let parsed: any = value;
|
||||||
|
try { parsed = JSON.parse(value); } catch {}
|
||||||
|
|
||||||
|
if (!indented) {
|
||||||
|
currentParent = value === '' ? key : null;
|
||||||
|
if (value === '') meta[key] = {};
|
||||||
|
else meta[key] = parsed;
|
||||||
|
} else if (currentParent) {
|
||||||
|
meta[currentParent][key] = parsed;
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
return {meta, content: match[2].trim()};
|
return {meta, content: match[2].trim()};
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -12,6 +12,7 @@ export * from './errors';
|
|||||||
export * from './files';
|
export * from './files';
|
||||||
export * from './html';
|
export * from './html';
|
||||||
export * from './http';
|
export * from './http';
|
||||||
|
export * from './ip';
|
||||||
export * from './json';
|
export * from './json';
|
||||||
export * from './jwt';
|
export * from './jwt';
|
||||||
export * from './logger';
|
export * from './logger';
|
||||||
|
|||||||
77
src/ip.ts
Normal file
77
src/ip.ts
Normal file
@@ -0,0 +1,77 @@
|
|||||||
|
/**
|
||||||
|
* Check if IP address falls within any of the given CIDR ranges
|
||||||
|
* @param {string} ip IPV4 to check (192.168.0.12)
|
||||||
|
* @param {...string} cidrs IP ranges to check against (example: 192.168.0.0/24)
|
||||||
|
* @returns {boolean} Whether IP address is within any range
|
||||||
|
*/
|
||||||
|
export function matchesCidr(ip: string, ...cidrs: string[]): boolean {
|
||||||
|
if (!ip) return false;
|
||||||
|
if (!cidrs.length) return true;
|
||||||
|
const ipToInt = (str: string) => str.split('.')
|
||||||
|
.reduce((int, octet) => (int << 8) + parseInt(octet), 0) >>> 0;
|
||||||
|
return cidrs.some(cidr => {
|
||||||
|
if (!cidr) return true;
|
||||||
|
if (!cidr.includes('/')) return ip === cidr; // Single IP
|
||||||
|
const [range, bits] = cidr.split('/');
|
||||||
|
const mask = ~(2 ** (32 - parseInt(bits)) - 1);
|
||||||
|
return (ipToInt(ip) & mask) === (ipToInt(range) & mask);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Convert IPv6 to v4 because who uses that, NAT4Life
|
||||||
|
* @param {string} ip IPv6 address, e.g. 2001:0db8:85a3:0000:0000:8a2e:0370:7334
|
||||||
|
* @returns {string | null} IPv4 address, e.g. 172.16.58.3
|
||||||
|
*/
|
||||||
|
export function ipV6ToV4(ip: string) {
|
||||||
|
if(!ip) return null;
|
||||||
|
const ipv4 = ip.split(':').splice(-1)[0];
|
||||||
|
if(ipv4 == '1') return '127.0.0.1';
|
||||||
|
return ipv4;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @deprecated Use isReserved
|
||||||
|
*
|
||||||
|
* Check if IP is reserved, e.g. localhost, private IPs, etc.
|
||||||
|
* @param {string} ip
|
||||||
|
* @returns {boolean}
|
||||||
|
*/
|
||||||
|
export function reservedIp(ip: string): boolean {
|
||||||
|
if(ip == 'localhost' || ip == '127.0.0.1') return true;
|
||||||
|
return /\b(10\.(?:[0-9]{1,3}\.){2}[0-9]{1,3})\b|\b(172\.(?:1[6-9]|2[0-9]|3[0-1])\.(?:[0-9]{1,3}\.)[0-9]{1,3})\b|\b(192\.168\.(?:[0-9]{1,3}\.)[0-9]{1,3})\b/.test(ip);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Check if IP is within a reserved range
|
||||||
|
* @param {string} ip
|
||||||
|
* @returns {null | 'Invalid' | 'Host' | 'Loopback' | 'Private (Class A)' | 'Private (Class B)' | 'Link-Local' | 'IETF Protocol Assignments' | 'Documentation (TEST-NET-1)' | 'Benchmarking' | 'Documentation (TEST-NET-2)' | 'Documentation (TEST-NET-3)' | 'Multicast' | 'Reserved (Class E)'} null if public, class name if reserved
|
||||||
|
*/
|
||||||
|
export function isReserved(ip: string): null | 'Invalid' | 'Host' | 'Loopback' | 'Private (Class A)' | 'Private (Class B)' | 'Link-Local' | 'IETF Protocol Assignments' | 'Documentation (TEST-NET-1)' | 'Benchmarking' | 'Documentation (TEST-NET-2)' | 'Documentation (TEST-NET-3)' | 'Multicast' | 'Reserved (Class E)' {
|
||||||
|
const ipToNumber = (ip: string) => {
|
||||||
|
return ip.split('.').reduce((acc: number, octet: string) => (acc << 8) + parseInt(octet, 10), 0) >>> 0;
|
||||||
|
};
|
||||||
|
|
||||||
|
const ipNum = ipToNumber(ip);
|
||||||
|
if (ipNum === null) return 'Invalid';
|
||||||
|
|
||||||
|
const reserved = [
|
||||||
|
{ name: "Host", start: ipToNumber("0.0.0.0"), end: ipToNumber("0.255.255.255") },
|
||||||
|
{ name: "Loopback", start: ipToNumber("127.0.0.0"), end: ipToNumber("127.255.255.255") },
|
||||||
|
{ name: "Private (Class A)", start: ipToNumber("10.0.0.0"), end: ipToNumber("10.255.255.255") },
|
||||||
|
{ name: "CGNAT", start: ipToNumber("100.64.0.0"), end: ipToNumber("100.127.255.255") },
|
||||||
|
{ name: "Private (Class B)", start: ipToNumber("172.16.0.0"), end: ipToNumber("172.31.255.255") },
|
||||||
|
{ name: "Private (Class C)", start: ipToNumber("192.168.0.0"), end: ipToNumber("192.168.255.255") },
|
||||||
|
{ name: "Link-Local", start: ipToNumber("169.254.0.0"), end: ipToNumber("169.254.255.255") },
|
||||||
|
{ name: "IETF Protocol Assignments", start: ipToNumber("192.0.0.0"), end: ipToNumber("192.0.0.255") },
|
||||||
|
{ name: "Documentation (TEST-NET-1)", start: ipToNumber("192.0.2.0"), end: ipToNumber("192.0.2.255") },
|
||||||
|
{ name: "Benchmarking", start: ipToNumber("198.18.0.0"), end: ipToNumber("198.19.255.255") },
|
||||||
|
{ name: "Documentation (TEST-NET-2)", start: ipToNumber("198.51.100.0"), end: ipToNumber("198.51.100.255") },
|
||||||
|
{ name: "Documentation (TEST-NET-3)", start: ipToNumber("203.0.113.0"), end: ipToNumber("203.0.113.255") },
|
||||||
|
{ name: "Multicast", start: ipToNumber("224.0.0.0"), end: ipToNumber("239.255.255.255") },
|
||||||
|
{ name: "Reserved (Class E)", start: ipToNumber("240.0.0.0"), end: ipToNumber("255.255.255.255") }
|
||||||
|
];
|
||||||
|
|
||||||
|
const match = reserved.find(r => ipNum >= r.start && ipNum <= r.end);
|
||||||
|
return match ? <any>match.name : null;
|
||||||
|
}
|
||||||
40
src/misc.ts
40
src/misc.ts
@@ -76,46 +76,6 @@ export function gravatar(email: string, def='mp') {
|
|||||||
return `https://www.gravatar.com/avatar/${md5(email)}?d=${def}`;
|
return `https://www.gravatar.com/avatar/${md5(email)}?d=${def}`;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Check if IP address falls within CIDR range
|
|
||||||
* @param {string} ip IPV4 to check (192.168.0.12)
|
|
||||||
* @param {string} cidr IP range to check against (example: 192.168.0.0/24)
|
|
||||||
* @returns {boolean} Whether IP address is within range
|
|
||||||
*/
|
|
||||||
export function matchesCidr(ip: string, cidr: string): boolean {
|
|
||||||
if(!cidr) return true;
|
|
||||||
if(!ip) return false;
|
|
||||||
if(!cidr?.includes('/')) return ip === cidr; // Single IP
|
|
||||||
const [range, bits] = cidr.split('/');
|
|
||||||
const mask = ~(2 ** (32 - parseInt(bits)) - 1);
|
|
||||||
const ipToInt = (str: string) => str.split('.')
|
|
||||||
.reduce((int, octet) => (int << 8) + parseInt(octet), 0) >>> 0;
|
|
||||||
return (ipToInt(ip) & mask) === (ipToInt(range) & mask);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Convert IPv6 to v4 because who uses that, NAT4Life
|
|
||||||
* @param {string} ip IPv6 address, e.g. 2001:0db8:85a3:0000:0000:8a2e:0370:7334
|
|
||||||
* @returns {string | null} IPv4 address, e.g. 172.16.58.3
|
|
||||||
*/
|
|
||||||
export function ipV6ToV4(ip: string) {
|
|
||||||
if(!ip) return null;
|
|
||||||
const ipv4 = ip.split(':').splice(-1)[0];
|
|
||||||
if(ipv4 == '1') return '127.0.0.1';
|
|
||||||
return ipv4;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Check if IP is reserved, e.g. localhost, private IPs, etc.
|
|
||||||
* @param {string} ip
|
|
||||||
* @returns {boolean}
|
|
||||||
*/
|
|
||||||
export function reservedIp(ip: string): boolean {
|
|
||||||
if(ip == 'localhost' || ip == '127.0.0.1') return true;
|
|
||||||
return /\b(10\.(?:[0-9]{1,3}\.){2}[0-9]{1,3})\b|\b(172\.(?:1[6-9]|2[0-9]|3[0-1])\.(?:[0-9]{1,3}\.)[0-9]{1,3})\b|\b(192\.168\.(?:[0-9]{1,3}\.)[0-9]{1,3})\b/.test(ip);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Represents a function that listens for events and handles them accordingly.
|
* Represents a function that listens for events and handles them accordingly.
|
||||||
*
|
*
|
||||||
|
|||||||
@@ -97,8 +97,10 @@ export function deepCopy<T>(value: T): T {
|
|||||||
* @return {any} The des
|
* @return {any} The des
|
||||||
*/
|
*/
|
||||||
export function deepMerge<T>(target: any, ...sources: any[]): T {
|
export function deepMerge<T>(target: any, ...sources: any[]): T {
|
||||||
|
const BLOCKED = new Set(['__proto__', 'constructor', 'prototype']);
|
||||||
sources.forEach(s => {
|
sources.forEach(s => {
|
||||||
for(const key in s) {
|
for(const key in s) {
|
||||||
|
if(BLOCKED.has(key) || !Object.prototype.hasOwnProperty.call(s, key)) continue;
|
||||||
if(s[key] && typeof s[key] == 'object' && !Array.isArray(s[key])) {
|
if(s[key] && typeof s[key] == 'object' && !Array.isArray(s[key])) {
|
||||||
if(!target[key]) target[key] = {};
|
if(!target[key]) target[key] = {};
|
||||||
deepMerge(target[key], s[key]);
|
deepMerge(target[key], s[key]);
|
||||||
|
|||||||
26
src/xml.ts
26
src/xml.ts
@@ -1,12 +1,12 @@
|
|||||||
/**
|
/**
|
||||||
* Parses an XML string into a structured JavaScript object.
|
* Parses an XML string into a plain JavaScript object.
|
||||||
|
* Each tag becomes a key. Attributes and child tags are merged as
|
||||||
|
* sibling properties on that tag's object. Duplicate tag/attribute
|
||||||
|
* names are collapsed into arrays. Text-only tags resolve to their
|
||||||
|
* (optionally numeric) value; if a tag has both text and attributes/
|
||||||
|
* children, the text is kept under a `_text` key.
|
||||||
* @param {string} xml - The XML string to parse
|
* @param {string} xml - The XML string to parse
|
||||||
* @returns {Object} An object with `tag`, `attributes`, and `children` properties
|
* @returns {Object} The parsed object tree
|
||||||
*/
|
|
||||||
/**
|
|
||||||
* Parses an XML string into a structured JavaScript object (fast-xml-parser format).
|
|
||||||
* @param {string} xml - The XML string to parse
|
|
||||||
* @returns {Object} An object with tag names as keys and text content or nested objects as values
|
|
||||||
*/
|
*/
|
||||||
export function fromXml(xml: string) {
|
export function fromXml(xml: string) {
|
||||||
xml = xml.trim();
|
xml = xml.trim();
|
||||||
@@ -33,11 +33,11 @@ export function fromXml(xml: string) {
|
|||||||
|
|
||||||
if(xml[pos] === '/' && xml[pos + 1] === '>') {
|
if(xml[pos] === '/' && xml[pos + 1] === '>') {
|
||||||
pos += 2; // skip />
|
pos += 2; // skip />
|
||||||
return { [tagName]: '' };
|
return { [tagName]: Object.keys(attributes).length ? attributes : '' };
|
||||||
}
|
}
|
||||||
|
|
||||||
pos++; // skip >
|
pos++; // skip >
|
||||||
const children: any[] = [];
|
const children: any[] = Object.entries(attributes).map(([k, v]) => ({ [k]: v }));
|
||||||
let textContent = '';
|
let textContent = '';
|
||||||
|
|
||||||
while(pos < xml.length) {
|
while(pos < xml.length) {
|
||||||
@@ -49,7 +49,6 @@ export function fromXml(xml: string) {
|
|||||||
pos++; // skip >
|
pos++; // skip >
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
const startPos = pos;
|
|
||||||
const child = parseNode();
|
const child = parseNode();
|
||||||
if(typeof child === 'string') {
|
if(typeof child === 'string') {
|
||||||
textContent += child;
|
textContent += child;
|
||||||
@@ -64,17 +63,18 @@ export function fromXml(xml: string) {
|
|||||||
return { [tagName]: value };
|
return { [tagName]: value };
|
||||||
}
|
}
|
||||||
|
|
||||||
// If only text with no children
|
// If nothing at all
|
||||||
if(children.length === 0) {
|
if(children.length === 0) {
|
||||||
return { [tagName]: '' };
|
return { [tagName]: '' };
|
||||||
}
|
}
|
||||||
|
|
||||||
// Merge children into object
|
// Merge attributes/children into object
|
||||||
const result: any = {};
|
const result: any = {};
|
||||||
|
if(textContent) result._text = isNumeric(textContent) ? Number(textContent) : textContent;
|
||||||
for(const child of children) {
|
for(const child of children) {
|
||||||
for(const [key, value] of Object.entries(child)) {
|
for(const [key, value] of Object.entries(child)) {
|
||||||
if(result[key]) {
|
if(result[key]) {
|
||||||
// Convert to array if duplicate tags
|
// Convert to array if duplicate tags/attrs
|
||||||
if(!Array.isArray(result[key])) {
|
if(!Array.isArray(result[key])) {
|
||||||
result[key] = [result[key]];
|
result[key] = [result[key]];
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -14,10 +14,10 @@ describe('XML Parser', () => {
|
|||||||
expect(result).toEqual({ item: '' });
|
expect(result).toEqual({ item: '' });
|
||||||
});
|
});
|
||||||
|
|
||||||
it('should parse tag with attributes (ignored in fast-xml-parser format)', () => {
|
it('should parse tag with attributes as merged properties', () => {
|
||||||
const xml = '<user id="1" name="someone" />';
|
const xml = '<user id="1" name="someone" />';
|
||||||
const result = fromXml(xml);
|
const result = fromXml(xml);
|
||||||
expect(result).toEqual({ user: '' });
|
expect(result).toEqual({ user: { id: '1', name: 'someone' } });
|
||||||
});
|
});
|
||||||
|
|
||||||
it('should parse tag with text content', () => {
|
it('should parse tag with text content', () => {
|
||||||
@@ -94,6 +94,8 @@ describe('XML Parser', () => {
|
|||||||
expect(result).toEqual({
|
expect(result).toEqual({
|
||||||
root: {
|
root: {
|
||||||
user: {
|
user: {
|
||||||
|
id: '1',
|
||||||
|
name: 'someone',
|
||||||
email: 'someone@example.com',
|
email: 'someone@example.com',
|
||||||
active: ''
|
active: ''
|
||||||
}
|
}
|
||||||
@@ -190,7 +192,7 @@ describe('XML Parser', () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
describe('round-trip', () => {
|
describe('round-trip', () => {
|
||||||
it('should parse toXml output back to fast-xml-parser format', () => {
|
it('should parse toXml output back with attributes merged as properties', () => {
|
||||||
const obj = {
|
const obj = {
|
||||||
tag: 'root',
|
tag: 'root',
|
||||||
attributes: { id: '1' },
|
attributes: { id: '1' },
|
||||||
@@ -202,6 +204,7 @@ describe('XML Parser', () => {
|
|||||||
const parsed = fromXml(xml);
|
const parsed = fromXml(xml);
|
||||||
expect(parsed).toEqual({
|
expect(parsed).toEqual({
|
||||||
root: {
|
root: {
|
||||||
|
id: '1',
|
||||||
child: 'text'
|
child: 'text'
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|||||||
Reference in New Issue
Block a user