@gxpl/sdk 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 GX Platform
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,2 @@
+# GX SDK
+This is a root SDK module for GX.

package/dist/Client/Client.d.ts

@@ -0,0 +1,32 @@
+import { Meta } from '../types/project/Meta';
+import { Project } from '../types/project/Project';
+import { Layout } from '../types/project/Layout';
+import { Article } from '../types/article/Article';
+import { KeyframeAny } from '../types/keyframe/Keyframe';
+export declare class Client {
+    private fetchImpl;
+    private url;
+    constructor(APIUrl: string, fetchImpl?: FetchImpl);
+    private static getPageMeta;
+    getPageData(pageSlug: string, buildMode?: 'default' | 'self-hosted'): Promise<CntrlPageData>;
+    getProjectPagesPaths(): Promise<string[]>;
+    getLayouts(): Promise<Layout[]>;
+    private fetchProject;
+    private fetchArticle;
+    private findArticleIdByPageSlug;
+}
+interface FetchImplResponse {
+    ok: boolean;
+    json(): Promise<any>;
+    statusText: string;
+}
+type FetchImpl = (url: string, init?: RequestInit) => Promise<FetchImplResponse>;
+interface ArticleData {
+    article: Article;
+    keyframes: KeyframeAny[];
+}
+interface CntrlPageData extends ArticleData {
+    project: Project;
+    meta: Meta;
+}
+export {};

package/dist/Client/Client.js

@@ -0,0 +1,128 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Client = void 0;
+const isomorphic_fetch_1 = __importDefault(require("isomorphic-fetch"));
+const url_1 = require("url");
+const Article_schema_1 = require("../schemas/article/Article.schema");
+const Project_schema_1 = require("../schemas/project/Project.schema");
+const Keyframes_schema_1 = require("../schemas/keyframe/Keyframes.schema");
+class Client {
+    constructor(APIUrl, fetchImpl = isomorphic_fetch_1.default) {
+        this.fetchImpl = fetchImpl;
+        this.url = new url_1.URL(APIUrl);
+        if (!this.url.username) {
+            throw new Error('Project ID is missing in the URL.');
+        }
+        if (!this.url.password) {
+            throw new Error('API key is missing in the URL.');
+        }
+    }
+    static getPageMeta(projectMeta, pageMeta) {
+        var _a, _b, _c, _d, _e;
+        return pageMeta.enabled ? {
+            title: pageMeta.title ? pageMeta.title : (_a = projectMeta.title) !== null && _a !== void 0 ? _a : '',
+            description: pageMeta.description ? pageMeta.description : (_b = projectMeta.description) !== null && _b !== void 0 ? _b : '',
+            keywords: pageMeta.keywords ? pageMeta.keywords : (_c = projectMeta.keywords) !== null && _c !== void 0 ? _c : '',
+            opengraphThumbnail: pageMeta.opengraphThumbnail ? pageMeta.opengraphThumbnail : (_d = projectMeta.opengraphThumbnail) !== null && _d !== void 0 ? _d : '',
+            favicon: (_e = projectMeta.favicon) !== null && _e !== void 0 ? _e : ''
+        } : projectMeta;
+    }
+    getPageData(pageSlug_1) {
+        return __awaiter(this, arguments, void 0, function* (pageSlug, buildMode = 'default') {
+            try {
+                const project = yield this.fetchProject(buildMode);
+                const articleId = this.findArticleIdByPageSlug(pageSlug, project.pages);
+                const { article, keyframes } = yield this.fetchArticle(articleId, buildMode);
+                const page = project.pages.find(page => page.slug === pageSlug);
+                const meta = Client.getPageMeta(project.meta, page === null || page === void 0 ? void 0 : page.meta);
+                return {
+                    project,
+                    article,
+                    keyframes,
+                    meta
+                };
+            }
+            catch (e) {
+                throw e;
+            }
+        });
+    }
+    getProjectPagesPaths() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const { pages } = yield this.fetchProject();
+                return pages.map(p => p.slug);
+            }
+            catch (e) {
+                throw e;
+            }
+        });
+    }
+    getLayouts() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const { layouts } = yield this.fetchProject();
+                return layouts;
+            }
+            catch (e) {
+                throw e;
+            }
+        });
+    }
+    fetchProject() {
+        return __awaiter(this, arguments, void 0, function* (buildMode = 'default') {
+            const { username: projectId, password: apiKey, origin } = this.url;
+            const url = new url_1.URL(`/projects/${projectId}?buildMode=${buildMode}`, origin);
+            const response = yield this.fetchImpl(url.href, {
+                headers: {
+                    Authorization: `Bearer ${apiKey}`
+                }
+            });
+            if (!response.ok) {
+                throw new Error(`Failed to fetch project with id #${projectId}: ${response.statusText}`);
+            }
+            const data = yield response.json();
+            const project = Project_schema_1.ProjectSchema.parse(data);
+            return project;
+        });
+    }
+    fetchArticle(articleId_1) {
+        return __awaiter(this, arguments, void 0, function* (articleId, buildMode = 'default') {
+            const { username: projectId, password: apiKey, origin } = this.url;
+            const url = new url_1.URL(`/projects/${projectId}/articles/${articleId}?buildMode=${buildMode}`, origin);
+            const response = yield this.fetchImpl(url.href, {
+                headers: {
+                    Authorization: `Bearer ${apiKey}`
+                }
+            });
+            if (!response.ok) {
+                throw new Error(`Failed to fetch article with id #${articleId}: ${response.statusText}`);
+            }
+            const data = yield response.json();
+            const article = Article_schema_1.ArticleSchema.parse(data.article);
+            const keyframes = Keyframes_schema_1.KeyframesSchema.parse(data.keyframes);
+            return { article, keyframes };
+        });
+    }
+    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 #${projectId}`);
+        }
+        return page.articleId;
+    }
+}
+exports.Client = Client;

package/dist/Client/Client.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/Client/__mock__/articleMock.d.ts

@@ -0,0 +1,2 @@
+import { Article } from '../../types/article/Article';
+export declare const articleMock: Article;

package/dist/Client/__mock__/keyframesMock.d.ts

@@ -0,0 +1,2 @@
+import { KeyframeAny } from '../../types/keyframe/Keyframe';
+export declare const keyframesMock: KeyframeAny[];

package/dist/Client/__mock__/projectMock.d.ts

@@ -0,0 +1,2 @@
+import { Project } from '../../types/project/Project';
+export declare const projectMock: Project;

package/dist/Components/ControlSlider/ControlSlider.d.ts

@@ -0,0 +1,91 @@
+import { default as React } from 'react';
+interface SliderProps {
+    settings: SliderSettings;
+    content: SliderItem[];
+    styles: SliderStyles;
+    isEditor?: boolean;
+}
+export declare function ControlSlider({ settings, content, styles: sliderStyles, isEditor }: SliderProps): React.JSX.Element;
+type SliderItem = {
+    image: {
+        url: string;
+        name?: string;
+        objectFit?: 'cover' | 'contain';
+    };
+    imageCaption: any[];
+};
+type Offset = {
+    x: number;
+    y: number;
+};
+type SliderControls = {
+    arrowsImgUrl: string | null;
+    isActive: boolean;
+    color: string;
+    hover: string;
+    offset: Offset;
+    scale: number;
+};
+type SliderPagination = {
+    position: 'outside-1' | 'outside-2' | 'inside-1' | 'inside-2';
+    isActive: boolean;
+    scale: number;
+    offset: Offset;
+    colors: string[];
+    hover: string;
+};
+type Alignment = 'top-left' | 'top-center' | 'top-right' | 'middle-left' | 'middle-center' | 'middle-right' | 'bottom-left' | 'bottom-center' | 'bottom-right';
+type SliderCaption = {
+    alignment: Alignment;
+    isActive: boolean;
+    color: string;
+    offset: Offset;
+    hover: string;
+};
+type Triggers = {
+    triggersList: {
+        click: boolean;
+        drag: boolean;
+    };
+    autoPlay: string | null;
+};
+type SliderSettings = {
+    controls: SliderControls;
+    pagination: SliderPagination;
+    direction: 'horiz' | 'vert';
+    transition: {
+        type: 'slide' | 'fade in';
+        duration: string;
+        backgroundColor: string | null;
+    };
+    caption: SliderCaption;
+    triggers: Triggers;
+};
+type CaptionStyles = {
+    fontSettings: {
+        fontFamily: string;
+        fontWeight: number;
+        fontStyle: string;
+    };
+    widthSettings: {
+        width: number;
+        sizing: 'auto' | 'manual';
+    };
+    letterSpacing: number;
+    textAlign: 'left' | 'center' | 'right';
+    wordSpacing: number;
+    fontSizeLineHeight: {
+        fontSize: number;
+        lineHeight: number;
+    };
+    textAppearance: {
+        textTransform: 'none' | 'uppercase' | 'lowercase';
+        textDecoration: 'none' | 'underline';
+        fontVariant: 'normal' | 'small-caps';
+    };
+    color: string;
+};
+type SliderStyles = {
+    caption: CaptionStyles;
+};
+export {};