feat(build): CommonJS & AMD support

#789
FineUploader · May 11, 2016 · 2de6c8f · 2de6c8f
2 parents 1e7f125 + e3a8f8e
commit 2de6c8f
Show file tree

Hide file tree

Showing 29 changed files with 415 additions and 50 deletions.
diff --git a/Gruntfile.js b/Gruntfile.js
@@ -24,6 +24,7 @@ module.exports = function(grunt) {
     path = require("path");
     pkg = require("./package.json");
     paths = {
+        commonJs: "./lib/commonJs",
         dist: path.join("./_dist", pkg.version),
         build: "./_build",
         src: "./client",

diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 [![Fine Uploader](http://fineuploader.com/img/FineUploader_logo.png)](http://fineuploader.com/)
 
-Version: 5.7.1
+Version: 5.8.0
 
 [![Build Status](https://travis-ci.org/FineUploader/fine-uploader.png?branch=master)](https://travis-ci.org/FineUploader/fine-uploader)
 

diff --git a/client/js/image-support/scaler.js b/client/js/image-support/scaler.js
@@ -342,7 +342,7 @@ qq.extend(qq.Scaler.prototype, {
 
         reader.onload = function() {
             originalImageDataUri = reader.result;
-            insertionEffort.success(ExifRestorer.restore(originalImageDataUri, scaledImageDataUri));
+            insertionEffort.success(qq.ExifRestorer.restore(originalImageDataUri, scaledImageDataUri));
         };
 
         reader.onerror = function() {

diff --git a/client/js/s3/request-signer.js b/client/js/s3/request-signer.js
@@ -77,19 +77,19 @@ qq.s3.RequestSigner = function(o) {
             },
 
             signApiRequest: function(signatureConstructor, headersStr, signatureEffort) {
-                var headersWordArray = CryptoJS.enc.Utf8.parse(headersStr),
-                    headersHmacSha1 = CryptoJS.HmacSHA1(headersWordArray, credentialsProvider.get().secretKey),
-                    headersHmacSha1Base64 = CryptoJS.enc.Base64.stringify(headersHmacSha1);
+                var headersWordArray = qq.CryptoJS.enc.Utf8.parse(headersStr),
+                    headersHmacSha1 = qq.CryptoJS.HmacSHA1(headersWordArray, credentialsProvider.get().secretKey),
+                    headersHmacSha1Base64 = qq.CryptoJS.enc.Base64.stringify(headersHmacSha1);
 
                 generateHeaders(signatureConstructor, headersHmacSha1Base64, signatureEffort);
             },
 
             signPolicy: function(policy, signatureEffort, updatedAccessKey, updatedSessionToken) {
                 var policyStr = JSON.stringify(policy),
-                    policyWordArray = CryptoJS.enc.Utf8.parse(policyStr),
-                    base64Policy = CryptoJS.enc.Base64.stringify(policyWordArray),
-                    policyHmacSha1 = CryptoJS.HmacSHA1(base64Policy, credentialsProvider.get().secretKey),
-                    policyHmacSha1Base64 = CryptoJS.enc.Base64.stringify(policyHmacSha1);
+                    policyWordArray = qq.CryptoJS.enc.Utf8.parse(policyStr),
+                    base64Policy = qq.CryptoJS.enc.Base64.stringify(policyWordArray),
+                    policyHmacSha1 = qq.CryptoJS.HmacSHA1(base64Policy, credentialsProvider.get().secretKey),
+                    policyHmacSha1Base64 = qq.CryptoJS.enc.Base64.stringify(policyHmacSha1);
 
                 signatureEffort.success({
                     policy: base64Policy,
@@ -164,16 +164,16 @@ qq.s3.RequestSigner = function(o) {
                                 promise.failure(e.target.error);
                             }
                             else {
-                                var wordArray = CryptoJS.lib.WordArray.create(e.target.result);
-                                promise.success(CryptoJS.SHA256(wordArray).toString());
+                                var wordArray = qq.CryptoJS.lib.WordArray.create(e.target.result);
+                                promise.success(qq.CryptoJS.SHA256(wordArray).toString());
                             }
                         }
                     };
                     reader.readAsArrayBuffer(body);
                 }
                 else {
                     body = body || "";
-                    promise.success(CryptoJS.SHA256(body).toString());
+                    promise.success(qq.CryptoJS.SHA256(body).toString());
                 }
 
                 return promise;
@@ -187,7 +187,7 @@ qq.s3.RequestSigner = function(o) {
             getStringToSign: function(signatureSpec) {
                 var canonicalRequest = v4.getCanonicalRequest(signatureSpec),
                     date = qq.s3.util.getV4PolicyDate(signatureSpec.date, signatureSpec.drift),
-                    hashedRequest = CryptoJS.SHA256(canonicalRequest).toString(),
+                    hashedRequest = qq.CryptoJS.SHA256(canonicalRequest).toString(),
                     scope = v4.getScope(signatureSpec.date, options.signatureSpec.region),
                     stringToSignTemplate = "AWS4-HMAC-SHA256\n{}\n{}\n{}";
 
@@ -217,18 +217,18 @@ qq.s3.RequestSigner = function(o) {
                     matches = headersPattern.exec(headersStr),
                     dateKey, dateRegionKey, dateRegionServiceKey, signingKey;
 
-                dateKey = CryptoJS.HmacSHA256(matches[1], "AWS4" + secretKey);
-                dateRegionKey = CryptoJS.HmacSHA256(matches[2], dateKey);
-                dateRegionServiceKey = CryptoJS.HmacSHA256("s3", dateRegionKey);
-                signingKey = CryptoJS.HmacSHA256("aws4_request", dateRegionServiceKey);
+                dateKey = qq.CryptoJS.HmacSHA256(matches[1], "AWS4" + secretKey);
+                dateRegionKey = qq.CryptoJS.HmacSHA256(matches[2], dateKey);
+                dateRegionServiceKey = qq.CryptoJS.HmacSHA256("s3", dateRegionKey);
+                signingKey = qq.CryptoJS.HmacSHA256("aws4_request", dateRegionServiceKey);
 
-                generateHeaders(signatureConstructor, CryptoJS.HmacSHA256(headersStr, signingKey), signatureEffort);
+                generateHeaders(signatureConstructor, qq.CryptoJS.HmacSHA256(headersStr, signingKey), signatureEffort);
             },
 
             signPolicy: function(policy, signatureEffort, updatedAccessKey, updatedSessionToken) {
                 var policyStr = JSON.stringify(policy),
-                    policyWordArray = CryptoJS.enc.Utf8.parse(policyStr),
-                    base64Policy = CryptoJS.enc.Base64.stringify(policyWordArray),
+                    policyWordArray = qq.CryptoJS.enc.Utf8.parse(policyStr),
+                    base64Policy = qq.CryptoJS.enc.Base64.stringify(policyWordArray),
                     secretKey = credentialsProvider.get().secretKey,
                     credentialPattern = /.+\/(.+)\/(.+)\/s3\/aws4_request/,
                     credentialCondition = (function() {
@@ -245,14 +245,14 @@ qq.s3.RequestSigner = function(o) {
                     matches, dateKey, dateRegionKey, dateRegionServiceKey, signingKey;
 
                 matches = credentialPattern.exec(credentialCondition);
-                dateKey = CryptoJS.HmacSHA256(matches[1], "AWS4" + secretKey);
-                dateRegionKey = CryptoJS.HmacSHA256(matches[2], dateKey);
-                dateRegionServiceKey = CryptoJS.HmacSHA256("s3", dateRegionKey);
-                signingKey = CryptoJS.HmacSHA256("aws4_request", dateRegionServiceKey);
+                dateKey = qq.CryptoJS.HmacSHA256(matches[1], "AWS4" + secretKey);
+                dateRegionKey = qq.CryptoJS.HmacSHA256(matches[2], dateKey);
+                dateRegionServiceKey = qq.CryptoJS.HmacSHA256("s3", dateRegionKey);
+                signingKey = qq.CryptoJS.HmacSHA256("aws4_request", dateRegionServiceKey);
 
                 signatureEffort.success({
                     policy: base64Policy,
-                    signature: CryptoJS.HmacSHA256(base64Policy, signingKey).toString()
+                    signature: qq.CryptoJS.HmacSHA256(base64Policy, signingKey).toString()
                 }, updatedAccessKey, updatedSessionToken);
             }
         };
@@ -487,7 +487,7 @@ qq.s3.RequestSigner = function(o) {
                 queryParams = {v4: true};
             }
 
-            if (credentialsProvider.get().secretKey && window.CryptoJS) {
+            if (credentialsProvider.get().secretKey && qq.CryptoJS) {
                 if (credentialsProvider.get().expiration.getTime() > Date.now()) {
                     determineSignatureClientSide(id, toBeSigned, signatureEffort);
                 }

diff --git a/client/js/third-party/ExifRestorer.js b/client/js/third-party/ExifRestorer.js
@@ -1,7 +1,7 @@
 //Based on MinifyJpeg
 //http://elicon.blog57.fc2.com/blog-entry-206.html
 
-var ExifRestorer = (function()
+qq.ExifRestorer = (function()
 {
 
 	var ExifRestorer = {};

diff --git a/client/js/third-party/crypto-js/core.js b/client/js/third-party/crypto-js/core.js
@@ -7,7 +7,7 @@ code.google.com/p/crypto-js/wiki/License
 /**
  * CryptoJS core components.
  */
-var CryptoJS = CryptoJS || (function (Math, undefined) {
+qq.CryptoJS = (function (Math, undefined) {
     /**
      * CryptoJS namespace.
      */

diff --git a/client/js/third-party/crypto-js/enc-base64.js b/client/js/third-party/crypto-js/enc-base64.js
@@ -6,7 +6,7 @@ code.google.com/p/crypto-js/wiki/License
 */
 (function () {
     // Shortcuts
-    var C = CryptoJS;
+    var C = qq.CryptoJS;
     var C_lib = C.lib;
     var WordArray = C_lib.WordArray;
     var C_enc = C.enc;

diff --git a/client/js/third-party/crypto-js/hmac.js b/client/js/third-party/crypto-js/hmac.js
@@ -6,7 +6,7 @@ code.google.com/p/crypto-js/wiki/License
 */
 (function () {
     // Shortcuts
-    var C = CryptoJS;
+    var C = qq.CryptoJS;
     var C_lib = C.lib;
     var Base = C_lib.Base;
     var C_enc = C.enc;

diff --git a/client/js/third-party/crypto-js/lib-typedarrays.js b/client/js/third-party/crypto-js/lib-typedarrays.js
@@ -1,17 +1,17 @@
-/*
-CryptoJS v3.1.2
-code.google.com/p/crypto-js
-(c) 2009-2013 by Jeff Mott. All rights reserved.
-code.google.com/p/crypto-js/wiki/License
-*/
+/*
+CryptoJS v3.1.2
+code.google.com/p/crypto-js
+(c) 2009-2013 by Jeff Mott. All rights reserved.
+code.google.com/p/crypto-js/wiki/License
+*/
 (function () {
     // Check if typed arrays are supported
     if (typeof ArrayBuffer != 'function') {
         return;
     }
 
     // Shortcuts
-    var C = CryptoJS;
+    var C = qq.CryptoJS;
     var C_lib = C.lib;
     var WordArray = C_lib.WordArray;
 

diff --git a/client/js/third-party/crypto-js/sha1.js b/client/js/third-party/crypto-js/sha1.js
@@ -6,7 +6,7 @@ code.google.com/p/crypto-js/wiki/License
 */
 (function () {
     // Shortcuts
-    var C = CryptoJS;
+    var C = qq.CryptoJS;
     var C_lib = C.lib;
     var WordArray = C_lib.WordArray;
     var Hasher = C_lib.Hasher;

diff --git a/client/js/third-party/crypto-js/sha256.js b/client/js/third-party/crypto-js/sha256.js
@@ -1,12 +1,12 @@
-/*
-CryptoJS v3.1.2
-code.google.com/p/crypto-js
-(c) 2009-2013 by Jeff Mott. All rights reserved.
-code.google.com/p/crypto-js/wiki/License
-*/
+/*
+CryptoJS v3.1.2
+code.google.com/p/crypto-js
+(c) 2009-2013 by Jeff Mott. All rights reserved.
+code.google.com/p/crypto-js/wiki/License
+*/
 (function (Math) {
     // Shortcuts
-    var C = CryptoJS;
+    var C = qq.CryptoJS;
     var C_lib = C.lib;
     var WordArray = C_lib.WordArray;
     var Hasher = C_lib.Hasher;

diff --git a/client/js/version.js b/client/js/version.js
@@ -1,2 +1,2 @@
 /*global qq */
-qq.version = "5.7.1";
+qq.version = "5.8.0";
diff --git a/docs/features/forms.jmd b/docs/features/forms.jmd
@@ -79,6 +79,11 @@ The form support feature, like most other Fine Uploader features, works in all s
 The simplest use-case results in a very simple example, with only one line of JavaScript!  Here is a complete HTML
 file that integrates Fine Uploader into an existing form:
 
+{{ alert(
+"""There are many ways to load Fine Uploader into your project. The code below creates a global `qq` variable, but there are
+other, better options. Please see [modules feature page](modules.html) for more details.""") }}
+
+
 ```html
 <html>
     <head>