@open-pioneer/notifier 4.8.0 → 4.9.0-dev.20261002130116

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,7 @@
1
1
  # @open-pioneer/notifier
2
2
 
3
+ ## 4.9.0-dev.20261002130116
4
+
3
5
  ## 4.8.0
4
6
 
5
7
  ### Minor Changes
@@ -82,29 +84,29 @@
82
84
  - 9f074d8: **Breaking**: The `position` property has moved from the `<Notifier />` component to package properties.
83
85
  In order to change to location of notifications, you need to customize the package properties.
84
86
 
85
- Before:
86
-
87
- ```jsx
88
- // App.jsx
89
- <Notifier position="top-right" />
90
- ```
91
-
92
- After:
93
-
94
- ```ts
95
- // app.ts
96
- const Element = createCustomElement({
97
- // ...
98
- config: {
99
- properties: {
100
- "@open-pioneer/notifier": {
101
- position: "top-right"
102
- } satisfies NotifierProperties
103
- }
104
- }
105
- // or use resolveConfig()
106
- });
107
- ```
87
+ Before:
88
+
89
+ ```jsx
90
+ // App.jsx
91
+ <Notifier position="top-right" />
92
+ ```
93
+
94
+ After:
95
+
96
+ ```ts
97
+ // app.ts
98
+ const Element = createCustomElement({
99
+ // ...
100
+ config: {
101
+ properties: {
102
+ "@open-pioneer/notifier": {
103
+ position: "top-right",
104
+ } satisfies NotifierProperties,
105
+ },
106
+ },
107
+ // or use resolveConfig()
108
+ });
109
+ ```
108
110
 
109
111
  ### Patch Changes
110
112
 
@@ -121,13 +123,13 @@
121
123
  ### Major Changes
122
124
 
123
125
  - 9477e54: Update dependencies
124
- - React 19
125
- - Vite 6
126
- - FormatJS 3
127
- - Open Pioneer Build Tools
128
- - ...
126
+ - React 19
127
+ - Vite 6
128
+ - FormatJS 3
129
+ - Open Pioneer Build Tools
130
+ - ...
129
131
 
130
- For more details, see https://github.com/open-pioneer/trails-core-packages/pull/81
132
+ For more details, see https://github.com/open-pioneer/trails-core-packages/pull/81
131
133
 
132
134
  ## 2.4.0
133
135
 
@@ -135,13 +137,13 @@
135
137
 
136
138
  - e4ba048: Introduce new convenience methods on the `NotificationService` in addition to the existing `notify()` method:
137
139
 
138
- ```js
139
- const notifier = ...; // injected
140
- notifier.success(/* ... */)
141
- notifier.info(/* ... */)
142
- notifier.warning(/* ... */)
143
- notifier.error(/* ... */)
144
- ```
140
+ ```js
141
+ const notifier = ...; // injected
142
+ notifier.success(/* ... */)
143
+ notifier.info(/* ... */)
144
+ notifier.warning(/* ... */)
145
+ notifier.error(/* ... */)
146
+ ```
145
147
 
146
148
  ### Patch Changes
147
149
 
@@ -187,7 +189,7 @@
187
189
  ### Patch Changes
188
190
 
189
191
  - 4eac7c7: Move packages into core-packages repository.
190
- - @open-pioneer/runtime@2.1.2
192
+ - @open-pioneer/runtime@2.1.2
191
193
 
192
194
  ## 0.3.0
193
195
 
@@ -1,6 +1,6 @@
1
1
  import { CreateToasterReturn } from "@chakra-ui/react";
2
2
  import { Resource } from "@open-pioneer/core";
3
- import { ApplicationContext, ServiceOptions } from "@open-pioneer/runtime";
3
+ import { ServiceOptions } from "@open-pioneer/runtime";
4
4
  import type { NotificationOptions, NotificationService, SimpleNotificationOptions } from "./api";
5
5
  export type ToasterObject = CreateToasterReturn;
6
6
  export interface ToastMeta {
@@ -10,13 +10,10 @@ export interface InternalNotificationAPI extends NotificationService {
10
10
  readonly toaster: ToasterObject;
11
11
  registerUI(): Resource | undefined;
12
12
  }
13
- interface References {
14
- appCtx: ApplicationContext;
15
- }
16
13
  export declare class NotificationServiceImpl implements InternalNotificationAPI {
17
14
  #private;
18
15
  readonly toaster: ToasterObject;
19
- constructor({ properties }: ServiceOptions<References>);
16
+ constructor({ properties }: ServiceOptions);
20
17
  destroy(): void;
21
18
  notify(options: NotificationOptions): void;
22
19
  success(options: SimpleNotificationOptions): void;
@@ -26,4 +23,3 @@ export declare class NotificationServiceImpl implements InternalNotificationAPI
26
23
  closeAll(): void;
27
24
  registerUI(): Resource | undefined;
28
25
  }
29
- export {};
@@ -7,7 +7,6 @@ const PERSISTENT_TIMEOUT = 7 * 24 * 60 * 60 * 1e3;
7
7
  class NotificationServiceImpl {
8
8
  #uiPresent = false;
9
9
  #uiCheckTimeoutId;
10
- // oxlint-disable-line @typescript-eslint/no-explicit-any
11
10
  toaster;
12
11
  constructor({ properties }) {
13
12
  const typedProperties = properties;
@@ -1 +1 @@
1
- {"version":3,"file":"NotificationServiceImpl.js","sources":["NotificationServiceImpl.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023-2025 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\n\nimport { createToaster, CreateToasterProps, CreateToasterReturn } from \"@chakra-ui/react\";\nimport { createLogger, Resource } from \"@open-pioneer/core\";\nimport { ApplicationContext, ServiceOptions } from \"@open-pioneer/runtime\";\nimport { sourceId } from \"open-pioneer:source-info\";\nimport type {\n NotificationLevel,\n NotificationOptions,\n NotificationService,\n NotifierProperties,\n OffsetsObject,\n SimpleNotificationOptions\n} from \"./api\";\nconst LOG = createLogger(sourceId);\n\nexport type ToasterObject = CreateToasterReturn;\n\nexport interface ToastMeta {\n closable: boolean;\n}\n\nexport interface InternalNotificationAPI extends NotificationService {\n // Toasts in here carry `ToastMeta` metadata\n readonly toaster: ToasterObject;\n registerUI(): Resource | undefined;\n}\n\ninterface References {\n appCtx: ApplicationContext;\n}\n\n// 7 days. Needed because there is no \"indefinite\" timeout for tooltips in current chakra.\nconst PERSISTENT_TIMEOUT = 7 * 24 * 60 * 60 * 1000;\n\nexport class NotificationServiceImpl implements InternalNotificationAPI {\n #uiPresent = false;\n #uiCheckTimeoutId: any; // oxlint-disable-line @typescript-eslint/no-explicit-any\n\n readonly toaster: ToasterObject;\n\n constructor({ properties }: ServiceOptions<References>) {\n const typedProperties = properties as NotifierProperties;\n\n this.toaster = createToaster({\n placement: getPlacement(typedProperties.position),\n offsets: getOffsets(typedProperties.offsets),\n pauseOnPageIdle: true\n });\n\n if (import.meta.env.DEV && !import.meta.env.VITEST) {\n this.#uiCheckTimeoutId = setTimeout(() => {\n this.#checkUiNotification();\n this.#uiCheckTimeoutId = undefined;\n }, 5000);\n }\n }\n\n destroy() {\n clearTimeout(this.#uiCheckTimeoutId);\n this.#uiCheckTimeoutId = undefined;\n }\n\n notify(options: NotificationOptions): void {\n // Slightly delay the create call.\n // `toaster.create` currently calls `React.flushSync` somewhere deep inside zag-js.\n // This causes warnings when calling `notify()` in a useEffect().\n queueMicrotask(() => {\n this.toaster.create({\n type: options.level ?? \"info\",\n title: options.title,\n description: options.message,\n\n // Chakra currently has no concept of persistent toasts (other than type \"loading\"),\n // so we just use a very long timeout instead.\n // Note: MAX_VALUE or Infinity does not work either (probably too big for some computations made internally).\n duration: options.displayDuration ?? PERSISTENT_TIMEOUT,\n\n // Additional data for the toast (can be arbitrary)\n meta: {\n closable: true\n } satisfies ToastMeta\n });\n });\n }\n\n success(options: SimpleNotificationOptions): void {\n this.#sendSimpleNotification(\"success\", options);\n }\n\n info(options: SimpleNotificationOptions): void {\n this.#sendSimpleNotification(\"info\", options);\n }\n\n warning(options: SimpleNotificationOptions): void {\n this.#sendSimpleNotification(\"warning\", options);\n }\n\n error(options: SimpleNotificationOptions): void {\n this.#sendSimpleNotification(\"error\", options);\n }\n\n #sendSimpleNotification(level: NotificationLevel, options: SimpleNotificationOptions): void {\n if (typeof options === \"string\") {\n options = { message: options };\n }\n this.notify({ ...options, level });\n }\n\n closeAll(): void {\n this.toaster.dismiss();\n }\n\n registerUI(): Resource | undefined {\n // We only support exactly one handler.\n if (this.#uiPresent) {\n LOG.warn(\n \"A notifier UI has already been registered; this new component will be ignored.\\n\" +\n \"The <Notifier /> component has likely been used twice in your application.\"\n );\n return undefined;\n }\n\n this.#uiPresent = true;\n let destroyed = false;\n return {\n destroy: () => {\n if (destroyed) {\n return;\n }\n\n destroyed = true;\n this.#uiPresent = false;\n }\n };\n }\n\n #checkUiNotification() {\n if (!this.#uiPresent) {\n LOG.warn(\n `No notifier UI has been registered: notifications will not be visible.\\n` +\n `Make sure that your app contains the <Notifier /> component.`\n );\n }\n }\n}\n\n// Map to chakra placement\nfunction getPlacement(\n configPosition: NotifierProperties[\"position\"] = \"top-right\"\n): CreateToasterProps[\"placement\"] {\n switch (configPosition) {\n case \"top\":\n return \"top\";\n case \"top-left\":\n return \"top-start\";\n case \"top-right\":\n return \"top-end\";\n case \"bottom\":\n return \"bottom\";\n case \"bottom-left\":\n return \"bottom-start\";\n case \"bottom-right\":\n return \"bottom-end\";\n default:\n return \"top-end\";\n }\n}\n\nfunction getOffsets(offsetsConfig: NotifierProperties[\"offsets\"]): OffsetsObject | undefined {\n if (!offsetsConfig) {\n return undefined;\n }\n\n if (typeof offsetsConfig === \"string\") {\n return {\n left: offsetsConfig,\n top: offsetsConfig,\n right: offsetsConfig,\n bottom: offsetsConfig\n };\n }\n\n if (typeof offsetsConfig !== \"object\") {\n throw new Error(\"Unexpected 'offsets' property value: must be a string or an object.\");\n }\n checkProp(offsetsConfig, \"left\");\n checkProp(offsetsConfig, \"top\");\n checkProp(offsetsConfig, \"right\");\n checkProp(offsetsConfig, \"bottom\");\n return offsetsConfig;\n}\n\nfunction checkProp(obj: Partial<OffsetsObject>, prop: keyof OffsetsObject) {\n if (!obj[prop]) {\n throw new Error(`Offset '${prop}' is required.`);\n }\n}\n"],"names":[],"mappings":";;;;AAeA,MAAM,GAAA,GAAM,aAAa,QAAQ,CAAA;AAmBjC,MAAM,kBAAA,GAAqB,CAAA,GAAI,EAAA,GAAK,EAAA,GAAK,EAAA,GAAK,GAAA;AAEvC,MAAM,uBAAA,CAA2D;AAAA,EACpE,UAAA,GAAa,KAAA;AAAA,EACb,iBAAA;AAAA;AAAA,EAES,OAAA;AAAA,EAET,WAAA,CAAY,EAAE,UAAA,EAAW,EAA+B;AACpD,IAAA,MAAM,eAAA,GAAkB,UAAA;AAExB,IAAA,IAAA,CAAK,UAAU,aAAA,CAAc;AAAA,MACzB,SAAA,EAAW,YAAA,CAAa,eAAA,CAAgB,QAAQ,CAAA;AAAA,MAChD,OAAA,EAAS,UAAA,CAAW,eAAA,CAAgB,OAAO,CAAA;AAAA,MAC3C,eAAA,EAAiB;AAAA,KACpB,CAAA;AAED,IAAA,IAAI,YAAY,GAAA,CAAI,GAAA,IAAO,CAAC,MAAA,CAAA,IAAA,CAAY,IAAI,MAAA,EAAQ;AAChD,MAAA,IAAA,CAAK,iBAAA,GAAoB,WAAW,MAAM;AACtC,QAAA,IAAA,CAAK,oBAAA,EAAqB;AAC1B,QAAA,IAAA,CAAK,iBAAA,GAAoB,MAAA;AAAA,MAC7B,GAAG,GAAI,CAAA;AAAA,IACX;AAAA,EACJ;AAAA,EAEA,OAAA,GAAU;AACN,IAAA,YAAA,CAAa,KAAK,iBAAiB,CAAA;AACnC,IAAA,IAAA,CAAK,iBAAA,GAAoB,MAAA;AAAA,EAC7B;AAAA,EAEA,OAAO,OAAA,EAAoC;AAIvC,IAAA,cAAA,CAAe,MAAM;AACjB,MAAA,IAAA,CAAK,QAAQ,MAAA,CAAO;AAAA,QAChB,IAAA,EAAM,QAAQ,KAAA,IAAS,MAAA;AAAA,QACvB,OAAO,OAAA,CAAQ,KAAA;AAAA,QACf,aAAa,OAAA,CAAQ,OAAA;AAAA;AAAA;AAAA;AAAA,QAKrB,QAAA,EAAU,QAAQ,eAAA,IAAmB,kBAAA;AAAA;AAAA,QAGrC,IAAA,EAAM;AAAA,UACF,QAAA,EAAU;AAAA;AACd,OACH,CAAA;AAAA,IACL,CAAC,CAAA;AAAA,EACL;AAAA,EAEA,QAAQ,OAAA,EAA0C;AAC9C,IAAA,IAAA,CAAK,uBAAA,CAAwB,WAAW,OAAO,CAAA;AAAA,EACnD;AAAA,EAEA,KAAK,OAAA,EAA0C;AAC3C,IAAA,IAAA,CAAK,uBAAA,CAAwB,QAAQ,OAAO,CAAA;AAAA,EAChD;AAAA,EAEA,QAAQ,OAAA,EAA0C;AAC9C,IAAA,IAAA,CAAK,uBAAA,CAAwB,WAAW,OAAO,CAAA;AAAA,EACnD;AAAA,EAEA,MAAM,OAAA,EAA0C;AAC5C,IAAA,IAAA,CAAK,uBAAA,CAAwB,SAAS,OAAO,CAAA;AAAA,EACjD;AAAA,EAEA,uBAAA,CAAwB,OAA0B,OAAA,EAA0C;AACxF,IAAA,IAAI,OAAO,YAAY,QAAA,EAAU;AAC7B,MAAA,OAAA,GAAU,EAAE,SAAS,OAAA,EAAQ;AAAA,IACjC;AACA,IAAA,IAAA,CAAK,MAAA,CAAO,EAAE,GAAG,OAAA,EAAS,OAAO,CAAA;AAAA,EACrC;AAAA,EAEA,QAAA,GAAiB;AACb,IAAA,IAAA,CAAK,QAAQ,OAAA,EAAQ;AAAA,EACzB;AAAA,EAEA,UAAA,GAAmC;AAE/B,IAAA,IAAI,KAAK,UAAA,EAAY;AACjB,MAAA,GAAA,CAAI,IAAA;AAAA,QACA;AAAA,OAEJ;AACA,MAAA,OAAO,MAAA;AAAA,IACX;AAEA,IAAA,IAAA,CAAK,UAAA,GAAa,IAAA;AAClB,IAAA,IAAI,SAAA,GAAY,KAAA;AAChB,IAAA,OAAO;AAAA,MACH,SAAS,MAAM;AACX,QAAA,IAAI,SAAA,EAAW;AACX,UAAA;AAAA,QACJ;AAEA,QAAA,SAAA,GAAY,IAAA;AACZ,QAAA,IAAA,CAAK,UAAA,GAAa,KAAA;AAAA,MACtB;AAAA,KACJ;AAAA,EACJ;AAAA,EAEA,oBAAA,GAAuB;AACnB,IAAA,IAAI,CAAC,KAAK,UAAA,EAAY;AAClB,MAAA,GAAA,CAAI,IAAA;AAAA,QACA,CAAA;AAAA,4DAAA;AAAA,OAEJ;AAAA,IACJ;AAAA,EACJ;AACJ;AAGA,SAAS,YAAA,CACL,iBAAiD,WAAA,EAClB;AAC/B,EAAA,QAAQ,cAAA;AAAgB,IACpB,KAAK,KAAA;AACD,MAAA,OAAO,KAAA;AAAA,IACX,KAAK,UAAA;AACD,MAAA,OAAO,WAAA;AAAA,IACX,KAAK,WAAA;AACD,MAAA,OAAO,SAAA;AAAA,IACX,KAAK,QAAA;AACD,MAAA,OAAO,QAAA;AAAA,IACX,KAAK,aAAA;AACD,MAAA,OAAO,cAAA;AAAA,IACX,KAAK,cAAA;AACD,MAAA,OAAO,YAAA;AAAA,IACX;AACI,MAAA,OAAO,SAAA;AAAA;AAEnB;AAEA,SAAS,WAAW,aAAA,EAAyE;AACzF,EAAA,IAAI,CAAC,aAAA,EAAe;AAChB,IAAA,OAAO,MAAA;AAAA,EACX;AAEA,EAAA,IAAI,OAAO,kBAAkB,QAAA,EAAU;AACnC,IAAA,OAAO;AAAA,MACH,IAAA,EAAM,aAAA;AAAA,MACN,GAAA,EAAK,aAAA;AAAA,MACL,KAAA,EAAO,aAAA;AAAA,MACP,MAAA,EAAQ;AAAA,KACZ;AAAA,EACJ;AAEA,EAAA,IAAI,OAAO,kBAAkB,QAAA,EAAU;AACnC,IAAA,MAAM,IAAI,MAAM,qEAAqE,CAAA;AAAA,EACzF;AACA,EAAA,SAAA,CAAU,eAAe,MAAM,CAAA;AAC/B,EAAA,SAAA,CAAU,eAAe,KAAK,CAAA;AAC9B,EAAA,SAAA,CAAU,eAAe,OAAO,CAAA;AAChC,EAAA,SAAA,CAAU,eAAe,QAAQ,CAAA;AACjC,EAAA,OAAO,aAAA;AACX;AAEA,SAAS,SAAA,CAAU,KAA6B,IAAA,EAA2B;AACvE,EAAA,IAAI,CAAC,GAAA,CAAI,IAAI,CAAA,EAAG;AACZ,IAAA,MAAM,IAAI,KAAA,CAAM,CAAA,QAAA,EAAW,IAAI,CAAA,cAAA,CAAgB,CAAA;AAAA,EACnD;AACJ;;"}
1
+ {"version":3,"file":"NotificationServiceImpl.js","sources":["NotificationServiceImpl.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023-2025 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\n\nimport { createToaster, CreateToasterProps, CreateToasterReturn } from \"@chakra-ui/react\";\nimport { createLogger, Resource } from \"@open-pioneer/core\";\nimport { ServiceOptions } from \"@open-pioneer/runtime\";\nimport { sourceId } from \"open-pioneer:source-info\";\nimport type {\n NotificationLevel,\n NotificationOptions,\n NotificationService,\n NotifierProperties,\n OffsetsObject,\n SimpleNotificationOptions\n} from \"./api\";\nconst LOG = createLogger(sourceId);\n\nexport type ToasterObject = CreateToasterReturn;\n\nexport interface ToastMeta {\n closable: boolean;\n}\n\nexport interface InternalNotificationAPI extends NotificationService {\n // Toasts in here carry `ToastMeta` metadata\n readonly toaster: ToasterObject;\n registerUI(): Resource | undefined;\n}\n\n// 7 days, because Chakra has no indefinite toast duration.\nconst PERSISTENT_TIMEOUT = 7 * 24 * 60 * 60 * 1000;\n\nexport class NotificationServiceImpl implements InternalNotificationAPI {\n #uiPresent = false;\n #uiCheckTimeoutId: ReturnType<typeof setTimeout> | undefined;\n\n readonly toaster: ToasterObject;\n\n constructor({ properties }: ServiceOptions) {\n const typedProperties = properties as NotifierProperties;\n\n this.toaster = createToaster({\n placement: getPlacement(typedProperties.position),\n offsets: getOffsets(typedProperties.offsets),\n pauseOnPageIdle: true\n });\n\n if (import.meta.env.DEV && !import.meta.env.VITEST) {\n this.#uiCheckTimeoutId = setTimeout(() => {\n this.#checkUiNotification();\n this.#uiCheckTimeoutId = undefined;\n }, 5000);\n }\n }\n\n destroy() {\n clearTimeout(this.#uiCheckTimeoutId);\n this.#uiCheckTimeoutId = undefined;\n }\n\n notify(options: NotificationOptions): void {\n // Slightly delay the create call.\n // `toaster.create` currently calls `React.flushSync` somewhere deep inside zag-js.\n // This causes warnings when calling `notify()` in a useEffect().\n queueMicrotask(() => {\n this.toaster.create({\n type: options.level ?? \"info\",\n title: options.title,\n description: options.message,\n\n // Chakra currently has no concept of persistent toasts (other than type \"loading\"),\n // so we just use a very long timeout instead.\n // Note: MAX_VALUE or Infinity does not work either (probably too big for some computations made internally).\n duration: options.displayDuration ?? PERSISTENT_TIMEOUT,\n\n // Additional data for the toast (can be arbitrary)\n meta: {\n closable: true\n } satisfies ToastMeta\n });\n });\n }\n\n success(options: SimpleNotificationOptions): void {\n this.#sendSimpleNotification(\"success\", options);\n }\n\n info(options: SimpleNotificationOptions): void {\n this.#sendSimpleNotification(\"info\", options);\n }\n\n warning(options: SimpleNotificationOptions): void {\n this.#sendSimpleNotification(\"warning\", options);\n }\n\n error(options: SimpleNotificationOptions): void {\n this.#sendSimpleNotification(\"error\", options);\n }\n\n #sendSimpleNotification(level: NotificationLevel, options: SimpleNotificationOptions): void {\n if (typeof options === \"string\") {\n options = { message: options };\n }\n this.notify({ ...options, level });\n }\n\n closeAll(): void {\n this.toaster.dismiss();\n }\n\n registerUI(): Resource | undefined {\n // We only support exactly one handler.\n if (this.#uiPresent) {\n LOG.warn(\n \"A notifier UI has already been registered; this new component will be ignored.\\n\" +\n \"The <Notifier /> component has likely been used twice in your application.\"\n );\n return undefined;\n }\n\n this.#uiPresent = true;\n let destroyed = false;\n return {\n destroy: () => {\n if (destroyed) {\n return;\n }\n\n destroyed = true;\n this.#uiPresent = false;\n }\n };\n }\n\n #checkUiNotification() {\n if (!this.#uiPresent) {\n LOG.warn(\n `No notifier UI has been registered: notifications will not be visible.\\n` +\n `Make sure that your app contains the <Notifier /> component.`\n );\n }\n }\n}\n\n// Map to chakra placement\nfunction getPlacement(\n configPosition: NotifierProperties[\"position\"] = \"top-right\"\n): CreateToasterProps[\"placement\"] {\n switch (configPosition) {\n case \"top\":\n return \"top\";\n case \"top-left\":\n return \"top-start\";\n case \"top-right\":\n return \"top-end\";\n case \"bottom\":\n return \"bottom\";\n case \"bottom-left\":\n return \"bottom-start\";\n case \"bottom-right\":\n return \"bottom-end\";\n default:\n return \"top-end\";\n }\n}\n\nfunction getOffsets(offsetsConfig: NotifierProperties[\"offsets\"]): OffsetsObject | undefined {\n if (!offsetsConfig) {\n return undefined;\n }\n\n if (typeof offsetsConfig === \"string\") {\n return {\n left: offsetsConfig,\n top: offsetsConfig,\n right: offsetsConfig,\n bottom: offsetsConfig\n };\n }\n\n if (typeof offsetsConfig !== \"object\") {\n throw new Error(\"Unexpected 'offsets' property value: must be a string or an object.\");\n }\n checkProp(offsetsConfig, \"left\");\n checkProp(offsetsConfig, \"top\");\n checkProp(offsetsConfig, \"right\");\n checkProp(offsetsConfig, \"bottom\");\n return offsetsConfig;\n}\n\nfunction checkProp(obj: Partial<OffsetsObject>, prop: keyof OffsetsObject) {\n if (!obj[prop]) {\n throw new Error(`Offset '${prop}' is required.`);\n }\n}\n"],"names":[],"mappings":";;;;AAeA,MAAM,GAAA,GAAM,aAAa,QAAQ,CAAA;AAejC,MAAM,kBAAA,GAAqB,CAAA,GAAI,EAAA,GAAK,EAAA,GAAK,EAAA,GAAK,GAAA;AAEvC,MAAM,uBAAA,CAA2D;AAAA,EACpE,UAAA,GAAa,KAAA;AAAA,EACb,iBAAA;AAAA,EAES,OAAA;AAAA,EAET,WAAA,CAAY,EAAE,UAAA,EAAW,EAAmB;AACxC,IAAA,MAAM,eAAA,GAAkB,UAAA;AAExB,IAAA,IAAA,CAAK,UAAU,aAAA,CAAc;AAAA,MACzB,SAAA,EAAW,YAAA,CAAa,eAAA,CAAgB,QAAQ,CAAA;AAAA,MAChD,OAAA,EAAS,UAAA,CAAW,eAAA,CAAgB,OAAO,CAAA;AAAA,MAC3C,eAAA,EAAiB;AAAA,KACpB,CAAA;AAED,IAAA,IAAI,YAAY,GAAA,CAAI,GAAA,IAAO,CAAC,MAAA,CAAA,IAAA,CAAY,IAAI,MAAA,EAAQ;AAChD,MAAA,IAAA,CAAK,iBAAA,GAAoB,WAAW,MAAM;AACtC,QAAA,IAAA,CAAK,oBAAA,EAAqB;AAC1B,QAAA,IAAA,CAAK,iBAAA,GAAoB,MAAA;AAAA,MAC7B,GAAG,GAAI,CAAA;AAAA,IACX;AAAA,EACJ;AAAA,EAEA,OAAA,GAAU;AACN,IAAA,YAAA,CAAa,KAAK,iBAAiB,CAAA;AACnC,IAAA,IAAA,CAAK,iBAAA,GAAoB,MAAA;AAAA,EAC7B;AAAA,EAEA,OAAO,OAAA,EAAoC;AAIvC,IAAA,cAAA,CAAe,MAAM;AACjB,MAAA,IAAA,CAAK,QAAQ,MAAA,CAAO;AAAA,QAChB,IAAA,EAAM,QAAQ,KAAA,IAAS,MAAA;AAAA,QACvB,OAAO,OAAA,CAAQ,KAAA;AAAA,QACf,aAAa,OAAA,CAAQ,OAAA;AAAA;AAAA;AAAA;AAAA,QAKrB,QAAA,EAAU,QAAQ,eAAA,IAAmB,kBAAA;AAAA;AAAA,QAGrC,IAAA,EAAM;AAAA,UACF,QAAA,EAAU;AAAA;AACd,OACH,CAAA;AAAA,IACL,CAAC,CAAA;AAAA,EACL;AAAA,EAEA,QAAQ,OAAA,EAA0C;AAC9C,IAAA,IAAA,CAAK,uBAAA,CAAwB,WAAW,OAAO,CAAA;AAAA,EACnD;AAAA,EAEA,KAAK,OAAA,EAA0C;AAC3C,IAAA,IAAA,CAAK,uBAAA,CAAwB,QAAQ,OAAO,CAAA;AAAA,EAChD;AAAA,EAEA,QAAQ,OAAA,EAA0C;AAC9C,IAAA,IAAA,CAAK,uBAAA,CAAwB,WAAW,OAAO,CAAA;AAAA,EACnD;AAAA,EAEA,MAAM,OAAA,EAA0C;AAC5C,IAAA,IAAA,CAAK,uBAAA,CAAwB,SAAS,OAAO,CAAA;AAAA,EACjD;AAAA,EAEA,uBAAA,CAAwB,OAA0B,OAAA,EAA0C;AACxF,IAAA,IAAI,OAAO,YAAY,QAAA,EAAU;AAC7B,MAAA,OAAA,GAAU,EAAE,SAAS,OAAA,EAAQ;AAAA,IACjC;AACA,IAAA,IAAA,CAAK,MAAA,CAAO,EAAE,GAAG,OAAA,EAAS,OAAO,CAAA;AAAA,EACrC;AAAA,EAEA,QAAA,GAAiB;AACb,IAAA,IAAA,CAAK,QAAQ,OAAA,EAAQ;AAAA,EACzB;AAAA,EAEA,UAAA,GAAmC;AAE/B,IAAA,IAAI,KAAK,UAAA,EAAY;AACjB,MAAA,GAAA,CAAI,IAAA;AAAA,QACA;AAAA,OAEJ;AACA,MAAA,OAAO,MAAA;AAAA,IACX;AAEA,IAAA,IAAA,CAAK,UAAA,GAAa,IAAA;AAClB,IAAA,IAAI,SAAA,GAAY,KAAA;AAChB,IAAA,OAAO;AAAA,MACH,SAAS,MAAM;AACX,QAAA,IAAI,SAAA,EAAW;AACX,UAAA;AAAA,QACJ;AAEA,QAAA,SAAA,GAAY,IAAA;AACZ,QAAA,IAAA,CAAK,UAAA,GAAa,KAAA;AAAA,MACtB;AAAA,KACJ;AAAA,EACJ;AAAA,EAEA,oBAAA,GAAuB;AACnB,IAAA,IAAI,CAAC,KAAK,UAAA,EAAY;AAClB,MAAA,GAAA,CAAI,IAAA;AAAA,QACA,CAAA;AAAA,4DAAA;AAAA,OAEJ;AAAA,IACJ;AAAA,EACJ;AACJ;AAGA,SAAS,YAAA,CACL,iBAAiD,WAAA,EAClB;AAC/B,EAAA,QAAQ,cAAA;AAAgB,IACpB,KAAK,KAAA;AACD,MAAA,OAAO,KAAA;AAAA,IACX,KAAK,UAAA;AACD,MAAA,OAAO,WAAA;AAAA,IACX,KAAK,WAAA;AACD,MAAA,OAAO,SAAA;AAAA,IACX,KAAK,QAAA;AACD,MAAA,OAAO,QAAA;AAAA,IACX,KAAK,aAAA;AACD,MAAA,OAAO,cAAA;AAAA,IACX,KAAK,cAAA;AACD,MAAA,OAAO,YAAA;AAAA,IACX;AACI,MAAA,OAAO,SAAA;AAAA;AAEnB;AAEA,SAAS,WAAW,aAAA,EAAyE;AACzF,EAAA,IAAI,CAAC,aAAA,EAAe;AAChB,IAAA,OAAO,MAAA;AAAA,EACX;AAEA,EAAA,IAAI,OAAO,kBAAkB,QAAA,EAAU;AACnC,IAAA,OAAO;AAAA,MACH,IAAA,EAAM,aAAA;AAAA,MACN,GAAA,EAAK,aAAA;AAAA,MACL,KAAA,EAAO,aAAA;AAAA,MACP,MAAA,EAAQ;AAAA,KACZ;AAAA,EACJ;AAEA,EAAA,IAAI,OAAO,kBAAkB,QAAA,EAAU;AACnC,IAAA,MAAM,IAAI,MAAM,qEAAqE,CAAA;AAAA,EACzF;AACA,EAAA,SAAA,CAAU,eAAe,MAAM,CAAA;AAC/B,EAAA,SAAA,CAAU,eAAe,KAAK,CAAA;AAC9B,EAAA,SAAA,CAAU,eAAe,OAAO,CAAA;AAChC,EAAA,SAAA,CAAU,eAAe,QAAQ,CAAA;AACjC,EAAA,OAAO,aAAA;AACX;AAEA,SAAS,SAAA,CAAU,KAA6B,IAAA,EAA2B;AACvE,EAAA,IAAI,CAAC,GAAA,CAAI,IAAI,CAAA,EAAG;AACZ,IAAA,MAAM,IAAI,KAAA,CAAM,CAAA,QAAA,EAAW,IAAI,CAAA,cAAA,CAAgB,CAAA;AAAA,EACnD;AACJ;;"}
package/README.md CHANGED
@@ -6,7 +6,7 @@ This package allows a developer to emit global notifications from any applicatio
6
6
 
7
7
  ### Displaying notifications in an application
8
8
 
9
- The `<Notifier />` must be used in your app's UI , otherwise notifications from application components are not shown. It should be present exactly once.
9
+ The `<Notifier />` must be used in your app's UI, otherwise notifications from application components are not shown. It should be present exactly once.
10
10
 
11
11
  ```jsx
12
12
  import { Notifier } from "@open-pioneer/notifier";
@@ -69,7 +69,7 @@ const Element = createCustomElement({
69
69
  ### Emitting notifications
70
70
 
71
71
  Reference the interface name `notifier.NotificationService` to inject an instance of `NotificationService`.
72
- That service can be used to emit events from any service or UI component in the application:
72
+ That service can be used to emit notifications from any service or UI component in the application:
73
73
 
74
74
  ```ts
75
75
  const notificationService = ...; // injected
package/api.d.ts CHANGED
@@ -47,13 +47,13 @@ export interface NotificationService extends DeclaredService<"notifier.Notificat
47
47
  * @param options Options for the new notification.
48
48
  */
49
49
  notify(options: NotificationOptions): void;
50
- /** Emits a success notification. Same as {@link notify} with `type: "success"`. */
50
+ /** Emits a success notification. Same as {@link notify} with `level: "success"`. */
51
51
  success(options: SimpleNotificationOptions): void;
52
- /** Emits an info notification. Same as {@link notify} with `type: "info"`. */
52
+ /** Emits an info notification. Same as {@link notify} with `level: "info"`. */
53
53
  info(options: SimpleNotificationOptions): void;
54
- /** Emits a warning notification. Same as {@link notify} with `type: "warning"`. */
54
+ /** Emits a warning notification. Same as {@link notify} with `level: "warning"`. */
55
55
  warning(options: SimpleNotificationOptions): void;
56
- /** Emits an error notification. Same as {@link notify} with `type: "error"`. */
56
+ /** Emits an error notification. Same as {@link notify} with `level: "error"`. */
57
57
  error(options: SimpleNotificationOptions): void;
58
58
  /** Closes all active notifications. */
59
59
  closeAll(): void;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "type": "module",
3
3
  "name": "@open-pioneer/notifier",
4
- "version": "4.8.0",
4
+ "version": "4.9.0-dev.20261002130116",
5
5
  "description": "Provides support for application-wide notifications.",
6
6
  "keywords": [
7
7
  "open-pioneer-trails"
@@ -15,9 +15,8 @@
15
15
  },
16
16
  "dependencies": {
17
17
  "@chakra-ui/react": "^3.37.0",
18
- "@open-pioneer/core": "4.8.0",
19
- "@open-pioneer/react-utils": "4.8.0",
20
- "@open-pioneer/runtime": "4.8.0",
18
+ "@open-pioneer/core": "4.9.0-dev.20261002130116",
19
+ "@open-pioneer/runtime": "4.9.0-dev.20261002130116",
21
20
  "react": "^19.3.0",
22
21
  "react-icons": "^5.7.0"
23
22
  },