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

package/src/layouts/layout.ts

@@ -1,21 +1,19 @@
 /*
- * Copyright (c) 2023. See LICENSE file for more information
+ * Copyright (c) 2023-2024. See LICENSE file for more information
  */
 
 import {LayoutRecordManager} from "./layoutRecordManager.js";
-import {LayoutRecord} from "../records/layoutRecord.js";
 import {Script, ScriptResult} from "../types.js";
 import {LayoutInterface} from "./layoutInterface.js";
-import {Find} from "../records/getOperations/find.js";
 import {FMError} from "../FMError.js";
 import {LayoutBase} from "./layoutBase.js"
-import {DatabaseBase} from "../connection/databaseBase";
-import {ApiLayoutMetadata, ApiScriptResult} from "../models/apiResults";
+import {DatabaseBase} from "../connection/databaseBase.js";
+import {ApiLayoutMetadata, ApiScriptResult} from "../models/apiResults.js";
 
 export class Layout<T extends LayoutInterface> implements LayoutBase {
     readonly database: DatabaseBase;
-    readonly records = new LayoutRecordManager<T>(this)
     readonly name: string;
+    readonly records = new LayoutRecordManager<T>(this)
     metadata: ApiLayoutMetadata;
 
     constructor(database: DatabaseBase, name: string) {
@@ -23,31 +21,11 @@ export class Layout<T extends LayoutInterface> implements LayoutBase {
         this.name = name
     }
 
+
     get endpoint() {
         return `${this.database.endpoint}/layouts/${this.name}`
     }
 
-    /**
-     * @deprecated use layout.records.create() instead
-     */
-    createRecord(): Promise<LayoutRecord<T["fields"], T["portals"]>> {
-        return this.records.create()
-    }
-
-    /**
-     * @deprecated use layout.records.get() instead
-     */
-    getRecord(recordId): Promise<LayoutRecord<T["fields"], T["portals"]>> {
-        return this.records.get(recordId)
-    }
-
-    /**
-     * @deprecated use layout.records.find() instead
-     */
-    newFind(): Find<T> {
-        return this.records.find()
-    }
-
     async runScript(script: Script): Promise<ScriptResult> {
         let url = `${this.endpoint}/script/${encodeURIComponent(script.name)}`
         if (script.parameter) url += "?script.param=" + encodeURIComponent(script.parameter)

package/src/layouts/layoutBase.d.ts

@@ -1,6 +1,6 @@
-import { Script, ScriptResult } from "../types";
-import { DatabaseBase } from "../connection/databaseBase";
-import { ApiLayoutMetadata } from "../models/apiResults";
+import { Script, ScriptResult } from "../types.js";
+import { DatabaseBase } from "../connection/databaseBase.js";
+import { ApiLayoutMetadata } from "../models/apiResults.js";
 export interface LayoutBase {
     readonly name: string;
     metadata: any;

package/src/layouts/layoutBase.js

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

package/src/layouts/layoutBase.ts

@@ -1,11 +1,10 @@
 /*
- * Copyright (c) 2023. See LICENSE file for more information
+ * Copyright (c) 2023-2024. See LICENSE file for more information
  */
 
-import {Script, ScriptResult} from "../types";
-import {FMError} from "../FMError";
-import {DatabaseBase} from "../connection/databaseBase";
-import {ApiLayoutMetadata} from "../models/apiResults";
+import {Script, ScriptResult} from "../types.js";
+import {DatabaseBase} from "../connection/databaseBase.js";
+import {ApiLayoutMetadata} from "../models/apiResults.js";
 
 export interface LayoutBase {
     readonly name: string

package/src/layouts/layoutInterface.d.ts

@@ -1,5 +1,5 @@
 import { Portal } from "../records/portal.js";
-import { RecordFieldsMap } from "./recordFieldsMap";
+import { RecordFieldsMap } from "./recordFieldsMap.js";
 export interface LayoutInterface {
     fields: RecordFieldsMap;
     portals: PortalInterface;

package/src/layouts/layoutInterface.js

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

package/src/layouts/layoutInterface.ts

@@ -1,9 +1,9 @@
 /*
- * Copyright (c) 2023. See LICENSE file for more information
+ * Copyright (c) 2023-2024. See LICENSE file for more information
  */
 
 import {Portal} from "../records/portal.js";
-import {RecordFieldsMap} from "./recordFieldsMap";
+import {RecordFieldsMap} from "./recordFieldsMap.js";
 
 export interface LayoutInterface {
     fields: RecordFieldsMap,

package/src/layouts/layoutRecordManager.d.ts

@@ -1,13 +1,12 @@
 import { LayoutRecord } from "../records/layoutRecord.js";
 import { LayoutInterface } from "./layoutInterface.js";
-import { RecordGetRange } from "../records/getOperations/recordGetRange.js";
-import { Find } from "../records/getOperations/find.js";
 import { LayoutBase } from "./layoutBase.js";
+import { GetOperationOptions, RecordGetOperation } from "../records/getOperations/recordGetOperation.js";
+import { RecordFetchOptions } from "../types.js";
 export declare class LayoutRecordManager<T extends LayoutInterface> {
     readonly layout: LayoutBase;
     constructor(layout: LayoutBase);
-    create(): Promise<LayoutRecord<T["fields"], T["portals"]>>;
-    get(recordId: number): Promise<LayoutRecord<T["fields"], T["portals"]>>;
-    range(start?: number, limit?: number): RecordGetRange<T>;
-    find(start?: number, limit?: number): Find<T>;
+    create<OPTIONS extends RecordFetchOptions>(options: OPTIONS): Promise<LayoutRecord<T, OPTIONS["portals"][number]>>;
+    get(recordId: number): Promise<LayoutRecord<T>>;
+    list<OPTIONS extends GetOperationOptions<T>>(options: OPTIONS): RecordGetOperation<T, OPTIONS>;
 }

package/src/layouts/layoutRecordManager.js

@@ -1,15 +1,14 @@
 /*
- * Copyright (c) 2023. See LICENSE file for more information
+ * Copyright (c) 2023-2024. See LICENSE file for more information
  */
 import { LayoutRecord } from "../records/layoutRecord.js";
-import { RecordGetRange } from "../records/getOperations/recordGetRange.js";
-import { Find } from "../records/getOperations/find.js";
+import { RecordGetOperation } from "../records/getOperations/recordGetOperation.js";
 export class LayoutRecordManager {
     layout;
     constructor(layout) {
         this.layout = layout;
     }
-    async create() {
+    async create(options) {
         await this.layout.getLayoutMeta();
         let fields = {};
         for (let _field of this.layout.metadata.fieldMetaData) {
@@ -26,10 +25,7 @@ export class LayoutRecordManager {
         await record.get();
         return record;
     }
-    range(start = 0, limit = 100) {
-        return new RecordGetRange(this.layout, start, limit);
-    }
-    find(start = 0, limit = 100) {
-        return new Find(this.layout, start, limit);
+    list(options) {
+        return new RecordGetOperation(this.layout, options);
     }
 }

package/src/layouts/layoutRecordManager.ts

@@ -1,21 +1,20 @@
 /*
- * Copyright (c) 2023. See LICENSE file for more information
+ * Copyright (c) 2023-2024. See LICENSE file for more information
  */
 
 import {LayoutRecord} from "../records/layoutRecord.js";
 import {LayoutInterface} from "./layoutInterface.js";
-import {RecordGetRange} from "../records/getOperations/recordGetRange.js";
-import {Find} from "../records/getOperations/find.js";
 import {LayoutBase} from "./layoutBase.js"
+import {GetOperationOptions, RecordGetOperation} from "../records/getOperations/recordGetOperation.js";
+import {RecordFetchOptions} from "../types.js";
 
 export class LayoutRecordManager<T extends LayoutInterface> {
-    readonly layout: LayoutBase
-
+    readonly layout: LayoutBase;
     constructor(layout: LayoutBase) {
         this.layout = layout
     }
 
-    async create(): Promise<LayoutRecord<T["fields"], T["portals"]>> {
+    async create<OPTIONS extends RecordFetchOptions>(options: OPTIONS): Promise<LayoutRecord<T, OPTIONS["portals"][number]>> {
         await this.layout.getLayoutMeta()
         let fields = {}
         for (let _field of this.layout.metadata.fieldMetaData) {
@@ -26,18 +25,14 @@ export class LayoutRecordManager<T extends LayoutInterface> {
         return new LayoutRecord(this.layout, -1, 0, fields, portals)
     }
 
-    async get(recordId: number): Promise<LayoutRecord<T["fields"], T["portals"]>> {
+    async get(recordId: number): Promise<LayoutRecord<T>> {
         await this.layout.getLayoutMeta()
-        let record = new LayoutRecord(this.layout, recordId)
+        let record = new LayoutRecord<T>(this.layout, recordId)
         await record.get()
         return record
     }
 
-    range(start = 0, limit = 100) {
-        return new RecordGetRange<T>(this.layout, start, limit)
-    }
-
-    find(start = 0, limit = 100): Find<T> {
-        return new Find<T>(this.layout, start, limit)
+    list<OPTIONS extends GetOperationOptions<T>>(options: OPTIONS) {
+        return new RecordGetOperation<T, OPTIONS>(this.layout, options)
     }
 }

package/src/layouts/recordFieldsMap.d.ts

@@ -1,4 +1,4 @@
-import { Field, FieldValue } from "../records/field";
+import { FieldBase, FieldValue } from "../records/fieldBase.js";
 export interface RecordFieldsMap {
-    [fieldName: string]: Field<FieldValue>;
+    [fieldName: string]: FieldBase<FieldValue>;
 }

package/src/layouts/recordFieldsMap.js

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

package/src/layouts/recordFieldsMap.ts

@@ -1,9 +1,9 @@
 /*
- * Copyright (c) 2023. See LICENSE file for more information
+ * Copyright (c) 2023-2024. See LICENSE file for more information
  */
 
-import {Field, FieldValue} from "../records/field";
+import {FieldBase, FieldValue} from "../records/fieldBase.js";
 
 export interface RecordFieldsMap {
-    [fieldName: string]: Field<FieldValue>
+    [fieldName: string]: FieldBase<FieldValue>
 }

package/src/records/field.d.ts

@@ -1,25 +1,5 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import { RecordBase } from "./recordBase.js";
-import * as http from "http";
-import { ContainerBufferResult, DOWNLOAD_MODES } from "../types.js";
-import { ApiFieldMetadata } from "../models/apiResults.js";
-export type FieldValue = string | number | Date | Container;
-export type Container = null;
-export declare class Field<T extends FieldValue> {
+import { RecordBase } from "./recordBase";
+import { FieldBase, FieldValue } from "./fieldBase";
+export declare class Field<T extends FieldValue> extends FieldBase<T> {
     record: RecordBase<any>;
-    id: string;
-    protected _value: T;
-    edited: boolean;
-    constructor(record: any, id: any, contents: any);
-    set(content: string | number | Date | undefined | null): void;
-    get metadata(): ApiFieldMetadata;
-    get value(): T;
-    set value(value: T);
-    get string(): string;
-    get date(): Date;
-    get number(): number;
-    upload(buffer: Buffer, filename: string, mime: string): Promise<void>;
-    download(mode: DOWNLOAD_MODES.Stream): Promise<http.IncomingMessage>;
-    download(mode: DOWNLOAD_MODES.Buffer): Promise<ContainerBufferResult>;
 }

package/src/records/field.js

@@ -1,156 +1,7 @@
 /*
- * Copyright (c) 2023. See LICENSE file for more information
+ * Copyright (c) 2024. See LICENSE file for more information
  */
-import { RecordTypes } from "./recordBase.js";
-import { File, FormData } from "node-fetch";
-import { DOWNLOAD_MODES } from "../types.js";
-import { ApiFieldDisplayTypes, ApiFieldResultTypes, ApiFieldTypes } from "../models/apiResults.js";
-export class Field {
+import { FieldBase } from "./fieldBase";
+export class Field extends FieldBase {
     record;
-    id;
-    _value;
-    edited;
-    constructor(record, id, contents) {
-        this.record = record;
-        this.id = id;
-        this._value = contents;
-        this.edited = false;
-    }
-    set(content) {
-        if (this.metadata.result === "container")
-            throw "Cannot set container value using set(). Use upload() instead.";
-        if ((this.metadata.result === "timeStamp" ||
-            this.metadata.result === "date" ||
-            this.metadata.result === "time")
-            && !(content instanceof Date) && !!content) {
-            throw "Value was not an instance of Date: " + content;
-        }
-        // @ts-ignore
-        if (!content)
-            this._value = "";
-        // @ts-ignore
-        else
-            this._value = content;
-        this.edited = true;
-    }
-    get metadata() {
-        if (!this.record.layout.metadata) {
-            // Default to a regular text field
-            return {
-                name: this.id.toString(),
-                type: ApiFieldTypes.NORMAL,
-                displayType: ApiFieldDisplayTypes.EDIT_TEXT,
-                result: ApiFieldResultTypes.TEXT,
-                global: false,
-                autoEnter: true,
-                fourDigitYear: false,
-                maxRepeat: 1,
-                maxCharacters: 0,
-                notEmpty: false,
-                numeric: false,
-                timeOfDay: false,
-                repetitions: 1,
-                valueList: ""
-            };
-        }
-        if (this.record.type === RecordTypes.PORTAL) {
-            // @ts-ignore
-            return this.record.layout.metadata.portalMetaData[this.record.portal.name || "portal not attached"].find(i => i.name === this.id) || {
-                name: this.id.toString(),
-                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
-            };
-        }
-        else {
-            return this.record.layout.metadata.fieldMetaData.find(i => i.name === this.id) || {
-                name: this.id.toString(),
-                type: ApiFieldTypes.NORMAL,
-                displayType: ApiFieldDisplayTypes.EDIT_TEXT,
-                result: ApiFieldResultTypes.TEXT,
-                global: false,
-                autoEnter: true,
-                fourDigitYear: false,
-                maxRepeat: 1,
-                maxCharacters: 0,
-                notEmpty: false,
-                numeric: false,
-                timeOfDay: false,
-                repetitions: 1,
-                valueList: ""
-            };
-        }
-    }
-    get value() {
-        // if (this.metadata.result === "container") throw "Use await field.stream() to get the contents of a container field, instead of field.value"
-        return this._value;
-    }
-    set value(value) {
-        this._value = value;
-    }
-    get string() {
-        if (typeof this._value === "string") {
-            return this._value;
-        }
-        throw "Field value is not a string";
-    }
-    get date() {
-        if (this._value instanceof Date) {
-            return this._value;
-        }
-        throw "Field value is not a date";
-    }
-    get number() {
-        if (typeof this._value === "number") {
-            return this._value;
-        }
-        throw "Field value is not a number";
-    }
-    async upload(buffer, filename, mime) {
-        let trace = new Error();
-        if (this.metadata.result !== "container")
-            throw "Cannot upload a file to the field; " + this.id + " (not a container field)";
-        let form = new FormData();
-        form.append("upload", new File([buffer], filename, { type: mime }));
-        await this.record.layout.database.apiRequest(`${this.record.endpoint}/containers/${this.id}/1`, {
-            method: "POST",
-            // @ts-ignore
-            headers: { "Authorization": "Bearer " + this.record.layout.database.token },
-            body: form
-        });
-    }
-    async download(mode = DOWNLOAD_MODES.Stream) {
-        if (this.metadata.result !== ApiFieldResultTypes.CONTAINER)
-            throw new Error("Cannot perform download() on a non-container field");
-        let stream = await this.record.layout.database.streamURL(this.string);
-        if (mode === DOWNLOAD_MODES.Stream) {
-            return stream;
-        }
-        let body = [];
-        return new Promise((resolve, reject) => {
-            stream.on("data", chunk => {
-                body.push(chunk);
-            });
-            stream.on("error", (e) => {
-                reject(e);
-            });
-            stream.on("end", () => {
-                resolve({
-                    buffer: Buffer.concat(body),
-                    mime: stream.headers["content-type"],
-                    request: stream
-                });
-            });
-        });
-    }
 }

package/src/records/field.ts

@@ -1,175 +1,10 @@
 /*
- * Copyright (c) 2023. See LICENSE file for more information
+ * Copyright (c) 2024. See LICENSE file for more information
  */
 
-import {RecordBase, RecordTypes} from "./recordBase.js";
-import fetch, {File, FormData} from "node-fetch";
-import * as http from "http";
-import {ContainerBufferResult, DOWNLOAD_MODES, FieldMetaData} from "../types.js";
-import {FMError} from "../FMError.js";
-import {ApiFieldDisplayTypes, ApiFieldMetadata, ApiFieldResultTypes, ApiFieldTypes} from "../models/apiResults.js";
+import {RecordBase} from "./recordBase";
+import {FieldBase, FieldValue} from "./fieldBase";
 
-export type FieldValue = string | number | Date | Container
-export type Container = null
-
-export class Field<T extends FieldValue> {
+export class Field<T extends FieldValue> extends FieldBase<T> {
     record: RecordBase<any>;
-    id: string;
-    protected _value: T;
-    edited: boolean;
-
-    constructor(record, id, contents) {
-        this.record = record
-        this.id = id
-        this._value = contents
-        this.edited = false
-    }
-
-    set(content: string | number | Date | undefined | null) {
-        if (this.metadata.result === "container") throw "Cannot set container value using set(). Use upload() instead."
-        if (
-            (this.metadata.result === "timeStamp" ||
-                this.metadata.result === "date" ||
-                this.metadata.result === "time")
-            && !(content instanceof Date) && !!content
-        ) {
-            throw "Value was not an instance of Date: " + content
-        }
-        // @ts-ignore
-        if (!content) this._value = ""
-        // @ts-ignore
-        else this._value = content
-        this.edited = true
-    }
-
-    get metadata(): ApiFieldMetadata {
-        if (!this.record.layout.metadata) {
-            // Default to a regular text field
-            return {
-                name: this.id.toString(),
-                type: ApiFieldTypes.NORMAL,
-                displayType: ApiFieldDisplayTypes.EDIT_TEXT,
-                result: ApiFieldResultTypes.TEXT,
-                global: false,
-                autoEnter: true,
-                fourDigitYear: false,
-                maxRepeat: 1,
-                maxCharacters: 0,
-                notEmpty: false,
-                numeric: false,
-                timeOfDay: false,
-                repetitions: 1,
-                valueList: ""
-            }
-        }
-        if (this.record.type === RecordTypes.PORTAL) {
-            // @ts-ignore
-            return this.record.layout.metadata.portalMetaData[this.record.portal.name || "portal not attached"].find(i => i.name === this.id) as FieldMetaData || {
-                name: this.id.toString(),
-                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
-            } as FieldMetaData
-        }
-        else {
-            return this.record.layout.metadata.fieldMetaData.find(i => i.name === this.id) || {
-                name: this.id.toString(),
-                type: ApiFieldTypes.NORMAL,
-                displayType: ApiFieldDisplayTypes.EDIT_TEXT,
-                result: ApiFieldResultTypes.TEXT,
-                global: false,
-                autoEnter: true,
-                fourDigitYear: false,
-                maxRepeat: 1,
-                maxCharacters: 0,
-                notEmpty: false,
-                numeric: false,
-                timeOfDay: false,
-                repetitions: 1,
-                valueList: ""
-            }
-        }
-    }
-
-    get value(): T {
-        // if (this.metadata.result === "container") throw "Use await field.stream() to get the contents of a container field, instead of field.value"
-        return this._value
-    }
-
-    set value(value: T) {
-        this._value = value
-    }
-
-    get string(): string {
-        if (typeof this._value === "string") {
-            return this._value
-        }
-        throw "Field value is not a string"
-    }
-
-    get date(): Date {
-        if (this._value instanceof Date) {
-            return this._value
-        }
-        throw "Field value is not a date"
-    }
-
-    get number(): number {
-        if (typeof this._value === "number") {
-            return this._value
-        }
-        throw "Field value is not a number"
-    }
-
-    async upload(buffer: Buffer, filename: string, mime: string): Promise<void> {
-        let trace = new Error()
-        if (this.metadata.result !== "container") throw "Cannot upload a file to the field; " + this.id + " (not a container field)"
-        let form = new FormData()
-        form.append("upload", new File([buffer], filename, {type: mime}))
-
-        await this.record.layout.database.apiRequest<null>(`${this.record.endpoint}/containers/${this.id}/1`, {
-            method: "POST",
-            // @ts-ignore
-            headers: {"Authorization": "Bearer " + this.record.layout.database.token},
-            body: form
-        })
-    }
-
-    download(mode: DOWNLOAD_MODES.Stream): Promise<http.IncomingMessage>
-    download(mode: DOWNLOAD_MODES.Buffer): Promise<ContainerBufferResult>
-    async download(mode: DOWNLOAD_MODES = DOWNLOAD_MODES.Stream): Promise<http.IncomingMessage | ContainerBufferResult> {
-        if (this.metadata.result !== ApiFieldResultTypes.CONTAINER) throw new Error("Cannot perform download() on a non-container field")
-
-        let stream = await this.record.layout.database.streamURL(this.string)
-        if (mode === DOWNLOAD_MODES.Stream) {
-            return stream
-        }
-
-        let body = []
-        return new Promise((resolve, reject) => {
-            stream.on("data", chunk => {
-                body.push(chunk)
-            })
-            stream.on("error", (e) => {
-                reject(e)
-            })
-            stream.on("end", () => {
-                resolve({
-                    buffer: Buffer.concat(body),
-                    mime: stream.headers["content-type"],
-                    request: stream
-                } as ContainerBufferResult)
-            })
-        })
-    }
 }

package/src/records/fieldBase.d.ts

@@ -0,0 +1,30 @@
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
+import * as http from "http";
+import { ContainerBufferResult, DOWNLOAD_MODES, RecordTypes } from "../types.js";
+import { ApiFieldMetadata } from "../models/apiResults.js";
+import { LayoutBase } from "../layouts/layoutBase.js";
+export type FieldValue = string | number | Date | Container;
+export type Container = null;
+export type Parentable = {
+    layout: LayoutBase;
+    type: RecordTypes;
+    endpoint: string;
+};
+export declare class FieldBase<T extends FieldValue> {
+    parent: Parentable;
+    id: string;
+    protected _value: T;
+    edited: boolean;
+    constructor(record: Parentable, id: string, contents: T);
+    set(content: string | number | Date | undefined | null): void;
+    get metadata(): ApiFieldMetadata;
+    get value(): T;
+    set value(value: T);
+    get string(): string;
+    get date(): Date;
+    get number(): number;
+    upload(buffer: Buffer, filename: string, mime: string): Promise<void>;
+    download(mode: DOWNLOAD_MODES.Stream): Promise<http.IncomingMessage>;
+    download(mode: DOWNLOAD_MODES.Buffer): Promise<ContainerBufferResult>;
+}