Index.js #

Here is documentation about the main js file on server - index.js. And here you can find a list of all functions from this file:

1. Import variables
2. /generate-pages
3. Caching.
4. Image sources preparing.
5. Sitemap generation.
6. Redirects.
7. Regeneration.

Import variables #

Firstly get data from config.js

/generate-pages #

It's a post request. Using for multi-regeneration of pages.

This route call regenerate method from WebsitesManager class with arguments:

/version #

It's a get request. Using for getting version of server.

/sitemap.xml #

It's a get request. Using for creating sitemaps.

If config.mjs exist in folder with your site call generateIndexSitemap method from SitemapGenerator, else call generateSimpleSitemap method from SitemapGenerator. In both cases this request call mathods with arguments: req and res , but if config.mjs exist in folder with your site it's mean that config.mjs contains object with name chapters and every chapter it's a name for your sitemaps.

/:type-sitemap.xml #

It's a get request. Using for creating certain type of sitemap.

This request calling from method generateIndexSitemap in class SitemapGenerator, where :type it's a variable or name of certain sitemap, this name is name of appropriate chapter.

/feed/google-news/:type #

It's a get request. Using for generation and sending news to Google News. This request server recieve from Google

* #

It's a get request. Using for routing all pages, images, assets etc.

This a largest part of index.js, includes:

1. Seting data from config.mjs
2. Redirects
3. Prepare for generation
4. Finding template or asset
5. Generate

Seting data from config.mjs #

First at all we need to write root path to project's folder. Then using this path chacking if config.mjs is exist.

If config.mjs exist - get from config next data:

Examples #

Chapters

export const chapters = {
    pages: {
        app_id: 33333,
        slug_field_id: 777777,
        sitemap: {
            frequency: 'weekly',
            priority: 0.8,
            sitemapName: 'pages',
            cases: [
                {
                    case: '/',
                    priority: 1,
                    frequency: 'weekly'
                },
                {
                    case: '/blog/',
                    priority: 0.9,
                    frequency: 'daily'
                },
            ],
            filter: (items) => {
                return items.filter(item => {
                    const field = item.fields.find(field => field.field_id == 777777);
                    if(field) {
                        return field.field_value == 1;
                    }
                    return false;
                });
            }
        }
    },
    blog: {
        app_id: 34444,
        slug_field_id: 799999,
        sitemap: {
            frequency: 'weekly',
            priority: 0.6,
            cases: [
                {
                    case: /^\/blog\/authors\/[^\/]*\/$/,
                    sitemapName: 'authors',
                    frequency: 'weekly',
                    priority: 0.6
                },
            ],
            filter: (items) => {
                return items.filter(item => {
                    const field = item.fields.find(field => field.field_id == 799999);
                    if(field) {
                        return field.field_value == 1;
                    }
                    return false;
                });
            }
        }
    }
}

Routes

export const routes = [
    {
        route: '/blog/',
        index: '/blog/blog.html'
    },
    {
        route: '/blog/page/:page/',
        index: '/blog/blog.html'
    },
    {
        route: '/blog/authors/:author/page/:page/',
        index: '/blog/author.html'
    }
]

Redirects

export const redirects = [
    {
         from: '/service/it_consulting',
        to: '/services/it-consulting-services/'
    },
    {
        from: '/news/page/',
        to: '/news/'
    },
    {
        from: '/our_team/team',
        to: '/about-us/'
    }
]

Redirects #

In this part we call checkRedirects method from redirectsHandler class with original url like a argument. There is compare original with array of objects. If find original url in this array - redirect.

After redirect step check if url has a last symbol - '/', if it's false - add '/' to the end of url.

Prepare for generation #

In this step need to set values of variables from searchParams of original url.

Finding template or asset #

In this step check if url to page and hasn't paramin searchParams mode=ssr - get page from cache and response it if page exist.

If page don't exist or it is not a page trying to find template by this url using findSlugTemplate method from routeHandler class with arguments: routes (from config), url (requested url) and buildFolder (from config). This method return object with properties:

Example if not found

{ 
    found: false,
    paramsObject: {}, 
    queryParams: '?' 
}

Example if found

{
  route: '/blog/authors/:author/',
  index: '/blog/author.html',
  found: true,
  paramsObject: {
    routeObject: '{"route":"/blog/authors/:author/","index":"/blog/author.html"}',
    author: 'author-name',
    path: '/blog/authors/author-name/'
  },
  queryParams: '?routeObject={"route":"/blog/authors/:author/","index":"/blog/author.html"}&author=author-name&path=/blog/authors/author-name/'
}

If this method return found: false (can return false if page don't exist or finded url it's path to asset) call findStaticFile method from routeHandler class, which check if this is path to static file (image, js/css file) and if it is return object with two properties: type and path, else trying to return on client cached page or if this page doesn't exist in cache - return 404 Page.

If findStaticFile return object with properties check type value:

• If type === assets - check is it image. If image - remove header from response to fix bug with CORS and return file, else - just return file

• If type === html - update data in object which was returned from findSlugTemplate method before, by seting data in empty properties

• If type === error - return 404

Generate #

If url contain mode=ssr in searchParams started this part of code. Call generate method from SSR class with arguments (root, website, route, chapters, auth_key, buildFolder, disableImagesRegeneration, preview, disableBundling)