feat: entities endpoint (#147)

Author: Highjhacker

__tests__/mocks/entities.ts

@@ -0,0 +1,15 @@
+import nock from "nock";
+
+export const mockEntities = (host: string) => {
+    nock(host)
+        .get("/entities")
+        .reply(200, {
+            data: [],
+        });
+
+    nock(host)
+        .get("/entities/123")
+        .reply(200, {
+            data: [],
+        });
+};

__tests__/mocks/index.ts

@@ -2,6 +2,7 @@ import { Connection } from "../../src";
 
 import { mockBlocks } from "./blocks";
 import { mockDelegates } from "./delegates";
+import { mockEntities } from "./entities";
 import { mockLocks } from "./locks";
 import { mockNode } from "./node";
 import { mockPeers } from "./peers";
@@ -16,6 +17,7 @@ export const configureMocks = <T>(resource): T => {
 
 	mockBlocks(host);
 	mockDelegates(host);
+	mockEntities(host);
 	mockLocks(host);
 	mockNode(host);
 	mockPeers(host);

__tests__/resources/entities.test.ts

@@ -0,0 +1,18 @@
+import { Entities } from "../../src/resources/entities";
+import { configureMocks } from "../mocks";
+
+const resource: Entities = configureMocks<Entities>(Entities);
+
+describe("API - 2.0 - Resources - Entities", () => {
+  it("should call \"all\" method", async () => {
+    const response = await resource.all();
+
+    expect(response.status).toBe(200);
+  });
+
+  it("should call \"get\" method", async () => {
+    const response = await resource.get("123");
+
+    expect(response.status).toBe(200);
+  });
+});

src/resources/entities.ts

@@ -0,0 +1,26 @@
+import { ApiResponse, ApiResponseWithPagination } from "../interfaces";
+import {
+    AllEntitiesApiQuery,
+    Entity,
+} from "../resourcesTypes/entities";
+import { Resource } from "./resource";
+
+/**
+ * This endpoints return Entities.
+ */
+export class Entities extends Resource {
+    /**
+     * List all entities
+     */
+    public async all(query?: AllEntitiesApiQuery): Promise<ApiResponseWithPagination<Entity[]>> {
+        return this.sendGet("entities", query);
+    }
+
+    /**
+     * Return entity by id
+     * @param id Entity id
+     */
+    public async get(id: string): Promise<ApiResponse<Entity>> {
+        return this.sendGet(`entities/${id}`);
+    }
+}

src/resources/index.ts

@@ -1,5 +1,6 @@
 import { Blocks } from "./blocks";
 import { Delegates } from "./delegates";
+import { Entities } from "./entities";
 import { Locks } from "./locks";
 import { Node } from "./node";
 import { Peers } from "./peers";
@@ -14,6 +15,7 @@ export * from "./resource";
 export const Resources = {
 	blocks: Blocks,
 	delegates: Delegates,
+	entities: Entities,
 	locks: Locks,
 	node: Node,
 	peers: Peers,

src/resourcesTypes/entities.ts

@@ -0,0 +1,24 @@
+import { ApiQuery } from "../interfaces";
+
+export interface Entity {
+    id?: string;
+    address?: string;
+    publicKey?: string;
+    isResigned?: boolean;
+    type?: number;
+    subType?: number;
+    data: {
+        name?: string;
+        ipfsData?: string;
+    };
+}
+
+export interface AllEntitiesApiQuery extends ApiQuery {
+    /** Type by which it orders entities. */
+    orderBy?: string;
+    publicKey?: string;
+    type?: number;
+    subType?: number;
+    name?: string;
+    isResigned?: boolean;
+}

src/resourcesTypes/index.ts

@@ -1,5 +1,6 @@
 export * from "./blocks";
 export * from "./delegates";
+export * from "./entities";
 export * from "./locks";
 export * from "./node";
 export * from "./peers";