@jd-data-limited/easy-fm 3.0.9 → 3.1.0

package/src/records/recordBase.d.ts

@@ -0,0 +1,20 @@
+import { EventEmitter } from "events";
+import { Field } from "./field";
+import { Layout } from "../layouts/layout";
+import { FieldValue, RecordFieldsMap } from "../layouts/layoutInterface";
+import { recordObject } from "../types.js";
+export declare class RecordBase<T extends RecordFieldsMap> extends EventEmitter {
+    readonly layout: Layout<any>;
+    recordId: number;
+    modId: number;
+    fields: T;
+    protected portalData: any[];
+    constructor(layout: any, recordId: any, modId?: any);
+    get endpoint(): string;
+    get edited(): boolean;
+    get fieldsArray(): Field<FieldValue>[];
+    protected processFieldData(fieldData: any): T;
+    _onSave(): void;
+    getField(field: any): Field<FieldValue>;
+    toObject(filter?: (a: any) => any, portalFilter?: (a: any) => any, portalRowFilter?: (a: any) => any, portalFieldFilter?: (a: any) => any): recordObject;
+}

package/src/records/recordBase.js

@@ -0,0 +1,95 @@
+/*
+ * Copyright (c) 2023. See LICENSE file for more information
+ */
+import { EventEmitter } from "events";
+import * as moment from "moment/moment";
+import { Field } from "./field";
+export class RecordBase extends EventEmitter {
+    constructor(layout, recordId, modId = recordId) {
+        super();
+        this.layout = layout;
+        this.recordId = recordId;
+        this.modId = modId;
+    }
+    get endpoint() {
+        return `${this.layout.endpoint}/records/${this.recordId}`;
+    }
+    get edited() {
+        return !!this.fieldsArray.find(i => i.edited);
+    }
+    get fieldsArray() {
+        return Object.values(this.fields);
+    }
+    processFieldData(fieldData) {
+        let fields = {};
+        for (let key of Object.keys(fieldData)) {
+            let _field = new Field(this, key, fieldData[key]);
+            if (!!fieldData[key]) {
+                if (_field.metadata.result === "timeStamp") {
+                    // @ts-ignore
+                    let date = moment.default(fieldData[key], this.layout.database.host.metadata.productInfo.timeStampFormat.replace("dd", "DD"))
+                        .utcOffset(this.layout.database.host.timezoneOffset, true)
+                        .local();
+                    _field.set(date.toDate());
+                    _field.edited = false;
+                }
+                else if (_field.metadata.result === "time") {
+                    // @ts-ignore
+                    let date = moment.default(fieldData[key], this.layout.database.host.metadata.productInfo.timeFormat.replace("dd", "DD"))
+                        .utcOffset(this.layout.database.host.timezoneOffset, true)
+                        .local();
+                    _field.set(date.toDate());
+                    _field.edited = false;
+                }
+                else if (_field.metadata.result === "date") {
+                    // @ts-ignore
+                    let date = moment.default(fieldData[key], this.layout.database.host.metadata.productInfo.dateFormat.replace("dd", "DD"))
+                        .utcOffset(this.layout.database.host.timezoneOffset, true)
+                        .local();
+                    _field.set(date.toDate());
+                    _field.edited = false;
+                }
+            }
+            fields[key] = _field;
+        }
+        this.fields = fields;
+        return fields;
+    }
+    _onSave() {
+        this.emit("saved");
+        for (let field of this.fieldsArray)
+            field.edited = false;
+    }
+    getField(field) {
+        return this.fieldsArray.find(_field => _field.id === field);
+    }
+    toObject(filter = (a) => a.edited, portalFilter = (a) => a.records.find(record => record.edited), portalRowFilter = (a) => a.edited, portalFieldFilter = (a) => a.edited) {
+        let fields_processed = {};
+        for (let field of this.fieldsArray.filter(field => filter(field))) {
+            let value = field.value;
+            if (value instanceof Date) {
+                // @ts-ignore
+                let _value = moment.default(value)
+                    .utcOffset(this.layout.database.host.timezoneOffset);
+                // @ts-ignore
+                switch (field.metadata.result) {
+                    case "time":
+                        value = _value.format(this.layout.database.host.metadata.productInfo.timeFormat.replace("dd", "DD"));
+                        break;
+                    case "date":
+                        value = _value.format(this.layout.database.host.metadata.productInfo.dateFormat.replace("dd", "DD"));
+                        break;
+                    default:
+                        value = _value.format(this.layout.database.host.metadata.productInfo.timeStampFormat.replace("dd", "DD"));
+                }
+            }
+            fields_processed[field.id] = value;
+        }
+        let obj = {
+            "recordId": this.recordId,
+            "modId": this.modId,
+            "fieldData": fields_processed
+        };
+        return obj;
+    }
+}

package/src/records/recordBase.ts

@@ -0,0 +1,121 @@
+/*
+ * Copyright (c) 2023. See LICENSE file for more information
+ */
+
+import {EventEmitter} from "events";
+import * as moment from "moment/moment";
+import {Field} from "./field";
+import {Portal} from "./portal";
+import {Layout} from "../layouts/layout";
+import {FieldValue, RecordFieldsMap} from "../layouts/layoutInterface";
+import {recordObject} from "../types.js";
+
+export class RecordBase<T extends RecordFieldsMap> extends EventEmitter {
+    readonly layout: Layout<any>;
+    public recordId: number;
+    modId: number;
+    fields: T
+    protected portalData: any[];
+
+    constructor(layout, recordId, modId = recordId) {
+        super();
+        this.layout = layout
+        this.recordId = recordId
+        this.modId = modId
+    }
+
+    get endpoint(): string {
+        return `${this.layout.endpoint}/records/${this.recordId}`
+    }
+
+    get edited(): boolean {
+        return !!this.fieldsArray.find(i => i.edited)
+    }
+
+    get fieldsArray() {
+        return Object.values(this.fields)
+    }
+
+    protected processFieldData(fieldData) {
+        let fields: RecordFieldsMap = {}
+
+        for (let key of Object.keys(fieldData)) {
+            let _field = new Field(this, key, fieldData[key])
+            if (!!fieldData[key]) {
+                if (_field.metadata.result === "timeStamp") {
+                    // @ts-ignore
+                    let date = moment.default(fieldData[key], this.layout.database.host.metadata.productInfo.timeStampFormat.replace("dd", "DD"))
+                        .utcOffset(this.layout.database.host.timezoneOffset, true)
+                        .local()
+                    _field.set(date.toDate())
+                    _field.edited = false
+
+                }
+                else if (_field.metadata.result === "time") {
+                    // @ts-ignore
+                    let date = moment.default(fieldData[key], this.layout.database.host.metadata.productInfo.timeFormat.replace("dd", "DD"))
+                        .utcOffset(this.layout.database.host.timezoneOffset, true)
+                        .local()
+                    _field.set(date.toDate())
+                    _field.edited = false
+                }
+                else if (_field.metadata.result === "date") {
+                    // @ts-ignore
+                    let date = moment.default(fieldData[key], this.layout.database.host.metadata.productInfo.dateFormat.replace("dd", "DD"))
+                        .utcOffset(this.layout.database.host.timezoneOffset, true)
+                        .local()
+                    _field.set(date.toDate())
+                    _field.edited = false
+                }
+            }
+            fields[key] = _field
+        }
+        this.fields = fields as T
+        return fields as T
+    }
+
+    _onSave() {
+        this.emit("saved")
+        for (let field of this.fieldsArray) field.edited = false
+    }
+
+    getField(field) {
+        return this.fieldsArray.find(_field => _field.id === field)
+    }
+
+    toObject(filter = (a) => a.edited,
+             portalFilter = (a) => a.records.find(record => record.edited),
+             portalRowFilter = (a) => a.edited,
+             portalFieldFilter = (a) => a.edited
+    ): recordObject {
+        let fields_processed = {}
+        for (let field of this.fieldsArray.filter(field => filter(field))) {
+            let value = field.value
+            if (value instanceof Date) {
+                // @ts-ignore
+                let _value = moment.default(value)
+                    .utcOffset(this.layout.database.host.timezoneOffset)
+
+                // @ts-ignore
+
+                switch (field.metadata.result) {
+                    case "time":
+                        value = _value.format(this.layout.database.host.metadata.productInfo.timeFormat.replace("dd", "DD"))
+                        break
+                    case "date":
+                        value = _value.format(this.layout.database.host.metadata.productInfo.dateFormat.replace("dd", "DD"))
+                        break
+                    default:
+                        value = _value.format(this.layout.database.host.metadata.productInfo.timeStampFormat.replace("dd", "DD"))
+                }
+            }
+            fields_processed[field.id] = value
+        }
+        let obj = {
+            "recordId": this.recordId,
+            "modId": this.modId,
+            "fieldData": fields_processed
+        }
+        return obj
+    }
+}

package/src/types.d.ts

@@ -0,0 +1,117 @@
+import * as http from "http";
+import { Portal } from "./records/portal";
+import { FMError } from "./FMError";
+export interface databaseOptionsBase {
+    database: string;
+    credentials: loginOptionsOAuth | loginOptionsFileMaker | loginOptionsClaris | loginOptionsToken;
+}
+export interface databaseOptionsWithExternalSources extends databaseOptionsBase {
+    database: string;
+    credentials: loginOptionsOAuth | loginOptionsFileMaker | loginOptionsClaris | loginOptionsToken;
+    externalSources: databaseOptionsBase[];
+}
+export interface loginOptionsToken {
+    method: "token";
+    token: string;
+}
+export interface loginOptionsOAuth {
+    method: "oauth";
+    oauth: {
+        requestId: string;
+        requestIdentifier: string;
+    };
+}
+export interface loginOptionsFileMaker {
+    method: "filemaker";
+    username: string;
+    password: string;
+}
+export interface loginOptionsClaris {
+    method: "claris";
+    claris: {
+        fmid: string;
+    };
+}
+export interface limitPortalsInterface {
+    portal: Portal<any>;
+    offset: number;
+    limit: number;
+}
+export interface extraBodyOptions {
+    scripts?: {
+        prerequest?: Script;
+        presort?: Script;
+        after?: Script;
+    };
+}
+export declare enum DOWNLOAD_MODES {
+    Stream = 0,
+    Buffer = 1
+}
+export interface Script {
+    name: string;
+    parameter: string;
+}
+export interface recordObject {
+    recordId: number;
+    modId: number;
+    fieldData: any;
+    portalData?: portalDataObject;
+}
+export interface fileMakerResponse {
+    response: any;
+    messages: any[];
+}
+export interface portalDataObject {
+    [key: string]: recordObject;
+}
+export interface FieldMetaData {
+    name: string;
+    type: string;
+    displayType: string;
+    result: string;
+    global: boolean;
+    autoEnter: boolean;
+    fourDigitYear: boolean;
+    maxRepeat: number;
+    maxCharacters: number;
+    notEmpty: boolean;
+    numeric: boolean;
+    timeOfDay: false;
+    repetitionStart: number;
+    repetitionEnd: number;
+}
+export interface LayoutMetaData {
+    fieldMetaData: FieldMetaData[];
+    portalMetaData?: {
+        [key: string]: FieldMetaData[];
+    };
+}
+export interface FMHostMetadata {
+    productInfo: {
+        buildDate: Date;
+        name: string;
+        version: string;
+        dateFormat: string;
+        timeFormat: string;
+        timeStampFormat: string;
+    };
+}
+export interface ScriptResult {
+    scriptError?: FMError;
+    scriptResult?: string;
+}
+export interface ContainerBufferResult {
+    buffer: Buffer;
+    mime: string;
+    request: http.IncomingMessage;
+}
+export interface AuthorizationHeaders {
+    "Content-Type": "application/json";
+    Authorization: string;
+}
+export interface AuthorizationHeadersOAuth {
+    "Content-Type": "application/json";
+    "X-FM-Data-OAuth-RequestId": string;
+    "X-FM-Data-OAuth-Identifier": string;
+}

package/src/types.js

@@ -0,0 +1,8 @@
+/*
+ * Copyright (c) 2022-2023. 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 = {}));

package/src/types.ts

@@ -0,0 +1,151 @@
+/*
+ * Copyright (c) 2022-2023. See LICENSE file for more information
+ */
+
+// const fetch = (...args) => import('node-fetch').then(({default: fetch}) => fetch(...args));
+// @ts-ignore
+import * as moment from "moment"
+import * as http from "http";
+import {Portal} from "./records/portal";
+import {FMError} from "./FMError";
+
+// import * as btoa from "btoa";
+export interface databaseOptionsBase {
+    database: string
+    credentials: loginOptionsOAuth | loginOptionsFileMaker | loginOptionsClaris | loginOptionsToken,
+}
+
+export interface databaseOptionsWithExternalSources extends databaseOptionsBase {
+    database: string
+    credentials: loginOptionsOAuth | loginOptionsFileMaker | loginOptionsClaris | loginOptionsToken,
+    externalSources: databaseOptionsBase[]
+}
+
+export interface loginOptionsToken {
+    method: "token"
+    token: string
+}
+
+export interface loginOptionsOAuth {
+    method: "oauth"
+    oauth: {
+        requestId: string,
+        requestIdentifier: string
+    }
+}
+
+export interface loginOptionsFileMaker {
+    method: "filemaker"
+    username: string,
+    password: string,
+}
+
+export interface loginOptionsClaris {
+    method: "claris"
+    claris: {
+        fmid: string
+    }
+}
+
+export interface limitPortalsInterface {
+    portal: Portal<any>,
+    offset: number,
+    limit: number
+}
+
+export interface extraBodyOptions {
+    scripts?: {
+        prerequest?: Script,
+        presort?: Script,
+        after?: Script,
+    }
+}
+
+export enum DOWNLOAD_MODES {
+    Stream,
+    Buffer
+}
+
+export interface Script {
+    name: string
+    parameter: string
+}
+
+export interface recordObject {
+    recordId: number
+    modId: number,
+    fieldData: any,
+    portalData?: portalDataObject
+}
+
+export interface fileMakerResponse {
+    response: any,
+    messages: any[]
+}
+
+export interface portalDataObject {
+    [key: string]: recordObject
+}
+
+export interface FieldMetaData {
+    name: string,
+    type: string,
+    displayType: string,
+    result: string,
+    global: boolean,
+    autoEnter: boolean,
+    fourDigitYear: boolean,
+    maxRepeat: number,
+    maxCharacters: number,
+    notEmpty: boolean,
+    numeric: boolean,
+    timeOfDay: false,
+    repetitionStart: number,
+    repetitionEnd: number
+}
+
+export interface LayoutMetaData {
+    fieldMetaData: FieldMetaData[],
+    portalMetaData?: {
+        [key: string]: FieldMetaData[]
+    }
+}
+
+export interface FMHostMetadata {
+    productInfo: {
+        buildDate: Date,
+        name: string,
+        version: string,
+        dateFormat: string,
+        timeFormat: string,
+        timeStampFormat: string
+    }
+}
+
+export interface ScriptResult {
+    scriptError?: FMError,
+    scriptResult?: string
+}
+
+export interface ContainerBufferResult {
+    buffer: Buffer,
+    mime: string,
+    request: http.IncomingMessage
+}
+
+//
+// module.exports = {
+//     default: {FileMakerConnection}
+// }
+
+export interface AuthorizationHeaders {
+    "Content-Type": "application/json"
+    Authorization: string
+}
+
+export interface AuthorizationHeadersOAuth {
+    "Content-Type": "application/json"
+    "X-FM-Data-OAuth-RequestId": string,
+    "X-FM-Data-OAuth-Identifier": string
+}
+

package/test.d.ts

@@ -0,0 +1 @@
+export {};

package/test.js

@@ -0,0 +1,4 @@
+/*
+ * Copyright (c) 2023. See LICENSE file for more information
+ */
+export {};

package/tsconfig.json

@@ -4,7 +4,11 @@
     "module": "es2022",
     "lib": ["es2021.intl", "es2015"],
     "moduleResolution": "Node",
+    "declaration": true
   },
+  "exclude": [
+    "node_modules"
+  ],
   "files": [
     "src/index.ts"
   ]