@karpeleslab/klbfw 0.1.8 → 0.1.11

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Karpelès Lab Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,95 @@
+# klbfw
+
+Karpeles Lab framework lib
+
+This lib is used on frontend sites to communicate through the KLB API.
+
+# API
+
+## rest(api, method, params, context)
+
+Performs a rest query and returns a promise to the response.
+
+## upload.init(api, params, context)
+
+Perform an upload. This API will show a file selector and allow the user to select one or more files.
+
+## getPrefix()
+
+Returns the language/etc prefix part of the URL, for example `/l/en-US`. The prefix should be inserted before the path in the URL.
+
+## getSettings()
+
+Returns active settings if any.
+
+## getRealm()
+
+Returns realm information.
+
+## getContext()
+
+Returns current context.
+
+## setContext(ctx)
+
+Modifies the current context.
+
+## getMode()
+
+Returns the current rending mode `ssr`, `js` etc.
+
+## getHostname()
+
+Returns the hostname part of the current URL.
+
+## getRegistry()
+
+Returns data from the registry.
+
+## getLocale()
+
+Returns the currently active locale, for example `en-US`.
+
+## getUserGroup()
+
+Returns `g` from context, which is the current active user group.
+
+## getCurrency()
+
+Returns the currently selected currency, such as `USD`.
+
+## getToken()
+
+Returns the CSRF token.
+
+## getUrl()
+
+Returns the active URL.
+
+## getPath()
+
+Returns the non-prefixed request path.
+
+## getUuid()
+
+Returns the UUID of the request.
+
+## getInitialState()
+
+Returns the initial state passed from SSR execution (or null if no SSR was performed).
+
+# Cookie functions
+
+Those methods are a requirement as using things like `document.cookie` will not work in SSR mode. The methods described here will work when SSR is enabled, and will cause cookies to be added to the HTTP response.
+
+## getCookie(cookie)
+
+Get the value of a specific cookie.
+
+## setCookie(cookie, value)
+
+Sets value for a cookie.
+
+## hasCookie(cookie)
+
+Checks for presence of a given cookie.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@karpeleslab/klbfw",
-  "version": "0.1.8",
+  "version": "0.1.11",
   "description": "Frontend Framework",
   "main": "index.js",
   "scripts": {

package/upload.js

@@ -100,7 +100,7 @@ module.exports.upload = (function () {
 
 
     function sendprogress() {
-        if (upload.onprogress == undefined) return;
+        if (typeof upload.onprogress === "undefined") return;
 
         upload.onprogress(upload.getStatus());
     }
@@ -117,35 +117,55 @@ module.exports.upload = (function () {
         params["type"] = up.file.type;
 
         rest.rest(up.path, "POST", params, up.context).then(function (res) {
-            if (!res["data"]["Cloud_Aws_Bucket_Upload__"]) {
-                // invalid data
-                up.reject();
-                delete upload_running[up.up_id];
-                upload_failed.push(up);
+            // Method 1: aws signed multipart upload
+            if (res["data"]["Cloud_Aws_Bucket_Upload__"]) {
+                up.info = res["data"]; // contains stuff like Bucket_Endpoint, Key, etc
+
+                // ok we are ready to upload - this will initiate an upload
+                awsReq(up.info, "POST", "uploads=", "", {"Content-Type": up.file.type, "X-Amz-Acl": "private"}, up.context)
+                    .then(response => response.text())
+                    .then(str => (new DOMParser()).parseFromString(str, "text/xml"))
+                    .then(dom => dom.querySelector('UploadId').innerHTML)
+                    .then(function (uploadId) {
+                        up.uploadId = uploadId;
+
+                        // ok, let's compute block size so we know how many parts we need to send
+                        var fsize = up.file.size;
+                        var bsize = Math.ceil(fsize / 10000); // we want ~10k parts
+                        if (bsize < 5242880) bsize = 5242880; // minimum block size = 5MB
+
+                        up.method = 'aws';
+                        up.bsize = bsize;
+                        up.blocks = Math.ceil(fsize / bsize);
+                        up.b = {};
+                        up['status'] = 'uploading';
+                        upload.run();
+                    }).catch(res => failure(up, res))
                 return;
             }
+            // Method 2: PUT requests
+            if (res["data"]["PUT"]) {
+                var fsize = up.file.size;
+                var bsize = fsize; // upload file in a single block
+                if (res["data"]["Blocksize"]) {
+                    // this upload target supports multipart PUT upload
+                    bsize = res["data"]["Blocksize"]; // multipart upload
+                }
 
-            up.info = res["data"]; // contains stuff like Bucket_Endpoint, Key, etc
-
-            // ok we are ready to upload - this will initiate an upload
-            awsReq(up.info, "POST", "uploads=", "", {"Content-Type": up.file.type, "X-Amz-Acl": "private"}, up.context)
-                .then(response => response.text())
-                .then(str => (new DOMParser()).parseFromString(str, "text/xml"))
-                .then(dom => dom.querySelector('UploadId').innerHTML)
-                .then(function (uploadId) {
-                    up.uploadId = uploadId;
-
-                    // ok, let's compute block size so we know how many parts we need to send
-                    var fsize = up.file.size;
-                    var bsize = Math.ceil(fsize / 10000); // we want ~10k parts
-                    if (bsize < 5242880) bsize = 5242880; // minimum block size = 5MB
-
-                    up.bsize = bsize;
-                    up.blocks = Math.ceil(fsize / bsize);
-                    up.b = {};
-                    up['status'] = 'uploading';
-                    upload.run();
-                }).catch(res => failure(up, res))
+                up.info = res["data"];
+                up.method = 'put';
+                up.bsize = bsize;
+                up.blocks = Math.ceil(fsize / bsize);
+                up.b = {};
+                up['status'] = 'uploading';
+                upload.run();
+                return;
+            }
+            // invalid data
+            delete upload_running[up.up_id];
+            upload_failed.push(up);
+            up.reject();
+            return;
         })
             .catch(res => failure(up, res));
     }
@@ -185,12 +205,36 @@ module.exports.upload = (function () {
 
         var reader = new FileReader();
         reader.addEventListener("loadend", function () {
-            awsReq(up.info, "PUT", "partNumber=" + (partno + 1) + "&uploadId=" + up.uploadId, reader.result, null, up.context)
-                .then(function (response) {
-                    up.b[partno] = response.headers.get("ETag");
+            switch(up.method) {
+            case 'aws':
+                awsReq(up.info, "PUT", "partNumber=" + (partno + 1) + "&uploadId=" + up.uploadId, reader.result, null, up.context)
+                    .then(function (response) {
+                        up.b[partno] = response.headers.get("ETag");
+                        sendprogress();
+                        upload.run();
+                    }).catch(res => failure(up, res));
+                break;
+            case 'put':
+                let headers = {};
+                headers["Content-Type"] = up.file.type;
+                if (up.blocks > 1) {
+                    // add Content-Range header
+                    // Content-Range: bytes start-end/*
+                    const end = start + reader.result.byteLength - 1; // inclusive
+                    headers["Content-Range"] = "bytes "+start+"-"+end+"/*";
+                }
+
+                fetch(up.info["PUT"], {
+                    method: "PUT",
+                    body: reader.result,
+                    headers: headers,
+                }).then(function (response) {
+                    up.b[partno] = "done";
                     sendprogress();
                     upload.run();
                 }).catch(res => failure(up, res));
+                break;
+            }
         });
 
         reader.addEventListener("error", function (e) {
@@ -221,27 +265,43 @@ module.exports.upload = (function () {
         up["done"] = d;
 
         if (p == 0) {
-            // complete, see https://docs.aws.amazon.com/AmazonS3/latest/API/mpUploadComplete.html
             up["status"] = "validating";
-            var xml = "<CompleteMultipartUpload>";
-            for (var i = 0; i < up.blocks; i++) {
-                xml += "<Part><PartNumber>" + (i + 1) + "</PartNumber><ETag>" + up.b[i] + "</ETag></Part>";
-            }
-            xml += "</CompleteMultipartUpload>";
-            awsReq(up.info, "POST", "uploadId=" + up.uploadId, xml, null, up.context)
-            .then(response => response.text())
-            .then(function (r) {
-                // if success, need to call finalize
-                rest.rest("Cloud/Aws/Bucket/Upload/" + up.info.Cloud_Aws_Bucket_Upload__ + ":handleComplete", "POST", {}, up.context).then(function (ares) {
-                    // SUCCESS!
+            switch(up.method) {
+            case 'aws':
+                // complete, see https://docs.aws.amazon.com/AmazonS3/latest/API/mpUploadComplete.html
+                var xml = "<CompleteMultipartUpload>";
+                for (var i = 0; i < up.blocks; i++) {
+                    xml += "<Part><PartNumber>" + (i + 1) + "</PartNumber><ETag>" + up.b[i] + "</ETag></Part>";
+                }
+                xml += "</CompleteMultipartUpload>";
+                awsReq(up.info, "POST", "uploadId=" + up.uploadId, xml, null, up.context)
+                .then(response => response.text())
+                .then(function (r) {
+                    // if success, need to call finalize
+                    rest.rest("Cloud/Aws/Bucket/Upload/" + up.info.Cloud_Aws_Bucket_Upload__ + ":handleComplete", "POST", {}, up.context).then(function (ares) {
+                        // SUCCESS!
+                        up["status"] = "complete";
+                        up["final"] = ares["data"];
+                        sendprogress();
+                        up.resolve(up);
+                        delete upload_running[up.up_id];
+                        upload.run();
+                    }).catch(res => failure(up, res));
+                }).catch(res => failure(up, res));
+                break;
+            case 'put':
+                // complete, directly call handleComplete
+                rest.rest(up.info.Complete, "POST", {}, up.context).then(function (ares) {
+                    // success!
                     up["status"] = "complete";
                     up["final"] = ares["data"];
                     sendprogress();
-                    up.resolve(up);
                     delete upload_running[up.up_id];
+                    up.resolve(up);
                     upload.run();
                 }).catch(res => failure(up, res));
-            }).catch(res => failure(up, res));
+                break;
+            }
         }
     }