fluent-dom - npm Package Compare versions

Comparing version 0.3.0 to 0.4.0

CHANGELOG.md

 # Changelog
 
 ## Unreleased
-  - …
 
+## fluent-dom 0.4.0
+
+  - Drop support for IE and old evergreen browsers. (#133)
+
+    Currently supported are: Firefox 52+, Chrome 55+, Edge 15+, Safari 10.1+,
+    iOS Safari 10.3+ and node 8.9+.
+
+  - Add the `cached-iterable` runtime dependency.
+
+    `CachedAsyncIterable` is now available from its own package rather than
+    from the `fluent` package.
+
+  - Modify the constructor to not require `window `element to be passed.
+
 ## fluent-dom 0.3.0
+
   - Refactor the overlay sanitization methods into separate functions. (#189)
@@ -8,0 +22,0 @@ - Separate out CachedIterable and CachedAsyncIterable, and add a param to touchNext. (#191)

package.json

 {
   "name": "fluent-dom",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Fluent bindings for DOM",
@@ -42,4 +42,7 @@ "repository": {
   "devDependencies": {
-    "jsdom": "^11.6.2"
+    "jsdom": "^11.12.0"
+  },
+  "dependencies": {
+    "cached-iterable": "^0.2.1"
   }
 }

src/dom_localization.js

@@ -19,3 +19,2 @@ import translateElement from "./overlay";
   /**
-   * @param {Window}           windowElement
    * @param {Array<String>}    resourceIds      - List of resource IDs
@@ -26,3 +25,3 @@ * @param {Function}         generateMessages - Function that returns a
    */
-  constructor(windowElement, resourceIds, generateMessages) {
+  constructor(resourceIds, generateMessages) {
     super(resourceIds, generateMessages);
@@ -36,6 +35,4 @@
     this.pendingElements = new Set();
-    this.windowElement = windowElement;
-    this.mutationObserver = new windowElement.MutationObserver(
-      mutations => this.translateMutations(mutations)
-    );
+    this.windowElement = null;
+    this.mutationObserver = null;
 
@@ -138,2 +135,15 @@ this.observerConfig = {
 
+    if (this.windowElement) {
+      if (this.windowElement !== newRoot.ownerDocument.defaultView) {
+        throw new Error(`Cannot connect a root:
+          DOMLocalization already has a root from a different window.`);
+      }
+    } else {
+      this.windowElement = newRoot.ownerDocument.defaultView;
+      this.mutationObserver = new this.windowElement.MutationObserver(
+        mutations => this.translateMutations(mutations)
+      );
+    }
+
+
     this.roots.add(newRoot);
@@ -157,7 +167,16 @@ this.mutationObserver.observe(newRoot, this.observerConfig);
     this.roots.delete(root);
-    // Pause and resume the mutation observer to stop observing `root`.
+    // Pause the mutation observer to stop observing `root`.
     this.pauseObserving();
+
+    if (this.roots.size === 0) {
+      this.mutationObserver = null;
+      this.windowElement = null;
+      this.pendingrAF = null;
+      this.pendingElements.clear();
+      return true;
+    }
+
+    // Resume observing all other roots.
     this.resumeObserving();
-
-    return this.roots.size === 0;
+    return false;
   }
@@ -183,2 +202,6 @@
   pauseObserving() {
+    if (!this.mutationObserver) {
+      return;
+    }
+
     this.translateMutations(this.mutationObserver.takeRecords());
@@ -194,2 +217,6 @@ this.mutationObserver.disconnect();
   resumeObserving() {
+    if (!this.mutationObserver) {
+      return;
+    }
+
     for (const root of this.roots) {
@@ -196,0 +223,0 @@ this.mutationObserver.observe(root, this.observerConfig);

src/localization.js

 /* eslint no-console: ["error", { allow: ["warn", "error"] }] */
 /* global console */
 
-import { CachedAsyncIterable } from "../../fluent/src/index";
+import { CachedAsyncIterable } from "cached-iterable";
 
@@ -20,7 +20,7 @@ /**
    */
-  constructor(resourceIds, generateMessages) {
+  constructor(resourceIds = [], generateMessages) {
     this.resourceIds = resourceIds;
     this.generateMessages = generateMessages;
-    this.ctxs =
-      new CachedAsyncIterable(this.generateMessages(this.resourceIds));
+    this.ctxs = CachedAsyncIterable.from(
+      this.generateMessages(this.resourceIds));
   }
@@ -31,2 +31,3 @@
     this.onChange();
+    return this.resourceIds.length;
   }
@@ -37,2 +38,3 @@
     this.onChange();
+    return this.resourceIds.length;
   }
@@ -158,4 +160,5 @@
   onChange() {
-    this.ctxs =
-      new CachedAsyncIterable(this.generateMessages(this.resourceIds));
+    this.ctxs = CachedAsyncIterable.from(
+      this.generateMessages(this.resourceIds));
+    this.ctxs.touchNext(2);
   }
@@ -162,0 +165,0 @@ }

test/dom_localization_test.js

@@ -11,12 +11,5 @@ import assert from "assert";
 
-const mockWindow = {
-  MutationObserver: class MutationObserver {
-    takeRecords() {return new Set();}
-    disconnect() {}
-  }
-};
-
 suite("translateFragment", function() {
   test("translates a node", async function() {
-    const domLoc = new DOMLocalization(mockWindow, ["test.ftl"], mockGenerateMessages);
+    const domLoc = new DOMLocalization(["test.ftl"], mockGenerateMessages);
 
@@ -34,3 +27,3 @@ const frag = document.createDocumentFragment();
   test("does not inject content into a node with missing translation", async function() {
-    const domLoc = new DOMLocalization(mockWindow, ["test.ftl"], mockGenerateMessages);
+    const domLoc = new DOMLocalization(["test.ftl"], mockGenerateMessages);
 
@@ -37,0 +30,0 @@ const frag = document.createDocumentFragment();

test/extra_text_markup_test.js

 import assert from 'assert';
 import translateElement from '../src/overlay';
-import {elem} from './util';
+import {elem} from './index';
 
@@ -5,0 +5,0 @@ suite('Localized text markup', function() {

test/overlay_attributes_test.js

 import assert from 'assert';
 import translateElement from '../src/overlay';
-import {elem} from './util';
+import {elem} from './index';
 
@@ -5,0 +5,0 @@ suite('Top-level attributes', function() {

test/overlay_functional_children_test.js

 import assert from 'assert';
 import translateElement from '../src/overlay';
-import {elem} from './util';
+import {elem} from './index';
 
@@ -5,0 +5,0 @@ suite('Child without name', function() {

test/overlay_text_children_test.js

 import assert from 'assert';
 import translateElement from '../src/overlay';
-import {elem} from './util';
+import {elem} from './index';
 
@@ -5,0 +5,0 @@ suite('Text-semantic argument elements', function() {

No alert changes

Improved metrics

Total package byte prevSize

53851

increased by2.21%

Lines of code

1448

increased by1.47%

Worsened metrics

Dependency count

1

increased byInfinity%

Number of package files

15

decreased by-6.25%

Dependency changes

• + Addedcached-iterable@^0.2.1

• + Addedcached-iterable@0.2.1(transitive)