@gewis/grooster-backend-ts 1.1.0 → 1.2.0

package/src/base.ts

@@ -5,18 +5,19 @@
  * A GEWIS Rooster maker
  *
  * The version of the OpenAPI document: 0.1
- *
+ * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
 
-import type { Configuration } from "./configuration";
+
+import type { Configuration } from './configuration';
 // Some imports not used depending on template conditions
 // @ts-ignore
-import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from "axios";
-import globalAxios from "axios";
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import globalAxios from 'axios';
 
 export const BASE_PATH = "http://localhost".replace(/\/+$/, "");
 
@@ -25,10 +26,10 @@ export const BASE_PATH = "http://localhost".replace(/\/+$/, "");
  * @export
  */
 export const COLLECTION_FORMATS = {
-  csv: ",",
-  ssv: " ",
-  tsv: "\t",
-  pipes: "|",
+    csv: ",",
+    ssv: " ",
+    tsv: "\t",
+    pipes: "|",
 };
 
 /**
@@ -37,8 +38,8 @@ export const COLLECTION_FORMATS = {
  * @interface RequestArgs
  */
 export interface RequestArgs {
-  url: string;
-  options: RawAxiosRequestConfig;
+    url: string;
+    options: RawAxiosRequestConfig;
 }
 
 /**
@@ -47,19 +48,15 @@ export interface RequestArgs {
  * @class BaseAPI
  */
 export class BaseAPI {
-  protected configuration: Configuration | undefined;
+    protected configuration: Configuration | undefined;
 
-  constructor(
-    configuration?: Configuration,
-    protected basePath: string = BASE_PATH,
-    protected axios: AxiosInstance = globalAxios,
-  ) {
-    if (configuration) {
-      this.configuration = configuration;
-      this.basePath = configuration.basePath ?? basePath;
+    constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globalAxios) {
+        if (configuration) {
+            this.configuration = configuration;
+            this.basePath = configuration.basePath ?? basePath;
+        }
     }
-  }
-}
+};
 
 /**
  *
@@ -68,24 +65,22 @@ export class BaseAPI {
  * @extends {Error}
  */
 export class RequiredError extends Error {
-  constructor(
-    public field: string,
-    msg?: string,
-  ) {
-    super(msg);
-    this.name = "RequiredError";
-  }
+    constructor(public field: string, msg?: string) {
+        super(msg);
+        this.name = "RequiredError"
+    }
 }
 
 interface ServerMap {
-  [key: string]: {
-    url: string;
-    description: string;
-  }[];
+    [key: string]: {
+        url: string,
+        description: string,
+    }[];
 }
 
 /**
  *
  * @export
  */
-export const operationServerMap: ServerMap = {};
+export const operationServerMap: ServerMap = {
+}

package/src/common.ts

@@ -5,139 +5,105 @@
  * A GEWIS Rooster maker
  *
  * The version of the OpenAPI document: 0.1
- *
+ * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
 
+
 import type { Configuration } from "./configuration";
 import type { RequestArgs } from "./base";
-import type { AxiosInstance, AxiosResponse } from "axios";
+import type { AxiosInstance, AxiosResponse } from 'axios';
 import { RequiredError } from "./base";
 
 /**
  *
  * @export
  */
-export const DUMMY_BASE_URL = "https://example.com";
+export const DUMMY_BASE_URL = 'https://example.com'
 
 /**
  *
  * @throws {RequiredError}
  * @export
  */
-export const assertParamExists = function (
-  functionName: string,
-  paramName: string,
-  paramValue: unknown,
-) {
-  if (paramValue === null || paramValue === undefined) {
-    throw new RequiredError(
-      paramName,
-      `Required parameter ${paramName} was null or undefined when calling ${functionName}.`,
-    );
-  }
-};
+export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) {
+    if (paramValue === null || paramValue === undefined) {
+        throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
+    }
+}
 
 /**
  *
  * @export
  */
-export const setApiKeyToObject = async function (
-  object: any,
-  keyParamName: string,
-  configuration?: Configuration,
-) {
-  if (configuration && configuration.apiKey) {
-    const localVarApiKeyValue =
-      typeof configuration.apiKey === "function"
-        ? await configuration.apiKey(keyParamName)
-        : await configuration.apiKey;
-    object[keyParamName] = localVarApiKeyValue;
-  }
-};
+export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) {
+    if (configuration && configuration.apiKey) {
+        const localVarApiKeyValue = typeof configuration.apiKey === 'function'
+            ? await configuration.apiKey(keyParamName)
+            : await configuration.apiKey;
+        object[keyParamName] = localVarApiKeyValue;
+    }
+}
 
 /**
  *
  * @export
  */
-export const setBasicAuthToObject = function (
-  object: any,
-  configuration?: Configuration,
-) {
-  if (configuration && (configuration.username || configuration.password)) {
-    object["auth"] = {
-      username: configuration.username,
-      password: configuration.password,
-    };
-  }
-};
+export const setBasicAuthToObject = function (object: any, configuration?: Configuration) {
+    if (configuration && (configuration.username || configuration.password)) {
+        object["auth"] = { username: configuration.username, password: configuration.password };
+    }
+}
 
 /**
  *
  * @export
  */
-export const setBearerAuthToObject = async function (
-  object: any,
-  configuration?: Configuration,
-) {
-  if (configuration && configuration.accessToken) {
-    const accessToken =
-      typeof configuration.accessToken === "function"
-        ? await configuration.accessToken()
-        : await configuration.accessToken;
-    object["Authorization"] = "Bearer " + accessToken;
-  }
-};
+export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) {
+    if (configuration && configuration.accessToken) {
+        const accessToken = typeof configuration.accessToken === 'function'
+            ? await configuration.accessToken()
+            : await configuration.accessToken;
+        object["Authorization"] = "Bearer " + accessToken;
+    }
+}
 
 /**
  *
  * @export
  */
-export const setOAuthToObject = async function (
-  object: any,
-  name: string,
-  scopes: string[],
-  configuration?: Configuration,
-) {
-  if (configuration && configuration.accessToken) {
-    const localVarAccessTokenValue =
-      typeof configuration.accessToken === "function"
-        ? await configuration.accessToken(name, scopes)
-        : await configuration.accessToken;
-    object["Authorization"] = "Bearer " + localVarAccessTokenValue;
-  }
-};
+export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) {
+    if (configuration && configuration.accessToken) {
+        const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
+            ? await configuration.accessToken(name, scopes)
+            : await configuration.accessToken;
+        object["Authorization"] = "Bearer " + localVarAccessTokenValue;
+    }
+}
 
-function setFlattenedQueryParams(
-  urlSearchParams: URLSearchParams,
-  parameter: any,
-  key: string = "",
-): void {
-  if (parameter == null) return;
-  if (typeof parameter === "object") {
-    if (Array.isArray(parameter)) {
-      (parameter as any[]).forEach((item) =>
-        setFlattenedQueryParams(urlSearchParams, item, key),
-      );
-    } else {
-      Object.keys(parameter).forEach((currentKey) =>
-        setFlattenedQueryParams(
-          urlSearchParams,
-          parameter[currentKey],
-          `${key}${key !== "" ? "." : ""}${currentKey}`,
-        ),
-      );
+function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void {
+    if (parameter == null) return;
+    if (typeof parameter === "object") {
+        if (Array.isArray(parameter)) {
+            (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key));
+        }
+        else {
+            Object.keys(parameter).forEach(currentKey =>
+                setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`)
+            );
+        }
     }
-  } else {
-    if (urlSearchParams.has(key)) {
-      urlSearchParams.append(key, parameter);
-    } else {
-      urlSearchParams.set(key, parameter);
+    else {
+        if (urlSearchParams.has(key)) {
+            urlSearchParams.append(key, parameter);
+        }
+        else {
+            urlSearchParams.set(key, parameter);
+        }
     }
-  }
 }
 
 /**
@@ -145,58 +111,40 @@ function setFlattenedQueryParams(
  * @export
  */
 export const setSearchParams = function (url: URL, ...objects: any[]) {
-  const searchParams = new URLSearchParams(url.search);
-  setFlattenedQueryParams(searchParams, objects);
-  url.search = searchParams.toString();
-};
+    const searchParams = new URLSearchParams(url.search);
+    setFlattenedQueryParams(searchParams, objects);
+    url.search = searchParams.toString();
+}
 
 /**
  *
  * @export
  */
-export const serializeDataIfNeeded = function (
-  value: any,
-  requestOptions: any,
-  configuration?: Configuration,
-) {
-  const nonString = typeof value !== "string";
-  const needsSerialization =
-    nonString && configuration && configuration.isJsonMime
-      ? configuration.isJsonMime(requestOptions.headers["Content-Type"])
-      : nonString;
-  return needsSerialization
-    ? JSON.stringify(value !== undefined ? value : {})
-    : value || "";
-};
+export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) {
+    const nonString = typeof value !== 'string';
+    const needsSerialization = nonString && configuration && configuration.isJsonMime
+        ? configuration.isJsonMime(requestOptions.headers['Content-Type'])
+        : nonString;
+    return needsSerialization
+        ? JSON.stringify(value !== undefined ? value : {})
+        : (value || "");
+}
 
 /**
  *
  * @export
  */
 export const toPathString = function (url: URL) {
-  return url.pathname + url.search + url.hash;
-};
+    return url.pathname + url.search + url.hash
+}
 
 /**
  *
  * @export
  */
-export const createRequestFunction = function (
-  axiosArgs: RequestArgs,
-  globalAxios: AxiosInstance,
-  BASE_PATH: string,
-  configuration?: Configuration,
-) {
-  return <T = unknown, R = AxiosResponse<T>>(
-    axios: AxiosInstance = globalAxios,
-    basePath: string = BASE_PATH,
-  ) => {
-    const axiosRequestArgs = {
-      ...axiosArgs.options,
-      url:
-        (axios.defaults.baseURL ? "" : (configuration?.basePath ?? basePath)) +
-        axiosArgs.url,
+export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) {
+    return <T = unknown, R = AxiosResponse<T>>(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
+        const axiosRequestArgs = {...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url};
+        return axios.request<T, R>(axiosRequestArgs);
     };
-    return axios.request<T, R>(axiosRequestArgs);
-  };
-};
+}

package/src/configuration.ts

@@ -5,133 +5,111 @@
  * A GEWIS Rooster maker
  *
  * The version of the OpenAPI document: 0.1
- *
+ * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
 
+
 export interface ConfigurationParameters {
-  apiKey?:
-    | string
-    | Promise<string>
-    | ((name: string) => string)
-    | ((name: string) => Promise<string>);
-  username?: string;
-  password?: string;
-  accessToken?:
-    | string
-    | Promise<string>
-    | ((name?: string, scopes?: string[]) => string)
-    | ((name?: string, scopes?: string[]) => Promise<string>);
-  basePath?: string;
-  serverIndex?: number;
-  baseOptions?: any;
-  formDataCtor?: new () => any;
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    username?: string;
+    password?: string;
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    basePath?: string;
+    serverIndex?: number;
+    baseOptions?: any;
+    formDataCtor?: new () => any;
 }
 
 export class Configuration {
-  /**
-   * parameter for apiKey security
-   * @param name security name
-   * @memberof Configuration
-   */
-  apiKey?:
-    | string
-    | Promise<string>
-    | ((name: string) => string)
-    | ((name: string) => Promise<string>);
-  /**
-   * parameter for basic security
-   *
-   * @type {string}
-   * @memberof Configuration
-   */
-  username?: string;
-  /**
-   * parameter for basic security
-   *
-   * @type {string}
-   * @memberof Configuration
-   */
-  password?: string;
-  /**
-   * parameter for oauth2 security
-   * @param name security name
-   * @param scopes oauth2 scope
-   * @memberof Configuration
-   */
-  accessToken?:
-    | string
-    | Promise<string>
-    | ((name?: string, scopes?: string[]) => string)
-    | ((name?: string, scopes?: string[]) => Promise<string>);
-  /**
-   * override base path
-   *
-   * @type {string}
-   * @memberof Configuration
-   */
-  basePath?: string;
-  /**
-   * override server index
-   *
-   * @type {number}
-   * @memberof Configuration
-   */
-  serverIndex?: number;
-  /**
-   * base options for axios calls
-   *
-   * @type {any}
-   * @memberof Configuration
-   */
-  baseOptions?: any;
-  /**
-   * The FormData constructor that will be used to create multipart form data
-   * requests. You can inject this here so that execution environments that
-   * do not support the FormData class can still run the generated client.
-   *
-   * @type {new () => FormData}
-   */
-  formDataCtor?: new () => any;
+    /**
+     * parameter for apiKey security
+     * @param name security name
+     * @memberof Configuration
+     */
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    /**
+     * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    username?: string;
+    /**
+     * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    password?: string;
+    /**
+     * parameter for oauth2 security
+     * @param name security name
+     * @param scopes oauth2 scope
+     * @memberof Configuration
+     */
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    /**
+     * override base path
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    basePath?: string;
+    /**
+     * override server index
+     *
+     * @type {number}
+     * @memberof Configuration
+     */
+    serverIndex?: number;
+    /**
+     * base options for axios calls
+     *
+     * @type {any}
+     * @memberof Configuration
+     */
+    baseOptions?: any;
+    /**
+     * The FormData constructor that will be used to create multipart form data
+     * requests. You can inject this here so that execution environments that
+     * do not support the FormData class can still run the generated client.
+     *
+     * @type {new () => FormData}
+     */
+    formDataCtor?: new () => any;
 
-  constructor(param: ConfigurationParameters = {}) {
-    this.apiKey = param.apiKey;
-    this.username = param.username;
-    this.password = param.password;
-    this.accessToken = param.accessToken;
-    this.basePath = param.basePath;
-    this.serverIndex = param.serverIndex;
-    this.baseOptions = {
-      ...param.baseOptions,
-      headers: {
-        ...param.baseOptions?.headers,
-      },
-    };
-    this.formDataCtor = param.formDataCtor;
-  }
+    constructor(param: ConfigurationParameters = {}) {
+        this.apiKey = param.apiKey;
+        this.username = param.username;
+        this.password = param.password;
+        this.accessToken = param.accessToken;
+        this.basePath = param.basePath;
+        this.serverIndex = param.serverIndex;
+        this.baseOptions = {
+            ...param.baseOptions,
+            headers: {
+                ...param.baseOptions?.headers,
+            },
+        };
+        this.formDataCtor = param.formDataCtor;
+    }
 
-  /**
-   * Check if the given MIME is a JSON MIME.
-   * JSON MIME examples:
-   *   application/json
-   *   application/json; charset=UTF8
-   *   APPLICATION/JSON
-   *   application/vnd.company+json
-   * @param mime - MIME (Multipurpose Internet Mail Extensions)
-   * @return True if the given MIME is JSON, false otherwise.
-   */
-  public isJsonMime(mime: string): boolean {
-    const jsonMime: RegExp = new RegExp(
-      "^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$",
-      "i",
-    );
-    return (
-      mime !== null &&
-      (jsonMime.test(mime) ||
-        mime.toLowerCase() === "application/json-patch+json")
-    );
-  }
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    public isJsonMime(mime: string): boolean {
+        const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
+        return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
+    }
 }