Compare commits
5 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 9cf86f4be1 | |||
| 2240c93db5 | |||
| 3e9052c4a7 | |||
| 326f6fe851 | |||
| 5b57b67542 |
1
.gitignore
vendored
1
.gitignore
vendored
@@ -9,6 +9,7 @@ node_modules
|
||||
uploads
|
||||
public/momentum*js
|
||||
junit.xml
|
||||
/docs/
|
||||
|
||||
# Logs
|
||||
*.log
|
||||
|
||||
5
.gitmodules
vendored
5
.gitmodules
vendored
@@ -1,5 +0,0 @@
|
||||
[submodule "docs"]
|
||||
path = docs
|
||||
url = ../utils.wiki.git
|
||||
branch = master
|
||||
ignore = all
|
||||
1
docs
1
docs
Submodule docs deleted from dbf5d8cd07
18
package.json
18
package.json
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@ztimson/utils",
|
||||
"version": "0.27.11",
|
||||
"version": "0.27.15",
|
||||
"description": "Utility library",
|
||||
"author": "Zak Timson",
|
||||
"license": "MIT",
|
||||
@@ -30,15 +30,15 @@
|
||||
"var-persist": "^1.0.1"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/jest": "^29.5.12",
|
||||
"fake-indexeddb": "^6.0.1",
|
||||
"jest": "^29.7.0",
|
||||
"@types/jest": "^30.0.0",
|
||||
"fake-indexeddb": "^6.2.5",
|
||||
"jest": "^30.2.0",
|
||||
"jest-junit": "^16.0.0",
|
||||
"ts-jest": "^29.1.2",
|
||||
"typedoc": "^0.26.7",
|
||||
"typescript": "^5.3.3",
|
||||
"vite": "^5.0.12",
|
||||
"vite-plugin-dts": "^4.5.3"
|
||||
"ts-jest": "^29.4.5",
|
||||
"typedoc": "^0.28.15",
|
||||
"typescript": "^5.9.3",
|
||||
"vite": "^7.2.4",
|
||||
"vite-plugin-dts": "^4.5.4"
|
||||
},
|
||||
"files": [
|
||||
"dist"
|
||||
|
||||
@@ -109,35 +109,21 @@ export class PathEvent {
|
||||
return;
|
||||
}
|
||||
|
||||
// Check cache first
|
||||
if (PathEvent.pathEventCache.has(e)) {
|
||||
if(PathEvent.pathEventCache.has(e)) {
|
||||
Object.assign(this, PathEvent.pathEventCache.get(e)!);
|
||||
return;
|
||||
}
|
||||
|
||||
let [p, method] = e.replaceAll(/\/{2,}/g, '/').split(':');
|
||||
let [p, method] = e.replaceAll(/(^|\/)\*+\/?$/g, '').split(':');
|
||||
if(!method) method = '*';
|
||||
|
||||
// Handle special cases
|
||||
if(p === '' || p === undefined) {
|
||||
// Empty string matches nothing
|
||||
this.module = '';
|
||||
this.path = '';
|
||||
this.fullPath = '';
|
||||
this.name = '';
|
||||
this.methods = new ASet<Method>(['n']);
|
||||
this.hasGlob = false;
|
||||
PathEvent.pathEventCache.set(e, this);
|
||||
return;
|
||||
}
|
||||
|
||||
if(p === '*') {
|
||||
// Wildcard means any path any event
|
||||
if(p === '' || p === undefined || p === '*') {
|
||||
this.module = '';
|
||||
this.path = '';
|
||||
this.fullPath = '**';
|
||||
this.name = '';
|
||||
this.methods = new ASet<Method>(['*']);
|
||||
this.methods = new ASet<Method>(p === '*' ? ['*'] : <any>method.split(''));
|
||||
this.hasGlob = true;
|
||||
PathEvent.pathEventCache.set(e, this);
|
||||
return;
|
||||
@@ -148,17 +134,74 @@ export class PathEvent {
|
||||
this.path = temp.join('/');
|
||||
this.fullPath = `${this.module}${this.module && this.path ? '/' : ''}${this.path}`;
|
||||
this.name = temp.pop() || '';
|
||||
|
||||
// Don't trim /** - it's needed for glob matching to work properly
|
||||
// Only trim if there's something after it which won't happen with our parsing
|
||||
|
||||
this.hasGlob = this.fullPath.includes('*');
|
||||
this.methods = new ASet(<any>method.split(''));
|
||||
|
||||
// Store in cache
|
||||
PathEvent.pathEventCache.set(e, this);
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a filter pattern matches a target path
|
||||
* @private
|
||||
*/
|
||||
private static matches(pattern: PathEvent, target: PathEvent): boolean {
|
||||
const methodsMatch = pattern.all || target.all || pattern.methods.intersection(target.methods).length > 0;
|
||||
if(!methodsMatch) return false;
|
||||
if(!pattern.hasGlob && !target.hasGlob) {
|
||||
const last = pattern.fullPath[target.fullPath.length];
|
||||
return pattern.fullPath.startsWith(target.fullPath) && (last == null || last == '/');
|
||||
}
|
||||
if(pattern.hasGlob) return this.pathMatchesGlob(target.fullPath, pattern.fullPath);
|
||||
return this.pathMatchesGlob(pattern.fullPath, target.fullPath);
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a path matches a glob pattern
|
||||
* @private
|
||||
*/
|
||||
private static pathMatchesGlob(path: string, pattern: string): boolean {
|
||||
if(pattern === path) return true;
|
||||
const pathParts = path.split('/').filter(p => !!p);
|
||||
const patternParts = pattern.split('/').filter(p => !!p);
|
||||
|
||||
let pathIdx = 0;
|
||||
let patternIdx = 0;
|
||||
while (patternIdx < patternParts.length && pathIdx < pathParts.length) {
|
||||
const patternPart = patternParts[patternIdx];
|
||||
if(patternPart === '**') {
|
||||
if(patternIdx === patternParts.length - 1) return true;
|
||||
while (pathIdx < pathParts.length) {
|
||||
if(PathEvent.pathMatchesGlob(pathParts.slice(pathIdx).join('/'), patternParts.slice(patternIdx + 1).join('/'))) return true;
|
||||
pathIdx++;
|
||||
}
|
||||
return false;
|
||||
} else if(patternPart === '*') {
|
||||
pathIdx++;
|
||||
patternIdx++;
|
||||
} else {
|
||||
if(patternPart !== pathParts[pathIdx]) return false;
|
||||
pathIdx++;
|
||||
patternIdx++;
|
||||
}
|
||||
}
|
||||
if(patternIdx < patternParts.length) return patternParts.slice(patternIdx).every(p => p === '**');
|
||||
return pathIdx === pathParts.length;
|
||||
}
|
||||
|
||||
/**
|
||||
* Score a path for specificity ranking (lower = more specific = higher priority)
|
||||
* @private
|
||||
*/
|
||||
private static scoreSpecificity(path: string): number {
|
||||
if(path === '**' || path === '') return Number.MAX_SAFE_INTEGER;
|
||||
const segments = path.split('/').filter(p => !!p);
|
||||
let score = -segments.length;
|
||||
segments.forEach(seg => {
|
||||
if(seg === '**') score += 0.5;
|
||||
else if(seg === '*') score += 0.25;
|
||||
});
|
||||
return score;
|
||||
}
|
||||
|
||||
/** Clear the cache of all PathEvents */
|
||||
static clearCache(): void {
|
||||
PathEvent.pathEventCache.clear();
|
||||
@@ -169,82 +212,6 @@ export class PathEvent {
|
||||
PathEvent.permissionCache.clear();
|
||||
}
|
||||
|
||||
/**
|
||||
* Score a path for specificity ranking (lower = more specific = higher priority)
|
||||
* @private
|
||||
*/
|
||||
private static scoreSpecificity(path: string): number {
|
||||
if (path === '**' || path === '') return Number.MAX_SAFE_INTEGER; // Least specific
|
||||
|
||||
const segments = path.split('/').filter(p => !!p);
|
||||
// Base score: number of segments (more segments = more specific = lower score)
|
||||
let score = -segments.length;
|
||||
|
||||
// Penalty for wildcards (makes them less specific than exact matches)
|
||||
// ADD to score to make it HIGHER/WORSE
|
||||
segments.forEach(seg => {
|
||||
if (seg === '**') score += 0.5;
|
||||
else if (seg === '*') score += 0.25;
|
||||
});
|
||||
|
||||
return score;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a path matches a glob pattern
|
||||
* @private
|
||||
*/
|
||||
private static pathMatchesGlob(path: string, pattern: string): boolean {
|
||||
// Handle exact match
|
||||
if (pattern === path) return true;
|
||||
|
||||
const pathParts = path.split('/').filter(p => !!p);
|
||||
const patternParts = pattern.split('/').filter(p => !!p);
|
||||
|
||||
let pathIdx = 0;
|
||||
let patternIdx = 0;
|
||||
|
||||
while (patternIdx < patternParts.length && pathIdx < pathParts.length) {
|
||||
const patternPart = patternParts[patternIdx];
|
||||
|
||||
if (patternPart === '**') {
|
||||
// ** matches zero or more path segments
|
||||
if (patternIdx === patternParts.length - 1) {
|
||||
// ** at the end matches everything
|
||||
return true;
|
||||
}
|
||||
// Try matching from next pattern part onwards
|
||||
const nextPattern = patternParts[patternIdx + 1];
|
||||
while (pathIdx < pathParts.length) {
|
||||
if (PathEvent.pathMatchesGlob(pathParts.slice(pathIdx).join('/'), patternParts.slice(patternIdx + 1).join('/'))) {
|
||||
return true;
|
||||
}
|
||||
pathIdx++;
|
||||
}
|
||||
return false;
|
||||
} else if (patternPart === '*') {
|
||||
// * matches exactly one segment
|
||||
pathIdx++;
|
||||
patternIdx++;
|
||||
} else {
|
||||
// Exact match required
|
||||
if (patternPart !== pathParts[pathIdx]) {
|
||||
return false;
|
||||
}
|
||||
pathIdx++;
|
||||
patternIdx++;
|
||||
}
|
||||
}
|
||||
|
||||
// Check if we've consumed all pattern parts
|
||||
if (patternIdx < patternParts.length) {
|
||||
// Remaining pattern parts must all be ** to match
|
||||
return patternParts.slice(patternIdx).every(p => p === '**');
|
||||
}
|
||||
|
||||
return pathIdx === pathParts.length;
|
||||
}
|
||||
|
||||
/**
|
||||
* Combine multiple events into one parsed object. Longest path takes precedent, but all subsequent methods are
|
||||
* combined until a "none" is reached
|
||||
@@ -254,32 +221,22 @@ export class PathEvent {
|
||||
*/
|
||||
static combine(...paths: (string | PathEvent)[]): PathEvent {
|
||||
const parsed = paths.map(p => p instanceof PathEvent ? p : new PathEvent(p));
|
||||
|
||||
// Sort by specificity: lower score = more specific = higher priority
|
||||
const sorted = parsed.toSorted((p1, p2) => {
|
||||
const score1 = PathEvent.scoreSpecificity(p1.fullPath);
|
||||
const score2 = PathEvent.scoreSpecificity(p2.fullPath);
|
||||
return score1 - score2;
|
||||
});
|
||||
|
||||
let result: PathEvent | null = null;
|
||||
|
||||
for (const p of sorted) {
|
||||
if (!result) {
|
||||
if(!result) {
|
||||
result = p;
|
||||
} else {
|
||||
// Only combine if current result's path starts with or matches the new permission's path
|
||||
if (result.fullPath.startsWith(p.fullPath)) {
|
||||
// If we hit a none at a parent level, stop here
|
||||
if (p.none) {
|
||||
break;
|
||||
}
|
||||
// Combine methods for permissions in the same hierarchy
|
||||
if(result.fullPath.startsWith(p.fullPath)) {
|
||||
if(p.none) break;
|
||||
result.methods = new ASet([...result.methods, ...p.methods]);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return result || new PathEvent('');
|
||||
}
|
||||
|
||||
@@ -293,39 +250,7 @@ export class PathEvent {
|
||||
static filter(target: string | PathEvent | (string | PathEvent)[], ...filter: (string | PathEvent)[]): PathEvent[] {
|
||||
const parsedTarget = makeArray(target).map(pe => pe instanceof PathEvent ? pe : new PathEvent(pe));
|
||||
const parsedFilter = makeArray(filter).map(pe => pe instanceof PathEvent ? pe : new PathEvent(pe));
|
||||
|
||||
return parsedTarget.filter(t => {
|
||||
const combined = PathEvent.combine(t);
|
||||
return !!parsedFilter.find(r => PathEvent.matches(r, combined));
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if a filter pattern matches a target path
|
||||
* @private
|
||||
*/
|
||||
private static matches(pattern: PathEvent, target: PathEvent): boolean {
|
||||
// Handle special cases
|
||||
if (pattern.fullPath === '' || target.fullPath === '') return false;
|
||||
if (pattern.fullPath === '*' || target.fullPath === '*') return pattern.methods.has('*') || target.methods.has('*') || pattern.methods.intersection(target.methods).length > 0;
|
||||
|
||||
// Check methods
|
||||
const methodsMatch = pattern.all || target.all || pattern.methods.intersection(target.methods).length > 0;
|
||||
if (!methodsMatch) return false;
|
||||
|
||||
// Check paths
|
||||
if (!pattern.hasGlob && !target.hasGlob) {
|
||||
// Fast path: no globs, use string comparison
|
||||
return pattern.fullPath === target.fullPath;
|
||||
}
|
||||
|
||||
if (pattern.hasGlob) {
|
||||
// Pattern has glob, match target against it
|
||||
return this.pathMatchesGlob(target.fullPath, pattern.fullPath);
|
||||
}
|
||||
|
||||
// Target has glob but pattern doesn't - pattern must match within target's glob range
|
||||
return this.pathMatchesGlob(pattern.fullPath, target.fullPath);
|
||||
return parsedTarget.filter(t => !!parsedFilter.find(r => PathEvent.matches(r, t)));
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -338,11 +263,7 @@ export class PathEvent {
|
||||
static has(target: string | PathEvent | (string | PathEvent)[], ...has: (string | PathEvent)[]): boolean {
|
||||
const parsedTarget = makeArray(target).map(pe => pe instanceof PathEvent ? pe : new PathEvent(pe));
|
||||
const parsedRequired = makeArray(has).map(pe => pe instanceof PathEvent ? pe : new PathEvent(pe));
|
||||
|
||||
// If target is a single item, check directly; if multiple, combine first
|
||||
const effectiveTarget = parsedTarget.length === 1 ? parsedTarget[0] : PathEvent.combine(...parsedTarget);
|
||||
|
||||
return !!parsedRequired.find(r => PathEvent.matches(r, effectiveTarget));
|
||||
return !!parsedRequired.find(r => !!parsedTarget.find(t => PathEvent.matches(r, t)));
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@@ -45,12 +45,12 @@ describe('Path Events', () => {
|
||||
expect(pe.all).toBe(true);
|
||||
expect(pe.fullPath).toBe('**');
|
||||
expect(pe.methods.has('*')).toBe(true);
|
||||
expect(pe.hasAll('module:c', 'some/path:ud')).toBeTruthy();
|
||||
});
|
||||
|
||||
it('parses empty string as none', () => {
|
||||
it('parses empty string as wildcard', () => {
|
||||
const pe = new PathEvent('');
|
||||
expect(pe.none).toBe(true);
|
||||
expect(pe.fullPath).toBe('');
|
||||
expect(pe.has('any/path:c')).toBe(true);
|
||||
});
|
||||
|
||||
it('parses none method', () => {
|
||||
@@ -60,6 +60,10 @@ describe('Path Events', () => {
|
||||
expect(pe.none).toBe(false);
|
||||
});
|
||||
|
||||
it('Test several wild card perms', () => {
|
||||
expect(PathEvent.has(['actions:*', 'groups:*', 'users:*'], 'groups/AUTH:r')).toBe(true);
|
||||
});
|
||||
|
||||
it('setters for methods', () => {
|
||||
const pe = new PathEvent('users/system:r');
|
||||
pe.create = true;
|
||||
@@ -80,6 +84,7 @@ describe('Path Events', () => {
|
||||
expect(c.methods.has('c')).toBe(true);
|
||||
expect(c.methods.has('r')).toBe(true);
|
||||
expect(c.methods.has('u')).toBe(true);
|
||||
expect(c.delete).toBe(false);
|
||||
});
|
||||
|
||||
it('combine stops at none', () => {
|
||||
@@ -94,6 +99,17 @@ describe('Path Events', () => {
|
||||
expect(d.none).toBe(false);
|
||||
});
|
||||
|
||||
it('combine works with wildcards', () => {
|
||||
expect(PathEvent.has([
|
||||
'payments/anonymous:d',
|
||||
'payments/anonymous:c',
|
||||
'payments/system:cr',
|
||||
'logs/Momentum:c',
|
||||
'products:r',
|
||||
'*'
|
||||
], 'actions/692a92d18afa11e6722e9f2e:r')).toBe(true);
|
||||
});
|
||||
|
||||
it('filter finds overlap by path and methods', () => {
|
||||
const events = [
|
||||
new PathEvent('users/sys:cr'),
|
||||
|
||||
@@ -35,7 +35,7 @@ describe('Time Utilities', () => {
|
||||
});
|
||||
|
||||
it('throws for unknown timezone', () => {
|
||||
expect(() => formatDate('YYYY', new Date(), '???')).toThrowError(/Invalid timezone/);
|
||||
expect(() => formatDate('YYYY', new Date(), '???')).toThrow(/Invalid timezone/);
|
||||
});
|
||||
|
||||
it('handles timezone by offset number', () => {
|
||||
|
||||
Reference in New Issue
Block a user