@fgv/ts-res 5.0.1-0 → 5.0.1-2

package/lib/packlets/resources/resourceBuilder.js

@@ -104,6 +104,7 @@ class ResourceBuilder {
                 .onSuccess((added, detail) => {
                 if (detail === 'exists') {
                     /* c8 ignore next 5 - defensive coding: conflicting candidates with same conditions should not occur */
+                    /* c8 ignore next 6 - functional code tested but coverage intermittently missed */
                     if (!resourceCandidate_1.ResourceCandidate.equal(added, candidate)) {
                         return (0, ts_utils_1.failWithDetail)(`${this.id}: conflicting candidates.`, 'exists');
                     }
@@ -130,6 +131,7 @@ class ResourceBuilder {
         }
         if (decl.resourceTypeName !== undefined) {
             const rt = this.setResourceType(decl.resourceTypeName);
+            /* c8 ignore next 3 - functional code tested but coverage intermittently missed */
             if (rt.isFailure()) {
                 return (0, ts_utils_1.failWithDetail)(rt.message, 'type-mismatch');
             }
@@ -145,10 +147,12 @@ class ResourceBuilder {
      */
     setResourceType(resourceTypeName) {
         var _a;
+        /* c8 ignore next 2 - functional code tested but coverage intermittently missed */
         if (((_a = this._resourceType) === null || _a === void 0 ? void 0 : _a.key) === resourceTypeName) {
             return (0, ts_utils_1.succeed)(this);
         }
         else if (this._resourceType !== undefined) {
+            /* c8 ignore next 4 - functional code tested but coverage intermittently missed */
             return (0, ts_utils_1.fail)(`${this.id}: conflicting resource types ${this._resourceType.key} !== ${resourceTypeName}.`);
         }
         return this._resourceTypes.validating.get(resourceTypeName).onSuccess((resourceType) => {

package/lib/packlets/resources/resourceManagerBuilder.d.ts

@@ -93,6 +93,10 @@ export declare class ResourceManagerBuilder implements IResourceManager<Resource
      * the {@link Resources.ResourceCandidate | resource candidates} in this manager.
      */
     get conditions(): ReadOnlyConditionCollector;
+    /**
+     * The resource IDs that this resource manager can resolve.
+     */
+    get resourceIds(): ReadonlyArray<ResourceId>;
     /**
      * A {@link Conditions.ConditionSetCollector | ConditionSetCollector} which
      * contains the {@link Conditions.ConditionSet | condition sets} used so far by

package/lib/packlets/resources/resourceManagerBuilder.js

@@ -91,6 +91,12 @@ class ResourceManagerBuilder {
     get conditions() {
         return this._conditions;
     }
+    /**
+     * The resource IDs that this resource manager can resolve.
+     */
+    get resourceIds() {
+        return Array.from(this._resources.keys()).sort();
+    }
     /**
      * A {@link Conditions.ConditionSetCollector | ConditionSetCollector} which
      * contains the {@link Conditions.ConditionSet | condition sets} used so far by
@@ -532,6 +538,7 @@ class ResourceManagerBuilder {
                 .convert(collectionData)
                 .onSuccess((compiledCollection) => {
                 // Apply hash-based normalization only if requested
+                /* c8 ignore next 5 - functional code tested but coverage intermittently missed */
                 if ((options === null || options === void 0 ? void 0 : options.normalized) === true) {
                     const normalizer = new ts_utils_1.Hash.Crc32Normalizer();
                     return normalizer
@@ -578,6 +585,7 @@ class ResourceManagerBuilder {
                             processedResourceIds.add(resourceDecl.id);
                             // Apply edits if there are candidates for this resource
                             const editedDeclResult = ResourceManagerBuilder._applyEditsToResourceDeclaration(resourceDecl, candidatesByResource, this._conditions);
+                            /* c8 ignore next 2 - functional code tested but coverage intermittently missed */
                             if (editedDeclResult.isFailure()) {
                                 return (0, ts_utils_1.fail)(`${resourceDecl.id}: Failed to apply edits: ${editedDeclResult.message}`);
                             }
@@ -590,11 +598,13 @@ class ResourceManagerBuilder {
                     }
                     // Handle any remaining candidates that target new resources not in the original collection
                     const errors = new ts_utils_1.MessageAggregator();
+                    /* c8 ignore next 9 - functional code tested but coverage intermittently missed */
                     for (const [resourceId, candidates] of candidatesByResource) {
                         if (!processedResourceIds.has(resourceId)) {
                             // Create a new resource declaration for candidates targeting a new resource ID
                             ResourceManagerBuilder._createResourceDeclFromCandidates(resourceId, candidates, this._conditions)
                                 .withErrorFormat((e) => `${resourceId}: Failed to create new resource from candidates: ${e}`)
+                                /* c8 ignore next 7 - functional code tested but coverage intermittently missed */
                                 .onSuccess((newResourceDecl) => {
                                 return newManager
                                     .addResource(newResourceDecl)
@@ -655,6 +665,7 @@ class ResourceManagerBuilder {
         if (message !== undefined) {
             return (0, ts_utils_1.fail)(`Invalid resource ID "${resourceDecl.id}": ${message}`);
         }
+        /* c8 ignore next 4 - functional code tested but coverage intermittently missed */
         const editCandidates = candidatesByResource.get(resourceId);
         if (!editCandidates || editCandidates.length === 0) {
             return (0, ts_utils_1.succeed)(resourceDecl);
@@ -674,6 +685,7 @@ class ResourceManagerBuilder {
         }
         // Then, apply edits (this replaces any colliding original candidates)
         // Convert edit candidates (which have ids) to child candidates (without ids) for merging
+        /* c8 ignore next 37 - functional code tested but coverage intermittently missed */
         for (const editCandidate of editCandidates) {
             const conditionTokenResult = conditions_1.ConditionSet.getKeyFromLooseDecl(editCandidate.conditions, conditionCollector);
             if (conditionTokenResult.isFailure()) {

package/lib/packlets/runtime/compiledResourceCollection.d.ts

@@ -54,6 +54,10 @@ export declare class CompiledResourceCollection implements IResourceManager<IRes
      * contains the {@link Qualifiers.Qualifier | qualifiers} used in this collection.
      */
     get qualifiers(): IReadOnlyQualifierCollector;
+    /**
+     * The resource IDs contained in this compiled resource collection.
+     */
+    get resourceIds(): ReadonlyArray<ResourceId>;
     /**
      * A {@link ResourceTypes.ResourceTypeCollector | ResourceTypeCollector} which
      * contains the {@link ResourceTypes.ResourceType | resource types} used in this collection.

package/lib/packlets/runtime/compiledResourceCollection.js

@@ -88,6 +88,12 @@ class CompiledResourceCollection {
     get qualifiers() {
         return this._qualifiers;
     }
+    /**
+     * The resource IDs contained in this compiled resource collection.
+     */
+    get resourceIds() {
+        return Array.from(this._builtResources.keys()).sort();
+    }
     /**
      * A {@link ResourceTypes.ResourceTypeCollector | ResourceTypeCollector} which
      * contains the {@link ResourceTypes.ResourceType | resource types} used in this collection.
@@ -419,6 +425,7 @@ class CompiledResourceCollection {
         const resourceMap = new ts_utils_1.ValidatingResultMap({
             converters: new ts_utils_1.Collections.KeyValueConverters({
                 key: common_1.Convert.resourceId,
+                /* c8 ignore next 3 - covered but coverage is confused */
                 value: (from) => {
                     return Validate.resource.validate(from);
                 }

package/lib/packlets/runtime/context/simpleContextQualifierProvider.js

@@ -155,19 +155,20 @@ class SimpleContextQualifierProvider extends contextQualifierProvider_1.ContextQ
         if (nameOrIndexOrQualifier instanceof qualifiers_1.Qualifier) {
             return (0, ts_utils_1.succeed)(nameOrIndexOrQualifier);
         }
+        /* c8 ignore next 16 - functional code tested but coverage intermittently missed */
         if (typeof nameOrIndexOrQualifier === 'string') {
             return this.qualifiers.validating
                 .get(nameOrIndexOrQualifier)
-                .withErrorFormat((error) => `${nameOrIndexOrQualifier}: Not a valid qualifier name.`);
+                .withErrorFormat((error) => `${nameOrIndexOrQualifier}: invalid qualifier name.`);
         }
         if (typeof nameOrIndexOrQualifier === 'number') {
             return this.qualifiers
                 .getAt(nameOrIndexOrQualifier)
-                .withErrorFormat((error) => `${nameOrIndexOrQualifier}: Not a valid qualifier index.`);
+                .withErrorFormat((error) => `${nameOrIndexOrQualifier}: invalid qualifier index.`);
         }
         return SimpleContextQualifierProvider._qualifierNameFromQualifierLike(nameOrIndexOrQualifier)
             .onSuccess((qualifierName) => this.qualifiers.validating.get(qualifierName))
-            .withErrorFormat((error) => `${nameOrIndexOrQualifier}: Not a valid Qualifier, name or index.`);
+            .withErrorFormat((error) => `${nameOrIndexOrQualifier}: invalid Qualifier, name or index.`);
     }
     /**
      * Resolves a qualifier name from a name, index, or qualifier object.

package/lib/packlets/runtime/iResourceManager.d.ts

@@ -82,6 +82,10 @@ export interface IResourceManager<TR extends IResource = IResource> {
      * The number of resources in this resource manager.
      */
     readonly numResources: number;
+    /**
+     * The resource IDs that this resource manager can resolve.
+     */
+    readonly resourceIds: ReadonlyArray<ResourceId>;
     /**
      * The number of candidates in this resource manager.
      */

package/lib/packlets/runtime/resource-tree/resourceTreeChildren.js

@@ -46,6 +46,7 @@ class ReadOnlyResourceTreeChildren extends ts_utils_1.ResultMap {
             if (node.isLeaf) {
                 return (0, ts_utils_1.succeed)(node).withDetail('success');
             }
+            /* c8 ignore next 3 - functional code tested but coverage intermittently missed */
             return (0, ts_utils_1.fail)(`${name}: not a resource${this.path ? ` in ${this.path}` : ''}.`).withDetail('failure');
         });
     }
@@ -54,6 +55,7 @@ class ReadOnlyResourceTreeChildren extends ts_utils_1.ResultMap {
             if (node.isBranch) {
                 return (0, ts_utils_1.succeed)(node).withDetail('success');
             }
+            /* c8 ignore next 3 - functional code tested but coverage intermittently missed */
             return (0, ts_utils_1.fail)(`${name}: not a branch${this.path ? ` in ${this.path}` : ''}.`).withDetail('failure');
         });
     }
@@ -90,6 +92,7 @@ class ReadOnlyResourceTreeChildren extends ts_utils_1.ResultMap {
             if (node.isBranch) {
                 return (0, ts_utils_1.succeed)(node).withDetail('success');
             }
+            /* c8 ignore next 3 - functional code tested but coverage intermittently missed */
             return (0, ts_utils_1.fail)(`${id}: not a branch${this.path ? ` in ${this.path}` : ''}.`).withDetail('failure');
         });
     }

package/lib/packlets/runtime/resourceResolver.d.ts

@@ -1,6 +1,6 @@
 import { Result } from '@fgv/ts-utils';
 import { JsonValue } from '@fgv/ts-json-base';
-import { IResourceResolver } from '../common';
+import { IResourceResolver, ResourceId } from '../common';
 import { Condition, ConditionSet } from '../conditions';
 import { AbstractDecision } from '../decisions';
 import { ReadOnlyQualifierTypeCollector } from '../qualifier-types';
@@ -91,6 +91,10 @@ export declare class ResourceResolver implements IResourceResolver {
      * The readonly qualifier collector that provides qualifier implementations.
      */
     get qualifiers(): IReadOnlyQualifierCollector;
+    /**
+     * The resource IDs that this resolver can resolve.
+     */
+    get resourceIds(): ReadonlyArray<ResourceId>;
     /**
      * The cache array for resolved conditions, indexed by condition index for O(1) lookup.
      * Each entry stores the resolved {@link Runtime.IConditionMatchResult | condition match result} for

package/lib/packlets/runtime/resourceResolver.js

@@ -41,6 +41,12 @@ class ResourceResolver {
     get qualifiers() {
         return this.contextQualifierProvider.qualifiers;
     }
+    /**
+     * The resource IDs that this resolver can resolve.
+     */
+    get resourceIds() {
+        return this.resourceManager.resourceIds;
+    }
     /**
      * The cache array for resolved conditions, indexed by condition index for O(1) lookup.
      * Each entry stores the resolved {@link Runtime.IConditionMatchResult | condition match result} for
@@ -239,7 +245,7 @@ class ResourceResolver {
         for (let instanceIndex = 0; instanceIndex < decision.candidates.length; instanceIndex++) {
             const candidate = decision.candidates[instanceIndex];
             const conditionSetResult = this.resolveConditionSet(candidate.conditionSet);
-            /* c8 ignore next 4 - defensive coding: extreme internal error scenario not reachable in normal operation */
+            /* c8 ignore next 4 - defensive in depth */
             if (conditionSetResult.isFailure()) {
                 (_b = this._listener) === null || _b === void 0 ? void 0 : _b.onCacheError('decision', decisionIndex);
                 return (0, ts_utils_1.fail)(`${decision.key}: Failed to resolve condition set": ${conditionSetResult.message}`);
@@ -253,7 +259,6 @@ class ResourceResolver {
                 });
             }
             else if (resolution.matchType === 'matchAsDefault') {
-                /* c8 ignore next 4 - edge case: default matching instances rarely used in practice */
                 matchingDefaultInstanceResults.push({
                     index: instanceIndex,
                     result: resolution
@@ -310,7 +315,6 @@ class ResourceResolver {
         return (0, ts_utils_1.succeed)(bestCandidate);
     }
     resolveAllResourceCandidates(idOrResource) {
-        /* c8 ignore next 4 - defensive coding: string resource resolution should use direct resource calls */
         if (typeof idOrResource === 'string') {
             return this.resourceManager
                 .getBuiltResource(idOrResource)
@@ -343,7 +347,7 @@ class ResourceResolver {
         }
         // Add all default matches after regular matches (already sorted by priority)
         for (const candidateIndex of resolution.defaultInstanceIndices) {
-            /* c8 ignore next 3 - defensive coding: extreme internal error scenario not reachable in normal operation */
+            /* c8 ignore next 3 - defense in depth should not happen */
             if (candidateIndex >= resource.candidates.length) {
                 return (0, ts_utils_1.fail)(`Invalid candidate index ${candidateIndex} for resource "${resource.id}"`);
             }

package/lib/packlets/runtime/resourceTreeResolver.js

@@ -103,6 +103,7 @@ class ResourceTreeResolver {
             }).onSuccess((value) => {
                 // Only convert undefined to {} if emptyBranchMode is 'allow'
                 // For 'omit' mode or custom handlers returning undefined, preserve undefined
+                /* c8 ignore next 3 - defense in depth */
                 return (0, ts_utils_1.succeed)(value === undefined && emptyBranchMode === 'allow' ? {} : value);
             });
     }
@@ -173,6 +174,7 @@ class ResourceTreeResolver {
         if (node.isLeaf) {
             return (0, ts_utils_1.fail)(`Internal error: processBranchNode called on leaf node at ${path}`);
         }
+        /* c8 ignore next 2 - ?? is defense in depth */
         const resourceErrorMode = (_a = options.onResourceError) !== null && _a !== void 0 ? _a : 'fail';
         const emptyBranchMode = (_b = options.onEmptyBranch) !== null && _b !== void 0 ? _b : 'allow';
         const aggregator = new ts_utils_1.MessageAggregator();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fgv/ts-res",
-  "version": "5.0.1-0",
+  "version": "5.0.1-2",
   "description": "Multi-dimensional Resource Runtime",
   "main": "lib/index.js",
   "types": "dist/ts-res.d.ts",
@@ -44,16 +44,16 @@
     "@rushstack/heft-node-rig": "2.9.5",
     "@types/heft-jest": "1.0.6",
     "eslint-plugin-tsdoc": "~0.4.0",
-    "@fgv/ts-utils-jest": "5.0.1-0",
-    "@fgv/ts-extras": "5.0.1-0"
+    "@fgv/ts-utils-jest": "5.0.1-2",
+    "@fgv/ts-extras": "5.0.1-2"
   },
   "dependencies": {
     "luxon": "^3.7.2",
     "fflate": "~0.8.2",
-    "@fgv/ts-json-base": "5.0.1-0",
-    "@fgv/ts-utils": "5.0.1-0",
-    "@fgv/ts-bcp47": "5.0.1-0",
-    "@fgv/ts-json": "5.0.1-0"
+    "@fgv/ts-utils": "5.0.1-2",
+    "@fgv/ts-json-base": "5.0.1-2",
+    "@fgv/ts-bcp47": "5.0.1-2",
+    "@fgv/ts-json": "5.0.1-2"
   },
   "scripts": {
     "build": "heft build --clean",