@metamask-previews/geolocation-controller 0.1.0-preview-0aca970c8

package/dist/GeolocationController.mjs

@@ -0,0 +1,149 @@
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _GeolocationController_instances, _GeolocationController_fetchAndUpdate;
+import { BaseController } from "@metamask/base-controller";
+import { UNKNOWN_LOCATION } from "./geolocation-api-service/geolocation-api-service.mjs";
+/**
+ * The name of the {@link GeolocationController}, used to namespace the
+ * controller's actions and events and to namespace the controller's state data
+ * when composed with other controllers.
+ */
+export const controllerName = 'GeolocationController';
+/**
+ * The metadata for each property in {@link GeolocationControllerState}.
+ */
+const geolocationControllerMetadata = {
+    location: {
+        persist: false,
+        includeInDebugSnapshot: true,
+        includeInStateLogs: true,
+        usedInUi: true,
+    },
+    status: {
+        persist: false,
+        includeInDebugSnapshot: true,
+        includeInStateLogs: true,
+        usedInUi: true,
+    },
+    lastFetchedAt: {
+        persist: false,
+        includeInDebugSnapshot: true,
+        includeInStateLogs: true,
+        usedInUi: false,
+    },
+    error: {
+        persist: false,
+        includeInDebugSnapshot: true,
+        includeInStateLogs: true,
+        usedInUi: false,
+    },
+};
+/**
+ * Constructs the default {@link GeolocationController} state. This allows
+ * consumers to provide a partial state object when initializing the controller
+ * and also helps in constructing complete state objects for this controller in
+ * tests.
+ *
+ * @returns The default {@link GeolocationController} state.
+ */
+export function getDefaultGeolocationControllerState() {
+    return {
+        location: UNKNOWN_LOCATION,
+        status: 'idle',
+        lastFetchedAt: null,
+        error: null,
+    };
+}
+const MESSENGER_EXPOSED_METHODS = [
+    'getGeolocation',
+    'refreshGeolocation',
+];
+/**
+ * GeolocationController manages UI-facing geolocation state by delegating
+ * the actual API interaction to {@link GeolocationApiService} via the
+ * messenger.
+ *
+ * The service (registered externally as
+ * `GeolocationApiService:fetchGeolocation`) handles HTTP requests, response
+ * validation, TTL caching, and promise deduplication. This controller focuses
+ * on state lifecycle (`idle` -> `loading` -> `complete` | `error`) and
+ * exposes `getGeolocation` / `refreshGeolocation` as messenger actions.
+ */
+export class GeolocationController extends BaseController {
+    /**
+     * Constructs a new {@link GeolocationController}.
+     *
+     * @param args - The arguments to this controller.
+     * @param args.messenger - The messenger suited for this controller. Must
+     * have a `GeolocationApiService:fetchGeolocation` action handler registered.
+     * @param args.state - Optional partial initial state.
+     */
+    constructor({ messenger, state }) {
+        super({
+            messenger,
+            metadata: geolocationControllerMetadata,
+            name: controllerName,
+            state: { ...getDefaultGeolocationControllerState(), ...state },
+        });
+        _GeolocationController_instances.add(this);
+        this.messenger.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
+    }
+    /**
+     * Returns the geolocation country code. Delegates to the
+     * {@link GeolocationApiService} for network fetching and caching, then
+     * updates controller state with the result.
+     *
+     * @returns The ISO country code string.
+     */
+    async getGeolocation() {
+        return __classPrivateFieldGet(this, _GeolocationController_instances, "m", _GeolocationController_fetchAndUpdate).call(this);
+    }
+    /**
+     * Forces a fresh geolocation fetch, bypassing the service's cache.
+     *
+     * @returns The ISO country code string.
+     */
+    async refreshGeolocation() {
+        this.update((draft) => {
+            draft.lastFetchedAt = null;
+        });
+        return __classPrivateFieldGet(this, _GeolocationController_instances, "m", _GeolocationController_fetchAndUpdate).call(this, { bypassCache: true });
+    }
+}
+_GeolocationController_instances = new WeakSet(), _GeolocationController_fetchAndUpdate = 
+/**
+ * Calls the geolocation service and updates controller state with the
+ * result.
+ *
+ * @param options - Options forwarded to the service.
+ * @param options.bypassCache - When true, the service skips its TTL cache.
+ * @returns The ISO country code string.
+ */
+async function _GeolocationController_fetchAndUpdate(options) {
+    this.update((draft) => {
+        draft.status = 'loading';
+        draft.error = null;
+    });
+    try {
+        const location = await this.messenger.call('GeolocationApiService:fetchGeolocation', options);
+        this.update((draft) => {
+            draft.location = location;
+            draft.status = 'complete';
+            draft.lastFetchedAt = Date.now();
+            draft.error = null;
+        });
+        return location;
+    }
+    catch (error) {
+        const message = error instanceof Error ? error.message : String(error);
+        this.update((draft) => {
+            draft.status = 'error';
+            draft.error = message;
+        });
+        return this.state.location;
+    }
+};
+//# sourceMappingURL=GeolocationController.mjs.map

package/dist/GeolocationController.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"GeolocationController.mjs","sourceRoot":"","sources":["../src/GeolocationController.ts"],"names":[],"mappings":";;;;;;AAKA,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAG3D,OAAO,EAAE,gBAAgB,EAAE,8DAA0D;AAKrF;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,uBAAuB,CAAC;AAgBtD;;GAEG;AACH,MAAM,6BAA6B,GAAG;IACpC,QAAQ,EAAE;QACR,OAAO,EAAE,KAAK;QACd,sBAAsB,EAAE,IAAI;QAC5B,kBAAkB,EAAE,IAAI;QACxB,QAAQ,EAAE,IAAI;KACf;IACD,MAAM,EAAE;QACN,OAAO,EAAE,KAAK;QACd,sBAAsB,EAAE,IAAI;QAC5B,kBAAkB,EAAE,IAAI;QACxB,QAAQ,EAAE,IAAI;KACf;IACD,aAAa,EAAE;QACb,OAAO,EAAE,KAAK;QACd,sBAAsB,EAAE,IAAI;QAC5B,kBAAkB,EAAE,IAAI;QACxB,QAAQ,EAAE,KAAK;KAChB;IACD,KAAK,EAAE;QACL,OAAO,EAAE,KAAK;QACd,sBAAsB,EAAE,IAAI;QAC5B,kBAAkB,EAAE,IAAI;QACxB,QAAQ,EAAE,KAAK;KAChB;CACkD,CAAC;AAEtD;;;;;;;GAOG;AACH,MAAM,UAAU,oCAAoC;IAClD,OAAO;QACL,QAAQ,EAAE,gBAAgB;QAC1B,MAAM,EAAE,MAAM;QACd,aAAa,EAAE,IAAI;QACnB,KAAK,EAAE,IAAI;KACZ,CAAC;AACJ,CAAC;AAED,MAAM,yBAAyB,GAAG;IAChC,gBAAgB;IAChB,oBAAoB;CACZ,CAAC;AA6DX;;;;;;;;;;GAUG;AACH,MAAM,OAAO,qBAAsB,SAAQ,cAI1C;IACC;;;;;;;OAOG;IACH,YAAY,EAAE,SAAS,EAAE,KAAK,EAAgC;QAC5D,KAAK,CAAC;YACJ,SAAS;YACT,QAAQ,EAAE,6BAA6B;YACvC,IAAI,EAAE,cAAc;YACpB,KAAK,EAAE,EAAE,GAAG,oCAAoC,EAAE,EAAE,GAAG,KAAK,EAAE;SAC/D,CAAC,CAAC;;QAEH,IAAI,CAAC,SAAS,CAAC,4BAA4B,CACzC,IAAI,EACJ,yBAAyB,CAC1B,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,cAAc;QAClB,OAAO,uBAAA,IAAI,+EAAgB,MAApB,IAAI,CAAkB,CAAC;IAChC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,kBAAkB;QACtB,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,aAAa,GAAG,IAAI,CAAC;QAC7B,CAAC,CAAC,CAAC;QACH,OAAO,uBAAA,IAAI,+EAAgB,MAApB,IAAI,EAAiB,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;IACrD,CAAC;CAyCF;;AAvCC;;;;;;;GAOG;AACH,KAAK,gDAAiB,OAAmC;IACvD,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QACpB,KAAK,CAAC,MAAM,GAAG,SAAS,CAAC;QACzB,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC;IACrB,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CACxC,wCAAwC,EACxC,OAAO,CACR,CAAC;QAEF,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC;YAC1B,KAAK,CAAC,MAAM,GAAG,UAAU,CAAC;YAC1B,KAAK,CAAC,aAAa,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YACjC,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC;QACrB,CAAC,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC;IAClB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAEvE,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,MAAM,GAAG,OAAO,CAAC;YACvB,KAAK,CAAC,KAAK,GAAG,OAAO,CAAC;QACxB,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;IAC7B,CAAC;AACH,CAAC","sourcesContent":["import type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  StateMetadata,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport type { Messenger } from '@metamask/messenger';\n\nimport { UNKNOWN_LOCATION } from './geolocation-api-service/geolocation-api-service';\nimport type { GeolocationApiServiceFetchGeolocationAction } from './geolocation-api-service/geolocation-api-service-method-action-types';\nimport type { GeolocationControllerMethodActions } from './GeolocationController-method-action-types';\nimport type { GeolocationRequestStatus } from './types';\n\n/**\n * The name of the {@link GeolocationController}, used to namespace the\n * controller's actions and events and to namespace the controller's state data\n * when composed with other controllers.\n */\nexport const controllerName = 'GeolocationController';\n\n/**\n * State for the {@link GeolocationController}.\n */\nexport type GeolocationControllerState = {\n  /** ISO 3166-1 alpha-2 country code, or \"UNKNOWN\" if not yet determined. */\n  location: string;\n  /** Current status of the geolocation fetch lifecycle. */\n  status: GeolocationRequestStatus;\n  /** Epoch milliseconds of the last successful fetch, or null if never fetched. */\n  lastFetchedAt: number | null;\n  /** Last error message, or null if no error has occurred. */\n  error: string | null;\n};\n\n/**\n * The metadata for each property in {@link GeolocationControllerState}.\n */\nconst geolocationControllerMetadata = {\n  location: {\n    persist: false,\n    includeInDebugSnapshot: true,\n    includeInStateLogs: true,\n    usedInUi: true,\n  },\n  status: {\n    persist: false,\n    includeInDebugSnapshot: true,\n    includeInStateLogs: true,\n    usedInUi: true,\n  },\n  lastFetchedAt: {\n    persist: false,\n    includeInDebugSnapshot: true,\n    includeInStateLogs: true,\n    usedInUi: false,\n  },\n  error: {\n    persist: false,\n    includeInDebugSnapshot: true,\n    includeInStateLogs: true,\n    usedInUi: false,\n  },\n} satisfies StateMetadata<GeolocationControllerState>;\n\n/**\n * Constructs the default {@link GeolocationController} state. This allows\n * consumers to provide a partial state object when initializing the controller\n * and also helps in constructing complete state objects for this controller in\n * tests.\n *\n * @returns The default {@link GeolocationController} state.\n */\nexport function getDefaultGeolocationControllerState(): GeolocationControllerState {\n  return {\n    location: UNKNOWN_LOCATION,\n    status: 'idle',\n    lastFetchedAt: null,\n    error: null,\n  };\n}\n\nconst MESSENGER_EXPOSED_METHODS = [\n  'getGeolocation',\n  'refreshGeolocation',\n] as const;\n\n/**\n * Retrieves the state of the {@link GeolocationController}.\n */\nexport type GeolocationControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  GeolocationControllerState\n>;\n\n/**\n * Actions that {@link GeolocationControllerMessenger} exposes to other consumers.\n */\nexport type GeolocationControllerActions =\n  | GeolocationControllerGetStateAction\n  | GeolocationControllerMethodActions;\n\n/**\n * Actions from other messengers that {@link GeolocationControllerMessenger} calls.\n */\ntype AllowedActions = GeolocationApiServiceFetchGeolocationAction;\n\n/**\n * Published when the state of {@link GeolocationController} changes.\n */\nexport type GeolocationControllerStateChangeEvent = ControllerStateChangeEvent<\n  typeof controllerName,\n  GeolocationControllerState\n>;\n\n/**\n * Events that {@link GeolocationControllerMessenger} exposes to other consumers.\n */\nexport type GeolocationControllerEvents = GeolocationControllerStateChangeEvent;\n\n/**\n * Events from other messengers that {@link GeolocationControllerMessenger}\n * subscribes to.\n */\ntype AllowedEvents = never;\n\n/**\n * The messenger restricted to actions and events accessed by\n * {@link GeolocationController}.\n */\nexport type GeolocationControllerMessenger = Messenger<\n  typeof controllerName,\n  GeolocationControllerActions | AllowedActions,\n  GeolocationControllerEvents | AllowedEvents\n>;\n\n/**\n * Options for constructing the {@link GeolocationController}.\n */\nexport type GeolocationControllerOptions = {\n  /** The messenger for inter-controller communication. */\n  messenger: GeolocationControllerMessenger;\n  /** Optional partial initial state. */\n  state?: Partial<GeolocationControllerState>;\n};\n\n/**\n * GeolocationController manages UI-facing geolocation state by delegating\n * the actual API interaction to {@link GeolocationApiService} via the\n * messenger.\n *\n * The service (registered externally as\n * `GeolocationApiService:fetchGeolocation`) handles HTTP requests, response\n * validation, TTL caching, and promise deduplication. This controller focuses\n * on state lifecycle (`idle` -> `loading` -> `complete` | `error`) and\n * exposes `getGeolocation` / `refreshGeolocation` as messenger actions.\n */\nexport class GeolocationController extends BaseController<\n  typeof controllerName,\n  GeolocationControllerState,\n  GeolocationControllerMessenger\n> {\n  /**\n   * Constructs a new {@link GeolocationController}.\n   *\n   * @param args - The arguments to this controller.\n   * @param args.messenger - The messenger suited for this controller. Must\n   * have a `GeolocationApiService:fetchGeolocation` action handler registered.\n   * @param args.state - Optional partial initial state.\n   */\n  constructor({ messenger, state }: GeolocationControllerOptions) {\n    super({\n      messenger,\n      metadata: geolocationControllerMetadata,\n      name: controllerName,\n      state: { ...getDefaultGeolocationControllerState(), ...state },\n    });\n\n    this.messenger.registerMethodActionHandlers(\n      this,\n      MESSENGER_EXPOSED_METHODS,\n    );\n  }\n\n  /**\n   * Returns the geolocation country code. Delegates to the\n   * {@link GeolocationApiService} for network fetching and caching, then\n   * updates controller state with the result.\n   *\n   * @returns The ISO country code string.\n   */\n  async getGeolocation(): Promise<string> {\n    return this.#fetchAndUpdate();\n  }\n\n  /**\n   * Forces a fresh geolocation fetch, bypassing the service's cache.\n   *\n   * @returns The ISO country code string.\n   */\n  async refreshGeolocation(): Promise<string> {\n    this.update((draft) => {\n      draft.lastFetchedAt = null;\n    });\n    return this.#fetchAndUpdate({ bypassCache: true });\n  }\n\n  /**\n   * Calls the geolocation service and updates controller state with the\n   * result.\n   *\n   * @param options - Options forwarded to the service.\n   * @param options.bypassCache - When true, the service skips its TTL cache.\n   * @returns The ISO country code string.\n   */\n  async #fetchAndUpdate(options?: { bypassCache?: boolean }): Promise<string> {\n    this.update((draft) => {\n      draft.status = 'loading';\n      draft.error = null;\n    });\n\n    try {\n      const location = await this.messenger.call(\n        'GeolocationApiService:fetchGeolocation',\n        options,\n      );\n\n      this.update((draft) => {\n        draft.location = location;\n        draft.status = 'complete';\n        draft.lastFetchedAt = Date.now();\n        draft.error = null;\n      });\n\n      return location;\n    } catch (error) {\n      const message = error instanceof Error ? error.message : String(error);\n\n      this.update((draft) => {\n        draft.status = 'error';\n        draft.error = message;\n      });\n\n      return this.state.location;\n    }\n  }\n}\n"]}

package/dist/geolocation-api-service/geolocation-api-service-method-action-types.cjs

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=geolocation-api-service-method-action-types.cjs.map

package/dist/geolocation-api-service/geolocation-api-service-method-action-types.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"geolocation-api-service-method-action-types.cjs","sourceRoot":"","sources":["../../src/geolocation-api-service/geolocation-api-service-method-action-types.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated by `scripts/generate-method-action-types.ts`.\n * Do not edit manually.\n */\n\nimport type { GeolocationApiService } from './geolocation-api-service';\n\n/**\n * Returns the geolocation country code. Serves from cache when the TTL has\n * not expired, otherwise performs a network fetch. Concurrent callers are\n * deduplicated to a single in-flight request.\n *\n * @param options - Optional fetch options.\n * @param options.bypassCache - When true, invalidates the cache and forces a\n * fresh network request.\n * @returns The ISO 3166-1 alpha-2 country code, or `UNKNOWN_LOCATION`\n * when the API returns an empty or invalid body.\n */\nexport type GeolocationApiServiceFetchGeolocationAction = {\n  type: `GeolocationApiService:fetchGeolocation`;\n  handler: GeolocationApiService['fetchGeolocation'];\n};\n\n/**\n * Union of all GeolocationApiService action types.\n */\nexport type GeolocationApiServiceMethodActions =\n  GeolocationApiServiceFetchGeolocationAction;\n"]}

package/dist/geolocation-api-service/geolocation-api-service-method-action-types.d.cts

@@ -0,0 +1,25 @@
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+import type { GeolocationApiService } from "./geolocation-api-service.cjs";
+/**
+ * Returns the geolocation country code. Serves from cache when the TTL has
+ * not expired, otherwise performs a network fetch. Concurrent callers are
+ * deduplicated to a single in-flight request.
+ *
+ * @param options - Optional fetch options.
+ * @param options.bypassCache - When true, invalidates the cache and forces a
+ * fresh network request.
+ * @returns The ISO 3166-1 alpha-2 country code, or `UNKNOWN_LOCATION`
+ * when the API returns an empty or invalid body.
+ */
+export type GeolocationApiServiceFetchGeolocationAction = {
+    type: `GeolocationApiService:fetchGeolocation`;
+    handler: GeolocationApiService['fetchGeolocation'];
+};
+/**
+ * Union of all GeolocationApiService action types.
+ */
+export type GeolocationApiServiceMethodActions = GeolocationApiServiceFetchGeolocationAction;
+//# sourceMappingURL=geolocation-api-service-method-action-types.d.cts.map

package/dist/geolocation-api-service/geolocation-api-service-method-action-types.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"geolocation-api-service-method-action-types.d.cts","sourceRoot":"","sources":["../../src/geolocation-api-service/geolocation-api-service-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,qBAAqB,EAAE,sCAAkC;AAEvE;;;;;;;;;;GAUG;AACH,MAAM,MAAM,2CAA2C,GAAG;IACxD,IAAI,EAAE,wCAAwC,CAAC;IAC/C,OAAO,EAAE,qBAAqB,CAAC,kBAAkB,CAAC,CAAC;CACpD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kCAAkC,GAC5C,2CAA2C,CAAC"}

package/dist/geolocation-api-service/geolocation-api-service-method-action-types.d.mts

@@ -0,0 +1,25 @@
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+import type { GeolocationApiService } from "./geolocation-api-service.mjs";
+/**
+ * Returns the geolocation country code. Serves from cache when the TTL has
+ * not expired, otherwise performs a network fetch. Concurrent callers are
+ * deduplicated to a single in-flight request.
+ *
+ * @param options - Optional fetch options.
+ * @param options.bypassCache - When true, invalidates the cache and forces a
+ * fresh network request.
+ * @returns The ISO 3166-1 alpha-2 country code, or `UNKNOWN_LOCATION`
+ * when the API returns an empty or invalid body.
+ */
+export type GeolocationApiServiceFetchGeolocationAction = {
+    type: `GeolocationApiService:fetchGeolocation`;
+    handler: GeolocationApiService['fetchGeolocation'];
+};
+/**
+ * Union of all GeolocationApiService action types.
+ */
+export type GeolocationApiServiceMethodActions = GeolocationApiServiceFetchGeolocationAction;
+//# sourceMappingURL=geolocation-api-service-method-action-types.d.mts.map

package/dist/geolocation-api-service/geolocation-api-service-method-action-types.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"geolocation-api-service-method-action-types.d.mts","sourceRoot":"","sources":["../../src/geolocation-api-service/geolocation-api-service-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,qBAAqB,EAAE,sCAAkC;AAEvE;;;;;;;;;;GAUG;AACH,MAAM,MAAM,2CAA2C,GAAG;IACxD,IAAI,EAAE,wCAAwC,CAAC;IAC/C,OAAO,EAAE,qBAAqB,CAAC,kBAAkB,CAAC,CAAC;CACpD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kCAAkC,GAC5C,2CAA2C,CAAC"}

package/dist/geolocation-api-service/geolocation-api-service-method-action-types.mjs

@@ -0,0 +1,6 @@
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+export {};
+//# sourceMappingURL=geolocation-api-service-method-action-types.mjs.map

package/dist/geolocation-api-service/geolocation-api-service-method-action-types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"geolocation-api-service-method-action-types.mjs","sourceRoot":"","sources":["../../src/geolocation-api-service/geolocation-api-service-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated by `scripts/generate-method-action-types.ts`.\n * Do not edit manually.\n */\n\nimport type { GeolocationApiService } from './geolocation-api-service';\n\n/**\n * Returns the geolocation country code. Serves from cache when the TTL has\n * not expired, otherwise performs a network fetch. Concurrent callers are\n * deduplicated to a single in-flight request.\n *\n * @param options - Optional fetch options.\n * @param options.bypassCache - When true, invalidates the cache and forces a\n * fresh network request.\n * @returns The ISO 3166-1 alpha-2 country code, or `UNKNOWN_LOCATION`\n * when the API returns an empty or invalid body.\n */\nexport type GeolocationApiServiceFetchGeolocationAction = {\n  type: `GeolocationApiService:fetchGeolocation`;\n  handler: GeolocationApiService['fetchGeolocation'];\n};\n\n/**\n * Union of all GeolocationApiService action types.\n */\nexport type GeolocationApiServiceMethodActions =\n  GeolocationApiServiceFetchGeolocationAction;\n"]}

package/dist/geolocation-api-service/geolocation-api-service.cjs

@@ -0,0 +1,186 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _GeolocationApiService_instances, _GeolocationApiService_messenger, _GeolocationApiService_fetch, _GeolocationApiService_url, _GeolocationApiService_ttlMs, _GeolocationApiService_policy, _GeolocationApiService_cachedLocation, _GeolocationApiService_lastFetchedAt, _GeolocationApiService_fetchPromise, _GeolocationApiService_isCacheValid, _GeolocationApiService_performFetch;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GeolocationApiService = exports.UNKNOWN_LOCATION = exports.serviceName = void 0;
+const controller_utils_1 = require("@metamask/controller-utils");
+const types_1 = require("../types.cjs");
+const DEFAULT_TTL_MS = 5 * 60 * 1000;
+const ENDPOINT_PATH = '/geolocation';
+// === GENERAL ===
+/**
+ * The name of the {@link GeolocationApiService}, used to namespace the
+ * service's actions and events.
+ */
+exports.serviceName = 'GeolocationApiService';
+/**
+ * Sentinel value used when the geolocation has not been determined yet or when
+ * the API returns an empty / invalid response.
+ */
+exports.UNKNOWN_LOCATION = 'UNKNOWN';
+// === MESSENGER ===
+const MESSENGER_EXPOSED_METHODS = ['fetchGeolocation'];
+// === SERVICE DEFINITION ===
+/**
+ * Returns the base URL for the geolocation API for the given environment.
+ *
+ * @param env - The environment to get the URL for.
+ * @returns The full URL for the geolocation endpoint.
+ */
+function getGeolocationUrl(env) {
+    const envPrefix = env === types_1.Env.PRD ? '' : `${env}-`;
+    return `https://on-ramp.${envPrefix}api.cx.metamask.io${ENDPOINT_PATH}`;
+}
+/**
+ * Low-level data service that fetches a country code from the geolocation API.
+ *
+ * Responsibilities:
+ * - HTTP request to the geolocation endpoint (wrapped in a service policy)
+ * - ISO 3166-1 alpha-2 response validation
+ * - TTL-based in-memory cache
+ * - Promise deduplication (concurrent callers share a single in-flight request)
+ *
+ * This class is intentionally not a controller: it does not manage UI state.
+ * Its {@link fetchGeolocation} method is automatically registered on the
+ * messenger so that controllers and other packages can call it directly.
+ */
+class GeolocationApiService {
+    /**
+     * Constructs a new {@link GeolocationApiService}.
+     *
+     * @param args - The constructor arguments.
+     * @param args.messenger - The messenger suited for this service.
+     * @param args.env - The environment to determine the correct API endpoint.
+     * Defaults to PRD.
+     * @param args.fetch - A function that can be used to make an HTTP request.
+     * Defaults to the global fetch.
+     * @param args.ttlMs - Cache TTL in milliseconds. Defaults to 5 minutes.
+     * @param args.policyOptions - Options to pass to `createServicePolicy`, which
+     * is used to wrap each request. See {@link CreateServicePolicyOptions}.
+     */
+    constructor({ messenger, env = types_1.Env.PRD, fetch: fetchFunction = globalThis.fetch, ttlMs, policyOptions = {}, }) {
+        _GeolocationApiService_instances.add(this);
+        _GeolocationApiService_messenger.set(this, void 0);
+        _GeolocationApiService_fetch.set(this, void 0);
+        _GeolocationApiService_url.set(this, void 0);
+        _GeolocationApiService_ttlMs.set(this, void 0);
+        /**
+         * The policy that wraps each HTTP request.
+         *
+         * @see {@link createServicePolicy}
+         */
+        _GeolocationApiService_policy.set(this, void 0);
+        _GeolocationApiService_cachedLocation.set(this, exports.UNKNOWN_LOCATION);
+        _GeolocationApiService_lastFetchedAt.set(this, null);
+        _GeolocationApiService_fetchPromise.set(this, null);
+        this.name = exports.serviceName;
+        __classPrivateFieldSet(this, _GeolocationApiService_messenger, messenger, "f");
+        __classPrivateFieldSet(this, _GeolocationApiService_url, getGeolocationUrl(env), "f");
+        __classPrivateFieldSet(this, _GeolocationApiService_fetch, fetchFunction, "f");
+        __classPrivateFieldSet(this, _GeolocationApiService_ttlMs, ttlMs ?? DEFAULT_TTL_MS, "f");
+        __classPrivateFieldSet(this, _GeolocationApiService_policy, (0, controller_utils_1.createServicePolicy)(policyOptions), "f");
+        __classPrivateFieldGet(this, _GeolocationApiService_messenger, "f").registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
+    }
+    /**
+     * Registers a handler that will be called after a request returns a 5xx
+     * response, causing a retry.
+     *
+     * @param listener - The handler to be called.
+     * @returns An object that can be used to unregister the handler.
+     * @see {@link createServicePolicy}
+     */
+    onRetry(listener) {
+        return __classPrivateFieldGet(this, _GeolocationApiService_policy, "f").onRetry(listener);
+    }
+    /**
+     * Registers a handler that will be called after a set number of retry rounds
+     * prove that requests to the API endpoint consistently return a 5xx response.
+     *
+     * @param listener - The handler to be called.
+     * @returns An object that can be used to unregister the handler.
+     * @see {@link createServicePolicy}
+     */
+    onBreak(listener) {
+        return __classPrivateFieldGet(this, _GeolocationApiService_policy, "f").onBreak(listener);
+    }
+    /**
+     * Registers a handler that will be called when requests are consistently
+     * failing or when a successful request takes longer than the degraded
+     * threshold.
+     *
+     * @param listener - The handler to be called.
+     * @returns An object that can be used to unregister the handler.
+     */
+    onDegraded(listener) {
+        return __classPrivateFieldGet(this, _GeolocationApiService_policy, "f").onDegraded(listener);
+    }
+    /**
+     * Returns the geolocation country code. Serves from cache when the TTL has
+     * not expired, otherwise performs a network fetch. Concurrent callers are
+     * deduplicated to a single in-flight request.
+     *
+     * @param options - Optional fetch options.
+     * @param options.bypassCache - When true, invalidates the TTL cache. If a
+     * request is already in-flight it will be reused (deduplication always
+     * applies).
+     * @returns The ISO 3166-1 alpha-2 country code, or {@link UNKNOWN_LOCATION}
+     * when the API returns an empty or invalid body.
+     */
+    async fetchGeolocation(options) {
+        if (options?.bypassCache) {
+            __classPrivateFieldSet(this, _GeolocationApiService_lastFetchedAt, null, "f");
+        }
+        if (__classPrivateFieldGet(this, _GeolocationApiService_instances, "m", _GeolocationApiService_isCacheValid).call(this)) {
+            return __classPrivateFieldGet(this, _GeolocationApiService_cachedLocation, "f");
+        }
+        if (__classPrivateFieldGet(this, _GeolocationApiService_fetchPromise, "f")) {
+            return __classPrivateFieldGet(this, _GeolocationApiService_fetchPromise, "f");
+        }
+        const promise = __classPrivateFieldGet(this, _GeolocationApiService_instances, "m", _GeolocationApiService_performFetch).call(this);
+        __classPrivateFieldSet(this, _GeolocationApiService_fetchPromise, promise, "f");
+        try {
+            return await promise;
+        }
+        finally {
+            __classPrivateFieldSet(this, _GeolocationApiService_fetchPromise, null, "f");
+        }
+    }
+}
+exports.GeolocationApiService = GeolocationApiService;
+_GeolocationApiService_messenger = new WeakMap(), _GeolocationApiService_fetch = new WeakMap(), _GeolocationApiService_url = new WeakMap(), _GeolocationApiService_ttlMs = new WeakMap(), _GeolocationApiService_policy = new WeakMap(), _GeolocationApiService_cachedLocation = new WeakMap(), _GeolocationApiService_lastFetchedAt = new WeakMap(), _GeolocationApiService_fetchPromise = new WeakMap(), _GeolocationApiService_instances = new WeakSet(), _GeolocationApiService_isCacheValid = function _GeolocationApiService_isCacheValid() {
+    return (__classPrivateFieldGet(this, _GeolocationApiService_lastFetchedAt, "f") !== null &&
+        Date.now() - __classPrivateFieldGet(this, _GeolocationApiService_lastFetchedAt, "f") < __classPrivateFieldGet(this, _GeolocationApiService_ttlMs, "f"));
+}, _GeolocationApiService_performFetch = 
+/**
+ * Performs the actual HTTP fetch, wrapped in the service policy for automatic
+ * retry and circuit-breaking, and validates the response.
+ *
+ * @returns The ISO country code string.
+ */
+async function _GeolocationApiService_performFetch() {
+    const response = await __classPrivateFieldGet(this, _GeolocationApiService_policy, "f").execute(async () => {
+        const localResponse = await __classPrivateFieldGet(this, _GeolocationApiService_fetch, "f").call(this, __classPrivateFieldGet(this, _GeolocationApiService_url, "f"));
+        if (!localResponse.ok) {
+            throw new controller_utils_1.HttpError(localResponse.status, `Geolocation fetch failed: ${localResponse.status}`);
+        }
+        return localResponse;
+    });
+    const raw = (await response.text()).trim();
+    const location = /^[A-Z]{2}$/u.test(raw) ? raw : exports.UNKNOWN_LOCATION;
+    if (location !== exports.UNKNOWN_LOCATION) {
+        __classPrivateFieldSet(this, _GeolocationApiService_cachedLocation, location, "f");
+        __classPrivateFieldSet(this, _GeolocationApiService_lastFetchedAt, Date.now(), "f");
+    }
+    return location;
+};
+//# sourceMappingURL=geolocation-api-service.cjs.map

package/dist/geolocation-api-service/geolocation-api-service.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"geolocation-api-service.cjs","sourceRoot":"","sources":["../../src/geolocation-api-service/geolocation-api-service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAIA,iEAA4E;AAK5E,wCAA+B;AAE/B,MAAM,cAAc,GAAG,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC;AAErC,MAAM,aAAa,GAAG,cAAc,CAAC;AAErC,kBAAkB;AAElB;;;GAGG;AACU,QAAA,WAAW,GAAG,uBAAuB,CAAC;AAEnD;;;GAGG;AACU,QAAA,gBAAgB,GAAG,SAAS,CAAC;AAE1C,oBAAoB;AAEpB,MAAM,yBAAyB,GAAG,CAAC,kBAAkB,CAAU,CAAC;AAkChE,6BAA6B;AAE7B;;;;;GAKG;AACH,SAAS,iBAAiB,CAAC,GAAQ;IACjC,MAAM,SAAS,GAAG,GAAG,KAAK,WAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,CAAC;IACnD,OAAO,mBAAmB,SAAS,qBAAqB,aAAa,EAAE,CAAC;AAC1E,CAAC;AAUD;;;;;;;;;;;;GAYG;AACH,MAAa,qBAAqB;IA2BhC;;;;;;;;;;;;OAYG;IACH,YAAY,EACV,SAAS,EACT,GAAG,GAAG,WAAG,CAAC,GAAG,EACb,KAAK,EAAE,aAAa,GAAG,UAAU,CAAC,KAAK,EACvC,KAAK,EACL,aAAa,GAAG,EAAE,GAOnB;;QA9CQ,mDAA2C;QAE3C,+CAAgC;QAEhC,6CAAa;QAEb,+CAAe;QAExB;;;;WAIG;QACM,gDAAuB;QAEhC,gDAA0B,wBAAgB,EAAC;QAE3C,+CAAgC,IAAI,EAAC;QAErC,8CAAwC,IAAI,EAAC;QA4B3C,IAAI,CAAC,IAAI,GAAG,mBAAW,CAAC;QACxB,uBAAA,IAAI,oCAAc,SAAS,MAAA,CAAC;QAC5B,uBAAA,IAAI,8BAAQ,iBAAiB,CAAC,GAAG,CAAC,MAAA,CAAC;QACnC,uBAAA,IAAI,gCAAU,aAAa,MAAA,CAAC;QAC5B,uBAAA,IAAI,gCAAU,KAAK,IAAI,cAAc,MAAA,CAAC;QACtC,uBAAA,IAAI,iCAAW,IAAA,sCAAmB,EAAC,aAAa,CAAC,MAAA,CAAC;QAElD,uBAAA,IAAI,wCAAW,CAAC,4BAA4B,CAC1C,IAAI,EACJ,yBAAyB,CAC1B,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,OAAO,CAAC,QAAiD;QACvD,OAAO,uBAAA,IAAI,qCAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;OAOG;IACH,OAAO,CAAC,QAAiD;QACvD,OAAO,uBAAA,IAAI,qCAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;OAOG;IACH,UAAU,CACR,QAAoD;QAEpD,OAAO,uBAAA,IAAI,qCAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,gBAAgB,CAAC,OAAiC;QACtD,IAAI,OAAO,EAAE,WAAW,EAAE,CAAC;YACzB,uBAAA,IAAI,wCAAkB,IAAI,MAAA,CAAC;QAC7B,CAAC;QAED,IAAI,uBAAA,IAAI,6EAAc,MAAlB,IAAI,CAAgB,EAAE,CAAC;YACzB,OAAO,uBAAA,IAAI,6CAAgB,CAAC;QAC9B,CAAC;QAED,IAAI,uBAAA,IAAI,2CAAc,EAAE,CAAC;YACvB,OAAO,uBAAA,IAAI,2CAAc,CAAC;QAC5B,CAAC;QAED,MAAM,OAAO,GAAG,uBAAA,IAAI,6EAAc,MAAlB,IAAI,CAAgB,CAAC;QACrC,uBAAA,IAAI,uCAAiB,OAAO,MAAA,CAAC;QAE7B,IAAI,CAAC;YACH,OAAO,MAAM,OAAO,CAAC;QACvB,CAAC;gBAAS,CAAC;YACT,uBAAA,IAAI,uCAAiB,IAAI,MAAA,CAAC;QAC5B,CAAC;IACH,CAAC;CA0CF;AAnLD,sDAmLC;;IAlCG,OAAO,CACL,uBAAA,IAAI,4CAAe,KAAK,IAAI;QAC5B,IAAI,CAAC,GAAG,EAAE,GAAG,uBAAA,IAAI,4CAAe,GAAG,uBAAA,IAAI,oCAAO,CAC/C,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,KAAK;IACH,MAAM,QAAQ,GAAG,MAAM,uBAAA,IAAI,qCAAQ,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE;QACrD,MAAM,aAAa,GAAG,MAAM,uBAAA,IAAI,oCAAO,MAAX,IAAI,EAAQ,uBAAA,IAAI,kCAAK,CAAC,CAAC;QACnD,IAAI,CAAC,aAAa,CAAC,EAAE,EAAE,CAAC;YACtB,MAAM,IAAI,4BAAS,CACjB,aAAa,CAAC,MAAM,EACpB,6BAA6B,aAAa,CAAC,MAAM,EAAE,CACpD,CAAC;QACJ,CAAC;QACD,OAAO,aAAa,CAAC;IACvB,CAAC,CAAC,CAAC;IAEH,MAAM,GAAG,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IAC3C,MAAM,QAAQ,GAAG,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,wBAAgB,CAAC;IAElE,IAAI,QAAQ,KAAK,wBAAgB,EAAE,CAAC;QAClC,uBAAA,IAAI,yCAAmB,QAAQ,MAAA,CAAC;QAChC,uBAAA,IAAI,wCAAkB,IAAI,CAAC,GAAG,EAAE,MAAA,CAAC;IACnC,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC","sourcesContent":["import type {\n  CreateServicePolicyOptions,\n  ServicePolicy,\n} from '@metamask/controller-utils';\nimport { createServicePolicy, HttpError } from '@metamask/controller-utils';\nimport type { Messenger } from '@metamask/messenger';\nimport type { IDisposable } from 'cockatiel';\n\nimport type { GeolocationApiServiceMethodActions } from './geolocation-api-service-method-action-types';\nimport { Env } from '../types';\n\nconst DEFAULT_TTL_MS = 5 * 60 * 1000;\n\nconst ENDPOINT_PATH = '/geolocation';\n\n// === GENERAL ===\n\n/**\n * The name of the {@link GeolocationApiService}, used to namespace the\n * service's actions and events.\n */\nexport const serviceName = 'GeolocationApiService';\n\n/**\n * Sentinel value used when the geolocation has not been determined yet or when\n * the API returns an empty / invalid response.\n */\nexport const UNKNOWN_LOCATION = 'UNKNOWN';\n\n// === MESSENGER ===\n\nconst MESSENGER_EXPOSED_METHODS = ['fetchGeolocation'] as const;\n\n/**\n * Actions that {@link GeolocationApiService} exposes to other consumers.\n */\nexport type GeolocationApiServiceActions = GeolocationApiServiceMethodActions;\n\n/**\n * Actions from other messengers that {@link GeolocationApiServiceMessenger}\n * calls.\n */\ntype AllowedActions = never;\n\n/**\n * Events that {@link GeolocationApiService} exposes to other consumers.\n */\nexport type GeolocationApiServiceEvents = never;\n\n/**\n * Events from other messengers that {@link GeolocationApiService} subscribes\n * to.\n */\ntype AllowedEvents = never;\n\n/**\n * The messenger restricted to actions and events accessed by\n * {@link GeolocationApiService}.\n */\nexport type GeolocationApiServiceMessenger = Messenger<\n  typeof serviceName,\n  GeolocationApiServiceActions | AllowedActions,\n  GeolocationApiServiceEvents | AllowedEvents\n>;\n\n// === SERVICE DEFINITION ===\n\n/**\n * Returns the base URL for the geolocation API for the given environment.\n *\n * @param env - The environment to get the URL for.\n * @returns The full URL for the geolocation endpoint.\n */\nfunction getGeolocationUrl(env: Env): string {\n  const envPrefix = env === Env.PRD ? '' : `${env}-`;\n  return `https://on-ramp.${envPrefix}api.cx.metamask.io${ENDPOINT_PATH}`;\n}\n\n/**\n * Options accepted by {@link GeolocationApiService.fetchGeolocation}.\n */\nexport type FetchGeolocationOptions = {\n  /** When true, the TTL cache is invalidated so the next request fetches fresh data. */\n  bypassCache?: boolean;\n};\n\n/**\n * Low-level data service that fetches a country code from the geolocation API.\n *\n * Responsibilities:\n * - HTTP request to the geolocation endpoint (wrapped in a service policy)\n * - ISO 3166-1 alpha-2 response validation\n * - TTL-based in-memory cache\n * - Promise deduplication (concurrent callers share a single in-flight request)\n *\n * This class is intentionally not a controller: it does not manage UI state.\n * Its {@link fetchGeolocation} method is automatically registered on the\n * messenger so that controllers and other packages can call it directly.\n */\nexport class GeolocationApiService {\n  /**\n   * The name of the service.\n   */\n  readonly name: typeof serviceName;\n\n  readonly #messenger: GeolocationApiServiceMessenger;\n\n  readonly #fetch: typeof globalThis.fetch;\n\n  readonly #url: string;\n\n  readonly #ttlMs: number;\n\n  /**\n   * The policy that wraps each HTTP request.\n   *\n   * @see {@link createServicePolicy}\n   */\n  readonly #policy: ServicePolicy;\n\n  #cachedLocation: string = UNKNOWN_LOCATION;\n\n  #lastFetchedAt: number | null = null;\n\n  #fetchPromise: Promise<string> | null = null;\n\n  /**\n   * Constructs a new {@link GeolocationApiService}.\n   *\n   * @param args - The constructor arguments.\n   * @param args.messenger - The messenger suited for this service.\n   * @param args.env - The environment to determine the correct API endpoint.\n   * Defaults to PRD.\n   * @param args.fetch - A function that can be used to make an HTTP request.\n   * Defaults to the global fetch.\n   * @param args.ttlMs - Cache TTL in milliseconds. Defaults to 5 minutes.\n   * @param args.policyOptions - Options to pass to `createServicePolicy`, which\n   * is used to wrap each request. See {@link CreateServicePolicyOptions}.\n   */\n  constructor({\n    messenger,\n    env = Env.PRD,\n    fetch: fetchFunction = globalThis.fetch,\n    ttlMs,\n    policyOptions = {},\n  }: {\n    messenger: GeolocationApiServiceMessenger;\n    env?: Env;\n    fetch?: typeof fetch;\n    ttlMs?: number;\n    policyOptions?: CreateServicePolicyOptions;\n  }) {\n    this.name = serviceName;\n    this.#messenger = messenger;\n    this.#url = getGeolocationUrl(env);\n    this.#fetch = fetchFunction;\n    this.#ttlMs = ttlMs ?? DEFAULT_TTL_MS;\n    this.#policy = createServicePolicy(policyOptions);\n\n    this.#messenger.registerMethodActionHandlers(\n      this,\n      MESSENGER_EXPOSED_METHODS,\n    );\n  }\n\n  /**\n   * Registers a handler that will be called after a request returns a 5xx\n   * response, causing a retry.\n   *\n   * @param listener - The handler to be called.\n   * @returns An object that can be used to unregister the handler.\n   * @see {@link createServicePolicy}\n   */\n  onRetry(listener: Parameters<ServicePolicy['onRetry']>[0]): IDisposable {\n    return this.#policy.onRetry(listener);\n  }\n\n  /**\n   * Registers a handler that will be called after a set number of retry rounds\n   * prove that requests to the API endpoint consistently return a 5xx response.\n   *\n   * @param listener - The handler to be called.\n   * @returns An object that can be used to unregister the handler.\n   * @see {@link createServicePolicy}\n   */\n  onBreak(listener: Parameters<ServicePolicy['onBreak']>[0]): IDisposable {\n    return this.#policy.onBreak(listener);\n  }\n\n  /**\n   * Registers a handler that will be called when requests are consistently\n   * failing or when a successful request takes longer than the degraded\n   * threshold.\n   *\n   * @param listener - The handler to be called.\n   * @returns An object that can be used to unregister the handler.\n   */\n  onDegraded(\n    listener: Parameters<ServicePolicy['onDegraded']>[0],\n  ): IDisposable {\n    return this.#policy.onDegraded(listener);\n  }\n\n  /**\n   * Returns the geolocation country code. Serves from cache when the TTL has\n   * not expired, otherwise performs a network fetch. Concurrent callers are\n   * deduplicated to a single in-flight request.\n   *\n   * @param options - Optional fetch options.\n   * @param options.bypassCache - When true, invalidates the TTL cache. If a\n   * request is already in-flight it will be reused (deduplication always\n   * applies).\n   * @returns The ISO 3166-1 alpha-2 country code, or {@link UNKNOWN_LOCATION}\n   * when the API returns an empty or invalid body.\n   */\n  async fetchGeolocation(options?: FetchGeolocationOptions): Promise<string> {\n    if (options?.bypassCache) {\n      this.#lastFetchedAt = null;\n    }\n\n    if (this.#isCacheValid()) {\n      return this.#cachedLocation;\n    }\n\n    if (this.#fetchPromise) {\n      return this.#fetchPromise;\n    }\n\n    const promise = this.#performFetch();\n    this.#fetchPromise = promise;\n\n    try {\n      return await promise;\n    } finally {\n      this.#fetchPromise = null;\n    }\n  }\n\n  /**\n   * Checks whether the cached geolocation is still within the TTL window.\n   *\n   * @returns True if the cache is valid.\n   */\n  #isCacheValid(): boolean {\n    return (\n      this.#lastFetchedAt !== null &&\n      Date.now() - this.#lastFetchedAt < this.#ttlMs\n    );\n  }\n\n  /**\n   * Performs the actual HTTP fetch, wrapped in the service policy for automatic\n   * retry and circuit-breaking, and validates the response.\n   *\n   * @returns The ISO country code string.\n   */\n  async #performFetch(): Promise<string> {\n    const response = await this.#policy.execute(async () => {\n      const localResponse = await this.#fetch(this.#url);\n      if (!localResponse.ok) {\n        throw new HttpError(\n          localResponse.status,\n          `Geolocation fetch failed: ${localResponse.status}`,\n        );\n      }\n      return localResponse;\n    });\n\n    const raw = (await response.text()).trim();\n    const location = /^[A-Z]{2}$/u.test(raw) ? raw : UNKNOWN_LOCATION;\n\n    if (location !== UNKNOWN_LOCATION) {\n      this.#cachedLocation = location;\n      this.#lastFetchedAt = Date.now();\n    }\n\n    return location;\n  }\n}\n"]}

package/dist/geolocation-api-service/geolocation-api-service.d.cts

@@ -0,0 +1,127 @@
+import type { CreateServicePolicyOptions, ServicePolicy } from "@metamask/controller-utils";
+import type { Messenger } from "@metamask/messenger";
+import type { IDisposable } from "cockatiel";
+import type { GeolocationApiServiceMethodActions } from "./geolocation-api-service-method-action-types.cjs";
+import { Env } from "../types.cjs";
+/**
+ * The name of the {@link GeolocationApiService}, used to namespace the
+ * service's actions and events.
+ */
+export declare const serviceName = "GeolocationApiService";
+/**
+ * Sentinel value used when the geolocation has not been determined yet or when
+ * the API returns an empty / invalid response.
+ */
+export declare const UNKNOWN_LOCATION = "UNKNOWN";
+/**
+ * Actions that {@link GeolocationApiService} exposes to other consumers.
+ */
+export type GeolocationApiServiceActions = GeolocationApiServiceMethodActions;
+/**
+ * Actions from other messengers that {@link GeolocationApiServiceMessenger}
+ * calls.
+ */
+type AllowedActions = never;
+/**
+ * Events that {@link GeolocationApiService} exposes to other consumers.
+ */
+export type GeolocationApiServiceEvents = never;
+/**
+ * Events from other messengers that {@link GeolocationApiService} subscribes
+ * to.
+ */
+type AllowedEvents = never;
+/**
+ * The messenger restricted to actions and events accessed by
+ * {@link GeolocationApiService}.
+ */
+export type GeolocationApiServiceMessenger = Messenger<typeof serviceName, GeolocationApiServiceActions | AllowedActions, GeolocationApiServiceEvents | AllowedEvents>;
+/**
+ * Options accepted by {@link GeolocationApiService.fetchGeolocation}.
+ */
+export type FetchGeolocationOptions = {
+    /** When true, the TTL cache is invalidated so the next request fetches fresh data. */
+    bypassCache?: boolean;
+};
+/**
+ * Low-level data service that fetches a country code from the geolocation API.
+ *
+ * Responsibilities:
+ * - HTTP request to the geolocation endpoint (wrapped in a service policy)
+ * - ISO 3166-1 alpha-2 response validation
+ * - TTL-based in-memory cache
+ * - Promise deduplication (concurrent callers share a single in-flight request)
+ *
+ * This class is intentionally not a controller: it does not manage UI state.
+ * Its {@link fetchGeolocation} method is automatically registered on the
+ * messenger so that controllers and other packages can call it directly.
+ */
+export declare class GeolocationApiService {
+    #private;
+    /**
+     * The name of the service.
+     */
+    readonly name: typeof serviceName;
+    /**
+     * Constructs a new {@link GeolocationApiService}.
+     *
+     * @param args - The constructor arguments.
+     * @param args.messenger - The messenger suited for this service.
+     * @param args.env - The environment to determine the correct API endpoint.
+     * Defaults to PRD.
+     * @param args.fetch - A function that can be used to make an HTTP request.
+     * Defaults to the global fetch.
+     * @param args.ttlMs - Cache TTL in milliseconds. Defaults to 5 minutes.
+     * @param args.policyOptions - Options to pass to `createServicePolicy`, which
+     * is used to wrap each request. See {@link CreateServicePolicyOptions}.
+     */
+    constructor({ messenger, env, fetch: fetchFunction, ttlMs, policyOptions, }: {
+        messenger: GeolocationApiServiceMessenger;
+        env?: Env;
+        fetch?: typeof fetch;
+        ttlMs?: number;
+        policyOptions?: CreateServicePolicyOptions;
+    });
+    /**
+     * Registers a handler that will be called after a request returns a 5xx
+     * response, causing a retry.
+     *
+     * @param listener - The handler to be called.
+     * @returns An object that can be used to unregister the handler.
+     * @see {@link createServicePolicy}
+     */
+    onRetry(listener: Parameters<ServicePolicy['onRetry']>[0]): IDisposable;
+    /**
+     * Registers a handler that will be called after a set number of retry rounds
+     * prove that requests to the API endpoint consistently return a 5xx response.
+     *
+     * @param listener - The handler to be called.
+     * @returns An object that can be used to unregister the handler.
+     * @see {@link createServicePolicy}
+     */
+    onBreak(listener: Parameters<ServicePolicy['onBreak']>[0]): IDisposable;
+    /**
+     * Registers a handler that will be called when requests are consistently
+     * failing or when a successful request takes longer than the degraded
+     * threshold.
+     *
+     * @param listener - The handler to be called.
+     * @returns An object that can be used to unregister the handler.
+     */
+    onDegraded(listener: Parameters<ServicePolicy['onDegraded']>[0]): IDisposable;
+    /**
+     * Returns the geolocation country code. Serves from cache when the TTL has
+     * not expired, otherwise performs a network fetch. Concurrent callers are
+     * deduplicated to a single in-flight request.
+     *
+     * @param options - Optional fetch options.
+     * @param options.bypassCache - When true, invalidates the TTL cache. If a
+     * request is already in-flight it will be reused (deduplication always
+     * applies).
+     * @returns The ISO 3166-1 alpha-2 country code, or {@link UNKNOWN_LOCATION}
+     * when the API returns an empty or invalid body.
+     */
+    fetchGeolocation(options?: FetchGeolocationOptions): Promise<string>;
+}
+export {};
+//# sourceMappingURL=geolocation-api-service.d.cts.map

package/dist/geolocation-api-service/geolocation-api-service.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"geolocation-api-service.d.cts","sourceRoot":"","sources":["../../src/geolocation-api-service/geolocation-api-service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,0BAA0B,EAC1B,aAAa,EACd,mCAAmC;AAEpC,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AACrD,OAAO,KAAK,EAAE,WAAW,EAAE,kBAAkB;AAE7C,OAAO,KAAK,EAAE,kCAAkC,EAAE,0DAAsD;AACxG,OAAO,EAAE,GAAG,EAAE,qBAAiB;AAQ/B;;;GAGG;AACH,eAAO,MAAM,WAAW,0BAA0B,CAAC;AAEnD;;;GAGG;AACH,eAAO,MAAM,gBAAgB,YAAY,CAAC;AAM1C;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG,kCAAkC,CAAC;AAE9E;;;GAGG;AACH,KAAK,cAAc,GAAG,KAAK,CAAC;AAE5B;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG,KAAK,CAAC;AAEhD;;;GAGG;AACH,KAAK,aAAa,GAAG,KAAK,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,8BAA8B,GAAG,SAAS,CACpD,OAAO,WAAW,EAClB,4BAA4B,GAAG,cAAc,EAC7C,2BAA2B,GAAG,aAAa,CAC5C,CAAC;AAeF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC,sFAAsF;IACtF,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,qBAAa,qBAAqB;;IAChC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,OAAO,WAAW,CAAC;IAuBlC;;;;;;;;;;;;OAYG;gBACS,EACV,SAAS,EACT,GAAa,EACb,KAAK,EAAE,aAAgC,EACvC,KAAK,EACL,aAAkB,GACnB,EAAE;QACD,SAAS,EAAE,8BAA8B,CAAC;QAC1C,GAAG,CAAC,EAAE,GAAG,CAAC;QACV,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;QACrB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,aAAa,CAAC,EAAE,0BAA0B,CAAC;KAC5C;IAcD;;;;;;;OAOG;IACH,OAAO,CAAC,QAAQ,EAAE,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW;IAIvE;;;;;;;OAOG;IACH,OAAO,CAAC,QAAQ,EAAE,UAAU,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,WAAW;IAIvE;;;;;;;OAOG;IACH,UAAU,CACR,QAAQ,EAAE,UAAU,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,GACnD,WAAW;IAId;;;;;;;;;;;OAWG;IACG,gBAAgB,CAAC,OAAO,CAAC,EAAE,uBAAuB,GAAG,OAAO,CAAC,MAAM,CAAC;CA+D3E"}