ember-primitives 0.31.0 → 0.32.0

package/declarations/on-resize.d.ts

@@ -0,0 +1,38 @@
+import Modifier, { type ArgsFor } from 'ember-modifier';
+import type Owner from '@ember/owner';
+export interface Signature {
+    /**
+     * Any element that is resizable can have onResize attached
+     */
+    Element: Element;
+    Args: {
+        Positional: [
+            /**
+             * The ResizeObserver callback will only receive
+             * one entry per resize event.
+             *
+             * See: [ResizeObserverEntry](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserverEntry)
+             */
+            callback: (entry: ResizeObserverEntry) => void
+        ];
+    };
+}
+declare class OnResize extends Modifier<Signature> {
+    #private;
+    constructor(owner: Owner, args: ArgsFor<Signature>);
+    modify(element: Element, [callback]: [callback: (entry: ResizeObserverEntry) => void]): void;
+}
+export declare const onResize: typeof OnResize;
+/**
+ * Ignores "ResizeObserver loop limit exceeded" error in Ember tests.
+ *
+ * This "error" is safe to ignore as it is just a warning message,
+ * telling that the "looping" observation will be skipped in the current frame,
+ * and will be delivered in the next one.
+ *
+ * For some reason, it is fired as an `error` event at `window` failing Ember
+ * tests and exploding Sentry with errors that must be ignored.
+ */
+export default function ignoreROError(): void;
+export {};
+//# sourceMappingURL=on-resize.d.ts.map

package/declarations/on-resize.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"on-resize.d.ts","sourceRoot":"","sources":["../src/on-resize.ts"],"names":[],"mappings":"AAGA,OAAO,QAAQ,EAAE,EAAE,KAAK,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAExD,OAAO,KAAK,KAAK,MAAM,cAAc,CAAC;AAEtC,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE;QACJ,UAAU,EAAE;YACV;;;;;eAKG;YACH,QAAQ,EAAE,CAAC,KAAK,EAAE,mBAAmB,KAAK,IAAI;SAC/C,CAAC;KACH,CAAC;CACH;AAED,cAAM,QAAS,SAAQ,QAAQ,CAAC,SAAS,CAAC;;gBAM5B,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,CAAC,SAAS,CAAC;IAUlD,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,mBAAmB,KAAK,IAAI,CAAC;CAetF;AAED,eAAO,MAAM,QAAQ,iBAAW,CAAC;AA6EjC;;;;;;;;;GASG;AACH,MAAM,CAAC,OAAO,UAAU,aAAa,SAgBpC"}

package/dist/on-resize.js

@@ -0,0 +1,116 @@
+import { assert } from '@ember/debug';
+import { registerDestructor } from '@ember/destroyable';
+import Modifier from 'ember-modifier';
+
+class OnResize extends Modifier {
+  #callback = null;
+  #element = null;
+  #resizeObserver = new ResizeObserverManager();
+  constructor(owner, args) {
+    super(owner, args);
+    registerDestructor(this, () => {
+      if (this.#element && this.#callback) {
+        this.#resizeObserver.unobserve(this.#element, this.#callback);
+      }
+    });
+  }
+  modify(element, [callback]) {
+    assert(`{{onResize}}: callback must be a function, but was ${callback}`, typeof callback === 'function');
+    if (this.#element && this.#callback) {
+      this.#resizeObserver.unobserve(this.#element, this.#callback);
+    }
+    this.#resizeObserver.observe(element, callback);
+    this.#callback = callback;
+    this.#element = element;
+  }
+}
+const onResize = OnResize;
+const errorMessages = ['ResizeObserver loop limit exceeded', 'ResizeObserver loop completed with undelivered notifications.'];
+class ResizeObserverManager {
+  #callbacks = new WeakMap();
+  #handleResize = entries => {
+    for (const entry of entries) {
+      const callbacks = this.#callbacks.get(entry.target);
+      if (callbacks) {
+        for (const callback of callbacks) {
+          callback(entry);
+        }
+      }
+    }
+  };
+  #observer = new ResizeObserver(this.#handleResize);
+  constructor() {
+    ignoreROError();
+    registerDestructor(this, () => {
+      this.#observer?.disconnect();
+    });
+  }
+
+  /**
+   * Initiate the observing of the `element` or add an additional `callback`
+   * if the `element` is already observed.
+   *
+   * @param {object} element
+   * @param {function} callback The `callback` is called whenever the size of
+   *    the `element` changes. It is called with `ResizeObserverEntry` object
+   *    for the particular `element`.
+   */
+  observe(element, callback) {
+    const callbacks = this.#callbacks.get(element);
+    if (callbacks) {
+      callbacks.add(callback);
+    } else {
+      this.#callbacks.set(element, new Set([callback]));
+      this.#observer.observe(element);
+    }
+  }
+
+  /**
+   * End the observing of the `element` or just remove the provided `callback`.
+   *
+   * It will unobserve the `element` if the `callback` is not provided
+   * or there are no more callbacks left for this `element`.
+   *
+   * @param {object} element
+   * @param {function?} callback - The `callback` to remove from the listeners
+   *   of the `element` size changes.
+   */
+  unobserve(element, callback) {
+    const callbacks = this.#callbacks.get(element);
+    if (!callbacks) {
+      return;
+    }
+    callbacks.delete(callback);
+    if (!callback || !callbacks.size) {
+      this.#callbacks.delete(element);
+      this.#observer.unobserve(element);
+    }
+  }
+}
+
+/**
+ * Ignores "ResizeObserver loop limit exceeded" error in Ember tests.
+ *
+ * This "error" is safe to ignore as it is just a warning message,
+ * telling that the "looping" observation will be skipped in the current frame,
+ * and will be delivered in the next one.
+ *
+ * For some reason, it is fired as an `error` event at `window` failing Ember
+ * tests and exploding Sentry with errors that must be ignored.
+ */
+function ignoreROError() {
+  if (typeof window.onerror !== 'function') {
+    return;
+  }
+  const onError = window.onerror;
+  window.onerror = (...args) => {
+    const [message] = args;
+    if (typeof message === 'string') {
+      if (errorMessages.includes(message)) return true;
+    }
+    onError(...args);
+  };
+}
+
+export { ignoreROError as default, onResize };
+//# sourceMappingURL=on-resize.js.map

package/dist/on-resize.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"on-resize.js","sources":["../src/on-resize.ts"],"sourcesContent":["import { assert } from '@ember/debug';\nimport { registerDestructor } from '@ember/destroyable';\n\nimport Modifier, { type ArgsFor } from 'ember-modifier';\n\nimport type Owner from '@ember/owner';\n\nexport interface Signature {\n  /**\n   * Any element that is resizable can have onResize attached\n   */\n  Element: Element;\n  Args: {\n    Positional: [\n      /**\n       * The ResizeObserver callback will only receive\n       * one entry per resize event.\n       *\n       * See: [ResizeObserverEntry](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserverEntry)\n       */\n      callback: (entry: ResizeObserverEntry) => void,\n    ];\n  };\n}\n\nclass OnResize extends Modifier<Signature> {\n  #callback: ((entry: ResizeObserverEntry) => void) | null = null;\n  #element: Element | null = null;\n\n  #resizeObserver: ResizeObserverManager = new ResizeObserverManager();\n\n  constructor(owner: Owner, args: ArgsFor<Signature>) {\n    super(owner, args);\n\n    registerDestructor(this, () => {\n      if (this.#element && this.#callback) {\n        this.#resizeObserver.unobserve(this.#element, this.#callback);\n      }\n    });\n  }\n\n  modify(element: Element, [callback]: [callback: (entry: ResizeObserverEntry) => void]) {\n    assert(\n      `{{onResize}}: callback must be a function, but was ${callback as unknown as string}`,\n      typeof callback === 'function'\n    );\n\n    if (this.#element && this.#callback) {\n      this.#resizeObserver.unobserve(this.#element, this.#callback);\n    }\n\n    this.#resizeObserver.observe(element, callback);\n\n    this.#callback = callback;\n    this.#element = element;\n  }\n}\n\nexport const onResize = OnResize;\n\nconst errorMessages = [\n  'ResizeObserver loop limit exceeded',\n  'ResizeObserver loop completed with undelivered notifications.',\n];\n\nclass ResizeObserverManager {\n  #callbacks = new WeakMap<Element, Set<(entry: ResizeObserverEntry) => unknown>>();\n\n  #handleResize = (entries: ResizeObserverEntry[]) => {\n    for (const entry of entries) {\n      const callbacks = this.#callbacks.get(entry.target);\n\n      if (callbacks) {\n        for (const callback of callbacks) {\n          callback(entry);\n        }\n      }\n    }\n  };\n  #observer = new ResizeObserver(this.#handleResize);\n\n  constructor() {\n    ignoreROError();\n\n    registerDestructor(this, () => {\n      this.#observer?.disconnect();\n    });\n  }\n\n  /**\n   * Initiate the observing of the `element` or add an additional `callback`\n   * if the `element` is already observed.\n   *\n   * @param {object} element\n   * @param {function} callback The `callback` is called whenever the size of\n   *    the `element` changes. It is called with `ResizeObserverEntry` object\n   *    for the particular `element`.\n   */\n  observe(element: Element, callback: (entry: ResizeObserverEntry) => unknown) {\n    const callbacks = this.#callbacks.get(element);\n\n    if (callbacks) {\n      callbacks.add(callback);\n    } else {\n      this.#callbacks.set(element, new Set([callback]));\n      this.#observer.observe(element);\n    }\n  }\n\n  /**\n   * End the observing of the `element` or just remove the provided `callback`.\n   *\n   * It will unobserve the `element` if the `callback` is not provided\n   * or there are no more callbacks left for this `element`.\n   *\n   * @param {object} element\n   * @param {function?} callback - The `callback` to remove from the listeners\n   *   of the `element` size changes.\n   */\n  unobserve(element: Element, callback: (entry: ResizeObserverEntry) => unknown) {\n    const callbacks = this.#callbacks.get(element);\n\n    if (!callbacks) {\n      return;\n    }\n\n    callbacks.delete(callback);\n\n    if (!callback || !callbacks.size) {\n      this.#callbacks.delete(element);\n      this.#observer.unobserve(element);\n    }\n  }\n}\n\n/**\n * Ignores \"ResizeObserver loop limit exceeded\" error in Ember tests.\n *\n * This \"error\" is safe to ignore as it is just a warning message,\n * telling that the \"looping\" observation will be skipped in the current frame,\n * and will be delivered in the next one.\n *\n * For some reason, it is fired as an `error` event at `window` failing Ember\n * tests and exploding Sentry with errors that must be ignored.\n */\nexport default function ignoreROError() {\n  if (typeof window.onerror !== 'function') {\n    return;\n  }\n\n  const onError = window.onerror;\n\n  window.onerror = (...args) => {\n    const [message] = args;\n\n    if (typeof message === 'string') {\n      if (errorMessages.includes(message)) return true;\n    }\n\n    onError(...args);\n  };\n}\n"],"names":["OnResize","Modifier","ResizeObserverManager","constructor","owner","args","registerDestructor","unobserve","modify","element","callback","assert","observe","onResize","errorMessages","WeakMap","entries","entry","callbacks","get","target","ResizeObserver","ignoreROError","disconnect","add","set","Set","delete","size","window","onerror","onError","message","includes"],"mappings":";;;;AAyBA,MAAMA,QAAQ,SAASC,QAAQ,CAAY;EACzC,SAAS,GAAkD,IAAI;EAC/D,QAAQ,GAAmB,IAAI;AAE/B,EAAA,eAAe,GAA0B,IAAIC,qBAAqB,EAAE;AAEpEC,EAAAA,WAAWA,CAACC,KAAY,EAAEC,IAAwB,EAAE;AAClD,IAAA,KAAK,CAACD,KAAK,EAAEC,IAAI,CAAC;IAElBC,kBAAkB,CAAC,IAAI,EAAE,MAAM;MAC7B,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,SAAS,EAAE;AACnC,QAAA,IAAI,CAAC,eAAe,CAACC,SAAS,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC;AAC/D;AACF,KAAC,CAAC;AACJ;AAEAC,EAAAA,MAAMA,CAACC,OAAgB,EAAE,CAACC,QAAQ,CAAmD,EAAE;IACrFC,MAAM,CACJ,sDAAsDD,QAAQ,CAAA,CAAuB,EACrF,OAAOA,QAAQ,KAAK,UACtB,CAAC;IAED,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,SAAS,EAAE;AACnC,MAAA,IAAI,CAAC,eAAe,CAACH,SAAS,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC;AAC/D;IAEA,IAAI,CAAC,eAAe,CAACK,OAAO,CAACH,OAAO,EAAEC,QAAQ,CAAC;AAE/C,IAAA,IAAI,CAAC,SAAS,GAAGA,QAAQ;AACzB,IAAA,IAAI,CAAC,QAAQ,GAAGD,OAAO;AACzB;AACF;AAEO,MAAMI,QAAQ,GAAGb;AAExB,MAAMc,aAAa,GAAG,CACpB,oCAAoC,EACpC,+DAA+D,CAChE;AAED,MAAMZ,qBAAqB,CAAC;AAC1B,EAAA,UAAU,GAAG,IAAIa,OAAO,EAAyD;EAEjF,aAAa,GAAIC,OAA8B,IAAK;AAClD,IAAA,KAAK,MAAMC,KAAK,IAAID,OAAO,EAAE;AAC3B,MAAA,MAAME,SAAS,GAAG,IAAI,CAAC,UAAU,CAACC,GAAG,CAACF,KAAK,CAACG,MAAM,CAAC;AAEnD,MAAA,IAAIF,SAAS,EAAE;AACb,QAAA,KAAK,MAAMR,QAAQ,IAAIQ,SAAS,EAAE;UAChCR,QAAQ,CAACO,KAAK,CAAC;AACjB;AACF;AACF;GACD;EACD,SAAS,GAAG,IAAII,cAAc,CAAC,IAAI,CAAC,aAAa,CAAC;AAElDlB,EAAAA,WAAWA,GAAG;AACZmB,IAAAA,aAAa,EAAE;IAEfhB,kBAAkB,CAAC,IAAI,EAAE,MAAM;AAC7B,MAAA,IAAI,CAAC,SAAS,EAAEiB,UAAU,EAAE;AAC9B,KAAC,CAAC;AACJ;;AAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACEX,EAAAA,OAAOA,CAACH,OAAgB,EAAEC,QAAiD,EAAE;IAC3E,MAAMQ,SAAS,GAAG,IAAI,CAAC,UAAU,CAACC,GAAG,CAACV,OAAO,CAAC;AAE9C,IAAA,IAAIS,SAAS,EAAE;AACbA,MAAAA,SAAS,CAACM,GAAG,CAACd,QAAQ,CAAC;AACzB,KAAC,MAAM;AACL,MAAA,IAAI,CAAC,UAAU,CAACe,GAAG,CAAChB,OAAO,EAAE,IAAIiB,GAAG,CAAC,CAAChB,QAAQ,CAAC,CAAC,CAAC;AACjD,MAAA,IAAI,CAAC,SAAS,CAACE,OAAO,CAACH,OAAO,CAAC;AACjC;AACF;;AAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACEF,EAAAA,SAASA,CAACE,OAAgB,EAAEC,QAAiD,EAAE;IAC7E,MAAMQ,SAAS,GAAG,IAAI,CAAC,UAAU,CAACC,GAAG,CAACV,OAAO,CAAC;IAE9C,IAAI,CAACS,SAAS,EAAE;AACd,MAAA;AACF;AAEAA,IAAAA,SAAS,CAACS,MAAM,CAACjB,QAAQ,CAAC;AAE1B,IAAA,IAAI,CAACA,QAAQ,IAAI,CAACQ,SAAS,CAACU,IAAI,EAAE;AAChC,MAAA,IAAI,CAAC,UAAU,CAACD,MAAM,CAAClB,OAAO,CAAC;AAC/B,MAAA,IAAI,CAAC,SAAS,CAACF,SAAS,CAACE,OAAO,CAAC;AACnC;AACF;AACF;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACe,SAASa,aAAaA,GAAG;AACtC,EAAA,IAAI,OAAOO,MAAM,CAACC,OAAO,KAAK,UAAU,EAAE;AACxC,IAAA;AACF;AAEA,EAAA,MAAMC,OAAO,GAAGF,MAAM,CAACC,OAAO;AAE9BD,EAAAA,MAAM,CAACC,OAAO,GAAG,CAAC,GAAGzB,IAAI,KAAK;AAC5B,IAAA,MAAM,CAAC2B,OAAO,CAAC,GAAG3B,IAAI;AAEtB,IAAA,IAAI,OAAO2B,OAAO,KAAK,QAAQ,EAAE;MAC/B,IAAIlB,aAAa,CAACmB,QAAQ,CAACD,OAAO,CAAC,EAAE,OAAO,IAAI;AAClD;IAEAD,OAAO,CAAC,GAAG1B,IAAI,CAAC;GACjB;AACH;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ember-primitives",
-  "version": "0.31.0",
+  "version": "0.32.0",
   "description": "Making apps easier to build",
   "sideEffects": [
     "*.css"