diff --git a/packages/analytics/README.md b/packages/analytics/README.md index dfb3b1cd..f0f9b883 100644 --- a/packages/analytics/README.md +++ b/packages/analytics/README.md @@ -141,6 +141,8 @@ Sets the user ID property. | ------------- | ------------------------------------------------------------- | | **`options`** | SetUserIdOptions | +**Since:** 0.1.0 + -------------------- @@ -156,6 +158,8 @@ Sets a custom user property to a given value. | ------------- | ------------------------------------------------------------------------- | | **`options`** | SetUserPropertyOptions | +**Since:** 0.1.0 + -------------------- @@ -171,6 +175,8 @@ Sets the current screen name. | ------------- | --------------------------------------------------------------------------- | | **`options`** | SetCurrentScreenOptions | +**Since:** 0.1.0 + -------------------- @@ -186,6 +192,8 @@ Logs an app event. | ------------- | ----------------------------------------------------------- | | **`options`** | LogEventOptions | +**Since:** 0.1.0 + -------------------- @@ -203,6 +211,8 @@ Only available for Android and iOS. | ------------- | --------------------------------------------------------------------------------------------- | | **`options`** | SetSessionTimeoutDurationOptions | +**Since:** 0.1.0 + -------------------- @@ -219,6 +229,8 @@ The value does not apply until the next run of the app. | ------------- | --------------------------------------------------------------- | | **`options`** | SetEnabledOptions | +**Since:** 0.1.0 + -------------------- @@ -234,6 +246,8 @@ Only available for Web. **Returns:** Promise<IsEnabledResult> +**Since:** 0.1.0 + -------------------- @@ -248,6 +262,8 @@ Resets the app instance id. Only available for Android and iOS. +**Since:** 0.1.0 + -------------------- @@ -256,54 +272,54 @@ Only available for Android and iOS. #### SetUserIdOptions -| Prop | Type | -| ------------ | --------------------------- | -| **`userId`** | string \| null | +| Prop | Type | Since | +| ------------ | --------------------------- | ----- | +| **`userId`** | string \| null | 0.1.0 | #### SetUserPropertyOptions -| Prop | Type | -| ----------- | --------------------------- | -| **`key`** | string | -| **`value`** | string \| null | +| Prop | Type | Since | +| ----------- | --------------------------- | ----- | +| **`key`** | string | 0.1.0 | +| **`value`** | string \| null | 0.1.0 | #### SetCurrentScreenOptions -| Prop | Type | Description | -| ------------------------- | --------------------------- | --------------------------------------------------- | -| **`screenName`** | string \| null | | -| **`screenClassOverride`** | string \| null | Only available for Android and iOS. Default: `null` | +| Prop | Type | Description | Default | Since | +| ------------------------- | --------------------------- | ----------------------------------- | ----------------- | ----- | +| **`screenName`** | string \| null | | | 0.1.0 | +| **`screenClassOverride`** | string \| null | Only available for Android and iOS. | null | 0.1.0 | #### LogEventOptions -| Prop | Type | Description | -| ------------ | ------------------------------------ | -------------------------- | -| **`name`** | string | The event name. | -| **`params`** | { [key: string]: any; } | The optional event params. | +| Prop | Type | Description | Since | +| ------------ | ------------------------------------ | -------------------------- | ----- | +| **`name`** | string | The event name. | 0.1.0 | +| **`params`** | { [key: string]: any; } | The optional event params. | 0.1.0 | #### SetSessionTimeoutDurationOptions -| Prop | Type | Description | -| -------------- | ------------------- | ------------------------------------------------- | -| **`duration`** | number | Duration in seconds. Default: `1800` (30 minutes) | +| Prop | Type | Description | Default | Since | +| -------------- | ------------------- | -------------------- | ----------------- | ----- | +| **`duration`** | number | Duration in seconds. | 1800 | 0.1.0 | #### SetEnabledOptions -| Prop | Type | -| ------------- | -------------------- | -| **`enabled`** | boolean | +| Prop | Type | Since | +| ------------- | -------------------- | ----- | +| **`enabled`** | boolean | 0.1.0 | #### IsEnabledResult -| Prop | Type | -| ------------- | -------------------- | -| **`enabled`** | boolean | +| Prop | Type | Since | +| ------------- | -------------------- | ----- | +| **`enabled`** | boolean | 0.1.0 | diff --git a/packages/analytics/src/definitions.ts b/packages/analytics/src/definitions.ts index d962459d..d9332c17 100644 --- a/packages/analytics/src/definitions.ts +++ b/packages/analytics/src/definitions.ts @@ -1,24 +1,34 @@ export interface FirebaseAnalyticsPlugin { /** * Sets the user ID property. + * + * @since 0.1.0 */ setUserId(options: SetUserIdOptions): Promise; /** * Sets a custom user property to a given value. + * + * @since 0.1.0 */ setUserProperty(options: SetUserPropertyOptions): Promise; /** * Sets the current screen name. + * + * @since 0.1.0 */ setCurrentScreen(options: SetCurrentScreenOptions): Promise; /** * Logs an app event. + * + * @since 0.1.0 */ logEvent(options: LogEventOptions): Promise; /** * Sets the duration of inactivity that terminates the current session. * * Only available for Android and iOS. + * + * @since 0.1.0 */ setSessionTimeoutDuration( options: SetSessionTimeoutDurationOptions, @@ -26,12 +36,16 @@ export interface FirebaseAnalyticsPlugin { /** * Enables/disables automatic data collection. * The value does not apply until the next run of the app. + * + * @since 0.1.0 */ setEnabled(options: SetEnabledOptions): Promise; /** * Returns whether or not automatic data collection is enabled. * * Only available for Web. + * + * @since 0.1.0 */ isEnabled(): Promise; /** @@ -39,53 +53,100 @@ export interface FirebaseAnalyticsPlugin { * Resets the app instance id. * * Only available for Android and iOS. + * + * @since 0.1.0 */ resetAnalyticsData(): Promise; } +/** + * @since 0.1.0 + */ export interface SetUserIdOptions { + /** + * @since 0.1.0 + */ userId: string | null; } +/** + * @since 0.1.0 + */ export interface SetUserPropertyOptions { + /** + * @since 0.1.0 + */ key: string; + /** + * @since 0.1.0 + */ value: string | null; } +/** + * @since 0.1.0 + */ export interface SetCurrentScreenOptions { + /** + * @since 0.1.0 + */ screenName: string | null; /** * Only available for Android and iOS. * - * Default: `null` + * @default null + * @since 0.1.0 */ screenClassOverride?: string | null; } +/** + * @since 0.1.0 + */ export interface LogEventOptions { /** * The event name. + * + * @since 0.1.0 */ name: string; /** * The optional event params. + * + * @since 0.1.0 */ params?: { [key: string]: any }; } +/** + * @since 0.1.0 + */ export interface SetSessionTimeoutDurationOptions { /** * Duration in seconds. * - * Default: `1800` (30 minutes) + * @default 1800 + * @since 0.1.0 */ duration: number; } +/** + * @since 0.1.0 + */ export interface SetEnabledOptions { + /** + * @since 0.1.0 + */ enabled: boolean; } +/** + * @since 0.1.0 + */ export interface IsEnabledResult { + /** + * @since 0.1.0 + */ enabled: boolean; } diff --git a/packages/app/README.md b/packages/app/README.md index cf07832c..df5ca747 100644 --- a/packages/app/README.md +++ b/packages/app/README.md @@ -56,6 +56,8 @@ Get the name for this app. **Returns:** Promise<GetNameResult> +**Since:** 0.1.0 + -------------------- @@ -69,6 +71,8 @@ Get the configuration options for this app. **Returns:** Promise<GetOptionsResult> +**Since:** 0.1.0 + -------------------- @@ -77,21 +81,21 @@ Get the configuration options for this app. #### GetNameResult -| Prop | Type | Description | -| ---------- | ------------------- | ---------------------------- | -| **`name`** | string | The unique name of this app. | +| Prop | Type | Description | Since | +| ---------- | ------------------- | ---------------------------- | ----- | +| **`name`** | string | The unique name of this app. | 0.1.0 | #### GetOptionsResult -| Prop | Type | Description | -| ------------------- | ------------------- | -------------------------------------------------------------- | -| **`apiKey`** | string | API key used for authenticating requests from your app. | -| **`applicationId`** | string | Google App ID used to uniquely identify an instance of an app. | -| **`databaseUrl`** | string | The database root URL. | -| **`gcmSenderId`** | string | The Project Number. | -| **`projectId`** | string | The Google Cloud project ID. | -| **`storageBucket`** | string | The Google Cloud Storage bucket name. | +| Prop | Type | Description | Since | +| ------------------- | ------------------- | -------------------------------------------------------------- | ----- | +| **`apiKey`** | string | API key used for authenticating requests from your app. | 0.1.0 | +| **`applicationId`** | string | Google App ID used to uniquely identify an instance of an app. | 0.1.0 | +| **`databaseUrl`** | string | The database root URL. | 0.1.0 | +| **`gcmSenderId`** | string | The Project Number. | 0.1.0 | +| **`projectId`** | string | The Google Cloud project ID. | 0.1.0 | +| **`storageBucket`** | string | The Google Cloud Storage bucket name. | 0.1.0 | diff --git a/packages/app/src/definitions.ts b/packages/app/src/definitions.ts index 42cc26dd..978fe8ce 100644 --- a/packages/app/src/definitions.ts +++ b/packages/app/src/definitions.ts @@ -1,44 +1,68 @@ export interface FirebaseAppPlugin { /** * Get the name for this app. + * + * @since 0.1.0 */ getName(): Promise; /** * Get the configuration options for this app. + * + * @since 0.1.0 */ getOptions(): Promise; } +/** + * @since 0.1.0 + */ export interface GetNameResult { /** * The unique name of this app. + * + * @since 0.1.0 */ name: string; } +/** + * @since 0.1.0 + */ export interface GetOptionsResult { /** * API key used for authenticating requests from your app. + * + * @since 0.1.0 */ apiKey: string; /** * Google App ID used to uniquely identify an instance of an app. + * + * @since 0.1.0 */ applicationId: string; /** * The database root URL. + * + * @since 0.1.0 */ databaseUrl: string; /** * The Project Number. + * + * @since 0.1.0 */ gcmSenderId: string; /** * The Google Cloud project ID. + * + * @since 0.1.0 */ projectId: string; /** * The Google Cloud Storage bucket name. + * + * @since 0.1.0 */ storageBucket: string; } diff --git a/packages/authentication/README.md b/packages/authentication/README.md index 776900c2..ac0195c1 100644 --- a/packages/authentication/README.md +++ b/packages/authentication/README.md @@ -43,10 +43,10 @@ These SDKs can initialize on their own and collect various data. These configuration values are available: -| Prop | Type | Description | Default | -| -------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -| **`skipNativeAuth`** | boolean | Configure whether the plugin should skip the native authentication. Only needed if you want to use the Firebase JavaScript SDK. Only available for Android and iOS. | false | -| **`providers`** | string[] | Configure which providers you want to use so that only the providers you need are fully initialized. If you do not configure any providers, they will be all initialized. Please note that this does not prevent the automatic initialization of third-party SDKs. Only available for Android and iOS. | ["apple.com", "facebook.com", "github.com", "google.com", "microsoft.com", "playgames.google.com", "twitter.com", "yahoo.com", "phone"] | +| Prop | Type | Description | Default | Since | +| -------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ----- | +| **`skipNativeAuth`** | boolean | Configure whether the plugin should skip the native authentication. Only needed if you want to use the Firebase JavaScript SDK. Only available for Android and iOS. | false | 0.1.0 | +| **`providers`** | string[] | Configure which providers you want to use so that only the providers you need are fully initialized. If you do not configure any providers, they will be all initialized. Please note that this does not prevent the automatic initialization of third-party SDKs. Only available for Android and iOS. | ["apple.com", "facebook.com", "github.com", "google.com", "microsoft.com", "playgames.google.com", "twitter.com", "yahoo.com", "phone"] | 0.1.0 | ### Examples @@ -301,6 +301,8 @@ Applies a verification code sent to the user by email. | ------------- | ------------------------------------------------------------------------- | | **`options`** | ApplyActionCodeOptions | +**Since:** 0.2.2 + -------------------- @@ -319,6 +321,8 @@ If the new account was created, the user is signed in automatically. **Returns:** Promise<SignInResult> +**Since:** 0.2.2 + -------------------- @@ -328,12 +332,14 @@ If the new account was created, the user is signed in automatically. confirmPasswordReset(options: ConfirmPasswordResetOptions) => Promise ``` -Completes the password reset process +Completes the password reset process. | Param | Type | | ------------- | ----------------------------------------------------------------------------------- | | **`options`** | ConfirmPasswordResetOptions | +**Since:** 0.2.2 + -------------------- @@ -347,6 +353,8 @@ Fetches the currently signed-in user. **Returns:** Promise<GetCurrentUserResult> +**Since:** 0.1.0 + -------------------- @@ -364,6 +372,8 @@ Fetches the Firebase Auth ID Token for the currently signed-in user. **Returns:** Promise<GetIdTokenResult> +**Since:** 0.1.0 + -------------------- @@ -375,6 +385,8 @@ sendEmailVerification() => Promise Sends a verification email to the currently signed in user. +**Since:** 0.2.2 + -------------------- @@ -390,6 +402,8 @@ Sends a password reset email. | ------------- | --------------------------------------------------------------------------------------- | | **`options`** | SendPasswordResetEmailOptions | +**Since:** 0.2.2 + -------------------- @@ -405,6 +419,8 @@ Sets the user-facing language code for auth operations. | ------------- | ------------------------------------------------------------------------- | | **`options`** | SetLanguageCodeOptions | +**Since:** 0.1.0 + -------------------- @@ -422,6 +438,8 @@ Starts the Apple sign-in flow. **Returns:** Promise<SignInResult> +**Since:** 0.1.0 + -------------------- @@ -442,6 +460,8 @@ In this case you have to use the `signInWithCustomToken` interface of the Fireba **Returns:** Promise<SignInResult> +**Since:** 0.1.0 + -------------------- @@ -459,6 +479,8 @@ Starts the sign-in flow using an email and password. **Returns:** Promise<SignInResult> +**Since:** 0.2.2 + -------------------- @@ -476,6 +498,8 @@ Starts the Facebook sign-in flow. **Returns:** Promise<SignInResult> +**Since:** 0.1.0 + -------------------- @@ -493,6 +517,8 @@ Starts the GitHub sign-in flow. **Returns:** Promise<SignInResult> +**Since:** 0.1.0 + -------------------- @@ -510,6 +536,8 @@ Starts the Google sign-in flow. **Returns:** Promise<SignInResult> +**Since:** 0.1.0 + -------------------- @@ -527,6 +555,8 @@ Starts the Microsoft sign-in flow. **Returns:** Promise<SignInResult> +**Since:** 0.1.0 + -------------------- @@ -548,6 +578,8 @@ Only available for Android and iOS. **Returns:** Promise<SignInWithPhoneNumberResult> +**Since:** 0.1.0 + -------------------- @@ -565,6 +597,8 @@ Starts the Play Games sign-in flow. **Returns:** Promise<SignInResult> +**Since:** 0.1.0 + -------------------- @@ -582,6 +616,8 @@ Starts the Twitter sign-in flow. **Returns:** Promise<SignInResult> +**Since:** 0.1.0 + -------------------- @@ -599,6 +635,8 @@ Starts the Yahoo sign-in flow. **Returns:** Promise<SignInResult> +**Since:** 0.1.0 + -------------------- @@ -610,6 +648,8 @@ signOut() => Promise Starts the sign-out flow. +**Since:** 0.1.0 + -------------------- @@ -625,6 +665,8 @@ Updates the email address of the currently signed in user. | ------------- | ----------------------------------------------------------------- | | **`options`** | UpdateEmailOptions | +**Since:** 0.1.0 + -------------------- @@ -640,6 +682,8 @@ Updates the password of the currently signed in user. | ------------- | ----------------------------------------------------------------------- | | **`options`** | UpdatePasswordOptions | +**Since:** 0.1.0 + -------------------- @@ -651,6 +695,8 @@ useAppLanguage() => Promise Sets the user-facing language code to be the default app language. +**Since:** 0.1.0 + -------------------- @@ -666,6 +712,8 @@ Instrument your app to talk to the Authentication emulator. | ------------- | ----------------------------------------------------------------- | | **`options`** | UseEmulatorOptions | +**Since:** 0.2.0 + -------------------- @@ -684,6 +732,8 @@ Listen for the user's sign-in state changes. **Returns:** Promise<PluginListenerHandle> & PluginListenerHandle +**Since:** 0.1.0 + -------------------- @@ -695,6 +745,8 @@ removeAllListeners() => Promise Remove all listeners for this plugin. +**Since:** 0.1.0 + -------------------- @@ -703,163 +755,163 @@ Remove all listeners for this plugin. #### ApplyActionCodeOptions -| Prop | Type | Description | -| ------------- | ------------------- | ------------------------------------- | -| **`oobCode`** | string | A verification code sent to the user. | +| Prop | Type | Description | Since | +| ------------- | ------------------- | ------------------------------------- | ----- | +| **`oobCode`** | string | A verification code sent to the user. | 0.2.2 | #### SignInResult -| Prop | Type | Description | -| ---------------- | ----------------------------------------------------------------- | --------------------------------------------------------- | -| **`user`** | User \| null | The currently signed-in user, or null if there isn't any. | -| **`credential`** | AuthCredential \| null | Credentials returned by an auth provider. | +| Prop | Type | Description | Since | +| ---------------- | ----------------------------------------------------------------- | --------------------------------------------------------- | ----- | +| **`user`** | User \| null | The currently signed-in user, or null if there isn't any. | 0.1.0 | +| **`credential`** | AuthCredential \| null | Credentials returned by an auth provider. | 0.1.0 | #### User -| Prop | Type | -| ------------------- | --------------------------- | -| **`displayName`** | string \| null | -| **`email`** | string \| null | -| **`emailVerified`** | boolean | -| **`isAnonymous`** | boolean | -| **`phoneNumber`** | string \| null | -| **`photoUrl`** | string \| null | -| **`providerId`** | string | -| **`tenantId`** | string \| null | -| **`uid`** | string | +| Prop | Type | Since | +| ------------------- | --------------------------- | ----- | +| **`displayName`** | string \| null | 0.1.0 | +| **`email`** | string \| null | 0.1.0 | +| **`emailVerified`** | boolean | 0.1.0 | +| **`isAnonymous`** | boolean | 0.1.0 | +| **`phoneNumber`** | string \| null | 0.1.0 | +| **`photoUrl`** | string \| null | 0.1.0 | +| **`providerId`** | string | 0.1.0 | +| **`tenantId`** | string \| null | 0.1.0 | +| **`uid`** | string | 0.1.0 | #### AuthCredential -| Prop | Type | Description | -| ----------------- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| **`providerId`** | string | The authentication provider ID for the credential. Example: `google.com`. | -| **`accessToken`** | string | The OAuth access token associated with the credential if it belongs to an OAuth provider. | -| **`idToken`** | string | The OAuth ID token associated with the credential if it belongs to an OIDC provider. | -| **`secret`** | string | The OAuth access token secret associated with the credential if it belongs to an OAuth 1.0 provider. | -| **`nonce`** | string | The random string used to make sure that the ID token you get was granted specifically in response to your app's authentication request. | +| Prop | Type | Description | Since | +| ----------------- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ----- | +| **`providerId`** | string | The authentication provider ID for the credential. | 0.1.0 | +| **`accessToken`** | string | The OAuth access token associated with the credential if it belongs to an OAuth provider. | 0.1.0 | +| **`idToken`** | string | The OAuth ID token associated with the credential if it belongs to an OIDC provider. | 0.1.0 | +| **`secret`** | string | The OAuth access token secret associated with the credential if it belongs to an OAuth 1.0 provider. | 0.1.0 | +| **`nonce`** | string | The random string used to make sure that the ID token you get was granted specifically in response to your app's authentication request. | 0.1.0 | #### CreateUserWithEmailAndPasswordOptions -| Prop | Type | -| -------------- | ------------------- | -| **`email`** | string | -| **`password`** | string | +| Prop | Type | Since | +| -------------- | ------------------- | ----- | +| **`email`** | string | 0.2.2 | +| **`password`** | string | 0.2.2 | #### ConfirmPasswordResetOptions -| Prop | Type | Description | -| ----------------- | ------------------- | ------------------------------------- | -| **`oobCode`** | string | A verification code sent to the user. | -| **`newPassword`** | string | The new password. | +| Prop | Type | Description | Since | +| ----------------- | ------------------- | ------------------------------------- | ----- | +| **`oobCode`** | string | A verification code sent to the user. | 0.2.2 | +| **`newPassword`** | string | The new password. | 0.2.2 | #### GetCurrentUserResult -| Prop | Type | Description | -| ---------- | --------------------------------------------- | --------------------------------------------------------- | -| **`user`** | User \| null | The currently signed-in user, or null if there isn't any. | +| Prop | Type | Description | Since | +| ---------- | --------------------------------------------- | --------------------------------------------------------- | ----- | +| **`user`** | User \| null | The currently signed-in user, or null if there isn't any. | 0.1.0 | #### GetIdTokenResult -| Prop | Type | Description | -| ----------- | ------------------- | -------------------------------------- | -| **`token`** | string | The Firebase Auth ID token JWT string. | +| Prop | Type | Description | Since | +| ----------- | ------------------- | -------------------------------------- | ----- | +| **`token`** | string | The Firebase Auth ID token JWT string. | 0.1.0 | #### GetIdTokenOptions -| Prop | Type | Description | -| ------------------ | -------------------- | --------------------------------------------- | -| **`forceRefresh`** | boolean | Force refresh regardless of token expiration. | +| Prop | Type | Description | Since | +| ------------------ | -------------------- | --------------------------------------------- | ----- | +| **`forceRefresh`** | boolean | Force refresh regardless of token expiration. | 0.1.0 | #### SendPasswordResetEmailOptions -| Prop | Type | -| ----------- | ------------------- | -| **`email`** | string | +| Prop | Type | Since | +| ----------- | ------------------- | ----- | +| **`email`** | string | 0.2.2 | #### SetLanguageCodeOptions -| Prop | Type | Description | -| ------------------ | ------------------- | --------------------------------------- | -| **`languageCode`** | string | BCP 47 language code. Example: `en-US`. | +| Prop | Type | Description | Since | +| ------------------ | ------------------- | --------------------- | ----- | +| **`languageCode`** | string | BCP 47 language code. | 0.1.0 | #### SignInOptions -| Prop | Type | Description | -| ---------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------- | -| **`customParameters`** | SignInCustomParameter[] | Configures custom parameters to be passed to the identity provider during the OAuth sign-in flow. | -| **`scopes`** | string[] | Scopes to request from provider. | +| Prop | Type | Description | Since | +| ---------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------- | ----- | +| **`customParameters`** | SignInCustomParameter[] | Configures custom parameters to be passed to the identity provider during the OAuth sign-in flow. | 0.1.0 | +| **`scopes`** | string[] | Scopes to request from provider. | 0.3.1 | #### SignInCustomParameter -| Prop | Type | Description | -| ----------- | ------------------- | ------------------------------------------------------------------ | -| **`key`** | string | The custom parameter key (e.g. `login_hint`). | -| **`value`** | string | The custom parameter value (e.g. `user@firstadd.onmicrosoft.com`). | +| Prop | Type | Description | Since | +| ----------- | ------------------- | ------------------------------------------------------------------ | ----- | +| **`key`** | string | The custom parameter key (e.g. `login_hint`). | 0.1.0 | +| **`value`** | string | The custom parameter value (e.g. `user@firstadd.onmicrosoft.com`). | 0.1.0 | #### SignInWithCustomTokenOptions -| Prop | Type | Description | -| ----------- | ------------------- | --------------------------------- | -| **`token`** | string | The custom token to sign in with. | +| Prop | Type | Description | Since | +| ----------- | ------------------- | --------------------------------- | ----- | +| **`token`** | string | The custom token to sign in with. | 0.1.0 | #### SignInWithEmailAndPasswordOptions -| Prop | Type | Description | -| -------------- | ------------------- | ------------------------ | -| **`email`** | string | The users email address. | -| **`password`** | string | The users password. | +| Prop | Type | Description | Since | +| -------------- | ------------------- | ------------------------ | ----- | +| **`email`** | string | The users email address. | 0.2.2 | +| **`password`** | string | The users password. | 0.2.2 | #### SignInWithPhoneNumberResult -| Prop | Type | Description | -| -------------------- | ------------------- | ----------------------------------------------------------------------- | -| **`verificationId`** | string | The verification ID, which is needed to identify the verification code. | +| Prop | Type | Description | Since | +| -------------------- | ------------------- | ----------------------------------------------------------------------- | ----- | +| **`verificationId`** | string | The verification ID, which is needed to identify the verification code. | 0.1.0 | #### SignInWithPhoneNumberOptions -| Prop | Type | Description | -| ---------------------- | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | -| **`phoneNumber`** | string | The phone number to be verified. | -| **`verificationId`** | string | The verification ID which will be returned when `signInWithPhoneNumber` is called for the first time. The `verificationCode` must also be provided. | -| **`verificationCode`** | string | The verification code from the SMS message. The `verificationId` must also be provided. | +| Prop | Type | Description | Since | +| ---------------------- | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ----- | +| **`phoneNumber`** | string | The phone number to be verified. | 0.1.0 | +| **`verificationId`** | string | The verification ID which will be returned when `signInWithPhoneNumber` is called for the first time. The `verificationCode` must also be provided. | 0.1.0 | +| **`verificationCode`** | string | The verification code from the SMS message. The `verificationId` must also be provided. | 0.1.0 | #### UpdateEmailOptions -| Prop | Type | Description | -| -------------- | ------------------- | ---------------------- | -| **`newEmail`** | string | The new email address. | +| Prop | Type | Description | Since | +| -------------- | ------------------- | ---------------------- | ----- | +| **`newEmail`** | string | The new email address. | 0.2.2 | #### UpdatePasswordOptions -| Prop | Type | Description | -| ----------------- | ------------------- | ----------------- | -| **`newPassword`** | string | The new password. | +| Prop | Type | Description | Since | +| ----------------- | ------------------- | ----------------- | ----- | +| **`newPassword`** | string | The new password. | 0.2.2 | #### UseEmulatorOptions -| Prop | Type | Description | -| ---------- | ------------------- | ------------------------------------------------ | -| **`host`** | string | The emulator host (e.g. `10.0.2.2`). | -| **`port`** | number | The emulator port (e.g. `9099`). Default: `9099` | +| Prop | Type | Description | Default | Since | +| ---------- | ------------------- | ------------------------------------ | ----------------- | ----- | +| **`host`** | string | The emulator host (e.g. `10.0.2.2`). | | 0.2.0 | +| **`port`** | number | The emulator port (e.g. `9099`). | 9099 | 0.2.0 | #### PluginListenerHandle @@ -871,9 +923,9 @@ Remove all listeners for this plugin. #### AuthStateChange -| Prop | Type | Description | -| ---------- | --------------------------------------------- | --------------------------------------------------------- | -| **`user`** | User \| null | The currently signed-in user, or null if there isn't any. | +| Prop | Type | Description | Since | +| ---------- | --------------------------------------------- | --------------------------------------------------------- | ----- | +| **`user`** | User \| null | The currently signed-in user, or null if there isn't any. | 0.1.0 | ### Type Aliases diff --git a/packages/authentication/src/definitions.ts b/packages/authentication/src/definitions.ts index 5d8c11f4..fab14aaf 100644 --- a/packages/authentication/src/definitions.ts +++ b/packages/authentication/src/definitions.ts @@ -6,6 +6,8 @@ declare module '@capacitor/cli' { export interface PluginsConfig { /** * These configuration values are available: + * + * @since 0.1.0 */ FirebaseAuthentication?: { /** @@ -16,6 +18,7 @@ declare module '@capacitor/cli' { * * @default false * @example false + * @since 0.1.0 */ skipNativeAuth?: boolean; /** @@ -27,6 +30,7 @@ declare module '@capacitor/cli' { * * @default ["apple.com", "facebook.com", "github.com", "google.com", "microsoft.com", "playgames.google.com", "twitter.com", "yahoo.com", "phone"] * @example ["apple.com", "google.com"] + * @since 0.1.0 */ providers?: string[]; }; @@ -36,41 +40,59 @@ declare module '@capacitor/cli' { export interface FirebaseAuthenticationPlugin { /** * Applies a verification code sent to the user by email. + * + * @since 0.2.2 */ applyActionCode(options: ApplyActionCodeOptions): Promise; /** * Creates a new user account with email and password. * If the new account was created, the user is signed in automatically. + * + * @since 0.2.2 */ createUserWithEmailAndPassword( options: CreateUserWithEmailAndPasswordOptions, ): Promise; /** - * Completes the password reset process + * Completes the password reset process. + * + * @since 0.2.2 */ confirmPasswordReset(options: ConfirmPasswordResetOptions): Promise; /** * Fetches the currently signed-in user. + * + * @since 0.1.0 */ getCurrentUser(): Promise; /** * Fetches the Firebase Auth ID Token for the currently signed-in user. + * + * @since 0.1.0 */ getIdToken(options?: GetIdTokenOptions): Promise; /** * Sends a verification email to the currently signed in user. + * + * @since 0.2.2 */ sendEmailVerification(): Promise; /** * Sends a password reset email. + * + * @since 0.2.2 */ sendPasswordResetEmail(options: SendPasswordResetEmailOptions): Promise; /** * Sets the user-facing language code for auth operations. + * + * @since 0.1.0 */ setLanguageCode(options: SetLanguageCodeOptions): Promise; /** * Starts the Apple sign-in flow. + * + * @since 0.1.0 */ signInWithApple(options?: SignInOptions): Promise; /** @@ -78,30 +100,42 @@ export interface FirebaseAuthenticationPlugin { * * This method cannot be used in combination with `skipNativeAuth` on Android and iOS. * In this case you have to use the `signInWithCustomToken` interface of the Firebase JS SDK directly. + * + * @since 0.1.0 */ signInWithCustomToken( options: SignInWithCustomTokenOptions, ): Promise; /** * Starts the sign-in flow using an email and password. + * + * @since 0.2.2 */ signInWithEmailAndPassword( options: SignInWithEmailAndPasswordOptions, ): Promise; /** * Starts the Facebook sign-in flow. + * + * @since 0.1.0 */ signInWithFacebook(options?: SignInOptions): Promise; /** * Starts the GitHub sign-in flow. + * + * @since 0.1.0 */ signInWithGithub(options?: SignInOptions): Promise; /** * Starts the Google sign-in flow. + * + * @since 0.1.0 */ signInWithGoogle(options?: SignInOptions): Promise; /** * Starts the Microsoft sign-in flow. + * + * @since 0.1.0 */ signInWithMicrosoft(options?: SignInOptions): Promise; /** @@ -110,44 +144,64 @@ export interface FirebaseAuthenticationPlugin { * Either the phone number or the verification code and verification ID must be provided. * * Only available for Android and iOS. + * + * @since 0.1.0 */ signInWithPhoneNumber( options: SignInWithPhoneNumberOptions, ): Promise; /** * Starts the Play Games sign-in flow. + * + * @since 0.1.0 */ signInWithPlayGames(options?: SignInOptions): Promise; /** * Starts the Twitter sign-in flow. + * + * @since 0.1.0 */ signInWithTwitter(options?: SignInOptions): Promise; /** * Starts the Yahoo sign-in flow. + * + * @since 0.1.0 */ signInWithYahoo(options?: SignInOptions): Promise; /** * Starts the sign-out flow. + * + * @since 0.1.0 */ signOut(): Promise; /** * Updates the email address of the currently signed in user. + * + * @since 0.1.0 */ updateEmail(options: UpdateEmailOptions): Promise; /** * Updates the password of the currently signed in user. + * + * @since 0.1.0 */ updatePassword(options: UpdatePasswordOptions): Promise; /** * Sets the user-facing language code to be the default app language. + * + * @since 0.1.0 */ useAppLanguage(): Promise; /** * Instrument your app to talk to the Authentication emulator. + * + * @since 0.2.0 */ useEmulator(options: UseEmulatorOptions): Promise; /** * Listen for the user's sign-in state changes. + * + * @since 0.1.0 */ addListener( eventName: 'authStateChange', @@ -155,214 +209,374 @@ export interface FirebaseAuthenticationPlugin { ): Promise & PluginListenerHandle; /** * Remove all listeners for this plugin. + * + * @since 0.1.0 */ removeAllListeners(): Promise; } +/** + * @since 0.2.2 + */ export interface ApplyActionCodeOptions { /** * A verification code sent to the user. + * + * @since 0.2.2 */ oobCode: string; } +/** + * @since 0.2.2 + */ export interface ConfirmPasswordResetOptions { /** * A verification code sent to the user. + * + * @since 0.2.2 */ oobCode: string; /** * The new password. + * + * @since 0.2.2 */ newPassword: string; } +/** + * @since 0.2.2 + */ export interface CreateUserWithEmailAndPasswordOptions { + /** + * @since 0.2.2 + */ email: string; + /** + * @since 0.2.2 + */ password: string; } +/** + * @since 0.1.0 + */ export interface GetCurrentUserResult { /** * The currently signed-in user, or null if there isn't any. + * + * @since 0.1.0 */ user: User | null; } +/** + * @since 0.1.0 + */ export interface GetIdTokenOptions { /** * Force refresh regardless of token expiration. + * + * @since 0.1.0 */ forceRefresh: boolean; } +/** + * @since 0.1.0 + */ export interface GetIdTokenResult { /** * The Firebase Auth ID token JWT string. + * + * @since 0.1.0 */ token: string; } +/** + * @since 0.2.2 + */ export interface SendPasswordResetEmailOptions { + /** + * @since 0.2.2 + */ email: string; } +/** + * @since 0.1.0 + */ export interface SetLanguageCodeOptions { /** * BCP 47 language code. * - * Example: `en-US`. + * @example "en-US" + * @since 0.1.0 */ languageCode: string; } +/** + * @since 0.2.2 + */ export interface UpdateEmailOptions { /** * The new email address. + * + * @since 0.2.2 */ newEmail: string; } +/** + * @since 0.2.2 + */ export interface UpdatePasswordOptions { /** * The new password. + * + * @since 0.2.2 */ newPassword: string; } +/** + * @since 0.1.0 + */ export interface SignInOptions { /** * Configures custom parameters to be passed to the identity provider during the OAuth sign-in flow. + * + * @since 0.1.0 */ customParameters?: SignInCustomParameter[]; /** * Scopes to request from provider. + * + * @since 0.3.1 */ scopes?: string[]; } +/** + * @since 0.1.0 + */ export interface SignInCustomParameter { /** * The custom parameter key (e.g. `login_hint`). + * + * @since 0.1.0 */ key: string; /** * The custom parameter value (e.g. `user@firstadd.onmicrosoft.com`). + * + * @since 0.1.0 */ value: string; } +/** + * @since 0.1.0 + */ export interface SignInWithPhoneNumberOptions { /** * The phone number to be verified. + * + * @since 0.1.0 */ phoneNumber?: string; /** * The verification ID which will be returned when `signInWithPhoneNumber` is called for the first time. * The `verificationCode` must also be provided. + * + * @since 0.1.0 */ verificationId?: string; /** * The verification code from the SMS message. * The `verificationId` must also be provided. + * + * @since 0.1.0 */ verificationCode?: string; } +/** + * @since 0.2.2 + */ export interface SignInWithEmailAndPasswordOptions { /** * The users email address. + * + * @since 0.2.2 */ email: string; /** * The users password. + * + * @since 0.2.2 */ password: string; } +/** + * @since 0.1.0 + */ export interface SignInWithCustomTokenOptions { /** * The custom token to sign in with. + * + * @since 0.1.0 */ token: string; } +/** + * @since 0.1.0 + */ export interface SignInResult { /** * The currently signed-in user, or null if there isn't any. + * + * @since 0.1.0 */ user: User | null; /** * Credentials returned by an auth provider. + * + * @since 0.1.0 */ credential: AuthCredential | null; } +/** + * @since 0.2.0 + */ export interface UseEmulatorOptions { /** * The emulator host (e.g. `10.0.2.2`). + * + * @since 0.2.0 */ host: string; /** * The emulator port (e.g. `9099`). * - * Default: `9099` + * @default 9099 + * @since 0.2.0 */ port?: number; } +/** + * @since 0.1.0 + */ export interface SignInWithPhoneNumberResult extends SignInResult { /** * The verification ID, which is needed to identify the verification code. + * + * @since 0.1.0 */ verificationId?: string; } +/** + * @since 0.1.0 + */ export interface User { + /** + * @since 0.1.0 + */ displayName: string | null; + /** + * @since 0.1.0 + */ email: string | null; + /** + * @since 0.1.0 + */ emailVerified: boolean; + /** + * @since 0.1.0 + */ isAnonymous: boolean; + /** + * @since 0.1.0 + */ phoneNumber: string | null; + /** + * @since 0.1.0 + */ photoUrl: string | null; + /** + * @since 0.1.0 + */ providerId: string; + /** + * @since 0.1.0 + */ tenantId: string | null; + /** + * @since 0.1.0 + */ uid: string; } +/** + * @since 0.1.0 + */ export interface AuthCredential { /** * The authentication provider ID for the credential. * - * Example: `google.com`. + * @example "google.com" + * @since 0.1.0 */ providerId: string; /** * The OAuth access token associated with the credential if it belongs to an OAuth provider. + * + * @since 0.1.0 */ accessToken?: string; /** * The OAuth ID token associated with the credential if it belongs to an OIDC provider. + * + * @since 0.1.0 */ idToken?: string; /** * The OAuth access token secret associated with the credential if it belongs to an OAuth 1.0 provider. + * + * @since 0.1.0 */ secret?: string; /** * The random string used to make sure that the ID token you get was granted specifically in response to your app's authentication request. + * + * @since 0.1.0 */ nonce?: string; } /** * Callback to receive the user's sign-in state change notifications. + * + * @since 0.1.0 */ export type AuthStateChangeListener = (change: AuthStateChange) => void; +/** + * @since 0.1.0 + */ export interface AuthStateChange { /** * The currently signed-in user, or null if there isn't any. + * + * @since 0.1.0 */ user: User | null; } diff --git a/packages/crashlytics/README.md b/packages/crashlytics/README.md index f4a1db08..72628f20 100644 --- a/packages/crashlytics/README.md +++ b/packages/crashlytics/README.md @@ -133,6 +133,8 @@ Only available for Android and iOS. | ------------- | ----------------------------------------------------- | | **`options`** | CrashOptions | +**Since:** 0.1.0 + -------------------- @@ -150,6 +152,8 @@ Only available for Android and iOS. | ------------- | ------------------------------------------------------------------- | | **`options`** | SetCustomKeyOptions | +**Since:** 0.1.0 + -------------------- @@ -167,6 +171,8 @@ Only available for Android and iOS. | ------------- | ------------------------------------------------------------- | | **`options`** | SetUserIdOptions | +**Since:** 0.1.0 + -------------------- @@ -184,6 +190,8 @@ Only available for Android and iOS. | ------------- | ------------------------------------------------- | | **`options`** | LogOptions | +**Since:** 0.1.0 + -------------------- @@ -202,6 +210,8 @@ Only available for Android and iOS. | ------------- | --------------------------------------------------------------- | | **`options`** | SetEnabledOptions | +**Since:** 0.1.0 + -------------------- @@ -217,6 +227,8 @@ Only available for iOS. **Returns:** Promise<IsEnabledResult> +**Since:** 0.1.0 + -------------------- @@ -232,6 +244,8 @@ Only available for Android and iOS. **Returns:** Promise<DidCrashOnPreviousExecutionResult> +**Since:** 0.1.0 + -------------------- @@ -246,6 +260,8 @@ When automatic data collection is enabled, Crashlytics automatically uploads rep Only available for Android and iOS. +**Since:** 0.1.0 + -------------------- @@ -259,6 +275,8 @@ Deletes any unsent reports on the device. Only available for Android and iOS. +**Since:** 0.1.0 + -------------------- @@ -276,6 +294,8 @@ Only available for Android and iOS. | ------------- | ------------------------------------------------------------------------- | | **`options`** | RecordExceptionOptions | +**Since:** 0.1.0 + -------------------- @@ -284,62 +304,62 @@ Only available for Android and iOS. #### CrashOptions -| Prop | Type | -| ------------- | ------------------- | -| **`message`** | string | +| Prop | Type | Since | +| ------------- | ------------------- | ----- | +| **`message`** | string | 0.1.0 | #### SetCustomKeyOptions -| Prop | Type | -| ----------- | ---------------------------------------------------------------------------- | -| **`key`** | string | -| **`value`** | string \| number \| boolean | -| **`type`** | 'string' \| 'boolean' \| 'long' \| 'double' \| 'int' \| 'float' | +| Prop | Type | Since | +| ----------- | ---------------------------------------------------------------------------- | ----- | +| **`key`** | string | 0.1.0 | +| **`value`** | string \| number \| boolean | 0.1.0 | +| **`type`** | 'string' \| 'boolean' \| 'long' \| 'double' \| 'int' \| 'float' | 0.1.0 | #### SetUserIdOptions -| Prop | Type | -| ------------ | ------------------- | -| **`userId`** | string | +| Prop | Type | Since | +| ------------ | ------------------- | ----- | +| **`userId`** | string | 0.1.0 | #### LogOptions -| Prop | Type | -| ------------- | ------------------- | -| **`message`** | string | +| Prop | Type | Since | +| ------------- | ------------------- | ----- | +| **`message`** | string | 0.1.0 | #### SetEnabledOptions -| Prop | Type | -| ------------- | -------------------- | -| **`enabled`** | boolean | +| Prop | Type | Since | +| ------------- | -------------------- | ----- | +| **`enabled`** | boolean | 0.1.0 | #### IsEnabledResult -| Prop | Type | -| ------------- | -------------------- | -| **`enabled`** | boolean | +| Prop | Type | Since | +| ------------- | -------------------- | ----- | +| **`enabled`** | boolean | 0.1.0 | #### DidCrashOnPreviousExecutionResult -| Prop | Type | -| ------------- | -------------------- | -| **`crashed`** | boolean | +| Prop | Type | Since | +| ------------- | -------------------- | ----- | +| **`crashed`** | boolean | 0.1.0 | #### RecordExceptionOptions -| Prop | Type | Description | -| ------------- | ------------------- | ------------------------------------------------------------------ | -| **`message`** | string | | -| **`code`** | number | Error code within a specific error domain. Only available for iOS. | -| **`domain`** | string | A string containing the error domain. Only available for iOS. | +| Prop | Type | Description | Since | +| ------------- | ------------------- | ------------------------------------------------------------------ | ----- | +| **`message`** | string | | 0.1.0 | +| **`code`** | number | Error code within a specific error domain. Only available for iOS. | 0.1.0 | +| **`domain`** | string | A string containing the error domain. Only available for iOS. | 0.1.0 | diff --git a/packages/crashlytics/src/definitions.ts b/packages/crashlytics/src/definitions.ts index 4674980e..5a769dca 100644 --- a/packages/crashlytics/src/definitions.ts +++ b/packages/crashlytics/src/definitions.ts @@ -3,24 +3,32 @@ export interface FirebaseCrashlyticsPlugin { * Forces a crash to test the implementation. * * Only available for Android and iOS. + * + * @since 0.1.0 */ crash(options: CrashOptions): Promise; /** * Sets a custom key and value that is associated with subsequent fatal and non-fatal reports. * * Only available for Android and iOS. + * + * @since 0.1.0 */ setCustomKey(options: SetCustomKeyOptions): Promise; /** * Sets a user ID (identifier) that is associated with subsequent fatal and non-fatal reports. * * Only available for Android and iOS. + * + * @since 0.1.0 */ setUserId(options: SetUserIdOptions): Promise; /** * Adds a custom log message that is sent with your crash data to give yourself more context for the events leading up to a crash. * * Only available for Android and iOS. + * + * @since 0.1.0 */ log(options: LogOptions): Promise; /** @@ -28,18 +36,24 @@ export interface FirebaseCrashlyticsPlugin { * The value does not apply until the next run of the app. * * Only available for Android and iOS. + * + * @since 0.1.0 */ setEnabled(options: SetEnabledOptions): Promise; /** * Returns whether or not automatic data collection is enabled. * * Only available for iOS. + * + * @since 0.1.0 */ isEnabled(): Promise; /** * Returns whether the app crashed during the previous execution. * * Only available for Android and iOS. + * + * @since 0.1.0 */ didCrashOnPreviousExecution(): Promise; /** @@ -47,64 +61,128 @@ export interface FirebaseCrashlyticsPlugin { * When automatic data collection is enabled, Crashlytics automatically uploads reports at startup. * * Only available for Android and iOS. + * + * @since 0.1.0 */ sendUnsentReports(): Promise; /** * Deletes any unsent reports on the device. * * Only available for Android and iOS. + * + * @since 0.1.0 */ deleteUnsentReports(): Promise; /** * Records a non-fatal report to send to Crashlytics. * * Only available for Android and iOS. + * + * @since 0.1.0 */ recordException(options: RecordExceptionOptions): Promise; } +/** + * @since 0.1.0 + */ export interface CrashOptions { + /** + * @since 0.1.0 + */ message: string; } +/** + * @since 0.1.0 + */ export interface SetCustomKeyOptions { + /** + * @since 0.1.0 + */ key: string; + /** + * @since 0.1.0 + */ value: string | number | boolean; + /** + * @since 0.1.0 + */ type: 'string' | 'long' | 'double' | 'boolean' | 'int' | 'float'; } +/** + * @since 0.1.0 + */ export interface SetUserIdOptions { + /** + * @since 0.1.0 + */ userId: string; } +/** + * @since 0.1.0 + */ export interface LogOptions { + /** + * @since 0.1.0 + */ message: string; } +/** + * @since 0.1.0 + */ export interface SetEnabledOptions { + /** + * @since 0.1.0 + */ enabled: boolean; } +/** + * @since 0.1.0 + */ export interface IsEnabledResult { + /** + * @since 0.1.0 + */ enabled: boolean; } +/** + * @since 0.1.0 + */ export interface DidCrashOnPreviousExecutionResult { + /** + * @since 0.1.0 + */ crashed: boolean; } +/** + * @since 0.1.0 + */ export interface RecordExceptionOptions { + /** + * @since 0.1.0 + */ message: string; /** * Error code within a specific error domain. * * Only available for iOS. + * + * @since 0.1.0 */ code?: number; /** * A string containing the error domain. * * Only available for iOS. + * + * @since 0.1.0 */ domain?: string; } diff --git a/packages/messaging/README.md b/packages/messaging/README.md index 8cd9ffca..e98ebb12 100644 --- a/packages/messaging/README.md +++ b/packages/messaging/README.md @@ -549,8 +549,8 @@ Remove all native listeners for this plugin. | Prop | Type | Description | Since | | ------------------ | ----------------------------------------------------- | --------------------------------------------------------------- | ----- | -| **`actionId`** | Notification | The action performed on the notification. | 0.2.2 | -| **`inputValue`** | Notification | Text entered on the notification action. Only available on iOS. | 0.2.2 | +| **`actionId`** | string | The action performed on the notification. | 0.2.2 | +| **`inputValue`** | string | Text entered on the notification action. Only available on iOS. | 0.2.2 | | **`notification`** | Notification | The notification in which the action was performed. | 0.2.2 | diff --git a/packages/messaging/src/definitions.ts b/packages/messaging/src/definitions.ts index 86453e58..540d953e 100644 --- a/packages/messaging/src/definitions.ts +++ b/packages/messaging/src/definitions.ts @@ -20,9 +20,9 @@ declare module '@capacitor/cli' { * * Only available for iOS. * - * @since 0.2.2 * @example ["badge", "sound", "alert"] * @default ["badge", "sound", "alert"] + * @since 0.2.2 */ presentationOptions: PresentationOption[]; }; diff --git a/packages/performance/README.md b/packages/performance/README.md index 971bd917..00a2d07a 100644 --- a/packages/performance/README.md +++ b/packages/performance/README.md @@ -88,6 +88,8 @@ Starts a trace. | ------------- | --------------------------------------------------------------- | | **`options`** | StartTraceOptions | +**Since:** 0.1.0 + -------------------- @@ -103,6 +105,8 @@ Stops a trace. | ------------- | ------------------------------------------------------------- | | **`options`** | StopTraceOptions | +**Since:** 0.1.0 + -------------------- @@ -118,6 +122,8 @@ Atomically increments the metric with the given name for the selected trace by t | ------------- | ------------------------------------------------------------------------- | | **`options`** | IncrementMetricOptions | +**Since:** 0.1.0 + -------------------- @@ -134,6 +140,8 @@ Will be applied with the next start of the app. | ------------- | --------------------------------------------------------------------------------------------------------- | | **`options`** | SetPerformanceCollectionEnabledOptions | +**Since:** 0.1.0 + -------------------- @@ -147,6 +155,8 @@ Determines whether performance monitoring is enabled or disabled. **Returns:** Promise<IsPerformanceCollectionEnabledResult> +**Since:** 0.1.0 + -------------------- @@ -155,39 +165,39 @@ Determines whether performance monitoring is enabled or disabled. #### StartTraceOptions -| Prop | Type | Description | -| --------------- | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **`traceName`** | string | Custom trace name. Names for custom code traces must meet the following requirements: no leading or trailing whitespace, no leading underscore (_) character, and max length is 100 characters. | +| Prop | Type | Description | Since | +| --------------- | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- | +| **`traceName`** | string | Custom trace name. Names for custom code traces must meet the following requirements: no leading or trailing whitespace, no leading underscore (_) character, and max length is 100 characters. | 0.1.0 | #### StopTraceOptions -| Prop | Type | Description | -| --------------- | ------------------- | ------------------------------------------------- | -| **`traceName`** | string | Name of the trace that was set with `startTrace`. | +| Prop | Type | Description | Since | +| --------------- | ------------------- | ------------------------------------------------- | ----- | +| **`traceName`** | string | Name of the trace that was set with `startTrace`. | 0.1.0 | #### IncrementMetricOptions -| Prop | Type | Description | -| ----------------- | ------------------- | -------------------------------------------------------------- | -| **`traceName`** | string | Name of the trace that was set with `startTrace`. | -| **`metricName`** | string | Name of the metric to be incremented. | -| **`incrementBy`** | number | Amount by which the metric has to be incremented. Default: `1` | +| Prop | Type | Description | Default | Since | +| ----------------- | ------------------- | ------------------------------------------------- | -------------- | ----- | +| **`traceName`** | string | Name of the trace that was set with `startTrace`. | | 0.1.0 | +| **`metricName`** | string | Name of the metric to be incremented. | | 0.1.0 | +| **`incrementBy`** | number | Amount by which the metric has to be incremented. | 1 | 0.1.0 | #### SetPerformanceCollectionEnabledOptions -| Prop | Type | Description | -| ------------- | -------------------- | ----------------------------------------- | -| **`enabled`** | boolean | Should performance monitoring be enabled. | +| Prop | Type | Description | Since | +| ------------- | -------------------- | ----------------------------------------- | ----- | +| **`enabled`** | boolean | Should performance monitoring be enabled. | 0.1.0 | #### IsPerformanceCollectionEnabledResult -| Prop | Type | Description | -| ------------- | -------------------- | --------------------------------------------------------------- | -| **`enabled`** | boolean | `true` if performance monitoring is enabled, otherwise `false`. | +| Prop | Type | Description | Since | +| ------------- | -------------------- | --------------------------------------------------------------- | ----- | +| **`enabled`** | boolean | `true` if performance monitoring is enabled, otherwise `false`. | 0.1.0 | diff --git a/packages/performance/src/definitions.ts b/packages/performance/src/definitions.ts index 49a2ee0e..a5ddda3c 100644 --- a/packages/performance/src/definitions.ts +++ b/packages/performance/src/definitions.ts @@ -1,29 +1,42 @@ export interface FirebasePerformancePlugin { /** * Starts a trace. + * + * @since 0.1.0 */ startTrace(options: StartTraceOptions): Promise; /** * Stops a trace. + * + * @since 0.1.0 */ stopTrace(options: StopTraceOptions): Promise; /** * Atomically increments the metric with the given name for the selected trace by the `incrementBy` value. + * + * @since 0.1.0 */ incrementMetric(options: IncrementMetricOptions): Promise; /** * Enables or disables performance monitoring. * Will be applied with the next start of the app. + * + * @since 0.1.0 */ setPerformanceCollectionEnabled( options: SetPerformanceCollectionEnabledOptions, ): Promise; /** * Determines whether performance monitoring is enabled or disabled. + * + * @since 0.1.0 */ isPerformanceCollectionEnabled(): Promise; } +/** + * @since 0.1.0 + */ export interface StartTraceOptions { /** * Custom trace name. @@ -31,37 +44,57 @@ export interface StartTraceOptions { * Names for custom code traces must meet the following requirements: * no leading or trailing whitespace, no leading underscore (_) character, * and max length is 100 characters. + * + * @since 0.1.0 */ traceName: string; } +/** + * @since 0.1.0 + */ export interface StopTraceOptions { /** * Name of the trace that was set with `startTrace`. + * + * @since 0.1.0 */ traceName: string; } +/** + * @since 0.1.0 + */ export interface IncrementMetricOptions { /** * Name of the trace that was set with `startTrace`. + * + * @since 0.1.0 */ traceName: string; /** * Name of the metric to be incremented. + * + * @since 0.1.0 */ metricName: string; /** * Amount by which the metric has to be incremented. * - * Default: `1` + * @default 1 + * @since 0.1.0 */ incrementBy?: number; } +/** + * @since 0.1.0 + */ export interface SetPerformanceCollectionEnabledOptions { /** * Should performance monitoring be enabled. + * + * @since 0.1.0 */ enabled: boolean; } @@ -69,6 +102,8 @@ export interface SetPerformanceCollectionEnabledOptions { export interface IsPerformanceCollectionEnabledResult { /** * `true` if performance monitoring is enabled, otherwise `false`. + * + * @since 0.1.0 */ enabled: boolean; }