fix: support deprecated types from Capacitor 2 (#139)

* screen reader

* action sheet

* more screen reader

* wip

* export all from definitions

* motion

* toast

* haptics

* more screen reader

* app

* network

* app-launcher

* wip

* filesystem

* browser

* text-zoom

* status-bar

* device

* clipboard

* generate readmes

* fmt

* update docgen

* regen

* geolocation

* camera

* splash-screen

* build and format

Author: imhoffd

action-sheet/README.md

@@ -25,17 +25,17 @@ npx cap sync
 ### showActions(...)
 
 ```typescript
-showActions(options: ActionSheetOptions) => Promise<ActionSheetResult>
+showActions(options: ShowActionsOptions) => Promise<ShowActionsResult>
 ```
 
 Show an Action Sheet style modal with various options for the user
 to select.
 
 | Param         | Type                                                              |
 | ------------- | ----------------------------------------------------------------- |
-| **`options`** | <code><a href="#actionsheetoptions">ActionSheetOptions</a></code> |
+| **`options`** | <code><a href="#showactionsoptions">ShowActionsOptions</a></code> |
 
-**Returns:** <code>Promise&lt;<a href="#actionsheetresult">ActionSheetResult</a>&gt;</code>
+**Returns:** <code>Promise&lt;<a href="#showactionsresult">ShowActionsResult</a>&gt;</code>
 
 **Since:** 1.0.0
 
@@ -45,35 +45,35 @@ to select.
 ### Interfaces
 
 
-#### ActionSheetResult
+#### ShowActionsResult
 
 | Prop        | Type                | Description                                  | Since |
 | ----------- | ------------------- | -------------------------------------------- | ----- |
 | **`index`** | <code>number</code> | The index of the clicked option (Zero-based) | 1.0.0 |
 
 
-#### ActionSheetOptions
+#### ShowActionsOptions
 
 | Prop          | Type                             | Description                                                              | Since |
 | ------------- | -------------------------------- | ------------------------------------------------------------------------ | ----- |
 | **`title`**   | <code>string</code>              | The title of the Action Sheet.                                           | 1.0.0 |
 | **`message`** | <code>string</code>              | A message to show under the title. This option is only supported on iOS. | 1.0.0 |
-| **`options`** | <code>ActionSheetOption[]</code> | Options the user can choose from.                                        | 1.0.0 |
+| **`options`** | <code>ActionSheetSchema[]</code> | Options the user can choose from.                                        | 1.0.0 |
 
 
-#### ActionSheetOption
+#### ActionSheetSchema
 
 | Prop        | Type                                                                      | Description                                                                           | Since |
 | ----------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ----- |
 | **`title`** | <code>string</code>                                                       | The title of the option                                                               | 1.0.0 |
-| **`style`** | <code><a href="#actionsheetoptionstyle">ActionSheetOptionStyle</a></code> | The style of the option This option is only supported on iOS.                         | 1.0.0 |
+| **`style`** | <code><a href="#actionsheetschemastyle">ActionSheetSchemaStyle</a></code> | The style of the option This option is only supported on iOS.                         | 1.0.0 |
 | **`icon`**  | <code>string</code>                                                       | Icon for the option (ionicon naming convention) This option is only supported on Web. | 1.0.0 |
 
 
 ### Enums
 
 
-#### ActionSheetOptionStyle
+#### ActionSheetSchemaStyle
 
 | Members           | Value                      | Description                                                                                                 | Since |
 | ----------------- | -------------------------- | ----------------------------------------------------------------------------------------------------------- | ----- |

action-sheet/src/definitions.ts

@@ -1,4 +1,4 @@
-export interface ActionSheetOptions {
+export interface ShowActionsOptions {
   /**
    * The title of the Action Sheet.
    *
@@ -20,10 +20,10 @@ export interface ActionSheetOptions {
    *
    * @since 1.0.0
    */
-  options: ActionSheetOption[];
+  options: ActionSheetSchema[];
 }
 
-export enum ActionSheetOptionStyle {
+export enum ActionSheetSchemaStyle {
   /**
    * Default style of the option.
    *
@@ -47,7 +47,7 @@ export enum ActionSheetOptionStyle {
   Cancel = 'CANCEL',
 }
 
-export interface ActionSheetOption {
+export interface ActionSheetSchema {
   /**
    * The title of the option
    *
@@ -62,7 +62,7 @@ export interface ActionSheetOption {
    *
    * @since 1.0.0
    */
-  style?: ActionSheetOptionStyle;
+  style?: ActionSheetSchemaStyle;
 
   /**
    * Icon for the option (ionicon naming convention)
@@ -74,7 +74,7 @@ export interface ActionSheetOption {
   icon?: string;
 }
 
-export interface ActionSheetResult {
+export interface ShowActionsResult {
   /**
    * The index of the clicked option (Zero-based)
    *
@@ -90,5 +90,23 @@ export interface ActionSheetPlugin {
    *
    * @since 1.0.0
    */
-  showActions(options: ActionSheetOptions): Promise<ActionSheetResult>;
+  showActions(options: ShowActionsOptions): Promise<ShowActionsResult>;
 }
+
+/**
+ * @deprecated Use `ShowActionsOptions`.
+ * @since 1.0.0
+ */
+export type ActionSheetOptions = ShowActionsOptions;
+
+/**
+ * @deprecated Use `ShowActionsResult`.
+ * @since 1.0.0
+ */
+export type ActionSheetResult = ShowActionsResult;
+
+/**
+ * @deprecated Use `ActionSheetSchema`.
+ * @since 1.0.0
+ */
+export type ActionSheetOption = ActionSheetSchema;

action-sheet/src/index.ts

@@ -1,10 +1,10 @@
 import { registerPlugin } from '@capacitor/core';
 
 import type { ActionSheetPlugin } from './definitions';
-import { ActionSheetOptionStyle } from './definitions';
 
 const ActionSheet = registerPlugin<ActionSheetPlugin>('ActionSheet', {
   web: () => import('./web').then(m => new m.ActionSheetWeb()),
 });
 
-export { ActionSheet, ActionSheetOptionStyle };
+export * from './definitions';
+export { ActionSheet };

action-sheet/src/web.ts

@@ -1,14 +1,14 @@
 import { WebPlugin } from '@capacitor/core';
 
 import type {
-  ActionSheetOptions,
   ActionSheetPlugin,
-  ActionSheetResult,
+  ShowActionsResult,
+  ShowActionsOptions,
 } from './definitions';
 
 export class ActionSheetWeb extends WebPlugin implements ActionSheetPlugin {
-  async showActions(options: ActionSheetOptions): Promise<ActionSheetResult> {
-    return new Promise<ActionSheetResult>((resolve, _reject) => {
+  async showActions(options: ShowActionsOptions): Promise<ShowActionsResult> {
+    return new Promise<ShowActionsResult>((resolve, _reject) => {
       let actionSheet: any = document.querySelector('pwa-action-sheet');
       if (!actionSheet) {
         actionSheet = document.createElement('pwa-action-sheet');

app-launcher/README.md

@@ -15,6 +15,7 @@ npx cap sync
 
 * [`canOpenUrl(...)`](#canopenurl)
 * [`openUrl(...)`](#openurl)
+* [Interfaces](#interfaces)
 
 </docgen-index>
 
@@ -24,7 +25,7 @@ npx cap sync
 ### canOpenUrl(...)
 
 ```typescript
-canOpenUrl(options: { url: string; }) => Promise<{ value: boolean; }>
+canOpenUrl(options: CanOpenURLOptions) => Promise<CanOpenURLResult>
 ```
 
 Check if an app can be opened with the given URL.
@@ -35,11 +36,11 @@ This method always returns false for undeclared schemes, whether or not an appro
 app is installed. To learn more about the key, see
 [LSApplicationQueriesSchemes](https://developer.apple.com/library/archive/documentation/General/Reference/InfoPlistKeyReference/Articles/LaunchServicesKeys.html#//apple_ref/doc/plist/info/LSApplicationQueriesSchemes).
 
-| Param         | Type                          |
-| ------------- | ----------------------------- |
-| **`options`** | <code>{ url: string; }</code> |
+| Param         | Type                                                            |
+| ------------- | --------------------------------------------------------------- |
+| **`options`** | <code><a href="#canopenurloptions">CanOpenURLOptions</a></code> |
 
-**Returns:** <code>Promise&lt;{ value: boolean; }&gt;</code>
+**Returns:** <code>Promise&lt;<a href="#canopenurlresult">CanOpenURLResult</a>&gt;</code>
 
 **Since:** 1.0.0
 
@@ -49,19 +50,50 @@ app is installed. To learn more about the key, see
 ### openUrl(...)
 
 ```typescript
-openUrl(options: { url: string; }) => Promise<{ completed: boolean; }>
+openUrl(options: OpenURLOptions) => Promise<OpenURLResult>
 ```
 
 Open an app with the given URL.
 
-| Param         | Type                          |
-| ------------- | ----------------------------- |
-| **`options`** | <code>{ url: string; }</code> |
+| Param         | Type                                                      |
+| ------------- | --------------------------------------------------------- |
+| **`options`** | <code><a href="#openurloptions">OpenURLOptions</a></code> |
 
-**Returns:** <code>Promise&lt;{ completed: boolean; }&gt;</code>
+**Returns:** <code>Promise&lt;<a href="#openurlresult">OpenURLResult</a>&gt;</code>
 
 **Since:** 1.0.0
 
 --------------------
 
+
+### Interfaces
+
+
+#### CanOpenURLResult
+
+| Prop        | Type                 |
+| ----------- | -------------------- |
+| **`value`** | <code>boolean</code> |
+
+
+#### CanOpenURLOptions
+
+| Prop      | Type                |
+| --------- | ------------------- |
+| **`url`** | <code>string</code> |
+
+
+#### OpenURLResult
+
+| Prop            | Type                 |
+| --------------- | -------------------- |
+| **`completed`** | <code>boolean</code> |
+
+
+#### OpenURLOptions
+
+| Prop      | Type                |
+| --------- | ------------------- |
+| **`url`** | <code>string</code> |
+
 </docgen-api>

app-launcher/src/definitions.ts

@@ -10,12 +10,28 @@ export interface AppLauncherPlugin {
    *
    * @since 1.0.0
    */
-  canOpenUrl(options: { url: string }): Promise<{ value: boolean }>;
+  canOpenUrl(options: CanOpenURLOptions): Promise<CanOpenURLResult>;
 
   /**
    * Open an app with the given URL.
    *
    * @since 1.0.0
    */
-  openUrl(options: { url: string }): Promise<{ completed: boolean }>;
+  openUrl(options: OpenURLOptions): Promise<OpenURLResult>;
+}
+
+export interface CanOpenURLOptions {
+  url: string;
+}
+
+export interface CanOpenURLResult {
+  value: boolean;
+}
+
+export interface OpenURLOptions {
+  url: string;
+}
+
+export interface OpenURLResult {
+  completed: boolean;
 }

app-launcher/src/index.ts

@@ -6,4 +6,5 @@ const AppLauncher = registerPlugin<AppLauncherPlugin>('AppLauncher', {
   web: () => import('./web').then(m => new m.AppLauncherWeb()),
 });
 
+export * from './definitions';
 export { AppLauncher };

app-launcher/src/web.ts

@@ -1,13 +1,19 @@
 import { WebPlugin } from '@capacitor/core';
 
-import type { AppLauncherPlugin } from './definitions';
+import type {
+  AppLauncherPlugin,
+  CanOpenURLOptions,
+  CanOpenURLResult,
+  OpenURLOptions,
+  OpenURLResult,
+} from './definitions';
 
 export class AppLauncherWeb extends WebPlugin implements AppLauncherPlugin {
-  async canOpenUrl(_options: { url: string }): Promise<{ value: boolean }> {
+  async canOpenUrl(_options: CanOpenURLOptions): Promise<CanOpenURLResult> {
     return { value: true };
   }
 
-  async openUrl(_options: { url: string }): Promise<{ completed: boolean }> {
+  async openUrl(_options: OpenURLOptions): Promise<OpenURLResult> {
     return { completed: true };
   }
 }