@mailwoman/core 2.0.0

package/out/resources/whosonfirst/placetypes/Placetype.js

@@ -0,0 +1,338 @@
+/**
+ * @copyright Sister Software
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+import FastGlob from "fast-glob";
+import * as fs from "node:fs/promises";
+import { PathBuilder } from "path-ts";
+import { takeInParallel } from "../../collections.js";
+import { prepareRepositoryDirectories } from "../../git.js";
+import { normalizePlacetypeDefinition, PlacetypeRoleOrder, } from "./definition.js";
+export const PLACETYPES_REPO_SOURCE = {
+    url: "https://github.com/whosonfirst/whosonfirst-placetypes.git",
+    owner: "whosonfirst",
+    name: "whosonfirst-placetypes",
+};
+export class Placetype {
+    [Symbol.dispose]() {
+        this.parentNames.clear();
+        this.parents.clear();
+        this.siblings.clear();
+        this.children.clear();
+    }
+    //#region Static Caches
+    /**
+     * A map of placetypes indexed by their Brooklyn Integers ID.
+     *
+     * Note that these IDs are not in any specific order. Avoid using them for sorting.
+     */
+    static #byID = new Map();
+    /**
+     * A map of placetypes indexed by their name.
+     */
+    static #byName = new Map();
+    /**
+     * A map of placetype children indexed by their parent's name.
+     */
+    static #childrenOfParentName = new Map();
+    /**
+     * A map of placetype children names indexed by their parent's name.
+     */
+    static #childNamesOfParentName = new Map();
+    //#endregion
+    //#region Static Methods
+    static async prepare({ batchSize, localRepoDirectory }) {
+        const { repoDirectory, exists } = await prepareRepositoryDirectories(PLACETYPES_REPO_SOURCE, localRepoDirectory);
+        if (!exists)
+            return;
+        const definitionPaths = FastGlob.stream(["*.json"], {
+            cwd: repoDirectory("placetypes").toString(),
+            absolute: true,
+        });
+        const batchIterator = takeInParallel(definitionPaths, batchSize, async (definitionPath) => {
+            const definitionContent = await fs.readFile(definitionPath, "utf8");
+            const definition = JSON.parse(definitionContent);
+            Placetype.register(definition);
+            return definition;
+        });
+        await Array.fromAsync(batchIterator);
+    }
+    /**
+     * Find a placetype by its name or ID.
+     */
+    static find = (idOrName) => {
+        if (typeof idOrName === "string") {
+            return Placetype.#byName.get(idOrName) || null;
+        }
+        return Placetype.#byID.get(idOrName) || null;
+    };
+    /**
+     * Find a placetype by its name or ID.
+     *
+     * @throws {Error} If no placetype is found with the given name.
+     */
+    static findOrThrow = (idOrName) => {
+        const placetype = Placetype.find(idOrName);
+        if (!placetype) {
+            throw new Error(`No placetype found with id ${idOrName}`);
+        }
+        return placetype;
+    };
+    /**
+     * Compare two placetypes, sorting less specific (i.e. bigger or higher) placetypes first.
+     *
+     * Note that the two placetype IDs have no affect on the comparison as they are not sequential,
+     * only unique.
+     */
+    static comparatorAsc(a, b) {
+        if (a.siblings.has(b)) {
+            return PlacetypeRoleOrder[a.role] - PlacetypeRoleOrder[b.role];
+        }
+        if (a.children.has(b))
+            return -1;
+        if (b.children.has(a))
+            return 1;
+        return 0;
+    }
+    /**
+     * Compare two placetypes, sorting more specific (i.e. smaller or lower) placetypes first.
+     *
+     * Note that the two placetype IDs have no affect on the comparison as they are not sequential,
+     * only unique.
+     */
+    static comparatorDesc(a, b) {
+        if (a.siblings.has(b)) {
+            return PlacetypeRoleOrder[b.role] - PlacetypeRoleOrder[a.role];
+        }
+        if (a.children.has(b))
+            return 1;
+        if (b.children.has(a))
+            return -1;
+        return 0;
+    }
+    //#endregion
+    /**
+     * The source definition of this placetype.
+     */
+    #definition;
+    //#region Properties
+    /**
+     * The Brooklyn Integers ID of this placetype.
+     *
+     * This is effectively a unique identifier for the placetype, but any pattern of sequential
+     * integers is coincidental.
+     */
+    get id() {
+        return this.#definition.id;
+    }
+    /**
+     * The name of this placetype, e.g. "country", "city", "neighborhood"
+     */
+    get name() {
+        return this.#definition.name;
+    }
+    /**
+     * The role of this placetype, indicating its level of requirement to represent a full hierarchy.
+     *
+     * Some placetypes only exist to provide a supplementary role and are not required for a full
+     * hierarchy.
+     */
+    get role() {
+        return this.#definition.role;
+    }
+    /**
+     * The parent names of this placetype, i.e. those that this Placetype is a child of.
+     *
+     * @example Continent is a parent of "country"
+     */
+    parentNames;
+    /**
+     * The parents of this Placetype, i.e. those with this Placetype as a child.
+     */
+    parents;
+    /**
+     * Sibling Placetypes of this Placetype, i.e. those with the same parent.
+     *
+     * Note that this is **all** siblings across **all** parents.
+     */
+    siblings;
+    /**
+     * Children of this Placetype, i.e. those with **this Placetype as a parent**.
+     */
+    children;
+    //#endregion
+    //#region Predicates
+    /**
+     * Check if this placetype has a child matching the given name, ID, or Placetype instance.
+     */
+    hasChild(childLike) {
+        const children = Placetype.#childrenOfParentName.get(this.name);
+        if (!children)
+            return false;
+        if (childLike instanceof Placetype) {
+            return children.has(childLike);
+        }
+        const child = Placetype.findOrThrow(childLike);
+        return children.has(child);
+    }
+    //#endregion
+    //#region Lineage Methods
+    /**
+     * Find the ancestors of this placetype, optionally filtered by role.
+     *
+     * An ancestor is a parent, grandparent, great-grandparent, etc. of this placetype.
+     */
+    findAncestors(roles) {
+        const ancestorsContext = new Set();
+        const roleFilters = roles ? new Set(roles) : null;
+        this.#collectAncestors(ancestorsContext, roleFilters);
+        return Array.from(ancestorsContext).sort(Placetype.comparatorAsc);
+    }
+    #collectAncestors(ancestorsContext, roleFilters) {
+        for (const parent of this.parents) {
+            if (roleFilters && !roleFilters.has(parent.role))
+                continue;
+            ancestorsContext.add(parent);
+            parent.#collectAncestors(ancestorsContext, roleFilters);
+        }
+    }
+    /**
+     * Find the children of this placetype, optionally filtered by role.
+     *
+     * @see {@linkcode children} for children as a Set.
+     */
+    findChildren(roles) {
+        const roleFilters = roles ? new Set(roles) : null;
+        const validChildren = [];
+        for (const child of this.children) {
+            if (roleFilters && !roleFilters.has(child.role))
+                continue;
+            validChildren.push(child);
+        }
+        return validChildren.sort(Placetype.comparatorAsc);
+    }
+    /**
+     * Find the parents of this placetype, optionally filtered by role.
+     *
+     * @see {@linkcode parents} for parents as a Set.
+     */
+    findParents(roles) {
+        const roleFilters = roles ? new Set(roles) : null;
+        const validParents = [];
+        for (const parent of this.parents) {
+            if (roleFilters && !roleFilters.has(parent.role))
+                continue;
+            validParents.push(parent);
+        }
+        return validParents.sort(Placetype.comparatorDesc);
+    }
+    /**
+     * Find the siblings of this placetype, optionally filtered by role.
+     */
+    findSiblings(roles) {
+        const roleFilters = roles ? new Set(roles) : null;
+        const validSiblings = Array.from(this.siblings);
+        if (roleFilters) {
+            return validSiblings.filter((sibling) => roleFilters.has(sibling.role));
+        }
+        return validSiblings.sort((a, b) => {
+            return PlacetypeRoleOrder[a.role] - PlacetypeRoleOrder[b.role];
+        });
+    }
+    /**
+     * Find the descendants of this placetype, optionally filtered by role.
+     *
+     * A descendant is a child, grandchild, great-grandchild, etc. of this placetype.
+     */
+    findDescendants(roles) {
+        const descendantsContext = new Set();
+        const roleFilters = roles ? new Set(roles) : null;
+        this.#collectDescendants(descendantsContext, roleFilters);
+        return Array.from(descendantsContext).sort(Placetype.comparatorAsc);
+    }
+    #collectDescendants(descendantsContext, roleFilters) {
+        for (const child of this.children) {
+            if (roleFilters && !roleFilters.has(child.role))
+                continue;
+            descendantsContext.add(child);
+            child.#collectDescendants(descendantsContext, roleFilters);
+        }
+    }
+    //#endregion
+    //#region Constructors
+    /**
+     * Register a placetype specification, creating a new Placetype instance and indexing it by id.
+     */
+    static register(initLike) {
+        const definition = normalizePlacetypeDefinition(initLike);
+        const placetype = new Placetype(definition);
+        return placetype;
+    }
+    /**
+     * Create a new Placetype instance from a PlacetypeDefinition
+     *
+     * @see {@linkcode Placetype.register}
+     */
+    constructor(definition) {
+        this.#definition = definition;
+        this.parentNames = new Set(definition.parent);
+        this.parents = new Set();
+        this.siblings = new Set();
+        let children = Placetype.#childrenOfParentName.get(definition.name);
+        if (!children) {
+            children = new Set();
+            Placetype.#childrenOfParentName.set(definition.name, children);
+        }
+        this.children = children;
+        // Constructor level indexes...
+        Placetype.#byID.set(definition.id, this);
+        Placetype.#byName.set(definition.name, this);
+        // Next, we need to prepare the parent/child relationships...
+        for (const parentName of definition.parent || []) {
+            // Create the children set if it doesn't exist...
+            let directSiblings = Placetype.#childrenOfParentName.get(parentName);
+            if (!directSiblings) {
+                directSiblings = new Set();
+                Placetype.#childrenOfParentName.set(parentName, directSiblings);
+            }
+            // And add the placetype to the parent's children...
+            directSiblings.add(this);
+            // Once more, for the child names...
+            let childNames = Placetype.#childNamesOfParentName.get(parentName);
+            if (!childNames) {
+                childNames = new Set();
+                Placetype.#childNamesOfParentName.set(parentName, childNames);
+            }
+            // Adding the name to the parent's child names...
+            childNames.add(definition.name);
+            // It's possible that this parent has already been registered...
+            const parent = Placetype.find(parentName);
+            if (parent) {
+                this.parents.add(parent);
+                const siblings = Placetype.#childrenOfParentName.get(parentName);
+                for (const sibling of siblings || []) {
+                    if (sibling === this)
+                        continue;
+                    this.siblings.add(sibling);
+                }
+            }
+        }
+        // Finally, there may be children who have registered before this placetype.
+        // We need to adopt them into our parentage...
+        const orphans = Placetype.#childrenOfParentName.get(definition.name);
+        for (const child of orphans || []) {
+            child.parents.add(this);
+        }
+    }
+    //#endregion
+    //#region Methods
+    toString() {
+        const { name, id, role } = this.#definition;
+        return `Placetype[${name}][${id}][${role}]`;
+    }
+    [Symbol.for("nodejs.util.inspect.custom")]() {
+        return this.toString();
+    }
+}
+//# sourceMappingURL=Placetype.js.map

package/out/resources/whosonfirst/placetypes/Placetype.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Placetype.js","sourceRoot":"","sources":["../../../../resources/whosonfirst/placetypes/Placetype.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,QAAQ,MAAM,WAAW,CAAA;AAChC,OAAO,KAAK,EAAE,MAAM,kBAAkB,CAAA;AACtC,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AACrC,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,4BAA4B,EAAyB,MAAM,cAAc,CAAA;AAClF,OAAO,EACN,4BAA4B,EAI5B,kBAAkB,GAClB,MAAM,iBAAiB,CAAA;AAExB,MAAM,CAAC,MAAM,sBAAsB,GAAG;IACrC,GAAG,EAAE,2DAA2D;IAChE,KAAK,EAAE,aAAa;IACpB,IAAI,EAAE,wBAAwB;CACM,CAAA;AAOrC,MAAM,OAAO,SAAS;IACd,CAAC,MAAM,CAAC,OAAO,CAAC;QACtB,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,CAAA;QACxB,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAA;QACpB,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAA;QACrB,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAA;IACtB,CAAC;IAED,uBAAuB;IAEvB;;;;OAIG;IACH,MAAM,CAAC,KAAK,GAAG,IAAI,GAAG,EAAqB,CAAA;IAE3C;;OAEG;IACH,MAAM,CAAC,OAAO,GAAG,IAAI,GAAG,EAAqB,CAAA;IAE7C;;OAEG;IACH,MAAM,CAAC,qBAAqB,GAAG,IAAI,GAAG,EAA0B,CAAA;IAEhE;;OAEG;IACH,MAAM,CAAC,uBAAuB,GAAG,IAAI,GAAG,EAAuB,CAAA;IAE/D,YAAY;IAEZ,wBAAwB;IAExB,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,SAAS,EAAE,kBAAkB,EAAwB;QAC3E,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,MAAM,4BAA4B,CAAC,sBAAsB,EAAE,kBAAkB,CAAC,CAAA;QAEhH,IAAI,CAAC,MAAM;YAAE,OAAM;QAEnB,MAAM,eAAe,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,EAAE;YACnD,GAAG,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC,QAAQ,EAAE;YAC3C,QAAQ,EAAE,IAAI;SACd,CAAC,CAAA;QAEF,MAAM,aAAa,GAAG,cAAc,CAAC,eAAe,EAAE,SAAS,EAAE,KAAK,EAAE,cAAc,EAAE,EAAE;YACzF,MAAM,iBAAiB,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC,CAAA;YACnE,MAAM,UAAU,GAAwB,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAA;YAErE,SAAS,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;YAE9B,OAAO,UAAU,CAAA;QAClB,CAAC,CAAC,CAAA;QAEF,MAAM,KAAK,CAAC,SAAS,CAAC,aAAa,CAAC,CAAA;IACrC,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,IAAI,GAAG,CAAC,QAAyB,EAAoB,EAAE;QAC7D,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;YAClC,OAAO,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAA;QAC/C,CAAC;QAED,OAAO,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAA;IAC7C,CAAC,CAAA;IAED;;;;OAIG;IACH,MAAM,CAAC,WAAW,GAAG,CAAC,QAAyB,EAAa,EAAE;QAC7D,MAAM,SAAS,GAAG,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QAE1C,IAAI,CAAC,SAAS,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,8BAA8B,QAAQ,EAAE,CAAC,CAAA;QAC1D,CAAC;QAED,OAAO,SAAS,CAAA;IACjB,CAAC,CAAA;IAED;;;;;OAKG;IACH,MAAM,CAAC,aAAa,CAAC,CAAY,EAAE,CAAY;QAC9C,IAAI,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;YACvB,OAAO,kBAAkB,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,kBAAkB,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;QAC/D,CAAC;QAED,IAAI,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;YAAE,OAAO,CAAC,CAAC,CAAA;QAChC,IAAI,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;YAAE,OAAO,CAAC,CAAA;QAE/B,OAAO,CAAC,CAAA;IACT,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,cAAc,CAAC,CAAY,EAAE,CAAY;QAC/C,IAAI,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;YACvB,OAAO,kBAAkB,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,kBAAkB,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;QAC/D,CAAC;QAED,IAAI,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;YAAE,OAAO,CAAC,CAAA;QAC/B,IAAI,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;YAAE,OAAO,CAAC,CAAC,CAAA;QAEhC,OAAO,CAAC,CAAA;IACT,CAAC;IAED,YAAY;IAEZ;;OAEG;IACM,WAAW,CAAqB;IAEzC,oBAAoB;IAEpB;;;;;OAKG;IACH,IAAW,EAAE;QACZ,OAAO,IAAI,CAAC,WAAW,CAAC,EAAE,CAAA;IAC3B,CAAC;IAED;;OAEG;IACH,IAAW,IAAI;QACd,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAA;IAC7B,CAAC;IAED;;;;;OAKG;IACH,IAAW,IAAI;QACd,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAA;IAC7B,CAAC;IAED;;;;OAIG;IACI,WAAW,CAAa;IAE/B;;OAEG;IACI,OAAO,CAAgB;IAE9B;;;;OAIG;IACI,QAAQ,CAAgB;IAE/B;;OAEG;IACI,QAAQ,CAAgB;IAE/B,YAAY;IAEZ,oBAAoB;IAEpB;;OAEG;IACI,QAAQ,CAAC,SAAsC;QACrD,MAAM,QAAQ,GAAG,SAAS,CAAC,qBAAqB,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAE/D,IAAI,CAAC,QAAQ;YAAE,OAAO,KAAK,CAAA;QAE3B,IAAI,SAAS,YAAY,SAAS,EAAE,CAAC;YACpC,OAAO,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;QAC/B,CAAC;QAED,MAAM,KAAK,GAAG,SAAS,CAAC,WAAW,CAAC,SAAS,CAAC,CAAA;QAE9C,OAAO,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;IAC3B,CAAC;IAED,YAAY;IAEZ,yBAAyB;IAEzB;;;;OAIG;IACI,aAAa,CAAC,KAAsC;QAC1D,MAAM,gBAAgB,GAAG,IAAI,GAAG,EAAa,CAAA;QAC7C,MAAM,WAAW,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;QAEjD,IAAI,CAAC,iBAAiB,CAAC,gBAAgB,EAAE,WAAW,CAAC,CAAA;QAErD,OAAO,KAAK,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAA;IAClE,CAAC;IAED,iBAAiB,CAAC,gBAAgC,EAAE,WAAuC;QAC1F,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACnC,IAAI,WAAW,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC;gBAAE,SAAQ;YAE1D,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;YAE5B,MAAM,CAAC,iBAAiB,CAAC,gBAAgB,EAAE,WAAW,CAAC,CAAA;QACxD,CAAC;IACF,CAAC;IAED;;;;OAIG;IACI,YAAY,CAAC,KAAsC;QACzD,MAAM,WAAW,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;QACjD,MAAM,aAAa,GAAgB,EAAE,CAAA;QAErC,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnC,IAAI,WAAW,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC;gBAAE,SAAQ;YAEzD,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC1B,CAAC;QAED,OAAO,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAA;IACnD,CAAC;IAED;;;;OAIG;IACI,WAAW,CAAC,KAAsC;QACxD,MAAM,WAAW,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;QACjD,MAAM,YAAY,GAAgB,EAAE,CAAA;QAEpC,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACnC,IAAI,WAAW,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC;gBAAE,SAAQ;YAE1D,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAC1B,CAAC;QAED,OAAO,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,CAAA;IACnD,CAAC;IAED;;OAEG;IACI,YAAY,CAAC,KAAsC;QACzD,MAAM,WAAW,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;QAEjD,MAAM,aAAa,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QAE/C,IAAI,WAAW,EAAE,CAAC;YACjB,OAAO,aAAa,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAA;QACxE,CAAC;QAED,OAAO,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;YAClC,OAAO,kBAAkB,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,kBAAkB,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;QAC/D,CAAC,CAAC,CAAA;IACH,CAAC;IAED;;;;OAIG;IACI,eAAe,CAAC,KAAsC;QAC5D,MAAM,kBAAkB,GAAG,IAAI,GAAG,EAAa,CAAA;QAC/C,MAAM,WAAW,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;QAEjD,IAAI,CAAC,mBAAmB,CAAC,kBAAkB,EAAE,WAAW,CAAC,CAAA;QAEzD,OAAO,KAAK,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAA;IACpE,CAAC;IAED,mBAAmB,CAAC,kBAAkC,EAAE,WAAuC;QAC9F,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnC,IAAI,WAAW,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC;gBAAE,SAAQ;YAEzD,kBAAkB,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;YAE7B,KAAK,CAAC,mBAAmB,CAAC,kBAAkB,EAAE,WAAW,CAAC,CAAA;QAC3D,CAAC;IACF,CAAC;IAED,YAAY;IAEZ,sBAAsB;IAEtB;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,QAAuD;QACtE,MAAM,UAAU,GAAG,4BAA4B,CAAC,QAAQ,CAAC,CAAA;QACzD,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,UAAU,CAAC,CAAA;QAE3C,OAAO,SAAS,CAAA;IACjB,CAAC;IAED;;;;OAIG;IACH,YAAsB,UAA+B;QACpD,IAAI,CAAC,WAAW,GAAG,UAAU,CAAA;QAC7B,IAAI,CAAC,WAAW,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,CAAA;QAC7C,IAAI,CAAC,OAAO,GAAG,IAAI,GAAG,EAAE,CAAA;QACxB,IAAI,CAAC,QAAQ,GAAG,IAAI,GAAG,EAAE,CAAA;QAEzB,IAAI,QAAQ,GAAG,SAAS,CAAC,qBAAqB,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,CAAA;QAEnE,IAAI,CAAC,QAAQ,EAAE,CAAC;YACf,QAAQ,GAAG,IAAI,GAAG,EAAE,CAAA;YACpB,SAAS,CAAC,qBAAqB,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;QAC/D,CAAC;QAED,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;QAExB,+BAA+B;QAC/B,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,EAAE,IAAI,CAAC,CAAA;QACxC,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;QAE5C,6DAA6D;QAC7D,KAAK,MAAM,UAAU,IAAI,UAAU,CAAC,MAAM,IAAI,EAAE,EAAE,CAAC;YAClD,iDAAiD;YACjD,IAAI,cAAc,GAAG,SAAS,CAAC,qBAAqB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;YAEpE,IAAI,CAAC,cAAc,EAAE,CAAC;gBACrB,cAAc,GAAG,IAAI,GAAG,EAAa,CAAA;gBAErC,SAAS,CAAC,qBAAqB,CAAC,GAAG,CAAC,UAAU,EAAE,cAAc,CAAC,CAAA;YAChE,CAAC;YAED,oDAAoD;YACpD,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;YAExB,oCAAoC;YACpC,IAAI,UAAU,GAAG,SAAS,CAAC,uBAAuB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;YAElE,IAAI,CAAC,UAAU,EAAE,CAAC;gBACjB,UAAU,GAAG,IAAI,GAAG,EAAU,CAAA;gBAE9B,SAAS,CAAC,uBAAuB,CAAC,GAAG,CAAC,UAAU,EAAE,UAAU,CAAC,CAAA;YAC9D,CAAC;YAED,iDAAiD;YACjD,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,CAAA;YAE/B,gEAAgE;YAChE,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;YAEzC,IAAI,MAAM,EAAE,CAAC;gBACZ,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;gBAExB,MAAM,QAAQ,GAAG,SAAS,CAAC,qBAAqB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;gBAEhE,KAAK,MAAM,OAAO,IAAI,QAAQ,IAAI,EAAE,EAAE,CAAC;oBACtC,IAAI,OAAO,KAAK,IAAI;wBAAE,SAAQ;oBAE9B,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;gBAC3B,CAAC;YACF,CAAC;QACF,CAAC;QAED,4EAA4E;QAC5E,8CAA8C;QAC9C,MAAM,OAAO,GAAG,SAAS,CAAC,qBAAqB,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,CAAA;QAEpE,KAAK,MAAM,KAAK,IAAI,OAAO,IAAI,EAAE,EAAE,CAAC;YACnC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;QACxB,CAAC;IACF,CAAC;IAED,YAAY;IAEZ,iBAAiB;IAEV,QAAQ;QACd,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,WAAW,CAAA;QAC3C,OAAO,aAAa,IAAI,KAAK,EAAE,KAAK,IAAI,GAAG,CAAA;IAC5C,CAAC;IAEM,CAAC,MAAM,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC;QAChD,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAA;IACvB,CAAC"}

package/out/resources/whosonfirst/placetypes/admin.d.ts

@@ -0,0 +1,48 @@
+/**
+ * @copyright Sister Software
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+import { Alpha2LanguageCode, type Alpha3bLanguageCode } from "@mailwoman/core/resources/languages";
+import type { Feature, Geometry } from "geojson";
+import type { WhosOnFirstPlacetype } from "./definition.js";
+export interface WOFBaseProperties {
+    "wof:id": number;
+    "wof:name": string;
+    "wof:src": string;
+    "src:geom": string;
+    "wof:placetype": WhosOnFirstPlacetype;
+    "wof:parent_id": number;
+    "wof:superseded_by"?: number[];
+}
+export declare const WOFNameKinds: readonly ["preferred", "variant", "colloquial", "abbr", "short"];
+export type WOFNameKind = (typeof WOFNameKinds)[number];
+export type LanguageSpecificKey = `name:${Alpha3bLanguageCode}_x_${WOFNameKind}`;
+export type WOFLanguageProperties = {
+    [key in LanguageSpecificKey]?: string | string[];
+};
+export type WOFProperties = WOFBaseProperties & WOFLanguageProperties;
+export type WOFFeature = Feature<Geometry, WOFProperties>;
+type LocalizedPlacetypePropMap = Map<WOFNameKind, string>;
+export interface ParsedWOFPlacetype {
+    id: number;
+    parent_id: number;
+    name: string;
+    src: string;
+    placetype: WhosOnFirstPlacetype;
+    localizedPropMap: Map<Alpha3bLanguageCode, LocalizedPlacetypePropMap>;
+}
+export declare function parsePlacetypeSource(key: string): {
+    languageCode: Alpha3bLanguageCode | undefined;
+    nameKind: "preferred" | "variant" | "colloquial" | "abbr" | "short" | undefined;
+};
+export declare function pluckPlacetypeSpec({ "wof:id": id, "wof:name": name, "wof:src": wof_src, "src:geom": geom_src, "wof:parent_id": parent_id, "wof:placetype": placetype, "wof:superseded_by": superseded_by, ...props }: WOFProperties): ParsedWOFPlacetype;
+/**
+ * Given a WhosOnFirst filename, plucks and normalizes the language code into an ISO 639-1 alpha-2
+ * code.
+ *
+ * @deprecated
+ */
+export declare function pluckFileNameLanguageCode(filename: string): Alpha2LanguageCode | null;
+export {};
+//# sourceMappingURL=admin.d.ts.map

package/out/resources/whosonfirst/placetypes/admin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"admin.d.ts","sourceRoot":"","sources":["../../../../resources/whosonfirst/placetypes/admin.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EACN,kBAAkB,EAClB,KAAK,mBAAmB,EAIxB,MAAM,qCAAqC,CAAA;AAC5C,OAAO,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AAChD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAA;AAE3D,MAAM,WAAW,iBAAiB;IACjC,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;IACjB,UAAU,EAAE,MAAM,CAAA;IAClB,eAAe,EAAE,oBAAoB,CAAA;IACrC,eAAe,EAAE,MAAM,CAAA;IACvB,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAA;CAC9B;AAED,eAAO,MAAM,YAAY,kEAAmE,CAAA;AAC5F,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,CAAC,CAAA;AACvD,MAAM,MAAM,mBAAmB,GAAG,QAAQ,mBAAmB,MAAM,WAAW,EAAE,CAAA;AAEhF,MAAM,MAAM,qBAAqB,GAAG;KAClC,GAAG,IAAI,mBAAmB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE;CAChD,CAAA;AAED,MAAM,MAAM,aAAa,GAAG,iBAAiB,GAAG,qBAAqB,CAAA;AAErE,MAAM,MAAM,UAAU,GAAG,OAAO,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAA;AAEzD,KAAK,yBAAyB,GAAG,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,CAAA;AAEzD,MAAM,WAAW,kBAAkB;IAClC,EAAE,EAAE,MAAM,CAAA;IACV,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;IACX,SAAS,EAAE,oBAAoB,CAAA;IAC/B,gBAAgB,EAAE,GAAG,CAAC,mBAAmB,EAAE,yBAAyB,CAAC,CAAA;CACrE;AAID,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,MAAM;;;EAM/C;AAED,wBAAgB,kBAAkB,CAAC,EAClC,QAAQ,EAAE,EAAE,EACZ,UAAU,EAAE,IAAI,EAChB,SAAS,EAAE,OAAO,EAClB,UAAU,EAAE,QAAQ,EACpB,eAAe,EAAE,SAAS,EAC1B,eAAe,EAAE,SAAS,EAC1B,mBAAmB,EAAE,aAAa,EAClC,GAAG,KAAK,EACR,EAAE,aAAa,GAAG,kBAAkB,CAqCpC;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,CAAC,QAAQ,EAAE,MAAM,GAAG,kBAAkB,GAAG,IAAI,CASrF"}

package/out/resources/whosonfirst/placetypes/admin.js

@@ -0,0 +1,61 @@
+/**
+ * @copyright Sister Software
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+import { Alpha2LanguageCode, Alpha3bToAlpha2, isAlpha2LanguageCode, isAlpha3bLanguageCode, } from "@mailwoman/core/resources/languages";
+export const WOFNameKinds = ["preferred", "variant", "colloquial", "abbr", "short"];
+const langPattern = new RegExp(`:([a-z0-9\\-_]{2,3})_x_(${WOFNameKinds.join("|")})`);
+export function parsePlacetypeSource(key) {
+    const [, languageCode, nameKind] = (langPattern.exec(key) ?? []);
+    return { languageCode, nameKind };
+}
+export function pluckPlacetypeSpec({ "wof:id": id, "wof:name": name, "wof:src": wof_src, "src:geom": geom_src, "wof:parent_id": parent_id, "wof:placetype": placetype, "wof:superseded_by": superseded_by, ...props }) {
+    const localizedPropMap = new Map();
+    for (const [key, value] of Object.entries(props)) {
+        if (!value)
+            continue;
+        if (!value || typeof value === "number")
+            continue;
+        const { languageCode, nameKind } = parsePlacetypeSource(key);
+        if (!languageCode || !nameKind)
+            continue;
+        let langMap = localizedPropMap.get(languageCode);
+        if (!langMap) {
+            langMap = new Map();
+            localizedPropMap.set(languageCode, langMap);
+        }
+        const firstValue = Array.isArray(value) ? value[0] : value;
+        if (firstValue) {
+            langMap.set(nameKind, firstValue);
+        }
+    }
+    const src = wof_src || geom_src || "unknown";
+    if (!src)
+        throw new Error(`No source found for placetype ${placetype} with ID ${id}`);
+    return {
+        id,
+        name,
+        src,
+        parent_id,
+        placetype,
+        localizedPropMap,
+    };
+}
+/**
+ * Given a WhosOnFirst filename, plucks and normalizes the language code into an ISO 639-1 alpha-2
+ * code.
+ *
+ * @deprecated
+ */
+export function pluckFileNameLanguageCode(filename) {
+    const [, languageCode] = filename.match(/name:([a-z]{2,3})_\w+\.txt/) || [];
+    if (!languageCode)
+        return null;
+    if (isAlpha2LanguageCode(languageCode))
+        return languageCode;
+    if (isAlpha3bLanguageCode(languageCode))
+        return Alpha3bToAlpha2.get(languageCode) ?? null;
+    return null;
+}
+//# sourceMappingURL=admin.js.map

package/out/resources/whosonfirst/placetypes/admin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"admin.js","sourceRoot":"","sources":["../../../../resources/whosonfirst/placetypes/admin.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EACN,kBAAkB,EAElB,eAAe,EACf,oBAAoB,EACpB,qBAAqB,GACrB,MAAM,qCAAqC,CAAA;AAc5C,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,WAAW,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,CAAU,CAAA;AAuB5F,MAAM,WAAW,GAAG,IAAI,MAAM,CAAC,2BAA2B,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;AAEpF,MAAM,UAAU,oBAAoB,CAAC,GAAW;IAC/C,MAAM,CAAC,EAAE,YAAY,EAAE,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,GAAa,CAAC,IAAI,EAAE,CAExE,CAAA;IAED,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAA;AAClC,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,EAClC,QAAQ,EAAE,EAAE,EACZ,UAAU,EAAE,IAAI,EAChB,SAAS,EAAE,OAAO,EAClB,UAAU,EAAE,QAAQ,EACpB,eAAe,EAAE,SAAS,EAC1B,eAAe,EAAE,SAAS,EAC1B,mBAAmB,EAAE,aAAa,EAClC,GAAG,KAAK,EACO;IACf,MAAM,gBAAgB,GAAG,IAAI,GAAG,EAAkD,CAAA;IAElF,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAClD,IAAI,CAAC,KAAK;YAAE,SAAQ;QACpB,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ;YAAE,SAAQ;QAEjD,MAAM,EAAE,YAAY,EAAE,QAAQ,EAAE,GAAG,oBAAoB,CAAC,GAAG,CAAC,CAAA;QAE5D,IAAI,CAAC,YAAY,IAAI,CAAC,QAAQ;YAAE,SAAQ;QAExC,IAAI,OAAO,GAAG,gBAAgB,CAAC,GAAG,CAAC,YAAY,CAAC,CAAA;QAEhD,IAAI,CAAC,OAAO,EAAE,CAAC;YACd,OAAO,GAAG,IAAI,GAAG,EAAE,CAAA;YACnB,gBAAgB,CAAC,GAAG,CAAC,YAAY,EAAE,OAAO,CAAC,CAAA;QAC5C,CAAC;QAED,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAA;QAE1D,IAAI,UAAU,EAAE,CAAC;YAChB,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAA;QAClC,CAAC;IACF,CAAC;IAED,MAAM,GAAG,GAAG,OAAO,IAAI,QAAQ,IAAI,SAAS,CAAA;IAE5C,IAAI,CAAC,GAAG;QAAE,MAAM,IAAI,KAAK,CAAC,iCAAiC,SAAS,YAAY,EAAE,EAAE,CAAC,CAAA;IAErF,OAAO;QACN,EAAE;QACF,IAAI;QACJ,GAAG;QACH,SAAS;QACT,SAAS;QACT,gBAAgB;KAChB,CAAA;AACF,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,yBAAyB,CAAC,QAAgB;IACzD,MAAM,CAAC,EAAE,YAAY,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,4BAA4B,CAAC,IAAI,EAAE,CAAA;IAE3E,IAAI,CAAC,YAAY;QAAE,OAAO,IAAI,CAAA;IAE9B,IAAI,oBAAoB,CAAC,YAAY,CAAC;QAAE,OAAO,YAAY,CAAA;IAC3D,IAAI,qBAAqB,CAAC,YAAY,CAAC;QAAE,OAAO,eAAe,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,IAAI,CAAA;IAEzF,OAAO,IAAI,CAAA;AACZ,CAAC"}

package/out/resources/whosonfirst/placetypes/definition.d.ts

@@ -0,0 +1,73 @@
+/**
+ * @copyright Sister Software
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+/**
+ * Placetype roles in a hierarchy.
+ */
+export declare const PlacetypeRoles: readonly ["optional", "common", "common_optional"];
+/**
+ * A placetype's role in representing a full hierarchy.
+ */
+export type PlacetypeRole = (typeof PlacetypeRoles)[number];
+/**
+ * The order of placetype roles in a hierarchy.
+ */
+export declare const PlacetypeRoleOrder: Record<PlacetypeRole, number>;
+/**
+ * WhosOnFirst placetypes are a hierarchical classification system for geographic features.
+ *
+ * @see {@link https://github.com/whosonfirst/whosonfirst-placetypes/blob/main/data/placetypes-spec-latest.json | WhosOnFirst Placetypes}
+ */
+export type WhosOnFirstPlacetype = "address" | "arcade" | "borough" | "building" | "campus" | "concourse" | "continent" | "country" | "county" | "custom" | "dependency" | "disputed" | "empire" | "enclosure" | "installation" | "intersection" | "localadmin" | "locality" | "macrocounty" | "macrohood" | "macroregion" | "marinearea" | "marketarea" | "metroarea" | "microhood" | "nation" | "neighbourhood" | "ocean" | "planet" | "postalcode" | "postalregion" | "region" | "timezone" | "venue" | "wing";
+export type PlacetypeLocalizationRecord = {
+    [languageCode: string]: string | undefined;
+};
+export interface PlacetypeDefinition {
+    /**
+     * The id of the placetype, typically generated by Brooklyn Integers.
+     *
+     * @see {@link https://brooklynintegers.com/ Brooklyn Integers}
+     */
+    id: number;
+    /**
+     * The name of the placetype, e.g. "country", "city", "neighborhood"
+     */
+    name: string;
+    /**
+     * The localized names of the placetype.
+     */
+    names: PlacetypeLocalizationRecord;
+    /**
+     * The role of the placetype.
+     */
+    role: PlacetypeRole;
+    /**
+     * The possible parent placetypes of this placetype.
+     *
+     * The parent placetypes are typically Brooklyn Integers.
+     */
+    parent?: string[];
+}
+export declare const WOFPrefix = "wof:";
+export type WOFPrefix = typeof WOFPrefix;
+/**
+ * A raw JSON representation of a placetype definition.
+ *
+ * This identical to the {@linkcode PlacetypeDefinition} however, each key is prefixed with "wof:"
+ */
+export type PlacetypeDefinitionInit = {
+    [K in keyof PlacetypeDefinition as `${WOFPrefix}${K}`]: PlacetypeDefinition[K];
+};
+/**
+ * Convert a prefixed placetype definition to a standard placetype definition.
+ */
+export declare function normalizePlacetypeDefinition(initLike: PlacetypeDefinition | PlacetypeDefinitionInit): PlacetypeDefinition;
+/**
+ * A record of placetype definitions, keyed by Placetype id.
+ */
+export type PlacetypeDefinitionRecord = {
+    [id: number]: Omit<PlacetypeDefinition, "id"> | undefined;
+};
+//# sourceMappingURL=definition.d.ts.map

package/out/resources/whosonfirst/placetypes/definition.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"definition.d.ts","sourceRoot":"","sources":["../../../../resources/whosonfirst/placetypes/definition.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;GAEG;AACH,eAAO,MAAM,cAAc,oDAAqD,CAAA;AAEhF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,CAAC,CAAA;AAE3D;;GAEG;AACH,eAAO,MAAM,kBAAkB,EAA6E,MAAM,CACjH,aAAa,EACb,MAAM,CACN,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAC7B,SAAS,GACT,QAAQ,GACR,SAAS,GACT,UAAU,GACV,QAAQ,GACR,WAAW,GACX,WAAW,GACX,SAAS,GACT,QAAQ,GACR,QAAQ,GACR,YAAY,GACZ,UAAU,GACV,QAAQ,GACR,WAAW,GACX,cAAc,GACd,cAAc,GACd,YAAY,GACZ,UAAU,GACV,aAAa,GACb,WAAW,GACX,aAAa,GACb,YAAY,GACZ,YAAY,GACZ,WAAW,GACX,WAAW,GACX,QAAQ,GACR,eAAe,GACf,OAAO,GACP,QAAQ,GACR,YAAY,GACZ,cAAc,GACd,QAAQ,GACR,UAAU,GACV,OAAO,GACP,MAAM,CAAA;AAET,MAAM,MAAM,2BAA2B,GAAG;IACzC,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAA;CAC1C,CAAA;AAED,MAAM,WAAW,mBAAmB;IACnC;;;;OAIG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,KAAK,EAAE,2BAA2B,CAAA;IAElC;;OAEG;IACH,IAAI,EAAE,aAAa,CAAA;IAEnB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;CACjB;AAED,eAAO,MAAM,SAAS,SAAS,CAAA;AAC/B,MAAM,MAAM,SAAS,GAAG,OAAO,SAAS,CAAA;AAExC;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAAG;KACpC,CAAC,IAAI,MAAM,mBAAmB,IAAI,GAAG,SAAS,GAAG,CAAC,EAAE,GAAG,mBAAmB,CAAC,CAAC,CAAC;CAC9E,CAAA;AAED;;GAEG;AACH,wBAAgB,4BAA4B,CAC3C,QAAQ,EAAE,mBAAmB,GAAG,uBAAuB,GACrD,mBAAmB,CASrB;AAED;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACvC,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC,mBAAmB,EAAE,IAAI,CAAC,GAAG,SAAS,CAAA;CACzD,CAAA"}

package/out/resources/whosonfirst/placetypes/definition.js

@@ -0,0 +1,26 @@
+/**
+ * @copyright Sister Software
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+/**
+ * Placetype roles in a hierarchy.
+ */
+export const PlacetypeRoles = ["optional", "common", "common_optional"];
+/**
+ * The order of placetype roles in a hierarchy.
+ */
+export const PlacetypeRoleOrder = Object.fromEntries(PlacetypeRoles.map((role, index) => [role, index]));
+export const WOFPrefix = "wof:";
+/**
+ * Convert a prefixed placetype definition to a standard placetype definition.
+ */
+export function normalizePlacetypeDefinition(initLike) {
+    const spec = {};
+    for (const [key, value] of Object.entries(initLike)) {
+        const normalizedKey = key.startsWith(WOFPrefix) ? key.slice(WOFPrefix.length) : key;
+        spec[normalizedKey] = value;
+    }
+    return spec;
+}
+//# sourceMappingURL=definition.js.map

package/out/resources/whosonfirst/placetypes/definition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"definition.js","sourceRoot":"","sources":["../../../../resources/whosonfirst/placetypes/definition.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,UAAU,EAAE,QAAQ,EAAE,iBAAiB,CAAU,CAAA;AAOhF;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,MAAM,CAAC,WAAW,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAGtG,CAAA;AA+ED,MAAM,CAAC,MAAM,SAAS,GAAG,MAAM,CAAA;AAY/B;;GAEG;AACH,MAAM,UAAU,4BAA4B,CAC3C,QAAuD;IAEvD,MAAM,IAAI,GAA4B,EAAE,CAAA;IAExC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;QACrD,MAAM,aAAa,GAAG,GAAG,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,CAAA;QACnF,IAAI,CAAC,aAAa,CAAC,GAAG,KAAK,CAAA;IAC5B,CAAC;IAED,OAAO,IAAsC,CAAA;AAC9C,CAAC"}

package/out/resources/whosonfirst/placetypes/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @copyright Sister Software
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+export * from "./admin.js";
+export * from "./definition.js";
+export * from "./mermaid.js";
+export * from "./Placetype.js";
+//# sourceMappingURL=index.d.ts.map

package/out/resources/whosonfirst/placetypes/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../resources/whosonfirst/placetypes/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,cAAc,YAAY,CAAA;AAC1B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,cAAc,CAAA;AAC5B,cAAc,gBAAgB,CAAA"}

package/out/resources/whosonfirst/placetypes/index.js

@@ -0,0 +1,10 @@
+/**
+ * @copyright Sister Software
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+export * from "./admin.js";
+export * from "./definition.js";
+export * from "./mermaid.js";
+export * from "./Placetype.js";
+//# sourceMappingURL=index.js.map

package/out/resources/whosonfirst/placetypes/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../resources/whosonfirst/placetypes/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,cAAc,YAAY,CAAA;AAC1B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,cAAc,CAAA;AAC5B,cAAc,gBAAgB,CAAA"}

package/out/resources/whosonfirst/placetypes/mermaid.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @copyright Sister Software
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+import type { PlacetypeRole } from "./definition.js";
+import { Placetype } from "./Placetype.js";
+/**
+ * Colors for placetype roles.
+ */
+export declare const PlacetypeRoleColor: {
+    readonly common: "#0066cc";
+    readonly common_optional: "#00cc66";
+    readonly optional: "#ffcc00";
+};
+/**
+ * Generate a Mermaid flowchart markup for a placetype and its descendants.
+ */
+export declare function generateMermaidMarkup(placetype: Placetype, roles?: Iterable<PlacetypeRole>): string;
+//# sourceMappingURL=mermaid.d.ts.map

package/out/resources/whosonfirst/placetypes/mermaid.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mermaid.d.ts","sourceRoot":"","sources":["../../../../resources/whosonfirst/placetypes/mermaid.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AACpD,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAE1C;;GAEG;AACH,eAAO,MAAM,kBAAkB;;;;CAImB,CAAA;AAElD;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,SAAS,EAAE,SAAS,EAAE,KAAK,CAAC,EAAE,QAAQ,CAAC,aAAa,CAAC,GAAG,MAAM,CA8BnG"}