@ruiapp/rapid-configure-tools 0.5.2 → 0.6.0

package/dist/mod.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var path = require('path');
 var fs = require('fs');
 var lodash = require('lodash');
+var rapidCore = require('@ruiapp/rapid-core');
 var axios = require('axios');
 var axiosCookiejarSupport = require('axios-cookiejar-support');
 var toughCookie = require('tough-cookie');
@@ -15,59 +16,12 @@ var path__default = /*#__PURE__*/_interopDefaultLegacy(path);
 var fs__default = /*#__PURE__*/_interopDefaultLegacy(fs);
 var axios__default = /*#__PURE__*/_interopDefaultLegacy(axios);
 
-function ensureDirectoryExists(dirPath) {
-    if (!fs__default["default"].existsSync(dirPath)) {
-        const parentDirPath = path__default["default"].dirname(dirPath);
-        ensureDirectoryExists(parentDirPath);
-        fs__default["default"].mkdirSync(dirPath);
-    }
-}
-function enumFileBaseNamesInDirectory(options) {
-    const { dirPath, prefix, fileNameFilter } = options;
-    let fileNames = [];
-    let resolvedDirPath = dirPath;
-    const isRelative = dirPath.startsWith(".") || dirPath.startsWith("..");
-    if (isRelative) {
-        resolvedDirPath = path__default["default"].join(process.cwd(), dirPath);
-    }
-    if (!fs__default["default"].existsSync(resolvedDirPath)) {
-        console.warn(`Directory '${resolvedDirPath}' not found.`);
-        return [];
-    }
-    const files = fs__default["default"].readdirSync(resolvedDirPath);
-    for (const fileName of files) {
-        const filePathName = path__default["default"].join(resolvedDirPath, fileName);
-        const fileStat = fs__default["default"].statSync(filePathName);
-        if (fileStat.isDirectory()) {
-            fileNames = fileNames.concat(enumFileBaseNamesInDirectory({
-                dirPath: filePathName,
-                prefix: prefix ? `${prefix}/${fileName}` : fileName,
-                fileNameFilter,
-            }));
-        }
-        else if (fileStat.isFile()) {
-            if (fileNameFilter && !fileNameFilter(fileName)) {
-                continue;
-            }
-            const baseName = path__default["default"].parse(fileName).name;
-            if (prefix) {
-                fileNames.push(`${prefix}/${baseName}`);
-            }
-            else {
-                fileNames.push(baseName);
-            }
-        }
-    }
-    fileNames.sort();
-    return fileNames;
-}
-
 /**
  * 用于生成模型索引文件，将模型定义按照类型分别导出。
  */
 function generateEntityModelIndexFilesOfTypeDir({ modelsDir, outputDir, typeDefFilePath, categoryDirName, modelTypeName, modelsFileName, extraImports, modelWrapper, flattenModelArray, }) {
     const filesDir = path__default["default"].join(modelsDir, categoryDirName);
-    const fileNames = enumFileBaseNamesInDirectory({
+    const fileNames = rapidCore.enumFileBaseNamesInDirectory({
         dirPath: filesDir,
         fileNameFilter(fileName) {
             return !(fileName.endsWith(".test.js") || fileName.endsWith(".test.ts"));
@@ -126,7 +80,7 @@ function generateEntityModelIndexFilesOfTypeDir({ modelsDir, outputDir, typeDefF
 }
 function generateModelIndexFilesOfTypeDir({ modelsDir, outputDir, typeDefFilePath, categoryDirName, modelTypeName, modelsFileName, extraImports, modelWrapper, flattenModelArray, }) {
     const filesDir = path__default["default"].join(modelsDir, categoryDirName);
-    const fileNames = enumFileBaseNamesInDirectory({
+    const fileNames = rapidCore.enumFileBaseNamesInDirectory({
         dirPath: filesDir,
         fileNameFilter(fileName) {
             return !(fileName.endsWith(".test.js") || fileName.endsWith(".test.ts"));
@@ -182,7 +136,7 @@ function generateModelIndexFiles(declarationsDirectory) {
     const modelsDir = path__default["default"].join(declarationsDirectory, "models");
     const outputDir = path__default["default"].join(declarationsDirectory, "meta");
     const typeDefFilePath = "@ruiapp/rapid-extension";
-    ensureDirectoryExists(outputDir);
+    rapidCore.ensureDirectoryExists(outputDir);
     generateEntityModelIndexFilesOfTypeDir({
         modelsDir,
         outputDir,
@@ -610,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)}`);
@@ -954,13 +908,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)) {
@@ -990,6 +1045,7 @@ class RapidModelsUpdater {
                 newDictionaryEntryUpdater(rapidConfigApi),
                 newModelUpdater(rapidConfigApi),
                 newPropertyUpdater(rapidConfigApi),
+                newPageUpdater(rapidConfigApi),
             ],
         });
         appUpdater.updateModels([
@@ -1001,6 +1057,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.2",
+  "version": "0.6.0",
   "description": "",
   "main": "dist/mod.js",
   "keywords": [],
@@ -20,7 +20,8 @@
     "axios-cookiejar-support": "^4.0.7",
     "lodash": "^4.17.21",
     "tough-cookie": "^4.1.3",
-    "@ruiapp/rapid-extension": "^0.5.26"
+    "@ruiapp/rapid-extension": "^0.6.0",
+    "@ruiapp/rapid-core": "^0.10.0"
   },
   "dependencies": {},
   "scripts": {

package/src/meta-file-generator/generators/model-index-generator.ts

@@ -5,7 +5,7 @@
 import fs from "fs";
 import { forEach } from "lodash";
 import path from "path";
-import { ensureDirectoryExists, enumFileBaseNamesInDirectory } from "../../utils/file-utility";
+import { ensureDirectoryExists, enumFileBaseNamesInDirectory } from "@ruiapp/rapid-core";
 
 interface GenerateModelsIndexFileOption {
   /**

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/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>;
+};

package/dist/utils/file-utility.d.ts

@@ -1,7 +0,0 @@
-export declare function ensureDirectoryExists(dirPath: string): void;
-export type EnumFileBaseNamesOptions = {
-    dirPath: string;
-    prefix?: string;
-    fileNameFilter?: (fileName: string) => boolean;
-};
-export declare function enumFileBaseNamesInDirectory(options: EnumFileBaseNamesOptions): string[];

package/src/utils/file-utility.ts

@@ -1,62 +0,0 @@
-import fs from "fs";
-import path from "path";
-
-export function ensureDirectoryExists(dirPath: string) {
-  if (!fs.existsSync(dirPath)) {
-    const parentDirPath = path.dirname(dirPath);
-    ensureDirectoryExists(parentDirPath);
-
-    fs.mkdirSync(dirPath);
-  }
-}
-
-export type EnumFileBaseNamesOptions = {
-  dirPath: string;
-  prefix?: string;
-  fileNameFilter?: (fileName: string) => boolean;
-};
-
-export function enumFileBaseNamesInDirectory(options: EnumFileBaseNamesOptions): string[] {
-  const { dirPath, prefix, fileNameFilter } = options;
-  let fileNames = [];
-
-  let resolvedDirPath = dirPath;
-  const isRelative = dirPath.startsWith(".") || dirPath.startsWith("..");
-  if (isRelative) {
-    resolvedDirPath = path.join(process.cwd(), dirPath);
-  }
-
-  if (!fs.existsSync(resolvedDirPath)) {
-    console.warn(`Directory '${resolvedDirPath}' not found.`);
-    return [];
-  }
-
-  const files = fs.readdirSync(resolvedDirPath);
-  for (const fileName of files) {
-    const filePathName = path.join(resolvedDirPath, fileName);
-    const fileStat = fs.statSync(filePathName);
-    if (fileStat.isDirectory()) {
-      fileNames = fileNames.concat(
-        enumFileBaseNamesInDirectory({
-          dirPath: filePathName,
-          prefix: prefix ? `${prefix}/${fileName}` : fileName,
-          fileNameFilter,
-        }),
-      );
-    } else if (fileStat.isFile()) {
-      if (fileNameFilter && !fileNameFilter(fileName)) {
-        continue;
-      }
-
-      const baseName = path.parse(fileName).name;
-      if (prefix) {
-        fileNames.push(`${prefix}/${baseName}`);
-      } else {
-        fileNames.push(baseName);
-      }
-    }
-  }
-
-  fileNames.sort();
-  return fileNames;
-}