@jd-data-limited/easy-fm 4.0.16 → 4.1.0

package/src/records/portal.d.ts

@@ -1,11 +1,25 @@
-import { PortalRecord } from "./portalRecord.js";
-import { RecordFieldsMap } from "../layouts/recordFieldsMap.js";
-import { PortalBase } from "./portalBase.js";
-import { LayoutRecord } from "./layoutRecord.js";
+import { PortalRecord } from './portalRecord.js';
+import { type RecordFieldsMap } from '../layouts/recordFieldsMap.js';
+import { type PortalBase } from './portalBase.js';
+import { type LayoutRecord } from './layoutRecord.js';
+/**
+ * Represents a portal.
+ *
+ * @template T - The type of RecordFieldsMap.
+ * @class
+ * @implements {PortalBase<T>}
+ */
 export declare class Portal<T extends RecordFieldsMap> implements PortalBase<T> {
     readonly record: LayoutRecord<any>;
     readonly name: string;
-    records: PortalRecord<T>[];
+    records: Array<PortalRecord<T>>;
     constructor(record: LayoutRecord<any>, name: string);
+    /**
+     * Add a new record to the portal
+     * @function create
+     * @async
+     * @summary Creates a new record.
+     * @returns {Promise<PortalRecord<T>>} A Promise that resolves to the newly created record.
+     */
     create(): Promise<PortalRecord<T>>;
 }

package/src/records/portal.js

@@ -1,7 +1,14 @@
 /*
  * Copyright (c) 2023-2024. See LICENSE file for more information
  */
-import { PortalRecord } from "./portalRecord.js";
+import { PortalRecord } from './portalRecord.js';
+/**
+ * Represents a portal.
+ *
+ * @template T - The type of RecordFieldsMap.
+ * @class
+ * @implements {PortalBase<T>}
+ */
 export class Portal {
     record;
     name;
@@ -10,12 +17,19 @@ export class Portal {
         this.record = record;
         this.name = name;
     }
+    /**
+     * Add a new record to the portal
+     * @function create
+     * @async
+     * @summary Creates a new record.
+     * @returns {Promise<PortalRecord<T>>} A Promise that resolves to the newly created record.
+     */
     async create() {
-        let fields = {};
-        for (let _field of (await this.record.layout.getLayoutMeta()).portalMetaData[this.name]) {
-            fields[_field.name] = "";
+        const fields = {};
+        for (const _field of (await this.record.layout.getLayoutMeta()).portalMetaData[this.name]) {
+            fields[_field.name] = '';
         }
-        let record = new PortalRecord(this.record, this, -1, -1, fields);
+        const record = new PortalRecord(this.record, this, -1, -1, fields);
         this.records.push(record);
         return record;
     }

package/src/records/portal.ts

@@ -2,30 +2,42 @@
  * Copyright (c) 2023-2024. See LICENSE file for more information
  */
 
-import {PortalRecord} from "./portalRecord.js";
-import {RecordFieldsMap} from "../layouts/recordFieldsMap.js";
-import {PortalBase} from "./portalBase.js";
-import {LayoutRecord} from "./layoutRecord.js";
+import {PortalRecord} from './portalRecord.js'
+import {type RecordFieldsMap} from '../layouts/recordFieldsMap.js'
+import {type PortalBase} from './portalBase.js'
+import {type LayoutRecord} from './layoutRecord.js'
 
+/**
+ * Represents a portal.
+ *
+ * @template T - The type of RecordFieldsMap.
+ * @class
+ * @implements {PortalBase<T>}
+ */
 export class Portal<T extends RecordFieldsMap> implements PortalBase<T> {
-    readonly record: LayoutRecord<any>;
-    readonly name: string;
-    public records: PortalRecord<T>[] = [];
+    readonly record: LayoutRecord<any>
+    readonly name: string
+    public records: Array<PortalRecord<T>> = []
 
-    constructor(record: LayoutRecord<any>, name: string) {
+    constructor (record: LayoutRecord<any>, name: string) {
         this.record = record
         this.name = name
     }
 
-    async create() {
-        let fields: {
-            [key: string]: string
-        } = {}
-        for (let _field of (await this.record.layout.getLayoutMeta()).portalMetaData[this.name]) {
-            fields[_field.name] = ""
+    /**
+     * Add a new record to the portal
+     * @function create
+     * @async
+     * @summary Creates a new record.
+     * @returns {Promise<PortalRecord<T>>} A Promise that resolves to the newly created record.
+     */
+    async create () {
+        const fields: Record<string, string> = {}
+        for (const _field of (await this.record.layout.getLayoutMeta()).portalMetaData[this.name]) {
+            fields[_field.name] = ''
         }
-        let record = new PortalRecord<T>(this.record, this, -1, -1, fields)
+        const record = new PortalRecord<T>(this.record, this, -1, -1, fields)
         this.records.push(record)
         return record
     }
-}
+}

package/src/records/portalBase.d.ts

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

package/src/records/portalBase.ts

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

package/src/records/portalRecord.d.ts

@@ -1,18 +1,26 @@
-import { RecordBase } from "./recordBase.js";
-import { extraBodyOptions, RecordTypes } from "../types.js";
-import { RecordFieldsMap } from "../layouts/recordFieldsMap.js";
-import { PortalBase } from "./portalBase.js";
-import { Field, FieldValue } from "./field.js";
+import { RecordBase } from './recordBase.js';
+import { type extraBodyOptions, RecordTypes } from '../types.js';
+import { type RecordFieldsMap } from '../layouts/recordFieldsMap.js';
+import { type PortalBase } from './portalBase.js';
+import { type Field, type FieldValue } from './field.js';
+/**
+ * Represents a PortalRecord, which is a record in a portal within a parent record.
+ * @template T - The type of the record's field map.
+ */
 export declare class PortalRecord<T extends RecordFieldsMap> extends RecordBase<T> {
     readonly portal: PortalBase<T>;
     readonly type = RecordTypes.PORTAL;
     constructor(record: RecordBase<any>, portal: PortalBase<any>, recordId: number, modId?: number, fieldData?: {});
     _onSave(): void;
+    /**
+     * Commits the parent record, and in turn this one.
+     *
+     * @param {extraBodyOptions} [extraBody={}] - The optional extra body options.
+     * @returns {Promise} - A promise that resolves when the record is committed.
+     */
     commit(extraBody?: extraBodyOptions): Promise<import("./layoutRecord.js").LayoutRecord<import("../index.js").LayoutInterface>>;
     toObject(fieldFilter: (a: Field<FieldValue>) => boolean): {
         modId?: string;
         recordId?: string;
-    } & {
-        [key: string]: string;
-    };
+    } & Record<string, string>;
 }

package/src/records/portalRecord.js

@@ -1,8 +1,12 @@
 /*
  * Copyright (c) 2023-2024. See LICENSE file for more information
  */
-import { RecordBase } from "./recordBase.js";
-import { RecordTypes } from "../types.js";
+import { RecordBase } from './recordBase.js';
+import { RecordTypes } from '../types.js';
+/**
+ * Represents a PortalRecord, which is a record in a portal within a parent record.
+ * @template T - The type of the record's field map.
+ */
 export class PortalRecord extends RecordBase {
     portal;
     type = RecordTypes.PORTAL;
@@ -14,15 +18,21 @@ export class PortalRecord extends RecordBase {
         super._onSave();
         this.portal.record._onSave();
     }
-    commit(extraBody = {}) {
-        return this.portal.record.commit(extraBody);
+    /**
+     * Commits the parent record, and in turn this one.
+     *
+     * @param {extraBodyOptions} [extraBody={}] - The optional extra body options.
+     * @returns {Promise} - A promise that resolves when the record is committed.
+     */
+    async commit(extraBody = {}) {
+        return await this.portal.record.commit(extraBody);
     }
     toObject(fieldFilter) {
-        let res = {
+        const res = {
             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)))
+        for (const field of this.fieldsArray.filter(a => fieldFilter(a)))
             res[field.id] = field.value?.toString();
         // console.log(res)
         return res;

package/src/records/portalRecord.ts

@@ -2,41 +2,51 @@
  * Copyright (c) 2023-2024. See LICENSE file for more information
  */
 
-import {RecordBase} from "./recordBase.js";
-import {extraBodyOptions, RecordTypes} from "../types.js";
+import {RecordBase} from './recordBase.js'
+import {type extraBodyOptions, RecordTypes} from '../types.js'
 
-import {RecordFieldsMap} from "../layouts/recordFieldsMap.js";
-import {PortalBase} from "./portalBase.js";
-import {Field, FieldValue} from "./field.js";
+import {type RecordFieldsMap} from '../layouts/recordFieldsMap.js'
+import {type PortalBase} from './portalBase.js'
+import {type Field, type FieldValue} from './field.js'
 
+/**
+ * Represents a PortalRecord, which is a record in a portal within a parent record.
+ * @template T - The type of the record's field map.
+ */
 export class PortalRecord<T extends RecordFieldsMap> extends RecordBase<T> {
-    readonly portal: PortalBase<T>;
+    readonly portal: PortalBase<T>
     readonly type = RecordTypes.PORTAL
 
-    constructor(record: RecordBase<any>, portal: PortalBase<any>, recordId: number, modId = recordId, fieldData = {}) {
-        super(record.layout, recordId, modId, fieldData);
+    constructor (record: RecordBase<any>, portal: PortalBase<any>, recordId: number, modId = recordId, fieldData = {}) {
+        super(record.layout, recordId, modId, fieldData)
         this.portal = portal
     }
 
-    _onSave() {
-        super._onSave();
+    _onSave () {
+        super._onSave()
         this.portal.record._onSave()
     }
 
-    commit(extraBody: extraBodyOptions = {}) {
-        return this.portal.record.commit(extraBody)
+    /**
+     * Commits the parent record, and in turn this one.
+     *
+     * @param {extraBodyOptions} [extraBody={}] - The optional extra body options.
+     * @returns {Promise} - A promise that resolves when the record is committed.
+     */
+    async commit (extraBody: extraBodyOptions = {}) {
+        return await this.portal.record.commit(extraBody)
     }
 
-    toObject(fieldFilter: (a: Field<FieldValue>) => boolean): {
-        modId?: string,
-        recordId?: string,
-    } & {[key: string]: string} {
-        let res: any = {
+    toObject (fieldFilter: (a: Field<FieldValue>) => boolean): {
+        modId?: string
+        recordId?: string
+    } & Record<string, string> {
+        const res: any = {
             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()
+        for (const field of this.fieldsArray.filter(a => fieldFilter(a))) res[field.id] = field.value?.toString()
         // console.log(res)
         return res
     }
-}
+}

package/src/records/recordBase.d.ts

@@ -1,21 +1,31 @@
 /// <reference types="node" resolution-mode="require"/>
-import { EventEmitter } from "events";
-import { RecordTypes } from "../types.js";
-import { RecordFieldsMap } from "../layouts/recordFieldsMap.js";
-import { LayoutBase } from "../layouts/layoutBase.js";
-import { ApiFieldData } from "../models/apiResults.js";
-import { Field, FieldValue } from "./field.js";
+import { EventEmitter } from 'events';
+import { RecordTypes } from '../types.js';
+import { type RecordFieldsMap } from '../layouts/recordFieldsMap.js';
+import { type LayoutBase } from '../layouts/layoutBase.js';
+import { type ApiFieldData } from '../models/apiResults.js';
+import { Field, type FieldValue } from './field.js';
 export declare abstract class RecordBase<T extends RecordFieldsMap> extends EventEmitter {
     readonly layout: LayoutBase;
     readonly type: RecordTypes;
     recordId: number;
     modId: number;
+    /**
+     * An object containing each field in this record.
+     *
+     * @template T - The type of the field.
+     */
     fields: T;
     protected portalData: any[];
     protected constructor(layout: LayoutBase, recordId: number, modId: number | undefined, fieldData: ApiFieldData);
     get endpoint(): string;
+    /**
+     * A boolean indicating whether this record has been modified and should be committed
+     *
+     * @returns {boolean} A boolean value indicating whether any of the fields have been edited.
+     */
     get edited(): boolean;
-    get fieldsArray(): Field<FieldValue>[];
+    get fieldsArray(): Array<Field<FieldValue>>;
     protected processFieldData(fieldData: ApiFieldData): T;
     _onSave(): void;
 }

package/src/records/recordBase.js

@@ -1,15 +1,20 @@
 /*
  * Copyright (c) 2023-2024. See LICENSE file for more information
  */
-import { EventEmitter } from "events";
-import * as moment from "moment";
-import { RecordTypes } from "../types.js";
-import { Field } from "./field.js";
+import { EventEmitter } from 'events';
+import * as moment from 'moment';
+import { RecordTypes } from '../types.js';
+import { Field } from './field.js';
 export class RecordBase extends EventEmitter {
     layout;
     type = RecordTypes.UNKNOWN;
     recordId;
     modId;
+    /**
+     * An object containing each field in this record.
+     *
+     * @template T - The type of the field.
+     */
     fields;
     portalData = [];
     constructor(layout, recordId, modId = recordId, fieldData) {
@@ -22,6 +27,11 @@ export class RecordBase extends EventEmitter {
     get endpoint() {
         return `${this.layout.endpoint}/records/${this.recordId}`;
     }
+    /**
+     * A boolean indicating whether this record has been modified and should be committed
+     *
+     * @returns {boolean} A boolean value indicating whether any of the fields have been edited.
+     */
     get edited() {
         return !!this.fieldsArray.find(i => i.edited);
     }
@@ -29,12 +39,11 @@ export class RecordBase extends EventEmitter {
         return Object.values(this.fields);
     }
     processFieldData(fieldData) {
-        let fields = {};
-        for (let key of Object.keys(fieldData)) {
-            let _field = new Field(this, key, fieldData[key]);
-            if (!!fieldData[key]) {
-                if (_field.metadata.result === "timeStamp") {
-                    // @ts-ignore
+        const fields = {};
+        for (const key of Object.keys(fieldData)) {
+            const _field = new Field(this, key, fieldData[key]);
+            if (fieldData[key]) {
+                if (_field.metadata.result === 'timeStamp') {
                     let date = moment.default(fieldData[key]);
                     date = date
                         .utcOffset(this.layout.database.host.timezoneOffsetFunc(date), true)
@@ -42,8 +51,7 @@ export class RecordBase extends EventEmitter {
                     _field.set(date);
                     _field.edited = false;
                 }
-                else if (_field.metadata.result === "time") {
-                    // @ts-ignore
+                else if (_field.metadata.result === 'time') {
                     let date = moment.default(fieldData[key]);
                     date = date
                         .utcOffset(this.layout.database.host.timezoneOffsetFunc(date), true)
@@ -51,8 +59,7 @@ export class RecordBase extends EventEmitter {
                     _field.set(date);
                     _field.edited = false;
                 }
-                else if (_field.metadata.result === "date") {
-                    // @ts-ignore
+                else if (_field.metadata.result === 'date') {
                     let date = moment.default(fieldData[key]);
                     date = date
                         .utcOffset(this.layout.database.host.timezoneOffsetFunc(date), true)
@@ -67,8 +74,8 @@ export class RecordBase extends EventEmitter {
         return fields;
     }
     _onSave() {
-        this.emit("saved");
-        for (let field of this.fieldsArray)
+        this.emit('saved');
+        for (const field of this.fieldsArray)
             field.edited = false;
     }
 }

package/src/records/recordBase.ts

@@ -2,70 +2,74 @@
  * Copyright (c) 2023-2024. See LICENSE file for more information
  */
 
-import {EventEmitter} from "events";
-import * as moment from "moment";
-import {Moment} from "moment";
-import {RecordTypes} from "../types.js";
-import {RecordFieldsMap} from "../layouts/recordFieldsMap.js";
-import {LayoutBase} from "../layouts/layoutBase.js";
-import {ApiFieldData} from "../models/apiResults.js";
-import {Field, FieldValue} from "./field.js";
+import {EventEmitter} from 'events'
+import * as moment from 'moment'
+import {type Moment} from 'moment'
+import {RecordTypes} from '../types.js'
+import {type RecordFieldsMap} from '../layouts/recordFieldsMap.js'
+import {type LayoutBase} from '../layouts/layoutBase.js'
+import {type ApiFieldData} from '../models/apiResults.js'
+import {Field, type FieldValue} from './field.js'
 
 export abstract class RecordBase<T extends RecordFieldsMap> extends EventEmitter {
-    readonly layout: LayoutBase;
-    readonly type: RecordTypes = RecordTypes.UNKNOWN;
-    public recordId: number;
-    modId: number;
-    fields: T;
-    protected portalData: any[] = [];
+    readonly layout: LayoutBase
+    readonly type: RecordTypes = RecordTypes.UNKNOWN
+    public recordId: number
+    modId: number
+    /**
+     * An object containing each field in this record.
+     *
+     * @template T - The type of the field.
+     */
+    fields: T
+    protected portalData: any[] = []
 
-    protected constructor(layout: LayoutBase, recordId: number, modId = recordId, fieldData: ApiFieldData) {
-        super();
+    protected constructor (layout: LayoutBase, recordId: number, modId = recordId, fieldData: ApiFieldData) {
+        super()
         this.layout = layout
         this.recordId = recordId
         this.modId = modId
         this.fields = this.processFieldData(fieldData)
     }
 
-    get endpoint(): string {
+    get endpoint (): string {
         return `${this.layout.endpoint}/records/${this.recordId}`
     }
 
-    get edited(): boolean {
+    /**
+     * A boolean indicating whether this record has been modified and should be committed
+     *
+     * @returns {boolean} A boolean value indicating whether any of the fields have been edited.
+     */
+    get edited (): boolean {
         return !!this.fieldsArray.find(i => i.edited)
     }
 
-    get fieldsArray(): Field<FieldValue>[] {
+    get fieldsArray (): Array<Field<FieldValue>> {
         return Object.values(this.fields)
     }
 
-    protected processFieldData(fieldData: ApiFieldData) {
-        let fields: RecordFieldsMap = {}
+    protected processFieldData (fieldData: ApiFieldData) {
+        const fields: RecordFieldsMap = {}
 
-        for (let key of Object.keys(fieldData)) {
-            let _field = new Field<number | string | Moment>(this, key, fieldData[key])
-            if (!!fieldData[key]) {
-                if (_field.metadata.result === "timeStamp") {
-                    // @ts-ignore
+        for (const key of Object.keys(fieldData)) {
+            const _field = new Field<number | string | Moment>(this, key, fieldData[key])
+            if (fieldData[key]) {
+                if (_field.metadata.result === 'timeStamp') {
                     let date = moment.default(fieldData[key])
                     date = date
                         .utcOffset(this.layout.database.host.timezoneOffsetFunc(date), true)
                         .local()
                     _field.set(date)
                     _field.edited = false
-
-                }
-                else if (_field.metadata.result === "time") {
-                    // @ts-ignore
+                } else if (_field.metadata.result === 'time') {
                     let date = moment.default(fieldData[key])
                     date = date
                         .utcOffset(this.layout.database.host.timezoneOffsetFunc(date), true)
                         .local()
                     _field.set(date)
                     _field.edited = false
-                }
-                else if (_field.metadata.result === "date") {
-                    // @ts-ignore
+                } else if (_field.metadata.result === 'date') {
                     let date = moment.default(fieldData[key])
                     date = date
                         .utcOffset(this.layout.database.host.timezoneOffsetFunc(date), true)
@@ -80,8 +84,8 @@ export abstract class RecordBase<T extends RecordFieldsMap> extends EventEmitter
         return fields as T
     }
 
-    _onSave() {
-        this.emit("saved")
-        for (let field of this.fieldsArray) field.edited = false
+    _onSave () {
+        this.emit('saved')
+        for (const field of this.fieldsArray) field.edited = false
     }
-}
+}