@fgv/ts-res 5.0.0-22 → 5.0.0-24

package/src/packlets/resource-json/resourceDeclTree.ts

@@ -1,116 +0,0 @@
-/*
- * Copyright (c) 2025 Erik Fortune
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-import { captureResult, mapResults, MessageAggregator, Result, succeed } from '@fgv/ts-utils';
-import { IResourceDeclContainer } from './resourceDeclContainer';
-import * as Convert from './convert';
-import * as Normalized from './normalized';
-import * as Json from './json';
-import { Helpers as CommonHelpers } from '../common';
-import { mergeChildResource } from './helpers';
-
-/**
- * Class that extracts resources and candidates from a
- * {@link ResourceJson.Json.IResourceTreeRootDecl | resource tree root}.
- * @public
- */
-export class ResourceDeclTree implements IResourceDeclContainer {
-  /**
-   * The {@link ResourceJson.Normalized.IResourceTreeRootDecl | resource tree root declaration}
-   * being processed.
-   */
-  public readonly tree: Normalized.IResourceTreeRootDecl;
-
-  /**
-   * {@inheritdoc ResourceJson.IResourceDeclContainer.context}
-   */
-  public get context(): Normalized.IContainerContextDecl | undefined {
-    return this.tree.context;
-  }
-
-  protected _resources: Normalized.ILooseResourceDecl[] = [];
-  protected _candidates: Normalized.ILooseResourceCandidateDecl[] = [];
-
-  protected constructor(tree: Normalized.IResourceTreeRootDecl) {
-    this.tree = tree;
-    const id = tree.context?.baseId;
-    const conditions = tree.context?.conditions;
-    this._extract(tree, id, conditions).orThrow();
-  }
-
-  /**
-   * Creates a new {@link ResourceJson.ResourceDeclTree | ResourceDeclTree} from an
-   * untyped {@link ResourceJson.Json.IResourceTreeRootDecl | resource tree root declaration}.
-   * @param from - The JSON object to convert.
-   * @returns `Success` with the new tree if the JSON object is valid, otherwise `Failure`.
-   */
-  public static create(from: unknown): Result<ResourceDeclTree> {
-    return Convert.resourceTreeRootDecl
-      .convert(from)
-      .withErrorFormat((err) => `Invalid resource tree: ${err}`)
-      .onSuccess((decl) => {
-        return captureResult(() => new ResourceDeclTree(decl));
-      });
-  }
-
-  /**
-   * Gets the loose resources extracted from the collection.
-   * @returns The {@link ResourceJson.Normalized.ILooseResourceDecl | loose resource declarations}
-   * extracted from the collection.
-   */
-  public getImporterResources(): ReadonlyArray<Normalized.ILooseResourceDecl> {
-    return this._resources;
-  }
-
-  /**
-   * Gets the loose candidates extracted from the collection.
-   * @returns The {@link ResourceJson.Normalized.ILooseResourceCandidateDecl | loose resource candidate declarations}
-   * extracted from the collection.
-   */
-  public getImporterCandidates(): ReadonlyArray<Normalized.ILooseResourceCandidateDecl> {
-    return this._candidates;
-  }
-
-  private _extract(
-    node: Normalized.IResourceTreeChildNodeDecl,
-    parentName?: string,
-    parentConditions?: ReadonlyArray<Json.ILooseConditionDecl>
-  ): Result<this> {
-    const errors: MessageAggregator = new MessageAggregator();
-
-    const resourceEntries = Array.from(Object.entries(node.resources ?? {}));
-    const mergedResources = resourceEntries.map(([name, resource]) =>
-      mergeChildResource(resource, name, parentName, parentConditions)
-    );
-    this._resources.push(...mapResults(mergedResources).aggregateError(errors).orDefault([]));
-
-    const children = Array.from(Object.entries(node.children ?? {}));
-    children.forEach(([name, childNode]) => {
-      CommonHelpers.joinResourceIds(parentName, name)
-        .onSuccess((childName) => {
-          return this._extract(childNode, childName, parentConditions).aggregateError(errors);
-        })
-        .aggregateError(errors);
-    });
-    return errors.returnOrReport(succeed(this));
-  }
-}

package/src/packlets/resource-types/config/convert.ts

@@ -1,38 +0,0 @@
-/*
- * Copyright (c) 2025 Erik Fortune
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-/* eslint-disable @rushstack/typedef-var */
-
-import { Converters } from '@fgv/ts-utils';
-import { Converters as JsonConverters } from '@fgv/ts-json-base';
-import { IResourceTypeConfig } from './json';
-
-/**
- * A `Converter` for {@link ResourceTypes.Config.IResourceTypeConfig | ResourceTypeConfig} objects.
- * @returns A `Converter` for {@link ResourceTypes.Config.IResourceTypeConfig | ResourceTypeConfig} objects.
- * @public
- */
-export const resourceTypeConfig = Converters.strictObject<IResourceTypeConfig>({
-  name: Converters.string,
-  typeName: Converters.string,
-  template: JsonConverters.jsonObject.optional()
-});

package/src/packlets/resource-types/config/index.ts

@@ -1,27 +0,0 @@
-/*
- * Copyright (c) 2025 Erik Fortune
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-import * as Convert from './convert';
-
-export * from './json';
-
-export { Convert };

package/src/packlets/resource-types/config/json.ts

@@ -1,33 +0,0 @@
-/*
- * Copyright (c) 2025 Erik Fortune
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-import { JsonObject } from '@fgv/ts-json-base';
-
-/**
- * Configuration for a {@link ResourceTypes.ResourceType | resource type}.
- * @public
- */
-export interface IResourceTypeConfig {
-  name: string;
-  typeName: string;
-  template?: JsonObject;
-}

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

@@ -1,44 +0,0 @@
-/*
- * Copyright (c) 2025 Erik Fortune
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-import { fail, Result } from '@fgv/ts-utils';
-import { IResourceTypeConfig } from './config';
-import { ResourceType } from './resourceType';
-import { JsonResourceType } from './jsonResourceType';
-import { Convert as CommonConverters } from '../common';
-
-/**
- * Creates a {@link ResourceTypes.ResourceType | ResourceType} from a configuration object.
- * @param config - The {@link ResourceTypes.Config.IResourceTypeConfig | configuration object}
- * containing the name and type name of the resource type.
- * @returns `Success` with the new {@link ResourceTypes.ResourceType | ResourceType}
- * if successful, `Failure` with an error message otherwise.
- * @public
- */
-export function createResourceTypeFromConfig(config: IResourceTypeConfig): Result<ResourceType> {
-  if (config.typeName === 'json') {
-    return CommonConverters.resourceTypeName
-      .convert(config.name)
-      .onSuccess((key) => JsonResourceType.create({ key }));
-  }
-  return fail(`${config.typeName}: Unknown resource type.`);
-}

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

@@ -1,30 +0,0 @@
-/*
- * Copyright (c) 2025 Erik Fortune
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-import * as Config from './config';
-
-export * from './resourceType';
-export * from './resourceTypeCollector';
-export * from './jsonResourceType';
-export * from './helpers';
-
-export { Config };

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

@@ -1,102 +0,0 @@
-/*
- * Copyright (c) 2025 Erik Fortune
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-import { Converters as JsonConverters, JsonObject } from '@fgv/ts-json-base';
-import { IResourceCandidateValidationProperties, ResourceType } from './resourceType';
-import { CandidateCompleteness, Convert, ResourceTypeName } from '../common';
-import { captureResult, Result } from '@fgv/ts-utils';
-
-/**
- * Parameters to create a {@link ResourceTypes.JsonResourceType | JsonResourceType} instance.
- * @public
- */
-export interface IJsonResourceTypeCreateParams {
-  /**
-   * Optional key for the new {@link ResourceTypes.JsonResourceType | JsonResourceType} instance.
-   * Defaults to 'json'.
-   */
-  key?: string;
-
-  /**
-   * Optional index for the new {@link ResourceTypes.JsonResourceType | JsonResourceType}
-   * instance.
-   */
-  index?: number;
-
-  /**
-   * Optional template for new instances of {@link ResourceTypes.JsonResourceType | JsonResourceType}
-   * resources.
-   */
-  template?: JsonObject;
-}
-
-/**
- * Implementation of a {@link ResourceTypes.ResourceType | ResourceType} for JSON values.
- * @public
- */
-export class JsonResourceType extends ResourceType<JsonObject> {
-  /**
-   * Protected {@link ResourceTypes.JsonResourceType | JsonResourceType} constructor for use by subclasses.
-   * Use {@link ResourceTypes.JsonResourceType.create | JsonResourceType.create} to create a new instance.
-   * @param key - The key for the new {@link ResourceTypes.JsonResourceType | JsonResourceType} instance.
-   * @param index - Optional index for the new {@link ResourceTypes.JsonResourceType | JsonResourceType} instance.
-   */
-  protected constructor(key: ResourceTypeName, index?: number, template?: JsonObject) {
-    super(key, index, template);
-  }
-
-  /**
-   * Factory method to create a new {@link ResourceTypes.JsonResourceType | JsonResourceType} instance.
-   * @param params - {@link ResourceTypes.IJsonResourceTypeCreateParams | Parameters} to create the new instance.
-   * @returns `Success` with the new {@link ResourceTypes.JsonResourceType | JsonResourceType} instance if successful
-   * or `Failure` with an error message if not.
-   */
-  public static create(params?: IJsonResourceTypeCreateParams): Result<JsonResourceType> {
-    return Convert.resourceTypeName.convert(params?.key ?? 'json').onSuccess((key) => {
-      return captureResult(() => new JsonResourceType(key, params?.index, params?.template));
-    });
-  }
-
-  /**
-   * {@inheritdoc ResourceTypes.ResourceType.validateDeclaration}
-   */
-
-  public validateDeclaration(props: IResourceCandidateValidationProperties): Result<JsonObject> {
-    return JsonConverters.jsonObject.convert(props.json);
-  }
-
-  /**
-   * {@inheritdoc ResourceTypes.ResourceType.(validate:1)}
-   */
-  public validate(json: JsonObject, completeness: CandidateCompleteness): Result<JsonObject>;
-  /**
-   * {@inheritdoc ResourceTypes.ResourceType.(validate:2)}
-   */
-  public validate(json: JsonObject, completeness: 'full'): Result<JsonObject>;
-  /**
-   * {@inheritdoc ResourceTypes.ResourceType.(validate:3)}
-   */
-  public validate(json: JsonObject, completeness: 'partial'): Result<JsonObject>;
-  public validate(json: JsonObject, __completeness?: CandidateCompleteness): Result<JsonObject> {
-    return JsonConverters.jsonObject.convert(json);
-  }
-}

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

@@ -1,292 +0,0 @@
-/*
- * Copyright (c) 2025 Erik Fortune
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-import { isJsonObject, JsonObject, JsonValue } from '@fgv/ts-json-base';
-import { Collections, fail, ICollectible, Result, succeed } from '@fgv/ts-utils';
-import {
-  CandidateCompleteness,
-  Convert as CommonConvert,
-  Validate,
-  ResourceTypeIndex,
-  ResourceTypeName,
-  ResourceValueMergeMethod,
-  ResourceId,
-  IResourceResolver
-} from '../common';
-import * as ResourceJson from '../resource-json';
-
-/**
- * Parameters used to validate a {@link ResourceJson.Json.ILooseResourceCandidateDecl | resource candidate declaration}.
- * @public
- */
-export interface IResourceCandidateValidationProperties {
-  /**
-   * {@inheritdoc ResourceJson.Json.ILooseResourceCandidateDecl.id}
-   * @public
-   */
-  id: ResourceId;
-
-  /**
-   * Describes how complete the candidate value is.
-   * @public
-   */
-  completeness: CandidateCompleteness;
-
-  /**
-   * {@inheritdoc ResourceJson.Json.ILooseResourceCandidateDecl.json}
-   * @public
-   */
-  json: JsonValue;
-
-  /**
-   * {@inheritdoc ResourceJson.Json.ILooseResourceCandidateDecl.mergeMethod}
-   * @public
-   */
-  mergeMethod: ResourceValueMergeMethod;
-}
-
-/**
- * Interface for a resource type.  Resource types are responsible for
- * validating and converting JSON values into the appropriate strongly-typed
- * resource value.
- * @public
- */
-export interface IResourceType<T = unknown> extends ICollectible<ResourceTypeName, ResourceTypeIndex> {
-  /**
-   * The key for this resource type.
-   */
-  readonly key: ResourceTypeName;
-
-  /**
-   * The index for this resource type.
-   */
-  readonly index: ResourceTypeIndex | undefined;
-
-  /**
-   * Validates properties of a {@link ResourceJson.Json.ILooseResourceCandidateDecl | resource candidate declaration} for
-   * a resource instance value.
-   * @param props - The {@link ResourceTypes.IResourceCandidateValidationProperties | properties } to validate.
-   * @returns `Success` with the strongly-typed resource value if the JSON and merge method
-   * are valid, `Failure` with an error message otherwise.
-   * @public
-   */
-  validateDeclaration(props: IResourceCandidateValidationProperties): Result<T | Partial<T>>;
-
-  /**
-   * Validates a JSON value for use as a partial resource instance value.
-   * @param json - The JSON value to validate.
-   * @param completeness - Describes {@link CandidateCompleteness | how complete} the candidate value is.
-   * @returns `Success` with the strongly-typed partial resource value if the JSON is valid,
-   * `Failure` with an error message otherwise.
-   * @public
-   */
-  validate(json: JsonValue, completeness: CandidateCompleteness): Result<Partial<T>>;
-
-  /**
-   * Validates a JSON value for use as a complete resource instance value.
-   * @param json - The JSON value to validate.
-   * @param completeness - Describes {@link CandidateCompleteness | how complete} the candidate value is.
-   * @returns `Success` with the strongly-typed resource value if the JSON is valid,
-   * `Failure` with an error message otherwise.
-   * @public
-   */
-  validate(json: JsonValue, completeness: 'full'): Result<T>;
-
-  /**
-   * Validates a JSON value for use as a partial resource instance value.
-   * @param json - The JSON value to validate.
-   * @param completeness - Describes {@link CandidateCompleteness | how complete} the candidate value is.
-   * @returns `Success` with the strongly-typed partial resource value if the JSON is valid,
-   * `Failure` with an error message otherwise.
-   * @public
-   */
-  validate(json: JsonValue, completeness: 'partial'): Result<Partial<T>>;
-
-  /**
-   * 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.
-   * @param init - An optional initial value for the resource.
-   * @param resolver - An optional resource resolver that can be used to create the template.
-   * @param conditions - An optional set of conditions that must be met for the resource to be selected.
-   * @returns A loose resource declaration with default values for this resource type.
-   * @public
-   */
-  createTemplate(
-    resourceId: ResourceId,
-    init?: JsonValue,
-    conditions?: ResourceJson.Json.ConditionSetDecl,
-    resolver?: IResourceResolver
-  ): Result<ResourceJson.Json.ILooseResourceDecl>;
-}
-
-/**
- * Abstract base class for resource types which are responsible for
- * validating and converting JSON values into the appropriate strongly-typed
- * resource value.
- * @public
- */
-export abstract class ResourceType<T = unknown> implements IResourceType<T> {
-  private _collectible: Collections.Collectible<ResourceTypeName, ResourceTypeIndex>;
-  private _template: JsonObject;
-  /**
-   * {@inheritdoc ResourceTypes.IResourceType.key}
-   */
-  public get key(): ResourceTypeName {
-    return this._collectible.key;
-  }
-
-  /**
-   * {@inheritdoc ResourceTypes.IResourceType.index}
-   */
-  public get index(): ResourceTypeIndex | undefined {
-    return this._collectible.index;
-  }
-
-  protected constructor(key: ResourceTypeName, index?: number, template?: JsonObject) {
-    this._collectible = new Collections.Collectible<ResourceTypeName, ResourceTypeIndex>({
-      key,
-      /* c8 ignore next 1 - coverage having a rough time */
-      index: index !== undefined ? Validate.toResourceTypeIndex(index).orThrow() : undefined,
-      indexConverter: CommonConvert.resourceTypeIndex
-    });
-    this._template = template ?? {};
-  }
-
-  /**
-   * Validates properties of a {@link ResourceJson.Json.ILooseResourceCandidateDecl | resource candidate declaration} for
-   * a resource instance value.
-   * @param props - The {@link ResourceTypes.IResourceCandidateValidationProperties | properties } to validate.
-   * @returns `Success` with the strongly-typed resource value if the JSON and merge method
-   * are valid, `Failure` with an error message otherwise.
-   * @public
-   */
-  public abstract validateDeclaration(props: IResourceCandidateValidationProperties): Result<T | Partial<T>>;
-
-  /**
-   * Validates a JSON value for use as a partial resource instance value.
-   * @param json - The JSON value to validate.
-   * @param completeness - Describes {@link CandidateCompleteness | how complete} the candidate value is.
-   * @returns `Success` with the strongly-typed partial resource value if the JSON is valid,
-   * `Failure` with an error message otherwise.
-   * @public
-   */
-  public abstract validate(json: JsonValue, completeness: CandidateCompleteness): Result<Partial<T>>;
-
-  /**
-   * Validates a JSON value for use as a complete resource instance value.
-   * @param json - The JSON value to validate.
-   * @param completeness - Describes {@link CandidateCompleteness | how complete} the candidate value is.
-   * @returns `Success` with the strongly-typed resource value if the JSON is valid,
-   * `Failure` with an error message otherwise.
-   * @public
-   */
-  public abstract validate(json: JsonValue, completeness: 'full'): Result<T>;
-
-  /**
-   * Validates a JSON value for use as a partial resource instance value.
-   * @param json - The JSON value to validate.
-   * @param completeness - Describes {@link CandidateCompleteness | how complete} the candidate value is.
-   * @returns `Success` with the strongly-typed partial resource value if the JSON is valid,
-   * `Failure` with an error message otherwise.
-   * @public
-   */
-  public abstract validate(json: JsonValue, completeness: 'partial'): Result<Partial<T>>;
-
-  /**
-   * Validates a JSON value for use as a full or partial resource instance value.
-   * @param json - The JSON value to validate.
-   * @param completeness - Describes {@link CandidateCompleteness | how complete} the candidate value is.
-   * @returns `Success` with the strongly-typed full or partial resource value if
-   * the JSON is valid, `Failure` with an error message otherwise.
-   * @public
-   */
-  public abstract validate(json: JsonValue, completeness?: CandidateCompleteness): Result<T | Partial<T>>;
-
-  /**
-   * Sets the index for this resource type.  Once set, the index cannot be changed.
-   */
-  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
-   * @param init - An optional initial value for the resource.
-   * @param conditions - An optional set of conditions that must be met for the resource to be selected.
-   * @param resolver - An optional resource resolver that can be used to create the template.
-   * @returns A loose resource declaration with default values for this resource type
-   * @public
-   */
-  public createTemplate(
-    resourceId: ResourceId,
-    init?: JsonValue,
-    conditions?: ResourceJson.Json.ConditionSetDecl,
-    resolver?: IResourceResolver
-  ): Result<ResourceJson.Json.ILooseResourceDecl> {
-    return this.getDefaultTemplateCandidate(init, conditions, resolver).onSuccess((candidate) =>
-      succeed({
-        id: resourceId,
-        resourceTypeName: this.key,
-        candidates: [candidate]
-      })
-    );
-  }
-
-  /**
-   * 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
-   * @public
-   */
-  public getDefaultTemplateCandidate(
-    json?: JsonValue,
-    conditions?: ResourceJson.Json.ConditionSetDecl,
-    __resolver?: IResourceResolver
-  ): Result<ResourceJson.Json.IChildResourceCandidateDecl> {
-    json = json ?? this._template;
-
-    if (!isJsonObject(json)) {
-      return fail(`${this.key}: Invalid initial value "${json}" must be JSON object.`);
-    }
-
-    const candidate: ResourceJson.Json.IChildResourceCandidateDecl = {
-      json,
-      ...(conditions ? { conditions } : {}),
-      mergeMethod: 'replace'
-    };
-
-    return this.validate(json, 'full')
-      .onSuccess((json) => succeed({ ...candidate, isPartial: false }))
-      .onFailure(() =>
-        this.validate(json, 'partial').onSuccess((json) => succeed({ ...candidate, isPartial: true }))
-      );
-  }
-}