@ua/capacitor-airship - npm Package Compare versions

Comparing version 2.2.0 to 2.3.0

dist/esm/AirshipRoot.d.ts

@@ -15,2 +15,4 @@ import type { PluginListenerHandle } from '@capacitor/core';
 import type { AirshipConfig, DeepLinkEvent } from './types';
+import { AirshipLiveActivityManager } from './AirshipLiveActivityManager';
+import { AirshipLiveUpdateManager } from './AirshipLiveUpdateManager';
 /**
@@ -32,2 +34,10 @@ * Airship
     readonly featureFlagManager: AirshipFeatureFlagManager;
+    /**
+     * iOS only accessors
+     */
+    readonly iOS: AirshipRootIOS;
+    /**
+     * iOS only accessors
+     */
+    readonly android: AirshipRootAndroid;
     constructor(plugin: AirshipPluginWrapper);
@@ -52,1 +62,9 @@ /**
 }
+export declare class AirshipRootIOS {
+    readonly liveActivityManager: AirshipLiveActivityManager;
+    constructor(plugin: AirshipPluginWrapper);
+}
+export declare class AirshipRootAndroid {
+    readonly liveUpdateManager: AirshipLiveUpdateManager;
+    constructor(plugin: AirshipPluginWrapper);
+}

dist/esm/AirshipRoot.js

@@ -13,2 +13,4 @@ import { AirshipActions } from './AirshipActions';
 import { EventType } from './EventType';
+import { AirshipLiveActivityManager } from './AirshipLiveActivityManager';
+import { AirshipLiveUpdateManager } from './AirshipLiveUpdateManager';
 /**
@@ -31,2 +33,4 @@ * Airship
         this.featureFlagManager = new AirshipFeatureFlagManager(plugin);
+        this.iOS = new AirshipRootIOS(plugin);
+        this.android = new AirshipRootAndroid(plugin);
     }
@@ -57,2 +61,12 @@ /**
 }
+export class AirshipRootIOS {
+    constructor(plugin) {
+        this.liveActivityManager = new AirshipLiveActivityManager(plugin);
+    }
+}
+export class AirshipRootAndroid {
+    constructor(plugin) {
+        this.liveUpdateManager = new AirshipLiveUpdateManager(plugin);
+    }
+}
 //# sourceMappingURL=AirshipRoot.js.map

dist/esm/EventType.d.ts

@@ -1,2 +0,2 @@
-import type { ChannelCreatedEvent, NotificationResponseEvent, PushReceivedEvent, DeepLinkEvent, MessageCenterUpdatedEvent, PushNotificationStatusChangedEvent, iOS, DisplayMessageCenterEvent, DisplayPreferenceCenterEvent, PushTokenReceivedEvent } from './types';
+import type { ChannelCreatedEvent, NotificationResponseEvent, PushReceivedEvent, DeepLinkEvent, MessageCenterUpdatedEvent, PushNotificationStatusChangedEvent, iOS, DisplayMessageCenterEvent, DisplayPreferenceCenterEvent, PushTokenReceivedEvent, LiveActivitiesUpdatedEvent } from './types';
 export declare enum EventType {
@@ -12,3 +12,4 @@ ChannelCreated = "channel_created",
     PushTokenReceived = "push_token_received",
-    IOSAuthorizedNotificationSettingsChanged = "ios_authorized_notification_settings_changed"
+    IOSAuthorizedNotificationSettingsChanged = "ios_authorized_notification_settings_changed",
+    IOSLiveActivitiesUpdated = "ios_live_activities_updated"
 }
@@ -26,2 +27,3 @@ export interface EventTypeMap {
     [EventType.PushTokenReceived]: PushTokenReceivedEvent;
+    [EventType.IOSLiveActivitiesUpdated]: LiveActivitiesUpdatedEvent;
 }

dist/esm/EventType.js

@@ -13,3 +13,4 @@ export var EventType;
     EventType["IOSAuthorizedNotificationSettingsChanged"] = "ios_authorized_notification_settings_changed";
+    EventType["IOSLiveActivitiesUpdated"] = "ios_live_activities_updated";
 })(EventType || (EventType = {}));
 //# sourceMappingURL=EventType.js.map

dist/esm/index.d.ts

@@ -13,2 +13,4 @@ import { AirshipRoot } from './AirshipRoot';
 export { AirshipFeatureFlagManager } from './AirshipFeatureFlagManager';
+export { AirshipLiveActivityManager } from './AirshipLiveActivityManager';
+export { AirshipLiveUpdateManager } from './AirshipLiveUpdateManager';
 export { AirshipPush, AirshipPushAndroid, AirshipPushIOS } from './AirshipPush';
@@ -15,0 +17,0 @@ export { SubscriptionListEditor } from './SubscriptionListEditor';

dist/esm/index.js

@@ -15,2 +15,4 @@ import { registerPlugin } from '@capacitor/core';
 export { AirshipFeatureFlagManager } from './AirshipFeatureFlagManager';
+export { AirshipLiveActivityManager } from './AirshipLiveActivityManager';
+export { AirshipLiveUpdateManager } from './AirshipLiveUpdateManager';
 export { AirshipPush, AirshipPushAndroid, AirshipPushIOS } from './AirshipPush';
@@ -17,0 +19,0 @@ export { SubscriptionListEditor } from './SubscriptionListEditor';

dist/esm/types.d.ts

@@ -176,2 +176,11 @@ export declare type JsonValue = string | number | boolean | null | JsonObject | JsonArray;
 /**
+ * Event fired whenever any of the Live Activities update, create, or end.
+ */
+export interface LiveActivitiesUpdatedEvent {
+    /**
+     * The Live Activities.
+     */
+    activities: LiveActivity[];
+}
+/**
  * Custom event
@@ -554,2 +563,6 @@ */
     /**
+     * Optional - The message expiration date in milliseconds.
+     */
+    expirationDate?: number;
+    /**
      * Optional - The icon url for the message.
@@ -703,1 +716,218 @@ */
 }
+/**
+ * Live Activity info.
+ */
+export interface LiveActivity {
+    /**
+     * The activity ID.
+     */
+    id: string;
+    /**
+     * The attribute types.
+     */
+    attributeTypes: string;
+    /**
+     * The content.
+     */
+    content: LiveActivityContent;
+    /**
+     * The attributes.
+     */
+    attributes: JsonObject;
+}
+/**
+ * Live Activity content.
+ */
+export interface LiveActivityContent {
+    /**
+     * The content state.
+     */
+    state: JsonObject;
+    /**
+     * Optional ISO 8601 date string that defines when the Live Activity will be stale.
+     */
+    staleDate?: string;
+    /**
+     * The relevance score.
+     */
+    relevanceScore: number;
+}
+/**
+ * Base Live Activity request.
+ */
+export interface LiveActivityRequest {
+    /**
+     * Attributes types. This should match the Activity type of your Live Activity.
+     */
+    attributesType: string;
+}
+/**
+ * Live Activity list request.
+ */
+export interface LiveActivityListRequest extends LiveActivityRequest {
+}
+/**
+ * Live Activity start request.
+ */
+export interface LiveActivityStartRequest extends LiveActivityRequest {
+    /**
+     * Dynamic content.
+     */
+    content: LiveActivityContent;
+    /**
+     * Fixed attributes.
+     */
+    attributes: JsonObject;
+}
+/**
+ * Live Activity update request.
+ */
+export interface LiveActivityUpdateRequest extends LiveActivityRequest {
+    /**
+     * The Live Activity ID to update.
+     */
+    activityId: string;
+    /**
+     * Dynamic content.
+     */
+    content: LiveActivityContent;
+}
+/**
+ * Live Activity end request.
+ */
+export interface LiveActivityEndRequest extends LiveActivityRequest {
+    /**
+     * The Live Activity ID to update.
+     */
+    activityId: string;
+    /**
+     * Dynamic content.
+     */
+    content?: LiveActivityContent;
+    /**
+     * Dismissal policy. Defaults to `LiveActivityDismissalPolicyDefault`.
+     */
+    dismissalPolicy?: LiveActivityDismissalPolicy;
+}
+export declare type LiveActivityDismissalPolicy = LiveActivityDismissalPolicyImmediate | LiveActivityDismissalPolicyDefault | LiveActivityDismissalPolicyAfterDate;
+/**
+ * Dismissal policy to immediately dismiss the Live Activity on end.
+ */
+export interface LiveActivityDismissalPolicyImmediate {
+    type: 'immediate';
+}
+/**
+ * Dismissal policy to dismiss the Live Activity after the expiration.
+ */
+export interface LiveActivityDismissalPolicyDefault {
+    type: 'default';
+}
+/**
+ * Dismissal policy to dismiss the Live Activity after a given date.
+ */
+export interface LiveActivityDismissalPolicyAfterDate {
+    type: 'after';
+    date: string;
+}
+/**
+ * Live Update info.
+ */
+export interface LiveUpdate {
+    /**
+     * The Live Update name.
+     */
+    name: string;
+    /**
+     * The Live Update type.
+     */
+    type: string;
+    /**
+     * Dynamic content.
+     */
+    content: JsonObject;
+    /**
+     *  ISO 8601 date string of the last content update.
+     */
+    lastContentUpdateTimestamp: string;
+    /**
+     * ISO 8601 date string of the last state update.
+     */
+    lastStateChangeTimestamp: string;
+    /**
+     * Optional ISO 8601 date string that defines when to end this Live Update.
+     */
+    dismissTimestamp?: string;
+}
+/**
+ * Live Update list request.
+ */
+export interface LiveUpdateListRequest {
+    type: string;
+}
+/**
+ * Live Update update request.
+ */
+export interface LiveUpdateUpdateRequest {
+    /**
+     * The Live Update name.
+     */
+    name: string;
+    /**
+     * Dynamic content.
+     */
+    content: JsonObject;
+    /**
+     * Optional ISO 8601 date string, used to filter out of order updates/
+     */
+    timestamp?: string;
+    /**
+     * Optional ISO 8601 date string that defines when to end this Live Update.
+     */
+    dismissTimestamp?: string;
+}
+/**
+ * Live Update end request.
+ */
+export interface LiveUpdateEndRequest {
+    /**
+     * The Live Update name.
+     */
+    name: string;
+    /**
+     * Dynamic content.
+     */
+    content?: JsonObject;
+    /**
+     * Optional ISO 8601 date string, used to filter out of order updates/
+     */
+    timestamp?: string;
+    /**
+     * Optional ISO 8601 date string that defines when to end this Live Update.
+     */
+    dismissTimestamp?: string;
+}
+/**
+ * Live Update start request.
+ */
+export interface LiveUpdateStartRequest {
+    /**
+     * The Live Update name.
+     */
+    name: string;
+    /**
+     * The Live Update type.
+     */
+    type: string;
+    /**
+     * Dynamic content.
+     */
+    content: JsonObject;
+    /**
+     * Optional ISO 8601 date string, used to filter out of order updates/
+     */
+    timestamp?: string;
+    /**
+     * Optional ISO 8601 date string that defines when to end this Live Update.
+     */
+    dismissTimestamp?: string;
+}

dist/plugin.cjs.js

@@ -153,2 +153,3 @@ 'use strict';
     EventType["IOSAuthorizedNotificationSettingsChanged"] = "ios_authorized_notification_settings_changed";
+    EventType["IOSLiveActivitiesUpdated"] = "ios_live_activities_updated";
 })(EventType || (EventType = {}));
@@ -1057,2 +1058,112 @@
 /**
+ * Live Activity manager.
+ */
+class AirshipLiveActivityManager {
+    constructor(plugin) {
+        this.plugin = plugin;
+    }
+    /**
+     * Lists any Live Activities for the request.
+     * @param request The request options.
+     * @returns A promise with the result.
+     */
+    list(request) {
+        return this.plugin.perform('liveActivityManager#list', request);
+    }
+    /**
+     * Lists all Live Activities.
+     * @param request The request options.
+     * @returns A promise with the result.
+     */
+    listAll() {
+        return this.plugin.perform('liveActivityManager#listAll');
+    }
+    /**
+     * Starts a Live Activity.
+     * @param request The request options.
+     * @returns A promise with the result.
+     */
+    start(request) {
+        return this.plugin.perform('liveActivityManager#start', request);
+    }
+    /**
+     * Updates a Live Activity.
+     * @param request The request options.
+     * @returns A promise with the result.
+     */
+    update(request) {
+        return this.plugin.perform('liveActivityManager#update', request);
+    }
+    /**
+     * Ends a Live Activity.
+     * @param request The request options.
+     * @returns A promise with the result.
+     */
+    end(request) {
+        return this.plugin.perform('liveActivityManager#end', request);
+    }
+    /**
+     * Adds a Live Activity listener.
+     */
+    onLiveActivityUpdates(listener) {
+        return this.plugin.addListener(EventType.IOSLiveActivitiesUpdated, listener);
+    }
+}
+
+/**
+ * Live Update manager.
+ */
+class AirshipLiveUpdateManager {
+    constructor(plugin) {
+        this.plugin = plugin;
+    }
+    /**
+     * Lists any Live Updates for the request.
+     * @param request The request options.
+     * @returns A promise with the result.
+     */
+    list(request) {
+        return this.plugin.perform('liveUpdateManager#list', request);
+    }
+    /**
+     * Lists all Live Updates.
+     * @returns A promise with the result.
+     */
+    listAll() {
+        return this.plugin.perform('liveUpdateManager#listAll');
+    }
+    /**
+     * Starts a Live Update.
+     * @param request The request options.
+     * @returns A promise with the result.
+     */
+    start(request) {
+        return this.plugin.perform('liveUpdateManager#start', request);
+    }
+    /**
+     * Updates a Live Update.
+     * @param request The request options.
+     * @returns A promise with the result.
+     */
+    update(request) {
+        return this.plugin.perform('liveUpdateManager#update', request);
+    }
+    /**
+     * Ends a Live Update.
+     * @param request The request options.
+     * @returns A promise with the result.
+     */
+    end(request) {
+        return this.plugin.perform('liveUpdateManager#end', request);
+    }
+    /**
+     * Clears all Live Updates.
+     * @returns A promise with the result.
+     */
+    clearAll() {
+        return this.plugin.perform('liveUpdateManager#clearAll');
+    }
+}
+
+/**
  * Airship
@@ -1074,2 +1185,4 @@ */
         this.featureFlagManager = new AirshipFeatureFlagManager(plugin);
+        this.iOS = new AirshipRootIOS(plugin);
+        this.android = new AirshipRootAndroid(plugin);
     }
@@ -1100,2 +1213,12 @@ /**
 }
+class AirshipRootIOS {
+    constructor(plugin) {
+        this.liveActivityManager = new AirshipLiveActivityManager(plugin);
+    }
+}
+class AirshipRootAndroid {
+    constructor(plugin) {
+        this.liveUpdateManager = new AirshipLiveUpdateManager(plugin);
+    }
+}
 
@@ -1308,2 +1431,4 @@ /// <reference types="@capacitor/cli" />
 exports.AirshipInApp = AirshipInApp;
+exports.AirshipLiveActivityManager = AirshipLiveActivityManager;
+exports.AirshipLiveUpdateManager = AirshipLiveUpdateManager;
 exports.AirshipLocale = AirshipLocale;
@@ -1310,0 +1435,0 @@ exports.AirshipMessageCenter = AirshipMessageCenter;

dist/plugin.js

@@ -150,2 +150,3 @@ var capacitorAirship = (function (exports, core) {
         EventType["IOSAuthorizedNotificationSettingsChanged"] = "ios_authorized_notification_settings_changed";
+        EventType["IOSLiveActivitiesUpdated"] = "ios_live_activities_updated";
     })(EventType || (EventType = {}));
@@ -1054,2 +1055,112 @@
     /**
+     * Live Activity manager.
+     */
+    class AirshipLiveActivityManager {
+        constructor(plugin) {
+            this.plugin = plugin;
+        }
+        /**
+         * Lists any Live Activities for the request.
+         * @param request The request options.
+         * @returns A promise with the result.
+         */
+        list(request) {
+            return this.plugin.perform('liveActivityManager#list', request);
+        }
+        /**
+         * Lists all Live Activities.
+         * @param request The request options.
+         * @returns A promise with the result.
+         */
+        listAll() {
+            return this.plugin.perform('liveActivityManager#listAll');
+        }
+        /**
+         * Starts a Live Activity.
+         * @param request The request options.
+         * @returns A promise with the result.
+         */
+        start(request) {
+            return this.plugin.perform('liveActivityManager#start', request);
+        }
+        /**
+         * Updates a Live Activity.
+         * @param request The request options.
+         * @returns A promise with the result.
+         */
+        update(request) {
+            return this.plugin.perform('liveActivityManager#update', request);
+        }
+        /**
+         * Ends a Live Activity.
+         * @param request The request options.
+         * @returns A promise with the result.
+         */
+        end(request) {
+            return this.plugin.perform('liveActivityManager#end', request);
+        }
+        /**
+         * Adds a Live Activity listener.
+         */
+        onLiveActivityUpdates(listener) {
+            return this.plugin.addListener(EventType.IOSLiveActivitiesUpdated, listener);
+        }
+    }
+
+    /**
+     * Live Update manager.
+     */
+    class AirshipLiveUpdateManager {
+        constructor(plugin) {
+            this.plugin = plugin;
+        }
+        /**
+         * Lists any Live Updates for the request.
+         * @param request The request options.
+         * @returns A promise with the result.
+         */
+        list(request) {
+            return this.plugin.perform('liveUpdateManager#list', request);
+        }
+        /**
+         * Lists all Live Updates.
+         * @returns A promise with the result.
+         */
+        listAll() {
+            return this.plugin.perform('liveUpdateManager#listAll');
+        }
+        /**
+         * Starts a Live Update.
+         * @param request The request options.
+         * @returns A promise with the result.
+         */
+        start(request) {
+            return this.plugin.perform('liveUpdateManager#start', request);
+        }
+        /**
+         * Updates a Live Update.
+         * @param request The request options.
+         * @returns A promise with the result.
+         */
+        update(request) {
+            return this.plugin.perform('liveUpdateManager#update', request);
+        }
+        /**
+         * Ends a Live Update.
+         * @param request The request options.
+         * @returns A promise with the result.
+         */
+        end(request) {
+            return this.plugin.perform('liveUpdateManager#end', request);
+        }
+        /**
+         * Clears all Live Updates.
+         * @returns A promise with the result.
+         */
+        clearAll() {
+            return this.plugin.perform('liveUpdateManager#clearAll');
+        }
+    }
+
+    /**
      * Airship
@@ -1071,2 +1182,4 @@ */
             this.featureFlagManager = new AirshipFeatureFlagManager(plugin);
+            this.iOS = new AirshipRootIOS(plugin);
+            this.android = new AirshipRootAndroid(plugin);
         }
@@ -1097,2 +1210,12 @@ /**
     }
+    class AirshipRootIOS {
+        constructor(plugin) {
+            this.liveActivityManager = new AirshipLiveActivityManager(plugin);
+        }
+    }
+    class AirshipRootAndroid {
+        constructor(plugin) {
+            this.liveUpdateManager = new AirshipLiveUpdateManager(plugin);
+        }
+    }
 
@@ -1305,2 +1428,4 @@ /// <reference types="@capacitor/cli" />
     exports.AirshipInApp = AirshipInApp;
+    exports.AirshipLiveActivityManager = AirshipLiveActivityManager;
+    exports.AirshipLiveUpdateManager = AirshipLiveUpdateManager;
     exports.AirshipLocale = AirshipLocale;
@@ -1307,0 +1432,0 @@ exports.AirshipMessageCenter = AirshipMessageCenter;

package.json

 {
   "name": "@ua/capacitor-airship",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "description": "Airship capacitor plugin",
@@ -5,0 +5,0 @@ "main": "dist/plugin.cjs.js",

No alert changes

Improved metrics

Total package byte prevSize

488492

increased by10.83%

Number of package files

87

increased by6.1%

Lines of code

6310

increased by12.72%

No dependency changes