@extrahorizon/javascript-sdk 8.7.0-dev-101-9e49b6c → 8.7.0-dev-103-01749fa

package/build/index.cjs.js

@@ -661,6 +661,13 @@ class RefreshTokenUnknownError extends BadRequestError {
 }
 class RefreshTokenExpiredError extends BadRequestError {
 }
+class FirebaseInvalidPlatformDataError extends BadRequestError {
+    constructor(apiError) {
+        super(apiError);
+        this.notificationId = apiError.response.notificationId;
+        this.errors = apiError.response.errors;
+    }
+}
 // 401 Unauthorized
 class UnauthorizedError extends ApiError {
 }
@@ -746,6 +753,13 @@ class BadGatewayServerError extends ApiError {
 }
 class StripeRequestError extends BadGatewayServerError {
 }
+class FirebaseConnectionError extends BadGatewayServerError {
+    constructor(apiError) {
+        super(apiError);
+        this.notificationId = apiError.response.notificationId;
+        this.errors = apiError.response.errors;
+    }
+}
 // 503 Service Unavailable Error
 class ServiceUnavailableError extends ApiError {
 }
@@ -5498,7 +5512,7 @@ const logsService = (httpWithAuth) => {
     };
 };
 
-const version = '8.7.0-dev-101-9e49b6c';
+const version = '8.7.0-dev-103-01749fa';
 
 /**
  * Create ExtraHorizon client.
@@ -5703,6 +5717,8 @@ exports.EmptyBodyError = EmptyBodyError;
 exports.ErrorClassMap = ErrorClassMap;
 exports.FieldFormatError = FieldFormatError;
 exports.FileTooLargeError = FileTooLargeError;
+exports.FirebaseConnectionError = FirebaseConnectionError;
+exports.FirebaseInvalidPlatformDataError = FirebaseInvalidPlatformDataError;
 exports.ForbiddenError = ForbiddenError;
 exports.ForgotPasswordRequestLimitError = ForgotPasswordRequestLimitError;
 exports.ForgotPasswordRequestTimeoutError = ForgotPasswordRequestTimeoutError;

package/build/index.mjs

@@ -631,6 +631,13 @@ class RefreshTokenUnknownError extends BadRequestError {
 }
 class RefreshTokenExpiredError extends BadRequestError {
 }
+class FirebaseInvalidPlatformDataError extends BadRequestError {
+    constructor(apiError) {
+        super(apiError);
+        this.notificationId = apiError.response.notificationId;
+        this.errors = apiError.response.errors;
+    }
+}
 // 401 Unauthorized
 class UnauthorizedError extends ApiError {
 }
@@ -716,6 +723,13 @@ class BadGatewayServerError extends ApiError {
 }
 class StripeRequestError extends BadGatewayServerError {
 }
+class FirebaseConnectionError extends BadGatewayServerError {
+    constructor(apiError) {
+        super(apiError);
+        this.notificationId = apiError.response.notificationId;
+        this.errors = apiError.response.errors;
+    }
+}
 // 503 Service Unavailable Error
 class ServiceUnavailableError extends ApiError {
 }
@@ -5468,7 +5482,7 @@ const logsService = (httpWithAuth) => {
     };
 };
 
-const version = '8.7.0-dev-101-9e49b6c';
+const version = '8.7.0-dev-103-01749fa';
 
 /**
  * Create ExtraHorizon client.
@@ -5647,4 +5661,4 @@ const parseStoredCredentials = (fileContent) => exhCredentialsDecoder(fileConten
     .filter(line => line.length === 2)
     .reduce((memo, [key, value]) => ({ ...memo, [key]: value }), {}));
 
-export { AccessTokenExpiredError, AccessTokenUnknownError, ActionType, ActivationRequestLimitError, ActivationRequestTimeoutError, ActivationUnknownError, AlreadyActivatedError, ApiError, ApiFunctionRequestMethod, ApiRequestErrorType, AppStoreTransactionAlreadyLinked, ApplicationNotAuthenticatedError, ApplicationType, ApplicationUnknownError, AuthenticationError, AuthorizationCodeExpiredError, AuthorizationUnknownError, BadGatewayServerError, BadRequestError, BodyFormatError, CallbackNotValidError, Comorbidities, DefaultLocalizationMissingError, DisabledForOidcUsersError, DuplicateRequestError, EmailUnknownError, EmailUsedError, EmptyBodyError, ErrorClassMap, FieldFormatError, FieldType, FileTooLargeError, ForbiddenError, ForgotPasswordRequestLimitError, ForgotPasswordRequestTimeoutError, Gender, GlobalPermissionName, IDFormatError, IllegalArgumentError, IllegalStateError, Impediments, IncorrectPinCodeError, InvalidClientError, InvalidCurrencyForProductPrice, InvalidGrantError, InvalidMfaCodeError, InvalidMfaTokenError, InvalidNonceError, InvalidPKCEError, InvalidPresenceTokenError, InvalidReceiptDataError, InvalidRequestError, InvalidTokenError, JSONSchemaType, LocalizationKeyMissingError, LockedDocumentError, LoginAttemptStatus, LoginFreezeError, LoginTimeoutError, MedicationFrequency, MedicationUnit, MfaReattemptDelayError, MfaRequiredError, MissingPKCEVerifierError, MissingRequiredFieldsError, NewMFARequiredError, NewPasswordHashUnknownError, NewPasswordPinCodeUnknownError, NoConfiguredAppStoreProduct, NoConfiguredPlayStoreProduct, NoMatchingPlayStoreLinkedSubscription, NoPermissionError, NotActivatedError, NotEnoughMfaMethodsError, NotFoundError, OAuth2ClientIdError, OAuth2ClientSecretError, OAuth2ErrorClassMap, OAuth2LoginError, OAuth2MissingClientCredentialsError, OauthKeyError, OauthSignatureError, OauthTokenError, ObjectMaxBytesOptionType, ObjectMinBytesOptionType, OidcIdTokenError, OidcInvalidAuthorizationCodeError, OidcProviderResponseError, OrderSchemaStatus, PasswordError, PaymentIntentCreationSchemaPaymentMethodType, PaymentIntentCreationSchemaSetupPaymentMethodReuse, PinCodesNotEnabledError, PlayStoreTransactionAlreadyLinked, ProfileActivity, ProfileAlreadyExistsError, QueuedMailStatus, RefreshTokenExpiredError, RefreshTokenUnknownError, RemoveFieldError, ResourceAlreadyExistsError, ResourceUnknownError, Results, ServerError, ServiceUnavailableError, StatusInUseError, StripePaymentMethodError, StripeRequestError, SubscriptionEntitlementSource, SubscriptionEntitlementStatus, SubscriptionEntitlementStatusCategory, SubscriptionEventSource, SubscriptionEventType, SupportedLanguageCodes, TaskStatus, TemplateFillingError, TokenNotDeleteableError, TokenPermission, TooManyFailedAttemptsError, UnauthorizedClientError, UnauthorizedError, UnauthorizedTokenError, UnknownReceiptTransactionError, UnsupportedGrantError, UnsupportedGrantTypeError, UnsupportedResponseTypeError, UserNotAuthenticatedError, createClient, createOAuth1Client, createOAuth2Client, createProxyClient, findAllGeneric, findAllIterator, getMockSdkOAuth2 as getMockSdk, getMockSdkOAuth1, getMockSdkOAuth2, getMockSdkProxy, parseGlobalPermissions, parseStoredCredentials, recursiveMap, rqlBuilder, rqlParser };
+export { AccessTokenExpiredError, AccessTokenUnknownError, ActionType, ActivationRequestLimitError, ActivationRequestTimeoutError, ActivationUnknownError, AlreadyActivatedError, ApiError, ApiFunctionRequestMethod, ApiRequestErrorType, AppStoreTransactionAlreadyLinked, ApplicationNotAuthenticatedError, ApplicationType, ApplicationUnknownError, AuthenticationError, AuthorizationCodeExpiredError, AuthorizationUnknownError, BadGatewayServerError, BadRequestError, BodyFormatError, CallbackNotValidError, Comorbidities, DefaultLocalizationMissingError, DisabledForOidcUsersError, DuplicateRequestError, EmailUnknownError, EmailUsedError, EmptyBodyError, ErrorClassMap, FieldFormatError, FieldType, FileTooLargeError, FirebaseConnectionError, FirebaseInvalidPlatformDataError, ForbiddenError, ForgotPasswordRequestLimitError, ForgotPasswordRequestTimeoutError, Gender, GlobalPermissionName, IDFormatError, IllegalArgumentError, IllegalStateError, Impediments, IncorrectPinCodeError, InvalidClientError, InvalidCurrencyForProductPrice, InvalidGrantError, InvalidMfaCodeError, InvalidMfaTokenError, InvalidNonceError, InvalidPKCEError, InvalidPresenceTokenError, InvalidReceiptDataError, InvalidRequestError, InvalidTokenError, JSONSchemaType, LocalizationKeyMissingError, LockedDocumentError, LoginAttemptStatus, LoginFreezeError, LoginTimeoutError, MedicationFrequency, MedicationUnit, MfaReattemptDelayError, MfaRequiredError, MissingPKCEVerifierError, MissingRequiredFieldsError, NewMFARequiredError, NewPasswordHashUnknownError, NewPasswordPinCodeUnknownError, NoConfiguredAppStoreProduct, NoConfiguredPlayStoreProduct, NoMatchingPlayStoreLinkedSubscription, NoPermissionError, NotActivatedError, NotEnoughMfaMethodsError, NotFoundError, OAuth2ClientIdError, OAuth2ClientSecretError, OAuth2ErrorClassMap, OAuth2LoginError, OAuth2MissingClientCredentialsError, OauthKeyError, OauthSignatureError, OauthTokenError, ObjectMaxBytesOptionType, ObjectMinBytesOptionType, OidcIdTokenError, OidcInvalidAuthorizationCodeError, OidcProviderResponseError, OrderSchemaStatus, PasswordError, PaymentIntentCreationSchemaPaymentMethodType, PaymentIntentCreationSchemaSetupPaymentMethodReuse, PinCodesNotEnabledError, PlayStoreTransactionAlreadyLinked, ProfileActivity, ProfileAlreadyExistsError, QueuedMailStatus, RefreshTokenExpiredError, RefreshTokenUnknownError, RemoveFieldError, ResourceAlreadyExistsError, ResourceUnknownError, Results, ServerError, ServiceUnavailableError, StatusInUseError, StripePaymentMethodError, StripeRequestError, SubscriptionEntitlementSource, SubscriptionEntitlementStatus, SubscriptionEntitlementStatusCategory, SubscriptionEventSource, SubscriptionEventType, SupportedLanguageCodes, TaskStatus, TemplateFillingError, TokenNotDeleteableError, TokenPermission, TooManyFailedAttemptsError, UnauthorizedClientError, UnauthorizedError, UnauthorizedTokenError, UnknownReceiptTransactionError, UnsupportedGrantError, UnsupportedGrantTypeError, UnsupportedResponseTypeError, UserNotAuthenticatedError, createClient, createOAuth1Client, createOAuth2Client, createProxyClient, findAllGeneric, findAllIterator, getMockSdkOAuth2 as getMockSdk, getMockSdkOAuth1, getMockSdkOAuth2, getMockSdkProxy, parseGlobalPermissions, parseStoredCredentials, recursiveMap, rqlBuilder, rqlParser };

package/build/types/errors.d.ts

@@ -1,4 +1,4 @@
-import { MfaMethod } from './types';
+import { MfaMethod, NotificationV2Error } from './types';
 declare type Method = 'get' | 'GET' | 'delete' | 'DELETE' | 'head' | 'HEAD' | 'options' | 'OPTIONS' | 'post' | 'POST' | 'put' | 'PUT' | 'patch' | 'PATCH';
 interface RequestConfig {
     url?: string;
@@ -145,6 +145,11 @@ export declare class RefreshTokenUnknownError extends BadRequestError {
 }
 export declare class RefreshTokenExpiredError extends BadRequestError {
 }
+export declare class FirebaseInvalidPlatformDataError extends BadRequestError {
+    notificationId?: string;
+    errors?: NotificationV2Error[];
+    constructor(apiError: ApiError);
+}
 export declare class UnauthorizedError extends ApiError {
 }
 export declare class ApplicationNotAuthenticatedError extends UnauthorizedError {
@@ -215,6 +220,11 @@ export declare class BadGatewayServerError extends ApiError {
 }
 export declare class StripeRequestError extends BadGatewayServerError {
 }
+export declare class FirebaseConnectionError extends BadGatewayServerError {
+    notificationId?: string;
+    errors?: NotificationV2Error[];
+    constructor(apiError: ApiError);
+}
 export declare class ServiceUnavailableError extends ApiError {
 }
 export declare class OidcIdTokenError extends ServiceUnavailableError {

package/build/types/services/notificationsV2/types.d.ts

@@ -1,7 +1,7 @@
 import { ObjectId, OptionsBase, OptionsWithRql, PagedResultWithPager } from '../types';
 export * from './users/types';
 export interface NotificationV2Creation<T extends Record<string, string> = Record<string, string>> {
-    targetUserId: string;
+    targetUserId: ObjectId;
     title: string;
     body: string;
     data?: T;
@@ -21,25 +21,77 @@ export interface NotificationV2Creation<T extends Record<string, string> = Recor
 export interface NotificationV2<T extends Record<string, string> = Record<string, string>> extends NotificationV2Creation<T> {
     id: ObjectId;
     creatorId: ObjectId;
+    /**
+     * Indicates whether we tried to send the notification.
+     * Would be `false` if no devices with FCM tokens were found for the user.
+     * See `errors` for any errors that occurred.
+     */
     sent: boolean;
+    /**
+     * The errors that occurred while sending the notification, if any.
+     */
+    errors?: NotificationV2Error[];
     creationTimestamp: Date;
     updateTimestamp: Date;
 }
+export interface NotificationV2Error {
+    /**
+     * The name of the device for which the error occurred.
+     * If not set, the error occurred for the FCM token defined on the root of the user settings.
+     */
+    deviceName?: string;
+    exhError: {
+        code: string;
+        name: string;
+        message: string;
+    };
+    /**
+     * The error received from FCM, unchanged, if available.
+     * @example
+     * {
+     *   "error": {
+     *     "code": 403,
+     *     "message": "SenderId mismatch",
+     *     "status": "PERMISSION_DENIED",
+     *     "details": [
+     *       {
+     *         "@type": "type.googleapis.com/google.firebase.fcm.v1.FcmError",
+     *         "errorCode": "SENDER_ID_MISMATCH",
+     *       }
+     *     ]
+     *   }
+     * }
+     * */
+    fcmError?: any;
+}
 export interface NotificationV2Service {
     /**
      * # Create a notification
      *
+     * A user's FCM token and their device's with an FCM token will be targeted for the notification
+     *
+     * If an unusable FCM token is detected, the request will succeed, however, the FCM token will be removed from the user's settings.
+     * Any unusable FCM token errors will be included in the `errors` field of the response.
+     *
+     * Multiple errors can occur at once when multiple devices are targeted and errors are thrown in this order:
+     * - `FirebaseConnectionError`
+     * - `FirebaseInvalidPlatformDataError`
+     * Both error types will include a `notificationId` and an `errors` field with details about any errors that occurred.
+     *
      * ## Access via permissions
      * Permission | Scopes | Effect
      * - | - | -
      * `CREATE_NOTIFICATIONS` | `global` | Create notifications for any user
-     * `CREATE_NOTIFICATIONS` | `group` | Create notifications for any patient in group
+     * `CREATE_NOTIFICATIONS` | `group` | Create notifications for any patient in a group
      * none | | Create notifications for yourself
      *
      * # Interface
      * @param requestBody
      * @param options
      * @returns NotificationV2<T>
+     *
+     * @throws {FirebaseInvalidPlatformDataError} if FCM reports invalid values for `android`, `apns`, or `webpush`.
+     * @throws {FirebaseConnectionError} if FCM is unreachable or returns an unknown error.
      */
     create<T extends Record<string, string>>(requestBody: NotificationV2Creation<T>, options?: OptionsBase): Promise<NotificationV2<T>>;
     /**

package/build/types/services/notificationsV2/users/types.d.ts

@@ -34,6 +34,7 @@ export interface NotificationV2UserService {
      */
     getById(userId: ObjectId, options?: OptionsBase): Promise<NotificationV2User>;
     /**
+     * @deprecated We recommend using `devices` instead, managed by the `addOrUpdateDevice()` and `removeDevice()` methods.
      * # Update a user its notification settings
      *
      * Updates (or creates if non exists) a user its settings for the specified user id.

package/build/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "8.7.0-dev-101-9e49b6c";
+export declare const version = "8.7.0-dev-103-01749fa";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@extrahorizon/javascript-sdk",
-  "version": "8.7.0-dev-101-9e49b6c",
+  "version": "8.7.0-dev-103-01749fa",
   "description": "This package serves as a JavaScript wrapper around all Extra Horizon cloud services.",
   "main": "build/index.cjs.js",
   "types": "build/types/index.d.ts",