@fgv/ts-res 5.0.2 → 5.1.0-1

package/dist/packlets/resource-types/config/convert.js

@@ -1,35 +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';
-/**
- * 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({
-    name: Converters.string,
-    typeName: Converters.string,
-    template: JsonConverters.jsonObject.optional()
-});
-//# sourceMappingURL=convert.js.map

package/dist/packlets/resource-types/config/index.js

@@ -1,25 +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 };
-//# sourceMappingURL=index.js.map

package/dist/packlets/resource-types/config/json.js

@@ -1,23 +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.
- */
-export {};
-//# sourceMappingURL=json.js.map

package/lib/packlets/config/common.d.ts

@@ -1,35 +0,0 @@
-import { Result } from '@fgv/ts-utils';
-import { ISystemConfiguration } from './json';
-import { SystemConfiguration, ISystemConfigurationInitParams } from './systemConfiguration';
-/**
- * A `string` literal type representing a well-known predefined system configuration.
- * @public
- */
-export type PredefinedSystemConfiguration = 'default' | 'language-priority' | 'territory-priority' | 'extended-example';
-/**
- * An array of all well-known predefined system configurations.
- * @public
- */
-export declare const allPredefinedSystemConfigurations: ReadonlyArray<PredefinedSystemConfiguration>;
-export * from './predefined';
-/**
- * Returns the {@link Config.Model.ISystemConfiguration | system configuration} declaration for the
- * specified predefined system configuration.
- * @param name - The name of the predefined system configuration.
- * @param initParams - Optional {@link Config.ISystemConfigurationInitParams | initialization parameters}.
- * @returns `Success` with the {@link Config.Model.ISystemConfiguration | system configuration}
- * declaration if successful, `Failure` with an error message otherwise.
- * @public
- */
-export declare function getPredefinedDeclaration(name: PredefinedSystemConfiguration, initParams?: ISystemConfigurationInitParams): Result<ISystemConfiguration>;
-/**
- * Returns the {@link Config.SystemConfiguration | SystemConfiguration} for the specified
- * predefined system configuration.
- * @param name - The name of the predefined system configuration.
- * @param initParams - Optional {@link Config.ISystemConfigurationInitParams | initialization parameters}.
- * @returns `Success` with the {@link Config.SystemConfiguration | SystemConfiguration}
- * if successful, `Failure` with an error message otherwise.
- * @public
- */
-export declare function getPredefinedSystemConfiguration(name: PredefinedSystemConfiguration, initParams?: ISystemConfigurationInitParams): Result<SystemConfiguration>;
-//# sourceMappingURL=common.d.ts.map

package/lib/packlets/config/common.js

@@ -1,97 +0,0 @@
-"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 });
-exports.allPredefinedSystemConfigurations = void 0;
-exports.getPredefinedDeclaration = getPredefinedDeclaration;
-exports.getPredefinedSystemConfiguration = getPredefinedSystemConfiguration;
-const ts_utils_1 = require("@fgv/ts-utils");
-const systemConfiguration_1 = require("./systemConfiguration");
-const ts_json_base_1 = require("@fgv/ts-json-base");
-const predefined_1 = require("./predefined");
-/**
- * An array of all well-known predefined system configurations.
- * @public
- */
-exports.allPredefinedSystemConfigurations = [
-    'default',
-    'language-priority',
-    'territory-priority',
-    'extended-example'
-];
-__exportStar(require("./predefined"), exports);
-const predefinedDecls = {
-    default: predefined_1.Default.DefaultSystemConfiguration,
-    'language-priority': predefined_1.Default.LanguagePrioritySystemConfiguration,
-    'territory-priority': predefined_1.Default.TerritoryPrioritySystemConfiguration,
-    'extended-example': predefined_1.Example.ExtendedSystemConfiguration
-};
-/**
- * Returns the {@link Config.Model.ISystemConfiguration | system configuration} declaration for the
- * specified predefined system configuration.
- * @param name - The name of the predefined system configuration.
- * @param initParams - Optional {@link Config.ISystemConfigurationInitParams | initialization parameters}.
- * @returns `Success` with the {@link Config.Model.ISystemConfiguration | system configuration}
- * declaration if successful, `Failure` with an error message otherwise.
- * @public
- */
-function getPredefinedDeclaration(name, initParams) {
-    if (name in predefinedDecls) {
-        const baseConfig = (0, ts_json_base_1.sanitizeJsonObject)(predefinedDecls[name]);
-        if (initParams === null || initParams === void 0 ? void 0 : initParams.qualifierDefaultValues) {
-            return baseConfig.onSuccess((config) => (0, systemConfiguration_1.updateSystemConfigurationQualifierDefaultValues)(config, initParams.qualifierDefaultValues));
-        }
-        return baseConfig;
-    }
-    /* c8 ignore next 3 - defense in depth */
-    return (0, ts_utils_1.fail)(`Unknown predefined system configuration: ${name}`);
-}
-/**
- * Returns the {@link Config.SystemConfiguration | SystemConfiguration} for the specified
- * predefined system configuration.
- * @param name - The name of the predefined system configuration.
- * @param initParams - Optional {@link Config.ISystemConfigurationInitParams | initialization parameters}.
- * @returns `Success` with the {@link Config.SystemConfiguration | SystemConfiguration}
- * if successful, `Failure` with an error message otherwise.
- * @public
- */
-function getPredefinedSystemConfiguration(name, initParams) {
-    if (name in predefinedDecls) {
-        return systemConfiguration_1.SystemConfiguration.create(predefinedDecls[name], initParams);
-    }
-    return (0, ts_utils_1.fail)(`Unknown predefined system configuration: ${name}`);
-}
-//# sourceMappingURL=common.js.map

package/lib/packlets/config/configInitFactory.d.ts

@@ -1,217 +0,0 @@
-import { Result } from '@fgv/ts-utils';
-import { QualifierType, SystemQualifierType } from '../qualifier-types';
-import * as QualifierTypes from '../qualifier-types';
-import * as ResourceTypes from '../resource-types';
-import { ResourceType } from '../resource-types';
-/**
- * Function signature for creating a qualifier type from configuration.
- * @public
- */
-export type QualifierTypeFactoryFunction<T extends QualifierType = QualifierType> = (config: QualifierTypes.Config.IAnyQualifierTypeConfig) => Result<T>;
-/**
- * Function signature for creating a resource type from configuration.
- * @public
- */
-export type ResourceTypeFactoryFunction = (config: ResourceTypes.Config.IResourceTypeConfig) => Result<ResourceType>;
-/**
- * Interface for a factory that creates a new instance of a configuration object.
- * @public
- */
-export interface IConfigInitFactory<TConfig, T> {
-    /**
-     * Creates a new instance of a configuration object.
-     * @param config - The configuration object to create.
-     * @returns A result containing the new instance of the configuration object.
-     */
-    create(config: TConfig): Result<T>;
-}
-/**
- * Creates a {@link Config.IConfigInitFactory | IConfigInitFactory} from a factory function.
- * @param fn - The factory function to wrap.
- * @returns An `IConfigInitFactory` instance that delegates to the function.
- * @public
- */
-export declare function createQualifierTypeFactory<T extends QualifierType = QualifierType>(fn: QualifierTypeFactoryFunction<T>): IConfigInitFactory<QualifierTypes.Config.IAnyQualifierTypeConfig, T>;
-/**
- * Creates a {@link Config.IConfigInitFactory | IConfigInitFactory} from a resource type factory function.
- * @param fn - The factory function to wrap.
- * @returns An `IConfigInitFactory` instance that delegates to the function.
- * @public
- */
-export declare function createResourceTypeFactory(fn: ResourceTypeFactoryFunction): IConfigInitFactory<ResourceTypes.Config.IResourceTypeConfig, ResourceType>;
-/**
- * A factory that chains multiple factories together.
- * @public
- */
-export declare class ChainedConfigInitFactory<TConfig, T> implements IConfigInitFactory<TConfig, T> {
-    readonly factories: IConfigInitFactory<TConfig, T>[];
-    /**
-     * Constructor for a chained config init factory.
-     * @param factories - The factories to chain.
-     */
-    constructor(factories: IConfigInitFactory<TConfig, T>[]);
-    /**
-     * Creates a new instance of a configuration object.
-     * @param config - The configuration object to create.
-     * @returns A result containing the new instance of the configuration object.
-     */
-    create(config: TConfig): Result<T>;
-}
-/**
- * A factory that creates a {@link QualifierTypes.SystemQualifierType | SystemQualifierType} from
- * {@link QualifierTypes.Config.IAnyQualifierTypeConfig | any qualifier type configuration}.
- * @returns `Success` with the new {@link QualifierTypes.SystemQualifierType | SystemQualifierType}
- * if successful, `Failure` with an error message otherwise.
- * @public
- */
-export declare class BuiltInQualifierTypeFactory implements IConfigInitFactory<QualifierTypes.Config.ISystemQualifierTypeConfig, SystemQualifierType> {
-    /** {@inheritDoc Config.IConfigInitFactory.create} */
-    create(config: QualifierTypes.Config.IAnyQualifierTypeConfig): Result<SystemQualifierType>;
-}
-/**
- * A factory that creates {@link QualifierTypes.QualifierType | QualifierType} instances from configuration,
- * supporting both built-in system types and custom external types.
- *
- * This factory allows external consumers to extend the qualifier type system with their own custom types
- * while maintaining support for all built-in types (Language, Territory, Literal).
- *
- * @typeParam T - The custom qualifier type(s) to support. Defaults to {@link QualifierTypes.SystemQualifierType | SystemQualifierType}.
- *
- * @example Creating a factory with custom qualifier types
- * ```typescript
- * // Define a custom qualifier type
- * class CustomQualifierType extends QualifierType {
- *   // ... implementation
- * }
- *
- * // Define a discriminated union of all types
- * type AppQualifierType = SystemQualifierType | CustomQualifierType;
- *
- * // Create a factory that handles custom types
- * const customFactory: IConfigInitFactory<IAnyQualifierTypeConfig, CustomQualifierType> = {
- *   create(config) {
- *     // ... handle custom type creation
- *   }
- * };
- *
- * // Create the combined factory
- * const qualifierTypeFactory = new QualifierTypeFactory<AppQualifierType>([customFactory]);
- *
- * // The factory returns T | SystemQualifierType, supporting all types
- * const result = qualifierTypeFactory.create(config); // Result<AppQualifierType | SystemQualifierType>
- * ```
- *
- * @remarks
- * - The factory chains custom factories with the built-in factory
- * - Custom factories are tried first, falling back to built-in types
- * - The return type is a union of custom types (T) and system types
- *
- * @public
- */
-export declare class QualifierTypeFactory<T extends QualifierType = SystemQualifierType> extends ChainedConfigInitFactory<QualifierTypes.Config.IAnyQualifierTypeConfig, T | SystemQualifierType> {
-    /**
-     * Constructor for a {@link Config.QualifierTypeFactory | qualifier type factory}.
-     * @param factories - Array of factories for custom qualifier types. Can be:
-     *                    - {@link Config.IConfigInitFactory | IConfigInitFactory} instances
-     *                    - {@link Config.QualifierTypeFactoryFunction | Factory functions}
-     *                    - A mix of both
-     *                    These are tried in order before falling back to built-in types.
-     * @remarks The {@link Config.BuiltInQualifierTypeFactory | built-in factory} is always appended to handle
-     *          system qualifier types (Language, Territory, Literal).
-     */
-    constructor(factories: Array<IConfigInitFactory<QualifierTypes.Config.IAnyQualifierTypeConfig, T> | QualifierTypeFactoryFunction<T>>);
-}
-/**
- * A factory that validates and creates {@link QualifierTypes.QualifierType | QualifierType} instances
- * from weakly-typed configuration objects. This factory accepts configurations with unvalidated
- * string properties and validates them before delegating to the underlying factory chain.
- *
- * This pattern is useful at package boundaries where type identity issues may occur with
- * branded types across different package instances.
- *
- * @example
- * ```typescript
- * // Accept weakly-typed config from external source
- * const validatingFactory = new ValidatingQualifierTypeFactory([customFactory]);
- *
- * // Config can have plain string types instead of branded types
- * const config = {
- *   name: 'my-qualifier',  // plain string, not QualifierTypeName
- *   systemType: 'custom',   // plain string
- *   configuration: { ... }
- * };
- *
- * const result = validatingFactory.create(config); // Validates and converts internally
- * ```
- *
- * @public
- */
-export declare class ValidatingQualifierTypeFactory<T extends QualifierType = SystemQualifierType> implements IConfigInitFactory<unknown, T | SystemQualifierType> {
-    private readonly _innerFactory;
-    /**
-     * Constructor for a validating qualifier type factory.
-     * @param factories - Array of factories for custom qualifier types. Can be:
-     *                    - {@link Config.IConfigInitFactory | IConfigInitFactory} instances
-     *                    - {@link Config.QualifierTypeFactoryFunction | Factory functions}
-     *                    - A mix of both
-     */
-    constructor(factories: Array<IConfigInitFactory<QualifierTypes.Config.IAnyQualifierTypeConfig, T> | QualifierTypeFactoryFunction<T>>);
-    /**
-     * Creates a qualifier type from a weakly-typed configuration object.
-     * @param config - The configuration object to validate and use for creation.
-     * @returns A result containing the new qualifier type if successful.
-     */
-    create(config: unknown): Result<T | SystemQualifierType>;
-}
-/**
- * A factory that creates a {@link ResourceTypes.ResourceType | ResourceType} from a {@link ResourceTypes.Config.IResourceTypeConfig | resource type configuration}.
- * @public
- */
-export declare class BuiltInResourceTypeFactory implements IConfigInitFactory<ResourceTypes.Config.IResourceTypeConfig, ResourceType> {
-    /** {@inheritDoc Config.IConfigInitFactory.create} */
-    create(config: ResourceTypes.Config.IResourceTypeConfig): Result<ResourceType>;
-}
-/**
- * A factory that creates a {@link ResourceTypes.ResourceType | ResourceType} from a {@link ResourceTypes.Config.IResourceTypeConfig | resource type configuration}
- * by chaining a supplied factory with a {@link Config.BuiltInResourceTypeFactory | built-in factory} that handles built-in resource types.
- * @public
- */
-export declare class ResourceTypeFactory extends ChainedConfigInitFactory<ResourceTypes.Config.IResourceTypeConfig, ResourceType> {
-    /**
-     * Constructor for a resource type factory.
-     * @param factories - Array of factories for resource types. Can be:
-     *                    - {@link Config.IConfigInitFactory | IConfigInitFactory} instances
-     *                    - {@link Config.ResourceTypeFactoryFunction | Factory functions}
-     *                    - A mix of both
-     * @remarks The {@link Config.BuiltInResourceTypeFactory | built-in factory} is always added to the end of the chain.
-     */
-    constructor(factories: Array<IConfigInitFactory<ResourceTypes.Config.IResourceTypeConfig, ResourceType> | ResourceTypeFactoryFunction>);
-}
-/**
- * A factory that validates and creates {@link ResourceTypes.ResourceType | ResourceType} instances
- * from weakly-typed configuration objects. This factory accepts configurations with unvalidated
- * string properties and validates them before delegating to the underlying factory chain.
- *
- * This pattern is useful at package boundaries where type identity issues may occur with
- * branded types across different package instances.
- *
- * @public
- */
-export declare class ValidatingResourceTypeFactory implements IConfigInitFactory<unknown, ResourceType> {
-    private readonly _innerFactory;
-    /**
-     * Constructor for a validating resource type factory.
-     * @param factories - Array of factories for resource types. Can be:
-     *                    - {@link Config.IConfigInitFactory | IConfigInitFactory} instances
-     *                    - {@link Config.ResourceTypeFactoryFunction | Factory functions}
-     *                    - A mix of both
-     */
-    constructor(factories: Array<IConfigInitFactory<ResourceTypes.Config.IResourceTypeConfig, ResourceType> | ResourceTypeFactoryFunction>);
-    /**
-     * Creates a resource type from a weakly-typed configuration object.
-     * @param config - The configuration object to validate and use for creation.
-     * @returns A result containing the new resource type if successful.
-     */
-    create(config: unknown): Result<ResourceType>;
-}
-//# sourceMappingURL=configInitFactory.d.ts.map