@fgv/ts-res 5.0.1-9 → 5.0.2-0

package/dist/packlets/import/importers/importer.js

@@ -0,0 +1,23 @@
+/*
+ * 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=importer.js.map

package/dist/packlets/import/importers/index.browser.js

@@ -0,0 +1,29 @@
+/*
+ * 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.
+ */
+// Browser-safe importers - excludes Node.js filesystem dependencies
+export * from './importer';
+export * from './collectionImporter';
+export * from './jsonImporter';
+// Excluded from browser:
+// - fsItemImporter (processes filesystem items)
+// - pathImporter (requires Node.js fs via FileTree.forFilesystem())
+//# sourceMappingURL=index.browser.js.map

package/dist/packlets/import/importers/index.js

@@ -0,0 +1,27 @@
+/*
+ * 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 * from './importer';
+export * from './collectionImporter';
+export * from './fsItemImporter';
+export * from './jsonImporter';
+export * from './pathImporter';
+//# sourceMappingURL=index.js.map

package/dist/packlets/import/importers/jsonImporter.js

@@ -0,0 +1,94 @@
+/*
+ * Copyright (c) 2025 Erik Fortune
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+import { captureResult, failWithDetail, succeed } from '@fgv/ts-utils';
+import { isImportable } from '../importable';
+import * as ResourceJson from '../../resource-json';
+/**
+ * {@link Import.Importers.IImporter | Importer} implementation which imports resources from a JSON object.
+ * @public
+ */
+export class JsonImporter {
+    /**
+     * Protected {@link Import.Importers.JsonImporter | JsonImporter} constructor for derived classes.
+     */
+    constructor() {
+        /**
+         * {@inheritdoc Import.Importers.IImporter.types}
+         */
+        this.types = ['json'];
+    }
+    /**
+     * Creates a new {@link Import.Importers.JsonImporter | JsonImporter} instance.
+     * @returns `Success` with the new {@link Import.Importers.JsonImporter | JsonImporter} if successful,
+     * `Failure` otherwise.
+     */
+    static create() {
+        return captureResult(() => new JsonImporter());
+    }
+    /**
+     * {@inheritdoc Import.Importers.IImporter.import}
+     */
+    import(item, manager) {
+        var _a, _b;
+        /* c8 ignore next 1 - coverage intermittently misses the next line */
+        if (!isImportable(item) || item.type !== 'json') {
+            /* c8 ignore next 3 - functional code path tested but coverage intermittently missed */
+            const name = (_b = (_a = item.context) === null || _a === void 0 ? void 0 : _a.baseId) !== null && _b !== void 0 ? _b : 'unknown';
+            return failWithDetail(`${name}: invalid JSON importable (${item.type})`, 'skipped');
+        }
+        return (this._tryImportResourceCollection(item)
+            .onFailure(() => this._tryImportResourceTree(item))
+            // experimenting with this, accepting any JSON object here makes it
+            // very hard to distinguish a collection or tree with a typo from a
+            // legitimate single loose resource, which yields extremely confusing
+            // error messages. Disabled until/unless we come up with a better plan.
+            //.onFailure(() => this._tryImportResource(item, manager));
+            .onFailure(() => { var _a, _b; 
+        /* c8 ignore next 1 - defense in depth */
+        return failWithDetail(`${(_b = (_a = item.context) === null || _a === void 0 ? void 0 : _a.baseId) !== null && _b !== void 0 ? _b : 'unknown'}: unrecognized JSON format.`, 'failed'); }));
+    }
+    _tryImportResourceCollection(item) {
+        return ResourceJson.ResourceDeclCollection.create(item.json)
+            .onSuccess((collection) => {
+            const importable = {
+                type: 'resourceCollection',
+                collection,
+                context: item.context
+            };
+            return succeed([importable]);
+        })
+            .withDetail('skipped', 'consumed');
+    }
+    _tryImportResourceTree(item) {
+        return ResourceJson.ResourceDeclTree.create(item.json)
+            .onSuccess((tree) => {
+            const importable = {
+                type: 'resourceTree',
+                tree,
+                context: item.context
+            };
+            return succeed([importable]);
+        })
+            .withDetail('skipped', 'consumed');
+    }
+}
+//# sourceMappingURL=jsonImporter.js.map

package/dist/packlets/import/importers/pathImporter.js

@@ -0,0 +1,84 @@
+/*
+ * Copyright (c) 2025 Erik Fortune
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+import { captureResult, failWithDetail, succeedWithDetail } from '@fgv/ts-utils';
+import { FileTree } from '@fgv/ts-json-base';
+import { FsItem } from '../fsItem';
+/**
+ * {@link Import.Importers.IImporter | Importer} implementation which imports resources from a `FileTree`
+ * given a path.
+ * @public
+ */
+export class PathImporter {
+    /**
+     * Protected constructor for the {@link Import.Importers.PathImporter | PathImporter}.
+     * @param params - Parameters for creating the {@link Import.Importers.PathImporter | PathImporter}.
+     */
+    constructor(params) {
+        var _a, _b;
+        /**
+         * The types of {@link Import.IImportable | importables} that this importer can handle.
+         */
+        this.types = ['path'];
+        this.qualifiers = params.qualifiers;
+        this.tree = (_a = params.tree) !== null && _a !== void 0 ? _a : FileTree.forFilesystem().orThrow();
+        this.ignoreFileTypes = (_b = params.ignoreFileTypes) !== null && _b !== void 0 ? _b : [];
+    }
+    /**
+     * Creates a new {@link Import.Importers.PathImporter | PathImporter}.
+     * @param params - Parameters for creating the {@link Import.Importers.PathImporter | dirPathImporter}.
+     * @returns `Success` with the new `PathImporter` if successful, `Failure` with an error message if not.
+     */
+    static create(params) {
+        return captureResult(() => new PathImporter(params));
+    }
+    /**
+     * {@inheritdoc Import.Importers.IImporter.import}
+     */
+    import(item, __manager) {
+        const { value: fsItem, message: getTreeMessage, detail: getTreeDetail } = this._getFileTreeItemFromImportable(item);
+        if (getTreeMessage !== undefined) {
+            return failWithDetail(getTreeMessage, getTreeDetail === 'skipped' ? 'skipped' : 'failed');
+        }
+        if (fsItem.item.type === 'file' && this.ignoreFileTypes.includes(fsItem.item.extension)) {
+            return succeedWithDetail([], 'processed');
+        }
+        // extracted characteristics are in the fsItem so add them to the context when
+        // that is imported instead of now.
+        const context = item.context;
+        return succeedWithDetail([{ type: 'fsItem', item: fsItem, context }], 'processed');
+    }
+    /**
+     * Gets an {@link Import.FsItem | FsItem} from an {@link Import.IImportable | importable}.
+     * @param item - The importable to convert.
+     * @returns `Success` containing the `FsItem` if successful, `Failure` with an error message if not.
+     */
+    _getFileTreeItemFromImportable(item) {
+        if (item.type === 'path') {
+            if ('path' in item && typeof item.path === 'string') {
+                return FsItem.createForPath(item.path, this.qualifiers, this.tree);
+            }
+            return failWithDetail(`malformed path importable does not contain a string path`, 'failed');
+        }
+        return failWithDetail(`${item.type}: invalid importable type for a PathImporter`, 'skipped');
+    }
+}
+//# sourceMappingURL=pathImporter.js.map

package/dist/packlets/import/index.browser.js

@@ -0,0 +1,34 @@
+/*
+ * 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.
+ */
+// Browser-safe import exports - excludes Node.js filesystem dependencies
+export * from './importContext';
+export * from './importable';
+export * from './importManager';
+// Export FsItem class (browser-safe for in-memory FileTree usage)
+export { FsItem } from './fsItem';
+// Use browser-safe importers index
+import * as Importers from './importers/index.browser';
+export { Importers };
+// Excluded from browser:
+// - FsItem.createForPath() static method (requires Node.js fs via FileTree.forFilesystem())
+// - PathImporter and FsItemImporter (via importers/index.browser.ts)
+//# sourceMappingURL=index.browser.js.map

package/dist/packlets/import/index.js

@@ -0,0 +1,28 @@
+/*
+ * 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 * from './importContext';
+export * from './importable';
+export * from './fsItem';
+export * from './importManager';
+import * as Importers from './importers';
+export { Importers };
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1,124 @@
+/*
+ * 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 * as Common from '../../common';
+import { Converters as JsonConverters } from '@fgv/ts-json-base';
+/**
+ * A `Converter` for {@link QualifierTypes.Config.ILanguageQualifierTypeConfig | LanguageQualifierTypeConfig} objects.
+ * @returns A `Converter` for {@link QualifierTypes.Config.ILanguageQualifierTypeConfig | LanguageQualifierTypeConfig} objects.
+ * @public
+ */
+export const languageQualifierTypeConfig = Converters.strictObject({
+    allowContextList: Converters.boolean.optional()
+});
+/**
+ * A `Converter` for {@link QualifierTypes.Config.ITerritoryQualifierTypeConfig | TerritoryQualifierTypeConfig} objects.
+ * @returns A `Converter` for {@link QualifierTypes.Config.ITerritoryQualifierTypeConfig | TerritoryQualifierTypeConfig} objects.
+ * @public
+ */
+export const territoryQualifierTypeConfig = Converters.strictObject({
+    allowContextList: Converters.boolean,
+    acceptLowercase: Converters.boolean.optional(),
+    allowedTerritories: Converters.arrayOf(Converters.string).optional(),
+    hierarchy: Converters.recordOf(Converters.string).optional()
+});
+/**
+ * A `Converter` for {@link QualifierTypes.Config.ILiteralQualifierTypeConfig | LiteralQualifierTypeConfig} objects.
+ * @returns A `Converter` for {@link QualifierTypes.Config.ILiteralQualifierTypeConfig | LiteralQualifierTypeConfig} objects.
+ * @public
+ */
+export const literalQualifierTypeConfig = Converters.strictObject({
+    allowContextList: Converters.boolean.optional(),
+    caseSensitive: Converters.boolean.optional(),
+    enumeratedValues: Converters.arrayOf(Converters.string).optional(),
+    hierarchy: Converters.recordOf(Converters.string).optional()
+});
+/**
+ * A `Converter` for {@link QualifierTypes.Config.ISystemLanguageQualifierTypeConfig | SystemLanguageQualifierTypeConfig} objects.
+ * @returns A `Converter` for {@link QualifierTypes.Config.ISystemLanguageQualifierTypeConfig | SystemLanguageQualifierTypeConfig} objects.
+ * @public
+ */
+export const systemLanguageQualifierTypeConfig = Converters.strictObject({
+    name: Converters.string,
+    systemType: Converters.literal('language'),
+    configuration: languageQualifierTypeConfig.optional()
+});
+/**
+ * A `Converter` for {@link QualifierTypes.Config.ISystemTerritoryQualifierTypeConfig | SystemTerritoryQualifierTypeConfig} objects.
+ * @returns A `Converter` for {@link QualifierTypes.Config.ISystemTerritoryQualifierTypeConfig | SystemTerritoryQualifierTypeConfig} objects.
+ * @public
+ */
+export const systemTerritoryQualifierTypeConfig = Converters.strictObject({
+    name: Converters.string,
+    systemType: Converters.literal('territory'),
+    configuration: territoryQualifierTypeConfig.optional()
+});
+/**
+ * A `Converter` for {@link QualifierTypes.Config.ISystemLiteralQualifierTypeConfig | SystemLiteralQualifierTypeConfig} objects.
+ * @returns A `Converter` for {@link QualifierTypes.Config.ISystemLiteralQualifierTypeConfig | SystemLiteralQualifierTypeConfig} objects.
+ * @public
+ */
+export const systemLiteralQualifierTypeConfig = Converters.strictObject({
+    name: Converters.string,
+    systemType: Converters.literal('literal'),
+    configuration: literalQualifierTypeConfig.optional()
+});
+/**
+ * A `Converter` for {@link QualifierTypes.Config.ISystemQualifierTypeConfig | SystemQualifierTypeConfig} objects.
+ * @returns A `Converter` for {@link QualifierTypes.Config.ISystemQualifierTypeConfig | SystemQualifierTypeConfig} objects.
+ * @public
+ */
+export const systemQualifierTypeConfig = Converters.discriminatedObject('systemType', {
+    language: systemLanguageQualifierTypeConfig,
+    territory: systemTerritoryQualifierTypeConfig,
+    literal: systemLiteralQualifierTypeConfig
+});
+/**
+ * A `Converter` for {@link QualifierTypes.Config.IQualifierTypeConfig | QualifierTypeConfig} objects.
+ * @returns A `Converter` for {@link QualifierTypes.Config.IQualifierTypeConfig | QualifierTypeConfig} objects.
+ * @param config - A `Converter` for the configuration object.
+ * @public
+ */
+export function qualifierTypeConfig(config) {
+    return Converters.strictObject({
+        name: Common.Convert.qualifierTypeName,
+        systemType: Common.Convert.qualifierTypeName,
+        configuration: config.optional()
+    });
+}
+/**
+ * A `Converter` for {@link QualifierTypes.Config.IQualifierTypeConfig | QualifierTypeConfig} objects.
+ * @returns A `Converter` for {@link QualifierTypes.Config.IQualifierTypeConfig | QualifierTypeConfig} objects.
+ * @public
+ */
+export const jsonQualifierTypeConfig = qualifierTypeConfig(JsonConverters.jsonObject);
+/**
+ * A `Converter` for {@link QualifierTypes.Config.IAnyQualifierTypeConfig | AnyQualifierTypeConfig} objects.
+ * @returns A `Converter` for {@link QualifierTypes.Config.IAnyQualifierTypeConfig | AnyQualifierTypeConfig} objects.
+ * @public
+ */
+export const anyQualifierTypeConfig = Converters.oneOf([
+    jsonQualifierTypeConfig,
+    systemQualifierTypeConfig
+]);
+//# sourceMappingURL=convert.js.map

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

@@ -0,0 +1,25 @@
+/*
+ * 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/qualifier-types/config/json.js

@@ -0,0 +1,32 @@
+/*
+ * 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.
+ */
+/**
+ * Checks if a {@link QualifierTypes.Config.IAnyQualifierTypeConfig | qualifier type configuration} is a
+ * {@link QualifierTypes.Config.ISystemQualifierTypeConfig | system qualifier type configuration}.
+ * @param config - The {@link QualifierTypes.Config.IAnyQualifierTypeConfig | qualifier type configuration} to check.
+ * @returns `true` if the configuration is a system qualifier type configuration, `false` otherwise.
+ * @public
+ */
+export function isSystemQualifierTypeConfig(config) {
+    return (config.systemType === 'language' || config.systemType === 'territory' || config.systemType === 'literal');
+}
+//# sourceMappingURL=json.js.map

package/dist/packlets/qualifier-types/convert.js

@@ -0,0 +1,56 @@
+/*
+ * Copyright (c) 2025 Erik Fortune
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+import { Converters, fail } from '@fgv/ts-utils';
+/**
+ * Converter for {@link QualifierTypes.QualifierType | QualifierType} objects,
+ * retrieves a {@link QualifierTypes.QualifierType | QualifierType} by name or
+ * index from a supplied {@link QualifierTypes.Convert.IQualifierTypeConvertContext | conversion context}.
+ * @public
+ */
+// eslint-disable-next-line @rushstack/typedef-var
+export const qualifierType = Converters.generic((from, __self, context) => {
+    if (!context) {
+        return fail('qualifierType converter requires a context');
+    }
+    if (typeof from === 'string') {
+        return context.qualifierTypes.validating.get(from);
+    }
+    else if (typeof from === 'number') {
+        return context.qualifierTypes.getAt(from);
+    }
+    return fail('qualifierType converter requires a string or number');
+});
+/**
+ * Gets a converter for {@link QualifierTypes.ILiteralValueHierarchyCreateParams | ILiteralValueHierarchyCreateParams}
+ * objects with values validated by a supplied value converter.
+ * @param valueConverter - Converter for the literal value type.
+ * @public
+ */
+export function literalValueHierarchyCreateParams(valueConverter) {
+    return Converters.object({
+        values: Converters.arrayOf(valueConverter),
+        hierarchy: Converters.recordOf(valueConverter, {
+            keyConverter: valueConverter
+        })
+    });
+}
+//# sourceMappingURL=convert.js.map

package/dist/packlets/qualifier-types/helpers.js

@@ -0,0 +1,82 @@
+/*
+ * Copyright (c) 2025 Erik Fortune
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+import { fail } from '@fgv/ts-utils';
+import * as Config from './config';
+import { LanguageQualifierType } from './languageQualifierType';
+import { TerritoryQualifierType } from './territoryQualifierType';
+import { LiteralQualifierType } from './literalQualifierType';
+/**
+ * Creates a {@link QualifierTypes.QualifierType | QualifierType} from a configuration object.
+ * This factory function determines the appropriate qualifier type based on the systemType
+ * and delegates to the appropriate type-specific createFromConfig method.
+ * @param typeConfig - The {@link QualifierTypes.Config.IQualifierTypeConfig | configuration object}
+ * containing the name, systemType, and optional type-specific configuration.
+ * @returns `Success` with the new {@link QualifierTypes.QualifierType | QualifierType}
+ * if successful, `Failure` with an error message otherwise.
+ * @public
+ */
+export function createQualifierTypeFromConfig(typeConfig) {
+    var _a;
+    /* c8 ignore next 1 - defense in depth */
+    const childConfig = (_a = typeConfig.configuration) !== null && _a !== void 0 ? _a : {};
+    switch (typeConfig.systemType) {
+        case 'language':
+            return Config.Convert.languageQualifierTypeConfig
+                .convert(childConfig)
+                .onSuccess((configuration) => LanguageQualifierType.createFromConfig(Object.assign(Object.assign({}, typeConfig), { configuration })));
+        case 'territory':
+            return Config.Convert.territoryQualifierTypeConfig
+                .convert(childConfig)
+                .onSuccess((configuration) => TerritoryQualifierType.createFromConfig(Object.assign(Object.assign({}, typeConfig), { configuration })));
+        case 'literal':
+            return Config.Convert.literalQualifierTypeConfig
+                .convert(childConfig)
+                .onSuccess((configuration) => LiteralQualifierType.createFromConfig(Object.assign(Object.assign({}, typeConfig), { configuration })));
+    }
+    /* c8 ignore next 1 - defense in depth */
+    return fail(`Unknown qualifier type: ${typeConfig.systemType}`);
+}
+/**
+ * Creates a {@link QualifierTypes.SystemQualifierType | SystemQualifierType} from a system configuration object.
+ * This factory function determines the appropriate qualifier type based on the systemType
+ * and delegates to the appropriate type-specific createFromConfig method.
+ * @param typeConfig - The {@link QualifierTypes.Config.ISystemQualifierTypeConfig | configuration object}
+ * containing the name, systemType, and optional type-specific configuration.
+ * @returns `Success` with the new {@link QualifierTypes.SystemQualifierType | SystemQualifierType}
+ * if successful, `Failure` with an error message otherwise.
+ * @public
+ */
+export function createQualifierTypeFromSystemConfig(typeConfig) {
+    const { systemType } = typeConfig;
+    switch (systemType) {
+        case 'language':
+            return LanguageQualifierType.createFromConfig(typeConfig);
+        case 'territory':
+            return TerritoryQualifierType.createFromConfig(typeConfig);
+        case 'literal':
+            return LiteralQualifierType.createFromConfig(typeConfig);
+    }
+    /* c8 ignore next 3 - should not happen */
+    // @ts-expect-error
+    return fail(`${systemType}: Unknown system qualifier type.`);
+}
+//# sourceMappingURL=helpers.js.map