@jd-data-limited/easy-fm 4.0.3 → 4.0.5

package/src/records/layoutRecord.ts

@@ -9,9 +9,10 @@ import {Portal} from "./portal.js";
 import {LayoutInterface} from "../layouts/layoutInterface.js";
 import {FMError} from "../FMError.js";
 import {LayoutRecordBase} from "./layoutRecordBase.js";
-import {ApiPortalData, ApiRecordResponseObj} from "../models/apiResults.js";
+import {ApiFieldData, ApiPortalData, ApiRecordResponseObj, ApiRowDataDef} from "../models/apiResults.js";
 import {LayoutBase} from "../layouts/layoutBase.js"
 import {FieldBase, FieldValue} from "./fieldBase.js";
+import * as moment from "moment/moment.js";
 
 export class LayoutRecord<LAYOUT extends LayoutInterface> extends RecordBase<LAYOUT["fields"]> implements LayoutRecordBase {
     // @ts-ignore
@@ -25,8 +26,7 @@ export class LayoutRecord<LAYOUT extends LayoutInterface> extends RecordBase<LAY
         fieldData: Record<string, string | number> = {},
         portalData: ApiPortalData | null = null, portalsToInclude: (keyof LAYOUT["portals"])[] = [])
     {
-        super(layout, parseInt(recordId as string), parseInt(modId as string));
-        this.processFieldData(fieldData)
+        super(layout, parseInt(recordId as string), parseInt(modId as string), fieldData);
         this.portalsToInclude = portalsToInclude
         if (portalData) {
             this.processPortalData(portalData)
@@ -47,7 +47,7 @@ export class LayoutRecord<LAYOUT extends LayoutInterface> extends RecordBase<LAY
             if (extraBody.scripts.after.parameter) data["script.param"] = extraBody.scripts.after.parameter
         }
         if (extraBody.scripts?.prerequest) {
-            data["script.prerequest"] = extraBody.scripts.after.name
+            data["script.prerequest"] = extraBody.scripts.prerequest.name
             if (extraBody.scripts.prerequest.parameter) data["script.prerequest.param"] = extraBody.scripts.prerequest.parameter
         }
         if (extraBody.scripts?.presort) {
@@ -63,7 +63,10 @@ export class LayoutRecord<LAYOUT extends LayoutInterface> extends RecordBase<LAY
                     body: JSON.stringify(data)
                 })
 
-                if (typeof res.response.scriptError !== "undefined" && res.response.scriptError !== '0') {
+                if (!res.response) {
+                    throw new FMError(res.messages[0].code, res.httpStatus, res)
+                }
+                else 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") {
@@ -88,7 +91,10 @@ export class LayoutRecord<LAYOUT extends LayoutInterface> extends RecordBase<LAY
             method: "PATCH",
             body: JSON.stringify(data)
         })
-        if (typeof res.response.scriptError !== "undefined" && res.response.scriptError !== '0') {
+        if (!res.response) {
+            throw new FMError(res.messages[0].code, res.httpStatus, res)
+        }
+        else 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") {
@@ -127,13 +133,15 @@ export class LayoutRecord<LAYOUT extends LayoutInterface> extends RecordBase<LAY
             method: "GET"
         })
 
-        if (res.messages[0].code === "0") {
+        if (res.response && 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
+        } else {
+            throw new FMError(res.messages[0].code, res.httpStatus, res)
         }
     }
 
@@ -143,7 +151,10 @@ export class LayoutRecord<LAYOUT extends LayoutInterface> extends RecordBase<LAY
             port: 443,
             method: "POST"
         })
-        if (typeof res.response.scriptError !== "undefined" && res.response.scriptError !== '0') {
+        if (!res.response) {
+            throw new FMError(res.messages[0].code, res.httpStatus, res, trace)
+        }
+        else 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") {
@@ -176,13 +187,49 @@ export class LayoutRecord<LAYOUT extends LayoutInterface> extends RecordBase<LAY
         }
     }
 
+    fieldsToObject(filter = (a: FieldBase<FieldValue>) => a.edited): Omit<ApiRowDataDef, "portalData"> {
+        let fields_processed: ApiFieldData = {}
+        let field: FieldBase<FieldValue>
+        for (field of this.fieldsArray.filter(field => filter(field))) {
+            let value = field.value as string | number | Date
+            if (value instanceof Date) {
+                // @ts-ignore
+                let _value = moment.default(value)
+                    .utcOffset(this.layout.database.host.timezoneOffset)
+
+                // @ts-ignore
+
+                switch (field.metadata.result) {
+                    case "time":
+                        value = _value.format(this.layout.database.host.metadata.productInfo.timeFormat.replace("dd", "DD"))
+                        break
+                    case "date":
+                        value = _value.format(this.layout.database.host.metadata.productInfo.dateFormat.replace("dd", "DD"))
+                        break
+                    default:
+                        value = _value.format(this.layout.database.host.metadata.productInfo.timeStampFormat.replace("dd", "DD"))
+                }
+            }
+            fields_processed[field.id] = value
+        }
+        let obj = {
+            "recordId": this.recordId.toString(),
+            "modId": this.modId.toString(),
+            "fieldData": fields_processed
+        }
+        return obj
+    }
+
     toObject(
         filter: (a: FieldBase<FieldValue>) => any = (a) => a.edited,
         portalFilter: (a: Portal<any>) => any = (a) => a.records.find(record => record.edited),
         portalRowFilter: (a: PortalRecord<never>) => any = (a) => a.edited,
         portalFieldFilter: (a: FieldBase<FieldValue>) => any = (a) => a.edited
     ) {
-        let obj = super.toObject(filter);
+        let obj: ApiRowDataDef = {
+            ...this.fieldsToObject(filter),
+            portalData: {}
+        };
 
         // Check if there's been any edited portal information
         let portals = this.portalsArray.filter(a => portalFilter(a))

package/src/records/portal.d.ts

@@ -7,5 +7,5 @@ export declare class Portal<T extends RecordFieldsMap> implements PortalBase<T>
     readonly name: string;
     records: PortalRecord<T>[];
     constructor(record: LayoutRecord<any>, name: string);
-    create(): PortalRecord<T>;
+    create(): Promise<PortalRecord<T>>;
 }

package/src/records/portal.js

@@ -5,14 +5,14 @@ import { PortalRecord } from "./portalRecord.js";
 export class Portal {
     record;
     name;
-    records;
+    records = [];
     constructor(record, name) {
         this.record = record;
         this.name = name;
     }
-    create() {
+    async create() {
         let fields = {};
-        for (let _field of this.record.layout.metadata.portalMetaData[this.name]) {
+        for (let _field of (await this.record.layout.getLayoutMeta()).portalMetaData[this.name]) {
             fields[_field.name] = "";
         }
         let record = new PortalRecord(this.record, this, -1, -1, fields);

package/src/records/portal.ts

@@ -10,18 +10,18 @@ import {LayoutRecord} from "./layoutRecord.js";
 export class Portal<T extends RecordFieldsMap> implements PortalBase<T> {
     readonly record: LayoutRecord<any>;
     readonly name: string;
-    public records: PortalRecord<T>[];
+    public records: PortalRecord<T>[] = [];
 
     constructor(record: LayoutRecord<any>, name: string) {
         this.record = record
         this.name = name
     }
 
-    create() {
+    async create() {
         let fields: {
             [key: string]: string
         } = {}
-        for (let _field of this.record.layout.metadata.portalMetaData[this.name]) {
+        for (let _field of (await this.record.layout.getLayoutMeta()).portalMetaData[this.name]) {
             fields[_field.name] = ""
         }
         let record = new PortalRecord<T>(this.record, this, -1, -1, fields)

package/src/records/portalRecord.d.ts

@@ -10,8 +10,9 @@ export declare class PortalRecord<T extends RecordFieldsMap> extends RecordBase<
     _onSave(): void;
     commit(extraBody?: extraBodyOptions): Promise<import("./layoutRecord.js").LayoutRecord<import("../index.js").LayoutInterface>>;
     toObject(fieldFilter: (a: FieldBase<FieldValue>) => boolean): {
+        modId?: string;
+        recordId?: string;
+    } & {
         [key: string]: string;
-        modId: string;
-        recordId: string;
     };
 }

package/src/records/portalRecord.js

@@ -7,9 +7,8 @@ export class PortalRecord extends RecordBase {
     portal;
     type = RecordTypes.PORTAL;
     constructor(record, portal, recordId, modId = recordId, fieldData = {}) {
-        super(record.layout, recordId, modId);
+        super(record.layout, recordId, modId, fieldData);
         this.portal = portal;
-        this.processFieldData(fieldData);
     }
     _onSave() {
         super._onSave();
@@ -19,13 +18,12 @@ export class PortalRecord extends RecordBase {
         return this.portal.record.commit(extraBody);
     }
     toObject(fieldFilter) {
-        super.toObject();
         let res = {
             recordId: this.recordId === -1 ? undefined : this.recordId.toString(),
             modId: this.modId === -1 ? undefined : this.modId.toString()
         };
         for (let field of this.fieldsArray.filter(a => fieldFilter(a)))
-            res[field.id] = field.value.toString();
+            res[field.id] = field.value?.toString();
         // console.log(res)
         return res;
     }

package/src/records/portalRecord.ts

@@ -14,10 +14,8 @@ export class PortalRecord<T extends RecordFieldsMap> extends RecordBase<T> {
     readonly type = RecordTypes.PORTAL
 
     constructor(record: RecordBase<any>, portal: PortalBase<any>, recordId: number, modId = recordId, fieldData = {}) {
-        super(record.layout, recordId, modId);
-
+        super(record.layout, recordId, modId, fieldData);
         this.portal = portal
-        this.processFieldData(fieldData)
     }
 
     _onSave() {
@@ -29,17 +27,15 @@ export class PortalRecord<T extends RecordFieldsMap> extends RecordBase<T> {
         return this.portal.record.commit(extraBody)
     }
 
-    toObject(fieldFilter: (a: FieldBase<FieldValue>) => boolean) {
-        super.toObject()
-        let res: {
-            "modId": string,
-            "recordId": string
-            [key: string]: string
-        } = {
+    toObject(fieldFilter: (a: FieldBase<FieldValue>) => boolean): {
+        modId?: string,
+        recordId?: string,
+    } & {[key: string]: string} {
+        let res: any = {
             recordId: this.recordId === -1 ? undefined : this.recordId.toString(),
             modId: this.modId === -1 ? undefined : this.modId.toString()
         }
-        for (let field of this.fieldsArray.filter(a => fieldFilter(a))) res[field.id] = field.value.toString()
+        for (let field of this.fieldsArray.filter(a => fieldFilter(a))) res[field.id] = field.value?.toString()
         // console.log(res)
         return res
     }

package/src/records/recordBase.d.ts

@@ -4,19 +4,18 @@ import { FieldBase, FieldValue } from "./fieldBase.js";
 import { RecordTypes } from "../types.js";
 import { RecordFieldsMap } from "../layouts/recordFieldsMap.js";
 import { LayoutBase } from "../layouts/layoutBase.js";
-import { ApiFieldData, ApiRowDataDef } from "../models/apiResults.js";
-export declare class RecordBase<T extends RecordFieldsMap> extends EventEmitter {
+import { ApiFieldData } from "../models/apiResults.js";
+export declare abstract class RecordBase<T extends RecordFieldsMap> extends EventEmitter {
     readonly layout: LayoutBase;
     readonly type: RecordTypes;
     recordId: number;
     modId: number;
     fields: T;
     protected portalData: any[];
-    constructor(layout: LayoutBase, recordId: number, modId?: number);
+    protected constructor(layout: LayoutBase, recordId: number, modId: number | undefined, fieldData: ApiFieldData);
     get endpoint(): string;
     get edited(): boolean;
     get fieldsArray(): FieldBase<FieldValue>[];
     protected processFieldData(fieldData: ApiFieldData): T;
     _onSave(): void;
-    toObject(filter?: (a: FieldBase<FieldValue>) => boolean): Partial<Omit<ApiRowDataDef, "portalDataInfo">>;
 }

package/src/records/recordBase.js

@@ -11,12 +11,13 @@ export class RecordBase extends EventEmitter {
     recordId;
     modId;
     fields;
-    portalData;
-    constructor(layout, recordId, modId = recordId) {
+    portalData = [];
+    constructor(layout, recordId, modId = recordId, fieldData) {
         super();
         this.layout = layout;
         this.recordId = recordId;
         this.modId = modId;
+        this.fields = this.processFieldData(fieldData);
     }
     get endpoint() {
         return `${this.layout.endpoint}/records/${this.recordId}`;
@@ -67,34 +68,4 @@ export class RecordBase extends EventEmitter {
         for (let field of this.fieldsArray)
             field.edited = false;
     }
-    toObject(filter = (a) => a.edited) {
-        let fields_processed = {};
-        let field;
-        for (field of this.fieldsArray.filter(field => filter(field))) {
-            let value = field.value;
-            if (value instanceof Date) {
-                // @ts-ignore
-                let _value = moment.default(value)
-                    .utcOffset(this.layout.database.host.timezoneOffset);
-                // @ts-ignore
-                switch (field.metadata.result) {
-                    case "time":
-                        value = _value.format(this.layout.database.host.metadata.productInfo.timeFormat.replace("dd", "DD"));
-                        break;
-                    case "date":
-                        value = _value.format(this.layout.database.host.metadata.productInfo.dateFormat.replace("dd", "DD"));
-                        break;
-                    default:
-                        value = _value.format(this.layout.database.host.metadata.productInfo.timeStampFormat.replace("dd", "DD"));
-                }
-            }
-            fields_processed[field.id] = value;
-        }
-        let obj = {
-            "recordId": this.recordId.toString(),
-            "modId": this.modId.toString(),
-            "fieldData": fields_processed
-        };
-        return obj;
-    }
 }

package/src/records/recordBase.ts

@@ -8,21 +8,22 @@ import {FieldBase, FieldValue} from "./fieldBase.js";
 import {RecordTypes} from "../types.js";
 import {RecordFieldsMap} from "../layouts/recordFieldsMap.js";
 import {LayoutBase} from "../layouts/layoutBase.js";
-import {ApiFieldData, ApiRowDataDef} from "../models/apiResults.js";
+import {ApiFieldData} from "../models/apiResults.js";
 
-export class RecordBase<T extends RecordFieldsMap> extends EventEmitter {
+export abstract class RecordBase<T extends RecordFieldsMap> extends EventEmitter {
     readonly layout: LayoutBase;
     readonly type: RecordTypes = RecordTypes.UNKNOWN;
     public recordId: number;
     modId: number;
     fields: T;
-    protected portalData: any[];
+    protected portalData: any[] = [];
 
-    constructor(layout: LayoutBase, recordId: number, modId = recordId) {
+    protected constructor(layout: LayoutBase, recordId: number, modId = recordId, fieldData: ApiFieldData) {
         super();
         this.layout = layout
         this.recordId = recordId
         this.modId = modId
+        this.fields = this.processFieldData(fieldData)
     }
 
     get endpoint(): string {
@@ -79,37 +80,4 @@ export class RecordBase<T extends RecordFieldsMap> extends EventEmitter {
         this.emit("saved")
         for (let field of this.fieldsArray) field.edited = false
     }
-
-    toObject(filter = (a: FieldBase<FieldValue>) => a.edited): Partial<Omit<ApiRowDataDef, "portalDataInfo">> {
-        let fields_processed: ApiFieldData = {}
-        let field: FieldBase<FieldValue>
-        for (field of this.fieldsArray.filter(field => filter(field))) {
-            let value = field.value
-            if (value instanceof Date) {
-                // @ts-ignore
-                let _value = moment.default(value)
-                    .utcOffset(this.layout.database.host.timezoneOffset)
-
-                // @ts-ignore
-
-                switch (field.metadata.result) {
-                    case "time":
-                        value = _value.format(this.layout.database.host.metadata.productInfo.timeFormat.replace("dd", "DD"))
-                        break
-                    case "date":
-                        value = _value.format(this.layout.database.host.metadata.productInfo.dateFormat.replace("dd", "DD"))
-                        break
-                    default:
-                        value = _value.format(this.layout.database.host.metadata.productInfo.timeStampFormat.replace("dd", "DD"))
-                }
-            }
-            fields_processed[field.id] = value
-        }
-        let obj = {
-            "recordId": this.recordId.toString(),
-            "modId": this.modId.toString(),
-            "fieldData": fields_processed
-        }
-        return obj
-    }
 }

package/src/utils/fmQuery.d.ts

@@ -0,0 +1,4 @@
+type QueryParameter = string | number | Date;
+export declare function fmQueryEscape(str: string): string;
+export declare function fmQuery(strings: TemplateStringsArray, ...args: QueryParameter[]): string;
+export {};

package/src/utils/fmQuery.js

@@ -0,0 +1,20 @@
+/*
+ * Copyright (c) 2024. See LICENSE file for more information
+ */
+const SPECIAL_CHARACTERS = ["\\", "=", "<", "≤", "≥", ">", "…", "...", "//", "@", "#", "*", "\"", "~"];
+export function fmQueryEscape(str) {
+    for (let char of SPECIAL_CHARACTERS) {
+        str = str.replace(char, `\\${char}`);
+    }
+    return str;
+}
+export function fmQuery(strings, ...args) {
+    let argStrings = args.map(item => {
+        return fmQueryEscape(item.toString());
+    });
+    // Zip the parameters together
+    const query = strings.map((str, index) => {
+        return str + (args[index] || '');
+    });
+    return query.join("");
+}

package/src/utils/query.d.ts

@@ -0,0 +1,4 @@
+type QueryParameter = string | number | Date;
+export declare function queryEscape(str: string): string;
+export declare function query(strings: TemplateStringsArray, ...args: QueryParameter[]): string;
+export {};

package/src/utils/query.js

@@ -0,0 +1,20 @@
+/*
+ * Copyright (c) 2024. See LICENSE file for more information
+ */
+const SPECIAL_CHARACTERS = ["\\", "=", "<", "≤", "≥", ">", "…", "...", "//", "@", "#", "*", "\"", "~"];
+export function queryEscape(str) {
+    for (let char of SPECIAL_CHARACTERS) {
+        str = str.replace(char, `\\${char}`);
+    }
+    return str;
+}
+export function query(strings, ...args) {
+    let argStrings = args.map(item => {
+        return queryEscape(item.toString());
+    });
+    // Zip the parameters together
+    const query = strings.map((str, index) => {
+        return str + (argStrings[index] || '');
+    });
+    return query.join("");
+}

package/src/utils/query.ts

@@ -0,0 +1,25 @@
+/*
+ * Copyright (c) 2024. See LICENSE file for more information
+ */
+
+const SPECIAL_CHARACTERS = ["\\", "=", "<", "≤", "≥", ">", "…", "...", "//", "@", "#", "*", "\"", "~"]
+type QueryParameter = string | number | Date
+
+export function queryEscape(str: string) {
+    for (let char of SPECIAL_CHARACTERS) {
+        str = str.replace(char, `\\${char}`)
+    }
+    return str
+}
+
+export function query(strings: TemplateStringsArray, ...args: QueryParameter[]) {
+    let argStrings = args.map(item => {
+        return queryEscape(item.toString())
+    })
+
+    // Zip the parameters together
+    const query = strings.map((str, index) => {
+        return str + (argStrings[index] || '')
+    })
+    return query.join("")
+}

package/src/records/field.ts

@@ -1,10 +0,0 @@
-/*
- * Copyright (c) 2024. See LICENSE file for more information
- */
-
-import {RecordBase} from "./recordBase.js";
-import {FieldBase, FieldValue} from "./fieldBase.js";
-
-export class Field<T extends FieldValue> extends FieldBase<T> {
-    record: RecordBase<any>;
-}