@jd-data-limited/easy-fm 3.2.7 → 3.2.9

package/package.json

@@ -1,13 +1,10 @@
 {
   "name": "@jd-data-limited/easy-fm",
-  "version": "3.2.7",
+  "version": "3.2.9",
   "dependencies": {
-    "@types/btoa": "^1.2.3",
-    "@types/events": "^3.0.0",
+    "follow-redirects": "^1.15.5",
     "moment": "^2.29.4",
-    "node-fetch": "3.2.8",
-    "typescript": "^5.2.2",
-    "ytdl-core": "^4.11.4"
+    "node-fetch": "3.3.2"
   },
   "type": "module",
   "main": "src/index.js",
@@ -16,8 +13,11 @@
   "url": "https://github.com/JD-Data-Limited/easy-fm",
   "license": "SEE LICENSE IN LICENSE",
   "description": "easy-fm is a Node.js module that allows you to interact with\r a [FileMaker database stored](https://www.claris.com/filemaker/) on\r a [FileMaker server](https://www.claris.com/filemaker/server/). This module interacts with your server using the\r [FileMaker Data API](https://help.claris.com/en/data-api-guide/content/index.html).",
+  "files": [
+    "./src/**/*"
+  ],
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
+    "test": "node --test tests/login.js",
     "build": "webpack"
   },
   "repository": {
@@ -34,6 +34,10 @@
     "url": "https://github.com/JD-Data-Limited/easy-fm/issues"
   },
   "devDependencies": {
+    "@types/btoa": "^1.2.3",
+    "@types/events": "^3.0.0",
+    "dotenv": "^16.3.1",
+    "typescript": "^5.2.2",
     "webpack": "^5.81.0",
     "webpack-cli": "^5.0.2"
   }

package/src/FMError.d.ts

@@ -8,5 +8,5 @@ export declare class FMError extends Error {
     readonly code: number;
     readonly message: string;
     readonly messages: string;
-    constructor(code: any, httpStatus: any, res: any, trace?: Error);
+    constructor(code: string | number, httpStatus: number, res: any, trace?: Error);
 }

package/src/FMError.ts

@@ -1021,7 +1021,7 @@ export class FMError extends Error {
     readonly message: string
     readonly messages: string
 
-    constructor(code, httpStatus, res, trace?: Error) {
+    constructor(code: string | number, httpStatus: number, res: any, trace?: Error) {
         if (typeof code === "string") code = parseInt(code)
         super(errs.find(err => err.e === code).d || "Unknown error");
         this.httpStatus = httpStatus

package/src/connection/FMHost.d.ts

@@ -9,5 +9,5 @@ export default class FMHost implements HostBase {
     constructor(_hostname: string, timezoneOffset?: number, verify?: boolean);
     listDatabases(credentials?: loginOptionsOAuth | loginOptionsFileMaker | loginOptionsClaris): Promise<any>;
     database<T extends DatabaseStructure>(data: databaseOptionsWithExternalSources): Database<T>;
-    getMetadata(): Promise<any>;
+    getMetadata(): Promise<FMHostMetadata>;
 }

package/src/connection/FMHost.ts

@@ -9,12 +9,12 @@ import {Database} from "./database.js";
 import {HostBase} from "./HostBase.js"
 import {
     databaseOptionsWithExternalSources, DatabaseStructure,
-    fileMakerResponse,
     FMHostMetadata,
     loginOptionsClaris,
     loginOptionsFileMaker,
     loginOptionsOAuth
 } from "../types.js";
+import {ApiResults} from "../models/apiResults";
 
 export default class FMHost implements HostBase {
     readonly hostname: string
@@ -39,7 +39,7 @@ export default class FMHost implements HostBase {
             method: "GET",
             headers
         })
-        let data = await _fetch.json() as fileMakerResponse
+        let data = await _fetch.json() as ApiResults<{databases: any}>
         // console.log(data.messages[0])
 
         if (data.messages[0].code === "0") {
@@ -61,7 +61,7 @@ export default class FMHost implements HostBase {
         let _fetch = await fetch(`${this.hostname}/fmi/data/v2/productInfo`, {
             method: "GET",
         })
-        let data = await _fetch.json() as fileMakerResponse
+        let data = await _fetch.json() as ApiResults<FMHostMetadata>
         // console.log(data.messages[0])
 
         if (data.messages[0].code === "0") {

package/src/connection/database.d.ts

@@ -7,6 +7,7 @@ import HTTP_REDIRECT from "follow-redirects";
 import { databaseOptionsWithExternalSources, DatabaseStructure, Script } from "../types.js";
 import { HostBase } from "./HostBase.js";
 import { DatabaseBase } from "./databaseBase";
+import { ApiResults } from "../models/apiResults";
 export declare class Database<T extends DatabaseStructure> extends EventEmitter implements DatabaseBase {
     private _token;
     readonly host: HostBase;
@@ -16,14 +17,15 @@ export declare class Database<T extends DatabaseStructure> extends EventEmitter
     constructor(host: HostBase, conn: databaseOptionsWithExternalSources);
     private generateExternalSourceLogin;
     logout(): Promise<void>;
-    login(): Promise<string>;
+    login(): Promise<any>;
     get token(): any;
     get endpoint(): string;
-    apiRequest<T = any>(url: string | Request, options?: any, autoRelogin?: boolean): Promise<T>;
+    apiRequest<T = any>(url: string | Request, options?: any, autoRelogin?: boolean): Promise<ApiResults<T>>;
+    listLayouts(): Promise<Layout<LayoutInterface>[]>;
     getLayout<R extends string>(name: R): Layout<T["layouts"][R]>;
     getLayout<R extends LayoutInterface>(name: string): Layout<R>;
     setGlobals(globalFields: any): Promise<void>;
     script(name: any, parameter?: string): Script;
     _tokenExpired(): void;
-    streamContainer(field: any, url: any): Promise<HTTP_REDIRECT.http.IncomingMessage>;
+    streamURL(url: string): Promise<HTTP_REDIRECT.http.IncomingMessage>;
 }

package/src/connection/database.js

@@ -38,9 +38,9 @@ export class Database extends EventEmitter {
         }
     }
     logout() {
-        return new Promise((resolve, reject) => __awaiter(this, void 0, void 0, function* () {
+        return __awaiter(this, void 0, void 0, function* () {
             if (!this.token)
-                reject(new Error("Not logged in"));
+                throw new Error("Not logged in");
             let _fetch = yield fetch(`${this.endpoint}/sessions/${this.token}`, {
                 method: "DELETE",
                 headers: {
@@ -50,28 +50,22 @@ export class Database extends EventEmitter {
             let data = yield _fetch.json();
             // console.log(data)
             this._token = null;
-            resolve();
-        }));
+        });
     }
     login() {
-        return new Promise((resolve, reject) => __awaiter(this, void 0, void 0, function* () {
+        return __awaiter(this, void 0, void 0, function* () {
             // Reset cookies
             this.cookies = {};
-            try {
-                yield this.host.getMetadata();
-            }
-            catch (e) {
-                reject(e);
-                return;
-            }
+            yield this.host.getMetadata();
             if (this.token)
                 throw new Error("Already logged in. Run logout() first");
             if (this.connection_details.credentials.method === "token") {
                 this._token = this.connection_details.credentials.token;
-                resolve(this.token);
+                return this.token;
             }
             else {
-                fetch(`${this.endpoint}/sessions`, {
+                console.time();
+                let res = yield fetch(`${this.endpoint}/sessions`, {
                     hostname: this.host.hostname,
                     port: 443,
                     method: "POST",
@@ -82,21 +76,18 @@ export class Database extends EventEmitter {
                             return this.generateExternalSourceLogin(_i);
                         })
                     })
-                }).then((res) => __awaiter(this, void 0, void 0, function* () {
-                    let _res = (yield res.json());
-                    if (res.status === 200) {
-                        this._token = res.headers.get('x-fm-data-access-token');
-                        resolve(this._token);
-                    }
-                    else {
-                        reject(new FMError(_res.messages[0].code, _res.status, res));
-                    }
-                }))
-                    .catch(e => {
-                    reject(e);
                 });
+                console.time();
+                let _res = (yield res.json());
+                if (res.status === 200) {
+                    this._token = res.headers.get('x-fm-data-access-token');
+                    return this._token;
+                }
+                else {
+                    throw new FMError(_res.messages[0].code, _res.status, res);
+                }
             }
-        }));
+        });
     }
     get token() {
         return this._token;
@@ -119,35 +110,42 @@ export class Database extends EventEmitter {
                 }
             }
             let data = yield _fetch.json();
+            // Remove response if it is empty. This makes checking for an empty response easier
+            if (Object.keys(data.response).length === 0)
+                delete data.response;
             // console.log(data.messages[0])
-            if (data.messages[0].code == 952 && autoRelogin) {
+            if (data.messages[0].code === "952" && autoRelogin) {
                 this._token = null;
                 yield this.login();
                 return yield this.apiRequest(url, options, false);
             }
+            else if (data.messages[0].code !== "0") {
+                throw new FMError(data.messages[0].code, _fetch.status, data);
+            }
+            data.httpStatus = _fetch.status;
             return data;
         });
     }
+    listLayouts() {
+        return __awaiter(this, void 0, void 0, function* () {
+            let req = yield this.apiRequest(`${this.endpoint}/layouts`);
+            if (!req.response)
+                throw new FMError(req.messages[0].code, req.httpStatus, req.messages[0].message);
+            return req.response.layouts.filter(i => !i.isFolder).map(layout => new Layout(this, layout.name));
+        });
+    }
     getLayout(name) {
         return new Layout(this, name);
     }
+    /*
+    @deprecated
+     */
     setGlobals(globalFields) {
-        // console.log({globalFields})
-        return new Promise((resolve, reject) => {
-            this.apiRequest(`${this.endpoint}/globals`, {
+        return __awaiter(this, void 0, void 0, function* () {
+            // console.log({globalFields})
+            yield this.apiRequest(`${this.endpoint}/globals`, {
                 method: "PATCH",
                 body: JSON.stringify({ globalFields })
-            }).then(res => {
-                // console.log(res)
-                if (res.messages[0].code === "0") {
-                    resolve();
-                }
-                else {
-                    reject((res.messages[0].code, res.status, res));
-                }
-            })
-                .catch(e => {
-                reject(e);
             });
         });
     }
@@ -157,15 +155,10 @@ export class Database extends EventEmitter {
     _tokenExpired() {
         this.emit("token_expired");
     }
-    streamContainer(field, url) {
+    streamURL(url) {
         return new Promise((resolve, reject) => {
-            if (field.metadata.result !== "container") {
-                reject("Cannot stream the field " + field.id + " as it is not a container");
-                return;
-            }
             if (!url || typeof url !== "string") {
-                reject("Container is empty, or has invalid value");
-                return;
+                throw new Error("URL is empty, or has invalid value");
             }
             let headers = {};
             if (Object.keys(this.cookies).length !== 0) {

package/src/connection/database.ts

@@ -12,13 +12,13 @@ import HTTP_REDIRECT  from "follow-redirects"
 import {
     databaseOptionsBase,
     databaseOptionsWithExternalSources, DatabaseStructure,
-    fileMakerResponse,
     loginOptionsFileMaker,
     loginOptionsToken,
     Script
 } from "../types.js";
 import {HostBase} from "./HostBase.js"
 import {DatabaseBase} from "./databaseBase";
+import {ApiLayout, ApiResults} from "../models/apiResults";
 
 type GetLayoutReturnType<T extends DatabaseStructure, R extends LayoutInterface | string> = R extends string ? T["layouts"][R] : R
 
@@ -50,67 +50,55 @@ export class Database<T extends DatabaseStructure> extends EventEmitter implemen
         }
     }
 
-    logout(): Promise<void> {
-        return new Promise(async (resolve, reject) => {
-            if (!this.token) reject(new Error("Not logged in"))
+    async logout(): Promise<void> {
+        if (!this.token) throw new Error("Not logged in")
 
-            let _fetch = await fetch(`${this.endpoint}/sessions/${this.token}`, {
-                method: "DELETE",
-                headers: {
-                    "content-type": "application/json"
-                }
-            })
-            let data = await _fetch.json()
-            // console.log(data)
-            this._token = null
-            resolve()
+        let _fetch = await fetch(`${this.endpoint}/sessions/${this.token}`, {
+            method: "DELETE",
+            headers: {
+                "content-type": "application/json"
+            }
         })
+        let data = await _fetch.json()
+        // console.log(data)
+        this._token = null
     }
 
-    login() {
-        return new Promise<string>(async (resolve, reject) => {
-            // Reset cookies
-            this.cookies = {}
+    async login() {
+        // Reset cookies
+        this.cookies = {}
 
-            try {
-                await this.host.getMetadata()
-            } catch (e) {
-                reject(e)
-                return
-            }
-            if (this.token) throw new Error("Already logged in. Run logout() first")
+        await this.host.getMetadata()
+        if (this.token) throw new Error("Already logged in. Run logout() first")
 
-            if (this.connection_details.credentials.method === "token") {
-                this._token = (<loginOptionsToken>this.connection_details.credentials).token
-                resolve(this.token)
-            }
-            else {
-                fetch(`${this.endpoint}/sessions`, {
-                    hostname: this.host.hostname,
-                    port: 443,
-                    method: "POST",
-                    headers: generateAuthorizationHeaders(this.connection_details.credentials) as unknown as HeadersInit,
-                    body: JSON.stringify({
-                        fmDataSource: this.connection_details.externalSources.map(i => {
-                            let _i = <databaseOptionsBase>i
-                            return this.generateExternalSourceLogin(_i)
-                        })
+        if (this.connection_details.credentials.method === "token") {
+            this._token = (<loginOptionsToken>this.connection_details.credentials).token
+            return this.token
+        }
+        else {
+            console.time()
+            let res = await fetch(`${this.endpoint}/sessions`, {
+                hostname: this.host.hostname,
+                port: 443,
+                method: "POST",
+                headers: generateAuthorizationHeaders(this.connection_details.credentials) as unknown as HeadersInit,
+                body: JSON.stringify({
+                    fmDataSource: this.connection_details.externalSources.map(i => {
+                        let _i = <databaseOptionsBase>i
+                        return this.generateExternalSourceLogin(_i)
                     })
-                }).then(async res => {
-                    let _res = <any>(await res.json())
-                    if (res.status === 200) {
-                        this._token = res.headers.get('x-fm-data-access-token')
-                        resolve(this._token)
-                    }
-                    else {
-                        reject(new FMError(_res.messages[0].code, _res.status, res))
-                    }
                 })
-                    .catch(e => {
-                        reject(e)
-                    })
+            })
+            console.time()
+            let _res = <any>(await res.json())
+            if (res.status === 200) {
+                this._token = res.headers.get('x-fm-data-access-token')
+                return this._token
             }
-        })
+            else {
+                throw new FMError(_res.messages[0].code, _res.status, res)
+            }
+        }
     }
 
     get token() {
@@ -121,7 +109,7 @@ export class Database<T extends DatabaseStructure> extends EventEmitter implemen
         return `${this.host.hostname}/fmi/data/v2/databases/${this.name}`
     }
 
-    async apiRequest<T = any>(url: string | Request, options: any = {}, autoRelogin = true): Promise<T> {
+    async apiRequest<T = any>(url: string | Request, options: any = {}, autoRelogin = true): Promise<ApiResults<T>> {
         if (!options.headers) options.headers = {}
         options.headers["content-type"] = options.headers["content-type"] ? options.headers["content-type"] : "application/json"
         options.headers["authorization"] = "Bearer " + this._token
@@ -134,14 +122,30 @@ export class Database<T extends DatabaseStructure> extends EventEmitter implemen
                 this.cookies[cookie_split[0]] = cookie_split[1]
             }
         }
-        let data = await _fetch.json() as fileMakerResponse
+        let data = await _fetch.json() as ApiResults<T>
+
+        // Remove response if it is empty. This makes checking for an empty response easier
+        if (Object.keys(data.response).length === 0) delete data.response
+
         // console.log(data.messages[0])
-        if (data.messages[0].code == 952 && autoRelogin) {
+        if (data.messages[0].code === "952" && autoRelogin) {
             this._token = null
             await this.login()
             return await this.apiRequest(url, options, false)
         }
-        return (data as any)
+        else if (data.messages[0].code !== "0") {
+            throw new FMError(data.messages[0].code, _fetch.status, data)
+        }
+
+        data.httpStatus = _fetch.status
+        return data
+    }
+
+    async listLayouts() {
+        let req = await this.apiRequest<{layouts: ApiLayout[]}>(`${this.endpoint}/layouts`)
+        if (!req.response) throw new FMError(req.messages[0].code, req.httpStatus, req.messages[0].message)
+
+        return req.response.layouts.filter(i => !i.isFolder).map(layout => new Layout(this, layout.name))
     }
 
     getLayout<R extends string>(name: R): Layout<T["layouts"][R]>
@@ -150,25 +154,14 @@ export class Database<T extends DatabaseStructure> extends EventEmitter implemen
         return new Layout<LayoutInterface>(this, name)
     }
 
-    setGlobals(globalFields): Promise<void> {
+    /*
+    @deprecated
+     */
+    async setGlobals(globalFields) {
         // console.log({globalFields})
-        return new Promise((resolve, reject) => {
-            this.apiRequest(`${this.endpoint}/globals`, {
-                method: "PATCH",
-                body: JSON.stringify({globalFields})
-            }).then(res => {
-                // console.log(res)
-                if (res.messages[0].code === "0") {
-                    resolve()
-                }
-                else {
-                    reject(
-                        (res.messages[0].code, res.status, res))
-                }
-            })
-                .catch(e => {
-                    reject(e)
-                })
+        await this.apiRequest(`${this.endpoint}/globals`, {
+            method: "PATCH",
+            body: JSON.stringify({globalFields})
         })
     }
 
@@ -180,15 +173,10 @@ export class Database<T extends DatabaseStructure> extends EventEmitter implemen
         this.emit("token_expired")
     }
 
-    streamContainer(field, url): Promise<HTTP_REDIRECT.http.IncomingMessage> {
+    streamURL(url: string): Promise<HTTP_REDIRECT.http.IncomingMessage> {
         return new Promise((resolve, reject) => {
-            if (field.metadata.result !== "container") {
-                reject("Cannot stream the field " + field.id + " as it is not a container")
-                return
-            }
             if (!url || typeof url !== "string") {
-                reject("Container is empty, or has invalid value")
-                return
+                throw new Error("URL is empty, or has invalid value")
             }
 
             let headers = {}

package/src/connection/databaseBase.d.ts

@@ -1,8 +1,11 @@
 import { HostBase } from "./HostBase.js";
 import { Request } from "node-fetch";
+import { ApiResults } from "../models/apiResults";
+import HTTP_REDIRECT from "follow-redirects";
 export interface DatabaseBase {
     host: HostBase;
     readonly name: string;
     endpoint: string;
-    apiRequest(url: string | Request, options?: any, autoRelogin?: boolean): Promise<any>;
+    apiRequest<T = unknown>(url: string | Request, options?: any, autoRelogin?: boolean): Promise<ApiResults<T>>;
+    streamURL(url: string): Promise<HTTP_REDIRECT.http.IncomingMessage>;
 }

package/src/connection/databaseBase.ts

@@ -5,6 +5,8 @@
 import {HostBase} from "./HostBase.js"
 import {Request} from "node-fetch";
 import {DatabaseStructure} from "../types";
+import {ApiResults} from "../models/apiResults";
+import HTTP_REDIRECT  from "follow-redirects"
 
 export interface DatabaseBase {
     host: HostBase,
@@ -13,5 +15,6 @@ export interface DatabaseBase {
 
     // layouts: DatabaseStructure["layouts"]
 
-    apiRequest(url: string | Request, options?: any, autoRelogin?: boolean): Promise<any>
+    apiRequest<T = unknown>(url: string | Request, options?: any, autoRelogin?: boolean): Promise<ApiResults<T>>
+    streamURL(url: string): Promise<HTTP_REDIRECT.http.IncomingMessage>
 }

package/src/layouts/layout.d.ts

@@ -3,14 +3,14 @@ import { LayoutRecord } from "../records/layoutRecord.js";
 import { Script, ScriptResult } from "../types.js";
 import { LayoutInterface } from "./layoutInterface.js";
 import { Find } from "../records/getOperations/find.js";
-import { FMError } from "../FMError.js";
 import { LayoutBase } from "./layoutBase.js";
 import { DatabaseBase } from "../connection/databaseBase";
+import { ApiLayoutMetadata } from "../models/apiResults";
 export declare class Layout<T extends LayoutInterface> implements LayoutBase {
     readonly database: DatabaseBase;
     readonly records: LayoutRecordManager<T>;
     readonly name: string;
-    metadata: any;
+    metadata: ApiLayoutMetadata;
     constructor(database: DatabaseBase, name: string);
     get endpoint(): string;
     /**
@@ -26,5 +26,5 @@ export declare class Layout<T extends LayoutInterface> implements LayoutBase {
      */
     newFind(): Find<T>;
     runScript(script: Script): Promise<ScriptResult>;
-    getLayoutMeta(): Promise<this | FMError>;
+    getLayoutMeta(): Promise<ApiLayoutMetadata>;
 }

package/src/layouts/layout.js

@@ -40,45 +40,31 @@ export class Layout {
         return this.records.find();
     }
     runScript(script) {
-        let trace = new Error();
-        return new Promise((resolve, reject) => __awaiter(this, void 0, void 0, function* () {
+        return __awaiter(this, void 0, void 0, function* () {
             let url = `${this.endpoint}/script/${encodeURIComponent(script.name)}`;
             if (script.parameter)
                 url += "?script.param=" + encodeURIComponent(script.parameter);
-            this.database.apiRequest(url, {
+            let res = yield this.database.apiRequest(url, {
                 port: 443,
                 method: "GET"
-            })
-                .then(res => {
-                if (res.messages[0].code === "0") {
-                    let error = parseInt(res.response.scriptError);
-                    let msg = {
-                        scriptError: error ? new FMError(error, 200, res, trace) : undefined,
-                        scriptResult: res.response.scriptResult
-                    };
-                    resolve(msg);
-                }
-                else {
-                    // console.log(res)
-                    reject(new FMError(res.messages[0].code, res.status, res, trace));
-                }
-            })
-                .catch(e => {
-                reject(e);
             });
-        }));
+            if (res.messages[0].code === "0") {
+                let error = parseInt(res.response.scriptError);
+                return {
+                    scriptError: error ? new FMError(error, 200, res) : undefined,
+                    scriptResult: res.response.scriptResult
+                };
+            }
+        });
     }
     getLayoutMeta() {
-        return new Promise((resolve, reject) => {
+        return __awaiter(this, void 0, void 0, function* () {
             if (this.metadata) {
-                resolve(this.metadata);
-                return;
+                return this.metadata;
             }
-            this.database.apiRequest(this.endpoint).then(res => {
-                this.metadata = res.response;
-                resolve(this);
-            })
-                .catch(e => reject(e));
+            let res = yield this.database.apiRequest(this.endpoint);
+            this.metadata = res.response;
+            return this.metadata;
         });
     }
 }