Compare commits

..

5 Commits

Author SHA1 Message Date
057528b0c5 Fixed doc build step
All checks were successful
Build / Build NPM Project (push) Successful in 1m17s
Build / Publish Docs (push) Successful in 1m16s
Build / Tag Version (push) Successful in 28s
2025-10-20 16:16:55 -04:00
1595aea529 Fixed imports
Some checks failed
Build / Build NPM Project (push) Successful in 1m22s
Build / Publish Documentation (push) Failing after 19s
Build / Tag Version (push) Successful in 36s
2025-10-20 16:02:27 -04:00
08503de552 Fixed tests
Some checks failed
Build / Build NPM Project (push) Failing after 56s
Build / Publish Documentation (push) Has been skipped
Build / Tag Version (push) Has been skipped
2025-10-20 15:56:19 -04:00
a9a9b04a5a JSONAttemptPrase fallback
Some checks failed
Build / Build NPM Project (push) Failing after 48s
Build / Publish Documentation (push) Has been skipped
Build / Tag Version (push) Has been skipped
2025-10-20 15:51:10 -04:00
a7b19900da Added object map
Some checks failed
Build / Build NPM Project (push) Successful in 1m59s
Build / Publish Documentation (push) Failing after 32s
Build / Tag Version (push) Successful in 43s
2025-10-20 15:17:51 -04:00
16 changed files with 256 additions and 115 deletions

View File

@@ -13,3 +13,7 @@ quote_type = single
[*.md] [*.md]
max_line_length = off max_line_length = off
trim_trailing_whitespace = false trim_trailing_whitespace = false
[*.{yaml,yml}]
indent_style = space
indent_size = 2

View File

@@ -11,26 +11,26 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
container: node:20-alpine container: node:20-alpine
steps: steps:
- name: Clone Repository - name: Clone Repository
uses: ztimson/actions/clone@develop uses: ztimson/actions/clone@develop
- name: Install & Build - name: Install & Build
run: | run: |
npm i npm i
npm run build npm run build
- name: Test - name: Test
run: npm run test:coverage run: npm run test:coverage
- name: Upload to Registry - name: Upload to Registry
uses: ztimson/actions/npm/publish@develop uses: ztimson/actions/npm/publish@develop
- name: Upload to NPM - name: Upload to NPM
uses: ztimson/actions/npm/publish@develop uses: ztimson/actions/npm/publish@develop
with: with:
owner: ztimson owner: ztimson
registry: https://registry.npmjs.org/ registry: https://registry.npmjs.org/
token: ${{secrets.NPM_TOKEN}} token: ${{secrets.NPM_TOKEN}}
tag: tag:
name: Tag Version name: Tag Version
needs: build needs: build
@@ -38,23 +38,53 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
container: node container: node
steps: steps:
- name: Clone Repository - name: Clone Repository
uses: ztimson/actions/clone@develop uses: ztimson/actions/clone@develop
- name: Get Version Number
run: echo "VERSION=$(cat package.json | grep version | grep -Eo ':.+' | grep -Eo '[[:alnum:]\.\/\-]+')" >> $GITHUB_ENV
- name: Tag Version
uses: ztimson/actions/tag@develop
with:
tag: ${{env.VERSION}}
- name: Get Version Number
run: echo "VERSION=$(cat package.json | grep version | grep -Eo ':.+' | grep -Eo '[[:alnum:]\.\/\-]+')" >> $GITHUB_ENV
- name: Tag Version
uses: ztimson/actions/tag@develop
with:
tag: ${{env.VERSION}}
docs: docs:
name: Publish Documentation name: Publish Docs
needs: build runs-on: ubuntu-latest
uses: ztimson/actions/.github/workflows/docker.yaml@develop container: docker:dind
with: steps:
name: ztimson/utils - name: Clone Repository
repository: ${{github.server_url}}/${{github.repository}}.git uses: ztimson/actions/clone@develop
pass: ${{secrets.DEPLOY_TOKEN}}
- name: Build Image
run: |
REGISTRY=$(echo ${{github.server_url}} | sed s%http://%% | sed s%https://%%)
docker build -t "$REGISTRY/${{github.repository}}:${{github.ref_name}}" .
- name: Build Image
run: |
echo "CHECKSUM: ${{env.CHECKSUM}}"
REGISTRY=$(echo ${{github.server_url}} | sed s%http://%% | sed s%https://%%)
docker build -t "$REGISTRY/${{github.repository}}:${{github.ref_name}}" --build-arg LICENSE_KEY="${{secrets.LICENSE_KEY}}" --build-arg UPDATE_TOKEN="${{secrets.UPDATE_TOKEN}}" .
- name: Publish Branch Tag
run: |
REGISTRY=$(echo ${{github.server_url}} | sed s%http://%% | sed s%https://%%)
docker login -u ${{github.repository_owner}} -p ${{secrets.DEPLOY_TOKEN}} $REGISTRY
docker push "$REGISTRY/${{github.repository}}:${{github.ref_name}}"
- name: Publish Version Tag
run: |
if [ "${{github.ref_name}}" = "master" ]; then
REGISTRY=$(echo ${{github.server_url}} | sed s%http://%% | sed s%https://%%)
docker tag "$REGISTRY/${{github.repository}}:${{github.ref_name}}" "$REGISTRY/${{github.repository}}:${{env.VERSION}}"
docker push "$REGISTRY/${{github.repository}}:${{env.VERSION}}"
fi
- name: Publish Latest Tag
run: |
if [ "${{github.ref_name}}" = "master" ]; then
REGISTRY=$(echo ${{github.server_url}} | sed s%http://%% | sed s%https://%%)
docker tag "$REGISTRY/${{github.repository}}:${{github.ref_name}}" "$REGISTRY/${{github.repository}}:latest"
docker push "$REGISTRY/${{github.repository}}:latest"
fi

View File

@@ -1,11 +1,102 @@
<!DOCTYPE html>
<html> <html>
<head>
<title>Console Styling Playground</title>
</head>
<body> <body>
<script type="module"> <h1>Open Chrome DevTools Console to see magic! (Ctrl+Shift+J or Cmd+Option+J)</h1>
import {formatDate} from './dist/index.mjs';
const dt = new Date('2021-03-03T09:00:00Z'); <script>
const result = formatDate('Do MMMM dddd', dt, 0); // Console Styling Playground
console.log(result); class ConsoleStyler {
// Basic badge with customizable colors
badge(text, bgColor = '#007bff', textColor = 'white') {
console.log(
`%c ${text} `,
`background-color: ${bgColor};
color: ${textColor};
border-radius: 12px;
padding: 2px 8px;
font-weight: bold;`
);
}
// Multi-style log with different sections
richLog() {
console.log(
'%cSystem%c Operation %cDetails',
'background-color: #f0f0f0; color: black; padding: 2px 5px; border-radius: 3px;',
'color: blue; font-weight: bold;',
'color: green;'
);
}
// Grouped logs with nested information
groupedLog(title, items) {
console.group(title);
items.forEach(item => {
console.log(item);
});
console.groupEnd();
}
// Table view for structured data
tableLog(data) {
console.table(data);
}
// Performance tracking
timeTrack(label, operation) {
console.time(label);
operation();
console.timeEnd(label);
}
// Demonstration method
demo() {
// Different styled badges
this.badge('NEW', '#28a745'); // Green
this.badge('WARNING', '#ffc107', 'black'); // Yellow
this.badge('ERROR', '#dc3545'); // Red
this.badge('CUSTOM', '#6f42c1'); // Purple
// Rich multi-style log
this.richLog();
// Grouped logs
this.groupedLog('User Details', [
{ name: 'John Doe', age: 30, role: 'Admin' },
{ name: 'Jane Smith', age: 25, role: 'User' }
]);
// Table logging
this.tableLog([
{ name: 'John', age: 30, active: true },
{ name: 'Jane', age: 25, active: false }
]);
// Performance tracking
this.timeTrack('Complex Operation', () => {
let sum = 0;
for(let i = 0; i < 1000000; i++) {
sum += i;
}
console.log('Sum:', sum);
});
// Advanced: Conditional styling
const logLevel = 'warn';
console.log(
`%c[${logLevel.toUpperCase()}]%c Detailed message`,
`color: ${logLevel === 'warn' ? 'orange' : 'red'}; font-weight: bold;`,
'color: black;'
);
}
}
// Create instance and run demo
const styler = new ConsoleStyler();
styler.demo();
</script> </script>
</body> </body>
</html> </html>

View File

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

View File

@@ -1,5 +1,6 @@
import {Database, Table} from './database.ts'; import {Database, Table} from './database.ts';
import {deepCopy, includes, JSONSanitize} from './objects.ts'; import {JSONSanitize} from './json.ts';
import {deepCopy, includes} from './objects.ts';
export type CacheOptions = { export type CacheOptions = {
/** Delete keys automatically after x amount of seconds */ /** Delete keys automatically after x amount of seconds */

View File

@@ -1,6 +1,7 @@
import {makeArray} from './array.ts'; import {makeArray} from './array.ts';
import {ASet} from './aset.ts'; import {ASet} from './aset.ts';
import {dotNotation, flattenObj, JSONSanitize} from './objects.ts'; import {JSONSanitize} from './json.ts';
import {dotNotation, flattenObj} from './objects.ts';
import {LETTER_LIST} from './string.ts'; import {LETTER_LIST} from './string.ts';
/** /**

View File

@@ -1,5 +1,5 @@
import {makeArray} from './array.ts'; import {makeArray} from './array.ts';
import {JSONAttemptParse} from './objects.ts'; import {JSONAttemptParse} from './json.ts';
import {PromiseProgress} from './promise-progress'; import {PromiseProgress} from './promise-progress';
import {formatDate} from './time.ts'; import {formatDate} from './time.ts';

View File

@@ -9,6 +9,7 @@ export * from './files';
export * from './emitter'; export * from './emitter';
export * from './errors'; export * from './errors';
export * from './http'; export * from './http';
export * from './json';
export * from './jwt'; export * from './jwt';
export * from './logger'; export * from './logger';
export * from './math'; export * from './math';

40
src/json.ts Normal file
View File

@@ -0,0 +1,40 @@
/**
* Parse JSON but return the original string if it fails
*
* @param {any} json JSON string to parse
* @param fallback Fallback value if unable to parse, defaults to original string
* @return {string | T} Object if successful, original string otherwise
*/
export function JSONAttemptParse<T1, T2>(json: T2, fallback?: T1): T1 | T2 {
try { return JSON.parse(<any>json); }
catch { return fallback ?? json; }
}
/**
* Stringifies objects & skips primitives
*
* @param {any} obj Object to convert to serializable value
* @return {string | T} Serialized value
*/
export function JSONSerialize<T1>(obj: T1): T1 | string {
if(typeof obj == 'object' && obj != null) return JSONSanitize(obj);
return obj;
}
/**
* Convert an object to a JSON string avoiding any circular references.
*
* @param obj Object to convert to JSON
* @param {number} space Format the JSON with spaces
* @return {string} JSON string
*/
export function JSONSanitize(obj: any, space?: number): string {
const cache: any[] = [];
return JSON.stringify(obj, (key, value) => {
if(typeof value === 'object' && value !== null) {
if(cache.includes(value)) return '[Circular]';
cache.push(value);
}
return value;
}, space);
}

View File

@@ -1,4 +1,4 @@
import {JSONAttemptParse} from './objects.ts'; import {JSONAttemptParse} from './json.ts';
/** /**
* Creates a JSON Web Token (JWT) using the provided payload. * Creates a JSON Web Token (JWT) using the provided payload.

View File

@@ -1,5 +1,5 @@
import {TypedEmitter, TypedEvents} from './emitter'; import {TypedEmitter, TypedEvents} from './emitter';
import {JSONSanitize} from './objects.ts'; import {JSONSanitize} from './json.ts';
export const CliEffects = { export const CliEffects = {
CLEAR: "\x1b[0m", CLEAR: "\x1b[0m",

View File

@@ -1,5 +1,6 @@
export type Delta = { [key: string]: any | Delta | null }; import {JSONSanitize} from './json.ts';
export type Delta = { [key: string]: any | Delta | null };
/** /**
* Applies deltas to `target`. * Applies deltas to `target`.
@@ -294,41 +295,12 @@ export function mixin(target: any, constructors: any[]) {
} }
/** /**
* Parse JSON but return the original string if it fails * Run a map function on each property
* * @param obj Object that will be iterated
* @param {any} json JSON string to parse * @param {(key: string, value: any) => any} fn Transformer function - receives key & value
* @return {string | T} Object if successful, original string otherwise * @returns {{}}
*/ */
export function JSONAttemptParse<T1, T2>(json: T2): T1 | T2 { export function objectMap<T>(obj: any, fn: (key: string, value: any) => any): T {
try { return JSON.parse(<any>json); } return <any>Object.entries(obj).map(([key, value]: [string, any]) => [key, fn(key, value)])
catch { return json; } .reduce((acc, [key, value]) => ({ ...acc, [key]: value }), {});
}
/**
* Stringifies objects & skips primitives
*
* @param {any} obj Object to convert to serializable value
* @return {string | T} Serialized value
*/
export function JSONSerialize<T1>(obj: T1): T1 | string {
if(typeof obj == 'object' && obj != null) return JSONSanitize(obj);
return obj;
}
/**
* Convert an object to a JSON string avoiding any circular references.
*
* @param obj Object to convert to JSON
* @param {number} space Format the JSON with spaces
* @return {string} JSON string
*/
export function JSONSanitize(obj: any, space?: number): string {
const cache: any[] = [];
return JSON.stringify(obj, (key, value) => {
if(typeof value === 'object' && value !== null) {
if(cache.includes(value)) return '[Circular]';
cache.push(value);
}
return value;
}, space);
} }

View File

@@ -1,4 +1,5 @@
import {dotNotation, JSONAttemptParse, JSONSerialize} from './objects.ts'; import {JSONAttemptParse, JSONSerialize} from './json.ts';
import {dotNotation} from './objects.ts';
/** /**
* Filters an array of objects based on a search term and optional regex checking. * Filters an array of objects based on a search term and optional regex checking.

View File

@@ -1,5 +1,3 @@
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

33
tests/json.spec.ts Normal file
View File

@@ -0,0 +1,33 @@
import {JSONAttemptParse, JSONSanitize, JSONSerialize} from '../src';
describe('JSON Utilities', () => {
describe('JSONAttemptParse', () => {
it('parses valid JSON', () => {
expect(JSONAttemptParse('{"a":1}')).toEqual({ a: 1 });
});
it('returns original string on error', () => {
expect(JSONAttemptParse('not json')).toBe('not json');
});
});
describe('JSONSerialize', () => {
it('serializes objects', () => {
expect(JSONSerialize({ a: 1 })).toBe(JSON.stringify({ a: 1 }));
});
it('leaves primitives as is', () => {
expect(JSONSerialize('test')).toBe('test');
expect(JSONSerialize(123)).toBe(123);
});
});
describe('JSONSanitize', () => {
it('stringifies objects', () => {
expect(JSONSanitize({ a: 1 })).toBe(JSON.stringify({ a: 1 }));
});
it('does not throw on circular refs', () => {
const obj: any = {};
obj.self = obj;
expect(() => JSONSanitize(obj)).not.toThrow();
});
});
});

View File

@@ -1,6 +1,5 @@
import { import {
clean, deepCopy, deepMerge, dotNotation, encodeQuery, flattenObj, formData, includes, isEqual, mixin, clean, deepCopy, deepMerge, dotNotation, encodeQuery, flattenObj, formData, includes, isEqual, mixin,
JSONAttemptParse, JSONSerialize, JSONSanitize
} from '../src'; } from '../src';
describe('Object utilities', () => { describe('Object utilities', () => {
@@ -131,34 +130,4 @@ describe('Object utilities', () => {
expect(c.bar()).toBe(2); expect(c.bar()).toBe(2);
}); });
}); });
describe('JSONAttemptParse', () => {
it('parses valid JSON', () => {
expect(JSONAttemptParse('{"a":1}')).toEqual({ a: 1 });
});
it('returns original string on error', () => {
expect(JSONAttemptParse('not json')).toBe('not json');
});
});
describe('JSONSerialize', () => {
it('serializes objects', () => {
expect(JSONSerialize({ a: 1 })).toBe(JSON.stringify({ a: 1 }));
});
it('leaves primitives as is', () => {
expect(JSONSerialize('test')).toBe('test');
expect(JSONSerialize(123)).toBe(123);
});
});
describe('JSONSanitize', () => {
it('stringifies objects', () => {
expect(JSONSanitize({ a: 1 })).toBe(JSON.stringify({ a: 1 }));
});
it('does not throw on circular refs', () => {
const obj: any = {};
obj.self = obj;
expect(() => JSONSanitize(obj)).not.toThrow();
});
});
}); });