@ruiapp/rapid-configure-tools 0.5.3 → 0.6.1

package/dist/mod.js

@@ -564,7 +564,7 @@ class RapidUpdater {
             }
         }
         for (const entityToSave of entitiesToSave) {
-            if (!modelUpdater.relationFields) {
+            if (!modelUpdater.relationFields || !modelUpdater.relationFields.length) {
                 continue;
             }
             console.log(`update relation fields of ${modelUpdater.modelType} ${modelUpdater.inputTitlePrinter(entityToSave)}`);
@@ -764,6 +764,7 @@ function newModelUpdater(rapidConfigApi) {
                 "derivedType",
                 "derivedTypePropertyCode",
                 "displayPropertyCode",
+                "defaultOrderBy",
                 "indexes",
                 "permissionPolicies",
                 "softDelete",
@@ -908,13 +909,114 @@ function newPropertyUpdater(rapidConfigApi) {
     return propertyUpdater;
 }
 
+function convertInputToEntity(input) {
+    const inputEntity = {
+        subSystem: input.subSystem,
+        appCode: input.appCode,
+        code: input.code,
+        parentCode: input.parentCode,
+        routePath: input.routePath,
+        name: input.name,
+        title: input.title,
+        permissionCheck: input.permissionCheck,
+        config: {
+            view: input.view,
+            stores: input.stores,
+            eventSubscriptions: input.eventSubscriptions,
+            functions: input.functions,
+            $i18n: input.$i18n,
+            $locales: input.$locales,
+        },
+    };
+    return inputEntity;
+}
+function newPageUpdater(rapidConfigApi) {
+    const pageUpdater = {
+        modelType: "page",
+        relationFields: [],
+        entityBatchMode: false,
+        inputTitlePrinter(input) {
+            return input.code;
+        },
+        entityKeyGetter(input) {
+            return input.code;
+        },
+        async entitySingleFinder(entityKey) {
+            const res = await rapidConfigApi.post(`meta/pages/operations/find`, {
+                filters: [
+                    {
+                        operator: "eq",
+                        field: "code",
+                        value: entityKey,
+                    },
+                ],
+            });
+            const entities = res.data.list;
+            if (entities && entities.length) {
+                return entities[0];
+            }
+            return null;
+        },
+        entityExistensePredicate(input, entity) {
+            return entity.code === input.code;
+        },
+        isEntityChanged(input, remoteEntity) {
+            const inputEntity = convertInputToEntity(input);
+            const changedFieldNames = detectChangedFields(inputEntity, remoteEntity, [
+                "subSystem",
+                "appCode",
+                "code",
+                "parentCode",
+                "routePath",
+                "name",
+                "title",
+                "config",
+                "permissionCheck",
+            ]);
+            if (changedFieldNames.length) {
+                console.log(`${this.modelType} ${this.inputTitlePrinter(inputEntity)} changed with these fields:`, changedFieldNames);
+            }
+            return changedFieldNames.length > 0;
+        },
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        async createEntity(input, mainEntity, inputIndex) {
+            const createEntityInput = convertInputToEntity(input);
+            const res = await rapidConfigApi.post(`meta/pages`, createEntityInput);
+            const { data } = res;
+            if (!data.id) {
+                console.log("Response:");
+                console.log(data);
+                console.log("Input:");
+                console.log(createEntityInput);
+            }
+            return data;
+        },
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        async updateEntity(input, remoteEntity, mainEntity, inputIndex) {
+            const updateEntityInput = convertInputToEntity(input);
+            const res = await rapidConfigApi.patch(`meta/pages/${remoteEntity.id}`, updateEntityInput);
+            const { data } = res;
+            if (!data.id) {
+                console.log("Response:");
+                console.log(data);
+                console.log("Input:");
+                console.log(updateEntityInput);
+            }
+            return data;
+        },
+    };
+    return pageUpdater;
+}
+
 class RapidModelsUpdater {
     #rapidConfigApi;
     #entities;
     #dataDictionaries;
+    #pages;
     constructor(options) {
         this.#entities = options.entities;
         this.#dataDictionaries = options.dataDictionaries;
+        this.#pages = options.pages;
         const { appDataDirLocation, rapidApiUrl } = options;
         const cookieJarStorageLocation = path__default["default"].join(appDataDirLocation, "rapid-cookie-jar.json");
         if (!fs__default["default"].existsSync(appDataDirLocation)) {
@@ -944,6 +1046,7 @@ class RapidModelsUpdater {
                 newDictionaryEntryUpdater(rapidConfigApi),
                 newModelUpdater(rapidConfigApi),
                 newPropertyUpdater(rapidConfigApi),
+                newPageUpdater(rapidConfigApi),
             ],
         });
         appUpdater.updateModels([
@@ -955,6 +1058,10 @@ class RapidModelsUpdater {
                 modelType: "model",
                 entities: this.#entities.filter((item) => !item.metaOnly),
             },
+            {
+                modelType: "page",
+                entities: this.#pages,
+            },
         ]);
     }
 }

package/dist/rapid-models-updater/PageUpdater.d.ts

@@ -0,0 +1,4 @@
+import type { RapidPage } from "@ruiapp/rapid-extension";
+import type { AxiosInstance } from "axios";
+import type { RapidPageEntity } from "./types";
+export declare function newPageUpdater(rapidConfigApi: AxiosInstance): import("./types").IRapidModelUpdaterSingleGetMode<RapidPageEntity, RapidPage, any>;

package/dist/rapid-models-updater/mod.d.ts

@@ -1,9 +1,10 @@
-import type { RapidDataDictionary, RapidEntity } from "@ruiapp/rapid-extension";
+import type { RapidDataDictionary, RapidEntity, RapidPage } from "@ruiapp/rapid-extension";
 export interface RapidModelsUpdateOptions {
     appDataDirLocation: string;
     rapidApiUrl: string;
     entities: RapidEntity[];
     dataDictionaries: RapidDataDictionary[];
+    pages: RapidPage[];
 }
 export default class RapidModelsUpdater {
     #private;

package/dist/rapid-models-updater/types.d.ts

@@ -1,4 +1,4 @@
-import type { RapidDataDictionary, RapidDataDictionaryEntry, RapidEntity, RapidField } from "@ruiapp/rapid-extension";
+import type { RapidDataDictionary, RapidDataDictionaryEntry, RapidEntity, RapidField, RapidPage } from "@ruiapp/rapid-extension";
 export type IRapidModelUpdater<TEntity, TInput, TMainEntity = any> = IRapidModelUpdaterBatchGetMode<TEntity, TInput, TMainEntity> | IRapidModelUpdaterSingleGetMode<TEntity, TInput, TMainEntity>;
 export interface IRapidModelUpdaterCommon<TEntity, TInput, TMainEntity> {
     modelType: string;
@@ -43,3 +43,17 @@ export type CreateRapidPropertyInput = RapidField & {
 };
 export type UpdateRapidPropertyInput = CreateRapidPropertyInput;
 export type RapidProperty = ObjWithIdProp & RapidField;
+export type CreateRapidPageInput = RapidPage;
+export type UpdateRapidPageInput = CreateRapidPageInput;
+export type RapidPageEntity = {
+    id?: string;
+    subSystem?: string;
+    appCode?: string;
+    code: string;
+    parentCode?: string;
+    routePath?: string;
+    name: string;
+    title?: string;
+    config?: Record<any, any>;
+    permissionCheck?: Record<any, any>;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ruiapp/rapid-configure-tools",
-  "version": "0.5.3",
+  "version": "0.6.1",
   "description": "",
   "main": "dist/mod.js",
   "keywords": [],
@@ -20,8 +20,8 @@
     "axios-cookiejar-support": "^4.0.7",
     "lodash": "^4.17.21",
     "tough-cookie": "^4.1.3",
-    "@ruiapp/rapid-core": "^0.9.8",
-    "@ruiapp/rapid-extension": "^0.5.44"
+    "@ruiapp/rapid-core": "^0.10.1",
+    "@ruiapp/rapid-extension": "^0.6.1"
   },
   "dependencies": {},
   "scripts": {

package/src/rapid-models-updater/AppUpdater.ts

@@ -62,7 +62,7 @@ export default class RapidUpdater {
     }
 
     for (const entityToSave of entitiesToSave) {
-      if (!modelUpdater.relationFields) {
+      if (!modelUpdater.relationFields || !modelUpdater.relationFields.length) {
         continue;
       }
 

package/src/rapid-models-updater/ModelUpdater.ts

@@ -42,6 +42,7 @@ export function newModelUpdater(rapidConfigApi: AxiosInstance) {
         "derivedType",
         "derivedTypePropertyCode",
         "displayPropertyCode",
+        "defaultOrderBy",
         "indexes",
         "permissionPolicies",
         "softDelete",

package/src/rapid-models-updater/PageUpdater.ts

@@ -0,0 +1,115 @@
+import type { FindEntityOptions, RapidPage } from "@ruiapp/rapid-extension";
+import type { AxiosInstance } from "axios";
+import { detectChangedFields } from "./ObjectChangesDetector";
+import type { CreateRapidPageInput, IRapidModelUpdater, UpdateRapidPageInput, RapidPageEntity } from "./types";
+
+function convertInputToEntity(input: RapidPage) {
+  const inputEntity: RapidPageEntity = {
+    subSystem: input.subSystem,
+    appCode: input.appCode,
+    code: input.code,
+    parentCode: input.parentCode,
+    routePath: input.routePath,
+    name: input.name,
+    title: input.title,
+    permissionCheck: input.permissionCheck,
+    config: {
+      view: input.view,
+      stores: input.stores,
+      eventSubscriptions: input.eventSubscriptions,
+      functions: input.functions,
+      $i18n: input.$i18n,
+      $locales: input.$locales,
+    },
+  };
+  return inputEntity;
+}
+
+export function newPageUpdater(rapidConfigApi: AxiosInstance) {
+  const pageUpdater: IRapidModelUpdater<RapidPageEntity, RapidPage> = {
+    modelType: "page",
+    relationFields: [],
+
+    entityBatchMode: false,
+
+    inputTitlePrinter(input) {
+      return input.code;
+    },
+
+    entityKeyGetter(input) {
+      return input.code;
+    },
+
+    async entitySingleFinder(entityKey: string) {
+      const res = await rapidConfigApi.post(`meta/pages/operations/find`, {
+        filters: [
+          {
+            operator: "eq",
+            field: "code",
+            value: entityKey,
+          },
+        ],
+      } satisfies FindEntityOptions);
+
+      const entities = res.data.list;
+      if (entities && entities.length) {
+        return entities[0];
+      }
+
+      return null;
+    },
+
+    entityExistensePredicate(input, entity) {
+      return entity.code === input.code;
+    },
+
+    isEntityChanged(input, remoteEntity) {
+      const inputEntity = convertInputToEntity(input);
+      const changedFieldNames = detectChangedFields(inputEntity, remoteEntity, [
+        "subSystem",
+        "appCode",
+        "code",
+        "parentCode",
+        "routePath",
+        "name",
+        "title",
+        "config",
+        "permissionCheck",
+      ]);
+      if (changedFieldNames.length) {
+        console.log(`${this.modelType} ${this.inputTitlePrinter(inputEntity)} changed with these fields:`, changedFieldNames);
+      }
+      return changedFieldNames.length > 0;
+    },
+
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    async createEntity(input, mainEntity, inputIndex) {
+      const createEntityInput: CreateRapidPageInput = convertInputToEntity(input);
+      const res = await rapidConfigApi.post(`meta/pages`, createEntityInput);
+      const { data } = res;
+      if (!data.id) {
+        console.log("Response:");
+        console.log(data);
+        console.log("Input:");
+        console.log(createEntityInput);
+      }
+      return data;
+    },
+
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    async updateEntity(input, remoteEntity, mainEntity, inputIndex) {
+      const updateEntityInput: UpdateRapidPageInput = convertInputToEntity(input);
+      const res = await rapidConfigApi.patch(`meta/pages/${remoteEntity.id}`, updateEntityInput);
+      const { data } = res;
+      if (!data.id) {
+        console.log("Response:");
+        console.log(data);
+        console.log("Input:");
+        console.log(updateEntityInput);
+      }
+      return data;
+    },
+  };
+
+  return pageUpdater;
+}

package/src/rapid-models-updater/mod.ts

@@ -8,23 +8,27 @@ import { newDictionaryUpdater } from "./DictionaryUpdater";
 import { newDictionaryEntryUpdater } from "./DictionaryEntryUpdater";
 import { newModelUpdater } from "./ModelUpdater";
 import { newPropertyUpdater } from "./PropertyUpdater";
-import type { RapidDataDictionary, RapidEntity } from "@ruiapp/rapid-extension";
+import type { RapidDataDictionary, RapidEntity, RapidPage } from "@ruiapp/rapid-extension";
+import { newPageUpdater } from "./PageUpdater";
 
 export interface RapidModelsUpdateOptions {
   appDataDirLocation: string;
   rapidApiUrl: string;
   entities: RapidEntity[];
   dataDictionaries: RapidDataDictionary[];
+  pages: RapidPage[];
 }
 
 export default class RapidModelsUpdater {
   #rapidConfigApi: AxiosInstance;
   #entities: RapidEntity[];
   #dataDictionaries: RapidDataDictionary[];
+  #pages: RapidPage[];
 
   constructor(options: RapidModelsUpdateOptions) {
     this.#entities = options.entities;
     this.#dataDictionaries = options.dataDictionaries;
+    this.#pages = options.pages;
 
     const { appDataDirLocation, rapidApiUrl } = options;
 
@@ -61,6 +65,7 @@ export default class RapidModelsUpdater {
         newDictionaryEntryUpdater(rapidConfigApi),
         newModelUpdater(rapidConfigApi),
         newPropertyUpdater(rapidConfigApi),
+        newPageUpdater(rapidConfigApi),
       ],
     });
     appUpdater.updateModels([
@@ -72,6 +77,10 @@ export default class RapidModelsUpdater {
         modelType: "model",
         entities: this.#entities.filter((item) => !item.metaOnly),
       },
+      {
+        modelType: "page",
+        entities: this.#pages,
+      },
     ]);
   }
 }

package/src/rapid-models-updater/types.ts

@@ -1,4 +1,4 @@
-import type { RapidDataDictionary, RapidDataDictionaryEntry, RapidEntity, RapidField } from "@ruiapp/rapid-extension";
+import type { RapidDataDictionary, RapidDataDictionaryEntry, RapidEntity, RapidField, RapidPage } from "@ruiapp/rapid-extension";
 
 export type IRapidModelUpdater<TEntity, TInput, TMainEntity = any> =
   | IRapidModelUpdaterBatchGetMode<TEntity, TInput, TMainEntity>
@@ -62,3 +62,19 @@ export type CreateRapidPropertyInput = RapidField & {
 export type UpdateRapidPropertyInput = CreateRapidPropertyInput;
 
 export type RapidProperty = ObjWithIdProp & RapidField;
+
+export type CreateRapidPageInput = RapidPage;
+export type UpdateRapidPageInput = CreateRapidPageInput;
+
+export type RapidPageEntity = {
+  id?: string;
+  subSystem?: string;
+  appCode?: string;
+  code: string;
+  parentCode?: string;
+  routePath?: string;
+  name: string;
+  title?: string;
+  config?: Record<any, any>;
+  permissionCheck?: Record<any, any>;
+};