@jd-data-limited/easy-fm 3.2.7 → 4.0.0

package/src/records/getOperations/recordGetOperation.ts

@@ -1,54 +1,196 @@
 /*
- * Copyright (c) 2023. See LICENSE file for more information
+ * Copyright (c) 2023-2024. See LICENSE file for more information
  */
 
 import {LayoutInterface} from "../../layouts/layoutInterface.js";
-import {Portal} from "../portal.js";
-import {limitPortalsInterface} from "../../types.js";
+import {ScriptRequestData} from "../../types.js";
 import {LayoutBase} from "../../layouts/layoutBase.js"
+import {LayoutRecord} from "../layoutRecord.js";
+import {ApiRecordResponseObj} from "../../models/apiResults.js";
+import {FMError} from "../../FMError.js";
 
-export class RecordGetOperation<T extends LayoutInterface> {
+export type SortOrder = "ascend" | "descend"
+export type FindRequest = {
+    [key: string]: string,
+    omit?: "true" | "false"
+}
+export type PortalRequest = {
+    name: string,
+}
+
+type PortalData<T extends LayoutInterface> = {
+    [key in keyof T["portals"]]: {
+        limit: number,
+        offset: number
+    }
+}
+export type GetOperationOptions<T extends LayoutInterface> = {
+    portals: Partial<PortalData<T>>,
+    limit?: number,
+    offset?: number
+}
+
+export class RecordGetOperation<T extends LayoutInterface, OPTIONS extends GetOperationOptions<T>> {
     protected layout: LayoutBase
     protected limit: number = 100
-    protected scripts: object
-    protected sort: object[]
-    protected limitPortals: limitPortalsInterface[] = []
-    protected offset: number = 0
+    protected scriptData: ScriptRequestData = {}
+    protected sortData: { fieldName: string, sortOrder: SortOrder }[] = []
+    protected portals: Partial<PortalData<T>>
+    protected offset: number = 1
+    protected queries: FindRequest[] = []
 
-    constructor(layout: LayoutBase) {
+    constructor(layout: LayoutBase, options: OPTIONS) {
         this.layout = layout
-        this.scripts = {
-            "script": null, // Runs after everything
-            "script.prerequeset": null, // Runs before the request
-            "script.presort": null // Runs before the sort
+        this.sortData = []
+        this.portals = options.portals
+        this.offset = options.offset || 1 // Offset refers to the starting record. offset 1 is the same as no offset.
+        this.limit = options.limit || 100
+    }
+
+    get isFindRequest() {
+        return this.queries.length !== 0
+    }
+
+    protected generateParamsBody(offset: number, limit: number) {
+        const params: {[key: string]: any} = {
+            limit: limit.toString(),
+            offset: offset.toString(),
         }
-        this.sort = []
+        if (this.sortData.length !== 0) params.sort = JSON.stringify(this.sortData)
+
+
+        if (this.scriptData.after) params["script"] = this.scriptData.after.name
+        if (this.scriptData.after?.parameter) params["script.param"] = this.scriptData.after.parameter
+
+        if (this.scriptData.presort) params["script.presort"] = this.scriptData.after.name
+        if (this.scriptData.presort?.parameter) params["script.presort.param"] = this.scriptData.after.parameter
+
+        if (this.scriptData.prerequest) params["script.prerequest"] = this.scriptData.after.name
+        if (this.scriptData.prerequest?.parameter) params["script.prerequest.param"] = this.scriptData.after.parameter
+
+        if (this.queries.length !== 0) params["query"] = this.queries
+
+        let portals = Object.keys(this.portals)
+        params["portal"] = portals
+        for (let portal of portals) {
+            params[`offset.${portal}`] = this.portals[portal].offset
+            params[`limit.${portal}`] = this.portals[portal].limit
+        }
+
+        return params
     }
+    protected generateParamsURL(offset: number, limit: number) {
+        const params = new URLSearchParams({
+            _limit: limit.toString(),
+            _offset: offset.toString(),
+        })
+        if (this.sortData.length !== 0) params.set("_sort", JSON.stringify(this.sortData))
 
-    /*
-    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<any>, offset = 0, limit = 100) {
-        if (offset < 0) throw "Portal offset cannot be less than 0"
-        this.limitPortals.push({portalName: portal.name, offset, limit})
-        return this
+        if (this.scriptData.after) params.set("script", this.scriptData.after.name)
+        if (this.scriptData.after?.parameter) params.set("script.param", this.scriptData.after.parameter)
+
+        if (this.scriptData.presort) params.set("script.presort", this.scriptData.after.name)
+        if (this.scriptData.presort?.parameter) params.set("script.presort.param", this.scriptData.after.parameter)
+
+        if (this.scriptData.prerequest) params.set("script.prerequest", this.scriptData.after.name)
+        if (this.scriptData.prerequest?.parameter) params.set("script.prerequest.param", this.scriptData.after.parameter)
+
+        let portals = Object.keys(this.portals)
+        for (let portal of portals) {
+            params.set(`_offset.${portal}`, this.portals[portal].limit.toString())
+            params.set(`_offset.${portal}`, this.portals[portal].offset.toString())
+        }
+        params.set('portal', JSON.stringify(portals))
+
+        return params
     }
 
-    setLimit(limit: number) {
-        if (limit < 1) throw "Record limit too low"
-        this.limit = limit
+    scripts(scripts: ScriptRequestData) {
+        this.scriptData = scripts;
         return this
     }
 
-    addSort(fieldName, sortOrder) {
-        this.sort.push({fieldName, sortOrder})
+    sort(fieldName: string, sortOrder: SortOrder) {
+        this.sortData.push({fieldName, sortOrder})
         return this
     }
 
-    setOffset(offset: number) {
-        if (offset < 0) throw "Record offset too low"
-        this.offset = offset
+    addRequest(query: FindRequest) {
+        this.queries.push(query)
         return this
     }
+
+    fetch() {
+        return this.performFind(this.offset, this.limit)
+    }
+
+    private async performFind(offset: number, limit: number): Promise<LayoutRecord<T, keyof OPTIONS["portals"]>[]> {
+        let trace = new Error()
+        await this.layout.getLayoutMeta()
+
+        const is_find = this.isFindRequest
+        let endpoint = this.layout.endpoint + (is_find ? "/_find" : "/records")
+        if (!is_find) endpoint += "?" + new URLSearchParams(this.generateParamsURL(offset, limit)).toString()
+        const reqData = {
+            // port: 443,
+            method: is_find ? "POST" : "GET",
+            body: is_find ? JSON.stringify(this.generateParamsBody(offset, limit)) : undefined,
+        }
+
+        let res = await this.layout.database.apiRequest<ApiRecordResponseObj>(
+            endpoint,
+            reqData
+        )
+        if (res.messages[0].code === "0") {
+            // console.log("RESOLVING")
+            if (!this.layout.metadata) await this.layout.getLayoutMeta()
+            return res.response.data.map(item => {
+                return new LayoutRecord(this.layout, item.recordId, item.modId, item.fieldData, item.portalData)
+            })
+        }
+        else if (res.messages[0].code == "401") {
+            // No records found, so return empty set
+            return []
+        }
+        else {
+            throw new FMError(res.messages[0].code, res.httpStatus, res, trace)
+        }
+    }
+
+    [Symbol.asyncIterator]() {
+        let nextOffset = this.offset
+        let startOffset: number = JSON.parse(JSON.stringify(this.offset))
+        let limit = this.limit
+
+        let exit_after_last_record = false
+        let records: LayoutRecord<T, keyof OPTIONS["portals"]>[] = []
+
+        const fetch = async () => {
+            const theoretical_limit = (limit - nextOffset) + startOffset
+            if (theoretical_limit === 0) {
+                exit_after_last_record = true
+                records = []
+                return
+            }
+            records = await this.performFind(nextOffset, theoretical_limit < 100 ? theoretical_limit : 100);
+            nextOffset += 100;
+            if (records.length < 100) exit_after_last_record = true
+        }
+
+        return {
+            next: async () => {
+                if (records.length === 0 && !exit_after_last_record) {
+                    await fetch();
+                }
+
+                if (records.length === 0 && exit_after_last_record) {
+                    return {done: true, value: undefined};
+                }
+                else {
+                    const record = records.shift()
+                    return {done: false, value: record};
+                }
+            }
+        };
+    }
 }

package/src/records/layoutRecord.d.ts

@@ -1,18 +1,19 @@
 import { extraBodyOptions, recordObject } from "../types.js";
 import { RecordBase } from "./recordBase.js";
 import { Portal } from "./portal.js";
-import { PortalInterface } from "../layouts/layoutInterface.js";
-import { RecordFieldsMap } from "../layouts/recordFieldsMap";
-import { LayoutRecordBase } from "./layoutRecordBase";
-export declare class LayoutRecord<T extends RecordFieldsMap, P extends PortalInterface> extends RecordBase<T> implements LayoutRecordBase {
-    portals: P;
-    constructor(layout: any, recordId: any, modId?: any, fieldData?: {}, portalData?: any);
+import { LayoutInterface } from "../layouts/layoutInterface.js";
+import { LayoutRecordBase } from "./layoutRecordBase.js";
+import { LayoutBase } from "../layouts/layoutBase.js";
+export declare class LayoutRecord<LAYOUT extends LayoutInterface, PORTALS_TO_INCLUDE = string> extends RecordBase<LAYOUT["fields"]> implements LayoutRecordBase {
+    portals: Pick<LAYOUT["portals"], PORTALS_TO_INCLUDE>;
+    private readonly portalsToInclude;
+    constructor(layout: LayoutBase, recordId: number | string, modId?: string | number, fieldData?: Record<string, string | number>, portalData?: any, portalsToInclude?: PORTALS_TO_INCLUDE[]);
     get portalsArray(): Portal<any>[];
     commit(extraBody?: extraBodyOptions): Promise<this>;
     protected processPortalData(portalData: any): void;
     get(): Promise<this>;
     getPortal(portal: any): Portal<any>;
-    duplicate(): Promise<LayoutRecord<T, P>>;
+    duplicate(): Promise<LayoutRecord<LAYOUT>>;
     delete(): Promise<void>;
     toObject(filter?: (a: any) => any, portalFilter?: (a: any) => any, portalRowFilter?: (a: any) => any, portalFieldFilter?: (a: any) => any): recordObject;
 }

package/src/records/layoutRecord.js

@@ -1,25 +1,18 @@
 /*
- * Copyright (c) 2023. See LICENSE file for more information
+ * Copyright (c) 2023-2024. 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); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 import { RecordBase } from "./recordBase.js";
 import { PortalRecord } from "./portalRecord.js";
 import { Portal } from "./portal.js";
 import { FMError } from "../FMError.js";
 export class LayoutRecord extends RecordBase {
-    constructor(layout, recordId, modId = recordId, fieldData = {}, portalData = null) {
+    // @ts-ignore
+    portals = {};
+    portalsToInclude;
+    constructor(layout, recordId, modId = recordId, fieldData = {}, portalData = null, portalsToInclude = []) {
         super(layout, recordId, modId);
-        // @ts-ignore
-        this.portals = {};
         this.processFieldData(fieldData);
+        this.portalsToInclude = portalsToInclude;
         if (portalData) {
             this.processPortalData(portalData);
         }
@@ -27,76 +20,61 @@ export class LayoutRecord extends RecordBase {
     get portalsArray() {
         return Object.values(this.portals);
     }
-    commit(extraBody = {}) {
-        let trace = new Error();
-        return new Promise((resolve, reject) => __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c;
-            let data = this.toObject();
-            delete data.recordId;
-            delete data.modId;
-            if ((_a = extraBody.scripts) === null || _a === void 0 ? void 0 : _a.after) {
-                data["script"] = extraBody.scripts.after.name;
-                if (extraBody.scripts.after.parameter)
-                    data["script.param"] = extraBody.scripts.after.parameter;
-            }
-            if ((_b = extraBody.scripts) === null || _b === void 0 ? void 0 : _b.prerequest) {
-                data["script.prerequest"] = extraBody.scripts.after.name;
-                if (extraBody.scripts.prerequest.parameter)
-                    data["script.prerequest.param"] = extraBody.scripts.prerequest.parameter;
-            }
-            if ((_c = extraBody.scripts) === null || _c === void 0 ? void 0 : _c.presort) {
-                data["script.presort"] = extraBody.scripts.presort.name;
-                if (extraBody.scripts.presort.parameter)
-                    data["script.presort.param"] = extraBody.scripts.presort.parameter;
-            }
-            if (this.recordId === -1) {
-                // This is a new LayoutRecord
-                this.layout.database.apiRequest(`${this.layout.endpoint}/records`, {
-                    port: 443,
-                    method: "POST",
-                    body: JSON.stringify(data)
-                })
-                    .then(res => {
-                    if (typeof res.response.scriptError !== "undefined" && res.response.scriptError !== '0') {
-                        reject(new FMError(res.response.scriptError, res.status, res, trace));
-                    }
-                    else if (res.messages[0].code === "0") {
-                        this.recordId = parseInt(res.response.recordId);
-                        this.modId = parseInt(res.response.modId);
-                        resolve(this);
-                    }
-                    else {
-                        reject(new FMError(res.messages[0].code, res.status, res, trace));
-                    }
-                })
-                    .catch(e => {
-                    reject(e);
-                });
-                return;
-            }
-            // for (let item of Object.keys(data)) extraBody[item] = data[item]
-            this.layout.database.apiRequest(this.endpoint, {
+    async commit(extraBody = {}) {
+        let data = this.toObject();
+        delete data.recordId;
+        delete data.modId;
+        if (extraBody.scripts?.after) {
+            data["script"] = extraBody.scripts.after.name;
+            if (extraBody.scripts.after.parameter)
+                data["script.param"] = extraBody.scripts.after.parameter;
+        }
+        if (extraBody.scripts?.prerequest) {
+            data["script.prerequest"] = extraBody.scripts.after.name;
+            if (extraBody.scripts.prerequest.parameter)
+                data["script.prerequest.param"] = extraBody.scripts.prerequest.parameter;
+        }
+        if (extraBody.scripts?.presort) {
+            data["script.presort"] = extraBody.scripts.presort.name;
+            if (extraBody.scripts.presort.parameter)
+                data["script.presort.param"] = extraBody.scripts.presort.parameter;
+        }
+        if (this.recordId === -1) {
+            // This is a new LayoutRecord
+            let res = await this.layout.database.apiRequest(`${this.layout.endpoint}/records`, {
                 port: 443,
-                method: "PATCH",
+                method: "POST",
                 body: JSON.stringify(data)
-            })
-                .then(res => {
-                if (typeof res.response.scriptError !== "undefined" && res.response.scriptError !== '0') {
-                    reject(new FMError(res.response.scriptError, res.status, res, trace));
-                }
-                else if (res.messages[0].code === "0") {
-                    this.modId = res.response.modId;
-                    this._onSave();
-                    resolve(this);
-                }
-                else {
-                    reject(new FMError(res.messages[0].code, res.status, res, trace));
-                }
-            })
-                .catch(e => {
-                reject(e);
             });
-        }));
+            if (typeof res.response.scriptError !== "undefined" && res.response.scriptError !== '0') {
+                throw new FMError(res.response.scriptError, res.httpStatus, res);
+            }
+            else if (res.messages[0].code === "0") {
+                this.recordId = parseInt(res.response.recordId);
+                this.modId = parseInt(res.response.modId);
+                return this;
+            }
+            else {
+                throw new FMError(res.messages[0].code, res.httpStatus, res);
+            }
+        }
+        // for (let item of Object.keys(data)) extraBody[item] = data[item]
+        let res = await this.layout.database.apiRequest(this.endpoint, {
+            port: 443,
+            method: "PATCH",
+            body: JSON.stringify(data)
+        });
+        if (typeof res.response.scriptError !== "undefined" && res.response.scriptError !== '0') {
+            throw new FMError(res.response.scriptError, res.httpStatus, res);
+        }
+        else if (res.messages[0].code === "0") {
+            this.modId = +res.response.modId;
+            this._onSave();
+            return this;
+        }
+        else {
+            throw new FMError(res.messages[0].code, res.httpStatus, res);
+        }
     }
     processPortalData(portalData) {
         for (let portalName of Object.keys(portalData)) {
@@ -111,89 +89,65 @@ export class LayoutRecord extends RecordBase {
             this.portals[portalName] = _portal;
         }
     }
-    get() {
+    async get() {
         let trace = new Error();
         if (this.recordId === -1) {
             throw "Cannot get this RecordBase until a commit() is done.";
         }
-        return new Promise((resolve, reject) => __awaiter(this, void 0, void 0, function* () {
-            if (!this.layout.metadata)
-                yield this.layout.getLayoutMeta();
-            this.layout.database.apiRequest(this.endpoint, {
-                port: 443,
-                method: "GET"
-            })
-                .then(res => {
-                if (res.messages[0].code === "0") {
-                    // console.log(res, res.response.data)
-                    this.modId = res.response.data[0].modId;
-                    this.processFieldData(res.response.data[0].fieldData);
-                    this.portalData = [];
-                    if (res.response.data[0].portalData)
-                        this.processPortalData(res.response.data[0].portalData);
-                    resolve(this);
-                }
-                else {
-                    reject(new FMError(res.messages[0].code, res.status, res, trace));
-                }
-            })
-                .catch(e => {
-                reject(e);
-            });
-        }));
+        if (!this.layout.metadata)
+            await this.layout.getLayoutMeta();
+        let res = await this.layout.database.apiRequest(this.endpoint, {
+            port: 443,
+            method: "GET"
+        });
+        if (res.messages[0].code === "0") {
+            // console.log(res, res.response.data)
+            this.modId = +res.response.data[0].modId;
+            this.processFieldData(res.response.data[0].fieldData);
+            this.portalData = [];
+            if (res.response.data[0].portalData)
+                this.processPortalData(res.response.data[0].portalData);
+            return this;
+        }
     }
     getPortal(portal) {
         return this.portalsArray.find(p => p.name === portal);
     }
-    duplicate() {
+    async duplicate() {
         let trace = new Error();
-        return new Promise((resolve, reject) => __awaiter(this, void 0, void 0, function* () {
-            this.layout.database.apiRequest(this.endpoint, {
-                port: 443,
-                method: "POST"
-            })
-                .then(res => {
-                if (typeof res.response.scriptError !== "undefined" && res.response.scriptError !== '0') {
-                    reject(new FMError(res.response.scriptError, res.status, res, trace));
-                }
-                else if (res.messages[0].code === "0") {
-                    let data = this.toObject((a) => true, (a) => true, (a) => false, (a) => false);
-                    let _res = new LayoutRecord(this.layout, res.response.recordId, res.response.modId, data.fieldData, data.portalData);
-                    this.emit("duplicated");
-                    resolve(_res);
-                }
-                else {
-                    reject(new FMError(res.messages[0].code, res.status, res, trace));
-                }
-            })
-                .catch(e => {
-                reject(e);
-            });
-        }));
+        let res = await this.layout.database.apiRequest(this.endpoint, {
+            port: 443,
+            method: "POST"
+        });
+        if (typeof res.response.scriptError !== "undefined" && res.response.scriptError !== '0') {
+            throw new FMError(res.response.scriptError, res.httpStatus, res, trace);
+        }
+        else if (res.messages[0].code === "0") {
+            let data = this.toObject((a) => true, (a) => true, (a) => false, (a) => false);
+            let _res = new LayoutRecord(this.layout, res.response.recordId, res.response.modId, data.fieldData, data.portalData);
+            this.emit("duplicated");
+            return _res;
+        }
+        else {
+            throw new FMError(res.messages[0].code, res.httpStatus, res, trace);
+        }
     }
-    delete() {
-        let trace = new Error();
-        return new Promise((resolve, reject) => __awaiter(this, void 0, void 0, function* () {
-            this.layout.database.apiRequest(this.endpoint, {
-                port: 443,
-                method: "DELETE"
-            })
-                .then(res => {
-                if (typeof res.response.scriptError !== "undefined" && res.response.scriptError !== '0') {
-                    reject(new FMError(res.response.scriptError, res.status, res, trace));
-                }
-                else if (res.messages[0].code === "0") {
-                    this.emit("deleted");
-                    resolve();
-                }
-                else {
-                    reject(new FMError(res.messages[0].code, res.status, res, trace));
-                }
-            })
-                .catch(e => {
-                reject(e);
-            });
-        }));
+    async delete() {
+        let res = await this.layout.database.apiRequest(this.endpoint, {
+            port: 443,
+            method: "DELETE"
+        });
+        console.log(res);
+        if (typeof res.response?.scriptError !== "undefined" && res.response?.scriptError !== '0') {
+            throw new FMError(res.response.scriptError, res.httpStatus, res);
+        }
+        else if (res.messages[0].code === "0") {
+            this.emit("deleted");
+            return;
+        }
+        else {
+            throw new FMError(res.messages[0].code, res.httpStatus, res);
+        }
     }
     toObject(filter = (a) => a.edited, portalFilter = (a) => a.records.find(record => record.edited), portalRowFilter = (a) => a.edited, portalFieldFilter = (a) => a.edited) {
         let obj = super.toObject(filter, portalFilter, portalRowFilter, portalFieldFilter);