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

package/src/index.ts

@@ -2,22 +2,22 @@
  * Copyright (c) 2023-2024. See LICENSE file for more information
  */
 
-import FMHost from "./connection/FMHost.js";
-import {FMError} from "./FMError.js";
-import * as TYPES from "./types.js"
-import {PickPortals} from "./types.js"
-import {Database} from "./connection/database.js";
-import {Layout} from "./layouts/layout.js";
-import {RecordBase} from "./records/recordBase.js";
-import {LayoutRecord} from "./records/layoutRecord.js";
-import {LayoutInterface, PortalInterface} from "./layouts/layoutInterface.js";
-import {PortalRecord} from "./records/portalRecord.js";
-import {Portal} from "./records/portal.js";
-import {FindRequest, FindRequestRaw, RecordGetOperation} from "./records/getOperations/recordGetOperation.js";
-import {LayoutRecordManager} from "./layouts/layoutRecordManager.js";
-import {RecordFieldsMap} from "./layouts/recordFieldsMap.js";
-import {query, queryEscape} from "./utils/query.js";
-import {Container, Field} from "./records/field.js";
+import FMHost from './connection/FMHost.js'
+import {FMError} from './FMError.js'
+import * as TYPES from './types.js'
+import {type PickPortals} from './types.js'
+import {Database} from './connection/database.js'
+import {Layout} from './layouts/layout.js'
+import {RecordBase} from './records/recordBase.js'
+import {LayoutRecord} from './records/layoutRecord.js'
+import {type LayoutInterface, type PortalInterface} from './layouts/layoutInterface.js'
+import {PortalRecord} from './records/portalRecord.js'
+import {Portal} from './records/portal.js'
+import {type FindRequest, type FindRequestRaw, RecordGetOperation} from './records/getOperations/recordGetOperation.js'
+import {LayoutRecordManager} from './layouts/layoutRecordManager.js'
+import {type RecordFieldsMap} from './layouts/recordFieldsMap.js'
+import {asDate, asTime, asTimestamp, query, queryEscape} from './utils/query.js'
+import {type Container, Field} from './records/field.js'
 
 export default FMHost
 export {
@@ -27,18 +27,21 @@ export {
     Layout,
     RecordBase,
     LayoutRecord,
-    LayoutInterface,
-    RecordFieldsMap,
-    PortalInterface,
+    type LayoutInterface,
+    type RecordFieldsMap,
+    type PortalInterface,
     PortalRecord,
     Portal,
     Field,
     RecordGetOperation,
     LayoutRecordManager,
-    Container,
-    PickPortals,
-    FindRequestRaw,
-    FindRequest,
+    type Container,
+    type PickPortals,
+    type FindRequestRaw,
+    type FindRequest,
     query,
-    queryEscape
-}
+    queryEscape,
+    asDate,
+    asTime,
+    asTimestamp
+}

package/src/layouts/layout.d.ts

@@ -1,9 +1,9 @@
-import { LayoutRecordManager } from "./layoutRecordManager.js";
-import { Script, ScriptResult } from "../types.js";
-import { LayoutInterface } from "./layoutInterface.js";
-import { LayoutBase } from "./layoutBase.js";
-import { DatabaseBase } from "../connection/databaseBase.js";
-import { ApiLayoutMetadata } from "../models/apiResults.js";
+import { LayoutRecordManager } from './layoutRecordManager.js';
+import { type Script, type ScriptResult } from '../types.js';
+import { type LayoutInterface } from './layoutInterface.js';
+import { type LayoutBase } from './layoutBase.js';
+import { type DatabaseBase } from '../connection/databaseBase.js';
+import { type ApiLayoutMetadata } from '../models/apiResults.js';
 export declare class Layout<T extends LayoutInterface> implements LayoutBase {
     readonly database: DatabaseBase;
     readonly name: string;
@@ -11,6 +11,17 @@ export declare class Layout<T extends LayoutInterface> implements LayoutBase {
     metadata: ApiLayoutMetadata | null;
     constructor(database: DatabaseBase, name: string);
     get endpoint(): string;
+    /**
+     * Executes a FileMaker script on this layout asynchronously and returns the result.
+     * @param {Script} script - The script to be executed.
+     * @returns {Promise<ScriptResult>} - A promise that resolves to the script result or rejects with an error.
+     */
     runScript(script: Script): Promise<ScriptResult>;
+    /**
+     * Retrieves the layout metadata
+     *
+     * @returns {Promise<ApiLayoutMetadata>} The layout metadata.
+     * @throws {FMError} If an error occurs during the API request.
+     */
     getLayoutMeta(): Promise<ApiLayoutMetadata>;
 }

package/src/layouts/layout.js

@@ -1,8 +1,8 @@
 /*
  * Copyright (c) 2023-2024. See LICENSE file for more information
  */
-import { LayoutRecordManager } from "./layoutRecordManager.js";
-import { FMError } from "../FMError.js";
+import { LayoutRecordManager } from './layoutRecordManager.js';
+import { FMError } from '../FMError.js';
 export class Layout {
     database;
     name;
@@ -15,15 +15,20 @@ export class Layout {
     get endpoint() {
         return `${this.database.endpoint}/layouts/${this.name}`;
     }
+    /**
+     * Executes a FileMaker script on this layout asynchronously and returns the result.
+     * @param {Script} script - The script to be executed.
+     * @returns {Promise<ScriptResult>} - A promise that resolves to the script result or rejects with an error.
+     */
     async runScript(script) {
         let url = `${this.endpoint}/script/${encodeURIComponent(script.name)}`;
         if (script.parameter)
-            url += "?script.param=" + encodeURIComponent(script.parameter);
-        let res = await this.database.apiRequestJSON(url, {
-            method: "GET"
+            url += '?script.param=' + encodeURIComponent(script.parameter);
+        const res = await this.database._apiRequestJSON(url, {
+            method: 'GET'
         });
-        if (res.response && res.messages[0].code === "0") {
-            let error = parseInt(res.response.scriptError);
+        if (res.response && res.messages[0].code === '0') {
+            const error = parseInt(res.response.scriptError);
             return {
                 scriptError: error ? new FMError(error, 200, res) : undefined,
                 scriptResult: res.response.scriptResult
@@ -33,11 +38,17 @@ export class Layout {
             throw new FMError(res.messages[0].code, res.httpStatus, res);
         }
     }
+    /**
+     * Retrieves the layout metadata
+     *
+     * @returns {Promise<ApiLayoutMetadata>} The layout metadata.
+     * @throws {FMError} If an error occurs during the API request.
+     */
     async getLayoutMeta() {
         if (this.metadata) {
             return this.metadata;
         }
-        let res = await this.database.apiRequestJSON(this.endpoint);
+        const res = await this.database._apiRequestJSON(this.endpoint);
         if (!res.response)
             throw new FMError(res.messages[0].code, res.httpStatus, res);
         this.metadata = res.response;

package/src/layouts/layout.ts

@@ -2,55 +2,65 @@
  * Copyright (c) 2023-2024. See LICENSE file for more information
  */
 
-import {LayoutRecordManager} from "./layoutRecordManager.js";
-import {Script, ScriptResult} from "../types.js";
-import {LayoutInterface} from "./layoutInterface.js";
-import {FMError} from "../FMError.js";
-import {LayoutBase} from "./layoutBase.js"
-import {DatabaseBase} from "../connection/databaseBase.js";
-import {ApiLayoutMetadata, ApiScriptResult} from "../models/apiResults.js";
+import {LayoutRecordManager} from './layoutRecordManager.js'
+import {type Script, type ScriptResult} from '../types.js'
+import {type LayoutInterface} from './layoutInterface.js'
+import {FMError} from '../FMError.js'
+import {type LayoutBase} from './layoutBase.js'
+import {type DatabaseBase} from '../connection/databaseBase.js'
+import {type ApiLayoutMetadata, type ApiScriptResult} from '../models/apiResults.js'
 
 export class Layout<T extends LayoutInterface> implements LayoutBase {
-    readonly database: DatabaseBase;
-    readonly name: string;
+    readonly database: DatabaseBase
+    readonly name: string
     readonly records = new LayoutRecordManager<T>(this)
-    metadata: ApiLayoutMetadata | null = null;
+    metadata: ApiLayoutMetadata | null = null
 
-    constructor(database: DatabaseBase, name: string) {
+    constructor (database: DatabaseBase, name: string) {
         this.database = database
         this.name = name
     }
 
-
-    get endpoint() {
+    get endpoint () {
         return `${this.database.endpoint}/layouts/${this.name}`
     }
 
-    async runScript(script: Script): Promise<ScriptResult> {
+    /**
+     * Executes a FileMaker script on this layout asynchronously and returns the result.
+     * @param {Script} script - The script to be executed.
+     * @returns {Promise<ScriptResult>} - A promise that resolves to the script result or rejects with an error.
+     */
+    async runScript (script: Script): Promise<ScriptResult> {
         let url = `${this.endpoint}/script/${encodeURIComponent(script.name)}`
-        if (script.parameter) url += "?script.param=" + encodeURIComponent(script.parameter)
-        let res = await this.database.apiRequestJSON<ApiScriptResult>(url, {
-            method: "GET"
+        if (script.parameter) url += '?script.param=' + encodeURIComponent(script.parameter)
+        const res = await this.database._apiRequestJSON<ApiScriptResult>(url, {
+            method: 'GET'
         })
-        if (res.response && res.messages[0].code === "0") {
-            let error = parseInt(res.response.scriptError)
+        if (res.response && res.messages[0].code === '0') {
+            const error = parseInt(res.response.scriptError)
             return {
                 scriptError: error ? new FMError(error, 200, res) : undefined,
                 scriptResult: res.response.scriptResult
             }
         } else {
-            throw new FMError(res.messages[0].code, res.httpStatus, res);
+            throw new FMError(res.messages[0].code, res.httpStatus, res)
         }
     }
 
-    public async getLayoutMeta(): Promise<ApiLayoutMetadata> {
+    /**
+     * Retrieves the layout metadata
+     *
+     * @returns {Promise<ApiLayoutMetadata>} The layout metadata.
+     * @throws {FMError} If an error occurs during the API request.
+     */
+    public async getLayoutMeta (): Promise<ApiLayoutMetadata> {
         if (this.metadata) {
             return this.metadata
         }
 
-        let res = await this.database.apiRequestJSON<ApiLayoutMetadata>(this.endpoint)
+        const res = await this.database._apiRequestJSON<ApiLayoutMetadata>(this.endpoint)
         if (!res.response) throw new FMError(res.messages[0].code, res.httpStatus, res)
         this.metadata = res.response
         return this.metadata
     }
-}
+}

package/src/layouts/layoutBase.d.ts

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

package/src/layouts/layoutBase.ts

@@ -2,15 +2,15 @@
  * Copyright (c) 2023-2024. See LICENSE file for more information
  */
 
-import {Script, ScriptResult} from "../types.js";
-import {DatabaseBase} from "../connection/databaseBase.js";
-import {ApiLayoutMetadata} from "../models/apiResults.js";
+import {type Script, type ScriptResult} from '../types.js'
+import {type DatabaseBase} from '../connection/databaseBase.js'
+import {type ApiLayoutMetadata} from '../models/apiResults.js'
 
 export interface LayoutBase {
     readonly name: string
     metadata: ApiLayoutMetadata | null
     endpoint: string
-    runScript(script: Script): Promise<ScriptResult>
-    getLayoutMeta(): Promise<ApiLayoutMetadata>
+    runScript: (script: Script) => Promise<ScriptResult>
+    getLayoutMeta: () => Promise<ApiLayoutMetadata>
     database: DatabaseBase
-}
+}

package/src/layouts/layoutInterface.d.ts

@@ -1,9 +1,7 @@
-import { Portal } from "../records/portal.js";
-import { RecordFieldsMap } from "./recordFieldsMap.js";
+import { type Portal } from '../records/portal.js';
+import { type RecordFieldsMap } from './recordFieldsMap.js';
 export interface LayoutInterface {
     fields: RecordFieldsMap;
     portals: PortalInterface;
 }
-export interface PortalInterface {
-    [key: string | number | symbol]: Portal<RecordFieldsMap>;
-}
+export type PortalInterface = Record<string | number | symbol, Portal<RecordFieldsMap>>;

package/src/layouts/layoutInterface.ts

@@ -2,14 +2,12 @@
  * Copyright (c) 2023-2024. See LICENSE file for more information
  */
 
-import {Portal} from "../records/portal.js";
-import {RecordFieldsMap} from "./recordFieldsMap.js";
+import {type Portal} from '../records/portal.js'
+import {type RecordFieldsMap} from './recordFieldsMap.js'
 
 export interface LayoutInterface {
-    fields: RecordFieldsMap,
+    fields: RecordFieldsMap
     portals: PortalInterface
 }
 
-export interface PortalInterface {
-    [key: string | number | symbol]: Portal<RecordFieldsMap>
-}
+export type PortalInterface = Record<string | number | symbol, Portal<RecordFieldsMap>>

package/src/layouts/layoutRecordManager.d.ts

@@ -1,12 +1,35 @@
-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 { 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';
+/**
+ * Manager class for handling layout records.
+ */
 export declare class LayoutRecordManager<T extends LayoutInterface> {
     readonly layout: LayoutBase;
     constructor(layout: LayoutBase);
-    create<OPTIONS extends RecordFetchOptions>(options: OPTIONS): Promise<LayoutRecord<PickPortals<T, OPTIONS["portals"][number]>>>;
+    /**
+     * 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.
+     */
+    create<OPTIONS extends RecordFetchOptions>(options: OPTIONS): Promise<LayoutRecord<PickPortals<T, OPTIONS['portals'][number]>>>;
+    /**
+     * 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.
+     */
     get(recordId: number): Promise<LayoutRecord<PickPortals<T, never>>>;
+    /**
+     * 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): RecordGetOperation<T, OPTIONS>;
 }

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;
-    }[];
+    }>;
 }