@apia/api 2.0.11 → 3.0.2

package/dist/apiaApi.d.ts

@@ -1,156 +0,0 @@
-import { TModify } from '@apia/util';
-import { AxiosResponse } from 'axios';
-import QueryString from 'qs';
-import { IApiaApiRequestConfig, TApiaApiResult } from './types.js';
-
-declare function getConfig<LoadType>(outerBehaveConfig?: IApiaApiRequestConfig<LoadType>): IApiaApiRequestConfig<unknown> & IApiaApiRequestConfig<LoadType> & Partial<IApiaApiRequestConfig<unknown>>;
-type TApiaApiAxiosResponse<LoadType> = AxiosResponse<LoadType | null> & {
-    hasError: boolean;
-    hasMessages: boolean;
-};
-/**
-* IMPORTANT!! The ApiaApi is programmed under the slogan that
- * **should never throw an exception**. **Errors** coming from
- * connectivity or exceptions on the server **will be handled
- * automatically** by ApiaApi, using the notification system
- * of the application. It is possible to determine in what context they should
- * be thrown those exceptions (global, main, modal) using the
- * alertsCategory configuration properties **(see errorsHandling.md)**.
- *
- * @param url String, the url you want to call
- * @param config interface IApiaApiRequestConfig<DataType>;
- *
- * @throws Nothing
- *
- * @example
- *
- * ApiaApi.post<ResponseType>('url...', {
-    axiosConfig?: AxiosRequestConfig;
-
-    // Configuración de postData
-    postData? unknown;
-    postDataTreatement?: 'stringify' | undefined;
-
-    // Configuración de queryString
-    queryData?: string | Record<string, unknown>;
-    stringifyOptions?: QueryString.IStringifyOptions;
-
-    // Response validator,
-    // If it returns true, everything continues correctly
-    // If it returns false, the ApiaApi throws a standard error.
-    // If it returns string, ApiaApi throws the error returned in the string.
-    validateResponse?: (
-      response: AxiosResponse<DataType | null>,
-    ) => boolean | string;
-
-    // Configuración de alertas
-    alertsImportance?: TAlertImportance;
-
-    // Configuración de ApiaApiHandler, falta documentar
-    handleLoad?: boolean;
-    eventsHandler?: IEventsHandler;
-
-    // other configuration
-    colors?: TColors;
-    debug?: boolean;
-  }
- * @returns The type of the return value depends on the type passed when calling the function. If there was an error it returns null.
- */
-declare function post<LoadType extends Record<string, unknown> = Record<string, unknown>, DataType = unknown>(url: string | TModify<IApiaApiRequestConfig<LoadType>, {
-    postData?: DataType;
-    postDataTreatement?: 'stringify';
-}>, config?: TModify<IApiaApiRequestConfig<LoadType>, {
-    postData?: DataType;
-    postDataTreatement?: 'stringify';
-}>): TApiaApiResult<LoadType>;
-declare function post<LoadType extends Record<string, unknown> = Record<string, unknown>, DataType = unknown>(config: TModify<IApiaApiRequestConfig<LoadType>, {
-    postData?: DataType;
-    postDataTreatement?: 'stringify';
-}>): TApiaApiResult<LoadType>;
-/**
- * IMPORTANTE!! El ApiaApi está programado bajo la consigna de que
- * **no debe tirar núnca una excepción**. **Los errores** provenientes
- * de la conectividad o de excepciones en el servidor **serán manejados
- * automáticamente** por el ApiaApi utilizando el sistema de notificaciones
- * de la aplicación. Es posible determinar en qué contexto deben
- * ser lanzadas esas excepciones (global, main, modal) utilizando las
- * propiedades de configuración alertsCategory **(ver errorsHandling.md)**.
- *
- * @param url String, el url al que se desea llamar
- * @param config interface IApiaApiRequestConfig<DataType>;
- *
- * @throws Nothing
- *
- * @example
- *
- * ApiaApi.get<TipoDeRespuesta>('url...', {
-    axiosConfig?: AxiosRequestConfig;
-
-    // Configuración de queryString
-    queryData?: string | Record<string, unknown>;
-    stringifyOptions?: QueryString.IStringifyOptions;
-
-    // Validador de respuesta,
-    // Si devuelve true, todo sigue correctamente
-    // Si devuelve false, el ApiaApi tira un error estándar.
-    // Si devuelve string, el ApiaApi tira el error devuelto en el string.
-    validateResponse?: (
-      response: AxiosResponse<DataType | null>,
-    ) => boolean | string;
-
-    // Configuración de alertas
-    alertsImportance?: TAlertImportance;
-
-    // Configuración de ApiaApiHandler, falta documentar
-    handleLoad?: boolean;
-    eventsHandler?: IEventsHandler;
-
-    // Otra configuración
-    colors?: TColors;
-    debug?: boolean;
-  }
- * @returns El tipo del valor devuelto depende del tipo pasado al llamar a la función. Si hubo un error devuelve null
- */
-declare function get<LoadType extends Record<string, unknown> = Record<string, unknown>>(url: string | IApiaApiRequestConfig<LoadType>, config?: IApiaApiRequestConfig<LoadType>): TApiaApiResult<LoadType>;
-declare function get<LoadType extends Record<string, unknown> = Record<string, unknown>>(config: IApiaApiRequestConfig<LoadType>): TApiaApiResult<LoadType>;
-declare const ApiaApi: {
-    get: typeof get;
-    getConfig: typeof getConfig;
-    post: typeof post;
-};
-/**
- * Creates an url based on the general requirements of Apia.
- * If the ajaxUrl property is not passed, it will use the
- * window.URL_REQUEST_AJAX. Its use is very simple, just pass the objects you
- * want to appear in the query string.
- *
- * @example makeApiaUrl({
- *   ajaxUrl: 'the.endpoint.you.want',
- *   queryString: 'an=existent&query=string',
- *   action: 'theAction',
- *   anotherProp: 15
- * })
- *
- * @returns the well formed url, in the example, the response url is:
- * /context/the.endpoint.you.want?an=existent&query=string&anotherProp=15&tabId=...&tokenId=...&action=theAction
- */
-declare function makeApiaUrl(props?: {
-    action?: string;
-    ajaxUrl?: string;
-    queryString?: string;
-    stringifyOptions?: QueryString.IStringifyOptions;
-    tabId?: string | number;
-    preventAsXmlParameter?: boolean;
-    avoidTabId?: boolean;
-    [key: string]: unknown;
-}): string;
-declare global {
-    interface Window {
-        TAB_ID_REQUEST: string;
-        CONTEXT: string;
-        URL_REQUEST_AJAX: string;
-    }
-}
-
-export { type TApiaApiAxiosResponse, ApiaApi as default, makeApiaUrl };
-//# sourceMappingURL=apiaApi.d.ts.map

package/dist/apiaApi.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"apiaApi.d.ts","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/dist/apiaApi.js

@@ -1,458 +0,0 @@
-import axios from 'axios';
-import merge from 'lodash-es/merge';
-import QueryString from 'qs';
-import { session } from '@apia/session';
-import { debugDispatcher, parseXmlAsync, EventEmitter, arrayOrArray } from '@apia/util';
-import { notify, getNotificationMessageObj, dispatchNotifications } from '@apia/notifications';
-import { handle } from './ApiaApiHandler.js';
-
-debugDispatcher.on(
-  "parseXml",
-  async ([text]) => {
-    const result = await parseXmlAsync(text);
-    console.info(result);
-  },
-  "Acepta un par\xE1metro de tipo string y realiza un parseo como si fuera xml, convirti\xE9ndolo a objeto javascript."
-);
-const defaultConfig = {
-  debug: false,
-  colors: {
-    exception: "red",
-    alert: "yellow",
-    message: "lightgreen"
-  },
-  handleLoad: false
-};
-const STORED_CONFIG = "ApiaApiConfig";
-let forcedConfig = {};
-const storedConfig = localStorage.getItem(STORED_CONFIG);
-if (storedConfig)
-  forcedConfig = JSON.parse(storedConfig);
-function getConfig(outerBehaveConfig) {
-  return merge({}, defaultConfig, outerBehaveConfig, forcedConfig);
-}
-function makeUrl(url, queryData, stringifyOptions) {
-  let finalUrl = url;
-  const questionMarkIndex = finalUrl.indexOf("?");
-  if (questionMarkIndex === -1)
-    finalUrl += "?";
-  else if (questionMarkIndex !== finalUrl.length - 1 && !finalUrl.endsWith("&"))
-    finalUrl += "&";
-  let parsedUrl = `${finalUrl}${queryData ? QueryString.stringify(queryData, stringifyOptions) : ""}`;
-  if (parsedUrl.endsWith("&") || parsedUrl.endsWith("?")) {
-    parsedUrl = parsedUrl.slice(0, parsedUrl.length - 1);
-  }
-  return parsedUrl;
-}
-const getURLActionName = (url) => {
-  const actionIdx = url.match(/action=(\w+)/)?.[1];
-  return actionIdx ?? "noAction";
-};
-class ApiaActionsClass extends EventEmitter {
-}
-const ApiaActions = new ApiaActionsClass();
-function getColor(color, colors = defaultConfig.colors ?? {
-  exception: "red",
-  alert: "yellow",
-  message: "green"
-}) {
-  return colors[color];
-}
-const handleWrongResponse = (error) => {
-  let errorMessage;
-  if (typeof error !== "string") {
-    if (error.message)
-      errorMessage = error.message;
-    else
-      errorMessage = error.toString();
-  } else
-    errorMessage = error;
-  notify({
-    type: "danger",
-    message: error.message.replaceAll("AxiosError", "Error")
-  });
-  console.log("%c ", "font-size:10vh");
-  console.log("%cError in ApiaApi", "color:red;font-size:2em;font-weight:bold");
-  console.log(`red/${errorMessage}`, { error });
-  console.log("%c ", "font-size:10vh");
-};
-function isJsonResponse(response) {
-  return response.headers["content-type"].match("application/json");
-}
-function isXmlResponse(response) {
-  return response.headers["content-type"].match(
-    /(?:application|text)?\/xml/
-  );
-}
-function isHtmlResponse(response) {
-  return response.headers["content-type"].match(
-    /(?:application|text)?\/html/
-  );
-}
-function handleActions(actions) {
-  if (actions) {
-    if (getConfig().debug)
-      console.log(
-        "%cHandled actions: ",
-        `color: ${getConfig().colors?.message ?? "green"}`,
-        { actions }
-      );
-    const actionsArray = arrayOrArray(actions.action);
-    actionsArray.forEach((action) => {
-      ApiaActions.emit("action", {
-        ...action,
-        param: arrayOrArray(action.param)
-      });
-    });
-  }
-}
-function handleOnClose({
-  exceptions,
-  onClose,
-  sysExceptions,
-  sysMessages
-}) {
-  try {
-    import(
-      /* webpackChunkName: "api-[request]" */
-      `/api/onClose/${onClose}.ts`
-    ).then(
-      (func) => {
-        if (exceptions || sysExceptions || sysMessages) {
-          const notificationsObject = getNotificationMessageObj({
-            exceptions,
-            onClose,
-            sysExceptions,
-            sysMessages
-          });
-          if (notificationsObject)
-            notificationsObject.forEach((notification) => {
-              notify({
-                ...notification,
-                onClose: func.default
-              });
-            });
-          else
-            func.default();
-        } else
-          func.default();
-      },
-      (e) => {
-        notify({
-          message: `onClose action not found: ${String(e)}`,
-          type: "danger"
-        });
-      }
-    );
-  } catch (e) {
-    parseMessages({ exceptions, sysExceptions, sysMessages });
-    console.error("Error while handling onClose");
-    console.error(e);
-  }
-}
-function parseMessages(response) {
-  if (!response)
-    return;
-  const { exceptions, sysMessages, sysExceptions } = response;
-  if (exceptions || sysExceptions || sysMessages) {
-    try {
-      dispatchNotifications({
-        exceptions,
-        sysExceptions,
-        sysMessages
-      });
-    } catch (e) {
-      handleWrongResponse(new Error(e));
-    }
-  }
-}
-const parseSuccessfulResponse = async (response, currentUrl, outerBehaveConfig = defaultConfig) => {
-  const behaveConfig = getConfig(outerBehaveConfig);
-  let parsedObj = void 0;
-  if (isJsonResponse(response)) {
-    if (typeof response.data === "string")
-      parsedObj = JSON.parse(
-        response.data.trim()
-      );
-    else if (typeof response.data === "object" && response.data)
-      parsedObj = response.data;
-  } else if (isXmlResponse(response)) {
-    parsedObj = await parseXmlAsync(response.data).catch(
-      (e) => {
-        handleWrongResponse(new Error(e));
-      }
-    );
-  } else if (isHtmlResponse(response)) {
-    console.error(
-      "El contenido devuelto es Html, no se esperaba esa respuesta"
-    );
-    return null;
-  }
-  if (behaveConfig.validateResponse) {
-    const validateResult = await behaveConfig.validateResponse({
-      ...response,
-      data: parsedObj?.load ?? parsedObj
-    });
-    if (typeof validateResult === "string")
-      throw new Error(`Validation error: ${validateResult}`);
-    else if (!validateResult) {
-      throw new Error("Error");
-    }
-  }
-  if (parsedObj) {
-    const {
-      actions,
-      onClose,
-      exceptions,
-      sysExceptions,
-      sysMessages,
-      load,
-      ...rest
-    } = parsedObj;
-    if (rest.code === "-1" && exceptions) {
-      session.invalidate();
-      return null;
-    }
-    if (exceptions && behaveConfig.debug) {
-      console.log(
-        `%cparseSuccessfulResponse`,
-        `color: ${getColor("exception", behaveConfig.colors)}`,
-        {
-          exceptions
-        }
-      );
-    }
-    if (sysExceptions && behaveConfig.debug) {
-      console.log(
-        `%cparseSuccessfulResponse`,
-        `color: ${getColor("exception", behaveConfig.colors)}`,
-        {
-          sysExceptions
-        }
-      );
-    }
-    if (sysMessages && behaveConfig.debug) {
-      console.log(
-        `%cparseSuccessfulResponse`,
-        `color: ${getColor("alert", behaveConfig.colors)}`,
-        {
-          sysMessages
-        }
-      );
-    }
-    handleActions(actions);
-    if (behaveConfig.handleLoad && onClose)
-      handleOnClose({
-        exceptions,
-        onClose,
-        sysExceptions,
-        sysMessages
-      });
-    else
-      parseMessages({ exceptions, sysExceptions, sysMessages });
-    if (load) {
-      if (behaveConfig.handleLoad) {
-        console.log(
-          `%chandleLoad`,
-          `color: ${getColor("message", behaveConfig.colors)}`,
-          {
-            load
-          }
-        );
-        if (!handle(load, currentUrl, {
-          methodsPath: outerBehaveConfig.methodsPath,
-          modalConfiguration: {
-            ...behaveConfig.modalConfiguration,
-            onClose: () => {
-              if (onClose)
-                handleOnClose({
-                  exceptions,
-                  onClose,
-                  sysExceptions,
-                  sysMessages
-                });
-              if (behaveConfig.modalConfiguration?.onClose)
-                behaveConfig.modalConfiguration?.onClose();
-            }
-          }
-        })) {
-          console.log(
-            `%cunhandledLoad -> There is no handler defined`,
-            `color: ${getColor("exception", behaveConfig.colors)}`,
-            {
-              load
-            }
-          );
-        }
-      }
-      return { ...load, sysMessages, exceptions, sysExceptions };
-    }
-    return { ...rest, sysMessages, exceptions, sysExceptions };
-  }
-  return null;
-};
-async function handleResponse(result, currentUrl, outerBehaveConfig = defaultConfig) {
-  const behaveConfig = getConfig(outerBehaveConfig);
-  try {
-    if (!result || result.data === void 0) {
-      if (behaveConfig.debug)
-        console.log(
-          `%cApiaApi wrong response`,
-          `color: ${getColor("alert", behaveConfig.colors)}`
-        );
-    } else {
-      const parsedResponse = await parseSuccessfulResponse(
-        result,
-        currentUrl,
-        behaveConfig
-      );
-      const action = getURLActionName(currentUrl);
-      if (behaveConfig.debug)
-        console.log(
-          `%c <- ApiaApi.${result.config.method ?? ""} ${action} `,
-          `color: ${getColor("message", behaveConfig.colors)}`,
-          {
-            data: parsedResponse
-          }
-        );
-      return {
-        ...result,
-        data: parsedResponse,
-        hasError: !!parsedResponse?.exceptions || !!parsedResponse?.sysExceptions,
-        hasMessages: !!parsedResponse?.sysMessages
-      };
-    }
-  } catch (e) {
-    handleWrongResponse(new Error(e));
-    return null;
-  }
-  return null;
-}
-async function post(par1, par2) {
-  const actualUrl = typeof par1 !== "string" ? makeApiaUrl() : par1;
-  const configParameter = typeof par1 === "string" ? par2 ?? defaultConfig : par1;
-  const behaveConfig = {
-    ...getConfig(configParameter),
-    postData: configParameter.postDataTreatement === "stringify" ? QueryString.stringify(
-      configParameter.postData,
-      configParameter.stringifyOptions
-    ) : configParameter.postData
-  };
-  const parsedUrl = makeUrl(
-    actualUrl,
-    behaveConfig.queryData,
-    behaveConfig.stringifyOptions
-  );
-  if (behaveConfig.debug) {
-    const queryString = actualUrl.split("&");
-    const action = getURLActionName(actualUrl);
-    console.log(
-      `%cApiaApi.post ${action}`,
-      `color: ${getColor("message", behaveConfig.colors)}`,
-      {
-        url: parsedUrl,
-        queryDataInURL: [...queryString],
-        queryData: behaveConfig.queryData,
-        formData: behaveConfig.postData,
-        stringifyOptiopns: behaveConfig.stringifyOptions
-      }
-    );
-  }
-  const response = await axios.post(parsedUrl, behaveConfig.postData, behaveConfig.axiosConfig).catch((e) => {
-    handleWrongResponse(new Error(e));
-  });
-  if (response) {
-    const result = handleResponse(response, actualUrl, behaveConfig);
-    return result;
-  }
-  return null;
-}
-async function get(par1, par2) {
-  const actualUrl = typeof par1 !== "string" ? makeApiaUrl() : par1;
-  const behaveConfig = getConfig(
-    typeof par1 === "string" ? par2 ?? defaultConfig : par1
-  );
-  const parsedUrl = makeUrl(
-    actualUrl,
-    behaveConfig.queryData,
-    behaveConfig.stringifyOptions
-  );
-  if (behaveConfig.debug)
-    console.log(
-      `%cApiaApi.get`,
-      `color: ${getColor("message", behaveConfig.colors)}`,
-      {
-        url: parsedUrl
-      }
-    );
-  const response = await axios.get(parsedUrl, behaveConfig.axiosConfig).catch((e) => {
-    handleWrongResponse(new Error(e));
-  });
-  if (response) {
-    const result = await handleResponse(
-      response,
-      actualUrl,
-      behaveConfig
-    );
-    return result;
-  }
-  return null;
-}
-const ApiaApi = {
-  get,
-  getConfig,
-  post
-};
-function makeApiaUrl(props) {
-  let actualQueryData = {};
-  if (props) {
-    const {
-      ajaxUrl,
-      queryString: queryString2,
-      stringifyOptions,
-      shouldAvoidTabId,
-      preventAsXmlParameter,
-      avoidTabId,
-      tabId: outerTabId,
-      ...rest
-    } = props;
-    actualQueryData = { ...rest };
-  }
-  const queryString = QueryString.stringify(
-    actualQueryData,
-    props?.stringifyOptions ?? {
-      arrayFormat: "repeat",
-      encodeValuesOnly: false
-    }
-  );
-  let actualAjaxUrl = props?.ajaxUrl ?? window.URL_REQUEST_AJAX;
-  if (actualAjaxUrl.indexOf("?") === actualAjaxUrl.length - 1) {
-    actualAjaxUrl = actualAjaxUrl.slice(0, actualAjaxUrl.length - 1);
-  }
-  if (!actualAjaxUrl.startsWith("/")) {
-    actualAjaxUrl = `/${actualAjaxUrl}`;
-  }
-  const match = window.TAB_ID_REQUEST.match(/tokenId=(\w+)/);
-  const currentTokenId = (match ?? [])[1];
-  let tabId = (props?.tabId ? `&tabId=${props.tabId}&tokenId=${currentTokenId}` : window.TAB_ID_REQUEST).slice(1);
-  if (props?.avoidTabId) {
-    tabId = "";
-  }
-  let { CONTEXT } = window;
-  if (CONTEXT?.endsWith("/")) {
-    CONTEXT += CONTEXT.slice(0, CONTEXT.length - 1);
-  }
-  let timestamp = `timestamp=${Date.now()}&`;
-  if (props?.queryString && props.queryString.includes("timestamp=") || queryString?.includes("timestamp=")) {
-    timestamp = "";
-  }
-  const contextWord = CONTEXT.replaceAll("/", "");
-  actualAjaxUrl = actualAjaxUrl.match(
-    new RegExp(`^(?:(?:/?${contextWord})?/)?(.+)$`)
-  )?.[1];
-  return `${contextWord ? "/" : ""}${contextWord}/${actualAjaxUrl}?${timestamp}${!props?.preventAsXmlParameter ? "asXml=true&" : ""}${props?.queryString ? `${props.queryString}&` : ""}${queryString ? `${queryString}&` : ""}${tabId}`;
-}
-var ApiaApi$1 = ApiaApi;
-
-export { ApiaActions, ApiaApi$1 as default, isHtmlResponse, isJsonResponse, isXmlResponse, makeApiaUrl, parseMessages, parseSuccessfulResponse };
-//# sourceMappingURL=apiaApi.js.map