fac

fms-api-client

A FileMaker Server Data API client designed to allow interaction with a FileMaker database from a web environment.

Showing:

Popularity

Downloads/wk

85

GitHub Stars

67

Maintenance

Last Commit

2yrs ago

Contributors

3

Package

Dependencies

14

Size (min+gzip)

235.4KB

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

fms-api-client

Build Status Known Vulnerabilities Coverage Status GitHub issues Github commits (since latest release) code style: prettier GitHub license

A FileMaker Data API client designed to allow easier interaction with a FileMaker database from a web environment. This client abstracts the FileMaker 17 & 18 Data API into class based methods.

fms-api-client documentation

Table of Contents

License

MIT © Lui de la Parra

Installation

npm install --save fms-api-client

Usage

Introduction

The fms-api-client is a wrapper around the FileMaker Data API. Much ❤️ to FileMaker for their work on the Data API. This client attempts to follow the terminology and conventions used by FileMaker wherever possible. The client uses a lightweight datastore to hold Data API connections. For more information about datastore configuration see the datastore connection section and the marpat project.

Each client committed to the datastore will automatically handle Data API Sessions. If required, clients can also manually open or close their FileMaker sessions by calling either the client.login() method or the client.logout() method. To remove a client from a datastore and log out a session call client.destroy(). For more information on Data API Session handling see the Data API sessions section.

All client methods accept parameters as defined by FileMaker. The client also allows for an expanded parameter syntax designed to make interacting with the client easier. Scripts and portals can be defined as arrays. Find queries can be defined as either an object or an array. For more information on the syntax supported by the client see the parameter syntax section.

In addition to the expanded syntax the client will also automatically parse arrays, objects, and numbers to adhere to the requirements of the Data API. The limit and offset parameters can be either strings or a numbers. The client will also automatically convert limit, find, and offset parameters into their underscored conterparts as needed. Additionally, if a script result is valid JSON it will be automatically parsed for you by the client.

All methods on the client return promises and each method will reject with a message and code upon encountering an error. All messages and codes follow the FileMaker Data API codes where applicable.

The client will queue concurrent requests to the Data API. The client can be configured with a concurrency setting. The client will attempt ensure that each request to the Data API is made with an valid token which is not in use. This behavior prevents request session collisions. For more information on Data API Session handling see the request queue section.

The client also provides utility modules to aid in working with FileMaker Data API Results. The provided utility modules are fieldData, recordId, containerData, and transform. These utilities will accept and return either an object or an array objects. For more information on the utility modules see the utilities section.

Parameter Syntax

The client supports the same parameter syntax as is found in the Data API Documentation. Where appropriate and useful the client also allows additional parameters.

Script Array Syntax

The custom script parameter follows the following syntax:

{
  "scripts": [
    {
      "name": "At Mos Eisley",
      "phase": "presort",
      "param": "awesome bar"
    },
    {
      "name": "First Shot",
      "phase": "prerequest",
      "param": "Han"
    },
    {
      "name": "Moof Milker",
      "param": "Greedo"
    }
  ]
}

File ./examples/schema/scripts-array-schema.json

Following the Data API, the prerequest phase occurs before executing request and sorting of records, the presort phase after executing request and before sorting records. Not specifying a phase will run the script after the request and sorting are executed.

Note: The FileMaker script and portal syntax will override the alternative scripts and portals parameter syntax.

Portals Array Syntax

The custom portals parameter follows the following syntax:

{
  "portals": [
    { "name": "planets", "limit": 1, "offset": 1 },
    { "name": "vehicles", "limit": 2 }
  ]
}

File ./examples/schema/portals-array-schema.json

If a portals array is not used all portals on a queried layout will be returned.

Note: The FileMaker script and portal syntax will override the alternative scripts and portals parameter syntax.

Data Syntax

Arrays and objects are stringified before being inserted into field or portal data.

{
  "data": {
    "name": "Yoda",
    "Vehicles::name": "The Force"
  }
}

File ./examples/schema/data-schema.json

Any property not nested in a portalData property will be moved into the fieldData property.

Sort Syntax

The client accepts the same sort parameters as the Data API.

{
  "sort": [
    { "fieldName": "name", "sortOrder": "ascend" },
    { "fieldName": "modificationTimestamp", "sortOrder": "descend" }
  ]
}

File ./examples/schema/sort-schema.json

Query Syntax

When using the find method a query is required. The query can either be a single json object or an array of json objects.

{
  "query": [
    {
      "name": "Han solo",
      "Vehicles::name": "Millenium Falcon"
    },
    {
      "name": "Luke Skywalker",
      "Vehicles::name": "X-Wing Starfighter"
    },
    {
      "age": ">10000"
    }
  ]
}

File ./examples/schema/query-schema.json

Datastore Connection

The connect method must be called before the FileMaker class is used. The connect method is not currently exposed by fms-api-client, but from the marpat dependency. marpat is a fork of camo. Thanks and love to Scott Robinson for his creation and maintenance of camo.

marpat is designed to allow the use of multiple datastores with the focus on encrypted file storage and project flexibility.

For more information on marpat and the different types of supported storage visit marpat

const { connect } = require('marpat');
connect('nedb://memory');

Excerpt from ./examples/index.js

Client Creation

After connecting to a datastore you can import and create clients. A client is created using the create method on the Filemaker class. The FileMaker class accepts an object with the following properties:

PropertyTypeDescription
databaseStringThe FileMaker database to connect to
serverStringThe FileMaker server to use as the host. Note: Must be an http or https Domain.
userStringThe FileMaker user account to be used when authenticating into the Data API
passwordStringThe FileMaker user account's password.
[name]StringA name for the client.
[usage]BooleanTrack Data API usage for this client. Note: Default is true
[timeout]NumberThe default timeout time for requests Note: Default is 0, (no timeout)
[concurrency]NumberThe number of concurrent requests that will be made to FileMaker
[proxy]Objectsettings for a proxy server
[agent]Objectsettings for a custom request agent

⚠️ You should only use the agent parameter when absolutely necessary. The Data API was designed to be used on https. Deviating from the intended use should be done with caution.

const client = Filemaker.create({
  name: process.env.CLIENT_NAME,
  database: process.env.DATABASE,
  concurrency: 3,
  server: process.env.SERVER,
  user: process.env.USERNAME,
  password: process.env.PASSWORD,
  usage: process.env.CLIENT_USAGE_TRACKING
});

Excerpt from ./examples/index.js

Note: The server must be an http or https domain.

A client can be used directly after saving it. The client.save() method takes no arguments and will either reject with an error or resolve with a useable client. The client will automatically handle Data API session creation and expiration. Once a client is saved it will be stored on the datastore for reuse later.

    return client.save();
  })
  .then(client => authentication(client))
  .then(client => metadata(client))
  .then(client => creates(client))
  .then(client => duplicate(client))
  .then(client => gets(client))
  .then(client => lists(client))
  .then(client => finds(client))
  .then(client => edits(client))
  .then(client => scripts(client))
  .then(client => script(client))
  .then(client => globals(client))
  .then(client => deletes(client))
  .then(client => uploads(client))
  .then(client => utilities(client))

Excerpt from ./examples/index.js A client can be removed using either the client.destroy() method, the Filemaker.deleteOne(query) method or the Filemaker.deleteMany(query) method. Note Only the client.destroy() method will close a FileMaker session. Any client removed using the the Filemaker.deleteOne(query) method or the Filemaker.deleteMany(query) method will not log out before being destroyed.

Client Use

A client can be used after it is created and saved or recalled from the datastore. The Filemaker.find(query) or Filemaker.findOne(query) methods can be used to recall clients. The Filemaker.findOne(query) method will return either one client or null. The Filemaker.find(query) will return either an empty array or an array of clients. All public methods on the client return promises.

const createManyRecords = client =>
  Promise.all([
    client.create('Heroes', { name: 'Anakin Skywalker' }, { merge: true }),
    client.create('Heroes', { name: 'Obi-Wan' }, { merge: true }),
    client.create('Heroes', { name: 'Yoda' }, { merge: true })
  ]).then(result => log('create-many-records-example', result));

Excerpt from ./examples/create.examples.js

Results:

[
  {
    "name": "Anakin Skywalker",
    "recordId": "1138",
    "modId": "327"
  },
  {
    "name": "Obi-Wan",
    "recordId": "1138",
    "modId": "327"
  },
  {
    "name": "Yoda",
    "recordId": "1138",
    "modId": "327"
  }
]

File ./examples/results/create-many-records-example.json

Request Queue

The client will automatically queue a requests to the FileMaker Data API if there are no available sessions to make the request. The client will ensure that a session is not in use or expired before it uses a session token in a request. This functionality is designed to prevent session collisions. The client will open and use a new session up to the configured concurrency limit. The concurrency limit is set when a client is created. By default the concurrency limit is one.

Data API Sessions

The client will automatically handle creating and closing Data API sessions. If a new session is required the client will authenticate and generate a new session or queue requests if the session limit has been reached.

The Data API session is also monitored, updated, and saved as the client interacts with the Data API. The client will always attempt to reuse a valid token whenever possible.

The client contains two methods related to Data API sessions. These methods are client.login() and client.logout(). The login method is used to start a Data API session and the logout method will end a Data API session.

Login Method

The client will automatically call the login method if it does not have a valid token. This method returns an object with a token property. This method will also save the token to the client's connection for future use.

client.login()

const login = client =>
  client.login().then(result => log('client-login-example', result));

Excerpt from ./examples/authentication.examples.js

Logout Method

The logout method is used to end a Data API session. This method will also remove the current client's authentication token. The logout method accepts an optional id parameter. The logout method will use the id parameter as the session to target for ending.

client.logout(id)

const logout = client =>
  client
    .login()
    .then(() => client.logout())
    .then(result => log('client-logout-example', result));

Excerpt from ./examples/authentication.examples.js

Client Methods

Product Info

A client can get server product info. The productInfo method will return metadata about the FileMaker server the client is configured to use.

client.productInfo()

const productInfo = client =>
  client.productInfo().then(result => log('product-info-example', result));

Excerpt from ./examples/metadata.examples.js Result:

{
  "name": "FileMaker Data API Engine",
  "buildDate": "07/05/2019",
  "version": "18.0.2.217",
  "dateFormat": "MM/dd/yyyy",
  "timeFormat": "HH:mm:ss",
  "timeStampFormat": "MM/dd/yyyy HH:mm:ss"
}

File ./examples/results/product-info-example.json

Get Databases

A client can get the databases accessible using the configured credentials. This method will return all databases hosted by the currently configured server that the client can connect to. An alternative set of credentials can be passed to this method to check what databases alternate credentials are able to access.

client.databases(credentials)

const databases = client =>
  client.databases().then(result => log('databases-info-example', result));

Excerpt from ./examples/metadata.examples.js

Result:

{
  "databases": [
    {
      "name": "fms-api-app"
    },
    {
      "name": "node-red-app"
    }
  ]
}

File ./examples/results/databases-info-example.json

Get Layouts

The layouts method will return a list of layouts accessible by the configured client.

client.layouts()

const layouts = client =>
  client.layouts().then(result => log('layouts-example', result));

Excerpt from ./examples/metadata.examples.js

Result:

{
  "layouts": [
    {
      "name": "Parameter Storage Demo"
    },
    {
      "name": "Chalmuns"
    },
    {
      "name": "Card Windows",
      "isFolder": true,
      "folderLayoutNames": [
        {
          "name": "Authorization Window"
        }
      ]
    },
    {
      "name": "API Integration Layouts",
      "isFolder": true,
      "folderLayoutNames": [
        {
          "name": "authentication"
        }
      ]
    },
    {
      "name": "Base Tables",
      "isFolder": true,
      "folderLayoutNames": [
        {
          "name": "RequestLog"
        },
        {
          "name": "SyncLog"
        },
        {
          "name": "AuthenticationStore"
        }
      ]
    },
    {
      "name": "Heroes"
    },
    {
      "name": "Transform"
    },
    {
      "name": "Hero Search"
    },
    {
      "name": "Hero"
    },
    {
      "name": "Globals"
    },
    {
      "name": "Scripts"
    },
    {
      "name": "Logs"
    },
    {
      "name": "Planets"
    },
    {
      "name": "Driods"
    },
    {
      "name": "Vehicles"
    },
    {
      "name": "Species"
    },
    {
      "name": "Images"
    }
  ]
}

File ./examples/results/layouts-example.json

Get Scripts

The scripts method will return metadata for the scripts accessible by the configured client.

client.scripts()

const scripts = client =>
  client
    .scripts(process.env.LAYOUT)
    .then(result => log('scripts-example', result));

Excerpt from ./examples/metadata.examples.js

Result:

{
  "scripts": [
    {
      "name": "Upon Open",
      "isFolder": false
    },
    {
      "name": "FMS Triggered Script",
      "isFolder": false
    },
    {
      "name": "node-red-script",
      "isFolder": false
    },
    {
      "name": "example script",
      "isFolder": false
    },
    {
      "name": "Error Script",
      "isFolder": false
    },
    {
      "name": "Non JSON Script",
      "isFolder": false
    },
    {
      "name": "Create Droids",
      "isFolder": false
    },
    {
      "name": "Delete All Records",
      "isFolder": false
    },
    {
      "name": "Buttons",
      "folderScriptNames": [
        {
          "name": "New Clip Record",
          "isFolder": false
        },
        {
          "name": "Update Clip Button",
          "isFolder": false
        },
        {
          "name": "Replace Clip Record Data",
          "isFolder": false
        },
        {
          "name": "Delete All Clip Records",
          "isFolder": false
        },
        {
          "name": "Push all flagged clips",
          "isFolder": false
        },
        {
          "name": "Set Clipboard",
          "isFolder": false
        }
      ],
      "isFolder": true
    }
  ]
}

File ./examples/results/scripts-example.json

Get Layout

The layout method will get metadata for the specified layout.

client.layout(layout)

ParamTypeDescription
layoutStringThe layout to use in the request.
[parameters]Objectoptional request parameters for the request.
const layout = client =>
  client
    .layout(process.env.LAYOUT)
    .then(result => log('layout-details-example', result));

Excerpt from ./examples/metadata.examples.js

Result:

{
  "fieldMetaData": [
    {
      "name": "name",
      "type": "normal",
      "displayType": "editText",
      "result": "text",
      "global": false,
      "autoEnter": false,
      "fourDigitYear": false,
      "maxRepeat": 1,
      "maxCharacters": 0,
      "notEmpty": false,
      "numeric": false,
      "timeOfDay": false,
      "repetitionStart": 1,
      "repetitionEnd": 1
    },
    {
      "name": "image",
      "type": "normal",
      "displayType": "editText",
      "result": "container",
      "global": false,
      "autoEnter": false,
      "fourDigitYear": false,
      "maxRepeat": 1,
      "maxCharacters": 0,
      "notEmpty": false,
      "numeric": false,
      "timeOfDay": false,
      "repetitionStart": 1,
      "repetitionEnd": 1
    },
    {
      "name": "object",
      "type": "normal",
      "displayType": "editText",
      "result": "text",
      "global": false,
      "autoEnter": false,
      "fourDigitYear": false,
      "maxRepeat": 1,
      "maxCharacters": 0,
      "notEmpty": false,
      "numeric": false,
      "timeOfDay": false,
      "repetitionStart": 1,
      "repetitionEnd": 1
    },
    {
      "name": "array",
      "type": "normal",
      "displayType": "editText",
      "result": "text",
      "global": false,
      "autoEnter": false,
      "fourDigitYear": false,
      "maxRepeat": 1,
      "maxCharacters": 0,
      "notEmpty": false,
      "numeric": false,
      "timeOfDay": false,
      "repetitionStart": 1,
      "repetitionEnd": 1
    },
    {
      "name": "height",
      "type": "normal",
      "displayType": "editText",
      "result": "text",
      "global": false,
      "autoEnter": false,
      "fourDigitYear": false,
      "maxRepeat": 1,
      "maxCharacters": 0,
      "notEmpty": false,
      "numeric": false,
      "timeOfDay": false,
      "repetitionStart": 1,
      "repetitionEnd": 1
    },
    {
      "name": "id",
      "type": "normal",
      "displayType": "editText",
      "result": "text",
      "global": false,
      "autoEnter": true,
      "fourDigitYear": false,
      "maxRepeat": 1,
      "maxCharacters": 0,
      "notEmpty": false,
      "numeric": false,
      "timeOfDay": false,
      "repetitionStart": 1,
      "repetitionEnd": 1
    },
    {
      "name": "imageName",
      "type": "calculation",
      "displayType": "editText",
      "result": "text",
      "global": false,
      "autoEnter": false,
      "fourDigitYear": false,
      "maxRepeat": 1,
      "maxCharacters": 0,
      "notEmpty": false,
      "numeric": false,
      "timeOfDay": false,
      "repetitionStart": 1,
      "repetitionEnd": 1
    },
    {
      "name": "creationAccountName",
      "type": "normal",
      "displayType": "editText",
      "result": "text",
      "global": false,
      "autoEnter": true,
      "fourDigitYear": false,
      "maxRepeat": 1,
      "maxCharacters": 0,
      "notEmpty": false,
      "numeric": false,
      "timeOfDay": false,
      "repetitionStart": 1,
      "repetitionEnd": 1
    },
    {
      "name": "creationTimestamp",
      "type": "normal",
      "displayType": "editText",
      "result": "timeStamp",
      "global": false,
      "autoEnter": true,
      "fourDigitYear": false,
      "maxRepeat": 1,
      "maxCharacters": 0,
      "notEmpty": false,
      "numeric": false,
      "timeOfDay": false,
      "repetitionStart": 1,
      "repetitionEnd": 1
    },
    {
      "name": "modificationAccountName",
      "type": "normal",
      "displayType": "editText",
      "result": "text",
      "global": false,
      "autoEnter": true,
      "fourDigitYear": false,
      "maxRepeat": 1,
      "maxCharacters": 0,
      "notEmpty": false,
      "numeric": false,
      "timeOfDay": false,
      "repetitionStart": 1,
      "repetitionEnd": 1
    },
    {
      "name": "modificationTimestamp",
      "type": "normal",
      "displayType": "editText",
      "result": "timeStamp",
      "global": false,
      "autoEnter": true,
      "fourDigitYear": false,
      "maxRepeat": 1,
      "maxCharacters": 0,
      "notEmpty": false,
      "numeric": false,
      "timeOfDay": false,
      "repetitionStart": 1,
      "repetitionEnd": 1
    },
    {
      "name": "Vehicles::name",
      "type": "normal",
      "displayType": "editText",
      "result": "text",
      "global": false,
      "autoEnter": false,
      "fourDigitYear": false,
      "maxRepeat": 1,
      "maxCharacters": 0,
      "notEmpty": false,
      "numeric": false,
      "timeOfDay": false,
      "repetitionStart": 1,
      "repetitionEnd": 1
    }
  ],
  "portalMetaData": {
    "Planets": [
      {
        "name": "Planets::name",
        "type": "normal",
        "displayType": "editText",
        "result": "text",
        "global": false,
        "autoEnter": false,
        "fourDigitYear": false,
        "maxRepeat": 1,
        "maxCharacters": 0,
        "notEmpty": false,
        "numeric": false,
        "timeOfDay": false,
        "repetitionStart": 1,
        "repetitionEnd": 1
      },
      {
        "name": "Species::name",
        "type": "normal",
        "displayType": "editText",
        "result": "text",
        "global": false,
        "autoEnter": false,
        "fourDigitYear": false,
        "maxRepeat": 1,
        "maxCharacters": 0,
        "notEmpty": false,
        "numeric": false,
        "timeOfDay": false,
        "repetitionStart": 1,
        "repetitionEnd": 1
      }
    ],
    "Vehicles": [
      {
        "name": "Vehicles::name",
        "type": "normal",
        "displayType": "editText",
        "result": "text",
        "global": false,
        "autoEnter": false,
        "fourDigitYear": false,
        "maxRepeat": 1,
        "maxCharacters": 0,
        "notEmpty": false,
        "numeric": false,
        "timeOfDay": false,
        "repetitionStart": 1,
        "repetitionEnd": 1
      },
      {
        "name": "Vehicles::type",
        "type": "normal",
        "displayType": "editText",
        "result": "text",
        "global": false,
        "autoEnter": false,
        "fourDigitYear": false,
        "maxRepeat": 1,
        "maxCharacters": 0,
        "notEmpty": false,
        "numeric": false,
        "timeOfDay": false,
        "repetitionStart": 1,
        "repetitionEnd": 1
      }
    ]
  }
}

File ./examples/results/layout-details-example.json

Create Records

Using the client you can create filemaker records. To create a record specify the layout to use and the data to insert on creation. The client will automatically convert numbers, arrays, and objects into strings so they can be inserted into a filemaker field. The create method will automatically create a fieldData property and add all data to that property if there is no fieldData property present. The client will preserve the contents of the portalData property.

client.create(layout, data, parameters)

ParamTypeDescription
layoutStringThe layout to use when creating a record.
dataObjectThe data to use when creating a record.
parametersObjectThe request parameters to use when creating the record.
const createRecord = client =>
  client
    .create('Heroes', {
      name: 'George Lucas'
    })
    .then(result => log('create-record-example', result));

Excerpt from ./examples/create.examples.js

Result:

{
  "recordId": "1138",
  "modId": "327"
}

File ./examples/results/create-record-example.json

The create method also allows you to trigger scripts when creating a record. Notice the scripts property in the following example. You can specify scripts to run using either FileMaker's script.key syntax or specify an array of in a scripts property. The script objects should have with name, optional phase, and optional params parameters. For more information see the scripts syntax example in the introduction.

const triggerScriptsOnCreate = client =>
  client
    .create(
      'Heroes',
      { name: 'Anakin Skywalker' },
      {
        merge: true,
        scripts: [
          { name: 'Create Droids', param: { droids: ['C3-PO', 'R2-D2'] } }
        ]
      }
    )
    .then(result => log('trigger-scripts-on-create-example', result));

Excerpt from ./examples/create.examples.js

Result:

{
  "name": "Anakin Skywalker",
  "scriptError": "0",
  "recordId": "1138",
  "modId": "327"
}

File ./examples/results/trigger-scripts-on-create-example.json

Duplicate Record

The duplicate method duplicates the FileMaker record using the layout and recordId parameters passed to it.

client.duplicate(layout, recordId, parameters)

ParamTypeDescription
layoutStringThe layout to use in the request.
recordIdStringThe record id to target for duplication.
[parameters]Objectoptional request parameters for the request.
client
  .duplicate('Heroes', response.data[0].recordId)
  .then(result => log('duplicate-record-example', result));

Excerpt from ./examples/duplicate.examples.js

Result:

{
  "recordId": "1138",
  "modId": "327"
}

File ./examples/results/duplicate-record-example.json

The duplicate method also allows you to trigger scripts when duplicating a record. Notice the scripts property in the following example. You can specify scripts to run using either FileMaker's script.key syntax or specify an array of in a scripts property. The script objects should have with name, optional phase, and optional params parameters. For more information see the scripts syntax example in the introduction.

const triggerScriptsOnCreate = client =>
  client
    .create(
      'Heroes',
      { name: 'Anakin Skywalker' },
      {
        merge: true,
        scripts: [
          { name: 'Create Droids', param: { droids: ['C3-PO', 'R2-D2'] } }
        ]
      }
    )
    .then(result => log('trigger-scripts-on-create-example', result));

Excerpt from ./examples/create.examples.js

Result:

{
  "name": "Anakin Skywalker",
  "scriptError": "0",
  "recordId": "1138",
  "modId": "327"
}

File ./examples/results/trigger-scripts-on-create-example.json

Get Record Details

The Get method will return a specific FileMaker record based on the recordId passed to it. The recordId can be a string or a number.

client.get(layout, recordId, parameters)

ParamTypeDescription
layoutStringThe layout to use when retrieving the record.
recordIdStringThe FileMaker internal record ID to use when retrieving the record.
[parameters]ObjectParameters to add for the get query.
client
  .get('Heroes', response.data[0].recordId)
  .then(result => log('get-record-example', result));

Excerpt from ./examples/get.examples.js Result:

{
  "dataInfo": {
    "database": "fms-api-app",
    "layout": "Heroes",
    "table": "Heroes",
    "totalRecordCount": "1977",
    "foundCount": 1,
    "returnedCount": 1
  },
  "data": [
    {
      "fieldData": {
        "name": "yoda",
        "image": "https://some-server.com/Streaming_SSL/MainDB/E8BDBF29B9388B2F212002F7F6A7D6B8EF87A16E7E2D231EA27B8FC32147F64D?RCType=EmbeddedRCFileProcessor",
        "object": "",
        "array": "",
        "height": "",
        "id": "r2d2-c3po-l3-37-bb-8",
        "imageName": "placeholder.md",
        "creationAccountName": "obi-wan",
        "creationTimestamp": "05/25/1977 6:00:00",
        "modificationAccountName": "obi-wan",
        "modificationTimestamp": "05/25/1977 6:00:00",
        "Vehicles::name": ""
      },
      "portalData": {
        "Planets": [],
        "Vehicles": []
      },
      "recordId": "1138",
      "modId": "327",
      "portalDataInfo": [
        {
          "database": "fms-api-app",
          "table": "Planets",
          "foundCount": 0,
          "returnedCount": 0
        },
        {
          "database": "fms-api-app",
          "table": "Vehicles",
          "foundCount": 0,
          "returnedCount": 0
        }
      ]
    }
  ]
}

File ./examples/results/get-record-example.json

List Records

You can use the client to list filemaker records. The list method accepts a layout and parameter variable. The client will automatically santize the limit, offset, and sort keys to correspond with the DAPI's requirements.

client.list(layout, parameters)

ParamTypeDescription
layoutStringThe layout to use when retrieving the record.
[parameters]Objectthe parameters to use to modify the query.
const listHeroes = client =>
  client
    .list('Heroes', { limit: 2 })
    .then(result => log('list-records-example', result));

Excerpt from ./examples/list.examples.js

Result:

{
  "dataInfo": {
    "database": "fms-api-app",
    "layout": "Heroes",
    "table": "Heroes",
    "totalRecordCount": "1977",
    "foundCount": 29493,
    "returnedCount": 2
  },
  "data": [
    {
      "fieldData": {
        "name": "George Lucas",
        "image": "https://some-server.com/Streaming_SSL/MainDB/6BA0C4191156DE2DF3036BB1ABF079B0CF8BF6F286316A5603EF789FB45C66D7.png?RCType=EmbeddedRCFileProcessor",
        "object": "",
        "array": "",
        "height": "",
        "id": "r2d2-c3po-l3-37-bb-8",
        "imageName": "IMG_0001.PNG",
        "creationAccountName": "obi-wan",
        "creationTimestamp": "05/25/1977 6:00:00",
        "modificationAccountName": "obi-wan",
        "modificationTimestamp": "05/25/1977 6:00:00",
        "Vehicles::name": "test"
      },
      "portalData": {
        "Planets": [],
        "Vehicles": [
          {
            "recordId": "1138",
            "Vehicles::name": "test",
            "Vehicles::type": "",
            "modId": "327"
          }
        ]
      },
      "recordId": "1138",
      "modId": "327",
      "portalDataInfo": [
        {
          "database": "fms-api-app",
          "table": "Planets",
          "foundCount": 0,
          "returnedCount": 0
        },
        {
          "database": "fms-api-app",
          "table": "Vehicles",
          "foundCount": 1,
          "returnedCount": 1
        }
      ]
    },
    {
      "fieldData": {
        "name": "George Lucas",
        "image": "",
        "object": "",
        "array": "",
        "height": "",
        "id": "r2d2-c3po-l3-37-bb-8",
        "imageName": "",
        "creationAccountName": "obi-wan",
        "creationTimestamp": "05/25/1977 6:00:00",
        "modificationAccountName": "obi-wan",
        "modificationTimestamp": "05/25/1977 6:00:00",
        "Vehicles::name": ""
      },
      "portalData": {
        "Planets": [],
        "Vehicles": []
      },
      "recordId": "1138",
      "modId": "327",
      "portalDataInfo": [
        {
          "database": "fms-api-app",
          "table": "Planets",
          "foundCount": 0,
          "returnedCount": 0
        },
        {
          "database": "fms-api-app",
          "table": "Vehicles",
          "foundCount": 0,
          "returnedCount": 0
        }
      ]
    }
  ]
}

File ./examples/results/list-records-example.json

Find Records

The client's find method will accept either a single object as find parameters or an array. The find method will also santize the limit, sort, and offset parameters to conform with the Data API's requirements.

client.find(layout, query, parameters)

ParamTypeDescription
layoutStringThe layout to use when performing the find.
queryObjectto use in the find request.
parametersObjectthe parameters to use to modify the query.
const findRecords = client =>
  client
    .find('Heroes', [{ name: 'Anakin Skywalker' }], { limit: 1 })
    .then(result => log('find-records-example', result));

Excerpt from ./examples/find.examples.js

Result:

{
  "dataInfo": {
    "database": "fms-api-app",
    "layout": "Heroes",
    "table": "Heroes",
    "totalRecordCount": "1977",
    "foundCount": 153,
    "returnedCount": 1
  },
  "data": [
    {
      "fieldData": {
        "name": "Anakin Skywalker",
        "image": "",
        "object": "",
        "array": "",
        "height": "",
        "id": "r2d2-c3po-l3-37-bb-8",
        "imageName": "",
        "creationAccountName": "obi-wan",
        "creationTimestamp": "05/25/1977 6:00:00",
        "modificationAccountName": "obi-wan",
        "modificationTimestamp": "05/25/1977 6:00:00",
        "Vehicles::name": ""
      },
      "portalData": {
        "Planets": [],
        "Vehicles": []
      },
      "recordId": "1138",
      "modId": "327",
      "portalDataInfo": [
        {
          "database": "fms-api-app",
          "table": "Planets",
          "foundCount": 0,
          "returnedCount": 0
        },
        {
          "database": "fms-api-app",
          "table": "Vehicles",
          "foundCount": 0,
          "returnedCount": 0
        }
      ]
    }
  ]
}

File ./examples/results/find-records-example.json

Edit Records

The client's edit method requires a layout, recordId, and object to use for updating the record.

client.edit(layout, recordId, data, parameters)

ParamTypeDescription
layoutStringThe layout to use when editing the record.
recordIdStringThe FileMaker internal record ID to use when editing the record.
dataObjectThe data to use when editing a record.
parametersObjectparameters to use when performing the query.
const editRecord = client =>
  client
    .find('Heroes', [{ name: 'Anakin Skywalker' }], { limit: 1 })
    .then(response => response.data[0].recordId)
    .then(recordId => client.edit('Heroes', recordId, { name: 'Darth Vader' }))
    .then(result => log('edit-record-example', result));

Excerpt from ./examples/edit.examples.js

Result:

{
  "modId": "327"
}

File ./examples/results/edit-record-example.json

Delete Records

The client's delete method requires a layout and a record id. The recordId can be a number or a string.

client.delete(layout, recordId, parameters)

ParamTypeDescription
layoutStringThe layout to use when deleting the record.
recordIdStringThe FileMaker internal record ID to use when editing the record.
parametersObjectparameters to use when performing the query.
const deleteRecords = client =>
  client
    .find('Heroes', [{ name: 'yoda' }], { limit: 1 })
    .then(response => response.data[0].recordId)
    .then(recordId => client.delete('Heroes', recordId))
    .then(result => log('delete-record-example', result));

Excerpt from ./examples/delete.examples.js

Result:

{}

File ./examples/results/delete-record-example.json

Trigger Script

The client's script method will trigger a script. You can also trigger scripts with the create, edit, list, find, and delete methods. This method performs a list with a limit of one on the specified layout before triggering the script. this is the most lightweight request possible while still being able to trigger a script.

client.script(layout, script, param, parameters)

ParamTypeDescription
layoutStringThe layout to use for the list request
scriptStringThe name of the script
paramObject | StringParameter to pass to the script
[parameters]ObjectOptional request parameters.
const triggerScript = client =>
  client
    .script('Heroes', 'FMS Triggered Script', { name: 'Han' })
    .then(result => log('script-trigger-example', result));

Excerpt from ./examples/script.examples.js

Result:

{
  "scriptResult": {
    "answer": "Han shot first"
  },
  "scriptError": "0"
}

File ./examples/results/script-trigger-example.json

Run Multiple Scripts

The client's script method will trigger a script. You can also trigger scripts with the create, edit, list, find, and delete methods. This method performs a list with a limit of one on the specified layout before triggering the script. this is the most lightweight request possible while still being able to trigger a script.

client.run(layout, scripts,parameters)

ParamTypeDescription
layoutStringThe layout to use for the list request
scriptsObject | ArrayThe name of the script
parametersObjectParameters to pass to the script
requestObjectA request to run alongside the list method.
const runMultipleScripts = client =>
  client
    .run('Heroes', [
      { name: 'FMS Triggered Script', param: { name: 'Han' } },
      { name: 'FMS Triggered Script', phase: 'presort', param: { name: 'Han' } }
    ])
    .then(result => log('run-scripts-example', result));

Excerpt from ./examples/scripts.examples.js

Result:

{
  "scriptResult.presort": {
    "answer": "Han shot first"
  },
  "scriptResult": {
    "answer": "Han shot first"
  }
}

File ./examples/results/run-scripts-example.json

Upload Files

The upload method will upload binary data to a container. The file parameter should be either a path to a file or a buffer. If you need to set a field repetition, you can set that in parameters. If recordId is 0 or undefined a new record will be created.

client.upload(file, layout, container, recordId, parameters)

ParamTypeDescription
fileStringThe path to the file to upload.
layoutStringThe layout to use when performing the find.
containerFieldNameStringThe field name to insert the data into. It must be a container field.
recordIdNumber | Stringthe recordId to use when uploading the file.
parametersObjectparameters to use when performing the query.
[fieldRepetition]String | NumberThe field repetition to use when inserting the file. The default is 1.
const uploadImage = client =>
  client
    .upload('./assets/placeholder.md', 'Heroes', 'image')
    .then(result => log('upload-image-example', result));

Excerpt from ./examples/upload.examples.js

Result:

{
  "modId": "327",
  "recordId": "1138"
}

File ./examples/results/upload-image-example.json

You can also provide a record Id to the upload method and the file will be uploaded to that record.

          client
            .upload('./assets/placeholder.md', 'Heroes', 'image', recordId)
            .then(result => log('upload-specific-record-example', result))
            .catch(error => error),

Excerpt from ./examples/upload.examples.js

Result:

{
  "modId": "327",
  "recordId": "1138"
}

File ./examples/results/upload-specific-record-example.json

Set Session Globals

The globals method will set global fields for the current session.

client.globals(data, parameters)

ParamTypeDescription
dataObject | Arraya json object containing the name value pairs to set.
parametersObjectparameters to use when performing the query.
const setGlobals = client =>
  client
    .globals({ 'Globals::ship': 'Millenium Falcon' })
    .then(result => log('set-globals-example', result));

Excerpt from ./examples/globals.examples.js

Result:

{}

File ./examples/results/set-globals-example.json

Client Status

The client status method will return an object description the current client's connection status. This method will return overall client data usage, urls for pending and queued requests and current session information.

client.status()

const getStatus = client =>
  client.status().then(result => log('client-status-example', result));

Excerpt from ./examples/utility.examples.js

Result:

{
  "data": {
    "since": "2019-09-15T15:30:43-07:00",
    "in": "438 Bytes",
    "out": "29.8 kB"
  },
  "queue": [],
  "pending": [],
  "sessions": [
    {
      "issued": "2019-09-15T15:30:44-07:00",
      "expires": "2019-09-15T15:45:47-07:00",
      "id": "r2d2-c3po-l3-37-bb-8",
      "active": false
    },
    {
      "issued": "2019-09-15T15:30:44-07:00",
      "expires": "2019-09-15T15:45:44-07:00",
      "id": "r2d2-c3po-l3-37-bb-8",
      "active": true
    },
    {
      "issued": "2019-09-15T15:30:44-07:00",
      "expires": "2019-09-15T15:45:44-07:00",
      "id": "r2d2-c3po-l3-37-bb-8",
      "active": true
    }
  ]
}

File ./examples/results/client-status-example.json

Client Reset

The client reset method will drop all pending and queued requests while also clearing all open sessions.

⚠️ This method is experimental. It does not reject pending or queued requests before clearing them. Use with caution.

client.reset()

const resetClient = client =>
  client.reset().then(result => log('client-reset-example', result));

Excerpt from ./examples/utility.examples.js

Result:

{
  "message": "Client Reset"
}

File ./examples/results/client-reset-example.json

Utilities

The client also provides utilities to aid in parsing and manipulating FileMaker Data. The client exports the recordId(data), fieldData(data), and transform(data, options) to aid in transforming Data API response data into other formats. Each utility is capable of recieving either an object or a array.

Record Id Utility

The record id utility retrieves the recordId properties for a response. This utility will return either a single string or an array of strings.

recordId(data)

ParamTypeDescription
dataObject | Arraythe raw data returned from a filemaker. This can be an array or an object.
const extractRecordIdOriginal = client =>
  client
    .find('Heroes', { name: 'yoda' }, { limit: 2 })
    .then(response => recordId(response.data))
    .then(result => log('record-id-utility-example', result));

Excerpt from ./examples/utility.examples.js

Record Id Utility Results

original:

[
  {
    "fieldData": {
      "name": "Yoda",
      "image": "https://some-server.com/Streaming_SSL/MainDB/1D86123EDDA1866BDDC2962F71108F8D78EFCAE349E66934D2737E3615918167?RCType=EmbeddedRCFileProcessor",
      "object": "",
      "array": "",
      "height": "",
      "id": "r2d2-c3po-l3-37-bb-8",
      "imageName": "placeholder.md",
      "creationAccountName": "obi-wan",
      "creationTimestamp": "05/25/1977 6:00:00",
      "modificationAccountName": "obi-wan",
      "modificationTimestamp": "05/25/1977 6:00:00",
      "Vehicles::name": ""
    },
    "portalData": {
      "Planets": [],
      "Vehicles": []
    },
    "recordId": "1138",
    "modId": "327",
    "portalDataInfo": [
      {
        "database": "fms-api-app",
        "table": "Planets",
        "foundCount": 0,
        "returnedCount": 0
      },
      {
        "database": "fms-api-app",
        "table": "Vehicles",
        "foundCount": 0,
        "returnedCount": 0
      }
    ]
  },
  {
    "fieldData": {
      "name": "yoda",
      "image": "",
      "object": "",
      "array": "",
      "height": "",
      "id": "r2d2-c3po-l3-37-bb-8",
      "imageName": "",
      "creationAccountName": "obi-wan",
      "creationTimestamp": "05/25/1977 6:00:00",
      "modificationAccountName": "obi-wan",
      "modificationTimestamp": "05/25/1977 6:00:00",
      "Vehicles::name": ""
    },
    "portalData": {
      "Planets": [],
      "Vehicles": []
    },
    "recordId": "1138",
    "modId": "327",
    "portalDataInfo": [
      {
        "database": "fms-api-app",
        "table": "Planets",
        "foundCount": 0,
        "returnedCount": 0
      },
      {
        "database": "fms-api-app",
        "table": "Vehicles",
        "foundCount": 0,
        "returnedCount": 0
      }
    ]
  }
]

File ./examples/results/record-id-utility-original-example.json

Transformed:

["751326", "751329"]

File ./examples/results/record-id-utility-example.json

Field Data Utility

The field data utility retrieves the fieldData, recordId, and modId properties from a Data API response. The fieldData utility will merge the recordId and modId properties into fielData properties. This utility will not convert table::field properties.

fieldData(data)

ParamTypeDescription
dataObject | ArrayThe raw data returned from a filemaker. This can be an array or an object.
const extractFieldData = client =>
  client
    .find('Heroes', { name: 'yoda' }, { limit: 2 })
    .then(response => fieldData(response.data))
    .then(result => log('field-data-utility-example', result));

Excerpt from ./examples/utility.examples.js

Field Data Utility Results

Original:

[
  {
    "fieldData": {
      "name": "Yoda",
      "image": "https://some-server.com/Streaming_SSL/MainDB/8F7489E114CFFE0FC13E8A45A2F52D77A50ABFB36B05C0858114F37EA3141634?RCType=EmbeddedRCFileProcessor",
      "object": "",
      "array": "",
      "height": "",
      "id": "r2d2-c3po-l3-37-bb-8",
      "imageName": "placeholder.md",
      "creationAccountName": "obi-wan",
      "creationTimestamp": "05/25/1977 6:00:00",
      "modificationAccountName": "obi-wan",
      "modificationTimestamp": "05/25/1977 6:00:00",
      "Vehicles::name": ""
    },
    "portalData": {
      "Planets": [],
      "Vehicles": []
    },
    "recordId": "1138",
    "modId": "327",
    "portalDataInfo": [
      {
        "database": "fms-api-app",
        "table": "Planets",
        "foundCount": 0,
        "returnedCount": 0
      },
      {
        "database": "fms-api-app",
        "table": "Vehicles",
        "foundCount": 0,
        "returnedCount": 0
      }
    ]
  },
  {
    "fieldData": {
      "name": "yoda",
      "image": "",
      "object": "",
      "array": "",
      "height": "",
      "id": "r2d2-c3po-l3-37-bb-8",
      "imageName": "",
      "creationAccountName": "obi-wan",
      "creationTimestamp": "05/25/1977 6:00:00",
      "modificationAccountName": "obi-wan",
      "modificationTimestamp": "05/25/1977 6:00:00",
      "Vehicles::name": ""
    },
    "portalData": {
      "Planets": [],
      "Vehicles": []
    },
    "recordId": "1138",
    "modId": "327",
    "portalDataInfo": [
      {
        "database": "fms-api-app",
        "table": "Planets",
        "foundCount": 0,
        "returnedCount": 0
      },
      {
        "database": "fms-api-app",
        "table": "Vehicles",
        "foundCount": 0,
        "returnedCount": 0
      }
    ]
  }
]

File ./examples/results/field-data-utility-original-example.json

Transformed:

[
  {
    "name": "Yoda",
    "image": "https://some-server.com/Streaming_SSL/MainDB/27EA97DBE4B14E5BE2E09713E6C5CF75604F9458EC0885B00E436B618C798D87?RCType=EmbeddedRCFileProcessor",
    "object": "",
    "array": "",
    "height": "",
    "id": "r2d2-c3po-l3-37-bb-8",
    "imageName": "placeholder.md",
    "creationAccountName": "obi-wan",
    "creationTimestamp": "05/25/1977 6:00:00",
    "modificationAccountName": "obi-wan",
    "modificationTimestamp": "05/25/1977 6:00:00",
    "Vehicles::name": "",
    "recordId": "1138",
    "modId": "327"
  },
  {
    "name": "yoda",
    "image": "",
    "object": "",
    "array": "",
    "height": "",
    "id": "r2d2-c3po-l3-37-bb-8",
    "imageName": "",
    "creationAccountName": "obi-wan",
    "creationTimestamp": "05/25/1977 6:00:00",
    "modificationAccountName": "obi-wan",
    "modificationTimestamp": "05/25/1977 6:00:00",
    "Vehicles::name": "",
    "recordId": "1138",
    "modId": "327"
  }
]

File ./examples/results/field-data-utility-example.json

Transform Utility

The transform utility converts Data API response data by converting table::field properties into objects. This utility will traverse the response data converting { table::field : value} properties to { table:{ field : value } }. This utility will also convert portalData into arrays of objects.

The transform utility accepts three option properties. The three option properties are all booleans and true by default. The properties are convert,fieldData,portalData. The convert property toggles the transformation of table::field properties. The fieldData property toggles merging of fieldData to the result. The portalData property toggles merging portalData to the result. Setting any property to false will turn that transformation off.

transform(data, parameters)

ParamTypeDescription
dataObjectThe data to transform.
optionsObjecttransformation options to pass to transformObject.
const transformData = client =>
  client
    .find('Transform', { name: 'Han Solo' }, { limit: 1 })
    .then(result => transform(result.data))
    .then(result => log('transform-utility-example', result));

Excerpt from ./examples/utility.examples.js

Transform Utility Results

Original:

[
  {
    "fieldData": {
      "starships": "",
      "vehicles": "",
      "species": "",
      "biography": "",
      "birthYear": "",
      "id": "r2d2-c3po-l3-37-bb-8",
      "name": "Han Solo"
    },
    "portalData": {
      "Planets": [
        {
          "recordId": "1138",
          "Planets::name": "Coriella",
          "modId": "327"
        }
      ],
      "Vehicles": [
        {
          "recordId": "1138",
          "Vehicles::name": "Millenium Falcon",
          "Vehicles::type": "Starship",
          "modId": "327"
        }
      ]
    },
    "recordId": "1138",
    "modId": "327",
    "portalDataInfo": [
      {
        "database": "fms-api-app",
        "table": "Planets",
        "foundCount": 1,
        "returnedCount": 1
      },
      {
        "database": "fms-api-app",
        "table": "Vehicles",
        "foundCount": 1,
        "returnedCount": 1
      }
    ]
  }
]

File ./examples/results/transform-utility-original-example.json

Transformed:

[
  {
    "starships": "",
    "vehicles": "",
    "species": "",
    "biography": "",
    "birthYear": "",
    "id": "r2d2-c3po-l3-37-bb-8",
    "name": "Han Solo",
    "Planets": [
      {
        "recordId": "1138",
        "name": "Coriella",
        "modId": "327"
      }
    ],
    "Vehicles": [
      {
        "recordId": "1138",
        "name": "Millenium Falcon",
        "type": "Starship",
        "modId": "327"
      }
    ],
    "recordId": "1138",
    "modId": "327"
  }
]

File ./examples/results/transform-utility-example.json

Container Data Utility

The container data utility will retrieve FileMaker container data by following the links returned by the Data API. This utility will accept either a single data object or an array of objects. The utility will use the field parameter to target container data urls in the data parameter. This utility also requires a name parameter which will be used to target a data property that should be used as the file's name. If a name parameter is provided that is not a property or nested property in the data parameter, the name parameter itself will be used. The destination parameter should be either 'buffer' to indicate that an object with a file's name and buffer should be returned or the path, relative to the current working directory, where the utility should write container data to a file. This utility will also accept optional request parameters to modify the http request.

containerData(data, field, destination, name, parameters)

ParamTypeDescription
dataObject | ArrayThe response recieved from the FileMaker DAPI.
fieldStringThe container field name to target. This can be a nested property.
destinationString"buffer" if a buffer object should be returned or the path to write the file.
nameStringThe field to use for the file name or a static string.
[parameters]ObjectRequest configuration parameters.
[parameters.timeout]Numbera timeout for the request.
const getContainerData = client =>
  client
    .find('Heroes', { imageName: '*' }, { limit: 1 })
    .then(result =>
      containerData(
        result.data,
        'fieldData.image',
        './assets',
        'fieldData.imageName'
      )
    )
    .then(result => log('container-data-example', result));

Excerpt from ./examples/utility.examples.js

Result:

[
  {
    "name": "IMG_0001.PNG",
    "path": "assets/IMG_0001.PNG"
  }
]

File ./examples/results/container-data-example.json

Databases Utility

The databases utility will get the accessible databases for the server and credentials passed to it.

databases(server, credentials, version, parameters)

ParamTypeDefaultDescription
hostStringThe host FileMaker server.
[credentials]StringCredentials to use when getting a list of databases.
[version]String"vLatest"The Data API version to use. The default is 'vLatest'.
[parameters]ObjectRequest configuration parameters.
const getDatabases = client =>
  databases(process.env.SERVER).then(result =>
    log('databases-utility-example', result)
  );

Excerpt from ./examples/utility.examples.js

Result:

{
  "databases": [
    {
      "name": "fms-api-app"
    },
    {
      "name": "node-red-app"
    }
  ]
}

File ./examples/results/databases-utility-example.json

Product Info Utility

The productInfo utility will get Data API information for the server passed to it.

productInfo(host, version, parameters)

ParamTypeDefaultDescription
hostStringThe host FileMaker server.
[version]String"vLatest"The Data API version to use. The default is 'vLatest'.
[parameters]ObjectRequest configuration parameters.
const getProductInfo = client =>
  productInfo(process.env.SERVER).then(result =>
    log('product-info-utility-example', result)
  );

Excerpt from ./examples/utility.examples.js

Result:

{
  "name": "FileMaker Data API Engine",
  "buildDate": "07/05/2019",
  "version": "18.0.2.217",
  "dateFormat": "MM/dd/yyyy",
  "timeFormat": "HH:mm:ss",
  "timeStampFormat": "MM/dd/yyyy HH:mm:ss"
}

File ./examples/results/product-info-utility-example.json

Additional Client Capabilities

Data Merge

Both the create method and the edit method accept a merge boolean in their option parameters. If the merge property is true the data used to create or edit the filemaker record will be merged with the FileMaker Data API results.

const mergeDataOnCreate = client =>
  client
    .create(
      'Heroes',
      {
        name: 'George Lucas'
      },
      { merge: true }
    )
    .then(result => log('create-record-merge-example', result));

Excerpt from ./examples/create.examples.js

Result:

{
  "name": "George Lucas",
  "recordId": "1138",
  "modId": "327"
}

File ./examples/results/create-record-merge-example.json

Custom Request Agents

The client has the ability to create custom agents and modify requests parameters or use a proxy. Agents, request parameters, and proxies can be configured either when the client is created or when a request is being made.

A client can have a custom Agent. Using a custom request agent will allow you to configure an agent designed for your specific needs. A request agent can be configured to not reject unauthorized request such as those with invalid SSLs, keep the connection alive, or limit the number of sockets to a host. There is no need to create an agent unless theses options are needed.

Note If you are using a custom agent you are responsible for destroying that agent with client.destroy once the agent is no longer used.

Custom Request Parameters

All client methods except client.login() and client.logout() accept request parameters. These parameters are request.proxy and request.timeout, request.agent. These properties will apply only to the current request.

Proxies

The client can be configured to use a proxy. The proxy can be configured either for every request by specifying the proxy during the creation of the client, or just for a particular request by specifying the proxy in the request parameters.

Tests

npm install
npm test
> fms-api-client@2.3.2 test /fms-api-client
> snyk test && nyc _mocha --recursive ./test --timeout=15000 --exit


Testing /fms-api-client...

Organization:      luidog
Package manager:   npm
Target file:       package-lock.json
Open source:       yes
Project path:      /fms-api-client
Local Snyk policy: found
Licenses:          enabled

✓ Tested 357 dependencies for known issues, no vulnerable paths found.



  Agent Configuration Capabilities
    ✓ should attempt to clear invalid sessions (156ms)
    ✓ should attempt to clear invalid sessions even if there is no header (100ms)
    ✓ should reject non http protocol requests (96ms)

  Agent Configuration Capabilities
    ✓ should accept no agent configuration
    ✓ should not create an agent unless one is defined (203ms)
    ✓ should adjust the request protocol according to the server
    ✓ should create an https agent
    ✓ should use a created request agent (216ms)
    ✓ should destroy the agent when the client is deleted (208ms)
    ✓ should clear a connection without a custom agent (202ms)
    ✓ should clear a connection with a custom agent (185ms)
    ✓ should create an http agent
    ✓ should use a proxy if one is set (239ms)
    ✓ should require the http protocol (135ms)
    ✓ should accept a timeout property
    ✓ should accept a concurrency property
    ✓ should use a timeout if one is set (115ms)
    ✓ should not try to resolve pending requests that do not have a resolve function

  Authentication Capabilities
    ✓ should authenticate into FileMaker. (103ms)
    ✓ should automatically request an authentication token (294ms)
    ✓ should reuse an open session (189ms)
    ✓ should log out of the filemaker. (207ms)
    ✓ should not attempt a logout if there is no valid token.
    ✓ should reject if the logout request fails (183ms)
    ✓ should reject if the login request fails (1473ms)
    ✓ should reject if it can not create a new data api session (1417ms)
    ✓ should reject if it can not create a new data api session with authentication (1433ms)
    ✓ should clear queued requests if it can not add a new data api session (1446ms)
    ✓ should clear pending requests if it can not add a new data api session (1424ms)
    ✓ should attempt to log out before being removed (92ms)
    ✓ should clear invalid sessions (1449ms)
    ✓ should open sessions with a custom agent automatically
    ✓ should open sessions with a custom agent on login
    ✓ should close sessions with a custom agent automatically
    ✓ should catch the log out error before being removed if the login is not valid (174ms)

  Client Capabilities
    ✓ should show the current status
    ✓ should show the current status
    ✓ should reset the client

  ContainerData Capabilities
    ✓ should download container data from an object to a file (2683ms)
    ✓ should download container data from an array to a file (1387ms)
    ✓ should return an array of records if it is passed an array (1454ms)
    ✓ should return a single record object if passed an object (1358ms)
    ✓ should download container data from an array to a buffer (1365ms)
    ✓ should download container data from an object to a buffer (1392ms)
    ✓ should substitute a uuid if the record id can not be found in an object (1645ms)
    ✓ should substitute a uuid if the record id can not be found in an array (2385ms)
    ✓ should reject with an error and a message (281ms)
    ✓ should reject if WPE rejects the request (199ms)

  Create Capabilities
    ✓ should create FileMaker records without fieldData (302ms)
    ✓ should allow you to specify a timeout (50ms)
    ✓ should create FileMaker records using fieldData (117ms)
    ✓ should create FileMaker records with portalData (123ms)
    ✓ should allow portalData to be an object or number (128ms)
    ✓ should reject bad data with an error (129ms)
    ✓ should create records with mixed types (122ms)
    ✓ should substitute an empty object if data is not provided (133ms)
    ✓ should return an object with merged data properties (138ms)
    ✓ should allow you to run a script when creating a record with a merge response (146ms)
    ✓ should allow you to specify scripts as an array (147ms)
    ✓ should allow you to specify scripts as an array with a merge response (149ms)
    ✓ should sanitize parameters when creating a new record (146ms)
    ✓ should accept both the default script parameters and a scripts array (139ms)

  Databases Capabilities
    ✓ should get hosted databases (96ms)
    ✓ should fail with a code and a message (102ms)

  Databases Utility Capabilities
    ✓ should retrieve databases without credentials (82ms)
    ✓ should retrieve databases using account credentials (90ms)
    ✓ should fail with a code and a message (267ms)
    ✓ should require a server to list databases

  Delete Capabilities
    ✓ should delete FileMaker records. (465ms)
    ✓ should allow you to specify a timeout (208ms)
    ✓ should trigger scripts via an array when deleting records. (295ms)
    ✓ should trigger scripts via parameters when deleting records. (300ms)
    ✓ should allow you to mix script parameters and scripts array when deleting records. (303ms)
    ✓ should stringify script parameters. (325ms)
    ✓ should reject deletions that do not specify a recordId (153ms)
    ✓ should reject deletions that do not specify an invalid recordId (166ms)

  Duplicate Record Capabilities
    ✓ should allow you to duplicate a record (502ms)
    ✓ should require an id to duplicate a record (346ms)

  Edit Capabilities
    ✓ should edit FileMaker records without fieldData (515ms)
    ✓ should allow you to specify a timeout (254ms)
    ✓ should edit FileMaker records using fieldData (340ms)
    ✓ should edit FileMaker records with portalData (347ms)
    ✓ should edit FileMaker records with portalData and allow portalData to be an array. (355ms)
    ✓ should reject bad data with an error (360ms)
    ✓ should return an object with merged filemaker and data properties (371ms)
    ✓ should allow you to run a script when editing a record (389ms)
    ✓ should allow you to run a script via a scripts array when editing a record (388ms)
    ✓ should allow you to specify scripts as an array (387ms)
    ✓ should allow you to specify scripts as an array with a merge response (394ms)
    ✓ should sanitize parameters when creating a editing record (381ms)
    ✓ should accept both the default script parameters and a scripts array (410ms)

  FieldData Capabilities
    ✓ it should extract field data while maintaining the array (586ms)
    ✓ it should extract field data while maintaining the object (410ms)

  Find Capabilities
    ✓ should perform a find request (546ms)
    ✓ should allow you to use an object instead of an array for a find (363ms)
    ✓ should specify omit Criterea (341ms)
    ✓ should safely parse omit true and false (283ms)
    ✓ should allow additional parameters to manipulate the results (216ms)
    ✓ should allow you to limit the number of portal records to return (218ms)
    ✓ should allow you to use numbers in the find query parameters (216ms)
    ✓ should allow you to sort the results (1791ms)
    ✓ should return an empty array if the find does not return results (375ms)
    ✓ should allow you run a pre request script (332ms)
    ✓ should return a response even if a script fails (434ms)
    ✓ should allow you to send a parameter to the pre request script (376ms)
    ✓ should allow you run script after the find and before the sort (1185ms)
    ✓ should allow you to pass a parameter to a script after the find and before the sort (915ms)
    ✓ should reject of there is an issue with the find request (227ms)

  Get Capabilities
    ✓ should get specific FileMaker records. (650ms)
    ✓ should allow you to specify a timeout (400ms)
    ✓ should reject get requests that do not specify a recordId (463ms)
    ✓ should allow you to limit the number of portal records to return (472ms)
    ✓ should accept namespaced portal limit and offset parameters (480ms)

  Global Capabilities
    ✓ should allow you to set session globals (429ms)
    ✓ should allow you to specify a timeout (169ms)
    ✓ should reject with a message and code if it fails to set a global (242ms)

  Request Interceptor Capabilities
    ✓ should reject if the server errors (262ms)
    ✓ should intercept authentication errors (106ms)
    ✓ should intercept json responses that do not return a token (344ms)
    ✓ should intercept non json responses (226ms)
    ✓ should reject non http requests to the server with a json error
    ✓ should reject non https requests to the server with a json error (128ms)
    ✓ should convert non json responses to json

  Layout Metadata Capabilities
    ✓ should get field and portal metadata for a layout (425ms)
    ✓ should require a layout (244ms)
    ✓ should fail with a code and a message (249ms)

  Database Layout List Capabilities
    ✓ should get a list of Layouts and folders for the currently configured database (425ms)
    ✓ should fail with a code and a message (266ms)

  List Capabilities
    ✓ should allow you to list records (490ms)
    ✓ should allow you to specify a timeout (181ms)
    ✓ should allow you use parameters to modify the list response (259ms)
    ✓ should should allow you to use numbers in parameters (251ms)
    ✓ should should allow you to provide an array of portals in parameters (256ms)
    ✓ should should remove non used properties from a portal object (259ms)
    ✓ should modify requests to comply with DAPI name reservations (253ms)
    ✓ should allow strings while complying with DAPI name reservations (258ms)
    ✓ should allow you to offset the list response (261ms)
    ✓ should santize parameters that would cause unexpected parameters (265ms)
    ✓ should allow you to limit the number of portal records to return (263ms)
    ✓ should accept namespaced portal limit and offset parameters (263ms)
    ✓ should reject invalid parameters (406ms)

  Client Product Info Capabilities
    ✓ should get FileMaker Server Information (75ms)
    ✓ should fail with a code and a message (100ms)

  Product Info Utility Capabilities
    ✓ should get FileMaker Server Information (75ms)
    ✓ should fail with a code and a message (229ms)
    ✓ should require a server parameter

  Request Queue Capabilities
    ✓ should queue requests to FileMaker (4456ms)

  RecordId Capabilities
    ✓ it should extract the recordId while maintaining the array (748ms)
    ✓ it should extract recordId while maintaining the object (561ms)

  Script Queue Capabilities
    ✓ should allow you to trigger a script with an object (463ms)
    ✓ should allow you to trigger a script with an object (285ms)
    ✓ should allow you to trigger a script with an array (296ms)
    ✓ should allow you to trigger a script via a string (296ms)
    ✓ should allow you to specify a timeout (225ms)
    ✓ should allow you to trigger a script without specifying a parameter (296ms)
    ✓ should allow you to trigger a script specifying a string as a parameter (294ms)
    ✓ should allow you to trigger a script specifying a number as a parameter (310ms)
    ✓ should allow you to trigger a script specifying an object as a parameter (295ms)
    ✓ should reject a script that does not exist (295ms)
    ✓ should allow return a result even if a script returns an error (297ms)
    ✓ should parse script results if the results are json (301ms)
    ✓ should not parse script results if the results are not json (309ms)

  Single Script Capabilities
    ✓ should allow you to trigger a script (490ms)
    ✓ should allow you to specify a timeout (236ms)
    ✓ should allow you to trigger a script specifying a string as a parameter (314ms)
    ✓ should allow you to trigger a script specifying a number as a parameter (309ms)
    ✓ should allow you to trigger a script specifying an object as a parameter (305ms)
    ✓ should allow you to trigger a script specifying an array as a parameter (315ms)
    ✓ should allow you to trigger a script without a parameter (310ms)
    ✓ should reject a script that does not exist (309ms)
    ✓ should parse script results if the results are json (321ms)
    ✓ should not parse script results if the results are not json (311ms)

  General Script Capabilities
    ✓ should allow you to trigger a script in a find (576ms)
    ✓ should allow you to trigger a script in a list (320ms)
    ✓ should reject a script that does not exist (317ms)
    ✓ should allow return a result even if a script returns an error (332ms)
    ✓ should parse script results if the results are json (331ms)
    ✓ should not parse script results if the results are not json (331ms)
    ✓ should parse an array of scripts (326ms)
    ✓ should trigger scripts on all three script phases (341ms)

  Database Script List Capabilities
    ✓ should get a list of scripts and folders for the currently configured database (504ms)
    ✓ should fail with a code and a message (345ms)

  Storage
    ✓ should allow an instance to be created
    ✓ should allow an instance to be saved.
    ✓ should reject if a client can not be validated
    ✓ should allow an instance to be recalled
    ✓ should allow instances to be listed
    ✓ should allow you to remove an instance

  Transform Capabilities
    ✓ should merge portal data and field data from an array (678ms)
    ✓ should merge portal data and field data from an object (413ms)
    ✓ should optionally not convert table::field keys from an array (405ms)
    ✓ should optionally not convert table::field keys from an object (401ms)
    ✓ should allow you to remove field data from an array (414ms)
    ✓ should allow you to remove field data from an object (414ms)
    ✓ should allow you to remove portal data from an array (419ms)
    ✓ should allow you to remove portal data from an object (410ms)
    ✓ should merge portal data and portal data from an array (425ms)

  File Upload Capabilities
    ✓ should allow you to specify a timeout (822ms)
    ✓ should allow you to upload a file to a new record (1819ms)
    ✓ should allow you to upload a buffer to a new record (1138ms)
    ✓ should allow you to upload a file to a specific container repetition (800ms)
    ✓ should allow you to upload a buffer to a specific container repetition (811ms)
    ✓ should reject with a message if it can not find the file to upload
    ✓ should allow you to upload a file to a specific record (1090ms)
    ✓ should allow you to upload a buffer object to a specific record (838ms)
    ✓ should allow you to upload a file to a specific record container repetition (836ms)
    ✓ should allow you to upload a buffer to a specific record container repetition (829ms)
    ✓ should reject of the request is invalid (819ms)
    ✓ should reject an empty buffer object (378ms)
    ✓ should reject a null buffer object (382ms)
    ✓ should reject a number instead of an object (377ms)
    ✓ should reject an object without a filename (376ms)
    ✓ should reject an object without a buffer (381ms)

  Data API URL Construction Capabilities
    Get URL Construction
      ✓ should generate a get request url
      ✓ should not require a version
    Update URL Construction
      ✓ should generate a record update url (560ms)
      ✓ should not require a version (390ms)
    Delete URL Construction
      ✓ should generate a record delete url (383ms)
      ✓ should not require a version (385ms)
    Get URL Construction
      ✓ should generate a get record url (370ms)
      ✓ should not require a version (384ms)
    List URL Construction
      ✓ should generate a list records url
      ✓ should not require a version
    Find URL Construction
      ✓ should generate a find url
      ✓ should not require a version
    Logout URL Construction
      ✓ should generate a logout url
      ✓ should not require a version
    Globals URL Construction
      ✓ should generate a global url
      ✓ should not require a version
    Logout URL Construction
      ✓ should generate a logout url
      ✓ should not require a version
    Upload URL Construction
      ✓ should generate a upload url
      ✓ should not require a repetition
      ✓ should not require a version
    Authentication URL Construction
      ✓ should generate a authentication url
      ✓ should not require a version
    Database Layouts Metadata URL Construction
      ✓ should generate a database layouts metadata url
      ✓ should not require a version
    Layout Metadata URL Construction
      ✓ should generate a layout metadata url
      ✓ should not require a version
    Database Scripts Metadata URL Construction
      ✓ should generate a database scripts metadata url
      ✓ should not require a version
    Duplicate Record URL Construction
      ✓ should generate a duplicate record url
      ✓ should not require a version
    Product Info URL Construction
      ✓ should generate a product Info metadata url
      ✓ should not require a version
    Server Databases Metadata URL Construction
      ✓ should generate a server databases metadata url
      ✓ should not require a version
    Run a Script URL Construction
      ✓ should generate a server databases metadata url
      ✓ should not require a version

  Data Usage
    Tracks Data Usage
      ✓ should track API usage data. (550ms)
      ✓ should allow you to reset usage data. (393ms)
    Does Not Track Data Usage
      ✓ should not track data usage in (493ms)
      ✓ should not track data usage out (393ms)

  Conversion Utility Capabilities
    Omit Utility
      ✓ it should remove properties while maintaing the array
      ✓ it should remove properties while maintaing the object
    Parse Utility
      ✓ it should return a string when given a string
      ✓ it should return an object when given a stringified object
    isJSON Utility
      ✓ it should return true for an object
      ✓ it should return true for an empty object
      ✓ it should return true for a stringified object
      ✓ it should return false for a number
      ✓ it should return false for undefined
      ✓ it should return false for a string
      ✓ it should return false for null

  Filemaker Utility Capabilities
    filter Results
      ✓ it should pick an array of properties while maintaing the array
      ✓ it should pick an array of properties while maintaing the object
      ✓ it should pick a string property while maintaing the array
      ✓ it should pick a string property while maintaing the object


  269 passing (2m)

------------------------------|----------|----------|----------|----------|-------------------|
File                          |  % Stmts | % Branch |  % Funcs |  % Lines | Uncovered Line #s |
------------------------------|----------|----------|----------|----------|-------------------|
All files                     |      100 |      100 |      100 |      100 |                   |
 fms-api-client               |      100 |      100 |      100 |      100 |                   |
  index.js                    |      100 |      100 |      100 |      100 |                   |
 fms-api-client/src           |      100 |      100 |      100 |      100 |                   |
  index.js                    |      100 |      100 |      100 |      100 |                   |
 fms-api-client/src/models    |      100 |      100 |      100 |      100 |                   |
  agent.model.js              |      100 |      100 |      100 |      100 |                   |
  client.model.js             |      100 |      100 |      100 |      100 |                   |
  connection.model.js         |      100 |      100 |      100 |      100 |                   |
  credentials.model.js        |      100 |      100 |      100 |      100 |                   |
  data.model.js               |      100 |      100 |      100 |      100 |                   |
  index.js                    |      100 |      100 |      100 |      100 |                   |
  session.model.js            |      100 |      100 |      100 |      100 |                   |
 fms-api-client/src/services  |      100 |      100 |      100 |      100 |                   |
  container.service.js        |      100 |      100 |      100 |      100 |                   |
  index.js                    |      100 |      100 |      100 |      100 |                   |
  metadata.service.js         |      100 |      100 |      100 |      100 |                   |
  request.service.js          |      100 |      100 |      100 |      100 |                   |
  transform.service.js        |      100 |      100 |      100 |      100 |                   |
 fms-api-client/src/utilities |      100 |      100 |      100 |      100 |                   |
  conversion.utilities.js     |      100 |      100 |      100 |      100 |                   |
  filemaker.utilities.js      |      100 |      100 |      100 |      100 |                   |
  index.js                    |      100 |      100 |      100 |      100 |                   |
  urls.utilities.js           |      100 |      100 |      100 |      100 |                   |
------------------------------|----------|----------|----------|----------|-------------------|

Dependencies

  • axios: Promise based HTTP client for the browser and node.js
  • axios-cookiejar-support: Add tough-cookie support to axios.
  • form-data: A library to create readable "multipart/form-data" streams. Can be used to submit forms and file uploads to other web applications.
  • into-stream: Convert a string/promise/array/iterable/buffer/typedarray/arraybuffer/object into a stream
  • lodash: Lodash modular utilities.
  • marpat: A class-based ES6 ODM for Mongo-like databases.
  • mime-types: The ultimate javascript content-type utility.
  • moment: Parse, validate, manipulate, and display dates
  • object-sizeof: Sizeof of a JavaScript object in Bytes
  • prettysize: Convert bytes to other sizes for prettier logging
  • snyk: snyk library and cli utility
  • stream-to-array: Concatenate a readable stream's data into a single array
  • tough-cookie: RFC6265 Cookies and Cookie Jar for node.js
  • uuid: RFC4122 (v1, v4, and v5) UUIDs

Development Dependencies

  • chai: BDD/TDD assertion library for node.js and the browser. Test framework agnostic.
  • chai-as-promised: Extends Chai with assertions about promises.
  • coveralls: takes json-cov output into stdin and POSTs to coveralls.io
  • deep-map: Transforms nested values of complex objects
  • dotenv: Loads environment variables from .env file
  • es6-weak-map: ECMAScript6 WeakMap polyfill
  • eslint: An AST-based pattern checker for JavaScript.
  • eslint-config-google: ESLint shareable config for the Google style
  • eslint-config-prettier: Turns off all rules that are unnecessary or might conflict with Prettier.
  • eslint-plugin-prettier: Runs prettier as an eslint rule
  • fs-extra: fs-extra contains methods that aren't included in the vanilla Node.js fs package. Such as mkdir -p, cp -r, and rm -rf.
  • http-proxy: HTTP proxying for the masses
  • jsdoc: An API documentation generator for JavaScript.
  • jsdoc-to-markdown: Generates markdown API documentation from jsdoc annotated source code
  • minami: Clean and minimal JSDoc 3 Template / Theme
  • mocha: simple, flexible, fun test framework
  • mocha-lcov-reporter: LCOV reporter for Mocha
  • mos: A pluggable module that injects content into your markdown files via hidden JavaScript snippets
  • mos-plugin-dependencies: A mos plugin that creates dependencies sections
  • mos-plugin-execute: Mos plugin to inline a process output
  • mos-plugin-installation: A mos plugin for creating installation section
  • mos-plugin-license: A mos plugin for generating a license section
  • mos-plugin-snippet: A mos plugin for embedding snippets from files
  • nyc: the Istanbul command line interface
  • prettier: Prettier is an opinionated code formatter
  • sinon: JavaScript test spies, stubs and mocks.
  • varium: Declare and validate environment variables

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial