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

package/lib/packlets/config/predefined/default.d.ts

@@ -1,57 +0,0 @@
-import { ISystemConfiguration } from '../json';
-import * as QualifierTypes from '../../qualifier-types';
-import * as Qualifiers from '../../qualifiers';
-import * as ResourceTypes from '../../resource-types';
-/**
- * Default qualifier types.
- * @remarks
- * The default qualifier types are:
- * - language: recognizes BCP 47 language tags, accepts a comma-separated list of language tags in the context
- * - territory: recognizes ISO 3166-1 alpha-2 territory codes, accepts a single code in the context
- * @public
- */
-export declare const DefaultQualifierTypes: ReadonlyArray<QualifierTypes.Config.ISystemQualifierTypeConfig>;
-/**
- * Qualifier definitions in which territory is the primary qualifier, with
- * language as a secondary qualifier.
- * @remarks
- * The default qualifiers are:
- * - currentTerritory(token: geo): territory qualifier, priority 850
- * - language(token: lang): language qualifier, priority 800
- * @public
- */
-export declare const TerritoryPriorityQualifiers: ReadonlyArray<Qualifiers.IQualifierDecl>;
-/**
- * Qualifier definitions in which language is the primary qualifier, with
- * territory as a secondary qualifier.
- * @remarks
- * The default qualifiers are:
- * - language(token: lang): language qualifier, priority 850
- * - currentTerritory(token: geo): territory qualifier, priority 800
- * @public
- */
-export declare const LanguagePriorityQualifiers: ReadonlyArray<Qualifiers.IQualifierDecl>;
-/**
- * Default resource types.
- * @public
- */
-export declare const DefaultResourceTypes: ReadonlyArray<ResourceTypes.Config.IResourceTypeConfig>;
-/**
- * System configuration with territory as the primary qualifier, and
- * language as a secondary qualifier.
- * @public
- */
-export declare const TerritoryPrioritySystemConfiguration: ISystemConfiguration;
-/**
- * System configuration with language as the primary qualifier, and
- * territory as a secondary qualifier.
- * @public
- */
-export declare const LanguagePrioritySystemConfiguration: ISystemConfiguration;
-/**
- * The default system configuration gives priority to territory as the primary qualifier,
- * with language as a secondary qualifier.
- * @public
- */
-export declare const DefaultSystemConfiguration: ISystemConfiguration;
-//# sourceMappingURL=default.d.ts.map

package/lib/packlets/config/predefined/default.js

@@ -1,141 +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.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DefaultSystemConfiguration = exports.LanguagePrioritySystemConfiguration = exports.TerritoryPrioritySystemConfiguration = exports.DefaultResourceTypes = exports.LanguagePriorityQualifiers = exports.TerritoryPriorityQualifiers = exports.DefaultQualifierTypes = void 0;
-/**
- * Default qualifier types.
- * @remarks
- * The default qualifier types are:
- * - language: recognizes BCP 47 language tags, accepts a comma-separated list of language tags in the context
- * - territory: recognizes ISO 3166-1 alpha-2 territory codes, accepts a single code in the context
- * @public
- */
-exports.DefaultQualifierTypes = [
-    {
-        name: 'language',
-        systemType: 'language',
-        configuration: {
-            allowContextList: true
-        }
-    },
-    {
-        name: 'territory',
-        systemType: 'territory',
-        configuration: {
-            allowContextList: false
-        }
-    }
-];
-/**
- * Qualifier definitions in which territory is the primary qualifier, with
- * language as a secondary qualifier.
- * @remarks
- * The default qualifiers are:
- * - currentTerritory(token: geo): territory qualifier, priority 850
- * - language(token: lang): language qualifier, priority 800
- * @public
- */
-exports.TerritoryPriorityQualifiers = [
-    {
-        name: 'currentTerritory',
-        token: 'geo',
-        typeName: 'territory',
-        defaultPriority: 850
-    },
-    {
-        name: 'language',
-        token: 'lang',
-        typeName: 'language',
-        defaultPriority: 800
-    }
-];
-/**
- * Qualifier definitions in which language is the primary qualifier, with
- * territory as a secondary qualifier.
- * @remarks
- * The default qualifiers are:
- * - language(token: lang): language qualifier, priority 850
- * - currentTerritory(token: geo): territory qualifier, priority 800
- * @public
- */
-exports.LanguagePriorityQualifiers = [
-    {
-        name: 'language',
-        token: 'lang',
-        typeName: 'language',
-        defaultPriority: 850
-    },
-    {
-        name: 'currentTerritory',
-        token: 'geo',
-        typeName: 'territory',
-        defaultPriority: 800
-    }
-];
-/**
- * Default resource types.
- * @public
- */
-exports.DefaultResourceTypes = [
-    {
-        name: 'json',
-        typeName: 'json'
-    }
-];
-/**
- * System configuration with territory as the primary qualifier, and
- * language as a secondary qualifier.
- * @public
- */
-exports.TerritoryPrioritySystemConfiguration = {
-    name: 'territory-priority',
-    description: 'Territory priority system configuration',
-    qualifierTypes: [...exports.DefaultQualifierTypes],
-    qualifiers: [...exports.TerritoryPriorityQualifiers],
-    resourceTypes: [...exports.DefaultResourceTypes]
-};
-/**
- * System configuration with language as the primary qualifier, and
- * territory as a secondary qualifier.
- * @public
- */
-exports.LanguagePrioritySystemConfiguration = {
-    name: 'language-priority',
-    description: 'Language priority system configuration',
-    qualifierTypes: [...exports.DefaultQualifierTypes],
-    qualifiers: [...exports.LanguagePriorityQualifiers],
-    resourceTypes: [...exports.DefaultResourceTypes]
-};
-/**
- * The default system configuration gives priority to territory as the primary qualifier,
- * with language as a secondary qualifier.
- * @public
- */
-exports.DefaultSystemConfiguration = {
-    name: 'default',
-    description: 'Default system configuration',
-    qualifierTypes: [...exports.DefaultQualifierTypes],
-    qualifiers: [...exports.TerritoryPriorityQualifiers],
-    resourceTypes: [...exports.DefaultResourceTypes]
-};
-//# sourceMappingURL=default.js.map

package/lib/packlets/config/predefined/extended.d.ts

@@ -1,25 +0,0 @@
-import * as ResourceTypes from '../../resource-types';
-import * as QualifierTypes from '../../qualifier-types';
-import * as Qualifiers from '../../qualifiers';
-import { ISystemConfiguration } from '../json';
-/**
- * Example extended qualifier types.
- * @public
- */
-export declare const ExtendedQualifierTypes: ReadonlyArray<QualifierTypes.Config.ISystemQualifierTypeConfig>;
-/**
- * Example extended qualifiers.
- * @public
- */
-export declare const ExtendedQualifiers: ReadonlyArray<Qualifiers.IQualifierDecl>;
-/**
- * Example resource types.
- * @public
- */
-export declare const ExtendedResourceTypes: ReadonlyArray<ResourceTypes.Config.IResourceTypeConfig>;
-/**
- * An example system configuration demonstrating various configuration options.
- * @public
- */
-export declare const ExtendedSystemConfiguration: ISystemConfiguration;
-//# sourceMappingURL=extended.d.ts.map

package/lib/packlets/config/predefined/extended.js

@@ -1,193 +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.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ExtendedSystemConfiguration = exports.ExtendedResourceTypes = exports.ExtendedQualifiers = exports.ExtendedQualifierTypes = void 0;
-/**
- * Example extended qualifier types.
- * @public
- */
-exports.ExtendedQualifierTypes = [
-    {
-        name: 'language',
-        systemType: 'language',
-        configuration: {
-            allowContextList: true
-        }
-    },
-    {
-        name: 'territory',
-        systemType: 'territory',
-        configuration: {
-            allowContextList: false,
-            acceptLowercase: false
-        }
-    },
-    {
-        name: 'role',
-        systemType: 'literal',
-        configuration: {
-            enumeratedValues: ['admin', 'agent', 'user', 'guest']
-        }
-    },
-    {
-        name: 'environment',
-        systemType: 'literal',
-        configuration: {
-            enumeratedValues: ['production', 'integration', 'development', 'test', 'ephemeral']
-        }
-    },
-    {
-        name: 'currency',
-        systemType: 'literal',
-        configuration: {
-            caseSensitive: true,
-            enumeratedValues: ['USD', 'EUR', 'GBP', 'JPY', 'CNY']
-        }
-    },
-    {
-        name: 'market',
-        systemType: 'literal',
-        configuration: {
-            enumeratedValues: [
-                'world',
-                'americas',
-                'europe',
-                'asia',
-                'oceania',
-                'africa',
-                'middle-east',
-                'latin-america',
-                'caribbean',
-                'central-america',
-                'south-america',
-                'north-america',
-                'nordics',
-                'baltic',
-                'balkans',
-                'eastern-europe',
-                'western-europe',
-                'central-europe',
-                'eastern-africa',
-                'western-africa',
-                'central-africa',
-                'north-africa',
-                'south-africa',
-                'middle-africa',
-                'southeast-asia'
-            ],
-            hierarchy: {
-                americas: 'world',
-                europe: 'world',
-                asia: 'world',
-                oceania: 'world',
-                africa: 'world',
-                'middle-east': 'world',
-                'latin-america': 'americas',
-                caribbean: 'americas',
-                'central-america': 'americas',
-                'south-america': 'americas',
-                'north-america': 'americas',
-                nordics: 'europe',
-                baltic: 'europe',
-                balkans: 'europe',
-                'eastern-europe': 'europe',
-                'western-europe': 'europe',
-                'central-europe': 'europe',
-                'eastern-africa': 'africa',
-                'western-africa': 'africa',
-                'central-africa': 'africa',
-                'north-africa': 'africa',
-                'south-africa': 'africa',
-                'middle-africa': 'africa',
-                'southeast-asia': 'asia'
-            }
-        }
-    }
-];
-/**
- * Example extended qualifiers.
- * @public
- */
-exports.ExtendedQualifiers = [
-    {
-        name: 'homeTerritory',
-        token: 'home',
-        typeName: 'territory',
-        defaultPriority: 900
-    },
-    {
-        name: 'currentTerritory',
-        token: 'geo',
-        typeName: 'territory',
-        defaultPriority: 850
-    },
-    {
-        name: 'language',
-        token: 'lang',
-        typeName: 'language',
-        defaultPriority: 800
-    },
-    {
-        name: 'market',
-        typeName: 'market',
-        defaultPriority: 750
-    },
-    {
-        name: 'role',
-        typeName: 'role',
-        defaultPriority: 700
-    },
-    {
-        name: 'environment',
-        token: 'env',
-        typeName: 'environment',
-        defaultPriority: 650
-    },
-    {
-        name: 'currency',
-        typeName: 'currency',
-        defaultPriority: 600
-    }
-];
-/**
- * Example resource types.
- * @public
- */
-exports.ExtendedResourceTypes = [
-    {
-        name: 'json',
-        typeName: 'json'
-    }
-];
-/**
- * An example system configuration demonstrating various configuration options.
- * @public
- */
-exports.ExtendedSystemConfiguration = {
-    name: 'extended-example',
-    description: 'An example system configuration demonstrating various configuration options',
-    qualifierTypes: [...exports.ExtendedQualifierTypes],
-    qualifiers: [...exports.ExtendedQualifiers],
-    resourceTypes: [...exports.ExtendedResourceTypes]
-};
-//# sourceMappingURL=extended.js.map

package/lib/packlets/config/predefined/index.d.ts

@@ -1,4 +0,0 @@
-import * as Default from './default';
-import * as Example from './extended';
-export { Default, Example };
-//# sourceMappingURL=index.d.ts.map

package/lib/packlets/config/predefined/index.js

@@ -1,62 +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 __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.Example = exports.Default = void 0;
-const Default = __importStar(require("./default"));
-exports.Default = Default;
-const Example = __importStar(require("./extended"));
-exports.Example = Example;
-//# sourceMappingURL=index.js.map

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

@@ -1,94 +0,0 @@
-import { Result } from '@fgv/ts-utils';
-import * as QualifierTypes from '../qualifier-types';
-import * as ResourceTypes from '../resource-types';
-import { QualifierType, ReadOnlyQualifierTypeCollector } from '../qualifier-types';
-import { IReadOnlyQualifierCollector } from '../qualifiers';
-import { ReadOnlyResourceTypeCollector, ResourceType } from '../resource-types';
-import { ISystemConfiguration } from './json';
-import { IConfigInitFactory } from './configInitFactory';
-/**
- * Parameters used to initialize a {@link Config.SystemConfiguration | SystemConfiguration}.
- * @public
- */
-export interface ISystemConfigurationInitParams {
-    /**
-     * Optional map of qualifier names to default values. If provided, qualifiers
-     * in the system configuration will be updated with these default values.
-     * Use `null` as the value to remove an existing default value.
-     */
-    qualifierDefaultValues?: Record<string, string | null>;
-    qualifierTypeFactory?: IConfigInitFactory<QualifierTypes.Config.IAnyQualifierTypeConfig, QualifierType>;
-    resourceTypeFactory?: IConfigInitFactory<ResourceTypes.Config.IResourceTypeConfig, ResourceType>;
-}
-/**
- * Creates a copy of the provided {@link Config.Model.ISystemConfiguration | system configuration}
- * with updated qualifier default values.
- * @param config - The base {@link Config.Model.ISystemConfiguration | system configuration} to copy.
- * @param qualifierDefaultValues - Map of qualifier names to default values. Use `null` to remove existing values.
- * @returns `Success` with the updated {@link Config.Model.ISystemConfiguration | system configuration}
- * if successful, `Failure` with an error message otherwise.
- * @public
- */
-export declare function updateSystemConfigurationQualifierDefaultValues(config: ISystemConfiguration, qualifierDefaultValues: Record<string, string | null>): Result<ISystemConfiguration>;
-/**
- * A system configuration for both runtime or build.
- * @public
- */
-export declare class SystemConfiguration {
-    /**
-     * The name of this system configuration.
-     */
-    get name(): string | undefined;
-    /**
-     * The description of this system configuration.
-     */
-    get description(): string | undefined;
-    /**
-     * The {@link QualifierTypes.QualifierTypeCollector | qualifier types} that this system configuration uses.
-     */
-    readonly qualifierTypes: ReadOnlyQualifierTypeCollector;
-    /**
-     * The {@link QualifierTypes.QualifierTypeCollector | qualifier types} that this system configuration uses.
-     * @public
-     */
-    readonly qualifiers: IReadOnlyQualifierCollector;
-    /**
-     * The {@link ResourceTypes.ResourceTypeCollector | resource types} that this system configuration uses.
-     */
-    readonly resourceTypes: ReadOnlyResourceTypeCollector;
-    private readonly _config;
-    /**
-     * Constructs a new instance of a {@link Config.SystemConfiguration | SystemConfiguration} from the
-     * supplied {@link Config.Model.ISystemConfiguration | system configuration}.
-     * @param config - The {@link Config.Model.ISystemConfiguration | system configuration} to use.
-     * @public
-     */
-    protected constructor(config: ISystemConfiguration, initParams?: ISystemConfigurationInitParams);
-    /**
-     * Creates a new {@link Config.SystemConfiguration | SystemConfiguration} from the supplied
-     * {@link Config.Model.ISystemConfiguration | system configuration}.
-     * @param config - The {@link Config.Model.ISystemConfiguration | system configuration} to use.
-     * @param initParams - Optional {@link Config.ISystemConfigurationInitParams | initialization parameters}.
-     * @returns `Success` with the new {@link Config.SystemConfiguration | SystemConfiguration}
-     * if successful, `Failure` with an error message otherwise.
-     * @public
-     */
-    static create(config: ISystemConfiguration, initParams?: ISystemConfigurationInitParams): Result<SystemConfiguration>;
-    /**
-     * Loads a {@link Config.SystemConfiguration | SystemConfiguration} from a file.
-     * @param path - The path to the file to load.
-     * @returns `Success` with the {@link Config.SystemConfiguration | SystemConfiguration}
-     * if successful, `Failure` with an error message otherwise.
-     * @public
-     */
-    static loadFromFile(path: string, initParams?: ISystemConfigurationInitParams): Result<SystemConfiguration>;
-    /**
-     * Returns the {@link Config.Model.ISystemConfiguration | system configuration} that this
-     * {@link Config.SystemConfiguration | SystemConfiguration} was created from.
-     * @returns `Success` with the {@link Config.Model.ISystemConfiguration | system configuration}
-     * if successful, `Failure` with an error message otherwise.
-     * @public
-     */
-    getConfig(): Result<ISystemConfiguration>;
-}
-//# sourceMappingURL=systemConfiguration.d.ts.map