add special case for contents and collections keys, for now

rsek · Jan 17, 2024 · 7276776 · 7276776
1 parent 360df52
commit 7276776
Show file tree

Hide file tree

Showing 3 changed files with 45 additions and 27 deletions.
diff --git a/pkg/nodejs/@datasworn/core/dist/ObjectGlobPath/ObjectGlobber.d.ts b/pkg/nodejs/@datasworn/core/dist/ObjectGlobPath/ObjectGlobber.d.ts
@@ -9,6 +9,8 @@ import CONST from '../IdElements/CONST.js';
 declare class ObjectGlobber<TTuple extends Array<PropertyKey> = Array<PropertyKey>> extends Array<TTuple[number]> {
     #private;
     constructor(...items: TTuple);
+    /** Keys that are part of the real object path, but not part of the ID */
+    static readonly implicitKeys: string[];
     /** Does this path contain any wildcard or globstar elements? */
     get wildcard(): boolean;
     toJSON(): unknown[];
@@ -29,7 +31,7 @@ declare class ObjectGlobber<TTuple extends Array<PropertyKey> = Array<PropertyKe
         matchTest?: ObjectGlobber.MatchTest;
         includeArrays: boolean;
     }): unknown[];
-    static getKeyMatches(from: object, matchKey: PropertyKey, { forEachMatch, matchTest, includeArrays }?: {
+    static getKeyMatches(from: object, matchedKey: PropertyKey, { forEachMatch, matchTest, includeArrays }?: {
         forEachMatch?: ObjectGlobber.WalkIteratee;
         matchTest?: ObjectGlobber.MatchTest;
         includeArrays: boolean;

diff --git a/pkg/nodejs/@datasworn/core/dist/ObjectGlobPath/ObjectGlobber.js b/pkg/nodejs/@datasworn/core/dist/ObjectGlobPath/ObjectGlobber.js
@@ -108,7 +108,10 @@ class ObjectGlobber extends Array {
         const nextPath = keys.slice(1);
         // console.log('next:', nextKey, nextPath)
         if (nextPath.length === 0)
-            return _a.getKeyMatches(from, nextKey, { includeArrays, matchTest });
+            return _a.getKeyMatches(from, nextKey, {
+                includeArrays,
+                matchTest
+            });
         const matches = _a.getKeyMatches(from, nextKey, {
             includeArrays
         });
@@ -121,27 +124,27 @@ class ObjectGlobber extends Array {
         }
         return results;
     }
-    static getKeyMatches(from, matchKey, { forEachMatch, matchTest, includeArrays = false } = {
+    static getKeyMatches(from, matchedKey, { forEachMatch, matchTest, includeArrays = false } = {
         includeArrays: false
     }) {
-        if (!_a.isPropertyKey(matchKey))
-            throw new Error(`Expected a number, string, or symbol key, but got ${typeof matchKey}`);
+        if (!_a.isPropertyKey(matchedKey))
+            throw new Error(`Expected a number, string, or symbol key, but got ${typeof matchedKey}`);
         const results = [];
         const hasMatchTest = typeof matchTest === 'function';
         function iterateWildcardMatch(key, value, results) {
-            if (!hasMatchTest || matchTest(value, key, matchKey))
+            if (!hasMatchTest || matchTest(value, key, matchedKey))
                 results.push(value);
         }
         function iterateGlobstarMatch(key, value, results) {
             iterateWildcardMatch(key, value, results);
             if (_a.isWalkable(value, includeArrays)) {
-                results.push(..._a.getKeyMatches(value, matchKey, {
+                results.push(..._a.getKeyMatches(value, matchedKey, {
                     matchTest,
                     includeArrays
                 }));
             }
         }
-        switch (matchKey) {
+        switch (matchedKey) {
             case _a.WILDCARD.description:
             case _a.WILDCARD:
                 if (from instanceof Map) {
@@ -174,13 +177,14 @@ class ObjectGlobber extends Array {
             default: {
                 let value;
                 if (from instanceof Map)
-                    value = from.get(matchKey);
+                    value = from.get(matchedKey);
                 else
-                    value = from[matchKey];
-                if (typeof value === 'undefined')
-                    throw new Error(`Unable to find key ${typeof matchKey === 'symbol'
-                        ? matchKey.toString()
-                        : JSON.stringify(matchKey)}`);
+                    value = from[matchedKey];
+                if (typeof value === 'undefined' &&
+                    !_a.implicitKeys.includes(matchedKey))
+                    throw new Error(`Unable to find key ${typeof matchedKey === 'symbol'
+                        ? matchedKey.toString()
+                        : JSON.stringify(matchedKey)}`);
                 results.push(value);
                 break;
             }
@@ -289,6 +293,8 @@ _a = ObjectGlobber, _ObjectGlobber_getPlainObjectPaths = function _ObjectGlobber
     }
     return results;
 };
+/** Keys that are part of the real object path, but not part of the ID */
+ObjectGlobber.implicitKeys = ['contents', 'collections'];
 (function (ObjectGlobber) {
     /** Represents a glob wildcard path element, usually expressed as `*` */
     ObjectGlobber.WILDCARD = Symbol(CONST_js_1.default.WildcardString);

diff --git a/src/pkg-core/ObjectGlobPath/ObjectGlobber.ts b/src/pkg-core/ObjectGlobPath/ObjectGlobber.ts
@@ -18,6 +18,9 @@ class ObjectGlobber<
 		super(...(items.map(ObjectGlobber.replaceGlobString as any) as any))
 	}
 
+	/** Keys that are part of the real object path, but not part of the ID */
+	static readonly implicitKeys = ['contents', 'collections']
+
 	/** Does this path contain any wildcard or globstar elements? */
 	get wildcard() {
 		return this.some(ObjectGlobber.isGlobElement)
@@ -150,7 +153,10 @@ class ObjectGlobber<
 		// console.log('next:', nextKey, nextPath)
 
 		if (nextPath.length === 0)
-			return ObjectGlobber.getKeyMatches(from, nextKey, { includeArrays, matchTest })
+			return ObjectGlobber.getKeyMatches(from, nextKey, {
+				includeArrays,
+				matchTest
+			})
 
 		const matches = ObjectGlobber.getKeyMatches(from, nextKey, {
 			includeArrays
@@ -172,7 +178,7 @@ class ObjectGlobber<
 
 	static getKeyMatches(
 		from: object,
-		matchKey: PropertyKey,
+		matchedKey: PropertyKey,
 		{
 			forEachMatch,
 			matchTest,
@@ -185,9 +191,9 @@ class ObjectGlobber<
 			includeArrays: false
 		}
 	): unknown[] {
-		if (!ObjectGlobber.isPropertyKey(matchKey))
+		if (!ObjectGlobber.isPropertyKey(matchedKey))
 			throw new Error(
-				`Expected a number, string, or symbol key, but got ${typeof matchKey}`
+				`Expected a number, string, or symbol key, but got ${typeof matchedKey}`
 			)
 
 		const results: unknown[] = []
@@ -199,7 +205,8 @@ class ObjectGlobber<
 			value: unknown,
 			results: unknown[]
 		) {
-			if (!hasMatchTest || matchTest(value, key, matchKey)) results.push(value)
+			if (!hasMatchTest || matchTest(value, key, matchedKey))
+				results.push(value)
 		}
 		function iterateGlobstarMatch(
 			key: PropertyKey,
@@ -209,15 +216,15 @@ class ObjectGlobber<
 			iterateWildcardMatch(key, value, results)
 			if (ObjectGlobber.isWalkable(value, includeArrays)) {
 				results.push(
-					...ObjectGlobber.getKeyMatches(value, matchKey, {
+					...ObjectGlobber.getKeyMatches(value, matchedKey, {
 						matchTest,
 						includeArrays
 					})
 				)
 			}
 		}
 
-		switch (matchKey) {
+		switch (matchedKey) {
 			case ObjectGlobber.WILDCARD.description:
 			case ObjectGlobber.WILDCARD:
 				if (from instanceof Map) {
@@ -245,15 +252,18 @@ class ObjectGlobber<
 				break
 			default: {
 				let value: unknown
-				if (from instanceof Map) value = from.get(matchKey)
-				else value = from[matchKey]
+				if (from instanceof Map) value = from.get(matchedKey)
+				else value = from[matchedKey]
 
-				if (typeof value === 'undefined')
+				if (
+					typeof value === 'undefined' &&
+					!ObjectGlobber.implicitKeys.includes(matchedKey as string)
+				)
 					throw new Error(
 						`Unable to find key ${
-							typeof matchKey === 'symbol'
-								? (matchKey as any).toString()
-								: JSON.stringify(matchKey)
+							typeof matchedKey === 'symbol'
+								? (matchedKey as any).toString()
+								: JSON.stringify(matchedKey)
 						}`
 					)