@jd-data-limited/easy-fm 4.0.7 → 4.0.9

package/README.md

@@ -1,30 +1,38 @@
-# easy-fm
+# Introduction
 
-A [FileMaker Data API](https://help.claris.com/en/data-api-guide/content/index.html) client for NodeJS
+A FileMaker Data API 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/)
-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 -->
+a FileMaker database stored on a FileMaker server
+or FileMaker Cloud. This module interacts with your server using the
+FileMaker Data API.
+
+# Contents
 
-* [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)
+<!-- TOC -->
+* [Introduction](#introduction)
+* [Contents](#contents)
+* [Installation](#installation)
+* [Usage](#usage)
+  * [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
+# Installation
+
+```npm
+npm install @jd-data-limited/easy-fm --save
+```
+
+easy-fm also requires the following to be configured within your FileMaker enviroment:
 
 1. Enable the FileMaker Data API from the server's admin console. This setting is located
    in `Connectors > FileMaker Data API`.
@@ -33,7 +41,7 @@ or [FileMaker Cloud](https://store.claris.com/filemaker-cloud). This module inte
 
 ---
 
-## Before you begin
+# Usage
 
 - 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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jd-data-limited/easy-fm",
-  "version": "4.0.7",
+  "version": "4.0.9",
   "dependencies": {
     "follow-redirects": "^1.15.5",
     "@types/follow-redirects": "^1.14.4",

package/src/connection/database.d.ts

@@ -18,11 +18,11 @@ export declare class Database<T extends DatabaseStructure> extends EventEmitter
     constructor(host: HostBase, conn: databaseOptionsWithExternalSources);
     private generateExternalSourceLogin;
     logout(): Promise<void>;
-    login(): Promise<any>;
+    login(forceLogin?: boolean): Promise<any>;
     get token(): any;
     get endpoint(): string;
-    apiRequestRaw(url: string | Request, options?: any): Promise<Response>;
-    apiRequestJSON<T = any>(url: string | Request, options?: any, autoRelogin?: boolean): Promise<ApiResults<T>>;
+    apiRequestRaw(url: string | Request, options?: any, autoRelogin?: boolean): Promise<Response>;
+    apiRequestJSON<T = any>(url: string | Request, options?: any): 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>;

package/src/connection/database.js

@@ -44,11 +44,11 @@ export class Database extends EventEmitter {
         // console.log(data)
         this._token = null;
     }
-    async login() {
+    async login(forceLogin = false) {
         // Reset cookies
         this.cookies = {};
         await this.host.getMetadata();
-        if (this.token)
+        if (this.token && !forceLogin)
             throw new Error("Already logged in. Run logout() first");
         if (this.connection_details.credentials.method === "token") {
             this._token = this.connection_details.credentials.token;
@@ -85,10 +85,11 @@ export class Database extends EventEmitter {
     get endpoint() {
         return `${this.host.hostname}/fmi/data/v2/databases/${this.name}`;
     }
-    async apiRequestRaw(url, options = {}) {
+    async apiRequestRaw(url, options = {}, autoRelogin = true) {
+        if (!this.token)
+            await this.login(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);
@@ -98,21 +99,23 @@ export class Database extends EventEmitter {
                 this.cookies[cookie_split[0]] = cookie_split[1];
             }
         }
+        if (_fetch.status === 401 && autoRelogin) {
+            await this.login(true);
+            return await this.apiRequestRaw(url, options, false);
+        }
         return _fetch;
     }
-    async apiRequestJSON(url, options = {}, autoRelogin = true) {
+    async apiRequestJSON(url, options = {}) {
+        if (!options.headers)
+            options.headers = {};
+        options.headers["content-type"] = options.headers["content-type"] ? options.headers["content-type"] : "application/json";
         let _fetch = await this.apiRequestRaw(url, options);
         let data = await _fetch.json();
         // Remove response if it is empty. This makes checking for an empty response easier
         if (data.response && 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.apiRequestJSON(url, options, false);
-        }
-        else if (data.messages[0].code !== "0") {
+        if (data.messages[0].code !== "0") {
             throw new FMError(data.messages[0].code, _fetch.status, data);
         }
         data.httpStatus = _fetch.status;

package/src/connection/database.ts

@@ -65,12 +65,12 @@ export class Database<T extends DatabaseStructure> extends EventEmitter implemen
         this._token = null
     }
 
-    async login() {
+    async login(forceLogin = false) {
         // Reset cookies
         this.cookies = {}
 
         await this.host.getMetadata()
-        if (this.token) throw new Error("Already logged in. Run logout() first")
+        if (this.token && !forceLogin) throw new Error("Already logged in. Run logout() first")
 
         if (this.connection_details.credentials.method === "token") {
             this._token = (<loginOptionsToken>this.connection_details.credentials).token
@@ -110,9 +110,10 @@ export class Database<T extends DatabaseStructure> extends EventEmitter implemen
         return `${this.host.hostname}/fmi/data/v2/databases/${this.name}`
     }
 
-    async apiRequestRaw(url: string | Request, options: any = {}) {
+    async apiRequestRaw(url: string | Request, options: any = {}, autoRelogin = true): Promise<Response> {
+        if (!this.token) await this.login(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
 
@@ -123,9 +124,16 @@ export class Database<T extends DatabaseStructure> extends EventEmitter implemen
                 this.cookies[cookie_split[0]] = cookie_split[1]
             }
         }
+
+        if (_fetch.status === 401 && autoRelogin) {
+            await this.login(true)
+            return await this.apiRequestRaw(url, options, false)
+        }
         return _fetch
     }
-    async apiRequestJSON<T = any>(url: string | Request, options: any = {}, autoRelogin = true): Promise<ApiResults<T>> {
+    async apiRequestJSON<T = any>(url: string | Request, options: any = {}): Promise<ApiResults<T>> {
+        if (!options.headers) options.headers = {}
+        options.headers["content-type"] = options.headers["content-type"] ? options.headers["content-type"] : "application/json"
         let _fetch = await this.apiRequestRaw(url, options)
         let data = await _fetch.json() as ApiResults<T>
 
@@ -133,12 +141,7 @@ export class Database<T extends DatabaseStructure> extends EventEmitter implemen
         if (data.response && 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.apiRequestJSON(url, options, false)
-        }
-        else if (data.messages[0].code !== "0") {
+        if (data.messages[0].code !== "0") {
             throw new FMError(data.messages[0].code, _fetch.status, data)
         }
 

package/src/index.d.ts

@@ -10,9 +10,9 @@ import { LayoutInterface, PortalInterface } from "./layouts/layoutInterface.js";
 import { PortalRecord } from "./records/portalRecord.js";
 import { Portal } from "./records/portal.js";
 import { Container, FieldBase } from "./records/fieldBase.js";
-import { RecordGetOperation } from "./records/getOperations/recordGetOperation.js";
+import { FindRequest, 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";
 export default FMHost;
-export { FMError, TYPES, Database, Layout, RecordBase, LayoutRecord, LayoutInterface, RecordFieldsMap, PortalInterface, PortalRecord, Portal, FieldBase, RecordGetOperation, LayoutRecordManager, Container, PickPortals, query, queryEscape };
+export { FMError, TYPES, Database, Layout, RecordBase, LayoutRecord, LayoutInterface, RecordFieldsMap, PortalInterface, PortalRecord, Portal, FieldBase, RecordGetOperation, LayoutRecordManager, Container, PickPortals, FindRequest, query, queryEscape };

package/src/index.ts

@@ -14,7 +14,7 @@ import {LayoutInterface, PortalInterface} from "./layouts/layoutInterface.js";
 import {PortalRecord} from "./records/portalRecord.js";
 import {Portal} from "./records/portal.js";
 import {Container, FieldBase} from "./records/fieldBase.js";
-import {RecordGetOperation} from "./records/getOperations/recordGetOperation.js";
+import {FindRequest, 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";
@@ -37,6 +37,7 @@ export {
     LayoutRecordManager,
     Container,
     PickPortals,
+    FindRequest,
     query,
     queryEscape
 }

package/src/records/fieldBase.js

@@ -123,7 +123,6 @@ export class FieldBase {
         let res = await this.parent.layout.database.apiRequestRaw(`${this.parent.endpoint}/containers/${this.id}/1`, {
             method: "POST",
             // @ts-ignore
-            headers: { "Authorization": "Bearer " + this.parent.layout.database.token },
             body: form
         });
         if (!res.ok)

package/src/records/fieldBase.ts

@@ -139,7 +139,6 @@ export class FieldBase<T extends FieldValue> {
         let res = await this.parent.layout.database.apiRequestRaw(`${this.parent.endpoint}/containers/${this.id}/1`, {
             method: "POST",
             // @ts-ignore
-            headers: {"Authorization": "Bearer " + this.parent.layout.database.token},
             body: form
         })
         if (!res.ok) throw new Error(`Upload failed with HTTP error: ${res.status} (${res.statusText})`)

package/src/records/getOperations/recordGetOperation.d.ts

@@ -2,9 +2,10 @@ import { LayoutInterface } from "../../layouts/layoutInterface.js";
 import { PickPortals, ScriptRequestData } from "../../types.js";
 import { LayoutBase } from "../../layouts/layoutBase.js";
 import { LayoutRecord } from "../layoutRecord.js";
+import { Query } from "../../utils/query.js";
 export type SortOrder = "ascend" | "descend";
 export type FindRequest = {
-    [key: string]: string;
+    [key: string]: Query;
 } & {
     omit?: "true" | "false";
 };
@@ -35,6 +36,7 @@ export declare class RecordGetOperation<T extends LayoutInterface, OPTIONS exten
     protected queries: FindRequest[];
     constructor(layout: LayoutBase, options: OPTIONS);
     get isFindRequest(): boolean;
+    private formatQueries;
     protected generateParamsBody(offset: number, limit: number): {
         [key: string]: any;
     };

package/src/records/getOperations/recordGetOperation.js

@@ -3,6 +3,7 @@
  */
 import { LayoutRecord } from "../layoutRecord.js";
 import { FMError } from "../../FMError.js";
+import { FindRequestSymbol } from "../../utils/query.js";
 export class RecordGetOperation {
     layout;
     limit = 100;
@@ -21,6 +22,19 @@ export class RecordGetOperation {
     get isFindRequest() {
         return this.queries.length !== 0;
     }
+    formatQueries() {
+        return this.queries.map(query => {
+            let out = {};
+            for (let key of Object.keys(query)) {
+                if (query[key][FindRequestSymbol])
+                    out[key] = query[key][FindRequestSymbol];
+                else {
+                    out[key] = query[key];
+                }
+            }
+            return out;
+        });
+    }
     generateParamsBody(offset, limit) {
         const params = {
             limit: limit.toString(),
@@ -41,7 +55,7 @@ export class RecordGetOperation {
         if (this.scriptData.prerequest?.parameter)
             params["script.prerequest.param"] = this.scriptData.prerequest.parameter;
         if (this.queries.length !== 0)
-            params["query"] = this.queries;
+            params["query"] = this.formatQueries();
         let portals = Object.keys(this.portals);
         params["portal"] = portals;
         for (let portal of portals) {

package/src/records/getOperations/recordGetOperation.ts

@@ -8,10 +8,11 @@ import {LayoutBase} from "../../layouts/layoutBase.js"
 import {LayoutRecord} from "../layoutRecord.js";
 import {ApiRecordResponseObj} from "../../models/apiResults.js";
 import {FMError} from "../../FMError.js";
+import {FindRequestSymbol, Query} from "../../utils/query.js";
 
 export type SortOrder = "ascend" | "descend"
 export type FindRequest = {
-    [key: string]: string,
+    [key: string]: Query
 } & {omit?: "true" | "false"}
 
 export type PortalRequest = {
@@ -51,6 +52,17 @@ export class RecordGetOperation<T extends LayoutInterface, OPTIONS extends GetOp
         return this.queries.length !== 0
     }
 
+    private formatQueries() {
+        return this.queries.map(query => {
+            let out: any = {}
+            for (let key of Object.keys(query)) {
+                if (query[key][FindRequestSymbol]) out[key] = query[key][FindRequestSymbol]
+                else {out[key] = query[key]}
+            }
+            return out
+        })
+    }
+
     protected generateParamsBody(offset: number, limit: number) {
         const params: {[key: string]: any} = {
             limit: limit.toString(),
@@ -68,7 +80,7 @@ export class RecordGetOperation<T extends LayoutInterface, OPTIONS extends GetOp
         if (this.scriptData.prerequest) params["script.prerequest"] = this.scriptData.prerequest.name
         if (this.scriptData.prerequest?.parameter) params["script.prerequest.param"] = this.scriptData.prerequest.parameter
 
-        if (this.queries.length !== 0) params["query"] = this.queries
+        if (this.queries.length !== 0) params["query"] = this.formatQueries()
 
         let portals: (keyof typeof this.portals)[] = Object.keys(this.portals)
         params["portal"] = portals

package/src/utils/query.d.ts

@@ -1,4 +1,10 @@
+export declare const FindRequestSymbol: unique symbol;
 type QueryParameter = string | number | Date;
+export type Query = {
+    [FindRequestSymbol]: string;
+};
 export declare function queryEscape(str: string): string;
-export declare function query(strings: TemplateStringsArray, ...args: QueryParameter[]): string;
+export declare function query(strings: TemplateStringsArray, ...args: QueryParameter[]): {
+    [FindRequestSymbol]: string;
+};
 export {};

package/src/utils/query.js

@@ -1,6 +1,7 @@
 /*
  * Copyright (c) 2024. See LICENSE file for more information
  */
+export const FindRequestSymbol = Symbol("easyfm-findrequest");
 const SPECIAL_CHARACTERS = ["\\", "=", "<", "≤", "≥", ">", "…", "...", "//", "@", "#", "*", "\"", "~"];
 export function queryEscape(str) {
     for (let char of SPECIAL_CHARACTERS) {
@@ -16,5 +17,5 @@ export function query(strings, ...args) {
     const query = strings.map((str, index) => {
         return str + (argStrings[index] || '');
     });
-    return query.join("");
+    return { [FindRequestSymbol]: query.join("") };
 }

package/src/utils/query.ts

@@ -2,8 +2,10 @@
  * Copyright (c) 2024. See LICENSE file for more information
  */
 
+export const FindRequestSymbol = Symbol("easyfm-findrequest");
 const SPECIAL_CHARACTERS = ["\\", "=", "<", "≤", "≥", ">", "…", "...", "//", "@", "#", "*", "\"", "~"]
 type QueryParameter = string | number | Date
+export type Query = {[FindRequestSymbol]: string}
 
 export function queryEscape(str: string) {
     for (let char of SPECIAL_CHARACTERS) {
@@ -21,5 +23,5 @@ export function query(strings: TemplateStringsArray, ...args: QueryParameter[])
     const query = strings.map((str, index) => {
         return str + (argStrings[index] || '')
     })
-    return query.join("")
+    return {[FindRequestSymbol]: query.join("")}
 }

package/src/utils/fmQuery.d.ts

@@ -1,4 +0,0 @@
-type QueryParameter = string | number | Date;
-export declare function fmQueryEscape(str: string): string;
-export declare function fmQuery(strings: TemplateStringsArray, ...args: QueryParameter[]): string;
-export {};

package/src/utils/fmQuery.js

@@ -1,20 +0,0 @@
-/*
- * Copyright (c) 2024. See LICENSE file for more information
- */
-const SPECIAL_CHARACTERS = ["\\", "=", "<", "≤", "≥", ">", "…", "...", "//", "@", "#", "*", "\"", "~"];
-export function fmQueryEscape(str) {
-    for (let char of SPECIAL_CHARACTERS) {
-        str = str.replace(char, `\\${char}`);
-    }
-    return str;
-}
-export function fmQuery(strings, ...args) {
-    let argStrings = args.map(item => {
-        return fmQueryEscape(item.toString());
-    });
-    // Zip the parameters together
-    const query = strings.map((str, index) => {
-        return str + (args[index] || '');
-    });
-    return query.join("");
-}