Compare commits

..

14 Commits

Author SHA1 Message Date
ff4401934c Fixed formatDate month shortform
All checks were successful
Build / Build NPM Project (push) Successful in 1m21s
Build / Tag Version (push) Successful in 13s
Build / Publish Documentation (push) Successful in 1m57s
2024-11-16 11:02:32 -05:00
ce3c8d012a Fixed import
All checks were successful
Build / Build NPM Project (push) Successful in 1m5s
Build / Tag Version (push) Successful in 14s
Build / Publish Documentation (push) Successful in 2m2s
2024-11-15 16:22:01 -05:00
a86e8350ee bump 0.22.9
Some checks failed
Build / Build NPM Project (push) Failing after 24s
Build / Tag Version (push) Has been skipped
Build / Publish Documentation (push) Has been skipped
2024-11-15 16:18:45 -05:00
7b4e17e4c4 Added advanced search function
Some checks failed
Build / Build NPM Project (push) Failing after 20s
Build / Tag Version (push) Has been skipped
Build / Publish Documentation (push) Has been skipped
2024-11-15 16:17:52 -05:00
fa66820c76 more time utils
All checks were successful
Build / Build NPM Project (push) Successful in 38s
Build / Tag Version (push) Successful in 8s
Build / Publish Documentation (push) Successful in 2m27s
2024-11-14 23:29:58 -05:00
49a2df8cd4 Fixed timezone format
All checks were successful
Build / Build NPM Project (push) Successful in 1m15s
Build / Tag Version (push) Successful in 13s
Build / Publish Documentation (push) Successful in 1m57s
2024-11-14 22:58:24 -05:00
ccf3fcb043 fixed fromCsv escaping quotes & letter headers
All checks were successful
Build / Build NPM Project (push) Successful in 37s
Build / Tag Version (push) Successful in 7s
Build / Publish Documentation (push) Successful in 1m46s
2024-11-09 17:27:05 -05:00
341ef37205 Added fromCsv
All checks were successful
Build / Build NPM Project (push) Successful in 37s
Build / Tag Version (push) Successful in 7s
Build / Publish Documentation (push) Successful in 1m43s
2024-11-09 16:30:05 -05:00
0eab2630ad added fileText method
All checks were successful
Build / Build NPM Project (push) Successful in 37s
Build / Tag Version (push) Successful in 6s
Build / Publish Documentation (push) Successful in 2m21s
2024-11-09 15:35:05 -05:00
2f59a9d02e improved toCSV
All checks were successful
Build / Build NPM Project (push) Successful in 41s
Build / Tag Version (push) Successful in 7s
Build / Publish Documentation (push) Successful in 1m41s
2024-11-09 13:49:04 -05:00
ce2f32dd45 Fixed PathEvents double slash
All checks were successful
Build / Build NPM Project (push) Successful in 1m10s
Build / Tag Version (push) Successful in 13s
Build / Publish Documentation (push) Successful in 1m54s
2024-11-08 18:49:11 -05:00
ce40b5b1e7 Deprecated old methods
All checks were successful
Build / Build NPM Project (push) Successful in 39s
Build / Tag Version (push) Successful in 7s
Build / Publish Documentation (push) Successful in 1m41s
2024-11-07 10:46:56 -05:00
2500bcdcf1 Added string splice and updated dateFormat to accept custom format stings
All checks were successful
Build / Build NPM Project (push) Successful in 1m6s
Build / Tag Version (push) Successful in 13s
Build / Publish Documentation (push) Successful in 1m50s
2024-11-07 10:30:43 -05:00
db18c010aa Added adjusted interval & set errorFromCode to always return an error even on 200's
All checks were successful
Build / Build NPM Project (push) Successful in 1m16s
Build / Tag Version (push) Successful in 14s
Build / Publish Documentation (push) Successful in 2m1s
2024-10-29 10:41:25 -04:00
12 changed files with 276 additions and 45 deletions

View File

@ -6,9 +6,10 @@
</head>
<body>
<script type="module">
import {PathEvent} from './dist/index.mjs';
import {adjustTz, formatDate} from './dist/index.mjs';
console.log(PathEvent.has(['data/Inventory:n', 'logs:c'], `logs/client:n`));
console.log(formatDate(new Date(), 'HH:mm:ss z'));
console.log(formatDate(adjustTz(new Date(), 0), 'HH:mm:ss z', 'UTC'));
</script>
</body>
</html>

View File

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

View File

@ -1,4 +1,41 @@
import {dotNotation, flattenObj} from './objects.ts';
import {ASet} from './aset.ts';
import {dotNotation, flattenObj, JSONSanitize} from './objects.ts';
import {LETTER_LIST} from './string.ts';
export function fromCsv<T = any>(csv: string, hasHeaders=true): T[] {
const row = csv.split('\n');
let headers: any = hasHeaders ? row.splice(0, 1)[0] : null;
if(headers) headers = headers.match(/(?:[^,"']+|"[^"]*"|'[^']*')+/g);
return <T[]>row.map(r => {
function parseLine(line: string): (string | null)[] {
const parts = line.split(','), columns: string[] = [];
let quoted = false;
for(const p of parts) {
if(quoted) columns[columns.length - 1] = columns.at(-1) + ',' + p;
else columns.push(p);
if(/[^"]"$/g.test(p)) {
quoted = false;
} else if(/^"[^"]/g.test(p)) {
quoted = true;
}
}
return columns;
}
const props = parseLine(r);
const h = headers || (Array(props.length).fill(null).map((r, i) => {
let letter = '';
const first = i / 26;
if(first > 1) letter += LETTER_LIST[Math.floor(first - 1)];
letter += LETTER_LIST[i % 26];
return letter;
}));
return h.reduce((acc: any, h: any, i: number) => {
dotNotation(acc, h, props[i]);
return acc;
}, {});
})
}
/**
* Convert an object to a CSV string
@ -7,20 +44,13 @@ import {dotNotation, flattenObj} from './objects.ts';
* @param {boolean} flatten Should nested object be flattened or treated as values
* @return {string} CSV string
*/
export function csv(target: any[], flatten=true) {
const headers = target.reduce((acc, row) => {
Object.keys(flatten ? flattenObj(row) : row)
.forEach(key => { if(!acc.includes(key)) acc.push(key); });
return acc;
}, []);
export function toCsv(target: any[], flatten=true) {
const headers = new ASet(target.reduce((acc, row) => [...acc, ...Object.keys(flatten ? flattenObj(row) : row)], []));
return [
headers.join(','),
...target.map(row => headers.map((h: string) => {
const value = dotNotation<any>(row, h);
const type = typeof value;
if(type == 'string' && value.includes(',')) return `"${value}"`;
if(type == 'object') return `"${JSON.stringify(value)}"`;
return value;
return (typeof value == 'object' && value != null) ? '"' + JSONSanitize(value).replaceAll('"', '""') + '"' : value;
}).join(','))
].join('\n');
}

View File

@ -180,7 +180,6 @@ export class GatewayTimeoutError extends CustomError {
* @return {CustomError} The proper error type
*/
export function errorFromCode(code: number, message?: string) {
if(code >= 200 && code < 300) return null;
switch(code) {
case 400:
return new BadRequestError(message);

View File

@ -52,6 +52,21 @@ export function fileBrowser(options: {accept?: string, multiple?: boolean} = {})
});
}
/**
* Extract text from a file
*
* @param file File to extract text from
* @return {Promise<string | null>} File contents
*/
export function fileText(file: any): Promise<string | null> {
return new Promise((resolve, reject) => {
const reader = new FileReader();
reader.onload = () => resolve(<string>reader.result);
reader.onerror = () => reject(reader.error);
reader.readAsText(file);
});
}
/**
* Create timestamp intended for filenames from a date
*

View File

@ -13,6 +13,7 @@ export * from './misc';
export * from './objects';
export * from './path-events';
export * from './promise-progress';
export * from './search';
export * from './string';
export * from './time';
export * from './types';

View File

@ -29,10 +29,10 @@ export function clean<T>(obj: T, undefinedOnly = false): Partial<T> {
* Should be replaced by `structuredClone` once released.
* @param {T} value Object to copy
* @returns {T} Type
* @deprecated Please use `structuredClone`
*/
export function deepCopy<T>(value: T): T {
return structuredClone(value);
try {return structuredClone(value); }
catch { return JSON.parse(JSONSanitize(value)); }
}
/**
@ -91,7 +91,6 @@ export function dotNotation<T>(obj: any, prop: string, set?: T): T | undefined {
}, obj);
}
/**
* Convert object into URL encoded query string
*
@ -128,8 +127,9 @@ export function encodeQuery(data: any): string {
export function flattenObj(obj: any, parent?: any, result: any = {}) {
if(typeof obj === "object" && !Array.isArray(obj)) {
for(const key of Object.keys(obj)) {
const propName = parent ? parent + '.' + key : key;
if(typeof obj[key] === 'object') {
const propName = parent ? `${parent}.${key}` : key;
if(typeof obj[key] === 'object' && obj[key] != null && !Array.isArray(obj[key])) {
console.log(propName, );
flattenObj(obj[key], propName, result);
} else {
result[propName] = obj[key];
@ -216,11 +216,11 @@ export function mixin(target: any, constructors: any[]) {
/**
* Parse JSON but return the original string if it fails
*
* @param {string} json JSON string to parse
* @param {any} json JSON string to parse
* @return {string | T} Object if successful, original string otherwise
*/
export function JSONAttemptParse<T>(json: string): T | string {
try { return JSON.parse(json); }
export function JSONAttemptParse<T1, T2>(json: T2): T1 | T2 {
try { return JSON.parse(<any>json); }
catch { return json; }
}
@ -234,10 +234,8 @@ export function JSONAttemptParse<T>(json: string): T | string {
export function JSONSanitize(obj: any, space?: number): string {
let cache: any[] = [];
return JSON.stringify(obj, (key, value) => {
if (typeof value === 'object' && value !== null) {
if (cache.includes(value)) return;
cache.push(value);
}
if(typeof value === 'object' && value !== null)
if(!cache.includes(value)) cache.push(value);
return value;
}, space);
}

View File

@ -25,7 +25,7 @@ export type Method = '*' | 'n' | 'c' | 'r' | 'u' | 'd' | 'x';
* @param {string} args
* @return {PathEvent} Event object
*/
export function PE(str: TemplateStringsArray, ...args: string[]) {
export function PE(str: TemplateStringsArray, ...args: any[]) {
const combined = [];
for(let i = 0; i < str.length || i < args.length; i++) {
if(str[i]) combined.push(str[i]);
@ -92,7 +92,7 @@ export class PathEvent {
constructor(Event: string | PathEvent) {
if(typeof Event == 'object') return Object.assign(this, Event);
let [p, scope, method] = Event.split(':');
let [p, scope, method] = Event.replaceAll(/\/{2,}/g, '/').split(':');
if(!method) method = scope || '*';
if(p == '*' || !p && method == '*') {
p = '';

38
src/search.ts Normal file
View File

@ -0,0 +1,38 @@
import {dotNotation, JSONAttemptParse} from './objects';
export function search(rows: any[], search: string, regex?: boolean, transform: Function = (r: any) => r) {
if(!rows) return [];
return rows.filter(r => {
// Empty search
const value = transform(r);
if(!search) return true;
// Regex search
if(regex) {
return !!Object.values(value).filter((v: any) => {
try { return RegExp(search, 'gm').test(v.toString()); }
catch { return false; }
}).length
}
// Make sure at least one OR passes
const or = search.split('||').map(p => p.trim()).filter(p => !!p);
return -1 != or.findIndex(p => {
// Make sure all ANDs pass
const and = p.split('&&').map(p => p.trim()).filter(p => !!p);
return and.filter(p => {
// Boolean operator
const prop = /(\w+)\s*(==?|!=|>=|>|<=|<)\s*(\w+)/g.exec(p);
if(prop) {
const a = JSON.stringify(JSONAttemptParse(dotNotation<any>(value, prop[1])));
const operator = prop[2] == '=' ? '==' : prop[2];
const b = JSON.stringify(JSONAttemptParse(prop[3]));
return eval(`${a} ${operator} ${b}`);
}
// Case-sensitive
const v = Object.values(value).join('');
if(/[A-Z]/g.test(search)) return v.includes(p);
// Case-insensitive
return v.toLowerCase().includes(p);
}).length == and.length;
})
});
}

View File

@ -1,24 +1,22 @@
import {dotNotation, flattenObj} from './objects.ts';
/**
* String of all letters
*/
const LETTER_LIST = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ';
export const LETTER_LIST = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';
/**
* String of all numbers
*/
const NUMBER_LIST = '0123456789';
export const NUMBER_LIST = '0123456789';
/**
* String of all symbols
*/
const SYMBOL_LIST = '~`!@#$%^&*()_-+={[}]|\\:;"\'<,>.?/';
export const SYMBOL_LIST = '~`!@#$%^&*()_-+={[}]|\\:;"\'<,>.?/';
/**
* String of all letters, numbers & symbols
*/
const CHAR_LIST = LETTER_LIST + NUMBER_LIST + SYMBOL_LIST;
export const CHAR_LIST = LETTER_LIST + LETTER_LIST.toLowerCase() + NUMBER_LIST + SYMBOL_LIST;
/**
* Convert number of bytes into a human-readable size
@ -44,7 +42,7 @@ export function formatBytes(bytes: number, decimals = 2) {
export function formatPhoneNumber(number: string) {
const parts = /(\+?1)?.*?(\d{3}).*?(\d{3}).*?(\d{4})/g.exec(number);
if(!parts) throw new Error(`Number cannot be parsed: ${number}`);
return `${parts[1] ?? ''} (${parts[2]}) ${parts[3]}-${parts[4]}`.trim();
return `${parts[1] ? '+1' : ''} (${parts[2]}) ${parts[3]}-${parts[4]}`.trim();
}
/**
@ -60,6 +58,7 @@ export function formatPhoneNumber(number: string) {
* @param {string} str - Value that will be injected to parent
* @param {number} index - Position to inject string at
* @returns {string} - New string
* @deprecated use `strSplice()`
*/
export function insertAt(target: string, str: string, index: number): String {
return `${target.slice(0, index)}${str}${target.slice(index + 1)}`;
@ -150,6 +149,21 @@ export function randomStringBuilder(length: number, letters = false, numbers = f
}).join('');
}
/**
* Splice a string together (Similar to Array.splice)
*
* @param {string} str String that will be modified
* @param {number} start Start index of splice
* @param {number} deleteCount Number of characters to remove in splice
* @param {string} insert Insert new string into splice
* @return {string} Returned spliced string
*/
export function strSplice(str: string, start: number, deleteCount: number, insert = '') {
const before = str.slice(0, start);
const after = str.slice(start + deleteCount);
return before + insert + after;
}
/**
* Find all substrings that match a given pattern.
*
@ -195,6 +209,7 @@ export type ParsedUrl = {
*
* @param {string} url URL string that will be parsed
* @returns {RegExpExecArray} Parts of URL
* @deprecated Use built-in URL object: `new URL('...')`;
*/
export function parseUrl(url: string): ParsedUrl {
const processed = new RegExp(

View File

@ -1,17 +1,151 @@
/**
* Return date formated highest to lowest: YYYY-MM-DD H:mm AM
* Like setInterval but will adjust the timeout value to account for runtime
* @param {Function} cb Callback function that will be ran
* @param {number} ms Run function ever x seconds
* @return {() => void}
*/
export function adjustedInterval(cb: Function, ms: number) {
let cancel = false, timeout: any = null;
const p = async () => {
if (cancel) return;
const start = new Date().getTime();
await cb();
const end = new Date().getTime();
timeout = setTimeout(() => p(), ms - (end - start) || 1);
};
p();
return () => {
cancel = true;
if(timeout) clearTimeout(timeout);
}
}
export function adjustTz(date: Date, offset: number) {
const currentOffset = date.getTimezoneOffset();
offset = currentOffset - offset * 60;
return new Date(date.getTime() + offset * 60000);
}
/**
* Format date
*
* @param {Date | number | string} date Date or timestamp to convert to string
* @param {string} format How date string will be formatted, default: `YYYY-MM-DD H:mm A`
* @param tz Override timezone, can be either string or number
* @return {string} Formated date
*/
export function formatDate(date: Date | number | string): string {
export function formatDate(date: Date | number | string, format = 'YYYY-MM-DD H:mm', tz?: any): string {
if(typeof date == 'number' || typeof date == 'string') date = new Date(date);
let hours = date.getHours(), postfix = 'AM';
if(hours >= 12) {
if(hours > 12) hours -= 12;
postfix = 'PM';
} else if(hours == 0) hours = 12;
return `${date.getFullYear()}-${(date.getMonth() + 1).toString().padStart(2, '0')}-${date.getDate().toString().padStart(2, '0')}, ${hours}:${date.getMinutes().toString().padStart(2, '0')} ${postfix}`;
function day(num: number): string {
switch(num) {
case(0): return 'Sunday';
case(1): return 'Monday';
case(2): return 'Tuesday';
case(3): return 'Wednesday';
case(4): return 'Thursday';
case(5): return 'Friday';
case(6): return 'Saturday';
default: return '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 {
switch(num) {
case(0): return 'January';
case(1): return 'February';
case(2): return 'March';
case(3): return 'April';
case(4): return 'May';
case(5): return 'June';
case(6): return 'July';
case(7): return 'August';
case(8): return 'September';
case(9): return 'October';
case(10): return 'November';
case(11): return 'December';
default: return 'Unknown';
}
}
function suffix(num: number) {
let n = num.toString();
switch(n.at(-1)) {
case('1'): return num + 'st';
case('2'): return num + 'nd';
case('3'): return num + 'rd';
default: return num + 'th';
}
}
function tzOffset(offset: number) {
const hours = ~~(offset / 60);
const minutes = offset % 60;
return (offset > 0 ? '-' : '') + `${hours}:${minutes.toString().padStart(2, '0')}`;
}
function timezone(date: Date): string {
return new Intl.DateTimeFormat('en-US', {timeZoneName: 'short'})
.format(date).split(' ').pop() || '';
}
return format
// Year
.replaceAll('YYYY', date.getFullYear().toString())
.replaceAll('YY', date.getFullYear().toString().slice(2))
// Month
.replaceAll('MMMM', month(date.getMonth()))
.replaceAll('MMM', month(date.getMonth()).slice(0, 3))
.replaceAll('MM', (date.getMonth() + 1).toString().padStart(2, '0'))
.replaceAll('M', (date.getMonth() + 1).toString())
// Day
.replaceAll('DDD', doy(date).toString())
.replaceAll('DD', date.getDate().toString().padStart(2, '0'))
.replaceAll('Do', suffix(date.getDate()))
.replaceAll('D', date.getDate().toString())
.replaceAll('dddd', day(date.getDay()))
.replaceAll('ddd', day(date.getDay()).slice(0, 2))
.replaceAll('dd', date.getDate().toString().padStart(2, '0'))
.replaceAll('d', date.getDay().toString())
// Hour
.replaceAll('HH', date.getHours().toString().padStart(2, '0'))
.replaceAll('H', date.getHours().toString())
.replaceAll('hh', (date.getHours() > 12 ? date.getHours() - 12 : date.getHours()).toString().padStart(2, '0'))
.replaceAll('h', (date.getHours() > 12 ? date.getHours() - 12 : date.getHours()).toString())
// Minute
.replaceAll('mm', date.getMinutes().toString().padStart(2, '0'))
.replaceAll('m', date.getMinutes().toString())
// Second
.replaceAll('ss', date.getSeconds().toString().padStart(2, '0'))
.replaceAll('s', date.getSeconds().toString())
// Millisecond
.replaceAll('SSS', date.getMilliseconds().toString().padEnd(3, '0'))
.replaceAll('SS', date.getMilliseconds().toString().slice(0, 1).padEnd(2, '0'))
.replaceAll('S', date.getMilliseconds().toString()[0])
// Period/Meridian (AM/PM)
.replaceAll('A', date.getHours() >= 12 ? 'PM' : 'AM')
.replaceAll('a', date.getHours() >= 12 ? 'pm' : 'am')
// Timezone
.replaceAll('ZZ', tzOffset(isNaN(tz) ? date.getTimezoneOffset() : tz).replace(':', ''))
.replaceAll('Z', tzOffset(isNaN(tz) ? date.getTimezoneOffset() : tz))
.replaceAll('z', typeof tz == 'string' ? tz : timezone(date));
}
/**
* Run a function immediately & repeat every x ms
*
* @param {() => any} fn Callback function
* @param {number} interval Repeat in ms
* @return {number} Clear Interval ID
*/
export function instantInterval(fn: () => any, interval: number) {
fn();
return setInterval(fn, interval);
}
/**

View File

@ -15,6 +15,6 @@
*
* @return {Array<keyof T>} Available keys
*/
export function tyoeKeys<T extends object>() {
export function typeKeys<T extends object>() {
return Object.keys(<T>{}) as Array<keyof T>;
}