New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
@cycraft/capacitor-repro
Advanced tools
@cycraft/capacitor-repro - npm Package Compare versions
Comparing version 0.0.1 to 0.0.2
@@ -21,3 +21,3 @@ import type { PermissionState, PluginListenerHandle } from '@capacitor/core'; | ||
| * @default ["badge", "sound", "alert"] | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
@@ -32,9 +32,19 @@ presentationOptions: PresentationOption[]; | ||
| * | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
| setup(options: SetupOptions): Promise<void>; | ||
| /** | ||
| * Set the log level. | ||
| * | ||
| * Only available for Android and iOS. | ||
| * | ||
| * @since 0.0.2 | ||
| * @see https://docs.repro.io/en/dev/sdk/log.html | ||
| */ | ||
| setLogLevel(options: SetLogLevelOptions): Promise<void>; | ||
| /** | ||
| * Set the user ID. | ||
| * | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| * @see https://docs.repro.io/en/dev/sdk/user-id.html | ||
| */ | ||
@@ -45,9 +55,47 @@ setUserId(options: SetUserIdOptions): Promise<void>; | ||
| * | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| * @see https://docs.repro.io/en/dev/sdk/user-id.html | ||
| */ | ||
| getUserId(): Promise<GetUserIdResult>; | ||
| /** | ||
| * Set custom user profile with a string value. | ||
| * | ||
| * Only available for Android and iOS. | ||
| * | ||
| * @since 0.0.2 | ||
| * @see https://docs.repro.io/en/dev/sdk/user-profile.html#setstringuserprofile | ||
| */ | ||
| setStringUserProfile(options: SetStringUserProfileOptions): Promise<void>; | ||
| /** | ||
| * Set custom user profile with an integer value. | ||
| * | ||
| * Only available for Android and iOS. | ||
| * | ||
| * @since 0.0.2 | ||
| * @see https://docs.repro.io/en/dev/sdk/user-profile.html#setintuserprofile | ||
| */ | ||
| setIntegerUserProfile(options: SetIntegerUserProfileOptions): Promise<void>; | ||
| /** | ||
| * Set custom user profile with a double value. | ||
| * | ||
| * Only available for Android and iOS. | ||
| * | ||
| * @since 0.0.2 | ||
| * @see https://docs.repro.io/en/dev/sdk/user-profile.html#setdoubleuserprofile | ||
| */ | ||
| setDoubleUserProfile(options: SetDoubleUserProfileOptions): Promise<void>; | ||
| /** | ||
| * Set custom user profile with a date value. | ||
| * | ||
| * Only available for Android and iOS. | ||
| * | ||
| * @since 0.0.2 | ||
| * @see https://docs.repro.io/en/dev/sdk/user-profile.html#setdateuserprofile | ||
| */ | ||
| setDateUserProfile(options: SetDateUserProfileOptions): Promise<void>; | ||
| /** | ||
| * Set the device ID. | ||
| * | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| * @see https://docs.repro.io/en/dev/sdk/device-id.html | ||
| */ | ||
@@ -58,3 +106,3 @@ getDeviceId(): Promise<GetDeviceIdResult>; | ||
| * | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
@@ -67,3 +115,3 @@ track(options: TrackOptions): Promise<void>; | ||
| * | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
@@ -76,3 +124,3 @@ enablePushNotification(): Promise<void>; | ||
| * | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
@@ -85,3 +133,3 @@ subscribeToPushNotification(): Promise<void>; | ||
| * | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
@@ -92,3 +140,3 @@ isPushNotificationSubscribeAllowed(): Promise<IsPushNotificationSubscribeAllowedResult>; | ||
| * | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
@@ -101,6 +149,24 @@ getNewsFeeds(options: GetNewsFeedsOptions): Promise<GetNewsFeedsResult>; | ||
| * | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
| updateNewsFeeds(options: UpdateNewsFeedsOptions): Promise<void>; | ||
| /** | ||
| * Disable in-app messages on foreground transition. | ||
| * | ||
| * Only available for Android and iOS. | ||
| * | ||
| * @since 0.0.2 | ||
| * @see https://docs.repro.io/en/dev/sdk/in-app-message.html | ||
| */ | ||
| disableInAppMessagesOnForegroundTransition(): Promise<void>; | ||
| /** | ||
| * Enable in-app messages on foreground transition. | ||
| * | ||
| * Only available for Android and iOS. | ||
| * | ||
| * @since 0.0.2 | ||
| * @see https://docs.repro.io/en/dev/sdk/in-app-message.html | ||
| */ | ||
| enableInAppMessagesOnForegroundTransition(): Promise<void>; | ||
| /** | ||
| * Check permission to receive push notifications. | ||
@@ -110,3 +176,3 @@ * | ||
| * | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
@@ -119,3 +185,3 @@ checkPermissions(): Promise<PermissionStatus>; | ||
| * | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
@@ -126,3 +192,3 @@ requestPermissions(): Promise<PermissionStatus>; | ||
| * | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
@@ -135,3 +201,3 @@ addListener(eventName: 'notificationReceived', listenerFunc: NotificationReceivedListener): Promise<PluginListenerHandle> & PluginListenerHandle; | ||
| * | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
@@ -142,6 +208,9 @@ addListener(eventName: 'notificationActionPerformed', listenerFunc: NotificationActionPerformedListener): Promise<PluginListenerHandle> & PluginListenerHandle; | ||
| * | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
| removeAllListeners(): Promise<void>; | ||
| } | ||
| /** | ||
| * @since 0.0.0 | ||
| */ | ||
| export interface SetupOptions { | ||
@@ -153,3 +222,3 @@ /** | ||
| * | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| * @see https://docs.repro.io/en/dev/web/getstarted/web.html#id7 | ||
@@ -165,3 +234,3 @@ */ | ||
| * | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| * @see https://docs.repro.io/en/dev/newsfeed-api/index.html#repro-client | ||
@@ -174,2 +243,34 @@ */ | ||
| */ | ||
| export interface SetLogLevelOptions { | ||
| /** | ||
| * The log level. | ||
| * | ||
| * @since 0.0.1 | ||
| */ | ||
| logLevel: LogLevel; | ||
| } | ||
| /** | ||
| * @since 0.0.1 | ||
| */ | ||
| export declare enum LogLevel { | ||
| /** | ||
| * @since 0.0.1 | ||
| */ | ||
| Debug = "DEBUG", | ||
| /** | ||
| * @since 0.0.1 | ||
| */ | ||
| Info = "INFO", | ||
| /** | ||
| * @since 0.0.1 | ||
| */ | ||
| Warning = "WARNING", | ||
| /** | ||
| * @since 0.0.1 | ||
| */ | ||
| Error = "ERROR" | ||
| } | ||
| /** | ||
| * @since 0.0.0 | ||
| */ | ||
| export interface SetUserIdOptions { | ||
@@ -179,3 +280,3 @@ /** | ||
| * | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| * @example "user_123" | ||
@@ -186,3 +287,3 @@ */ | ||
| /** | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
@@ -193,3 +294,3 @@ export interface GetUserIdResult { | ||
| * | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| * @example "user_123" | ||
@@ -199,2 +300,70 @@ */ | ||
| } | ||
| /** | ||
| * @since 0.0.1 | ||
| */ | ||
| export interface SetStringUserProfileOptions { | ||
| /** | ||
| * The user profile key. | ||
| * | ||
| * @since 0.0.1 | ||
| */ | ||
| key: string; | ||
| /** | ||
| * The user profile value. | ||
| * | ||
| * @since 0.0.1 | ||
| */ | ||
| value: string; | ||
| } | ||
| /** | ||
| * @since 0.0.1 | ||
| */ | ||
| export interface SetIntegerUserProfileOptions { | ||
| /** | ||
| * The user profile key. | ||
| * | ||
| * @since 0.0.1 | ||
| */ | ||
| key: string; | ||
| /** | ||
| * The user profile value. | ||
| * | ||
| * @since 0.0.1 | ||
| */ | ||
| value: number; | ||
| } | ||
| /** | ||
| * @since 0.0.1 | ||
| */ | ||
| export interface SetDoubleUserProfileOptions { | ||
| /** | ||
| * The user profile key. | ||
| * | ||
| * @since 0.0.1 | ||
| */ | ||
| key: string; | ||
| /** | ||
| * The user profile value. | ||
| * | ||
| * @since 0.0.1 | ||
| */ | ||
| value: number; | ||
| } | ||
| /** | ||
| * @since 0.0.1 | ||
| */ | ||
| export interface SetDateUserProfileOptions { | ||
| /** | ||
| * The user profile key. | ||
| * | ||
| * @since 0.0.1 | ||
| */ | ||
| key: string; | ||
| /** | ||
| * The user profile value. | ||
| * | ||
| * @since 0.0.1 | ||
| */ | ||
| value: Date; | ||
| } | ||
| export interface GetDeviceIdResult { | ||
@@ -204,3 +373,3 @@ /** | ||
| * | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| * @example "a8af1451aff07f98" | ||
@@ -211,3 +380,3 @@ */ | ||
| /** | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
@@ -218,3 +387,3 @@ export interface TrackOptions { | ||
| * | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| * @example "Finished tutorial" | ||
@@ -226,3 +395,3 @@ */ | ||
| * | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
@@ -234,3 +403,3 @@ eventProperties?: { | ||
| /** | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
@@ -241,3 +410,3 @@ export interface IsPushNotificationSubscribeAllowedResult { | ||
| * | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
@@ -247,7 +416,7 @@ isAllowed: boolean; | ||
| /** | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
| export interface GetNewsFeedsOptions { | ||
| /** | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
@@ -258,3 +427,3 @@ campaignType: CampaignType; | ||
| * | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| * @default 20 | ||
@@ -265,3 +434,3 @@ * @min 1 | ||
| /** | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
@@ -271,7 +440,7 @@ offsetNewsFeedId?: number; | ||
| /** | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
| export interface GetNewsFeedsResult { | ||
| /** | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
@@ -281,7 +450,7 @@ newsFeeds: NewsFeed[]; | ||
| /** | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
| export interface UpdateNewsFeedsOptions { | ||
| /** | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
@@ -291,3 +460,3 @@ newsFeeds: NewsFeed[]; | ||
| /** | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
@@ -298,31 +467,31 @@ export interface NewsFeed { | ||
| * | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
| id: number; | ||
| /** | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
| campaignType: CampaignType; | ||
| /** | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
| deviceId?: string; | ||
| /** | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
| title?: string; | ||
| /** | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
| summary?: string; | ||
| /** | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
| body?: string; | ||
| /** | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
| linkUrl?: string; | ||
| /** | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
@@ -333,3 +502,3 @@ imageUrl?: string; | ||
| * | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| * @example "2023-11-17T09:28:54.095Z" | ||
@@ -341,3 +510,3 @@ */ | ||
| * | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| * @default false | ||
@@ -350,3 +519,3 @@ * @example true | ||
| * | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| * @default false | ||
@@ -358,23 +527,23 @@ * @example true | ||
| /** | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
| export declare enum CampaignType { | ||
| /** | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
| PushNotification = "PUSH_NOTIFICATION", | ||
| /** | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
| InAppMessage = "IN_APP_MESSAGE", | ||
| /** | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
| WebMessage = "WEB_MESSAGE", | ||
| /** | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
| All = "ALL", | ||
| /** | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
@@ -384,7 +553,7 @@ Unknown = "UNKNOWN" | ||
| /** | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
| export interface PermissionStatus { | ||
| /** | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
@@ -396,3 +565,3 @@ receive: PermissionState; | ||
| * | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
@@ -403,11 +572,11 @@ export declare type NotificationReceivedListener = (event: NotificationReceivedEvent) => void; | ||
| * | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
| export declare type NotificationActionPerformedListener = (event: NotificationActionPerformedEvent) => void; | ||
| /** | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
| export interface NotificationReceivedEvent { | ||
| /** | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
@@ -417,3 +586,3 @@ notification: Notification; | ||
| /** | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
@@ -424,3 +593,3 @@ export interface NotificationActionPerformedEvent { | ||
| * | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
@@ -433,3 +602,3 @@ actionId: string; | ||
| * | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
@@ -440,3 +609,3 @@ inputValue?: string; | ||
| * | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
@@ -446,3 +615,3 @@ notification: Notification; | ||
| /** | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
@@ -453,3 +622,3 @@ export interface Notification { | ||
| * | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
@@ -460,3 +629,3 @@ body?: string; | ||
| * | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
@@ -467,3 +636,3 @@ data?: unknown; | ||
| * | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
@@ -476,3 +645,3 @@ id?: string; | ||
| * | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
@@ -483,5 +652,5 @@ subtitle?: string; | ||
| * | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
| title?: string; | ||
| } |
@@ -5,22 +5,44 @@ /// <reference types="@capacitor/cli" /> | ||
| */ | ||
| export var LogLevel; | ||
| (function (LogLevel) { | ||
| /** | ||
| * @since 0.0.1 | ||
| */ | ||
| LogLevel["Debug"] = "DEBUG"; | ||
| /** | ||
| * @since 0.0.1 | ||
| */ | ||
| LogLevel["Info"] = "INFO"; | ||
| /** | ||
| * @since 0.0.1 | ||
| */ | ||
| LogLevel["Warning"] = "WARNING"; | ||
| /** | ||
| * @since 0.0.1 | ||
| */ | ||
| LogLevel["Error"] = "ERROR"; | ||
| })(LogLevel || (LogLevel = {})); | ||
| /** | ||
| * @since 0.0.0 | ||
| */ | ||
| export var CampaignType; | ||
| (function (CampaignType) { | ||
| /** | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
| CampaignType["PushNotification"] = "PUSH_NOTIFICATION"; | ||
| /** | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
| CampaignType["InAppMessage"] = "IN_APP_MESSAGE"; | ||
| /** | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
| CampaignType["WebMessage"] = "WEB_MESSAGE"; | ||
| /** | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
| CampaignType["All"] = "ALL"; | ||
| /** | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
@@ -27,0 +49,0 @@ CampaignType["Unknown"] = "UNKNOWN"; |
| import { WebPlugin } from '@capacitor/core'; | ||
| import type { GetDeviceIdResult, GetNewsFeedsOptions, GetNewsFeedsResult, GetUserIdResult, IsPushNotificationSubscribeAllowedResult, PermissionStatus, ReproPlugin, SetUserIdOptions, SetupOptions, TrackOptions, UpdateNewsFeedsOptions } from './definitions'; | ||
| import type { GetDeviceIdResult, GetNewsFeedsOptions, GetNewsFeedsResult, GetUserIdResult, IsPushNotificationSubscribeAllowedResult, PermissionStatus, ReproPlugin, SetDateUserProfileOptions, SetDoubleUserProfileOptions, SetIntegerUserProfileOptions, SetLogLevelOptions, SetStringUserProfileOptions, SetUserIdOptions, SetupOptions, TrackOptions, UpdateNewsFeedsOptions } from './definitions'; | ||
| export declare class ReproWeb extends WebPlugin implements ReproPlugin { | ||
@@ -8,4 +8,9 @@ private static readonly ERROR_NOT_SET_UP; | ||
| setup(options: SetupOptions): Promise<void>; | ||
| setLogLevel(_options: SetLogLevelOptions): Promise<void>; | ||
| setUserId(options: SetUserIdOptions): Promise<void>; | ||
| getUserId(): Promise<GetUserIdResult>; | ||
| setStringUserProfile(_options: SetStringUserProfileOptions): Promise<void>; | ||
| setIntegerUserProfile(_options: SetIntegerUserProfileOptions): Promise<void>; | ||
| setDoubleUserProfile(_options: SetDoubleUserProfileOptions): Promise<void>; | ||
| setDateUserProfile(_options: SetDateUserProfileOptions): Promise<void>; | ||
| getDeviceId(): Promise<GetDeviceIdResult>; | ||
@@ -18,4 +23,6 @@ track(_options: TrackOptions): Promise<void>; | ||
| updateNewsFeeds(options: UpdateNewsFeedsOptions): Promise<void>; | ||
| disableInAppMessagesOnForegroundTransition(): Promise<void>; | ||
| enableInAppMessagesOnForegroundTransition(): Promise<void>; | ||
| checkPermissions(): Promise<PermissionStatus>; | ||
| requestPermissions(): Promise<PermissionStatus>; | ||
| } |
@@ -23,2 +23,5 @@ import { WebPlugin } from '@capacitor/core'; | ||
| } | ||
| async setLogLevel(_options) { | ||
| throw this.unimplemented('Not implemented on web.'); | ||
| } | ||
| async setUserId(options) { | ||
@@ -30,2 +33,14 @@ window.reproio('setUserID', options.userId); | ||
| } | ||
| async setStringUserProfile(_options) { | ||
| throw this.unimplemented('Not implemented on web.'); | ||
| } | ||
| async setIntegerUserProfile(_options) { | ||
| throw this.unimplemented('Not implemented on web.'); | ||
| } | ||
| async setDoubleUserProfile(_options) { | ||
| throw this.unimplemented('Not implemented on web.'); | ||
| } | ||
| async setDateUserProfile(_options) { | ||
| throw this.unimplemented('Not implemented on web.'); | ||
| } | ||
| async getDeviceId() { | ||
@@ -104,2 +119,8 @@ return window.reproio('getDeviceID'); | ||
| } | ||
| async disableInAppMessagesOnForegroundTransition() { | ||
| throw this.unimplemented('Not implemented on web.'); | ||
| } | ||
| async enableInAppMessagesOnForegroundTransition() { | ||
| throw this.unimplemented('Not implemented on web.'); | ||
| } | ||
| async checkPermissions() { | ||
@@ -106,0 +127,0 @@ throw new Error('Method not implemented.'); |
@@ -11,22 +11,44 @@ 'use strict'; | ||
| */ | ||
| exports.LogLevel = void 0; | ||
| (function (LogLevel) { | ||
| /** | ||
| * @since 0.0.1 | ||
| */ | ||
| LogLevel["Debug"] = "DEBUG"; | ||
| /** | ||
| * @since 0.0.1 | ||
| */ | ||
| LogLevel["Info"] = "INFO"; | ||
| /** | ||
| * @since 0.0.1 | ||
| */ | ||
| LogLevel["Warning"] = "WARNING"; | ||
| /** | ||
| * @since 0.0.1 | ||
| */ | ||
| LogLevel["Error"] = "ERROR"; | ||
| })(exports.LogLevel || (exports.LogLevel = {})); | ||
| /** | ||
| * @since 0.0.0 | ||
| */ | ||
| exports.CampaignType = void 0; | ||
| (function (CampaignType) { | ||
| /** | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
| CampaignType["PushNotification"] = "PUSH_NOTIFICATION"; | ||
| /** | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
| CampaignType["InAppMessage"] = "IN_APP_MESSAGE"; | ||
| /** | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
| CampaignType["WebMessage"] = "WEB_MESSAGE"; | ||
| /** | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
| CampaignType["All"] = "ALL"; | ||
| /** | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
@@ -61,2 +83,5 @@ CampaignType["Unknown"] = "UNKNOWN"; | ||
| } | ||
| async setLogLevel(_options) { | ||
| throw this.unimplemented('Not implemented on web.'); | ||
| } | ||
| async setUserId(options) { | ||
@@ -68,2 +93,14 @@ window.reproio('setUserID', options.userId); | ||
| } | ||
| async setStringUserProfile(_options) { | ||
| throw this.unimplemented('Not implemented on web.'); | ||
| } | ||
| async setIntegerUserProfile(_options) { | ||
| throw this.unimplemented('Not implemented on web.'); | ||
| } | ||
| async setDoubleUserProfile(_options) { | ||
| throw this.unimplemented('Not implemented on web.'); | ||
| } | ||
| async setDateUserProfile(_options) { | ||
| throw this.unimplemented('Not implemented on web.'); | ||
| } | ||
| async getDeviceId() { | ||
@@ -142,2 +179,8 @@ return window.reproio('getDeviceID'); | ||
| } | ||
| async disableInAppMessagesOnForegroundTransition() { | ||
| throw this.unimplemented('Not implemented on web.'); | ||
| } | ||
| async enableInAppMessagesOnForegroundTransition() { | ||
| throw this.unimplemented('Not implemented on web.'); | ||
| } | ||
| async checkPermissions() { | ||
@@ -144,0 +187,0 @@ throw new Error('Method not implemented.'); |
@@ -8,22 +8,44 @@ var capacitorRepro = (function (exports, core) { | ||
| */ | ||
| exports.LogLevel = void 0; | ||
| (function (LogLevel) { | ||
| /** | ||
| * @since 0.0.1 | ||
| */ | ||
| LogLevel["Debug"] = "DEBUG"; | ||
| /** | ||
| * @since 0.0.1 | ||
| */ | ||
| LogLevel["Info"] = "INFO"; | ||
| /** | ||
| * @since 0.0.1 | ||
| */ | ||
| LogLevel["Warning"] = "WARNING"; | ||
| /** | ||
| * @since 0.0.1 | ||
| */ | ||
| LogLevel["Error"] = "ERROR"; | ||
| })(exports.LogLevel || (exports.LogLevel = {})); | ||
| /** | ||
| * @since 0.0.0 | ||
| */ | ||
| exports.CampaignType = void 0; | ||
| (function (CampaignType) { | ||
| /** | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
| CampaignType["PushNotification"] = "PUSH_NOTIFICATION"; | ||
| /** | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
| CampaignType["InAppMessage"] = "IN_APP_MESSAGE"; | ||
| /** | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
| CampaignType["WebMessage"] = "WEB_MESSAGE"; | ||
| /** | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
| CampaignType["All"] = "ALL"; | ||
| /** | ||
| * @since 0.0.1 | ||
| * @since 0.0.0 | ||
| */ | ||
@@ -58,2 +80,5 @@ CampaignType["Unknown"] = "UNKNOWN"; | ||
| } | ||
| async setLogLevel(_options) { | ||
| throw this.unimplemented('Not implemented on web.'); | ||
| } | ||
| async setUserId(options) { | ||
@@ -65,2 +90,14 @@ window.reproio('setUserID', options.userId); | ||
| } | ||
| async setStringUserProfile(_options) { | ||
| throw this.unimplemented('Not implemented on web.'); | ||
| } | ||
| async setIntegerUserProfile(_options) { | ||
| throw this.unimplemented('Not implemented on web.'); | ||
| } | ||
| async setDoubleUserProfile(_options) { | ||
| throw this.unimplemented('Not implemented on web.'); | ||
| } | ||
| async setDateUserProfile(_options) { | ||
| throw this.unimplemented('Not implemented on web.'); | ||
| } | ||
| async getDeviceId() { | ||
@@ -139,2 +176,8 @@ return window.reproio('getDeviceID'); | ||
| } | ||
| async disableInAppMessagesOnForegroundTransition() { | ||
| throw this.unimplemented('Not implemented on web.'); | ||
| } | ||
| async enableInAppMessagesOnForegroundTransition() { | ||
| throw this.unimplemented('Not implemented on web.'); | ||
| } | ||
| async checkPermissions() { | ||
@@ -141,0 +184,0 @@ throw new Error('Method not implemented.'); |
| { | ||
| "name": "@cycraft/capacitor-repro", | ||
| "version": "0.0.1", | ||
| "version": "0.0.2", | ||
| "description": "Unofficial Capacitor plugin for Repro SDK.", | ||
@@ -5,0 +5,0 @@ "main": "dist/plugin.cjs.js", |
352
README.md
@@ -174,3 +174,3 @@ # @cycraft/capacitor-repro | ||
| | ------------------------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | ----- | | ||
| | **`presentationOptions`** | <code>PresentationOption[]</code> | This is an array of strings you can combine. Possible values in the array are: - `badge`: badge count on the app icon is updated (default value) - `sound`: the device will ring/vibrate when the push notification is received - `alert`: the push notification is displayed in a native dialog An empty array can be provided if none of the options are desired. Only available for iOS. | <code>["badge", "sound", "alert"]</code> | 0.0.1 | | ||
| | **`presentationOptions`** | <code>PresentationOption[]</code> | This is an array of strings you can combine. Possible values in the array are: - `badge`: badge count on the app icon is updated (default value) - `sound`: the device will ring/vibrate when the push notification is received - `alert`: the push notification is displayed in a native dialog An empty array can be provided if none of the options are desired. Only available for iOS. | <code>["badge", "sound", "alert"]</code> | 0.0.0 | | ||
@@ -260,4 +260,9 @@ ### Examples | ||
| * [`setup(...)`](#setup) | ||
| * [`setLogLevel(...)`](#setloglevel) | ||
| * [`setUserId(...)`](#setuserid) | ||
| * [`getUserId()`](#getuserid) | ||
| * [`setStringUserProfile(...)`](#setstringuserprofile) | ||
| * [`setIntegerUserProfile(...)`](#setintegeruserprofile) | ||
| * [`setDoubleUserProfile(...)`](#setdoubleuserprofile) | ||
| * [`setDateUserProfile(...)`](#setdateuserprofile) | ||
| * [`getDeviceId()`](#getdeviceid) | ||
@@ -270,2 +275,4 @@ * [`track(...)`](#track) | ||
| * [`updateNewsFeeds(...)`](#updatenewsfeeds) | ||
| * [`disableInAppMessagesOnForegroundTransition()`](#disableinappmessagesonforegroundtransition) | ||
| * [`enableInAppMessagesOnForegroundTransition()`](#enableinappmessagesonforegroundtransition) | ||
| * [`checkPermissions()`](#checkpermissions) | ||
@@ -297,3 +304,3 @@ * [`requestPermissions()`](#requestpermissions) | ||
| **Since:** 0.0.1 | ||
| **Since:** 0.0.0 | ||
@@ -303,2 +310,21 @@ -------------------- | ||
| ### setLogLevel(...) | ||
| ```typescript | ||
| setLogLevel(options: SetLogLevelOptions) => Promise<void> | ||
| ``` | ||
| Set the log level. | ||
| Only available for Android and iOS. | ||
| | Param | Type | | ||
| | ------------- | ----------------------------------------------------------------- | | ||
| | **`options`** | <code><a href="#setlogleveloptions">SetLogLevelOptions</a></code> | | ||
| **Since:** 0.0.2 | ||
| -------------------- | ||
| ### setUserId(...) | ||
@@ -316,3 +342,3 @@ | ||
| **Since:** 0.0.1 | ||
| **Since:** 0.0.0 | ||
@@ -332,3 +358,3 @@ -------------------- | ||
| **Since:** 0.0.1 | ||
| **Since:** 0.0.0 | ||
@@ -338,2 +364,78 @@ -------------------- | ||
| ### setStringUserProfile(...) | ||
| ```typescript | ||
| setStringUserProfile(options: SetStringUserProfileOptions) => Promise<void> | ||
| ``` | ||
| Set custom user profile with a string value. | ||
| Only available for Android and iOS. | ||
| | Param | Type | | ||
| | ------------- | ----------------------------------------------------------------------------------- | | ||
| | **`options`** | <code><a href="#setstringuserprofileoptions">SetStringUserProfileOptions</a></code> | | ||
| **Since:** 0.0.2 | ||
| -------------------- | ||
| ### setIntegerUserProfile(...) | ||
| ```typescript | ||
| setIntegerUserProfile(options: SetIntegerUserProfileOptions) => Promise<void> | ||
| ``` | ||
| Set custom user profile with an integer value. | ||
| Only available for Android and iOS. | ||
| | Param | Type | | ||
| | ------------- | ------------------------------------------------------------------------------------- | | ||
| | **`options`** | <code><a href="#setintegeruserprofileoptions">SetIntegerUserProfileOptions</a></code> | | ||
| **Since:** 0.0.2 | ||
| -------------------- | ||
| ### setDoubleUserProfile(...) | ||
| ```typescript | ||
| setDoubleUserProfile(options: SetDoubleUserProfileOptions) => Promise<void> | ||
| ``` | ||
| Set custom user profile with a double value. | ||
| Only available for Android and iOS. | ||
| | Param | Type | | ||
| | ------------- | ----------------------------------------------------------------------------------- | | ||
| | **`options`** | <code><a href="#setdoubleuserprofileoptions">SetDoubleUserProfileOptions</a></code> | | ||
| **Since:** 0.0.2 | ||
| -------------------- | ||
| ### setDateUserProfile(...) | ||
| ```typescript | ||
| setDateUserProfile(options: SetDateUserProfileOptions) => Promise<void> | ||
| ``` | ||
| Set custom user profile with a date value. | ||
| Only available for Android and iOS. | ||
| | Param | Type | | ||
| | ------------- | ------------------------------------------------------------------------------- | | ||
| | **`options`** | <code><a href="#setdateuserprofileoptions">SetDateUserProfileOptions</a></code> | | ||
| **Since:** 0.0.2 | ||
| -------------------- | ||
| ### getDeviceId() | ||
@@ -349,3 +451,3 @@ | ||
| **Since:** 0.0.1 | ||
| **Since:** 0.0.0 | ||
@@ -367,3 +469,3 @@ -------------------- | ||
| **Since:** 0.0.1 | ||
| **Since:** 0.0.0 | ||
@@ -383,3 +485,3 @@ -------------------- | ||
| **Since:** 0.0.1 | ||
| **Since:** 0.0.0 | ||
@@ -399,3 +501,3 @@ -------------------- | ||
| **Since:** 0.0.1 | ||
| **Since:** 0.0.0 | ||
@@ -417,3 +519,3 @@ -------------------- | ||
| **Since:** 0.0.1 | ||
| **Since:** 0.0.0 | ||
@@ -437,3 +539,3 @@ -------------------- | ||
| **Since:** 0.0.1 | ||
| **Since:** 0.0.0 | ||
@@ -457,3 +559,3 @@ -------------------- | ||
| **Since:** 0.0.1 | ||
| **Since:** 0.0.0 | ||
@@ -463,2 +565,32 @@ -------------------- | ||
| ### disableInAppMessagesOnForegroundTransition() | ||
| ```typescript | ||
| disableInAppMessagesOnForegroundTransition() => Promise<void> | ||
| ``` | ||
| Disable in-app messages on foreground transition. | ||
| Only available for Android and iOS. | ||
| **Since:** 0.0.2 | ||
| -------------------- | ||
| ### enableInAppMessagesOnForegroundTransition() | ||
| ```typescript | ||
| enableInAppMessagesOnForegroundTransition() => Promise<void> | ||
| ``` | ||
| Enable in-app messages on foreground transition. | ||
| Only available for Android and iOS. | ||
| **Since:** 0.0.2 | ||
| -------------------- | ||
| ### checkPermissions() | ||
@@ -476,3 +608,3 @@ | ||
| **Since:** 0.0.1 | ||
| **Since:** 0.0.0 | ||
@@ -494,3 +626,3 @@ -------------------- | ||
| **Since:** 0.0.1 | ||
| **Since:** 0.0.0 | ||
@@ -515,3 +647,3 @@ -------------------- | ||
| **Since:** 0.0.1 | ||
| **Since:** 0.0.0 | ||
@@ -538,3 +670,3 @@ -------------------- | ||
| **Since:** 0.0.1 | ||
| **Since:** 0.0.0 | ||
@@ -552,3 +684,3 @@ -------------------- | ||
| **Since:** 0.0.1 | ||
| **Since:** 0.0.0 | ||
@@ -565,6 +697,13 @@ -------------------- | ||
| | ----------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- | | ||
| | **`sdkToken`** | <code>string</code> | The Repro SDK token. Log in to the Repro Web dashboard and go to `Settings`, `Project Settings` and copy the `SDK token`. | 0.0.1 | | ||
| | **`clientToken`** | <code>string</code> | The Repro Client token. Log in to the Repro Web dashboard and go to `Settings`, `Project Settings` and copy the `Repro Client token`. Only available for Web. | 0.0.1 | | ||
| | **`sdkToken`** | <code>string</code> | The Repro SDK token. Log in to the Repro Web dashboard and go to `Settings`, `Project Settings` and copy the `SDK token`. | 0.0.0 | | ||
| | **`clientToken`** | <code>string</code> | The Repro Client token. Log in to the Repro Web dashboard and go to `Settings`, `Project Settings` and copy the `Repro Client token`. Only available for Web. | 0.0.0 | | ||
| #### SetLogLevelOptions | ||
| | Prop | Type | Description | Since | | ||
| | -------------- | --------------------------------------------- | -------------- | ----- | | ||
| | **`logLevel`** | <code><a href="#loglevel">LogLevel</a></code> | The log level. | 0.0.1 | | ||
| #### SetUserIdOptions | ||
@@ -574,3 +713,3 @@ | ||
| | ------------ | ------------------- | ------------ | ----- | | ||
| | **`userId`** | <code>string</code> | The user ID. | 0.0.1 | | ||
| | **`userId`** | <code>string</code> | The user ID. | 0.0.0 | | ||
@@ -582,5 +721,88 @@ | ||
| | ------------ | ------------------- | ------------ | ----- | | ||
| | **`userId`** | <code>string</code> | The user ID. | 0.0.1 | | ||
| | **`userId`** | <code>string</code> | The user ID. | 0.0.0 | | ||
| #### SetStringUserProfileOptions | ||
| | Prop | Type | Description | Since | | ||
| | ----------- | ------------------- | ----------------------- | ----- | | ||
| | **`key`** | <code>string</code> | The user profile key. | 0.0.1 | | ||
| | **`value`** | <code>string</code> | The user profile value. | 0.0.1 | | ||
| #### SetIntegerUserProfileOptions | ||
| | Prop | Type | Description | Since | | ||
| | ----------- | ------------------- | ----------------------- | ----- | | ||
| | **`key`** | <code>string</code> | The user profile key. | 0.0.1 | | ||
| | **`value`** | <code>number</code> | The user profile value. | 0.0.1 | | ||
| #### SetDoubleUserProfileOptions | ||
| | Prop | Type | Description | Since | | ||
| | ----------- | ------------------- | ----------------------- | ----- | | ||
| | **`key`** | <code>string</code> | The user profile key. | 0.0.1 | | ||
| | **`value`** | <code>number</code> | The user profile value. | 0.0.1 | | ||
| #### SetDateUserProfileOptions | ||
| | Prop | Type | Description | Since | | ||
| | ----------- | ------------------------------------- | ----------------------- | ----- | | ||
| | **`key`** | <code>string</code> | The user profile key. | 0.0.1 | | ||
| | **`value`** | <code><a href="#date">Date</a></code> | The user profile value. | 0.0.1 | | ||
| #### Date | ||
| Enables basic storage and retrieval of dates and times. | ||
| | Method | Signature | Description | | ||
| | ---------------------- | ------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | **toString** | () => string | Returns a string representation of a date. The format of the string depends on the locale. | | ||
| | **toDateString** | () => string | Returns a date as a string value. | | ||
| | **toTimeString** | () => string | Returns a time as a string value. | | ||
| | **toLocaleString** | () => string | Returns a value as a string value appropriate to the host environment's current locale. | | ||
| | **toLocaleDateString** | () => string | Returns a date as a string value appropriate to the host environment's current locale. | | ||
| | **toLocaleTimeString** | () => string | Returns a time as a string value appropriate to the host environment's current locale. | | ||
| | **valueOf** | () => number | Returns the stored time value in milliseconds since midnight, January 1, 1970 UTC. | | ||
| | **getTime** | () => number | Gets the time value in milliseconds. | | ||
| | **getFullYear** | () => number | Gets the year, using local time. | | ||
| | **getUTCFullYear** | () => number | Gets the year using Universal Coordinated Time (UTC). | | ||
| | **getMonth** | () => number | Gets the month, using local time. | | ||
| | **getUTCMonth** | () => number | Gets the month of a <a href="#date">Date</a> object using Universal Coordinated Time (UTC). | | ||
| | **getDate** | () => number | Gets the day-of-the-month, using local time. | | ||
| | **getUTCDate** | () => number | Gets the day-of-the-month, using Universal Coordinated Time (UTC). | | ||
| | **getDay** | () => number | Gets the day of the week, using local time. | | ||
| | **getUTCDay** | () => number | Gets the day of the week using Universal Coordinated Time (UTC). | | ||
| | **getHours** | () => number | Gets the hours in a date, using local time. | | ||
| | **getUTCHours** | () => number | Gets the hours value in a <a href="#date">Date</a> object using Universal Coordinated Time (UTC). | | ||
| | **getMinutes** | () => number | Gets the minutes of a <a href="#date">Date</a> object, using local time. | | ||
| | **getUTCMinutes** | () => number | Gets the minutes of a <a href="#date">Date</a> object using Universal Coordinated Time (UTC). | | ||
| | **getSeconds** | () => number | Gets the seconds of a <a href="#date">Date</a> object, using local time. | | ||
| | **getUTCSeconds** | () => number | Gets the seconds of a <a href="#date">Date</a> object using Universal Coordinated Time (UTC). | | ||
| | **getMilliseconds** | () => number | Gets the milliseconds of a <a href="#date">Date</a>, using local time. | | ||
| | **getUTCMilliseconds** | () => number | Gets the milliseconds of a <a href="#date">Date</a> object using Universal Coordinated Time (UTC). | | ||
| | **getTimezoneOffset** | () => number | Gets the difference in minutes between the time on the local computer and Universal Coordinated Time (UTC). | | ||
| | **setTime** | (time: number) => number | Sets the date and time value in the <a href="#date">Date</a> object. | | ||
| | **setMilliseconds** | (ms: number) => number | Sets the milliseconds value in the <a href="#date">Date</a> object using local time. | | ||
| | **setUTCMilliseconds** | (ms: number) => number | Sets the milliseconds value in the <a href="#date">Date</a> object using Universal Coordinated Time (UTC). | | ||
| | **setSeconds** | (sec: number, ms?: number \| undefined) => number | Sets the seconds value in the <a href="#date">Date</a> object using local time. | | ||
| | **setUTCSeconds** | (sec: number, ms?: number \| undefined) => number | Sets the seconds value in the <a href="#date">Date</a> object using Universal Coordinated Time (UTC). | | ||
| | **setMinutes** | (min: number, sec?: number \| undefined, ms?: number \| undefined) => number | Sets the minutes value in the <a href="#date">Date</a> object using local time. | | ||
| | **setUTCMinutes** | (min: number, sec?: number \| undefined, ms?: number \| undefined) => number | Sets the minutes value in the <a href="#date">Date</a> object using Universal Coordinated Time (UTC). | | ||
| | **setHours** | (hours: number, min?: number \| undefined, sec?: number \| undefined, ms?: number \| undefined) => number | Sets the hour value in the <a href="#date">Date</a> object using local time. | | ||
| | **setUTCHours** | (hours: number, min?: number \| undefined, sec?: number \| undefined, ms?: number \| undefined) => number | Sets the hours value in the <a href="#date">Date</a> object using Universal Coordinated Time (UTC). | | ||
| | **setDate** | (date: number) => number | Sets the numeric day-of-the-month value of the <a href="#date">Date</a> object using local time. | | ||
| | **setUTCDate** | (date: number) => number | Sets the numeric day of the month in the <a href="#date">Date</a> object using Universal Coordinated Time (UTC). | | ||
| | **setMonth** | (month: number, date?: number \| undefined) => number | Sets the month value in the <a href="#date">Date</a> object using local time. | | ||
| | **setUTCMonth** | (month: number, date?: number \| undefined) => number | Sets the month value in the <a href="#date">Date</a> object using Universal Coordinated Time (UTC). | | ||
| | **setFullYear** | (year: number, month?: number \| undefined, date?: number \| undefined) => number | Sets the year of the <a href="#date">Date</a> object using local time. | | ||
| | **setUTCFullYear** | (year: number, month?: number \| undefined, date?: number \| undefined) => number | Sets the year value in the <a href="#date">Date</a> object using Universal Coordinated Time (UTC). | | ||
| | **toUTCString** | () => string | Returns a date converted to a string using Universal Coordinated Time (UTC). | | ||
| | **toISOString** | () => string | Returns a date as a string value in ISO format. | | ||
| | **toJSON** | (key?: any) => string | Used by the JSON.stringify method to enable the transformation of an object's data for JavaScript Object Notation (JSON) serialization. | | ||
| #### GetDeviceIdResult | ||
@@ -590,3 +812,3 @@ | ||
| | -------------- | ------------------- | -------------- | ----- | | ||
| | **`deviceId`** | <code>string</code> | The device ID. | 0.0.1 | | ||
| | **`deviceId`** | <code>string</code> | The device ID. | 0.0.0 | | ||
@@ -598,4 +820,4 @@ | ||
| | --------------------- | ------------------------------------ | --------------------- | ----- | | ||
| | **`eventName`** | <code>string</code> | The event name. | 0.0.1 | | ||
| | **`eventProperties`** | <code>{ [key: string]: any; }</code> | The event properties. | 0.0.1 | | ||
| | **`eventName`** | <code>string</code> | The event name. | 0.0.0 | | ||
| | **`eventProperties`** | <code>{ [key: string]: any; }</code> | The event properties. | 0.0.0 | | ||
@@ -607,3 +829,3 @@ | ||
| | --------------- | -------------------- | ---------------------------------------------------------- | ----- | | ||
| | **`isAllowed`** | <code>boolean</code> | Whether the push notification subscribe is allowed or not. | 0.0.1 | | ||
| | **`isAllowed`** | <code>boolean</code> | Whether the push notification subscribe is allowed or not. | 0.0.0 | | ||
@@ -615,3 +837,3 @@ | ||
| | --------------- | ----------------------- | ----- | | ||
| | **`newsFeeds`** | <code>NewsFeed[]</code> | 0.0.1 | | ||
| | **`newsFeeds`** | <code>NewsFeed[]</code> | 0.0.0 | | ||
@@ -623,13 +845,13 @@ | ||
| | ------------------ | ----------------------------------------------------- | --------------------------------------------------- | ------------------ | ----- | | ||
| | **`id`** | <code>number</code> | The ID of the news feed. | | 0.0.1 | | ||
| | **`campaignType`** | <code><a href="#campaigntype">CampaignType</a></code> | | | 0.0.1 | | ||
| | **`deviceId`** | <code>string</code> | | | 0.0.1 | | ||
| | **`title`** | <code>string</code> | | | 0.0.1 | | ||
| | **`summary`** | <code>string</code> | | | 0.0.1 | | ||
| | **`body`** | <code>string</code> | | | 0.0.1 | | ||
| | **`linkUrl`** | <code>string</code> | | | 0.0.1 | | ||
| | **`imageUrl`** | <code>string</code> | | | 0.0.1 | | ||
| | **`deliveredAt`** | <code>string</code> | The date and time when the news feed was delivered. | | 0.0.1 | | ||
| | **`shown`** | <code>boolean</code> | Whether the news feed is shown or not. | <code>false</code> | 0.0.1 | | ||
| | **`read`** | <code>boolean</code> | Whether the news feed is read or not. | <code>false</code> | 0.0.1 | | ||
| | **`id`** | <code>number</code> | The ID of the news feed. | | 0.0.0 | | ||
| | **`campaignType`** | <code><a href="#campaigntype">CampaignType</a></code> | | | 0.0.0 | | ||
| | **`deviceId`** | <code>string</code> | | | 0.0.0 | | ||
| | **`title`** | <code>string</code> | | | 0.0.0 | | ||
| | **`summary`** | <code>string</code> | | | 0.0.0 | | ||
| | **`body`** | <code>string</code> | | | 0.0.0 | | ||
| | **`linkUrl`** | <code>string</code> | | | 0.0.0 | | ||
| | **`imageUrl`** | <code>string</code> | | | 0.0.0 | | ||
| | **`deliveredAt`** | <code>string</code> | The date and time when the news feed was delivered. | | 0.0.0 | | ||
| | **`shown`** | <code>boolean</code> | Whether the news feed is shown or not. | <code>false</code> | 0.0.0 | | ||
| | **`read`** | <code>boolean</code> | Whether the news feed is read or not. | <code>false</code> | 0.0.0 | | ||
@@ -641,5 +863,5 @@ | ||
| | ---------------------- | ----------------------------------------------------- | ------------------------------------------ | --------------- | ----- | | ||
| | **`campaignType`** | <code><a href="#campaigntype">CampaignType</a></code> | | | 0.0.1 | | ||
| | **`limit`** | <code>number</code> | The number of news feed entries to return. | <code>20</code> | 0.0.1 | | ||
| | **`offsetNewsFeedId`** | <code>number</code> | | | 0.0.1 | | ||
| | **`campaignType`** | <code><a href="#campaigntype">CampaignType</a></code> | | | 0.0.0 | | ||
| | **`limit`** | <code>number</code> | The number of news feed entries to return. | <code>20</code> | 0.0.0 | | ||
| | **`offsetNewsFeedId`** | <code>number</code> | | | 0.0.0 | | ||
@@ -651,3 +873,3 @@ | ||
| | --------------- | ----------------------- | ----- | | ||
| | **`newsFeeds`** | <code>NewsFeed[]</code> | 0.0.1 | | ||
| | **`newsFeeds`** | <code>NewsFeed[]</code> | 0.0.0 | | ||
@@ -659,3 +881,3 @@ | ||
| | ------------- | ----------------------------------------------------------- | ----- | | ||
| | **`receive`** | <code><a href="#permissionstate">PermissionState</a></code> | 0.0.1 | | ||
| | **`receive`** | <code><a href="#permissionstate">PermissionState</a></code> | 0.0.0 | | ||
@@ -674,3 +896,3 @@ | ||
| | ------------------ | ----------------------------------------------------- | ----- | | ||
| | **`notification`** | <code><a href="#notification">Notification</a></code> | 0.0.1 | | ||
| | **`notification`** | <code><a href="#notification">Notification</a></code> | 0.0.0 | | ||
@@ -682,7 +904,7 @@ | ||
| | -------------- | -------------------- | ----------------------------------------------------------------------- | ----- | | ||
| | **`body`** | <code>string</code> | The notification payload. | 0.0.1 | | ||
| | **`data`** | <code>unknown</code> | Any additional data that was included in the push notification payload. | 0.0.1 | | ||
| | **`id`** | <code>string</code> | The notification identifier. | 0.0.1 | | ||
| | **`subtitle`** | <code>string</code> | The notification subtitle. Only available for iOS. | 0.0.1 | | ||
| | **`title`** | <code>string</code> | The notification title. | 0.0.1 | | ||
| | **`body`** | <code>string</code> | The notification payload. | 0.0.0 | | ||
| | **`data`** | <code>unknown</code> | Any additional data that was included in the push notification payload. | 0.0.0 | | ||
| | **`id`** | <code>string</code> | The notification identifier. | 0.0.0 | | ||
| | **`subtitle`** | <code>string</code> | The notification subtitle. Only available for iOS. | 0.0.0 | | ||
| | **`title`** | <code>string</code> | The notification title. | 0.0.0 | | ||
@@ -694,5 +916,5 @@ | ||
| | ------------------ | ----------------------------------------------------- | ---------------------------------------------------------------- | ----- | | ||
| | **`actionId`** | <code>string</code> | The action performed on the notification. | 0.0.1 | | ||
| | **`inputValue`** | <code>string</code> | Text entered on the notification action. Only available for iOS. | 0.0.1 | | ||
| | **`notification`** | <code><a href="#notification">Notification</a></code> | The notification in which the action was performed. | 0.0.1 | | ||
| | **`actionId`** | <code>string</code> | The action performed on the notification. | 0.0.0 | | ||
| | **`inputValue`** | <code>string</code> | Text entered on the notification action. Only available for iOS. | 0.0.0 | | ||
| | **`notification`** | <code><a href="#notification">Notification</a></code> | The notification in which the action was performed. | 0.0.0 | | ||
@@ -725,2 +947,12 @@ | ||
| #### LogLevel | ||
| | Members | Value | Since | | ||
| | ------------- | ---------------------- | ----- | | ||
| | **`Debug`** | <code>'DEBUG'</code> | 0.0.1 | | ||
| | **`Info`** | <code>'INFO'</code> | 0.0.1 | | ||
| | **`Warning`** | <code>'WARNING'</code> | 0.0.1 | | ||
| | **`Error`** | <code>'ERROR'</code> | 0.0.1 | | ||
| #### CampaignType | ||
@@ -730,10 +962,20 @@ | ||
| | ---------------------- | -------------------------------- | ----- | | ||
| | **`PushNotification`** | <code>'PUSH_NOTIFICATION'</code> | 0.0.1 | | ||
| | **`InAppMessage`** | <code>'IN_APP_MESSAGE'</code> | 0.0.1 | | ||
| | **`WebMessage`** | <code>'WEB_MESSAGE'</code> | 0.0.1 | | ||
| | **`All`** | <code>'ALL'</code> | 0.0.1 | | ||
| | **`Unknown`** | <code>'UNKNOWN'</code> | 0.0.1 | | ||
| | **`PushNotification`** | <code>'PUSH_NOTIFICATION'</code> | 0.0.0 | | ||
| | **`InAppMessage`** | <code>'IN_APP_MESSAGE'</code> | 0.0.0 | | ||
| | **`WebMessage`** | <code>'WEB_MESSAGE'</code> | 0.0.0 | | ||
| | **`All`** | <code>'ALL'</code> | 0.0.0 | | ||
| | **`Unknown`** | <code>'UNKNOWN'</code> | 0.0.0 | | ||
| </docgen-api> | ||
| ## Development | ||
| ### Release | ||
| Run the following command on `origin/main` to bump version, update changelog, create a tag, push the changes to the remote repository and publish the package to npm: | ||
| ```bash | ||
| npm run release && git push --follow-tags origin main && npm publish | ||
| ``` | ||
| ## Changelog | ||
@@ -740,0 +982,0 @@ |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Fixed alerts
New author
Supply chain riskA new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by52.02%
267809
- Number of package files
- increased by17.86%
66
- Lines of code
- increased by64.14%
4545
- Number of lines in readme file
- increased by34.04%
953
- Number of medium supply chain risk alerts
- decreased by-14.29%
6
No dependency changes