onesignal-web-sdk/src/models/AppConfig.ts

Web push notifications from OneSignal.

export interface AppConfig {
  /**
   * The OneSignal dashboard app ID. Although this value is provided, it isn't
   * used since it will always be identical to the provided app ID.
   */
  appId: string;

  /**
   * The subdomain chosen on the dashboard for non-HTTPS apps.
   */
  subdomain?: string;

  /**
   * The allowed origin this web push config is allowed to run on.
   */
  origin: string;

  /**
   * Describes whether the subdomain HTTP users subscribe to should belong to
   * the legacy domain onesignal.com, or the newer domain os.tc.
   */
  httpUseOneSignalCom?: boolean;
  cookieSyncEnabled?: boolean;
  restrictedOriginEnabled?: boolean | null;
  metrics: {
    enable: boolean;
    mixpanelReportingToken: string | null;
  };
  enableOnSession?: boolean;

  safariWebId?: string;

  /**
   * Chrome and Chrome-like browsers including Opera and Yandex use VAPID for
   * authentication, and so each app uses a uniquely generated key.
   */
  vapidPublicKey?: string;

  /**
   * Firefox uses VAPID for application identification instead of
   * authentication, and so all apps share an identification key.
   */
  onesignalVapidPublicKey?: string;

  /**
   * Describes whether this app's email records require authentication.
   */
  emailAuthRequired?: boolean;
  userConfig: AppUserConfig;
  // TODO: Cleanup: pageUrl is also on AppUserConfig
  pageUrl?: string;
}

export enum ConfigIntegrationKind {
  TypicalSite = 'typical',
  WordPress = 'wordpress',
  Shopify = 'shopify',
  Blogger = 'blogger',
  Magento = 'magento',
  Drupal = 'drupal',
  SquareSpace = 'squarespace',
  Joomla = 'joomla',
  Weebly = 'weebly',
  Wix = "wix",
  Custom = 'custom',
}

export enum NotificationClickMatchBehavior {
  Exact = 'exact',
  Origin = 'origin'
}

export enum NotificationClickActionBehavior {
  Navigate = 'navigate',
  Focus = 'focus'
}

export interface AppUserConfig {
  [key: string]: any;
  appId?: string;
  autoRegister?: boolean;
  autoResubscribe?: boolean;
  path?: string;
  serviceWorkerPath?: string;
  serviceWorkerUpdaterPath?: string;
  serviceWorkerParam?: any;
  subdomainName?: string;
  promptOptions?: AppUserConfigPromptOptions;
  welcomeNotification?: AppUserConfigWelcomeNotification;
  notifyButton?: Partial<AppUserConfigNotifyButton>;
  persistNotification?: boolean;
  webhooks?: AppUserConfigWebhooks;
  notificationClickHandlerMatch?: NotificationClickMatchBehavior;
  notificationClickHandlerAction?: NotificationClickActionBehavior;
  allowLocalhostAsSecureOrigin?: boolean;
  requiresUserPrivacyConsent?: boolean;
  pageUrl?: string;
}

interface BasePromptOptions {
  enabled: boolean;
  autoPrompt?: boolean;
}

export interface SlidedownPermissionMessageOptions extends BasePromptOptions {
  actionMessage: string;
  acceptButtonText: string;
  cancelButtonText: string;
}

export interface FullscreenPermissionMessageOptions extends BasePromptOptions {
  autoAcceptTitle?: string;
  actionMessage: string;
  acceptButton: string;
  cancelButton: string;
  title: string;
  message: string;
  caption: string;
}

type CustomLinkStyle = "button" | "link";
type CustomLinkSize = "large" | "medium" | "small";

export interface AppUserConfigCustomLinkOptions extends BasePromptOptions {
  style?: CustomLinkStyle;
  size?: CustomLinkSize;
  unsubscribeEnabled?: boolean;
  text?: {
    explanation?: string;
    subscribe?: string;
    unsubscribe?: string;
  }
  color?: {
    button?: string;
    text?: string;
  }
}

export interface AppUserConfigPromptOptions {
  autoPrompt?: boolean;
  subscribeText?: string;
  showGraphic?: boolean;
  timeout?: number;
  autoAcceptTitle?: string;
  actionMessage?: string;
  exampleNotificationTitleDesktop?: string;
  exampleNotificationMessageDesktop?: string;
  exampleNotificationTitleMobile?: string;
  exampleNotificationMessageMobile?: string;
  exampleNotificationCaption?: string;
  acceptButtonText?: string;
  cancelButtonText?: string;
  showCredit?: string;
  native?: BasePromptOptions;
  slidedown?: SlidedownPermissionMessageOptions;
  fullscreen?: FullscreenPermissionMessageOptions;
  customlink?: AppUserConfigCustomLinkOptions;
}

export interface AppUserConfigWelcomeNotification {
  disable: boolean;
  title: string | undefined;
  message: string | undefined;
  url: string | undefined;
}

export type BellSize = 'small' | 'medium' | 'large';
export type BellPosition = 'bottom-left' | 'bottom-right';

export interface BellText {
  'tip.state.unsubscribed': string;
  'tip.state.subscribed': string;
  'tip.state.blocked': string;
  'message.prenotify': string;
  'message.action.subscribed': string;
  'message.action.subscribing': string;
  'message.action.resubscribed': string;
  'message.action.unsubscribed': string;
  'dialog.main.title': string;
  'dialog.main.button.subscribe': string;
  'dialog.main.button.unsubscribe': string;
  'dialog.blocked.title': string;
  'dialog.blocked.message': string;
}

export interface AppUserConfigNotifyButton {
  options?: AppUserConfigNotifyButton;
  enable: boolean;
  displayPredicate?: Function | null | undefined;
  size?: BellSize;
  position?: BellPosition;
  offset?: { bottom: string; left: string; right: string };
  prenotify?: boolean;
  showCredit?: boolean;
  colors?: {
    'circle.background': string;
    'circle.foreground': string;
    'badge.background': string;
    'badge.foreground': string;
    'badge.bordercolor': string;
    'pulse.color': string;
    'dialog.button.background.hovering': string;
    'dialog.button.background.active': string;
    'dialog.button.background': string;
    'dialog.button.foreground': string;
  };
  text: BellText;
  theme?: string;
  showLauncherAfter?: number;
  showBadgeAfter?: number;
}

export interface AppUserConfigWebhooks {
  cors: boolean | undefined;
  'notification.displayed': string | undefined;
  'notification.clicked': string | undefined;
  'notification.dismissed': string | undefined;
}

export interface ServerAppConfigPrompt {
  native: {
    enabled: boolean;
    autoPrompt: boolean;
  },
  bell: {
    enabled: boolean;
    size: 'small' | 'medium' | 'large';
    color: {
      main: string;
      accent: string;
    };
    dialog: {
      main: {
        title: string;
        subscribeButton: string;
        unsubscribeButton: string;
      };
      blocked: {
        title: string;
        message: string;
      };
    };
    offset: {
      left: number;
      right: number;
      bottom: number;
    };
    message: {
      subscribing: string;
      unsubscribing: string;
    };
    tooltip: {
      blocked: string;
      subscribed: string;
      unsubscribed: string;
    };
    location: 'bottom-left' | 'bottom-right';
    hideWhenSubscribed: boolean;
    customizeTextEnabled: boolean;
  };
  slidedown: {
    enabled: boolean;
    autoPrompt: boolean;
    acceptButton: string;
    cancelButton: string;
    actionMessage: string;
    customizeTextEnabled: boolean;
  };
  fullscreen: {
    title: string;
    caption: string;
    enabled: boolean;
    message: string;
    acceptButton: string;
    cancelButton: string;
    actionMessage: string;
    autoAcceptTitle: string;
    customizeTextEnabled: boolean;
  };
  customlink: {
    enabled: boolean;
    style: CustomLinkStyle;
    size: CustomLinkSize;
    unsubscribeEnabled: boolean;
    text: {
      explanation: string;
      subscribe: string;
      unsubscribe: string;
    }
    color: {
      button: string;
      text: string;
    }
  }
}

export interface ServerAppConfig {
  success: boolean;
  app_id: string;
  features: {
    cookie_sync: {
      enable: boolean;
    };
    metrics: {
      enable: boolean;
      mixpanel_reporting_token: string;
    };
    restrict_origin: {
      enable: boolean;
    };
    email?: {
      require_auth: boolean;
    };
    enable_on_session?: boolean;
  };
  config: {
    /**
     * The allowed origin this web push config is allowed to run on.
     */
    origin: string;
    staticPrompts: ServerAppConfigPrompt;
    autoResubscribe: boolean;
    siteInfo: {
      name: string;
      origin: string;
      proxyOrigin: string | undefined;
      defaultIconUrl: string | null;
      proxyOriginEnabled: boolean;
    };
    webhooks: {
      enable: boolean;
      corsEnable?: boolean;
      notificationClickedHook?: string;
      notificationDismissedHook?: string;
      notificationDisplayedHook?: string;
    };
    integration: {
      kind: ConfigIntegrationKind;
    };
    serviceWorker: {
      path?: string;
      workerName?: string;
      registrationScope?: string;
      updaterWorkerName?: string;
      customizationEnabled: boolean;
    };
    setupBehavior?: {
      allowLocalhostAsSecureOrigin: false;
    };
    welcomeNotification: {
      url: string | undefined;
      title: string | undefined;
      enable: boolean;
      message: string | undefined;
      urlEnabled: boolean| undefined;
    };
    notificationBehavior?: {
      click: {
        match: NotificationClickMatchBehavior;
        action: NotificationClickActionBehavior;
      };
      display: {
        persist: boolean;
      };
    };
    vapid_public_key: string;
    onesignal_vapid_public_key: string;
    http_use_onesignal_com?: boolean;
    safari_web_id?: string;
    subdomain: string| undefined;
  };

  generated_at: number;
}