@jd-data-limited/easy-fm 3.2.6 → 3.2.8

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

@@ -1,20 +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 { 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 {
+    record;
+    id;
+    _value;
+    edited;
     constructor(record, id, contents) {
         this.record = record;
         this.id = id;
@@ -43,9 +38,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 +49,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 +75,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 +86,8 @@ export class Field {
                 notEmpty: false,
                 numeric: false,
                 timeOfDay: false,
-                repetitionStart: 1,
-                repetitionEnd: 1
+                repetitions: 1,
+                valueList: ""
             };
         }
     }
@@ -121,60 +116,41 @@ export class Field {
         }
         throw "Field value is not a number";
     }
-    upload(buffer, filename, mime) {
+    async 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* () {
-            let form = new FormData();
-            form.append("upload", new File([buffer], filename, { type: mime }));
-            let _fetch = yield fetch(`${this.record.endpoint}/containers/${this.id}/1`, {
-                method: "POST",
-                // @ts-ignore
-                headers: { "Authorization": "Bearer " + this.record.layout.database.token },
-                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);
-            });
-        }));
+        let form = new FormData();
+        form.append("upload", new File([buffer], filename, { type: mime }));
+        await this.record.layout.database.apiRequest(`${this.record.endpoint}/containers/${this.id}/1`, {
+            method: "POST",
+            // @ts-ignore
+            headers: { "Authorization": "Bearer " + this.record.layout.database.token },
+            body: form
+        });
     }
-    download(mode = DOWNLOAD_MODES.Stream) {
+    async download(mode = DOWNLOAD_MODES.Stream) {
+        if (this.metadata.result !== ApiFieldResultTypes.CONTAINER)
+            throw new Error("Cannot perform download() on a non-container field");
+        let stream = await this.record.layout.database.streamURL(this.string);
+        if (mode === DOWNLOAD_MODES.Stream) {
+            return stream;
+        }
+        let body = [];
         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 = [];
-                stream.on("data", chunk => {
-                    body.push(chunk);
-                });
-                stream.on("error", (e) => {
-                    reject(e);
-                });
-                stream.on("end", () => {
-                    resolve({
-                        buffer: Buffer.concat(body),
-                        mime: stream.headers["content-type"],
-                        request: stream
-                    });
-                });
-            })
-                .catch(e => {
+            stream.on("data", chunk => {
+                body.push(chunk);
+            });
+            stream.on("error", (e) => {
                 reject(e);
             });
+            stream.on("end", () => {
+                resolve({
+                    buffer: Buffer.concat(body),
+                    mime: stream.headers["content-type"],
+                    request: stream
+                });
+            });
         });
     }
 }

package/src/records/field.ts

@@ -7,6 +7,7 @@ import fetch, {File, FormData} from "node-fetch";
 import * as http from "http";
 import {ContainerBufferResult, DOWNLOAD_MODES, FieldMetaData} from "../types.js";
 import {FMError} from "../FMError.js";
+import {ApiFieldDisplayTypes, ApiFieldMetadata, ApiFieldResultTypes, ApiFieldTypes} from "../models/apiResults.js";
 
 export type FieldValue = string | number | Date | Container
 export type Container = null
@@ -41,14 +42,14 @@ export class Field<T extends FieldValue> {
         this.edited = true
     }
 
-    get metadata(): FieldMetaData {
+    get metadata(): ApiFieldMetadata {
         if (!this.record.layout.metadata) {
             // 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,
@@ -57,9 +58,9 @@ export class Field<T extends FieldValue> {
                 notEmpty: false,
                 numeric: false,
                 timeOfDay: false,
-                repetitionStart: 1,
-                repetitionEnd: 1
-            } as FieldMetaData
+                repetitions: 1,
+                valueList: ""
+            }
         }
         if (this.record.type === RecordTypes.PORTAL) {
             // @ts-ignore
@@ -81,11 +82,11 @@ export class Field<T extends FieldValue> {
             } as FieldMetaData
         }
         else {
-            return this.record.layout.metadata.fieldMetaData.find(i => i.name === this.id) as FieldMetaData || {
+            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,
@@ -94,9 +95,9 @@ export class Field<T extends FieldValue> {
                 notEmpty: false,
                 numeric: false,
                 timeOfDay: false,
-                repetitionStart: 1,
-                repetitionEnd: 1
-            } as FieldMetaData
+                repetitions: 1,
+                valueList: ""
+            }
         }
     }
 
@@ -130,64 +131,45 @@ export class Field<T extends FieldValue> {
         throw "Field value is not a number"
     }
 
-    upload(buffer: Buffer, filename: string, mime: string): Promise<void> {
+    async upload(buffer: Buffer, filename: string, mime: string): Promise<void> {
         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(async (resolve, reject) => {
-            let form = new FormData()
-            form.append("upload", new File([buffer], filename, {type: mime}))
-
-            let _fetch = await fetch(`${this.record.endpoint}/containers/${this.id}/1`, {
-                method: "POST",
-                // @ts-ignore
-                headers: {"Authorization": "Bearer " + this.record.layout.database.token},
-                body: form
-            }).then(res => res.json())
-                .then(data => {
-                    let _res = data as any
-                    if (_res.messages[0].code === "0") {
-                        resolve()
-                    }
-                    else {
-                        reject(new FMError(_res.messages[0].code, _res.status, data, trace))
-                    }
-                })
-                .catch(e => {
-                    reject(e)
-                })
+        let form = new FormData()
+        form.append("upload", new File([buffer], filename, {type: mime}))
+
+        await this.record.layout.database.apiRequest<null>(`${this.record.endpoint}/containers/${this.id}/1`, {
+            method: "POST",
+            // @ts-ignore
+            headers: {"Authorization": "Bearer " + this.record.layout.database.token},
+            body: form
         })
     }
 
     download(mode: DOWNLOAD_MODES.Stream): Promise<http.IncomingMessage>
     download(mode: DOWNLOAD_MODES.Buffer): Promise<ContainerBufferResult>
-    download(mode: DOWNLOAD_MODES = DOWNLOAD_MODES.Stream): Promise<http.IncomingMessage | ContainerBufferResult> {
+    async download(mode: DOWNLOAD_MODES = DOWNLOAD_MODES.Stream): Promise<http.IncomingMessage | ContainerBufferResult> {
+        if (this.metadata.result !== ApiFieldResultTypes.CONTAINER) throw new Error("Cannot perform download() on a non-container field")
+
+        let stream = await this.record.layout.database.streamURL(this.string)
+        if (mode === DOWNLOAD_MODES.Stream) {
+            return stream
+        }
+
+        let body = []
         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 = []
-                    stream.on("data", chunk => {
-                        body.push(chunk)
-                    })
-                    stream.on("error", (e) => {
-                        reject(e)
-                    })
-                    stream.on("end", () => {
-                        resolve({
-                            buffer: Buffer.concat(body),
-                            mime: stream.headers["content-type"],
-                            request: stream
-                        } as ContainerBufferResult)
-                    })
-                })
-                .catch(e => {
-                    reject(e)
-                })
+            stream.on("data", chunk => {
+                body.push(chunk)
+            })
+            stream.on("error", (e) => {
+                reject(e)
+            })
+            stream.on("end", () => {
+                resolve({
+                    buffer: Buffer.concat(body),
+                    mime: stream.headers["content-type"],
+                    request: stream
+                } as ContainerBufferResult)
+            })
         })
     }
 }

package/src/records/getOperations/find.js

@@ -1,19 +1,11 @@
 /*
  * 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 { RecordGetOperation } from "./recordGetOperation.js";
 import { LayoutRecord } from "../layoutRecord.js";
 import { FMError } from "../../FMError.js";
 export class Find extends RecordGetOperation {
+    queries;
     constructor(layout, start = 0, limit = 100) {
         super(layout);
         this.setOffset(start);
@@ -55,36 +47,24 @@ export class Find extends RecordGetOperation {
     run() {
         return this.fetch();
     }
-    fetch() {
+    async fetch() {
         let trace = new Error();
-        return new Promise((resolve, reject) => {
-            // console.log(this.#toObject())
-            this.layout.getLayoutMeta()
-                .then(() => {
-                return this.layout.database.apiRequest(`${this.layout.endpoint}/_find`, {
-                    port: 443,
-                    method: "POST",
-                    body: JSON.stringify(this.toObject())
-                });
-            })
-                .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 LayoutRecord(this.layout, item.recordId, item.modId, item.fieldData, item.portalData);
-                    });
-                    resolve(data);
-                }
-                else {
-                    reject(new FMError(res.messages[0].code, res.status, res, trace));
-                }
-            }))
-                .catch(e => {
-                reject(e);
-            });
+        await this.layout.getLayoutMeta();
+        let res = await this.layout.database.apiRequest(`${this.layout.endpoint}/_find`, {
+            port: 443,
+            method: "POST",
+            body: JSON.stringify(this.toObject())
         });
+        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 {
+            throw new FMError(res.messages[0].code, res.httpStatus, res, trace);
+        }
     }
 }