feat(apiv6): implemented closeChangeset

.github/workflows/lint.yml

@@ -25,4 +25,5 @@ jobs:
           github_token: ${{ secrets.github_token }}
           # Enable linters
           eslint: true
-          eslint_extensions: ts
+          prettier: true
+          eslint_extensions: ts

.github/workflows/tests.yml

@@ -20,4 +20,4 @@ jobs:
         run: npm ci
 
       - name: Run tests
-        run: npm run test
+        run: npm run test

.prettierrc.json

@@ -0,0 +1,7 @@
+{
+  "trailingComma": "es5",
+  "tabWidth": 2,
+  "printWidth": 150,
+  "semi": true,
+  "singleQuote": true
+}

README.md

@@ -1,2 +1,3 @@
 # node-osm-api
+
 easy communication with osm api

commitlint.config.js

@@ -1 +1 @@
-module.exports = { extends: ['@commitlint/config-conventional'] };
+module.exports = { extends: ['@commitlint/config-conventional'] };

package.json

@@ -35,23 +35,22 @@
     "http-status-codes": "^2.1.4"
   },
   "devDependencies": {
-    "@types/node": "^14.14.9",
     "@commitlint/config-conventional": "^11.0.0",
     "@map-colonies/eslint-config": "^1.1.0",
     "@types/chai": "^4.2.14",
     "@types/mocha": "^8.0.4",
     "@types/nock": "^11.1.0",
+    "@types/node": "^14.14.9",
     "@typescript-eslint/eslint-plugin": "^4.8.1",
     "@typescript-eslint/parser": "^4.8.1",
-    "@types/xml": "^1.0.5",
-    "typescript": "^4.1.2",
     "chai": "^4.2.0",
     "commitlint": "^11.0.0",
     "eslint": "^7.14.0",
     "husky": "^4.3.0",
     "mocha": "^8.2.1",
     "nock": "^13.0.5",
     "ts-node": "^9.0.0",
-    "xml": "^1.0.1"
+    "typescript": "^4.1.2",
+    "prettier": "^2.2.1"
   }
 }

src/api/v6/index.ts

@@ -1,35 +1,66 @@
 import axios, { AxiosError, AxiosInstance, AxiosResponse } from 'axios';
 import StatusCodes from 'http-status-codes';
-import { createChangesetEndPoint } from '../../lib/endpoints';
-import  { UnauthorizedError, BadXmlError, InternalServerError } from '../../lib/error-handler';
+import { createChangesetEndPoint, closeChangesetEndPoint } from '../../lib/endpoints';
+import {
+  UnauthorizedError,
+  BadXmlError,
+  ChangesetNotFoundError,
+  OwnerMismatchError,
+  NotAllowedError,
+  ChangesetAlreadyClosedError,
+} from '../../lib/errors';
+import { OWNER_MISMATCH } from '../../lib/constants';
 class Apiv6 {
-    private readonly httpClient: AxiosInstance;
-
-    public constructor(private readonly baseUrl: string, username: string, password: string) {
-        this.httpClient = axios.create({ baseURL: baseUrl, auth: { username, password } });
+  private readonly httpClient: AxiosInstance;
+
+  public constructor(private readonly baseUrl: string, username: string, password: string) {
+    this.httpClient = axios.create({
+      baseURL: baseUrl,
+      auth: { username, password },
+    });
+  }
+
+  public async createChangeset(data: string): Promise<number> {
+    let res: AxiosResponse<number>;
+    try {
+      res = await this.httpClient.put<number>(createChangesetEndPoint, data);
+    } catch (e) {
+      const axiosError = e as AxiosError;
+
+      if (axiosError.response?.status === StatusCodes.BAD_REQUEST) {
+        throw new BadXmlError(axiosError);
+      } else if (axiosError.response?.status === StatusCodes.UNAUTHORIZED) {
+        throw new UnauthorizedError(axiosError);
+      } else {
+        throw new Error(e);
+      }
     }
-
-    public async createChangeset(data: string): Promise<number> {
-        let res: AxiosResponse<number>;
-        try {
-            res = await this.httpClient.put<number>(createChangesetEndPoint, data);
-        } 
-        catch (e) {
-            const axiosError = e as AxiosError;
+    const { data: changeSetId } = res;
+    return changeSetId;
+  }
+
+  public async closeChangeset(id: number): Promise<void> {
+    try {
+      await this.httpClient.put<number>(closeChangesetEndPoint(id));
+    } catch (e) {
+      const axiosError = e as AxiosError;
 
-            if (axiosError.response?.status === StatusCodes.BAD_REQUEST) {
-                throw new BadXmlError(axiosError);
-            } else if (axiosError.response?.status === StatusCodes.UNAUTHORIZED) {
-                throw new UnauthorizedError(axiosError); 
-            } else if (axiosError.response?.status === StatusCodes.INTERNAL_SERVER_ERROR) {
-                throw new InternalServerError(axiosError);
-            } else {
-                throw new Error(e);
-            }
+      if (axiosError.response?.status === StatusCodes.UNAUTHORIZED) {
+        throw new UnauthorizedError(axiosError);
+      } else if (axiosError.response?.status === StatusCodes.METHOD_NOT_ALLOWED) {
+        throw new NotAllowedError(axiosError);
+      } else if (axiosError.response?.status === StatusCodes.NOT_FOUND) {
+        throw new ChangesetNotFoundError(axiosError);
+      } else if (axiosError.response?.status === StatusCodes.CONFLICT) {
+        if (axiosError.response.data === OWNER_MISMATCH) {
+          throw new OwnerMismatchError(axiosError);
         }
-        const { data: changeSetId } = res;
-        return changeSetId;
+        throw new ChangesetAlreadyClosedError(axiosError);
+      } else {
+        throw new Error(e);
+      }
     }
+  }
 }
 
-export default Apiv6;
+export default Apiv6;

src/index.ts

@@ -1,3 +1,3 @@
 import Apiv6 from './api/v6';
 
-export default Apiv6;
+export default Apiv6;

src/lib/constants.ts

@@ -0,0 +1 @@
+export const OWNER_MISMATCH = "The user doesn't own that changeset";

src/lib/endpoints.ts

@@ -1 +1,2 @@
-export const createChangesetEndPoint = '/api/0.6/changeset/create';
+export const createChangesetEndPoint = '/api/0.6/changeset/create';
+export const closeChangesetEndPoint = (id: number): string => `/api/0.6/changeset/${id}/close`;

src/lib/errors.ts

@@ -0,0 +1,50 @@
+import { AxiosError } from 'axios';
+
+class HttpErrorHandler extends Error {
+  public constructor(error: AxiosError) {
+    super(error.response?.data);
+    Object.setPrototypeOf(this, HttpErrorHandler.prototype);
+  }
+}
+
+export class UnauthorizedError extends HttpErrorHandler {
+  public constructor(error: AxiosError) {
+    super(error);
+    Object.setPrototypeOf(this, UnauthorizedError.prototype);
+  }
+}
+
+export class BadXmlError extends HttpErrorHandler {
+  public constructor(error: AxiosError) {
+    super(error);
+    Object.setPrototypeOf(this, BadXmlError.prototype);
+  }
+}
+
+export class ChangesetNotFoundError extends HttpErrorHandler {
+  public constructor(error: AxiosError) {
+    super(error);
+    Object.setPrototypeOf(this, ChangesetNotFoundError.prototype);
+  }
+}
+
+export class ChangesetAlreadyClosedError extends HttpErrorHandler {
+  public constructor(error: AxiosError) {
+    super(error);
+    Object.setPrototypeOf(this, ChangesetAlreadyClosedError.prototype);
+  }
+}
+
+export class OwnerMismatchError extends HttpErrorHandler {
+  public constructor(error: AxiosError) {
+    super(error);
+    Object.setPrototypeOf(this, OwnerMismatchError.prototype);
+  }
+}
+
+export class NotAllowedError extends HttpErrorHandler {
+  public constructor(error: AxiosError) {
+    super(error);
+    Object.setPrototypeOf(this, NotAllowedError.prototype);
+  }
+}