Merge pull request #2 from prezly/feature/sdk

Feature - SDK

Author: markogresak

.gitignore

@@ -25,6 +25,8 @@ build/Release
 
 node_modules/
 
+/coverage
+
 # TypeScript cache
 *.tsbuildinfo
 

jest.config.js

@@ -5,4 +5,8 @@ module.exports = {
     },
     testEnvironment: 'node',
     setupFiles: ['<rootDir>/setupJest.ts'],
+    moduleNameMapper: {
+        '^Api$': '<rootDir>/src/Api',
+        '^types$': '<rootDir>/src/types',
+    },
 };

package.json

@@ -2,7 +2,7 @@
     "name": "@prezly/sdk",
     "version": "1.0.0",
     "description": "Prezly API SDK",
-    "main": "dist/sdk.js",
+    "main": "dist/index.js",
     "repository": {
         "type": "git",
         "url": "https://github.com/prezly/sdk.git"

src/Api/Api.ts

@@ -1,75 +1,71 @@
 import { Method, HeadersMap, Response } from './types';
 import createRequest from './createRequest';
 
+const withAccessToken = (headers: HeadersMap = {}, accessToken: string): HeadersMap => ({
+    ...headers,
+    'x-access-token': accessToken,
+});
+
+interface Params {
+    accessToken: string;
+    headers?: HeadersMap;
+    query?: object;
+}
+
+interface ParamsWithPayload extends Params {
+    payload?: object;
+}
+
 const Api = {
-    get: <P = any>(
-        url: string,
-        { query, headers }: { headers?: HeadersMap; query?: object } = {},
-    ): Promise<Response<P>> =>
+    get: <P = any>(url: string, { accessToken, headers, query }: Params): Promise<Response<P>> =>
         createRequest(url, {
+            headers: withAccessToken(headers, accessToken),
             method: Method.GET,
-            headers,
             query,
         }),
 
     post: <P = any>(
         url: string,
-        {
-            headers,
-            query,
-            payload,
-        }: { headers?: HeadersMap; query?: object; payload?: object } = {},
+        { accessToken, headers, payload, query }: ParamsWithPayload,
     ): Promise<Response<P>> =>
         createRequest(url, {
+            headers: withAccessToken(headers, accessToken),
             method: Method.POST,
-            headers,
-            query,
             payload,
+            query,
         }),
 
     put: <P = any>(
         url: string,
-        {
-            headers,
-            query,
-            payload,
-        }: { headers?: HeadersMap; query?: object; payload?: object } = {},
+        { accessToken, headers, payload, query }: ParamsWithPayload,
     ): Promise<Response<P>> =>
         createRequest(url, {
+            headers: withAccessToken(headers, accessToken),
             method: Method.PUT,
-            headers,
-            query,
             payload,
+            query,
         }),
 
     patch: <P = any>(
         url: string,
-        {
-            headers,
-            query,
-            payload,
-        }: { headers?: HeadersMap; query?: object; payload?: object } = {},
+        { accessToken, headers, payload, query }: ParamsWithPayload,
     ): Promise<Response<P>> =>
         createRequest(url, {
+            headers: withAccessToken(headers, accessToken),
             method: Method.PATCH,
-            headers,
-            query,
             payload,
+            query,
         }),
 
     delete: <P = any>(
         url: string,
-        {
-            headers,
-            query,
-            payload,
-        }: { headers?: HeadersMap; query?: object; payload?: object } = {},
+        { accessToken, headers, payload, query }: ParamsWithPayload,
     ): Promise<Response<P>> =>
         createRequest(url, {
+            headers: withAccessToken(headers, accessToken),
             method: Method.DELETE,
-            headers,
-            query,
             payload,
+            query,
         }),
 };
 

src/Sdk/Coverage/Coverage.ts

@@ -0,0 +1,55 @@
+import { Api } from 'Api';
+import { Coverage } from 'types';
+
+import { coverageUrl } from '../routing';
+import { getItemId } from '../utils';
+
+import { CoverageListResponse } from './types';
+
+interface Options {
+    accessToken: string;
+    baseUrl: string;
+}
+
+export default class CoverageSdk {
+    private readonly accessToken: string;
+    private readonly url: string;
+
+    constructor({ accessToken, baseUrl }: Options) {
+        this.accessToken = accessToken;
+        this.url = `${baseUrl}/${coverageUrl}`;
+    }
+
+    async list(): Promise<CoverageListResponse> {
+        const response = await Api.get<CoverageListResponse>(this.url, {
+            accessToken: this.accessToken,
+        });
+        return response.payload;
+    }
+
+    async get(itemOrItemId: string | Coverage): Promise<Coverage> {
+        const response = await Api.get<{ coverage: Coverage }>(this.getUrlWithId(itemOrItemId), {
+            accessToken: this.accessToken,
+        });
+        return response.payload.coverage;
+    }
+
+    async create(): Promise<Coverage> {
+        throw new Error('Not implemented!');
+    }
+
+    async update(): Promise<Coverage> {
+        throw new Error('Not implemented!');
+    }
+
+    async delete(itemOrItemId: string | Coverage): Promise<void> {
+        await Api.delete<{ coverage: Coverage }>(this.getUrlWithId(itemOrItemId), {
+            accessToken: this.accessToken,
+        });
+    }
+
+    private getUrlWithId(itemOrItemId: string | Coverage): string {
+        const itemId: string = getItemId<string, Coverage>(itemOrItemId);
+        return `${this.url}/${itemId}`;
+    }
+}

src/Sdk/Coverage/index.ts

@@ -0,0 +1 @@
+export { default as Coverage } from './Coverage';

src/Sdk/Coverage/types.ts

@@ -0,0 +1,7 @@
+import { Coverage, Pagination } from 'types';
+
+export interface CoverageListResponse {
+    coverage: Coverage[];
+    sort: string;
+    pagination: Pagination;
+}

src/Sdk/Sdk.ts

@@ -0,0 +1,15 @@
+import { Options } from './types';
+import { Coverage } from './Coverage';
+
+export const BASE_URL = 'https://api.prezly.com';
+
+export default class Sdk {
+    public coverage: Coverage;
+
+    constructor({ accessToken, baseUrl = BASE_URL }: Options) {
+        this.coverage = new Coverage({
+            accessToken,
+            baseUrl,
+        });
+    }
+}

src/Sdk/index.ts

@@ -0,0 +1 @@
+export { default as Sdk } from './Sdk';

src/Sdk/routing.ts

@@ -0,0 +1 @@
+export const coverageUrl = '/v2/coverage';