Merge pull request #5 from js-items/develop

fix: added new enveloped and paginated interfaces

dist/interfaces/EnvelopedResponse.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="node" />
+import { OutgoingHttpHeaders } from "http";
+export interface EnvelopedResponse<T> {
+    readonly status: number;
+    readonly body: T;
+    readonly headers: OutgoingHttpHeaders;
+}

dist/interfaces/PaginatedResults.d.ts

@@ -0,0 +1,12 @@
+import Item from './Item';
+export interface PaginationMetadata {
+    readonly hasAfter: boolean;
+    readonly hasBefore: boolean;
+    readonly after: string | null;
+    readonly before: string | null;
+    readonly totalCount: number;
+}
+export interface PaginatedResponse<I extends Item> {
+    readonly data: I[];
+    readonly pagination: PaginationMetadata;
+}

dist/interfaces/cursorResult.d.ts

@@ -4,4 +4,5 @@ export default interface CursorResult {
     readonly after: Cursor;
     readonly hasBefore: boolean;
     readonly hasAfter: boolean;
+    readonly totalCount?: number;
 }

src/interfaces/CursorResult.ts

@@ -5,4 +5,5 @@ export default interface CursorResult {
   readonly after: Cursor;
   readonly hasBefore: boolean;
   readonly hasAfter: boolean;
+  readonly totalCount?: number;
 }

src/interfaces/EnvelopedResponse.ts

@@ -0,0 +1,7 @@
+import { OutgoingHttpHeaders } from "http";
+
+export interface EnvelopedResponse<T> {
+  readonly status: number;
+  readonly body: T;
+  readonly headers: OutgoingHttpHeaders;
+}

src/interfaces/PaginatedResults.ts

@@ -0,0 +1,13 @@
+import Item from './Item';
+
+export interface PaginationMetadata {
+  readonly hasAfter: boolean;
+  readonly hasBefore: boolean;
+  readonly after: string | null;
+  readonly before: string | null;
+  readonly totalCount: number;
+}
+export interface PaginatedResponse<I extends Item> {
+  readonly data: I[];
+  readonly pagination: PaginationMetadata;
+}