@jd-data-limited/easy-fm 1.0.1-alpha1 → 1.0.2-alpha2

package/.expo/README.md

@@ -0,0 +1,15 @@
+> Why do I have a folder named ".expo" in my project?
+
+The ".expo" folder is created when an Expo project is started using "expo start" command.
+
+> What do the files contain?
+
+- "devices.json": contains information about devices that have recently opened this project. This is used to populate the "Development sessions" list in your development builds.
+- "packager-info.json": contains port numbers and process PIDs that are used to serve the application to the mobile device/simulator.
+- "settings.json": contains the server configuration that is used to serve the application manifest.
+
+> Should I commit the ".expo" folder?
+
+No, you should not share the ".expo" folder. It does not contain any information that is relevant for other developers working on the project, it is specific to your machine.
+
+Upon project creation, the ".expo" folder is already added to your ".gitignore" file.

package/.expo/settings.json

@@ -0,0 +1,8 @@
+{
+  "hostType": "lan",
+  "lanType": "ip",
+  "dev": true,
+  "minify": false,
+  "urlRandomness": null,
+  "https": false
+}

package/index.js

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022. See LICENSE file for more information
+ * Copyright (c) 2022-2023. See LICENSE file for more information
  */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
@@ -102,7 +102,11 @@ export default class FileMakerConnection extends database {
         super(conn.database);
         this.host = this;
         this.hostname = conn.hostname;
-        this.externalSources = externalDataSources.map(i => { let e = new database(i, this); e.external = true; return e; });
+        this.externalSources = externalDataSources.map(i => {
+            let e = new database(i, this);
+            e.external = true;
+            return e;
+        });
         this.rejectUnauthroized = rejectUnauthorized;
     }
     logout() {
@@ -459,7 +463,9 @@ class field {
                     reject(new FMError(_res.messages[0].code, _res.status, data));
                 }
             })
-                .catch(e => { reject(e); });
+                .catch(e => {
+                reject(e);
+            });
         }));
     }
     download() {
@@ -503,10 +509,12 @@ class portalItem extends record {
         return res;
     }
 }
-class find {
+class recordGetOperation {
     constructor(layout) {
+        this.limit = 100;
+        this.limitPortals = [];
+        this.offset = 0;
         this.layout = layout;
-        this.queries = [];
         this.scripts = {
             "script": null,
             "script.prerequeset": null,
@@ -514,6 +522,86 @@ class find {
         };
         this.sort = [];
     }
+    /*
+    addToPortalLimit() will adjust the results of the get request so that if a layout has multiple portals in it,
+    only data from the specified ones will be read. This may help reduce load on your FileMaker API
+    */
+    addToPortalLimit(portal, offset = 0, limit = 100) {
+        if (offset < 0)
+            throw "Portal offset cannot be less than 0";
+        this.limitPortals.push({ portal, offset, limit });
+    }
+    setLimit(limit) {
+        if (limit < 1)
+            throw "Record limit too low";
+        this.limit = limit;
+    }
+    addSort(fieldName, sortOrder) {
+        this.sort.push({ fieldName, sortOrder });
+        return this;
+    }
+    setOffset(offset) {
+        if (offset < 0)
+            throw "Record offset too low";
+        this.limit = offset;
+    }
+}
+class recordGetRange extends recordGetOperation {
+    constructor(layout) {
+        super(layout);
+    }
+    generateQueryParams() {
+        let params = [];
+        if (this.limit !== 100)
+            params.push("_limit=" + this.limit);
+        if (this.offset !== 0)
+            params.push("_offset=" + this.offset);
+        if (this.sort.length > 0)
+            params.push("_sort=" + encodeURI(JSON.stringify(this.sort)));
+        if (this.limitPortals.length > 0) {
+            params.push("portal=" + encodeURI(JSON.stringify(this.limitPortals.map(p => p.portal.name))));
+            for (let item of this.limitPortals) {
+                if (item.offset !== 0)
+                    params.push("_offset." + item.portal.name.replace(/[^0-9A-z]/g, "") + "=" + item.offset);
+                if (item.limit !== 100)
+                    params.push("_limit." + item.portal.name.replace(/[^0-9A-z]/g, "") + "=" + item.limit);
+            }
+        }
+        if (params.length === 0)
+            return "";
+        return "?" + params.join("&");
+    }
+    run() {
+        return new Promise((resolve, reject) => {
+            // console.log(this.#toObject())
+            this.layout.database.apiRequest(`${this.layout.endpoint}/records${this.generateQueryParams()}`, {
+                method: "GET"
+            }).then((res) => __awaiter(this, void 0, void 0, function* () {
+                // // console.log(res)
+                if (res.messages[0].code === "0") {
+                    // console.log("RESOLVING")
+                    if (!this.layout.metadata)
+                        yield this.layout.getLayoutMeta();
+                    let data = res.response.data.map(item => {
+                        return new record(this.layout, item.recordId, item.modId, item.fieldData, item.portalData);
+                    });
+                    resolve(data);
+                }
+                else {
+                    reject(new FMError(res.messages[0].code, res.status, res));
+                }
+            }))
+                .catch(e => {
+                reject(e);
+            });
+        });
+    }
+}
+class find extends recordGetOperation {
+    constructor(layout) {
+        super(layout);
+        this.queries = [];
+    }
     toObject() {
         let out = { query: this.queries, sort: undefined };
         if (this.sort.length !== 0)
@@ -525,6 +613,17 @@ class find {
                     out[item + ".param"] = this.scripts[item].parameter;
             }
         }
+        if (this.limit !== 100)
+            out["limit"] = this.limit;
+        if (this.offset !== 0)
+            out["offset"] = this.offset;
+        if (this.limitPortals.length > 0) {
+            out["portal"] = this.limitPortals.map(p => p.portal.name);
+            for (let item of this.limitPortals) {
+                out["offset." + item.portal.name.replace(/[^0-9A-z]/g, "")] = item.offset;
+                out["limit." + item.portal.name.replace(/[^0-9A-z]/g, "")] = item.limit;
+            }
+        }
         return out;
     }
     addRequests(...requests) {
@@ -532,11 +631,10 @@ class find {
             this.queries.push(item);
         return this;
     }
-    addSort(fieldName, sortOrder) {
-        this.sort.push({ fieldName, sortOrder });
-        return this;
-    }
     find() {
+        return this.run();
+    }
+    run() {
         return new Promise((resolve, reject) => {
             // console.log(this.#toObject())
             this.layout.database.apiRequest(`${this.layout.endpoint}/_find`, {

package/index.ts

@@ -15,14 +15,15 @@ import fetch, {
     Request,
     Response
 } from 'node-fetch';
-import { EventEmitter } from "events";
+import {EventEmitter} from "events";
 // @ts-ignore
 import fs from "fs"
 // @ts-ignore
 import path from "path"
 // @ts-ignore
-import { fileURLToPath } from "url"
+import {fileURLToPath} from "url"
 import * as https from "https";
+
 // import * as btoa from "btoa";
 
 interface connectionOptions {
@@ -32,7 +33,7 @@ interface connectionOptions {
 
 interface hostConnectionOptions {
     hostname: string
-    database: loginOptionsOAuth | loginOptionsFileMaker | loginOptionsClaris | loginOptionsToken
+    databases: (loginOptionsOAuth | loginOptionsFileMaker | loginOptionsClaris | loginOptionsToken)[]
 }
 
 interface databaseOptions {
@@ -66,6 +67,12 @@ interface loginOptionsClaris extends databaseOptions {
     }
 }
 
+interface limitPortalsInterface {
+    portal: portal,
+    offset: number,
+    limit: number
+}
+
 // @ts-ignore
 const errs = JSON.parse(fs.readFileSync(path.join(path.dirname(fileURLToPath(import.meta.url)), 'fmErrors.json')).toString())
 
@@ -89,11 +96,7 @@ class database {
 
     public hostname: string;
 
-    constructor(props: databaseOptions, host: FileMakerConnection = null) {
-        this.props = props
-        this.name = this.props.database
-        if (host) this.host = host
-    }
+    constructor() {}
 
     get token() {
         return this.host.token
@@ -139,47 +142,36 @@ class database {
     }
 
     get endpoint(): string {
-        return `https://${this.hostname || this.host.hostname}/fmi/data/v2/databases/${encodeURI(this.name)}`
-    }
-
-    get externalLoginInfo() {
-        // Returns an object that can be used when using this database object as an external source
-        let out = {
-            database: this.name,
-            username: undefined,
-            password: undefined,
-            oauthRequestId: undefined,
-            oauthIdentifier: undefined
-        }
-        switch (this.props.method) {
-            case "filemaker":
-                out.username = (<loginOptionsFileMaker>this.props).username
-                out.password = (<loginOptionsFileMaker>this.props).password
-            case "token":
-                throw "Token logins cannot be used for connecting to external sources. Please either use no login method, or open a second connection."
-            case "oauth":
-                out.oauthRequestId = (<loginOptionsOAuth>this.props).oauth.requestId
-                out.oauthIdentifier = (<loginOptionsOAuth>this.props).oauth.requestIdentifier
-
-            case "claris":
-                throw "Claris logins cannot be used for connecting to external sources. Please either use no login method, or open a second connection."
+        return `${this.host.endpoint}/${encodeURI(this.name)}`
+    }
+
+    pairHost(db: FileMakerConnection, details: databaseOptions, returnConDetails = true) {
+        this.host = db
+        this.name = details.database
+        if (returnConDetails) {
+            if (details.method === "filemaker") {
+                return {
+                    database: this.name,
+                    username: (<loginOptionsFileMaker>details).username,
+                    password: (<loginOptionsFileMaker>details).password
+                }
+            } else {
+                throw `Authentication method used for '${this.name}' is not supported for external data source connections`
+            }
         }
-        return out
     }
 }
 
-export default class FileMakerConnection extends database{
+export default class FileMakerConnection {
     private _token: any;
-    private username: any;
-    private password: any;
+    private hostname: string;
     public readonly rejectUnauthroized: boolean;
-    externalSources: database[];
+    private databases: database[]
+    private databaseConDetails: (loginOptionsOAuth | loginOptionsFileMaker | loginOptionsClaris | loginOptionsToken)[];
 
-    constructor(conn: hostConnectionOptions, externalDataSources:databaseOptions[] = [], rejectUnauthorized = true) {
-        super(conn.database);
-        this.host = this
+    constructor(conn: hostConnectionOptions, rejectUnauthorized = true) {
         this.hostname = conn.hostname
-        this.externalSources = externalDataSources.map(i => {let e = new database(i, this); e.external = true; return e;})
+        this.databaseConDetails = conn.databases
         this.rejectUnauthroized = rejectUnauthorized
     }
 
@@ -196,7 +188,6 @@ export default class FileMakerConnection extends database{
             let data = await _fetch.json()
             // console.log(data)
             this._token = null
-            this.name = null
             this.hostname = null
             resolve()
         })
@@ -205,19 +196,26 @@ export default class FileMakerConnection extends database{
     login() {
         return new Promise<string>((resolve, reject) => {
             if (this.token) throw new Error("Already logged in. Run logout() first")
+            this.databases = [new database()]
+            this.databases[0].pairHost(this, this.databaseConDetails[0], false)
+            let external_sources_cons = this.databaseConDetails.slice(1).map(con => {
+                let db = new database()
+                this.databases.push(db)
+                return db.pairHost(this, con)
+            })
 
-            if (this.props.method === "filemaker") {
-                this.username = (<loginOptionsFileMaker>this.props).username
-                this.name = this.props.database
-
+            if (this.databaseConDetails[0].method === "filemaker") {
                 fetch(`${this.endpoint}/sessions`, {
                     hostname: this.hostname,
                     port: 443,
                     method: "POST",
                     headers: {
                         "Content-Type": "application/json",
-                        "Authorization": "Basic " + Buffer.from(this.username + ":" + (<loginOptionsFileMaker>this.props).password).toString("base64")
-                    }
+                        "Authorization": "Basic " + Buffer.from((<loginOptionsFileMaker>this.databaseConDetails[0]).username + ":" + (<loginOptionsFileMaker>this.databaseConDetails[0]).password).toString("base64")
+                    },
+                    body: JSON.stringify({
+                        fmDataSource: external_sources_cons
+                    })
                 }).then(async res => {
                     if (res.status === 200) {
                         this._token = res.headers.get('x-fm-data-access-token')
@@ -230,22 +228,20 @@ export default class FileMakerConnection extends database{
                     .catch(e => {
                         reject(e)
                     })
-            }
-            else if (this.props.method === "token") {
-                this._token = (<loginOptionsToken>this.props).token
-                this.name = this.props.database
+            } else if (this.databaseConDetails[0].method === "token") {
+                this._token = (<loginOptionsToken>this.databaseConDetails[0]).token
                 resolve(this.token)
-            }
-            else if (this.props.method === "oauth") {
-                this.name = this.props.database
+            } else if (this.databaseConDetails[0].method === "oauth") {
                 fetch(`${this.endpoint}/sessions`, {
                     method: "POST",
                     headers: {
                         "Content-Type": "application/json",
-                        "X-FM-Data-OAuth-RequestId": (<loginOptionsOAuth>this.props).oauth.requestId,
-                        "X-FM-Data-OAuth-Identifier": (<loginOptionsOAuth>this.props).oauth.requestIdentifier
+                        "X-FM-Data-OAuth-RequestId": (<loginOptionsOAuth>this.databaseConDetails[0]).oauth.requestId,
+                        "X-FM-Data-OAuth-Identifier": (<loginOptionsOAuth>this.databaseConDetails[0]).oauth.requestIdentifier
                     },
-                    body: "{}"
+                    body: external_sources_cons.length === 0 ? "{}" : JSON.stringify({
+                        fmDataSource: external_sources_cons
+                    })
                 })
                     .then(res => res.json())
                     .then(res => {
@@ -253,14 +249,12 @@ export default class FileMakerConnection extends database{
                         this._token = _res.headers["x-fm-data-access-token"]
                         resolve(this.token)
                     })
-            }
-            else if (this.props.method === "claris") {
-                this.name = this.props.database
+            } else if (this.databaseConDetails[0].method === "claris") {
                 fetch(`${this.endpoint}/sessions`, {
                     method: "POST",
                     headers: {
                         "Content-Type": "application/json",
-                        "Authorization": (<loginOptionsClaris>this.props).claris.fmid,
+                        "Authorization": (<loginOptionsClaris>this.databaseConDetails[0]).claris.fmid,
                     },
                     body: "{}"
                 })
@@ -274,15 +268,24 @@ export default class FileMakerConnection extends database{
         })
     }
 
+    getDatabase(database_name) {
+        return this.databases.find(db => db.name === database_name)
+    }
+
     get token() {
         return this._token
     }
+
+    get endpoint(): string {
+        return `https://${this.hostname}/fmi/data/v2/databases/`
+    }
 }
 
 class layout {
     readonly database: database;
     protected name: string;
     metadata: any;
+
     constructor(database: database, name: string) {
         this.database = database
         this.name = name
@@ -357,7 +360,7 @@ class record extends EventEmitter {
     fields: field[];
     readonly portals: portal[];
     private portalData: any[];
-    
+
     constructor(layout, recordId, modId = recordId, fieldData = {}, portalData = null) {
         super();
         this.layout = layout
@@ -399,7 +402,9 @@ class record extends EventEmitter {
     }
 
     get() {
-        if (this.recordId === -1) {throw "Cannot get this record until a commit() is done."}
+        if (this.recordId === -1) {
+            throw "Cannot get this record until a commit() is done."
+        }
         return new Promise(async (resolve, reject) => {
             if (!this.layout.metadata) await this.layout.getLayoutMeta()
 
@@ -445,8 +450,7 @@ class record extends EventEmitter {
                     .then(res => {
                         if (typeof res.response.scriptError !== "undefined" && res.response.scriptError !== '0') {
                             reject(new FMError(res.response.scriptError, res.status, res))
-                        }
-                        else if (res.messages[0].code === "0") {
+                        } else if (res.messages[0].code === "0") {
                             console.log(res)
                             this.recordId = parseInt(res.response.recordId)
                             this.modId = parseInt(res.response.modId)
@@ -455,7 +459,7 @@ class record extends EventEmitter {
                             reject(new FMError(res.messages[0].code, res.status, res))
                         }
                     })
-             sh       .catch(e => {
+                    .catch(e => {
                         reject(e)
                     })
 
@@ -471,8 +475,7 @@ class record extends EventEmitter {
                 .then(res => {
                     if (typeof res.response.scriptError !== "undefined" && res.response.scriptError !== '0') {
                         reject(new FMError(res.response.scriptError, res.status, res))
-                    }
-                    else if (res.messages[0].code === "0") {
+                    } else if (res.messages[0].code === "0") {
                         console.log(res)
                         this.modId = res.response.modId
                         this.emit("saved")
@@ -529,6 +532,7 @@ class field {
     id: number;
     value: string | number;
     edited: boolean;
+
     constructor(record, id, contents) {
         this.record = record
         this.id = id
@@ -570,9 +574,12 @@ class field {
                         reject(new FMError(_res.messages[0].code, _res.status, data))
                     }
                 })
-                .catch(e => {reject(e)})
+                .catch(e => {
+                    reject(e)
+                })
         })
     }
+
     download() {
         return new Promise((resolve, reject) => {
             https.get(this.value.toString(), (res) => {
@@ -624,15 +631,16 @@ class portalItem extends record {
     }
 }
 
-class find {
+class recordGetOperation {
     protected layout: layout
-    protected queries: object[]
+    protected limit: number = 100
     protected scripts: object
     protected sort: object[]
+    protected limitPortals: limitPortalsInterface[] = []
+    protected offset: number = 0
 
     constructor(layout) {
         this.layout = layout
-        this.queries = []
         this.scripts = {
             "script": null, // Runs after everything
             "script.prerequeset": null, // Runs before the request
@@ -641,6 +649,86 @@ class find {
         this.sort = []
     }
 
+    /*
+    addToPortalLimit() will adjust the results of the get request so that if a layout has multiple portals in it,
+    only data from the specified ones will be read. This may help reduce load on your FileMaker API
+    */
+    addToPortalLimit(portal: portal, offset = 0, limit = 100) {
+        if (offset < 0) throw "Portal offset cannot be less than 0"
+        this.limitPortals.push({portal, offset, limit})
+    }
+
+    setLimit(limit: number) {
+        if (limit < 1) throw "Record limit too low"
+        this.limit = limit
+    }
+
+    addSort(fieldName, sortOrder) {
+        this.sort.push({fieldName, sortOrder})
+        return this
+    }
+
+    setOffset(offset: number) {
+        if (offset < 0) throw "Record offset too low"
+        this.limit = offset
+    }
+}
+
+class recordGetRange extends recordGetOperation {
+    constructor(layout) {
+        super(layout)
+    }
+
+    private generateQueryParams() {
+        let params = []
+        if (this.limit !== 100) params.push("_limit=" + this.limit)
+        if (this.offset !== 0) params.push("_offset=" + this.offset)
+        if (this.sort.length > 0) params.push("_sort=" + encodeURI(JSON.stringify(this.sort)))
+        if (this.limitPortals.length > 0) {
+            params.push("portal=" + encodeURI(JSON.stringify(this.limitPortals.map(p => p.portal.name))))
+            for (let item of this.limitPortals) {
+                if (item.offset !== 0) params.push("_offset." + item.portal.name.replace(/[^0-9A-z]/g, "") + "=" + item.offset)
+                if (item.limit !== 100) params.push("_limit." + item.portal.name.replace(/[^0-9A-z]/g, "") + "=" + item.limit)
+            }
+        }
+
+        if (params.length === 0) return ""
+        return "?" + params.join("&")
+    }
+
+    run() {
+        return new Promise((resolve, reject) => {
+            // console.log(this.#toObject())
+            this.layout.database.apiRequest(`${this.layout.endpoint}/records${this.generateQueryParams()}`, {
+                method: "GET"
+            }).then(async res => {
+                // // console.log(res)
+                if (res.messages[0].code === "0") {
+                    // console.log("RESOLVING")
+                    if (!this.layout.metadata) await this.layout.getLayoutMeta()
+                    let data = res.response.data.map(item => {
+                        return new record(this.layout, item.recordId, item.modId, item.fieldData, item.portalData)
+                    })
+                    resolve(data)
+                } else {
+                    reject(new FMError(res.messages[0].code, res.status, res))
+                }
+            })
+                .catch(e => {
+                    reject(e)
+                })
+        })
+    }
+}
+
+class find extends recordGetOperation {
+    protected queries: object[]
+
+    constructor(layout) {
+        super(layout)
+        this.queries = []
+    }
+
     private toObject() {
         let out = {query: this.queries, sort: undefined}
         if (this.sort.length !== 0) out.sort = this.sort
@@ -652,6 +740,16 @@ class find {
             }
         }
 
+        if (this.limit !== 100) out["limit"] = this.limit
+        if (this.offset !== 0) out["offset"] = this.offset
+        if (this.limitPortals.length > 0) {
+            out["portal"] = this.limitPortals.map(p => p.portal.name)
+            for (let item of this.limitPortals) {
+                out["offset." + item.portal.name.replace(/[^0-9A-z]/g, "")] = item.offset
+                out["limit." + item.portal.name.replace(/[^0-9A-z]/g, "")] = item.limit
+            }
+        }
+
         return out
     }
 
@@ -660,12 +758,11 @@ class find {
         return this
     }
 
-    addSort(fieldName, sortOrder) {
-        this.sort.push({fieldName, sortOrder})
-        return this
+    find() {
+        return this.run()
     }
 
-    find() {
+    run() {
         return new Promise((resolve, reject) => {
             // console.log(this.#toObject())
             this.layout.database.apiRequest(`${this.layout.endpoint}/_find`, {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jd-data-limited/easy-fm",
-  "version": "1.0.1alpha1",
+  "version": "1.0.2alpha2",
   "dependencies": {
     "@types/btoa": "^1.2.3",
     "@types/events": "^3.0.0",