refactor: ServiceBuilder methods rename

src/baseService.ts

@@ -55,7 +55,7 @@ export class BaseService {
         configurable: true,
         get() {
           return (...args: any[]) => {
-            if (serviceBuilder.inlineResponseBody) {
+            if (serviceBuilder.withInlineResponseBody) {
               return self._wrapToInlinedResponse(methodName, args);
             } else {
               return self._wrapToAxiosResponse(methodName, args);

src/index.ts

@@ -1,2 +1,4 @@
 export * from "./baseService";
 export * from "./decorators";
+
+//export {BaseService} from "./baseService";

src/service.builder.ts

@@ -11,15 +11,15 @@ export class ServiceBuilder {
   private _standalone: boolean | AxiosInstance = false;
   private _requestInterceptors: Array<RequestInterceptorFunction | RequestInterceptor> = [];
   private _responseInterceptors: Array<ResponseInterceptorFunction | ResponseInterceptor> = [];
-  private _inlineResponseBody = false;
+  private _withInlineResponseBody = false;
   private _shouldSaveRequestHistory = false;
   private _timeout = 60000;
 
   public build<T>(service: new (builder: ServiceBuilder) => T): T {
     return new service(this);
   }
 
-  public setEndpoint(endpoint: string): ServiceBuilder {
+  public baseUrl(endpoint: string): ServiceBuilder {
     this._endpoint = endpoint;
     return this;
   }
@@ -48,8 +48,8 @@ export class ServiceBuilder {
     return this;
   }
 
-  public onlyResponseBody(): ServiceBuilder {
-    this._inlineResponseBody = true;
+  public inlineResponseBody(): ServiceBuilder {
+    this._withInlineResponseBody = true;
     return this;
   }
 
@@ -62,8 +62,8 @@ export class ServiceBuilder {
     return this._shouldSaveRequestHistory;
   }
 
-  get inlineResponseBody(): boolean {
-    return this._inlineResponseBody;
+  get withInlineResponseBody(): boolean {
+    return this._withInlineResponseBody;
   }
 
   get endpoint(): string {

tests/test/decorators/decorators.formurlencoded.test.ts

@@ -7,7 +7,7 @@ describe("Decorators - @FormUrlEncoded", () => {
   let service: FormUrlEncodedService;
 
   beforeAll(() => {
-    service = new ServiceBuilder().setEndpoint(testServer.url).build(FormUrlEncodedService);
+    service = new ServiceBuilder().baseUrl(testServer.url).build(FormUrlEncodedService);
   });
 
   const object = {

tests/test/decorators/decorators.multipart.test.ts

@@ -6,7 +6,7 @@ import { FileService, MessagingService } from "../../fixture/fixtures.multipart"
 
 describe("Decorators - Multipart", () => {
   test("@Multipart", async () => {
-    const fileService = new ServiceBuilder().setEndpoint(testServer.url).build(FileService);
+    const fileService = new ServiceBuilder().baseUrl(testServer.url).build(FileService);
     const bucket = {
       value: "test-bucket",
     };
@@ -19,15 +19,15 @@ describe("Decorators - Multipart", () => {
   });
 
   test("@Multipart - test2", async () => {
-    const messagingService = new ServiceBuilder().setEndpoint(testServer.url).build(MessagingService);
+    const messagingService = new ServiceBuilder().baseUrl(testServer.url).build(MessagingService);
     const from = { value: "+11111111" };
     const to = { value: ["+22222222", "+33333333"] };
     const response = await messagingService.createSMS(from, to);
     expect(response.config.headers[CONTENT_TYPE_HEADER]).toContain(CONTENT_TYPE.MULTIPART_FORM_DATA);
   });
 
   test("@ResponseType", async () => {
-    const fileService = new ServiceBuilder().setEndpoint(testServer.url).build(FileService);
+    const fileService = new ServiceBuilder().baseUrl(testServer.url).build(FileService);
     const response = await fileService.getFile("x-y-z");
     expect(response.config.responseType).toEqual("stream");
   });

tests/test/decorators/decorators.test.ts

@@ -8,7 +8,7 @@ describe("Decorators", () => {
   let service: PostsApiService;
 
   beforeAll(() => {
-    service = new ServiceBuilder().setEndpoint(testServer.url).build(PostsApiService);
+    service = new ServiceBuilder().baseUrl(testServer.url).build(PostsApiService);
   });
 
   test("@BasePath", async () => {
@@ -24,7 +24,7 @@ describe("Decorators", () => {
   });
 
   test("@GET - without base path", async () => {
-    const service = new ServiceBuilder().setEndpoint(testServer.url).build(ServiceWithoutBasePath);
+    const service = new ServiceBuilder().baseUrl(testServer.url).build(ServiceWithoutBasePath);
     const response = await service.get();
 
     expect(response.data).toHaveLength(posts.length);
@@ -40,7 +40,7 @@ describe("Decorators", () => {
   });
 
   test("@GET - Absolute url", async () => {
-    const service = new ServiceBuilder().setEndpoint(JSONPLACEHOLDER_URL).build(PostsApiService);
+    const service = new ServiceBuilder().baseUrl(JSONPLACEHOLDER_URL).build(PostsApiService);
     const response = await service.getAbsoluteUrl();
     expect(response.data).toHaveLength(100);
     verifyRequest(response, "get", "/posts");

tests/test/decorators/decorators.timeout.test.ts

@@ -4,12 +4,12 @@ import { testServer } from "../../testHelpers";
 
 describe("Decorators - timeout", () => {
   test("@Timeout", async () => {
-    const service = new ServiceBuilder().setEndpoint(testServer.url).build(TimeoutService);
+    const service = new ServiceBuilder().baseUrl(testServer.url).build(TimeoutService);
     await expect(service.timeoutIn3000()).rejects.toThrow(/timeout/);
   });
 
   test("The timeout in `@Timeout` decorator should shield the value in `setTimeout` method.", async () => {
-    const service = new ServiceBuilder().setEndpoint(testServer.url).setTimeout(3000).build(TimeoutService);
+    const service = new ServiceBuilder().baseUrl(testServer.url).setTimeout(3000).build(TimeoutService);
     const response = await service.timeoutIn6000();
     expect(response.config.timeout).toEqual(6000);
     expect(response.data).toEqual({});

tests/test/decorators/decorators.wrong-cases.test.ts

@@ -12,7 +12,7 @@ import { Post, posts } from "../../fixture/fixtures";
 
 describe("Decorators - wrong cases", () => {
   describe("Headers", () => {
-    const service = new ServiceBuilder().setEndpoint(testServer.url).build(WrongHeaderService);
+    const service = new ServiceBuilder().baseUrl(testServer.url).build(WrongHeaderService);
 
     describe("@HeaderMap", () => {
       test("Empty header key", async () => {
@@ -54,7 +54,7 @@ describe("Decorators - wrong cases", () => {
   });
 
   describe("Fields", () => {
-    const service = new ServiceBuilder().setEndpoint(testServer.url).build(WrongFieldService);
+    const service = new ServiceBuilder().baseUrl(testServer.url).build(WrongFieldService);
 
     describe("@FieldMap", () => {
       test("Empty field key", async () => {
@@ -76,7 +76,7 @@ describe("Decorators - wrong cases", () => {
   });
 
   describe("Multipart", () => {
-    const service = new ServiceBuilder().setEndpoint(testServer.url).build(WrongMultipartService);
+    const service = new ServiceBuilder().baseUrl(testServer.url).build(WrongMultipartService);
 
     test("Empty part key", async () => {
       const bucket = {
@@ -89,7 +89,7 @@ describe("Decorators - wrong cases", () => {
   });
 
   describe("Query params", () => {
-    const service = new ServiceBuilder().setEndpoint(testServer.url).build(WrongQueryService);
+    const service = new ServiceBuilder().baseUrl(testServer.url).build(WrongQueryService);
 
     describe("@QueryMap", () => {
       test("Empty header key", async () => {
@@ -131,7 +131,7 @@ describe("Decorators - wrong cases", () => {
   });
 
   describe("No Http decorator", () => {
-    const noHttpMethodService = new ServiceBuilder().setEndpoint(testServer.url).build(NoHttpMethodService);
+    const noHttpMethodService = new ServiceBuilder().baseUrl(testServer.url).build(NoHttpMethodService);
 
     describe("Works fine with not decorated methods", () => {
       test("No params", async () => {
@@ -190,7 +190,7 @@ describe("Decorators - wrong cases", () => {
   });
 
   test("__getLastRequest - empty", async () => {
-    const anyService = new ServiceBuilder().setEndpoint(testServer.url).build(NoHttpMethodService);
+    const anyService = new ServiceBuilder().baseUrl(testServer.url).build(NoHttpMethodService);
     await verifyErrorThrown(async () => {
       await anyService.__getLastRequest();
     }, ErrorMessages.__TEST_NO_REQUESTS_IN_HISTORY);

tests/test/decorators/inlined-response/decorators.inlined.test.ts

@@ -16,8 +16,8 @@ describe("Decorators - inlined response", () => {
   beforeEach(() => {
     service = new ServiceBuilder()
       .saveRequestHistory()
-      .setEndpoint(testServer.url)
-      .onlyResponseBody()
+      .baseUrl(testServer.url)
+      .inlineResponseBody()
       .build(ResponseBodyPostsApiService);
   });
 
@@ -40,7 +40,7 @@ describe("Decorators - inlined response", () => {
   });
 
   test("@GET - without base path", async () => {
-    const service = new ServiceBuilder().setEndpoint(testServer.url).build(ServiceWithoutBasePath);
+    const service = new ServiceBuilder().baseUrl(testServer.url).build(ServiceWithoutBasePath);
     const response = await service.get();
 
     expect(response.data).toHaveLength(posts.length);
@@ -56,7 +56,7 @@ describe("Decorators - inlined response", () => {
   });
 
   test("@GET - Absolute url", async () => {
-    const service = new ServiceBuilder().setEndpoint(JSONPLACEHOLDER_URL).build(PostsApiService);
+    const service = new ServiceBuilder().baseUrl(JSONPLACEHOLDER_URL).build(PostsApiService);
     const response = await service.getAbsoluteUrl();
     expect(response.data).toHaveLength(100);
     verifyRequest(response, "get", "/posts");

tests/test/interceptors/request-interceptors.test.ts

@@ -28,7 +28,7 @@ describe("Request interceptors", () => {
   });
 
   async function verifyInterceptor(setInterceptor: (builder: ServiceBuilder) => void) {
-    const builder = new ServiceBuilder().setEndpoint(testServer.url);
+    const builder = new ServiceBuilder().baseUrl(testServer.url);
     setInterceptor(builder);
     const service = builder.build(PostsApiService);
 

tests/test/interceptors/response-interceptors.test.ts

@@ -47,7 +47,7 @@ describe("Response interceptors", () => {
       const spy = jest.spyOn(interceptor, "onRejected");
 
       const service = new ServiceBuilder()
-        .setEndpoint(testServer.url)
+        .baseUrl(testServer.url)
         .setResponseInterceptors(interceptor)
         .setStandalone(true)
         .build(PostsApiService);
@@ -69,7 +69,7 @@ describe("Response interceptors", () => {
       const spy = jest.spyOn(interceptor, "onRejected");
 
       const service = new ServiceBuilder()
-        .setEndpoint(testServer.url)
+        .baseUrl(testServer.url)
         .setStandalone(true)
         .setResponseInterceptors(interceptor)
         .build(PostsApiService);
@@ -81,7 +81,7 @@ describe("Response interceptors", () => {
   });
 
   async function verifyInterceptor(setInterceptor: (builder: ServiceBuilder) => void) {
-    const builder = new ServiceBuilder().setEndpoint(testServer.url).setStandalone(true);
+    const builder = new ServiceBuilder().baseUrl(testServer.url).setStandalone(true);
 
     setInterceptor(builder);
 

tests/test/metadata.test.ts

@@ -6,7 +6,7 @@ describe("Metadata", () => {
   let service: PostsApiService;
 
   beforeAll(() => {
-    service = new ServiceBuilder().setEndpoint(testServer.url).build(PostsApiService);
+    service = new ServiceBuilder().baseUrl(testServer.url).build(PostsApiService);
   });
 
   test("Method not found", () => {

tests/test/standalone.test.ts

@@ -5,7 +5,7 @@ import axios, { AxiosRequestConfig } from "axios";
 
 describe("Standalone", () => {
   test("With instance", async () => {
-    const serviceWithoutStandalone = new ServiceBuilder().setEndpoint(testServer.url).build(PostsApiService);
+    const serviceWithoutStandalone = new ServiceBuilder().baseUrl(testServer.url).build(PostsApiService);
     const axiosInstance = axios.create();
 
     axiosInstance.interceptors.response.use((value) => {
@@ -14,7 +14,7 @@ describe("Standalone", () => {
     });
 
     const serviceWithStandalone = new ServiceBuilder()
-      .setEndpoint(testServer.url)
+      .baseUrl(testServer.url)
       .setStandalone(axiosInstance)
       .build(PostsApiService);
 
@@ -23,15 +23,15 @@ describe("Standalone", () => {
   });
 
   test("With boolean", async () => {
-    const serviceWithoutStandalone = new ServiceBuilder().setEndpoint(testServer.url).build(PostsApiService);
+    const serviceWithoutStandalone = new ServiceBuilder().baseUrl(testServer.url).build(PostsApiService);
 
     const interceptor = (config: AxiosRequestConfig) => {
       config["standaloneId"] = 101;
       return config;
     };
 
     const serviceWithStandalone = new ServiceBuilder()
-      .setEndpoint(testServer.url)
+      .baseUrl(testServer.url)
       .setStandalone(true)
       .setRequestInterceptors(interceptor)
       .build(PostsApiService);

tests/test/transformers/request.transformer.test.ts

@@ -11,7 +11,7 @@ describe("Request transformer", () => {
     };
 
     const service = new ServiceBuilder()
-      .setEndpoint(testServer.url)
+      .baseUrl(testServer.url)
       .setRequestInterceptors(interceptor)
       .build(TransformerApiService);
 

tests/test/transformers/response.transformer.test.ts

@@ -7,7 +7,7 @@ describe("Response transformer", () => {
   let service: TransformerApiService;
 
   beforeAll(() => {
-    service = new ServiceBuilder().setEndpoint(testServer.url).build(TransformerApiService);
+    service = new ServiceBuilder().baseUrl(testServer.url).build(TransformerApiService);
   });
 
   test("@ResponseTransformer", async () => {