@jd-data-limited/easy-fm 4.0.14 → 4.1.0

package/src/types.d.ts

@@ -1,10 +1,10 @@
 /// <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.js";
-export type PickPortals<LAYOUT extends LayoutInterface, PORTALS extends string | number | symbol = ""> = Omit<LAYOUT, "portals"> & {
-    portals: Pick<LAYOUT["portals"], PORTALS>;
+import type * as http from 'http';
+import { type FMError } from './FMError.js';
+import { type LayoutInterface } from './layouts/layoutInterface.js';
+export type PickPortals<LAYOUT extends LayoutInterface, PORTALS extends string | number | symbol = ''> = Omit<LAYOUT, 'portals'> & {
+    portals: Pick<LAYOUT['portals'], PORTALS>;
 };
 export interface databaseOptionsBase {
     database: string;
@@ -13,27 +13,28 @@ export interface databaseOptionsBase {
 }
 export interface databaseOptionsWithExternalSources extends databaseOptionsBase {
     database: string;
+    debug?: boolean;
     credentials: loginOptionsOAuth | loginOptionsFileMaker | loginOptionsClaris | loginOptionsToken;
     externalSources: databaseOptionsBase[];
 }
 export interface loginOptionsToken {
-    method: "token";
+    method: 'token';
     token: string;
 }
 export interface loginOptionsOAuth {
-    method: "oauth";
+    method: 'oauth';
     oauth: {
         requestId: string;
         requestIdentifier: string;
     };
 }
 export interface loginOptionsFileMaker {
-    method: "filemaker";
+    method: 'filemaker';
     username: string;
     password: string;
 }
 export interface loginOptionsClaris {
-    method: "claris";
+    method: 'claris';
     claris: {
         fmid: string;
     };
@@ -43,11 +44,11 @@ export interface portalFetchData<T = string> {
     offset: number;
     limit: number;
 }
-export type ScriptRequestData = {
+export interface ScriptRequestData {
     prerequest?: Script;
     presort?: Script;
     after?: Script;
-};
+}
 export interface extraBodyOptions {
     scripts?: ScriptRequestData;
 }
@@ -65,9 +66,7 @@ export interface recordObject {
     fieldData: any;
     portalData?: portalDataObject;
 }
-export interface portalDataObject {
-    [key: string]: recordObject;
-}
+export type portalDataObject = Record<string, recordObject>;
 export interface FieldMetaData {
     name: string;
     type: string;
@@ -86,9 +85,7 @@ export interface FieldMetaData {
 }
 export interface LayoutMetaData {
     fieldMetaData: FieldMetaData[];
-    portalMetaData?: {
-        [key: string]: FieldMetaData[];
-    };
+    portalMetaData?: Record<string, FieldMetaData[]>;
 }
 export interface FMHostMetadata {
     productInfo: {
@@ -106,21 +103,21 @@ export interface ScriptResult {
 }
 export interface ContainerBufferResult {
     buffer: Buffer;
-    mime: string;
+    mime?: string;
     request: http.IncomingMessage;
 }
 export interface AuthorizationHeaders {
-    "Content-Type": "application/json";
+    '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;
+    'Content-Type': 'application/json';
+    'X-FM-Data-OAuth-RequestId': string;
+    'X-FM-Data-OAuth-Identifier': string;
 }
-export type RecordFetchOptions = {
+export interface RecordFetchOptions {
     readonly portals: readonly string[];
-};
+}
 export declare enum RecordTypes {
     UNKNOWN = 0,
     LAYOUT = 1,

package/src/types.ts

@@ -3,62 +3,62 @@
  */
 
 // 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.js";
+import type * as http from 'http'
+import {type FMError} from './FMError.js'
+import {type LayoutInterface} from './layouts/layoutInterface.js'
 
-export type PickPortals<LAYOUT extends LayoutInterface, PORTALS extends string | number | symbol = ""> =
-    Omit<LAYOUT, "portals"> & { portals: Pick<LAYOUT["portals"], PORTALS> }
+export type PickPortals<LAYOUT extends LayoutInterface, PORTALS extends string | number | symbol = ''> =
+    Omit<LAYOUT, 'portals'> & { portals: Pick<LAYOUT['portals'], PORTALS> }
 
 export interface databaseOptionsBase {
-    database: string,
-    debug?: boolean,
-    credentials: loginOptionsOAuth | loginOptionsFileMaker | loginOptionsClaris | loginOptionsToken,
+    database: string
+    debug?: boolean
+    credentials: loginOptionsOAuth | loginOptionsFileMaker | loginOptionsClaris | loginOptionsToken
 }
 
 export interface databaseOptionsWithExternalSources extends databaseOptionsBase {
     database: string
-    credentials: loginOptionsOAuth | loginOptionsFileMaker | loginOptionsClaris | loginOptionsToken,
+    debug?: boolean
+    credentials: loginOptionsOAuth | loginOptionsFileMaker | loginOptionsClaris | loginOptionsToken
     externalSources: databaseOptionsBase[]
 }
 
 export interface loginOptionsToken {
-    method: "token"
+    method: 'token'
     token: string
 }
 
 export interface loginOptionsOAuth {
-    method: "oauth"
+    method: 'oauth'
     oauth: {
-        requestId: string,
+        requestId: string
         requestIdentifier: string
     }
 }
 
 export interface loginOptionsFileMaker {
-    method: "filemaker"
-    username: string,
-    password: string,
+    method: 'filemaker'
+    username: string
+    password: string
 }
 
 export interface loginOptionsClaris {
-    method: "claris"
+    method: 'claris'
     claris: {
         fmid: string
     }
 }
 
 export interface portalFetchData<T = string> {
-    portalName: T,
-    offset: number,
+    portalName: T
+    offset: number
     limit: number
 }
 
-export type ScriptRequestData = {
-    prerequest?: Script,
-    presort?: Script,
-    after?: Script,
+export interface ScriptRequestData {
+    prerequest?: Script
+    presort?: Script
+    after?: Script
 }
 
 export interface extraBodyOptions {
@@ -77,58 +77,54 @@ export interface Script {
 
 export interface recordObject {
     recordId: number
-    modId: number,
-    fieldData: any,
+    modId: number
+    fieldData: any
     portalData?: portalDataObject
 }
 
-export interface portalDataObject {
-    [key: string]: recordObject
-}
+export type portalDataObject = Record<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,
+    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[]
-    }
+    fieldMetaData: FieldMetaData[]
+    portalMetaData?: Record<string, FieldMetaData[]>
 }
 
 export interface FMHostMetadata {
     productInfo: {
-        buildDate: Date,
-        name: string,
-        version: string,
-        dateFormat: string,
-        timeFormat: string,
+        buildDate: Date
+        name: string
+        version: string
+        dateFormat: string
+        timeFormat: string
         timeStampFormat: string
     }
 }
 
 export interface ScriptResult {
-    scriptError?: FMError,
+    scriptError?: FMError
     scriptResult?: string
 }
 
 export interface ContainerBufferResult {
-    buffer: Buffer,
-    mime: string,
+    buffer: Buffer
+    mime?: string
     request: http.IncomingMessage
 }
 
@@ -138,17 +134,17 @@ export interface ContainerBufferResult {
 // }
 
 export interface AuthorizationHeaders {
-    "Content-Type": "application/json"
+    '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
+    'Content-Type': 'application/json'
+    'X-FM-Data-OAuth-RequestId': string
+    'X-FM-Data-OAuth-Identifier': string
 }
 
-export type RecordFetchOptions = {
+export interface RecordFetchOptions {
     readonly portals: readonly string[]
 }
 
@@ -156,4 +152,4 @@ export enum RecordTypes {
     UNKNOWN,
     LAYOUT,
     PORTAL
-}
+}

package/src/utils/query.d.ts

@@ -1,9 +1,16 @@
-import { Moment } from "moment";
+import { type Moment } from 'moment';
 export declare const FindRequestSymbol: unique symbol;
-type QueryParameter = string | number | Moment;
-export type Query = {
-    [FindRequestSymbol]: (string | Moment)[];
-};
+export interface TimestampType {
+    type: 'date' | 'time' | 'timestamp';
+    moment: Moment;
+}
+type QueryParameter = string | number | TimestampType;
+export interface Query {
+    [FindRequestSymbol]: Array<string | TimestampType>;
+}
 export declare function queryEscape(str: string): string;
 export declare function query(strings: TemplateStringsArray, ...args: QueryParameter[]): Query;
+export declare function asDate(date: Date | Moment): TimestampType;
+export declare function asTime(date: Date | Moment): TimestampType;
+export declare function asTimestamp(date: Date | Moment): TimestampType;
 export {};

package/src/utils/query.js

@@ -1,24 +1,24 @@
 /*
  * Copyright (c) 2024. See LICENSE file for more information
  */
-import moment from "moment/moment.js";
-export const FindRequestSymbol = Symbol("easyfm-findrequest");
-const SPECIAL_CHARACTERS = ["\\", "=", "<", "≤", "≥", ">", "…", "...", "//", "@", "#", "*", "\"", "~"];
+import moment from 'moment';
+export const FindRequestSymbol = Symbol('easyfm-findrequest');
+const SPECIAL_CHARACTERS = ['\\', '=', '<', '≤', '≥', '>', '…', '...', '//', '@', '#', '*', '"', '~'];
 export function queryEscape(str) {
-    for (let char of SPECIAL_CHARACTERS) {
+    for (const char of SPECIAL_CHARACTERS) {
         str = str.replace(char, `\\${char}`);
     }
     return str;
 }
 export function query(strings, ...args) {
-    let argStrings = args.map(item => {
-        if (moment.isMoment(item))
-            return item;
-        else if (typeof item === "number") {
+    const argStrings = args.map(item => {
+        if (typeof item === 'number') {
             return queryEscape(item.toString());
         }
-        else
+        else if (typeof item === 'string')
             return queryEscape(item);
+        else
+            return item;
     });
     // Zip the parameters together
     const query = strings.map((str, index) => {
@@ -26,3 +26,22 @@ export function query(strings, ...args) {
     }).flat(1);
     return { [FindRequestSymbol]: query };
 }
+export function asDate(date) {
+    return {
+        type: 'date',
+        moment: moment(date)
+    };
+}
+export function asTime(date) {
+    return {
+        type: 'time',
+        moment: moment(date)
+    };
+}
+export function asTimestamp(date) {
+    return {
+        type: 'timestamp',
+        moment: moment(date)
+    };
+}
+query;

package/src/utils/query.ts

@@ -2,28 +2,30 @@
  * Copyright (c) 2024. See LICENSE file for more information
  */
 
-import {Moment} from "moment";
-import moment from "moment/moment.js";
+import moment, {type Moment} from 'moment'
 
-export const FindRequestSymbol = Symbol("easyfm-findrequest");
-const SPECIAL_CHARACTERS = ["\\", "=", "<", "≤", "≥", ">", "…", "...", "//", "@", "#", "*", "\"", "~"]
-type QueryParameter = string | number | Moment
-export type Query = {[FindRequestSymbol]: (string | Moment)[]}
+export const FindRequestSymbol = Symbol('easyfm-findrequest')
+const SPECIAL_CHARACTERS = ['\\', '=', '<', '≤', '≥', '>', '…', '...', '//', '@', '#', '*', '"', '~']
+export interface TimestampType {
+    type: 'date' | 'time' | 'timestamp'
+    moment: Moment
+}
+type QueryParameter = string | number | TimestampType
+export interface Query { [FindRequestSymbol]: Array<string | TimestampType> }
 
-export function queryEscape(str: string) {
-    for (let char of SPECIAL_CHARACTERS) {
+export function queryEscape (str: string) {
+    for (const char of SPECIAL_CHARACTERS) {
         str = str.replace(char, `\\${char}`)
     }
     return str
 }
 
-export function query(strings: TemplateStringsArray, ...args: QueryParameter[]): Query {
-    let argStrings = args.map(item => {
-        if (moment.isMoment(item)) return item
-        else if (typeof item === "number") {
+export function query (strings: TemplateStringsArray, ...args: QueryParameter[]): Query {
+    const argStrings = args.map(item => {
+        if (typeof item === 'number') {
             return queryEscape(item.toString())
-        }
-        else return queryEscape(item)
+        } else if (typeof item === 'string') return queryEscape(item)
+        else return item
     })
 
     // Zip the parameters together
@@ -31,4 +33,27 @@ export function query(strings: TemplateStringsArray, ...args: QueryParameter[]):
         return [str, (argStrings[index] || '')]
     }).flat(1)
     return {[FindRequestSymbol]: query}
-}
+}
+
+export function asDate (date: Date | Moment): TimestampType {
+    return {
+        type: 'date',
+        moment: moment(date)
+    }
+}
+
+export function asTime (date: Date | Moment): TimestampType {
+    return {
+        type: 'time',
+        moment: moment(date)
+    }
+}
+
+export function asTimestamp (date: Date | Moment): TimestampType {
+    return {
+        type: 'timestamp',
+        moment: moment(date)
+    }
+}
+
+query