@fgv/ts-bcp47 5.1.0-2 → 5.1.0-4

package/dist/packlets/unsd/regionCodes.js

@@ -0,0 +1,115 @@
+/*
+ * Copyright (c) 2022 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 { allSucceed, succeed } from '@fgv/ts-utils';
+import { loadM49csvFileSync, m49CsvFile } from './csv/converters';
+// eslint-disable-next-line @rushstack/packlets/mechanics
+import defaultRegions from '../../data/unsd/m49.json';
+import { Areas } from './areas';
+import { Regions } from './regions';
+/**
+ * @public
+ */
+export class RegionCodes {
+    /**
+     * @internal
+     */
+    constructor() {
+        this.regions = new Regions();
+        this.areas = new Areas();
+    }
+    static create(rows) {
+        const codes = new RegionCodes();
+        return codes._importRows(rows).onSuccess(() => {
+            return succeed(codes);
+        });
+    }
+    static createFromJson(from) {
+        return m49CsvFile.convert(from).onSuccess(RegionCodes.create);
+    }
+    static loadDefault() {
+        return this.createFromJson(defaultRegions);
+    }
+    static loadCsv(path) {
+        return loadM49csvFileSync(path).onSuccess((rows) => {
+            return this.create(rows);
+        });
+    }
+    tryGetRegionOrArea(code) {
+        var _a;
+        /* c8 ignore next - numeric area not allowed in bcp-47 so right side of ?? shouldn't be hit. */
+        return (_a = this.regions.tryGetRegion(code)) !== null && _a !== void 0 ? _a : this.areas.tryGetArea(code);
+    }
+    getIsContained(container, contained) {
+        let next = contained;
+        while (next) {
+            if (next === container) {
+                return true;
+            }
+            next = next.tier !== 'global' ? next.parent : undefined;
+        }
+        return false;
+    }
+    /**
+     * Imports a single parsed row of UN M.49 region code data
+     * @param row - The parsed row to be imported.
+     * @returns `Success` with `true` if the row was successfully
+     * imported, or `Failure` with details if an error occurs.
+     * @internal
+     */
+    _importRow(row) {
+        return this.regions
+            .getOrAddRegionChildRegion('region', this.regions.global, row.regionCode, row.regionName)
+            .onSuccess((region) => {
+            return this.regions.getOrAddRegionChildRegion('subRegion', region, row.subRegionCode, row.subRegionName);
+        })
+            .onSuccess((region) => {
+            return this.regions.getOrAddRegionChildRegion('intermediateRegion', region, row.intermediateRegionCode, row.intermediateRegionName);
+        })
+            .onSuccess((region) => {
+            return this.areas.addArea({
+                name: row.countryOrArea,
+                code: row.m49Code,
+                tier: 'area',
+                parent: region,
+                isoAlpha2: row.isoAlpha2RegionCode,
+                isoAlpha3: row.isoAlpha3RegionCode,
+                leastDevelopedCountry: row.leastDevelopedCountry,
+                landlockedDevelopingCountry: row.landLockedDevelopingCountry,
+                smallIslandDevelopingState: row.smallIslandDevelopingState
+            });
+        })
+            .onSuccess(() => {
+            return succeed(true);
+        });
+    }
+    /**
+     * Imports multiple parsed rows from UN M.49 region code data
+     * @param rows - The parsed rows to be imported.
+     * @returns `Success` with `true` if the rows were successfully
+     * imported, or `Failure` with details if an error occurs.
+     * @internal
+     */
+    _importRows(rows) {
+        return allSucceed(rows.map((row) => this._importRow(row)), true);
+    }
+}
+//# sourceMappingURL=regionCodes.js.map

package/dist/packlets/unsd/regions.js

@@ -0,0 +1,71 @@
+/*
+ * Copyright (c) 2022 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, succeed } from '@fgv/ts-utils';
+export const GlobalRegionName = 'World';
+export const GlobalRegionCode = '001';
+/**
+ * @public
+ */
+export class Regions {
+    constructor() {
+        this.global = { name: GlobalRegionName, code: GlobalRegionCode, tier: 'global', regions: [], areas: [] };
+        this._regions = new Map();
+    }
+    tryGetRegion(from) {
+        return this._regions.get(from);
+    }
+    getRegion(from) {
+        const got = this._regions.get(from);
+        return got ? succeed(got) : fail(`${from}: region not found`);
+    }
+    getOrAddRegionChildRegion(tier, parent, code, name) {
+        if (!code && !name) {
+            return succeed(parent);
+        }
+        else if (!code || !name) {
+            return fail(`${code}(${name}): code and name must both be present`);
+        }
+        const existing = this._regions.get(code);
+        if (existing) {
+            if (existing.name !== name) {
+                return fail(`${code}: cannot add ${name} - already exists as ${existing.name}`);
+            }
+            if (existing.tier !== tier) {
+                return fail(`${code}: cannot add ${name} as tier ${tier} - already exists as tier ${existing.tier}`);
+            }
+            if (existing.parent !== parent) {
+                const haveParent = `${existing.parent.code}/${existing.parent.name}`;
+                const wantParent = `${parent.code}/${parent.name}`;
+                return fail(`${code}: cannot add ${name} with parent ${wantParent} - already exists with parent ${haveParent}`);
+            }
+            return succeed(existing);
+        }
+        const added = { name, code, tier, parent, regions: [], areas: [] };
+        this._regions.set(code, added);
+        parent.regions.push(added);
+        return succeed(added);
+    }
+    getAll() {
+        return Array.from(this._regions.values());
+    }
+}
+//# sourceMappingURL=regions.js.map

package/dist/packlets/utils/index.js

@@ -0,0 +1,24 @@
+/*
+ * Copyright (c) 2021 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 './jsonHelpers';
+export * from './validationHelpers';
+//# sourceMappingURL=index.js.map

package/dist/packlets/utils/jsonHelpers.js

@@ -0,0 +1,25 @@
+/*
+ * Copyright (c) 2021 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 function sanitizeJson(from) {
+    return JSON.parse(JSON.stringify(from));
+}
+//# sourceMappingURL=jsonHelpers.js.map

package/dist/packlets/utils/public.js

@@ -0,0 +1,24 @@
+/*
+ * Copyright (c) 2022 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.
+ */
+// istanbul ignore file
+export { ValidationHelpers } from './validationHelpers';
+//# sourceMappingURL=public.js.map

package/dist/packlets/utils/validationHelpers.js

@@ -0,0 +1,116 @@
+/*
+ * Copyright (c) 2021 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, succeed } from '@fgv/ts-utils';
+/**
+  A collection of validation and normalization helpers for constrained string
+  types.
+ * @public
+ */
+export class ValidationHelpers {
+    /**
+     * Constructs new {@link Utils.ValidationHelpers | validation helpers}
+     * from supplied initializers.
+     * @param init - The {@link Utils.ValidationHelpersConstructorParams | constructor params}
+     * used to initialize this {@link Utils.ValidationHelpers | validation helpers}.
+     */
+    constructor(init) {
+        this.description = init.description;
+        this.isWellFormed = init.isWellFormed;
+        this.isCanonical = init.isCanonical;
+        this._toCanonical = init.toCanonical;
+        this.converter = Converters.isA(this.description, this.isWellFormed);
+    }
+    /**
+     * Converts a supplied `unknown` to the canonical form of the tag
+     * validated by these helpers.
+     * @param from - The `unknown` to be converted.
+     * @param context - Optional context used in the conversion.
+     * @returns `Success` with the corresponding canonical value,
+     * or `Failure` with details if an error occurs.
+     */
+    toCanonical(from, context) {
+        if (this.isWellFormed(from, context)) {
+            if (this._toCanonical) {
+                return this._toCanonical(from, context);
+            }
+            /* c8 ignore next 3 - functional code tested but coverage intermittently missed */
+            if (this.isCanonical(from, context)) {
+                return succeed(from);
+            }
+            /* c8 ignore next 2 */
+            return fail(`cannot convert "${from}" to canonical ${this.description}`);
+        }
+        return fail(`invalid ${this.description} ("${JSON.stringify(from)}")`);
+    }
+    /**
+     * Determines if a supplied `unknown` is a well-formed representation
+     * of the tag validated by these helpers.
+     * @param from - The `unknown` to be validated.
+     * @param context - Optional context used in the validation.
+     * @returns `Success` with the validated value, or `Failure` with details
+     * if an error occurs.
+     */
+    verifyIsWellFormed(from, context) {
+        if (this.isWellFormed(from, context)) {
+            return succeed(from);
+        }
+        return fail(`malformed ${this.description}`);
+    }
+    /**
+     * Determines if a supplied `unknown` is a well-formed, canonical representation
+     * of the tag validated by these helpers.
+     * @param from - The `unknown` to be validated.
+     * @param context - Optional context used in the validation.
+     * @returns `Success` with the validated canonical value, or `Failure` with
+     * details if an error occurs.
+     */
+    verifyIsCanonical(from, context) {
+        if (this.isCanonical(from, context)) {
+            return succeed(from);
+        }
+        /* c8 ignore next 3 - should never occur and very hard to test */
+        if (!this.isWellFormed(from, context)) {
+            return fail(`malformed ${this.description}`);
+        }
+        return fail(`non-canonical ${this.description}`);
+    }
+}
+/**
+ * @internal
+ */
+export class RegExpValidationHelpers extends ValidationHelpers {
+    constructor(params) {
+        super({
+            description: params.description,
+            toCanonical: params.toCanonical,
+            isWellFormed: (from) => {
+                return typeof from === 'string' && this.wellFormed.test(from);
+            },
+            isCanonical: (from) => {
+                return typeof from === 'string' && this.canonical.test(from);
+            }
+        });
+        this.wellFormed = params.wellFormed;
+        this.canonical = params.canonical;
+    }
+}
+//# sourceMappingURL=validationHelpers.js.map