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

package/src/layouts/layout.ts

@@ -10,12 +10,13 @@ import {Find} from "../records/getOperations/find.js";
 import {FMError} from "../FMError.js";
 import {LayoutBase} from "./layoutBase.js"
 import {DatabaseBase} from "../connection/databaseBase";
+import {ApiLayoutMetadata, ApiScriptResult} from "../models/apiResults";
 
 export class Layout<T extends LayoutInterface> implements LayoutBase {
     readonly database: DatabaseBase;
     readonly records = new LayoutRecordManager<T>(this)
     readonly name: string;
-    metadata: any;
+    metadata: ApiLayoutMetadata;
 
     constructor(database: DatabaseBase, name: string) {
         this.database = database
@@ -47,47 +48,29 @@ export class Layout<T extends LayoutInterface> implements LayoutBase {
         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 { ApiLayoutMetadata } from "../models/apiResults";
 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.ts

@@ -5,12 +5,13 @@
 import {Script, ScriptResult} from "../types";
 import {FMError} from "../FMError";
 import {DatabaseBase} from "../connection/databaseBase";
+import {ApiLayoutMetadata} from "../models/apiResults";
 
 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/layoutRecordManager.d.ts

@@ -7,7 +7,7 @@ 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"]>>;
+    get(recordId: number): Promise<LayoutRecord<T["fields"], T["portals"]>>;
     range(start?: number, limit?: number): RecordGetRange<T>;
     find(start?: number, limit?: number): Find<T>;
 }

package/src/layouts/layoutRecordManager.js

@@ -1,6 +1,15 @@
 /*
  * Copyright (c) 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); }); }
+    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 { LayoutRecord } from "../records/layoutRecord.js";
 import { RecordGetRange } from "../records/getOperations/recordGetRange.js";
 import { Find } from "../records/getOperations/find.js";
@@ -9,36 +18,24 @@ export class LayoutRecordManager {
         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);
-            });
+        return __awaiter(this, void 0, void 0, function* () {
+            yield 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);
-            });
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.layout.getLayoutMeta();
+            let record = new LayoutRecord(this.layout, recordId);
+            yield record.get();
+            return record;
         });
     }
     range(start = 0, limit = 100) {

package/src/layouts/layoutRecordManager.ts

@@ -15,38 +15,22 @@ export class LayoutRecordManager<T extends LayoutInterface> {
         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)
-            })
-        })
+    async create(): Promise<LayoutRecord<T["fields"], T["portals"]>> {
+        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): 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 get(recordId: number): Promise<LayoutRecord<T["fields"], T["portals"]>> {
+        await this.layout.getLayoutMeta()
+        let record = new LayoutRecord(this.layout, recordId)
+        await record.get()
+        return record
     }
 
     range(start = 0, limit = 100) {

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;
+    }[];
+}

package/src/models/apiResults.js

@@ -0,0 +1,28 @@
+/*
+ * Copyright (c) 2023. See LICENSE file for more information
+ */
+export var ApiFieldTypes;
+(function (ApiFieldTypes) {
+    ApiFieldTypes["NORMAL"] = "normal";
+    ApiFieldTypes["CALCULATION"] = "calculation";
+    ApiFieldTypes["SUMMARY"] = "summary";
+})(ApiFieldTypes || (ApiFieldTypes = {}));
+export var ApiFieldDisplayTypes;
+(function (ApiFieldDisplayTypes) {
+    ApiFieldDisplayTypes["EDIT_TEXT"] = "editText";
+    ApiFieldDisplayTypes["POPUP_LIST"] = "popupList";
+    ApiFieldDisplayTypes["CHECKBOX"] = "checkBox";
+    ApiFieldDisplayTypes["RADIO_BUTTONS"] = "radioButtons";
+    ApiFieldDisplayTypes["SELECTION_LIST"] = "selectionList";
+    ApiFieldDisplayTypes["CALENDAR"] = "calendar";
+    ApiFieldDisplayTypes["SECURE_TEXT"] = "secureText";
+})(ApiFieldDisplayTypes || (ApiFieldDisplayTypes = {}));
+export var ApiFieldResultTypes;
+(function (ApiFieldResultTypes) {
+    ApiFieldResultTypes["TEXT"] = "text";
+    ApiFieldResultTypes["NUMBER"] = "number";
+    ApiFieldResultTypes["DATE"] = "date";
+    ApiFieldResultTypes["TIME"] = "time";
+    ApiFieldResultTypes["TIMESTAMP"] = "timeStamp";
+    ApiFieldResultTypes["CONTAINER"] = "container";
+})(ApiFieldResultTypes || (ApiFieldResultTypes = {}));

package/src/models/apiResults.ts

@@ -0,0 +1,112 @@
+/*
+ * Copyright (c) 2023. See LICENSE file for more information
+ */
+
+import * as stream from "stream";
+
+export enum ApiFieldTypes {
+    NORMAL = "normal",
+    CALCULATION = "calculation",
+    SUMMARY = "summary"
+}
+
+export enum ApiFieldDisplayTypes {
+    EDIT_TEXT = "editText",
+    POPUP_LIST = "popupList",
+    CHECKBOX = "checkBox",
+    RADIO_BUTTONS = "radioButtons",
+    SELECTION_LIST = "selectionList",
+    CALENDAR = "calendar",
+    SECURE_TEXT = "secureText"
+}
+
+export 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
+    }[]
+}

package/src/records/field.d.ts

@@ -2,7 +2,8 @@
 /// <reference types="node" />
 import { RecordBase } from "./recordBase.js";
 import * as http from "http";
-import { ContainerBufferResult, DOWNLOAD_MODES, FieldMetaData } from "../types.js";
+import { ContainerBufferResult, DOWNLOAD_MODES } from "../types.js";
+import { ApiFieldMetadata } from "../models/apiResults.js";
 export type FieldValue = string | number | Date | Container;
 export type Container = null;
 export declare class Field<T extends FieldValue> {
@@ -12,7 +13,7 @@ export declare class Field<T extends FieldValue> {
     edited: boolean;
     constructor(record: any, id: any, contents: any);
     set(content: string | number | Date | undefined | null): void;
-    get metadata(): FieldMetaData;
+    get metadata(): ApiFieldMetadata;
     get value(): T;
     set value(value: T);
     get string(): string;

package/src/records/field.js

@@ -11,9 +11,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { RecordTypes } from "./recordBase.js";
-import fetch, { File, FormData } from "node-fetch";
+import { File, FormData } from "node-fetch";
 import { DOWNLOAD_MODES } from "../types.js";
-import { FMError } from "../FMError.js";
+import { ApiFieldDisplayTypes, ApiFieldResultTypes, ApiFieldTypes } from "../models/apiResults.js";
 export class Field {
     constructor(record, id, contents) {
         this.record = record;
@@ -43,9 +43,9 @@ export class Field {
             // Default to a regular text field
             return {
                 name: this.id.toString(),
-                type: 'normal',
-                displayType: 'editText',
-                result: 'text',
+                type: ApiFieldTypes.NORMAL,
+                displayType: ApiFieldDisplayTypes.EDIT_TEXT,
+                result: ApiFieldResultTypes.TEXT,
                 global: false,
                 autoEnter: true,
                 fourDigitYear: false,
@@ -54,8 +54,8 @@ export class Field {
                 notEmpty: false,
                 numeric: false,
                 timeOfDay: false,
-                repetitionStart: 1,
-                repetitionEnd: 1
+                repetitions: 1,
+                valueList: ""
             };
         }
         if (this.record.type === RecordTypes.PORTAL) {
@@ -80,9 +80,9 @@ export class Field {
         else {
             return this.record.layout.metadata.fieldMetaData.find(i => i.name === this.id) || {
                 name: this.id.toString(),
-                type: 'normal',
-                displayType: 'editText',
-                result: 'text',
+                type: ApiFieldTypes.NORMAL,
+                displayType: ApiFieldDisplayTypes.EDIT_TEXT,
+                result: ApiFieldResultTypes.TEXT,
                 global: false,
                 autoEnter: true,
                 fourDigitYear: false,
@@ -91,8 +91,8 @@ export class Field {
                 notEmpty: false,
                 numeric: false,
                 timeOfDay: false,
-                repetitionStart: 1,
-                repetitionEnd: 1
+                repetitions: 1,
+                valueList: ""
             };
         }
     }
@@ -122,42 +122,30 @@ export class Field {
         throw "Field value is not a number";
     }
     upload(buffer, filename, mime) {
-        let trace = new Error();
-        if (this.metadata.result !== "container")
-            throw "Cannot upload a file to the field; " + this.id + " (not a container field)";
-        return new Promise((resolve, reject) => __awaiter(this, void 0, void 0, function* () {
+        return __awaiter(this, void 0, void 0, function* () {
+            let trace = new Error();
+            if (this.metadata.result !== "container")
+                throw "Cannot upload a file to the field; " + this.id + " (not a container field)";
             let form = new FormData();
             form.append("upload", new File([buffer], filename, { type: mime }));
-            let _fetch = yield fetch(`${this.record.endpoint}/containers/${this.id}/1`, {
+            yield this.record.layout.database.apiRequest(`${this.record.endpoint}/containers/${this.id}/1`, {
                 method: "POST",
                 // @ts-ignore
-                headers: { "Authorization": "Bearer " + this.record.layout.database.token },
+                headers: { "Authorization": "Bearer " + this.record.layout.database.token, "Content-Type": "multipart/form-data" },
                 body: form
-            }).then(res => res.json())
-                .then(data => {
-                let _res = data;
-                if (_res.messages[0].code === "0") {
-                    resolve();
-                }
-                else {
-                    reject(new FMError(_res.messages[0].code, _res.status, data, trace));
-                }
-            })
-                .catch(e => {
-                reject(e);
             });
-        }));
+        });
     }
     download(mode = DOWNLOAD_MODES.Stream) {
-        return new Promise((resolve, reject) => {
-            // @ts-ignore
-            this.record.layout.database.streamContainer(this, this._value)
-                .then(stream => {
-                if (mode === DOWNLOAD_MODES.Stream) {
-                    resolve(stream);
-                    return;
-                }
-                let body = [];
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.metadata.result !== ApiFieldResultTypes.CONTAINER)
+                throw new Error("Cannot perform download() on a non-container field");
+            let stream = yield this.record.layout.database.streamURL(this.string);
+            if (mode === DOWNLOAD_MODES.Stream) {
+                return stream;
+            }
+            let body = [];
+            return new Promise((resolve, reject) => {
                 stream.on("data", chunk => {
                     body.push(chunk);
                 });
@@ -171,9 +159,6 @@ export class Field {
                         request: stream
                     });
                 });
-            })
-                .catch(e => {
-                reject(e);
             });
         });
     }