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

package/src/layouts/layout.d.ts

@@ -1,30 +1,16 @@
 import { LayoutRecordManager } from "./layoutRecordManager.js";
-import { LayoutRecord } from "../records/layoutRecord.js";
 import { Script, ScriptResult } from "../types.js";
 import { LayoutInterface } from "./layoutInterface.js";
-import { Find } from "../records/getOperations/find.js";
-import { FMError } from "../FMError.js";
 import { LayoutBase } from "./layoutBase.js";
-import { DatabaseBase } from "../connection/databaseBase";
+import { DatabaseBase } from "../connection/databaseBase.js";
+import { ApiLayoutMetadata } from "../models/apiResults.js";
 export declare class Layout<T extends LayoutInterface> implements LayoutBase {
     readonly database: DatabaseBase;
-    readonly records: LayoutRecordManager<T>;
     readonly name: string;
-    metadata: any;
+    readonly records: LayoutRecordManager<T>;
+    metadata: ApiLayoutMetadata;
     constructor(database: DatabaseBase, name: string);
     get endpoint(): string;
-    /**
-     * @deprecated use layout.records.create() instead
-     */
-    createRecord(): Promise<LayoutRecord<T["fields"], T["portals"]>>;
-    /**
-     * @deprecated use layout.records.get() instead
-     */
-    getRecord(recordId: any): Promise<LayoutRecord<T["fields"], T["portals"]>>;
-    /**
-     * @deprecated use layout.records.find() instead
-     */
-    newFind(): Find<T>;
     runScript(script: Script): Promise<ScriptResult>;
-    getLayoutMeta(): Promise<this | FMError>;
+    getLayoutMeta(): Promise<ApiLayoutMetadata>;
 }

package/src/layouts/layout.js

@@ -1,84 +1,42 @@
 /*
- * 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 { LayoutRecordManager } from "./layoutRecordManager.js";
 import { FMError } from "../FMError.js";
 export class Layout {
+    database;
+    name;
+    records = new LayoutRecordManager(this);
+    metadata;
     constructor(database, name) {
-        this.records = new LayoutRecordManager(this);
         this.database = database;
         this.name = name;
     }
     get endpoint() {
         return `${this.database.endpoint}/layouts/${this.name}`;
     }
-    /**
-     * @deprecated use layout.records.create() instead
-     */
-    createRecord() {
-        return this.records.create();
-    }
-    /**
-     * @deprecated use layout.records.get() instead
-     */
-    getRecord(recordId) {
-        return this.records.get(recordId);
-    }
-    /**
-     * @deprecated use layout.records.find() instead
-     */
-    newFind() {
-        return this.records.find();
-    }
-    runScript(script) {
-        let trace = new Error();
-        return new Promise((resolve, reject) => __awaiter(this, void 0, void 0, function* () {
-            let url = `${this.endpoint}/script/${encodeURIComponent(script.name)}`;
-            if (script.parameter)
-                url += "?script.param=" + encodeURIComponent(script.parameter);
-            this.database.apiRequest(url, {
-                port: 443,
-                method: "GET"
-            })
-                .then(res => {
-                if (res.messages[0].code === "0") {
-                    let error = parseInt(res.response.scriptError);
-                    let msg = {
-                        scriptError: error ? new FMError(error, 200, res, trace) : undefined,
-                        scriptResult: res.response.scriptResult
-                    };
-                    resolve(msg);
-                }
-                else {
-                    // console.log(res)
-                    reject(new FMError(res.messages[0].code, res.status, res, trace));
-                }
-            })
-                .catch(e => {
-                reject(e);
-            });
-        }));
-    }
-    getLayoutMeta() {
-        return new Promise((resolve, reject) => {
-            if (this.metadata) {
-                resolve(this.metadata);
-                return;
-            }
-            this.database.apiRequest(this.endpoint).then(res => {
-                this.metadata = res.response;
-                resolve(this);
-            })
-                .catch(e => reject(e));
+    async runScript(script) {
+        let url = `${this.endpoint}/script/${encodeURIComponent(script.name)}`;
+        if (script.parameter)
+            url += "?script.param=" + encodeURIComponent(script.parameter);
+        let res = await this.database.apiRequest(url, {
+            port: 443,
+            method: "GET"
         });
+        if (res.messages[0].code === "0") {
+            let error = parseInt(res.response.scriptError);
+            return {
+                scriptError: error ? new FMError(error, 200, res) : undefined,
+                scriptResult: res.response.scriptResult
+            };
+        }
+    }
+    async getLayoutMeta() {
+        if (this.metadata) {
+            return this.metadata;
+        }
+        let res = await this.database.apiRequest(this.endpoint);
+        this.metadata = res.response;
+        return this.metadata;
     }
 }

package/src/layouts/layout.ts

@@ -1,93 +1,54 @@
 /*
- * Copyright (c) 2023. See LICENSE file for more information
+ * Copyright (c) 2023-2024. See LICENSE file for more information
  */
 
 import {LayoutRecordManager} from "./layoutRecordManager.js";
-import {LayoutRecord} from "../records/layoutRecord.js";
 import {Script, ScriptResult} from "../types.js";
 import {LayoutInterface} from "./layoutInterface.js";
-import {Find} from "../records/getOperations/find.js";
 import {FMError} from "../FMError.js";
 import {LayoutBase} from "./layoutBase.js"
-import {DatabaseBase} from "../connection/databaseBase";
+import {DatabaseBase} from "../connection/databaseBase.js";
+import {ApiLayoutMetadata, ApiScriptResult} from "../models/apiResults.js";
 
 export class Layout<T extends LayoutInterface> implements LayoutBase {
     readonly database: DatabaseBase;
-    readonly records = new LayoutRecordManager<T>(this)
     readonly name: string;
-    metadata: any;
+    readonly records = new LayoutRecordManager<T>(this)
+    metadata: ApiLayoutMetadata;
 
     constructor(database: DatabaseBase, name: string) {
         this.database = database
         this.name = name
     }
 
+
     get endpoint() {
         return `${this.database.endpoint}/layouts/${this.name}`
     }
 
-    /**
-     * @deprecated use layout.records.create() instead
-     */
-    createRecord(): Promise<LayoutRecord<T["fields"], T["portals"]>> {
-        return this.records.create()
-    }
-
-    /**
-     * @deprecated use layout.records.get() instead
-     */
-    getRecord(recordId): Promise<LayoutRecord<T["fields"], T["portals"]>> {
-        return this.records.get(recordId)
-    }
-
-    /**
-     * @deprecated use layout.records.find() instead
-     */
-    newFind(): Find<T> {
-        return this.records.find()
-    }
-
-    runScript(script: Script): Promise<ScriptResult> {
-        let trace = new Error()
-        return new Promise(async (resolve, reject) => {
-            let url = `${this.endpoint}/script/${encodeURIComponent(script.name)}`
-            if (script.parameter) url += "?script.param=" + encodeURIComponent(script.parameter)
-            this.database.apiRequest(url, {
-                port: 443,
-                method: "GET"
-            })
-                .then(res => {
-                    if (res.messages[0].code === "0") {
-                        let error = parseInt(res.response.scriptError)
-                        let msg: ScriptResult = {
-                            scriptError: error ? new FMError(error, 200, res, trace) : undefined,
-                            scriptResult: res.response.scriptResult
-                        }
-                        resolve(msg)
-                    }
-                    else {
-                        // console.log(res)
-                        reject(new FMError(res.messages[0].code, res.status, res, trace))
-                    }
-                })
-                .catch(e => {
-                    reject(e)
-                })
+    async runScript(script: Script): Promise<ScriptResult> {
+        let url = `${this.endpoint}/script/${encodeURIComponent(script.name)}`
+        if (script.parameter) url += "?script.param=" + encodeURIComponent(script.parameter)
+        let res = await this.database.apiRequest<ApiScriptResult>(url, {
+            port: 443,
+            method: "GET"
         })
+        if (res.messages[0].code === "0") {
+            let error = parseInt(res.response.scriptError)
+            return {
+                scriptError: error ? new FMError(error, 200, res) : undefined,
+                scriptResult: res.response.scriptResult
+            }
+        }
     }
 
-    public getLayoutMeta(): Promise<this | FMError> {
-        return new Promise((resolve, reject) => {
-            if (this.metadata) {
-                resolve(this.metadata)
-                return
-            }
+    public async getLayoutMeta(): Promise<ApiLayoutMetadata> {
+        if (this.metadata) {
+            return this.metadata
+        }
 
-            this.database.apiRequest(this.endpoint).then(res => {
-                this.metadata = res.response
-                resolve(this)
-            })
-                .catch(e => reject(e))
-        })
+        let res = await this.database.apiRequest<ApiLayoutMetadata>(this.endpoint)
+        this.metadata = res.response
+        return this.metadata
     }
 }

package/src/layouts/layoutBase.d.ts

@@ -1,11 +1,11 @@
-import { Script, ScriptResult } from "../types";
-import { FMError } from "../FMError";
-import { DatabaseBase } from "../connection/databaseBase";
+import { Script, ScriptResult } from "../types.js";
+import { DatabaseBase } from "../connection/databaseBase.js";
+import { ApiLayoutMetadata } from "../models/apiResults.js";
 export interface LayoutBase {
     readonly name: string;
     metadata: any;
     endpoint: string;
     runScript(script: Script): Promise<ScriptResult>;
-    getLayoutMeta(): Promise<this | FMError>;
+    getLayoutMeta(): Promise<ApiLayoutMetadata>;
     database: DatabaseBase;
 }

package/src/layouts/layoutBase.js

@@ -1,4 +1,4 @@
 /*
- * Copyright (c) 2023. See LICENSE file for more information
+ * Copyright (c) 2023-2024. See LICENSE file for more information
  */
 export {};

package/src/layouts/layoutBase.ts

@@ -1,16 +1,16 @@
 /*
- * Copyright (c) 2023. See LICENSE file for more information
+ * Copyright (c) 2023-2024. See LICENSE file for more information
  */
 
-import {Script, ScriptResult} from "../types";
-import {FMError} from "../FMError";
-import {DatabaseBase} from "../connection/databaseBase";
+import {Script, ScriptResult} from "../types.js";
+import {DatabaseBase} from "../connection/databaseBase.js";
+import {ApiLayoutMetadata} from "../models/apiResults.js";
 
 export interface LayoutBase {
     readonly name: string
     metadata: any
     endpoint: string
     runScript(script: Script): Promise<ScriptResult>
-    getLayoutMeta(): Promise<this | FMError>
+    getLayoutMeta(): Promise<ApiLayoutMetadata>
     database: DatabaseBase
 }

package/src/layouts/layoutInterface.d.ts

@@ -1,5 +1,5 @@
 import { Portal } from "../records/portal.js";
-import { RecordFieldsMap } from "./recordFieldsMap";
+import { RecordFieldsMap } from "./recordFieldsMap.js";
 export interface LayoutInterface {
     fields: RecordFieldsMap;
     portals: PortalInterface;

package/src/layouts/layoutInterface.js

@@ -1,4 +1,4 @@
 /*
- * Copyright (c) 2023. See LICENSE file for more information
+ * Copyright (c) 2023-2024. See LICENSE file for more information
  */
 export {};

package/src/layouts/layoutInterface.ts

@@ -1,9 +1,9 @@
 /*
- * Copyright (c) 2023. See LICENSE file for more information
+ * Copyright (c) 2023-2024. See LICENSE file for more information
  */
 
 import {Portal} from "../records/portal.js";
-import {RecordFieldsMap} from "./recordFieldsMap";
+import {RecordFieldsMap} from "./recordFieldsMap.js";
 
 export interface LayoutInterface {
     fields: RecordFieldsMap,

package/src/layouts/layoutRecordManager.d.ts

@@ -1,13 +1,12 @@
 import { LayoutRecord } from "../records/layoutRecord.js";
 import { LayoutInterface } from "./layoutInterface.js";
-import { RecordGetRange } from "../records/getOperations/recordGetRange.js";
-import { Find } from "../records/getOperations/find.js";
 import { LayoutBase } from "./layoutBase.js";
+import { GetOperationOptions, RecordGetOperation } from "../records/getOperations/recordGetOperation.js";
+import { RecordFetchOptions } from "../types.js";
 export declare class LayoutRecordManager<T extends LayoutInterface> {
     readonly layout: LayoutBase;
     constructor(layout: LayoutBase);
-    create(): Promise<LayoutRecord<T["fields"], T["portals"]>>;
-    get(recordId: any): Promise<LayoutRecord<T["fields"], T["portals"]>>;
-    range(start?: number, limit?: number): RecordGetRange<T>;
-    find(start?: number, limit?: number): Find<T>;
+    create<OPTIONS extends RecordFetchOptions>(options: OPTIONS): Promise<LayoutRecord<T, OPTIONS["portals"][number]>>;
+    get(recordId: number): Promise<LayoutRecord<T>>;
+    list<OPTIONS extends GetOperationOptions<T>>(options: OPTIONS): RecordGetOperation<T, OPTIONS>;
 }

package/src/layouts/layoutRecordManager.js

@@ -1,50 +1,31 @@
 /*
- * Copyright (c) 2023. See LICENSE file for more information
+ * Copyright (c) 2023-2024. See LICENSE file for more information
  */
 import { LayoutRecord } from "../records/layoutRecord.js";
-import { RecordGetRange } from "../records/getOperations/recordGetRange.js";
-import { Find } from "../records/getOperations/find.js";
+import { RecordGetOperation } from "../records/getOperations/recordGetOperation.js";
 export class LayoutRecordManager {
+    layout;
     constructor(layout) {
         this.layout = layout;
     }
-    create() {
-        return new Promise((resolve, reject) => {
-            // Get the layout's metadata
-            this.layout.getLayoutMeta().then(layout => {
-                let fields = {};
-                for (let _field of this.layout.metadata.fieldMetaData) {
-                    fields[_field.name] = "";
-                }
-                let portals = {};
-                for (let _portal of Object.keys(this.layout.metadata.portalMetaData))
-                    portals[_portal] = [];
-                resolve(new LayoutRecord(this.layout, -1, 0, fields, portals));
-            }).catch(e => {
-                reject(e);
-            });
-        });
+    async create(options) {
+        await this.layout.getLayoutMeta();
+        let fields = {};
+        for (let _field of this.layout.metadata.fieldMetaData) {
+            fields[_field.name] = "";
+        }
+        let portals = {};
+        for (let _portal of Object.keys(this.layout.metadata.portalMetaData))
+            portals[_portal] = [];
+        return new LayoutRecord(this.layout, -1, 0, fields, portals);
     }
-    get(recordId) {
-        return new Promise((resolve, reject) => {
-            let record;
-            this.layout.getLayoutMeta()
-                .then(layout => {
-                record = new LayoutRecord(this.layout, recordId);
-                return record.get();
-            })
-                .then(() => {
-                resolve(record);
-            })
-                .catch(e => {
-                reject(e);
-            });
-        });
+    async get(recordId) {
+        await this.layout.getLayoutMeta();
+        let record = new LayoutRecord(this.layout, recordId);
+        await record.get();
+        return record;
     }
-    range(start = 0, limit = 100) {
-        return new RecordGetRange(this.layout, start, limit);
-    }
-    find(start = 0, limit = 100) {
-        return new Find(this.layout, start, limit);
+    list(options) {
+        return new RecordGetOperation(this.layout, options);
     }
 }

package/src/layouts/layoutRecordManager.ts

@@ -1,59 +1,38 @@
 /*
- * Copyright (c) 2023. See LICENSE file for more information
+ * Copyright (c) 2023-2024. See LICENSE file for more information
  */
 
 import {LayoutRecord} from "../records/layoutRecord.js";
 import {LayoutInterface} from "./layoutInterface.js";
-import {RecordGetRange} from "../records/getOperations/recordGetRange.js";
-import {Find} from "../records/getOperations/find.js";
 import {LayoutBase} from "./layoutBase.js"
+import {GetOperationOptions, RecordGetOperation} from "../records/getOperations/recordGetOperation.js";
+import {RecordFetchOptions} from "../types.js";
 
 export class LayoutRecordManager<T extends LayoutInterface> {
-    readonly layout: LayoutBase
-
+    readonly layout: LayoutBase;
     constructor(layout: LayoutBase) {
         this.layout = layout
     }
 
-    create(): Promise<LayoutRecord<T["fields"], T["portals"]>> {
-        return new Promise((resolve, reject) => {
-            // Get the layout's metadata
-            this.layout.getLayoutMeta().then(layout => {
-                let fields = {}
-                for (let _field of this.layout.metadata.fieldMetaData) {
-                    fields[_field.name] = ""
-                }
-                let portals = {}
-                for (let _portal of Object.keys(this.layout.metadata.portalMetaData)) portals[_portal] = []
-                resolve(new LayoutRecord(this.layout, -1, 0, fields, portals))
-            }).catch(e => {
-                reject(e)
-            })
-        })
-    }
-
-    get(recordId): Promise<LayoutRecord<T["fields"], T["portals"]>> {
-        return new Promise((resolve, reject) => {
-            let record
-            this.layout.getLayoutMeta()
-                .then(layout => {
-                    record = new LayoutRecord(this.layout, recordId)
-                    return record.get()
-                })
-                .then(() => {
-                    resolve(record)
-                })
-                .catch(e => {
-                    reject(e)
-                })
-        })
+    async create<OPTIONS extends RecordFetchOptions>(options: OPTIONS): Promise<LayoutRecord<T, OPTIONS["portals"][number]>> {
+        await this.layout.getLayoutMeta()
+        let fields = {}
+        for (let _field of this.layout.metadata.fieldMetaData) {
+            fields[_field.name] = ""
+        }
+        let portals = {}
+        for (let _portal of Object.keys(this.layout.metadata.portalMetaData)) portals[_portal] = []
+        return new LayoutRecord(this.layout, -1, 0, fields, portals)
     }
 
-    range(start = 0, limit = 100) {
-        return new RecordGetRange<T>(this.layout, start, limit)
+    async get(recordId: number): Promise<LayoutRecord<T>> {
+        await this.layout.getLayoutMeta()
+        let record = new LayoutRecord<T>(this.layout, recordId)
+        await record.get()
+        return record
     }
 
-    find(start = 0, limit = 100): Find<T> {
-        return new Find<T>(this.layout, start, limit)
+    list<OPTIONS extends GetOperationOptions<T>>(options: OPTIONS) {
+        return new RecordGetOperation<T, OPTIONS>(this.layout, options)
     }
 }

package/src/layouts/recordFieldsMap.d.ts

@@ -1,4 +1,4 @@
-import { Field, FieldValue } from "../records/field";
+import { FieldBase, FieldValue } from "../records/fieldBase.js";
 export interface RecordFieldsMap {
-    [fieldName: string]: Field<FieldValue>;
+    [fieldName: string]: FieldBase<FieldValue>;
 }

package/src/layouts/recordFieldsMap.js

@@ -1,4 +1,4 @@
 /*
- * Copyright (c) 2023. See LICENSE file for more information
+ * Copyright (c) 2023-2024. See LICENSE file for more information
  */
 export {};

package/src/layouts/recordFieldsMap.ts

@@ -1,9 +1,9 @@
 /*
- * Copyright (c) 2023. See LICENSE file for more information
+ * Copyright (c) 2023-2024. See LICENSE file for more information
  */
 
-import {Field, FieldValue} from "../records/field";
+import {FieldBase, FieldValue} from "../records/fieldBase.js";
 
 export interface RecordFieldsMap {
-    [fieldName: string]: Field<FieldValue>
+    [fieldName: string]: FieldBase<FieldValue>
 }

package/src/models/apiResults.d.ts

@@ -0,0 +1,103 @@
+export declare enum ApiFieldTypes {
+    NORMAL = "normal",
+    CALCULATION = "calculation",
+    SUMMARY = "summary"
+}
+export declare enum ApiFieldDisplayTypes {
+    EDIT_TEXT = "editText",
+    POPUP_LIST = "popupList",
+    CHECKBOX = "checkBox",
+    RADIO_BUTTONS = "radioButtons",
+    SELECTION_LIST = "selectionList",
+    CALENDAR = "calendar",
+    SECURE_TEXT = "secureText"
+}
+export declare enum ApiFieldResultTypes {
+    TEXT = "text",
+    NUMBER = "number",
+    DATE = "date",
+    TIME = "time",
+    TIMESTAMP = "timeStamp",
+    CONTAINER = "container"
+}
+export interface ApiMessage {
+    code: string;
+    message: string;
+}
+export interface ApiResults<T = unknown> {
+    response?: null | T & {
+        scriptError?: string;
+    };
+    messages: ApiMessage[];
+    httpStatus: number;
+}
+export interface ApiLayout {
+    name: string;
+    isFolder: boolean;
+    folderLayoutNames: string[];
+}
+export interface ApiLayoutMetadata {
+    fieldMetaData: ApiFieldMetadata[];
+    portalMetaData: {
+        [key: string]: ApiFieldMetadata[];
+    };
+    valueLists: ApiValueList[];
+}
+export interface ApiFieldMetadata {
+    name: string;
+    type: ApiFieldTypes;
+    displayType: ApiFieldDisplayTypes;
+    result: ApiFieldResultTypes;
+    global: boolean;
+    autoEnter: boolean;
+    fourDigitYear: boolean;
+    maxRepeat: number;
+    maxCharacters: number;
+    notEmpty: boolean;
+    numeric: boolean;
+    repetitions: number;
+    timeOfDay: boolean;
+    valueList: string;
+}
+export interface ApiValueList {
+    name: string;
+    type: string;
+    values: {
+        value: string;
+        displayName: string;
+    }[];
+}
+export interface ApiScriptResult {
+    scriptError: string;
+    scriptResult?: string;
+}
+export interface ApiRecordResponseObj {
+    data: ApiRowDataDef[];
+    dataInfo: ApiResultSetObj;
+}
+export interface ApiFieldData {
+    [key: string]: string;
+}
+export interface ApiPortalData {
+    [key: string]: ApiFieldData[];
+}
+export interface ApiResultSetObj {
+    database: string;
+    layout: string;
+    table: string;
+    totalRecordCount: number;
+    foundCount: number;
+    returnedCount: number;
+}
+export interface ApiRowDataDef {
+    fieldData: ApiFieldData;
+    portalData: ApiPortalData;
+    modId: string;
+    recordId: string;
+    portalDataInfo: {
+        database: string;
+        table: string;
+        foundCount: number;
+        returnedCount: number;
+    }[];
+}