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

package/src/records/portal.ts

@@ -1,25 +1,27 @@
 /*
- * Copyright (c) 2023. See LICENSE file for more information
+ * Copyright (c) 2023-2024. See LICENSE file for more information
  */
 
 import {PortalRecord} from "./portalRecord.js";
-import {RecordFieldsMap} from "../layouts/recordFieldsMap";
-import {PortalBase} from "./portalBase";
-import {LayoutRecordBase} from "./layoutRecordBase";
-import {LayoutRecord} from "./layoutRecord";
+import {RecordFieldsMap} from "../layouts/recordFieldsMap.js";
+import {PortalBase} from "./portalBase.js";
+import {LayoutRecord} from "./layoutRecord.js";
+import {LayoutInterface} from "../layouts/layoutInterface.js";
 
 export class Portal<T extends RecordFieldsMap> implements PortalBase<T> {
-    readonly record: LayoutRecord<any, any>;
+    readonly record: LayoutRecord<LayoutInterface>;
     readonly name: string;
     public records: PortalRecord<T>[];
 
-    constructor(record: LayoutRecord<any, any>, name: string) {
+    constructor(record: LayoutRecord<LayoutInterface, any>, name: string) {
         this.record = record
         this.name = name
     }
 
     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/portalBase.d.ts

@@ -1,8 +1,9 @@
-import { RecordFieldsMap } from "../layouts/recordFieldsMap";
-import { RecordBase } from "./recordBase";
-import { LayoutRecord } from "./layoutRecord";
+import { RecordFieldsMap } from "../layouts/recordFieldsMap.js";
+import { RecordBase } from "./recordBase.js";
+import { LayoutRecord } from "./layoutRecord.js";
+import { LayoutInterface } from "../layouts/layoutInterface.js";
 export interface PortalBase<T extends RecordFieldsMap> {
-    readonly record: LayoutRecord<any, any>;
+    readonly record: LayoutRecord<LayoutInterface>;
     readonly name: string;
     records: RecordBase<T>[];
 }

package/src/records/portalBase.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/records/portalBase.ts

@@ -1,14 +1,14 @@
 /*
- * Copyright (c) 2023. See LICENSE file for more information
+ * Copyright (c) 2023-2024. See LICENSE file for more information
  */
 
-import {RecordFieldsMap} from "../layouts/recordFieldsMap";
-import {LayoutRecordBase} from "./layoutRecordBase";
-import {RecordBase} from "./recordBase";
-import {LayoutRecord} from "./layoutRecord";
+import {RecordFieldsMap} from "../layouts/recordFieldsMap.js";
+import {RecordBase} from "./recordBase.js";
+import {LayoutRecord} from "./layoutRecord.js";
+import {LayoutInterface} from "../layouts/layoutInterface.js";
 
 export interface PortalBase<T extends RecordFieldsMap> {
-    readonly record: LayoutRecord<any, any>
+    readonly record: LayoutRecord<LayoutInterface>
     readonly name: string
     records: RecordBase<T>[]
 }

package/src/records/portalRecord.d.ts

@@ -1,13 +1,17 @@
-import { RecordBase, RecordTypes } from "./recordBase.js";
-import { extraBodyOptions } from "../types.js";
-import { RecordFieldsMap } from "../layouts/recordFieldsMap";
-import { PortalBase } from "./portalBase";
+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<any, any>>;
-    toObject(fieldFilter: any): any;
-    getField(field: any): import("./field.js").Field<import("./field.js").FieldValue>;
+    commit(extraBody?: extraBodyOptions): Promise<import("./layoutRecord.js").LayoutRecord<import("../index.js").LayoutInterface, string>>;
+    toObject(fieldFilter: (a: FieldBase<FieldValue>) => boolean): {
+        [key: string]: string;
+        modId: string;
+        recordId: string;
+    };
 }

package/src/records/portalRecord.js

@@ -1,7 +1,8 @@
 /*
- * Copyright (c) 2023. See LICENSE file for more information
+ * Copyright (c) 2023-2024. See LICENSE file for more information
  */
-import { RecordBase, RecordTypes } from "./recordBase.js";
+import { RecordBase } from "./recordBase.js";
+import { RecordTypes } from "../types.js";
 export class PortalRecord extends RecordBase {
     portal;
     type = RecordTypes.PORTAL;
@@ -20,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

@@ -1,18 +1,19 @@
 /*
- * Copyright (c) 2023. See LICENSE file for more information
+ * Copyright (c) 2023-2024. See LICENSE file for more information
  */
 
-import {RecordBase, RecordTypes} from "./recordBase.js";
-import {extraBodyOptions, recordObject} from "../types.js";
+import {RecordBase} from "./recordBase.js";
+import {extraBodyOptions, RecordTypes} from "../types.js";
 
-import {RecordFieldsMap} from "../layouts/recordFieldsMap";
-import {PortalBase} from "./portalBase";
+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,26 +1,22 @@
-/// <reference types="node" />
+/// <reference types="node" resolution-mode="require"/>
 import { EventEmitter } from "events";
-import { Field } from "./field.js";
-import { Layout } from "../layouts/layout.js";
-import { recordObject } from "../types.js";
-import { RecordFieldsMap } from "../layouts/recordFieldsMap";
-export declare enum RecordTypes {
-    UNKNOWN = 0,
-    LAYOUT = 1,
-    PORTAL = 2
-}
+import { FieldBase, FieldValue } from "./fieldBase.js";
+import { RecordTypes } from "../types.js";
+import { RecordFieldsMap } from "../layouts/recordFieldsMap.js";
+import { LayoutBase } from "../layouts/layoutBase.js";
+import { ApiFieldData, ApiRowDataDef } from "../models/apiResults.js";
 export declare class RecordBase<T extends RecordFieldsMap> extends EventEmitter {
-    readonly layout: Layout<any>;
+    readonly layout: LayoutBase;
     readonly type: RecordTypes;
     recordId: number;
     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(): Field<import("./field.js").FieldValue>[];
-    protected processFieldData(fieldData: any): T;
+    get fieldsArray(): FieldBase<FieldValue>[];
+    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

@@ -1,15 +1,10 @@
 /*
- * Copyright (c) 2023. See LICENSE file for more information
+ * Copyright (c) 2023-2024. See LICENSE file for more information
  */
 import { EventEmitter } from "events";
 import * as moment from "moment";
-import { Field } from "./field.js";
-export var RecordTypes;
-(function (RecordTypes) {
-    RecordTypes[RecordTypes["UNKNOWN"] = 0] = "UNKNOWN";
-    RecordTypes[RecordTypes["LAYOUT"] = 1] = "LAYOUT";
-    RecordTypes[RecordTypes["PORTAL"] = 2] = "PORTAL";
-})(RecordTypes || (RecordTypes = {}));
+import { FieldBase } from "./fieldBase.js";
+import { RecordTypes } from "../types.js";
 export class RecordBase extends EventEmitter {
     layout;
     type = RecordTypes.UNKNOWN;
@@ -35,7 +30,7 @@ export class RecordBase extends EventEmitter {
     processFieldData(fieldData) {
         let fields = {};
         for (let key of Object.keys(fieldData)) {
-            let _field = new Field(this, key, fieldData[key]);
+            let _field = new FieldBase(this, key, fieldData[key]);
             if (!!fieldData[key]) {
                 if (_field.metadata.result === "timeStamp") {
                     // @ts-ignore
@@ -72,9 +67,10 @@ 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 = {};
-        for (let field of this.fieldsArray.filter(field => filter(field))) {
+        let field;
+        for (field of this.fieldsArray.filter(field => filter(field))) {
             let value = field.value;
             if (value instanceof Date) {
                 // @ts-ignore
@@ -95,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

@@ -1,29 +1,24 @@
 /*
- * Copyright (c) 2023. See LICENSE file for more information
+ * Copyright (c) 2023-2024. See LICENSE file for more information
  */
 
 import {EventEmitter} from "events";
 import * as moment from "moment";
-import {Field} from "./field.js";
-import {Layout} from "../layouts/layout.js";
-import {recordObject} from "../types.js";
-import {RecordFieldsMap} from "../layouts/recordFieldsMap";
-
-export enum RecordTypes {
-    UNKNOWN,
-    LAYOUT,
-    PORTAL
-}
+import {FieldBase, FieldValue} from "./fieldBase.js";
+import {RecordTypes} from "../types.js";
+import {RecordFieldsMap} from "../layouts/recordFieldsMap.js";
+import {LayoutBase} from "../layouts/layoutBase.js";
+import {ApiFieldData, ApiRowDataDef} from "../models/apiResults.js";
 
 export class RecordBase<T extends RecordFieldsMap> extends EventEmitter {
-    readonly layout: Layout<any>;
+    readonly layout: LayoutBase;
     readonly type: RecordTypes = RecordTypes.UNKNOWN;
     public recordId: number;
     modId: number;
     fields: T;
     protected portalData: any[];
 
-    constructor(layout, recordId, modId = recordId) {
+    constructor(layout: LayoutBase, recordId: number, modId = recordId) {
         super();
         this.layout = layout
         this.recordId = recordId
@@ -38,15 +33,15 @@ export class RecordBase<T extends RecordFieldsMap> extends EventEmitter {
         return !!this.fieldsArray.find(i => i.edited)
     }
 
-    get fieldsArray() {
+    get fieldsArray(): FieldBase<FieldValue>[] {
         return Object.values(this.fields)
     }
 
-    protected processFieldData(fieldData) {
+    protected processFieldData(fieldData: ApiFieldData) {
         let fields: RecordFieldsMap = {}
 
         for (let key of Object.keys(fieldData)) {
-            let _field = new Field(this, key, fieldData[key])
+            let _field = new FieldBase(this, key, fieldData[key])
             if (!!fieldData[key]) {
                 if (_field.metadata.result === "timeStamp") {
                     // @ts-ignore
@@ -85,13 +80,10 @@ 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 = {}
-        for (let field of this.fieldsArray.filter(field => filter(field))) {
+    toObject(filter = (a: FieldBase<FieldValue>) => a.edited): Partial<Omit<ApiRowDataDef, "portalDataInfo">> {
+        let fields_processed: ApiFieldData = {}
+        let field: FieldBase<FieldValue>
+        for (field of this.fieldsArray.filter(field => filter(field))) {
             let value = field.value
             if (value instanceof Date) {
                 // @ts-ignore
@@ -114,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

package/src/types.d.ts

@@ -1,13 +1,7 @@
-/// <reference types="node" />
-/// <reference types="node" />
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
 import * as http from "http";
 import { FMError } from "./FMError.js";
-import { LayoutInterface } from "./layouts/layoutInterface";
-export interface DatabaseStructure {
-    layouts: {
-        [key: string]: LayoutInterface;
-    };
-}
 export interface databaseOptionsBase {
     database: string;
     credentials: loginOptionsOAuth | loginOptionsFileMaker | loginOptionsClaris | loginOptionsToken;
@@ -39,17 +33,18 @@ export interface loginOptionsClaris {
         fmid: string;
     };
 }
-export interface limitPortalsInterface {
-    portalName: string;
+export interface portalFetchData<T = string> {
+    portalName: T;
     offset: number;
     limit: number;
 }
+export type ScriptRequestData = {
+    prerequest?: Script;
+    presort?: Script;
+    after?: Script;
+};
 export interface extraBodyOptions {
-    scripts?: {
-        prerequest?: Script;
-        presort?: Script;
-        after?: Script;
-    };
+    scripts?: ScriptRequestData;
 }
 export declare enum DOWNLOAD_MODES {
     Stream = 0,
@@ -118,3 +113,11 @@ export interface AuthorizationHeadersOAuth {
     "X-FM-Data-OAuth-RequestId": string;
     "X-FM-Data-OAuth-Identifier": string;
 }
+export type RecordFetchOptions = {
+    readonly portals: readonly string[];
+};
+export declare enum RecordTypes {
+    UNKNOWN = 0,
+    LAYOUT = 1,
+    PORTAL = 2
+}

package/src/types.js

@@ -1,8 +1,14 @@
 /*
- * Copyright (c) 2022-2023. See LICENSE file for more information
+ * Copyright (c) 2022-2024. See LICENSE file for more information
  */
 export var DOWNLOAD_MODES;
 (function (DOWNLOAD_MODES) {
     DOWNLOAD_MODES[DOWNLOAD_MODES["Stream"] = 0] = "Stream";
     DOWNLOAD_MODES[DOWNLOAD_MODES["Buffer"] = 1] = "Buffer";
 })(DOWNLOAD_MODES || (DOWNLOAD_MODES = {}));
+export var RecordTypes;
+(function (RecordTypes) {
+    RecordTypes[RecordTypes["UNKNOWN"] = 0] = "UNKNOWN";
+    RecordTypes[RecordTypes["LAYOUT"] = 1] = "LAYOUT";
+    RecordTypes[RecordTypes["PORTAL"] = 2] = "PORTAL";
+})(RecordTypes || (RecordTypes = {}));

package/src/types.ts

@@ -1,19 +1,11 @@
 /*
- * Copyright (c) 2022-2023. See LICENSE file for more information
+ * Copyright (c) 2022-2024. See LICENSE file for more information
  */
 
 // const fetch = (...args) => import('node-fetch').then(({default: fetch}) => fetch(...args));
 // @ts-ignore
 import * as http from "http";
 import {FMError} from "./FMError.js";
-import {LayoutInterface} from "./layouts/layoutInterface";
-
-// import * as btoa from "btoa";
-export interface DatabaseStructure {
-    layouts: {
-        [key: string]: LayoutInterface
-    }
-}
 
 export interface databaseOptionsBase {
     database: string
@@ -52,18 +44,20 @@ export interface loginOptionsClaris {
     }
 }
 
-export interface limitPortalsInterface {
-    portalName: string,
+export interface portalFetchData<T = string> {
+    portalName: T,
     offset: number,
     limit: number
 }
 
+export type ScriptRequestData = {
+    prerequest?: Script,
+    presort?: Script,
+    after?: Script,
+}
+
 export interface extraBodyOptions {
-    scripts?: {
-        prerequest?: Script,
-        presort?: Script,
-        after?: Script,
-    }
+    scripts?: ScriptRequestData
 }
 
 export enum DOWNLOAD_MODES {
@@ -147,4 +141,14 @@ export interface AuthorizationHeadersOAuth {
     "Content-Type": "application/json"
     "X-FM-Data-OAuth-RequestId": string,
     "X-FM-Data-OAuth-Identifier": string
+}
+
+export type RecordFetchOptions = {
+    readonly portals: readonly string[]
+}
+
+export enum RecordTypes {
+    UNKNOWN,
+    LAYOUT,
+    PORTAL
 }

package/src/records/getOperations/find.d.ts

@@ -1,15 +0,0 @@
-import { RecordGetOperation } from "./recordGetOperation.js";
-import { LayoutRecord } from "../layoutRecord.js";
-import { LayoutInterface } from "../../layouts/layoutInterface";
-import { LayoutBase } from "../../layouts/layoutBase.js";
-export declare class Find<T extends LayoutInterface> extends RecordGetOperation<T> {
-    protected queries: object[];
-    constructor(layout: LayoutBase, start?: number, limit?: number);
-    private toObject;
-    addRequests(...requests: any[]): this;
-    /**
-     * @deprecated in favour of .fetch()
-     */
-    run(): Promise<LayoutRecord<T["fields"], T["portals"]>[]>;
-    fetch(): Promise<LayoutRecord<T["fields"], T["portals"]>[]>;
-}

package/src/records/getOperations/find.js

@@ -1,70 +0,0 @@
-/*
- * Copyright (c) 2023. See LICENSE file for more information
- */
-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);
-        this.setLimit(limit);
-        this.queries = [];
-    }
-    toObject() {
-        let out = { query: this.queries, sort: undefined };
-        if (this.sort.length !== 0)
-            out.sort = this.sort;
-        for (let item of Object.keys(this.scripts)) {
-            if (this.scripts[item]) {
-                out[item] = this.scripts[item].name;
-                if (this.scripts[item].parameter)
-                    out[item + ".param"] = this.scripts[item].parameter;
-            }
-        }
-        if (this.limit !== 100)
-            out["limit"] = this.limit;
-        if (this.offset !== 0)
-            out["offset"] = this.offset;
-        if (this.limitPortals.length > 0) {
-            out["portal"] = this.limitPortals.map(p => p.portalName);
-            for (let item of this.limitPortals) {
-                out["offset." + item.portalName.replace(/[^0-9A-z]/g, "")] = item.offset;
-                out["limit." + item.portalName.replace(/[^0-9A-z]/g, "")] = item.limit;
-            }
-        }
-        return out;
-    }
-    addRequests(...requests) {
-        for (let item of requests)
-            this.queries.push(item);
-        return this;
-    }
-    /**
-     * @deprecated in favour of .fetch()
-     */
-    run() {
-        return this.fetch();
-    }
-    async fetch() {
-        let trace = new Error();
-        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);
-        }
-    }
-}