Docs generation fixes

Author: MrRefactoring

src/clients/baseClient.ts

@@ -2,7 +2,7 @@
 import axios, { AxiosInstance, AxiosResponse } from 'axios';
 import type { Callback } from '../callback';
 import type { Client } from './client';
-import type { Config, JiraError } from '../config';
+import { Config, ConfigSchema, JiraError } from '../config';
 import { getAuthenticationToken } from '../services/authenticationService';
 import type { RequestConfig } from '../requestConfig';
 import { HttpException, isObject } from './httpException';
@@ -15,13 +15,7 @@ export class BaseClient implements Client {
   private instance: AxiosInstance;
 
   constructor(protected readonly config: Config) {
-    try {
-      new URL(config.host);
-    } catch {
-      throw new Error(
-        "Couldn't parse the host URL. Perhaps you forgot to add 'http://' or 'https://' at the beginning of the URL?",
-      );
-    }
+    this.config = ConfigSchema.parse(config);
 
     this.instance = axios.create({
       paramsSerializer: this.paramSerializer.bind(this),

src/config.ts

@@ -9,24 +9,24 @@ import { HttpException } from './clients';
 //   expiryTimeSeconds: z.number().optional()
 // });
 
-const BasicAuthSchema = z.object({
+export const BasicAuthSchema = z.object({
   email: z.string(),
   apiToken: z.string(),
-});
+}).strict();
 
 export type BasicAuth = z.infer<typeof BasicAuthSchema>;
 
-const OAuth2Schema = z.object({
+export const OAuth2Schema = z.object({
   accessToken: z.string(),
-});
+}).strict();
 
 export type OAuth2 = z.infer<typeof OAuth2Schema>;
 
 // Middlewares schemas
-const MiddlewaresSchema = z.object({
+export const MiddlewaresSchema = z.object({
   onError: z.function().args(z.any()).returns(z.void()).optional(),
   onResponse: z.function().args(z.any()).returns(z.void()).optional(),
-});
+}).strict();
 
 export type Middlewares = z.infer<typeof MiddlewaresSchema>;
 
@@ -38,7 +38,7 @@ export const ConfigSchema = z.object({
   baseRequestConfig: z.any().optional(),
   authentication: z.union([z.object({ basic: BasicAuthSchema }), z.object({ oauth2: OAuth2Schema })]).optional(),
   middlewares: MiddlewaresSchema.optional(),
-});
+}).strict();
 
 export type Config = z.infer<typeof ConfigSchema>;
 

src/services/authenticationService/authentications/createBasicAuthenticationToken.ts

@@ -1,11 +1,11 @@
-import { Base64Encoder } from '../base64Encoder';
+import { encode } from '../base64Encoder';
 import { BasicAuth } from '../../../config';
 
 export function createBasicAuthenticationToken(authenticationData: BasicAuth) {
   const login = authenticationData.email;
   const secret = authenticationData.apiToken;
 
-  const token = Base64Encoder.encode(`${login}:${secret}`);
+  const token = encode(`${login}:${secret}`);
 
   return `Basic ${token}`;
 }

src/services/authenticationService/base64Encoder.ts

@@ -1,69 +1,66 @@
-/* eslint-disable */
 /** @copyright The code was taken from the portal http://www.webtoolkit.info/javascript-base64.html */
 
-export namespace Base64Encoder {
-  const base64Sequence = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=';
+const base64Sequence = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=';
 
-  const utf8Encode = (value: string) => {
-    value = value.replace(/\r\n/g, '\n');
+const utf8Encode = (value: string) => {
+  value = value.replace(/\r\n/g, '\n');
 
-    let utftext = '';
+  let utftext = '';
 
-    for (let n = 0; n < value.length; n++) {
-      const c = value.charCodeAt(n);
+  for (let n = 0; n < value.length; n++) {
+    const c = value.charCodeAt(n);
 
-      if (c < 128) {
-        utftext += String.fromCharCode(c);
-      } else if (c > 127 && c < 2048) {
-        utftext += String.fromCharCode((c >> 6) | 192);
+    if (c < 128) {
+      utftext += String.fromCharCode(c);
+    } else if (c > 127 && c < 2048) {
+      utftext += String.fromCharCode((c >> 6) | 192);
 
-        utftext += String.fromCharCode((c & 63) | 128);
-      } else {
-        utftext += String.fromCharCode((c >> 12) | 224);
+      utftext += String.fromCharCode((c & 63) | 128);
+    } else {
+      utftext += String.fromCharCode((c >> 12) | 224);
 
-        utftext += String.fromCharCode(((c >> 6) & 63) | 128);
+      utftext += String.fromCharCode(((c >> 6) & 63) | 128);
 
-        utftext += String.fromCharCode((c & 63) | 128);
-      }
+      utftext += String.fromCharCode((c & 63) | 128);
     }
-
-    return utftext;
-  };
-
-  export const encode = (input: string) => {
-    let output = '';
-    let chr1;
-    let chr2;
-    let chr3;
-    let enc1;
-    let enc2;
-    let enc3;
-    let enc4;
-    let i = 0;
-
-    input = utf8Encode(input);
-
-    while (i < input.length) {
-      chr1 = input.charCodeAt(i++);
-      chr2 = input.charCodeAt(i++);
-      chr3 = input.charCodeAt(i++);
-
-      enc1 = chr1 >> 2;
-      enc2 = ((chr1 & 3) << 4) | (chr2 >> 4);
-      enc3 = ((chr2 & 15) << 2) | (chr3 >> 6);
-      enc4 = chr3 & 63;
-
-      if (isNaN(chr2)) {
-        enc3 = enc4 = 64;
-      } else if (isNaN(chr3)) {
-        enc4 = 64;
-      }
-
-      output += `${base64Sequence.charAt(enc1)}${base64Sequence.charAt(enc2)}${base64Sequence.charAt(
-        enc3,
-      )}${base64Sequence.charAt(enc4)}`;
+  }
+
+  return utftext;
+};
+
+export const encode = (input: string) => {
+  let output = '';
+  let chr1;
+  let chr2;
+  let chr3;
+  let enc1;
+  let enc2;
+  let enc3;
+  let enc4;
+  let i = 0;
+
+  input = utf8Encode(input);
+
+  while (i < input.length) {
+    chr1 = input.charCodeAt(i++);
+    chr2 = input.charCodeAt(i++);
+    chr3 = input.charCodeAt(i++);
+
+    enc1 = chr1 >> 2;
+    enc2 = ((chr1 & 3) << 4) | (chr2 >> 4);
+    enc3 = ((chr2 & 15) << 2) | (chr3 >> 6);
+    enc4 = chr3 & 63;
+
+    if (isNaN(chr2)) {
+      enc3 = enc4 = 64;
+    } else if (isNaN(chr3)) {
+      enc4 = 64;
     }
 
-    return output;
-  };
-}
+    output += `${base64Sequence.charAt(enc1)}${base64Sequence.charAt(enc2)}${base64Sequence.charAt(
+      enc3,
+    )}${base64Sequence.charAt(enc4)}`;
+  }
+
+  return output;
+};