@memberjunction/geo-core 5.34.0 → 5.35.0

package/dist/providers/types.d.ts

@@ -0,0 +1,76 @@
+import { GeocodePrecision } from '../types.js';
+/**
+ * Forward (address-to-coordinates) geocoding request.
+ * Providers receive both a pre-built single-line address string and the
+ * structured components (when available). Providers may use either form
+ * depending on their API shape.
+ */
+export interface GeocodeRequest {
+    /** Pre-built single-line address, e.g. "123 Main St, Springfield, IL 62701, USA". */
+    AddressString: string;
+    /** Optional structured components. Empty/missing when not provided. */
+    Address?: string;
+    City?: string;
+    StateProvince?: string;
+    PostalCode?: string;
+    Country?: string;
+    /** ISO 3166-1 alpha-2 country code (e.g. "US"), used for region-bias / routing. */
+    CountryCode?: string;
+}
+/**
+ * Reverse (coordinates-to-address) geocoding request.
+ */
+export interface ReverseGeocodeRequest {
+    Latitude: number;
+    Longitude: number;
+}
+/**
+ * Provider-agnostic geocoding result. Providers normalize their native
+ * response into this shape. Confidence is normalized to 0.0–1.0; precision
+ * uses the GeocodePrecision enum from the persistence layer.
+ */
+export interface ProviderGeocodeResult {
+    Latitude: number;
+    Longitude: number;
+    Precision: GeocodePrecision;
+    /** Normalized 0.0–1.0 confidence score. null if the provider doesn't surface one. */
+    Confidence: number | null;
+    FormattedAddress: string | null;
+    /** ISO 3166-1 alpha-2 country code returned by the provider. */
+    CountryCode: string | null;
+    /** State/province code/abbreviation returned by the provider. */
+    StateProvinceCode: string | null;
+    StateProvinceName: string | null;
+    City: string | null;
+    PostalCode: string | null;
+    /** Street line 1 if the provider parsed it out. */
+    Line1: string | null;
+    /** Street line 2 (apt/unit/suite) if the provider parsed it out. */
+    Line2: string | null;
+}
+/**
+ * Common interface all geocoding providers implement. New providers are
+ * registered via GeocodingProviderRegistry.Register() — no core changes needed.
+ */
+export interface IGeocodingProvider {
+    /** Stable identifier used in config and the GeocodingSource enum (e.g. 'google', 'geocodio', 'here'). */
+    readonly Name: string;
+    /**
+     * 'global' if the provider supports all countries, otherwise an array of
+     * ISO 3166-1 alpha-2 codes. Used for routing decisions when a country is
+     * known up-front.
+     */
+    readonly SupportedCountries: 'global' | readonly string[];
+    /**
+     * True if the provider's free tier / ToS permits indefinite persistent
+     * storage of geocoding results. Used to gate use for RecordGeoCode persistence.
+     */
+    readonly AllowsPersistentStorage: boolean;
+    /** True if API credentials are configured and the provider is ready to call. */
+    IsConfigured(): boolean;
+    /** Forward geocode. Returns null when the provider can't resolve the address. Throws on transient API errors. */
+    Geocode(req: GeocodeRequest): Promise<ProviderGeocodeResult | null>;
+    /** Reverse geocode. Returns null when the provider can't resolve coordinates. Throws on transient API errors. */
+    ReverseGeocode(req: ReverseGeocodeRequest): Promise<ProviderGeocodeResult | null>;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/providers/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/providers/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE5C;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC3B,qFAAqF;IACrF,aAAa,EAAE,MAAM,CAAC;IACtB,uEAAuE;IACvE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,mFAAmF;IACnF,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;CACrB;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,gBAAgB,CAAC;IAC5B,qFAAqF;IACrF,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,gEAAgE;IAChE,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,iEAAiE;IACjE,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,mDAAmD;IACnD,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,oEAAoE;IACpE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IAC/B,yGAAyG;IACzG,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,QAAQ,CAAC,kBAAkB,EAAE,QAAQ,GAAG,SAAS,MAAM,EAAE,CAAC;IAC1D;;;OAGG;IACH,QAAQ,CAAC,uBAAuB,EAAE,OAAO,CAAC;IAC1C,gFAAgF;IAChF,YAAY,IAAI,OAAO,CAAC;IACxB,iHAAiH;IACjH,OAAO,CAAC,GAAG,EAAE,cAAc,GAAG,OAAO,CAAC,qBAAqB,GAAG,IAAI,CAAC,CAAC;IACpE,iHAAiH;IACjH,cAAc,CAAC,GAAG,EAAE,qBAAqB,GAAG,OAAO,CAAC,qBAAqB,GAAG,IAAI,CAAC,CAAC;CACrF"}

package/dist/providers/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/providers/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/providers/types.ts"],"names":[],"mappings":""}

package/dist/types.d.ts

@@ -19,7 +19,7 @@ export type GeocodeStatus = 'success' | 'failed' | 'pending';
 /**
  * Source that produced the geocode.
  */
-export type GeocodingSource = 'google' | 'reference_data' | 'manual' | 'ip_geolocation' | 'native' | 'reverse';
+export type GeocodingSource = 'google' | 'geocodio' | 'here' | 'reference_data' | 'manual' | 'ip_geolocation' | 'native' | 'reverse';
 /**
  * Result from a geocoding operation.
  */

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC5B,wFAAwF;IACxF,YAAY,EAAE,SAAS,CAAC;IACxB,qEAAqE;IACrE,MAAM,EAAE,MAAM,EAAE,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,OAAO,GAAG,aAAa,GAAG,MAAM,GAAG,QAAQ,GAAG,gBAAgB,GAAG,SAAS,CAAC;AAE1G;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAC;AAE7D;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,QAAQ,GAAG,gBAAgB,GAAG,QAAQ,GAAG,gBAAgB,GAAG,QAAQ,GAAG,SAAS,CAAC;AAE/G;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,gBAAgB,CAAC;IAC5B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,MAAM,EAAE,eAAe,CAAC;CAC3B;AAED;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;IACrB,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,MAAM,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,IAAI,GAAG,IAAI,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC5B,wFAAwF;IACxF,YAAY,EAAE,SAAS,CAAC;IACxB,qEAAqE;IACrE,MAAM,EAAE,MAAM,EAAE,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,OAAO,GAAG,aAAa,GAAG,MAAM,GAAG,QAAQ,GAAG,gBAAgB,GAAG,SAAS,CAAC;AAE1G;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAC;AAE7D;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,QAAQ,GAAG,UAAU,GAAG,MAAM,GAAG,gBAAgB,GAAG,QAAQ,GAAG,gBAAgB,GAAG,QAAQ,GAAG,SAAS,CAAC;AAErI;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,gBAAgB,CAAC;IAC5B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,MAAM,EAAE,eAAe,CAAC;CAC3B;AAED;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;IACrB,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,MAAM,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,IAAI,GAAG,IAAI,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@memberjunction/geo-core",
   "type": "module",
-  "version": "5.34.0",
+  "version": "5.35.0",
   "description": "MemberJunction: Core geo-spatial types, interfaces, and GeoCodeSyncService for geocoding lifecycle management",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -17,9 +17,9 @@
   "author": "MemberJunction.com",
   "license": "ISC",
   "dependencies": {
-    "@memberjunction/global": "5.34.0",
-    "@memberjunction/core": "5.34.0",
-    "@memberjunction/core-entities": "5.34.0"
+    "@memberjunction/global": "5.35.0",
+    "@memberjunction/core": "5.35.0",
+    "@memberjunction/core-entities": "5.35.0"
   },
   "devDependencies": {
     "@types/node": "^24.10.11",