@capgo/capacitor-screen-orientation 7.0.0

package/dist/esm/definitions.d.ts

@@ -0,0 +1,302 @@
+import type { PluginListenerHandle } from '@capacitor/core';
+/**
+ * Orientation type that describes the orientation state of the device.
+ *
+ * @since 1.0.0
+ */
+export type OrientationType = 'portrait-primary' | 'portrait-secondary' | 'landscape-primary' | 'landscape-secondary';
+/**
+ * Orientation lock type that can be used to lock the device orientation.
+ *
+ * @since 1.0.0
+ */
+export type OrientationLockType = 'any' | 'natural' | 'landscape' | 'portrait' | 'portrait-primary' | 'portrait-secondary' | 'landscape-primary' | 'landscape-secondary';
+/**
+ * Result returned by the orientation() method.
+ *
+ * @since 1.0.0
+ */
+export interface ScreenOrientationResult {
+    /**
+     * The current orientation type.
+     *
+     * @since 1.0.0
+     */
+    type: OrientationType;
+}
+/**
+ * Result returned by the isOrientationLocked() method.
+ *
+ * @since 1.0.0
+ */
+export interface OrientationLockStatusResult {
+    /**
+     * Whether the device orientation lock is currently enabled.
+     *
+     * This is determined by comparing the physical device orientation
+     * (from motion sensors) with the UI orientation. If they differ,
+     * orientation lock is enabled.
+     *
+     * Available on iOS (Core Motion) and Android (Accelerometer) when motion tracking is active.
+     *
+     * @since 1.0.0
+     */
+    locked: boolean;
+    /**
+     * The physical orientation of the device from motion sensors.
+     * Available when motion tracking is active (iOS and Android).
+     *
+     * @since 1.0.0
+     */
+    physicalOrientation?: OrientationType;
+    /**
+     * The current UI orientation reported by the system.
+     *
+     * @since 1.0.0
+     */
+    uiOrientation: OrientationType;
+}
+/**
+ * Options for locking the screen orientation.
+ *
+ * @since 1.0.0
+ */
+export interface OrientationLockOptions {
+    /**
+     * The orientation type to lock to.
+     *
+     * @since 1.0.0
+     */
+    orientation: OrientationLockType;
+    /**
+     * Whether to track physical device orientation using motion sensors.
+     * When true, uses device motion sensors to detect the true physical
+     * orientation of the device, even when the device orientation lock is enabled.
+     *
+     * **Important:** This does NOT bypass the UI orientation lock.
+     * The screen will still respect the user's orientation lock setting.
+     * This option only affects orientation detection/tracking - you'll receive
+     * orientation change events based on how the device is physically held,
+     * but the UI will not rotate if orientation lock is enabled.
+     *
+     * Supported on iOS (Core Motion) and Android (Accelerometer).
+     *
+     * @default false
+     * @since 1.0.0
+     */
+    bypassOrientationLock?: boolean;
+}
+/**
+ * Options for starting orientation tracking using motion sensors.
+ *
+ * @since 1.0.0
+ */
+export interface StartOrientationTrackingOptions {
+    /**
+     * Whether to track physical device orientation using motion sensors.
+     * When true, uses device motion sensors to detect the true physical
+     * orientation of the device, even when the device orientation lock is enabled.
+     *
+     * **Important:** This does NOT bypass the UI orientation lock.
+     * This only enables detection of the physical orientation.
+     *
+     * Supported on iOS (Core Motion) and Android (Accelerometer).
+     *
+     * @default false
+     * @since 1.0.0
+     */
+    bypassOrientationLock?: boolean;
+}
+/**
+ * Capacitor Screen Orientation Plugin interface.
+ *
+ * Provides methods to detect and control screen orientation,
+ * with support for detecting true physical device orientation using motion sensors.
+ *
+ * @since 1.0.0
+ */
+export interface CapacitorScreenOrientationPlugin {
+    /**
+     * Get the current screen orientation.
+     *
+     * Returns the current orientation of the device screen.
+     *
+     * @since 1.0.0
+     * @returns {Promise<ScreenOrientationResult>} A promise that resolves with the current orientation.
+     *
+     * @example
+     * ```typescript
+     * const result = await ScreenOrientation.orientation();
+     * console.log('Current orientation:', result.type);
+     * ```
+     */
+    orientation(): Promise<ScreenOrientationResult>;
+    /**
+     * Lock the screen orientation to a specific type.
+     *
+     * Locks the screen to the specified orientation.
+     * On iOS, if bypassOrientationLock is true, it will also start
+     * tracking physical device orientation using motion sensors.
+     *
+     * Note: The UI will still respect the user's orientation lock setting.
+     * Motion tracking allows you to detect how the device is physically held
+     * even when the UI doesn't rotate.
+     *
+     * @since 1.0.0
+     * @param options Options for locking the orientation.
+     * @returns {Promise<void>} A promise that resolves when the orientation is locked.
+     *
+     * @example
+     * ```typescript
+     * // Standard lock
+     * await ScreenOrientation.lock({ orientation: 'landscape' });
+     *
+     * // Lock with motion tracking on iOS
+     * await ScreenOrientation.lock({
+     *   orientation: 'portrait',
+     *   bypassOrientationLock: true
+     * });
+     * ```
+     */
+    lock(options: OrientationLockOptions): Promise<void>;
+    /**
+     * Unlock the screen orientation.
+     *
+     * Allows the screen to rotate freely based on device position.
+     * Also stops any motion-based orientation tracking if it was enabled.
+     *
+     * @since 1.0.0
+     * @returns {Promise<void>} A promise that resolves when the orientation is unlocked.
+     *
+     * @example
+     * ```typescript
+     * await ScreenOrientation.unlock();
+     * ```
+     */
+    unlock(): Promise<void>;
+    /**
+     * Start tracking device orientation using motion sensors.
+     *
+     * This method is useful when you want to track the device's physical
+     * orientation independently from the screen orientation lock.
+     * It uses Core Motion on iOS to detect orientation changes.
+     *
+     * @since 1.0.0
+     * @param options Options for starting orientation tracking.
+     * @returns {Promise<void>} A promise that resolves when tracking starts.
+     *
+     * @example
+     * ```typescript
+     * await ScreenOrientation.startOrientationTracking({
+     *   bypassOrientationLock: true
+     * });
+     *
+     * // Listen for changes
+     * ScreenOrientation.addListener('screenOrientationChange', (result) => {
+     *   console.log('Orientation changed:', result.type);
+     * });
+     * ```
+     */
+    startOrientationTracking(options?: StartOrientationTrackingOptions): Promise<void>;
+    /**
+     * Stop tracking device orientation using motion sensors.
+     *
+     * Stops the motion-based orientation tracking if it was started.
+     *
+     * @since 1.0.0
+     * @returns {Promise<void>} A promise that resolves when tracking stops.
+     *
+     * @example
+     * ```typescript
+     * await ScreenOrientation.stopOrientationTracking();
+     * ```
+     */
+    stopOrientationTracking(): Promise<void>;
+    /**
+     * Check if device orientation lock is currently enabled.
+     *
+     * This method compares the physical device orientation (from motion sensors)
+     * with the UI orientation. If they differ, orientation lock is enabled.
+     *
+     * Note: This requires motion tracking to be active via
+     * startOrientationTracking() or lock() with bypassOrientationLock: true.
+     * Works on both iOS (Core Motion) and Android (Accelerometer).
+     *
+     * @since 1.0.0
+     * @returns {Promise<OrientationLockStatusResult>} A promise that resolves with the lock status.
+     *
+     * @example
+     * ```typescript
+     * // Start motion tracking first
+     * await ScreenOrientation.startOrientationTracking({
+     *   bypassOrientationLock: true
+     * });
+     *
+     * // Check lock status
+     * const status = await ScreenOrientation.isOrientationLocked();
+     * if (status.locked) {
+     *   console.log('Orientation lock is ON');
+     *   console.log('Physical:', status.physicalOrientation);
+     *   console.log('UI:', status.uiOrientation);
+     * }
+     * ```
+     */
+    isOrientationLocked(): Promise<OrientationLockStatusResult>;
+    /**
+     * Listen for screen orientation changes.
+     *
+     * Registers a listener that will be called whenever the screen orientation changes.
+     * If motion-based tracking is enabled, this will also fire for orientation changes
+     * detected by motion sensors even when orientation lock is enabled.
+     *
+     * @since 1.0.0
+     * @param eventName The event name. Must be 'screenOrientationChange'.
+     * @param listenerFunc Callback function invoked when orientation changes.
+     * @returns {Promise<PluginListenerHandle>} A promise that resolves to a listener handle.
+     *
+     * @example
+     * ```typescript
+     * const listener = await ScreenOrientation.addListener(
+     *   'screenOrientationChange',
+     *   (result) => {
+     *     console.log('New orientation:', result.type);
+     *   }
+     * );
+     *
+     * // To remove the listener:
+     * await listener.remove();
+     * ```
+     */
+    addListener(eventName: 'screenOrientationChange', listenerFunc: (result: ScreenOrientationResult) => void): Promise<PluginListenerHandle>;
+    /**
+     * Remove all listeners for this plugin.
+     *
+     * Removes all registered event listeners.
+     *
+     * @since 1.0.0
+     * @returns {Promise<void>} A promise that resolves when all listeners are removed.
+     *
+     * @example
+     * ```typescript
+     * await ScreenOrientation.removeAllListeners();
+     * ```
+     */
+    removeAllListeners(): Promise<void>;
+    /**
+     * Get the native plugin version.
+     *
+     * Returns the current version of the native plugin implementation.
+     *
+     * @since 1.0.0
+     * @returns {Promise<{ version: string }>} A promise that resolves with the version string.
+     *
+     * @example
+     * ```typescript
+     * const { version } = await ScreenOrientation.getPluginVersion();
+     * console.log('Plugin version:', version);
+     * ```
+     */
+    getPluginVersion(): Promise<{
+        version: string;
+    }>;
+}

package/dist/esm/definitions.js

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

package/dist/esm/definitions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["import type { PluginListenerHandle } from '@capacitor/core';\n\n/**\n * Orientation type that describes the orientation state of the device.\n *\n * @since 1.0.0\n */\nexport type OrientationType = 'portrait-primary' | 'portrait-secondary' | 'landscape-primary' | 'landscape-secondary';\n\n/**\n * Orientation lock type that can be used to lock the device orientation.\n *\n * @since 1.0.0\n */\nexport type OrientationLockType =\n  | 'any'\n  | 'natural'\n  | 'landscape'\n  | 'portrait'\n  | 'portrait-primary'\n  | 'portrait-secondary'\n  | 'landscape-primary'\n  | 'landscape-secondary';\n\n/**\n * Result returned by the orientation() method.\n *\n * @since 1.0.0\n */\nexport interface ScreenOrientationResult {\n  /**\n   * The current orientation type.\n   *\n   * @since 1.0.0\n   */\n  type: OrientationType;\n}\n\n/**\n * Result returned by the isOrientationLocked() method.\n *\n * @since 1.0.0\n */\nexport interface OrientationLockStatusResult {\n  /**\n   * Whether the device orientation lock is currently enabled.\n   *\n   * This is determined by comparing the physical device orientation\n   * (from motion sensors) with the UI orientation. If they differ,\n   * orientation lock is enabled.\n   *\n   * Available on iOS (Core Motion) and Android (Accelerometer) when motion tracking is active.\n   *\n   * @since 1.0.0\n   */\n  locked: boolean;\n\n  /**\n   * The physical orientation of the device from motion sensors.\n   * Available when motion tracking is active (iOS and Android).\n   *\n   * @since 1.0.0\n   */\n  physicalOrientation?: OrientationType;\n\n  /**\n   * The current UI orientation reported by the system.\n   *\n   * @since 1.0.0\n   */\n  uiOrientation: OrientationType;\n}\n\n/**\n * Options for locking the screen orientation.\n *\n * @since 1.0.0\n */\nexport interface OrientationLockOptions {\n  /**\n   * The orientation type to lock to.\n   *\n   * @since 1.0.0\n   */\n  orientation: OrientationLockType;\n\n  /**\n   * Whether to track physical device orientation using motion sensors.\n   * When true, uses device motion sensors to detect the true physical\n   * orientation of the device, even when the device orientation lock is enabled.\n   *\n   * **Important:** This does NOT bypass the UI orientation lock.\n   * The screen will still respect the user's orientation lock setting.\n   * This option only affects orientation detection/tracking - you'll receive\n   * orientation change events based on how the device is physically held,\n   * but the UI will not rotate if orientation lock is enabled.\n   *\n   * Supported on iOS (Core Motion) and Android (Accelerometer).\n   *\n   * @default false\n   * @since 1.0.0\n   */\n  bypassOrientationLock?: boolean;\n}\n\n/**\n * Options for starting orientation tracking using motion sensors.\n *\n * @since 1.0.0\n */\nexport interface StartOrientationTrackingOptions {\n  /**\n   * Whether to track physical device orientation using motion sensors.\n   * When true, uses device motion sensors to detect the true physical\n   * orientation of the device, even when the device orientation lock is enabled.\n   *\n   * **Important:** This does NOT bypass the UI orientation lock.\n   * This only enables detection of the physical orientation.\n   *\n   * Supported on iOS (Core Motion) and Android (Accelerometer).\n   *\n   * @default false\n   * @since 1.0.0\n   */\n  bypassOrientationLock?: boolean;\n}\n\n/**\n * Capacitor Screen Orientation Plugin interface.\n *\n * Provides methods to detect and control screen orientation,\n * with support for detecting true physical device orientation using motion sensors.\n *\n * @since 1.0.0\n */\nexport interface CapacitorScreenOrientationPlugin {\n  /**\n   * Get the current screen orientation.\n   *\n   * Returns the current orientation of the device screen.\n   *\n   * @since 1.0.0\n   * @returns {Promise<ScreenOrientationResult>} A promise that resolves with the current orientation.\n   *\n   * @example\n   * ```typescript\n   * const result = await ScreenOrientation.orientation();\n   * console.log('Current orientation:', result.type);\n   * ```\n   */\n  orientation(): Promise<ScreenOrientationResult>;\n\n  /**\n   * Lock the screen orientation to a specific type.\n   *\n   * Locks the screen to the specified orientation.\n   * On iOS, if bypassOrientationLock is true, it will also start\n   * tracking physical device orientation using motion sensors.\n   *\n   * Note: The UI will still respect the user's orientation lock setting.\n   * Motion tracking allows you to detect how the device is physically held\n   * even when the UI doesn't rotate.\n   *\n   * @since 1.0.0\n   * @param options Options for locking the orientation.\n   * @returns {Promise<void>} A promise that resolves when the orientation is locked.\n   *\n   * @example\n   * ```typescript\n   * // Standard lock\n   * await ScreenOrientation.lock({ orientation: 'landscape' });\n   *\n   * // Lock with motion tracking on iOS\n   * await ScreenOrientation.lock({\n   *   orientation: 'portrait',\n   *   bypassOrientationLock: true\n   * });\n   * ```\n   */\n  lock(options: OrientationLockOptions): Promise<void>;\n\n  /**\n   * Unlock the screen orientation.\n   *\n   * Allows the screen to rotate freely based on device position.\n   * Also stops any motion-based orientation tracking if it was enabled.\n   *\n   * @since 1.0.0\n   * @returns {Promise<void>} A promise that resolves when the orientation is unlocked.\n   *\n   * @example\n   * ```typescript\n   * await ScreenOrientation.unlock();\n   * ```\n   */\n  unlock(): Promise<void>;\n\n  /**\n   * Start tracking device orientation using motion sensors.\n   *\n   * This method is useful when you want to track the device's physical\n   * orientation independently from the screen orientation lock.\n   * It uses Core Motion on iOS to detect orientation changes.\n   *\n   * @since 1.0.0\n   * @param options Options for starting orientation tracking.\n   * @returns {Promise<void>} A promise that resolves when tracking starts.\n   *\n   * @example\n   * ```typescript\n   * await ScreenOrientation.startOrientationTracking({\n   *   bypassOrientationLock: true\n   * });\n   *\n   * // Listen for changes\n   * ScreenOrientation.addListener('screenOrientationChange', (result) => {\n   *   console.log('Orientation changed:', result.type);\n   * });\n   * ```\n   */\n  startOrientationTracking(options?: StartOrientationTrackingOptions): Promise<void>;\n\n  /**\n   * Stop tracking device orientation using motion sensors.\n   *\n   * Stops the motion-based orientation tracking if it was started.\n   *\n   * @since 1.0.0\n   * @returns {Promise<void>} A promise that resolves when tracking stops.\n   *\n   * @example\n   * ```typescript\n   * await ScreenOrientation.stopOrientationTracking();\n   * ```\n   */\n  stopOrientationTracking(): Promise<void>;\n\n  /**\n   * Check if device orientation lock is currently enabled.\n   *\n   * This method compares the physical device orientation (from motion sensors)\n   * with the UI orientation. If they differ, orientation lock is enabled.\n   *\n   * Note: This requires motion tracking to be active via\n   * startOrientationTracking() or lock() with bypassOrientationLock: true.\n   * Works on both iOS (Core Motion) and Android (Accelerometer).\n   *\n   * @since 1.0.0\n   * @returns {Promise<OrientationLockStatusResult>} A promise that resolves with the lock status.\n   *\n   * @example\n   * ```typescript\n   * // Start motion tracking first\n   * await ScreenOrientation.startOrientationTracking({\n   *   bypassOrientationLock: true\n   * });\n   *\n   * // Check lock status\n   * const status = await ScreenOrientation.isOrientationLocked();\n   * if (status.locked) {\n   *   console.log('Orientation lock is ON');\n   *   console.log('Physical:', status.physicalOrientation);\n   *   console.log('UI:', status.uiOrientation);\n   * }\n   * ```\n   */\n  isOrientationLocked(): Promise<OrientationLockStatusResult>;\n\n  /**\n   * Listen for screen orientation changes.\n   *\n   * Registers a listener that will be called whenever the screen orientation changes.\n   * If motion-based tracking is enabled, this will also fire for orientation changes\n   * detected by motion sensors even when orientation lock is enabled.\n   *\n   * @since 1.0.0\n   * @param eventName The event name. Must be 'screenOrientationChange'.\n   * @param listenerFunc Callback function invoked when orientation changes.\n   * @returns {Promise<PluginListenerHandle>} A promise that resolves to a listener handle.\n   *\n   * @example\n   * ```typescript\n   * const listener = await ScreenOrientation.addListener(\n   *   'screenOrientationChange',\n   *   (result) => {\n   *     console.log('New orientation:', result.type);\n   *   }\n   * );\n   *\n   * // To remove the listener:\n   * await listener.remove();\n   * ```\n   */\n  addListener(\n    eventName: 'screenOrientationChange',\n    listenerFunc: (result: ScreenOrientationResult) => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * Remove all listeners for this plugin.\n   *\n   * Removes all registered event listeners.\n   *\n   * @since 1.0.0\n   * @returns {Promise<void>} A promise that resolves when all listeners are removed.\n   *\n   * @example\n   * ```typescript\n   * await ScreenOrientation.removeAllListeners();\n   * ```\n   */\n  removeAllListeners(): Promise<void>;\n\n  /**\n   * Get the native plugin version.\n   *\n   * Returns the current version of the native plugin implementation.\n   *\n   * @since 1.0.0\n   * @returns {Promise<{ version: string }>} A promise that resolves with the version string.\n   *\n   * @example\n   * ```typescript\n   * const { version } = await ScreenOrientation.getPluginVersion();\n   * console.log('Plugin version:', version);\n   * ```\n   */\n  getPluginVersion(): Promise<{ version: string }>;\n}\n"]}

package/dist/esm/index.d.ts

@@ -0,0 +1,4 @@
+import type { CapacitorScreenOrientationPlugin } from './definitions';
+declare const ScreenOrientation: CapacitorScreenOrientationPlugin;
+export * from './definitions';
+export { ScreenOrientation };

package/dist/esm/index.js

@@ -0,0 +1,7 @@
+import { registerPlugin } from '@capacitor/core';
+const ScreenOrientation = registerPlugin('CapacitorScreenOrientation', {
+    web: () => import('./web').then((m) => new m.CapacitorScreenOrientationWeb()),
+});
+export * from './definitions';
+export { ScreenOrientation };
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAIjD,MAAM,iBAAiB,GAAG,cAAc,CAAmC,4BAA4B,EAAE;IACvG,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,6BAA6B,EAAE,CAAC;CAC9E,CAAC,CAAC;AAEH,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,iBAAiB,EAAE,CAAC","sourcesContent":["import { registerPlugin } from '@capacitor/core';\n\nimport type { CapacitorScreenOrientationPlugin } from './definitions';\n\nconst ScreenOrientation = registerPlugin<CapacitorScreenOrientationPlugin>('CapacitorScreenOrientation', {\n  web: () => import('./web').then((m) => new m.CapacitorScreenOrientationWeb()),\n});\n\nexport * from './definitions';\nexport { ScreenOrientation };\n"]}

package/dist/esm/web.d.ts

@@ -0,0 +1,20 @@
+import { WebPlugin } from '@capacitor/core';
+import type { CapacitorScreenOrientationPlugin, OrientationLockOptions, OrientationType, ScreenOrientationResult, StartOrientationTrackingOptions } from './definitions';
+export declare class CapacitorScreenOrientationWeb extends WebPlugin implements CapacitorScreenOrientationPlugin {
+    private readonly pluginVersion;
+    constructor();
+    orientation(): Promise<ScreenOrientationResult>;
+    lock(options: OrientationLockOptions): Promise<void>;
+    unlock(): Promise<void>;
+    startOrientationTracking(_options?: StartOrientationTrackingOptions): Promise<void>;
+    stopOrientationTracking(): Promise<void>;
+    isOrientationLocked(): Promise<{
+        locked: boolean;
+        physicalOrientation?: OrientationType;
+        uiOrientation: OrientationType;
+    }>;
+    getPluginVersion(): Promise<{
+        version: string;
+    }>;
+    private mapOrientationType;
+}

package/dist/esm/web.js

@@ -0,0 +1,81 @@
+import { WebPlugin } from '@capacitor/core';
+export class CapacitorScreenOrientationWeb extends WebPlugin {
+    constructor() {
+        var _a;
+        super();
+        this.pluginVersion = '1.0.0';
+        if ((_a = window.screen) === null || _a === void 0 ? void 0 : _a.orientation) {
+            window.screen.orientation.addEventListener('change', () => {
+                this.notifyListeners('screenOrientationChange', {
+                    type: this.mapOrientationType(window.screen.orientation.type),
+                });
+            });
+        }
+    }
+    async orientation() {
+        var _a;
+        if (!((_a = window.screen) === null || _a === void 0 ? void 0 : _a.orientation)) {
+            throw this.unavailable('Screen Orientation API not available');
+        }
+        return {
+            type: this.mapOrientationType(window.screen.orientation.type),
+        };
+    }
+    async lock(options) {
+        var _a;
+        const screenOrientation = (_a = window.screen) === null || _a === void 0 ? void 0 : _a.orientation;
+        if (!(screenOrientation === null || screenOrientation === void 0 ? void 0 : screenOrientation.lock)) {
+            throw this.unavailable('Screen Orientation lock not available');
+        }
+        // bypassOrientationLock is only supported on iOS native platform
+        // Silently ignore it on web
+        try {
+            await screenOrientation.lock(options.orientation);
+        }
+        catch (error) {
+            throw new Error(`Failed to lock orientation: ${error}`);
+        }
+    }
+    async unlock() {
+        var _a;
+        const screenOrientation = (_a = window.screen) === null || _a === void 0 ? void 0 : _a.orientation;
+        if (!(screenOrientation === null || screenOrientation === void 0 ? void 0 : screenOrientation.unlock)) {
+            throw this.unavailable('Screen Orientation unlock not available');
+        }
+        screenOrientation.unlock();
+    }
+    async startOrientationTracking(_options) {
+        // Motion-based orientation tracking is only supported on iOS
+        // Silently ignore on web
+    }
+    async stopOrientationTracking() {
+        // Motion-based orientation tracking is only supported on iOS
+        // Silently ignore on web
+    }
+    async isOrientationLocked() {
+        const orientationResult = await this.orientation();
+        return {
+            locked: false,
+            uiOrientation: orientationResult.type,
+        };
+    }
+    async getPluginVersion() {
+        return { version: this.pluginVersion };
+    }
+    mapOrientationType(type) {
+        if (type.includes('portrait-primary') || type === 'portrait-primary') {
+            return 'portrait-primary';
+        }
+        if (type.includes('portrait-secondary') || type === 'portrait-secondary') {
+            return 'portrait-secondary';
+        }
+        if (type.includes('landscape-primary') || type === 'landscape-primary') {
+            return 'landscape-primary';
+        }
+        if (type.includes('landscape-secondary') || type === 'landscape-secondary') {
+            return 'landscape-secondary';
+        }
+        return 'portrait-primary'; // default fallback
+    }
+}
+//# sourceMappingURL=web.js.map

package/dist/esm/web.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"web.js","sourceRoot":"","sources":["../../src/web.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAU5C,MAAM,OAAO,6BAA8B,SAAQ,SAAS;IAG1D;;QACE,KAAK,EAAE,CAAC;QAHO,kBAAa,GAAG,OAAO,CAAC;QAIvC,IAAI,MAAA,MAAM,CAAC,MAAM,0CAAE,WAAW,EAAE,CAAC;YAC/B,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,gBAAgB,CAAC,QAAQ,EAAE,GAAG,EAAE;gBACxD,IAAI,CAAC,eAAe,CAAC,yBAAyB,EAAE;oBAC9C,IAAI,EAAE,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC;iBAC9D,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,KAAK,CAAC,WAAW;;QACf,IAAI,CAAC,CAAA,MAAA,MAAM,CAAC,MAAM,0CAAE,WAAW,CAAA,EAAE,CAAC;YAChC,MAAM,IAAI,CAAC,WAAW,CAAC,sCAAsC,CAAC,CAAC;QACjE,CAAC;QACD,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC;SAC9D,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,OAA+B;;QACxC,MAAM,iBAAiB,GAAG,MAAA,MAAM,CAAC,MAAM,0CAAE,WAAkB,CAAC;QAC5D,IAAI,CAAC,CAAA,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAE,IAAI,CAAA,EAAE,CAAC;YAC7B,MAAM,IAAI,CAAC,WAAW,CAAC,uCAAuC,CAAC,CAAC;QAClE,CAAC;QAED,iEAAiE;QACjE,4BAA4B;QAE5B,IAAI,CAAC;YACH,MAAM,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QACpD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,+BAA+B,KAAK,EAAE,CAAC,CAAC;QAC1D,CAAC;IACH,CAAC;IAED,KAAK,CAAC,MAAM;;QACV,MAAM,iBAAiB,GAAG,MAAA,MAAM,CAAC,MAAM,0CAAE,WAAkB,CAAC;QAC5D,IAAI,CAAC,CAAA,iBAAiB,aAAjB,iBAAiB,uBAAjB,iBAAiB,CAAE,MAAM,CAAA,EAAE,CAAC;YAC/B,MAAM,IAAI,CAAC,WAAW,CAAC,yCAAyC,CAAC,CAAC;QACpE,CAAC;QACD,iBAAiB,CAAC,MAAM,EAAE,CAAC;IAC7B,CAAC;IAED,KAAK,CAAC,wBAAwB,CAAC,QAA0C;QACvE,6DAA6D;QAC7D,yBAAyB;IAC3B,CAAC;IAED,KAAK,CAAC,uBAAuB;QAC3B,6DAA6D;QAC7D,yBAAyB;IAC3B,CAAC;IAED,KAAK,CAAC,mBAAmB;QAKvB,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;QACnD,OAAO;YACL,MAAM,EAAE,KAAK;YACb,aAAa,EAAE,iBAAiB,CAAC,IAAI;SACtC,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,gBAAgB;QACpB,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,aAAa,EAAE,CAAC;IACzC,CAAC;IAEO,kBAAkB,CAAC,IAAY;QACrC,IAAI,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAC,IAAI,IAAI,KAAK,kBAAkB,EAAE,CAAC;YACrE,OAAO,kBAAkB,CAAC;QAC5B,CAAC;QACD,IAAI,IAAI,CAAC,QAAQ,CAAC,oBAAoB,CAAC,IAAI,IAAI,KAAK,oBAAoB,EAAE,CAAC;YACzE,OAAO,oBAAoB,CAAC;QAC9B,CAAC;QACD,IAAI,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,IAAI,IAAI,KAAK,mBAAmB,EAAE,CAAC;YACvE,OAAO,mBAAmB,CAAC;QAC7B,CAAC;QACD,IAAI,IAAI,CAAC,QAAQ,CAAC,qBAAqB,CAAC,IAAI,IAAI,KAAK,qBAAqB,EAAE,CAAC;YAC3E,OAAO,qBAAqB,CAAC;QAC/B,CAAC;QACD,OAAO,kBAAkB,CAAC,CAAC,mBAAmB;IAChD,CAAC;CACF","sourcesContent":["import { WebPlugin } from '@capacitor/core';\n\nimport type {\n  CapacitorScreenOrientationPlugin,\n  OrientationLockOptions,\n  OrientationType,\n  ScreenOrientationResult,\n  StartOrientationTrackingOptions,\n} from './definitions';\n\nexport class CapacitorScreenOrientationWeb extends WebPlugin implements CapacitorScreenOrientationPlugin {\n  private readonly pluginVersion = '1.0.0';\n\n  constructor() {\n    super();\n    if (window.screen?.orientation) {\n      window.screen.orientation.addEventListener('change', () => {\n        this.notifyListeners('screenOrientationChange', {\n          type: this.mapOrientationType(window.screen.orientation.type),\n        });\n      });\n    }\n  }\n\n  async orientation(): Promise<ScreenOrientationResult> {\n    if (!window.screen?.orientation) {\n      throw this.unavailable('Screen Orientation API not available');\n    }\n    return {\n      type: this.mapOrientationType(window.screen.orientation.type),\n    };\n  }\n\n  async lock(options: OrientationLockOptions): Promise<void> {\n    const screenOrientation = window.screen?.orientation as any;\n    if (!screenOrientation?.lock) {\n      throw this.unavailable('Screen Orientation lock not available');\n    }\n\n    // bypassOrientationLock is only supported on iOS native platform\n    // Silently ignore it on web\n\n    try {\n      await screenOrientation.lock(options.orientation);\n    } catch (error) {\n      throw new Error(`Failed to lock orientation: ${error}`);\n    }\n  }\n\n  async unlock(): Promise<void> {\n    const screenOrientation = window.screen?.orientation as any;\n    if (!screenOrientation?.unlock) {\n      throw this.unavailable('Screen Orientation unlock not available');\n    }\n    screenOrientation.unlock();\n  }\n\n  async startOrientationTracking(_options?: StartOrientationTrackingOptions): Promise<void> {\n    // Motion-based orientation tracking is only supported on iOS\n    // Silently ignore on web\n  }\n\n  async stopOrientationTracking(): Promise<void> {\n    // Motion-based orientation tracking is only supported on iOS\n    // Silently ignore on web\n  }\n\n  async isOrientationLocked(): Promise<{\n    locked: boolean;\n    physicalOrientation?: OrientationType;\n    uiOrientation: OrientationType;\n  }> {\n    const orientationResult = await this.orientation();\n    return {\n      locked: false,\n      uiOrientation: orientationResult.type,\n    };\n  }\n\n  async getPluginVersion(): Promise<{ version: string }> {\n    return { version: this.pluginVersion };\n  }\n\n  private mapOrientationType(type: string): OrientationType {\n    if (type.includes('portrait-primary') || type === 'portrait-primary') {\n      return 'portrait-primary';\n    }\n    if (type.includes('portrait-secondary') || type === 'portrait-secondary') {\n      return 'portrait-secondary';\n    }\n    if (type.includes('landscape-primary') || type === 'landscape-primary') {\n      return 'landscape-primary';\n    }\n    if (type.includes('landscape-secondary') || type === 'landscape-secondary') {\n      return 'landscape-secondary';\n    }\n    return 'portrait-primary'; // default fallback\n  }\n}\n"]}

package/dist/plugin.cjs.js

@@ -0,0 +1,95 @@
+'use strict';
+
+var core = require('@capacitor/core');
+
+const ScreenOrientation = core.registerPlugin('CapacitorScreenOrientation', {
+    web: () => Promise.resolve().then(function () { return web; }).then((m) => new m.CapacitorScreenOrientationWeb()),
+});
+
+class CapacitorScreenOrientationWeb extends core.WebPlugin {
+    constructor() {
+        var _a;
+        super();
+        this.pluginVersion = '1.0.0';
+        if ((_a = window.screen) === null || _a === void 0 ? void 0 : _a.orientation) {
+            window.screen.orientation.addEventListener('change', () => {
+                this.notifyListeners('screenOrientationChange', {
+                    type: this.mapOrientationType(window.screen.orientation.type),
+                });
+            });
+        }
+    }
+    async orientation() {
+        var _a;
+        if (!((_a = window.screen) === null || _a === void 0 ? void 0 : _a.orientation)) {
+            throw this.unavailable('Screen Orientation API not available');
+        }
+        return {
+            type: this.mapOrientationType(window.screen.orientation.type),
+        };
+    }
+    async lock(options) {
+        var _a;
+        const screenOrientation = (_a = window.screen) === null || _a === void 0 ? void 0 : _a.orientation;
+        if (!(screenOrientation === null || screenOrientation === void 0 ? void 0 : screenOrientation.lock)) {
+            throw this.unavailable('Screen Orientation lock not available');
+        }
+        // bypassOrientationLock is only supported on iOS native platform
+        // Silently ignore it on web
+        try {
+            await screenOrientation.lock(options.orientation);
+        }
+        catch (error) {
+            throw new Error(`Failed to lock orientation: ${error}`);
+        }
+    }
+    async unlock() {
+        var _a;
+        const screenOrientation = (_a = window.screen) === null || _a === void 0 ? void 0 : _a.orientation;
+        if (!(screenOrientation === null || screenOrientation === void 0 ? void 0 : screenOrientation.unlock)) {
+            throw this.unavailable('Screen Orientation unlock not available');
+        }
+        screenOrientation.unlock();
+    }
+    async startOrientationTracking(_options) {
+        // Motion-based orientation tracking is only supported on iOS
+        // Silently ignore on web
+    }
+    async stopOrientationTracking() {
+        // Motion-based orientation tracking is only supported on iOS
+        // Silently ignore on web
+    }
+    async isOrientationLocked() {
+        const orientationResult = await this.orientation();
+        return {
+            locked: false,
+            uiOrientation: orientationResult.type,
+        };
+    }
+    async getPluginVersion() {
+        return { version: this.pluginVersion };
+    }
+    mapOrientationType(type) {
+        if (type.includes('portrait-primary') || type === 'portrait-primary') {
+            return 'portrait-primary';
+        }
+        if (type.includes('portrait-secondary') || type === 'portrait-secondary') {
+            return 'portrait-secondary';
+        }
+        if (type.includes('landscape-primary') || type === 'landscape-primary') {
+            return 'landscape-primary';
+        }
+        if (type.includes('landscape-secondary') || type === 'landscape-secondary') {
+            return 'landscape-secondary';
+        }
+        return 'portrait-primary'; // default fallback
+    }
+}
+
+var web = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    CapacitorScreenOrientationWeb: CapacitorScreenOrientationWeb
+});
+
+exports.ScreenOrientation = ScreenOrientation;
+//# sourceMappingURL=plugin.cjs.js.map

package/dist/plugin.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.cjs.js","sources":["esm/index.js","esm/web.js"],"sourcesContent":["import { registerPlugin } from '@capacitor/core';\nconst ScreenOrientation = registerPlugin('CapacitorScreenOrientation', {\n    web: () => import('./web').then((m) => new m.CapacitorScreenOrientationWeb()),\n});\nexport * from './definitions';\nexport { ScreenOrientation };\n//# sourceMappingURL=index.js.map","import { WebPlugin } from '@capacitor/core';\nexport class CapacitorScreenOrientationWeb extends WebPlugin {\n    constructor() {\n        var _a;\n        super();\n        this.pluginVersion = '1.0.0';\n        if ((_a = window.screen) === null || _a === void 0 ? void 0 : _a.orientation) {\n            window.screen.orientation.addEventListener('change', () => {\n                this.notifyListeners('screenOrientationChange', {\n                    type: this.mapOrientationType(window.screen.orientation.type),\n                });\n            });\n        }\n    }\n    async orientation() {\n        var _a;\n        if (!((_a = window.screen) === null || _a === void 0 ? void 0 : _a.orientation)) {\n            throw this.unavailable('Screen Orientation API not available');\n        }\n        return {\n            type: this.mapOrientationType(window.screen.orientation.type),\n        };\n    }\n    async lock(options) {\n        var _a;\n        const screenOrientation = (_a = window.screen) === null || _a === void 0 ? void 0 : _a.orientation;\n        if (!(screenOrientation === null || screenOrientation === void 0 ? void 0 : screenOrientation.lock)) {\n            throw this.unavailable('Screen Orientation lock not available');\n        }\n        // bypassOrientationLock is only supported on iOS native platform\n        // Silently ignore it on web\n        try {\n            await screenOrientation.lock(options.orientation);\n        }\n        catch (error) {\n            throw new Error(`Failed to lock orientation: ${error}`);\n        }\n    }\n    async unlock() {\n        var _a;\n        const screenOrientation = (_a = window.screen) === null || _a === void 0 ? void 0 : _a.orientation;\n        if (!(screenOrientation === null || screenOrientation === void 0 ? void 0 : screenOrientation.unlock)) {\n            throw this.unavailable('Screen Orientation unlock not available');\n        }\n        screenOrientation.unlock();\n    }\n    async startOrientationTracking(_options) {\n        // Motion-based orientation tracking is only supported on iOS\n        // Silently ignore on web\n    }\n    async stopOrientationTracking() {\n        // Motion-based orientation tracking is only supported on iOS\n        // Silently ignore on web\n    }\n    async isOrientationLocked() {\n        const orientationResult = await this.orientation();\n        return {\n            locked: false,\n            uiOrientation: orientationResult.type,\n        };\n    }\n    async getPluginVersion() {\n        return { version: this.pluginVersion };\n    }\n    mapOrientationType(type) {\n        if (type.includes('portrait-primary') || type === 'portrait-primary') {\n            return 'portrait-primary';\n        }\n        if (type.includes('portrait-secondary') || type === 'portrait-secondary') {\n            return 'portrait-secondary';\n        }\n        if (type.includes('landscape-primary') || type === 'landscape-primary') {\n            return 'landscape-primary';\n        }\n        if (type.includes('landscape-secondary') || type === 'landscape-secondary') {\n            return 'landscape-secondary';\n        }\n        return 'portrait-primary'; // default fallback\n    }\n}\n//# sourceMappingURL=web.js.map"],"names":["registerPlugin","WebPlugin"],"mappings":";;;;AACK,MAAC,iBAAiB,GAAGA,mBAAc,CAAC,4BAA4B,EAAE;AACvE,IAAI,GAAG,EAAE,MAAM,mDAAe,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,6BAA6B,EAAE,CAAC;AACjF,CAAC;;ACFM,MAAM,6BAA6B,SAASC,cAAS,CAAC;AAC7D,IAAI,WAAW,GAAG;AAClB,QAAQ,IAAI,EAAE;AACd,QAAQ,KAAK,EAAE;AACf,QAAQ,IAAI,CAAC,aAAa,GAAG,OAAO;AACpC,QAAQ,IAAI,CAAC,EAAE,GAAG,MAAM,CAAC,MAAM,MAAM,IAAI,IAAI,EAAE,KAAK,MAAM,GAAG,MAAM,GAAG,EAAE,CAAC,WAAW,EAAE;AACtF,YAAY,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,gBAAgB,CAAC,QAAQ,EAAE,MAAM;AACvE,gBAAgB,IAAI,CAAC,eAAe,CAAC,yBAAyB,EAAE;AAChE,oBAAoB,IAAI,EAAE,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC;AACjF,iBAAiB,CAAC;AAClB,YAAY,CAAC,CAAC;AACd,QAAQ;AACR,IAAI;AACJ,IAAI,MAAM,WAAW,GAAG;AACxB,QAAQ,IAAI,EAAE;AACd,QAAQ,IAAI,EAAE,CAAC,EAAE,GAAG,MAAM,CAAC,MAAM,MAAM,IAAI,IAAI,EAAE,KAAK,MAAM,GAAG,MAAM,GAAG,EAAE,CAAC,WAAW,CAAC,EAAE;AACzF,YAAY,MAAM,IAAI,CAAC,WAAW,CAAC,sCAAsC,CAAC;AAC1E,QAAQ;AACR,QAAQ,OAAO;AACf,YAAY,IAAI,EAAE,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC;AACzE,SAAS;AACT,IAAI;AACJ,IAAI,MAAM,IAAI,CAAC,OAAO,EAAE;AACxB,QAAQ,IAAI,EAAE;AACd,QAAQ,MAAM,iBAAiB,GAAG,CAAC,EAAE,GAAG,MAAM,CAAC,MAAM,MAAM,IAAI,IAAI,EAAE,KAAK,MAAM,GAAG,MAAM,GAAG,EAAE,CAAC,WAAW;AAC1G,QAAQ,IAAI,EAAE,iBAAiB,KAAK,IAAI,IAAI,iBAAiB,KAAK,MAAM,GAAG,MAAM,GAAG,iBAAiB,CAAC,IAAI,CAAC,EAAE;AAC7G,YAAY,MAAM,IAAI,CAAC,WAAW,CAAC,uCAAuC,CAAC;AAC3E,QAAQ;AACR;AACA;AACA,QAAQ,IAAI;AACZ,YAAY,MAAM,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC;AAC7D,QAAQ;AACR,QAAQ,OAAO,KAAK,EAAE;AACtB,YAAY,MAAM,IAAI,KAAK,CAAC,CAAC,4BAA4B,EAAE,KAAK,CAAC,CAAC,CAAC;AACnE,QAAQ;AACR,IAAI;AACJ,IAAI,MAAM,MAAM,GAAG;AACnB,QAAQ,IAAI,EAAE;AACd,QAAQ,MAAM,iBAAiB,GAAG,CAAC,EAAE,GAAG,MAAM,CAAC,MAAM,MAAM,IAAI,IAAI,EAAE,KAAK,MAAM,GAAG,MAAM,GAAG,EAAE,CAAC,WAAW;AAC1G,QAAQ,IAAI,EAAE,iBAAiB,KAAK,IAAI,IAAI,iBAAiB,KAAK,MAAM,GAAG,MAAM,GAAG,iBAAiB,CAAC,MAAM,CAAC,EAAE;AAC/G,YAAY,MAAM,IAAI,CAAC,WAAW,CAAC,yCAAyC,CAAC;AAC7E,QAAQ;AACR,QAAQ,iBAAiB,CAAC,MAAM,EAAE;AAClC,IAAI;AACJ,IAAI,MAAM,wBAAwB,CAAC,QAAQ,EAAE;AAC7C;AACA;AACA,IAAI;AACJ,IAAI,MAAM,uBAAuB,GAAG;AACpC;AACA;AACA,IAAI;AACJ,IAAI,MAAM,mBAAmB,GAAG;AAChC,QAAQ,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,WAAW,EAAE;AAC1D,QAAQ,OAAO;AACf,YAAY,MAAM,EAAE,KAAK;AACzB,YAAY,aAAa,EAAE,iBAAiB,CAAC,IAAI;AACjD,SAAS;AACT,IAAI;AACJ,IAAI,MAAM,gBAAgB,GAAG;AAC7B,QAAQ,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,aAAa,EAAE;AAC9C,IAAI;AACJ,IAAI,kBAAkB,CAAC,IAAI,EAAE;AAC7B,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAC,IAAI,IAAI,KAAK,kBAAkB,EAAE;AAC9E,YAAY,OAAO,kBAAkB;AACrC,QAAQ;AACR,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC,oBAAoB,CAAC,IAAI,IAAI,KAAK,oBAAoB,EAAE;AAClF,YAAY,OAAO,oBAAoB;AACvC,QAAQ;AACR,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,IAAI,IAAI,KAAK,mBAAmB,EAAE;AAChF,YAAY,OAAO,mBAAmB;AACtC,QAAQ;AACR,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC,qBAAqB,CAAC,IAAI,IAAI,KAAK,qBAAqB,EAAE;AACpF,YAAY,OAAO,qBAAqB;AACxC,QAAQ;AACR,QAAQ,OAAO,kBAAkB,CAAC;AAClC,IAAI;AACJ;;;;;;;;;"}