jj 3.0.0-rc.3 → 3.0.0-rc.4

package/lib/bundle.cjs

@@ -38,7 +38,6 @@ __export(src_exports, {
   JJSR: () => JJSR,
   JJT: () => JJT,
   attr2prop: () => attr2prop,
-  customEvent: () => customEvent,
   defineComponent: () => defineComponent,
   fetchStyle: () => fetchStyle,
   fetchTemplate: () => fetchTemplate
@@ -102,17 +101,6 @@ function toStr(x) {
 }
 
 // src/wrappers/JJET.ts
-function customEvent(type, detail, options) {
-  if (!isStr(type)) {
-    throw typeErr("eventName", "a string", type, 'Pass an event name like "todo-toggle".');
-  }
-  return new CustomEvent(type, {
-    bubbles: true,
-    composed: true,
-    ...options,
-    detail
-  });
-}
 var _ref;
 var _JJET = class _JJET {
   /**
@@ -162,15 +150,15 @@ var _JJET = class _JJET {
    * @example
    * ```ts
    * const target = {
-   *     count: 0,
+   * dispatching a plain Event object.
    *     increment() {
    *         this.count++
    *     },
    * }
    *
-   * JJET.from(window).on('click', target.increment.bind(target))
+   * @param options Optional event initialization dictionary.
    * ```
-   * @param eventName - The name of the event.
+   * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/Event/Event | Event()} for details on event options.
    * @param handler - The event handler.
    * @param options - Optional event listener options.
    * @returns This instance for chaining.
@@ -210,16 +198,41 @@ var _JJET = class _JJET {
   /**
    * Dispatches an Event at the specified EventTarget.
    *
-   * @param event - The Event object to dispatch.
+   * @param event - The Event object to dispatch. Since CustomEvent extends Event, you can also dispatch CustomEvent instances here.
    * @returns This instance for chaining.
    * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/dispatchEvent | EventTarget.dispatchEvent}
+   * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/CustomEvent | CustomEvent} for creating custom events with payloads.
+   * @see {@link triggerEvent} for a convenience wrapper that creates and dispatches an Event in one step.
+   * @see {@link triggerCustomEvent} for a convenience wrapper that creates and dispatches a CustomEvent with JJ's default settings in one step.
    */
   trigger(event) {
-    this.ref.dispatchEvent(event);
-    return this;
+    try {
+      this.ref.dispatchEvent(event);
+      return this;
+    } catch (cause) {
+      throw new Error(`Failed to trigger the event ${JSON.stringify(event)}`, { cause });
+    }
+  }
+  /**
+   * Creates a new `Event` and dispatches on the wrapped target.
+   *
+   * @remarks
+   * This is a convenience wrapper around {@link trigger} for the common case of
+   * dispatching a plain Event object.
+   *
+   * The created event defaults to `bubbles: true` and `composed: true`.
+   * Pass `options` to override those defaults.
+   *
+   * @param type The name identifying the type of the event for example 'click'
+   * @param options Optional event initialization dictionary.
+   * @returns This instance for chaining.
+   * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/Event/Event | Event()} for details on event options.
+   */
+  triggerEvent(type, options) {
+    return this.trigger(new Event(type, { bubbles: true, composed: true, ...options }));
   }
   /**
-   * Creates and dispatches a `CustomEvent` on the wrapped target.
+   * Creates a new `CustomEvent` and dispatches on the wrapped target.
    *
    * @remarks
    * This is a convenience wrapper around {@link trigger} for the common case of
@@ -228,11 +241,10 @@ var _JJET = class _JJET {
    * The created event defaults to `bubbles: true` and `composed: true`.
    * Pass `options` to override those defaults.
    *
-   * @param eventName - The event type name.
+   * @param type - The event type name.
    * @param detail - Optional payload exposed as `event.detail`.
    * @param options - Additional `CustomEvent` options excluding `detail`.
    * @returns This instance for chaining.
-   * @throws {TypeError} If `eventName` is not a string.
    * @example
    * ```ts
    * JJET.from(window).triggerCustomEvent('panel-ready', { id: '123' })
@@ -247,8 +259,8 @@ var _JJET = class _JJET {
    * ```
    * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/CustomEvent/CustomEvent | CustomEvent()}
    */
-  triggerCustomEvent(eventName, detail, options) {
-    return this.trigger(customEvent(eventName, detail, options));
+  triggerCustomEvent(type, detail, options) {
+    return this.trigger(new CustomEvent(type, { bubbles: true, composed: true, ...options, detail }));
   }
   /**
    * Runs a function in the context of this JJET instance.
@@ -2929,7 +2941,6 @@ async function defineComponent(name, constructor, options) {
   JJSR,
   JJT,
   attr2prop,
-  customEvent,
   defineComponent,
   fetchStyle,
   fetchTemplate