@open-pioneer/core 4.1.0 → 4.2.0-dev.20251021072202

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,13 @@
1
1
  # @open-pioneer/core
2
2
 
3
+ ## 4.2.0-dev.20251021072202
4
+
5
+ ### Minor Changes
6
+
7
+ - 0bcda89: Deprecate the `EventEmitter` class.
8
+ Use [@conterra/reactivity-events](https://www.npmjs.com/package/@conterra/reactivity-events) for events instead.
9
+ - 1b95a62: Update chakra-ui to 3.28.0
10
+
3
11
  ## 4.1.0
4
12
 
5
13
  ### Minor Changes
package/README.md CHANGED
@@ -2,10 +2,6 @@
2
2
 
3
3
  This package contains basic utility functions and classes used in Open Pioneer Trails applications.
4
4
 
5
- ## Events
6
-
7
- The package exports the `EventEmitter` class that supports emitting and subscribing to user defined events.
8
-
9
5
  ## Usage
10
6
 
11
7
  ### Errors
@@ -99,6 +95,12 @@ function someFunctionName() {
99
95
  }
100
96
  ```
101
97
 
98
+ ### Events
99
+
100
+ > Note: the `EventEmitter` class is deprecated since v4.2.0. Use [@conterra/reactivity-events](https://www.npmjs.com/package/@conterra/reactivity-events) instead.
101
+
102
+ The package exports the `EventEmitter` class that supports emitting and subscribing to user defined events.
103
+
102
104
  ## License
103
105
 
104
106
  Apache-2.0 (see `LICENSE` file)
package/deprecated.d.ts CHANGED
@@ -20,6 +20,14 @@ export interface DeprecatedOptions {
20
20
  */
21
21
  alternative?: string;
22
22
  }
23
+ /**
24
+ * To dynamically enable/disable deprecations at runtime.
25
+ *
26
+ * Currently only used for other tests in this project.
27
+ *
28
+ * @internal
29
+ */
30
+ export declare function setDeprecationWarningsEnabled(newEnabled: boolean): void;
23
31
  /**
24
32
  * Creates a deprecation helper for a deprecated entity.
25
33
  *
package/deprecated.js CHANGED
@@ -1,12 +1,12 @@
1
- const PRINT_DEPRECATIONS = typeof __PRINT_DEPRECATIONS__ !== "undefined" ? __PRINT_DEPRECATIONS__ : true;
1
+ let enabled = typeof __PRINT_DEPRECATIONS__ !== "undefined" ? __PRINT_DEPRECATIONS__ : true;
2
2
  function deprecated(options) {
3
- if (!PRINT_DEPRECATIONS || !import.meta.env.DEV) {
3
+ if (!enabled || !import.meta.env.DEV) {
4
4
  return () => {
5
5
  };
6
6
  }
7
7
  let called = false;
8
8
  return function deprecationHelper() {
9
- if (called) {
9
+ if (!enabled || called) {
10
10
  return;
11
11
  }
12
12
  called = true;
package/deprecated.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"deprecated.js","sources":["deprecated.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023-2025 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nconst PRINT_DEPRECATIONS =\n typeof __PRINT_DEPRECATIONS__ !== \"undefined\" ? __PRINT_DEPRECATIONS__ : true;\n\n/**\n * Options supported by {@link deprecated}.\n */\nexport interface DeprecatedOptions {\n /**\n * The package that contains the deprecated entity.\n */\n packageName?: string;\n\n /**\n * The entity name (class name, function name, option, ...) that was deprecated.\n */\n name: string;\n\n /**\n * The version or date in which the entity was deprecated.\n */\n since: string;\n\n /**\n * Available alternatives, if any.\n * Should be a succinct message like `use xyz instead`.\n */\n alternative?: string;\n}\n\n/**\n * Creates a deprecation helper for a deprecated entity.\n *\n * This helper is used to print a deprecation warning to the browser console\n * when the deprecated functionality is being used.\n *\n * Returns a _function_ that should be called when the deprecated entity is being used.\n * The function will print a deprecation warning when usage is detected for the first time.\n * Any further calls will have no effect to prevent spamming the console.\n *\n * > NOTE: Deprecation warnings are only printed in development builds.\n *\n * Example:\n *\n * ```js\n * const printDeprecation = deprecated({\n * name: \"someFunctionName\",\n * packageName: \"some-package\",\n * since: \"v1.2.3\",\n * alternative: \"use xyz instead\"\n * });\n *\n * // Later, when the deprecated function is actually being used:\n * function someFunctionName() {\n * printDeprecation();\n * // ...\n * } *\n * ```\n */\nexport function deprecated(options: DeprecatedOptions): () => void {\n if (!PRINT_DEPRECATIONS || !import.meta.env.DEV) {\n return () => {}; // do nothing\n }\n\n let called = false;\n return function deprecationHelper() {\n if (called) {\n return;\n }\n\n called = true;\n console.warn(buildDeprecationWarning(options));\n };\n}\n\nfunction buildDeprecationWarning(options: DeprecatedOptions): string {\n const { packageName, name, since, alternative } = options;\n const packageInfo = packageName ? ` in ${packageName}` : \"\";\n const alternativeInfo = alternative ? `, ${alternative}` : \"\";\n const message = `⚠️ DEPRECATED: ${name}${packageInfo} (since ${since}${alternativeInfo}) - Please update your code as this may be removed in future versions.`;\n return message;\n}\n"],"names":[],"mappings":"AAEA,MAAM,kBAAA,GACF,OAAO,sBAAA,KAA2B,WAAA,GAAc,sBAAA,GAAyB,IAAA;AAyDtE,SAAS,WAAW,OAAA,EAAwC;AAC/D,EAAA,IAAI,CAAC,kBAAA,IAAsB,CAAC,MAAA,CAAA,IAAA,CAAY,IAAI,GAAA,EAAK;AAC7C,IAAA,OAAO,MAAM;AAAA,IAAC,CAAA;AAAA,EAClB;AAEA,EAAA,IAAI,MAAA,GAAS,KAAA;AACb,EAAA,OAAO,SAAS,iBAAA,GAAoB;AAChC,IAAA,IAAI,MAAA,EAAQ;AACR,MAAA;AAAA,IACJ;AAEA,IAAA,MAAA,GAAS,IAAA;AACT,IAAA,OAAA,CAAQ,IAAA,CAAK,uBAAA,CAAwB,OAAO,CAAC,CAAA;AAAA,EACjD,CAAA;AACJ;AAEA,SAAS,wBAAwB,OAAA,EAAoC;AACjE,EAAA,MAAM,EAAE,WAAA,EAAa,IAAA,EAAM,KAAA,EAAO,aAAY,GAAI,OAAA;AAClD,EAAA,MAAM,WAAA,GAAc,WAAA,GAAc,CAAA,IAAA,EAAO,WAAW,CAAA,CAAA,GAAK,EAAA;AACzD,EAAA,MAAM,eAAA,GAAkB,WAAA,GAAc,CAAA,EAAA,EAAK,WAAW,CAAA,CAAA,GAAK,EAAA;AAC3D,EAAA,MAAM,OAAA,GAAU,4BAAkB,IAAI,CAAA,EAAG,WAAW,CAAA,QAAA,EAAW,KAAK,GAAG,eAAe,CAAA,sEAAA,CAAA;AACtF,EAAA,OAAO,OAAA;AACX;;;;"}
1
+ {"version":3,"file":"deprecated.js","sources":["deprecated.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023-2025 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nlet enabled = typeof __PRINT_DEPRECATIONS__ !== \"undefined\" ? __PRINT_DEPRECATIONS__ : true;\n\n/**\n * Options supported by {@link deprecated}.\n */\nexport interface DeprecatedOptions {\n /**\n * The package that contains the deprecated entity.\n */\n packageName?: string;\n\n /**\n * The entity name (class name, function name, option, ...) that was deprecated.\n */\n name: string;\n\n /**\n * The version or date in which the entity was deprecated.\n */\n since: string;\n\n /**\n * Available alternatives, if any.\n * Should be a succinct message like `use xyz instead`.\n */\n alternative?: string;\n}\n\n/**\n * To dynamically enable/disable deprecations at runtime.\n *\n * Currently only used for other tests in this project.\n *\n * @internal\n */\nexport function setDeprecationWarningsEnabled(newEnabled: boolean) {\n enabled = newEnabled;\n}\n\n/**\n * Creates a deprecation helper for a deprecated entity.\n *\n * This helper is used to print a deprecation warning to the browser console\n * when the deprecated functionality is being used.\n *\n * Returns a _function_ that should be called when the deprecated entity is being used.\n * The function will print a deprecation warning when usage is detected for the first time.\n * Any further calls will have no effect to prevent spamming the console.\n *\n * > NOTE: Deprecation warnings are only printed in development builds.\n *\n * Example:\n *\n * ```js\n * const printDeprecation = deprecated({\n * name: \"someFunctionName\",\n * packageName: \"some-package\",\n * since: \"v1.2.3\",\n * alternative: \"use xyz instead\"\n * });\n *\n * // Later, when the deprecated function is actually being used:\n * function someFunctionName() {\n * printDeprecation();\n * // ...\n * } *\n * ```\n */\nexport function deprecated(options: DeprecatedOptions): () => void {\n if (!enabled || !import.meta.env.DEV) {\n return () => {}; // do nothing\n }\n\n let called = false;\n return function deprecationHelper() {\n if (!enabled || called) {\n return;\n }\n\n called = true;\n console.warn(buildDeprecationWarning(options));\n };\n}\n\nfunction buildDeprecationWarning(options: DeprecatedOptions): string {\n const { packageName, name, since, alternative } = options;\n const packageInfo = packageName ? ` in ${packageName}` : \"\";\n const alternativeInfo = alternative ? `, ${alternative}` : \"\";\n const message = `⚠️ DEPRECATED: ${name}${packageInfo} (since ${since}${alternativeInfo}) - Please update your code as this may be removed in future versions.`;\n return message;\n}\n"],"names":[],"mappings":"AAEA,IAAI,OAAA,GAAU,OAAO,sBAAA,KAA2B,WAAA,GAAc,sBAAA,GAAyB,IAAA;AAoEhF,SAAS,WAAW,OAAA,EAAwC;AAC/D,EAAA,IAAI,CAAC,OAAA,IAAW,CAAC,MAAA,CAAA,IAAA,CAAY,IAAI,GAAA,EAAK;AAClC,IAAA,OAAO,MAAM;AAAA,IAAC,CAAA;AAAA,EAClB;AAEA,EAAA,IAAI,MAAA,GAAS,KAAA;AACb,EAAA,OAAO,SAAS,iBAAA,GAAoB;AAChC,IAAA,IAAI,CAAC,WAAW,MAAA,EAAQ;AACpB,MAAA;AAAA,IACJ;AAEA,IAAA,MAAA,GAAS,IAAA;AACT,IAAA,OAAA,CAAQ,IAAA,CAAK,uBAAA,CAAwB,OAAO,CAAC,CAAA;AAAA,EACjD,CAAA;AACJ;AAEA,SAAS,wBAAwB,OAAA,EAAoC;AACjE,EAAA,MAAM,EAAE,WAAA,EAAa,IAAA,EAAM,KAAA,EAAO,aAAY,GAAI,OAAA;AAClD,EAAA,MAAM,WAAA,GAAc,WAAA,GAAc,CAAA,IAAA,EAAO,WAAW,CAAA,CAAA,GAAK,EAAA;AACzD,EAAA,MAAM,eAAA,GAAkB,WAAA,GAAc,CAAA,EAAA,EAAK,WAAW,CAAA,CAAA,GAAK,EAAA;AAC3D,EAAA,MAAM,OAAA,GAAU,4BAAkB,IAAI,CAAA,EAAG,WAAW,CAAA,QAAA,EAAW,KAAK,GAAG,eAAe,CAAA,sEAAA,CAAA;AACtF,EAAA,OAAO,OAAA;AACX;;;;"}
package/events.d.ts CHANGED
@@ -28,9 +28,12 @@ type EventType<Events extends {}, Name extends keyof Events> = ArgType<Events[Na
28
28
  * });
29
29
  * emitter.emit("mouse-clicked", new MouseEvent(...));
30
30
  * ```
31
+ *
32
+ * @deprecated Use the package [@conterra/reactivity-events](https://www.npmjs.com/package/@conterra/reactivity-events) instead.
31
33
  */
32
34
  export declare class EventEmitter<Events extends {}> {
33
35
  private [state];
36
+ constructor();
34
37
  /**
35
38
  * Registers the given listener function as an event handler for `eventName`.
36
39
  *
@@ -55,6 +58,8 @@ export declare class EventEmitter<Events extends {}> {
55
58
  }
56
59
  /**
57
60
  * Read-only version of the {@link EventEmitter} interface that only allows listening for events.
61
+ *
62
+ * @deprecated Use the package [@conterra/reactivity-events](https://www.npmjs.com/package/@conterra/reactivity-events) instead.
58
63
  */
59
64
  export type EventSource<Events extends {}> = Pick<EventEmitter<Events>, "on" | "once">;
60
65
  export {};
package/events.js CHANGED
@@ -1,6 +1,20 @@
1
+ import { deprecated } from './deprecated.js';
2
+ import { on, emit, emitter } from '@conterra/reactivity-events';
3
+
1
4
  const state = Symbol("EventEmitterState");
5
+ const deprecatedHelper = deprecated({
6
+ name: "EventEmitter",
7
+ packageName: "@open-pioneer/core",
8
+ since: "v4.2.0",
9
+ alternative: "use @conterra/reactivity-events instead"
10
+ });
11
+ const SYNC_OPT = { dispatch: "sync" };
12
+ const ONCE_OPT = { dispatch: "sync", once: true };
2
13
  class EventEmitter {
3
14
  [state] = new EventEmitterState();
15
+ constructor() {
16
+ deprecatedHelper();
17
+ }
4
18
  /**
5
19
  * Registers the given listener function as an event handler for `eventName`.
6
20
  *
@@ -8,9 +22,8 @@ class EventEmitter {
8
22
  * when it is no longer needed.
9
23
  */
10
24
  on(eventName, listener) {
11
- return this[state].on(eventName, {
12
- listener
13
- });
25
+ const e = this[state].getEmitter(eventName, true);
26
+ return on(e, listener, SYNC_OPT);
14
27
  }
15
28
  /**
16
29
  * Registers the given listener function to listen for `eventName` events _once_.
@@ -19,10 +32,8 @@ class EventEmitter {
19
32
  * The listener function should be unregistered by destroying the returned {@link Resource}.
20
33
  */
21
34
  once(eventName, listener) {
22
- return this[state].on(eventName, {
23
- listener,
24
- once: true
25
- });
35
+ const e = this[state].getEmitter(eventName, true);
36
+ return on(e, listener, ONCE_OPT);
26
37
  }
27
38
  /**
28
39
  * Emits an event of the given name and calls the registered event handlers.
@@ -31,42 +42,21 @@ class EventEmitter {
31
42
  * After `emit()` has completed, all listeners will already have been invoked.
32
43
  */
33
44
  emit(eventName, ...args) {
34
- this[state].emit(eventName, args[0]);
45
+ const e = this[state].getEmitter(eventName);
46
+ if (e) {
47
+ emit(e, args[0]);
48
+ }
35
49
  }
36
50
  }
37
51
  class EventEmitterState {
38
- handlers = /* @__PURE__ */ new Map();
39
- on(name, handler) {
40
- let handlers = this.handlers.get(name);
41
- if (!handlers) {
42
- handlers = /* @__PURE__ */ new Set();
43
- this.handlers.set(name, handlers);
44
- }
45
- handlers.add(handler);
46
- return {
47
- destroy() {
48
- handler.removed = true;
49
- handlers?.delete(handler);
50
- handlers = void 0;
51
- }
52
- };
53
- }
54
- emit(name, event) {
55
- const handlers = this.handlers.get(name);
56
- if (!handlers) {
57
- return;
58
- }
59
- const copy = [...handlers];
60
- for (const handler of copy) {
61
- if (handler.removed) {
62
- continue;
63
- }
64
- if (handler.once) {
65
- handler.removed = true;
66
- handlers.delete(handler);
67
- }
68
- handler.listener(event);
52
+ emitters = /* @__PURE__ */ new Map();
53
+ getEmitter(name, init = false) {
54
+ let e = this.emitters.get(name);
55
+ if (!e && init) {
56
+ e = emitter();
57
+ this.emitters.set(name, e);
69
58
  }
59
+ return e;
70
60
  }
71
61
  }
72
62
 
package/events.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"events.js","sources":["events.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023-2025 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport { Resource } from \"./resources\";\n\nconst state = Symbol(\"EventEmitterState\");\n\nexport type EventNames<Events extends {}> = keyof Events & string;\n\ntype ArgType<T> = [T] extends [void] ? [] : [event: T];\n\ntype EventType<Events extends {}, Name extends keyof Events> = ArgType<Events[Name]>;\n\n/**\n * A support class that implements emitting and listening for events.\n *\n * This class supports inheritance or direct use:\n *\n * ```js\n * const emitter = new EventEmitter();\n * class MyClass extends EventEmitter {};\n * ```\n *\n * When using this class from TypeScript, declare your supported event\n * types using an interface first:\n *\n * ```ts\n * interface Events {\n * // key: event name, value: event type\n * \"mouse-clicked\": MouseEvent;\n * }\n *\n * const emitter = new EventEmitter<Events>();\n * emitter.on(\"mouse-clicked\", (event) => {\n * // event is a MouseEvent\n * });\n * emitter.emit(\"mouse-clicked\", new MouseEvent(...));\n * ```\n */\nexport class EventEmitter<Events extends {}> {\n private [state] = new EventEmitterState();\n\n /**\n * Registers the given listener function as an event handler for `eventName`.\n *\n * The listener function should be unregistered by destroying the returned {@link Resource}\n * when it is no longer needed.\n */\n on<Name extends EventNames<Events>>(\n eventName: Name,\n listener: (...args: EventType<Events, Name>) => void\n ): Resource {\n return this[state].on(eventName, {\n listener: listener as InternalListener\n });\n }\n\n /**\n * Registers the given listener function to listen for `eventName` events _once_.\n * The listener function will automatically be unregistered after it has been called.\n *\n * The listener function should be unregistered by destroying the returned {@link Resource}.\n */\n once<Name extends EventNames<Events>>(\n eventName: Name,\n listener: (...args: EventType<Events, Name>) => void\n ): Resource {\n return this[state].on(eventName, {\n listener: listener as InternalListener,\n once: true\n });\n }\n\n /**\n * Emits an event of the given name and calls the registered event handlers.\n *\n * _Note:_ event handlers run synchronously.\n * After `emit()` has completed, all listeners will already have been invoked.\n */\n emit<Name extends EventNames<Events>>(eventName: Name, ...args: EventType<Events, Name>): void {\n this[state].emit(eventName, args[0]);\n }\n}\n\n/**\n * Read-only version of the {@link EventEmitter} interface that only allows listening for events.\n */\nexport type EventSource<Events extends {}> = Pick<EventEmitter<Events>, \"on\" | \"once\">;\n\ntype InternalListener = (event: unknown) => void;\n\ninterface EventHandler {\n once?: boolean;\n removed?: boolean;\n listener: InternalListener;\n}\n\nclass EventEmitterState {\n private handlers = new Map<string, Set<EventHandler>>();\n\n on(name: string, handler: EventHandler): Resource {\n let handlers = this.handlers.get(name);\n if (!handlers) {\n handlers = new Set();\n this.handlers.set(name, handlers);\n }\n handlers.add(handler);\n return {\n destroy() {\n handler.removed = true;\n handlers?.delete(handler);\n handlers = undefined;\n }\n };\n }\n\n emit(name: string, event: unknown) {\n const handlers = this.handlers.get(name);\n if (!handlers) {\n return;\n }\n\n // Copy to allow (de-) registration of handlers during emit.\n // This is convenient for correctness but may been further optimization\n // if events are emitted frequently.\n const copy = [...handlers];\n for (const handler of copy) {\n if (handler.removed) {\n continue;\n }\n\n if (handler.once) {\n handler.removed = true;\n handlers.delete(handler);\n }\n handler.listener(event);\n }\n }\n}\n"],"names":[],"mappings":"AAIA,MAAM,KAAA,GAAQ,OAAO,mBAAmB,CAAA;AAkCjC,MAAM,YAAA,CAAgC;AAAA,EACzC,CAAS,KAAK,IAAI,IAAI,iBAAA,EAAkB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQxC,EAAA,CACI,WACA,QAAA,EACQ;AACR,IAAA,OAAO,IAAA,CAAK,KAAK,CAAA,CAAE,EAAA,CAAG,SAAA,EAAW;AAAA,MAC7B;AAAA,KACH,CAAA;AAAA,EACL;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,IAAA,CACI,WACA,QAAA,EACQ;AACR,IAAA,OAAO,IAAA,CAAK,KAAK,CAAA,CAAE,EAAA,CAAG,SAAA,EAAW;AAAA,MAC7B,QAAA;AAAA,MACA,IAAA,EAAM;AAAA,KACT,CAAA;AAAA,EACL;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,IAAA,CAAsC,cAAoB,IAAA,EAAqC;AAC3F,IAAA,IAAA,CAAK,KAAK,CAAA,CAAE,IAAA,CAAK,SAAA,EAAW,IAAA,CAAK,CAAC,CAAC,CAAA;AAAA,EACvC;AACJ;AAeA,MAAM,iBAAA,CAAkB;AAAA,EACZ,QAAA,uBAAe,GAAA,EAA+B;AAAA,EAEtD,EAAA,CAAG,MAAc,OAAA,EAAiC;AAC9C,IAAA,IAAI,QAAA,GAAW,IAAA,CAAK,QAAA,CAAS,GAAA,CAAI,IAAI,CAAA;AACrC,IAAA,IAAI,CAAC,QAAA,EAAU;AACX,MAAA,QAAA,uBAAe,GAAA,EAAI;AACnB,MAAA,IAAA,CAAK,QAAA,CAAS,GAAA,CAAI,IAAA,EAAM,QAAQ,CAAA;AAAA,IACpC;AACA,IAAA,QAAA,CAAS,IAAI,OAAO,CAAA;AACpB,IAAA,OAAO;AAAA,MACH,OAAA,GAAU;AACN,QAAA,OAAA,CAAQ,OAAA,GAAU,IAAA;AAClB,QAAA,QAAA,EAAU,OAAO,OAAO,CAAA;AACxB,QAAA,QAAA,GAAW,MAAA;AAAA,MACf;AAAA,KACJ;AAAA,EACJ;AAAA,EAEA,IAAA,CAAK,MAAc,KAAA,EAAgB;AAC/B,IAAA,MAAM,QAAA,GAAW,IAAA,CAAK,QAAA,CAAS,GAAA,CAAI,IAAI,CAAA;AACvC,IAAA,IAAI,CAAC,QAAA,EAAU;AACX,MAAA;AAAA,IACJ;AAKA,IAAA,MAAM,IAAA,GAAO,CAAC,GAAG,QAAQ,CAAA;AACzB,IAAA,KAAA,MAAW,WAAW,IAAA,EAAM;AACxB,MAAA,IAAI,QAAQ,OAAA,EAAS;AACjB,QAAA;AAAA,MACJ;AAEA,MAAA,IAAI,QAAQ,IAAA,EAAM;AACd,QAAA,OAAA,CAAQ,OAAA,GAAU,IAAA;AAClB,QAAA,QAAA,CAAS,OAAO,OAAO,CAAA;AAAA,MAC3B;AACA,MAAA,OAAA,CAAQ,SAAS,KAAK,CAAA;AAAA,IAC1B;AAAA,EACJ;AACJ;;;;"}
1
+ {"version":3,"file":"events.js","sources":["events.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023-2025 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport { deprecated } from \"./deprecated\";\nimport { Resource } from \"./resources\";\nimport {\n emit,\n emitter,\n on,\n EventEmitter as ReactivityEmitter,\n SubscribeOptions\n} from \"@conterra/reactivity-events\";\n\nconst state = Symbol(\"EventEmitterState\");\n\nexport type EventNames<Events extends {}> = keyof Events & string;\n\ntype ArgType<T> = [T] extends [void] ? [] : [event: T];\n\ntype EventType<Events extends {}, Name extends keyof Events> = ArgType<Events[Name]>;\n\nconst deprecatedHelper = deprecated({\n name: \"EventEmitter\",\n packageName: \"@open-pioneer/core\",\n since: \"v4.2.0\",\n alternative: \"use @conterra/reactivity-events instead\"\n});\n\nconst SYNC_OPT = { dispatch: \"sync\" } as const satisfies SubscribeOptions;\nconst ONCE_OPT = { dispatch: \"sync\", once: true } as const satisfies SubscribeOptions;\n\n/**\n * A support class that implements emitting and listening for events.\n *\n * This class supports inheritance or direct use:\n *\n * ```js\n * const emitter = new EventEmitter();\n * class MyClass extends EventEmitter {};\n * ```\n *\n * When using this class from TypeScript, declare your supported event\n * types using an interface first:\n *\n * ```ts\n * interface Events {\n * // key: event name, value: event type\n * \"mouse-clicked\": MouseEvent;\n * }\n *\n * const emitter = new EventEmitter<Events>();\n * emitter.on(\"mouse-clicked\", (event) => {\n * // event is a MouseEvent\n * });\n * emitter.emit(\"mouse-clicked\", new MouseEvent(...));\n * ```\n *\n * @deprecated Use the package [@conterra/reactivity-events](https://www.npmjs.com/package/@conterra/reactivity-events) instead.\n */\nexport class EventEmitter<Events extends {}> {\n private [state] = new EventEmitterState();\n\n constructor() {\n deprecatedHelper();\n }\n\n /**\n * Registers the given listener function as an event handler for `eventName`.\n *\n * The listener function should be unregistered by destroying the returned {@link Resource}\n * when it is no longer needed.\n */\n on<Name extends EventNames<Events>>(\n eventName: Name,\n listener: (...args: EventType<Events, Name>) => void\n ): Resource {\n const e = this[state].getEmitter(eventName, true);\n return on(e, listener as InternalListener, SYNC_OPT);\n }\n\n /**\n * Registers the given listener function to listen for `eventName` events _once_.\n * The listener function will automatically be unregistered after it has been called.\n *\n * The listener function should be unregistered by destroying the returned {@link Resource}.\n */\n once<Name extends EventNames<Events>>(\n eventName: Name,\n listener: (...args: EventType<Events, Name>) => void\n ): Resource {\n const e = this[state].getEmitter(eventName, true);\n return on(e, listener as InternalListener, ONCE_OPT);\n }\n\n /**\n * Emits an event of the given name and calls the registered event handlers.\n *\n * _Note:_ event handlers run synchronously.\n * After `emit()` has completed, all listeners will already have been invoked.\n */\n emit<Name extends EventNames<Events>>(eventName: Name, ...args: EventType<Events, Name>): void {\n const e = this[state].getEmitter(eventName);\n if (e) {\n emit(e, args[0]);\n }\n }\n}\n\n/**\n * Read-only version of the {@link EventEmitter} interface that only allows listening for events.\n *\n * @deprecated Use the package [@conterra/reactivity-events](https://www.npmjs.com/package/@conterra/reactivity-events) instead.\n */\nexport type EventSource<Events extends {}> = Pick<EventEmitter<Events>, \"on\" | \"once\">;\n\ntype InternalListener = (event: unknown) => void;\n\nclass EventEmitterState {\n private emitters = new Map<string, ReactivityEmitter<unknown>>();\n\n getEmitter(name: string): ReactivityEmitter<unknown> | undefined;\n getEmitter(name: string, init: true): ReactivityEmitter<unknown>;\n getEmitter(name: string, init = false) {\n let e = this.emitters.get(name);\n if (!e && init) {\n e = emitter();\n this.emitters.set(name, e);\n }\n return e;\n }\n}\n"],"names":[],"mappings":";;;AAYA,MAAM,KAAA,GAAQ,OAAO,mBAAmB,CAAA;AAQxC,MAAM,mBAAmB,UAAA,CAAW;AAAA,EAChC,IAAA,EAAM,cAAA;AAAA,EACN,WAAA,EAAa,oBAAA;AAAA,EACb,KAAA,EAAO,QAAA;AAAA,EACP,WAAA,EAAa;AACjB,CAAC,CAAA;AAED,MAAM,QAAA,GAAW,EAAE,QAAA,EAAU,MAAA,EAAO;AACpC,MAAM,QAAA,GAAW,EAAE,QAAA,EAAU,MAAA,EAAQ,MAAM,IAAA,EAAK;AA8BzC,MAAM,YAAA,CAAgC;AAAA,EACzC,CAAS,KAAK,IAAI,IAAI,iBAAA,EAAkB;AAAA,EAExC,WAAA,GAAc;AACV,IAAA,gBAAA,EAAiB;AAAA,EACrB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,EAAA,CACI,WACA,QAAA,EACQ;AACR,IAAA,MAAM,IAAI,IAAA,CAAK,KAAK,CAAA,CAAE,UAAA,CAAW,WAAW,IAAI,CAAA;AAChD,IAAA,OAAO,EAAA,CAAG,CAAA,EAAG,QAAA,EAA8B,QAAQ,CAAA;AAAA,EACvD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,IAAA,CACI,WACA,QAAA,EACQ;AACR,IAAA,MAAM,IAAI,IAAA,CAAK,KAAK,CAAA,CAAE,UAAA,CAAW,WAAW,IAAI,CAAA;AAChD,IAAA,OAAO,EAAA,CAAG,CAAA,EAAG,QAAA,EAA8B,QAAQ,CAAA;AAAA,EACvD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,IAAA,CAAsC,cAAoB,IAAA,EAAqC;AAC3F,IAAA,MAAM,CAAA,GAAI,IAAA,CAAK,KAAK,CAAA,CAAE,WAAW,SAAS,CAAA;AAC1C,IAAA,IAAI,CAAA,EAAG;AACH,MAAA,IAAA,CAAK,CAAA,EAAG,IAAA,CAAK,CAAC,CAAC,CAAA;AAAA,IACnB;AAAA,EACJ;AACJ;AAWA,MAAM,iBAAA,CAAkB;AAAA,EACZ,QAAA,uBAAe,GAAA,EAAwC;AAAA,EAI/D,UAAA,CAAW,IAAA,EAAc,IAAA,GAAO,KAAA,EAAO;AACnC,IAAA,IAAI,CAAA,GAAI,IAAA,CAAK,QAAA,CAAS,GAAA,CAAI,IAAI,CAAA;AAC9B,IAAA,IAAI,CAAC,KAAK,IAAA,EAAM;AACZ,MAAA,CAAA,GAAI,OAAA,EAAQ;AACZ,MAAA,IAAA,CAAK,QAAA,CAAS,GAAA,CAAI,IAAA,EAAM,CAAC,CAAA;AAAA,IAC7B;AACA,IAAA,OAAO,CAAA;AAAA,EACX;AACJ;;;;"}
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "type": "module",
3
3
  "name": "@open-pioneer/core",
4
- "version": "4.1.0",
4
+ "version": "4.2.0-dev.20251021072202",
5
5
  "description": "Contains basic utility functions and classes used by the @open-pioneer project.",
6
6
  "keywords": [
7
7
  "open-pioneer-trails"
@@ -13,6 +13,9 @@
13
13
  "url": "https://github.com/open-pioneer/trails-core-packages",
14
14
  "directory": "src/packages/core"
15
15
  },
16
+ "dependencies": {
17
+ "@conterra/reactivity-events": "^0.8.0"
18
+ },
16
19
  "exports": {
17
20
  "./package.json": "./package.json",
18
21
  ".": {