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

package/src/connection/FMHost.d.ts

@@ -1,8 +1,12 @@
-import { Database } from "./database.js";
-import { HostBase } from "./HostBase.js";
-import { databaseOptionsWithExternalSources, FMHostMetadata, loginOptionsClaris, loginOptionsFileMaker, loginOptionsOAuth } from "../types.js";
-import { DatabaseStructure } from "../databaseStructure.js";
-import { Moment } from "moment";
+import { Database } from './database.js';
+import { type HostBase } from './HostBase.js';
+import { type databaseOptionsWithExternalSources, type FMHostMetadata, type loginOptionsClaris, type loginOptionsFileMaker, type loginOptionsOAuth } from '../types.js';
+import { type DatabaseStructure } from '../databaseStructure.js';
+import { type Moment } from 'moment';
+/**
+ * Represents a FileMaker host.
+ * @implements {HostBase}
+ */
 export default class FMHost implements HostBase {
     readonly hostname: string;
     readonly timezoneOffsetFunc: (moment: Moment) => number;
@@ -13,7 +17,21 @@ export default class FMHost implements HostBase {
     get dateFormat(): string;
     get timeFormat(): string;
     get timeStampFormat(): string;
+    /**
+     * Retrieves a list of databases from the FileMaker Server.
+     *
+     * @param {loginOptionsOAuth | loginOptionsFileMaker | loginOptionsClaris} [credentials] - Optional credentials required for authentication.
+     * @throws {FMError} If the request to the FileMaker Server fails or if the response contains an error.
+     * @returns {Promise<any[]>} A promise that resolves to an array of database objects if successful.
+     */
     listDatabases(credentials?: loginOptionsOAuth | loginOptionsFileMaker | loginOptionsClaris): Promise<any>;
+    /**
+     * Creates a new database connection with the specified options.
+     *
+     * @template T - The type of the database structure.
+     * @param {databaseOptionsWithExternalSources} data - The options for the database, including external sources.
+     * @return {Database<T>} A new Database instance.
+     */
     database<T extends DatabaseStructure>(data: databaseOptionsWithExternalSources): Database<T>;
     getMetadata(): Promise<FMHostMetadata>;
 }

package/src/connection/FMHost.js

@@ -1,9 +1,13 @@
 /*
  * Copyright (c) 2023-2024. See LICENSE file for more information
  */
-import { generateAuthorizationHeaders } from "./generateAuthorizationHeaders.js";
-import { FMError } from "../FMError.js";
-import { Database } from "./database.js";
+import { generateAuthorizationHeaders } from './generateAuthorizationHeaders.js';
+import { FMError } from '../FMError.js';
+import { Database } from './database.js';
+/**
+ * Represents a FileMaker host.
+ * @implements {HostBase}
+ */
 export default class FMHost {
     hostname;
     timezoneOffsetFunc;
@@ -11,71 +15,83 @@ export default class FMHost {
     _metadata = null;
     constructor(_hostname, timezoneOffset = (moment) => 0 - (new Date()).getTimezoneOffset(), verify = true) {
         if (!(/^https?:\/\//).test(_hostname))
-            throw "hostname MUST begin with either http:// or https://";
+            throw new Error('hostname MUST begin with either http:// or https://');
         this.hostname = _hostname;
         this.timezoneOffsetFunc = timezoneOffset;
         this.verify = verify;
     }
     get metadata() {
-        return this._metadata || {
+        return this._metadata ?? {
             productInfo: {
                 buildDate: new Date(),
-                name: "",
-                version: "",
-                dateFormat: "MM/dd/yyyy",
-                timeFormat: "HH:mm:ss",
-                timeStampFormat: "MM/dd/yyyy HH:mm:ss"
+                name: '',
+                version: '',
+                dateFormat: 'MM/dd/yyyy',
+                timeFormat: 'HH:mm:ss',
+                timeStampFormat: 'MM/dd/yyyy HH:mm:ss'
             }
         };
     }
     get dateFormat() {
         return this.metadata.productInfo.dateFormat
-            .replace("dd", "DD")
-            .replace("yyyy", "YYYY");
+            .replace('dd', 'DD')
+            .replace('yyyy', 'YYYY');
     }
     get timeFormat() { return this.metadata.productInfo.timeFormat; }
     get timeStampFormat() {
         return this.metadata.productInfo.timeStampFormat
-            .replace("dd", "DD")
-            .replace("yyyy", "YYYY");
+            .replace('dd', 'DD')
+            .replace('yyyy', 'YYYY');
     }
+    /**
+     * Retrieves a list of databases from the FileMaker Server.
+     *
+     * @param {loginOptionsOAuth | loginOptionsFileMaker | loginOptionsClaris} [credentials] - Optional credentials required for authentication.
+     * @throws {FMError} If the request to the FileMaker Server fails or if the response contains an error.
+     * @returns {Promise<any[]>} A promise that resolves to an array of database objects if successful.
+     */
     async listDatabases(credentials) {
         let headers = {};
         if (credentials) {
             headers = generateAuthorizationHeaders(credentials);
         }
-        let _fetch = await fetch(`${this.hostname}/fmi/data/v2/databases`, {
-            method: "GET",
+        const _fetch = await fetch(`${this.hostname}/fmi/data/v2/databases`, {
+            method: 'GET',
             headers
         });
-        let data = await _fetch.json();
+        const data = await _fetch.json();
         // console.log(data.messages[0])
-        if (data.messages[0].code === "0" && data.response) {
+        if (data.messages[0].code === '0' && data.response) {
             return data.response.databases;
         }
         else {
-            // @ts-ignore
-            throw new FMError(data.messages[0].code, data.status, data);
+            throw new FMError(data.messages[0].code, _fetch.status, data);
         }
     }
+    /**
+     * Creates a new database connection with the specified options.
+     *
+     * @template T - The type of the database structure.
+     * @param {databaseOptionsWithExternalSources} data - The options for the database, including external sources.
+     * @return {Database<T>} A new Database instance.
+     */
     database(data) {
         return new Database(this, data);
     }
     async getMetadata() {
         if (this._metadata)
             return this._metadata;
-        let _fetch = await fetch(`${this.hostname}/fmi/data/v2/productInfo`, {
-            method: "GET",
+        const _fetch = await fetch(`${this.hostname}/fmi/data/v2/productInfo`, {
+            method: 'GET'
         });
-        let data = await _fetch.json();
+        const data = await _fetch.json();
         // console.log(data.messages[0])
-        if (data.messages[0].code === "0" && data.response) {
+        if (data.messages[0].code === '0' && data.response) {
             this._metadata = data.response;
             return data.response;
         }
         else {
-            // @ts-ignore
-            throw new FMError(data.messages[0].code, data.status, data);
+            throw new FMError(data.messages[0].code, _fetch.status, data);
         }
     }
 }

package/src/connection/FMHost.ts

@@ -2,106 +2,120 @@
  * Copyright (c) 2023-2024. See LICENSE file for more information
  */
 
-import {generateAuthorizationHeaders} from "./generateAuthorizationHeaders.js";
-import {FMError} from "../FMError.js";
-import {Database} from "./database.js";
-import {HostBase} from "./HostBase.js"
+import {generateAuthorizationHeaders} from './generateAuthorizationHeaders.js'
+import {FMError} from '../FMError.js'
+import {Database} from './database.js'
+import {type HostBase} from './HostBase.js'
 import {
-    databaseOptionsWithExternalSources,
-    FMHostMetadata,
-    loginOptionsClaris,
-    loginOptionsFileMaker,
-    loginOptionsOAuth
-} from "../types.js";
-import {ApiResults} from "../models/apiResults.js";
-import {DatabaseStructure} from "../databaseStructure.js";
-import {Moment} from "moment";
+    type databaseOptionsWithExternalSources,
+    type FMHostMetadata,
+    type loginOptionsClaris,
+    type loginOptionsFileMaker,
+    type loginOptionsOAuth
+} from '../types.js'
+import {type ApiResults} from '../models/apiResults.js'
+import {type DatabaseStructure} from '../databaseStructure.js'
+import {type Moment} from 'moment'
 
+/**
+ * Represents a FileMaker host.
+ * @implements {HostBase}
+ */
 export default class FMHost implements HostBase {
     readonly hostname: string
     readonly timezoneOffsetFunc: (moment: Moment) => number
     readonly verify: boolean
     _metadata: FMHostMetadata | null = null
 
-    constructor(
+    constructor (
         _hostname: string,
         timezoneOffset = (moment: Moment) => 0 - (new Date()).getTimezoneOffset(),
         verify = true
     ) {
-        if (!(/^https?:\/\//).test(_hostname)) throw "hostname MUST begin with either http:// or https://"
+        if (!(/^https?:\/\//).test(_hostname)) throw new Error('hostname MUST begin with either http:// or https://')
         this.hostname = _hostname
         this.timezoneOffsetFunc = timezoneOffset
         this.verify = verify
     }
 
-    get metadata(): FMHostMetadata {
-        return this._metadata || {
+    get metadata (): FMHostMetadata {
+        return this._metadata ?? {
             productInfo: {
                 buildDate: new Date(),
-                name: "",
-                version: "",
-                dateFormat: "MM/dd/yyyy",
-                timeFormat: "HH:mm:ss",
-                timeStampFormat: "MM/dd/yyyy HH:mm:ss"
+                name: '',
+                version: '',
+                dateFormat: 'MM/dd/yyyy',
+                timeFormat: 'HH:mm:ss',
+                timeStampFormat: 'MM/dd/yyyy HH:mm:ss'
             }
-        };
+        }
     }
 
-    get dateFormat() {
+    get dateFormat () {
         return this.metadata.productInfo.dateFormat
-            .replace("dd", "DD")
-            .replace("yyyy", "YYYY")
+            .replace('dd', 'DD')
+            .replace('yyyy', 'YYYY')
     }
 
-    get timeFormat() {return this.metadata.productInfo.timeFormat}
-    get timeStampFormat() {
+    get timeFormat () { return this.metadata.productInfo.timeFormat }
+    get timeStampFormat () {
         return this.metadata.productInfo.timeStampFormat
-            .replace("dd", "DD")
-            .replace("yyyy", "YYYY")
+            .replace('dd', 'DD')
+            .replace('yyyy', 'YYYY')
     }
 
-    async listDatabases(credentials?: loginOptionsOAuth | loginOptionsFileMaker | loginOptionsClaris) {
+    /**
+     * Retrieves a list of databases from the FileMaker Server.
+     *
+     * @param {loginOptionsOAuth | loginOptionsFileMaker | loginOptionsClaris} [credentials] - Optional credentials required for authentication.
+     * @throws {FMError} If the request to the FileMaker Server fails or if the response contains an error.
+     * @returns {Promise<any[]>} A promise that resolves to an array of database objects if successful.
+     */
+    async listDatabases (credentials?: loginOptionsOAuth | loginOptionsFileMaker | loginOptionsClaris) {
         let headers = {}
         if (credentials) {
             headers = generateAuthorizationHeaders(credentials)
         }
 
-        let _fetch = await fetch(`${this.hostname}/fmi/data/v2/databases`, {
-            method: "GET",
+        const _fetch = await fetch(`${this.hostname}/fmi/data/v2/databases`, {
+            method: 'GET',
             headers
         })
-        let data = await _fetch.json() as ApiResults<{databases: any}>
+        const data = await _fetch.json() as ApiResults<{ databases: any }>
         // console.log(data.messages[0])
 
-        if (data.messages[0].code === "0" && data.response) {
+        if (data.messages[0].code === '0' && data.response) {
             return data.response.databases
-        }
-        else {
-            // @ts-ignore
-            throw new FMError(data.messages[0].code, data.status, data)
+        } else {
+            throw new FMError(data.messages[0].code, _fetch.status, data)
         }
     }
 
+    /**
+     * Creates a new database connection with the specified options.
+     *
+     * @template T - The type of the database structure.
+     * @param {databaseOptionsWithExternalSources} data - The options for the database, including external sources.
+     * @return {Database<T>} A new Database instance.
+     */
     database<T extends DatabaseStructure>(data: databaseOptionsWithExternalSources) {
         return new Database<T>(this, data)
     }
 
-    async getMetadata() {
+    async getMetadata () {
         if (this._metadata) return this._metadata
 
-        let _fetch = await fetch(`${this.hostname}/fmi/data/v2/productInfo`, {
-            method: "GET",
+        const _fetch = await fetch(`${this.hostname}/fmi/data/v2/productInfo`, {
+            method: 'GET'
         })
-        let data = await _fetch.json() as ApiResults<FMHostMetadata>
+        const data = await _fetch.json() as ApiResults<FMHostMetadata>
         // console.log(data.messages[0])
 
-        if (data.messages[0].code === "0" && data.response) {
+        if (data.messages[0].code === '0' && data.response) {
             this._metadata = data.response
             return data.response
-        }
-        else {
-            // @ts-ignore
-            throw new FMError(data.messages[0].code, data.status, data)
+        } else {
+            throw new FMError(data.messages[0].code, _fetch.status, data)
         }
     }
-}
+}

package/src/connection/HostBase.d.ts

@@ -1,11 +1,11 @@
-import { FMHostMetadata } from "../types.js";
-import { Moment } from "moment";
+import { type FMHostMetadata } from '../types.js';
+import { type Moment } from 'moment';
 export interface HostBase {
     readonly hostname: string;
     readonly timezoneOffsetFunc: (moment: Moment) => number;
     readonly verify: boolean;
     metadata: FMHostMetadata;
-    getMetadata(): PromiseLike<any>;
+    getMetadata: () => PromiseLike<any>;
     timeFormat: string;
     dateFormat: string;
     timeStampFormat: string;

package/src/connection/HostBase.ts

@@ -2,16 +2,16 @@
  * Copyright (c) 2023-2024. See LICENSE file for more information
  */
 
-import {FMHostMetadata} from "../types.js";
-import {Moment} from "moment";
+import {type FMHostMetadata} from '../types.js'
+import {type Moment} from 'moment'
 
 export interface HostBase {
     readonly hostname: string
-    readonly timezoneOffsetFunc: (moment: Moment) => number,
+    readonly timezoneOffsetFunc: (moment: Moment) => number
     readonly verify: boolean
     metadata: FMHostMetadata
-    getMetadata(): PromiseLike<any>
+    getMetadata: () => PromiseLike<any>
     timeFormat: string
     dateFormat: string
     timeStampFormat: string
-}
+}

package/src/connection/database.d.ts

@@ -1,33 +1,66 @@
 /// <reference types="node" resolution-mode="require"/>
 /// <reference types="node" resolution-mode="require"/>
-import { EventEmitter } from "events";
-import { LayoutInterface } from "../layouts/layoutInterface.js";
-import { Layout } from "../layouts/layout.js";
-import { databaseOptionsWithExternalSources, Script } from "../types.js";
-import { HostBase } from "./HostBase.js";
-import { DatabaseBase } from "./databaseBase.js";
-import { ApiResults } from "../models/apiResults.js";
-import { DatabaseStructure } from "../databaseStructure.js";
-import { IncomingMessage } from "http";
+import { EventEmitter } from 'events';
+import { type LayoutInterface } from '../layouts/layoutInterface.js';
+import { Layout } from '../layouts/layout.js';
+import { type databaseOptionsWithExternalSources, type Script } from '../types.js';
+import { type HostBase } from './HostBase.js';
+import { type DatabaseBase } from './databaseBase.js';
+import { type ApiResults } from '../models/apiResults.js';
+import { type DatabaseStructure } from '../databaseStructure.js';
+import { type IncomingMessage } from 'http';
+/**
+ * Represents a database connection.
+ * @template T - The structure of the database.
+ */
 export declare class Database<T extends DatabaseStructure> extends EventEmitter implements DatabaseBase {
     private _token;
     readonly host: HostBase;
-    private connection_details;
+    private readonly connection_details;
     private cookies;
     readonly name: string;
     readonly debug: boolean;
     constructor(host: HostBase, conn: databaseOptionsWithExternalSources);
     private generateExternalSourceLogin;
+    /**
+     * Logs out the user by deleting the current session token.
+     * Throws an error if the user is not logged in.
+     *
+     * @returns {Promise<void>} A promise that resolves with no value once the logout is successful.
+     * @throws {Error} Throws an error if the user is not logged in.
+     */
     logout(): Promise<void>;
-    login(forceLogin?: boolean): Promise<any>;
-    get token(): any;
+    /**
+     * Logs in to the database. Not required, as this is often done automatically
+     *
+     * @param {boolean} [forceLogin=false] - Whether to force login even if already logged in.
+     * @throws {Error} - Throws an error if already logged in and forceLogin is false.
+     * @throws {FMError} - Throws an FMError if login fails.
+     * @return {Promise<string>} - Returns a promise that resolves to the access token upon successful login.
+     */
+    login(forceLogin?: boolean): Promise<string>;
+    get token(): string;
+    /**
+     * Returns the endpoint URL for the database connection.
+     *
+     * @returns {string} The endpoint URL.
+     */
     get endpoint(): string;
-    apiRequestRaw(url: string | Request, options?: any, autoRelogin?: boolean): Promise<Response>;
-    apiRequestJSON<T = any>(url: string | Request, options?: any): Promise<ApiResults<T>>;
+    _apiRequestRaw(url: string | Request, options?: RequestInit & {
+        headers?: Record<string, string>;
+    }, autoRelogin?: boolean): Promise<Response>;
+    _apiRequestJSON<T = any>(url: string | Request, options?: RequestInit & {
+        headers?: Record<string, string>;
+    }): Promise<ApiResults<T>>;
+    /**
+     * Retrieves a list of layouts in the current FileMaker database.
+     *
+     * @returns {Promise<Layout[]>} A promise that resolves to an array of Layout objects.
+     * @throws {FMError} If there was an error retrieving the layouts.
+     */
     listLayouts(): Promise<Layout<LayoutInterface>[]>;
-    getLayout<R extends keyof T["layouts"]>(name: R): Layout<T["layouts"][R]>;
-    getLayout<R extends LayoutInterface>(name: string): Layout<R>;
+    layout<R extends keyof T['layouts']>(name: R): Layout<T['layouts'][R]>;
+    layout<R extends LayoutInterface>(name: string): Layout<R>;
     script(name: string, parameter?: string): Script;
-    _tokenExpired(): void;
     streamURL(url: string): Promise<IncomingMessage>;
 }