@jd-data-limited/easy-fm 4.1.6 → 4.1.8

package/src/models/apiResults.ts

@@ -1,110 +0,0 @@
-/*
- * Copyright (c) 2023-2024. See LICENSE file for more information
- */
-
-export enum ApiFieldTypes {
-    NORMAL = 'normal',
-    CALCULATION = 'calculation',
-    SUMMARY = 'summary'
-}
-
-export enum ApiFieldDisplayTypes {
-    EDIT_TEXT = 'editText',
-    POPUP_LIST = 'popupList',
-    CHECKBOX = 'checkBox',
-    RADIO_BUTTONS = 'radioButtons',
-    SELECTION_LIST = 'selectionList',
-    CALENDAR = 'calendar',
-    SECURE_TEXT = 'secureText'
-}
-
-export enum ApiFieldResultTypes {
-    TEXT = 'text',
-    NUMBER = 'number',
-    DATE = 'date',
-    TIME = 'time',
-    TIMESTAMP = 'timeStamp',
-    CONTAINER = 'container'
-}
-
-export interface ApiMessage {
-    code: string
-    message: string
-}
-
-export interface ApiResults<T = unknown> {
-    response?: null | T & { scriptError?: string }
-    messages: ApiMessage[]
-    httpStatus: number
-}
-
-export interface ApiLayout {
-    name: string
-    isFolder?: boolean
-    folderLayoutNames?: ApiLayout[]
-}
-
-export interface ApiLayoutMetadata {
-    fieldMetaData: ApiFieldMetadata[]
-    portalMetaData: Record<string, ApiFieldMetadata[]>
-    valueLists: ApiValueList[]
-}
-
-export interface ApiFieldMetadata {
-    name: string
-    type: ApiFieldTypes
-    displayType: ApiFieldDisplayTypes
-    result: ApiFieldResultTypes
-    global: boolean
-    autoEnter: boolean
-    fourDigitYear: boolean
-    maxRepeat: number
-    maxCharacters: number
-    notEmpty: boolean
-    numeric: boolean
-    repetitions: number
-    timeOfDay: boolean
-    valueList: string
-}
-
-export interface ApiValueList {
-    name: string
-    type: string
-    values: Array<{ value: string, displayName: string }>
-}
-
-export interface ApiScriptResult {
-    scriptError: string
-    scriptResult?: string
-}
-
-export interface ApiRecordResponseObj {
-    data: ApiRowDataDef[]
-    dataInfo: ApiResultSetObj
-}
-
-export type ApiFieldData = Record<string, string | number>
-
-export type ApiPortalData = Record<string, ApiFieldData[]>
-
-export interface ApiResultSetObj {
-    database: string
-    layout: string
-    table: string
-    totalRecordCount: number
-    foundCount: number
-    returnedCount: number
-}
-
-export interface ApiRowDataDef {
-    fieldData: ApiFieldData
-    portalData: ApiPortalData
-    modId: string
-    recordId: string
-    portalDataInfo?: Array<{
-        database: string
-        table: string
-        foundCount: number
-        returnedCount: number
-    }>
-}

package/src/records/field.ts

@@ -1,235 +0,0 @@
-/*
- * Copyright (c) 2023-2024. See LICENSE file for more information
- */
-
-import {RecordTypes} from '../types.js'
-import {ApiFieldDisplayTypes, type ApiFieldMetadata, ApiFieldResultTypes, ApiFieldTypes} from '../models/apiResults.js'
-import {type LayoutBase} from '../layouts/layoutBase.js'
-import {type Moment} from 'moment'
-import {FMError} from '../FMError.js'
-
-export type FieldValue = string | number | Moment | Container
-export type Container = null
-
-export interface Parentable {
-    layout: LayoutBase
-    type: RecordTypes
-    endpoint: string
-    portal?: { name: string }
-}
-
-/**
- * A class representing a field in a record.
- *
- * @template T - The type of the field value.
- */
-export class Field<T extends FieldValue> {
-    parent: Parentable
-    id: string
-    protected _value: T | null
-    edited: boolean
-
-    static firstContainerDownload: Promise<any> | null = null
-
-    constructor (record: Parentable, id: string, contents: T) {
-        this.parent = record
-        this.id = id
-        this._value = contents
-        this.edited = false
-    }
-
-    /**
-     * Sets the value of the field.
-     *
-     * @param {T | null} content - The new content value to be set. Can be either the type T or null.
-     * @throws {Error} Cannot set container value using set(). Use upload() instead, if the result is a 'container'.
-     */
-    set (content: T | null) {
-        if (this.metadata.result === 'container') throw new Error('Cannot set container value using set(). Use upload() instead.')
-        else this._value = content
-        this.edited = true
-    }
-
-    get metadata (): ApiFieldMetadata {
-        if (!this.parent.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.parent.type === RecordTypes.PORTAL && this.parent.portal) {
-            return this.parent.layout.metadata.portalMetaData[this.parent.portal.name || 'portal not attached'].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: ''
-                }
-        } else {
-            return this.parent.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 | null {
-        // 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 new Error('Field value is not a string')
-    }
-
-    /**
-     * Uploads a file to the container field.
-     *
-     * @param {Buffer} file - The file content as a buffer.
-     *
-     * @throws {Error} - Cannot upload a file to the field if it's not a container field.
-     * @throws {Error} - Upload failed with HTTP error.
-     *
-     * @returns {Promise<void>} - A promise that resolves when the file is successfully uploaded.
-     */
-    async upload (file: File): Promise<void> {
-        if (this.metadata.result !== 'container') {
-            throw new Error('Cannot upload a file to the field; ' + this.id + ' (not a container field)')
-        }
-        const form = new FormData()
-        form.append('upload', file)
-
-        const res = await this.parent.layout.database._apiRequestRaw(`${this.parent.endpoint}/containers/${this.id}/1`, {
-            method: 'POST',
-            headers: {
-                // Authorization: 'Bearer ' + this.parent.layout.database.token,
-                // 'Content-Type': 'multipart/form-data'
-            },
-            body: form
-        })
-        if (!res.ok) {
-            throw new Error(`Upload failed with HTTP error: ${res.status} (${res.statusText})`)
-        }
-        const data: { messages: Array<{ code: string }> } = await res.json() as any
-        if (data.messages[0].code === '0') return
-        else {
-            throw new FMError(data.messages[0].code, res.status, res)
-        }
-    }
-
-    @containerDownloadFunction
-    async #streamAsync (): Promise<{ data: NodeJS.ReadableStream, mime: string }> {
-        const req = await this.parent.layout.database._apiRequestRaw(this.string, {useCookieJar: true})
-        if (!req.ok || !req.body) {
-            throw new Error(`HTTP Error: ${req.status} (${req.statusText})`)
-        }
-        return {data: req.body, mime: req.headers.get('Content-Type') ?? ''}
-    }
-
-    async stream () {
-        return await this.#streamAsync()
-    }
-
-    @containerDownloadFunction
-    async arrayBuffer (): Promise<{ data: ArrayBuffer, mime: string }> {
-        const req = await this.parent.layout.database._apiRequestRaw(this.string, {useCookieJar: true})
-        if (!req.ok) throw new Error(`HTTP Error: ${req.status} (${req.statusText})`)
-        return {data: await req.arrayBuffer(), mime: req.headers.get('Content-Type') ?? ''}
-    }
-}
-
-function containerDownloadFunction<PROPS extends any[], T extends FieldValue, R = unknown> (originalMethod: (...p: PROPS) => Promise<R>, context: ClassMethodDecoratorContext<Field<T>>) {
-    async function replacementMethod (this: Field<T>, ...args: PROPS) {
-        return await ContainerDownloadExecutor.processTask(async () => await originalMethod.call(this, ...args))
-    }
-
-    return replacementMethod
-}
-
-class ContainerDownloadExecutorClass {
-    hasDownloadedFirstContainer: 0 | 1 | 2 = 0
-    waitingFuncs: Array<{
-        func: (() => any)
-        done: ((...args: any[]) => any)
-        err: ((e: any) => any)
-    }> = []
-
-    async processTask<T extends () => Promise<any>>(task: T) {
-        const isFirstTask = this.hasDownloadedFirstContainer === 0
-        if (isFirstTask) {
-            this.hasDownloadedFirstContainer = 1
-            let res
-            try {
-                res = await task()
-            } catch (e) {
-                this.hasDownloadedFirstContainer = 0
-                const nextTask = this.waitingFuncs.splice(0, 1)[0]
-                if (nextTask) {
-                    this.processTask(nextTask.func)
-                        .then(res => nextTask.done(res))
-                        .catch(e => nextTask.err(e))
-                }
-                throw e
-            }
-            this.hasDownloadedFirstContainer = 2
-            for (const task of this.waitingFuncs) {
-                task.func()
-                    .then((res: any) => task.done(res))
-                    .catch((e: any) => task.err(e))
-            }
-            return res
-        } else if (this.hasDownloadedFirstContainer === 1) {
-            return await new Promise((resolve, reject) => {
-                this.waitingFuncs.push({
-                    func: task,
-                    done: resolve,
-                    err: reject
-                })
-            })
-        } else return await task()
-    }
-}
-
-const ContainerDownloadExecutor = new ContainerDownloadExecutorClass()

package/src/records/getOperations/recordGetOperation.ts

@@ -1,268 +0,0 @@
-/*
- * Copyright (c) 2023-2024. See LICENSE file for more information
- */
-
-import {type LayoutInterface} from '../../layouts/layoutInterface.js'
-import {type PickPortals, type ScriptRequestData} from '../../types.js'
-import {type LayoutBase} from '../../layouts/layoutBase.js'
-import {LayoutRecord} from '../layoutRecord.js'
-import {type ApiRecordResponseObj} from '../../models/apiResults.js'
-import {FMError} from '../../FMError.js'
-import {FindRequestSymbol, type Query} from '../../utils/query.js'
-
-export type SortOrder = 'ascend' | 'descend'
-export type FindRequestRaw = Record<string, string>
-export type FindRequest = Record<string, Query>
-
-export interface PortalRequest {
-    name: string
-}
-
-type PortalData<T extends LayoutInterface> = {
-    [key in keyof T['portals']]: {
-        limit: number
-        offset: number
-    }
-}
-export interface GetOperationOptions<T extends LayoutInterface> {
-    portals: Partial<PortalData<T>>
-    limit?: number
-    offset?: number
-}
-
-export class RecordGetOperation<T extends LayoutInterface, OPTIONS extends GetOperationOptions<T>> {
-    protected layout: LayoutBase
-    protected limit: number = 100
-    protected scriptData: ScriptRequestData = {}
-    protected sortData: Array<{ fieldName: string, sortOrder: SortOrder }> = []
-    protected portals: Partial<PortalData<T>>
-    protected offset: number = 1
-    protected queries: Array<{ req: FindRequestRaw, omit: boolean }> = []
-
-    constructor (layout: LayoutBase, options: OPTIONS) {
-        this.layout = layout
-        this.sortData = []
-        this.portals = options.portals
-        this.offset = options.offset ?? 1 // Offset refers to the starting record. offset 1 is the same as no offset.
-        this.limit = options.limit ?? 100
-    }
-
-    get isFindRequest () {
-        return this.queries.length !== 0
-    }
-
-    private formatQueries () {
-        const test = this.queries.map(query => {
-            const out: any = {}
-            for (const key of Object.keys(query.req)) {
-                if (query.req[key]) out[key] = query.req[key]
-                else {
-                    out[key] = query.req[key]
-                }
-            }
-            if (query.omit) out.omit = 'true'
-            return out
-        })
-        return test
-    }
-
-    protected generateParamsBody (offset: number, limit: number) {
-        const params: Record<string, any> = {
-            limit: limit.toString(),
-            offset: offset.toString(),
-            dateformats: 2 // Ensure dates are received in ISO8601 format
-        }
-        if (this.sortData.length !== 0) params.sort = this.sortData
-
-        if (this.scriptData.after) params.script = this.scriptData.after.name
-        if (this.scriptData.after?.parameter) params['script.param'] = this.scriptData.after.parameter
-
-        if (this.scriptData.presort) params['script.presort'] = this.scriptData.presort.name
-        if (this.scriptData.presort?.parameter) params['script.presort.param'] = this.scriptData.presort.parameter
-
-        if (this.scriptData.prerequest) params['script.prerequest'] = this.scriptData.prerequest.name
-        if (this.scriptData.prerequest?.parameter) params['script.prerequest.param'] = this.scriptData.prerequest.parameter
-
-        if (this.queries.length !== 0) params.query = this.formatQueries()
-
-        const portals: Array<keyof typeof this.portals> = Object.keys(this.portals)
-        params.portal = portals
-        for (const portal of portals) {
-            params[`offset.${portal.toString()}`] = this.portals[portal]?.offset
-            params[`limit.${portal.toString()}`] = this.portals[portal]?.limit
-        }
-
-        return params
-    }
-
-    protected generateParamsURL (offset: number, limit: number) {
-        const params = new URLSearchParams({
-            _limit: limit.toString(),
-            _offset: offset.toString(),
-            dateformats: '2' // Ensure dates are received in ISO8601 format
-        })
-        if (this.sortData.length !== 0) params.set('_sort', JSON.stringify(this.sortData))
-
-        if (this.scriptData.after) params.set('script', this.scriptData.after.name)
-        if (this.scriptData.after?.parameter) params.set('script.param', this.scriptData.after.parameter)
-
-        if (this.scriptData.presort) params.set('script.presort', this.scriptData.presort.name)
-        if (this.scriptData.presort?.parameter) params.set('script.presort.param', this.scriptData.presort.parameter)
-
-        if (this.scriptData.prerequest) params.set('script.prerequest', this.scriptData.prerequest.name)
-        if (this.scriptData.prerequest?.parameter) params.set('script.prerequest.param', this.scriptData.prerequest.parameter)
-
-        const portals: Array<keyof typeof this.portals> = Object.keys(this.portals)
-        for (const portal of portals) {
-            params.set(`_offset.${portal.toString()}`, (this.portals[portal]?.limit ?? '').toString())
-            params.set(`_offset.${portal.toString()}`, (this.portals[portal]?.offset ?? '').toString())
-        }
-        params.set('portal', JSON.stringify(portals))
-
-        return params
-    }
-
-    /**
-     * Configures any FileMaker scripts to be run as a part of the request
-     *
-     * @param {ScriptRequestData} scripts - The script request data to set.
-     * @return {this} - The current instance of the class.
-     */
-    scripts (scripts: ScriptRequestData) {
-        this.scriptData = scripts
-        return this
-    }
-
-    /**
-     * Sorts the data based on the given field name and sort order.
-     *
-     * @param {string} fieldName - The name of the field by which the data should be sorted.
-     * @param {SortOrder} sortOrder - The sort order to be applied (either "asc" for ascending or "desc" for descending).
-     *
-     * @return {this} - Returns the current instance of the object.
-     */
-    sort (fieldName: string, sortOrder: SortOrder) {
-        this.sortData.push({fieldName, sortOrder})
-        return this
-    }
-
-    private parseFindRequest<I extends FindRequest>(query: I): { [key in keyof I]: string } {
-        const out: any = {}
-        for (const key of Object.keys(query)) {
-            out[key] = query[key][FindRequestSymbol].map(item => {
-                if (typeof item === 'string') return item
-
-                // Re-write date into correct format
-                return item
-                    .moment
-                    .clone()
-                    .utcOffset(this.layout.database.host.timezoneOffsetFunc(item.moment))
-                    .format(
-                        item.type === 'date'
-                            ? this.layout.database.host.dateFormat
-                            : item.type == 'time'
-                                ? this.layout.database.host.timeFormat
-                                : this.layout.database.host.timeStampFormat
-                    )
-            }).join('')
-        }
-        return out
-    }
-
-    /**
-     * Adds a new request/query to the list of queries.
-     *
-     * @param {FindRequest} query - The find request to be added.
-     * @param {boolean} [omit=false] - Flag to indicate if the find request should be omitted.
-     * @return {Object} - The current object instance.
-     */
-    addRequest (query: FindRequest, omit = false) {
-        this.queries.push({req: this.parseFindRequest(query), omit})
-        return this
-    }
-
-    /**
-     * Perform a fetch operation.
-     *
-     * @returns {Promise} A promise that resolves with the result of the fetch operation.
-     */
-    async fetch () {
-        return await this.performFind(this.offset, this.limit)
-    }
-
-    private async performFind (offset: number, limit: number): Promise<Array<LayoutRecord<
-    PickPortals<T, keyof OPTIONS['portals']>
-    >>> {
-        const trace = new Error()
-        await this.layout.getLayoutMeta()
-
-        const isFind = this.isFindRequest
-        let endpoint = this.layout.endpoint + (isFind ? '/_find' : '/records')
-        if (!isFind) endpoint += '?' + new URLSearchParams(this.generateParamsURL(offset, limit)).toString()
-        const reqData = {
-            // port: 443,
-            method: isFind ? 'POST' : 'GET',
-            body: isFind ? JSON.stringify(this.generateParamsBody(offset, limit)) : undefined
-        }
-
-        try {
-            const res = await this.layout.database._apiRequestJSON<ApiRecordResponseObj>(
-                endpoint,
-                reqData
-            )
-            if (res.messages[0].code === '0' && res.response) {
-                // 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)
-            }
-        } catch (e) {
-            if (e instanceof FMError) {
-                if (e.code === 401) {
-                    // No records found, so return empty set
-                    return []
-                }
-            }
-            throw e
-        }
-    }
-
-    [Symbol.asyncIterator] () {
-        let nextOffset = this.offset
-        const startOffset: number = JSON.parse(JSON.stringify(this.offset))
-        const limit = this.limit
-
-        let exitAfterLastRecord = false
-        let records: Array<LayoutRecord<PickPortals<T, keyof OPTIONS['portals']>>> = []
-
-        const fetch = async () => {
-            const theoreticalLimit = (limit - nextOffset) + startOffset
-            if (theoreticalLimit === 0) {
-                exitAfterLastRecord = true
-                records = []
-                return
-            }
-            records = await this.performFind(nextOffset, theoreticalLimit < 100 ? theoreticalLimit : 100)
-            nextOffset += 100
-            if (records.length < 100) exitAfterLastRecord = true
-        }
-
-        return {
-            next: async () => {
-                if (records.length === 0 && !exitAfterLastRecord) {
-                    await fetch()
-                }
-
-                if (records.length === 0 && exitAfterLastRecord) {
-                    return {done: true, value: undefined}
-                } else {
-                    const record = records.shift()
-                    return {done: false, value: record}
-                }
-            }
-        }
-    }
-}