@jd-data-limited/easy-fm 1.1.6-alpha1 → 1.2.0-alpha1

package/README.md

@@ -17,19 +17,11 @@ or [FileMaker Cloud](https://store.claris.com/filemaker-cloud). 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)
-5. [Index](#index)
+## 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 the UTC time offset for your current timezone.
 
----
 
 ## Connecting to a database
 
@@ -37,12 +29,21 @@ easy-fm currently does not support connecting to external data sources, or authe
 FileMaker authentication.
 
 ```javascript
-import fm, {FMError} from "easy-fm"; // Import the module
-const connection = new fm(
-    // Connection options (see below)
-);
+import FMHost, {FMError} from "easy-fm"; // Import the module
+const host = new FMHost(
+    "https://<your-servers-address>",
+    700 // Timezone offset
+)
+const database = host.database({
+    database: "your_database.fmp12",
+    credentials: {
+        method: "filemaker",
+        username: "<username>",
+        password: "<password>"
+    }
+})
 
-connection.login().then(token => {
+database.login().then(() => {
     // Record operations can only be performed after a successful login
 })
 ```
@@ -54,255 +55,80 @@ connection.login().then(token => {
 >
 > 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
+## Getting records
 
-## Token
+One of (if not the) most common interactions you'll need to use is fetching records.
 
-If you have already created a session with the FileMaker Data API, you can use this to import your session.
+### Fetch a range of records
 
 ```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
+let layout = database.getLayout("Your layout name")
+let range_request = layout.records.range()
 
-## Claris Account (FileMaker Cloud)
+range_request.setOffset(50) // Starting from the 50th record...
+range_request.setLimit(100) // Fetch 100 records
 
-(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
-
-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 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
-
-[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'
+let records = await range_request.run()
+console.log(records)
 ```
 
-### Modify a record
-
-WARNING: The commit step is mandatory. Otherwise the changes will never be uploaded
+### Searching for records
 
 ```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()
-```
-> **NOTE:** A commit will also commit any changes made to portal records.
+let layout = database.getLayout("Your layout name")
+let find_request = layout.records.find()
 
-### Create a new 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
 
-```javascript
-let record = await layout.createRecord()
-record.getField("field1").set("ABC")
-record.getField("field2").set("DEF")
-await record.commit()
+let records = await range_request.run()
+console.log(records)
 ```
 
-> **WARNING:** The record is *not* created on the database server until a `commit()` step is done.x
+### Fetch a record using its record ID
 
-### Downloading container field files
+> Please note: When in FileMaker Pro, a record's ID is returned when using Get(RecordID). If you need to fetch a record
+> using a different ID, use the search method above.
 
 ```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
-})
+let layout = database.getLayout("Your layout name")
+let record = await layout.records.get(164)
+console.log(record)
 ```
 
-[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)
-
+### Create a record
 
 ```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 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)
+let layout = database.getLayout("Your layout name")
+let record = await layout.records.create()
 
-### Read and modify portal information
+record.getField("Field1").set("Value here")
+record.getField("Field2").set("Value here")
+record.getField("Field3").set("Value here")
 
-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")
-}
+await record.commit()
 ```
 
-> **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.
+### Modify a record
 
 ```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.run() // Perform the find
-console.log(records)
-```
-
----
+let layout = database.getLayout("Your layout name")
+let record = await layout.records.get(164)
 
-### Scripts
+record.getField("Field1").set("Value here")
+record.getField("Field2").set("Value here")
+record.getField("Field3").set("Value here")
 
-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)
+await record.commit()
 ```
 
----
-
-## Classes and methods
-
----
+# Documentation
 
-## Index
+## FMHost
 
-### RecordID
+`hostname`: string
+> The hostname of the server you are connecting to
 
-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)`
+`timezoneOffset`: number
+> The server's timezone offset

package/TEMP/FILEMAKER.txt

@@ -0,0 +1,218 @@
+FILEMAKER:
+
+__CreationTimestamp
+__CreationUser
+__ModificationTimestamp
+__ModificationTimestamp|JS
+__ModificationUser
+__PrimaryKey
+__RecordID
+__RecordNumber
+__ShortID
+_1
+_IsIncubating
+_PDF|ArchiveID
+_Report|JSON|Shorthand
+_Report|JSON|Shorthand|Default
+_Report|JSON|Shorthand|HASH
+_RI|RI|Date|Sorter
+_RI|RI|Date|Sorter2
+_shouldShow
+_temp_field
+FI|A|Animal
+FI|A|Fertility
+FI|FI|BeddingFloorType
+FI|FI|BeddingFloorType Calc
+FI|FI|CalvingSystem
+FI|FI|FarmingSystem
+FI|FI|FarmingType
+FI|FI|FeedPad
+FI|FI|FeedPadCleaning
+FI|FI|HerdHome
+FI|FI|Lane
+FI|FI|Slatted
+FI|FI|StallType
+FI|FI|WinteringBarn
+FI|FS|Comment
+FI|FS|IncurringPenalties
+FI|FS|KnownCurrentIssues
+FI|FS|KnownCurrentIssues|Other
+FI|FS|Penalties|Bactoscan
+FI|FS|Penalties|Calc
+FI|FS|Penalties|Coliform
+FI|FS|Penalties|SCC
+FI|FS|Penalties|Temperature
+FI|FS|Penalties|Thermoduric
+FI|FS|PenaltyTypes
+FI|MM|Comment
+FI|MM|Comment|Report
+FI|MM|IdentifyProcess
+FI|MM|IdentifyProcess|Other
+FI|MM|TreatmentsPerMonth
+GI|1C|Email
+GI|1C|FName
+GI|1C|Label
+GI|1C|LName
+GI|1C|PhNumber
+GI|1C|PhType
+GI|1C|Role
+GI|2C|Email
+GI|2C|FName
+GI|2C|LName
+GI|2C|PhNumber
+GI|2C|Role
+GI|Customer|Label
+GI|Customer|LabelExtended
+GI|Customer|LabelExtended|Address
+GI|Customer|LabelExtended|Contact
+GI|Partner|Label
+GI|Partner|LabelExtended
+GI|Partner|LabelExtended|Address
+GI|Partner|LabelExtended|Contact
+GI|VET|Address
+GI|VET|Address|City
+GI|VET|Address|Country
+GI|VET|Address|Postcode
+GI|VET|Address|Street
+GI|VET|Address|StreetAddress
+GI|VET|Address|Town
+GI|VET|Email
+GI|VET|FName
+GI|VET|Label
+GI|VET|Label|Extended
+GI|VET|Label|Extended|Address
+GI|VET|Label|Extended|Contact
+GI|VET|LName
+GI|VET|PhNumber
+GI|VET|PracticeName
+GI|VET|ReceiveReport
+GI|VET|WasOnSite
+I|I|MiscComments
+I|ID|IncubationTimestamp
+I|ID|IncubationTimestamp|JS
+In|ArchiveID
+In|FarmID
+In|IncubationHours
+In|PartnerID
+In|UserID
+LinerLifeCalculator|CowsInClusters
+LinerLifeCalculator|Life_InDays
+LinerLifeCalculator|Life_InMonths
+LinerLifeCalculator|LinerLife
+LinerLifeCalculator|LinerUsage
+LinerLifeCalculator|MilkingsPerDay
+OnLoan|Date
+OnLoan|to
+Out|Contractor|Comments
+Out|ImportantNotes
+Out|KnownIssues|Notes
+Out|MilkingSystem|Notes
+Out|Pathogen|1
+Out|Pathogen|1|PriorityLevel
+Out|Pathogen|1|RiskLevel
+Out|Pathogen|2
+Out|Pathogen|2|PriorityLevel
+Out|Pathogen|2|RiskLevel
+Out|Pathogen|3
+Out|Pathogen|3|PriorityLevel
+Out|Pathogen|3|RiskLevel
+Out|Pathogen|4
+Out|Pathogen|4|PriorityLevel
+Out|Pathogen|4|RiskLevel
+Out|Pathogen|5
+Out|Pathogen|5|PriorityLevel5
+Out|Pathogen|5|RiskLevel
+Out|PF|MilkSamplingDate
+Out|PF|ReportDate
+Out|PF|ReportGeneratedBy
+Out|PI|GeneralComments
+Out|PI|GeneralComments Page1
+Out|PI|GeneralComments Page2
+Out|PI|GeneralComments|JSONSplit
+Out|PostMilking|Comment
+Out|PreMilking|Comment
+PDF|GenerateReport
+PlaceHolder
+Report|AddressTo
+Report|FooterText
+Report|HeaderText
+Report|IDNumber
+Report|JSON|Upload
+Report|JSON|Upload|DUMP
+Report|Type
+RI|RI|Date
+RI|RI|Date|JS
+RI|RI|HerdID
+RI|RI|LastSCCRecordingDate
+RI|RI|LastSCCRecordingValue
+RI|RI|MilkAvgYield|Calc
+RI|RI|MilkVolume
+RI|RI|MilkVolume|Calc
+RI|RI|MilkVolumeUnit
+RI|RI|NumAnimals
+RI|RI|NumAnimals|Calc
+RI|RI|NumAnimalsInTank
+RI|RI|SampleSource
+RI|RI|SampleSource|Calc
+RI|RI|SCC|Comments
+RI|RI|SCC|Value
+RI|RI|SubPopulation
+SMPI|MP|MilkPickups
+SMPI|MP|MilkPickups|Num
+SMPI|MP|NumMilkingsPerDay
+SMPI|MS|ACR
+SMPI|MS|InShedFeeding
+SMPI|MS|MilkingSystem|Calc
+SMPI|MS|MilkingSystemMake
+SMPI|MS|MilkingSystemMake|Name
+SMPI|MS|MilkingSystemType
+SMPI|MS|MSAge
+SMPI|MS|NumOfBales
+SMPI|PostI|ExtraEmolientActiveIngredients
+SMPI|PostI|ExtraEmolientActiveIngredients|Calc
+SMPI|PostM|Comments
+SMPI|PostM|DippingOrSpraying
+SMPI|PostM|DippingOrSpraying|Other
+SMPI|PostM|ExtraEmolientProductName
+SMPI|PostM|PostMilkingTeatSpraying
+SMPI|PostM|ProductActiveConcentration
+SMPI|PostM|ProductActiveIngredient
+SMPI|PostM|ProductActiveIngredient|Calc
+SMPI|PostM|ProductActiveIngredient|Other
+SMPI|PostM|ProductEmolientConcentration
+SMPI|PostM|ProductName
+SMPI|PostM|TeatCare|Brand
+SMPI|PostM|TeatSprayingTechnology
+SMPI|PostM|TeatSprayingTechnology|Other
+SMPI|PostM|UseEmolient
+SMPI|PreM|Brushes
+SMPI|PreM|Dilution
+SMPI|PreM|ProductName
+SMPI|PreM|TeatCare|Brand
+SMPI|PreM|TeatCare|Dilution
+SMPI|PreM|TeatCare|Name
+SMPI|PreM|TeatCleanMethod
+SMPI|PreM|TeatCleanMethod|Calc
+SMPI|PreM|TeatCleanMethod|Other
+SMPI|PreM|TeatDisinfectActiveIngredient
+SMPI|PreM|TeatDisinfectActiveIngredient|Calc
+SMPI|PreM|TeatDisinfectActiveIngredient|Other
+SMPI|PreM|TeatDisinfectMethod
+SMPI|PreM|TeatDisinfectMethod|Other
+SMPI|PreM|TeatDisinfectTech
+SMPI|PreM|TeatPrepClean
+SMPI|PreM|TeatPrepDisinfectLiquid
+SMPI|PreM|TeatPrepMethod
+SMPI|PreM|TeatPrepMethod|Other
+SMPI|PreM|TeatPrepTemp
+SMPI|PreM|TeatWipeMethod
+SMPI|PreM|TeatWipeMethod|Other
+SMPI|PreM|WashTemp
+SMPI|PW|Comment
+SMPI|PW|FarmWaterSource
+SMpI|PW|FarmWaterSource|Other
+SMPI|PW|TeatcareDilutionWaterSource
+SMPI|PW|WaterTreatmentTechnology
+SMPI|PW|WaterTreatmentTechnology|Other
+SMPIIPW|TeatcareDilutionWaterSource|Other
+status

package/TEMP/WEBAPP.txt

@@ -0,0 +1,92 @@
+WEB-APP:
+
+FI|A|Animal
+FI|A|Fertility
+FI|FI|BeddingFloorType
+FI|FI|CalvingSystem
+FI|FI|FarmingSystem
+FI|FI|FarmingType
+FI|FI|FeedPad
+FI|FI|FeedPadCleaning
+FI|FI|HerdHome
+FI|FI|Lane
+FI|FI|Slatted
+FI|FI|StallType
+FI|FI|WinteringBarn
+FI|FS|Comment
+FI|FS|IncurringPenalties
+FI|FS|KnownCurrentIssues
+FI|FS|Penalties|Bactoscan
+FI|FS|Penalties|Coliform
+FI|FS|Penalties|SCC
+FI|FS|Penalties|Temperature
+FI|FS|Penalties|Thermoduric
+FI|FS|PenaltyTypes
+FI|MM|Comment
+FI|MM|IdentifyProcess
+FI|MM|TreatmentsPerMonth
+GI|1C|Email
+GI|1C|FName
+GI|1C|LName
+GI|1C|PhNumber
+GI|1C|Role
+GI|2C|Email
+GI|2C|FName
+GI|2C|LName
+GI|2C|PhNumber
+GI|2C|Role
+GI|VET|Address
+GI|VET|Email
+GI|VET|FName
+GI|VET|LName
+GI|VET|PhNumber
+GI|VET|PracticeName
+GI|VET|ReceiveReport
+I|I|MiscComments
+I|ID|IncubationTimestamp|JS
+I|Images|HeldUpToLight
+I|Images|OnAnAngle
+I|Images|WhBackground
+RI|RI|Date|JS
+RI|RI|HerdID
+RI|RI|MilkVolume
+RI|RI|MilkVolumeUnit
+RI|RI|NumAnimals
+RI|RI|NumAnimalsInTank
+RI|RI|SampleSource
+RI|RI|SCC|Comments
+RI|RI|SCC|Value
+RI|RI|SubPopulation
+SMPI|MP|MilkPickups
+SMPI|MP|MilkPickups|Num
+SMPI|MP|NumMilkingsPerDay
+SMPI|MS|ACR
+SMPI|MS|InShedFeeding
+SMPI|MS|MilkingSystemMake
+SMPI|MS|MilkingSystemMake|Name
+SMPI|MS|MilkingSystemType
+SMPI|MS|MSAge
+SMPI|MS|NumOfBales
+SMPI|PostI|ExtraEmolientActiveIngredients
+SMPI|PostM|Comments
+SMPI|PostM|DippingOrSpraying
+SMPI|PostM|ExtraEmolientProductName
+SMPI|PostM|ProductActiveConcentration
+SMPI|PostM|ProductActiveIngredient
+SMPI|PostM|ProductEmolientConcentration
+SMPI|PostM|ProductName
+SMPI|PostM|TeatCare|Brand
+SMPI|PostM|TeatSprayingTechnology
+SMPI|PostM|UseEmolient
+SMPI|PreM|Dilution
+SMPI|PreM|ProductName
+SMPI|PreM|TeatCleanMethod
+SMPI|PreM|TeatDisinfectActiveIngredient
+SMPI|PreM|TeatDisinfectMethod
+SMPI|PreM|TeatDisinfectTech
+SMPI|PreM|TeatWipeMethod
+SMPI|PreM|WashTemp
+SMPI|PW|Comment
+SMPI|PW|FarmWaterSource
+SMPI|PW|TeatcareDilutionWaterSource
+SMPI|PW|WaterTreatmentTechnology

package/TEMP/config.yaml

@@ -0,0 +1,40 @@
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# <== Enter custom agent configurations in this file.
+# See https://cloud.google.com/stackdriver/docs/solutions/agents/ops-agent/configuration
+# for more details.
+
+logging:
+  receivers:
+    filemaker-event-log:
+      type: files
+      include_paths:
+        - "/opt/FileMaker/FileMaker Server/Logs/Event.log"
+    filemaker-access-log:
+      type: files
+      include_paths:
+        - "/opt/FileMaker/FileMaker Server/Logs/Access.log"
+    filemaker-fmdapi-log:
+      type: files
+      include_paths:
+        - "/opt/FileMaker/FileMaker Server/Logs/fmdapi.log"
+  service:
+    pipelines:
+      filemaker-event-pipeline:
+        receivers: [filemaker-event-log]
+      filemaker-access-pipeline:
+        receivers: [filemaker-access-log]
+      filemaker-fmdapi-pipeline:
+        receivers: [filemaker-fmdapi-log]