oneuptime/App/FeatureSet/ApiReference/Service/Model.ts

import { CodeExamplesPath, ViewsPath } from "../Utils/Config";
import ResourceUtil, { ModelDocumentation } from "../Utils/Resources";
import PageNotFoundServiceHandler from "./PageNotFound";
import { AppApiRoute } from "Common/ServiceRoute";
import { ColumnAccessControl } from "Common/Types/BaseDatabase/AccessControl";
import { getTableColumns } from "Common/Types/Database/TableColumn";
import Dictionary from "Common/Types/Dictionary";
import ObjectID from "Common/Types/ObjectID";
import Permission, {
  PermissionHelper,
  PermissionProps,
} from "Common/Types/Permission";
import LocalCache from "CommonServer/Infrastructure/LocalCache";
import { ExpressRequest, ExpressResponse } from "CommonServer/Utils/Express";
import LocalFile from "CommonServer/Utils/LocalFile";

const Resources: Array<ModelDocumentation> = ResourceUtil.getResources();
const ResourceDictionary: Dictionary<ModelDocumentation> =
  ResourceUtil.getResourceDictionaryByPath();

const PermissionDictionary: Dictionary<PermissionProps> =
  PermissionHelper.getAllPermissionPropsAsDictionary();

export default class ServiceHandler {
  public static async executeResponse(
    req: ExpressRequest,
    res: ExpressResponse,
  ): Promise<void> {
    let pageTitle: string = "";
    let pageDescription: string = "";
    let page: string | undefined = req.params["page"];
    const pageData: any = {};

    if (!page) {
      return PageNotFoundServiceHandler.executeResponse(req, res);
    }

    const currentResource: ModelDocumentation | undefined =
      ResourceDictionary[page];

    if (!currentResource) {
      return PageNotFoundServiceHandler.executeResponse(req, res);
    }

    // Resource Page.
    pageTitle = currentResource.name;
    pageDescription = currentResource.description;

    page = "model";

    const tableColumns: any = getTableColumns(currentResource.model);

    for (const key in tableColumns) {
      const accessControl: ColumnAccessControl | null =
        currentResource.model.getColumnAccessControlFor(key);

      if (!accessControl) {
        // remove columns with no access
        delete tableColumns[key];
        continue;
      }

      if (
        accessControl?.create.length === 0 &&
        accessControl?.read.length === 0 &&
        accessControl?.update.length === 0
      ) {
        // remove columns with no access
        delete tableColumns[key];
        continue;
      }

      tableColumns[key].permissions = accessControl;
    }

    delete tableColumns["deletedAt"];
    delete tableColumns["deletedByUserId"];
    delete tableColumns["deletedByUser"];
    delete tableColumns["version"];

    pageData.title = currentResource.model.singularName;
    pageData.description = currentResource.model.tableDescription;
    pageData.columns = tableColumns;
    pageData.tablePermissions = {
      read: currentResource.model.readRecordPermissions.map(
        (permission: Permission) => {
          return PermissionDictionary[permission];
        },
      ),
      update: currentResource.model.updateRecordPermissions.map(
        (permission: Permission) => {
          return PermissionDictionary[permission];
        },
      ),
      delete: currentResource.model.deleteRecordPermissions.map(
        (permission: Permission) => {
          return PermissionDictionary[permission];
        },
      ),
      create: currentResource.model.createRecordPermissions.map(
        (permission: Permission) => {
          return PermissionDictionary[permission];
        },
      ),
    };

    pageData.listRequest = await LocalCache.getOrSetString(
      "model",
      "list-request",
      async () => {
        return await LocalFile.read(`${CodeExamplesPath}/Model/ListRequest.md`);
      },
    );

    pageData.itemRequest = await LocalCache.getOrSetString(
      "model",
      "item-request",
      async () => {
        return await LocalFile.read(`${CodeExamplesPath}/Model/ItemRequest.md`);
      },
    );

    pageData.itemResponse = await LocalCache.getOrSetString(
      "model",
      "item-response",
      async () => {
        return await LocalFile.read(
          `${CodeExamplesPath}/Model/ItemResponse.md`,
        );
      },
    );

    pageData.countRequest = await LocalCache.getOrSetString(
      "model",
      "count-request",
      async () => {
        return await LocalFile.read(
          `${CodeExamplesPath}/Model/CountRequest.md`,
        );
      },
    );

    pageData.countResponse = await LocalCache.getOrSetString(
      "model",
      "count-response",
      async () => {
        return await LocalFile.read(
          `${CodeExamplesPath}/Model/CountResponse.md`,
        );
      },
    );

    pageData.updateRequest = await LocalCache.getOrSetString(
      "model",
      "update-request",
      async () => {
        return await LocalFile.read(
          `${CodeExamplesPath}/Model/UpdateRequest.md`,
        );
      },
    );

    pageData.updateResponse = await LocalCache.getOrSetString(
      "model",
      "update-response",
      async () => {
        return await LocalFile.read(
          `${CodeExamplesPath}/Model/UpdateResponse.md`,
        );
      },
    );

    pageData.createRequest = await LocalCache.getOrSetString(
      "model",
      "create-request",
      async () => {
        return await LocalFile.read(
          `${CodeExamplesPath}/Model/CreateRequest.md`,
        );
      },
    );

    pageData.createResponse = await LocalCache.getOrSetString(
      "model",
      "create-response",
      async () => {
        return await LocalFile.read(
          `${CodeExamplesPath}/Model/CreateResponse.md`,
        );
      },
    );

    pageData.deleteRequest = await LocalCache.getOrSetString(
      "model",
      "delete-request",
      async () => {
        return await LocalFile.read(
          `${CodeExamplesPath}/Model/DeleteRequest.md`,
        );
      },
    );

    pageData.deleteResponse = await LocalCache.getOrSetString(
      "model",
      "delete-response",
      async () => {
        return await LocalFile.read(
          `${CodeExamplesPath}/Model/DeleteResponse.md`,
        );
      },
    );

    pageData.listResponse = await LocalCache.getOrSetString(
      "model",
      "list-response",
      async () => {
        return await LocalFile.read(
          `${CodeExamplesPath}/Model/ListResponse.md`,
        );
      },
    );

    pageData.exampleObjectID = ObjectID.generate();

    pageData.apiPath =
      AppApiRoute.toString() + currentResource.model.crudApiPath?.toString();

    pageData.isMasterAdminApiDocs = currentResource.model.isMasterAdminApiDocs;

    return res.render(`${ViewsPath}/pages/index`, {
      page: page,
      resources: Resources,
      pageTitle: pageTitle,
      pageDescription: pageDescription,
      pageData: pageData,
    });
  }
}