chore: add wrapper class (#26)

* add wrapper class

* add jsdoc comment

* rename file to `asyncapidiff.ts`

* rename variables

Author: aayushmau5

package.json

@@ -8,6 +8,7 @@
     "start": "tsc --watch",
     "build": "tsc",
     "test": "jest",
+    "test:coverage": "jest --coverage",
     "test:watch": "jest --watch",
     "lint": "eslint --max-warnings 0 --config .eslintrc .",
     "lint:fix": "eslint --max-warnings 0 --config .eslintrc . --fix",

src/asyncapidiff.ts

@@ -0,0 +1,43 @@
+import { Output, DiffOutputItem } from './types';
+
+/**
+ * Implements functions to deal with the diff.
+ * @class
+ * @returns {AsyncAPIDiff}
+ */
+export default class AsyncAPIDiff {
+  private output: Output;
+
+  constructor(output: string) {
+    // output is a stringified JSON
+    this.output= JSON.parse(output);
+  }
+
+  /**
+   * @returns All the breaking changes
+   */
+  breaking(): DiffOutputItem[] {
+    return this.output.changes.filter((diff) => diff.type === 'breaking');
+  }
+
+  /**
+   * @returns All the non-breaking changes
+   */
+  nonBreaking(): DiffOutputItem[] {
+    return this.output.changes.filter((diff) => diff.type === 'non-breaking');
+  }
+
+  /**
+   * @returns All the unclassified changes
+   */
+  unclassified(): DiffOutputItem[] {
+    return this.output.changes.filter((diff) => diff.type === 'unclassified');
+  }
+
+  /**
+   * @returns The JSON output
+   */
+  getOutput(): Output {
+    return this.output;
+  }
+}

test/asycnapidiff.spec.ts

@@ -0,0 +1,36 @@
+import AsyncAPIDiff from '../src/asyncapidiff';
+
+import {
+  breakingChanges,
+  inputDiff,
+  nonbreakingChanges,
+  unclassifiedChanges,
+} from './fixtures/asyncapidiff.fixtures';
+
+describe('AsyncAPIDiff wrapper', () => {
+  test('checks the instance', () => {
+    expect(new AsyncAPIDiff(JSON.stringify(inputDiff))).toBeInstanceOf(
+      AsyncAPIDiff
+    );
+  });
+
+  test('checks the original output', () => {
+    const diff = new AsyncAPIDiff(JSON.stringify(inputDiff));
+    expect(diff.getOutput()).toEqual(inputDiff);
+  });
+
+  test('returns breaking changes', () => {
+    const diff = new AsyncAPIDiff(JSON.stringify(inputDiff));
+    expect(diff.breaking()).toEqual(breakingChanges);
+  });
+
+  test('returns non-breaking changes', () => {
+    const diff = new AsyncAPIDiff(JSON.stringify(inputDiff));
+    expect(diff.nonBreaking()).toEqual(nonbreakingChanges);
+  });
+
+  test('returns unclassified changes', () => {
+    const diff = new AsyncAPIDiff(JSON.stringify(inputDiff));
+    expect(diff.unclassified()).toEqual(unclassifiedChanges);
+  });
+});

test/fixtures/asyncapidiff.fixtures.ts

@@ -0,0 +1,37 @@
+export const inputDiff = {
+  changes: [
+    {
+      type: 'breaking',
+      path: '/servers',
+    },
+    {
+      type: 'non-breaking',
+      path: '/channels',
+    },
+    {
+      type: 'unclassified',
+      path: '/info',
+    },
+  ],
+};
+
+export const breakingChanges = [
+  {
+    type: 'breaking',
+    path: '/servers',
+  },
+];
+
+export const nonbreakingChanges = [
+  {
+    type: 'non-breaking',
+    path: '/channels',
+  },
+];
+
+export const unclassifiedChanges = [
+  {
+    type: 'unclassified',
+    path: '/info',
+  },
+];