@cntrl-site/sdk 0.7.2 → 1.0.0

package/lib/Client/Client.js

@@ -8,15 +8,14 @@ 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() {
@@ -38,8 +37,9 @@ class Client {
             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 article = core_1.ArticleSchema.parse(articleData.article);
+            const keyframes = core_1.KeyframesSchema.parse(articleData.keyframes);
+            return { article, keyframes };
         }
         catch (e) {
             throw e;
@@ -51,12 +51,6 @@ 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,
@@ -67,41 +61,49 @@ class Client {
         } : projectMeta;
     }
     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;
     }
     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;
-    }
     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;
     }
     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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cntrl-site/sdk",
-  "version": "0.7.2",
+  "version": "1.0.0",
   "description": "Generic SDK for use in public websites.",
   "main": "lib/index.js",
   "types": "src/index.ts",

package/src/Client/Client.test.ts

@@ -7,42 +7,45 @@ import { keyframesMock } from './__mock__/keyframesMock';
 
 describe('Client', () => {
   it('returns project', async () => {
+    const projectId = 'MY_PROJECT_ID';
+    const apiKey = 'MY_API_KEY';
     let fetchCalledTimes = 0;
-    const projectId = 'projectId';
-    const apiUrl = 'https://api.cntrl.site/';
+    const apiUrl = `https://${projectId}:${apiKey}@api.cntrl.site/`;
     const fetch = async (url: string) => {
       fetchCalledTimes += 1;
-      expect(url).toBe(`${apiUrl}projects/${projectId}`);
+      expect(url).toBe(`https://api.cntrl.site/projects/${projectId}`);
       return Promise.resolve({
         ok: true,
         json: () => Promise.resolve(projectMock),
         statusText: ''
       });
     };
-    const client = new Client(projectId, apiUrl, fetch);
+    const client = new Client(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 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.getProject()).rejects.toEqual(new Error('Failed to fetch project with id #projectId: reason'));
+    const client = new Client(apiUrl, fetch);
+    await expect(client.getProject()).rejects.toEqual(new Error('Failed to fetch project with id #MY_PROJECT_ID: reason'));
   });
 
   it('returns article by page slug', async () => {
     let fetchCalledTimes = 0;
-    const projectId = 'projectId';
-    const apiUrl = 'https://api.cntrl.site/';
-    const projectApiUrl = `${apiUrl}projects/projectId`;
-    const articleApiUrl = `${apiUrl}articles/articleId`;
+    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 articleApiUrl = `https://api.cntrl.site/projects/${projectId}/articles/articleId`;
     const fetch = async (url: string) => {
       fetchCalledTimes += 1;
       if (fetchCalledTimes === 1) {
@@ -53,33 +56,36 @@ describe('Client', () => {
       }
       return Promise.resolve({
         ok: true,
-        json: () => Promise.resolve(url === projectApiUrl ? projectMock : articleMock),
+        json: () => Promise.resolve(url === projectApiUrl ? projectMock : { article: articleMock, keyframes: keyframesMock }),
         statusText: ''
       });
     };
-    const client = new Client(projectId, apiUrl, fetch);
-    const article = await client.getPageArticle('/');
+    const client = new Client(apiUrl, fetch);
+    const { article, keyframes } = await client.getPageArticle('/');
     expect(fetchCalledTimes).toBe(2);
     expect(article).toEqual(articleMock);
+    expect(keyframes).toEqual(keyframesMock);
   });
 
   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/';
+    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);
+    const client = new Client(apiUrl, fetch);
     await expect(client.getPageArticle('/'))
-      .rejects.toEqual(new Error('Failed to fetch project with id #projectId: reason'));
+      .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 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 fetch = (url: string) => {
       return Promise.resolve({
         ok: url === projectApiUrl,
@@ -87,15 +93,16 @@ describe('Client', () => {
         statusText: 'reason'
       });
     };
-    const client = new Client(projectId, apiUrl, fetch);
+    const client = new Client(apiUrl, fetch);
     await expect(client.getPageArticle('/'))
       .rejects.toEqual(new Error('Failed to fetch article with id #articleId: 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,33 +111,35 @@ describe('Client', () => {
         statusText: 'reason'
       });
     };
-    const client = new Client(projectId, apiUrl, fetch);
+    const client = new Client(apiUrl, fetch);
     await expect(client.getPageArticle(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 projectId = 'MY_PROJECT_ID';
+    const apiKey = 'MY_API_KEY';
+    const apiUrl = `https://${projectId}:${apiKey}@api.cntrl.site/`;
     const fetch = (url: string) => {
       fetchCalledTimes += 1;
-      expect(url).toBe(`${apiUrl}projects/${projectId}/type-presets`);
+      expect(url).toBe(`https://api.cntrl.site/projects/${projectId}/type-presets`);
       return Promise.resolve({
         ok: true,
         json: () => Promise.resolve(typePresetsMock),
         statusText: ''
       });
     };
-    const client = new Client(projectId, apiUrl, fetch);
+    const client = new Client(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 projectId = 'MY_PROJECT_ID';
+    const apiKey = 'MY_API_KEY';
+    const apiUrl = `https://${projectId}:${apiKey}@api.cntrl.site/`;
     const fetch = () => {
       return Promise.resolve({
         ok: false,
@@ -138,49 +147,12 @@ describe('Client', () => {
         statusText: 'reason'
       });
     };
-    const client = new Client(projectId, apiUrl, fetch);
+    const client = new Client(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,
@@ -219,4 +191,20 @@ describe('Client', () => {
     expect(meta.description).toBeUndefined();
     expect(meta.title).toBeUndefined();
   });
+
+  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.'));
+  });
 });

package/src/Client/Client.ts

@@ -15,16 +15,17 @@ 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.');
     }
   }
 
@@ -39,7 +40,7 @@ export class Client {
     }
   }
 
-  async getPageArticle(pageSlug: string): Promise<TArticle> {
+  async getPageArticle(pageSlug: string): Promise<{ article: TArticle, keyframes: TKeyframeAny[] }> {
     try {
       const projectResponse = await this.fetchProject();
       const data = await projectResponse.json();
@@ -47,8 +48,9 @@ export class Client {
       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 article = ArticleSchema.parse(articleData.article);
+      const keyframes = KeyframesSchema.parse(articleData.keyframes);
+      return { article, keyframes };
     } catch (e) {
       throw e;
     }
@@ -61,13 +63,6 @@ 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,
@@ -79,47 +74,54 @@ export class Client {
   }
 
   private async fetchProject(): Promise<FetchImplResponse> {
-    const url = new 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(`/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;
   }
 
   private async fetchArticle(articleId: string): Promise<FetchImplResponse> {
-    const url = new URL(`/articles/${articleId}`, this.APIUrl);
-    const response = await this.fetchImpl(url.href);
+    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 article with id #${articleId}: ${response.statusText}`);
     }
     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);
+    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;
   }
 
   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 +133,4 @@ interface FetchImplResponse {
   statusText: string;
 }
 
-type FetchImpl = (url: string) => Promise<FetchImplResponse>;
+type FetchImpl = (url: string, init?: RequestInit) => Promise<FetchImplResponse>;