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

package/README.md

@@ -1,27 +1,29 @@
 # easy-fm
 
-Making NodeJS + FileMaker easier than ever
+A [FileMaker Data API](https://help.claris.com/en/data-api-guide/content/index.html) client for NodeJS
 
 easy-fm is a Node.js module that allows you to interact with
-a [FileMaker database](https://www.claris.com/filemaker/) stored on
-a [FileMaker server](https://www.claris.com/filemaker/server/)
+a [FileMaker database](https://www.claris.com/filemaker/) stored on a [FileMaker server](https://www.claris.com/filemaker/server/)
 or [FileMaker Cloud](https://store.claris.com/filemaker-cloud). This module interacts with your server using the
 [FileMaker Data API](https://help.claris.com/en/data-api-guide/content/index.html).
 <!-- TOC -->
+
 * [easy-fm](#easy-fm)
-  * [FileMaker setup instructions](#filemaker-setup-instructions)
-  * [Before you begin](#before-you-begin)
-  * [Connecting to a database](#connecting-to-a-database)
-  * [Getting records](#getting-records)
-    * [Fetch a range of records](#fetch-a-range-of-records)
-    * [Searching for records](#searching-for-records)
-    * [Fetch a record using its record ID (NOT RECOMMENDED)](#fetch-a-record-using-its-record-id-not-recommended)
-    * [Create a record](#create-a-record)
-    * [Modify a record](#modify-a-record)
+    * [FileMaker setup instructions](#filemaker-setup-instructions)
+    * [Before you begin](#before-you-begin)
+    * [Connecting to a database](#connecting-to-a-database)
+    * [Getting records](#getting-records)
+        * [Fetch a range of records](#fetch-a-range-of-records)
+        * [Searching for records](#searching-for-records)
+        * [Fetch a record using its record ID (NOT RECOMMENDED)](#fetch-a-record-using-its-record-id-not-recommended)
+        * [Create a record](#create-a-record)
+        * [Modify a record](#modify-a-record)
 * [Field names](#field-names)
 * [Portal names](#portal-names)
 * [Typescript Implementation](#typescript-implementation)
+
 <!-- TOC -->
+
 ## FileMaker setup instructions
 
 1. Enable the FileMaker Data API from the server's admin console. This setting is located
@@ -34,7 +36,8 @@ or [FileMaker Cloud](https://store.claris.com/filemaker-cloud). This module inte
 ## Before you begin
 
 - You need to know what your server's UTC time offset (in minutes) is.
-    - Running `0 - (new Date()).getTimezoneOffset()` in javascript will give you the UTC time offset for your current timezone.
+    - Running `0 - (new Date()).getTimezoneOffset()` in javascript will give you the UTC time offset for your current
+      timezone.
 
 ## Connecting to a database
 
@@ -77,26 +80,34 @@ One of (if not the) most common interactions you'll need to use is fetching reco
 
 ```javascript
 let layout = database.getLayout("Your layout name")
-let range_request = layout.records.range()
-
-range_request.setOffset(50) // Starting from the 50th record...
-range_request.setLimit(100) // Fetch 100 records
+let query = layout.records.list({
+    portals: {
+        test: {limit: 10, offset: 1} // Include results from the 'test' portal
+    },
+    limit: 10, // Limit result set to 10 records...
+    offset: 30 // ...starting from the 30th record
+})
 
-let records = await range_request.fetch()
+let records = await query.fetch()
 console.log(records)
 ```
 
 ### Searching for records
+Searching for records uses the same syntax as above, but with additional steps to add your search parameters.
 
 ```javascript
 let layout = database.getLayout("Your layout name")
-let find_request = layout.records.find()
+let query = layout.records.list({
+    portals: {
+        test: {limit: 10, offset: 1} // Include results from the 'test' portal
+    },
+    limit: 10, // Limit result set to 10 records...
+    offset: 30 // ...starting from the 30th record
+})
 
-find_request.addRequests({"GroupID": "abc"}) // Find only the records with field GroupID set to 'abc'
-find_request.setOffset(30) // Starting from the 30th matching record
-find_request.setLimit(10) // Fetch only 10 records
+query.addRequest({"GroupID": "=abc"}) // Add a filter
 
-let records = await range_request.fetch()
+let records = await query.fetch()
 console.log(records)
 ```
 
@@ -152,7 +163,8 @@ When interacting with FileMaker, it is important to remember how FileMaker field
 
 > Please read this section carefully if you are working with portals
 
-It is important to note that a portal's name **is not** the same as the name of the table that it links to. The name of a
+It is important to note that a portal's name **is not** the same as the name of the table that it links to. The name of
+a
 portal matches the object name it was assigned in FileMaker's layout editor.
 
 > **NOTE**: When no name has been manually assigned to it, it will default to the name of the related table.

package/package.json

@@ -1,13 +1,9 @@
 {
   "name": "@jd-data-limited/easy-fm",
-  "version": "3.2.7",
+  "version": "4.0.0",
   "dependencies": {
-    "@types/btoa": "^1.2.3",
-    "@types/events": "^3.0.0",
-    "moment": "^2.29.4",
-    "node-fetch": "3.2.8",
-    "typescript": "^5.2.2",
-    "ytdl-core": "^4.11.4"
+    "follow-redirects": "^1.15.5",
+    "moment": "^2.29.4"
   },
   "type": "module",
   "main": "src/index.js",
@@ -16,8 +12,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 +33,15 @@
     "url": "https://github.com/JD-Data-Limited/easy-fm/issues"
   },
   "devDependencies": {
+    "@types/btoa": "^1.2.3",
+    "@types/events": "^3.0.0",
+    "@types/follow-redirects": "^1.14.4",
+    "dotenv": "^16.3.1",
+    "typescript": "^5.3.3",
     "webpack": "^5.81.0",
     "webpack-cli": "^5.0.2"
+  },
+  "engines": {
+    "node": ">=20.9.0"
   }
 }

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

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023. See LICENSE file for more information
+ * Copyright (c) 2023-2024. See LICENSE file for more information
  */
 // @ts-ignore
 export const errs = [
@@ -1013,10 +1013,15 @@ 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);
-        super(errs.find(err => err.e === code).d || "Unknown error");
+        super(errs.find(err => err.e === code)?.d || "Unknown error");
         this.httpStatus = httpStatus;
         this.res = res;
         this.messages = res.messages;

package/src/FMError.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023. See LICENSE file for more information
+ * Copyright (c) 2023-2024. See LICENSE file for more information
  */
 
 // @ts-ignore
@@ -1021,9 +1021,9 @@ 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");
+        super(errs.find(err => err.e === code)?.d || "Unknown error");
         this.httpStatus = httpStatus
         this.res = res
         this.messages = res.messages

package/src/connection/FMHost.d.ts

@@ -1,6 +1,7 @@
 import { Database } from "./database.js";
 import { HostBase } from "./HostBase.js";
-import { databaseOptionsWithExternalSources, DatabaseStructure, FMHostMetadata, loginOptionsClaris, loginOptionsFileMaker, loginOptionsOAuth } from "../types.js";
+import { databaseOptionsWithExternalSources, FMHostMetadata, loginOptionsClaris, loginOptionsFileMaker, loginOptionsOAuth } from "../types.js";
+import { DatabaseStructure } from "../databaseStructure.js";
 export default class FMHost implements HostBase {
     readonly hostname: string;
     readonly timezoneOffset: number;
@@ -9,5 +10,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,14 @@
 /*
- * Copyright (c) 2023. See LICENSE file for more information
+ * Copyright (c) 2023-2024. 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 +16,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

@@ -1,20 +1,20 @@
 /*
- * Copyright (c) 2023. See LICENSE file for more information
+ * Copyright (c) 2023-2024. See LICENSE file for more information
  */
 
 import {generateAuthorizationHeaders} from "./generateAuthorizationHeaders.js";
-import fetch from "node-fetch";
 import {FMError} from "../FMError.js";
 import {Database} from "./database.js";
 import {HostBase} from "./HostBase.js"
 import {
-    databaseOptionsWithExternalSources, DatabaseStructure,
-    fileMakerResponse,
+    databaseOptionsWithExternalSources,
     FMHostMetadata,
     loginOptionsClaris,
     loginOptionsFileMaker,
     loginOptionsOAuth
 } from "../types.js";
+import {ApiResults} from "../models/apiResults.js";
+import {DatabaseStructure} from "../databaseStructure.js";
 
 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/HostBase.d.ts

@@ -1,4 +1,4 @@
-import { FMHostMetadata } from "../types";
+import { FMHostMetadata } from "../types.js";
 export interface HostBase {
     readonly hostname: string;
     readonly timezoneOffset: number;

package/src/connection/HostBase.js

@@ -1,4 +1,4 @@
 /*
- * Copyright (c) 2023. See LICENSE file for more information
+ * Copyright (c) 2023-2024. See LICENSE file for more information
  */
 export {};

package/src/connection/HostBase.ts

@@ -1,10 +1,8 @@
 /*
- * Copyright (c) 2023. See LICENSE file for more information
+ * Copyright (c) 2023-2024. See LICENSE file for more information
  */
 
-import {
-    FMHostMetadata
-} from "../types";
+import {FMHostMetadata} from "../types.js";
 
 export interface HostBase {
     readonly hostname: string

package/src/connection/database.d.ts

@@ -1,12 +1,14 @@
-/// <reference types="node" />
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
 import { EventEmitter } from "events";
-import { Request } from "node-fetch";
 import { LayoutInterface } from "../layouts/layoutInterface.js";
 import { Layout } from "../layouts/layout.js";
-import HTTP_REDIRECT from "follow-redirects";
-import { databaseOptionsWithExternalSources, DatabaseStructure, Script } from "../types.js";
+import { databaseOptionsWithExternalSources, Script } from "../types.js";
 import { HostBase } from "./HostBase.js";
-import { DatabaseBase } from "./databaseBase";
+import { DatabaseBase } from "./databaseBase.js";
+import { ApiResults } from "../models/apiResults.js";
+import { DatabaseStructure } from "../databaseStructure.js";
+import { IncomingMessage } from "http";
 export declare class Database<T extends DatabaseStructure> extends EventEmitter implements DatabaseBase {
     private _token;
     readonly host: HostBase;
@@ -16,14 +18,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>;
-    getLayout<R extends string>(name: R): Layout<T["layouts"][R]>;
+    apiRequest<T = any>(url: string | Request, options?: any, autoRelogin?: boolean): Promise<ApiResults<T>>;
+    listLayouts(): Promise<Layout<LayoutInterface>[]>;
+    getLayout<R extends keyof T["layouts"]>(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<IncomingMessage>;
 }