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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jd-data-limited/easy-fm",
-  "version": "4.0.0",
+  "version": "4.0.1",
   "dependencies": {
     "follow-redirects": "^1.15.5",
     "moment": "^2.29.4"

package/src/connection/database.d.ts

@@ -25,8 +25,7 @@ export declare class Database<T extends DatabaseStructure> extends EventEmitter
     listLayouts(): Promise<Layout<LayoutInterface>[]>;
     getLayout<R extends keyof T["layouts"]>(name: R): Layout<T["layouts"][R]>;
     getLayout<R extends LayoutInterface>(name: string): Layout<R>;
-    setGlobals(globalFields: any): Promise<void>;
-    script(name: any, parameter?: string): Script;
+    script(name: string, parameter?: string): Script;
     _tokenExpired(): void;
     streamURL(url: string): Promise<IncomingMessage>;
 }

package/src/connection/database.js

@@ -123,16 +123,6 @@ export class Database extends EventEmitter {
     getLayout(name) {
         return new Layout(this, name);
     }
-    /*
-    @deprecated
-     */
-    async setGlobals(globalFields) {
-        // console.log({globalFields})
-        await this.apiRequest(`${this.endpoint}/globals`, {
-            method: "PATCH",
-            body: JSON.stringify({ globalFields })
-        });
-    }
     script(name, parameter = "") {
         return { name, parameter };
     }

package/src/connection/database.ts

@@ -155,18 +155,7 @@ export class Database<T extends DatabaseStructure> extends EventEmitter implemen
         return new Layout<LayoutInterface>(this, name)
     }
 
-    /*
-    @deprecated
-     */
-    async setGlobals(globalFields) {
-        // console.log({globalFields})
-        await this.apiRequest(`${this.endpoint}/globals`, {
-            method: "PATCH",
-            body: JSON.stringify({globalFields})
-        })
-    }
-
-    script(name, parameter = ""): Script {
+    script(name: string, parameter = ""): Script {
         return ({name, parameter} as Script)
     }
 
@@ -180,7 +169,7 @@ export class Database<T extends DatabaseStructure> extends EventEmitter implemen
                 throw new Error("URL is empty, or has invalid value")
             }
 
-            let headers = {}
+            let headers: {[key: string]: string} = {}
             if (Object.keys(this.cookies).length !== 0) {
                 headers["Cookie"] = Object.keys(this.cookies)
                     .map(key => {
@@ -189,7 +178,7 @@ export class Database<T extends DatabaseStructure> extends EventEmitter implemen
                     .join("; ")
             }
 
-            const check_for_cookies = (res) => {
+            const check_for_cookies = (res: HTTP_REDIRECT.ResponseDetails) => {
                 // Check for the 'set-cookie' header. If it exists, remember it and strip it for better security.
                 if (res.headers['set-cookie']) {
                     for (let cookie of res.headers['set-cookie']) {

package/src/layouts/layoutBase.d.ts

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

package/src/layouts/layoutBase.ts

@@ -8,7 +8,7 @@ import {ApiLayoutMetadata} from "../models/apiResults.js";
 
 export interface LayoutBase {
     readonly name: string
-    metadata: any
+    metadata: ApiLayoutMetadata | null
     endpoint: string
     runScript(script: Script): Promise<ScriptResult>
     getLayoutMeta(): Promise<ApiLayoutMetadata>

package/src/layouts/layoutRecordManager.ts

@@ -7,6 +7,7 @@ import {LayoutInterface} from "./layoutInterface.js";
 import {LayoutBase} from "./layoutBase.js"
 import {GetOperationOptions, RecordGetOperation} from "../records/getOperations/recordGetOperation.js";
 import {RecordFetchOptions} from "../types.js";
+import {ApiFieldData} from "../models/apiResults.js";
 
 export class LayoutRecordManager<T extends LayoutInterface> {
     readonly layout: LayoutBase;
@@ -16,11 +17,11 @@ export class LayoutRecordManager<T extends LayoutInterface> {
 
     async create<OPTIONS extends RecordFetchOptions>(options: OPTIONS): Promise<LayoutRecord<T, OPTIONS["portals"][number]>> {
         await this.layout.getLayoutMeta()
-        let fields = {}
+        let fields: ApiFieldData = {}
         for (let _field of this.layout.metadata.fieldMetaData) {
             fields[_field.name] = ""
         }
-        let portals = {}
+        let portals: {[key: string]: []} = {}
         for (let _portal of Object.keys(this.layout.metadata.portalMetaData)) portals[_portal] = []
         return new LayoutRecord(this.layout, -1, 0, fields, portals)
     }

package/src/models/apiResults.d.ts

@@ -75,9 +75,9 @@ export interface ApiRecordResponseObj {
     data: ApiRowDataDef[];
     dataInfo: ApiResultSetObj;
 }
-export interface ApiFieldData {
-    [key: string]: string;
-}
+export type ApiFieldData = {
+    [key: string]: string | number;
+};
 export interface ApiPortalData {
     [key: string]: ApiFieldData[];
 }

package/src/models/apiResults.js

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023. See LICENSE file for more information
+ * Copyright (c) 2023-2024. See LICENSE file for more information
  */
 export var ApiFieldTypes;
 (function (ApiFieldTypes) {

package/src/models/apiResults.ts

@@ -1,9 +1,7 @@
 /*
- * Copyright (c) 2023. See LICENSE file for more information
+ * Copyright (c) 2023-2024. See LICENSE file for more information
  */
 
-import * as stream from "stream";
-
 export enum ApiFieldTypes {
     NORMAL = "normal",
     CALCULATION = "calculation",
@@ -85,7 +83,7 @@ export interface ApiRecordResponseObj {
     dataInfo: ApiResultSetObj
 }
 
-export interface ApiFieldData {[key: string]: string}
+export type ApiFieldData = {[key: string]: string | number}
 
 export interface ApiPortalData {[key: string]: ApiFieldData[]}
 

package/src/records/fieldBase.ts

@@ -154,7 +154,7 @@ export class FieldBase<T extends FieldValue> {
             return stream
         }
 
-        let body = []
+        let body: Uint8Array[] = []
         return new Promise((resolve, reject) => {
             stream.on("data", chunk => {
                 body.push(chunk)

package/src/records/layoutRecord.d.ts

@@ -1,19 +1,21 @@
-import { extraBodyOptions, recordObject } from "../types.js";
+import { extraBodyOptions } from "../types.js";
 import { RecordBase } from "./recordBase.js";
+import { PortalRecord } from "./portalRecord.js";
 import { Portal } from "./portal.js";
 import { LayoutInterface } from "../layouts/layoutInterface.js";
 import { LayoutRecordBase } from "./layoutRecordBase.js";
+import { ApiPortalData } from "../models/apiResults.js";
 import { LayoutBase } from "../layouts/layoutBase.js";
+import { FieldBase, FieldValue } from "./fieldBase.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[]);
+    constructor(layout: LayoutBase, recordId: number | string, modId?: string | number, fieldData?: Record<string, string | number>, portalData?: ApiPortalData | null, portalsToInclude?: PORTALS_TO_INCLUDE[]);
     get portalsArray(): Portal<any>[];
     commit(extraBody?: extraBodyOptions): Promise<this>;
-    protected processPortalData(portalData: any): void;
+    protected processPortalData(portalData: ApiPortalData): void;
     get(): Promise<this>;
-    getPortal(portal: any): Portal<any>;
     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;
+    toObject(filter?: (a: FieldBase<FieldValue>) => any, portalFilter?: (a: Portal<any>) => any, portalRowFilter?: (a: PortalRecord<never>) => any, portalFieldFilter?: (a: FieldBase<FieldValue>) => any): Partial<Omit<import("../models/apiResults.js").ApiRowDataDef, "portalDataInfo">>;
 }

package/src/records/layoutRecord.js

@@ -10,7 +10,7 @@ export class LayoutRecord extends RecordBase {
     portals = {};
     portalsToInclude;
     constructor(layout, recordId, modId = recordId, fieldData = {}, portalData = null, portalsToInclude = []) {
-        super(layout, recordId, modId);
+        super(layout, parseInt(recordId), parseInt(modId));
         this.processFieldData(fieldData);
         this.portalsToInclude = portalsToInclude;
         if (portalData) {
@@ -83,7 +83,7 @@ export class LayoutRecord extends RecordBase {
                 let fieldData = item;
                 delete fieldData.recordId;
                 delete fieldData.modId;
-                return new PortalRecord(this, _portal, item.recordId, item.modId, fieldData);
+                return new PortalRecord(this, _portal, parseInt(item.recordId), parseInt(item.modId), fieldData);
             });
             // @ts-ignore
             this.portals[portalName] = _portal;
@@ -110,9 +110,6 @@ export class LayoutRecord extends RecordBase {
             return this;
         }
     }
-    getPortal(portal) {
-        return this.portalsArray.find(p => p.name === portal);
-    }
     async duplicate() {
         let trace = new Error();
         let res = await this.layout.database.apiRequest(this.endpoint, {
@@ -150,7 +147,7 @@ export class LayoutRecord extends RecordBase {
         }
     }
     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);
+        let obj = super.toObject(filter);
         // Check if there's been any edited portal information
         let portals = this.portalsArray.filter(a => portalFilter(a));
         if (portals) {

package/src/records/layoutRecord.ts

@@ -2,15 +2,16 @@
  * Copyright (c) 2023-2024. See LICENSE file for more information
  */
 
-import {extraBodyOptions, recordObject} from "../types.js";
+import {extraBodyOptions} from "../types.js";
 import {RecordBase} from "./recordBase.js";
 import {PortalRecord} from "./portalRecord.js";
 import {Portal} from "./portal.js";
 import {LayoutInterface} from "../layouts/layoutInterface.js";
 import {FMError} from "../FMError.js";
 import {LayoutRecordBase} from "./layoutRecordBase.js";
-import {ApiRecordResponseObj} from "../models/apiResults.js";
+import {ApiPortalData, ApiRecordResponseObj} from "../models/apiResults.js";
 import {LayoutBase} from "../layouts/layoutBase.js"
+import {FieldBase, FieldValue} from "./fieldBase.js";
 
 export class LayoutRecord<LAYOUT extends LayoutInterface, PORTALS_TO_INCLUDE = string> extends RecordBase<LAYOUT["fields"]> implements LayoutRecordBase {
     // @ts-ignore
@@ -22,9 +23,9 @@ export class LayoutRecord<LAYOUT extends LayoutInterface, PORTALS_TO_INCLUDE = s
         recordId: number | string,
         modId = recordId,
         fieldData: Record<string, string | number> = {},
-        portalData = null, portalsToInclude: PORTALS_TO_INCLUDE[] = [])
+        portalData: ApiPortalData | null = null, portalsToInclude: PORTALS_TO_INCLUDE[] = [])
     {
-        super(layout, recordId, modId);
+        super(layout, parseInt(recordId as string), parseInt(modId as string));
         this.processFieldData(fieldData)
         this.portalsToInclude = portalsToInclude
         if (portalData) {
@@ -37,7 +38,7 @@ export class LayoutRecord<LAYOUT extends LayoutInterface, PORTALS_TO_INCLUDE = s
     }
 
     async commit(extraBody: extraBodyOptions = {}): Promise<this> {
-        let data = this.toObject()
+        let data: any = this.toObject()
         delete data.recordId
         delete data.modId
 
@@ -100,14 +101,14 @@ export class LayoutRecord<LAYOUT extends LayoutInterface, PORTALS_TO_INCLUDE = s
         }
     }
 
-    protected processPortalData(portalData): void {
+    protected processPortalData(portalData: ApiPortalData): void {
         for (let portalName of Object.keys(portalData)) {
             let _portal = new Portal(this, portalName)
             _portal.records = portalData[portalName].map(item => {
                 let fieldData = item;
                 delete fieldData.recordId;
                 delete fieldData.modId;
-                return new PortalRecord(this, _portal, item.recordId, item.modId, fieldData);
+                return new PortalRecord(this, _portal, parseInt(item.recordId as string), parseInt(item.modId as string), fieldData);
             })
 
             // @ts-ignore
@@ -136,10 +137,6 @@ export class LayoutRecord<LAYOUT extends LayoutInterface, PORTALS_TO_INCLUDE = s
         }
     }
 
-    getPortal(portal) {
-        return this.portalsArray.find(p => p.name === portal)
-    }
-
     async duplicate(): Promise<LayoutRecord<LAYOUT>> {
         let trace = new Error()
         let res = await this.layout.database.apiRequest<{recordId: string, modId: string}>(this.endpoint, {
@@ -179,8 +176,13 @@ export class LayoutRecord<LAYOUT extends LayoutInterface, PORTALS_TO_INCLUDE = s
         }
     }
 
-    toObject(filter: (a) => any = (a) => a.edited, portalFilter: (a) => any = (a) => a.records.find(record => record.edited), portalRowFilter: (a) => any = (a) => a.edited, portalFieldFilter: (a) => any = (a) => a.edited): recordObject {
-        let obj = super.toObject(filter, portalFilter, portalRowFilter, portalFieldFilter);
+    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);
 
         // Check if there's been any edited portal information
         let portals = this.portalsArray.filter(a => portalFilter(a))

package/src/records/portal.ts

@@ -19,7 +19,9 @@ export class Portal<T extends RecordFieldsMap> implements PortalBase<T> {
     }
 
     create() {
-        let fields = {}
+        let fields: {
+            [key: string]: string
+        } = {}
         for (let _field of this.record.layout.metadata.portalMetaData[this.name]) {
             fields[_field.name] = ""
         }

package/src/records/portalRecord.d.ts

@@ -2,12 +2,16 @@ import { RecordBase } from "./recordBase.js";
 import { extraBodyOptions, RecordTypes } from "../types.js";
 import { RecordFieldsMap } from "../layouts/recordFieldsMap.js";
 import { PortalBase } from "./portalBase.js";
+import { FieldBase, FieldValue } from "./fieldBase.js";
 export declare class PortalRecord<T extends RecordFieldsMap> extends RecordBase<T> {
     readonly portal: PortalBase<T>;
     readonly type = RecordTypes.PORTAL;
-    constructor(record: any, portal: any, recordId: any, modId?: any, fieldData?: {});
+    constructor(record: RecordBase<any>, portal: PortalBase<any>, recordId: number, modId?: number, fieldData?: {});
     _onSave(): void;
     commit(extraBody?: extraBodyOptions): Promise<import("./layoutRecord.js").LayoutRecord<import("../index.js").LayoutInterface, string>>;
-    toObject(fieldFilter: any): any;
-    getField(field: any): import("./fieldBase.js").FieldBase<import("./fieldBase.js").FieldValue>;
+    toObject(fieldFilter: (a: FieldBase<FieldValue>) => boolean): {
+        [key: string]: string;
+        modId: string;
+        recordId: string;
+    };
 }

package/src/records/portalRecord.js

@@ -21,15 +21,12 @@ export class PortalRecord extends RecordBase {
     toObject(fieldFilter) {
         super.toObject();
         let res = {
-            recordId: this.recordId === -1 ? undefined : this.recordId,
-            modId: this.modId === -1 ? undefined : this.modId
+            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;
+            res[field.id] = field.value.toString();
         // console.log(res)
         return res;
     }
-    getField(field) {
-        return this.fieldsArray.find(_field => _field.id === field) || this.fieldsArray.find(_field => _field.id === this.portal.name + "::" + field);
-    }
 }

package/src/records/portalRecord.ts

@@ -3,16 +3,17 @@
  */
 
 import {RecordBase} from "./recordBase.js";
-import {extraBodyOptions, recordObject, RecordTypes} from "../types.js";
+import {extraBodyOptions, RecordTypes} from "../types.js";
 
 import {RecordFieldsMap} from "../layouts/recordFieldsMap.js";
 import {PortalBase} from "./portalBase.js";
+import {FieldBase, FieldValue} from "./fieldBase.js";
 
 export class PortalRecord<T extends RecordFieldsMap> extends RecordBase<T> {
     readonly portal: PortalBase<T>;
     readonly type = RecordTypes.PORTAL
 
-    constructor(record, portal, recordId, modId = recordId, fieldData = {}) {
+    constructor(record: RecordBase<any>, portal: PortalBase<any>, recordId: number, modId = recordId, fieldData = {}) {
         super(record.layout, recordId, modId);
 
         this.portal = portal
@@ -28,18 +29,18 @@ export class PortalRecord<T extends RecordFieldsMap> extends RecordBase<T> {
         return this.portal.record.commit(extraBody)
     }
 
-    toObject(fieldFilter): any {
+    toObject(fieldFilter: (a: FieldBase<FieldValue>) => boolean) {
         super.toObject()
-        let res = {
-            recordId: this.recordId === -1 ? undefined : this.recordId,
-            modId: this.modId === -1 ? undefined : this.modId
-        } as recordObject
-        for (let field of this.fieldsArray.filter(a => fieldFilter(a))) res[field.id] = field.value
+        let res: {
+            "modId": string,
+            "recordId": string
+            [key: string]: string
+        } = {
+            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()
         // console.log(res)
         return res
     }
-
-    getField(field) {
-        return this.fieldsArray.find(_field => _field.id === field) || this.fieldsArray.find(_field => _field.id === this.portal.name + "::" + field)
-    }
 }

package/src/records/recordBase.d.ts

@@ -1,9 +1,10 @@
 /// <reference types="node" resolution-mode="require"/>
 import { EventEmitter } from "events";
 import { FieldBase, FieldValue } from "./fieldBase.js";
-import { recordObject, RecordTypes } from "../types.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 {
     readonly layout: LayoutBase;
     readonly type: RecordTypes;
@@ -11,11 +12,11 @@ export declare class RecordBase<T extends RecordFieldsMap> extends EventEmitter
     modId: number;
     fields: T;
     protected portalData: any[];
-    constructor(layout: any, recordId: any, modId?: any);
+    constructor(layout: LayoutBase, recordId: number, modId?: number);
     get endpoint(): string;
     get edited(): boolean;
     get fieldsArray(): FieldBase<FieldValue>[];
-    protected processFieldData(fieldData: any): T;
+    protected processFieldData(fieldData: ApiFieldData): T;
     _onSave(): void;
-    toObject(filter?: (a: any) => any, portalFilter?: (a: any) => any, portalRowFilter?: (a: any) => any, portalFieldFilter?: (a: any) => any): recordObject;
+    toObject(filter?: (a: FieldBase<FieldValue>) => boolean): Partial<Omit<ApiRowDataDef, "portalDataInfo">>;
 }

package/src/records/recordBase.js

@@ -67,7 +67,7 @@ export class RecordBase extends EventEmitter {
         for (let field of this.fieldsArray)
             field.edited = false;
     }
-    toObject(filter = (a) => a.edited, portalFilter = (a) => a.records.find(record => record.edited), portalRowFilter = (a) => a.edited, portalFieldFilter = (a) => a.edited) {
+    toObject(filter = (a) => a.edited) {
         let fields_processed = {};
         let field;
         for (field of this.fieldsArray.filter(field => filter(field))) {
@@ -91,8 +91,8 @@ export class RecordBase extends EventEmitter {
             fields_processed[field.id] = value;
         }
         let obj = {
-            "recordId": this.recordId,
-            "modId": this.modId,
+            "recordId": this.recordId.toString(),
+            "modId": this.modId.toString(),
             "fieldData": fields_processed
         };
         return obj;

package/src/records/recordBase.ts

@@ -5,9 +5,10 @@
 import {EventEmitter} from "events";
 import * as moment from "moment";
 import {FieldBase, FieldValue} from "./fieldBase.js";
-import {recordObject, RecordTypes} from "../types.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 class RecordBase<T extends RecordFieldsMap> extends EventEmitter {
     readonly layout: LayoutBase;
@@ -17,7 +18,7 @@ export class RecordBase<T extends RecordFieldsMap> extends EventEmitter {
     fields: T;
     protected portalData: any[];
 
-    constructor(layout, recordId, modId = recordId) {
+    constructor(layout: LayoutBase, recordId: number, modId = recordId) {
         super();
         this.layout = layout
         this.recordId = recordId
@@ -36,7 +37,7 @@ export class RecordBase<T extends RecordFieldsMap> extends EventEmitter {
         return Object.values(this.fields)
     }
 
-    protected processFieldData(fieldData) {
+    protected processFieldData(fieldData: ApiFieldData) {
         let fields: RecordFieldsMap = {}
 
         for (let key of Object.keys(fieldData)) {
@@ -79,12 +80,8 @@ export class RecordBase<T extends RecordFieldsMap> extends EventEmitter {
         for (let field of this.fieldsArray) field.edited = false
     }
 
-    toObject(filter = (a) => a.edited,
-             portalFilter = (a) => a.records.find(record => record.edited),
-             portalRowFilter = (a) => a.edited,
-             portalFieldFilter = (a) => a.edited
-    ): recordObject {
-        let fields_processed = {}
+    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
@@ -109,8 +106,8 @@ export class RecordBase<T extends RecordFieldsMap> extends EventEmitter {
             fields_processed[field.id] = value
         }
         let obj = {
-            "recordId": this.recordId,
-            "modId": this.modId,
+            "recordId": this.recordId.toString(),
+            "modId": this.modId.toString(),
             "fieldData": fields_processed
         }
         return obj