@jd-data-limited/easy-fm 1.1.3-alpha4 → 1.1.5-alpha1

package/.idea/php.xml

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="MessDetectorOptionsConfiguration">
+    <option name="transferred" value="true" />
+  </component>
+  <component name="PHPCSFixerOptionsConfiguration">
+    <option name="transferred" value="true" />
+  </component>
+  <component name="PHPCodeSnifferOptionsConfiguration">
+    <option name="transferred" value="true" />
+  </component>
+  <component name="PhpStanOptionsConfiguration">
+    <option name="transferred" value="true" />
+  </component>
+  <component name="PsalmOptionsConfiguration">
+    <option name="transferred" value="true" />
+  </component>
+</project>

package/README.md

@@ -1,8 +1,11 @@
 # easy-fm
 
+Making NodeJS + FileMaker easier than ever
+
 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/). This module interacts with your server using the
+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).
 
 ## FileMaker setup instructions
@@ -17,6 +20,10 @@ a [FileMaker server](https://www.claris.com/filemaker/server/). This module inte
 ## Table of contents
 
 1. [Connecting to a database](#connecting-to-a-database)
+    1. [Username and password](#username-and-password)
+    2. [Token](#token)
+    3. [OAuth](#oauth)
+    4. [Claris Account (FileMaker Cloud)](#claris-account--filemaker-cloud-)
 2. [Working with records](#working-with-records)
 3. [Performing find requests](#perform-find-requests)
 4. [Scripts](#scripts)
@@ -31,13 +38,101 @@ FileMaker authentication.
 
 ```javascript
 import fm, {FMError} from "easy-fm"; // Import the module
-const connection = new fm(); // This variable will be used for interacting with the server
-
-connection.login(hostname, database, username, password).then(async token => { // Login
+const connection = new fm(
+    // Connection options (see below)
+);
 
+connection.login().then(token => {
+    // Record operations can only be performed after a successful login
 })
 ```
 
+> **NOTE:** A connection will only give you access to the layouts in the database you are connected to, and not the
+> layouts
+> in
+> the external sources that you have specified.
+>
+> If you need to interact with layouts on multiple databases, you need to open one connection per database.
+
+## Username and password
+
+This method allows you to use a generic FileMaker account to connect to the database.
+
+```javascript
+new fm({
+    hostname: "localhost",
+    database: {
+        database: "MyDatabase", // Do not include the .fmp12 file extension
+        method: "filemaker",
+        username: "node",
+        password: "node123"
+    },
+    externalSources: []
+})
+``` 
+
+**Supports auto relogin?** Yes
+
+## Token
+
+If you have already created a session with the FileMaker Data API, you can use this to import your session.
+
+```javascript
+new fm({
+    hostname: "localhost",
+    database: {
+        database: "MyDatabase", // Do not include the .fmp12 file extension
+        method: "token",
+        token: "API token goes here"
+    },
+    externalSources: []
+})
+``` 
+
+**Supports auto relogin?** No
+
+## OAuth
+
+(untested) If your FileMaker server has OAuth configured, you can login using this method.
+
+```javascript
+new fm({
+    hostname: "localhost",
+    database: {
+        f
+        database: "MyDatabase", // Do not include the .fmp12 file extension
+        method: "oauth",
+        oauth: {
+            requestId: "oauth request ID",
+            requestIdentifier: "oatuh identifier"
+        }
+    },
+    externalSources: []
+})
+``` 
+
+**Supports auto relogin?** No
+
+## Claris Account (FileMaker Cloud)
+
+(untested) If you'd prefer to use a claris account to login, you can
+
+```javascript
+new fm({
+    hostname: "localhost",
+    database: {
+        database: "MyDatabase", // Do not include the .fmp12 file extension
+        method: "claris",
+        fmid: "" // The FileMaker token provided by Claris
+    },
+    externalSources: []
+})
+``` 
+
+Read more [here](https://help.claris.com/en/data-api-guide/content/log-in-database-session-claris-id.html)
+
+**Supports auto relogin?** No
+
 ---
 
 ## Working with records
@@ -49,7 +144,10 @@ use
 let layout = connection.getLayout("layout1") // Get the layout known as 'layout1'
 ```
 
-Once you have the layout, you can perform a multitude of tasks
+Once you have the layout, you can perform tasks on that layout
+
+> **Note:** You will only be able to get and modify fields that are on that layout. If a field is not on the layout, you
+> cannot see or modify it's contents.
 
 ### Get a single record using its RecordID
 
@@ -78,11 +176,10 @@ record.getField("field1").set("This is a value")
 record.getField("field2").set("This is also a value")
 await record.commit()
 ```
+> **NOTE:** A commit will also commit any changes made to portal records.
 
 ### Create a new record
 
-WARNING: The record is not created on the database until a commit is done
-
 ```javascript
 let record = await layout.createRecord()
 record.getField("field1").set("ABC")
@@ -90,6 +187,8 @@ record.getField("field2").set("DEF")
 await record.commit()
 ```
 
+> **WARNING:** The record is *not* created on the database server until a `commit()` step is done.x
+
 ### Downloading container field files
 
 ```javascript
@@ -112,7 +211,6 @@ container.download().then(stream => {
 When uploading files, they should be uploaded as a [Buffer](https://nodejs.org/api/buffer.html) object, along with a
 filename (string) and MIME (also string)
 
-MIME types are not currently automatically detected
 
 ```javascript
 const fs = require("fs")
@@ -129,7 +227,8 @@ container.upload(buffer, filename, mime).then(() => {
     console.log("UPLOAD SUCCESSFUL!")
 })
 ```
-[(Mozilla) Common MIME types](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types)
+
+> Mozilla has a list of common MIME types on their website; [(Mozilla) Common MIME types](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types)
 
 ### Read and modify portal information
 
@@ -155,7 +254,7 @@ for (let _record of portal.records) {
 }
 ```
 
-**WARNING**: Commiting a related portal record will also commit any changes to the parent record as well as any other
+> **WARNING**: Commiting a related portal record will also commit any changes to the parent record as well as any other
 portal records.
 
 ---
@@ -178,7 +277,7 @@ find.addRequests( // Specify the find criteria
 )
 
 find.addSort("CreatedBy", "ascend") // Sort the results in ascending order
-let records = await find.find() // Perform the find
+let records = await find.run() // Perform the find
 console.log(records)
 ```
 
@@ -199,9 +298,6 @@ console.log(result)
 
 ## Classes and methods
 
-
-
-
 ---
 
 ## Index

package/index.js

@@ -143,7 +143,7 @@ export default class FileMakerConnection extends EventEmitter {
     get endpoint() {
         return `https://${this.hostname}/fmi/data/v2/databases/${this.name}`;
     }
-    apiRequest(url, options = {}) {
+    apiRequest(url, options = {}, autoRelogin = true) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!options.headers)
                 options.headers = {};
@@ -152,6 +152,12 @@ export default class FileMakerConnection extends EventEmitter {
             options.rejectUnauthorized = this.rejectUnauthroized;
             let _fetch = yield fetch(url, options);
             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);
+            }
             return data;
         });
     }

package/index.ts

@@ -216,7 +216,7 @@ export default class FileMakerConnection extends EventEmitter {
         return `https://${this.hostname}/fmi/data/v2/databases/${this.name}`
     }
 
-    async apiRequest(url: string | Request, options: any = {}): Promise<any> {
+    async apiRequest(url: string | Request, options: any = {}, autoRelogin = true): Promise<any> {
         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
@@ -224,6 +224,12 @@ export default class FileMakerConnection extends EventEmitter {
 
         let _fetch = await fetch(url, options)
         let data = await _fetch.json()
+        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)
+        }
         return (data as any)
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jd-data-limited/easy-fm",
-  "version": "1.1.3alpha4",
+  "version": "1.1.5alpha1",
   "dependencies": {
     "@types/btoa": "^1.2.3",
     "@types/events": "^3.0.0",