@jd-data-limited/easy-fm 1.3.0 → 2.0.0

package/README.md

@@ -68,7 +68,7 @@ let range_request = layout.records.range()
 range_request.setOffset(50) // Starting from the 50th record...
 range_request.setLimit(100) // Fetch 100 records
 
-let records = await range_request.run()
+let records = await range_request.fetch()
 console.log(records)
 ```
 

package/dist/index.js

@@ -15,6 +15,13 @@ import fetch, { File, FormData } from 'node-fetch';
 import { EventEmitter } from "events";
 // @ts-ignore
 import * as moment from "moment";
+import * as http from "http";
+import * as https from "https";
+export var DOWNLOAD_MODES;
+(function (DOWNLOAD_MODES) {
+    DOWNLOAD_MODES[DOWNLOAD_MODES["Stream"] = 0] = "Stream";
+    DOWNLOAD_MODES[DOWNLOAD_MODES["Buffer"] = 1] = "Buffer";
+})(DOWNLOAD_MODES || (DOWNLOAD_MODES = {}));
 // @ts-ignore
 const errs = [
     {
@@ -1081,6 +1088,7 @@ export default class FMHost {
 export class Database extends EventEmitter {
     constructor(host, conn) {
         super();
+        this.cookies = {};
         this.host = host;
         this.name = conn.database;
         this.connection_details = conn;
@@ -1171,6 +1179,12 @@ export class Database extends EventEmitter {
             options.headers["authorization"] = "Bearer " + this._token;
             options.rejectUnauthorized = this.host.verify;
             let _fetch = yield fetch(url, options);
+            if (_fetch.headers.get('set-cookie')) {
+                for (let cookie of _fetch.headers.get('set-cookie')) {
+                    let cookie_split = cookie.split("=");
+                    this.cookies[cookie_split[0]] = cookie_split[1];
+                }
+            }
             let data = yield _fetch.json();
             // console.log(data.messages[0])
             if (data.messages[0].code == 952 && autoRelogin) {
@@ -1182,7 +1196,7 @@ export class Database extends EventEmitter {
         });
     }
     getLayout(name) {
-        return new layout(this, name);
+        return new Layout(this, name);
     }
     setGlobals(globalFields) {
         // console.log({globalFields})
@@ -1210,10 +1224,44 @@ export class Database extends EventEmitter {
     _tokenExpired() {
         this.emit("token_expired");
     }
+    streamContainer(field, url) {
+        return new Promise((resolve, reject) => {
+            if (field.metadata.result !== "container") {
+                reject("Cannot stream the field " + field.id + " as it is not a container");
+                return;
+            }
+            if (!url || typeof url !== "string") {
+                reject("Container is empty, or has invalid value");
+                return;
+            }
+            let headers = {};
+            if (Object.keys(this.cookies).length !== 0) {
+                headers["Cookie"] = Object.keys(this.cookies)
+                    .map(key => {
+                    return key + "=" + this.cookies[key];
+                })
+                    .join("; ");
+            }
+            // Automatically switch between the http and https modules, based on which is needed
+            (url.startsWith("https") ? https : http).get(url, {
+                headers
+            }, (res) => {
+                // Check for the 'set-cookie' header. If it exists, remember it and strip it for better security.
+                if (res.headers['set-cookie']) {
+                    for (let cookie of res.headers['set-cookie']) {
+                        let cookie_split = cookie.split("=");
+                        this.cookies[cookie_split[0]] = cookie_split[1];
+                    }
+                    res.headers['set-cookie'] = null;
+                }
+                resolve(res);
+            });
+        });
+    }
 }
-class layout {
+export class Layout {
     constructor(database, name) {
-        this.records = new layoutRecordManager(this);
+        this.records = new LayourRecordManager(this);
         this.database = database;
         this.name = name;
     }
@@ -1275,7 +1323,7 @@ class layout {
         });
     }
 }
-class layoutRecordManager {
+class LayourRecordManager {
     constructor(layout) {
         this.layout = layout;
     }
@@ -1309,14 +1357,14 @@ class layoutRecordManager {
             });
         });
     }
-    range() {
-        return new recordGetRange(this.layout);
+    range(start = 0, limit = 100) {
+        return new RecordGetRange(this.layout, start, limit);
     }
     find() {
-        return new find(this.layout);
+        return new Find(this.layout);
     }
 }
-class RecordBase extends EventEmitter {
+export class RecordBase extends EventEmitter {
     constructor(layout, recordId, modId = recordId) {
         super();
         this.portals = [];
@@ -1332,7 +1380,7 @@ class RecordBase extends EventEmitter {
     }
     processPortalData(portalData) {
         for (let item of Object.keys(portalData)) {
-            let _portal = new portal(this, item);
+            let _portal = new Portal(this, item);
             _portal.records = portalData[item].map(item => {
                 let fieldData = item;
                 delete fieldData.recordId;
@@ -1344,7 +1392,7 @@ class RecordBase extends EventEmitter {
     }
     processFieldData(fieldData) {
         return Object.keys(fieldData).map(item => {
-            let _field = new field(this, item, fieldData[item]);
+            let _field = new Field(this, item, fieldData[item]);
             if (!!fieldData[item]) {
                 if (_field.metadata.result === "timeStamp") {
                     // @ts-ignore
@@ -1561,7 +1609,7 @@ class RecordBase extends EventEmitter {
         return obj;
     }
 }
-class LayoutRecord extends RecordBase {
+export class LayoutRecord extends RecordBase {
     constructor(layout, recordId, modId = recordId, fieldData = {}, portalData = null) {
         super(layout, recordId, modId);
         this.fields = this.processFieldData(fieldData);
@@ -1571,7 +1619,7 @@ class LayoutRecord extends RecordBase {
         }
     }
 }
-class field {
+export class Field {
     constructor(record, id, contents) {
         this.record = record;
         this.id = id;
@@ -1648,6 +1696,7 @@ class field {
         }
     }
     get value() {
+        // if (this.metadata.result === "container") throw "Use await field.stream() to get the contents of a container field, instead of field.value"
         return this._value;
     }
     upload(buffer, filename, mime) {
@@ -1675,20 +1724,42 @@ class field {
             });
         }));
     }
-    download() {
+    download(mode = DOWNLOAD_MODES.Stream) {
         return new Promise((resolve, reject) => {
-            fetch(this.value.toString())
-                .then(res => resolve(res));
+            this.record.layout.database.streamContainer(this, this._value)
+                .then(stream => {
+                if (mode === DOWNLOAD_MODES.Stream) {
+                    resolve(stream);
+                    return;
+                }
+                let body = [];
+                stream.on("data", chunk => {
+                    body.push(chunk);
+                });
+                stream.on("error", (e) => {
+                    reject(e);
+                });
+                stream.on("end", () => {
+                    resolve({
+                        buffer: Buffer.concat(body),
+                        mime: stream.headers["content-type"],
+                        request: stream
+                    });
+                });
+            })
+                .catch(e => {
+                reject(e);
+            });
         });
     }
 }
-class portal {
+export class Portal {
     constructor(record, name) {
         this.record = record;
         this.name = name;
     }
 }
-class PortalRecord extends RecordBase {
+export class PortalRecord extends RecordBase {
     constructor(record, portal, recordId, modId = recordId, fieldData = {}) {
         super(record.layout, recordId, modId);
         this.portal = portal;
@@ -1712,7 +1783,7 @@ class PortalRecord extends RecordBase {
         return res;
     }
 }
-class recordGetOperation {
+export class RecordGetOperation {
     constructor(layout) {
         this.limit = 100;
         this.limitPortals = [];
@@ -1752,11 +1823,13 @@ class recordGetOperation {
         return this;
     }
 }
-class recordGetRange extends recordGetOperation {
-    constructor(layout) {
+export class RecordGetRange extends RecordGetOperation {
+    constructor(layout, start = 0, limit = 100) {
         super(layout);
+        this.setOffset(start);
+        this.setLimit(limit);
     }
-    generateQueryParams() {
+    generateQueryParams(extraBody = {}) {
         let params = [];
         if (this.limit !== 100)
             params.push("_limit=" + this.limit);
@@ -1773,15 +1846,38 @@ class recordGetRange extends recordGetOperation {
                     params.push("_limit." + item.portal.name.replace(/[^0-9A-z]/g, "") + "=" + item.limit);
             }
         }
+        if (extraBody.scripts) {
+            if (extraBody.scripts.prerequest) {
+                params.push("script.prerequest=" + extraBody.scripts.prerequest.name);
+                if (extraBody.scripts.prerequest.param)
+                    params.push("script.prerequest.param=" + extraBody.scripts.prerequest.param);
+            }
+            if (extraBody.scripts.presort) {
+                params.push("script.presort=" + extraBody.scripts.presort.name);
+                if (extraBody.scripts.presort.param)
+                    params.push("script.presort.param=" + extraBody.scripts.presort.param);
+            }
+            if (extraBody.scripts.after) {
+                params.push("script=" + extraBody.scripts.after.name);
+                if (extraBody.scripts.after.param)
+                    params.push("script.param=" + extraBody.scripts.after.param);
+            }
+        }
         if (params.length === 0)
             return "";
         return "?" + params.join("&");
     }
-    run() {
+    /**
+     * @deprecated in favour of .fetch()
+     */
+    run(extraBody = {}) {
+        return this.fetch(extraBody);
+    }
+    fetch(extraBody = {}) {
         return new Promise((resolve, reject) => {
             // console.log(this.#toObject())
             this.layout.getLayoutMeta().then(() => {
-                return this.layout.database.apiRequest(`${this.layout.endpoint}/records${this.generateQueryParams()}`, {
+                return this.layout.database.apiRequest(`${this.layout.endpoint}/records${this.generateQueryParams(extraBody)}`, {
                     method: "GET"
                 });
             })
@@ -1806,7 +1902,7 @@ class recordGetRange extends recordGetOperation {
         });
     }
 }
-class find extends recordGetOperation {
+export class Find extends RecordGetOperation {
     constructor(layout) {
         super(layout);
         this.queries = [];
@@ -1840,10 +1936,13 @@ class find extends recordGetOperation {
             this.queries.push(item);
         return this;
     }
-    find() {
-        return this.run();
-    }
+    /**
+     * @deprecated in favour of .fetch()
+     */
     run() {
+        return this.fetch();
+    }
+    fetch() {
         return new Promise((resolve, reject) => {
             // console.log(this.#toObject())
             this.layout.getLayoutMeta()

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@jd-data-limited/easy-fm",
-  "version": "1.3.0",
+  "version": "2.0.0",
   "dependencies": {
     "@types/btoa": "^1.2.3",
     "@types/events": "^3.0.0",
     "moment": "^2.29.4",
-    "node-fetch": "^3.3.0",
+    "node-fetch": "3.2.8",
     "typescript": "^4.9.4"
   },
   "type": "module",