Skip to content

Commit 8fbae42

Browse files
fadi-georgefadi-george
committed
fix: update init object interface (#130)
1 parent 35c2980 commit 8fbae42

File tree

12 files changed

+49
-55
lines changed

12 files changed

+49
-55
lines changed

‎outputs/onesignal-ngx/bundles/onesignal-ngx.umd.js.map‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎outputs/onesignal-ngx/bundles/onesignal-ngx.umd.min.js.map‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎outputs/onesignal-ngx/esm2015/lib/onesignal-ngx.service.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎outputs/onesignal-ngx/fesm2015/onesignal-ngx.js.map‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎outputs/onesignal-ngx/lib/onesignal-ngx.service.d.ts‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -136,8 +136,9 @@ export declare type UserNamespaceProperties = {
136136
};
137137
export interface IInitObject {
138138
appId: string;
139-
subdomainName?: string;
140139
requiresUserPrivacyConsent?: boolean;
140+
safari_web_id?: string;
141+
subdomainName?: string;
141142
promptOptions?: {
142143
slidedown: {
143144
prompts: {
@@ -152,7 +153,7 @@ export interface IInitObject {
152153
* @example
153154
* categories: [{ tag: 'local_news', label: 'Local News' }] // The user will be tagged with local_news but will see "Local News" in the prompt.
154155
*/
155-
categories: {
156+
categories?: {
156157
/** Should identify the action. */
157158
tag: string;
158159
/** What the user will see. */
@@ -177,7 +178,7 @@ export interface IInitObject {
177178
/** Triggers the opt-in. Up to 15 characters. */
178179
acceptButton?: string;
179180
/** Cancels opt-in. Up to 15 characters. */
180-
cancelMessage?: string;
181+
cancelButton?: string;
181182
/** The message of the confirmation prompt displayed after the email and/or phone number is provided. Up to 90 characters. */
182183
confirmMessage?: string;
183184
/** Identifies the email text field. Up to 15 characters. */
@@ -307,17 +308,15 @@ export interface IInitObject {
307308
};
308309
autoResubscribe?: boolean;
309310
autoRegister?: boolean;
310-
notificationClickHandlerMatch?: string;
311-
notificationClickHandlerAction?: string;
311+
notificationClickHandlerMatch?: 'exact' | 'origin';
312+
notificationClickHandlerAction?: 'navigate' | 'focus';
312313
path?: string;
313314
serviceWorkerParam?: {
314315
scope: string;
315316
};
316317
serviceWorkerPath?: string;
317318
serviceWorkerOverrideForTypical?: boolean;
318-
serviceWorkerUpdaterPath?: string;
319-
allowLocalhostAsSecureOrigin?: boolean;
320-
[key: string]: any;
319+
[key: string]: unknown;
321320
}
322321
export interface IOneSignalOneSignal {
323322
Slidedown: IOneSignalSlidedown;

‎outputs/onesignal-ngx/onesignal-ngx.metadata.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +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":947,"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"}
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":946,"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"}

‎outputs/react/index.ts‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -253,8 +253,9 @@ export type UserNamespaceProperties = {
253253

254254
export interface IInitObject {
255255
appId: string;
256-
subdomainName?: string;
257256
requiresUserPrivacyConsent?: boolean;
257+
safari_web_id?: string;
258+
subdomainName?: string;
258259
promptOptions?: {
259260
slidedown: {
260261
prompts: {
@@ -270,7 +271,7 @@ export interface IInitObject {
270271
* @example
271272
* categories: [{ tag: 'local_news', label: 'Local News' }] // The user will be tagged with local_news but will see "Local News" in the prompt.
272273
*/
273-
categories: {
274+
categories?: {
274275
/** Should identify the action. */
275276
tag: string;
276277

@@ -301,7 +302,7 @@ export interface IInitObject {
301302
acceptButton?: string;
302303

303304
/** Cancels opt-in. Up to 15 characters. */
304-
cancelMessage?: string;
305+
cancelButton?: string;
305306

306307
/** The message of the confirmation prompt displayed after the email and/or phone number is provided. Up to 90 characters. */
307308
confirmMessage?: string;
@@ -450,15 +451,13 @@ export interface IInitObject {
450451
};
451452
autoResubscribe?: boolean;
452453
autoRegister?: boolean;
453-
notificationClickHandlerMatch?: string;
454-
notificationClickHandlerAction?: string;
454+
notificationClickHandlerMatch?: 'exact' | 'origin';
455+
notificationClickHandlerAction?: 'navigate' | 'focus';
455456
path?: string;
456457
serviceWorkerParam?: { scope: string };
457458
serviceWorkerPath?: string;
458459
serviceWorkerOverrideForTypical?: boolean;
459-
serviceWorkerUpdaterPath?: string;
460-
allowLocalhostAsSecureOrigin?: boolean;
461-
[key: string]: any;
460+
[key: string]: unknown;
462461
}
463462

464463
export interface IOneSignalOneSignal {

‎outputs/vue/v2/index.ts‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -262,8 +262,9 @@ export type UserNamespaceProperties = {
262262

263263
export interface IInitObject {
264264
appId: string;
265-
subdomainName?: string;
266265
requiresUserPrivacyConsent?: boolean;
266+
safari_web_id?: string;
267+
subdomainName?: string;
267268
promptOptions?: {
268269
slidedown: {
269270
prompts: {
@@ -279,7 +280,7 @@ export interface IInitObject {
279280
* @example
280281
* categories: [{ tag: 'local_news', label: 'Local News' }] // The user will be tagged with local_news but will see "Local News" in the prompt.
281282
*/
282-
categories: {
283+
categories?: {
283284
/** Should identify the action. */
284285
tag: string;
285286

@@ -310,7 +311,7 @@ export interface IInitObject {
310311
acceptButton?: string;
311312

312313
/** Cancels opt-in. Up to 15 characters. */
313-
cancelMessage?: string;
314+
cancelButton?: string;
314315

315316
/** The message of the confirmation prompt displayed after the email and/or phone number is provided. Up to 90 characters. */
316317
confirmMessage?: string;
@@ -459,15 +460,13 @@ export interface IInitObject {
459460
};
460461
autoResubscribe?: boolean;
461462
autoRegister?: boolean;
462-
notificationClickHandlerMatch?: string;
463-
notificationClickHandlerAction?: string;
463+
notificationClickHandlerMatch?: 'exact' | 'origin';
464+
notificationClickHandlerAction?: 'navigate' | 'focus';
464465
path?: string;
465466
serviceWorkerParam?: { scope: string };
466467
serviceWorkerPath?: string;
467468
serviceWorkerOverrideForTypical?: boolean;
468-
serviceWorkerUpdaterPath?: string;
469-
allowLocalhostAsSecureOrigin?: boolean;
470-
[key: string]: any;
469+
[key: string]: unknown;
471470
}
472471

473472
export interface IOneSignalOneSignal {

‎outputs/vue/v3/index.ts‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -261,8 +261,9 @@ export type UserNamespaceProperties = {
261261

262262
export interface IInitObject {
263263
appId: string;
264-
subdomainName?: string;
265264
requiresUserPrivacyConsent?: boolean;
265+
safari_web_id?: string;
266+
subdomainName?: string;
266267
promptOptions?: {
267268
slidedown: {
268269
prompts: {
@@ -278,7 +279,7 @@ export interface IInitObject {
278279
* @example
279280
* categories: [{ tag: 'local_news', label: 'Local News' }] // The user will be tagged with local_news but will see "Local News" in the prompt.
280281
*/
281-
categories: {
282+
categories?: {
282283
/** Should identify the action. */
283284
tag: string;
284285

@@ -309,7 +310,7 @@ export interface IInitObject {
309310
acceptButton?: string;
310311

311312
/** Cancels opt-in. Up to 15 characters. */
312-
cancelMessage?: string;
313+
cancelButton?: string;
313314

314315
/** The message of the confirmation prompt displayed after the email and/or phone number is provided. Up to 90 characters. */
315316
confirmMessage?: string;
@@ -458,15 +459,13 @@ export interface IInitObject {
458459
};
459460
autoResubscribe?: boolean;
460461
autoRegister?: boolean;
461-
notificationClickHandlerMatch?: string;
462-
notificationClickHandlerAction?: string;
462+
notificationClickHandlerMatch?: 'exact' | 'origin';
463+
notificationClickHandlerAction?: 'navigate' | 'focus';
463464
path?: string;
464465
serviceWorkerParam?: { scope: string };
465466
serviceWorkerPath?: string;
466467
serviceWorkerOverrideForTypical?: boolean;
467-
serviceWorkerUpdaterPath?: string;
468-
allowLocalhostAsSecureOrigin?: boolean;
469-
[key: string]: any;
468+
[key: string]: unknown;
470469
}
471470

472471
export interface IOneSignalOneSignal {

‎package.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
"main": "index.js",
66
"scripts": {
77
"lint": "eslint . --ext .ts",
8-
"build": "./scripts/build",
9-
"build:outputs": "npm run build && ./scripts/copy-build-to-outputs",
8+
"build": "./scripts/build.sh",
9+
"build:outputs": "npm run build && ./scripts/copy-build-to-outputs.sh",
1010
"prepare": "husky"
1111
},
1212
"keywords": [

0 commit comments

Comments
 (0)