Merge pull request #650 from Telegram-Mini-Apps/feature/location-mana…

…ger-open-settings feat(sdk): implement locationManager.openSettings. Export it and the unmount function
Telegram-Mini-Apps · Feb 3, 2025 · 99dcf41 · 99dcf41
2 parents 7566bdc + c36aa39
commit 99dcf41
Show file tree

Hide file tree

Showing 5 changed files with 58 additions and 3 deletions.
diff --git a/.changeset/eighty-donkeys-collect.md b/.changeset/eighty-donkeys-collect.md
@@ -0,0 +1,5 @@
+---
+"@telegram-apps/sdk": minor
+---
+
+Implement `locationManager.openSettings` method. Exports location manager's `unmount` method. Fix invalid method name for `requestLocation`
diff --git a/packages/sdk/src/scopes/components/location-manager/exports.ts b/packages/sdk/src/scopes/components/location-manager/exports.ts
@@ -12,5 +12,7 @@ export {
   requestLocation,
   mountPromise as locationManagerMountPromise,
   isAvailable as isLocationManagerAvailable,
+  openSettings as openLocationManagerSettings,
+  unmount as unmountLocationManager,
 } from './exports.variable.js';
 export * as locationManager from './exports.variable.js';
diff --git a/packages/sdk/src/scopes/components/location-manager/exports.variable.ts b/packages/sdk/src/scopes/components/location-manager/exports.variable.ts
@@ -12,4 +12,6 @@ export {
   requestLocation,
   mountPromise,
   isAvailable,
+  openSettings,
+  unmount,
 } from './location-manager.js';
diff --git a/packages/sdk/src/scopes/components/location-manager/location-manager.test.ts b/packages/sdk/src/scopes/components/location-manager/location-manager.test.ts
@@ -0,0 +1,28 @@
+import { beforeEach, describe, vi } from 'vitest';
+
+import { testSafety } from '@test-utils/predefined/testSafety.js';
+import {
+  openSettings,
+  requestLocation,
+  mount,
+  _isMounted,
+} from '@/scopes/components/location-manager/location-manager.js';
+import { mockPostEvent, resetPackageState } from '@test-utils/utils.js';
+
+beforeEach(() => {
+  resetPackageState();
+  vi.restoreAllMocks();
+  mockPostEvent();
+});
+
+describe.each([
+  ['requestLocation', requestLocation, _isMounted],
+  ['openSettings', openSettings, undefined],
+  ['mount', mount, undefined],
+] as const)('%s', (name, fn, isMounted) => {
+  testSafety(fn, name, {
+    component: 'locationManager',
+    minVersion: '8.0',
+    isMounted,
+  });
+});
diff --git a/packages/sdk/src/scopes/components/location-manager/location-manager.ts b/packages/sdk/src/scopes/components/location-manager/location-manager.ts
@@ -5,7 +5,7 @@ import type { EventPayload } from '@telegram-apps/bridge';
 import type { Computed } from '@telegram-apps/signals';
 
 import { defineMountFn } from '@/scopes/defineMountFn.js';
-import { request } from '@/globals.js';
+import { postEvent, request } from '@/globals.js';
 import { createWrapComplete } from '@/scopes/wrappers/createWrapComplete.js';
 import { createWrapSupported } from '@/scopes/wrappers/createWrapSupported.js';
 import { NotAvailableError } from '@/errors.js';
@@ -16,6 +16,7 @@ import { createComputed, createSignal } from '@/signals-registry.js';
 
 const COMPONENT_NAME = 'locationManager';
 const CHECK_LOCATION_METHOD = 'web_app_check_location';
+const OPEN_SETTINGS_METHOD = 'web_app_open_location_settings';
 
 export interface State {
   /**
@@ -70,7 +71,6 @@ export const isAccessRequested = fromState('accessRequested');
  * @see location_checked
  */
 function eventToState(event: EventPayload<'location_checked'>): State {
-  console.log(event);
   let available = false;
   let accessRequested: Maybe<boolean>;
   let accessGranted: Maybe<boolean>;
@@ -159,10 +159,28 @@ const [
  *   const location = await requestLocation();
  * }
  */
-export const requestLocation = wrapComplete('getLocation', reqLocationFn);
+export const requestLocation = wrapComplete('requestLocation', reqLocationFn);
 export const [, requestLocationPromise, isRequestingLocation] = tReqLocationPromise;
 export const [, requestLocationError] = tReqLocationError;
 
+/**
+ * Opens the location access settings for bots. Useful when you need to request location access
+ * from users who haven't granted it yet.
+ *
+ * Note that this method can be called only in response to user interaction with the Mini App
+ * interface (e.g., a click inside the Mini App or on the main button).
+ * @since Mini Apps v8.0
+ * @throws {FunctionNotAvailableError} The environment is unknown
+ * @throws {FunctionNotAvailableError} The SDK is not initialized
+ * @throws {FunctionNotAvailableError} The function is not supported
+ * @example
+ * if (openSettings.isAvailable()) {
+ *   openSettings();
+ * }
+ */
+export const openSettings = wrapSupported('openSettings', () => {
+  postEvent(OPEN_SETTINGS_METHOD);
+}, OPEN_SETTINGS_METHOD);
 
 /**
  * Unmounts the component.