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

package/src/layouts/layoutRecordManager.js

@@ -1,30 +1,53 @@
 /*
  * Copyright (c) 2023-2024. See LICENSE file for more information
  */
-import { LayoutRecord } from "../records/layoutRecord.js";
-import { RecordGetOperation } from "../records/getOperations/recordGetOperation.js";
+import { LayoutRecord } from '../records/layoutRecord.js';
+import { RecordGetOperation } from '../records/getOperations/recordGetOperation.js';
+/**
+ * Manager class for handling layout records.
+ */
 export class LayoutRecordManager {
     layout;
     constructor(layout) {
         this.layout = layout;
     }
+    /**
+     * Creates a new layout record with the provided options.
+     *
+     * @param {OPTIONS} options - The options for creating the layout record.
+     * @return {Promise<LayoutRecord<PickPortals<T, OPTIONS['portals'][number]>>>}
+     * The newly created layout record.
+     */
     async create(options) {
-        let metadata = await this.layout.getLayoutMeta();
-        let fields = {};
-        for (let _field of metadata.fieldMetaData) {
-            fields[_field.name] = "";
+        const metadata = await this.layout.getLayoutMeta();
+        const fields = {};
+        for (const _field of metadata.fieldMetaData) {
+            fields[_field.name] = '';
         }
-        let portals = {};
-        for (let _portal of Object.keys(metadata.portalMetaData))
+        const portals = {};
+        for (const _portal of Object.keys(metadata.portalMetaData))
             portals[_portal] = [];
         return new LayoutRecord(this.layout, -1, 0, fields, portals);
     }
+    /**
+     * Retrieves a layout record based on the given recordId.
+     *
+     * @param {number} recordId - The identifier of the record to retrieve.
+     *
+     * @returns {Promise<LayoutRecord<PickPortals<T, never>>>} - A Promise that resolves with the retrieved layout record.
+     */
     async get(recordId) {
         await this.layout.getLayoutMeta();
-        let record = new LayoutRecord(this.layout, recordId);
+        const record = new LayoutRecord(this.layout, recordId);
         await record.get();
         return record;
     }
+    /**
+     * Creates a new instance of RecordGetOperation with the given options.
+     *
+     * @param {Array} options - An array of options for the operation.
+     * @return {RecordGetOperation} - A new instance of RecordGetOperation.
+     */
     list(options) {
         return new RecordGetOperation(this.layout, options);
     }

package/src/layouts/layoutRecordManager.ts

@@ -2,42 +2,65 @@
  * Copyright (c) 2023-2024. See LICENSE file for more information
  */
 
-import {LayoutRecord} from "../records/layoutRecord.js";
-import {LayoutInterface} from "./layoutInterface.js";
-import {LayoutBase} from "./layoutBase.js"
-import {GetOperationOptions, RecordGetOperation} from "../records/getOperations/recordGetOperation.js";
-import {PickPortals, RecordFetchOptions} from "../types.js";
-import {ApiFieldData} from "../models/apiResults.js";
+import {LayoutRecord} from '../records/layoutRecord.js'
+import {type LayoutInterface} from './layoutInterface.js'
+import {type LayoutBase} from './layoutBase.js'
+import {type GetOperationOptions, RecordGetOperation} from '../records/getOperations/recordGetOperation.js'
+import {type PickPortals, type RecordFetchOptions} from '../types.js'
+import {type ApiFieldData} from '../models/apiResults.js'
 
+/**
+ * Manager class for handling layout records.
+ */
 export class LayoutRecordManager<T extends LayoutInterface> {
-    readonly layout: LayoutBase;
-    constructor(layout: LayoutBase) {
+    readonly layout: LayoutBase
+    constructor (layout: LayoutBase) {
         this.layout = layout
     }
 
+    /**
+     * Creates a new layout record with the provided options.
+     *
+     * @param {OPTIONS} options - The options for creating the layout record.
+     * @return {Promise<LayoutRecord<PickPortals<T, OPTIONS['portals'][number]>>>}
+     * The newly created layout record.
+     */
     async create<OPTIONS extends RecordFetchOptions>(options: OPTIONS): Promise<LayoutRecord<
-        PickPortals<T, OPTIONS["portals"][number]>
+    PickPortals<T, OPTIONS['portals'][number]>
     >> {
-        let metadata = await this.layout.getLayoutMeta()
-        let fields: ApiFieldData = {}
-        for (let _field of metadata.fieldMetaData) {
-            fields[_field.name] = ""
+        const metadata = await this.layout.getLayoutMeta()
+        const fields: ApiFieldData = {}
+        for (const _field of metadata.fieldMetaData) {
+            fields[_field.name] = ''
         }
-        let portals: {[key: string]: []} = {}
-        for (let _portal of Object.keys(metadata.portalMetaData)) portals[_portal] = []
+        const portals: Record<string, []> = {}
+        for (const _portal of Object.keys(metadata.portalMetaData)) portals[_portal] = []
         return new LayoutRecord(this.layout, -1, 0, fields, portals)
     }
 
-    async get(recordId: number): Promise<LayoutRecord<
-        PickPortals<T, never>
+    /**
+     * Retrieves a layout record based on the given recordId.
+     *
+     * @param {number} recordId - The identifier of the record to retrieve.
+     *
+     * @returns {Promise<LayoutRecord<PickPortals<T, never>>>} - A Promise that resolves with the retrieved layout record.
+     */
+    async get (recordId: number): Promise<LayoutRecord<
+    PickPortals<T, never>
     >> {
         await this.layout.getLayoutMeta()
-        let record = new LayoutRecord<PickPortals<T, never>>(this.layout, recordId)
+        const record = new LayoutRecord<PickPortals<T, never>>(this.layout, recordId)
         await record.get()
         return record
     }
 
+    /**
+     * Creates a new instance of RecordGetOperation with the given options.
+     *
+     * @param {Array} options - An array of options for the operation.
+     * @return {RecordGetOperation} - A new instance of RecordGetOperation.
+     */
     list<OPTIONS extends GetOperationOptions<T>>(options: OPTIONS) {
         return new RecordGetOperation<T, OPTIONS>(this.layout, options)
     }
-}
+}

package/src/layouts/recordFieldsMap.d.ts

@@ -1,4 +1,2 @@
-import { Field, FieldValue } from "../records/field.js";
-export interface RecordFieldsMap {
-    [fieldName: string]: Field<FieldValue>;
-}
+import { type Field, type FieldValue } from '../records/field.js';
+export type RecordFieldsMap = Record<string, Field<FieldValue>>;

package/src/layouts/recordFieldsMap.ts

@@ -2,8 +2,6 @@
  * Copyright (c) 2023-2024. See LICENSE file for more information
  */
 
-import {Field, FieldValue} from "../records/field.js";
+import {type Field, type FieldValue} from '../records/field.js'
 
-export interface RecordFieldsMap {
-    [fieldName: string]: Field<FieldValue>
-}
+export type RecordFieldsMap = Record<string, Field<FieldValue>>

package/src/models/apiResults.d.ts

@@ -38,9 +38,7 @@ export interface ApiLayout {
 }
 export interface ApiLayoutMetadata {
     fieldMetaData: ApiFieldMetadata[];
-    portalMetaData: {
-        [key: string]: ApiFieldMetadata[];
-    };
+    portalMetaData: Record<string, ApiFieldMetadata[]>;
     valueLists: ApiValueList[];
 }
 export interface ApiFieldMetadata {
@@ -62,10 +60,10 @@ export interface ApiFieldMetadata {
 export interface ApiValueList {
     name: string;
     type: string;
-    values: {
+    values: Array<{
         value: string;
         displayName: string;
-    }[];
+    }>;
 }
 export interface ApiScriptResult {
     scriptError: string;
@@ -75,12 +73,8 @@ export interface ApiRecordResponseObj {
     data: ApiRowDataDef[];
     dataInfo: ApiResultSetObj;
 }
-export type ApiFieldData = {
-    [key: string]: string | number;
-};
-export interface ApiPortalData {
-    [key: string]: ApiFieldData[];
-}
+export type ApiFieldData = Record<string, string | number>;
+export type ApiPortalData = Record<string, ApiFieldData[]>;
 export interface ApiResultSetObj {
     database: string;
     layout: string;
@@ -94,10 +88,10 @@ export interface ApiRowDataDef {
     portalData: ApiPortalData;
     modId: string;
     recordId: string;
-    portalDataInfo?: {
+    portalDataInfo?: Array<{
         database: string;
         table: string;
         foundCount: number;
         returnedCount: number;
-    }[];
+    }>;
 }

package/src/models/apiResults.ts

@@ -3,108 +3,108 @@
  */
 
 export enum ApiFieldTypes {
-    NORMAL = "normal",
-    CALCULATION = "calculation",
-    SUMMARY = "summary"
+    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"
+    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"
+    TEXT = 'text',
+    NUMBER = 'number',
+    DATE = 'date',
+    TIME = 'time',
+    TIMESTAMP = 'timeStamp',
+    CONTAINER = 'container'
 }
 
 export interface ApiMessage {
-    code: string,
+    code: string
     message: string
 }
 
 export interface ApiResults<T = unknown> {
-    response?: null | T & {scriptError? : string},
-    messages: ApiMessage[],
+    response?: null | T & { scriptError?: string }
+    messages: ApiMessage[]
     httpStatus: number
 }
 
 export interface ApiLayout {
-    name: string,
-    isFolder?: boolean,
+    name: string
+    isFolder?: boolean
     folderLayoutNames?: ApiLayout[]
 }
 
 export interface ApiLayoutMetadata {
-    fieldMetaData: ApiFieldMetadata[],
-    portalMetaData: {[key: string]: ApiFieldMetadata[]},
+    fieldMetaData: ApiFieldMetadata[]
+    portalMetaData: Record<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,
+    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}[]
+    name: string
+    type: string
+    values: Array<{ value: string, displayName: string }>
 }
 
 export interface ApiScriptResult {
-    scriptError: string,
+    scriptError: string
     scriptResult?: string
 }
 
 export interface ApiRecordResponseObj {
-    data: ApiRowDataDef[],
+    data: ApiRowDataDef[]
     dataInfo: ApiResultSetObj
 }
 
-export type ApiFieldData = {[key: string]: string | number}
+export type ApiFieldData = Record<string, string | number>
 
-export interface ApiPortalData {[key: string]: ApiFieldData[]}
+export type ApiPortalData = Record<string, ApiFieldData[]>
 
 export interface ApiResultSetObj {
-    database: string,
-    layout: string,
-    table: string,
-    totalRecordCount: number,
-    foundCount: number,
+    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,
+    fieldData: ApiFieldData
+    portalData: ApiPortalData
+    modId: string
+    recordId: string
+    portalDataInfo?: Array<{
+        database: string
+        table: string
+        foundCount: number
         returnedCount: number
-    }[]
-}
+    }>
+}

package/src/records/field.d.ts

@@ -1,31 +1,61 @@
 /// <reference types="node" resolution-mode="require"/>
 /// <reference types="node" resolution-mode="require"/>
-import * as http from "http";
-import { ContainerBufferResult, DownloadModes, RecordTypes } from "../types.js";
-import { ApiFieldMetadata } from "../models/apiResults.js";
-import { LayoutBase } from "../layouts/layoutBase.js";
-import { Moment } from "moment";
+import type * as http from 'http';
+import { type ContainerBufferResult, DownloadModes, RecordTypes } from '../types.js';
+import { type ApiFieldMetadata } from '../models/apiResults.js';
+import { type LayoutBase } from '../layouts/layoutBase.js';
+import { type Moment } from 'moment';
 export type FieldValue = string | number | Moment | Container;
 export type Container = null;
-export type Parentable = {
+export interface Parentable {
     layout: LayoutBase;
     type: RecordTypes;
     endpoint: string;
-};
+    portal?: {
+        name: string;
+    };
+}
+/**
+ * A class representing a field in a record.
+ *
+ * @template T - The type of the field value.
+ */
 export declare class Field<T extends FieldValue> {
     parent: Parentable;
     id: string;
-    protected _value: T;
+    protected _value: T | null;
     edited: boolean;
     constructor(record: Parentable, id: string, contents: T);
-    set(content: T): void;
+    /**
+     * Sets the value of the field.
+     *
+     * @param {T | null} content - The new content value to be set. Can be either the type T or null.
+     * @throws {Error} Cannot set container value using set(). Use upload() instead, if the result is a 'container'.
+     */
+    set(content: T | null): void;
     get metadata(): ApiFieldMetadata;
-    get value(): T;
+    get value(): T | null;
     set value(value: T);
     get string(): string;
-    get date(): Date;
-    get number(): number;
+    /**
+     * Uploads a file to the container field.
+     *
+     * @param {Buffer} buffer - The file content as a buffer.
+     * @param {string} filename - The filename of the file.
+     * @param {string} mime - The MIME type of the file.
+     *
+     * @throws {Error} - Cannot upload a file to the field if it's not a container field.
+     * @throws {Error} - Upload failed with HTTP error.
+     *
+     * @returns {Promise<void>} - A promise that resolves when the file is successfully uploaded.
+     */
     upload(buffer: Buffer, filename: string, mime: string): Promise<void>;
+    /**
+     * Downloads a resource from the server using the specified download mode.
+     *
+     * @param {DownloadModes} mode - The mode to use for downloading the resource.
+     * @return {Promise<http.IncomingMessage>} - A promise that resolves with the incoming message representing the downloaded resource.
+     */
     download(mode: DownloadModes.Stream): Promise<http.IncomingMessage>;
     download(mode: DownloadModes.Buffer): Promise<ContainerBufferResult>;
 }

package/src/records/field.js

@@ -1,8 +1,13 @@
 /*
  * Copyright (c) 2023-2024. See LICENSE file for more information
  */
-import { DownloadModes, RecordTypes } from "../types.js";
-import { ApiFieldDisplayTypes, ApiFieldResultTypes, ApiFieldTypes } from "../models/apiResults.js";
+import { DownloadModes, RecordTypes } from '../types.js';
+import { ApiFieldDisplayTypes, ApiFieldResultTypes, ApiFieldTypes } from '../models/apiResults.js';
+/**
+ * A class representing a field in a record.
+ *
+ * @template T - The type of the field value.
+ */
 export class Field {
     parent;
     id;
@@ -14,13 +19,15 @@ export class Field {
         this._value = contents;
         this.edited = false;
     }
+    /**
+     * Sets the value of the field.
+     *
+     * @param {T | null} content - The new content value to be set. Can be either the type T or null.
+     * @throws {Error} Cannot set container value using set(). Use upload() instead, if the result is a 'container'.
+     */
     set(content) {
-        if (this.metadata.result === "container")
-            throw "Cannot set container value using set(). Use upload() instead.";
-        // @ts-ignore
-        if (!content)
-            this._value = "";
-        // @ts-ignore
+        if (this.metadata.result === 'container')
+            throw new Error('Cannot set container value using set(). Use upload() instead.');
         else
             this._value = content;
         this.edited = true;
@@ -42,30 +49,30 @@ export class Field {
                 numeric: false,
                 timeOfDay: false,
                 repetitions: 1,
-                valueList: ""
+                valueList: ''
             };
         }
-        if (this.parent.type === RecordTypes.PORTAL) {
-            // @ts-ignore
-            return this.parent.layout.metadata.portalMetaData[this.parent.portal.name || "portal not attached"].find(i => i.name === this.id) || {
-                name: this.id.toString(),
-                type: 'normal',
-                displayType: 'editText',
-                result: 'text',
-                global: false,
-                autoEnter: true,
-                fourDigitYear: false,
-                maxRepeat: 1,
-                maxCharacters: 0,
-                notEmpty: false,
-                numeric: false,
-                timeOfDay: false,
-                repetitionStart: 1,
-                repetitionEnd: 1
-            };
+        if (this.parent.type === RecordTypes.PORTAL && this.parent.portal) {
+            return this.parent.layout.metadata.portalMetaData[this.parent.portal.name || 'portal not attached'].find(i => i.name === this.id) ??
+                {
+                    name: this.id.toString(),
+                    type: ApiFieldTypes.NORMAL,
+                    displayType: ApiFieldDisplayTypes.EDIT_TEXT,
+                    result: ApiFieldResultTypes.TEXT,
+                    global: false,
+                    autoEnter: true,
+                    fourDigitYear: false,
+                    maxRepeat: 1,
+                    maxCharacters: 0,
+                    notEmpty: false,
+                    numeric: false,
+                    timeOfDay: false,
+                    repetitions: 1,
+                    valueList: ''
+                };
         }
         else {
-            return this.parent.layout.metadata.fieldMetaData.find(i => i.name === this.id) || {
+            return this.parent.layout.metadata.fieldMetaData.find(i => i.name === this.id) ?? {
                 name: this.id.toString(),
                 type: ApiFieldTypes.NORMAL,
                 displayType: ApiFieldDisplayTypes.EDIT_TEXT,
@@ -79,7 +86,7 @@ export class Field {
                 numeric: false,
                 timeOfDay: false,
                 repetitions: 1,
-                valueList: ""
+                valueList: ''
             };
         }
     }
@@ -91,32 +98,35 @@ export class Field {
         this._value = value;
     }
     get string() {
-        if (typeof this._value === "string") {
-            return this._value;
-        }
-        throw "Field value is not a string";
-    }
-    get date() {
-        if (this._value instanceof Date) {
+        if (typeof this._value === 'string') {
             return this._value;
         }
-        throw "Field value is not a date";
-    }
-    get number() {
-        if (typeof this._value === "number") {
-            return this._value;
-        }
-        throw "Field value is not a number";
+        throw new Error('Field value is not a string');
     }
+    /**
+     * Uploads a file to the container field.
+     *
+     * @param {Buffer} buffer - The file content as a buffer.
+     * @param {string} filename - The filename of the file.
+     * @param {string} mime - The MIME type of the file.
+     *
+     * @throws {Error} - Cannot upload a file to the field if it's not a container field.
+     * @throws {Error} - Upload failed with HTTP error.
+     *
+     * @returns {Promise<void>} - A promise that resolves when the file is successfully uploaded.
+     */
     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)";
-        let form = new FormData();
-        form.append("upload", new File([buffer], filename, { type: mime }));
-        let res = await this.parent.layout.database.apiRequestRaw(`${this.parent.endpoint}/containers/${this.id}/1`, {
-            method: "POST",
-            // @ts-ignore
+        if (this.metadata.result !== 'container') {
+            throw new Error('Cannot upload a file to the field; ' + this.id + ' (not a container field)');
+        }
+        const form = new FormData();
+        form.append('upload', new File([buffer], filename, { type: mime }));
+        const res = await this.parent.layout.database._apiRequestRaw(`${this.parent.endpoint}/containers/${this.id}/1`, {
+            method: 'POST',
+            headers: {
+                Authorization: 'Bearer ' + this.parent.layout.database.token,
+                'Content-Type': 'multipart/form-data'
+            },
             body: form
         });
         if (!res.ok)
@@ -124,23 +134,23 @@ export class Field {
     }
     async download(mode = DownloadModes.Stream) {
         if (this.metadata.result !== ApiFieldResultTypes.CONTAINER)
-            throw new Error("Cannot perform download() on a non-container field");
-        let stream = await this.parent.layout.database.streamURL(this.string);
+            throw new Error('Cannot perform download() on a non-container field');
+        const stream = await this.parent.layout.database.streamURL(this.string);
         if (mode === DownloadModes.Stream) {
             return stream;
         }
-        let body = [];
-        return new Promise((resolve, reject) => {
-            stream.on("data", chunk => {
+        const body = [];
+        return await new Promise((resolve, reject) => {
+            stream.on('data', (chunk) => {
                 body.push(chunk);
             });
-            stream.on("error", (e) => {
+            stream.on('error', (e) => {
                 reject(e);
             });
-            stream.on("end", () => {
+            stream.on('end', () => {
                 resolve({
                     buffer: Buffer.concat(body),
-                    mime: stream.headers["content-type"],
+                    mime: stream.headers['content-type'],
                     request: stream
                 });
             });