@fgv/ts-res 4.5.0-0

package/lib/packlets/resource-json/resourceDeclTree.d.ts

@@ -0,0 +1,39 @@
+import { Result } from '@fgv/ts-utils';
+import { IResourceDeclContainer } from './resourceDeclContainer';
+import * as Normalized from './normalized';
+/**
+ * Class that extracts resources and candidates from a
+ * {@link ResourceJson.Json.IResourceTreeRootDecl | resource tree root}.
+ * @public
+ */
+export declare class ResourceDeclTree implements IResourceDeclContainer {
+    /**
+     * The {@link ResourceJson.Normalized.IResourceTreeRootDecl | resource tree root declaration}
+     * being processed.
+     */
+    readonly tree: Normalized.IResourceTreeRootDecl;
+    protected _resources: Normalized.ILooseResourceDecl[];
+    protected _candidates: Normalized.ILooseResourceCandidateDecl[];
+    protected constructor(tree: Normalized.IResourceTreeRootDecl);
+    /**
+     * 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`.
+     */
+    static create(from: unknown): Result<ResourceDeclTree>;
+    /**
+     * Gets the loose resources extracted from the collection.
+     * @returns The {@link ResourceJson.Normalized.ILooseResourceDecl | loose resource declarations}
+     * extracted from the collection.
+     */
+    getLooseResources(): ReadonlyArray<Normalized.ILooseResourceDecl>;
+    /**
+     * Gets the loose candidates extracted from the collection.
+     * @returns The {@link ResourceJson.Normalized.ILooseResourceCandidateDecl | loose resource candidate declarations}
+     * extracted from the collection.
+     */
+    getLooseCandidates(): ReadonlyArray<Normalized.ILooseResourceCandidateDecl>;
+    private _extract;
+}
+//# sourceMappingURL=resourceDeclTree.d.ts.map

package/lib/packlets/resource-json/resourceDeclTree.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resourceDeclTree.d.ts","sourceRoot":"","sources":["../../../src/packlets/resource-json/resourceDeclTree.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAgD,MAAM,EAAW,MAAM,eAAe,CAAC;AAC9F,OAAO,EAAE,sBAAsB,EAAE,MAAM,yBAAyB,CAAC;AAEjE,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC;AAK3C;;;;GAIG;AACH,qBAAa,gBAAiB,YAAW,sBAAsB;IAC7D;;;OAGG;IACH,SAAgB,IAAI,EAAE,UAAU,CAAC,qBAAqB,CAAC;IAEvD,SAAS,CAAC,UAAU,EAAE,UAAU,CAAC,kBAAkB,EAAE,CAAM;IAC3D,SAAS,CAAC,WAAW,EAAE,UAAU,CAAC,2BAA2B,EAAE,CAAM;IAErE,SAAS,aAAa,IAAI,EAAE,UAAU,CAAC,qBAAqB;IAK5D;;;;;OAKG;WACW,MAAM,CAAC,IAAI,EAAE,OAAO,GAAG,MAAM,CAAC,gBAAgB,CAAC;IAS7D;;;;OAIG;IACI,iBAAiB,IAAI,aAAa,CAAC,UAAU,CAAC,kBAAkB,CAAC;IAIxE;;;;OAIG;IACI,kBAAkB,IAAI,aAAa,CAAC,UAAU,CAAC,2BAA2B,CAAC;IAIlF,OAAO,CAAC,QAAQ;CAuBjB"}

package/lib/packlets/resource-json/resourceDeclTree.js

@@ -0,0 +1,122 @@
+"use strict";
+/*
+ * 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.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResourceDeclTree = void 0;
+const ts_utils_1 = require("@fgv/ts-utils");
+const Convert = __importStar(require("./convert"));
+const common_1 = require("../common");
+const helpers_1 = require("./helpers");
+/**
+ * Class that extracts resources and candidates from a
+ * {@link ResourceJson.Json.IResourceTreeRootDecl | resource tree root}.
+ * @public
+ */
+class ResourceDeclTree {
+    constructor(tree) {
+        this._resources = [];
+        this._candidates = [];
+        this.tree = tree;
+        this._extract(tree, tree.baseName).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`.
+     */
+    static create(from) {
+        return Convert.resourceTreeRootDecl
+            .convert(from)
+            .withErrorFormat((err) => `Invalid resource tree: ${err}`)
+            .onSuccess((decl) => {
+            return (0, ts_utils_1.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.
+     */
+    getLooseResources() {
+        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.
+     */
+    getLooseCandidates() {
+        return this._candidates;
+    }
+    _extract(node, parentName, parentConditions) {
+        var _a, _b;
+        const errors = new ts_utils_1.MessageAggregator();
+        const resourceEntries = Array.from(Object.entries((_a = node.resources) !== null && _a !== void 0 ? _a : {}));
+        const mergedResources = resourceEntries.map(([name, resource]) => (0, helpers_1.mergeChildResource)(resource, name, parentName, parentConditions));
+        this._resources.push(...(0, ts_utils_1.mapResults)(mergedResources).aggregateError(errors).orDefault([]));
+        const children = Array.from(Object.entries((_b = node.children) !== null && _b !== void 0 ? _b : {}));
+        children.forEach(([name, childNode]) => {
+            common_1.Helpers.joinResourceIds(parentName, name)
+                .onSuccess((childName) => {
+                return this._extract(childNode, childName, parentConditions).aggregateError(errors);
+            })
+                .aggregateError(errors);
+        });
+        return errors.returnOrReport((0, ts_utils_1.succeed)(this));
+    }
+}
+exports.ResourceDeclTree = ResourceDeclTree;
+//# sourceMappingURL=resourceDeclTree.js.map

package/lib/packlets/resource-json/resourceDeclTree.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resourceDeclTree.js","sourceRoot":"","sources":["../../../src/packlets/resource-json/resourceDeclTree.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,4CAA8F;AAE9F,mDAAqC;AAGrC,sCAAqD;AACrD,uCAA+C;AAE/C;;;;GAIG;AACH,MAAa,gBAAgB;IAU3B,YAAsB,IAAsC;QAHlD,eAAU,GAAoC,EAAE,CAAC;QACjD,gBAAW,GAA6C,EAAE,CAAC;QAGnE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,OAAO,EAAE,CAAC;IAC/C,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,MAAM,CAAC,IAAa;QAChC,OAAO,OAAO,CAAC,oBAAoB;aAChC,OAAO,CAAC,IAAI,CAAC;aACb,eAAe,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,0BAA0B,GAAG,EAAE,CAAC;aACzD,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE;YAClB,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC;QACzD,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;OAIG;IACI,iBAAiB;QACtB,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACI,kBAAkB;QACvB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAEO,QAAQ,CACd,IAA2C,EAC3C,UAAmB,EACnB,gBAA6C;;QAE7C,MAAM,MAAM,GAAsB,IAAI,4BAAiB,EAAE,CAAC;QAE1D,MAAM,eAAe,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAA,IAAI,CAAC,SAAS,mCAAI,EAAE,CAAC,CAAC,CAAC;QACzE,MAAM,eAAe,GAAG,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,EAAE,CAC/D,IAAA,4BAAkB,EAAC,QAAQ,EAAE,IAAI,EAAE,UAAU,EAAE,gBAAgB,CAAC,CACjE,CAAC;QACF,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,IAAA,qBAAU,EAAC,eAAe,CAAC,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;QAE1F,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAA,IAAI,CAAC,QAAQ,mCAAI,EAAE,CAAC,CAAC,CAAC;QACjE,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,SAAS,CAAC,EAAE,EAAE;YACrC,gBAAa,CAAC,eAAe,CAAC,UAAU,EAAE,IAAI,CAAC;iBAC5C,SAAS,CAAC,CAAC,SAAS,EAAE,EAAE;gBACvB,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,SAAS,EAAE,gBAAgB,CAAC,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;YACtF,CAAC,CAAC;iBACD,cAAc,CAAC,MAAM,CAAC,CAAC;QAC5B,CAAC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC,cAAc,CAAC,IAAA,kBAAO,EAAC,IAAI,CAAC,CAAC,CAAC;IAC9C,CAAC;CACF;AAvED,4CAuEC","sourcesContent":["/*\n * Copyright (c) 2025 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport { captureResult, mapResults, MessageAggregator, Result, succeed } from '@fgv/ts-utils';\nimport { IResourceDeclContainer } from './resourceDeclContainer';\nimport * as Convert from './convert';\nimport * as Normalized from './normalized';\nimport * as Json from './json';\nimport { Helpers as CommonHelpers } from '../common';\nimport { mergeChildResource } from './helpers';\n\n/**\n * Class that extracts resources and candidates from a\n * {@link ResourceJson.Json.IResourceTreeRootDecl | resource tree root}.\n * @public\n */\nexport class ResourceDeclTree implements IResourceDeclContainer {\n  /**\n   * The {@link ResourceJson.Normalized.IResourceTreeRootDecl | resource tree root declaration}\n   * being processed.\n   */\n  public readonly tree: Normalized.IResourceTreeRootDecl;\n\n  protected _resources: Normalized.ILooseResourceDecl[] = [];\n  protected _candidates: Normalized.ILooseResourceCandidateDecl[] = [];\n\n  protected constructor(tree: Normalized.IResourceTreeRootDecl) {\n    this.tree = tree;\n    this._extract(tree, tree.baseName).orThrow();\n  }\n\n  /**\n   * Creates a new {@link ResourceJson.ResourceDeclTree | ResourceDeclTree} from an\n   * untyped {@link ResourceJson.Json.IResourceTreeRootDecl | resource tree root declaration}.\n   * @param from - The JSON object to convert.\n   * @returns `Success` with the new tree if the JSON object is valid, otherwise `Failure`.\n   */\n  public static create(from: unknown): Result<ResourceDeclTree> {\n    return Convert.resourceTreeRootDecl\n      .convert(from)\n      .withErrorFormat((err) => `Invalid resource tree: ${err}`)\n      .onSuccess((decl) => {\n        return captureResult(() => new ResourceDeclTree(decl));\n      });\n  }\n\n  /**\n   * Gets the loose resources extracted from the collection.\n   * @returns The {@link ResourceJson.Normalized.ILooseResourceDecl | loose resource declarations}\n   * extracted from the collection.\n   */\n  public getLooseResources(): ReadonlyArray<Normalized.ILooseResourceDecl> {\n    return this._resources;\n  }\n\n  /**\n   * Gets the loose candidates extracted from the collection.\n   * @returns The {@link ResourceJson.Normalized.ILooseResourceCandidateDecl | loose resource candidate declarations}\n   * extracted from the collection.\n   */\n  public getLooseCandidates(): ReadonlyArray<Normalized.ILooseResourceCandidateDecl> {\n    return this._candidates;\n  }\n\n  private _extract(\n    node: Normalized.IResourceTreeChildNodeDecl,\n    parentName?: string,\n    parentConditions?: Json.ILooseConditionDecl[]\n  ): Result<this> {\n    const errors: MessageAggregator = new MessageAggregator();\n\n    const resourceEntries = Array.from(Object.entries(node.resources ?? {}));\n    const mergedResources = resourceEntries.map(([name, resource]) =>\n      mergeChildResource(resource, name, parentName, parentConditions)\n    );\n    this._resources.push(...mapResults(mergedResources).aggregateError(errors).orDefault([]));\n\n    const children = Array.from(Object.entries(node.children ?? {}));\n    children.forEach(([name, childNode]) => {\n      CommonHelpers.joinResourceIds(parentName, name)\n        .onSuccess((childName) => {\n          return this._extract(childNode, childName, parentConditions).aggregateError(errors);\n        })\n        .aggregateError(errors);\n    });\n    return errors.returnOrReport(succeed(this));\n  }\n}\n"]}

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

@@ -0,0 +1,4 @@
+export * from './resourceType';
+export * from './resourceTypeCollector';
+export * from './jsonResourceType';
+//# sourceMappingURL=index.d.ts.map

package/lib/packlets/resource-types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/packlets/resource-types/index.ts"],"names":[],"mappings":"AAsBA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,yBAAyB,CAAC;AACxC,cAAc,oBAAoB,CAAC"}

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

@@ -0,0 +1,41 @@
+"use strict";
+/*
+ * 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.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./resourceType"), exports);
+__exportStar(require("./resourceTypeCollector"), exports);
+__exportStar(require("./jsonResourceType"), exports);
+//# sourceMappingURL=index.js.map

package/lib/packlets/resource-types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/packlets/resource-types/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;;;;;;;;;;;;;;AAEH,iDAA+B;AAC/B,0DAAwC;AACxC,qDAAmC","sourcesContent":["/*\n * Copyright (c) 2025 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nexport * from './resourceType';\nexport * from './resourceTypeCollector';\nexport * from './jsonResourceType';\n"]}

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

@@ -0,0 +1,65 @@
+import { JsonObject, JsonValue } from '@fgv/ts-json-base';
+import { ResourceType } from './resourceType';
+import { ResourceTypeName, ResourceValueMergeMethod } from '../common';
+import { 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;
+}
+/**
+ * Implementation of a {@link ResourceTypes.ResourceType | ResourceType} for JSON values.
+ * @public
+ */
+export declare 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);
+    /**
+     * 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.
+     */
+    static create(params?: IJsonResourceTypeCreateParams): Result<JsonResourceType>;
+    /**
+     * {@inheritdoc ResourceTypes.ResourceType.(validateDeclaration:1)}
+     */
+    validateDeclaration(json: JsonValue, isPartial: true, mergeMethod?: ResourceValueMergeMethod): Result<Partial<JsonObject>>;
+    /**
+     * {@inheritdoc ResourceTypes.ResourceType.(validateDeclaration:2)}
+     */
+    validateDeclaration(json: JsonValue, isPartial: false, mergeMethod?: ResourceValueMergeMethod): Result<JsonObject>;
+    /**
+     * {@inheritdoc ResourceTypes.ResourceType.(validateDeclaration:3)}
+     */
+    validateDeclaration(json: JsonValue, isPartial: boolean, mergeMethod?: ResourceValueMergeMethod): Result<JsonObject | Partial<JsonObject>>;
+    /**
+     * {@inheritdoc ResourceTypes.ResourceType.(validate:1)}
+     */
+    validate(json: JsonObject, isPartial: true): Result<JsonObject>;
+    /**
+     * {@inheritdoc ResourceTypes.ResourceType.(validate:2)}
+     */
+    validate(json: JsonObject, isPartial: false): Result<JsonObject>;
+    /**
+     * {@inheritdoc ResourceTypes.ResourceType.(validate:3)}
+     */
+    validate(json: JsonObject, isPartial: boolean): Result<JsonObject>;
+}
+//# sourceMappingURL=jsonResourceType.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"jsonResourceType.d.ts","sourceRoot":"","sources":["../../../src/packlets/resource-types/jsonResourceType.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAgC,UAAU,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AACxF,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAW,gBAAgB,EAAE,wBAAwB,EAAE,MAAM,WAAW,CAAC;AAChF,OAAO,EAAiB,MAAM,EAAE,MAAM,eAAe,CAAC;AAEtD;;;GAGG;AACH,MAAM,WAAW,6BAA6B;IAC5C;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,qBAAa,gBAAiB,SAAQ,YAAY,CAAC,UAAU,CAAC;IAC5D;;;;;OAKG;IACH,SAAS,aAAa,GAAG,EAAE,gBAAgB,EAAE,KAAK,CAAC,EAAE,MAAM;IAI3D;;;;;OAKG;WACW,MAAM,CAAC,MAAM,CAAC,EAAE,6BAA6B,GAAG,MAAM,CAAC,gBAAgB,CAAC;IAMtF;;OAEG;IACI,mBAAmB,CACxB,IAAI,EAAE,SAAS,EACf,SAAS,EAAE,IAAI,EACf,WAAW,CAAC,EAAE,wBAAwB,GACrC,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAC9B;;OAEG;IACI,mBAAmB,CACxB,IAAI,EAAE,SAAS,EACf,SAAS,EAAE,KAAK,EAChB,WAAW,CAAC,EAAE,wBAAwB,GACrC,MAAM,CAAC,UAAU,CAAC;IACrB;;OAEG;IACI,mBAAmB,CACxB,IAAI,EAAE,SAAS,EACf,SAAS,EAAE,OAAO,EAClB,WAAW,CAAC,EAAE,wBAAwB,GACrC,MAAM,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAS3C;;OAEG;IACI,QAAQ,CAAC,IAAI,EAAE,UAAU,EAAE,SAAS,EAAE,IAAI,GAAG,MAAM,CAAC,UAAU,CAAC;IACtE;;OAEG;IACI,QAAQ,CAAC,IAAI,EAAE,UAAU,EAAE,SAAS,EAAE,KAAK,GAAG,MAAM,CAAC,UAAU,CAAC;IACvE;;OAEG;IACI,QAAQ,CAAC,IAAI,EAAE,UAAU,EAAE,SAAS,EAAE,OAAO,GAAG,MAAM,CAAC,UAAU,CAAC;CAI1E"}

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

@@ -0,0 +1,63 @@
+"use strict";
+/*
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JsonResourceType = void 0;
+const ts_json_base_1 = require("@fgv/ts-json-base");
+const resourceType_1 = require("./resourceType");
+const common_1 = require("../common");
+const ts_utils_1 = require("@fgv/ts-utils");
+/**
+ * Implementation of a {@link ResourceTypes.ResourceType | ResourceType} for JSON values.
+ * @public
+ */
+class JsonResourceType extends resourceType_1.ResourceType {
+    /**
+     * 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.
+     */
+    constructor(key, index) {
+        super(key, index);
+    }
+    /**
+     * 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.
+     */
+    static create(params) {
+        var _a;
+        return common_1.Convert.resourceTypeName.convert((_a = params === null || params === void 0 ? void 0 : params.key) !== null && _a !== void 0 ? _a : 'json').onSuccess((key) => {
+            return (0, ts_utils_1.captureResult)(() => new JsonResourceType(key, params === null || params === void 0 ? void 0 : params.index));
+        });
+    }
+    validateDeclaration(json, __isPartial, __mergeMethod) {
+        return ts_json_base_1.Converters.jsonObject.convert(json);
+    }
+    validate(json, __isPartial) {
+        return ts_json_base_1.Converters.jsonObject.convert(json);
+    }
+}
+exports.JsonResourceType = JsonResourceType;
+//# sourceMappingURL=jsonResourceType.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"jsonResourceType.js","sourceRoot":"","sources":["../../../src/packlets/resource-types/jsonResourceType.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,oDAAwF;AACxF,iDAA8C;AAC9C,sCAAgF;AAChF,4CAAsD;AAoBtD;;;GAGG;AACH,MAAa,gBAAiB,SAAQ,2BAAwB;IAC5D;;;;;OAKG;IACH,YAAsB,GAAqB,EAAE,KAAc;QACzD,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACpB,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,MAAM,CAAC,MAAsC;;QACzD,OAAO,gBAAO,CAAC,gBAAgB,CAAC,OAAO,CAAC,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,GAAG,mCAAI,MAAM,CAAC,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE;YAC/E,OAAO,IAAA,wBAAa,EAAC,GAAG,EAAE,CAAC,IAAI,gBAAgB,CAAC,GAAG,EAAE,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,KAAK,CAAC,CAAC,CAAC;QACvE,CAAC,CAAC,CAAC;IACL,CAAC;IA0BM,mBAAmB,CACxB,IAAe,EACf,WAAoB,EACpB,aAAwC;QAExC,OAAO,yBAAc,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACjD,CAAC;IAcM,QAAQ,CAAC,IAAgB,EAAE,WAAoB;QACpD,OAAO,yBAAc,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACjD,CAAC;CACF;AAtED,4CAsEC","sourcesContent":["/*\n * Copyright (c) 2025 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport { Converters as JsonConverters, JsonObject, JsonValue } from '@fgv/ts-json-base';\nimport { ResourceType } from './resourceType';\nimport { Convert, ResourceTypeName, ResourceValueMergeMethod } from '../common';\nimport { captureResult, Result } from '@fgv/ts-utils';\n\n/**\n * Parameters to create a {@link ResourceTypes.JsonResourceType | JsonResourceType} instance.\n * @public\n */\nexport interface IJsonResourceTypeCreateParams {\n  /**\n   * Optional key for the new {@link ResourceTypes.JsonResourceType | JsonResourceType} instance.\n   * Defaults to 'json'.\n   */\n  key?: string;\n\n  /**\n   * Optional index for the new {@link ResourceTypes.JsonResourceType | JsonResourceType}\n   * instance.\n   */\n  index?: number;\n}\n\n/**\n * Implementation of a {@link ResourceTypes.ResourceType | ResourceType} for JSON values.\n * @public\n */\nexport class JsonResourceType extends ResourceType<JsonObject> {\n  /**\n   * Protected {@link ResourceTypes.JsonResourceType | JsonResourceType} constructor for use by subclasses.\n   * Use {@link ResourceTypes.JsonResourceType.create | JsonResourceType.create} to create a new instance.\n   * @param key - The key for the new {@link ResourceTypes.JsonResourceType | JsonResourceType} instance.\n   * @param index - Optional index for the new {@link ResourceTypes.JsonResourceType | JsonResourceType} instance.\n   */\n  protected constructor(key: ResourceTypeName, index?: number) {\n    super(key, index);\n  }\n\n  /**\n   * Factory method to create a new {@link ResourceTypes.JsonResourceType | JsonResourceType} instance.\n   * @param params - {@link ResourceTypes.IJsonResourceTypeCreateParams | Parameters} to create the new instance.\n   * @returns `Success` with the new {@link ResourceTypes.JsonResourceType | JsonResourceType} instance if successful\n   * or `Failure` with an error message if not.\n   */\n  public static create(params?: IJsonResourceTypeCreateParams): Result<JsonResourceType> {\n    return Convert.resourceTypeName.convert(params?.key ?? 'json').onSuccess((key) => {\n      return captureResult(() => new JsonResourceType(key, params?.index));\n    });\n  }\n\n  /**\n   * {@inheritdoc ResourceTypes.ResourceType.(validateDeclaration:1)}\n   */\n  public validateDeclaration(\n    json: JsonValue,\n    isPartial: true,\n    mergeMethod?: ResourceValueMergeMethod\n  ): Result<Partial<JsonObject>>;\n  /**\n   * {@inheritdoc ResourceTypes.ResourceType.(validateDeclaration:2)}\n   */\n  public validateDeclaration(\n    json: JsonValue,\n    isPartial: false,\n    mergeMethod?: ResourceValueMergeMethod\n  ): Result<JsonObject>;\n  /**\n   * {@inheritdoc ResourceTypes.ResourceType.(validateDeclaration:3)}\n   */\n  public validateDeclaration(\n    json: JsonValue,\n    isPartial: boolean,\n    mergeMethod?: ResourceValueMergeMethod\n  ): Result<JsonObject | Partial<JsonObject>>;\n  public validateDeclaration(\n    json: JsonValue,\n    __isPartial: boolean,\n    __mergeMethod?: ResourceValueMergeMethod\n  ): Result<JsonObject | Partial<JsonObject>> {\n    return JsonConverters.jsonObject.convert(json);\n  }\n\n  /**\n   * {@inheritdoc ResourceTypes.ResourceType.(validate:1)}\n   */\n  public validate(json: JsonObject, isPartial: true): Result<JsonObject>;\n  /**\n   * {@inheritdoc ResourceTypes.ResourceType.(validate:2)}\n   */\n  public validate(json: JsonObject, isPartial: false): Result<JsonObject>;\n  /**\n   * {@inheritdoc ResourceTypes.ResourceType.(validate:3)}\n   */\n  public validate(json: JsonObject, isPartial: boolean): Result<JsonObject>;\n  public validate(json: JsonObject, __isPartial: boolean): Result<JsonObject> {\n    return JsonConverters.jsonObject.convert(json);\n  }\n}\n"]}

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

@@ -0,0 +1,87 @@
+import { JsonValue } from '@fgv/ts-json-base';
+import { ICollectible, Result } from '@fgv/ts-utils';
+import { ResourceTypeIndex, ResourceTypeName, ResourceValueMergeMethod } from '../common';
+/**
+ * Abstract base class for resource types which are responsible for
+ * validating and converting JSON values into the appropriate strongly-typed
+ * resource value.
+ * @public
+ */
+export declare abstract class ResourceType<T = unknown> implements ICollectible<ResourceTypeName, ResourceTypeIndex> {
+    private _collectible;
+    /**
+     * The key for this resource type.
+     */
+    get key(): ResourceTypeName;
+    /**
+     * The index for this resource type.
+     */
+    get index(): ResourceTypeIndex | undefined;
+    protected constructor(key: ResourceTypeName, index?: number);
+    /**
+     * Validates a {@link ResourceJson.Json.ILooseResourceCandidateDecl | resource candidate declaration} for
+     * a partial resource instance value.
+     * @param json - The JSON value to validate.
+     * @param isPartial - `true` indicates that the value is expected to be incomplete.
+     * @param mergeMethod - The method to use when merging with previously resolved values.
+     * @returns `Success` with the strongly-typed resource value if the JSON and merge
+     * method are valid, `Failure` with an error message otherwise.
+     * @public
+     */
+    abstract validateDeclaration(json: JsonValue, isPartial: true, mergeMethod?: ResourceValueMergeMethod): Result<Partial<T>>;
+    /**
+     * Validates a {@link ResourceJson.Json.ILooseResourceCandidateDecl | resource candidate declaration} for
+     * a complete resource instance value.
+     * @param json - The JSON value to validate.
+     * @param isPartial - `false` indicates that the value is expected to be complete.
+     * @param mergeMethod - The method to use when merging with previously resolved values.
+     * @returns `Success` with the strongly-typed resource value if the JSON and merge method
+     * are valid, `Failure` with an error message otherwise.
+     * @public
+     */
+    abstract validateDeclaration(json: JsonValue, isPartial: false, mergeMethod?: ResourceValueMergeMethod): Result<T>;
+    /**
+     * Validates a {@link ResourceJson.Json.ILooseResourceCandidateDecl | resource candidate declaration} for
+     * a resource instance value.
+     * @param json - The JSON value to validate.
+     * @param isPartial - Indicates whether the value is expected to be incomplete.
+     * @param mergeMethod - The method to use when merging with previously resolved values.
+     * @returns `Success` with the strongly-typed resource value if the JSON and merge method
+     * are valid, `Failure` with an error message otherwise.
+     * @public
+     */
+    abstract validateDeclaration(json: JsonValue, isPartial: boolean, mergeMethod?: ResourceValueMergeMethod): Result<T | Partial<T>>;
+    abstract validateDeclaration(json: JsonValue, isPartial: boolean, mergeMethod?: ResourceValueMergeMethod): Result<T | Partial<T>>;
+    /**
+     * Validates a JSON value for use as a partial resource instance value.
+     * @param json - The JSON value to validate.
+     * @param isPartial - `true` indicates that the value is expected to be partial.
+     * @returns `Success` with the strongly-typed partial resource value if the JSON is valid,
+     * `Failure` with an error message otherwise.
+     * @public
+     */
+    abstract validate(json: JsonValue, isPartial: true): Result<T>;
+    /**
+     * Validates a JSON value for use as a complete resource instance value.
+     * @param json - The JSON value to validate.
+     * @param isPartial - `false` indicates that the value is expected to be complete.
+     * @returns `Success` with the strongly-typed resource value if the JSON is valid,
+     * `Failure` with an error message otherwise.
+     * @public
+     */
+    abstract validate(json: JsonValue, isPartial: false): 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 isPartial - Indicates whether the value is expected to be partial.
+     * @returns `Success` with the strongly-typed full or partial resource value if
+     * the JSON is valid, `Failure` with an error message otherwise.
+     * @public
+     */
+    abstract validate(json: JsonValue, isPartial: boolean): Result<T | Partial<T>>;
+    /**
+     * Sets the index for this resource type.  Once set, the index cannot be changed.
+     */
+    setIndex(index: number): Result<ResourceTypeIndex>;
+}
+//# sourceMappingURL=resourceType.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"resourceType.d.ts","sourceRoot":"","sources":["../../../src/packlets/resource-types/resourceType.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAC9C,OAAO,EAAe,YAAY,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAClE,OAAO,EAGL,iBAAiB,EACjB,gBAAgB,EAChB,wBAAwB,EACzB,MAAM,WAAW,CAAC;AAEnB;;;;;GAKG;AACH,8BAAsB,YAAY,CAAC,CAAC,GAAG,OAAO,CAAE,YAAW,YAAY,CAAC,gBAAgB,EAAE,iBAAiB,CAAC;IAC1G,OAAO,CAAC,YAAY,CAA+D;IACnF;;OAEG;IACH,IAAW,GAAG,IAAI,gBAAgB,CAEjC;IAED;;OAEG;IACH,IAAW,KAAK,IAAI,iBAAiB,GAAG,SAAS,CAEhD;IAED,SAAS,aAAa,GAAG,EAAE,gBAAgB,EAAE,KAAK,CAAC,EAAE,MAAM;IAS3D;;;;;;;;;OASG;aACa,mBAAmB,CACjC,IAAI,EAAE,SAAS,EACf,SAAS,EAAE,IAAI,EACf,WAAW,CAAC,EAAE,wBAAwB,GACrC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAErB;;;;;;;;;OASG;aACa,mBAAmB,CACjC,IAAI,EAAE,SAAS,EACf,SAAS,EAAE,KAAK,EAChB,WAAW,CAAC,EAAE,wBAAwB,GACrC,MAAM,CAAC,CAAC,CAAC;IAEZ;;;;;;;;;OASG;aACa,mBAAmB,CACjC,IAAI,EAAE,SAAS,EACf,SAAS,EAAE,OAAO,EAClB,WAAW,CAAC,EAAE,wBAAwB,GACrC,MAAM,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;aAET,mBAAmB,CACjC,IAAI,EAAE,SAAS,EACf,SAAS,EAAE,OAAO,EAClB,WAAW,CAAC,EAAE,wBAAwB,GACrC,MAAM,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IAEzB;;;;;;;OAOG;aACa,QAAQ,CAAC,IAAI,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC;IAErE;;;;;;;OAOG;aACa,QAAQ,CAAC,IAAI,EAAE,SAAS,EAAE,SAAS,EAAE,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAE/E;;;;;;;OAOG;aACa,QAAQ,CAAC,IAAI,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,GAAG,MAAM,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IAErF;;OAEG;IACI,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC,iBAAiB,CAAC;CAG1D"}

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

@@ -0,0 +1,62 @@
+"use strict";
+/*
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResourceType = void 0;
+const ts_utils_1 = require("@fgv/ts-utils");
+const common_1 = require("../common");
+/**
+ * Abstract base class for resource types which are responsible for
+ * validating and converting JSON values into the appropriate strongly-typed
+ * resource value.
+ * @public
+ */
+class ResourceType {
+    /**
+     * The key for this resource type.
+     */
+    get key() {
+        return this._collectible.key;
+    }
+    /**
+     * The index for this resource type.
+     */
+    get index() {
+        return this._collectible.index;
+    }
+    constructor(key, index) {
+        this._collectible = new ts_utils_1.Collections.Collectible({
+            key,
+            /* c8 ignore next 1 - coverage having a rough time */
+            index: index !== undefined ? common_1.Validate.toResourceTypeIndex(index).orThrow() : undefined,
+            indexConverter: common_1.Convert.resourceTypeIndex
+        });
+    }
+    /**
+     * Sets the index for this resource type.  Once set, the index cannot be changed.
+     */
+    setIndex(index) {
+        return this._collectible.setIndex(index);
+    }
+}
+exports.ResourceType = ResourceType;
+//# sourceMappingURL=resourceType.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"resourceType.js","sourceRoot":"","sources":["../../../src/packlets/resource-types/resourceType.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAGH,4CAAkE;AAClE,sCAMmB;AAEnB;;;;;GAKG;AACH,MAAsB,YAAY;IAEhC;;OAEG;IACH,IAAW,GAAG;QACZ,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC;IAC/B,CAAC;IAED;;OAEG;IACH,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC;IACjC,CAAC;IAED,YAAsB,GAAqB,EAAE,KAAc;QACzD,IAAI,CAAC,YAAY,GAAG,IAAI,sBAAW,CAAC,WAAW,CAAsC;YACnF,GAAG;YACH,qDAAqD;YACrD,KAAK,EAAE,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,iBAAQ,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,SAAS;YACtF,cAAc,EAAE,gBAAa,CAAC,iBAAiB;SAChD,CAAC,CAAC;IACL,CAAC;IAsFD;;OAEG;IACI,QAAQ,CAAC,KAAa;QAC3B,OAAO,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC3C,CAAC;CACF;AAnHD,oCAmHC","sourcesContent":["/*\n * Copyright (c) 2025 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport { JsonValue } from '@fgv/ts-json-base';\nimport { Collections, ICollectible, Result } from '@fgv/ts-utils';\nimport {\n  Convert as CommonConvert,\n  Validate,\n  ResourceTypeIndex,\n  ResourceTypeName,\n  ResourceValueMergeMethod\n} from '../common';\n\n/**\n * Abstract base class for resource types which are responsible for\n * validating and converting JSON values into the appropriate strongly-typed\n * resource value.\n * @public\n */\nexport abstract class ResourceType<T = unknown> implements ICollectible<ResourceTypeName, ResourceTypeIndex> {\n  private _collectible: Collections.Collectible<ResourceTypeName, ResourceTypeIndex>;\n  /**\n   * The key for this resource type.\n   */\n  public get key(): ResourceTypeName {\n    return this._collectible.key;\n  }\n\n  /**\n   * The index for this resource type.\n   */\n  public get index(): ResourceTypeIndex | undefined {\n    return this._collectible.index;\n  }\n\n  protected constructor(key: ResourceTypeName, index?: number) {\n    this._collectible = new Collections.Collectible<ResourceTypeName, ResourceTypeIndex>({\n      key,\n      /* c8 ignore next 1 - coverage having a rough time */\n      index: index !== undefined ? Validate.toResourceTypeIndex(index).orThrow() : undefined,\n      indexConverter: CommonConvert.resourceTypeIndex\n    });\n  }\n\n  /**\n   * Validates a {@link ResourceJson.Json.ILooseResourceCandidateDecl | resource candidate declaration} for\n   * a partial resource instance value.\n   * @param json - The JSON value to validate.\n   * @param isPartial - `true` indicates that the value is expected to be incomplete.\n   * @param mergeMethod - The method to use when merging with previously resolved values.\n   * @returns `Success` with the strongly-typed resource value if the JSON and merge\n   * method are valid, `Failure` with an error message otherwise.\n   * @public\n   */\n  public abstract validateDeclaration(\n    json: JsonValue,\n    isPartial: true,\n    mergeMethod?: ResourceValueMergeMethod\n  ): Result<Partial<T>>;\n\n  /**\n   * Validates a {@link ResourceJson.Json.ILooseResourceCandidateDecl | resource candidate declaration} for\n   * a complete resource instance value.\n   * @param json - The JSON value to validate.\n   * @param isPartial - `false` indicates that the value is expected to be complete.\n   * @param mergeMethod - The method to use when merging with previously resolved values.\n   * @returns `Success` with the strongly-typed resource value if the JSON and merge method\n   * are valid, `Failure` with an error message otherwise.\n   * @public\n   */\n  public abstract validateDeclaration(\n    json: JsonValue,\n    isPartial: false,\n    mergeMethod?: ResourceValueMergeMethod\n  ): Result<T>;\n\n  /**\n   * Validates a {@link ResourceJson.Json.ILooseResourceCandidateDecl | resource candidate declaration} for\n   * a resource instance value.\n   * @param json - The JSON value to validate.\n   * @param isPartial - Indicates whether the value is expected to be incomplete.\n   * @param mergeMethod - The method to use when merging with previously resolved values.\n   * @returns `Success` with the strongly-typed resource value if the JSON and merge method\n   * are valid, `Failure` with an error message otherwise.\n   * @public\n   */\n  public abstract validateDeclaration(\n    json: JsonValue,\n    isPartial: boolean,\n    mergeMethod?: ResourceValueMergeMethod\n  ): Result<T | Partial<T>>;\n\n  public abstract validateDeclaration(\n    json: JsonValue,\n    isPartial: boolean,\n    mergeMethod?: ResourceValueMergeMethod\n  ): Result<T | Partial<T>>;\n\n  /**\n   * Validates a JSON value for use as a partial resource instance value.\n   * @param json - The JSON value to validate.\n   * @param isPartial - `true` indicates that the value is expected to be partial.\n   * @returns `Success` with the strongly-typed partial resource value if the JSON is valid,\n   * `Failure` with an error message otherwise.\n   * @public\n   */\n  public abstract validate(json: JsonValue, isPartial: true): Result<T>;\n\n  /**\n   * Validates a JSON value for use as a complete resource instance value.\n   * @param json - The JSON value to validate.\n   * @param isPartial - `false` indicates that the value is expected to be complete.\n   * @returns `Success` with the strongly-typed resource value if the JSON is valid,\n   * `Failure` with an error message otherwise.\n   * @public\n   */\n  public abstract validate(json: JsonValue, isPartial: false): Result<Partial<T>>;\n\n  /**\n   * Validates a JSON value for use as a full or partial resource instance value.\n   * @param json - The JSON value to validate.\n   * @param isPartial - Indicates whether the value is expected to be partial.\n   * @returns `Success` with the strongly-typed full or partial resource value if\n   * the JSON is valid, `Failure` with an error message otherwise.\n   * @public\n   */\n  public abstract validate(json: JsonValue, isPartial: boolean): Result<T | Partial<T>>;\n\n  /**\n   * Sets the index for this resource type.  Once set, the index cannot be changed.\n   */\n  public setIndex(index: number): Result<ResourceTypeIndex> {\n    return this._collectible.setIndex(index);\n  }\n}\n"]}

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

@@ -0,0 +1,30 @@
+import { Collections, Result, ValidatingCollector } from '@fgv/ts-utils';
+import { ResourceType } from './resourceType';
+/**
+ * Parameters for creating a {@link ResourceTypes.ResourceTypeCollector | ResourceTypeCollector}.
+ * @public
+ */
+export interface IResourceCollectorCreateParams {
+    resourceTypes?: ResourceType[];
+}
+/**
+ * Map {@link ResourceTypeName | resource type names} to {@link ResourceTypes.ResourceType | resource types}.
+ * @public
+ */
+export declare class ResourceTypeCollector extends ValidatingCollector<ResourceType> {
+    protected constructor({ resourceTypes }: IResourceCollectorCreateParams);
+    /**
+     * Creates a new {@link ResourceTypes.ResourceTypeCollector | ResourceTypeCollector}.
+     * @param params - Optional for creating the new collector.
+     * @returns `Success` with the new instance, or `Failure` with an error
+     * message if the collector could not be created.
+     */
+    static create(params?: IResourceCollectorCreateParams): Result<ResourceTypeCollector>;
+    protected _toResourceType(from: unknown): Result<ResourceType>;
+}
+/**
+ * A read-only version of {@link ResourceTypes.ResourceTypeCollector | ResourceTypeCollector}.
+ * @public
+ */
+export type ReadOnlyResourceTypeCollector = Collections.IReadOnlyValidatingCollector<ResourceType>;
+//# sourceMappingURL=resourceTypeCollector.d.ts.map

package/lib/packlets/resource-types/resourceTypeCollector.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resourceTypeCollector.d.ts","sourceRoot":"","sources":["../../../src/packlets/resource-types/resourceTypeCollector.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,WAAW,EAAE,MAAM,EAAiB,mBAAmB,EAAiB,MAAM,eAAe,CAAC;AACvG,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAG9C;;;GAGG;AACH,MAAM,WAAW,8BAA8B;IAC7C,aAAa,CAAC,EAAE,YAAY,EAAE,CAAC;CAChC;AAED;;;GAGG;AACH,qBAAa,qBAAsB,SAAQ,mBAAmB,CAAC,YAAY,CAAC;IAC1E,SAAS,aAAa,EAAE,aAAa,EAAE,EAAE,8BAA8B;IAevE;;;;;OAKG;WACW,MAAM,CAAC,MAAM,CAAC,EAAE,8BAA8B,GAAG,MAAM,CAAC,qBAAqB,CAAC;IAM5F,SAAS,CAAC,eAAe,CAAC,IAAI,EAAE,OAAO,GAAG,MAAM,CAAC,YAAY,CAAC;CAM/D;AAED;;;GAGG;AACH,MAAM,MAAM,6BAA6B,GAAG,WAAW,CAAC,4BAA4B,CAAC,YAAY,CAAC,CAAC"}