@mailwoman/core 2.0.0

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

@@ -0,0 +1,44 @@
+/**
+ * @copyright Sister Software
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+import { Placetype } from "./Placetype.js";
+/**
+ * Colors for placetype roles.
+ */
+export const PlacetypeRoleColor = {
+    common: "#0066cc",
+    common_optional: "#00cc66",
+    optional: "#ffcc00",
+};
+/**
+ * Generate a Mermaid flowchart markup for a placetype and its descendants.
+ */
+export function generateMermaidMarkup(placetype, roles) {
+    const lines = [
+        "---",
+        "config:",
+        "  flowchart:",
+        "    defaultRenderer: elk",
+        "---",
+        "graph TD",
+        "  linkStyle default stroke-width: 5",
+        `  classDef common fill:${PlacetypeRoleColor.common},stroke:#004d99,color:white,font-weight:bold`,
+        `  classDef common_optional fill:${PlacetypeRoleColor.common_optional},stroke:#009933,color:white,font-weight:bold`,
+        `  classDef optional fill:${PlacetypeRoleColor.optional},stroke:#cca300,color:black,font-weight:bold`,
+    ];
+    const descendants = placetype.findDescendants(roles);
+    for (const [idx, descendant] of descendants.entries()) {
+        lines.push(`  ${placetype.name} --> ${descendant.name}:::${descendant.role}`);
+        lines.push(`  linkStyle ${idx} stroke:${PlacetypeRoleColor[descendant.role]}`);
+    }
+    for (const descendant of descendants) {
+        const children = descendant.findChildren(roles);
+        for (const child of children) {
+            lines.push(`  ${descendant.name} --> ${child.name}:::${child.role}`);
+        }
+    }
+    return lines.join("\n");
+}
+//# sourceMappingURL=mermaid.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"mermaid.js","sourceRoot":"","sources":["../../../../resources/whosonfirst/placetypes/mermaid.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAE1C;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG;IACjC,MAAM,EAAE,SAAS;IACjB,eAAe,EAAE,SAAS;IAC1B,QAAQ,EAAE,SAAS;CAC8B,CAAA;AAElD;;GAEG;AACH,MAAM,UAAU,qBAAqB,CAAC,SAAoB,EAAE,KAA+B;IAC1F,MAAM,KAAK,GAAa;QACvB,KAAK;QACL,SAAS;QACT,cAAc;QACd,0BAA0B;QAC1B,KAAK;QACL,UAAU;QACV,qCAAqC;QACrC,0BAA0B,kBAAkB,CAAC,MAAM,8CAA8C;QACjG,mCAAmC,kBAAkB,CAAC,eAAe,8CAA8C;QACnH,4BAA4B,kBAAkB,CAAC,QAAQ,8CAA8C;KACrG,CAAA;IAED,MAAM,WAAW,GAAG,SAAS,CAAC,eAAe,CAAC,KAAK,CAAC,CAAA;IAEpD,KAAK,MAAM,CAAC,GAAG,EAAE,UAAU,CAAC,IAAI,WAAW,CAAC,OAAO,EAAE,EAAE,CAAC;QACvD,KAAK,CAAC,IAAI,CAAC,KAAK,SAAS,CAAC,IAAI,QAAQ,UAAU,CAAC,IAAI,MAAM,UAAU,CAAC,IAAI,EAAE,CAAC,CAAA;QAC7E,KAAK,CAAC,IAAI,CAAC,eAAe,GAAG,WAAW,kBAAkB,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IAC/E,CAAC;IAED,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;QACtC,MAAM,QAAQ,GAAG,UAAU,CAAC,YAAY,CAAC,KAAK,CAAC,CAAA;QAE/C,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE,CAAC;YAC9B,KAAK,CAAC,IAAI,CAAC,KAAK,UAAU,CAAC,IAAI,QAAQ,KAAK,CAAC,IAAI,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC,CAAA;QACrE,CAAC;IACF,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;AACxB,CAAC"}

package/out/solver/BaseSolver.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @copyright Sister Software
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+import type { Classification } from "@mailwoman/core/classification";
+import type { TokenContext } from "@mailwoman/core/tokenization";
+export type SolverContext = Pick<TokenContext, "solutions">;
+export interface Solver {
+    solve(context: SolverContext): void;
+}
+export type SolverConstructor = new () => Solver;
+export interface FilterRelation {
+    object: Classification;
+    direction: FilterRelationDirection;
+    subject: Classification;
+}
+export type FilterRelationDirection = "precedes" | "follows";
+export type FilterRelationRule = [
+    object: Classification,
+    relation: FilterRelationDirection,
+    subject: Classification
+];
+//# sourceMappingURL=BaseSolver.d.ts.map

package/out/solver/BaseSolver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseSolver.d.ts","sourceRoot":"","sources":["../../solver/BaseSolver.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAA;AACpE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAA;AAEhE,MAAM,MAAM,aAAa,GAAG,IAAI,CAAC,YAAY,EAAE,WAAW,CAAC,CAAA;AAE3D,MAAM,WAAW,MAAM;IACtB,KAAK,CAAC,OAAO,EAAE,aAAa,GAAG,IAAI,CAAA;CACnC;AAED,MAAM,MAAM,iBAAiB,GAAG,UAAU,MAAM,CAAA;AAEhD,MAAM,WAAW,cAAc;IAC9B,MAAM,EAAE,cAAc,CAAA;IACtB,SAAS,EAAE,uBAAuB,CAAA;IAClC,OAAO,EAAE,cAAc,CAAA;CACvB;AAED,MAAM,MAAM,uBAAuB,GAAG,UAAU,GAAG,SAAS,CAAA;AAE5D,MAAM,MAAM,kBAAkB,GAAG;IAEhC,MAAM,EAAE,cAAc;IACtB,QAAQ,EAAE,uBAAuB;IACjC,OAAO,EAAE,cAAc;CACvB,CAAA"}

package/out/solver/BaseSolver.js

@@ -0,0 +1,7 @@
+/**
+ * @copyright Sister Software
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+export {};
+//# sourceMappingURL=BaseSolver.js.map

package/out/solver/BaseSolver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseSolver.js","sourceRoot":"","sources":["../../solver/BaseSolver.ts"],"names":[],"mappings":"AAAA;;;;GAIG"}

package/out/solver/HashMapSolver.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @copyright Sister Software
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+import { type Classification } from "@mailwoman/core/classification";
+import { TokenContext } from "@mailwoman/core/tokenization";
+import type { Solver } from "./BaseSolver.js";
+import { Solution } from "./Solution.js";
+export declare abstract class HashMapSolver implements Solver {
+    static MaxMatchesPerClassification: number;
+    abstract solve(context: TokenContext): void;
+    protected generateHashMap(context: TokenContext, includePrivate?: boolean, includeEmpty?: boolean): Map<Classification, Solution>;
+}
+//# sourceMappingURL=HashMapSolver.d.ts.map

package/out/solver/HashMapSolver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"HashMapSolver.d.ts","sourceRoot":"","sources":["../../solver/HashMapSolver.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,KAAK,cAAc,EAA2B,MAAM,gCAAgC,CAAA;AAC7F,OAAO,EAAQ,YAAY,EAAE,MAAM,8BAA8B,CAAA;AACjE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AAGxC,8BAAsB,aAAc,YAAW,MAAM;IACpD,MAAM,CAAC,2BAA2B,SAAI;IAEtC,QAAQ,CAAC,KAAK,CAAC,OAAO,EAAE,YAAY,GAAG,IAAI;IAE3C,SAAS,CAAC,eAAe,CACxB,OAAO,EAAE,YAAY,EACrB,cAAc,UAAQ,EACtB,YAAY,UAAQ,GAClB,GAAG,CAAC,cAAc,EAAE,QAAQ,CAAC;CA8DhC"}

package/out/solver/HashMapSolver.js

@@ -0,0 +1,61 @@
+/**
+ * @copyright Sister Software
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+import { isVisibleClassification } from "@mailwoman/core/classification";
+import { Span, TokenContext } from "@mailwoman/core/tokenization";
+import { Solution } from "./Solution.js";
+import { SolutionMatch } from "./SolutionMatch.js";
+export class HashMapSolver {
+    static MaxMatchesPerClassification = 8;
+    generateHashMap(context, includePrivate = false, includeEmpty = false) {
+        const classificationSolutionMap = new Map();
+        for (const section of context.sections) {
+            // Multi-word phrases
+            const { phrases } = section;
+            for (const phrase of phrases) {
+                for (const match of phrase.classifications.values()) {
+                    if (!includePrivate && !isVisibleClassification(match)) {
+                        continue;
+                    }
+                    let solution = classificationSolutionMap.get(match.classification);
+                    if (!solution) {
+                        solution = new Solution();
+                        classificationSolutionMap.set(match.classification, solution);
+                        if (includeEmpty) {
+                            solution.matches.push(new SolutionMatch(new Span(), match));
+                        }
+                    }
+                    if (solution.matches.length >= HashMapSolver.MaxMatchesPerClassification) {
+                        continue;
+                    }
+                    solution.matches.push(new SolutionMatch(phrase, match));
+                }
+            }
+            // Single-word spans.
+            // TODO: combine with above loop, or refactor to avoid duplication.
+            for (const word of section.children) {
+                for (const classification of word.classifications.values()) {
+                    if (!includePrivate && !isVisibleClassification(classification)) {
+                        continue;
+                    }
+                    let solution = classificationSolutionMap.get(classification.classification);
+                    if (!solution) {
+                        solution = new Solution();
+                        classificationSolutionMap.set(classification.classification, solution);
+                        if (includeEmpty) {
+                            solution.matches.push(new SolutionMatch(new Span(), classification));
+                        }
+                    }
+                    if (solution.matches.length >= HashMapSolver.MaxMatchesPerClassification) {
+                        continue;
+                    }
+                    solution.matches.push(new SolutionMatch(word, classification));
+                }
+            }
+        }
+        return classificationSolutionMap;
+    }
+}
+//# sourceMappingURL=HashMapSolver.js.map

package/out/solver/HashMapSolver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HashMapSolver.js","sourceRoot":"","sources":["../../solver/HashMapSolver.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAuB,uBAAuB,EAAE,MAAM,gCAAgC,CAAA;AAC7F,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAA;AAEjE,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AACxC,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAElD,MAAM,OAAgB,aAAa;IAClC,MAAM,CAAC,2BAA2B,GAAG,CAAC,CAAA;IAI5B,eAAe,CACxB,OAAqB,EACrB,cAAc,GAAG,KAAK,EACtB,YAAY,GAAG,KAAK;QAEpB,MAAM,yBAAyB,GAAG,IAAI,GAAG,EAA4B,CAAA;QAErE,KAAK,MAAM,OAAO,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;YACxC,qBAAqB;YACrB,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAA;YAE3B,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;gBAC9B,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,eAAe,CAAC,MAAM,EAAE,EAAE,CAAC;oBACrD,IAAI,CAAC,cAAc,IAAI,CAAC,uBAAuB,CAAC,KAAK,CAAC,EAAE,CAAC;wBACxD,SAAQ;oBACT,CAAC;oBAED,IAAI,QAAQ,GAAG,yBAAyB,CAAC,GAAG,CAAC,KAAK,CAAC,cAAc,CAAC,CAAA;oBAElE,IAAI,CAAC,QAAQ,EAAE,CAAC;wBACf,QAAQ,GAAG,IAAI,QAAQ,EAAE,CAAA;wBACzB,yBAAyB,CAAC,GAAG,CAAC,KAAK,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAA;wBAE7D,IAAI,YAAY,EAAE,CAAC;4BAClB,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,aAAa,CAAC,IAAI,IAAI,EAAE,EAAE,KAAK,CAAC,CAAC,CAAA;wBAC5D,CAAC;oBACF,CAAC;oBAED,IAAI,QAAQ,CAAC,OAAO,CAAC,MAAM,IAAI,aAAa,CAAC,2BAA2B,EAAE,CAAC;wBAC1E,SAAQ;oBACT,CAAC;oBAED,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,aAAa,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAA;gBACxD,CAAC;YACF,CAAC;YAED,qBAAqB;YACrB,mEAAmE;YACnE,KAAK,MAAM,IAAI,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;gBACrC,KAAK,MAAM,cAAc,IAAI,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,EAAE,CAAC;oBAC5D,IAAI,CAAC,cAAc,IAAI,CAAC,uBAAuB,CAAC,cAAc,CAAC,EAAE,CAAC;wBACjE,SAAQ;oBACT,CAAC;oBAED,IAAI,QAAQ,GAAG,yBAAyB,CAAC,GAAG,CAAC,cAAc,CAAC,cAAc,CAAC,CAAA;oBAE3E,IAAI,CAAC,QAAQ,EAAE,CAAC;wBACf,QAAQ,GAAG,IAAI,QAAQ,EAAE,CAAA;wBACzB,yBAAyB,CAAC,GAAG,CAAC,cAAc,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAA;wBAEtE,IAAI,YAAY,EAAE,CAAC;4BAClB,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,aAAa,CAAC,IAAI,IAAI,EAAE,EAAE,cAAc,CAAC,CAAC,CAAA;wBACrE,CAAC;oBACF,CAAC;oBAED,IAAI,QAAQ,CAAC,OAAO,CAAC,MAAM,IAAI,aAAa,CAAC,2BAA2B,EAAE,CAAC;wBAC1E,SAAQ;oBACT,CAAC;oBAED,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,aAAa,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC,CAAA;gBAC/D,CAAC;YACF,CAAC;QACF,CAAC;QAED,OAAO,yBAAyB,CAAA;IACjC,CAAC"}

package/out/solver/Solution.d.ts

@@ -0,0 +1,69 @@
+/**
+ * @copyright Sister Software
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+import { type Classification, type ClassificationRecord } from "@mailwoman/core/classification";
+import type { TokenContext } from "@mailwoman/core/tokenization";
+import { type SerializedSolutionMatch, SolutionMatch } from "./SolutionMatch.js";
+export interface SerializedSolution {
+    score: number;
+    penalty: number;
+    classifications: ClassificationRecord;
+    formatted_address: string;
+    matches: SerializedSolutionMatch[];
+}
+export interface SolutionCreationOptions {
+    context: TokenContext;
+    matches?: SolutionMatch[];
+}
+export declare class Solution {
+    matches: SolutionMatch[];
+    /**
+     * All classification in the solution.
+     */
+    collectClassifications(): Classification[];
+    /**
+     * Find the first matching pair in the solution by its classification.
+     */
+    find(classification: Classification): SolutionMatch | undefined;
+    /**
+     * Exclude match by classification.
+     */
+    findWithout(classification: Classification): SolutionMatch[];
+    /**
+     * Filter match by classification.
+     */
+    filter(classification: Classification): SolutionMatch[];
+    /**
+     * Absolute score of the solution.
+     */
+    score: number;
+    /**
+     * Penalty for the solution. This is used to penalize solutions that are not complete.
+     */
+    penalty: number;
+    /**
+     * Create a new solution.
+     */
+    constructor(matches?: Iterable<SolutionMatch>);
+    /**
+     * Predicate to determine if this solution covers another solution, i.e. the target solution is a
+     * subset of this solution without any unique ranges.
+     */
+    covers(that: Solution): boolean;
+    /**
+     * Predicate to determine if a solution covers another solution with the same classification.
+     */
+    coversSameClassification(that: Solution): boolean;
+    computeScore(contextCoverage: number): void;
+    /**
+     * @returns JSON representation of a solution
+     */
+    toJSON(): SerializedSolution;
+}
+/**
+ * Compare solutions for sorting, first by score, then by classification.
+ */
+export declare function rankingSolutionsByAreaClassification(a: Solution, b: Solution): number;
+//# sourceMappingURL=Solution.d.ts.map

package/out/solver/Solution.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Solution.d.ts","sourceRoot":"","sources":["../../solver/Solution.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EACN,KAAK,cAAc,EAGnB,KAAK,oBAAoB,EAEzB,MAAM,gCAAgC,CAAA;AAEvC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAA;AAChE,OAAO,EAAE,KAAK,uBAAuB,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAEhF,MAAM,WAAW,kBAAkB;IAClC,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;IACf,eAAe,EAAE,oBAAoB,CAAA;IACrC,iBAAiB,EAAE,MAAM,CAAA;IACzB,OAAO,EAAE,uBAAuB,EAAE,CAAA;CAClC;AAED,MAAM,WAAW,uBAAuB;IACvC,OAAO,EAAE,YAAY,CAAA;IACrB,OAAO,CAAC,EAAE,aAAa,EAAE,CAAA;CACzB;AAED,qBAAa,QAAQ;IACb,OAAO,EAAE,aAAa,EAAE,CAAA;IAE/B;;OAEG;IACI,sBAAsB,IAAI,cAAc,EAAE;IAIjD;;OAEG;IACI,IAAI,CAAC,cAAc,EAAE,cAAc,GAAG,aAAa,GAAG,SAAS;IAItE;;OAEG;IACI,WAAW,CAAC,cAAc,EAAE,cAAc,GAAG,aAAa,EAAE;IAInE;;OAEG;IACI,MAAM,CAAC,cAAc,EAAE,cAAc,GAAG,aAAa,EAAE;IAI9D;;OAEG;IACI,KAAK,SAAI;IAEhB;;OAEG;IACI,OAAO,SAAI;IAElB;;OAEG;gBACS,OAAO,GAAE,QAAQ,CAAC,aAAa,CAAM;IAIjD;;;OAGG;IACH,MAAM,CAAC,IAAI,EAAE,QAAQ,GAAG,OAAO;IAI/B;;OAEG;IACH,wBAAwB,CAAC,IAAI,EAAE,QAAQ,GAAG,OAAO;IAUjD,YAAY,CAAC,eAAe,EAAE,MAAM,GAAG,IAAI;IAoB3C;;OAEG;IACI,MAAM,IAAI,kBAAkB;CA8BnC;AAED;;GAEG;AACH,wBAAgB,oCAAoC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,QAAQ,GAAG,MAAM,CA6BrF"}

package/out/solver/Solution.js

@@ -0,0 +1,137 @@
+/**
+ * @copyright Sister Software
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+import { isVisibleClassification, } from "@mailwoman/core/classification";
+import { formatAddress } from "@mailwoman/core/formatter";
+import { SolutionMatch } from "./SolutionMatch.js";
+export class Solution {
+    matches;
+    /**
+     * All classification in the solution.
+     */
+    collectClassifications() {
+        return this.matches.map((pair) => pair.classification);
+    }
+    /**
+     * Find the first matching pair in the solution by its classification.
+     */
+    find(classification) {
+        return this.matches.find((pair) => pair.classification === classification);
+    }
+    /**
+     * Exclude match by classification.
+     */
+    findWithout(classification) {
+        return this.matches.filter((pair) => pair.classification !== classification);
+    }
+    /**
+     * Filter match by classification.
+     */
+    filter(classification) {
+        return this.matches.filter((pair) => pair.classification === classification);
+    }
+    /**
+     * Absolute score of the solution.
+     */
+    score = 0;
+    /**
+     * Penalty for the solution. This is used to penalize solutions that are not complete.
+     */
+    penalty = 0;
+    /**
+     * Create a new solution.
+     */
+    constructor(matches = []) {
+        this.matches = Array.from(matches);
+    }
+    /**
+     * Predicate to determine if this solution covers another solution, i.e. the target solution is a
+     * subset of this solution without any unique ranges.
+     */
+    covers(that) {
+        return that.matches.every((pair) => this.matches.some(({ span }) => span.covers(pair.span)));
+    }
+    /**
+     * Predicate to determine if a solution covers another solution with the same classification.
+     */
+    coversSameClassification(that) {
+        const result = that.matches.every((pair) => this.matches.some(({ classification, span }) => {
+            return classification === pair.classification && span.covers(pair.span);
+        }));
+        return result;
+    }
+    computeScore(contextCoverage) {
+        const total = {
+            coverage: 0,
+            confidence: 0,
+        };
+        this.matches.forEach((match) => {
+            const { confidence, coverage } = match;
+            // Total characters covered.
+            total.coverage += coverage;
+            // Confidence of match multiplied by characters covered.
+            total.confidence += confidence * coverage;
+        });
+        // The average character score covered divided by the total coverage.
+        this.score = (total.confidence / total.coverage) * (total.coverage / contextCoverage) * (1.0 - this.penalty);
+    }
+    /**
+     * @returns JSON representation of a solution
+     */
+    toJSON() {
+        const { matches, score, penalty } = this;
+        const classificationIDMap = new Map();
+        const classificationConfidences = new Map();
+        for (const { classification, confidence, span } of matches) {
+            if (!isVisibleClassification(classification))
+                continue;
+            let bodies = classificationIDMap.get(classification);
+            if (!bodies) {
+                bodies = [];
+                classificationIDMap.set(classification, bodies);
+            }
+            bodies.push(span.body);
+            classificationConfidences.set(classification, confidence);
+        }
+        const serialized = {
+            score: parseFloat(score.toFixed(2)),
+            penalty: parseFloat(penalty.toFixed(2)),
+            formatted_address: formatAddress(classificationIDMap),
+            classifications: Object.fromEntries(classificationIDMap),
+            matches: matches.map((match) => match.toJSON()),
+        };
+        return serialized;
+    }
+}
+/**
+ * Compare solutions for sorting, first by score, then by classification.
+ */
+export function rankingSolutionsByAreaClassification(a, b) {
+    if (b.score !== a.score) {
+        return b.score - a.score;
+    }
+    // Enforce a slight penalty for administrative ordering.
+    const areaA = a.matches.find(({ span }) => span.is("area"));
+    const areaB = b.matches.find(({ span }) => span.is("area"));
+    const classification = {
+        a: areaA?.classification,
+        b: areaB?.classification,
+    };
+    if (classification.a === "locality")
+        return -1;
+    if (classification.b === "locality")
+        return 1;
+    if (classification.a === "region")
+        return -1;
+    if (classification.b === "region")
+        return 1;
+    if (classification.a === "country")
+        return -1;
+    if (classification.b === "country")
+        return 1;
+    // sort results by score desc
+    return b.score - a.score;
+}
+//# sourceMappingURL=Solution.js.map

package/out/solver/Solution.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Solution.js","sourceRoot":"","sources":["../../solver/Solution.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAKN,uBAAuB,GACvB,MAAM,gCAAgC,CAAA;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAA;AAEzD,OAAO,EAAgC,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAehF,MAAM,OAAO,QAAQ;IACb,OAAO,CAAiB;IAE/B;;OAEG;IACI,sBAAsB;QAC5B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;IACvD,CAAC;IAED;;OAEG;IACI,IAAI,CAAC,cAA8B;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,KAAK,cAAc,CAAC,CAAA;IAC3E,CAAC;IAED;;OAEG;IACI,WAAW,CAAC,cAA8B;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,KAAK,cAAc,CAAC,CAAA;IAC7E,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,cAA8B;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,KAAK,cAAc,CAAC,CAAA;IAC7E,CAAC;IAED;;OAEG;IACI,KAAK,GAAG,CAAC,CAAA;IAEhB;;OAEG;IACI,OAAO,GAAG,CAAC,CAAA;IAElB;;OAEG;IACH,YAAY,UAAmC,EAAE;QAChD,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IACnC,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,IAAc;QACpB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IAC7F,CAAC;IAED;;OAEG;IACH,wBAAwB,CAAC,IAAc;QACtC,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAC1C,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,cAAc,EAAE,IAAI,EAAE,EAAE,EAAE;YAC9C,OAAO,cAAc,KAAK,IAAI,CAAC,cAAc,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACxE,CAAC,CAAC,CACF,CAAA;QAED,OAAO,MAAM,CAAA;IACd,CAAC;IAED,YAAY,CAAC,eAAuB;QACnC,MAAM,KAAK,GAAG;YACb,QAAQ,EAAE,CAAC;YACX,UAAU,EAAE,CAAC;SACb,CAAA;QAED,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC9B,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,GAAG,KAAK,CAAA;YAEtC,4BAA4B;YAC5B,KAAK,CAAC,QAAQ,IAAI,QAAQ,CAAA;YAE1B,wDAAwD;YACxD,KAAK,CAAC,UAAU,IAAI,UAAU,GAAG,QAAQ,CAAA;QAC1C,CAAC,CAAC,CAAA;QAEF,qEAAqE;QACrE,IAAI,CAAC,KAAK,GAAG,CAAC,KAAK,CAAC,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,GAAG,eAAe,CAAC,GAAG,CAAC,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,CAAA;IAC7G,CAAC;IAED;;OAEG;IACI,MAAM;QACZ,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,IAAI,CAAA;QACxC,MAAM,mBAAmB,GAAsB,IAAI,GAAG,EAAE,CAAA;QACxD,MAAM,yBAAyB,GAAgC,IAAI,GAAG,EAAE,CAAA;QAExE,KAAK,MAAM,EAAE,cAAc,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,OAAO,EAAE,CAAC;YAC5D,IAAI,CAAC,uBAAuB,CAAC,cAAc,CAAC;gBAAE,SAAQ;YAEtD,IAAI,MAAM,GAAG,mBAAmB,CAAC,GAAG,CAAC,cAAc,CAAC,CAAA;YAEpD,IAAI,CAAC,MAAM,EAAE,CAAC;gBACb,MAAM,GAAG,EAAE,CAAA;gBACX,mBAAmB,CAAC,GAAG,CAAC,cAAc,EAAE,MAAM,CAAC,CAAA;YAChD,CAAC;YAED,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;YAEtB,yBAAyB,CAAC,GAAG,CAAC,cAAc,EAAE,UAAU,CAAC,CAAA;QAC1D,CAAC;QAED,MAAM,UAAU,GAAuB;YACtC,KAAK,EAAE,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YACnC,OAAO,EAAE,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YACvC,iBAAiB,EAAE,aAAa,CAAC,mBAAmB,CAAC;YACrD,eAAe,EAAE,MAAM,CAAC,WAAW,CAAC,mBAAmB,CAAyB;YAChF,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;SAC/C,CAAA;QAED,OAAO,UAAU,CAAA;IAClB,CAAC;CACD;AAED;;GAEG;AACH,MAAM,UAAU,oCAAoC,CAAC,CAAW,EAAE,CAAW;IAC5E,IAAI,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,KAAK,EAAE,CAAC;QACzB,OAAO,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAA;IACzB,CAAC;IAED,wDAAwD;IAExD,MAAM,KAAK,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAA;IAC3D,MAAM,KAAK,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAA;IAE3D,MAAM,cAAc,GAAG;QACtB,CAAC,EAAE,KAAK,EAAE,cAAc;QACxB,CAAC,EAAE,KAAK,EAAE,cAAc;KACyC,CAAA;IAElE,IAAI,cAAc,CAAC,CAAC,KAAK,UAAU;QAAE,OAAO,CAAC,CAAC,CAAA;IAE9C,IAAI,cAAc,CAAC,CAAC,KAAK,UAAU;QAAE,OAAO,CAAC,CAAA;IAE7C,IAAI,cAAc,CAAC,CAAC,KAAK,QAAQ;QAAE,OAAO,CAAC,CAAC,CAAA;IAE5C,IAAI,cAAc,CAAC,CAAC,KAAK,QAAQ;QAAE,OAAO,CAAC,CAAA;IAE3C,IAAI,cAAc,CAAC,CAAC,KAAK,SAAS;QAAE,OAAO,CAAC,CAAC,CAAA;IAE7C,IAAI,cAAc,CAAC,CAAC,KAAK,SAAS;QAAE,OAAO,CAAC,CAAA;IAE5C,6BAA6B;IAC7B,OAAO,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAA;AACzB,CAAC"}

package/out/solver/SolutionMatch.d.ts

@@ -0,0 +1,69 @@
+/**
+ * @copyright Sister Software
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+import type { ClassificationMatch, ClassificationsMatchInput } from "@mailwoman/core/classification";
+import { Span } from "@mailwoman/core/tokenization";
+export interface SerializedSolutionMatch extends ClassificationMatch {
+    /**
+     * The span of text that was matched.
+     */
+    readonly value: string;
+    /**
+     * The start index of the span.
+     */
+    readonly start: number;
+    /**
+     * The end index of the span.
+     */
+    readonly end: number;
+}
+/**
+ * Comparator for sorting solution matches by their start index.
+ */
+export declare function compareMatchesByStart(a: SolutionMatch, b: SolutionMatch): number;
+export declare class SolutionMatch implements SerializedSolutionMatch {
+    #private;
+    /**
+     * The span of text that was matched.
+     */
+    readonly span: Span;
+    /**
+     * The classification of the match.
+     */
+    get classification(): "adjacent" | "alpha" | "alphanumeric" | "area" | "chain" | "country" | "dependency" | "directional" | "end_token_single_character" | "end_token" | "given_name" | "house_number" | "intersection" | "level_designator" | "level" | "locality" | "middle_initial" | "multistreet" | "numeric" | "ordinal" | "person" | "personal_suffix" | "personal_title" | "place" | "postcode" | "punctuation" | "region" | "road_type" | "start_token" | "stop_word" | "street_name" | "street_prefix" | "street_proper_name" | "street_suffix" | "street" | "surname" | "toponym" | "unit_designator" | "unit" | "unknown" | "venue";
+    /**
+     * The confidence of the match, from 0 to 1.
+     *
+     * This indicates how certain the classifier is that the match is correct.
+     */
+    get confidence(): number;
+    /**
+     * The body of the matched span.
+     */
+    get value(): string;
+    /**
+     * The start index of the span.
+     */
+    get start(): number;
+    /**
+     * The end index of the span.
+     */
+    get end(): number;
+    /**
+     * The languages that the match was classified as.
+     */
+    get languages(): import("../index.js").Displayable<ReadonlySet<import("../index.js").LibPostalLanguageCode | import("../index.js").Alpha3bLanguageCode>> | undefined;
+    /**
+     * The range of the span, i.e. the number of characters covered.
+     */
+    get coverage(): number;
+    constructor(span: Span, classification: ClassificationsMatchInput);
+    toJSON(): SerializedSolutionMatch;
+}
+export declare function calculateRangeScore(match: SolutionMatch): {
+    range: number;
+    confidence: number;
+};
+//# sourceMappingURL=SolutionMatch.d.ts.map

package/out/solver/SolutionMatch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SolutionMatch.d.ts","sourceRoot":"","sources":["../../solver/SolutionMatch.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,mBAAmB,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAA;AACpG,OAAO,EAAE,IAAI,EAAE,MAAM,8BAA8B,CAAA;AAEnD,MAAM,WAAW,uBAAwB,SAAQ,mBAAmB;IACnE;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IAEtB;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IAEtB;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;CACpB;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,CAAC,EAAE,aAAa,EAAE,CAAC,EAAE,aAAa,UAEvE;AAED,qBAAa,aAAc,YAAW,uBAAuB;;IAC5D;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAA;IAOnB;;OAEG;IACH,IAAW,cAAc,8lBAExB;IAED;;;;OAIG;IACH,IAAW,UAAU,WAEpB;IAED;;OAEG;IACH,IAAW,KAAK,WAEf;IAED;;OAEG;IACH,IAAW,KAAK,WAEf;IAED;;OAEG;IACH,IAAW,GAAG,WAEb;IAED;;OAEG;IACH,IAAW,SAAS,wJAEnB;IAED;;OAEG;IACH,IAAW,QAAQ,WAElB;gBAEW,IAAI,EAAE,IAAI,EAAE,cAAc,EAAE,yBAAyB;IAY1D,MAAM,IAAI,uBAAuB;CAQxC;AAED,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,aAAa;;;EAgBvD"}

package/out/solver/SolutionMatch.js

@@ -0,0 +1,101 @@
+/**
+ * @copyright Sister Software
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+import { Span } from "@mailwoman/core/tokenization";
+/**
+ * Comparator for sorting solution matches by their start index.
+ */
+export function compareMatchesByStart(a, b) {
+    return a.span.start - b.span.start;
+}
+export class SolutionMatch {
+    /**
+     * The span of text that was matched.
+     */
+    span;
+    /**
+     * Matched classifications and their respective metadata.
+     */
+    #match;
+    /**
+     * The classification of the match.
+     */
+    get classification() {
+        return this.#match.classification;
+    }
+    /**
+     * The confidence of the match, from 0 to 1.
+     *
+     * This indicates how certain the classifier is that the match is correct.
+     */
+    get confidence() {
+        return this.#match.confidence;
+    }
+    /**
+     * The body of the matched span.
+     */
+    get value() {
+        return this.span.body;
+    }
+    /**
+     * The start index of the span.
+     */
+    get start() {
+        return this.span.start;
+    }
+    /**
+     * The end index of the span.
+     */
+    get end() {
+        return this.span.end;
+    }
+    /**
+     * The languages that the match was classified as.
+     */
+    get languages() {
+        return this.#match.languages;
+    }
+    /**
+     * The range of the span, i.e. the number of characters covered.
+     */
+    get coverage() {
+        return this.span.coverage;
+    }
+    constructor(span, classification) {
+        this.span = span;
+        this.#match =
+            typeof classification === "string"
+                ? {
+                    classification,
+                    confidence: 1,
+                }
+                : classification;
+    }
+    toJSON() {
+        return {
+            ...this.#match,
+            value: this.span.body,
+            start: this.span.start,
+            end: this.span.end,
+        };
+    }
+}
+export function calculateRangeScore(match) {
+    let range;
+    if (match.span.children.size) {
+        range = Iterator
+            // ---
+            .from(match.span.children)
+            .reduce((sum, child) => sum + (child.end - child.start), 0);
+    }
+    else {
+        range = match.end - match.start;
+    }
+    return {
+        range,
+        confidence: match.confidence * range,
+    };
+}
+//# sourceMappingURL=SolutionMatch.js.map

package/out/solver/SolutionMatch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SolutionMatch.js","sourceRoot":"","sources":["../../solver/SolutionMatch.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAE,IAAI,EAAE,MAAM,8BAA8B,CAAA;AAmBnD;;GAEG;AACH,MAAM,UAAU,qBAAqB,CAAC,CAAgB,EAAE,CAAgB;IACvE,OAAO,CAAC,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,IAAI,CAAC,KAAK,CAAA;AACnC,CAAC;AAED,MAAM,OAAO,aAAa;IACzB;;OAEG;IACM,IAAI,CAAM;IAEnB;;OAEG;IACM,MAAM,CAAqB;IAEpC;;OAEG;IACH,IAAW,cAAc;QACxB,OAAO,IAAI,CAAC,MAAM,CAAC,cAAc,CAAA;IAClC,CAAC;IAED;;;;OAIG;IACH,IAAW,UAAU;QACpB,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,CAAA;IAC9B,CAAC;IAED;;OAEG;IACH,IAAW,KAAK;QACf,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAA;IACtB,CAAC;IAED;;OAEG;IACH,IAAW,KAAK;QACf,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAA;IACvB,CAAC;IAED;;OAEG;IACH,IAAW,GAAG;QACb,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAA;IACrB,CAAC;IAED;;OAEG;IACH,IAAW,SAAS;QACnB,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAA;IAC7B,CAAC;IAED;;OAEG;IACH,IAAW,QAAQ;QAClB,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAA;IAC1B,CAAC;IAED,YAAY,IAAU,EAAE,cAAyC;QAChE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAEhB,IAAI,CAAC,MAAM;YACV,OAAO,cAAc,KAAK,QAAQ;gBACjC,CAAC,CAAC;oBACA,cAAc;oBACd,UAAU,EAAE,CAAC;iBACb;gBACF,CAAC,CAAC,cAAc,CAAA;IACnB,CAAC;IAEM,MAAM;QACZ,OAAO;YACN,GAAG,IAAI,CAAC,MAAM;YACd,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI;YACrB,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK;YACtB,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG;SAClB,CAAA;IACF,CAAC;CACD;AAED,MAAM,UAAU,mBAAmB,CAAC,KAAoB;IACvD,IAAI,KAAa,CAAA;IAEjB,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;QAC9B,KAAK,GAAG,QAAQ;YACf,MAAM;aACL,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC;aACzB,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,GAAG,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAA;IAC7D,CAAC;SAAM,CAAC;QACP,KAAK,GAAG,KAAK,CAAC,GAAG,GAAG,KAAK,CAAC,KAAK,CAAA;IAChC,CAAC;IAED,OAAO;QACN,KAAK;QACL,UAAU,EAAE,KAAK,CAAC,UAAU,GAAG,KAAK;KACpC,CAAA;AACF,CAAC"}

package/out/solver/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @copyright Sister Software
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+export * from "./BaseSolver.js";
+export * from "./HashMapSolver.js";
+export * from "./mask.js";
+export * from "./Solution.js";
+export * from "./SolutionMatch.js";
+//# sourceMappingURL=index.d.ts.map

package/out/solver/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../solver/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,cAAc,iBAAiB,CAAA;AAC/B,cAAc,oBAAoB,CAAA;AAClC,cAAc,WAAW,CAAA;AACzB,cAAc,eAAe,CAAA;AAC7B,cAAc,oBAAoB,CAAA"}

package/out/solver/index.js

@@ -0,0 +1,11 @@
+/**
+ * @copyright Sister Software
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+export * from "./BaseSolver.js";
+export * from "./HashMapSolver.js";
+export * from "./mask.js";
+export * from "./Solution.js";
+export * from "./SolutionMatch.js";
+//# sourceMappingURL=index.js.map

package/out/solver/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../solver/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,cAAc,iBAAiB,CAAA;AAC/B,cAAc,oBAAoB,CAAA;AAClC,cAAc,WAAW,CAAA;AACzB,cAAc,eAAe,CAAA;AAC7B,cAAc,oBAAoB,CAAA"}

package/out/solver/mask.d.ts

@@ -0,0 +1,27 @@
+/**
+ * @copyright Sister Software
+ * @license AGPL-3.0
+ * @author Teffen Ellis, et al.
+ */
+import { TokenContext } from "@mailwoman/core/tokenization";
+import { SolutionMatch } from "./SolutionMatch.js";
+type MaskCode = "V" | "N" | "S" | "P" | "L" | "U" | "A";
+/**
+ * Mapping of classification labels to mask codes.
+ */
+export declare const ClassificationMaskCodeMap: Map<"adjacent" | "alpha" | "alphanumeric" | "area" | "chain" | "country" | "dependency" | "directional" | "end_token_single_character" | "end_token" | "given_name" | "house_number" | "intersection" | "level_designator" | "level" | "locality" | "middle_initial" | "multistreet" | "numeric" | "ordinal" | "person" | "personal_suffix" | "personal_title" | "place" | "postcode" | "punctuation" | "region" | "road_type" | "start_token" | "stop_word" | "street_name" | "street_prefix" | "street_proper_name" | "street_suffix" | "street" | "surname" | "toponym" | "unit_designator" | "unit" | "unknown" | "venue" | "fallback", MaskCode>;
+/**
+ * Mask which shows the areas covered by different types of classification
+ *
+ * - `N` housenumber
+ * - `S` street
+ * - `P` postcode
+ * - `A` administrative
+ * - `L` Level
+ * - `U` unit
+ *
+ * @returns Mask of the input for this solution
+ */
+export declare function createMask(context: TokenContext, matches: Iterable<SolutionMatch>): string;
+export {};
+//# sourceMappingURL=mask.d.ts.map

package/out/solver/mask.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mask.d.ts","sourceRoot":"","sources":["../../solver/mask.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAA;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAElD,KAAK,QAAQ,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAA;AAEvD;;GAEG;AACH,eAAO,MAAM,yBAAyB,unBAUpC,CAAA;AAEF;;;;;;;;;;;GAWG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,QAAQ,CAAC,aAAa,CAAC,GAAG,MAAM,CAsB1F"}