@cntrl-site/sdk 0.7.2 → 1.1.0

package/cntrl.scss

@@ -0,0 +1,66 @@
+// CAUTION: THIS FILE IS AUTO-GENERATED BASED ON
+// LAYOUT CONFIGURATION IN YOUR CNTRL PROJECT
+// WE HIGHLY ADVICE YOU TO NOT CHANGE IT MANUALLY
+@use "sass:map";
+
+$__CNTRL_LAYOUT_WIDTH__: 100;
+
+$layout: (
+
+    mobile: (
+        start: 0,
+        end: 749,
+        exemplary: 375,
+        isFirst: true,
+        isLast: false
+    ),
+
+    tablet: (
+        start: 750,
+        end: 1023,
+        exemplary: 768,
+        isFirst: false,
+        isLast: false
+    ),
+
+    desktop: (
+        start: 1024,
+        end: 9007199254740991,
+        exemplary: 1440,
+        isFirst: false,
+        isLast: true
+    ),
+
+);
+
+@function size($value) {
+    @return #{$value/$__CNTRL_LAYOUT_WIDTH__*100}vw;
+}
+
+@mixin for($name) {
+    $start: map.get(map.get($layout, $name), "start");
+    $end: map.get(map.get($layout, $name), "end");
+    $isFirst: map.get(map.get($layout, $name), "isFirst");
+    $isLast: map.get(map.get($layout, $name), "isLast");
+    $exemplary: map.get(map.get($layout, $name), "exemplary");
+    $__CNTRL_LAYOUT_WIDTH__: $exemplary !global;
+
+    @if $isFirst == true and $isLast == true {
+        @content;
+    } @else if $isFirst == true {
+        @media (max-width: #{$end}px) {
+            @content;
+        }
+    } @else if $isLast == true {
+        @media (min-width: #{$start}px) {
+            @content;
+        }
+    } @else {
+        @media (min-width: #{$start}px) and (max-width: #{$end}px) {
+            @content;
+        }
+    }
+
+    // reset global variable back to it's initial state
+    $__CNTRL_LAYOUT_WIDTH__: 100 !global;
+}

package/lib/Client/Client.js

@@ -8,38 +8,60 @@ const core_1 = require("@cntrl-site/core");
 const isomorphic_fetch_1 = __importDefault(require("isomorphic-fetch"));
 const url_1 = require("url");
 class Client {
-    constructor(projectId, APIUrl, fetchImpl = isomorphic_fetch_1.default) {
-        this.projectId = projectId;
-        this.APIUrl = APIUrl;
+    constructor(APIUrl, fetchImpl = isomorphic_fetch_1.default) {
         this.fetchImpl = fetchImpl;
-        if (projectId.length === 0) {
-            throw new Error('CNTRL SDK: Project ID is empty. Did you forget to pass it?');
+        this.url = new url_1.URL(APIUrl);
+        if (!this.url.username) {
+            throw new Error('Project ID is missing in the URL.');
         }
-        if (APIUrl.length === 0) {
-            throw new Error('CNTRL SDK: API URL is empty. Did you forget to pass it?');
+        if (!this.url.password) {
+            throw new Error('API key is missing in the URL.');
         }
     }
-    async getProject() {
+    static getPageMeta(projectMeta, pageMeta) {
+        return pageMeta.enabled ? {
+            title: pageMeta.title ? pageMeta.title : projectMeta.title,
+            description: pageMeta.description ? pageMeta.description : projectMeta.description,
+            keywords: pageMeta.keywords ? pageMeta.keywords : projectMeta.keywords,
+            opengraphThumbnail: pageMeta.opengraphThumbnail ? pageMeta.opengraphThumbnail : projectMeta.opengraphThumbnail,
+            favicon: projectMeta.favicon
+        } : projectMeta;
+    }
+    async getPageData(pageSlug) {
         try {
-            const response = await this.fetchProject();
-            const data = await response.json();
-            const project = core_1.ProjectSchema.parse(data);
-            return project;
+            const project = await this.fetchProject();
+            const articleId = this.findArticleIdByPageSlug(pageSlug, project.pages);
+            const [{ article, keyframes }, typePresets] = await Promise.all([
+                this.fetchArticle(articleId),
+                this.fetchTypePresets()
+            ]);
+            const page = project.pages.find(page => page.slug === pageSlug);
+            const meta = Client.getPageMeta(project.meta, page?.meta);
+            return {
+                project,
+                typePresets,
+                article,
+                keyframes,
+                meta
+            };
         }
         catch (e) {
             throw e;
         }
     }
-    async getPageArticle(pageSlug) {
+    async getProjectPagesPaths() {
         try {
-            const projectResponse = await this.fetchProject();
-            const data = await projectResponse.json();
-            const project = core_1.ProjectSchema.parse(data);
-            const articleId = this.findArticleIdByPageSlug(pageSlug, project.pages);
-            const articleResponse = await this.fetchArticle(articleId);
-            const articleData = await articleResponse.json();
-            const article = core_1.ArticleSchema.parse(articleData);
-            return article;
+            const { pages } = await this.fetchProject();
+            return pages.map(p => p.slug);
+        }
+        catch (e) {
+            throw e;
+        }
+    }
+    async getLayouts() {
+        try {
+            const { layouts } = await this.fetchProject();
+            return layouts;
         }
         catch (e) {
             throw e;
@@ -47,61 +69,59 @@ class Client {
     }
     async getTypePresets() {
         const response = await this.fetchTypePresets();
-        const data = await response.json();
-        const typePresets = core_1.TypePresetsSchema.parse(data);
-        return typePresets;
-    }
-    async getKeyframes(articleId) {
-        const response = await this.fetchKeyframes(articleId);
-        const data = await response.json();
-        const keyframes = core_1.KeyframesSchema.parse(data);
-        return keyframes;
-    }
-    static getPageMeta(projectMeta, pageMeta) {
-        return pageMeta.enabled ? {
-            title: pageMeta.title ? pageMeta.title : projectMeta.title,
-            description: pageMeta.description ? pageMeta.description : projectMeta.description,
-            keywords: pageMeta.keywords ? pageMeta.keywords : projectMeta.keywords,
-            opengraphThumbnail: pageMeta.opengraphThumbnail ? pageMeta.opengraphThumbnail : projectMeta.opengraphThumbnail,
-            favicon: projectMeta.favicon
-        } : projectMeta;
+        return response;
     }
     async fetchProject() {
-        const url = new url_1.URL(`/projects/${this.projectId}`, this.APIUrl);
-        const response = await this.fetchImpl(url.href);
+        const { username: projectId, password: apiKey, origin } = this.url;
+        const url = new url_1.URL(`/projects/${projectId}`, origin);
+        const response = await this.fetchImpl(url.href, {
+            headers: {
+                Authorization: `Bearer ${apiKey}`
+            }
+        });
         if (!response.ok) {
-            throw new Error(`Failed to fetch project with id #${this.projectId}: ${response.statusText}`);
+            throw new Error(`Failed to fetch project with id #${projectId}: ${response.statusText}`);
         }
-        return response;
+        const data = await response.json();
+        const project = core_1.ProjectSchema.parse(data);
+        return project;
     }
     async fetchArticle(articleId) {
-        const url = new url_1.URL(`/articles/${articleId}`, this.APIUrl);
-        const response = await this.fetchImpl(url.href);
+        const { username: projectId, password: apiKey, origin } = this.url;
+        const url = new url_1.URL(`/projects/${projectId}/articles/${articleId}`, origin);
+        const response = await this.fetchImpl(url.href, {
+            headers: {
+                Authorization: `Bearer ${apiKey}`
+            }
+        });
         if (!response.ok) {
             throw new Error(`Failed to fetch article with id #${articleId}: ${response.statusText}`);
         }
-        return response;
-    }
-    async fetchKeyframes(articleId) {
-        const url = new url_1.URL(`/keyframes/${articleId}`, this.APIUrl);
-        const response = await this.fetchImpl(url.href);
-        if (!response.ok) {
-            throw new Error(`Failed to fetch keyframes for the article with id #${articleId}: ${response.statusText}`);
-        }
-        return response;
+        const data = await response.json();
+        const article = core_1.ArticleSchema.parse(data.article);
+        const keyframes = core_1.KeyframesSchema.parse(data.keyframes);
+        return { article, keyframes };
     }
     async fetchTypePresets() {
-        const url = new url_1.URL(`/projects/${this.projectId}/type-presets`, this.APIUrl);
-        const response = await this.fetchImpl(url.href);
+        const { username: projectId, password: apiKey, origin } = this.url;
+        const url = new url_1.URL(`/projects/${projectId}/type-presets`, origin);
+        const response = await this.fetchImpl(url.href, {
+            headers: {
+                Authorization: `Bearer ${apiKey}`
+            }
+        });
         if (!response.ok) {
-            throw new Error(`Failed to fetch type presets for the project with id #${this.projectId}: ${response.statusText}`);
+            throw new Error(`Failed to fetch type presets for the project with id #${projectId}: ${response.statusText}`);
         }
-        return response;
+        const data = await response.json();
+        const typePresets = core_1.TypePresetsSchema.parse(data);
+        return typePresets;
     }
     findArticleIdByPageSlug(slug, pages) {
+        const { username: projectId } = this.url;
         const page = pages.find((page) => page.slug === slug);
         if (!page) {
-            throw new Error(`Page with a slug ${slug} was not found in project with id #${this.projectId}`);
+            throw new Error(`Page with a slug ${slug} was not found in project with id #${projectId}`);
         }
         return page.articleId;
     }

package/lib/cli.js

@@ -0,0 +1,55 @@
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const ejs_1 = __importDefault(require("ejs"));
+const dotenv_1 = require("dotenv");
+const commander_1 = require("commander");
+const Client_1 = require("./Client/Client");
+commander_1.program
+    .command('generate-layouts')
+    .option('-o, --output <outputFilePath>', 'Output file path', 'cntrl.scss')
+    .option('-e, --env <envFilename>', 'Name of the .env file', '.env.local')
+    .action(async (options) => {
+    try {
+        (0, dotenv_1.config)({ path: options.env });
+        const templateFilePath = path_1.default.resolve(__dirname, '../resources/template.scss.ejs');
+        const scssTemplate = fs_1.default.readFileSync(templateFilePath, 'utf-8');
+        const apiUrl = process.env.CNTRL_API_URL;
+        if (!apiUrl) {
+            throw new Error('Environment variable "CNTRL_API_URL" must be set.');
+        }
+        const client = new Client_1.Client(apiUrl);
+        const layouts = await client.getLayouts();
+        const ranges = convertLayouts(layouts);
+        const compiledTemplate = ejs_1.default.compile(scssTemplate);
+        const renderedTemplate = compiledTemplate({ ranges });
+        const outputFilePath = path_1.default.resolve(process.cwd(), options.output);
+        fs_1.default.writeFileSync(outputFilePath, renderedTemplate);
+        console.log(`Generated .scss file at ${outputFilePath}`);
+    }
+    catch (error) {
+        console.error('An error occurred:', error);
+        process.exit(1);
+    }
+});
+function convertLayouts(layouts, maxLayoutWidth = Number.MAX_SAFE_INTEGER) {
+    const sorted = layouts.slice().sort((la, lb) => la.startsWith - lb.startsWith);
+    const mapped = sorted.map((layout, i, ls) => {
+        const next = ls[i + 1];
+        return {
+            start: layout.startsWith,
+            end: next ? next.startsWith - 1 : maxLayoutWidth,
+            exemplary: layout.exemplary,
+            name: layout.title,
+            isFirst: i === 0,
+            isLast: !next
+        };
+    });
+    return mapped;
+}
+commander_1.program.parse(process.argv);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cntrl-site/sdk",
-  "version": "0.7.2",
+  "version": "1.1.0",
   "description": "Generic SDK for use in public websites.",
   "main": "lib/index.js",
   "types": "src/index.ts",
@@ -10,6 +10,9 @@
     "build": "tsc --project tsconfig.build.json",
     "prepublishOnly": "NODE_ENV=production npm run build"
   },
+  "bin": {
+    "cntrl-sdk": "lib/cli.js"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/cntrl-site/sdk.git"
@@ -24,9 +27,14 @@
     "lib": "lib"
   },
   "dependencies": {
-    "@cntrl-site/core": "^1.22.0",
+    "@cntrl-site/core": "^1.22.3",
+    "@types/ejs": "^3.1.2",
     "@types/isomorphic-fetch": "^0.0.36",
+    "commander": "^10.0.1",
+    "dotenv": "^16.1.3",
+    "ejs": "^3.1.9",
     "isomorphic-fetch": "^3.0.0",
+    "ts-node": "^10.9.1",
     "url": "^0.11.0"
   },
   "devDependencies": {

package/resources/template.scss.ejs

@@ -0,0 +1,50 @@
+// CAUTION: THIS FILE IS AUTO-GENERATED BASED ON
+// LAYOUT CONFIGURATION IN YOUR CNTRL PROJECT
+// WE HIGHLY ADVICE YOU TO NOT CHANGE IT MANUALLY
+@use "sass:map";
+
+$__CNTRL_LAYOUT_WIDTH__: 100;
+
+$layout: (
+<% ranges.forEach(function(range) { %>
+    <%= range.name %>: (
+        start: <%= range.start %>,
+        end: <%= range.end %>,
+        exemplary: <%= range.exemplary %>,
+        isFirst: <%= range.isFirst %>,
+        isLast: <%= range.isLast %>
+    ),
+<% }); %>
+);
+
+@function size($value) {
+    @return #{$value/$__CNTRL_LAYOUT_WIDTH__*100}vw;
+}
+
+@mixin for($name) {
+    $start: map.get(map.get($layout, $name), "start");
+    $end: map.get(map.get($layout, $name), "end");
+    $isFirst: map.get(map.get($layout, $name), "isFirst");
+    $isLast: map.get(map.get($layout, $name), "isLast");
+    $exemplary: map.get(map.get($layout, $name), "exemplary");
+    $__CNTRL_LAYOUT_WIDTH__: $exemplary !global;
+
+    @if $isFirst == true and $isLast == true {
+        @content;
+    } @else if $isFirst == true {
+        @media (max-width: #{$end}px) {
+            @content;
+        }
+    } @else if $isLast == true {
+        @media (min-width: #{$start}px) {
+            @content;
+        }
+    } @else {
+        @media (min-width: #{$start}px) and (max-width: #{$end}px) {
+            @content;
+        }
+    }
+
+    // reset global variable back to it's initial state
+    $__CNTRL_LAYOUT_WIDTH__: 100 !global;
+}

package/src/Client/Client.test.ts

@@ -2,100 +2,114 @@ import { Client } from './Client';
 import { projectMock } from './__mock__/projectMock';
 import { articleMock } from './__mock__/articleMock';
 import { typePresetsMock } from './__mock__/typePresetsMock';
-import { TMeta, TPageMeta } from '@cntrl-site/core';
 import { keyframesMock } from './__mock__/keyframesMock';
 
 describe('Client', () => {
-  it('returns project', async () => {
-    let fetchCalledTimes = 0;
+  it('throws an error when no project ID passed to the connect URL', async () => {
+    const projectId = '';
+    const apiKey = 'MY_API_KEY';
+    const apiUrl = `https://${projectId}:${apiKey}@api.cntrl.site/`;
+    expect(() => new Client(apiUrl)).toThrow(new Error('Project ID is missing in the URL.'));
+    expect(() => new Client('https://api.cntrl.site'))
+      .toThrow(new Error('Project ID is missing in the URL.'));
+  });
+
+  it('throws an error when no API key passed to the connect URL', async () => {
+    const projectId = 'whatever';
+    const apiKey = '';
+    const apiUrl = `https://${projectId}:${apiKey}@api.cntrl.site/`;
+    expect(() => new Client(apiUrl)).toThrow(new Error('API key is missing in the URL.'));
+  });
+
+  it('returns page data', async () => {
     const projectId = 'projectId';
-    const apiUrl = 'https://api.cntrl.site/';
+    const API_BASE_URL = 'api-test.cntrl.site';
+    const fetchesMap = {
+      [`https://${API_BASE_URL}/projects/${projectId}`]: projectMock,
+      [`https://${API_BASE_URL}/projects/${projectId}/type-presets`]: typePresetsMock,
+      [`https://${API_BASE_URL}/projects/${projectId}/articles/articleId`]: {
+        article: articleMock,
+        keyframes: keyframesMock
+      }
+    };
+    const apiKey = 'MY_API_KEY';
+    let fetchCalledTimes = 0;
+    const apiUrl = `https://${projectId}:${apiKey}@${API_BASE_URL}/`;
     const fetch = async (url: string) => {
       fetchCalledTimes += 1;
-      expect(url).toBe(`${apiUrl}projects/${projectId}`);
       return Promise.resolve({
         ok: true,
-        json: () => Promise.resolve(projectMock),
+        json: () => Promise.resolve(fetchesMap[url]),
         statusText: ''
       });
     };
-    const client = new Client(projectId, apiUrl, fetch);
-    const project = await client.getProject();
-    expect(fetchCalledTimes).toBe(1);
-    expect(project).toEqual(projectMock);
-  });
-
-  it('throws an error upon project fetch failure', async () => {
-    const projectId = 'projectId';
-    const apiUrl = 'https://api.cntrl.site/';
-    const fetch = async () => Promise.resolve({
-      ok: false,
-      statusText: 'reason',
-      json: () => Promise.resolve()
+    const client = new Client(apiUrl, fetch);
+    const pageData = await client.getPageData('/');
+    expect(fetchCalledTimes).toBe(3);
+    expect(pageData.project).toEqual(projectMock);
+    expect(pageData.article).toEqual(articleMock);
+    expect(pageData.typePresets).toEqual(typePresetsMock);
+    expect(pageData.keyframes).toEqual(keyframesMock);
+    expect(pageData.meta).toEqual({
+      description: 'page description',
+      favicon: 'project favicon',
+      keywords: 'page keywords',
+      opengraphThumbnail: 'page thumbnail',
+      title: 'page title'
     });
-    const client = new Client(projectId, apiUrl, fetch);
-    await expect(client.getProject()).rejects.toEqual(new Error('Failed to fetch project with id #projectId: reason'));
   });
 
-  it('returns article by page slug', async () => {
-    let fetchCalledTimes = 0;
+  it('ignores page meta if it is not enabled and uses project meta instead', async () => {
     const projectId = 'projectId';
-    const apiUrl = 'https://api.cntrl.site/';
-    const projectApiUrl = `${apiUrl}projects/projectId`;
-    const articleApiUrl = `${apiUrl}articles/articleId`;
+    const API_BASE_URL = 'api-test.cntrl.site';
+    const fetchesMap = {
+      [`https://${API_BASE_URL}/projects/${projectId}`]: projectMock,
+      [`https://${API_BASE_URL}/projects/${projectId}/type-presets`]: typePresetsMock,
+      [`https://${API_BASE_URL}/projects/${projectId}/articles/articleId2`]: {
+        article: articleMock,
+        keyframes: keyframesMock
+      }
+    };
+    const apiKey = 'MY_API_KEY';
+    let fetchCalledTimes = 0;
+    const apiUrl = `https://${projectId}:${apiKey}@${API_BASE_URL}/`;
     const fetch = async (url: string) => {
       fetchCalledTimes += 1;
-      if (fetchCalledTimes === 1) {
-        expect(url).toBe(projectApiUrl);
-      }
-      if (fetchCalledTimes === 2) {
-        expect(url).toBe(articleApiUrl);
-      }
       return Promise.resolve({
         ok: true,
-        json: () => Promise.resolve(url === projectApiUrl ? projectMock : articleMock),
+        json: () => Promise.resolve(fetchesMap[url]),
         statusText: ''
       });
     };
-    const client = new Client(projectId, apiUrl, fetch);
-    const article = await client.getPageArticle('/');
-    expect(fetchCalledTimes).toBe(2);
-    expect(article).toEqual(articleMock);
+    const client = new Client(apiUrl, fetch);
+    const pageData = await client.getPageData('/2');
+    expect(pageData.meta).toEqual({
+      description: 'project description',
+      favicon: 'project favicon',
+      keywords: 'project keywords',
+      opengraphThumbnail: 'project opengraph',
+      title: 'project title'
+    });
   });
 
-  it('throws an error upon project fetch failure when trying to get article by slug', async () => {
-    const projectId = 'projectId';
-    const apiUrl = 'https://api.cntrl.site/';
+  it('throws an error upon page data fetch failure', async () => {
+    const projectId = 'MY_PROJECT_ID';
+    const apiKey = 'MY_API_KEY';
+    const apiUrl = `https://${projectId}:${apiKey}@api.cntrl.site/`;
     const fetch = async () => Promise.resolve({
       ok: false,
       statusText: 'reason',
       json: () => Promise.resolve()
     });
-    const client = new Client(projectId, apiUrl, fetch);
-    await expect(client.getPageArticle('/'))
-      .rejects.toEqual(new Error('Failed to fetch project with id #projectId: reason'));
-  });
-
-  it('throws an error upon article fetch failure when trying to get article by slug', async () => {
-    const projectId = 'projectId';
-    const apiUrl = 'https://api.cntrl.site/';
-    const projectApiUrl = `${apiUrl}projects/projectId`;
-    const fetch = (url: string) => {
-      return Promise.resolve({
-        ok: url === projectApiUrl,
-        json: () => Promise.resolve(projectMock),
-        statusText: 'reason'
-      });
-    };
-    const client = new Client(projectId, apiUrl, fetch);
-    await expect(client.getPageArticle('/'))
-      .rejects.toEqual(new Error('Failed to fetch article with id #articleId: reason'));
+    const client = new Client(apiUrl, fetch);
+    await expect(client.getPageData('/')).rejects.toEqual(new Error('Failed to fetch project with id #MY_PROJECT_ID: reason'));
   });
 
   it('throws an error when trying to fetch article by nonexistent slug', async () => {
-    const projectId = 'projectId';
-    const apiUrl = 'https://api.cntrl.site/';
-    const projectApiUrl = `${apiUrl}projects/projectId`;
+    const projectId = 'MY_PROJECT_ID';
+    const apiKey = 'MY_API_KEY';
+    const apiUrl = `https://${projectId}:${apiKey}@api.cntrl.site/`;
+    const projectApiUrl = `https://api.cntrl.site/projects/${projectId}`;
     const slug = '/nonexistent-slug';
     const fetch = (url: string) => {
       return Promise.resolve({
@@ -104,119 +118,8 @@ describe('Client', () => {
         statusText: 'reason'
       });
     };
-    const client = new Client(projectId, apiUrl, fetch);
-    await expect(client.getPageArticle(slug))
+    const client = new Client(apiUrl, fetch);
+    await expect(client.getPageData(slug))
       .rejects.toEqual(new Error(`Page with a slug ${slug} was not found in project with id #${projectId}`));
   });
-
-  it('returns type presets by project id', async () => {
-    let fetchCalledTimes = 0;
-    const projectId = 'projectId';
-    const apiUrl = 'https://api.cntrl.site/';
-    const fetch = (url: string) => {
-      fetchCalledTimes += 1;
-      expect(url).toBe(`${apiUrl}projects/${projectId}/type-presets`);
-      return Promise.resolve({
-        ok: true,
-        json: () => Promise.resolve(typePresetsMock),
-        statusText: ''
-      });
-    };
-    const client = new Client(projectId, apiUrl, fetch);
-    const presets = await client.getTypePresets();
-    expect(presets).toEqual(typePresetsMock);
-    expect(fetchCalledTimes).toEqual(1);
-  });
-
-  it('throws an error upon type presets fetch failure', async () => {
-    const projectId = 'projectId';
-    const apiUrl = 'https://api.cntrl.site/';
-    const fetch = () => {
-      return Promise.resolve({
-        ok: false,
-        json: () => Promise.resolve(),
-        statusText: 'reason'
-      });
-    };
-    const client = new Client(projectId, apiUrl, fetch);
-    await expect(client.getTypePresets()).rejects.toEqual(
-      new Error(`Failed to fetch type presets for the project with id #${projectId}: reason`)
-    );
-  });
-
-  it('returns keyframes by article id', async () => {
-    let fetchCalledTimes = 0;
-    const projectId = 'projectId';
-    const articleId = 'articleId';
-    const apiUrl = 'https://api.cntrl.site/';
-    const fetch = (url: string) => {
-      fetchCalledTimes += 1;
-      expect(url).toBe(`${apiUrl}keyframes/${articleId}`);
-      return Promise.resolve({
-        ok: true,
-        json: () => Promise.resolve(keyframesMock),
-        statusText: ''
-      });
-    };
-    const client = new Client(projectId, apiUrl, fetch);
-    const presets = await client.getKeyframes(articleId);
-    expect(presets).toEqual(keyframesMock);
-    expect(fetchCalledTimes).toEqual(1);
-  });
-
-  it('throws an error upon keyframes fetch failure', async () => {
-    const projectId = 'projectId';
-    const articleId = 'articleId';
-    const apiUrl = 'https://api.cntrl.site/';
-    const fetch = () => {
-      return Promise.resolve({
-        ok: false,
-        json: () => Promise.resolve(),
-        statusText: 'reason'
-      });
-    };
-    const client = new Client(projectId, apiUrl, fetch);
-    await expect(client.getKeyframes(articleId)).rejects.toEqual(
-      new Error(`Failed to fetch keyframes for the article with id #${articleId}: reason`)
-    );
-  });
-
-  it('merges two meta objects into one with priority of page-based over project-based', () => {
-    const pageMeta: TPageMeta = {
-      enabled: true,
-      description: 'page-desc',
-      title: 'page-title'
-    };
-
-    const projectMeta: TMeta = {
-      opengraphThumbnail: 'proj-og',
-      description: 'proj-desc',
-      title: 'proj-title',
-      keywords: 'project, keywords'
-    };
-    const meta = Client.getPageMeta(projectMeta, pageMeta);
-    expect(meta.keywords).toBe(projectMeta.keywords);
-    expect(meta.opengraphThumbnail).toBe(projectMeta.opengraphThumbnail);
-    expect(meta.description).toBe(pageMeta.description);
-    expect(meta.title).toBe(pageMeta.title);
-  });
-
-  it('ignores page meta when `enabled` is set to `false` and uses only generic project meta', () => {
-    const pageMeta: TPageMeta = {
-      enabled: false,
-      description: 'page-desc',
-      title: 'page-title'
-    };
-
-    const projectMeta: TMeta = {
-      opengraphThumbnail: 'proj-og',
-      keywords: 'project, keywords'
-    };
-
-    const meta = Client.getPageMeta(projectMeta, pageMeta);
-    expect(meta.keywords).toBe(projectMeta.keywords);
-    expect(meta.opengraphThumbnail).toBe(projectMeta.opengraphThumbnail);
-    expect(meta.description).toBeUndefined();
-    expect(meta.title).toBeUndefined();
-  });
 });

package/src/Client/Client.ts

@@ -9,117 +9,138 @@ import {
   TypePresetsSchema,
   TPage,
   TKeyframeAny,
-  KeyframesSchema
+  KeyframesSchema,
+  TLayout
 } from '@cntrl-site/core';
 import fetch from 'isomorphic-fetch';
 import { URL } from 'url';
 
 export class Client {
+  private url: URL;
   constructor(
-    private projectId: string,
-    private APIUrl: string,
+    APIUrl: string,
     private fetchImpl: FetchImpl = fetch
   ) {
-    if (projectId.length === 0) {
-      throw new Error('CNTRL SDK: Project ID is empty. Did you forget to pass it?');
+    this.url = new URL(APIUrl);
+    if (!this.url.username) {
+      throw new Error('Project ID is missing in the URL.');
     }
-    if (APIUrl.length === 0) {
-      throw new Error('CNTRL SDK: API URL is empty. Did you forget to pass it?');
+    if (!this.url.password) {
+      throw new Error('API key is missing in the URL.');
     }
   }
 
-  async getProject(): Promise<TProject> {
+  private static getPageMeta(projectMeta: TMeta, pageMeta: TPageMeta): TMeta {
+    return pageMeta.enabled ? {
+      title: pageMeta.title ? pageMeta.title : projectMeta.title,
+      description: pageMeta.description ? pageMeta.description : projectMeta.description,
+      keywords: pageMeta.keywords ? pageMeta.keywords : projectMeta.keywords,
+      opengraphThumbnail: pageMeta.opengraphThumbnail ? pageMeta.opengraphThumbnail : projectMeta.opengraphThumbnail,
+      favicon: projectMeta.favicon
+    } : projectMeta;
+  }
+
+  async getPageData(pageSlug: string): Promise<CntrlPageData> {
     try {
-      const response = await this.fetchProject();
-      const data = await response.json();
-      const project = ProjectSchema.parse(data);
-      return project;
+      const project = await this.fetchProject();
+      const articleId = this.findArticleIdByPageSlug(pageSlug, project.pages);
+      const [{ article, keyframes }, typePresets] = await Promise.all([
+        this.fetchArticle(articleId),
+        this.fetchTypePresets()
+      ]);
+      const page = project.pages.find(page => page.slug === pageSlug)!;
+      const meta = Client.getPageMeta(project.meta, page?.meta!);
+      return {
+        project,
+        typePresets,
+        article,
+        keyframes,
+        meta
+      };
     } catch (e) {
       throw e;
     }
   }
 
-  async getPageArticle(pageSlug: string): Promise<TArticle> {
+  async getProjectPagesPaths(): Promise<string[]> {
     try {
-      const projectResponse = await this.fetchProject();
-      const data = await projectResponse.json();
-      const project = ProjectSchema.parse(data);
-      const articleId = this.findArticleIdByPageSlug(pageSlug, project.pages);
-      const articleResponse = await this.fetchArticle(articleId);
-      const articleData = await articleResponse.json();
-      const article = ArticleSchema.parse(articleData);
-      return article;
+      const { pages } = await this.fetchProject();
+      return pages.map(p => p.slug);
     } catch (e) {
       throw e;
     }
   }
 
-  async getTypePresets(): Promise<TTypePresets> {
-    const response = await this.fetchTypePresets();
-    const data = await response.json();
-    const typePresets = TypePresetsSchema.parse(data);
-    return typePresets;
-  }
-
-  async getKeyframes(articleId: string): Promise<TKeyframeAny[]> {
-    const response = await this.fetchKeyframes(articleId);
-    const data = await response.json();
-    const keyframes = KeyframesSchema.parse(data);
-    return keyframes;
-  }
-
-  public static getPageMeta(projectMeta: TMeta, pageMeta: TPageMeta): TMeta {
-    return pageMeta.enabled ? {
-      title: pageMeta.title ? pageMeta.title : projectMeta.title,
-      description: pageMeta.description ? pageMeta.description : projectMeta.description,
-      keywords: pageMeta.keywords ? pageMeta.keywords : projectMeta.keywords,
-      opengraphThumbnail: pageMeta.opengraphThumbnail ? pageMeta.opengraphThumbnail : projectMeta.opengraphThumbnail,
-      favicon: projectMeta.favicon
-    } : projectMeta;
+  async getLayouts(): Promise<TLayout[]> {
+    try {
+      const { layouts } = await this.fetchProject();
+      return layouts;
+    } catch (e) {
+      throw e;
+    }
   }
 
-  private async fetchProject(): Promise<FetchImplResponse> {
-    const url = new URL(`/projects/${this.projectId}`, this.APIUrl);
-    const response = await this.fetchImpl(url.href);
-    if (!response.ok) {
-      throw new Error(`Failed to fetch project with id #${this.projectId}: ${response.statusText}`);
-    }
+  async getTypePresets(): Promise<TTypePresets> {
+    const response = await this.fetchTypePresets();
     return response;
   }
 
-  private async fetchArticle(articleId: string): Promise<FetchImplResponse> {
-    const url = new URL(`/articles/${articleId}`, this.APIUrl);
-    const response = await this.fetchImpl(url.href);
+  private async fetchProject(): Promise<TProject> {
+    const { username: projectId, password: apiKey, origin } = this.url;
+    const url = new URL(`/projects/${projectId}`, origin);
+    const response = await this.fetchImpl(url.href, {
+      headers: {
+        Authorization: `Bearer ${apiKey}`
+      }
+    });
     if (!response.ok) {
-      throw new Error(`Failed to fetch article with id #${articleId}: ${response.statusText}`);
+      throw new Error(`Failed to fetch project with id #${projectId}: ${response.statusText}`);
     }
-    return response;
+    const data = await response.json();
+    const project = ProjectSchema.parse(data);
+    return project;
   }
 
-  private async fetchKeyframes(articleId: string): Promise<FetchImplResponse> {
-    const url = new URL(`/keyframes/${articleId}`, this.APIUrl);
-    const response = await this.fetchImpl(url.href);
+  private async fetchArticle(articleId: string): Promise<ArticleData> {
+    const { username: projectId, password: apiKey, origin } = this.url;
+    const url = new URL(`/projects/${projectId}/articles/${articleId}`, origin);
+    const response = await this.fetchImpl(url.href, {
+      headers: {
+        Authorization: `Bearer ${apiKey}`
+      }
+    });
     if (!response.ok) {
-      throw new Error(`Failed to fetch keyframes for the article with id #${articleId}: ${response.statusText}`);
+      throw new Error(`Failed to fetch article with id #${articleId}: ${response.statusText}`);
     }
-    return response;
+    const data = await response.json();
+    const article = ArticleSchema.parse(data.article);
+    const keyframes = KeyframesSchema.parse(data.keyframes);
+    return { article, keyframes };
   }
 
-  private async fetchTypePresets(): Promise<FetchImplResponse> {
-    const url = new URL(`/projects/${this.projectId}/type-presets`, this.APIUrl);
-    const response = await this.fetchImpl(url.href);
+  private async fetchTypePresets(): Promise<TTypePresets> {
+    const { username: projectId, password: apiKey, origin } = this.url;
+    const url = new URL(`/projects/${projectId}/type-presets`, origin);
+    const response = await this.fetchImpl(url.href, {
+      headers: {
+        Authorization: `Bearer ${apiKey}`
+      }
+    });
     if (!response.ok) {
       throw new Error(
-        `Failed to fetch type presets for the project with id #${this.projectId}: ${response.statusText}`
+        `Failed to fetch type presets for the project with id #${projectId}: ${response.statusText}`
       );
     }
-    return response;
+    const data = await response.json();
+    const typePresets = TypePresetsSchema.parse(data);
+    return typePresets;
   }
 
   private findArticleIdByPageSlug(slug: string, pages: TPage[]): string {
+    const { username: projectId } = this.url;
     const page = pages.find((page) => page.slug === slug);
     if (!page) {
-      throw new Error(`Page with a slug ${slug} was not found in project with id #${this.projectId}`);
+      throw new Error(`Page with a slug ${slug} was not found in project with id #${projectId}`);
     }
     return page.articleId;
   }
@@ -131,4 +152,13 @@ interface FetchImplResponse {
   statusText: string;
 }
 
-type FetchImpl = (url: string) => Promise<FetchImplResponse>;
+type FetchImpl = (url: string, init?: RequestInit) => Promise<FetchImplResponse>;
+interface ArticleData {
+  article: TArticle;
+  keyframes: TKeyframeAny[];
+}
+interface CntrlPageData extends ArticleData {
+  project: TProject;
+  typePresets: TTypePresets;
+  meta: TMeta;
+}

package/src/Client/__mock__/projectMock.ts

@@ -14,11 +14,11 @@ export const projectMock: TProject = {
     head: ''
   },
   meta: {
-    favicon: undefined,
-    title: undefined,
-    opengraphThumbnail: undefined,
-    keywords: undefined,
-    description: undefined
+    favicon: 'project favicon',
+    title: 'project title',
+    opengraphThumbnail: 'project opengraph',
+    keywords: 'project keywords',
+    description: 'project description'
   },
   grid: {
     color: 'rgba(0, 0, 0, 1)'
@@ -30,11 +30,25 @@ export const projectMock: TProject = {
     slug: '/',
     isPublished: true,
     meta: {
-      opengraphThumbnail: 'page-thumbnail',
-      title: 'page-title',
-      description: 'page-description',
+      opengraphThumbnail: 'page thumbnail',
+      title: 'page title',
+      description: 'page description',
       enabled: true,
-      keywords: 'page-keywords'
+      keywords: 'page keywords'
     }
-  }]
+  },
+    {
+      id: 'pageId2',
+      title: 'Page 2',
+      articleId: 'articleId2',
+      slug: '/2',
+      isPublished: true,
+      meta: {
+        opengraphThumbnail: 'page thumbnail',
+        title: 'page title',
+        description: 'page description',
+        enabled: false,
+        keywords: 'page keywords'
+      }
+    }]
 };

package/src/cli.ts

@@ -0,0 +1,67 @@
+#!/usr/bin/env node
+
+import fs from 'fs';
+import path from 'path';
+import ejs from 'ejs';
+import { config } from 'dotenv';
+import { program } from 'commander';
+import { TLayout } from '@cntrl-site/core';
+import { Client } from './Client/Client';
+
+program
+  .command('generate-layouts')
+  .option('-o, --output <outputFilePath>', 'Output file path', 'cntrl.scss')
+  .option('-e, --env <envFilename>', 'Name of the .env file', '.env.local')
+  .action(async (options) => {
+    try {
+      config({ path: options.env });
+      const templateFilePath = path.resolve(__dirname, '../resources/template.scss.ejs');
+      const scssTemplate = fs.readFileSync(templateFilePath, 'utf-8');
+      const apiUrl = process.env.CNTRL_API_URL;
+      if (!apiUrl) {
+        throw new Error('Environment variable "CNTRL_API_URL" must be set.');
+      }
+      const client = new Client(apiUrl);
+      const layouts = await client.getLayouts();
+      const ranges = convertLayouts(layouts);
+
+      const compiledTemplate = ejs.compile(scssTemplate);
+      const renderedTemplate = compiledTemplate({ ranges });
+
+      const outputFilePath = path.resolve(process.cwd(), options.output);
+      fs.writeFileSync(outputFilePath, renderedTemplate);
+
+      console.log(`Generated .scss file at ${outputFilePath}`);
+    } catch (error) {
+      console.error('An error occurred:', error);
+      process.exit(1);
+    }
+  });
+
+function convertLayouts(layouts: TLayout[], maxLayoutWidth: number = Number.MAX_SAFE_INTEGER): LayoutRange[] {
+  const sorted = layouts.slice().sort((la, lb) => la.startsWith - lb.startsWith);
+  const mapped = sorted.map<LayoutRange>((layout, i, ls) => {
+    const next = ls[i + 1];
+    return {
+      start: layout.startsWith,
+      end: next ? next.startsWith - 1 : maxLayoutWidth,
+      exemplary: layout.exemplary,
+      name: layout.title,
+      isFirst: i === 0,
+      isLast: !next
+    };
+  });
+  return mapped;
+}
+
+export interface LayoutRange {
+  /** closed range [start, end] */
+  start: number;
+  end: number;
+  exemplary: number;
+  name: string;
+  isFirst: boolean;
+  isLast: boolean;
+}
+
+program.parse(process.argv);