@jd-data-limited/easy-fm 3.2.6 → 3.2.8

package/package.json

@@ -1,13 +1,12 @@
 {
   "name": "@jd-data-limited/easy-fm",
-  "version": "3.2.6",
+  "version": "3.2.8",
   "dependencies": {
     "@types/btoa": "^1.2.3",
     "@types/events": "^3.0.0",
+    "follow-redirects": "^1.15.3",
     "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 +15,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,7 +36,9 @@
     "url": "https://github.com/JD-Data-Limited/easy-fm/issues"
   },
   "devDependencies": {
+    "typescript": "^5.2.2",
     "webpack": "^5.81.0",
-    "webpack-cli": "^5.0.2"
+    "webpack-cli": "^5.0.2",
+    "dotenv": "^16.3.1"
   }
 }

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.js

@@ -1013,6 +1013,11 @@ export const errs = [
     }
 ];
 export class FMError extends Error {
+    httpStatus;
+    res;
+    code;
+    message;
+    messages;
     constructor(code, httpStatus, res, trace) {
         if (typeof code === "string")
             code = parseInt(code);

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.js

@@ -1,20 +1,15 @@
 /*
  * Copyright (c) 2023. See LICENSE file for more information
  */
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 import { generateAuthorizationHeaders } from "./generateAuthorizationHeaders.js";
 import fetch from "node-fetch";
 import { FMError } from "../FMError.js";
 import { Database } from "./database.js";
 export default class FMHost {
+    hostname;
+    timezoneOffset;
+    verify;
+    metadata;
     constructor(_hostname, timezoneOffset = 0 - (new Date()).getTimezoneOffset(), verify = true) {
         if (!(/^https?:\/\//).test(_hostname))
             throw "hostname MUST begin with either http:// or https://";
@@ -22,47 +17,43 @@ export default class FMHost {
         this.timezoneOffset = timezoneOffset;
         this.verify = verify;
     }
-    listDatabases(credentials) {
-        return __awaiter(this, void 0, void 0, function* () {
-            let headers = {};
-            if (credentials) {
-                headers = generateAuthorizationHeaders(credentials);
-            }
-            let _fetch = yield fetch(`${this.hostname}/fmi/data/v2/databases`, {
-                method: "GET",
-                headers
-            });
-            let data = yield _fetch.json();
-            // console.log(data.messages[0])
-            if (data.messages[0].code === "0") {
-                return data.response.databases;
-            }
-            else {
-                // @ts-ignore
-                throw new FMError(data.messages[0].code, data.status, data);
-            }
+    async listDatabases(credentials) {
+        let headers = {};
+        if (credentials) {
+            headers = generateAuthorizationHeaders(credentials);
+        }
+        let _fetch = await fetch(`${this.hostname}/fmi/data/v2/databases`, {
+            method: "GET",
+            headers
         });
+        let data = await _fetch.json();
+        // console.log(data.messages[0])
+        if (data.messages[0].code === "0") {
+            return data.response.databases;
+        }
+        else {
+            // @ts-ignore
+            throw new FMError(data.messages[0].code, data.status, data);
+        }
     }
     database(data) {
         return new Database(this, data);
     }
-    getMetadata() {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (this.metadata)
-                return this.metadata;
-            let _fetch = yield fetch(`${this.hostname}/fmi/data/v2/productInfo`, {
-                method: "GET",
-            });
-            let data = yield _fetch.json();
-            // console.log(data.messages[0])
-            if (data.messages[0].code === "0") {
-                this.metadata = data.response;
-                return data.response;
-            }
-            else {
-                // @ts-ignore
-                throw new FMError(data.messages[0].code, data.status, data);
-            }
+    async getMetadata() {
+        if (this.metadata)
+            return this.metadata;
+        let _fetch = await fetch(`${this.hostname}/fmi/data/v2/productInfo`, {
+            method: "GET",
         });
+        let data = await _fetch.json();
+        // console.log(data.messages[0])
+        if (data.messages[0].code === "0") {
+            this.metadata = data.response;
+            return data.response;
+        }
+        else {
+            // @ts-ignore
+            throw new FMError(data.messages[0].code, data.status, data);
+        }
     }
 }

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

@@ -1,15 +1,6 @@
 /*
  * Copyright (c) 2023. See LICENSE file for more information
  */
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 import { EventEmitter } from "events";
 import fetch from "node-fetch";
 import { generateAuthorizationHeaders } from "./generateAuthorizationHeaders.js";
@@ -17,9 +8,13 @@ import { FMError } from "../FMError.js";
 import { Layout } from "../layouts/layout.js";
 import HTTP_REDIRECT from "follow-redirects";
 export class Database extends EventEmitter {
+    _token;
+    host;
+    connection_details;
+    cookies = {};
+    name;
     constructor(host, conn) {
         super();
-        this.cookies = {};
         this.host = host;
         this.name = conn.database;
         this.connection_details = conn;
@@ -37,66 +32,53 @@ export class Database extends EventEmitter {
             throw "Not yet supported login method";
         }
     }
-    logout() {
-        return new Promise((resolve, reject) => __awaiter(this, void 0, void 0, function* () {
-            if (!this.token)
-                reject(new Error("Not logged in"));
-            let _fetch = yield fetch(`${this.endpoint}/sessions/${this.token}`, {
-                method: "DELETE",
-                headers: {
-                    "content-type": "application/json"
-                }
-            });
-            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* () {
-            // Reset cookies
-            this.cookies = {};
-            try {
-                yield this.host.getMetadata();
-            }
-            catch (e) {
-                reject(e);
-                return;
+    async logout() {
+        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"
             }
-            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);
+        });
+        let data = await _fetch.json();
+        // console.log(data)
+        this._token = null;
+    }
+    async login() {
+        // Reset cookies
+        this.cookies = {};
+        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 = 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),
+                body: JSON.stringify({
+                    fmDataSource: this.connection_details.externalSources.map(i => {
+                        let _i = i;
+                        return this.generateExternalSourceLogin(_i);
+                    })
+                })
+            });
+            console.time();
+            let _res = (await res.json());
+            if (res.status === 200) {
+                this._token = res.headers.get('x-fm-data-access-token');
+                return this._token;
             }
             else {
-                fetch(`${this.endpoint}/sessions`, {
-                    hostname: this.host.hostname,
-                    port: 443,
-                    method: "POST",
-                    headers: generateAuthorizationHeaders(this.connection_details.credentials),
-                    body: JSON.stringify({
-                        fmDataSource: this.connection_details.externalSources.map(i => {
-                            let _i = i;
-                            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);
-                });
+                throw new FMError(_res.messages[0].code, _res.status, res);
             }
-        }));
+        }
     }
     get token() {
         return this._token;
@@ -104,51 +86,52 @@ export class Database extends EventEmitter {
     get endpoint() {
         return `${this.host.hostname}/fmi/data/v2/databases/${this.name}`;
     }
-    apiRequest(url, options = {}, autoRelogin = true) {
-        return __awaiter(this, void 0, void 0, function* () {
-            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;
-            options.rejectUnauthorized = this.host.verify;
-            let _fetch = yield fetch(url, options);
-            if (_fetch.headers.get('set-cookie')) {
-                for (let cookie of _fetch.headers.get('set-cookie')) {
-                    let cookie_split = cookie.split("=");
-                    this.cookies[cookie_split[0]] = cookie_split[1];
-                }
-            }
-            let data = yield _fetch.json();
-            // console.log(data.messages[0])
-            if (data.messages[0].code == 952 && autoRelogin) {
-                this._token = null;
-                yield this.login();
-                return yield this.apiRequest(url, options, false);
+    async apiRequest(url, options = {}, autoRelogin = true) {
+        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;
+        options.rejectUnauthorized = this.host.verify;
+        let _fetch = await fetch(url, options);
+        if (_fetch.headers.get('set-cookie')) {
+            for (let cookie of _fetch.headers.get('set-cookie')) {
+                let cookie_split = cookie.split("=");
+                this.cookies[cookie_split[0]] = cookie_split[1];
             }
-            return data;
-        });
+        }
+        let data = await _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) {
+            this._token = null;
+            await this.login();
+            return await 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;
+    }
+    async listLayouts() {
+        let req = await 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);
     }
-    setGlobals(globalFields) {
+    /*
+    @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 })
         });
     }
     script(name, parameter = "") {
@@ -157,15 +140,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) {