@jd-data-limited/easy-fm 4.0.8 → 4.0.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jd-data-limited/easy-fm",
-  "version": "4.0.8",
+  "version": "4.0.10",
   "dependencies": {
     "follow-redirects": "^1.15.5",
     "@types/follow-redirects": "^1.14.4",

package/src/index.d.ts

@@ -10,9 +10,9 @@ import { LayoutInterface, PortalInterface } from "./layouts/layoutInterface.js";
 import { PortalRecord } from "./records/portalRecord.js";
 import { Portal } from "./records/portal.js";
 import { Container, FieldBase } from "./records/fieldBase.js";
-import { RecordGetOperation } from "./records/getOperations/recordGetOperation.js";
+import { FindRequest, RecordGetOperation } from "./records/getOperations/recordGetOperation.js";
 import { LayoutRecordManager } from "./layouts/layoutRecordManager.js";
 import { RecordFieldsMap } from "./layouts/recordFieldsMap.js";
 import { query, queryEscape } from "./utils/query.js";
 export default FMHost;
-export { FMError, TYPES, Database, Layout, RecordBase, LayoutRecord, LayoutInterface, RecordFieldsMap, PortalInterface, PortalRecord, Portal, FieldBase, RecordGetOperation, LayoutRecordManager, Container, PickPortals, query, queryEscape };
+export { FMError, TYPES, Database, Layout, RecordBase, LayoutRecord, LayoutInterface, RecordFieldsMap, PortalInterface, PortalRecord, Portal, FieldBase, RecordGetOperation, LayoutRecordManager, Container, PickPortals, FindRequest, query, queryEscape };

package/src/index.ts

@@ -14,7 +14,7 @@ import {LayoutInterface, PortalInterface} from "./layouts/layoutInterface.js";
 import {PortalRecord} from "./records/portalRecord.js";
 import {Portal} from "./records/portal.js";
 import {Container, FieldBase} from "./records/fieldBase.js";
-import {RecordGetOperation} from "./records/getOperations/recordGetOperation.js";
+import {FindRequest, RecordGetOperation} from "./records/getOperations/recordGetOperation.js";
 import {LayoutRecordManager} from "./layouts/layoutRecordManager.js";
 import {RecordFieldsMap} from "./layouts/recordFieldsMap.js";
 import {query, queryEscape} from "./utils/query.js";
@@ -37,6 +37,7 @@ export {
     LayoutRecordManager,
     Container,
     PickPortals,
+    FindRequest,
     query,
     queryEscape
 }

package/src/records/fieldBase.d.ts

@@ -1,7 +1,7 @@
 /// <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 { ContainerBufferResult, DownloadModes, RecordTypes } from "../types.js";
 import { ApiFieldMetadata } from "../models/apiResults.js";
 import { LayoutBase } from "../layouts/layoutBase.js";
 export type FieldValue = string | number | Date | Container;
@@ -25,6 +25,6 @@ export declare class FieldBase<T extends FieldValue> {
     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>;
+    download(mode: DownloadModes.Stream): Promise<http.IncomingMessage>;
+    download(mode: DownloadModes.Buffer): Promise<ContainerBufferResult>;
 }

package/src/records/fieldBase.js

@@ -1,7 +1,7 @@
 /*
  * Copyright (c) 2023-2024. See LICENSE file for more information
  */
-import { DOWNLOAD_MODES, RecordTypes } from "../types.js";
+import { DownloadModes, RecordTypes } from "../types.js";
 import { ApiFieldDisplayTypes, ApiFieldResultTypes, ApiFieldTypes } from "../models/apiResults.js";
 export class FieldBase {
     parent;
@@ -128,11 +128,11 @@ export class FieldBase {
         if (!res.ok)
             throw new Error(`Upload failed with HTTP error: ${res.status} (${res.statusText})`);
     }
-    async download(mode = DOWNLOAD_MODES.Stream) {
+    async download(mode = DownloadModes.Stream) {
         if (this.metadata.result !== ApiFieldResultTypes.CONTAINER)
             throw new Error("Cannot perform download() on a non-container field");
         let stream = await this.parent.layout.database.streamURL(this.string);
-        if (mode === DOWNLOAD_MODES.Stream) {
+        if (mode === DownloadModes.Stream) {
             return stream;
         }
         let body = [];

package/src/records/fieldBase.ts

@@ -3,7 +3,7 @@
  */
 
 import * as http from "http";
-import {ContainerBufferResult, DOWNLOAD_MODES, FieldMetaData, RecordTypes} from "../types.js";
+import {ContainerBufferResult, DownloadModes, FieldMetaData, RecordTypes} from "../types.js";
 import {ApiFieldDisplayTypes, ApiFieldMetadata, ApiFieldResultTypes, ApiFieldTypes} from "../models/apiResults.js";
 import {LayoutBase} from "../layouts/layoutBase.js";
 
@@ -144,13 +144,13 @@ export class FieldBase<T extends FieldValue> {
         if (!res.ok) throw new Error(`Upload failed with HTTP error: ${res.status} (${res.statusText})`)
     }
 
-    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> {
+    download(mode: DownloadModes.Stream): Promise<http.IncomingMessage>
+    download(mode: DownloadModes.Buffer): Promise<ContainerBufferResult>
+    async download(mode: DownloadModes = DownloadModes.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.parent.layout.database.streamURL(this.string)
-        if (mode === DOWNLOAD_MODES.Stream) {
+        if (mode === DownloadModes.Stream) {
             return stream
         }
 

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

@@ -6,8 +6,6 @@ import { Query } from "../../utils/query.js";
 export type SortOrder = "ascend" | "descend";
 export type FindRequest = {
     [key: string]: Query;
-} & {
-    omit?: "true" | "false";
 };
 export type PortalRequest = {
     name: string;
@@ -33,7 +31,10 @@ export declare class RecordGetOperation<T extends LayoutInterface, OPTIONS exten
     }[];
     protected portals: Partial<PortalData<T>>;
     protected offset: number;
-    protected queries: FindRequest[];
+    protected queries: {
+        req: FindRequest;
+        omit: boolean;
+    }[];
     constructor(layout: LayoutBase, options: OPTIONS);
     get isFindRequest(): boolean;
     private formatQueries;
@@ -43,7 +44,7 @@ export declare class RecordGetOperation<T extends LayoutInterface, OPTIONS exten
     protected generateParamsURL(offset: number, limit: number): URLSearchParams;
     scripts(scripts: ScriptRequestData): this;
     sort(fieldName: string, sortOrder: SortOrder): this;
-    addRequest(query: FindRequest): this;
+    addRequest(query: FindRequest, omit?: boolean): this;
     fetch(): Promise<LayoutRecord<PickPortals<T, keyof OPTIONS["portals"]>>[]>;
     private performFind;
     [Symbol.asyncIterator](): {

package/src/records/getOperations/recordGetOperation.js

@@ -25,13 +25,15 @@ export class RecordGetOperation {
     formatQueries() {
         return this.queries.map(query => {
             let out = {};
-            for (let key of Object.keys(query)) {
-                if (query[key][FindRequestSymbol])
-                    out[key] = query[key][FindRequestSymbol];
+            for (let key of Object.keys(query.req)) {
+                if (query.req[key][FindRequestSymbol])
+                    out[key] = query.req[key][FindRequestSymbol];
                 else {
-                    out[key] = query[key];
+                    out[key] = query.req[key];
                 }
             }
+            if (query.omit)
+                out.omit = "true";
             return out;
         });
     }
@@ -99,8 +101,8 @@ export class RecordGetOperation {
         this.sortData.push({ fieldName, sortOrder });
         return this;
     }
-    addRequest(query) {
-        this.queries.push(query);
+    addRequest(query, omit = false) {
+        this.queries.push({ req: query, omit });
         return this;
     }
     fetch() {

package/src/records/getOperations/recordGetOperation.ts

@@ -13,7 +13,7 @@ import {FindRequestSymbol, Query} from "../../utils/query.js";
 export type SortOrder = "ascend" | "descend"
 export type FindRequest = {
     [key: string]: Query
-} & {omit?: "true" | "false"}
+}
 
 export type PortalRequest = {
     name: string,
@@ -38,7 +38,7 @@ export class RecordGetOperation<T extends LayoutInterface, OPTIONS extends GetOp
     protected sortData: { fieldName: string, sortOrder: SortOrder }[] = []
     protected portals: Partial<PortalData<T>>
     protected offset: number = 1
-    protected queries: FindRequest[] = []
+    protected queries: {req: FindRequest, omit: boolean}[] = []
 
     constructor(layout: LayoutBase, options: OPTIONS) {
         this.layout = layout
@@ -55,10 +55,11 @@ export class RecordGetOperation<T extends LayoutInterface, OPTIONS extends GetOp
     private formatQueries() {
         return this.queries.map(query => {
             let out: any = {}
-            for (let key of Object.keys(query)) {
-                if (query[key][FindRequestSymbol]) out[key] = query[key][FindRequestSymbol]
-                else {out[key] = query[key]}
+            for (let key of Object.keys(query.req)) {
+                if (query.req[key][FindRequestSymbol]) out[key] = query.req[key][FindRequestSymbol]
+                else {out[key] = query.req[key]}
             }
+            if (query.omit) out.omit = "true"
             return out
         })
     }
@@ -127,8 +128,8 @@ export class RecordGetOperation<T extends LayoutInterface, OPTIONS extends GetOp
         return this
     }
 
-    addRequest(query: FindRequest) {
-        this.queries.push(query)
+    addRequest(query: FindRequest, omit = false) {
+        this.queries.push({req: query, omit})
         return this
     }
 

package/src/types.d.ts

@@ -50,7 +50,7 @@ export type ScriptRequestData = {
 export interface extraBodyOptions {
     scripts?: ScriptRequestData;
 }
-export declare enum DOWNLOAD_MODES {
+export declare enum DownloadModes {
     Stream = 0,
     Buffer = 1
 }

package/src/types.js

@@ -1,11 +1,11 @@
 /*
  * 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 DownloadModes;
+(function (DownloadModes) {
+    DownloadModes[DownloadModes["Stream"] = 0] = "Stream";
+    DownloadModes[DownloadModes["Buffer"] = 1] = "Buffer";
+})(DownloadModes || (DownloadModes = {}));
 export var RecordTypes;
 (function (RecordTypes) {
     RecordTypes[RecordTypes["UNKNOWN"] = 0] = "UNKNOWN";

package/src/types.ts

@@ -64,7 +64,7 @@ export interface extraBodyOptions {
     scripts?: ScriptRequestData
 }
 
-export enum DOWNLOAD_MODES {
+export enum DownloadModes {
     Stream,
     Buffer
 }