@jd-data-limited/easy-fm 3.2.8 → 4.0.0

package/src/types.d.ts

@@ -1,13 +1,7 @@
-/// <reference types="node" />
-/// <reference types="node" />
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
 import * as http from "http";
 import { FMError } from "./FMError.js";
-import { LayoutInterface } from "./layouts/layoutInterface";
-export interface DatabaseStructure {
-    layouts: {
-        [key: string]: LayoutInterface;
-    };
-}
 export interface databaseOptionsBase {
     database: string;
     credentials: loginOptionsOAuth | loginOptionsFileMaker | loginOptionsClaris | loginOptionsToken;
@@ -39,17 +33,18 @@ export interface loginOptionsClaris {
         fmid: string;
     };
 }
-export interface limitPortalsInterface {
-    portalName: string;
+export interface portalFetchData<T = string> {
+    portalName: T;
     offset: number;
     limit: number;
 }
+export type ScriptRequestData = {
+    prerequest?: Script;
+    presort?: Script;
+    after?: Script;
+};
 export interface extraBodyOptions {
-    scripts?: {
-        prerequest?: Script;
-        presort?: Script;
-        after?: Script;
-    };
+    scripts?: ScriptRequestData;
 }
 export declare enum DOWNLOAD_MODES {
     Stream = 0,
@@ -118,3 +113,11 @@ export interface AuthorizationHeadersOAuth {
     "X-FM-Data-OAuth-RequestId": string;
     "X-FM-Data-OAuth-Identifier": string;
 }
+export type RecordFetchOptions = {
+    readonly portals: readonly string[];
+};
+export declare enum RecordTypes {
+    UNKNOWN = 0,
+    LAYOUT = 1,
+    PORTAL = 2
+}

package/src/types.js

@@ -1,8 +1,14 @@
 /*
- * Copyright (c) 2022-2023. See LICENSE file for more information
+ * Copyright (c) 2022-2024. See LICENSE file for more information
  */
 export var DOWNLOAD_MODES;
 (function (DOWNLOAD_MODES) {
     DOWNLOAD_MODES[DOWNLOAD_MODES["Stream"] = 0] = "Stream";
     DOWNLOAD_MODES[DOWNLOAD_MODES["Buffer"] = 1] = "Buffer";
 })(DOWNLOAD_MODES || (DOWNLOAD_MODES = {}));
+export var RecordTypes;
+(function (RecordTypes) {
+    RecordTypes[RecordTypes["UNKNOWN"] = 0] = "UNKNOWN";
+    RecordTypes[RecordTypes["LAYOUT"] = 1] = "LAYOUT";
+    RecordTypes[RecordTypes["PORTAL"] = 2] = "PORTAL";
+})(RecordTypes || (RecordTypes = {}));

package/src/types.ts

@@ -1,19 +1,11 @@
 /*
- * Copyright (c) 2022-2023. See LICENSE file for more information
+ * Copyright (c) 2022-2024. See LICENSE file for more information
  */
 
 // const fetch = (...args) => import('node-fetch').then(({default: fetch}) => fetch(...args));
 // @ts-ignore
 import * as http from "http";
 import {FMError} from "./FMError.js";
-import {LayoutInterface} from "./layouts/layoutInterface";
-
-// import * as btoa from "btoa";
-export interface DatabaseStructure {
-    layouts: {
-        [key: string]: LayoutInterface
-    }
-}
 
 export interface databaseOptionsBase {
     database: string
@@ -52,18 +44,20 @@ export interface loginOptionsClaris {
     }
 }
 
-export interface limitPortalsInterface {
-    portalName: string,
+export interface portalFetchData<T = string> {
+    portalName: T,
     offset: number,
     limit: number
 }
 
+export type ScriptRequestData = {
+    prerequest?: Script,
+    presort?: Script,
+    after?: Script,
+}
+
 export interface extraBodyOptions {
-    scripts?: {
-        prerequest?: Script,
-        presort?: Script,
-        after?: Script,
-    }
+    scripts?: ScriptRequestData
 }
 
 export enum DOWNLOAD_MODES {
@@ -147,4 +141,14 @@ export interface AuthorizationHeadersOAuth {
     "Content-Type": "application/json"
     "X-FM-Data-OAuth-RequestId": string,
     "X-FM-Data-OAuth-Identifier": string
+}
+
+export type RecordFetchOptions = {
+    readonly portals: readonly string[]
+}
+
+export enum RecordTypes {
+    UNKNOWN,
+    LAYOUT,
+    PORTAL
 }

package/src/records/getOperations/find.d.ts

@@ -1,15 +0,0 @@
-import { RecordGetOperation } from "./recordGetOperation.js";
-import { LayoutRecord } from "../layoutRecord.js";
-import { LayoutInterface } from "../../layouts/layoutInterface";
-import { LayoutBase } from "../../layouts/layoutBase.js";
-export declare class Find<T extends LayoutInterface> extends RecordGetOperation<T> {
-    protected queries: object[];
-    constructor(layout: LayoutBase, start?: number, limit?: number);
-    private toObject;
-    addRequests(...requests: any[]): this;
-    /**
-     * @deprecated in favour of .fetch()
-     */
-    run(): Promise<LayoutRecord<T["fields"], T["portals"]>[]>;
-    fetch(): Promise<LayoutRecord<T["fields"], T["portals"]>[]>;
-}

package/src/records/getOperations/find.js

@@ -1,70 +0,0 @@
-/*
- * Copyright (c) 2023. See LICENSE file for more information
- */
-import { RecordGetOperation } from "./recordGetOperation.js";
-import { LayoutRecord } from "../layoutRecord.js";
-import { FMError } from "../../FMError.js";
-export class Find extends RecordGetOperation {
-    queries;
-    constructor(layout, start = 0, limit = 100) {
-        super(layout);
-        this.setOffset(start);
-        this.setLimit(limit);
-        this.queries = [];
-    }
-    toObject() {
-        let out = { query: this.queries, sort: undefined };
-        if (this.sort.length !== 0)
-            out.sort = this.sort;
-        for (let item of Object.keys(this.scripts)) {
-            if (this.scripts[item]) {
-                out[item] = this.scripts[item].name;
-                if (this.scripts[item].parameter)
-                    out[item + ".param"] = this.scripts[item].parameter;
-            }
-        }
-        if (this.limit !== 100)
-            out["limit"] = this.limit;
-        if (this.offset !== 0)
-            out["offset"] = this.offset;
-        if (this.limitPortals.length > 0) {
-            out["portal"] = this.limitPortals.map(p => p.portalName);
-            for (let item of this.limitPortals) {
-                out["offset." + item.portalName.replace(/[^0-9A-z]/g, "")] = item.offset;
-                out["limit." + item.portalName.replace(/[^0-9A-z]/g, "")] = item.limit;
-            }
-        }
-        return out;
-    }
-    addRequests(...requests) {
-        for (let item of requests)
-            this.queries.push(item);
-        return this;
-    }
-    /**
-     * @deprecated in favour of .fetch()
-     */
-    run() {
-        return this.fetch();
-    }
-    async fetch() {
-        let trace = new Error();
-        await this.layout.getLayoutMeta();
-        let res = await this.layout.database.apiRequest(`${this.layout.endpoint}/_find`, {
-            port: 443,
-            method: "POST",
-            body: JSON.stringify(this.toObject())
-        });
-        if (res.messages[0].code === "0") {
-            // console.log("RESOLVING")
-            if (!this.layout.metadata)
-                await this.layout.getLayoutMeta();
-            return res.response.data.map(item => {
-                return new LayoutRecord(this.layout, item.recordId, item.modId, item.fieldData, item.portalData);
-            });
-        }
-        else {
-            throw new FMError(res.messages[0].code, res.httpStatus, res, trace);
-        }
-    }
-}

package/src/records/getOperations/find.ts

@@ -1,77 +0,0 @@
-/*
- * Copyright (c) 2023. See LICENSE file for more information
- */
-
-import {RecordGetOperation} from "./recordGetOperation.js";
-import {LayoutRecord} from "../layoutRecord.js";
-import {LayoutInterface} from "../../layouts/layoutInterface";
-import {LayoutBase} from "../../layouts/layoutBase.js";
-import {FMError} from "../../FMError.js";
-import {ApiRecordResponseObj} from "../../models/apiResults";
-
-export class Find<T extends LayoutInterface> extends RecordGetOperation<T> {
-    protected queries: object[]
-
-    constructor(layout: LayoutBase, start = 0, limit = 100) {
-        super(layout)
-        this.setOffset(start)
-        this.setLimit(limit)
-        this.queries = []
-    }
-
-    private toObject() {
-        let out = {query: this.queries, sort: undefined}
-        if (this.sort.length !== 0) out.sort = this.sort
-
-        for (let item of Object.keys(this.scripts)) {
-            if (this.scripts[item]) {
-                out[item] = this.scripts[item].name
-                if (this.scripts[item].parameter) out[item + ".param"] = this.scripts[item].parameter
-            }
-        }
-
-        if (this.limit !== 100) out["limit"] = this.limit
-        if (this.offset !== 0) out["offset"] = this.offset
-        if (this.limitPortals.length > 0) {
-            out["portal"] = this.limitPortals.map(p => p.portalName)
-            for (let item of this.limitPortals) {
-                out["offset." + item.portalName.replace(/[^0-9A-z]/g, "")] = item.offset
-                out["limit." + item.portalName.replace(/[^0-9A-z]/g, "")] = item.limit
-            }
-        }
-
-        return out
-    }
-
-    addRequests(...requests) {
-        for (let item of requests) this.queries.push(item)
-        return this
-    }
-
-    /**
-     * @deprecated in favour of .fetch()
-     */
-    run() {
-        return this.fetch()
-    }
-
-    async fetch(): Promise<LayoutRecord<T["fields"], T["portals"]>[]> {
-        let trace = new Error()
-        await this.layout.getLayoutMeta()
-        let res = await this.layout.database.apiRequest<ApiRecordResponseObj>(`${this.layout.endpoint}/_find`, {
-            port: 443,
-            method: "POST",
-            body: JSON.stringify(this.toObject())
-        })
-        if (res.messages[0].code === "0") {
-            // console.log("RESOLVING")
-            if (!this.layout.metadata) await this.layout.getLayoutMeta()
-            return res.response.data.map(item => {
-                return new LayoutRecord(this.layout, item.recordId, item.modId, item.fieldData, item.portalData)
-            })
-        }
-        else {
-            throw new FMError(res.messages[0].code, res.httpStatus, res, trace)
-        }
-    }
-}

package/src/records/getOperations/recordGetRange.d.ts

@@ -1,13 +0,0 @@
-import { LayoutInterface } from "../../layouts/layoutInterface.js";
-import { RecordGetOperation } from "./recordGetOperation.js";
-import { LayoutRecord } from "../layoutRecord.js";
-import { extraBodyOptions } from "../../types.js";
-export declare class RecordGetRange<T extends LayoutInterface> extends RecordGetOperation<T> {
-    constructor(layout: any, start?: number, limit?: number);
-    private generateQueryParams;
-    /**
-     * @deprecated in favour of .fetch()
-     */
-    run(extraBody?: extraBodyOptions): Promise<LayoutRecord<T["fields"], T["portals"]>[]>;
-    fetch(extraBody?: extraBodyOptions): Promise<LayoutRecord<T["fields"], T["portals"]>[]>;
-}

package/src/records/getOperations/recordGetRange.js

@@ -1,77 +0,0 @@
-/*
- * Copyright (c) 2023. See LICENSE file for more information
- */
-import { RecordGetOperation } from "./recordGetOperation.js";
-import { LayoutRecord } from "../layoutRecord.js";
-import { FMError } from "../../FMError.js";
-export class RecordGetRange extends RecordGetOperation {
-    constructor(layout, start = 0, limit = 100) {
-        super(layout);
-        this.setOffset(start);
-        this.setLimit(limit);
-    }
-    generateQueryParams(extraBody = {}) {
-        let params = [];
-        if (this.limit !== 100)
-            params.push("_limit=" + this.limit);
-        if (this.offset !== 0)
-            params.push("_offset=" + this.offset);
-        if (this.sort.length > 0)
-            params.push("_sort=" + encodeURI(JSON.stringify(this.sort)));
-        if (this.limitPortals.length > 0) {
-            params.push("portal=" + encodeURI(JSON.stringify(this.limitPortals.map(p => p.portalName))));
-            for (let item of this.limitPortals) {
-                if (item.offset !== 0)
-                    params.push("_offset." + item.portalName.replace(/[^0-9A-z]/g, "") + "=" + item.offset);
-                if (item.limit !== 100)
-                    params.push("_limit." + item.portalName.replace(/[^0-9A-z]/g, "") + "=" + item.limit);
-            }
-        }
-        if (extraBody.scripts) {
-            if (extraBody.scripts.prerequest) {
-                params.push("script.prerequest=" + extraBody.scripts.prerequest.name);
-                if (extraBody.scripts.prerequest.parameter)
-                    params.push("script.prerequest.param=" + extraBody.scripts.prerequest.parameter);
-            }
-            if (extraBody.scripts.presort) {
-                params.push("script.presort=" + extraBody.scripts.presort.name);
-                if (extraBody.scripts.presort.parameter)
-                    params.push("script.presort.param=" + extraBody.scripts.presort.parameter);
-            }
-            if (extraBody.scripts.after) {
-                params.push("script=" + extraBody.scripts.after.name);
-                if (extraBody.scripts.after.parameter)
-                    params.push("script.param=" + extraBody.scripts.after.parameter);
-            }
-        }
-        if (params.length === 0)
-            return "";
-        return "?" + params.join("&");
-    }
-    /**
-     * @deprecated in favour of .fetch()
-     */
-    run(extraBody = {}) {
-        return this.fetch(extraBody);
-    }
-    async fetch(extraBody = {}) {
-        let trace = new Error();
-        let res = await this.layout.getLayoutMeta().then(() => {
-            return this.layout.database.apiRequest(`${this.layout.endpoint}/records${this.generateQueryParams(extraBody)}`, {
-                method: "GET"
-            });
-        });
-        if (res.messages[0].code === "0") {
-            // console.log("RESOLVING")
-            if (!this.layout.metadata)
-                await this.layout.getLayoutMeta();
-            let data = res.response.data.map(item => {
-                return new LayoutRecord(this.layout, item.recordId, item.modId, item.fieldData, item.portalData);
-            });
-            return data;
-        }
-        else {
-            throw new FMError(res.messages[0].code, res.httpStatus, res, trace);
-        }
-    }
-}

package/src/records/getOperations/recordGetRange.ts

@@ -1,77 +0,0 @@
-/*
- * Copyright (c) 2023. See LICENSE file for more information
- */
-
-import {LayoutInterface} from "../../layouts/layoutInterface.js";
-import {RecordGetOperation} from "./recordGetOperation.js";
-import {LayoutRecord} from "../layoutRecord.js";
-import {extraBodyOptions} from "../../types.js";
-import {FMError} from "../../FMError.js";
-import {ApiRecordResponseObj} from "../../models/apiResults";
-
-export class RecordGetRange<T extends LayoutInterface> extends RecordGetOperation<T> {
-    constructor(layout, start = 0, limit = 100) {
-        super(layout)
-        this.setOffset(start)
-        this.setLimit(limit)
-    }
-
-    private generateQueryParams(extraBody: extraBodyOptions = {}) {
-        let params = []
-        if (this.limit !== 100) params.push("_limit=" + this.limit)
-        if (this.offset !== 0) params.push("_offset=" + this.offset)
-        if (this.sort.length > 0) params.push("_sort=" + encodeURI(JSON.stringify(this.sort)))
-        if (this.limitPortals.length > 0) {
-            params.push("portal=" + encodeURI(JSON.stringify(this.limitPortals.map(p => p.portalName))))
-            for (let item of this.limitPortals) {
-                if (item.offset !== 0) params.push("_offset." + item.portalName.replace(/[^0-9A-z]/g, "") + "=" + item.offset)
-                if (item.limit !== 100) params.push("_limit." + item.portalName.replace(/[^0-9A-z]/g, "") + "=" + item.limit)
-            }
-        }
-        if (extraBody.scripts) {
-            if (extraBody.scripts.prerequest) {
-                params.push("script.prerequest=" + extraBody.scripts.prerequest.name)
-                if (extraBody.scripts.prerequest.parameter) params.push("script.prerequest.param=" + extraBody.scripts.prerequest.parameter)
-            }
-            if (extraBody.scripts.presort) {
-                params.push("script.presort=" + extraBody.scripts.presort.name)
-                if (extraBody.scripts.presort.parameter) params.push("script.presort.param=" + extraBody.scripts.presort.parameter)
-            }
-            if (extraBody.scripts.after) {
-                params.push("script=" + extraBody.scripts.after.name)
-                if (extraBody.scripts.after.parameter) params.push("script.param=" + extraBody.scripts.after.parameter)
-            }
-        }
-
-        if (params.length === 0) return ""
-        return "?" + params.join("&")
-    }
-
-    /**
-     * @deprecated in favour of .fetch()
-     */
-    run(extraBody: extraBodyOptions = {}): Promise<LayoutRecord<T["fields"], T["portals"]>[]> {
-        return this.fetch(extraBody)
-    }
-
-    async fetch(extraBody: extraBodyOptions = {}): Promise<LayoutRecord<T["fields"], T["portals"]>[]> {
-        let trace = new Error()
-        let res = await this.layout.getLayoutMeta().then(() => {
-            return this.layout.database.apiRequest<ApiRecordResponseObj>(`${this.layout.endpoint}/records${this.generateQueryParams(extraBody)}`, {
-                method: "GET"
-            })
-        })
-
-        if (res.messages[0].code === "0") {
-            // console.log("RESOLVING")
-            if (!this.layout.metadata) await this.layout.getLayoutMeta()
-            let data = res.response.data.map(item => {
-                return new LayoutRecord(this.layout, item.recordId, item.modId, item.fieldData, item.portalData)
-            })
-            return data
-        }
-        else {
-            throw new FMError(res.messages[0].code, res.httpStatus, res, trace)
-        }
-    }
-}

package/src/records/portalRecordBase.d.ts

@@ -1,4 +0,0 @@
-import { RecordBase } from "./recordBase";
-import { RecordFieldsMap } from "../layouts/recordFieldsMap";
-export declare class PortalRecordBase<T extends RecordFieldsMap> extends RecordBase<T> {
-}

package/src/records/portalRecordBase.js

@@ -1,6 +0,0 @@
-/*
- * Copyright (c) 2023. See LICENSE file for more information
- */
-import { RecordBase } from "./recordBase";
-export class PortalRecordBase extends RecordBase {
-}