@jd-data-limited/easy-fm 4.0.5 → 4.0.7

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@jd-data-limited/easy-fm",
-  "version": "4.0.5",
+  "version": "4.0.7",
   "dependencies": {
     "follow-redirects": "^1.15.5",
+    "@types/follow-redirects": "^1.14.4",
     "moment": "^2.29.4"
   },
   "type": "module",
@@ -35,7 +36,6 @@
   "devDependencies": {
     "@types/btoa": "^1.2.3",
     "@types/events": "^3.0.0",
-    "@types/follow-redirects": "^1.14.4",
     "@types/inquirer": "^9.0.7",
     "dotenv": "^16.3.1",
     "inquirer": "^9.2.13",

package/src/connection/database.d.ts

@@ -21,7 +21,8 @@ export declare class Database<T extends DatabaseStructure> extends EventEmitter
     login(): Promise<any>;
     get token(): any;
     get endpoint(): string;
-    apiRequest<T = any>(url: string | Request, options?: any, autoRelogin?: boolean): Promise<ApiResults<T>>;
+    apiRequestRaw(url: string | Request, options?: any): Promise<Response>;
+    apiRequestJSON<T = any>(url: string | Request, options?: any, autoRelogin?: boolean): Promise<ApiResults<T>>;
     listLayouts(): Promise<Layout<LayoutInterface>[]>;
     getLayout<R extends keyof T["layouts"]>(name: R): Layout<T["layouts"][R]>;
     getLayout<R extends LayoutInterface>(name: string): Layout<R>;

package/src/connection/database.js

@@ -85,7 +85,7 @@ export class Database extends EventEmitter {
     get endpoint() {
         return `${this.host.hostname}/fmi/data/v2/databases/${this.name}`;
     }
-    async apiRequest(url, options = {}, autoRelogin = true) {
+    async apiRequestRaw(url, options = {}) {
         if (!options.headers)
             options.headers = {};
         options.headers["content-type"] = options.headers["content-type"] ? options.headers["content-type"] : "application/json";
@@ -98,6 +98,10 @@ export class Database extends EventEmitter {
                 this.cookies[cookie_split[0]] = cookie_split[1];
             }
         }
+        return _fetch;
+    }
+    async apiRequestJSON(url, options = {}, autoRelogin = true) {
+        let _fetch = await this.apiRequestRaw(url, options);
         let data = await _fetch.json();
         // Remove response if it is empty. This makes checking for an empty response easier
         if (data.response && Object.keys(data.response).length === 0)
@@ -106,7 +110,7 @@ export class Database extends EventEmitter {
         if (data.messages[0].code === "952" && autoRelogin) {
             this._token = null;
             await this.login();
-            return await this.apiRequest(url, options, false);
+            return await this.apiRequestJSON(url, options, false);
         }
         else if (data.messages[0].code !== "0") {
             throw new FMError(data.messages[0].code, _fetch.status, data);
@@ -115,7 +119,7 @@ export class Database extends EventEmitter {
         return data;
     }
     async listLayouts() {
-        let req = await this.apiRequest(`${this.endpoint}/layouts?page=2`);
+        let req = await this.apiRequestJSON(`${this.endpoint}/layouts?page=2`);
         if (!req.response)
             throw new FMError(req.messages[0].code, req.httpStatus, req.messages[0].message);
         const cycleLayoutNames = (layouts) => {

package/src/connection/database.ts

@@ -110,7 +110,7 @@ export class Database<T extends DatabaseStructure> extends EventEmitter implemen
         return `${this.host.hostname}/fmi/data/v2/databases/${this.name}`
     }
 
-    async apiRequest<T = any>(url: string | Request, options: any = {}, autoRelogin = true): Promise<ApiResults<T>> {
+    async apiRequestRaw(url: string | Request, options: any = {}) {
         if (!options.headers) options.headers = {}
         options.headers["content-type"] = options.headers["content-type"] ? options.headers["content-type"] : "application/json"
         options.headers["authorization"] = "Bearer " + this._token
@@ -123,6 +123,10 @@ export class Database<T extends DatabaseStructure> extends EventEmitter implemen
                 this.cookies[cookie_split[0]] = cookie_split[1]
             }
         }
+        return _fetch
+    }
+    async apiRequestJSON<T = any>(url: string | Request, options: any = {}, autoRelogin = true): Promise<ApiResults<T>> {
+        let _fetch = await this.apiRequestRaw(url, options)
         let data = await _fetch.json() as ApiResults<T>
 
         // Remove response if it is empty. This makes checking for an empty response easier
@@ -132,7 +136,7 @@ export class Database<T extends DatabaseStructure> extends EventEmitter implemen
         if (data.messages[0].code === "952" && autoRelogin) {
             this._token = null
             await this.login()
-            return await this.apiRequest(url, options, false)
+            return await this.apiRequestJSON(url, options, false)
         }
         else if (data.messages[0].code !== "0") {
             throw new FMError(data.messages[0].code, _fetch.status, data)
@@ -143,7 +147,7 @@ export class Database<T extends DatabaseStructure> extends EventEmitter implemen
     }
 
     async listLayouts() {
-        let req = await this.apiRequest<{layouts: ApiLayout[]}>(`${this.endpoint}/layouts?page=2`)
+        let req = await this.apiRequestJSON<{layouts: ApiLayout[]}>(`${this.endpoint}/layouts?page=2`)
         if (!req.response) throw new FMError(req.messages[0].code, req.httpStatus, req.messages[0].message)
 
         const cycleLayoutNames = (layouts: ApiLayout[]) => {

package/src/connection/databaseBase.d.ts

@@ -6,6 +6,7 @@ export interface DatabaseBase {
     host: HostBase;
     readonly name: string;
     endpoint: string;
-    apiRequest<T = unknown>(url: string | Request, options?: any, autoRelogin?: boolean): Promise<ApiResults<T>>;
+    apiRequestJSON<T = unknown>(url: string | Request, options?: RequestInit | undefined, autoRelogin?: boolean): Promise<ApiResults<T>>;
+    apiRequestRaw(url: string | Request, options?: RequestInit | undefined): Promise<Response>;
     streamURL(url: string): Promise<IncomingMessage>;
 }

package/src/connection/databaseBase.ts

@@ -13,6 +13,7 @@ export interface DatabaseBase {
 
     // layouts: DatabaseStructure["layouts"]
 
-    apiRequest<T = unknown>(url: string | Request, options?: any, autoRelogin?: boolean): Promise<ApiResults<T>>
+    apiRequestJSON<T = unknown>(url: string | Request, options?: RequestInit | undefined, autoRelogin?: boolean): Promise<ApiResults<T>>
+    apiRequestRaw(url: string | Request, options?: RequestInit | undefined): Promise<Response>
     streamURL(url: string): Promise<IncomingMessage>
 }

package/src/layouts/layout.js

@@ -19,8 +19,7 @@ export class Layout {
         let url = `${this.endpoint}/script/${encodeURIComponent(script.name)}`;
         if (script.parameter)
             url += "?script.param=" + encodeURIComponent(script.parameter);
-        let res = await this.database.apiRequest(url, {
-            port: 443,
+        let res = await this.database.apiRequestJSON(url, {
             method: "GET"
         });
         if (res.response && res.messages[0].code === "0") {
@@ -38,7 +37,7 @@ export class Layout {
         if (this.metadata) {
             return this.metadata;
         }
-        let res = await this.database.apiRequest(this.endpoint);
+        let res = await this.database.apiRequestJSON(this.endpoint);
         if (!res.response)
             throw new FMError(res.messages[0].code, res.httpStatus, res);
         this.metadata = res.response;

package/src/layouts/layout.ts

@@ -29,8 +29,7 @@ export class Layout<T extends LayoutInterface> implements LayoutBase {
     async runScript(script: Script): Promise<ScriptResult> {
         let url = `${this.endpoint}/script/${encodeURIComponent(script.name)}`
         if (script.parameter) url += "?script.param=" + encodeURIComponent(script.parameter)
-        let res = await this.database.apiRequest<ApiScriptResult>(url, {
-            port: 443,
+        let res = await this.database.apiRequestJSON<ApiScriptResult>(url, {
             method: "GET"
         })
         if (res.response && res.messages[0].code === "0") {
@@ -49,7 +48,7 @@ export class Layout<T extends LayoutInterface> implements LayoutBase {
             return this.metadata
         }
 
-        let res = await this.database.apiRequest<ApiLayoutMetadata>(this.endpoint)
+        let res = await this.database.apiRequestJSON<ApiLayoutMetadata>(this.endpoint)
         if (!res.response) throw new FMError(res.messages[0].code, res.httpStatus, res)
         this.metadata = res.response
         return this.metadata

package/src/records/fieldBase.js

@@ -120,12 +120,14 @@ export class FieldBase {
             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.parent.layout.database.apiRequest(`${this.parent.endpoint}/containers/${this.id}/1`, {
+        let res = await this.parent.layout.database.apiRequestRaw(`${this.parent.endpoint}/containers/${this.id}/1`, {
             method: "POST",
             // @ts-ignore
             headers: { "Authorization": "Bearer " + this.parent.layout.database.token },
             body: form
         });
+        if (!res.ok)
+            throw new Error(`Upload failed with HTTP error: ${res.status} (${res.statusText})`);
     }
     async download(mode = DOWNLOAD_MODES.Stream) {
         if (this.metadata.result !== ApiFieldResultTypes.CONTAINER)

package/src/records/fieldBase.ts

@@ -136,12 +136,13 @@ export class FieldBase<T extends FieldValue> {
         let form = new FormData()
         form.append("upload", new File([buffer], filename, {type: mime}))
 
-        await this.parent.layout.database.apiRequest<null>(`${this.parent.endpoint}/containers/${this.id}/1`, {
+        let res = await this.parent.layout.database.apiRequestRaw(`${this.parent.endpoint}/containers/${this.id}/1`, {
             method: "POST",
             // @ts-ignore
             headers: {"Authorization": "Bearer " + this.parent.layout.database.token},
             body: form
         })
+        if (!res.ok) throw new Error(`Upload failed with HTTP error: ${res.status} (${res.statusText})`)
     }
 
     download(mode: DOWNLOAD_MODES.Stream): Promise<http.IncomingMessage>

package/src/records/getOperations/recordGetOperation.js

@@ -105,7 +105,7 @@ export class RecordGetOperation {
             body: is_find ? JSON.stringify(this.generateParamsBody(offset, limit)) : undefined,
         };
         try {
-            let res = await this.layout.database.apiRequest(endpoint, reqData);
+            let res = await this.layout.database.apiRequestJSON(endpoint, reqData);
             if (res.messages[0].code === "0" && res.response) {
                 // console.log("RESOLVING")
                 if (!this.layout.metadata)

package/src/records/getOperations/recordGetOperation.ts

@@ -140,7 +140,7 @@ export class RecordGetOperation<T extends LayoutInterface, OPTIONS extends GetOp
         }
 
         try {
-            let res = await this.layout.database.apiRequest<ApiRecordResponseObj>(
+            let res = await this.layout.database.apiRequestJSON<ApiRecordResponseObj>(
                 endpoint,
                 reqData
             )

package/src/records/layoutRecord.js

@@ -41,8 +41,7 @@ export class LayoutRecord extends RecordBase {
         }
         if (this.recordId === -1) {
             // This is a new LayoutRecord
-            let res = await this.layout.database.apiRequest(`${this.layout.endpoint}/records`, {
-                port: 443,
+            let res = await this.layout.database.apiRequestJSON(`${this.layout.endpoint}/records`, {
                 method: "POST",
                 body: JSON.stringify(data)
             });
@@ -62,8 +61,7 @@ export class LayoutRecord extends RecordBase {
             }
         }
         // for (let item of Object.keys(data)) extraBody[item] = data[item]
-        let res = await this.layout.database.apiRequest(this.endpoint, {
-            port: 443,
+        let res = await this.layout.database.apiRequestJSON(this.endpoint, {
             method: "PATCH",
             body: JSON.stringify(data)
         });
@@ -102,8 +100,7 @@ export class LayoutRecord extends RecordBase {
         }
         if (!this.layout.metadata)
             await this.layout.getLayoutMeta();
-        let res = await this.layout.database.apiRequest(this.endpoint, {
-            port: 443,
+        let res = await this.layout.database.apiRequestJSON(this.endpoint, {
             method: "GET"
         });
         if (res.response && res.messages[0].code === "0") {
@@ -121,8 +118,7 @@ export class LayoutRecord extends RecordBase {
     }
     async duplicate() {
         let trace = new Error();
-        let res = await this.layout.database.apiRequest(this.endpoint, {
-            port: 443,
+        let res = await this.layout.database.apiRequestJSON(this.endpoint, {
             method: "POST"
         });
         if (!res.response) {
@@ -142,8 +138,7 @@ export class LayoutRecord extends RecordBase {
         }
     }
     async delete() {
-        let res = await this.layout.database.apiRequest(this.endpoint, {
-            port: 443,
+        let res = await this.layout.database.apiRequestJSON(this.endpoint, {
             method: "DELETE"
         });
         console.log(res);

package/src/records/layoutRecord.ts

@@ -57,8 +57,7 @@ export class LayoutRecord<LAYOUT extends LayoutInterface> extends RecordBase<LAY
 
         if (this.recordId === -1) {
             // This is a new LayoutRecord
-             let res = await this.layout.database.apiRequest<{ recordId: string, modId: string }>(`${this.layout.endpoint}/records`, {
-                    port: 443,
+             let res = await this.layout.database.apiRequestJSON<{ recordId: string, modId: string }>(`${this.layout.endpoint}/records`, {
                     method: "POST",
                     body: JSON.stringify(data)
                 })
@@ -80,14 +79,13 @@ export class LayoutRecord<LAYOUT extends LayoutInterface> extends RecordBase<LAY
         }
 
         // for (let item of Object.keys(data)) extraBody[item] = data[item]
-        let res = await this.layout.database.apiRequest<{
+        let res = await this.layout.database.apiRequestJSON<{
             modId: string, newPortalRecordInfo: {
                 tableName: string,
                 recordId: string,
                 modId: string
             }[]
         }>(this.endpoint, {
-            port: 443,
             method: "PATCH",
             body: JSON.stringify(data)
         })
@@ -128,8 +126,7 @@ export class LayoutRecord<LAYOUT extends LayoutInterface> extends RecordBase<LAY
             throw "Cannot get this RecordBase until a commit() is done."
         }
         if (!this.layout.metadata) await this.layout.getLayoutMeta()
-        let res = await this.layout.database.apiRequest<ApiRecordResponseObj>(this.endpoint, {
-            port: 443,
+        let res = await this.layout.database.apiRequestJSON<ApiRecordResponseObj>(this.endpoint, {
             method: "GET"
         })
 
@@ -147,8 +144,7 @@ export class LayoutRecord<LAYOUT extends LayoutInterface> extends RecordBase<LAY
 
     async duplicate(): Promise<LayoutRecord<LAYOUT>> {
         let trace = new Error()
-        let res = await this.layout.database.apiRequest<{recordId: string, modId: string}>(this.endpoint, {
-            port: 443,
+        let res = await this.layout.database.apiRequestJSON<{recordId: string, modId: string}>(this.endpoint, {
             method: "POST"
         })
         if (!res.response) {
@@ -170,8 +166,7 @@ export class LayoutRecord<LAYOUT extends LayoutInterface> extends RecordBase<LAY
     }
 
     async delete(): Promise<void> {
-        let res = await this.layout.database.apiRequest(this.endpoint, {
-            port: 443,
+        let res = await this.layout.database.apiRequestJSON(this.endpoint, {
             method: "DELETE"
         })
         console.log(res)

package/src/records/field.d.ts

@@ -1,6 +0,0 @@
-import { RecordBase } from "./recordBase.js";
-import { FieldBase, FieldValue } from "./fieldBase.js";
-export declare abstract class Field<T extends FieldValue> extends FieldBase<T> {
-    record: RecordBase<any>;
-    protected constructor(record: RecordBase<any>);
-}

package/src/records/field.js

@@ -1,11 +0,0 @@
-/*
- * Copyright (c) 2024. See LICENSE file for more information
- */
-import { FieldBase } from "./fieldBase.js";
-export class Field extends FieldBase {
-    record;
-    constructor(record) {
-        super();
-        this.record = record;
-    }
-}