diff --git a/scripts/docs-json/index.ts b/scripts/docs-json/index.ts index 6f1d287b..1dd5d7e7 100644 --- a/scripts/docs-json/index.ts +++ b/scripts/docs-json/index.ts @@ -15,6 +15,8 @@ interface Plugin { cordovaPlugin: { name: string; }; + premierSlug: string; + capacitorIncompatible: boolean; } const rootDir = resolve(__dirname, '../..'); @@ -55,6 +57,9 @@ function processPlugin(pluginModule): Plugin { const displayName = getTag(pluginClass, 'name'); const usage = getTag(pluginClass, 'usage'); const description = getTag(pluginClass, 'description'); + const premierSlug = getTag(pluginClass, 'premier'); + const capIncompat = getTag(pluginClass, 'capacitorincompatible'); + const capacitorIncompatible = capIncompat ? true : undefined; return { packageName, displayName, @@ -66,6 +71,8 @@ function processPlugin(pluginModule): Plugin { cordovaPlugin: { name: decorator.plugin, }, + premierSlug, + capacitorIncompatible, }; } diff --git a/src/@ionic-native/plugins/admob-pro/index.ts b/src/@ionic-native/plugins/admob-pro/index.ts index 7ce160c3..6f2ee87e 100644 --- a/src/@ionic-native/plugins/admob-pro/index.ts +++ b/src/@ionic-native/plugins/admob-pro/index.ts @@ -100,6 +100,7 @@ export interface AdExtras { /** * @paid * @name AdMob Pro + * @capacitorincompatible true * @description * Plugin for Google Ads, including AdMob / DFP (DoubleClick for publisher) and mediations to other Ad networks. * diff --git a/src/@ionic-native/plugins/android-permissions/index.ts b/src/@ionic-native/plugins/android-permissions/index.ts index 05d9f7c5..73369119 100644 --- a/src/@ionic-native/plugins/android-permissions/index.ts +++ b/src/@ionic-native/plugins/android-permissions/index.ts @@ -3,6 +3,7 @@ import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core'; /** * @name Android Permissions + * @premier android-permissions * @description * This plugin is designed to support Android new permissions checking mechanism. * diff --git a/src/@ionic-native/plugins/app-rate/index.ts b/src/@ionic-native/plugins/app-rate/index.ts index e705a18b..6320f98c 100644 --- a/src/@ionic-native/plugins/app-rate/index.ts +++ b/src/@ionic-native/plugins/app-rate/index.ts @@ -133,6 +133,7 @@ export interface AppUrls { /** * @name App Rate + * @premier app-rate * @description * The AppRate plugin makes it easy to prompt the user to rate your app, either now, later, or never. * diff --git a/src/@ionic-native/plugins/app-version/index.ts b/src/@ionic-native/plugins/app-version/index.ts index 9b1626c7..eb98464b 100644 --- a/src/@ionic-native/plugins/app-version/index.ts +++ b/src/@ionic-native/plugins/app-version/index.ts @@ -3,6 +3,7 @@ import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core'; /** * @name App Version + * @premier app-version * @description * Reads the version of your app from the target build settings. * diff --git a/src/@ionic-native/plugins/apple-wallet/index.ts b/src/@ionic-native/plugins/apple-wallet/index.ts index 5ad8e417..414a18e6 100644 --- a/src/@ionic-native/plugins/apple-wallet/index.ts +++ b/src/@ionic-native/plugins/apple-wallet/index.ts @@ -33,6 +33,7 @@ export interface WatchExistData { /** * @name Apple Wallet + * @premier apple-payment-pass * @description * A Cordova plugin that enables users from Add Payment Cards to their Apple Wallet. * diff --git a/src/@ionic-native/plugins/badge/index.ts b/src/@ionic-native/plugins/badge/index.ts index 745de874..d3bc2442 100644 --- a/src/@ionic-native/plugins/badge/index.ts +++ b/src/@ionic-native/plugins/badge/index.ts @@ -3,6 +3,7 @@ import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core'; /** * @name Badge + * @premier badge * @description * The essential purpose of badge numbers is to enable an application to inform its users that it has something for them — for example, unread messages — when the application isn’t running in the foreground. * diff --git a/src/@ionic-native/plugins/braintree/index.ts b/src/@ionic-native/plugins/braintree/index.ts index 31760d8e..16e401e7 100644 --- a/src/@ionic-native/plugins/braintree/index.ts +++ b/src/@ionic-native/plugins/braintree/index.ts @@ -136,6 +136,7 @@ export interface PaymentUIResult { /** * @name Braintree + * @capacitorincompatible true * @description * This plugin enables the use of the Braintree Drop-In Payments UI in your Ionic applications on Android and iOS, using the native Drop-In UI for each platform (not the Javascript SDK). * diff --git a/src/@ionic-native/plugins/calendar/index.ts b/src/@ionic-native/plugins/calendar/index.ts index 641fb0d7..fcfbf89e 100644 --- a/src/@ionic-native/plugins/calendar/index.ts +++ b/src/@ionic-native/plugins/calendar/index.ts @@ -58,6 +58,7 @@ export interface NameOrOptions { /** * @name Calendar + * @premier calendar * @description * This plugin allows you to add events to the Calendar of the mobile device. * diff --git a/src/@ionic-native/plugins/camera/index.ts b/src/@ionic-native/plugins/camera/index.ts index 6d11e73a..24a02505 100644 --- a/src/@ionic-native/plugins/camera/index.ts +++ b/src/@ionic-native/plugins/camera/index.ts @@ -123,6 +123,7 @@ export enum Direction { /** * @name Camera + * @premier camera * @description * Take a photo or capture video. * diff --git a/src/@ionic-native/plugins/clipboard/index.ts b/src/@ionic-native/plugins/clipboard/index.ts index c8ba4324..86c7abd6 100644 --- a/src/@ionic-native/plugins/clipboard/index.ts +++ b/src/@ionic-native/plugins/clipboard/index.ts @@ -2,6 +2,7 @@ import { Injectable } from '@angular/core'; import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core'; /** * @name Clipboard + * @premier clipboard * @description * Clipboard management plugin for Cordova that supports iOS, Android, and Windows Phone 8. * diff --git a/src/@ionic-native/plugins/contacts/index.ts b/src/@ionic-native/plugins/contacts/index.ts index 07e0e422..d4832717 100644 --- a/src/@ionic-native/plugins/contacts/index.ts +++ b/src/@ionic-native/plugins/contacts/index.ts @@ -300,6 +300,7 @@ export class ContactFindOptions implements IContactFindOptions { /** * @name Contacts + * @premier contacts * @description * Access and manage Contacts on the device. * diff --git a/src/@ionic-native/plugins/deeplinks/index.ts b/src/@ionic-native/plugins/deeplinks/index.ts index da62c4d4..754c8dff 100644 --- a/src/@ionic-native/plugins/deeplinks/index.ts +++ b/src/@ionic-native/plugins/deeplinks/index.ts @@ -30,6 +30,7 @@ export interface DeeplinkOptions { /** * @name Deeplinks + * @premier deeplinks * @description This plugin handles deeplinks on iOS and Android for both custom URL scheme links * and Universal App Links. * diff --git a/src/@ionic-native/plugins/device-feedback/index.ts b/src/@ionic-native/plugins/device-feedback/index.ts index aa351b6d..ade12ed5 100644 --- a/src/@ionic-native/plugins/device-feedback/index.ts +++ b/src/@ionic-native/plugins/device-feedback/index.ts @@ -11,6 +11,7 @@ export interface DeviceFeedbackStatus { /** * @name Device Feedback + * @premier vibration * @description * * Plugin that lets you provide haptic or acoustic feedback on Android devices. diff --git a/src/@ionic-native/plugins/device/index.ts b/src/@ionic-native/plugins/device/index.ts index bbaca144..fd875113 100644 --- a/src/@ionic-native/plugins/device/index.ts +++ b/src/@ionic-native/plugins/device/index.ts @@ -5,6 +5,7 @@ declare const window: any; /** * @name Device + * @premier device * @description * Access information about the underlying device and platform. * diff --git a/src/@ionic-native/plugins/dialogs/index.ts b/src/@ionic-native/plugins/dialogs/index.ts index c842df73..16844d86 100644 --- a/src/@ionic-native/plugins/dialogs/index.ts +++ b/src/@ionic-native/plugins/dialogs/index.ts @@ -15,6 +15,7 @@ export interface DialogsPromptCallback { /** * @name Dialogs + * @premier dialogs * @description * This plugin gives you ability to access and customize the device native dialogs. * diff --git a/src/@ionic-native/plugins/email-composer/index.ts b/src/@ionic-native/plugins/email-composer/index.ts index aa2b78f5..4df0e727 100644 --- a/src/@ionic-native/plugins/email-composer/index.ts +++ b/src/@ionic-native/plugins/email-composer/index.ts @@ -50,6 +50,7 @@ export interface EmailComposerOptions { /** * @name Email Composer + * @premier email-composer * @description * * Requires Cordova plugin: cordova-plugin-email-composer. For more info, please see the [Email Composer plugin docs](https://github.com/hypery2k/cordova-email-plugin). diff --git a/src/@ionic-native/plugins/fcm/index.ts b/src/@ionic-native/plugins/fcm/index.ts index 8a2db93c..db855e47 100644 --- a/src/@ionic-native/plugins/fcm/index.ts +++ b/src/@ionic-native/plugins/fcm/index.ts @@ -18,6 +18,7 @@ export interface NotificationData { /** * @name FCM + * @capacitorincompatible true * @description * Provides basic functionality for Firebase Cloud Messaging * diff --git a/src/@ionic-native/plugins/file-path/index.ts b/src/@ionic-native/plugins/file-path/index.ts index 5aea6831..0f848bd8 100644 --- a/src/@ionic-native/plugins/file-path/index.ts +++ b/src/@ionic-native/plugins/file-path/index.ts @@ -5,6 +5,7 @@ declare const window: any; /** * @name File Path + * @premier filesystem * @description * * This plugin allows you to resolve the native filesystem path for Android content URIs and is based on code in the aFileChooser library. diff --git a/src/@ionic-native/plugins/file/index.ts b/src/@ionic-native/plugins/file/index.ts index 54fd45fd..70f327d5 100644 --- a/src/@ionic-native/plugins/file/index.ts +++ b/src/@ionic-native/plugins/file/index.ts @@ -636,6 +636,7 @@ declare const window: Window; /** * @name File + * @premier filesystem * @description * This plugin implements a File API allowing read/write access to files residing on the device. * diff --git a/src/@ionic-native/plugins/firebase/index.ts b/src/@ionic-native/plugins/firebase/index.ts index 210d74dd..10f9531e 100644 --- a/src/@ionic-native/plugins/firebase/index.ts +++ b/src/@ionic-native/plugins/firebase/index.ts @@ -4,6 +4,7 @@ import { Observable } from 'rxjs'; /** * @name Firebase + * @capacitorincompatible true * @description * This plugin brings push notifications, analytics, event tracking, crash reporting and more from Google Firebase to your Cordova project! Android and iOS supported (including iOS 10). * diff --git a/src/@ionic-native/plugins/geolocation/index.ts b/src/@ionic-native/plugins/geolocation/index.ts index fa01f2d1..914b2957 100644 --- a/src/@ionic-native/plugins/geolocation/index.ts +++ b/src/@ionic-native/plugins/geolocation/index.ts @@ -106,6 +106,7 @@ export interface GeolocationOptions { /** * @name Geolocation + * @premier geolocation * @description * This plugin provides information about the device's location, such as latitude and longitude. Common sources of location information include Global Positioning System (GPS) and location inferred from network signals such as IP address, RFID, WiFi and Bluetooth MAC addresses, and GSM/CDMA cell IDs. * diff --git a/src/@ionic-native/plugins/globalization/index.ts b/src/@ionic-native/plugins/globalization/index.ts index d8e6a909..444d1b96 100644 --- a/src/@ionic-native/plugins/globalization/index.ts +++ b/src/@ionic-native/plugins/globalization/index.ts @@ -8,6 +8,7 @@ export interface GlobalizationOptions { /** * @name Globalization + * @premier globalization * @description * This plugin obtains information and performs operations specific to the user's locale, language, and timezone. * diff --git a/src/@ionic-native/plugins/in-app-browser/index.ts b/src/@ionic-native/plugins/in-app-browser/index.ts index 6236259c..c3799aa3 100644 --- a/src/@ionic-native/plugins/in-app-browser/index.ts +++ b/src/@ionic-native/plugins/in-app-browser/index.ts @@ -252,6 +252,7 @@ export class InAppBrowserObject { /** * @name In App Browser + * @premier inappbrowser * @description Launches in app Browser * @usage * ```typescript diff --git a/src/@ionic-native/plugins/ionic-webview/index.ts b/src/@ionic-native/plugins/ionic-webview/index.ts index 7e8fb2e7..b918f1c7 100644 --- a/src/@ionic-native/plugins/ionic-webview/index.ts +++ b/src/@ionic-native/plugins/ionic-webview/index.ts @@ -3,6 +3,7 @@ import { CordovaProperty, IonicNativePlugin, Plugin } from '@ionic-native/core'; /** * @name Ionic Webview + * @capacitorincompatible true * @description * Access Web View utilities. * diff --git a/src/@ionic-native/plugins/keyboard/index.ts b/src/@ionic-native/plugins/keyboard/index.ts index 5d9e80fc..6f7c956f 100644 --- a/src/@ionic-native/plugins/keyboard/index.ts +++ b/src/@ionic-native/plugins/keyboard/index.ts @@ -16,6 +16,8 @@ export enum KeyboardResizeMode { /** * @name Keyboard + * @premier keyboard + * @capacitorincompatible true * @description * Keyboard plugin for Cordova. * diff --git a/src/@ionic-native/plugins/media-capture/index.ts b/src/@ionic-native/plugins/media-capture/index.ts index 5da76b20..cbf62c8d 100644 --- a/src/@ionic-native/plugins/media-capture/index.ts +++ b/src/@ionic-native/plugins/media-capture/index.ts @@ -114,6 +114,7 @@ export interface ConfigurationData { /** * @name Media Capture + * @premier media-capture * @description * This plugin provides access to the device's audio, image, and video capture capabilities. * diff --git a/src/@ionic-native/plugins/media/index.ts b/src/@ionic-native/plugins/media/index.ts index 434350db..c06248ad 100644 --- a/src/@ionic-native/plugins/media/index.ts +++ b/src/@ionic-native/plugins/media/index.ts @@ -179,6 +179,7 @@ export type MediaErrorCallback = (error: MediaError) => void; /** * @name Media + * @premier media * @description * This plugin provides the ability to record and play back audio files on a device. * diff --git a/src/@ionic-native/plugins/music-controls/index.ts b/src/@ionic-native/plugins/music-controls/index.ts index bac3a9e6..8398c9ed 100644 --- a/src/@ionic-native/plugins/music-controls/index.ts +++ b/src/@ionic-native/plugins/music-controls/index.ts @@ -30,6 +30,7 @@ export interface MusicControlsOptions { /** * @name Music Controls + * @capacitorincompatible true * @description * Music controls for Cordova applications. * Display a 'media' notification with play/pause, previous, next buttons, allowing the user to control the play. diff --git a/src/@ionic-native/plugins/native-storage/index.ts b/src/@ionic-native/plugins/native-storage/index.ts index 81e033ed..374657b7 100644 --- a/src/@ionic-native/plugins/native-storage/index.ts +++ b/src/@ionic-native/plugins/native-storage/index.ts @@ -3,6 +3,7 @@ import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core'; /** * @name Native Storage + * @premier nativestorage * @description Native storage of variables in Android and iOS * * @usage diff --git a/src/@ionic-native/plugins/network/index.ts b/src/@ionic-native/plugins/network/index.ts index 1d04eb74..72935e42 100644 --- a/src/@ionic-native/plugins/network/index.ts +++ b/src/@ionic-native/plugins/network/index.ts @@ -17,6 +17,7 @@ export enum Connection { /** * @name Network + * @premier network-information * @description * Requires Cordova plugin: cordova-plugin-network-information. For more info, please see the [Network plugin docs](https://github.com/apache/cordova-plugin-network-information). * diff --git a/src/@ionic-native/plugins/qr-scanner/index.ts b/src/@ionic-native/plugins/qr-scanner/index.ts index 8354659b..846e0698 100644 --- a/src/@ionic-native/plugins/qr-scanner/index.ts +++ b/src/@ionic-native/plugins/qr-scanner/index.ts @@ -60,6 +60,7 @@ export interface QRScannerStatus { /** * @name QR Scanner + * @capacitorincompatible true * @description * A fast, energy efficient, highly-configurable QR code scanner for Cordova apps. * diff --git a/src/@ionic-native/plugins/screen-orientation/index.ts b/src/@ionic-native/plugins/screen-orientation/index.ts index 316673e0..f26f0eae 100644 --- a/src/@ionic-native/plugins/screen-orientation/index.ts +++ b/src/@ionic-native/plugins/screen-orientation/index.ts @@ -4,6 +4,7 @@ import { Observable } from 'rxjs'; /** * @name Screen Orientation + * @premier screen-orientation * @description * Cordova plugin to set/lock the screen orientation in a common way. * diff --git a/src/@ionic-native/plugins/social-sharing/index.ts b/src/@ionic-native/plugins/social-sharing/index.ts index 6368b45e..2525d0ab 100644 --- a/src/@ionic-native/plugins/social-sharing/index.ts +++ b/src/@ionic-native/plugins/social-sharing/index.ts @@ -3,6 +3,7 @@ import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core'; /** * @name Social Sharing + * @premier social-sharing * @description * Share text, files, images, and links via social networks, sms, and email. * diff --git a/src/@ionic-native/plugins/splash-screen/index.ts b/src/@ionic-native/plugins/splash-screen/index.ts index e9aa74b2..0b4dcd85 100644 --- a/src/@ionic-native/plugins/splash-screen/index.ts +++ b/src/@ionic-native/plugins/splash-screen/index.ts @@ -3,6 +3,8 @@ import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core'; /** * @name Splash Screen + * @premier splashscreen + * @capacitorincompatible true * @description This plugin displays and hides a splash screen during application launch. The methods below allows showing and hiding the splashscreen after the app has loaded. * @usage * ```typescript diff --git a/src/@ionic-native/plugins/status-bar/index.ts b/src/@ionic-native/plugins/status-bar/index.ts index 92a81faf..27c7506f 100644 --- a/src/@ionic-native/plugins/status-bar/index.ts +++ b/src/@ionic-native/plugins/status-bar/index.ts @@ -3,6 +3,8 @@ import { Cordova, CordovaProperty, IonicNativePlugin, Plugin } from '@ionic-nati /** * @name Status Bar + * @premier statusbar + * @capacitorincompatible true * @description * Manage the appearance of the native status bar. * diff --git a/src/@ionic-native/plugins/vibration/index.ts b/src/@ionic-native/plugins/vibration/index.ts index 2ae7ccd1..678ef0ac 100644 --- a/src/@ionic-native/plugins/vibration/index.ts +++ b/src/@ionic-native/plugins/vibration/index.ts @@ -3,6 +3,7 @@ import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core'; /** * @name Vibration + * @premier vibration * @description Vibrates the device * @usage * ```typescript