oip-common 0.0.6 → 0.0.7

package/src/api/data-contracts.ts

@@ -0,0 +1,186 @@
+/* eslint-disable */
+/* tslint:disable */
+// @ts-nocheck
+/*
+ * ---------------------------------------------------------------
+ * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API        ##
+ * ##                                                           ##
+ * ## AUTHOR: acacode                                           ##
+ * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
+ * ---------------------------------------------------------------
+ */
+
+/** Data Transfer Object for creating a new module instance */
+export interface AddModuleInstanceDto {
+  /** The identifier of the module to create an instance of */
+  moduleId?: number;
+  /** The display label for the module instance */
+  label?: string | null;
+  /** The icon identifier for the module instance (optional) */
+  icon?: string | null;
+  /** The parent module instance identifier (optional) */
+  parentId?: number | null;
+  /** Array of role identifiers that can view this module instance (optional) */
+  viewRoles?: string[] | null;
+}
+
+/** Standardized response format for API exceptions */
+export interface ApiExceptionResponse {
+  /** User-friendly title of the exception */
+  title?: string | null;
+  /** Detailed description of the error */
+  message?: string | null;
+  /** HTTP status code associated with the exception */
+  statusCode?: number;
+  /** Stack trace information (optional, typically omitted in production) */
+  stackTrace?: string | null;
+}
+
+/** Data Transfer Object for editing an existing module instance */
+export interface EditModuleInstanceDto {
+  /** The identifier of the module instance to edit */
+  moduleInstanceId?: number;
+  /** The updated display label for the module instance */
+  label?: string | null;
+  /** The updated icon identifier for the module instance (optional) */
+  icon?: string | null;
+  /** The updated parent module instance identifier (optional) */
+  parentId?: number | null;
+  /** Updated array of role identifiers that can view this module instance (optional) */
+  viewRoles?: string[] | null;
+}
+
+/** Data transfer object representing a module and its loaded status. */
+export interface ExistModuleDto {
+  /** Gets or sets the unique identifier of the module. */
+  moduleId?: number;
+  /** Gets or sets the name of the module. */
+  name?: string | null;
+  /** Gets or sets a value indicating whether the module is currently loaded in the application. */
+  currentlyLoaded?: boolean;
+}
+
+/** Module settings. */
+export interface FolderModuleSettings {
+  /** HTML content for the module. */
+  html?: string | null;
+}
+
+/** Represents a request to save module instance settings. */
+export interface FolderModuleSettingsSaveSettingsRequest {
+  /** Gets or sets the ID of the module instance. */
+  id?: number;
+  /** Module settings. */
+  settings?: FolderModuleSettings;
+}
+
+/** Response front security settings */
+export interface GetKeycloakClientSettingsResponse {
+  /** Authority */
+  authority?: string | null;
+  /** Client id */
+  clientId?: string | null;
+  /** Scope */
+  scope?: string | null;
+  /** Response Type */
+  responseType?: string | null;
+  /** Use Refresh Token */
+  useRefreshToken?: boolean;
+  /** Silent Renew */
+  silentRenew?: boolean;
+  /** Log level None = 0, Debug = 1, Warn = 2, Error = 3 */
+  logLevel?: number;
+  /** Urls with auth */
+  secureRoutes?: string[] | null;
+}
+
+/** Represents a key-value pair where the key is an integer and the value is a string. */
+export interface IntKeyValueDto {
+  key?: number;
+  value?: string | null;
+}
+
+/** Represents a request to delete a module by its identifier. */
+export interface ModuleDeleteRequest {
+  /** Gets or sets the unique identifier of the module to be deleted. */
+  moduleId?: number;
+}
+
+/** It module in app */
+export interface ModuleDto {
+  /** Id */
+  moduleId?: number;
+  /** Name */
+  name?: string | null;
+  /** Settings */
+  settings?: string | null;
+  /** Securities */
+  moduleSecurities?: ModuleSecurityDto[] | null;
+}
+
+/** Module Instance Dto */
+export interface ModuleInstanceDto {
+  /** Unique identifier for the module instance. */
+  moduleInstanceId?: number;
+  /** Identifier for the module. */
+  moduleId?: number;
+  /** The label for the module instance. */
+  label?: string | null;
+  /** Icon associated with the module instance. see https://primeng.org/icons */
+  icon?: string | null;
+  /** Route link. */
+  routerLink?: string[] | null;
+  /** URL for the module instance. */
+  url?: string | null;
+  /** The target. */
+  target?: string | null;
+  /** Configuration settings for the module instance. */
+  settings?: string | null;
+  /** Child module instances. */
+  items?: ModuleInstanceDto[] | null;
+  /** Securities */
+  securities?: string[] | null;
+}
+
+/** Module security DTO */
+export interface ModuleSecurityDto {
+  /** Right */
+  right?: string | null;
+  /** Role */
+  role?: string | null;
+}
+
+/** Put security dto */
+export interface PutSecurityRequest {
+  /** Instance id */
+  id?: number;
+  /** Securities */
+  securities?: SecurityResponse[] | null;
+}
+
+/** Security dto */
+export interface SecurityResponse {
+  /** Code */
+  code?: string | null;
+  /** Name */
+  name?: string | null;
+  /** Description */
+  description?: string | null;
+  /** Roles */
+  roles?: string[] | null;
+}
+
+export interface FolderModuleGetSecurityParams {
+  /** The ID of the module instance. */
+  id?: number;
+}
+
+export interface FolderModuleGetModuleInstanceSettingsParams {
+  /** The ID of the module instance. */
+  id?: number;
+}
+
+export interface MenuDeleteModuleInstanceParams {
+  /** The unique identifier of the module instance to delete. */
+  id?: number;
+}

package/src/api/http-client.ts

@@ -0,0 +1,276 @@
+/* eslint-disable */
+/* tslint:disable */
+// @ts-nocheck
+/*
+ * ---------------------------------------------------------------
+ * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API        ##
+ * ##                                                           ##
+ * ## AUTHOR: acacode                                           ##
+ * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
+ * ---------------------------------------------------------------
+ */
+
+import { inject, Injectable } from "@angular/core";
+import { LayoutService, } from "../services/app.layout.service";
+import { SecurityService } from "../services/security.service";
+export type QueryParamsType = Record<string | number, any>;
+export type ResponseFormat = keyof Omit<Body, "body" | "bodyUsed">;
+
+export interface FullRequestParams extends Omit<RequestInit, "body"> {
+  /** set parameter to `true` for call `securityWorker` for this request */
+  secure?: boolean;
+  /** request path */
+  path: string;
+  /** content type of request body */
+  type?: ContentType;
+  /** query params */
+  query?: QueryParamsType;
+  /** format of response (i.e. response.json() -> format: "json") */
+  format?: ResponseFormat;
+  /** request body */
+  body?: unknown;
+  /** base url */
+  baseUrl?: string;
+  /** request cancellation token */
+  cancelToken?: CancelToken;
+}
+
+export type RequestParams = Omit<
+  FullRequestParams,
+  "body" | "method" | "query" | "path"
+>;
+
+export interface ApiConfig<SecurityDataType = unknown> {
+  baseUrl?: string;
+  baseApiParams?: Omit<RequestParams, "baseUrl" | "cancelToken" | "signal">;
+  securityWorker?: (
+    securityData: SecurityDataType | null,
+  ) => Promise<RequestParams | void> | RequestParams | void;
+  customFetch?: typeof fetch;
+}
+
+export interface HttpResponse<D extends unknown, E extends unknown = unknown>
+  extends Response {
+  data: D;
+  error: E;
+}
+
+type CancelToken = Symbol | string | number;
+
+export enum ContentType {
+  Json = "application/json",
+  FormData = "multipart/form-data",
+  UrlEncoded = "application/x-www-form-urlencoded",
+  Text = "text/plain",
+}
+
+@Injectable({providedIn: "root"})
+export class HttpClient<SecurityDataType = unknown> {
+  protected securityService = inject(SecurityService);
+  protected layoutService = inject(LayoutService);
+  public baseUrl: string = "";
+  private securityData: SecurityDataType | null = null;
+  private securityWorker?: ApiConfig<SecurityDataType>["securityWorker"] = (
+    securityData,
+  ) => ({
+    headers: {
+      "Accept-language": this.layoutService.language()
+        ? this.layoutService.language()
+        : "en",
+      "X-Timezone": this.layoutService.timeZone(),
+      Authorization: `Bearer ${securityData}`,
+    },
+  });
+  private abortControllers = new Map<CancelToken, AbortController>();
+  private customFetch = (...fetchParams: Parameters<typeof fetch>) =>
+    fetch(...fetchParams);
+
+  private baseApiParams: RequestParams = {
+    credentials: "same-origin",
+    headers: {},
+    redirect: "follow",
+    referrerPolicy: "no-referrer",
+  };
+
+  constructor() {
+    this.securityService.getAccessToken().subscribe((token) => {
+      this.securityData = token;
+    });
+  }
+
+  public setSecurityData = (data: SecurityDataType | null) => {
+    this.securityData = data;
+  };
+
+  protected encodeQueryParam(key: string, value: any) {
+    const encodedKey = encodeURIComponent(key);
+    return `${encodedKey}=${encodeURIComponent(typeof value === "number" ? value : `${value}`)}`;
+  }
+
+  protected addQueryParam(query: QueryParamsType, key: string) {
+    return this.encodeQueryParam(key, query[key]);
+  }
+
+  protected addArrayQueryParam(query: QueryParamsType, key: string) {
+    const value = query[key];
+    return value.map((v: any) => this.encodeQueryParam(key, v)).join("&");
+  }
+
+  protected toQueryString(rawQuery?: QueryParamsType): string {
+    const query = rawQuery || {};
+    const keys = Object.keys(query).filter(
+      (key) => "undefined" !== typeof query[key],
+    );
+    return keys
+      .map((key) =>
+        Array.isArray(query[key])
+          ? this.addArrayQueryParam(query, key)
+          : this.addQueryParam(query, key),
+      )
+      .join("&");
+  }
+
+  protected addQueryParams(rawQuery?: QueryParamsType): string {
+    const queryString = this.toQueryString(rawQuery);
+    return queryString ? `?${queryString}` : "";
+  }
+
+  private contentFormatters: Record<ContentType, (input: any) => any> = {
+    [ContentType.Json]: (input: any) =>
+      input !== null && (typeof input === "object" || typeof input === "string")
+        ? JSON.stringify(input)
+        : input,
+    [ContentType.Text]: (input: any) =>
+      input !== null && typeof input !== "string"
+        ? JSON.stringify(input)
+        : input,
+    [ContentType.FormData]: (input: any) =>
+      Object.keys(input || {}).reduce((formData, key) => {
+        const property = input[key];
+        formData.append(
+          key,
+          property instanceof Blob
+            ? property
+            : typeof property === "object" && property !== null
+              ? JSON.stringify(property)
+              : `${property}`,
+        );
+        return formData;
+      }, new FormData()),
+    [ContentType.UrlEncoded]: (input: any) => this.toQueryString(input),
+  };
+
+  protected mergeRequestParams(
+    params1: RequestParams,
+    params2?: RequestParams,
+  ): RequestParams {
+    return {
+      ...this.baseApiParams,
+      ...params1,
+      ...(params2 || {}),
+      headers: {
+        ...(this.baseApiParams.headers || {}),
+        ...(params1.headers || {}),
+        ...((params2 && params2.headers) || {}),
+      },
+    };
+  }
+
+  protected createAbortSignal = (
+    cancelToken: CancelToken,
+  ): AbortSignal | undefined => {
+    if (this.abortControllers.has(cancelToken)) {
+      const abortController = this.abortControllers.get(cancelToken);
+      if (abortController) {
+        return abortController.signal;
+      }
+      return void 0;
+    }
+
+    const abortController = new AbortController();
+    this.abortControllers.set(cancelToken, abortController);
+    return abortController.signal;
+  };
+
+  public abortRequest = (cancelToken: CancelToken) => {
+    const abortController = this.abortControllers.get(cancelToken);
+
+    if (abortController) {
+      abortController.abort();
+      this.abortControllers.delete(cancelToken);
+    }
+  };
+
+  public request = async <T = any, E = any>({
+                                              body,
+                                              secure,
+                                              path,
+                                              type,
+                                              query,
+                                              format,
+                                              baseUrl,
+                                              cancelToken,
+                                              ...params
+                                            }: FullRequestParams): Promise<T> => {
+    const secureParams =
+      ((typeof secure === "boolean" ? secure : this.baseApiParams.secure) &&
+        this.securityWorker &&
+        (await this.securityWorker(this.securityData))) ||
+      {};
+    const requestParams = this.mergeRequestParams(params, secureParams);
+    const queryString = query && this.toQueryString(query);
+    const payloadFormatter = this.contentFormatters[type || ContentType.Json];
+    let responseFormat = format || requestParams.format;
+
+    return this.customFetch(
+      `${baseUrl || this.baseUrl || ""}${path}${queryString ? `?${queryString}` : ""}`,
+      {
+        ...requestParams,
+        headers: {
+          ...(requestParams.headers || {}),
+          ...(type && type !== ContentType.FormData
+            ? {"Content-Type": type}
+            : {}),
+        },
+        signal:
+          (cancelToken
+            ? this.createAbortSignal(cancelToken)
+            : requestParams.signal) || null,
+        body:
+          typeof body === "undefined" || body === null
+            ? null
+            : payloadFormatter(body),
+      },
+    ).then(async (response) => {
+      const r = response.clone() as HttpResponse<T, E>;
+      r.data = null as unknown as T;
+      r.error = null as unknown as E;
+
+      if (typeof E !== undefined && responseFormat === undefined)
+        responseFormat = "json";
+
+      const data = !responseFormat
+        ? r
+        : await response[responseFormat]()
+          .then((data) => {
+            if (r.ok) {
+              r.data = data;
+            } else {
+              r.error = data;
+            }
+            return r;
+          })
+          .catch((e) => {
+            r.error = e;
+            return r;
+          });
+
+      if (cancelToken) {
+        this.abortControllers.delete(cancelToken);
+      }
+
+      if (!response.ok) throw data;
+      return data.data;
+    });
+  };
+}