Export result types. Add docs

Author: FreePhoenix888

src/get-push-notification.ts

@@ -20,7 +20,7 @@ const pushNotification = await getPushNotification({
 export async function getPushNotification({
   deep,
   pushNotificationLinkId,
-}: GetPushNotificationParam): Promise<PushNotification> {
+}: GetPushNotificationParam): Promise<GetPushNotificationResult> {
   const titleTypeLinkId = await deep.id(
     FIREBASE_PUSH_NOTIFICATION_PACKAGE_NAME,
     FirebasePushNotificationContains[
@@ -107,3 +107,5 @@ export interface GetPushNotificationParam {
    */
   pushNotificationLinkId: number;
 }
+
+export type GetPushNotificationResult = PushNotification;

src/insert-device-registration-token.ts

@@ -19,7 +19,7 @@ const { deviceRegistrationTokenLinkId } = await insertDeviceRegistrationToken({
  */
 export async function insertDeviceRegistrationToken({
   deep, deviceRegistrationToken, deviceLinkId
-}: InsertDeviceRegistrationTokenParam): Promise<{ deviceRegistrationTokenLinkId: number }> {
+}: InsertDeviceRegistrationTokenParam): Promise<InsertDeviceRegistrationTokenResult> {
   const deviceRegistrationTokenTypeLinkId = await deep.id(
     FIREBASE_PUSH_NOTIFICATION_PACKAGE_NAME,
     FirebasePushNotificationContains[FirebasePushNotificationContains.DeviceRegistrationToken]
@@ -63,4 +63,11 @@ export interface InsertDeviceRegistrationTokenParam {
    * Device link id
    */
   deviceLinkId: number;
-}
+}
+
+export interface InsertDeviceRegistrationTokenResult { 
+  /**
+   * Device registration token link id
+   */
+  deviceRegistrationTokenLinkId: number
+ }

src/main.ts

@@ -1,12 +1,13 @@
 export {FirebasePushNotificationContains} from './contains'
-export {getPushNotification, type GetPushNotificationParam} from './get-push-notification'
-export {insertDeviceRegistrationToken, type InsertDeviceRegistrationTokenParam} from './insert-device-registration-token'
-export {insertPushNotification, type InsertPushNotificationParam} from './insert-push-notification'
-export {insertServiceAccount, type InsertServiceAccountParam} from './insert-service-account'
-export {insertWebPushCertificate, type InsertWebPushCertificateParam} from './insert-web-push-certificate'
+export {getPushNotification, type GetPushNotificationParam, type  GetPushNotificationResult} from './get-push-notification'
+export {insertDeviceRegistrationToken, type InsertDeviceRegistrationTokenParam, type InsertDeviceRegistrationTokenResult} from './insert-device-registration-token'
+export {insertPushNotification, type InsertPushNotificationParam, type InsertPushNotificationResult} from './insert-push-notification'
+export {insertServiceAccount, type InsertServiceAccountParam, type InsertServiceAccountResult} from './insert-service-account'
+export {insertWebPushCertificate, type InsertWebPushCertificateParam, type InsertWebPushCertificateResult} from './insert-web-push-certificate'
 export {FIREBASE_PUSH_NOTIFICATION_PACKAGE_NAME} from './package-name'
 export {PushNotification} from './push-notification'
 export {registerDevice, type RegisterDeviceParam} from './register-device'
-export {requestPermissions} from './request-permissions'
+export {requestPermissions, type RequestPermissionsResult} from './request-permissions'
 import * as pushNotificationJsonSchema from './schema.json';
-export { pushNotificationJsonSchema };
+export { pushNotificationJsonSchema };
+export {checkPermissions, type CheckPermissionsResult} from './check-permissions'

src/register-device.ts

@@ -10,6 +10,9 @@ import { FirebasePushNotificationContains } from './contains';
 /**
  * Registers device
  * 
+ * @remarks
+ * This function also handle onMessage event
+ * 
  * @example
 ```ts
 await registerDevice({

src/request-permissions.ts

@@ -9,7 +9,7 @@ import { PushNotifications } from "@capacitor/push-notifications";
 await requestPermissions()
 ```
  */
-export async function requestPermissions(): Promise<boolean>{
+export async function requestPermissions(): Promise<RequestPermissionsResult>{
   const { platform } = await Device.getInfo();
   let isPermissionsGranted: boolean;
   if (platform === 'web') {
@@ -21,4 +21,6 @@ export async function requestPermissions(): Promise<boolean>{
     isPermissionsGranted = permissionsStatus.receive === 'granted';
   }
   return isPermissionsGranted
-}
+}
+
+export type RequestPermissionsResult = boolean;