Compare commits

..

8 Commits

Author SHA1 Message Date
fcae9e107e Better applyDeltas
Some checks failed
Build / Build NPM Project (push) Successful in 42s
Build / Publish Documentation (push) Failing after 4s
Build / Tag Version (push) Successful in 9s
2025-08-01 23:43:43 -04:00
5bb5067abc Better applyDeltas
Some checks failed
Build / Build NPM Project (push) Successful in 39s
Build / Publish Documentation (push) Failing after 4s
Build / Tag Version (push) Successful in 9s
2025-08-01 23:33:10 -04:00
2064880673 Fixed package version
Some checks failed
Build / Build NPM Project (push) Successful in 40s
Build / Publish Documentation (push) Failing after 4s
Build / Tag Version (push) Successful in 8s
2025-08-01 23:10:16 -04:00
fdefdf354d New delta functions
Some checks failed
Build / Build NPM Project (push) Successful in 40s
Build / Publish Documentation (push) Failing after 5s
Build / Tag Version (push) Failing after 7s
2025-08-01 22:25:50 -04:00
31998c01d6 formatDate fixed
Some checks failed
Build / Build NPM Project (push) Successful in 1m12s
Build / Tag Version (push) Successful in 16s
Build / Publish Documentation (push) Failing after 16s
2025-08-01 11:06:07 -04:00
c5270fbd7e Better date format
Some checks failed
Build / Build NPM Project (push) Failing after 46s
Build / Publish Documentation (push) Has been skipped
Build / Tag Version (push) Has been skipped
2025-08-01 09:54:22 -04:00
bfe9493d23 Added array support to delta calculations
Some checks failed
Build / Build NPM Project (push) Successful in 42s
Build / Publish Documentation (push) Failing after 5s
Build / Tag Version (push) Successful in 9s
2025-07-30 21:14:02 -04:00
1b6fe42f78 Added delta functions
Some checks failed
Build / Build NPM Project (push) Successful in 42s
Build / Publish Documentation (push) Failing after 4s
Build / Tag Version (push) Successful in 8s
2025-07-30 14:34:59 -04:00
6 changed files with 150 additions and 141 deletions

View File

@ -1,9 +1,11 @@
<html> <html>
<body> <body>
<script type="module"> <script type="module">
import {PE} from './dist/index.mjs'; import {formatDate} from './dist/index.mjs';
console.log('data/Ts:n', PE`${'data/Ts'}:n`.methods); const dt = new Date('2021-03-03T09:00:00Z');
const result = formatDate('Do MMMM dddd', dt, 0);
console.log(result);
</script> </script>
</body> </body>
</html> </html>

View File

@ -1,6 +1,6 @@
{ {
"name": "@ztimson/utils", "name": "@ztimson/utils",
"version": "0.26.24", "version": "0.27.3",
"description": "Utility library", "description": "Utility library",
"author": "Zak Timson", "author": "Zak Timson",
"license": "MIT", "license": "MIT",

View File

@ -48,3 +48,17 @@ export function fracToDec(frac: string) {
split = (<string>split.pop()).split('/'); split = (<string>split.pop()).split('/');
return whole + (Number(split[0]) / Number(split[1])); return whole + (Number(split[0]) / Number(split[1]));
} }
/**
* Add a suffix to a number:
* 1 = 1st
* 2 = 2nd
* 3 = 3rd
* N = Nth
* @param {number} n
* @returns {string}
*/
export function numSuffix(n: number): string {
const s = ['th', 'st', 'nd', 'rd'], v = n % 100;
return `${n}${s[(v - 20) % 10] || s[v] || s[0]}`;
}

View File

@ -1,56 +1,51 @@
type Delta = { [key: string]: any | Delta | null }; export type Delta = { [key: string]: any | Delta | null };
/** /**
* Applies deltas in order to modify `target`. * Applies deltas to `target`.
* @param target - Object to mutate * @param base starting point
* @param deltas - List of deltas to apply * @param deltas List of deltas to apply
* @returns Mutated target * @returns Mutated target
*/ */
function applyDeltas(target: any, deltas: Delta[]): any { export function applyDeltas(base: any, ...deltas: any[]): any {
for(const delta of deltas) { function applyDelta(base: any, delta: any): any {
for(const [key, value] of Object.entries(delta)) { if(delta === null) return null;
if(value === null) { if(typeof base !== 'object' || base === null) return delta === undefined ? base : delta;
delete target[key]; // remove const result = Array.isArray(base) ? [...base] : { ...base };
} else if(typeof value === 'object' && !Array.isArray(value)) { for(const key in delta) {
if(typeof target[key] !== 'object' || Array.isArray(target[key])) { const val = delta[key];
target[key] = {}; // nested obj if(val === undefined) delete result[key];
else if(typeof val === 'object' && val !== null && !Array.isArray(val)) result[key] = applyDelta(result[key], val);
else result[key] = val;
} }
applyDeltas(target[key], [value]); // recurse return result;
} else {
target[key] = value; // restore
} }
}
} for(const d of deltas.flat()) base = applyDelta(base, d?.delta ?? d);
return target; return base;
} }
/** /**
* Creates a nested delta that reverts `target` back to `old`. * Creates a nested delta that reverts `target` back to `old`.
* @param old - Original object * @param old - Original object
* @param target - Modified object * @param updated - Modified object
* @returns Delta to revert changes * @returns New changes
*/ */
function calcDelta(old: any, target: any): Delta { export function calcDelta(old: any, updated: any): any {
const delta: Delta = {}; if(updated == null) return null; // full delete
const keys = new Set([...Object.keys(old || {}), ...Object.keys(target || {})]); const delta: any = {};
for(const key of keys) { const isObj = (v: any) => v && typeof v === 'object' && !Array.isArray(v);
const val1 = old?.[key]; for (const key of new Set([...(old ? Object.keys(old) : []), ...(updated ? Object.keys(updated) : [])])) {
const val2 = target?.[key]; const oldVal = old?.[key];
if(!(key in target)) { const newVal = updated?.[key];
delta[key] = val1; // removed if(isObj(oldVal) && isObj(newVal)) {
} else if(!(key in old)) { const nested = calcDelta(oldVal, newVal);
delta[key] = null; // added if(nested !== null && Object.keys(nested).length > 0) delta[key] = nested;
} else if( } else if(JSON.stringify(oldVal) !== JSON.stringify(newVal)) {
typeof val1 === 'object' && typeof val2 === 'object' && delta[key] = newVal;
val1 && val2 && !Array.isArray(val1)
) {
const nested = calcDelta(val1, val2);
if(Object.keys(nested).length) delta[key] = nested;
} else if(val1 !== val2) {
delta[key] = val1; // changed
} }
} }
return delta; return Object.keys(delta).length === 0 ? {} : delta;
} }
/** /**
@ -330,8 +325,8 @@ export function JSONSerialize<T1>(obj: T1): T1 | string {
export function JSONSanitize(obj: any, space?: number): string { export function JSONSanitize(obj: any, space?: number): string {
const cache: any[] = []; const cache: any[] = [];
return JSON.stringify(obj, (key, value) => { return JSON.stringify(obj, (key, value) => {
if (typeof value === 'object' && value !== null) { if(typeof value === 'object' && value !== null) {
if (cache.includes(value)) return '[Circular]'; if(cache.includes(value)) return '[Circular]';
cache.push(value); cache.push(value);
} }
return value; return value;

View File

@ -1,3 +1,5 @@
import {numSuffix} from './math.ts';
/** /**
* Like setInterval but will adjust the timeout value to account for runtime * Like setInterval but will adjust the timeout value to account for runtime
* @param {Function} cb Callback function that will be ran * @param {Function} cb Callback function that will be ran
@ -20,6 +22,15 @@ export function adjustedInterval(cb: Function, ms: number) {
} }
} }
export function dayOfWeek(d: number): string {
return ['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday'][d];
}
export function dayOfYear(date: Date): number {
const start = new Date(Date.UTC(date.getUTCFullYear(), 0, 1));
return Math.ceil((date.getTime() - start.getTime()) / (1000 * 60 * 60 * 24));
}
/** /**
* Format date * Format date
* *
@ -28,111 +39,94 @@ export function adjustedInterval(cb: Function, ms: number) {
* @param tz Set timezone offset * @param tz Set timezone offset
* @return {string} Formated date * @return {string} Formated date
*/ */
export function formatDate(format = 'YYYY-MM-DD H:mm', date: Date | number | string = new Date(), tz?: string | number): string { export function formatDate(format: string = 'YYYY-MM-DD H:mm', date: Date | number | string = new Date(), tz: string | number = 'local'): string {
const timezones = [ if (typeof date === 'number' || typeof date === 'string') date = new Date(date);
['IDLW', -12], if (isNaN(date.getTime())) throw new Error('Invalid date input');
['SST', -11], const numericTz = typeof tz === 'number';
['HST', -10], const localTz = tz === 'local' || (!numericTz && tz.toLowerCase?.() === 'local');
['AKST', -9], const tzName = localTz ? Intl.DateTimeFormat().resolvedOptions().timeZone : numericTz ? 'UTC' : tz;
['PST', -8],
['MST', -7],
['CST', -6],
['EST', -5],
['AST', -4],
['BRT', -3],
['MAT', -2],
['AZOT', -1],
['UTC', 0],
['CET', 1],
['EET', 2],
['MSK', 3],
['AST', 4],
['PKT', 5],
['IST', 5.5],
['BST', 6],
['ICT', 7],
['CST', 8],
['JST', 9],
['AEST', 10],
['SBT', 11],
['FJT', 12],
['TOT', 13],
['LINT', 14]
];
function adjustTz(date: Date, gmt: number) { if (!numericTz && tzName !== 'UTC') {
const currentOffset = date.getTimezoneOffset(); try {
const adjustedOffset = gmt * 60; new Intl.DateTimeFormat('en-US', { timeZone: tzName }).format();
return new Date(date.getTime() + (adjustedOffset + currentOffset) * 60000); } catch {
} throw new Error(`Invalid timezone: ${tzName}`);
function day(num: number): string {
return ['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday'][num] || 'Unknown';
}
function doy(date: Date) {
const start = new Date(`${date.getFullYear()}-01-01 0:00:00`);
return Math.ceil((date.getTime() - start.getTime()) / (1000 * 60 * 60 * 24));
}
function month(num: number): string {
return ['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December'][num] || 'Unknown';
}
function suffix(num: number) {
if (num % 100 >= 11 && num % 100 <= 13) return `${num}th`;
switch (num % 10) {
case 1: return `${num}st`;
case 2: return `${num}nd`;
case 3: return `${num}rd`;
default: return `${num}th`;
} }
} }
function tzOffset(offset: number) { let zonedDate = new Date(date);
const hours = ~~(offset / 60); if (!numericTz && tzName !== 'UTC') {
const minutes = offset % 60; const parts = new Intl.DateTimeFormat('en-US', {
return (offset > 0 ? '-' : '') + `${hours}:${minutes.toString().padStart(2, '0')}`; timeZone: tzName,
year: 'numeric', month: '2-digit', day: '2-digit',
hour: '2-digit', minute: '2-digit', second: '2-digit',
hour12: false
}).formatToParts(date);
const get = (type: string) => parts.find(p => p.type === type)?.value;
const build = `${get('year')}-${get('month')}-${get('day')}T${get('hour')}:${get('minute')}:${get('second')}Z`;
zonedDate = new Date(build);
} else if (numericTz || tzName === 'UTC') {
const offset = numericTz ? tz as number : 0;
zonedDate = new Date(date.getTime() + offset * 60 * 60 * 1000);
} }
if(typeof date == 'number' || typeof date == 'string' || date == null) date = new Date(date); const get = (fn: 'FullYear' | 'Month' | 'Date' | 'Day' | 'Hours' | 'Minutes' | 'Seconds' | 'Milliseconds') =>
(numericTz || tzName === 'UTC') ? zonedDate[`getUTC${fn}`]() : zonedDate[`get${fn}`]();
// Handle timezones function getTZOffset(): string {
let t!: [string, number]; if (numericTz) {
if(tz == null) tz = -(date.getTimezoneOffset() / 60); const total = (tz as number) * 60;
t = <any>timezones.find(t => isNaN(<any>tz) ? t[0] == tz : t[1] == tz); const hours = Math.floor(Math.abs(total) / 60);
if(!t) throw new Error(`Unknown timezone: ${tz}`); const mins = Math.abs(total) % 60;
date = adjustTz(date, t[1]); return `${tz >= 0 ? '+' : '-'}${String(hours).padStart(2, '0')}:${String(mins).padStart(2, '0')}`;
}
try {
const offset = new Intl.DateTimeFormat('en-US', {timeZone: tzName, timeZoneName: 'longOffset', hour: '2-digit', minute: '2-digit',})
.formatToParts(<Date>date).find(p => p.type === 'timeZoneName')?.value.match(/([+-]\d{2}:\d{2})/)?.[1];
if (offset) return offset;
} catch {}
return '+00:00';
}
function getTZAbbr(): string {
if (numericTz && tz === 0) return 'UTC';
try {
return new Intl.DateTimeFormat('en-US', { timeZone: tzName, timeZoneName: 'short' })
.formatToParts(<Date>date).find(p => p.type === 'timeZoneName')?.value || '';
} catch {
return tzName;
}
}
// Token mapping
const tokens: Record<string, string> = { const tokens: Record<string, string> = {
'YYYY': date.getFullYear().toString(), YYYY: get('FullYear').toString(),
'YY': date.getFullYear().toString().slice(2), YY: get('FullYear').toString().slice(2),
'MMMM': month(date.getMonth()), MMMM: month(get('Month')),
'MMM': month(date.getMonth()).slice(0, 3), MMM: month(get('Month')).slice(0, 3),
'MM': (date.getMonth() + 1).toString().padStart(2, '0'), MM: (get('Month') + 1).toString().padStart(2, '0'),
'M': (date.getMonth() + 1).toString(), M: (get('Month') + 1).toString(),
'DDD': doy(date).toString(), DDD: dayOfYear(zonedDate).toString(),
'DD': date.getDate().toString().padStart(2, '0'), DD: get('Date').toString().padStart(2, '0'),
'Do': suffix(date.getDate()), Do: numSuffix(get('Date')),
'D': date.getDate().toString(), D: get('Date').toString(),
'dddd': day(date.getDay()), dddd: dayOfWeek(get('Day')),
'ddd': day(date.getDay()).slice(0, 3), ddd: dayOfWeek(get('Day')).slice(0, 3),
'HH': date.getHours().toString().padStart(2, '0'), HH: get('Hours').toString().padStart(2, '0'),
'H': date.getHours().toString(), H: get('Hours').toString(),
'hh': (date.getHours() % 12 || 12).toString().padStart(2, '0'), hh: (get('Hours') % 12 || 12).toString().padStart(2, '0'),
'h': (date.getHours() % 12 || 12).toString(), h: (get('Hours') % 12 || 12).toString(),
'mm': date.getMinutes().toString().padStart(2, '0'), mm: get('Minutes').toString().padStart(2, '0'),
'm': date.getMinutes().toString(), m: get('Minutes').toString(),
'ss': date.getSeconds().toString().padStart(2, '0'), ss: get('Seconds').toString().padStart(2, '0'),
's': date.getSeconds().toString(), s: get('Seconds').toString(),
'SSS': date.getMilliseconds().toString().padStart(3, '0'), SSS: get('Milliseconds').toString().padStart(3, '0'),
'A': date.getHours() >= 12 ? 'PM' : 'AM', A: get('Hours') >= 12 ? 'PM' : 'AM',
'a': date.getHours() >= 12 ? 'pm' : 'am', a: get('Hours') >= 12 ? 'pm' : 'am',
'ZZ': tzOffset(t[1] * 60).replace(':', ''), ZZ: getTZOffset().replace(':', ''),
'Z': tzOffset(t[1] * 60), Z: getTZOffset(),
'z': typeof tz == 'string' ? tz : (<any>t)[0] z: getTZAbbr(),
}; };
return format.replace(/YYYY|YY|MMMM|MMM|MM|M|DDD|DD|Do|D|dddd|ddd|HH|H|hh|h|mm|m|ss|s|SSS|A|a|ZZ|Z|z/g, token => tokens[token]); return format.replace(/YYYY|YY|MMMM|MMM|MM|M|DDD|DD|Do|D|dddd|ddd|HH|H|hh|h|mm|m|ss|s|SSS|A|a|ZZ|Z|z/g, token => tokens[token]);
} }
@ -148,6 +142,10 @@ export function instantInterval(fn: () => any, interval: number) {
return setInterval(fn, interval); return setInterval(fn, interval);
} }
export function month(m: number): string {
return ['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December'][m];
}
/** /**
* Use in conjunction with `await` to pause an async script * Use in conjunction with `await` to pause an async script
* *

View File

@ -31,11 +31,11 @@ describe('Time Utilities', () => {
it('handles formatting for given timestamp', () => { it('handles formatting for given timestamp', () => {
const timestamp = Date.UTC(2023, 1, 1, 18, 5, 5, 123); // Feb 1, 2023 18:05:05.123 UTC const timestamp = Date.UTC(2023, 1, 1, 18, 5, 5, 123); // Feb 1, 2023 18:05:05.123 UTC
const formatted = formatDate('YYYY MM DD HH mm ss SSS A Z', timestamp, 'UTC'); const formatted = formatDate('YYYY MM DD HH mm ss SSS A Z', timestamp, 'UTC');
expect(formatted).toMatch(/^2023 02 01 18 05 05 123 PM \+?0:00$/i); expect(formatted).toMatch(/^2023 02 01 18 05 05 123 PM \+00:00/i);
}); });
it('throws for unknown timezone', () => { it('throws for unknown timezone', () => {
expect(() => formatDate('YYYY', new Date(), '???')).toThrowError(/Unknown timezone/); expect(() => formatDate('YYYY', new Date(), '???')).toThrowError(/Invalid timezone/);
}); });
it('handles timezone by offset number', () => { it('handles timezone by offset number', () => {