react-native-qpush 0.0.0-stage → 1.0.0

package/src/types.ts

@@ -0,0 +1,174 @@
+/**
+ * Public types of react-native-qpush.
+ *
+ * Names and shapes intentionally mirror OneSignal's React Native SDK v5 so
+ * migrating code is mostly a search & replace of `OneSignal` -> `QPush`.
+ */
+
+/** Log verbosity, same numeric values as OneSignal's `LogLevel`. */
+export enum LogLevel {
+  None = 0,
+  Fatal = 1,
+  Error = 2,
+  Warn = 3,
+  Info = 4,
+  Debug = 5,
+  Verbose = 6,
+}
+
+/** Native permission state (mirrors OneSignal's `OSNotificationPermission`). */
+export enum NotificationPermission {
+  NotDetermined = 0,
+  Denied = 1,
+  Authorized = 2,
+  Provisional = 3,
+  Ephemeral = 4,
+}
+
+/** Permission state as reported by the native layer. */
+export type PermissionStatus = 'notDetermined' | 'denied' | 'granted' | 'provisional' | 'ephemeral';
+
+/** Base URL of the qpush cloud API, used when no serverUrl is given. */
+export const QPUSH_CLOUD_API_URL = 'https://qpush.dev/api/v1';
+
+export interface QPushInitOptions {
+  /**
+   * API base URL. Defaults to the qpush cloud (`https://qpush.dev/api/v1`);
+   * set it only if you self-host. `/api/v1` is appended when missing.
+   */
+  serverUrl?: string;
+  /** Optional log level applied before anything else runs. */
+  logLevel?: LogLevel;
+}
+
+/** An action button attached to a notification. */
+export interface ActionButton {
+  id: string;
+  text: string;
+  /** Android drawable resource name. */
+  icon?: string;
+  url?: string;
+}
+
+/** Normalized notification content (platform independent). */
+export interface QPushNotificationData {
+  /** QPush notification id (uuid). */
+  notificationId: string;
+  title?: string;
+  subtitle?: string;
+  body?: string;
+  /** URL / deep link opened when the notification is tapped. */
+  launchURL?: string;
+  /** Custom JSON sent with the notification (`data`). */
+  additionalData?: Record<string, unknown>;
+  /** Big picture (Android) / attachment (iOS) image URL. */
+  bigPicture?: string;
+  largeIcon?: string;
+  smallIcon?: string;
+  /** ARGB hex, e.g. `FF0070F3` (Android). */
+  accentColor?: string;
+  sound?: string;
+  /** Android notification channel id. */
+  channelId?: string;
+  /** 10 = high, 5 = normal (Android). */
+  priority?: number;
+  /** Android group key / iOS thread-id. */
+  groupKey?: string;
+  collapseId?: string;
+  /** 1 public, 0 private, -1 secret (Android). */
+  visibility?: number;
+  /** iOS badge value from `aps.badge`. */
+  badge?: number;
+  /** iOS category identifier. */
+  category?: string;
+  /** iOS interruption level (`passive`, `active`, `time-sensitive`, `critical`). */
+  interruptionLevel?: string;
+  /** iOS relevance score (0..1). */
+  relevanceScore?: number;
+  /** `true` for background / silent pushes (iOS `content-available`). */
+  contentAvailable?: boolean;
+  actionButtons?: ActionButton[];
+  /** The untouched payload as received from the OS. */
+  rawPayload: Record<string, unknown>;
+}
+
+/** Result of a notification click. */
+export interface NotificationClickResult {
+  /** Id of the tapped action button, when a button was tapped. */
+  actionId?: string;
+  /** URL that was (or would have been) opened. Button URL wins over the notification URL. */
+  url?: string;
+}
+
+export interface PushSubscriptionState {
+  id: string | null;
+  token: string | null;
+  optedIn: boolean;
+}
+
+export interface PushSubscriptionChangedState {
+  previous: PushSubscriptionState;
+  current: PushSubscriptionState;
+}
+
+export interface UserState {
+  qpushId: string | null;
+  externalId: string | null;
+}
+
+export interface UserChangedState {
+  current: UserState;
+}
+
+/** FCM parameters returned by `GET /apps/{app_id}/android_params.js`. */
+export interface FcmParams {
+  project_id: string;
+  app_id: string;
+  api_key: string;
+  sender_id: string;
+}
+
+export interface AndroidParams {
+  app_id: string;
+  fcm: FcmParams | null;
+  use_identity_verification?: boolean;
+}
+
+export interface IosParams {
+  app_id: string;
+  apns_configured?: boolean;
+  environment?: string;
+  use_identity_verification?: boolean;
+}
+
+/** Subscription object as defined by the QPush protocol. */
+export interface SubscriptionPayload {
+  id?: string;
+  type: 'AndroidPush' | 'iOSPush';
+  token?: string | null;
+  enabled: boolean;
+  notification_types: number;
+  session_count?: number;
+  device_model?: string;
+  device_os?: string;
+  sdk: string;
+  app_version?: string;
+  test_type?: number | null;
+  carrier?: string;
+  rooted?: boolean;
+  net_type?: number;
+}
+
+/** User object as defined by the QPush protocol. */
+export interface UserPayload {
+  identity: Record<string, string>;
+  properties?: {
+    language?: string;
+    timezone_id?: string;
+    country?: string;
+    tags?: Record<string, string>;
+    first_active?: number;
+    last_active?: number;
+  };
+  subscriptions?: SubscriptionPayload[];
+}