@jd-data-limited/easy-fm 0.0.1

package/.idea/easy-fm.iml

@@ -0,0 +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>
+</module>

package/.idea/jsLibraryMappings.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="JavaScriptLibraryMappings">
+    <includedPredefinedLibrary name="Node.js Core" />
+  </component>
+</project>

package/.idea/modules.xml

@@ -0,0 +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>
+</project>

package/.idea/vcs.xml

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

package/LICENSE

@@ -0,0 +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.

package/README.md

@@ -0,0 +1,64 @@
+# easy-fm
+
+easy-fm is a Node.js module that allows you to interact with
+a [FileMaker database stored](https://www.claris.com/filemaker/) 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
+
+
+## Usage examples
+
+1. Get the first record on the 'table1' layout
+```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
+    let layout = connection.getLayout("layout1")
+    let record = layout.getRecord(1)
+    await record.get() // Fetch the data for that record
+    console.log(record)
+})
+```
+
+2. Get all related portal records
+```javascript
+await record.get() // Fetch the record's data
+let portal = record.getPortal("portal1") // 'portal1' should be the name you assigned the portal object, when creating the layout
+console.log(portal.records)
+```
+
+3. Run a script
+```javascript
+    let script = connection.script("script_name", "this is a parameter") // Create a new script object using the script name and parameter (optional)
+    
+    // Get the layout we want to run the script on
+    let layout = connection.getLayout("layout1")
+
+    // Run the script on the layout
+    let result = await layout.runScript(script)
+    console.log(result)
+```
+
+4. Perform a find
+```javascript
+let find = layout.newFind() // Create a new find operation
+
+find.addRequests( // Specify the find criteria
+    {"PrimaryKey": "AAAAA", "ModifiedBy": "BBBB"}, 
+    {"CreatedBy": "BBBB"}
+)
+
+find.addSort("CratedBy", "ascend") // Sort the results in ascending order
+let records = await find.find() // Perform the find
+console.log(records)
+```
+This is the same as the following find request in FileMaker:
+![img.png](img.png)

package/decs.d.ts

@@ -0,0 +1,4 @@
+declare module "fs"
+declare module "events"
+declare module "path"
+declare module "url"