@capawesome/capacitor-intercom 0.0.1

package/dist/esm/definitions.d.ts

@@ -0,0 +1,549 @@
+import type { PluginListenerHandle } from '@capacitor/core';
+export interface IntercomPlugin {
+    /**
+     * Get the number of unread conversations for the current user.
+     *
+     * @since 0.1.0
+     */
+    getUnreadConversationCount(): Promise<GetUnreadConversationCountResult>;
+    /**
+     * Handle an incoming push notification that belongs to Intercom.
+     *
+     * Use `isIntercomPushNotification(...)` to check whether the notification
+     * belongs to Intercom before calling this method.
+     *
+     * Only available on Android and iOS.
+     *
+     * @since 0.1.0
+     */
+    handlePushNotification(options: HandlePushNotificationOptions): Promise<void>;
+    /**
+     * Hide any currently presented Intercom UI (e.g. the Messenger).
+     *
+     * @since 0.1.0
+     */
+    hide(): Promise<void>;
+    /**
+     * Initialize the Intercom SDK with your app ID and API key.
+     *
+     * This method must be called before any other method.
+     *
+     * @since 0.1.0
+     */
+    initialize(options: InitializeOptions): Promise<void>;
+    /**
+     * Check whether an incoming push notification belongs to Intercom.
+     *
+     * Only available on Android and iOS.
+     *
+     * @since 0.1.0
+     */
+    isIntercomPushNotification(options: IsIntercomPushNotificationOptions): Promise<IsIntercomPushNotificationResult>;
+    /**
+     * Log an event with an optional set of metadata.
+     *
+     * @since 0.1.0
+     */
+    logEvent(options: LogEventOptions): Promise<void>;
+    /**
+     * Log in an unidentified (anonymous) user.
+     *
+     * @since 0.1.0
+     */
+    loginUnidentifiedUser(): Promise<void>;
+    /**
+     * Log in an identified user with a user ID and/or an email address.
+     *
+     * At least one of `userId` or `email` must be provided.
+     *
+     * @since 0.1.0
+     */
+    loginUser(options: LoginUserOptions): Promise<void>;
+    /**
+     * Log out the current user and clear the local Intercom data.
+     *
+     * @since 0.1.0
+     */
+    logout(): Promise<void>;
+    /**
+     * Present the Intercom Messenger with the given space.
+     *
+     * @since 0.1.0
+     */
+    present(options?: PresentOptions): Promise<void>;
+    /**
+     * Present a specific piece of Intercom content (e.g. an article, carousel,
+     * survey, or conversation).
+     *
+     * @since 0.1.0
+     */
+    presentContent(options: PresentContentOptions): Promise<void>;
+    /**
+     * Present the Intercom message composer, optionally pre-filled with an
+     * initial message.
+     *
+     * @since 0.1.0
+     */
+    presentMessageComposer(options?: PresentMessageComposerOptions): Promise<void>;
+    /**
+     * Forward a push notification token to Intercom.
+     *
+     * On Android, pass the Firebase Cloud Messaging (FCM) token. On iOS, pass
+     * the hexadecimal APNs device token.
+     *
+     * @since 0.1.0
+     */
+    sendPushTokenToIntercom(options: SendPushTokenToIntercomOptions): Promise<void>;
+    /**
+     * Set the bottom padding of the Intercom UI (in-app messages and launcher).
+     *
+     * Only available on Android and iOS.
+     *
+     * @since 0.1.0
+     */
+    setBottomPadding(options: SetBottomPaddingOptions): Promise<void>;
+    /**
+     * Set whether in-app messages are visible.
+     *
+     * @since 0.1.0
+     */
+    setInAppMessagesVisible(options: SetInAppMessagesVisibleOptions): Promise<void>;
+    /**
+     * Set whether the Intercom launcher is visible.
+     *
+     * @since 0.1.0
+     */
+    setLauncherVisible(options: SetLauncherVisibleOptions): Promise<void>;
+    /**
+     * Set the user hash (HMAC) for identity verification.
+     *
+     * This must be called before logging in the user.
+     *
+     * @since 0.1.0
+     */
+    setUserHash(options: SetUserHashOptions): Promise<void>;
+    /**
+     * Set the JSON Web Token (JWT) for identity verification.
+     *
+     * This must be called before logging in the user.
+     *
+     * @since 0.1.0
+     */
+    setUserJwt(options: SetUserJwtOptions): Promise<void>;
+    /**
+     * Update the attributes of the current user.
+     *
+     * @since 0.1.0
+     */
+    updateUser(options: UpdateUserOptions): Promise<void>;
+    /**
+     * Called when the Intercom Messenger is hidden.
+     *
+     * Only available on iOS and Web.
+     *
+     * @since 0.1.0
+     */
+    addListener(eventName: 'messengerHidden', listenerFunc: () => void): Promise<PluginListenerHandle>;
+    /**
+     * Called when the Intercom Messenger is shown.
+     *
+     * Only available on iOS and Web.
+     *
+     * @since 0.1.0
+     */
+    addListener(eventName: 'messengerShown', listenerFunc: () => void): Promise<PluginListenerHandle>;
+    /**
+     * Called when the number of unread conversations changes.
+     *
+     * @since 0.1.0
+     */
+    addListener(eventName: 'unreadConversationCountChange', listenerFunc: (event: UnreadConversationCountChangeEvent) => void): Promise<PluginListenerHandle>;
+    /**
+     * Remove all listeners for this plugin.
+     *
+     * @since 0.1.0
+     */
+    removeAllListeners(): Promise<void>;
+}
+/**
+ * @since 0.1.0
+ */
+export interface GetUnreadConversationCountResult {
+    /**
+     * The number of unread conversations.
+     *
+     * @since 0.1.0
+     */
+    count: number;
+}
+/**
+ * @since 0.1.0
+ */
+export interface HandlePushNotificationOptions {
+    /**
+     * The data of the push notification.
+     *
+     * @since 0.1.0
+     */
+    data: Record<string, unknown>;
+}
+/**
+ * @since 0.1.0
+ */
+export interface InitializeOptions {
+    /**
+     * The Android API key of your Intercom app.
+     *
+     * Required to use the plugin on Android.
+     *
+     * @since 0.1.0
+     */
+    androidApiKey?: string;
+    /**
+     * The app ID of your Intercom app.
+     *
+     * @since 0.1.0
+     */
+    appId: string;
+    /**
+     * The iOS API key of your Intercom app.
+     *
+     * Required to use the plugin on iOS.
+     *
+     * @since 0.1.0
+     */
+    iosApiKey?: string;
+}
+/**
+ * @since 0.1.0
+ */
+export interface IsIntercomPushNotificationOptions {
+    /**
+     * The data of the push notification.
+     *
+     * @since 0.1.0
+     */
+    data: Record<string, unknown>;
+}
+/**
+ * @since 0.1.0
+ */
+export interface IsIntercomPushNotificationResult {
+    /**
+     * Whether the push notification belongs to Intercom.
+     *
+     * @since 0.1.0
+     */
+    intercom: boolean;
+}
+/**
+ * @since 0.1.0
+ */
+export interface LogEventOptions {
+    /**
+     * The metadata of the event.
+     *
+     * @since 0.1.0
+     */
+    data?: Record<string, string | number | boolean>;
+    /**
+     * The name of the event.
+     *
+     * @since 0.1.0
+     */
+    name: string;
+}
+/**
+ * @since 0.1.0
+ */
+export interface LoginUserOptions {
+    /**
+     * The email address of the user.
+     *
+     * @since 0.1.0
+     */
+    email?: string;
+    /**
+     * The unique identifier of the user.
+     *
+     * @since 0.1.0
+     */
+    userId?: string;
+}
+/**
+ * @since 0.1.0
+ */
+export interface PresentContentOptions {
+    /**
+     * The identifier of the content to present.
+     *
+     * Required for the `article`, `carousel`, `survey`, and `conversation`
+     * content types.
+     *
+     * @since 0.1.0
+     */
+    id?: string;
+    /**
+     * The identifiers of the content to present.
+     *
+     * Required for the `help-center-collections` content type.
+     *
+     * @since 0.1.0
+     */
+    ids?: string[];
+    /**
+     * The type of content to present.
+     *
+     * @since 0.1.0
+     */
+    type: IntercomContentType;
+}
+/**
+ * @since 0.1.0
+ */
+export interface PresentMessageComposerOptions {
+    /**
+     * The message to pre-fill the composer with.
+     *
+     * @since 0.1.0
+     */
+    initialMessage?: string;
+}
+/**
+ * @since 0.1.0
+ */
+export interface PresentOptions {
+    /**
+     * The space to present.
+     *
+     * @default 'home'
+     * @since 0.1.0
+     */
+    space?: IntercomSpace;
+}
+/**
+ * @since 0.1.0
+ */
+export interface SendPushTokenToIntercomOptions {
+    /**
+     * The push notification token.
+     *
+     * On Android, this is the Firebase Cloud Messaging (FCM) token. On iOS,
+     * this is the hexadecimal APNs device token.
+     *
+     * @since 0.1.0
+     */
+    token: string;
+}
+/**
+ * @since 0.1.0
+ */
+export interface SetBottomPaddingOptions {
+    /**
+     * The bottom padding to set.
+     *
+     * @since 0.1.0
+     */
+    padding: number;
+}
+/**
+ * @since 0.1.0
+ */
+export interface SetInAppMessagesVisibleOptions {
+    /**
+     * Whether in-app messages should be visible.
+     *
+     * @since 0.1.0
+     */
+    visible: boolean;
+}
+/**
+ * @since 0.1.0
+ */
+export interface SetLauncherVisibleOptions {
+    /**
+     * Whether the launcher should be visible.
+     *
+     * @since 0.1.0
+     */
+    visible: boolean;
+}
+/**
+ * @since 0.1.0
+ */
+export interface SetUserHashOptions {
+    /**
+     * The user hash (HMAC) for identity verification.
+     *
+     * The hash must be generated on your backend using your Intercom secret
+     * key. Never expose the secret key in your app.
+     *
+     * @since 0.1.0
+     */
+    userHash: string;
+}
+/**
+ * @since 0.1.0
+ */
+export interface SetUserJwtOptions {
+    /**
+     * The JSON Web Token (JWT) for identity verification.
+     *
+     * The token must be generated on your backend using your Intercom secret
+     * key. Never expose the secret key in your app.
+     *
+     * @since 0.1.0
+     */
+    jwt: string;
+}
+/**
+ * @since 0.1.0
+ */
+export interface UnreadConversationCountChangeEvent {
+    /**
+     * The number of unread conversations.
+     *
+     * @since 0.1.0
+     */
+    count: number;
+}
+/**
+ * @since 0.1.0
+ */
+export interface UpdateUserCompany {
+    /**
+     * The date the company was created as a Unix timestamp in seconds.
+     *
+     * @since 0.1.0
+     * @example 1704067200
+     */
+    createdAt?: number;
+    /**
+     * The custom attributes of the company.
+     *
+     * @since 0.1.0
+     */
+    customAttributes?: Record<string, string | number | boolean>;
+    /**
+     * The unique identifier of the company.
+     *
+     * @since 0.1.0
+     */
+    id: string;
+    /**
+     * The monthly spend of the company.
+     *
+     * @since 0.1.0
+     */
+    monthlySpend?: number;
+    /**
+     * The name of the company.
+     *
+     * @since 0.1.0
+     */
+    name?: string;
+    /**
+     * The plan of the company.
+     *
+     * @since 0.1.0
+     */
+    plan?: string;
+}
+/**
+ * @since 0.1.0
+ */
+export interface UpdateUserOptions {
+    /**
+     * The companies the user belongs to.
+     *
+     * @since 0.1.0
+     */
+    companies?: UpdateUserCompany[];
+    /**
+     * The custom attributes of the user.
+     *
+     * @since 0.1.0
+     */
+    customAttributes?: Record<string, string | number | boolean>;
+    /**
+     * The email address of the user.
+     *
+     * @since 0.1.0
+     */
+    email?: string;
+    /**
+     * The preferred language of the user as an ISO 639-1 code.
+     *
+     * @since 0.1.0
+     * @example 'en'
+     */
+    languageOverride?: string;
+    /**
+     * The name of the user.
+     *
+     * @since 0.1.0
+     */
+    name?: string;
+    /**
+     * The phone number of the user.
+     *
+     * @since 0.1.0
+     */
+    phone?: string;
+    /**
+     * The date the user signed up as a Unix timestamp in seconds.
+     *
+     * @since 0.1.0
+     * @example 1704067200
+     */
+    signedUpAt?: number;
+    /**
+     * Whether the user is unsubscribed from emails.
+     *
+     * @since 0.1.0
+     */
+    unsubscribedFromEmails?: boolean;
+    /**
+     * The unique identifier of the user.
+     *
+     * @since 0.1.0
+     */
+    userId?: string;
+}
+/**
+ * A type of Intercom content that can be presented.
+ *
+ * @since 0.1.0
+ */
+export type IntercomContentType = 'article' | 'carousel' | 'conversation' | 'help-center-collections' | 'survey';
+/**
+ * A space of the Intercom Messenger.
+ *
+ * @since 0.1.0
+ */
+export type IntercomSpace = 'home' | 'messages' | 'help-center' | 'tickets';
+/**
+ * @since 0.1.0
+ */
+export declare enum ErrorCode {
+    /**
+     * The login of the user failed.
+     *
+     * @since 0.1.0
+     */
+    LoginFailed = "LOGIN_FAILED",
+    /**
+     * The plugin has not been initialized yet.
+     *
+     * Call `initialize(...)` before calling any other method.
+     *
+     * @since 0.1.0
+     */
+    NotInitialized = "NOT_INITIALIZED",
+    /**
+     * The update of the user failed.
+     *
+     * @since 0.1.0
+     */
+    UpdateFailed = "UPDATE_FAILED"
+}

package/dist/esm/definitions.js

@@ -0,0 +1,27 @@
+/**
+ * @since 0.1.0
+ */
+export var ErrorCode;
+(function (ErrorCode) {
+    /**
+     * The login of the user failed.
+     *
+     * @since 0.1.0
+     */
+    ErrorCode["LoginFailed"] = "LOGIN_FAILED";
+    /**
+     * The plugin has not been initialized yet.
+     *
+     * Call `initialize(...)` before calling any other method.
+     *
+     * @since 0.1.0
+     */
+    ErrorCode["NotInitialized"] = "NOT_INITIALIZED";
+    /**
+     * The update of the user failed.
+     *
+     * @since 0.1.0
+     */
+    ErrorCode["UpdateFailed"] = "UPDATE_FAILED";
+})(ErrorCode || (ErrorCode = {}));
+//# sourceMappingURL=definitions.js.map

package/dist/esm/definitions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAyjBA;;GAEG;AACH,MAAM,CAAN,IAAY,SAqBX;AArBD,WAAY,SAAS;IACnB;;;;OAIG;IACH,yCAA4B,CAAA;IAC5B;;;;;;OAMG;IACH,+CAAkC,CAAA;IAClC;;;;OAIG;IACH,2CAA8B,CAAA;AAChC,CAAC,EArBW,SAAS,KAAT,SAAS,QAqBpB","sourcesContent":["import type { PluginListenerHandle } from '@capacitor/core';\n\nexport interface IntercomPlugin {\n  /**\n   * Get the number of unread conversations for the current user.\n   *\n   * @since 0.1.0\n   */\n  getUnreadConversationCount(): Promise<GetUnreadConversationCountResult>;\n  /**\n   * Handle an incoming push notification that belongs to Intercom.\n   *\n   * Use `isIntercomPushNotification(...)` to check whether the notification\n   * belongs to Intercom before calling this method.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 0.1.0\n   */\n  handlePushNotification(options: HandlePushNotificationOptions): Promise<void>;\n  /**\n   * Hide any currently presented Intercom UI (e.g. the Messenger).\n   *\n   * @since 0.1.0\n   */\n  hide(): Promise<void>;\n  /**\n   * Initialize the Intercom SDK with your app ID and API key.\n   *\n   * This method must be called before any other method.\n   *\n   * @since 0.1.0\n   */\n  initialize(options: InitializeOptions): Promise<void>;\n  /**\n   * Check whether an incoming push notification belongs to Intercom.\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 0.1.0\n   */\n  isIntercomPushNotification(\n    options: IsIntercomPushNotificationOptions,\n  ): Promise<IsIntercomPushNotificationResult>;\n  /**\n   * Log an event with an optional set of metadata.\n   *\n   * @since 0.1.0\n   */\n  logEvent(options: LogEventOptions): Promise<void>;\n  /**\n   * Log in an unidentified (anonymous) user.\n   *\n   * @since 0.1.0\n   */\n  loginUnidentifiedUser(): Promise<void>;\n  /**\n   * Log in an identified user with a user ID and/or an email address.\n   *\n   * At least one of `userId` or `email` must be provided.\n   *\n   * @since 0.1.0\n   */\n  loginUser(options: LoginUserOptions): Promise<void>;\n  /**\n   * Log out the current user and clear the local Intercom data.\n   *\n   * @since 0.1.0\n   */\n  logout(): Promise<void>;\n  /**\n   * Present the Intercom Messenger with the given space.\n   *\n   * @since 0.1.0\n   */\n  present(options?: PresentOptions): Promise<void>;\n  /**\n   * Present a specific piece of Intercom content (e.g. an article, carousel,\n   * survey, or conversation).\n   *\n   * @since 0.1.0\n   */\n  presentContent(options: PresentContentOptions): Promise<void>;\n  /**\n   * Present the Intercom message composer, optionally pre-filled with an\n   * initial message.\n   *\n   * @since 0.1.0\n   */\n  presentMessageComposer(\n    options?: PresentMessageComposerOptions,\n  ): Promise<void>;\n  /**\n   * Forward a push notification token to Intercom.\n   *\n   * On Android, pass the Firebase Cloud Messaging (FCM) token. On iOS, pass\n   * the hexadecimal APNs device token.\n   *\n   * @since 0.1.0\n   */\n  sendPushTokenToIntercom(\n    options: SendPushTokenToIntercomOptions,\n  ): Promise<void>;\n  /**\n   * Set the bottom padding of the Intercom UI (in-app messages and launcher).\n   *\n   * Only available on Android and iOS.\n   *\n   * @since 0.1.0\n   */\n  setBottomPadding(options: SetBottomPaddingOptions): Promise<void>;\n  /**\n   * Set whether in-app messages are visible.\n   *\n   * @since 0.1.0\n   */\n  setInAppMessagesVisible(\n    options: SetInAppMessagesVisibleOptions,\n  ): Promise<void>;\n  /**\n   * Set whether the Intercom launcher is visible.\n   *\n   * @since 0.1.0\n   */\n  setLauncherVisible(options: SetLauncherVisibleOptions): Promise<void>;\n  /**\n   * Set the user hash (HMAC) for identity verification.\n   *\n   * This must be called before logging in the user.\n   *\n   * @since 0.1.0\n   */\n  setUserHash(options: SetUserHashOptions): Promise<void>;\n  /**\n   * Set the JSON Web Token (JWT) for identity verification.\n   *\n   * This must be called before logging in the user.\n   *\n   * @since 0.1.0\n   */\n  setUserJwt(options: SetUserJwtOptions): Promise<void>;\n  /**\n   * Update the attributes of the current user.\n   *\n   * @since 0.1.0\n   */\n  updateUser(options: UpdateUserOptions): Promise<void>;\n  /**\n   * Called when the Intercom Messenger is hidden.\n   *\n   * Only available on iOS and Web.\n   *\n   * @since 0.1.0\n   */\n  addListener(\n    eventName: 'messengerHidden',\n    listenerFunc: () => void,\n  ): Promise<PluginListenerHandle>;\n  /**\n   * Called when the Intercom Messenger is shown.\n   *\n   * Only available on iOS and Web.\n   *\n   * @since 0.1.0\n   */\n  addListener(\n    eventName: 'messengerShown',\n    listenerFunc: () => void,\n  ): Promise<PluginListenerHandle>;\n  /**\n   * Called when the number of unread conversations changes.\n   *\n   * @since 0.1.0\n   */\n  addListener(\n    eventName: 'unreadConversationCountChange',\n    listenerFunc: (event: UnreadConversationCountChangeEvent) => void,\n  ): Promise<PluginListenerHandle>;\n  /**\n   * Remove all listeners for this plugin.\n   *\n   * @since 0.1.0\n   */\n  removeAllListeners(): Promise<void>;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface GetUnreadConversationCountResult {\n  /**\n   * The number of unread conversations.\n   *\n   * @since 0.1.0\n   */\n  count: number;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface HandlePushNotificationOptions {\n  /**\n   * The data of the push notification.\n   *\n   * @since 0.1.0\n   */\n  data: Record<string, unknown>;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface InitializeOptions {\n  /**\n   * The Android API key of your Intercom app.\n   *\n   * Required to use the plugin on Android.\n   *\n   * @since 0.1.0\n   */\n  androidApiKey?: string;\n  /**\n   * The app ID of your Intercom app.\n   *\n   * @since 0.1.0\n   */\n  appId: string;\n  /**\n   * The iOS API key of your Intercom app.\n   *\n   * Required to use the plugin on iOS.\n   *\n   * @since 0.1.0\n   */\n  iosApiKey?: string;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface IsIntercomPushNotificationOptions {\n  /**\n   * The data of the push notification.\n   *\n   * @since 0.1.0\n   */\n  data: Record<string, unknown>;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface IsIntercomPushNotificationResult {\n  /**\n   * Whether the push notification belongs to Intercom.\n   *\n   * @since 0.1.0\n   */\n  intercom: boolean;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface LogEventOptions {\n  /**\n   * The metadata of the event.\n   *\n   * @since 0.1.0\n   */\n  data?: Record<string, string | number | boolean>;\n  /**\n   * The name of the event.\n   *\n   * @since 0.1.0\n   */\n  name: string;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface LoginUserOptions {\n  /**\n   * The email address of the user.\n   *\n   * @since 0.1.0\n   */\n  email?: string;\n  /**\n   * The unique identifier of the user.\n   *\n   * @since 0.1.0\n   */\n  userId?: string;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface PresentContentOptions {\n  /**\n   * The identifier of the content to present.\n   *\n   * Required for the `article`, `carousel`, `survey`, and `conversation`\n   * content types.\n   *\n   * @since 0.1.0\n   */\n  id?: string;\n  /**\n   * The identifiers of the content to present.\n   *\n   * Required for the `help-center-collections` content type.\n   *\n   * @since 0.1.0\n   */\n  ids?: string[];\n  /**\n   * The type of content to present.\n   *\n   * @since 0.1.0\n   */\n  type: IntercomContentType;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface PresentMessageComposerOptions {\n  /**\n   * The message to pre-fill the composer with.\n   *\n   * @since 0.1.0\n   */\n  initialMessage?: string;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface PresentOptions {\n  /**\n   * The space to present.\n   *\n   * @default 'home'\n   * @since 0.1.0\n   */\n  space?: IntercomSpace;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface SendPushTokenToIntercomOptions {\n  /**\n   * The push notification token.\n   *\n   * On Android, this is the Firebase Cloud Messaging (FCM) token. On iOS,\n   * this is the hexadecimal APNs device token.\n   *\n   * @since 0.1.0\n   */\n  token: string;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface SetBottomPaddingOptions {\n  /**\n   * The bottom padding to set.\n   *\n   * @since 0.1.0\n   */\n  padding: number;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface SetInAppMessagesVisibleOptions {\n  /**\n   * Whether in-app messages should be visible.\n   *\n   * @since 0.1.0\n   */\n  visible: boolean;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface SetLauncherVisibleOptions {\n  /**\n   * Whether the launcher should be visible.\n   *\n   * @since 0.1.0\n   */\n  visible: boolean;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface SetUserHashOptions {\n  /**\n   * The user hash (HMAC) for identity verification.\n   *\n   * The hash must be generated on your backend using your Intercom secret\n   * key. Never expose the secret key in your app.\n   *\n   * @since 0.1.0\n   */\n  userHash: string;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface SetUserJwtOptions {\n  /**\n   * The JSON Web Token (JWT) for identity verification.\n   *\n   * The token must be generated on your backend using your Intercom secret\n   * key. Never expose the secret key in your app.\n   *\n   * @since 0.1.0\n   */\n  jwt: string;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface UnreadConversationCountChangeEvent {\n  /**\n   * The number of unread conversations.\n   *\n   * @since 0.1.0\n   */\n  count: number;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface UpdateUserCompany {\n  /**\n   * The date the company was created as a Unix timestamp in seconds.\n   *\n   * @since 0.1.0\n   * @example 1704067200\n   */\n  createdAt?: number;\n  /**\n   * The custom attributes of the company.\n   *\n   * @since 0.1.0\n   */\n  customAttributes?: Record<string, string | number | boolean>;\n  /**\n   * The unique identifier of the company.\n   *\n   * @since 0.1.0\n   */\n  id: string;\n  /**\n   * The monthly spend of the company.\n   *\n   * @since 0.1.0\n   */\n  monthlySpend?: number;\n  /**\n   * The name of the company.\n   *\n   * @since 0.1.0\n   */\n  name?: string;\n  /**\n   * The plan of the company.\n   *\n   * @since 0.1.0\n   */\n  plan?: string;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface UpdateUserOptions {\n  /**\n   * The companies the user belongs to.\n   *\n   * @since 0.1.0\n   */\n  companies?: UpdateUserCompany[];\n  /**\n   * The custom attributes of the user.\n   *\n   * @since 0.1.0\n   */\n  customAttributes?: Record<string, string | number | boolean>;\n  /**\n   * The email address of the user.\n   *\n   * @since 0.1.0\n   */\n  email?: string;\n  /**\n   * The preferred language of the user as an ISO 639-1 code.\n   *\n   * @since 0.1.0\n   * @example 'en'\n   */\n  languageOverride?: string;\n  /**\n   * The name of the user.\n   *\n   * @since 0.1.0\n   */\n  name?: string;\n  /**\n   * The phone number of the user.\n   *\n   * @since 0.1.0\n   */\n  phone?: string;\n  /**\n   * The date the user signed up as a Unix timestamp in seconds.\n   *\n   * @since 0.1.0\n   * @example 1704067200\n   */\n  signedUpAt?: number;\n  /**\n   * Whether the user is unsubscribed from emails.\n   *\n   * @since 0.1.0\n   */\n  unsubscribedFromEmails?: boolean;\n  /**\n   * The unique identifier of the user.\n   *\n   * @since 0.1.0\n   */\n  userId?: string;\n}\n\n/**\n * A type of Intercom content that can be presented.\n *\n * @since 0.1.0\n */\nexport type IntercomContentType =\n  | 'article'\n  | 'carousel'\n  | 'conversation'\n  | 'help-center-collections'\n  | 'survey';\n\n/**\n * A space of the Intercom Messenger.\n *\n * @since 0.1.0\n */\nexport type IntercomSpace = 'home' | 'messages' | 'help-center' | 'tickets';\n\n/**\n * @since 0.1.0\n */\nexport enum ErrorCode {\n  /**\n   * The login of the user failed.\n   *\n   * @since 0.1.0\n   */\n  LoginFailed = 'LOGIN_FAILED',\n  /**\n   * The plugin has not been initialized yet.\n   *\n   * Call `initialize(...)` before calling any other method.\n   *\n   * @since 0.1.0\n   */\n  NotInitialized = 'NOT_INITIALIZED',\n  /**\n   * The update of the user failed.\n   *\n   * @since 0.1.0\n   */\n  UpdateFailed = 'UPDATE_FAILED',\n}\n"]}

package/dist/esm/index.d.ts

@@ -0,0 +1,4 @@
+import type { IntercomPlugin } from './definitions';
+declare const Intercom: IntercomPlugin;
+export * from './definitions';
+export { Intercom };

package/dist/esm/index.js

@@ -0,0 +1,7 @@
+import { registerPlugin } from '@capacitor/core';
+const Intercom = registerPlugin('Intercom', {
+    web: () => import('./web').then(m => new m.IntercomWeb()),
+});
+export * from './definitions';
+export { Intercom };
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAIjD,MAAM,QAAQ,GAAG,cAAc,CAAiB,UAAU,EAAE;IAC1D,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC;CAC1D,CAAC,CAAC;AAEH,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,QAAQ,EAAE,CAAC","sourcesContent":["import { registerPlugin } from '@capacitor/core';\n\nimport type { IntercomPlugin } from './definitions';\n\nconst Intercom = registerPlugin<IntercomPlugin>('Intercom', {\n  web: () => import('./web').then(m => new m.IntercomWeb()),\n});\n\nexport * from './definitions';\nexport { Intercom };\n"]}

package/dist/esm/web.d.ts

@@ -0,0 +1,34 @@
+import { WebPlugin } from '@capacitor/core';
+import type { GetUnreadConversationCountResult, InitializeOptions, IntercomPlugin, LogEventOptions, LoginUserOptions, PresentContentOptions, PresentMessageComposerOptions, PresentOptions, SetInAppMessagesVisibleOptions, SetLauncherVisibleOptions, SetUserHashOptions, SetUserJwtOptions, UpdateUserOptions } from './definitions';
+export declare class IntercomWeb extends WebPlugin implements IntercomPlugin {
+    private static readonly errorNotInitialized;
+    private static readonly errorNoWebEquivalent;
+    private appId?;
+    private initialized;
+    private unreadConversationCount;
+    private userHash?;
+    private userJwt?;
+    getUnreadConversationCount(): Promise<GetUnreadConversationCountResult>;
+    handlePushNotification(): Promise<void>;
+    hide(): Promise<void>;
+    initialize(options: InitializeOptions): Promise<void>;
+    isIntercomPushNotification(): Promise<never>;
+    logEvent(options: LogEventOptions): Promise<void>;
+    loginUnidentifiedUser(): Promise<void>;
+    loginUser(options: LoginUserOptions): Promise<void>;
+    logout(): Promise<void>;
+    present(options?: PresentOptions): Promise<void>;
+    presentContent(options: PresentContentOptions): Promise<void>;
+    presentMessageComposer(options?: PresentMessageComposerOptions): Promise<void>;
+    sendPushTokenToIntercom(): Promise<void>;
+    setBottomPadding(): Promise<void>;
+    setInAppMessagesVisible(options: SetInAppMessagesVisibleOptions): Promise<void>;
+    setLauncherVisible(options: SetLauncherVisibleOptions): Promise<void>;
+    setUserHash(options: SetUserHashOptions): Promise<void>;
+    setUserJwt(options: SetUserJwtOptions): Promise<void>;
+    updateUser(options: UpdateUserOptions): Promise<void>;
+    private boot;
+    private static mapSpace;
+    private registerEventListeners;
+    private throwIfNotInitialized;
+}