@gxpl/sdk 0.0.13 → 0.0.14

package/lib/sdk/Client/Client.d.ts

@@ -1,4 +1,3 @@
-import { Meta } from '../types/project/Meta';
 import { Project } from '../types/project/Project';
 import { Article } from '../types/article/Article';
 import { KeyframeAny } from '../types/keyframe/Keyframe';
@@ -6,12 +5,9 @@ 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[]>;
+    getPageData(buildMode?: 'default' | 'self-hosted'): Promise<CntrlPageData>;
     private fetchProject;
     private fetchArticle;
-    private findArticleIdByPageSlug;
 }
 interface FetchImplResponse {
     ok: boolean;
@@ -23,8 +19,8 @@ interface ArticleData {
     article: Article;
     keyframes: KeyframeAny[];
 }
-interface CntrlPageData extends ArticleData {
+interface CntrlPageData {
     project: Project;
-    meta: Meta;
+    articlesData: Record<string, ArticleData>;
 }
 export {};

package/lib/sdk/Client/Client.js

@@ -29,29 +29,19 @@ class Client {
             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') {
+    getPageData() {
+        return __awaiter(this, arguments, void 0, function* (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);
+                const articlesIds = project.pages.map(page => page.articleId);
+                const articlesDataArr = yield Promise.all(articlesIds.map(articleId => this.fetchArticle(articleId, buildMode)));
+                const articlesData = articlesDataArr.reduce((acc, articleData) => {
+                    acc[articleData.article.id] = articleData;
+                    return acc;
+                }, {});
                 return {
                     project,
-                    article,
-                    keyframes,
-                    meta
+                    articlesData
                 };
             }
             catch (e) {
@@ -59,17 +49,6 @@ class Client {
             }
         });
     }
-    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;
-            }
-        });
-    }
     fetchProject() {
         return __awaiter(this, arguments, void 0, function* (buildMode = 'default') {
             const { username: projectId, password: apiKey, origin } = this.url;
@@ -105,13 +84,5 @@ class Client {
             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/lib/sdk/schemas/project/Project.schema.d.ts

@@ -36,53 +36,14 @@ export declare const ProjectSchema: z.ZodObject<{
     }>;
     exemplary: z.ZodNumber;
     pages: z.ZodArray<z.ZodObject<{
-        title: z.ZodString;
         articleId: z.ZodString;
-        slug: z.ZodString;
-        meta: z.ZodOptional<z.ZodObject<{
-            title: z.ZodOptional<z.ZodString>;
-            description: z.ZodOptional<z.ZodString>;
-            opengraphThumbnail: z.ZodOptional<z.ZodString>;
-            keywords: z.ZodOptional<z.ZodString>;
-            enabled: z.ZodBoolean;
-        }, "strip", z.ZodTypeAny, {
-            enabled: boolean;
-            title?: string | undefined;
-            description?: string | undefined;
-            opengraphThumbnail?: string | undefined;
-            keywords?: string | undefined;
-        }, {
-            enabled: boolean;
-            title?: string | undefined;
-            description?: string | undefined;
-            opengraphThumbnail?: string | undefined;
-            keywords?: string | undefined;
-        }>>;
         id: z.ZodString;
     }, "strip", z.ZodTypeAny, {
         id: string;
-        title: string;
         articleId: string;
-        slug: string;
-        meta?: {
-            enabled: boolean;
-            title?: string | undefined;
-            description?: string | undefined;
-            opengraphThumbnail?: string | undefined;
-            keywords?: string | undefined;
-        } | undefined;
     }, {
         id: string;
-        title: string;
         articleId: string;
-        slug: string;
-        meta?: {
-            enabled: boolean;
-            title?: string | undefined;
-            description?: string | undefined;
-            opengraphThumbnail?: string | undefined;
-            keywords?: string | undefined;
-        } | undefined;
     }>, "many">;
     fonts: z.ZodObject<{
         google: z.ZodString;
@@ -143,6 +104,22 @@ export declare const ProjectSchema: z.ZodObject<{
         google: string;
         adobe: string;
     }>;
+    relations: z.ZodArray<z.ZodObject<{
+        from: z.ZodString;
+        to: z.ZodString;
+        type: z.ZodEnum<["slide", "fade"]>;
+        direction: z.ZodEnum<["north", "east", "south", "west"]>;
+    }, "strip", z.ZodTypeAny, {
+        type: "slide" | "fade";
+        from: string;
+        to: string;
+        direction: "north" | "east" | "south" | "west";
+    }, {
+        type: "slide" | "fade";
+        from: string;
+        to: string;
+        direction: "north" | "east" | "south" | "west";
+    }>, "many">;
 }, "strip", z.ZodTypeAny, {
     html: {
         head: string;
@@ -160,16 +137,7 @@ export declare const ProjectSchema: z.ZodObject<{
     exemplary: number;
     pages: {
         id: string;
-        title: string;
         articleId: string;
-        slug: string;
-        meta?: {
-            enabled: boolean;
-            title?: string | undefined;
-            description?: string | undefined;
-            opengraphThumbnail?: string | undefined;
-            keywords?: string | undefined;
-        } | undefined;
     }[];
     fonts: {
         custom: {
@@ -184,6 +152,12 @@ export declare const ProjectSchema: z.ZodObject<{
         google: string;
         adobe: string;
     };
+    relations: {
+        type: "slide" | "fade";
+        from: string;
+        to: string;
+        direction: "north" | "east" | "south" | "west";
+    }[];
 }, {
     html: {
         head: string;
@@ -201,16 +175,7 @@ export declare const ProjectSchema: z.ZodObject<{
     exemplary: number;
     pages: {
         id: string;
-        title: string;
         articleId: string;
-        slug: string;
-        meta?: {
-            enabled: boolean;
-            title?: string | undefined;
-            description?: string | undefined;
-            opengraphThumbnail?: string | undefined;
-            keywords?: string | undefined;
-        } | undefined;
     }[];
     fonts: {
         custom: {
@@ -225,4 +190,10 @@ export declare const ProjectSchema: z.ZodObject<{
         google: string;
         adobe: string;
     };
+    relations: {
+        type: "slide" | "fade";
+        from: string;
+        to: string;
+        direction: "north" | "east" | "south" | "west";
+    }[];
 }>;

package/lib/sdk/schemas/project/Project.schema.js

@@ -19,16 +19,7 @@ exports.ProjectSchema = zod_1.z.object({
     }),
     exemplary: zod_1.z.number().positive(),
     pages: zod_1.z.array(zod_1.z.object({
-        title: zod_1.z.string(),
         articleId: zod_1.z.string().min(1),
-        slug: zod_1.z.string(),
-        meta: zod_1.z.object({
-            title: zod_1.z.string().optional(),
-            description: zod_1.z.string().optional(),
-            opengraphThumbnail: zod_1.z.string().optional(),
-            keywords: zod_1.z.string().optional(),
-            enabled: zod_1.z.boolean()
-        }).optional(),
         id: zod_1.z.string().min(1)
     })),
     fonts: zod_1.z.object({
@@ -43,5 +34,11 @@ exports.ProjectSchema = zod_1.z.object({
                 url: zod_1.z.string()
             }))
         }))
-    })
+    }),
+    relations: zod_1.z.array(zod_1.z.object({
+        from: zod_1.z.string().min(1),
+        to: zod_1.z.string().min(1),
+        type: zod_1.z.enum(['slide', 'fade']),
+        direction: zod_1.z.enum(['north', 'east', 'south', 'west'])
+    }))
 });