@mentra/sdk 2.1.27 → 2.1.28

package/dist/utils/permissions-utils.js

@@ -1,263 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.cameraWarnLog = exports.postNotificationWarnLog = exports.readNotificationWarnLog = exports.calendarWarnLog = exports.backgroundLocationWarnLog = exports.locationWarnLog = exports.microPhoneWarnLog = void 0;
-/**
- * permissions-utils.ts
- *
- * This file provides runtime permission validation utilities for the MentraOS SDK.
- *
- * Each function queries the public permissions API endpoint to check if an app
- * has declared the required permission for a specific feature. If the permission
- * is missing, a styled warning message is displayed in the terminal.
- *
- * Key features:
- * - Fetches app permissions from /api/public/permissions/:packageName
- * - Gracefully handles offline/unreachable endpoints (silent failure)
- * - Displays professional bordered warnings when permissions are missing
- * - Non-blocking - allows app execution to continue even if checks fail
- *
- * These functions are called automatically by SDK methods that require specific
- * permissions (e.g., microphone access, location tracking, camera, etc.) to help
- * developers identify missing permission declarations during development.
- */
-const warning_1 = require("../constants/log-messages/warning");
-// Check if app has microphone permission, warn if missing
-const microPhoneWarnLog = (cloudServerUrl, packageName, funcName) => {
-    if (!cloudServerUrl)
-        return;
-    const permissionsUrl = `${cloudServerUrl}/api/public/permissions/${encodeURIComponent(packageName)}`;
-    // console.log(`Fetching permissions from: ${permissionsUrl}`);
-    fetch(permissionsUrl)
-        .then(async (res) => {
-        const contentType = res.headers.get("content-type");
-        if (!res.ok) {
-            console.warn(`Permission API returned ${res.status}: ${res.statusText}`);
-            return null;
-        }
-        if (contentType && contentType.includes("application/json")) {
-            return (await res.json());
-        }
-        else {
-            const text = await res.text();
-            console.warn(`Permission API returned non-JSON response: ${text}`);
-            return null;
-        }
-    })
-        .then((data) => {
-        if (data) {
-            const hasMic = data.permissions.some((p) => p.type === "MICROPHONE");
-            if (!hasMic) {
-                console.log((0, warning_1.noMicrophoneWarn)(funcName, packageName));
-            }
-        }
-    })
-        .catch((err) => {
-        // Silently fail if endpoint is unreachable - don't block execution
-        console.debug("Permission check skipped - endpoint unreachable:", err.message);
-    });
-};
-exports.microPhoneWarnLog = microPhoneWarnLog;
-// Check if app has location permission, warn if missing
-const locationWarnLog = (cloudServerUrl, packageName, funcName) => {
-    if (!cloudServerUrl)
-        return;
-    const permissionsUrl = `${cloudServerUrl}/api/public/permissions/${encodeURIComponent(packageName)}`;
-    fetch(permissionsUrl)
-        .then(async (res) => {
-        const contentType = res.headers.get("content-type");
-        if (!res.ok) {
-            console.warn(`Permission API returned ${res.status}: ${res.statusText}`);
-            return null;
-        }
-        if (contentType && contentType.includes("application/json")) {
-            return (await res.json());
-        }
-        else {
-            const text = await res.text();
-            console.warn(`Permission API returned non-JSON response: ${text}`);
-            return null;
-        }
-    })
-        .then((data) => {
-        if (data) {
-            const hasLocation = data.permissions.some((p) => p.type === "LOCATION");
-            if (!hasLocation) {
-                console.log((0, warning_1.locationWarn)(funcName, packageName));
-            }
-        }
-    })
-        .catch((err) => {
-        console.debug("Permission check skipped - endpoint unreachable:", err.message);
-    });
-};
-exports.locationWarnLog = locationWarnLog;
-// Check if app has background location permission, warn if missing
-const backgroundLocationWarnLog = (cloudServerUrl, packageName, funcName) => {
-    if (!cloudServerUrl)
-        return;
-    const permissionsUrl = `${cloudServerUrl}/api/public/permissions/${encodeURIComponent(packageName)}`;
-    fetch(permissionsUrl)
-        .then(async (res) => {
-        const contentType = res.headers.get("content-type");
-        if (!res.ok) {
-            console.warn(`Permission API returned ${res.status}: ${res.statusText}`);
-            return null;
-        }
-        if (contentType && contentType.includes("application/json")) {
-            return (await res.json());
-        }
-        else {
-            const text = await res.text();
-            console.warn(`Permission API returned non-JSON response: ${text}`);
-            return null;
-        }
-    })
-        .then((data) => {
-        if (data) {
-            const hasBackgroundLocation = data.permissions.some((p) => p.type === "BACKGROUND_LOCATION");
-            if (!hasBackgroundLocation) {
-                console.log((0, warning_1.baackgroundLocationWarn)(funcName, packageName));
-            }
-        }
-    })
-        .catch((err) => {
-        console.debug("Permission check skipped - endpoint unreachable:", err.message);
-    });
-};
-exports.backgroundLocationWarnLog = backgroundLocationWarnLog;
-// Check if app has calendar permission, warn if missing
-const calendarWarnLog = (cloudServerUrl, packageName, funcName) => {
-    if (!cloudServerUrl)
-        return;
-    const permissionsUrl = `${cloudServerUrl}/api/public/permissions/${encodeURIComponent(packageName)}`;
-    fetch(permissionsUrl)
-        .then(async (res) => {
-        const contentType = res.headers.get("content-type");
-        if (!res.ok) {
-            console.warn(`Permission API returned ${res.status}: ${res.statusText}`);
-            return null;
-        }
-        if (contentType && contentType.includes("application/json")) {
-            return (await res.json());
-        }
-        else {
-            const text = await res.text();
-            console.warn(`Permission API returned non-JSON response: ${text}`);
-            return null;
-        }
-    })
-        .then((data) => {
-        if (data) {
-            const hasCalendar = data.permissions.some((p) => p.type === "CALENDAR");
-            if (!hasCalendar) {
-                console.log((0, warning_1.calendarWarn)(funcName, packageName));
-            }
-        }
-    })
-        .catch((err) => {
-        console.debug("Permission check skipped - endpoint unreachable:", err.message);
-    });
-};
-exports.calendarWarnLog = calendarWarnLog;
-// Check if app has read notifications permission, warn if missing
-const readNotificationWarnLog = (cloudServerUrl, packageName, funcName) => {
-    if (!cloudServerUrl)
-        return;
-    const permissionsUrl = `${cloudServerUrl}/api/public/permissions/${encodeURIComponent(packageName)}`;
-    fetch(permissionsUrl)
-        .then(async (res) => {
-        const contentType = res.headers.get("content-type");
-        if (!res.ok) {
-            console.warn(`Permission API returned ${res.status}: ${res.statusText}`);
-            return null;
-        }
-        if (contentType && contentType.includes("application/json")) {
-            return (await res.json());
-        }
-        else {
-            const text = await res.text();
-            console.warn(`Permission API returned non-JSON response: ${text}`);
-            return null;
-        }
-    })
-        .then((data) => {
-        if (data) {
-            const hasReadNotifications = data.permissions.some((p) => p.type === "READ_NOTIFICATIONS");
-            if (!hasReadNotifications) {
-                console.log((0, warning_1.readNotficationWarn)(funcName, packageName));
-            }
-        }
-    })
-        .catch((err) => {
-        console.debug("Permission check skipped - endpoint unreachable:", err.message);
-    });
-};
-exports.readNotificationWarnLog = readNotificationWarnLog;
-// Check if app has post notifications permission, warn if missing
-const postNotificationWarnLog = (cloudServerUrl, packageName, funcName) => {
-    if (!cloudServerUrl)
-        return;
-    const permissionsUrl = `${cloudServerUrl}/api/public/permissions/${encodeURIComponent(packageName)}`;
-    fetch(permissionsUrl)
-        .then(async (res) => {
-        const contentType = res.headers.get("content-type");
-        if (!res.ok) {
-            console.warn(`Permission API returned ${res.status}: ${res.statusText}`);
-            return null;
-        }
-        if (contentType && contentType.includes("application/json")) {
-            return (await res.json());
-        }
-        else {
-            const text = await res.text();
-            console.warn(`Permission API returned non-JSON response: ${text}`);
-            return null;
-        }
-    })
-        .then((data) => {
-        if (data) {
-            const hasPostNotifications = data.permissions.some((p) => p.type === "POST_NOTIFICATIONS");
-            if (!hasPostNotifications) {
-                console.log((0, warning_1.postNotficationWarn)(funcName, packageName));
-            }
-        }
-    })
-        .catch((err) => {
-        console.debug("Permission check skipped - endpoint unreachable:", err.message);
-    });
-};
-exports.postNotificationWarnLog = postNotificationWarnLog;
-// Check if app has camera permission, warn if missing
-const cameraWarnLog = (cloudServerUrl, packageName, funcName) => {
-    if (!cloudServerUrl)
-        return;
-    const permissionsUrl = `${cloudServerUrl}/api/public/permissions/${encodeURIComponent(packageName)}`;
-    fetch(permissionsUrl)
-        .then(async (res) => {
-        const contentType = res.headers.get("content-type");
-        if (!res.ok) {
-            console.warn(`Permission API returned ${res.status}: ${res.statusText}`);
-            return null;
-        }
-        if (contentType && contentType.includes("application/json")) {
-            return (await res.json());
-        }
-        else {
-            const text = await res.text();
-            console.warn(`Permission API returned non-JSON response: ${text}`);
-            return null;
-        }
-    })
-        .then((data) => {
-        if (data) {
-            const hasCamera = data.permissions.some((p) => p.type === "CAMERA");
-            if (!hasCamera) {
-                console.log((0, warning_1.cameraWarn)(funcName, packageName));
-            }
-        }
-    })
-        .catch((err) => {
-        console.debug("Permission check skipped - endpoint unreachable:", err.message);
-    });
-};
-exports.cameraWarnLog = cameraWarnLog;

package/dist/utils/resource-tracker.js

@@ -1,153 +0,0 @@
-"use strict";
-/**
- * Resource Tracker
- *
- * A utility class for tracking and automatically cleaning up resources
- * like timers, event listeners, and other disposable objects.
- *
- * This helps prevent memory leaks by ensuring that all resources are
- * properly disposed when they're no longer needed.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ResourceTracker = void 0;
-exports.createResourceTracker = createResourceTracker;
-/**
- * Manages resources to prevent memory leaks
- */
-class ResourceTracker {
-    constructor() {
-        // Collection of cleanup functions to call when dispose() is called
-        this.cleanupFunctions = [];
-        // Flag to track if this resource tracker has been disposed
-        this.isDisposed = false;
-    }
-    /**
-     * Add a cleanup function to be executed when dispose() is called
-     *
-     * @param cleanup - The cleanup function to register
-     * @returns A function that will remove this cleanup function
-     */
-    track(cleanup) {
-        if (this.isDisposed) {
-            throw new Error('Cannot track resources on a disposed ResourceTracker');
-        }
-        this.cleanupFunctions.push(cleanup);
-        // Return a function that will remove this cleanup function
-        return () => {
-            const index = this.cleanupFunctions.indexOf(cleanup);
-            if (index !== -1) {
-                this.cleanupFunctions.splice(index, 1);
-            }
-        };
-    }
-    /**
-     * Track a disposable object (anything with a dispose or close method)
-     *
-     * @param disposable - The object to track
-     * @returns A function that will remove this disposable
-     */
-    trackDisposable(disposable) {
-        return this.track(() => {
-            if (typeof disposable.dispose === 'function') {
-                disposable.dispose();
-            }
-            else if (typeof disposable.close === 'function') {
-                disposable.close();
-            }
-        });
-    }
-    /**
-     * Track a timer and ensure it gets cleared
-     *
-     * @param timerId - The timer ID to track
-     * @param isInterval - Whether this is an interval (true) or timeout (false)
-     * @returns A function that will remove this timer
-     */
-    trackTimer(timerId, isInterval = false) {
-        return this.track(() => {
-            if (isInterval) {
-                clearInterval(timerId);
-            }
-            else {
-                clearTimeout(timerId);
-            }
-        });
-    }
-    /**
-     * Track a timeout and ensure it gets cleared
-     *
-     * @param timerId - The timeout ID to track
-     * @returns A function that will remove this timeout
-     */
-    trackTimeout(timerId) {
-        return this.trackTimer(timerId, false);
-    }
-    /**
-     * Track an interval and ensure it gets cleared
-     *
-     * @param timerId - The interval ID to track
-     * @returns A function that will remove this interval
-     */
-    trackInterval(timerId) {
-        return this.trackTimer(timerId, true);
-    }
-    /**
-     * Create a tracked timeout
-     *
-     * @param callback - Function to call when the timeout expires
-     * @param ms - Milliseconds to wait
-     * @returns The timeout ID
-     */
-    setTimeout(callback, ms) {
-        const timerId = setTimeout(callback, ms);
-        this.trackTimeout(timerId);
-        return timerId;
-    }
-    /**
-     * Create a tracked interval
-     *
-     * @param callback - Function to call at each interval
-     * @param ms - Milliseconds between intervals
-     * @returns The interval ID
-     */
-    setInterval(callback, ms) {
-        const timerId = setInterval(callback, ms);
-        this.trackInterval(timerId);
-        return timerId;
-    }
-    /**
-     * Dispose of all tracked resources
-     */
-    dispose() {
-        if (this.isDisposed) {
-            return;
-        }
-        // Run all cleanup functions
-        for (const cleanup of this.cleanupFunctions) {
-            try {
-                cleanup();
-            }
-            catch (error) {
-                console.error('Error during resource cleanup:', error);
-            }
-        }
-        // Clear the array
-        this.cleanupFunctions = [];
-        this.isDisposed = true;
-    }
-    /**
-     * Check if this tracker has been disposed
-     */
-    get disposed() {
-        return this.isDisposed;
-    }
-}
-exports.ResourceTracker = ResourceTracker;
-/**
- * Create a new ResourceTracker instance
- *
- * @returns A new ResourceTracker
- */
-function createResourceTracker() {
-    return new ResourceTracker();
-}