@jd-data-limited/easy-fm 3.1.6 → 3.1.7

package/README.md

@@ -7,7 +7,21 @@ a [FileMaker database](https://www.claris.com/filemaker/) stored on
 a [FileMaker server](https://www.claris.com/filemaker/server/)
 or [FileMaker Cloud](https://store.claris.com/filemaker-cloud). This module interacts with your server using the
 [FileMaker Data API](https://help.claris.com/en/data-api-guide/content/index.html).
-
+<!-- TOC -->
+* [easy-fm](#easy-fm)
+  * [FileMaker setup instructions](#filemaker-setup-instructions)
+  * [Before you begin](#before-you-begin)
+  * [Connecting to a database](#connecting-to-a-database)
+  * [Getting records](#getting-records)
+    * [Fetch a range of records](#fetch-a-range-of-records)
+    * [Searching for records](#searching-for-records)
+    * [Fetch a record using its record ID (NOT RECOMMENDED)](#fetch-a-record-using-its-record-id-not-recommended)
+    * [Create a record](#create-a-record)
+    * [Modify a record](#modify-a-record)
+* [Field names](#field-names)
+* [Portal names](#portal-names)
+* [Typescript Implementation](#typescript-implementation)
+<!-- TOC -->
 ## FileMaker setup instructions
 
 1. Enable the FileMaker Data API from the server's admin console. This setting is located
@@ -20,7 +34,7 @@ or [FileMaker Cloud](https://store.claris.com/filemaker-cloud). This module inte
 ## 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.
+    - Running `0 - (new Date()).getTimezoneOffset()` in javascript will give you the UTC time offset for your current timezone.
 
 ## Connecting to a database
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jd-data-limited/easy-fm",
-  "version": "3.1.6",
+  "version": "3.1.7",
   "dependencies": {
     "@types/btoa": "^1.2.3",
     "@types/events": "^3.0.0",

package/src/connection/database.d.ts

@@ -2,6 +2,7 @@
 /// <reference types="node" />
 import { EventEmitter } from "events";
 import { Request } from "node-fetch";
+import { LayoutInterface } from "../layouts/layoutInterface.js";
 import { Layout } from "../layouts/layout.js";
 import * as http from "http";
 import { databaseOptionsWithExternalSources, DatabaseStructure, Script } from "../types.js";
@@ -21,6 +22,7 @@ export declare class Database<T extends DatabaseStructure> extends EventEmitter
     get endpoint(): string;
     apiRequest<T = any>(url: string | Request, options?: any, autoRelogin?: boolean): Promise<T>;
     getLayout<R extends string>(name: R): Layout<T["layouts"][R]>;
+    getLayout<R extends LayoutInterface>(name: string): Layout<R>;
     setGlobals(globalFields: any): Promise<void>;
     script(name: any, parameter?: string): Script;
     _tokenExpired(): void;

package/src/connection/database.ts

@@ -21,6 +21,8 @@ import {
 import {HostBase} from "./HostBase.js"
 import {DatabaseBase} from "./databaseBase";
 
+type GetLayoutReturnType<T extends DatabaseStructure, R extends LayoutInterface | string> = R extends string ? T["layouts"][R] : R
+
 export class Database<T extends DatabaseStructure> extends EventEmitter implements DatabaseBase {
     private _token: any;
     readonly host: HostBase;
@@ -143,8 +145,10 @@ export class Database<T extends DatabaseStructure> extends EventEmitter implemen
         return (data as any)
     }
 
-    getLayout<R extends string>(name: R): Layout<T["layouts"][R]> {
-        return new Layout<T["layouts"][R]>(this, name)
+    getLayout<R extends string>(name: R): Layout<T["layouts"][R]>
+    getLayout<R extends LayoutInterface>(name: string): Layout<R>
+    getLayout(name: string): Layout<LayoutInterface> {
+        return new Layout<LayoutInterface>(this, name)
     }
 
     setGlobals(globalFields): Promise<void> {