Skip to content

feat: add IDisplayableOSNotification type #133

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sherwinski merged 3 commits into from
Feb 27, 2026
Merged

feat: add IDisplayableOSNotification type #133

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
44de724
feat: add `IDisplayableOSNotification` type
sherwinski Feb 27, 2026
f8bc081
chore: sync package versions from downstream
sherwinski Feb 27, 2026
6b4501b
build: add `IDisplayableOSNotification` type
sherwinski Feb 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion outputs/onesignal-ngx/bundles/onesignal-ngx.umd.js.map
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion outputs/onesignal-ngx/bundles/onesignal-ngx.umd.min.js.map
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion outputs/onesignal-ngx/esm2015/lib/onesignal-ngx.service.js
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion outputs/onesignal-ngx/fesm2015/onesignal-ngx.js.map
View file
Open in desktop

Large diffs are not rendered by default.

5 changes: 4 additions & 1 deletion outputs/onesignal-ngx/lib/onesignal-ngx.service.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,9 @@ export interface IOSNotificationActionButton {
*/
readonly launchURL?: string;
}
export interface IDisplayableOSNotification extends IOSNotification {
display(): void;
}
export interface NotificationClickResult {
readonly actionId?: string;
readonly url?: string;
Expand All @@ -117,7 +120,7 @@ export declare type NotificationEventTypeMap = {
'permissionPromptDisplay': void;
};
export interface NotificationForegroundWillDisplayEvent {
readonly notification: IOSNotification;
readonly notification: IDisplayableOSNotification;
preventDefault(): void;
}
export interface NotificationDismissEvent {
Expand Down
2 changes: 1 addition & 1 deletion outputs/onesignal-ngx/onesignal-ngx.metadata.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"__symbolic":"module","version":4,"metadata":{"AutoPromptOptions":{"__symbolic":"interface"},"IOneSignalAutoPromptOptions":{"__symbolic":"interface"},"IOneSignalCategories":{"__symbolic":"interface"},"IOneSignalTagCategory":{"__symbolic":"interface"},"PushSubscriptionNamespaceProperties":{"__symbolic":"interface"},"SubscriptionChangeEvent":{"__symbolic":"interface"},"NotificationEventName":{"__symbolic":"interface"},"SlidedownEventName":{"__symbolic":"interface"},"OneSignalDeferredLoadedCallback":{"__symbolic":"interface"},"IOSNotification":{"__symbolic":"interface"},"IOSNotificationActionButton":{"__symbolic":"interface"},"NotificationClickResult":{"__symbolic":"interface"},"NotificationEventTypeMap":{"__symbolic":"interface"},"NotificationForegroundWillDisplayEvent":{"__symbolic":"interface"},"NotificationDismissEvent":{"__symbolic":"interface"},"NotificationClickEvent":{"__symbolic":"interface"},"UserChangeEvent":{"__symbolic":"interface"},"UserNamespaceProperties":{"__symbolic":"interface"},"IInitObject":{"__symbolic":"interface"},"IOneSignalOneSignal":{"__symbolic":"interface"},"IOneSignalNotifications":{"__symbolic":"interface"},"IOneSignalSlidedown":{"__symbolic":"interface"},"IOneSignalDebug":{"__symbolic":"interface"},"IOneSignalSession":{"__symbolic":"interface"},"IOneSignalUser":{"__symbolic":"interface"},"IOneSignalPushSubscription":{"__symbolic":"interface"},"OneSignal":{"__symbolic":"class","decorators":[{"__symbolic":"call","expression":{"__symbolic":"reference","module":"@angular/core","name":"Injectable","line":952,"character":1},"arguments":[{"providedIn":"root"}]}],"members":{"__ctor__":[{"__symbolic":"constructor"}],"init":[{"__symbolic":"method"}]},"statics":{"ɵprov":{}}},"OnesignalNgxComponent":{"__symbolic":"class","decorators":[{"__symbolic":"call","expression":{"__symbolic":"reference","module":"@angular/core","name":"Component","line":2,"character":1},"arguments":[{"selector":"onesignal-onesignal-ngx","template":"\n <p>\n onesignal-ngx works!\n </p>\n ","styles":[]}]}],"members":{"__ctor__":[{"__symbolic":"constructor"}],"ngOnInit":[{"__symbolic":"method"}]}},"OnesignalNgxModule":{"__symbolic":"class","decorators":[{"__symbolic":"call","expression":{"__symbolic":"reference","module":"@angular/core","name":"NgModule","line":5,"character":1},"arguments":[{"declarations":[{"__symbolic":"reference","name":"OnesignalNgxComponent"}],"imports":[],"exports":[{"__symbolic":"reference","name":"OnesignalNgxComponent"}]}]}],"members":{}}},"origins":{"AutoPromptOptions":"./lib/onesignal-ngx.service","IOneSignalAutoPromptOptions":"./lib/onesignal-ngx.service","IOneSignalCategories":"./lib/onesignal-ngx.service","IOneSignalTagCategory":"./lib/onesignal-ngx.service","PushSubscriptionNamespaceProperties":"./lib/onesignal-ngx.service","SubscriptionChangeEvent":"./lib/onesignal-ngx.service","NotificationEventName":"./lib/onesignal-ngx.service","SlidedownEventName":"./lib/onesignal-ngx.service","OneSignalDeferredLoadedCallback":"./lib/onesignal-ngx.service","IOSNotification":"./lib/onesignal-ngx.service","IOSNotificationActionButton":"./lib/onesignal-ngx.service","NotificationClickResult":"./lib/onesignal-ngx.service","NotificationEventTypeMap":"./lib/onesignal-ngx.service","NotificationForegroundWillDisplayEvent":"./lib/onesignal-ngx.service","NotificationDismissEvent":"./lib/onesignal-ngx.service","NotificationClickEvent":"./lib/onesignal-ngx.service","UserChangeEvent":"./lib/onesignal-ngx.service","UserNamespaceProperties":"./lib/onesignal-ngx.service","IInitObject":"./lib/onesignal-ngx.service","IOneSignalOneSignal":"./lib/onesignal-ngx.service","IOneSignalNotifications":"./lib/onesignal-ngx.service","IOneSignalSlidedown":"./lib/onesignal-ngx.service","IOneSignalDebug":"./lib/onesignal-ngx.service","IOneSignalSession":"./lib/onesignal-ngx.service","IOneSignalUser":"./lib/onesignal-ngx.service","IOneSignalPushSubscription":"./lib/onesignal-ngx.service","OneSignal":"./lib/onesignal-ngx.service","OnesignalNgxComponent":"./lib/onesignal-ngx.component","OnesignalNgxModule":"./lib/onesignal-ngx.module"},"importAs":"onesignal-ngx"}
{"__symbolic":"module","version":4,"metadata":{"AutoPromptOptions":{"__symbolic":"interface"},"IOneSignalAutoPromptOptions":{"__symbolic":"interface"},"IOneSignalCategories":{"__symbolic":"interface"},"IOneSignalTagCategory":{"__symbolic":"interface"},"PushSubscriptionNamespaceProperties":{"__symbolic":"interface"},"SubscriptionChangeEvent":{"__symbolic":"interface"},"NotificationEventName":{"__symbolic":"interface"},"SlidedownEventName":{"__symbolic":"interface"},"OneSignalDeferredLoadedCallback":{"__symbolic":"interface"},"IOSNotification":{"__symbolic":"interface"},"IOSNotificationActionButton":{"__symbolic":"interface"},"IDisplayableOSNotification":{"__symbolic":"interface"},"NotificationClickResult":{"__symbolic":"interface"},"NotificationEventTypeMap":{"__symbolic":"interface"},"NotificationForegroundWillDisplayEvent":{"__symbolic":"interface"},"NotificationDismissEvent":{"__symbolic":"interface"},"NotificationClickEvent":{"__symbolic":"interface"},"UserChangeEvent":{"__symbolic":"interface"},"UserNamespaceProperties":{"__symbolic":"interface"},"IInitObject":{"__symbolic":"interface"},"IOneSignalOneSignal":{"__symbolic":"interface"},"IOneSignalNotifications":{"__symbolic":"interface"},"IOneSignalSlidedown":{"__symbolic":"interface"},"IOneSignalDebug":{"__symbolic":"interface"},"IOneSignalSession":{"__symbolic":"interface"},"IOneSignalUser":{"__symbolic":"interface"},"IOneSignalPushSubscription":{"__symbolic":"interface"},"OneSignal":{"__symbolic":"class","decorators":[{"__symbolic":"call","expression":{"__symbolic":"reference","module":"@angular/core","name":"Injectable","line":956,"character":1},"arguments":[{"providedIn":"root"}]}],"members":{"__ctor__":[{"__symbolic":"constructor"}],"init":[{"__symbolic":"method"}]},"statics":{"ɵprov":{}}},"OnesignalNgxComponent":{"__symbolic":"class","decorators":[{"__symbolic":"call","expression":{"__symbolic":"reference","module":"@angular/core","name":"Component","line":2,"character":1},"arguments":[{"selector":"onesignal-onesignal-ngx","template":"\n <p>\n onesignal-ngx works!\n </p>\n ","styles":[]}]}],"members":{"__ctor__":[{"__symbolic":"constructor"}],"ngOnInit":[{"__symbolic":"method"}]}},"OnesignalNgxModule":{"__symbolic":"class","decorators":[{"__symbolic":"call","expression":{"__symbolic":"reference","module":"@angular/core","name":"NgModule","line":5,"character":1},"arguments":[{"declarations":[{"__symbolic":"reference","name":"OnesignalNgxComponent"}],"imports":[],"exports":[{"__symbolic":"reference","name":"OnesignalNgxComponent"}]}]}],"members":{}}},"origins":{"AutoPromptOptions":"./lib/onesignal-ngx.service","IOneSignalAutoPromptOptions":"./lib/onesignal-ngx.service","IOneSignalCategories":"./lib/onesignal-ngx.service","IOneSignalTagCategory":"./lib/onesignal-ngx.service","PushSubscriptionNamespaceProperties":"./lib/onesignal-ngx.service","SubscriptionChangeEvent":"./lib/onesignal-ngx.service","NotificationEventName":"./lib/onesignal-ngx.service","SlidedownEventName":"./lib/onesignal-ngx.service","OneSignalDeferredLoadedCallback":"./lib/onesignal-ngx.service","IOSNotification":"./lib/onesignal-ngx.service","IOSNotificationActionButton":"./lib/onesignal-ngx.service","IDisplayableOSNotification":"./lib/onesignal-ngx.service","NotificationClickResult":"./lib/onesignal-ngx.service","NotificationEventTypeMap":"./lib/onesignal-ngx.service","NotificationForegroundWillDisplayEvent":"./lib/onesignal-ngx.service","NotificationDismissEvent":"./lib/onesignal-ngx.service","NotificationClickEvent":"./lib/onesignal-ngx.service","UserChangeEvent":"./lib/onesignal-ngx.service","UserNamespaceProperties":"./lib/onesignal-ngx.service","IInitObject":"./lib/onesignal-ngx.service","IOneSignalOneSignal":"./lib/onesignal-ngx.service","IOneSignalNotifications":"./lib/onesignal-ngx.service","IOneSignalSlidedown":"./lib/onesignal-ngx.service","IOneSignalDebug":"./lib/onesignal-ngx.service","IOneSignalSession":"./lib/onesignal-ngx.service","IOneSignalUser":"./lib/onesignal-ngx.service","IOneSignalPushSubscription":"./lib/onesignal-ngx.service","OneSignal":"./lib/onesignal-ngx.service","OnesignalNgxComponent":"./lib/onesignal-ngx.component","OnesignalNgxModule":"./lib/onesignal-ngx.module"},"importAs":"onesignal-ngx"}
20 changes: 10 additions & 10 deletions outputs/onesignal-ngx/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion outputs/onesignal-ngx/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "onesignal-ngx",
"version": "2.3.2",
"version": "2.4.0",
"description": "This is a JavaScript module that can be used to easily include OneSignal code in a website or app that uses Angular for its front-end codebase.",
"contributors": [
{
Expand Down
6 changes: 5 additions & 1 deletion outputs/react/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,6 +217,10 @@ export interface IOSNotificationActionButton {
readonly launchURL?: string;
}

export interface IDisplayableOSNotification extends IOSNotification {
display(): void;
}

export interface NotificationClickResult {
readonly actionId?: string;
readonly url?: string;
Expand All @@ -231,7 +235,7 @@ export type NotificationEventTypeMap = {
};

export interface NotificationForegroundWillDisplayEvent {
readonly notification: IOSNotification;
readonly notification: IDisplayableOSNotification;
preventDefault(): void;
}

Expand Down
4 changes: 2 additions & 2 deletions outputs/react/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion outputs/react/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "react-onesignal",
"version": "3.4.6",
"version": "3.5.0",
"description": "React OneSignal Module: Make it easy to integrate OneSignal with your React App!",
"contributors": [
{
Expand Down
6 changes: 5 additions & 1 deletion outputs/vue/v2/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,10 @@ export interface IOSNotificationActionButton {
readonly launchURL?: string;
}

export interface IDisplayableOSNotification extends IOSNotification {
display(): void;
}

export interface NotificationClickResult {
readonly actionId?: string;
readonly url?: string;
Expand All @@ -240,7 +244,7 @@ export type NotificationEventTypeMap = {
};

export interface NotificationForegroundWillDisplayEvent {
readonly notification: IOSNotification;
readonly notification: IDisplayableOSNotification;
preventDefault(): void;
}

Expand Down
4 changes: 2 additions & 2 deletions outputs/vue/v2/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion outputs/vue/v2/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "onesignal-vue",
"version": "2.5.4",
"version": "2.6.0",
"description": "Vue OneSignal Plugin: Make it easy to integrate OneSignal with your Vue App!",
"type": "module",
"contributors": [
Expand Down
6 changes: 5 additions & 1 deletion outputs/vue/v3/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,6 +225,10 @@ export interface IOSNotificationActionButton {
readonly launchURL?: string;
}

export interface IDisplayableOSNotification extends IOSNotification {
display(): void;
}

export interface NotificationClickResult {
readonly actionId?: string;
readonly url?: string;
Expand All @@ -239,7 +243,7 @@ export type NotificationEventTypeMap = {
};

export interface NotificationForegroundWillDisplayEvent {
readonly notification: IOSNotification;
readonly notification: IDisplayableOSNotification;
preventDefault(): void;
}

Expand Down
4 changes: 2 additions & 2 deletions outputs/vue/v3/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion outputs/vue/v3/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@onesignal/onesignal-vue3",
"version": "2.3.3",
"version": "2.4.0",
"description": "Vue 3 OneSignal Plugin: Make it easy to integrate OneSignal with your Vue App!",
"type": "module",
"contributors": [
Expand Down
2 changes: 2 additions & 0 deletions src/managers/TypingsWriterManager.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import {
NOTIFICATION_DISMISS_EVENT,
NOTIFICATION_EVENT_NAME,
NOTIFICATION_EVENT_TYPE_MAP,
DISPLAYABLE_OS_NOTIFICATION,
NOTIFICATION_FOREGROUND_WILL_DISPLAY_EVENT,
ONESIGNAL_DEFERRED_CALLBACK,
OS_NOTIFICATION,
Expand Down Expand Up @@ -101,6 +102,7 @@ export class TypingsWriterManager extends CodeWriter {
this.writeLine(prefix + ONESIGNAL_DEFERRED_CALLBACK);
this.writeLine(prefix + OS_NOTIFICATION);
this.writeLine(prefix + NOTIFICATION_BUTTON_ACTION_BUTTON);
this.writeLine(prefix + DISPLAYABLE_OS_NOTIFICATION);
this.writeLine(prefix + NOTIFICATION_CLICK_RESULT);
this.writeLine(prefix + NOTIFICATION_EVENT_TYPE_MAP);
this.writeLine(prefix + NOTIFICATION_FOREGROUND_WILL_DISPLAY_EVENT);
Expand Down
4 changes: 2 additions & 2 deletions src/scaffolds/angular-workspace/projects/onesignal-ngx/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion src/scaffolds/angular-workspace/projects/onesignal-ngx/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "onesignal-ngx",
"version": "2.3.2",
"version": "2.4.0",
"description": "This is a JavaScript module that can be used to easily include OneSignal code in a website or app that uses Angular for its front-end codebase.",
"contributors": [
{
Expand Down
6 changes: 5 additions & 1 deletion src/scaffolds/angular-workspace/projects/onesignal-ngx/src/lib/onesignal-ngx.service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,10 @@ export interface IOSNotificationActionButton {
readonly launchURL?: string;
}

export interface IDisplayableOSNotification extends IOSNotification {
display(): void;
Copy link
Collaborator

@fadi-george fadi-george Feb 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: could add tsdoc for this method

}

export interface NotificationClickResult {
readonly actionId?: string;
readonly url?: string;
Expand All @@ -104,7 +108,7 @@ export type NotificationEventTypeMap = {
};

export interface NotificationForegroundWillDisplayEvent {
readonly notification: IOSNotification;
readonly notification: IDisplayableOSNotification;
preventDefault(): void;
}

Expand Down
6 changes: 5 additions & 1 deletion src/snippets/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,12 @@ export const NOTIFICATION_CLICK_RESULT = `export interface NotificationClickResu
readonly url?: string;
}
`;
export const DISPLAYABLE_OS_NOTIFICATION = `export interface IDisplayableOSNotification extends IOSNotification {
display(): void;
}
`;
export const NOTIFICATION_FOREGROUND_WILL_DISPLAY_EVENT = `export interface NotificationForegroundWillDisplayEvent {
readonly notification: IOSNotification;
readonly notification: IDisplayableOSNotification;
preventDefault(): void;
}
`;
Expand Down
4 changes: 2 additions & 2 deletions src/static/react/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion src/static/react/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "react-onesignal",
"version": "3.4.6",
"version": "3.5.0",
"description": "React OneSignal Module: Make it easy to integrate OneSignal with your React App!",
"contributors": [
{
Expand Down
4 changes: 2 additions & 2 deletions src/static/vue/v2/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion src/static/vue/v2/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "onesignal-vue",
"version": "2.5.4",
"version": "2.6.0",
"description": "Vue OneSignal Plugin: Make it easy to integrate OneSignal with your Vue App!",
"type": "module",
"contributors": [
Expand Down
4 changes: 2 additions & 2 deletions src/static/vue/v3/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion src/static/vue/v3/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@onesignal/onesignal-vue3",
"version": "2.3.3",
"version": "2.4.0",
"description": "Vue 3 OneSignal Plugin: Make it easy to integrate OneSignal with your Vue App!",
"type": "module",
"contributors": [
Expand Down