@fgv/ts-res 5.0.0-19 → 5.0.0-20

package/dist/ts-res.d.ts

@@ -1738,7 +1738,7 @@ declare const containerContextDecl: Converter<Normalized.IContainerContextDecl>;
 
 declare namespace Context {
     export {
-        Convert_7 as Convert,
+        Convert_8 as Convert,
         IContextMatchOptions,
         IContextQualifierValueDecl,
         IContextDecl,
@@ -2168,16 +2168,6 @@ declare namespace Convert_6 {
 }
 
 declare namespace Convert_7 {
-    export {
-        contextQualifierValueDecl,
-        contextDecl,
-        IContextDeclConvertContext,
-        validatedContextQualifierValueDecl,
-        validatedContextDecl
-    }
-}
-
-declare namespace Convert_8 {
     export {
         looseConditionDecl,
         childConditionDecl,
@@ -2195,6 +2185,16 @@ declare namespace Convert_8 {
     }
 }
 
+declare namespace Convert_8 {
+    export {
+        contextQualifierValueDecl,
+        contextDecl,
+        IContextDeclConvertContext,
+        validatedContextQualifierValueDecl,
+        validatedContextDecl
+    }
+}
+
 declare namespace Convert_9 {
     export {
         validateSystemConfiguration,
@@ -5158,6 +5158,14 @@ declare interface IResourceType<T = unknown> extends ICollectible<ResourceTypeNa
      * Sets the index for this resource type.  Once set, the index cannot be changed.
      */
     setIndex(index: number): Result<ResourceTypeIndex>;
+    /**
+     * Creates a template for a new resource of this type.
+     * The template provides a default structure for creating new resource instances.
+     * @param resourceId - The id for the new resource
+     * @returns A loose resource declaration with default values for this resource type
+     * @public
+     */
+    createTemplate(resourceId: ResourceId): ResourceJson.Json.ILooseResourceDecl;
 }
 
 /**
@@ -5915,6 +5923,11 @@ declare class JsonResourceType extends ResourceType<JsonObject> {
      * {@inheritdoc ResourceTypes.ResourceType.(validate:3)}
      */
     validate(json: JsonObject, completeness: 'partial'): Result<JsonObject>;
+    /**
+     * Gets the default template value for a JSON resource type.
+     * @returns An empty object as the default JSON value
+     */
+    protected getDefaultTemplateValue(): JsonObject;
 }
 
 /**
@@ -7752,7 +7765,7 @@ declare const resourceIndex: Converter<ResourceIndex, unknown>;
 declare namespace ResourceJson {
     export {
         Compiled,
-        Convert_8 as Convert,
+        Convert_7 as Convert,
         Helpers_2 as Helpers,
         Json,
         Normalized,
@@ -8417,7 +8430,7 @@ declare const resourceTreeChildNodeDecl: Converter<Normalized.IResourceTreeChild
  * strongly-typed internal tree operations, ensuring type safety and consistent
  * error handling throughout the resource tree navigation.
  *
- * @internal
+ * @public
  */
 declare class ResourceTreeChildrenValidator<T> implements IReadOnlyResourceTreeChildren<T, string, string> {
     private readonly _inner;
@@ -8472,17 +8485,17 @@ declare class ResourceTreeChildrenValidator<T> implements IReadOnlyResourceTreeC
      */
     forEach(cb: (value: unknown, key: string, map: IReadOnlyResultMap<string, unknown>, thisArg?: unknown) => void, arg?: unknown): void;
     /**
-     * Gets a child node by its ResourceName key with detailed error information.
-     * @param key - The ResourceName key to look up
+     * Gets a child node by its string key with detailed error information.
+     * @param key - The string key to look up
      * @returns DetailedResult containing the node if found, or failure with details
      */
-    get(key: ResourceName): DetailedResult<IReadOnlyResourceTreeNode<T>, Collections.ResultMapResultDetail>;
+    get(key: string): DetailedResult<IReadOnlyResourceTreeNode<T>, Collections.ResultMapResultDetail>;
     /**
-     * Checks if a child node exists at the given ResourceName key.
-     * @param key - The ResourceName key to check
+     * Checks if a child node exists at the given string key.
+     * @param key - The string key to check
      * @returns True if a child node exists at the key, false otherwise
      */
-    has(key: ResourceName): boolean;
+    has(key: string): boolean;
     /**
      * Returns an iterator of ResourceName keys for all child nodes.
      * @returns Map iterator for all child node keys
@@ -8578,6 +8591,21 @@ export declare abstract class ResourceType<T = unknown> implements IResourceType
      * Sets the index for this resource type.  Once set, the index cannot be changed.
      */
     setIndex(index: number): Result<ResourceTypeIndex>;
+    /**
+     * Creates a template for a new resource of this type.
+     * Default implementation provides a basic template.
+     * Subclasses can override to provide type-specific templates.
+     * @param resourceId - The id for the new resource
+     * @returns A loose resource declaration with default values for this resource type
+     * @public
+     */
+    createTemplate(resourceId: ResourceId): ResourceJson.Json.ILooseResourceDecl;
+    /**
+     * Gets the default template value for this resource type.
+     * Subclasses should override this to provide type-specific default values.
+     * @returns The default JSON value for a new resource of this type
+     */
+    protected getDefaultTemplateValue(): JsonObject;
 }
 
 /**

package/lib/packlets/resource-types/jsonResourceType.d.ts

@@ -53,5 +53,10 @@ export declare class JsonResourceType extends ResourceType<JsonObject> {
      * {@inheritdoc ResourceTypes.ResourceType.(validate:3)}
      */
     validate(json: JsonObject, completeness: 'partial'): Result<JsonObject>;
+    /**
+     * Gets the default template value for a JSON resource type.
+     * @returns An empty object as the default JSON value
+     */
+    protected getDefaultTemplateValue(): JsonObject;
 }
 //# sourceMappingURL=jsonResourceType.d.ts.map

package/lib/packlets/resource-types/jsonResourceType.js

@@ -61,6 +61,13 @@ class JsonResourceType extends resourceType_1.ResourceType {
     validate(json, __completeness) {
         return ts_json_base_1.Converters.jsonObject.convert(json);
     }
+    /**
+     * Gets the default template value for a JSON resource type.
+     * @returns An empty object as the default JSON value
+     */
+    getDefaultTemplateValue() {
+        return {};
+    }
 }
 exports.JsonResourceType = JsonResourceType;
 //# sourceMappingURL=jsonResourceType.js.map

package/lib/packlets/resource-types/resourceType.d.ts

@@ -1,6 +1,7 @@
-import { JsonValue } from '@fgv/ts-json-base';
+import { JsonValue, JsonObject } from '@fgv/ts-json-base';
 import { ICollectible, Result } from '@fgv/ts-utils';
 import { CandidateCompleteness, ResourceTypeIndex, ResourceTypeName, ResourceValueMergeMethod, ResourceId } from '../common';
+import * as ResourceJson from '../resource-json';
 /**
  * Parameters used to validate a {@link ResourceJson.Json.ILooseResourceCandidateDecl | resource candidate declaration}.
  * @public
@@ -82,6 +83,14 @@ export interface IResourceType<T = unknown> extends ICollectible<ResourceTypeNam
      * Sets the index for this resource type.  Once set, the index cannot be changed.
      */
     setIndex(index: number): Result<ResourceTypeIndex>;
+    /**
+     * Creates a template for a new resource of this type.
+     * The template provides a default structure for creating new resource instances.
+     * @param resourceId - The id for the new resource
+     * @returns A loose resource declaration with default values for this resource type
+     * @public
+     */
+    createTemplate(resourceId: ResourceId): ResourceJson.Json.ILooseResourceDecl;
 }
 /**
  * Abstract base class for resource types which are responsible for
@@ -149,5 +158,20 @@ export declare abstract class ResourceType<T = unknown> implements IResourceType
      * Sets the index for this resource type.  Once set, the index cannot be changed.
      */
     setIndex(index: number): Result<ResourceTypeIndex>;
+    /**
+     * Creates a template for a new resource of this type.
+     * Default implementation provides a basic template.
+     * Subclasses can override to provide type-specific templates.
+     * @param resourceId - The id for the new resource
+     * @returns A loose resource declaration with default values for this resource type
+     * @public
+     */
+    createTemplate(resourceId: ResourceId): ResourceJson.Json.ILooseResourceDecl;
+    /**
+     * Gets the default template value for this resource type.
+     * Subclasses should override this to provide type-specific default values.
+     * @returns The default JSON value for a new resource of this type
+     */
+    protected getDefaultTemplateValue(): JsonObject;
 }
 //# sourceMappingURL=resourceType.d.ts.map

package/lib/packlets/resource-types/resourceType.js

@@ -57,6 +57,38 @@ class ResourceType {
     setIndex(index) {
         return this._collectible.setIndex(index);
     }
+    /**
+     * Creates a template for a new resource of this type.
+     * Default implementation provides a basic template.
+     * Subclasses can override to provide type-specific templates.
+     * @param resourceId - The id for the new resource
+     * @returns A loose resource declaration with default values for this resource type
+     * @public
+     */
+    createTemplate(resourceId) {
+        return {
+            id: resourceId,
+            resourceTypeName: this.key,
+            candidates: [
+                {
+                    json: this.getDefaultTemplateValue(),
+                    conditions: undefined,
+                    isPartial: false,
+                    mergeMethod: 'replace'
+                }
+            ]
+        };
+    }
+    /**
+     * Gets the default template value for this resource type.
+     * Subclasses should override this to provide type-specific default values.
+     * @returns The default JSON value for a new resource of this type
+     */
+    getDefaultTemplateValue() {
+        // Default implementation returns an empty object
+        // Subclasses should override for type-specific defaults
+        return {};
+    }
 }
 exports.ResourceType = ResourceType;
 //# sourceMappingURL=resourceType.js.map

package/lib/packlets/runtime/resource-tree/resourceTreeChildrenValidator.d.ts

@@ -14,7 +14,7 @@ import { IReadOnlyResourceTreeBranch, IReadOnlyResourceTreeChildren, IReadOnlyRe
  * strongly-typed internal tree operations, ensuring type safety and consistent
  * error handling throughout the resource tree navigation.
  *
- * @internal
+ * @public
  */
 export declare class ResourceTreeChildrenValidator<T> implements IReadOnlyResourceTreeChildren<T, string, string> {
     private readonly _inner;
@@ -69,17 +69,17 @@ export declare class ResourceTreeChildrenValidator<T> implements IReadOnlyResour
      */
     forEach(cb: (value: unknown, key: string, map: IReadOnlyResultMap<string, unknown>, thisArg?: unknown) => void, arg?: unknown): void;
     /**
-     * Gets a child node by its ResourceName key with detailed error information.
-     * @param key - The ResourceName key to look up
+     * Gets a child node by its string key with detailed error information.
+     * @param key - The string key to look up
      * @returns DetailedResult containing the node if found, or failure with details
      */
-    get(key: ResourceName): DetailedResult<IReadOnlyResourceTreeNode<T>, Collections.ResultMapResultDetail>;
+    get(key: string): DetailedResult<IReadOnlyResourceTreeNode<T>, Collections.ResultMapResultDetail>;
     /**
-     * Checks if a child node exists at the given ResourceName key.
-     * @param key - The ResourceName key to check
+     * Checks if a child node exists at the given string key.
+     * @param key - The string key to check
      * @returns True if a child node exists at the key, false otherwise
      */
-    has(key: ResourceName): boolean;
+    has(key: string): boolean;
     /**
      * Returns an iterator of ResourceName keys for all child nodes.
      * @returns Map iterator for all child node keys

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

@@ -37,7 +37,7 @@ const ts_utils_1 = require("@fgv/ts-utils");
  * strongly-typed internal tree operations, ensuring type safety and consistent
  * error handling throughout the resource tree navigation.
  *
- * @internal
+ * @public
  */
 class ResourceTreeChildrenValidator {
     /**
@@ -121,8 +121,8 @@ class ResourceTreeChildrenValidator {
         }
     }
     /**
-     * Gets a child node by its ResourceName key with detailed error information.
-     * @param key - The ResourceName key to look up
+     * Gets a child node by its string key with detailed error information.
+     * @param key - The string key to look up
      * @returns DetailedResult containing the node if found, or failure with details
      */
     get(key) {
@@ -132,8 +132,8 @@ class ResourceTreeChildrenValidator {
         return (0, ts_utils_1.failWithDetail)(`${key}: invalid resource name.`, 'invalid-key');
     }
     /**
-     * Checks if a child node exists at the given ResourceName key.
-     * @param key - The ResourceName key to check
+     * Checks if a child node exists at the given string key.
+     * @param key - The string key to check
      * @returns True if a child node exists at the key, false otherwise
      */
     has(key) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fgv/ts-res",
-  "version": "5.0.0-19",
+  "version": "5.0.0-20",
   "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.3",
     "@types/heft-jest": "1.0.6",
     "eslint-plugin-tsdoc": "~0.4.0",
-    "@fgv/ts-utils-jest": "5.0.0-19",
-    "@fgv/ts-extras": "5.0.0-19"
+    "@fgv/ts-utils-jest": "5.0.0-20",
+    "@fgv/ts-extras": "5.0.0-20"
   },
   "dependencies": {
     "luxon": "^3.7.1",
     "fflate": "~0.8.2",
-    "@fgv/ts-utils": "5.0.0-19",
-    "@fgv/ts-json": "5.0.0-19",
-    "@fgv/ts-json-base": "5.0.0-19",
-    "@fgv/ts-bcp47": "5.0.0-19"
+    "@fgv/ts-utils": "5.0.0-20",
+    "@fgv/ts-bcp47": "5.0.0-20",
+    "@fgv/ts-json-base": "5.0.0-20",
+    "@fgv/ts-json": "5.0.0-20"
   },
   "scripts": {
     "build": "heft build --clean",

package/src/packlets/resource-types/jsonResourceType.ts

@@ -93,4 +93,12 @@ export class JsonResourceType extends ResourceType<JsonObject> {
   public validate(json: JsonObject, __completeness?: CandidateCompleteness): Result<JsonObject> {
     return JsonConverters.jsonObject.convert(json);
   }
+
+  /**
+   * Gets the default template value for a JSON resource type.
+   * @returns An empty object as the default JSON value
+   */
+  protected getDefaultTemplateValue(): JsonObject {
+    return {};
+  }
 }

package/src/packlets/resource-types/resourceType.ts

@@ -20,7 +20,7 @@
  * SOFTWARE.
  */
 
-import { JsonValue } from '@fgv/ts-json-base';
+import { JsonValue, JsonObject } from '@fgv/ts-json-base';
 import { Collections, ICollectible, Result } from '@fgv/ts-utils';
 import {
   CandidateCompleteness,
@@ -31,6 +31,7 @@ import {
   ResourceValueMergeMethod,
   ResourceId
 } from '../common';
+import * as ResourceJson from '../resource-json';
 
 /**
  * Parameters used to validate a {@link ResourceJson.Json.ILooseResourceCandidateDecl | resource candidate declaration}.
@@ -123,6 +124,15 @@ export interface IResourceType<T = unknown> extends ICollectible<ResourceTypeNam
    * Sets the index for this resource type.  Once set, the index cannot be changed.
    */
   setIndex(index: number): Result<ResourceTypeIndex>;
+
+  /**
+   * Creates a template for a new resource of this type.
+   * The template provides a default structure for creating new resource instances.
+   * @param resourceId - The id for the new resource
+   * @returns A loose resource declaration with default values for this resource type
+   * @public
+   */
+  createTemplate(resourceId: ResourceId): ResourceJson.Json.ILooseResourceDecl;
 }
 
 /**
@@ -212,4 +222,38 @@ export abstract class ResourceType<T = unknown> implements IResourceType<T> {
   public setIndex(index: number): Result<ResourceTypeIndex> {
     return this._collectible.setIndex(index);
   }
+
+  /**
+   * Creates a template for a new resource of this type.
+   * Default implementation provides a basic template.
+   * Subclasses can override to provide type-specific templates.
+   * @param resourceId - The id for the new resource
+   * @returns A loose resource declaration with default values for this resource type
+   * @public
+   */
+  public createTemplate(resourceId: ResourceId): ResourceJson.Json.ILooseResourceDecl {
+    return {
+      id: resourceId,
+      resourceTypeName: this.key,
+      candidates: [
+        {
+          json: this.getDefaultTemplateValue(),
+          conditions: undefined,
+          isPartial: false,
+          mergeMethod: 'replace'
+        }
+      ]
+    };
+  }
+
+  /**
+   * Gets the default template value for this resource type.
+   * Subclasses should override this to provide type-specific default values.
+   * @returns The default JSON value for a new resource of this type
+   */
+  protected getDefaultTemplateValue(): JsonObject {
+    // Default implementation returns an empty object
+    // Subclasses should override for type-specific defaults
+    return {};
+  }
 }

package/src/packlets/runtime/resource-tree/resourceTreeChildrenValidator.ts

@@ -43,7 +43,7 @@ import {
  * strongly-typed internal tree operations, ensuring type safety and consistent
  * error handling throughout the resource tree navigation.
  *
- * @internal
+ * @public
  */
 export class ResourceTreeChildrenValidator<T> implements IReadOnlyResourceTreeChildren<T, string, string> {
   private readonly _inner: IReadOnlyResourceTreeChildren<T>;
@@ -141,13 +141,11 @@ export class ResourceTreeChildrenValidator<T> implements IReadOnlyResourceTreeCh
   }
 
   /**
-   * Gets a child node by its ResourceName key with detailed error information.
-   * @param key - The ResourceName key to look up
+   * Gets a child node by its string key with detailed error information.
+   * @param key - The string key to look up
    * @returns DetailedResult containing the node if found, or failure with details
    */
-  public get(
-    key: ResourceName
-  ): DetailedResult<IReadOnlyResourceTreeNode<T>, Collections.ResultMapResultDetail> {
+  public get(key: string): DetailedResult<IReadOnlyResourceTreeNode<T>, Collections.ResultMapResultDetail> {
     if (Validate.isValidResourceName(key)) {
       return this._inner.get(key);
     }
@@ -155,11 +153,11 @@ export class ResourceTreeChildrenValidator<T> implements IReadOnlyResourceTreeCh
   }
 
   /**
-   * Checks if a child node exists at the given ResourceName key.
-   * @param key - The ResourceName key to check
+   * Checks if a child node exists at the given string key.
+   * @param key - The string key to check
    * @returns True if a child node exists at the key, false otherwise
    */
-  public has(key: ResourceName): boolean {
+  public has(key: string): boolean {
     return this._inner.has(key as ResourceName);
   }