@jd-data-limited/easy-fm 4.0.1 → 4.0.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jd-data-limited/easy-fm",
-  "version": "4.0.1",
+  "version": "4.0.2",
   "dependencies": {
     "follow-redirects": "^1.15.5",
     "moment": "^2.29.4"
@@ -37,6 +37,7 @@
     "@types/events": "^3.0.0",
     "@types/follow-redirects": "^1.14.4",
     "dotenv": "^16.3.1",
+    "ts-morph": "^21.0.1",
     "typescript": "^5.3.3",
     "webpack": "^5.81.0",
     "webpack-cli": "^5.0.2"

package/src/connection/database.js

@@ -115,10 +115,21 @@ export class Database extends EventEmitter {
         return data;
     }
     async listLayouts() {
-        let req = await this.apiRequest(`${this.endpoint}/layouts`);
+        let req = await this.apiRequest(`${this.endpoint}/layouts?page=2`);
         if (!req.response)
             throw new FMError(req.messages[0].code, req.httpStatus, req.messages[0].message);
-        return req.response.layouts.filter(i => !i.isFolder).map(layout => new Layout(this, layout.name));
+        const cycleLayoutNames = (layouts) => {
+            let names = [];
+            for (let layout of layouts) {
+                if (layout.folderLayoutNames)
+                    names = names.concat(cycleLayoutNames(layout.folderLayoutNames));
+                else
+                    names.push(layout.name);
+            }
+            return names;
+        };
+        let layoutNames;
+        return cycleLayoutNames(req.response.layouts).map(layout => new Layout(this, layout));
     }
     getLayout(name) {
         return new Layout(this, name);

package/src/connection/database.ts

@@ -143,10 +143,20 @@ export class Database<T extends DatabaseStructure> extends EventEmitter implemen
     }
 
     async listLayouts() {
-        let req = await this.apiRequest<{layouts: ApiLayout[]}>(`${this.endpoint}/layouts`)
+        let req = await this.apiRequest<{layouts: ApiLayout[]}>(`${this.endpoint}/layouts?page=2`)
         if (!req.response) throw new FMError(req.messages[0].code, req.httpStatus, req.messages[0].message)
 
-        return req.response.layouts.filter(i => !i.isFolder).map(layout => new Layout(this, layout.name))
+        const cycleLayoutNames = (layouts: ApiLayout[]) => {
+            let names: string[] =  []
+            for (let layout of layouts) {
+                if (layout.folderLayoutNames) names = names.concat(cycleLayoutNames(layout.folderLayoutNames))
+                else names.push(layout.name)
+            }
+            return names
+        }
+        let layoutNames
+
+        return cycleLayoutNames(req.response.layouts).map(layout => new Layout(this, layout))
     }
 
     getLayout<R extends keyof T["layouts"]>(name: R): Layout<T["layouts"][R]>

package/src/index.d.ts

@@ -1,6 +1,7 @@
 import FMHost from "./connection/FMHost.js";
 import { FMError } from "./FMError.js";
 import * as TYPES from "./types.js";
+import { PickPortals } from "./types.js";
 import { Database } from "./connection/database.js";
 import { Layout } from "./layouts/layout.js";
 import { RecordBase } from "./records/recordBase.js";
@@ -13,4 +14,4 @@ import { RecordGetOperation } from "./records/getOperations/recordGetOperation.j
 import { LayoutRecordManager } from "./layouts/layoutRecordManager.js";
 import { RecordFieldsMap } from "./layouts/recordFieldsMap.js";
 export default FMHost;
-export { FMError, TYPES, Database, Layout, RecordBase, LayoutRecord, LayoutInterface, RecordFieldsMap, PortalInterface, PortalRecord, Portal, FieldBase, RecordGetOperation, LayoutRecordManager, Container };
+export { FMError, TYPES, Database, Layout, RecordBase, LayoutRecord, LayoutInterface, RecordFieldsMap, PortalInterface, PortalRecord, Portal, FieldBase, RecordGetOperation, LayoutRecordManager, Container, PickPortals };

package/src/index.ts

@@ -5,6 +5,7 @@
 import FMHost from "./connection/FMHost.js";
 import {FMError} from "./FMError.js";
 import * as TYPES from "./types.js"
+import {PickPortals} from "./types.js"
 import {Database} from "./connection/database.js";
 import {Layout} from "./layouts/layout.js";
 import {RecordBase} from "./records/recordBase.js";
@@ -33,5 +34,6 @@ export {
     FieldBase,
     RecordGetOperation,
     LayoutRecordManager,
-    Container
+    Container,
+    PickPortals
 }

package/src/layouts/layoutInterface.d.ts

@@ -5,5 +5,5 @@ export interface LayoutInterface {
     portals: PortalInterface;
 }
 export interface PortalInterface {
-    [key: string]: Portal<RecordFieldsMap>;
+    [key: string | number | symbol]: Portal<RecordFieldsMap>;
 }

package/src/layouts/layoutInterface.ts

@@ -11,6 +11,5 @@ export interface LayoutInterface {
 }
 
 export interface PortalInterface {
-    [key: string]: Portal<RecordFieldsMap>
-}
-
+    [key: string | number | symbol]: Portal<RecordFieldsMap>
+}

package/src/layouts/layoutRecordManager.d.ts

@@ -2,11 +2,11 @@ import { LayoutRecord } from "../records/layoutRecord.js";
 import { LayoutInterface } from "./layoutInterface.js";
 import { LayoutBase } from "./layoutBase.js";
 import { GetOperationOptions, RecordGetOperation } from "../records/getOperations/recordGetOperation.js";
-import { RecordFetchOptions } from "../types.js";
+import { PickPortals, RecordFetchOptions } from "../types.js";
 export declare class LayoutRecordManager<T extends LayoutInterface> {
     readonly layout: LayoutBase;
     constructor(layout: LayoutBase);
-    create<OPTIONS extends RecordFetchOptions>(options: OPTIONS): Promise<LayoutRecord<T, OPTIONS["portals"][number]>>;
-    get(recordId: number): Promise<LayoutRecord<T>>;
+    create<OPTIONS extends RecordFetchOptions>(options: OPTIONS): Promise<LayoutRecord<PickPortals<T, OPTIONS["portals"][number]>>>;
+    get(recordId: number): Promise<LayoutRecord<PickPortals<T, never>>>;
     list<OPTIONS extends GetOperationOptions<T>>(options: OPTIONS): RecordGetOperation<T, OPTIONS>;
 }

package/src/layouts/layoutRecordManager.ts

@@ -6,7 +6,7 @@ import {LayoutRecord} from "../records/layoutRecord.js";
 import {LayoutInterface} from "./layoutInterface.js";
 import {LayoutBase} from "./layoutBase.js"
 import {GetOperationOptions, RecordGetOperation} from "../records/getOperations/recordGetOperation.js";
-import {RecordFetchOptions} from "../types.js";
+import {PickPortals, RecordFetchOptions} from "../types.js";
 import {ApiFieldData} from "../models/apiResults.js";
 
 export class LayoutRecordManager<T extends LayoutInterface> {
@@ -15,7 +15,9 @@ export class LayoutRecordManager<T extends LayoutInterface> {
         this.layout = layout
     }
 
-    async create<OPTIONS extends RecordFetchOptions>(options: OPTIONS): Promise<LayoutRecord<T, OPTIONS["portals"][number]>> {
+    async create<OPTIONS extends RecordFetchOptions>(options: OPTIONS): Promise<LayoutRecord<
+        PickPortals<T, OPTIONS["portals"][number]>
+    >> {
         await this.layout.getLayoutMeta()
         let fields: ApiFieldData = {}
         for (let _field of this.layout.metadata.fieldMetaData) {
@@ -26,9 +28,11 @@ export class LayoutRecordManager<T extends LayoutInterface> {
         return new LayoutRecord(this.layout, -1, 0, fields, portals)
     }
 
-    async get(recordId: number): Promise<LayoutRecord<T>> {
+    async get(recordId: number): Promise<LayoutRecord<
+        PickPortals<T, never>
+    >> {
         await this.layout.getLayoutMeta()
-        let record = new LayoutRecord<T>(this.layout, recordId)
+        let record = new LayoutRecord<PickPortals<T, never>>(this.layout, recordId)
         await record.get()
         return record
     }

package/src/models/apiResults.d.ts

@@ -33,8 +33,8 @@ export interface ApiResults<T = unknown> {
 }
 export interface ApiLayout {
     name: string;
-    isFolder: boolean;
-    folderLayoutNames: string[];
+    isFolder?: boolean;
+    folderLayoutNames?: ApiLayout[];
 }
 export interface ApiLayoutMetadata {
     fieldMetaData: ApiFieldMetadata[];

package/src/models/apiResults.ts

@@ -40,8 +40,8 @@ export interface ApiResults<T = unknown> {
 
 export interface ApiLayout {
     name: string,
-    isFolder: boolean,
-    folderLayoutNames: string[]
+    isFolder?: boolean,
+    folderLayoutNames?: ApiLayout[]
 }
 
 export interface ApiLayoutMetadata {

package/src/records/field.d.ts

@@ -1,5 +1,5 @@
-import { RecordBase } from "./recordBase";
-import { FieldBase, FieldValue } from "./fieldBase";
+import { RecordBase } from "./recordBase.js";
+import { FieldBase, FieldValue } from "./fieldBase.js";
 export declare class Field<T extends FieldValue> extends FieldBase<T> {
     record: RecordBase<any>;
 }

package/src/records/field.js

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

package/src/records/field.ts

@@ -2,8 +2,8 @@
  * Copyright (c) 2024. See LICENSE file for more information
  */
 
-import {RecordBase} from "./recordBase";
-import {FieldBase, FieldValue} from "./fieldBase";
+import {RecordBase} from "./recordBase.js";
+import {FieldBase, FieldValue} from "./fieldBase.js";
 
 export class Field<T extends FieldValue> extends FieldBase<T> {
     record: RecordBase<any>;

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

@@ -1,5 +1,5 @@
 import { LayoutInterface } from "../../layouts/layoutInterface.js";
-import { ScriptRequestData } from "../../types.js";
+import { PickPortals, ScriptRequestData } from "../../types.js";
 import { LayoutBase } from "../../layouts/layoutBase.js";
 import { LayoutRecord } from "../layoutRecord.js";
 export type SortOrder = "ascend" | "descend";
@@ -41,12 +41,12 @@ export declare class RecordGetOperation<T extends LayoutInterface, OPTIONS exten
     scripts(scripts: ScriptRequestData): this;
     sort(fieldName: string, sortOrder: SortOrder): this;
     addRequest(query: FindRequest): this;
-    fetch(): Promise<LayoutRecord<T, keyof OPTIONS["portals"]>[]>;
+    fetch(): Promise<LayoutRecord<PickPortals<T, keyof OPTIONS["portals"]>>[]>;
     private performFind;
     [Symbol.asyncIterator](): {
         next: () => Promise<{
             done: boolean;
-            value: LayoutRecord<T, keyof OPTIONS["portals"]>;
+            value: LayoutRecord<PickPortals<T, keyof OPTIONS["portals"]>>;
         }>;
     };
 }

package/src/records/getOperations/recordGetOperation.ts

@@ -3,7 +3,7 @@
  */
 
 import {LayoutInterface} from "../../layouts/layoutInterface.js";
-import {ScriptRequestData} from "../../types.js";
+import {PickPortals, ScriptRequestData} from "../../types.js";
 import {LayoutBase} from "../../layouts/layoutBase.js"
 import {LayoutRecord} from "../layoutRecord.js";
 import {ApiRecordResponseObj} from "../../models/apiResults.js";
@@ -124,7 +124,9 @@ export class RecordGetOperation<T extends LayoutInterface, OPTIONS extends GetOp
         return this.performFind(this.offset, this.limit)
     }
 
-    private async performFind(offset: number, limit: number): Promise<LayoutRecord<T, keyof OPTIONS["portals"]>[]> {
+    private async performFind(offset: number, limit: number): Promise<LayoutRecord<
+        PickPortals<T, keyof OPTIONS["portals"]>
+    >[]> {
         let trace = new Error()
         await this.layout.getLayoutMeta()
 
@@ -163,7 +165,7 @@ export class RecordGetOperation<T extends LayoutInterface, OPTIONS extends GetOp
         let limit = this.limit
 
         let exit_after_last_record = false
-        let records: LayoutRecord<T, keyof OPTIONS["portals"]>[] = []
+        let records: LayoutRecord<PickPortals<T, keyof OPTIONS["portals"]>>[] = []
 
         const fetch = async () => {
             const theoretical_limit = (limit - nextOffset) + startOffset

package/src/records/layoutRecord.d.ts

@@ -7,10 +7,10 @@ import { LayoutRecordBase } from "./layoutRecordBase.js";
 import { ApiPortalData } from "../models/apiResults.js";
 import { LayoutBase } from "../layouts/layoutBase.js";
 import { FieldBase, FieldValue } from "./fieldBase.js";
-export declare class LayoutRecord<LAYOUT extends LayoutInterface, PORTALS_TO_INCLUDE = string> extends RecordBase<LAYOUT["fields"]> implements LayoutRecordBase {
-    portals: Pick<LAYOUT["portals"], PORTALS_TO_INCLUDE>;
+export declare class LayoutRecord<LAYOUT extends LayoutInterface> extends RecordBase<LAYOUT["fields"]> implements LayoutRecordBase {
+    portals: LAYOUT["portals"];
     private readonly portalsToInclude;
-    constructor(layout: LayoutBase, recordId: number | string, modId?: string | number, fieldData?: Record<string, string | number>, portalData?: ApiPortalData | null, portalsToInclude?: PORTALS_TO_INCLUDE[]);
+    constructor(layout: LayoutBase, recordId: number | string, modId?: string | number, fieldData?: Record<string, string | number>, portalData?: ApiPortalData | null, portalsToInclude?: (keyof LAYOUT["portals"])[]);
     get portalsArray(): Portal<any>[];
     commit(extraBody?: extraBodyOptions): Promise<this>;
     protected processPortalData(portalData: ApiPortalData): void;

package/src/records/layoutRecord.ts

@@ -13,17 +13,17 @@ import {ApiPortalData, ApiRecordResponseObj} from "../models/apiResults.js";
 import {LayoutBase} from "../layouts/layoutBase.js"
 import {FieldBase, FieldValue} from "./fieldBase.js";
 
-export class LayoutRecord<LAYOUT extends LayoutInterface, PORTALS_TO_INCLUDE = string> extends RecordBase<LAYOUT["fields"]> implements LayoutRecordBase {
+export class LayoutRecord<LAYOUT extends LayoutInterface> extends RecordBase<LAYOUT["fields"]> implements LayoutRecordBase {
     // @ts-ignore
-    portals: Pick<LAYOUT["portals"], PORTALS_TO_INCLUDE> = {}
-    private readonly portalsToInclude: PORTALS_TO_INCLUDE[]
+    portals: LAYOUT["portals"] = {}
+    private readonly portalsToInclude: (string | number | symbol)[]
 
     constructor(
         layout: LayoutBase,
         recordId: number | string,
         modId = recordId,
         fieldData: Record<string, string | number> = {},
-        portalData: ApiPortalData | null = null, portalsToInclude: PORTALS_TO_INCLUDE[] = [])
+        portalData: ApiPortalData | null = null, portalsToInclude: (keyof LAYOUT["portals"])[] = [])
     {
         super(layout, parseInt(recordId as string), parseInt(modId as string));
         this.processFieldData(fieldData)

package/src/records/portal.d.ts

@@ -2,11 +2,10 @@ import { PortalRecord } from "./portalRecord.js";
 import { RecordFieldsMap } from "../layouts/recordFieldsMap.js";
 import { PortalBase } from "./portalBase.js";
 import { LayoutRecord } from "./layoutRecord.js";
-import { LayoutInterface } from "../layouts/layoutInterface.js";
 export declare class Portal<T extends RecordFieldsMap> implements PortalBase<T> {
-    readonly record: LayoutRecord<LayoutInterface>;
+    readonly record: LayoutRecord<any>;
     readonly name: string;
     records: PortalRecord<T>[];
-    constructor(record: LayoutRecord<LayoutInterface, any>, name: string);
+    constructor(record: LayoutRecord<any>, name: string);
     create(): PortalRecord<T>;
 }

package/src/records/portal.ts

@@ -6,14 +6,13 @@ import {PortalRecord} from "./portalRecord.js";
 import {RecordFieldsMap} from "../layouts/recordFieldsMap.js";
 import {PortalBase} from "./portalBase.js";
 import {LayoutRecord} from "./layoutRecord.js";
-import {LayoutInterface} from "../layouts/layoutInterface.js";
 
 export class Portal<T extends RecordFieldsMap> implements PortalBase<T> {
-    readonly record: LayoutRecord<LayoutInterface>;
+    readonly record: LayoutRecord<any>;
     readonly name: string;
     public records: PortalRecord<T>[];
 
-    constructor(record: LayoutRecord<LayoutInterface, any>, name: string) {
+    constructor(record: LayoutRecord<any>, name: string) {
         this.record = record
         this.name = name
     }

package/src/records/portalRecord.d.ts

@@ -8,7 +8,7 @@ export declare class PortalRecord<T extends RecordFieldsMap> extends RecordBase<
     readonly type = RecordTypes.PORTAL;
     constructor(record: RecordBase<any>, portal: PortalBase<any>, recordId: number, modId?: number, fieldData?: {});
     _onSave(): void;
-    commit(extraBody?: extraBodyOptions): Promise<import("./layoutRecord.js").LayoutRecord<import("../index.js").LayoutInterface, string>>;
+    commit(extraBody?: extraBodyOptions): Promise<import("./layoutRecord.js").LayoutRecord<import("../index.js").LayoutInterface>>;
     toObject(fieldFilter: (a: FieldBase<FieldValue>) => boolean): {
         [key: string]: string;
         modId: string;

package/src/types.d.ts

@@ -2,6 +2,10 @@
 /// <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>;
+};
 export interface databaseOptionsBase {
     database: string;
     credentials: loginOptionsOAuth | loginOptionsFileMaker | loginOptionsClaris | loginOptionsToken;

package/src/types.ts

@@ -6,6 +6,10 @@
 // @ts-ignore
 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> }
 
 export interface databaseOptionsBase {
     database: string