@jd-data-limited/easy-fm 0.0.7 → 0.0.8

package/.idea/easy-fm.iml

@@ -1,8 +1,8 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<module type="WEB_MODULE" version="4">
-  <component name="NewModuleRootManager">
-    <content url="file://$MODULE_DIR$" />
-    <orderEntry type="inheritedJdk" />
-    <orderEntry type="sourceFolder" forTests="false" />
-  </component>
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="WEB_MODULE" version="4">
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$" />
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
 </module>

package/.idea/modules.xml

@@ -1,8 +1,8 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectModuleManager">
-    <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/easy-fm.iml" filepath="$PROJECT_DIR$/.idea/easy-fm.iml" />
-    </modules>
-  </component>
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/easy-fm.iml" filepath="$PROJECT_DIR$/.idea/easy-fm.iml" />
+    </modules>
+  </component>
 </project>

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/.idea/vcs.xml

@@ -1,6 +1,6 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="VcsDirectoryMappings">
-    <mapping directory="$PROJECT_DIR$" vcs="Git" />
-  </component>
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="" vcs="Git" />
+  </component>
 </project>

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2022 JD-Data-Limited
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2022 JD-Data-Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,193 +1,212 @@
-# easy-fm
-
-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
-[FileMaker Data API](https://help.claris.com/en/data-api-guide/content/index.html).
-
-## FileMaker setup instructions
-
-1. Enable the FileMaker Data API from the server's admin console. This setting is located
-   in `Connectors > FileMaker Data API`.
-2. Create a FileMaker database account for easy-fm to use. This account must have the 'Access via FileMaker Data API (
-   fmrest)' extended privilege
-
-## Table of contents
-
-1. [Connecting to a database](#connecting-to-a-database)
-2. [Working with records](#working-with-records)
-3. [Performing find requests](#perform-find-requests)
-4. [Scripts](#scripts)
-5. [Index](#index)
-
-## Connecting to a database
-
-easy-fm currently does not support connecting to external data sources, or authenticating by any method other than plain
-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
-
-})
-```
-
-## Working with records
-
-When running scripts or interacting with records, the first step that you need to do is get the layout that you want to
-use
-
-```javascript
-let layout = connection.getLayout("layout1") // Get the layout known as 'layout1'
-```
-
-Once you have the layout, you can perform a multitude of tasks
-
-### Get a single record using its RecordID
-
-[What's a RecordID?](#recordid)
-
-```javascript
-let record_id = 1
-let record = layout.getRecord(record_id)
-
-await record.get() // The 'getRecord' method does not automatically get that record's values, so this step does that instead
-
-let field = record.getField("field1")
-console.log(field.value) // Get the value of 'field1'
-```
-
-### Modify a record
-
-WARNING: The commit step is mandatory. Otherwise the changes will never be uploaded
-
-```javascript
-let record_id = 1
-let record = layout.getRecord(record_id)
-
-await record.get() // The 'getRecord' method does not automatically get that record's values, so this step does that instead
-record.getField("field1").set("This is a value")
-record.getField("field2").set("This is also a value")
-await record.commit()
-```
-
-### 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")
-record.getField("field2").set("DEF")
-await record.commit()
-```
-
-### Downloading container field files
-
-```javascript
-let record_id = 1
-let record = layout.getRecord(record_id)
-
-await record.get() // The 'getRecord' method does not automatically get that record's values, so this step does that instead
-
-let container = record.getField("container")
-container.download().then(stream => {
-    // Returns an IncomingMessage, which is an extension of ReadableStream
-})
-```
-
-[IncomingMessage](https://nodejs.org/api/http.html#class-httpincomingmessage)
-, [ReadableStream](https://nodejs.org/api/stream.html#class-streamreadable)
-
-### Uploading container files
-
-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")
-let filename = "image.jpg"
-let buffer = fs.readdirSync("./" + filename)
-let mime = "image/jpeg"
-
-let record_id = 1
-let record = layout.getRecord(record_id)
-await record.get() // The 'getRecord' method does not automatically get that record's values, so this step does that instead
-
-let container = record.getField("container")
-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)
-
-### Read and modify portal information
-
-To be able to read portal information for a record, you'll need to put a portal on the layout you are using. Make sure
-you also:
-
-- Give the portal object a name
-- Include the exact fields you need in the portal. Any fields you leave out will not be accessible by node.js, and
-  putting extra fields in is not a good idea.
-
-```javascript
-let record = layout.getRecord(1)
-
-// Portal data is downloaded when the record is fetched
-await record.get()
-let portal = record.getPortal("Portal1")
-
-for (let _record of portal.records) {
-    // Runs for all records in the portal
-    let field = _record.getField("field2")
-    console.log(field.value)
-    field.set("GHI")
-}
-```
-
-**WARNING**: Commiting a related portal record will also commit any changes to the parent record as well as any other
-portal records.
-
-## Perform find requests
-
-Performing find requests is one of the most common database operations
-
-![img.png](img.png)
-
-The image above is how the find request would look when doing it in a FileMaker script. This should hopefully help you
-understand how the find request process works.
-
-```javascript
-let find = layout.newFind() // Create a new find operation
-
-find.addRequests( // Specify the find criteria
-    {"PrimaryKey": "AAAAA", "ModifiedBy": "BBBB"},
-    {"CreatedBy": "BBBB"}
-)
-
-find.addSort("CreatedBy", "ascend") // Sort the results in ascending order
-let records = await find.find() // Perform the find
-console.log(records)
-```
-
-### Scripts
-
-Running scripts is another operation you may need to do regularly. This one is fairly straight-forward in how it works
-
-```javascript
-let layout = connection.getLayout("layout1")
-let script = connection.script("MyFileMakerScript", "This is a parameter")
-let result = await layout.runScript(script)
-console.log(result)
-```
-
-## Index
-
-### RecordID
-
-This is not a custom field that can be set and/or changed. You can get a record's ID from within FileMaker by
+# easy-fm
+
+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
+[FileMaker Data API](https://help.claris.com/en/data-api-guide/content/index.html).
+
+## FileMaker setup instructions
+
+1. Enable the FileMaker Data API from the server's admin console. This setting is located
+   in `Connectors > FileMaker Data API`.
+2. Create a FileMaker database account for easy-fm to use. This account must have the 'Access via FileMaker Data API (
+   fmrest)' extended privilege
+
+---
+
+## Table of contents
+
+1. [Connecting to a database](#connecting-to-a-database)
+2. [Working with records](#working-with-records)
+3. [Performing find requests](#perform-find-requests)
+4. [Scripts](#scripts)
+5. [Index](#index)
+
+---
+
+## Connecting to a database
+
+easy-fm currently does not support connecting to external data sources, or authenticating by any method other than plain
+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
+
+})
+```
+
+---
+
+## Working with records
+
+When running scripts or interacting with records, the first step that you need to do is get the layout that you want to
+use
+
+```javascript
+let layout = connection.getLayout("layout1") // Get the layout known as 'layout1'
+```
+
+Once you have the layout, you can perform a multitude of tasks
+
+### Get a single record using its RecordID
+
+[What's a RecordID?](#recordid)
+
+```javascript
+let record_id = 1
+let record = layout.getRecord(record_id)
+
+await record.get() // The 'getRecord' method does not automatically get that record's values, so this step does that instead
+
+let field = record.getField("field1")
+console.log(field.value) // Get the value of 'field1'
+```
+
+### Modify a record
+
+WARNING: The commit step is mandatory. Otherwise the changes will never be uploaded
+
+```javascript
+let record_id = 1
+let record = layout.getRecord(record_id)
+
+await record.get() // The 'getRecord' method does not automatically get that record's values, so this step does that instead
+record.getField("field1").set("This is a value")
+record.getField("field2").set("This is also a value")
+await record.commit()
+```
+
+### 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")
+record.getField("field2").set("DEF")
+await record.commit()
+```
+
+### Downloading container field files
+
+```javascript
+let record_id = 1
+let record = layout.getRecord(record_id)
+
+await record.get() // The 'getRecord' method does not automatically get that record's values, so this step does that instead
+
+let container = record.getField("container")
+container.download().then(stream => {
+    // Returns an IncomingMessage, which is an extension of ReadableStream
+})
+```
+
+[IncomingMessage](https://nodejs.org/api/http.html#class-httpincomingmessage)
+, [ReadableStream](https://nodejs.org/api/stream.html#class-streamreadable)
+
+### Uploading container files
+
+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")
+let filename = "image.jpg"
+let buffer = fs.readdirSync("./" + filename)
+let mime = "image/jpeg"
+
+let record_id = 1
+let record = layout.getRecord(record_id)
+await record.get() // The 'getRecord' method does not automatically get that record's values, so this step does that instead
+
+let container = record.getField("container")
+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)
+
+### Read and modify portal information
+
+To be able to read portal information for a record, you'll need to put a portal on the layout you are using. Make sure
+you also:
+
+- Give the portal object a name
+- Include the exact fields you need in the portal. Any fields you leave out will not be accessible by node.js, and
+  putting extra fields in is not a good idea.
+
+```javascript
+let record = layout.getRecord(1)
+
+// Portal data is downloaded when the record is fetched
+await record.get()
+let portal = record.getPortal("Portal1")
+
+for (let _record of portal.records) {
+    // Runs for all records in the portal
+    let field = _record.getField("field2")
+    console.log(field.value)
+    field.set("GHI")
+}
+```
+
+**WARNING**: Commiting a related portal record will also commit any changes to the parent record as well as any other
+portal records.
+
+---
+
+## Perform find requests
+
+Performing find requests is one of the most common database operations
+
+![img.png](img.png)
+
+The image above is how the find request would look when doing it in a FileMaker script. This should hopefully help you
+understand how the find request process works.
+
+```javascript
+let find = layout.newFind() // Create a new find operation
+
+find.addRequests( // Specify the find criteria
+    {"PrimaryKey": "AAAAA", "ModifiedBy": "BBBB"},
+    {"CreatedBy": "BBBB"}
+)
+
+find.addSort("CreatedBy", "ascend") // Sort the results in ascending order
+let records = await find.find() // Perform the find
+console.log(records)
+```
+
+---
+
+### Scripts
+
+Running scripts is another operation you may need to do regularly. This one is fairly straight-forward in how it works
+
+```javascript
+let layout = connection.getLayout("layout1")
+let script = connection.script("MyFileMakerScript", "This is a parameter")
+let result = await layout.runScript(script)
+console.log(result)
+```
+
+---
+
+## Classes and methods
+
+
+
+
+---
+
+## Index
+
+### RecordID
+
+This is not a custom field that can be set and/or changed. You can get a record's ID from within FileMaker by
 using `Get(RecordID)`

package/decs.d.ts

@@ -1,7 +1,7 @@
-declare module "fs"
-declare module "events"
-declare module "path"
-declare module "url"
-declare module "node-fetch"
-declare module "btoa"
+declare module "fs"
+declare module "events"
+declare module "path"
+declare module "url"
+declare module "node-fetch"
+declare module "btoa"
 declare module "buffer"

package/docs/classes/FileMakerConnection.md

@@ -0,0 +1,86 @@
+# Class: FileMakerConnection
+
+## Constructor
+
+```javascript
+export default class FileMakerConnection {
+    public hostname: string;
+    public database: string;
+    public token: any;
+    private username: any;
+    private password: any;
+    private rejectUnauthroized: boolean;
+
+    constructor() {
+    }
+}
+```
+
+This is the primary class as it holds information about the FileMaker connection
+
+## Methods
+
+### login(hostname, database, username, password, rejectUnauthorised)
+
+Creates a new login session on the FileMaker server, using the specified account.
+
+#### Parameters
+
+| Parameter          | Optional? | Default | Supported types |
+|--------------------|-----------|---------|-----------------|
+| hostname           | No        | N/A     | string          |
+| database           | No        | N/A     | string          |
+| username           | No        | N/A     | string          |
+| password           | No        | N/A     | string          |
+| rejectUnauthorised | Yes       | true    | boolean         |
+
+#### Returns:
+
+Promise <token>
+
+### importSession(token, rejectUnauthorised)
+
+Allows you to import and use a FileMaker Data API token that was generated in another application.
+
+#### Parameters
+
+| Parameter          | Optional? | Default | Supported types |
+|--------------------|-----------|---------|-----------------|
+| token              | No        | N/A     | string          |
+| rejectUnauthorised | Yes       | true    | boolean         |
+
+#### Returns:
+
+Promise <void>
+
+### getLayout(name)
+
+#### Parameters
+
+| Parameter          | Optional? | Default | Supported types | Description                               |
+|--------------------|-----------|---------|-----------------|-------------------------------------------|
+| name               | No        | N/A     | string          | The name of the layout you wish to access |
+
+#### Returns:
+
+[layout](layout.md)
+
+### apiRequest(name)
+
+#### Parameters
+
+| Parameter          | Optional? | Default | Supported types | Description                               |
+|--------------------|-----------|---------|-----------------|-------------------------------------------|
+| name               | No        | N/A     | string          | The name of the layout you wish to access |
+
+#### Returns:
+
+[layout](layout.md)
+
+### logout()
+
+Ends the current database session
+
+#### Returns:
+
+Promise <void>