Compare commits

..

4 Commits

Author SHA1 Message Date
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
8 changed files with 39 additions and 32 deletions

View File

@ -6,9 +6,9 @@
</head> </head>
<body> <body>
<script type="module"> <script type="module">
import {PathEvent} from './dist/index.mjs'; import {toCsv} from './dist/index.mjs';
console.log(PathEvent.has(['data/Inventory:n', 'logs:c'], `logs/client:n`)); console.log(toCsv([{test:123, test2: {test: [1, 2, 3, 4], test3: true, test4: 'okay'}}]));
</script> </script>
</body> </body>
</html> </html>

View File

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

View File

@ -1,4 +1,5 @@
import {dotNotation, flattenObj} from './objects.ts'; import {ASet} from './aset.ts';
import {dotNotation, flattenObj, JSONAttemptParse, JSONSanitize} from './objects.ts';
/** /**
* Convert an object to a CSV string * Convert an object to a CSV string
@ -7,20 +8,13 @@ import {dotNotation, flattenObj} from './objects.ts';
* @param {boolean} flatten Should nested object be flattened or treated as values * @param {boolean} flatten Should nested object be flattened or treated as values
* @return {string} CSV string * @return {string} CSV string
*/ */
export function csv(target: any[], flatten=true) { export function toCsv(target: any[], flatten=true) {
const headers = target.reduce((acc, row) => { const headers = new ASet(target.reduce((acc, row) => [...acc, ...Object.keys(flatten ? flattenObj(row) : row)], []));
Object.keys(flatten ? flattenObj(row) : row)
.forEach(key => { if(!acc.includes(key)) acc.push(key); });
return acc;
}, []);
return [ return [
headers.join(','), headers.join(','),
...target.map(row => headers.map((h: string) => { ...target.map(row => headers.map((h: string) => {
const value = dotNotation<any>(row, h); const value = dotNotation<any>(row, h);
const type = typeof value; return (typeof value == 'object' && value != null) ? '"' + JSONSanitize(value).replaceAll('"', '""') + '"' : value;
if(type == 'string' && value.includes(',')) return `"${value}"`;
if(type == 'object') return `"${JSON.stringify(value)}"`;
return value;
}).join(',')) }).join(','))
].join('\n'); ].join('\n');
} }

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 * Create timestamp intended for filenames from a date
* *

View File

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

View File

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

View File

@ -1,5 +1,3 @@
import {dotNotation, flattenObj} from './objects.ts';
/** /**
* String of all letters * String of all letters
*/ */
@ -44,7 +42,7 @@ export function formatBytes(bytes: number, decimals = 2) {
export function formatPhoneNumber(number: string) { export function formatPhoneNumber(number: string) {
const parts = /(\+?1)?.*?(\d{3}).*?(\d{3}).*?(\d{4})/g.exec(number); const parts = /(\+?1)?.*?(\d{3}).*?(\d{3}).*?(\d{4})/g.exec(number);
if(!parts) throw new Error(`Number cannot be parsed: ${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 {string} str - Value that will be injected to parent
* @param {number} index - Position to inject string at * @param {number} index - Position to inject string at
* @returns {string} - New string * @returns {string} - New string
* @deprecated use `strSplice()`
*/ */
export function insertAt(target: string, str: string, index: number): String { export function insertAt(target: string, str: string, index: number): String {
return `${target.slice(0, index)}${str}${target.slice(index + 1)}`; return `${target.slice(0, index)}${str}${target.slice(index + 1)}`;
@ -210,6 +209,7 @@ export type ParsedUrl = {
* *
* @param {string} url URL string that will be parsed * @param {string} url URL string that will be parsed
* @returns {RegExpExecArray} Parts of URL * @returns {RegExpExecArray} Parts of URL
* @deprecated Use built-in URL object: `new URL('...')`;
*/ */
export function parseUrl(url: string): ParsedUrl { export function parseUrl(url: string): ParsedUrl {
const processed = new RegExp( const processed = new RegExp(

View File

@ -15,6 +15,6 @@
* *
* @return {Array<keyof T>} Available keys * @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>; return Object.keys(<T>{}) as Array<keyof T>;
} }