@crvouga/mockingbird-service-google-maps 1.0.0 → 1.1.1

package/dist/server.d.ts

@@ -170,82 +170,6 @@ type FaultRegistry$1 = {
     take(candidate: FaultCandidate$1): Promise<FaultHit$1[]>;
 };
 
-/** One handled request, as the structured log sees it. */
-type RequestLog$1 = {
-    service: string;
-    namespace: string;
-    operationId: string | undefined;
-    method: string;
-    path: string;
-    status: number;
-    durationMs: number;
-    /** True when the path matched no operation in the contract. */
-    unmatched: boolean;
-    /** Set when a fault rule produced the response. */
-    faultId?: string;
-    /** Resource ids the handler touched (`userId`, `orderId`, …), when the service reports them. */
-    ids?: Record<string, string>;
-    /** Set when the service created a resource the request referred to but that did not exist. */
-    adopted?: boolean;
-};
-type MetricsReport$1 = {
-    requests: number;
-    /** Counts keyed `<operationId> <status>`. */
-    byOperation: Record<string, number>;
-    /**
-     * Paths that matched no operation, most frequent first.
-     *
-     * This is the early-warning signal: a consumer calling something the mock does
-     * not implement shows up here as a count, before it fails a suite as a 404.
-     */
-    unmatched: {
-        method: string;
-        path: string;
-        count: number;
-    }[];
-    faults: number;
-    totalDurationMs: number;
-};
-type Metrics$1 = {
-    record(entry: RequestLog$1): void;
-    report(): MetricsReport$1;
-    reset(): void;
-};
-
-/** One journal entry: a request log stamped with when (on the mock clock) it was handled. */
-type JournalEntry$1 = RequestLog$1 & {
-    at: string;
-};
-type JournalQuery$1 = {
-    /** Only this namespace. Omit for every namespace, oldest first across all of them. */
-    namespace?: string;
-    operationId?: string;
-    status?: number;
-    /** Only entries at or after this instant (epoch ms). */
-    since?: number;
-    /** At most this many, the most recent kept. */
-    limit?: number;
-};
-type Journal$1 = {
-    readonly size: number;
-    record(entry: JournalEntry$1): void;
-    list(query?: JournalQuery$1): JournalEntry$1[];
-    /** Forget one namespace's entries, or every namespace's. */
-    clear(namespace?: string): void;
-};
-
-/** Credential → namespace mapping behind `PUT /__admin/credentials`. */
-type CredentialRegistry$1 = {
-    set(credential: string, namespace: string): void;
-    get(credential: string): string | undefined;
-    remove(credential: string): boolean;
-    clear(): void;
-    entries(): {
-        credential: string;
-        namespace: string;
-    }[];
-};
-
 /** A stable identifier for a point in a {@link Timeline}. */
 type CheckpointId$1 = string;
 /** An immutable node in a timeline's checkpoint DAG. */
@@ -336,6 +260,110 @@ interface FetchAPI$2 {
     fetch(request: Request): Promise<Response>;
 }
 
+/**
+ * One problem with a request body, at a dotted path (`patient.address.city`, `items.0.sku`).
+ * `kind` is `media_type` when the body is present but its media type is not one the operation
+ * accepts (a `415` on most vendors), `syntax` when it could not be decoded, `required` when
+ * the operation needs a body and none arrived, and `schema` for a contract violation.
+ */
+type BodyIssue$1 = {
+    path: string;
+    message: string;
+    kind?: "media_type" | "syntax" | "required" | "schema";
+};
+
+/**
+ * What the mock received from a request it rejected, so a 4xx can be attributed after the
+ * fact (an empty body, a missing `content-type`, a schema violation) without logging the body.
+ */
+type RejectedRequest$1 = {
+    /** The raw `content-type` header, or `null` when the request sent none. */
+    contentType: string | null;
+    /** Bytes of body received from `content-length` (`0` for none), or `null` when the client sent no length (a streamed / chunked body). */
+    bodyBytes: number | null;
+    /** The raw `transfer-encoding` header (`chunked`), or `null`. */
+    transferEncoding: string | null;
+};
+/** One handled request, as the structured log sees it. */
+type RequestLog$1 = {
+    service: string;
+    namespace: string;
+    operationId: string | undefined;
+    method: string;
+    path: string;
+    status: number;
+    durationMs: number;
+    /** True when the path matched no operation in the contract. */
+    unmatched: boolean;
+    /** Set when a fault rule produced the response. */
+    faultId?: string;
+    /** Resource ids the handler touched (`userId`, `orderId`, …), when the service reports them. */
+    ids?: Record<string, string>;
+    /** Set when the service created a resource the request referred to but that did not exist. */
+    adopted?: boolean;
+    /** Set on a rejection (status ≥ 400) the mock produced itself, never on a scripted fault. */
+    request?: RejectedRequest$1;
+    /** The validation issues behind a rejection, when the service found any. */
+    issues?: BodyIssue$1[];
+};
+type MetricsReport$1 = {
+    requests: number;
+    /** Counts keyed `<operationId> <status>`. */
+    byOperation: Record<string, number>;
+    /**
+     * Paths that matched no operation, most frequent first.
+     *
+     * This is the early-warning signal: a consumer calling something the mock does
+     * not implement shows up here as a count, before it fails a suite as a 404.
+     */
+    unmatched: {
+        method: string;
+        path: string;
+        count: number;
+    }[];
+    faults: number;
+    totalDurationMs: number;
+};
+type Metrics$1 = {
+    record(entry: RequestLog$1): void;
+    report(): MetricsReport$1;
+    reset(): void;
+};
+
+/** One journal entry: a request log stamped with when (on the mock clock) it was handled. */
+type JournalEntry$1 = RequestLog$1 & {
+    at: string;
+};
+type JournalQuery$1 = {
+    /** Only this namespace. Omit for every namespace, oldest first across all of them. */
+    namespace?: string;
+    operationId?: string;
+    status?: number;
+    /** Only entries at or after this instant (epoch ms). */
+    since?: number;
+    /** At most this many, the most recent kept. */
+    limit?: number;
+};
+type Journal$1 = {
+    readonly size: number;
+    record(entry: JournalEntry$1): void;
+    list(query?: JournalQuery$1): JournalEntry$1[];
+    /** Forget one namespace's entries, or every namespace's. */
+    clear(namespace?: string): void;
+};
+
+/** Credential → namespace mapping behind `PUT /__admin/credentials`. */
+type CredentialRegistry$1 = {
+    set(credential: string, namespace: string): void;
+    get(credential: string): string | undefined;
+    remove(credential: string): boolean;
+    clear(): void;
+    entries(): {
+        credential: string;
+        namespace: string;
+    }[];
+};
+
 /**
  * A point-in-time copy of everything a service namespace holds.
  *
@@ -728,82 +756,6 @@ type FaultRegistry = {
     take(candidate: FaultCandidate): Promise<FaultHit[]>;
 };
 
-/** One handled request, as the structured log sees it. */
-type RequestLog = {
-    service: string;
-    namespace: string;
-    operationId: string | undefined;
-    method: string;
-    path: string;
-    status: number;
-    durationMs: number;
-    /** True when the path matched no operation in the contract. */
-    unmatched: boolean;
-    /** Set when a fault rule produced the response. */
-    faultId?: string;
-    /** Resource ids the handler touched (`userId`, `orderId`, …), when the service reports them. */
-    ids?: Record<string, string>;
-    /** Set when the service created a resource the request referred to but that did not exist. */
-    adopted?: boolean;
-};
-type MetricsReport = {
-    requests: number;
-    /** Counts keyed `<operationId> <status>`. */
-    byOperation: Record<string, number>;
-    /**
-     * Paths that matched no operation, most frequent first.
-     *
-     * This is the early-warning signal: a consumer calling something the mock does
-     * not implement shows up here as a count, before it fails a suite as a 404.
-     */
-    unmatched: {
-        method: string;
-        path: string;
-        count: number;
-    }[];
-    faults: number;
-    totalDurationMs: number;
-};
-type Metrics = {
-    record(entry: RequestLog): void;
-    report(): MetricsReport;
-    reset(): void;
-};
-
-/** One journal entry: a request log stamped with when (on the mock clock) it was handled. */
-type JournalEntry = RequestLog & {
-    at: string;
-};
-type JournalQuery = {
-    /** Only this namespace. Omit for every namespace, oldest first across all of them. */
-    namespace?: string;
-    operationId?: string;
-    status?: number;
-    /** Only entries at or after this instant (epoch ms). */
-    since?: number;
-    /** At most this many, the most recent kept. */
-    limit?: number;
-};
-type Journal = {
-    readonly size: number;
-    record(entry: JournalEntry): void;
-    list(query?: JournalQuery): JournalEntry[];
-    /** Forget one namespace's entries, or every namespace's. */
-    clear(namespace?: string): void;
-};
-
-/** Credential → namespace mapping behind `PUT /__admin/credentials`. */
-type CredentialRegistry = {
-    set(credential: string, namespace: string): void;
-    get(credential: string): string | undefined;
-    remove(credential: string): boolean;
-    clear(): void;
-    entries(): {
-        credential: string;
-        namespace: string;
-    }[];
-};
-
 /** A stable identifier for a point in a {@link Timeline}. */
 type CheckpointId = string;
 /** An immutable node in a timeline's checkpoint DAG. */
@@ -894,6 +846,123 @@ interface FetchAPI$1 {
     fetch(request: Request): Promise<Response>;
 }
 
+/** Options every provider constructor accepts. */
+type APIOptions = {
+    /** Sync SQLite client. Defaults to `@crvouga/mockingbird-service-sqlite`. */
+    sqlite?: SqliteClient$1;
+    /** Clock used for `created`-style fields. Default `Date.now`. */
+    now?: () => number;
+    /**
+     * Storage namespace for this instance's records. Instances sharing one SQLite
+     * client stay isolated when their namespaces differ. Defaults to the service name.
+     */
+    namespace?: string;
+};
+
+/**
+ * One problem with a request body, at a dotted path (`patient.address.city`, `items.0.sku`).
+ * `kind` is `media_type` when the body is present but its media type is not one the operation
+ * accepts (a `415` on most vendors), `syntax` when it could not be decoded, `required` when
+ * the operation needs a body and none arrived, and `schema` for a contract violation.
+ */
+type BodyIssue = {
+    path: string;
+    message: string;
+    kind?: "media_type" | "syntax" | "required" | "schema";
+};
+
+/**
+ * What the mock received from a request it rejected, so a 4xx can be attributed after the
+ * fact (an empty body, a missing `content-type`, a schema violation) without logging the body.
+ */
+type RejectedRequest = {
+    /** The raw `content-type` header, or `null` when the request sent none. */
+    contentType: string | null;
+    /** Bytes of body received from `content-length` (`0` for none), or `null` when the client sent no length (a streamed / chunked body). */
+    bodyBytes: number | null;
+    /** The raw `transfer-encoding` header (`chunked`), or `null`. */
+    transferEncoding: string | null;
+};
+/** One handled request, as the structured log sees it. */
+type RequestLog = {
+    service: string;
+    namespace: string;
+    operationId: string | undefined;
+    method: string;
+    path: string;
+    status: number;
+    durationMs: number;
+    /** True when the path matched no operation in the contract. */
+    unmatched: boolean;
+    /** Set when a fault rule produced the response. */
+    faultId?: string;
+    /** Resource ids the handler touched (`userId`, `orderId`, …), when the service reports them. */
+    ids?: Record<string, string>;
+    /** Set when the service created a resource the request referred to but that did not exist. */
+    adopted?: boolean;
+    /** Set on a rejection (status ≥ 400) the mock produced itself, never on a scripted fault. */
+    request?: RejectedRequest;
+    /** The validation issues behind a rejection, when the service found any. */
+    issues?: BodyIssue[];
+};
+type MetricsReport = {
+    requests: number;
+    /** Counts keyed `<operationId> <status>`. */
+    byOperation: Record<string, number>;
+    /**
+     * Paths that matched no operation, most frequent first.
+     *
+     * This is the early-warning signal: a consumer calling something the mock does
+     * not implement shows up here as a count, before it fails a suite as a 404.
+     */
+    unmatched: {
+        method: string;
+        path: string;
+        count: number;
+    }[];
+    faults: number;
+    totalDurationMs: number;
+};
+type Metrics = {
+    record(entry: RequestLog): void;
+    report(): MetricsReport;
+    reset(): void;
+};
+
+/** One journal entry: a request log stamped with when (on the mock clock) it was handled. */
+type JournalEntry = RequestLog & {
+    at: string;
+};
+type JournalQuery = {
+    /** Only this namespace. Omit for every namespace, oldest first across all of them. */
+    namespace?: string;
+    operationId?: string;
+    status?: number;
+    /** Only entries at or after this instant (epoch ms). */
+    since?: number;
+    /** At most this many, the most recent kept. */
+    limit?: number;
+};
+type Journal = {
+    readonly size: number;
+    record(entry: JournalEntry): void;
+    list(query?: JournalQuery): JournalEntry[];
+    /** Forget one namespace's entries, or every namespace's. */
+    clear(namespace?: string): void;
+};
+
+/** Credential → namespace mapping behind `PUT /__admin/credentials`. */
+type CredentialRegistry = {
+    set(credential: string, namespace: string): void;
+    get(credential: string): string | undefined;
+    remove(credential: string): boolean;
+    clear(): void;
+    entries(): {
+        credential: string;
+        namespace: string;
+    }[];
+};
+
 /**
  * A point-in-time copy of everything a service namespace holds.
  *
@@ -1044,19 +1113,6 @@ type ServiceRuntime<T extends ServiceInstance> = FetchAPI$1 & {
     timeline(namespace?: string): Timeline<ServiceTimelineState>;
 };
 
-/** Options every provider constructor accepts. */
-type APIOptions = {
-    /** Sync SQLite client. Defaults to `@crvouga/mockingbird-service-sqlite`. */
-    sqlite?: SqliteClient$1;
-    /** Clock used for `created`-style fields. Default `Date.now`. */
-    now?: () => number;
-    /**
-     * Storage namespace for this instance's records. Instances sharing one SQLite
-     * client stay isolated when their namespaces differ. Defaults to the service name.
-     */
-    namespace?: string;
-};
-
 /** Bind values accepted by Mockingbird's SQLite port (matches sqlite-mem / better-sqlite3). */
 type SqliteValue = null | number | bigint | string | Uint8Array | boolean;
 /** Mutation counters returned by {@link SqliteStatement.run}. */
@@ -1086,6 +1142,40 @@ interface SqliteClient {
     transaction<T>(fn: () => T): T;
 }
 
+/**
+ * The Address Validation API (`POST https://addressvalidation.googleapis.com/v1:validateAddress`)
+ * over the same corpus as Places and Geocoding.
+ *
+ * Shapes follow Google's reference: `ValidationResult` (`verdict`, `address`, `geocode`,
+ * `uspsData`) and `google.rpc.Status` errors. Google encodes responses as proto3 JSON, so
+ * `false` booleans and empty lists are omitted rather than sent.
+ *
+ * - https://developers.google.com/maps/documentation/address-validation/reference/rest/v1/TopLevel/validateAddress
+ * - https://developers.google.com/maps/documentation/address-validation/reference/rest/v1/ValidationResult
+ * - https://developers.google.com/maps/documentation/address-validation/understand-response
+ *
+ * Every answer is a pure function of the request and the namespace's corpus. A street the corpus
+ * holds (or one synthesized in a corpus city, as for Autocomplete) is a delivery point: DPV `Y`,
+ * with a deterministic ZIP+4. Admin rows can pin any part of the verdict (`validation`).
+ */
+type Granularity = "SUB_PREMISE" | "PREMISE" | "PREMISE_PROXIMITY" | "BLOCK" | "ROUTE" | "OTHER";
+type PossibleNextAction = "FIX" | "CONFIRM_ADD_SUBPREMISES" | "CONFIRM" | "ACCEPT";
+type DpvConfirmation = "Y" | "N" | "S" | "D";
+/** Per-row controls set through `PUT /__admin/corpus`: pin the verdict a test needs. */
+type ValidationOverrides = {
+    granularity?: Granularity;
+    addressComplete?: boolean;
+    possibleNextAction?: PossibleNextAction;
+    dpvConfirmation?: DpvConfirmation;
+    unconfirmedComponentTypes?: string[];
+    /** USPS refuses the address: `uspsData.errorMessage`, and no DPV code. */
+    uspsErrorMessage?: string;
+    /** An apartment building: a missing unit is `D`, an unknown one `S`. */
+    multiUnit?: boolean;
+    /** The units USPS knows for a `multiUnit` row. Absent: every unit is known. */
+    units?: string[];
+};
+
 /**
  * The addresses the mock knows, matching our QA fixtures: every row of `ROUTING_ZIP_CORPUS`
  * (`packages/qa/src/world/gen/addresses.ts`, ≥1 real ZIP per state + DC, ids kept stable), the
@@ -1104,6 +1194,8 @@ type CorpusAddress = {
     county: string;
     lat: number;
     lng: number;
+    /** Address Validation controls for this row (admin rows only): pin a verdict, flag units. */
+    validation?: ValidationOverrides;
 };
 
 /**
@@ -1169,6 +1261,9 @@ declare class GoogleMapsAPI implements FetchAPI {
     private status;
     /** Key check and status-effect faults, before every web-service call. */
     private gate;
+    /** Key check for the Google Cloud-style Address Validation API. */
+    private cloudGate;
+    private validate;
     private noted;
     private autocomplete;
     private details;

package/dist/server.js

@@ -2,8 +2,8 @@ import {
   DEFAULT_PORT,
   createServer,
   serveTarget
-} from "./chunk-YHBPY6U2.js";
-import "./chunk-5HEE5U7V.js";
+} from "./chunk-XR7ESTGM.js";
+import "./chunk-G5DEDMPE.js";
 export {
   DEFAULT_PORT,
   createServer,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@crvouga/mockingbird-service-google-maps",
-  "version": "1.0.0",
-  "description": "Mock of Google Places Autocomplete / Details / Find Place, the Geocoding API and a Maps JavaScript (places) shim, over a QA address corpus, with Google's status codes and fault presets.",
+  "version": "1.1.1",
+  "description": "Mock of Google Places Autocomplete / Details / Find Place, the Geocoding API, a Maps JavaScript (places) shim and the Address Validation API (USPS CASS/DPV verdicts), over a QA address corpus, with Google's status codes and fault presets.",
   "license": "MIT",
   "type": "module",
   "sideEffects": false,
@@ -42,7 +42,9 @@
     "maps",
     "places",
     "geocoding",
-    "autocomplete"
+    "autocomplete",
+    "address-validation",
+    "usps"
   ],
   "mockingbird": {
     "runtime": "portable",