@ruiapp/rapid-core 0.1.82 → 0.1.83

package/src/plugins/dataManage/actionHandlers/createCollectionEntity.ts

@@ -1,24 +1,24 @@
-import { RunEntityActionHandlerOptions } from "~/types";
-import { mergeInput } from "~/helpers/inputHelper";
-import { ActionHandlerContext } from "~/core/actionHandler";
-import { RapidPlugin } from "~/core/server";
-
-export const code = "createCollectionEntity";
-
-export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: RunEntityActionHandlerOptions) {
-  const { logger, server, input } = ctx;
-
-  const { defaultInput, fixedInput } = options;
-  const mergedInput = mergeInput(defaultInput, input, fixedInput);
-  logger.debug(`Running ${code} handler...`, { defaultInput, fixedInput, mergedInput });
-
-  const entityManager = server.getEntityManager(options.singularCode);
-  const output = await entityManager.createEntity(
-    {
-      entity: input,
-      routeContext: ctx.routerContext,
-    },
-    plugin,
-  );
-  ctx.output = output;
-}
+import { RunEntityActionHandlerOptions } from "~/types";
+import { mergeInput } from "~/helpers/inputHelper";
+import { ActionHandlerContext } from "~/core/actionHandler";
+import { RapidPlugin } from "~/core/server";
+
+export const code = "createCollectionEntity";
+
+export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: RunEntityActionHandlerOptions) {
+  const { logger, server, input } = ctx;
+
+  const { defaultInput, fixedInput } = options;
+  const mergedInput = mergeInput(defaultInput, input, fixedInput);
+  logger.debug(`Running ${code} handler...`, { defaultInput, fixedInput, mergedInput });
+
+  const entityManager = server.getEntityManager(options.singularCode);
+  const output = await entityManager.createEntity(
+    {
+      entity: input,
+      routeContext: ctx.routerContext,
+    },
+    plugin,
+  );
+  ctx.output = output;
+}

package/src/plugins/dataManage/actionHandlers/findCollectionEntities.ts

@@ -1,26 +1,26 @@
-import { FindEntityOptions, RunEntityActionHandlerOptions } from "~/types";
-import runCollectionEntityActionHandler from "~/helpers/runCollectionEntityActionHandler";
-import { removeFiltersWithNullValue } from "~/helpers/filterHelper";
-import { ActionHandlerContext } from "~/core/actionHandler";
-import { RapidPlugin } from "~/core/server";
-
-export const code = "findCollectionEntities";
-
-export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: RunEntityActionHandlerOptions) {
-  await runCollectionEntityActionHandler(ctx, options, code, async (entityManager, input: FindEntityOptions) => {
-    input.filters = removeFiltersWithNullValue(input.filters);
-    input.routeContext = ctx.routerContext;
-    const entities = await entityManager.findEntities(input);
-    const result: {
-      list: any;
-      total?: any;
-    } = { list: entities };
-
-    if (input.pagination && !input.pagination.withoutTotal) {
-      // TOOD: count entities when calling findEntities for performance.
-      const countResult = await entityManager.count(input);
-      result.total = countResult.count;
-    }
-    return result;
-  });
-}
+import { FindEntityOptions, RunEntityActionHandlerOptions } from "~/types";
+import runCollectionEntityActionHandler from "~/helpers/runCollectionEntityActionHandler";
+import { removeFiltersWithNullValue } from "~/helpers/filterHelper";
+import { ActionHandlerContext } from "~/core/actionHandler";
+import { RapidPlugin } from "~/core/server";
+
+export const code = "findCollectionEntities";
+
+export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: RunEntityActionHandlerOptions) {
+  await runCollectionEntityActionHandler(ctx, options, code, async (entityManager, input: FindEntityOptions) => {
+    input.filters = removeFiltersWithNullValue(input.filters);
+    input.routeContext = ctx.routerContext;
+    const entities = await entityManager.findEntities(input);
+    const result: {
+      list: any;
+      total?: any;
+    } = { list: entities };
+
+    if (input.pagination && !input.pagination.withoutTotal) {
+      // TOOD: count entities when calling findEntities for performance.
+      const countResult = await entityManager.count(input);
+      result.total = countResult.count;
+    }
+    return result;
+  });
+}

package/src/plugins/dataManage/actionHandlers/findCollectionEntityById.ts

@@ -1,21 +1,21 @@
-import { RunEntityActionHandlerOptions } from "~/types";
-import { ActionHandlerContext } from "~/core/actionHandler";
-import { RapidPlugin } from "~/core/server";
-
-export const code = "findCollectionEntityById";
-
-export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: RunEntityActionHandlerOptions) {
-  const { logger, server, input } = ctx;
-  logger.debug(`Running ${code} handler...`, { input });
-  const { id } = input;
-
-  const entityManager = server.getEntityManager(options.singularCode);
-  const entity = await entityManager.findById({
-    id,
-    routeContext: ctx.routerContext,
-  });
-  if (!entity) {
-    throw new Error(`${options.namespace}.${options.singularCode} with id "${id}" was not found.`);
-  }
-  ctx.output = entity;
-}
+import { RunEntityActionHandlerOptions } from "~/types";
+import { ActionHandlerContext } from "~/core/actionHandler";
+import { RapidPlugin } from "~/core/server";
+
+export const code = "findCollectionEntityById";
+
+export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: RunEntityActionHandlerOptions) {
+  const { logger, server, input } = ctx;
+  logger.debug(`Running ${code} handler...`, { input });
+  const { id } = input;
+
+  const entityManager = server.getEntityManager(options.singularCode);
+  const entity = await entityManager.findById({
+    id,
+    routeContext: ctx.routerContext,
+  });
+  if (!entity) {
+    throw new Error(`${options.namespace}.${options.singularCode} with id "${id}" was not found.`);
+  }
+  ctx.output = entity;
+}

package/src/plugins/dataManage/actionHandlers/queryDatabase.ts

@@ -1,22 +1,22 @@
-import { RunQueryDatabaseHandlerOptions } from "~/types";
-import { mergeInput } from "~/helpers/inputHelper";
-import { ActionHandlerContext } from "~/core/actionHandler";
-import { RapidPlugin } from "~/core/server";
-import { first } from "lodash";
-
-export const code = "queryDatabase";
-
-export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: RunQueryDatabaseHandlerOptions) {
-  const { logger, server, input } = ctx;
-
-  const { sql, querySingle, defaultInput, fixedInput } = options;
-  const mergedInput = mergeInput(defaultInput, input, fixedInput);
-  logger.debug(`Running ${code} handler...`, { defaultInput, fixedInput, mergedInput });
-
-  const result = await server.queryDatabaseObject(sql, mergedInput);
-  if (querySingle) {
-    ctx.output = first(result);
-  } else {
-    ctx.output = result;
-  }
-}
+import { RunQueryDatabaseHandlerOptions } from "~/types";
+import { mergeInput } from "~/helpers/inputHelper";
+import { ActionHandlerContext } from "~/core/actionHandler";
+import { RapidPlugin } from "~/core/server";
+import { first } from "lodash";
+
+export const code = "queryDatabase";
+
+export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: RunQueryDatabaseHandlerOptions) {
+  const { logger, server, input } = ctx;
+
+  const { sql, querySingle, defaultInput, fixedInput } = options;
+  const mergedInput = mergeInput(defaultInput, input, fixedInput);
+  logger.debug(`Running ${code} handler...`, { defaultInput, fixedInput, mergedInput });
+
+  const result = await server.queryDatabaseObject(sql, mergedInput);
+  if (querySingle) {
+    ctx.output = first(result);
+  } else {
+    ctx.output = result;
+  }
+}

package/src/plugins/dataManage/actionHandlers/removeEntityRelations.ts

@@ -1,20 +1,20 @@
-import { RemoveEntityRelationsOptions, RunEntityActionHandlerOptions } from "~/types";
-import { mergeInput } from "~/helpers/inputHelper";
-import { ActionHandlerContext } from "~/core/actionHandler";
-import { RapidPlugin } from "~/core/server";
-
-export const code = "removeEntityRelations";
-
-export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: RunEntityActionHandlerOptions) {
-  const { logger, server, input } = ctx;
-  const { defaultInput, fixedInput } = options;
-
-  const mergedInput: RemoveEntityRelationsOptions = mergeInput(defaultInput, input, fixedInput);
-  logger.debug(`Running ${code} handler...`, { defaultInput, fixedInput, mergedInput });
-  mergedInput.routeContext = ctx.routerContext;
-
-  const entityManager = server.getEntityManager(options.singularCode);
-  await entityManager.removeRelations(mergedInput, plugin);
-
-  ctx.output = {};
-}
+import { RemoveEntityRelationsOptions, RunEntityActionHandlerOptions } from "~/types";
+import { mergeInput } from "~/helpers/inputHelper";
+import { ActionHandlerContext } from "~/core/actionHandler";
+import { RapidPlugin } from "~/core/server";
+
+export const code = "removeEntityRelations";
+
+export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: RunEntityActionHandlerOptions) {
+  const { logger, server, input } = ctx;
+  const { defaultInput, fixedInput } = options;
+
+  const mergedInput: RemoveEntityRelationsOptions = mergeInput(defaultInput, input, fixedInput);
+  logger.debug(`Running ${code} handler...`, { defaultInput, fixedInput, mergedInput });
+  mergedInput.routeContext = ctx.routerContext;
+
+  const entityManager = server.getEntityManager(options.singularCode);
+  await entityManager.removeRelations(mergedInput, plugin);
+
+  ctx.output = {};
+}

package/src/plugins/dataManage/actionHandlers/updateCollectionEntityById.ts

@@ -1,35 +1,35 @@
-import { RunEntityActionHandlerOptions, UpdateEntityByIdOptions } from "~/types";
-import { mergeInput } from "~/helpers/inputHelper";
-import { ActionHandlerContext } from "~/core/actionHandler";
-import { RapidPlugin } from "~/core/server";
-
-export const code = "updateCollectionEntityById";
-
-export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: RunEntityActionHandlerOptions) {
-  const { logger, server, input } = ctx;
-
-  const { defaultInput, fixedInput } = options;
-  const mergedInput = mergeInput(defaultInput, input, fixedInput);
-  logger.debug(`Running ${code} handler...`, { defaultInput, fixedInput, mergedInput });
-
-  const operation = mergedInput.$operation;
-  if (operation) {
-    delete mergedInput.$operation;
-  }
-
-  const stateProperties = mergedInput.$stateProperties;
-  if (stateProperties) {
-    delete mergedInput.$stateProperties;
-  }
-
-  const updateEntityByIdOptions: UpdateEntityByIdOptions = {
-    id: mergedInput.id,
-    entityToSave: mergedInput,
-    operation,
-    stateProperties,
-    routeContext: ctx.routerContext,
-  };
-  const entityManager = server.getEntityManager(options.singularCode);
-  const output = await entityManager.updateEntityById(updateEntityByIdOptions, plugin);
-  ctx.output = output;
-}
+import { RunEntityActionHandlerOptions, UpdateEntityByIdOptions } from "~/types";
+import { mergeInput } from "~/helpers/inputHelper";
+import { ActionHandlerContext } from "~/core/actionHandler";
+import { RapidPlugin } from "~/core/server";
+
+export const code = "updateCollectionEntityById";
+
+export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: RunEntityActionHandlerOptions) {
+  const { logger, server, input } = ctx;
+
+  const { defaultInput, fixedInput } = options;
+  const mergedInput = mergeInput(defaultInput, input, fixedInput);
+  logger.debug(`Running ${code} handler...`, { defaultInput, fixedInput, mergedInput });
+
+  const operation = mergedInput.$operation;
+  if (operation) {
+    delete mergedInput.$operation;
+  }
+
+  const stateProperties = mergedInput.$stateProperties;
+  if (stateProperties) {
+    delete mergedInput.$stateProperties;
+  }
+
+  const updateEntityByIdOptions: UpdateEntityByIdOptions = {
+    id: mergedInput.id,
+    entityToSave: mergedInput,
+    operation,
+    stateProperties,
+    routeContext: ctx.routerContext,
+  };
+  const entityManager = server.getEntityManager(options.singularCode);
+  const output = await entityManager.updateEntityById(updateEntityByIdOptions, plugin);
+  ctx.output = output;
+}

package/src/plugins/fileManage/actionHandlers/downloadDocument.ts

@@ -1,36 +1,36 @@
-import path from "path";
-import { ActionHandlerContext } from "~/core/actionHandler";
-import { RapidPlugin } from "~/core/server";
-import { readFile } from "~/utilities/fsUtility";
-
-export const code = "downloadDocument";
-
-export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: any) {
-  const { server, applicationConfig, routerContext, input } = ctx;
-  const { request, response } = routerContext;
-
-  const documentDataAccessor = ctx.server.getDataAccessor({
-    singularCode: "ecm_document",
-  });
-  const storageDataAccessor = ctx.server.getDataAccessor({
-    singularCode: "ecm_storage_object",
-  });
-
-  const document = await documentDataAccessor.findById(input.documentId);
-  if (!document) {
-    ctx.output = { error: new Error("Document not found.") };
-    return;
-  }
-  const storageObject = await storageDataAccessor.findById(document.storage_object_id);
-  if (!storageObject) {
-    ctx.output = { error: new Error("Storage object not found.") };
-    return;
-  }
-
-  const fileKey = storageObject.key;
-  const filePathName = path.join(server.config.localFileStoragePath, fileKey);
-  const attachmentFileName = document.name;
-
-  response.body = await readFile(filePathName);
-  response.headers.set("Content-Disposition", `attachment; filename="${encodeURIComponent(attachmentFileName)}"`);
-}
+import path from "path";
+import { ActionHandlerContext } from "~/core/actionHandler";
+import { RapidPlugin } from "~/core/server";
+import { readFile } from "~/utilities/fsUtility";
+
+export const code = "downloadDocument";
+
+export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: any) {
+  const { server, applicationConfig, routerContext, input } = ctx;
+  const { request, response } = routerContext;
+
+  const documentDataAccessor = ctx.server.getDataAccessor({
+    singularCode: "ecm_document",
+  });
+  const storageDataAccessor = ctx.server.getDataAccessor({
+    singularCode: "ecm_storage_object",
+  });
+
+  const document = await documentDataAccessor.findById(input.documentId);
+  if (!document) {
+    ctx.output = { error: new Error("Document not found.") };
+    return;
+  }
+  const storageObject = await storageDataAccessor.findById(document.storage_object_id);
+  if (!storageObject) {
+    ctx.output = { error: new Error("Storage object not found.") };
+    return;
+  }
+
+  const fileKey = storageObject.key;
+  const filePathName = path.join(server.config.localFileStoragePath, fileKey);
+  const attachmentFileName = document.name;
+
+  response.body = await readFile(filePathName);
+  response.headers.set("Content-Disposition", `attachment; filename="${encodeURIComponent(attachmentFileName)}"`);
+}

package/src/plugins/fileManage/actionHandlers/uploadFile.ts

@@ -1,33 +1,33 @@
-import { v1 as uuidv1 } from "uuid";
-import { appendFile } from "~/utilities/fsUtility";
-import { ActionHandlerContext } from "~/core/actionHandler";
-import path from "path";
-import { isArray } from "lodash";
-import { RapidPlugin } from "~/core/server";
-
-export const code = "uploadFile";
-
-export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: any) {
-  const { server, applicationConfig, routerContext, input } = ctx;
-  const { request, response } = routerContext;
-
-  let file: File | File[] | null = input.file || input.files;
-  if (isArray(file)) {
-    file = file[0];
-  }
-
-  if (!file) {
-    ctx.status = 400;
-    ctx.output = { error: "File not found in request body." };
-    return;
-  }
-
-  const extName = path.extname(file.name);
-  const fileKey = `${uuidv1()}${extName}`;
-  const filePathName = path.join(server.config.localFileStoragePath, fileKey);
-
-  const fileBuffer = await file.arrayBuffer();
-  await appendFile(filePathName, fileBuffer);
-
-  ctx.output = { ok: true, fileKey };
-}
+import { v1 as uuidv1 } from "uuid";
+import { appendFile } from "~/utilities/fsUtility";
+import { ActionHandlerContext } from "~/core/actionHandler";
+import path from "path";
+import { isArray } from "lodash";
+import { RapidPlugin } from "~/core/server";
+
+export const code = "uploadFile";
+
+export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: any) {
+  const { server, applicationConfig, routerContext, input } = ctx;
+  const { request, response } = routerContext;
+
+  let file: File | File[] | null = input.file || input.files;
+  if (isArray(file)) {
+    file = file[0];
+  }
+
+  if (!file) {
+    ctx.status = 400;
+    ctx.output = { error: "File not found in request body." };
+    return;
+  }
+
+  const extName = path.extname(file.name);
+  const fileKey = `${uuidv1()}${extName}`;
+  const filePathName = path.join(server.config.localFileStoragePath, fileKey);
+
+  const fileBuffer = await file.arrayBuffer();
+  await appendFile(filePathName, fileBuffer);
+
+  ctx.output = { ok: true, fileKey };
+}

package/src/plugins/fileManage/routes/downloadDocument.ts

@@ -1,15 +1,15 @@
-import { RpdRoute } from "~/types";
-
-export default {
-  namespace: "ecm",
-  name: "ecm.downloadDocument",
-  code: "ecm.downloadDocument",
-  type: "RESTful",
-  method: "GET",
-  endpoint: "/download/document",
-  actions: [
-    {
-      code: "downloadDocument",
-    },
-  ],
-} satisfies RpdRoute;
+import { RpdRoute } from "~/types";
+
+export default {
+  namespace: "ecm",
+  name: "ecm.downloadDocument",
+  code: "ecm.downloadDocument",
+  type: "RESTful",
+  method: "GET",
+  endpoint: "/download/document",
+  actions: [
+    {
+      code: "downloadDocument",
+    },
+  ],
+} satisfies RpdRoute;

package/src/plugins/fileManage/routes/downloadFile.ts

@@ -1,15 +1,15 @@
-import { RpdRoute } from "~/types";
-
-export default {
-  namespace: "ecm",
-  name: "ecm.downloadFile",
-  code: "ecm.downloadFile",
-  type: "RESTful",
-  method: "GET",
-  endpoint: "/download/file",
-  actions: [
-    {
-      code: "downloadFile",
-    },
-  ],
-} satisfies RpdRoute;
+import { RpdRoute } from "~/types";
+
+export default {
+  namespace: "ecm",
+  name: "ecm.downloadFile",
+  code: "ecm.downloadFile",
+  type: "RESTful",
+  method: "GET",
+  endpoint: "/download/file",
+  actions: [
+    {
+      code: "downloadFile",
+    },
+  ],
+} satisfies RpdRoute;

package/src/plugins/fileManage/routes/index.ts

@@ -1,5 +1,5 @@
-import getMyProfile from "./uploadFile";
-import signin from "./downloadFile";
-import signout from "./downloadDocument";
-
-export default [getMyProfile, signin, signout];
+import getMyProfile from "./uploadFile";
+import signin from "./downloadFile";
+import signout from "./downloadDocument";
+
+export default [getMyProfile, signin, signout];

package/src/plugins/fileManage/routes/uploadFile.ts

@@ -1,15 +1,15 @@
-import { RpdRoute } from "~/types";
-
-export default {
-  namespace: "ecm",
-  name: "ecm.uploadFile",
-  code: "ecm.uploadFile",
-  type: "RESTful",
-  method: "POST",
-  endpoint: "/upload",
-  actions: [
-    {
-      code: "uploadFile",
-    },
-  ],
-} satisfies RpdRoute;
+import { RpdRoute } from "~/types";
+
+export default {
+  namespace: "ecm",
+  name: "ecm.uploadFile",
+  code: "ecm.uploadFile",
+  type: "RESTful",
+  method: "POST",
+  endpoint: "/upload",
+  actions: [
+    {
+      code: "uploadFile",
+    },
+  ],
+} satisfies RpdRoute;

package/src/plugins/metaManage/actionHandlers/getMetaModelDetail.ts

@@ -1,10 +1,10 @@
-import { ActionHandlerContext } from "~/core/actionHandler";
-import { RapidPlugin } from "~/core/server";
-
-export const code = "getMetaModelDetail";
-
-export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: any) {
-  const { server, input } = ctx;
-  const model = server.getModel(input);
-  ctx.output = model;
-}
+import { ActionHandlerContext } from "~/core/actionHandler";
+import { RapidPlugin } from "~/core/server";
+
+export const code = "getMetaModelDetail";
+
+export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: any) {
+  const { server, input } = ctx;
+  const model = server.getModel(input);
+  ctx.output = model;
+}

package/src/plugins/metaManage/actionHandlers/listMetaModels.ts

@@ -1,9 +1,9 @@
-import { ActionHandlerContext } from "~/core/actionHandler";
-import { RapidPlugin } from "~/core/server";
-
-export const code = "listMetaModels";
-
-export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: any) {
-  const { applicationConfig } = ctx;
-  ctx.output = { list: applicationConfig.models };
-}
+import { ActionHandlerContext } from "~/core/actionHandler";
+import { RapidPlugin } from "~/core/server";
+
+export const code = "listMetaModels";
+
+export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: any) {
+  const { applicationConfig } = ctx;
+  ctx.output = { list: applicationConfig.models };
+}

package/src/plugins/metaManage/actionHandlers/listMetaRoutes.ts

@@ -1,9 +1,9 @@
-import { ActionHandlerContext } from "~/core/actionHandler";
-import { RapidPlugin } from "~/core/server";
-
-export const code = "listMetaRoutes";
-
-export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: any) {
-  const { applicationConfig } = ctx;
-  ctx.output = { list: applicationConfig.routes };
-}
+import { ActionHandlerContext } from "~/core/actionHandler";
+import { RapidPlugin } from "~/core/server";
+
+export const code = "listMetaRoutes";
+
+export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: any) {
+  const { applicationConfig } = ctx;
+  ctx.output = { list: applicationConfig.routes };
+}

package/src/plugins/routeManage/actionHandlers/httpProxy.ts

@@ -1,13 +1,13 @@
-import { RunProxyHandlerOptions } from "~/types";
-import { doProxy } from "~/proxy/mod";
-import { ActionHandlerContext } from "~/core/actionHandler";
-import { RapidPlugin } from "~/core/server";
-
-export const code = "httpProxy";
-
-export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: RunProxyHandlerOptions) {
-  const { logger } = ctx;
-  logger.debug(`Running ${code} handler...`);
-
-  await doProxy(ctx.routerContext, options);
-}
+import { RunProxyHandlerOptions } from "~/types";
+import { doProxy } from "~/proxy/mod";
+import { ActionHandlerContext } from "~/core/actionHandler";
+import { RapidPlugin } from "~/core/server";
+
+export const code = "httpProxy";
+
+export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: RunProxyHandlerOptions) {
+  const { logger } = ctx;
+  logger.debug(`Running ${code} handler...`);
+
+  await doProxy(ctx.routerContext, options);
+}