[api-minor] Produce non-translated/non-polyfilled builds by default

README.md

@@ -23,7 +23,9 @@ Feel free to stop by #pdfjs on irc.mozilla.org for questions or guidance.
 
 ### Online demo
 
-+ https://mozilla.github.io/pdf.js/web/viewer.html
++ Modern browsers: https://mozilla.github.io/pdf.js/web/viewer.html
+
++ Older browsers: https://mozilla.github.io/pdf.js/es5/web/viewer.html
 
 ### Browser Extensions
 

examples/node/getinfo.js

@@ -8,7 +8,7 @@
 //
 
 // Run `gulp dist-install` to generate 'pdfjs-dist' npm package files.
-var pdfjsLib = require("pdfjs-dist");
+var pdfjsLib = require("pdfjs-dist/es5/build/pdf.js");
 
 // Loading file from file system into typed array
 var pdfPath = process.argv[2] || "../../web/compressed.tracemonkey-pldi-09.pdf";

examples/node/pdf2png/pdf2png.js

@@ -48,7 +48,7 @@ NodeCanvasFactory.prototype = {
   },
 };
 
-var pdfjsLib = require("pdfjs-dist");
+var pdfjsLib = require("pdfjs-dist/es5/build/pdf.js");
 
 // Relative path of the PDF file.
 var pdfURL = "../../../web/compressed.tracemonkey-pldi-09.pdf";

examples/node/pdf2svg.js

@@ -14,7 +14,7 @@ var stream = require("stream");
 require("./domstubs.js").setStubs(global);
 
 // Run `gulp dist-install` to generate 'pdfjs-dist' npm package files.
-var pdfjsLib = require("pdfjs-dist");
+var pdfjsLib = require("pdfjs-dist/es5/build/pdf.js");
 
 // Loading file from file system into typed array
 var pdfPath = process.argv[2] || "../../web/compressed.tracemonkey-pldi-09.pdf";

external/dist/README.md

@@ -7,4 +7,7 @@ parsing and rendering PDFs.
 This is a pre-built version of the PDF.js source code. It is automatically
 generated by the build scripts.
 
+For usage with older browsers/environments, without support for modern features
+such as e.g. `ReadableStream`, please refer to the `es5` folder.
+
 See https://github.com/mozilla/pdf.js for learning and contributing.

gulpfile.js

@@ -49,7 +49,9 @@ var EXTENSION_SRC_DIR = "extensions/";
 var BASELINE_DIR = BUILD_DIR + "baseline/";
 var MOZCENTRAL_BASELINE_DIR = BUILD_DIR + "mozcentral.baseline/";
 var GENERIC_DIR = BUILD_DIR + "generic/";
+var GENERIC_ES5_DIR = BUILD_DIR + "generic-es5/";
 var COMPONENTS_DIR = BUILD_DIR + "components/";
+var COMPONENTS_ES5_DIR = BUILD_DIR + "components-es5/";
 var IMAGE_DECODERS_DIR = BUILD_DIR + "image_decoders";
 var DEFAULT_PREFERENCES_DIR = BUILD_DIR + "default_preferences/";
 var MINIFIED_DIR = BUILD_DIR + "minified/";
@@ -85,6 +87,7 @@ var AUTOPREFIXER_CONFIG = {
 
 var DEFINES = {
   PRODUCTION: true,
+  SKIP_BABEL: true,
   TESTING: false,
   // The main build targets:
   GENERIC: false,
@@ -94,7 +97,6 @@ var DEFINES = {
   MINIFIED: false,
   COMPONENTS: false,
   LIB: false,
-  SKIP_BABEL: false,
   IMAGE_DECODERS: false,
 };
 
@@ -177,8 +179,7 @@ function createWebpackConfig(defines, output) {
     !bundleDefines.MOZCENTRAL &&
     !bundleDefines.CHROME &&
     !bundleDefines.TESTING;
-  var skipBabel =
-    bundleDefines.SKIP_BABEL || process.env["SKIP_BABEL"] === "true";
+  var skipBabel = bundleDefines.SKIP_BABEL;
 
   // Required to expose e.g., the `window` object.
   output.globalObject = "this";
@@ -734,8 +735,8 @@ function preprocessHTML(source, defines) {
   return createStringSource(source.substr(i + 1), out);
 }
 
-// Builds the generic production viewer that should be compatible with most
-// modern HTML5 browsers.
+// Builds the generic production viewer that is only compatible with up-to-date
+// HTML5 browsers, which implements modern ECMAScript features.
 gulp.task(
   "generic",
   gulp.series("buildnumber", "default_preferences", "locale", function() {
@@ -777,6 +778,49 @@ gulp.task(
   })
 );
 
+// Builds the generic production viewer that should be compatible with most
+// older HTML5 browsers.
+gulp.task(
+  "generic-es5",
+  gulp.series("buildnumber", "default_preferences", "locale", function() {
+    console.log();
+    console.log("### Creating generic (ES5) viewer");
+    var defines = builder.merge(DEFINES, { GENERIC: true, SKIP_BABEL: false });
+
+    rimraf.sync(GENERIC_ES5_DIR);
+
+    return merge([
+      createBundle(defines).pipe(gulp.dest(GENERIC_ES5_DIR + "build")),
+      createWebBundle(defines).pipe(gulp.dest(GENERIC_ES5_DIR + "web")),
+      gulp
+        .src(COMMON_WEB_FILES, { base: "web/" })
+        .pipe(gulp.dest(GENERIC_ES5_DIR + "web")),
+      gulp.src("LICENSE").pipe(gulp.dest(GENERIC_ES5_DIR)),
+      gulp
+        .src(
+          ["web/locale/*/viewer.properties", "web/locale/locale.properties"],
+          { base: "web/" }
+        )
+        .pipe(gulp.dest(GENERIC_ES5_DIR + "web")),
+      gulp
+        .src(["external/bcmaps/*.bcmap", "external/bcmaps/LICENSE"], {
+          base: "external/bcmaps",
+        })
+        .pipe(gulp.dest(GENERIC_ES5_DIR + "web/cmaps")),
+      preprocessHTML("web/viewer.html", defines).pipe(
+        gulp.dest(GENERIC_ES5_DIR + "web")
+      ),
+      preprocessCSS("web/viewer.css", "generic", defines, true)
+        .pipe(postcss([autoprefixer(AUTOPREFIXER_CONFIG)]))
+        .pipe(gulp.dest(GENERIC_ES5_DIR + "web")),
+
+      gulp
+        .src("web/compressed.tracemonkey-pldi-09.pdf")
+        .pipe(gulp.dest(GENERIC_ES5_DIR + "web")),
+    ]);
+  })
+);
+
 gulp.task(
   "components",
   gulp.series("buildnumber", function() {
@@ -803,6 +847,38 @@ gulp.task(
   })
 );
 
+gulp.task(
+  "components-es5",
+  gulp.series("buildnumber", function() {
+    console.log();
+    console.log("### Creating generic (ES5) components");
+    var defines = builder.merge(DEFINES, {
+      COMPONENTS: true,
+      GENERIC: true,
+      SKIP_BABEL: false,
+    });
+
+    rimraf.sync(COMPONENTS_ES5_DIR);
+
+    var COMPONENTS_IMAGES = [
+      "web/images/annotation-*.svg",
+      "web/images/loading-icon.gif",
+      "web/images/shadow.png",
+      "web/images/texture.png",
+    ];
+
+    return merge([
+      createComponentsBundle(defines).pipe(gulp.dest(COMPONENTS_ES5_DIR)),
+      gulp
+        .src(COMPONENTS_IMAGES)
+        .pipe(gulp.dest(COMPONENTS_ES5_DIR + "images")),
+      preprocessCSS("web/pdf_viewer.css", "components", defines, true)
+        .pipe(postcss([autoprefixer(AUTOPREFIXER_CONFIG)]))
+        .pipe(gulp.dest(COMPONENTS_ES5_DIR)),
+    ]);
+  })
+);
+
 gulp.task(
   "image_decoders",
   gulp.series("buildnumber", function() {
@@ -960,10 +1036,7 @@ gulp.task(
   gulp.series("buildnumber", "default_preferences", function() {
     console.log();
     console.log("### Building mozilla-central extension");
-    var defines = builder.merge(DEFINES, {
-      MOZCENTRAL: true,
-      SKIP_BABEL: true,
-    });
+    var defines = builder.merge(DEFINES, { MOZCENTRAL: true });
 
     var MOZCENTRAL_DIR = BUILD_DIR + "mozcentral/",
       MOZCENTRAL_EXTENSION_DIR = MOZCENTRAL_DIR + "browser/extensions/pdfjs/",
@@ -1024,7 +1097,7 @@ gulp.task(
   gulp.series("buildnumber", "default_preferences", "locale", function() {
     console.log();
     console.log("### Building Chromium extension");
-    var defines = builder.merge(DEFINES, { CHROME: true });
+    var defines = builder.merge(DEFINES, { CHROME: true, SKIP_BABEL: false });
 
     var CHROME_BUILD_DIR = BUILD_DIR + "/chromium/",
       CHROME_BUILD_CONTENT_DIR = CHROME_BUILD_DIR + "/content/";
@@ -1123,7 +1196,7 @@ gulp.task(
     }
     function preprocess(content) {
       var skipBabel =
-        process.env["SKIP_BABEL"] === "true" ||
+        bundleDefines.SKIP_BABEL ||
         /\/\*\s*no-babel-preset\s*\*\//.test(content);
       content = preprocessor2.preprocessPDFJSCode(ctx, content);
       content = babel.transform(content, {
@@ -1152,16 +1225,17 @@ gulp.task(
     }
     var babel = require("@babel/core");
     var versionInfo = getVersionJSON();
+    var bundleDefines = builder.merge(DEFINES, {
+      GENERIC: true,
+      LIB: true,
+      BUNDLE_VERSION: versionInfo.version,
+      BUNDLE_BUILD: versionInfo.commit,
+      TESTING: process.env["TESTING"] === "true",
+    });
     var ctx = {
       rootPath: __dirname,
       saveComments: false,
-      defines: builder.merge(DEFINES, {
-        GENERIC: true,
-        LIB: true,
-        BUNDLE_VERSION: versionInfo.version,
-        BUNDLE_BUILD: versionInfo.commit,
-        TESTING: process.env["TESTING"] === "true",
-      }),
+      defines: bundleDefines,
       map: {
         "pdfjs-lib": "../pdf",
       },
@@ -1192,27 +1266,38 @@ gulp.task(
 
 gulp.task(
   "publish",
-  gulp.series("generic", function(done) {
+  gulp.series("generic", "generic-es5", function(done) {
     var version = JSON.parse(
       fs.readFileSync(BUILD_DIR + "version.json").toString()
     ).version;
 
     config.stableVersion = config.betaVersion;
     config.betaVersion = version;
 
-    createStringSource(CONFIG_FILE, JSON.stringify(config, null, 2))
-      .pipe(gulp.dest("."))
-      .on("end", function() {
-        var targetName = "pdfjs-" + version + "-dist.zip";
-        gulp
-          .src(BUILD_DIR + "generic/**")
-          .pipe(zip(targetName))
-          .pipe(gulp.dest(BUILD_DIR))
-          .on("end", function() {
-            console.log("Built distribution file: " + targetName);
-            done();
-          });
-      });
+    var targetName = "pdfjs-" + version + "-dist.zip";
+    var targetNameES5 = "pdfjs-" + version + "-es5-dist.zip";
+
+    return merge([
+      createStringSource(CONFIG_FILE, JSON.stringify(config, null, 2)).pipe(
+        gulp.dest(".")
+      ),
+
+      gulp
+        .src(GENERIC_DIR + "**")
+        .pipe(zip(targetName))
+        .pipe(gulp.dest(BUILD_DIR))
+        .on("end", function() {
+          console.log("Built distribution file: " + targetName);
+        }),
+
+      gulp
+        .src(GENERIC_ES5_DIR + "**")
+        .pipe(zip(targetNameES5))
+        .pipe(gulp.dest(BUILD_DIR))
+        .on("end", function() {
+          console.log("Built distribution file: " + targetNameES5);
+        }),
+    ]);
   })
 );
 
@@ -1425,6 +1510,9 @@ gulp.task("gh-pages-prepare", function() {
     vfs
       .src(GENERIC_DIR + "**/*", { base: GENERIC_DIR, stripBOM: false })
       .pipe(gulp.dest(GH_PAGES_DIR)),
+    vfs
+      .src(GENERIC_ES5_DIR + "**/*", { base: GENERIC_ES5_DIR, stripBOM: false })
+      .pipe(gulp.dest(GH_PAGES_DIR + "es5/")),
     gulp
       .src("test/features/**/*", { base: "test/" })
       .pipe(gulp.dest(GH_PAGES_DIR)),
@@ -1503,6 +1591,7 @@ gulp.task(
   "web",
   gulp.series(
     "generic",
+    "generic-es5",
     "jsdoc",
     "gh-pages-prepare",
     "wintersmith",
@@ -1514,7 +1603,9 @@ gulp.task(
   "dist-pre",
   gulp.series(
     "generic",
+    "generic-es5",
     "components",
+    "components-es5",
     "image_decoders",
     "lib",
     "minified",
@@ -1602,6 +1693,15 @@ gulp.task(
             SRC_DIR + "pdf.worker.entry.js",
           ])
           .pipe(gulp.dest(DIST_DIR + "build/")),
+        gulp
+          .src([
+            GENERIC_ES5_DIR + "build/pdf.js",
+            GENERIC_ES5_DIR + "build/pdf.js.map",
+            GENERIC_ES5_DIR + "build/pdf.worker.js",
+            GENERIC_ES5_DIR + "build/pdf.worker.js.map",
+            SRC_DIR + "pdf.worker.entry.js",
+          ])
+          .pipe(gulp.dest(DIST_DIR + "es5/build/")),
         gulp
           .src(MINIFIED_DIR + "build/pdf.js")
           .pipe(rename("pdf.min.js"))
@@ -1617,6 +1717,9 @@ gulp.task(
         gulp
           .src(COMPONENTS_DIR + "**/*", { base: COMPONENTS_DIR })
           .pipe(gulp.dest(DIST_DIR + "web/")),
+        gulp
+          .src(COMPONENTS_ES5_DIR + "**/*", { base: COMPONENTS_ES5_DIR })
+          .pipe(gulp.dest(DIST_DIR + "es5/web/")),
         gulp
           .src(IMAGE_DECODERS_DIR + "**/*", { base: IMAGE_DECODERS_DIR })
           .pipe(gulp.dest(DIST_DIR + "image_decoders")),

package.json

@@ -53,7 +53,7 @@
     "yargs": "^11.1.1"
   },
   "scripts": {
-    "test": "env SKIP_BABEL=true gulp npm-test"
+    "test": "gulp npm-test"
   },
   "repository": {
     "type": "git",

src/shared/compatibility.js

@@ -14,9 +14,11 @@
  */
 /* eslint no-var: error */
 
-// Skip compatibility checks for modern builds and if we already ran the module.
+// Skip compatibility checks for modern builds (unless we're running the
+// unit-tests on Node.js/Travis) and if we already ran the module.
 if (
-  (typeof PDFJSDev === "undefined" || !PDFJSDev.test("SKIP_BABEL")) &&
+  (typeof PDFJSDev === "undefined" ||
+    PDFJSDev.test("!SKIP_BABEL || (LIB && TESTING)")) &&
   (typeof globalThis === "undefined" || !globalThis._pdfjsCompatibilityChecked)
 ) {
   // Provides support for globalThis in legacy browsers.