ap-ssg/lib/configs/userConfig.js

A fast, modular, SEO-optimized static site generator that minifies CSS, JS, and HTML for improved performance. It also supports JSON-LD, sitemap generation, and more, making it ideal for production-ready websites.

const Joi = require("joi");
const { organizationSchema } = require("./configObjects");

const configSchema = Joi.object({
  outDir: Joi.string()
    .default("build")
    .custom((value, helpers) => {
      if (
        value === "src" ||
        value.startsWith("src/") ||
        value.startsWith("./src")
      ) {
        return helpers.error("any.invalid");
      }
      return value;
    }, "outDir safety check")
    .messages({
      "any.invalid": `"outDir" cannot be "src" or a subdirectory of "src"`,
    }),

  websiteLang: Joi.string().default("en-US"),

  mode: Joi.string().valid("production", "development").required(),

  postBuild: Joi.array().items(Joi.func()).default([]),

  commonCss: Joi.array()
    .items(
      Joi.string()
        .pattern(
          /^\/assets\/css\/[\w\-]+\.css(\?.*)?$|^https?:\/\/.+\.css(\?.*)?$/
        )
        .message(
          "Each item must be a .css file from '/assets/css/' or a valid http/https URL"
        )
    )
    .default([]),

  commonJs: Joi.array()
    .items(
      Joi.string()
        .pattern(
          /^\/assets\/js\/[\w\-]+\.js(\?.*)?$|^https?:\/\/.+\.js(\?.*)?$/
        )
        .message(
          "Each item must be a .js file from '/assets/js/' or a valid http/https URL"
        )
    )
    .default([]),

  websiteName: Joi.string().required(),

  websiteDescription: Joi.string().required(),

  productionURL: Joi.string().uri().required(),

  developmentURL: Joi.string().uri().required(),

  metaTitleTemplate: Joi.string().default("%title"),

  organization: organizationSchema,

  autoImgAlt: Joi.boolean().default(false),

  themeColor: Joi.string()
    .pattern(/^#([0-9A-Fa-f]{3}){1,2}$/i) // Hex format
    .default("black"),

  integrations: Joi.object({
    googleAnalytics: Joi.string().optional(),
    bingWebmasters: Joi.string().optional(),
    googleWebmasters: Joi.string().optional(),
    hotjarAnalytics: Joi.string().optional(),
    googleTagManager: Joi.string().optional(),
    facebookPixel: Joi.string().optional(),
    microsoftClarity: Joi.string().optional(),
  }).optional(),

  pwa: Joi.object({
    enabled: Joi.boolean().default(true),
    short_name: Joi.string().required(),
    description: Joi.string().default("").optional(),
    htmlFiles: Joi.array().items(Joi.string().required()).required(),
    start_url: Joi.string().required(),
    display: Joi.string()
      .valid("standalone", "fullscreen", "minimal-ui", "browser")
      .default("standalone"),
    background_color: Joi.string()
      .pattern(/^#[0-9A-Fa-f]{6}$/)
      .default("#ffffff"),
    theme_color: Joi.string()
      .pattern(/^#[0-9A-Fa-f]{6}$/)
      .default("#3d0665"),
    orientation: Joi.string()
      .valid("any", "natural", "landscape", "portrait")
      .default("portrait"),
  }).required(),
});

/**
 * Validate user apssg.config.js file
 * @param config
 * @returns {any}
 */
const getValidUserConfig = (config) => {
  const { error, value } = configSchema.validate(config);

  if (error) {
    throw new Error(error.details[0].message);
  }

  // Corrected variable names
  value.isProduction = value.mode === "production";
  value.isDevelopment = value.mode === "development";

  value.pwa.name = value.websiteName;
  value.pwa.lang = value.websiteLang;

  value.websiteUrl = value.isProduction
    ? value.productionURL
    : value.developmentURL;

  return value;
};

// Assuming the configuration file is correctly located
const apConfigData = require(`${process.cwd()}/apssg.config.js`);

const userConfig = getValidUserConfig(apConfigData);

module.exports = userConfig;