mailwoman 2.0.0 → 2.0.3

package/package.json

@@ -1,90 +1,90 @@
 {
- "name": "mailwoman",
- "version": "2.0.0",
- "description": "Utilities for working with contacts for email, phone, and postal addresses.",
- "license": "AGPL-3.0-only",
- "contributors": [
-  {
-   "name": "Teffen Ellis",
-   "email": "teffen@sister.software"
+  "name": "mailwoman",
+  "version": "2.0.3",
+  "description": "Utilities for working with contacts for email, phone, and postal addresses.",
+  "license": "AGPL-3.0-only",
+  "contributors": [
+    {
+      "name": "Teffen Ellis",
+      "email": "teffen@sister.software"
+    },
+    {
+      "name": "Pelias Contributors"
+    }
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/sister-software/mailwoman.git",
+    "directory": "mailwoman"
   },
-  {
-   "name": "Pelias Contributors"
-  }
- ],
- "repository": {
-  "type": "git",
-  "url": "https://github.com/sister-software/mailwoman.git",
-  "directory": "mailwoman"
- },
- "bugs": {
-  "url": "https://github.com/sister-software/mailwoman/issues"
- },
- "homepage": "https://github.com/sister-software/mailwoman",
- "type": "module",
- "exports": {
-  "./package.json": "./package.json",
-  ".": "./out/index.js",
-  "./server": "./out/server/index.js",
-  "./sdk/test": "./out/sdk/test/index.js",
-  "./sdk/repo": "./out/sdk/repo.js",
-  "./sdk/cli": "./out/sdk/cli.js"
- },
- "dependencies": {
-  "@fragaria/address-formatter": "^6.3.0",
-  "@mailwoman/classifiers": "workspace:*",
-  "@mailwoman/core": "workspace:*",
-  "better-sqlite3": "^11.5.0",
-  "change-case": "^5.4.4",
-  "express": "^5.0.1",
-  "geojson": "^0.5.0",
-  "ioredis": "^5.4.1",
-  "pastel": "^4.0.1",
-  "path-ts": "^1.0.5",
-  "piscina": "^4.7.0",
-  "pluralize": "^8.0.0",
-  "regenerate": "^1.4.2",
-  "spliterator": "^2.0.0",
-  "zod": "^4.1.12"
- },
- "peerDependencies": {
-  "@inkjs/ui": "^2.0.0",
-  "core-js": "^3.49.0",
-  "ink": "^7.0.3",
-  "react": "^19.2.6"
- },
- "files": [
-  "!out/test/**/*",
-  "!**/*.ts",
-  "out/**/*.js",
-  "out/**/*.js.map",
-  "out/**/*.d.ts",
-  "out/**/*.d.ts.map",
-  "out/**/*.json"
- ],
- "keywords": [
-  "address",
-  "parser",
-  "usps",
-  "postal",
-  "pelias"
- ],
- "bin": "./out/cli.js",
- "peerDependenciesMeta": {
-  "@inkjs/ui": {
-   "optional": true
+  "bugs": {
+    "url": "https://github.com/sister-software/mailwoman/issues"
+  },
+  "homepage": "https://github.com/sister-software/mailwoman",
+  "type": "module",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": "./out/index.js",
+    "./server": "./out/server/index.js",
+    "./sdk/test": "./out/sdk/test/index.js",
+    "./sdk/repo": "./out/sdk/repo.js",
+    "./sdk/cli": "./out/sdk/cli.js"
+  },
+  "dependencies": {
+    "@fragaria/address-formatter": "^6.3.0",
+    "@mailwoman/classifiers": "2.0.3",
+    "@mailwoman/core": "2.0.3",
+    "better-sqlite3": "^11.5.0",
+    "change-case": "^5.4.4",
+    "express": "^5.0.1",
+    "geojson": "^0.5.0",
+    "ioredis": "^5.4.1",
+    "pastel": "^4.0.1",
+    "path-ts": "^1.0.5",
+    "piscina": "^4.7.0",
+    "pluralize": "^8.0.0",
+    "regenerate": "^1.4.2",
+    "spliterator": "^2.0.0",
+    "zod": "^4.1.12"
   },
-  "core-js": {
-   "optional": true
+  "peerDependencies": {
+    "@inkjs/ui": "^2.0.0",
+    "core-js": "^3.49.0",
+    "ink": "^7.0.3",
+    "react": "^19.2.6"
   },
-  "ink": {
-   "optional": true
+  "files": [
+    "!out/test/**/*",
+    "!**/*.ts",
+    "out/**/*.js",
+    "out/**/*.js.map",
+    "out/**/*.d.ts",
+    "out/**/*.d.ts.map",
+    "out/**/*.json"
+  ],
+  "keywords": [
+    "address",
+    "parser",
+    "usps",
+    "postal",
+    "pelias"
+  ],
+  "bin": "./out/cli.js",
+  "peerDependenciesMeta": {
+    "@inkjs/ui": {
+      "optional": true
+    },
+    "core-js": {
+      "optional": true
+    },
+    "ink": {
+      "optional": true
+    },
+    "react": {
+      "optional": true
+    }
   },
-  "react": {
-   "optional": true
+  "publishConfig": {
+    "access": "public"
   }
- },
- "publishConfig": {
-  "access": "public"
- }
-}
+}

package/out/cli.d.ts

@@ -1,8 +0,0 @@
-#!/usr/bin/env node
-/**
- * @copyright Sister Software
- * @license AGPL-3.0
- * @author Teffen Ellis, et al.
- */
-export {};
-//# sourceMappingURL=cli.d.ts.map

package/out/commands/corpus/build.d.ts

@@ -1,28 +0,0 @@
-/**
- * @copyright Sister Software
- * @license AGPL-3.0
- * @author Teffen Ellis, et al.
- *
- *   `mailwoman corpus build --version 0.1.0 --output /data/corpus/versioned/ --inputs '{ "wof-admin":
- *   "/data/wof/admin.db", "wof-postalcode": "/data/wof/post.db" }'`
- *
- *   End-to-end corpus build. Drives every registered adapter (or the filtered subset) per `--inputs`,
- *   runs synthesis + alignment, computes the locality-holdout split, and writes the final JSONL
- *   shards + per-stage manifests under `<output>/corpus-v<version>/`.
- *
- *   Adapters whose id is missing from `--inputs` are skipped (and noted in the manifest); this is how
- *   the CLI handles partial builds during development.
- */
-import zod from "zod";
-import type { CommandComponent } from "../../sdk/cli.js";
-declare const BuildConfigSchema: zod.ZodObject<{
-    corpusVersion: zod.ZodDefault<zod.ZodString>;
-    output: zod.ZodString;
-    inputs: zod.ZodString;
-    synthesize: zod.ZodDefault<zod.ZodOptional<zod.z.ZodCoercedBoolean<unknown>>>;
-    rowsPerShard: zod.ZodDefault<zod.ZodOptional<zod.z.ZodCoercedNumber<unknown>>>;
-}, zod.z.core.$strip>;
-export { BuildConfigSchema as options };
-declare const CorpusBuild: CommandComponent<typeof BuildConfigSchema>;
-export default CorpusBuild;
-//# sourceMappingURL=build.d.ts.map

package/out/commands/corpus/list.d.ts

@@ -1,19 +0,0 @@
-/**
- * @copyright Sister Software
- * @license AGPL-3.0
- * @author Teffen Ellis, et al.
- *
- *   `mailwoman corpus list` — print every adapter known to the default registry, one per line.
- *
- *   Used by humans and by scripts that want to fan out a build over adapters. Prints nothing (zero
- *   lines + exit 0) when no adapter has been registered yet; that's the expected state during early
- *   Phase 1 while adapters are still being authored.
- */
-/**
- * Per-line output is rendered as a single `Text` node so Ink does not column-wrap the adapter id
- * when the host stdout is non-TTY (CI, spawned tests). The list is meant to be grep-friendly, not
- * pretty.
- */
-declare const CorpusList: () => import("react/jsx-runtime").JSX.Element;
-export default CorpusList;
-//# sourceMappingURL=list.d.ts.map

package/out/commands/corpus/run.d.ts

@@ -1,26 +0,0 @@
-/**
- * @copyright Sister Software
- * @license AGPL-3.0
- * @author Teffen Ellis, et al.
- *
- *   `mailwoman corpus run <adapter-id> --input <path> --output <dir> [--country XX] [--limit N]`
- *
- *   CLI shim around `runAdapter` from `@mailwoman/corpus`. Resolves `<adapter-id>` against the
- *   default registry; refuses with a clear, non-zero exit if the id isn't known (and lists the
- *   registered ids). On success, prints a one-line summary and the path to the manifest file.
- */
-import zod from "zod";
-import type { CommandComponent } from "../../sdk/cli.js";
-declare const ArgumentsSchema: zod.ZodArray<zod.ZodString>;
-declare const RunConfigSchema: zod.ZodObject<{
-    input: zod.ZodString;
-    output: zod.ZodString;
-    country: zod.ZodOptional<zod.ZodString>;
-    limit: zod.ZodOptional<zod.z.ZodCoercedNumber<unknown>>;
-    corpusVersion: zod.ZodDefault<zod.ZodOptional<zod.ZodString>>;
-    progressEvery: zod.ZodDefault<zod.ZodOptional<zod.z.ZodCoercedNumber<unknown>>>;
-}, zod.z.core.$strip>;
-export { ArgumentsSchema as args, RunConfigSchema as options };
-declare const CorpusRun: CommandComponent<typeof RunConfigSchema, typeof ArgumentsSchema>;
-export default CorpusRun;
-//# sourceMappingURL=run.d.ts.map

package/out/commands/debug.d.ts

@@ -1,15 +0,0 @@
-/**
- * @copyright Sister Software
- * @license AGPL-3.0
- * @author Teffen Ellis, et al.
- */
-import zod from "zod";
-import type { CommandComponent } from "../sdk/cli.js";
-declare const ArgumentsSchema: zod.ZodArray<zod.ZodString>;
-declare const DebugConfigSchema: zod.ZodObject<{
-    locale: zod.ZodOptional<zod.ZodString>;
-}, zod.z.core.$strip>;
-export { ArgumentsSchema as args, DebugConfigSchema as options };
-declare const DebugCommand: CommandComponent<typeof DebugConfigSchema, typeof ArgumentsSchema>;
-export default DebugCommand;
-//# sourceMappingURL=debug.d.ts.map

package/out/commands/parse.d.ts

@@ -1,25 +0,0 @@
-/**
- * @copyright Sister Software
- * @license AGPL-3.0
- * @author Teffen Ellis, et al.
- */
-import zod from "zod";
-import type { CommandComponent } from "../sdk/cli.js";
-declare const ArgumentsSchema: zod.ZodArray<zod.ZodString>;
-export { ArgumentsSchema as args, ParseConfigSchema as options };
-declare const ParseConfigSchema: zod.ZodObject<{
-    debug: zod.ZodDefault<zod.ZodOptional<zod.ZodBoolean>>;
-    locale: zod.ZodDefault<zod.ZodOptional<zod.ZodString>>;
-    neural: zod.ZodDefault<zod.ZodOptional<zod.ZodBoolean>>;
-    format: zod.ZodDefault<zod.ZodOptional<zod.ZodEnum<{
-        tuple: "tuple";
-        json: "json";
-        xml: "xml";
-    }>>>;
-    model: zod.ZodOptional<zod.ZodString>;
-    tokenizer: zod.ZodOptional<zod.ZodString>;
-    policy: zod.ZodOptional<zod.ZodArray<zod.ZodString>>;
-}, zod.z.core.$strip>;
-declare const ParseCommand: CommandComponent<typeof ParseConfigSchema, typeof ArgumentsSchema>;
-export default ParseCommand;
-//# sourceMappingURL=parse.d.ts.map

package/out/commands/serve.d.ts

@@ -1,19 +0,0 @@
-/**
- * @copyright Sister Software
- * @license AGPL-3.0
- * @author Teffen Ellis, et al.
- */
-import zod from "zod";
-import type { CommandComponent } from "../sdk/cli.js";
-export declare const options: zod.ZodObject<{
-    port: zod.ZodDefault<zod.ZodOptional<zod.ZodNumber>>;
-    host: zod.ZodDefault<zod.ZodOptional<zod.ZodString>>;
-    cpus: zod.ZodOptional<zod.ZodNumber>;
-}, zod.z.core.$strip>;
-declare const ParseCommand: CommandComponent<zod.ZodObject<{
-    port: zod.ZodDefault<zod.ZodOptional<zod.ZodNumber>>;
-    host: zod.ZodDefault<zod.ZodOptional<zod.ZodString>>;
-    cpus: zod.ZodOptional<zod.ZodNumber>;
-}, zod.z.core.$strip>>;
-export default ParseCommand;
-//# sourceMappingURL=serve.d.ts.map

package/out/commands/wof/prepare/index.d.ts

@@ -1,12 +0,0 @@
-/**
- * @copyright Sister Software
- * @license AGPL-3.0
- * @author Teffen Ellis, et al.
- */
-import zod from "zod";
-import type { PositionalCommandComponent } from "../../../sdk/cli.js";
-declare const ArgumentsSchema: zod.ZodArray<zod.ZodString>;
-export { ArgumentsSchema as args };
-declare const WOFPrepare: PositionalCommandComponent<typeof ArgumentsSchema>;
-export default WOFPrepare;
-//# sourceMappingURL=index.d.ts.map

package/out/commands/wof/sync.d.ts

@@ -1,24 +0,0 @@
-/**
- * @copyright Sister Software
- * @license AGPL-3.0
- * @author Teffen Ellis, et al.
- */
-import zod from "zod";
-import type { CommandComponent } from "../../sdk/cli.js";
-declare const ArgumentsSchema: zod.ZodArray<zod.ZodString>;
-/**
- * `--repos` is a comma-separated allow-list of repo names. When set, the discovery step still
- * queries `gh repo list` for `whosonfirst-data/*` but filters down to only repos whose `name` is
- * present in the list. When absent, every non-archived repo in the org is synced (the original
- * behavior).
- *
- * The corpus build only needs a small subset (4 repos for US+FR admin+postalcode + the placetypes
- * codex). Cloning all ~100 whosonfirst-data repos is otherwise ~2.9 GB of git for no reason.
- */
-declare const OptionsSchema: zod.ZodObject<{
-    repos: zod.ZodOptional<zod.ZodString>;
-}, zod.z.core.$strip>;
-export { ArgumentsSchema as args, OptionsSchema as options };
-declare const WOFSync: CommandComponent<typeof OptionsSchema, typeof ArgumentsSchema>;
-export default WOFSync;
-//# sourceMappingURL=sync.d.ts.map

package/out/index.d.ts

@@ -1,9 +0,0 @@
-/**
- * @copyright Sister Software
- * @license AGPL-3.0
- * @author Teffen Ellis, et al.
- */
-export * from "@mailwoman/core";
-export * from "@mailwoman/classifiers";
-export * from "./utils/index.js";
-//# sourceMappingURL=index.d.ts.map

package/out/sdk/cli.d.ts

@@ -1,28 +0,0 @@
-/**
- * @copyright Sister Software
- * @license AGPL-3.0
- * @author Teffen Ellis, et al.
- */
-import type * as zod from "zod";
-/**
- * Type-helper to infer the positional arguments of a command.
- */
-export type PositionalArguments<T extends zod.ZodTypeAny> = {
-    args: zod.infer<T>;
-};
-/**
- * React component for a command with positional arguments.
- */
-export type PositionalCommandComponent<T extends zod.ZodTypeAny> = React.FC<PositionalArguments<T>>;
-/**
- * Type-helper to infer the options of a command.
- */
-export type CommandProps<OptionProps extends zod.ZodObject, PositionalProps extends zod.ZodTypeAny | unknown = unknown> = {
-    options: zod.infer<OptionProps>;
-    args: PositionalProps extends zod.ZodTypeAny ? zod.infer<PositionalProps> : unknown[];
-};
-/**
- * React component for a command with options.
- */
-export type CommandComponent<OptionProps extends zod.ZodObject, PositionalProps extends zod.ZodTypeAny | unknown = unknown> = React.FC<CommandProps<OptionProps, PositionalProps>>;
-//# sourceMappingURL=cli.d.ts.map

package/out/sdk/test/index.d.ts

@@ -1,41 +0,0 @@
-/**
- * @copyright Sister Software
- * @license AGPL-3.0
- * @author Teffen Ellis, et al.
- */
-import { type Classification, type Classifier, type LibPostalLanguageCode } from "@mailwoman/core";
-import { type ClassificationRecord } from "mailwoman";
-/**
- * Global test parser instance.
- */
-export declare const parser: import("mailwoman").AddressParser;
-export declare function assert(input: string, ...expectedClassifications: ClassificationRecord[]): void;
-/**
- * Assert that two items are deeply equal after JSON serialization.
- *
- * @param actual - The actual item.
- * @param expected - The expected item.
- * @param message - The message to display.
- */
-export declare function assertDeepSerialized(actual: unknown, expected: unknown, message?: string): void;
-/**
- * Given two iterables, zip them together into a single iterable which yields pairs of elements.
- *
- * If one iterable is longer than the other, the shorter iterable will be padded with `undefined`.
- */
-export declare function zip<T, U>(a: Iterable<T>, b: Iterable<U>): Generator<[a: T | undefined, b: U | undefined, idx: number]>;
-/**
- * Given two iterables, assert that they are congruent, i.e. that they have the same elements in the
- * same order.
- */
-export declare function assertCongruent<Item>(actualItemIterators: Iterable<Iterable<Item>>, ...expectedItemIterators: Iterable<Item>[]): void;
-export type ExpectedClassificationEntry = [
-    input: string,
-    Iterable<LibPostalLanguageCode>,
-    expectPositiveMatch?: boolean
-];
-/**
- * Assert that a classifier correctly classifies a set of inputs.
- */
-export declare function assertClassification(classifier: Classifier, classificationTarget: Classification, expectations: ExpectedClassificationEntry[]): void;
-//# sourceMappingURL=index.d.ts.map

package/out/server/AddressRouter.d.ts

@@ -1,20 +0,0 @@
-/**
- * @copyright Sister Software
- * @license AGPL-3.0
- * @author Teffen Ellis, et al.
- */
-import { type SerializedSolution } from "mailwoman";
-/**
- * Response from the address parser endpoint.
- */
-export interface ParseAddressResponse {
-    input: {
-        body: string;
-        start: number;
-        end: number;
-    };
-    solutions: SerializedSolution[];
-    debug?: string;
-}
-export declare const AddressRouter: import("express-serve-static-core").Router;
-//# sourceMappingURL=AddressRouter.d.ts.map

package/out/server/index.d.ts

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

package/out/server/static/main.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=main.d.ts.map

package/out/utils/DebugOutputBuilder.d.ts

@@ -1,11 +0,0 @@
-/**
- * @copyright Sister Software
- * @license AGPL-3.0
- * @author Teffen Ellis, et al.
- */
-import { type VerboseParseResult } from "@mailwoman/core";
-/**
- * Create a diagnostic report for a parser result.
- */
-export declare function createDiagnosticReport({ solutions, context, measures }: VerboseParseResult): string;
-//# sourceMappingURL=DebugOutputBuilder.d.ts.map

package/out/utils/index.d.ts

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

package/out/utils/parser.d.ts

@@ -1,13 +0,0 @@
-/**
- * @copyright Sister Software
- * @license AGPL-3.0
- * @author Teffen Ellis, et al.
- */
-import { AddressParser, type AddressParserOptions } from "@mailwoman/core/parser";
-/**
- * Create an address parser with the given options.
- *
- * This is the primary entry point for the Mailwoman library.
- */
-export declare function createAddressParser({ classifiers, solvers, ...options }?: AddressParserOptions): AddressParser;
-//# sourceMappingURL=parser.d.ts.map