Merge pull request #2 from wintondeshong/master

RouteUtils, ServiceUtils, Testing actors, and more types

Author: wintondeshong

package-lock.json

@@ -8,6 +8,7 @@
         "url": "https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/issues"
     },
     "dependencies": {
+        "axios": "0.19.2",
         "immutable": "4.0.0-rc.12"
     },
     "description": "Common patterns, functions, etc... used when building react applications",

package.json

@@ -0,0 +1,17 @@
+export default {
+    defaults: {
+        headers: {
+            post: {},
+            put: {},
+        },
+    },
+    delete: jest.fn(() => Promise.resolve({ data: {} })),
+    get: jest.fn(() => Promise.resolve({ data: {} })),
+    interceptors: {
+        response: {
+            use: jest.fn(),
+        },
+    },
+    post: jest.fn(() => Promise.resolve({ data: {} })),
+    put: jest.fn(() => Promise.resolve({ data: {} })),
+};

src/__mocks__/axios.ts

@@ -0,0 +1,10 @@
+enum ContentType {
+    Css = "text/css",
+    Html = "text/html",
+    Javascript = "text/javascript",
+    Json = "application/json",
+    Pdf = "application/pdf",
+    Xml = "application/xml",
+}
+
+export { ContentType };

src/enumerations/content-type.ts

@@ -0,0 +1,6 @@
+enum HttpHeader {
+    Accept = "Accept",
+    ContentType = "Content-Type",
+}
+
+export { HttpHeader };

src/enumerations/http-header.ts

@@ -0,0 +1,9 @@
+enum HttpVerb {
+    Delete = "DELETE",
+    Get = "GET",
+    Patch = "PATCH",
+    Post = "POST",
+    Put = "PUT",
+}
+
+export { HttpVerb };

src/enumerations/http-verb.ts

@@ -2,7 +2,10 @@
 // #region Enumerations
 // -----------------------------------------------------------------------------------------
 
+export * from "./enumerations/content-type";
 export * from "./enumerations/error-type";
+export * from "./enumerations/http-header";
+export * from "./enumerations/http-verb";
 
 //#endregion Enumerations
 
@@ -13,16 +16,38 @@ export * from "./enumerations/error-type";
 export * from "./interfaces/paged-result";
 export * from "./interfaces/result";
 export * from "./interfaces/result-error";
+export * from "./interfaces/service-response";
 
 //#endregion Interfaces
 
+// -----------------------------------------------------------------------------------------
+// #region Tests
+// -----------------------------------------------------------------------------------------
+
+// factories
+export * from "./tests/factories/axios-response-factory";
+export * from "./tests/factories/factory-type";
+export * from "./tests/factories/stub-resource-record-factory";
+
+// mocks
+export * from "./__mocks__/axios";
+export * from "./tests/mocks/mock-axios";
+
+// stubs
+export * from "./tests/stubs/stub-resource";
+export * from "./tests/stubs/stub-resource-record";
+
+//#endregion Tests
+
 // -----------------------------------------------------------------------------------------
 // #region Utilities
 // -----------------------------------------------------------------------------------------
 
 export * from "./utilities/collection-utils";
 export * from "./utilities/core-utils";
 export * from "./utilities/promise-factory";
+export * from "./utilities/route-utils";
+export * from "./utilities/service-utils";
 export * from "./utilities/string-utils";
 
 //#endregion Utilities

src/index.ts

@@ -0,0 +1,30 @@
+import { ResultRecord } from "../view-models/result-record";
+
+interface ServiceResponse<T> {
+    /**
+     * Result object containing detailed response information,
+     * such as; errors, result data, etc...
+     */
+    result?: ResultRecord<T>;
+    results?: ResultRecord<T[]>;
+
+    /**
+     * Convenience property to read result's nested record
+     */
+    resultObject?: T;
+    resultObjects?: T[];
+
+    /**
+     * Totoal possible records available for the initial service request. If greater
+     * than total results in this response, additional pages of results can be
+     * requested from the API
+     */
+    rowCount: number;
+
+    /**
+     * HTTP status code of the response
+     */
+    status: number;
+}
+
+export { ServiceResponse };

src/interfaces/service-response.ts

@@ -0,0 +1,23 @@
+import { Factory } from "rosie";
+import { FactoryType } from "./factory-type";
+import { AxiosResponse } from "axios";
+
+// -----------------------------------------------------------------------------------------
+// #region Factory
+// -----------------------------------------------------------------------------------------
+
+const AxiosResponseFactory = Factory.define<AxiosResponse>(
+    FactoryType.AxiosResponse
+)
+    .sequence("status", () => 200)
+    .sequence("statusText", () => "OK");
+
+// #endregion Factory
+
+// -----------------------------------------------------------------------------------------
+// #region Export
+// -----------------------------------------------------------------------------------------
+
+export { AxiosResponseFactory };
+
+// #endregion Export

src/tests/factories/axios-response-factory.ts

@@ -0,0 +1,6 @@
+const FactoryType = {
+    AxiosResponse: "AxiosResponse",
+    StubResourceRecord: "StubResourceRecord",
+};
+
+export { FactoryType };