@cntrl-site/sdk 0.3.0 → 0.4.0

package/lib/Client/Client.js

@@ -51,6 +51,12 @@ class Client {
         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,
@@ -76,6 +82,14 @@ class Client {
         }
         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;
+    }
     async fetchTypePresets() {
         const url = new url_1.URL(`/projects/${this.projectId}/type-presets`, this.APIUrl);
         const response = await this.fetchImpl(url.href);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cntrl-site/sdk",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Generic SDK for use in public websites.",
   "main": "lib/index.js",
   "types": "src/index.ts",
@@ -24,7 +24,7 @@
     "lib": "lib"
   },
   "dependencies": {
-    "@cntrl-site/core": "^1.14.0",
+    "@cntrl-site/core": "^1.14.1",
     "@types/isomorphic-fetch": "^0.0.36",
     "isomorphic-fetch": "^3.0.0",
     "url": "^0.11.0"

package/src/Client/Client.test.ts

@@ -3,6 +3,7 @@ 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 () => {
@@ -143,6 +144,43 @@ describe('Client', () => {
     );
   });
 
+  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,

package/src/Client/Client.ts

@@ -7,7 +7,9 @@ import {
   TPageMeta,
   TTypePresets,
   TypePresetsSchema,
-  TPage
+  TPage,
+  TKeyframeAny,
+  KeyframesSchema
 } from '@cntrl-site/core';
 import fetch from 'isomorphic-fetch';
 import { URL } from 'url';
@@ -59,6 +61,13 @@ export class Client {
     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,
@@ -87,6 +96,15 @@ export class Client {
     return response;
   }
 
+  private async fetchKeyframes(articleId: string): Promise<FetchImplResponse> {
+    const url = new 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;
+  }
+
   private async fetchTypePresets(): Promise<FetchImplResponse> {
     const url = new URL(`/projects/${this.projectId}/type-presets`, this.APIUrl);
     const response = await this.fetchImpl(url.href);

package/src/Client/__mock__/keyframesMock.ts

@@ -0,0 +1,15 @@
+import { KeyframeType, TKeyframeAny } from '@cntrl-site/core';
+
+export const keyframesMock: TKeyframeAny[] = [
+  {
+    id: 'keyframeId',
+    articleId: 'articleId',
+    type: KeyframeType.Color,
+    position: 100,
+    value: {
+      color: 'black'
+    },
+    itemId: 'itemId',
+    layoutId: 'layoutId'
+  }
+];