https://github.com/jwillinghalpern/fm-gofer
An easy fetch-like promise library for FileMaker WebViewer apps and widgets.
https://github.com/jwillinghalpern/fm-gofer
browser filemaker filemaker-scripts filemaker-webviewer-apps javascript javascript-library webviewer
Last synced: 8 months ago
JSON representation
An easy fetch-like promise library for FileMaker WebViewer apps and widgets.
- Host: GitHub
- URL: https://github.com/jwillinghalpern/fm-gofer
- Owner: jwillinghalpern
- License: isc
- Created: 2021-03-25T07:09:24.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-11-21T15:05:01.000Z (over 1 year ago)
- Last Synced: 2025-09-05T18:35:38.393Z (9 months ago)
- Topics: browser, filemaker, filemaker-scripts, filemaker-webviewer-apps, javascript, javascript-library, webviewer
- Language: TypeScript
- Homepage:
- Size: 1.06 MB
- Stars: 23
- Watchers: 6
- Forks: 2
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# fm-gofer
Promises in FM Web Viewers!
It's like fetch() for FileMaker! Go'fer some data. Call FileMaker scripts from JavaScript in a web viewer and get the response back using async/await.
## Try it
Check out `./example/FMGofer.fmp12`. This example demostrates the callback, resolve, reject, and timeout capabilities of the library. You can rebuild the example code used in the fm file by running `npm run build && npm run build:example`. This will output an html file in example/dist/index.html, which can be used in a FM webviewer.
## Install fm-gofer in your JS project
```bash
npm install --save fm-gofer
```
## Usage
### Import fm-gofer
#### `import` syntax
```javascript
import FMGofer, { Option } from 'fm-gofer';
```
#### `require` syntax
```javascript
const FMGofer = require('fm-gofer');
const { Option } = FMGofer;
```
#### Via CDN for convenience
```html
```
#### Or copy into yout HTML if you really want
```html
// This will set a global window property FMGofer
(copy of ./dist/fm-gofer.umd.cjs)
```
### Use fm-gofer
#### In your JS
```javascript
import FMGofer, { Option } from 'fm-gofer';
const a = await FMGofer.PerformScript('FM Script', param);
// use the Option enum to specify the script option in human-readable form:
const b = await FMGofer.PerformScriptWithOption(
'FM Script',
param,
Option.SuspendAndResume
);
// Set a custom timeout/timeout message if the default to wait indefinitely is too long
import FMGofer, { Option } from 'fm-gofer';
const c = await FMGofer.PerformScript('FM Script', param, 5000, 'timed out!');
const d = await FMGofer.PerformScriptWithOption(
'FM Script',
param,
Option.SuspendAndResume,
5000,
'timed out!'
);
// Or if you file returns JSON, you can use the json() method to parse the result
const parsedData = await FMGofer.PerformScript('FM Script').json();
```
#### In your FileMaker script
To return data to JS, extract `callbackName` and `promiseID` from `Get ( ScriptParameter )`, and use it to call back to JS and resolve/reject the promise. Pass `True` as the last param ("failed") to reject the promise.
```bash
Set Variable [ $callbackName ; JSONGetElement ( Get(ScriptParameter) ; "callbackName" ) ]
Set Variable [ $promiseID ; JSONGetElement ( Get(ScriptParameter) ; "promiseID" ) ]
# this contains param data sent from JS
Set Variable [ $parameter ; JSONGetElement ( Get(ScriptParameter) ; "parameter" ) ]
# callback to JS like this:
# (leave the third parameter slot empty or False to indicate a success. Or set to True to indicate an error)
Perform JavaScript in Web Viewer [ Object Name: "myWebview" ; Function Name: $callbackName ; Parameters: $promiseID, 'Success! Hello from FM!' ]
```
#### TypeScript support
```typescript
// You can assert the shape of the result returned from FM using typescript!
interface MyResult {
name: string;
age: number;
}
const j = await FMGofer.PerformScript('FM Script', param).json();
// Nested properties auto-complete in VSCode now!
const name = j.name;
const age = j.age;
```
## MISC
### Test
```bash
npm test
```
### Build
```bash
npm run build
```
## Contribute
If you see anything that should be improved please feel free to let me know or send pull requests.