@apia/api 0.0.7 → 0.1.0

package/README.md

@@ -19,7 +19,7 @@ Los archivos **tsconfig.json** y **tsup.config.ts** no son archivos únicos sino
 
 Luego de ejecutar estos pasos, el package estaría listo para comenzar a usarse.
 
-Este package trae como dependencias por defecto theme-ui y react. Si se desea agregar más dependencias se debe ejecutar el comando ```lerna add --scope="@apia/packageName" dependencyName```. Ejemplo, si creamos un paquete con el nombre @apia/myPackage y queremos agregar lodash-es como dependencia, ejecutamos el comando ```lerna add --scope="@apia/myPackage" lodash-es```. 
+Este package trae como dependencias por defecto theme-ui y react. Si se desea agregar más dependencias se debe ejecutar el comando ```lerna add --scope="@apia/packageName" dependencyName```. Ejemplo, si creamos un paquete con el nombre @apia/myPackage y queremos agregar lodash como dependencia, ejecutamos el comando ```lerna add --scope="@apia/myPackage" lodash```. 
 
 **Importante 1**: Dado que estamos desarrollando packages, es importante determinar si las dependencias que vamos a agregar son de tipo dependency o de tipo peerDependency.
 

package/cleanDist.json

@@ -0,0 +1,3 @@
+{
+  "cleanDist": 0.46826967418454335
+}

package/dist/index.d.ts

@@ -1,68 +1,9 @@
-import { TApiaLoad, TModify } from '@apia/util';
+import * as theme_ui_jsx_runtime from 'theme-ui/jsx-runtime';
+import * as React from 'react';
 import { AxiosResponse, AxiosRequestConfig } from 'axios';
+import { TModify, TApiaLoad } from '@apia/util';
+import { TNotificationMessage, notify } from '@apia/notifications';
 import QueryString from 'qs';
-import { notify, TNotificationMessage } from '@apia/notifications';
-import * as React from 'react';
-
-type TApiaApiMethodHandler = {
-    alert: typeof notify;
-    close: () => void;
-    configuration?: THandleConfiguration;
-    formDefinition: TApiaLoad;
-    reset: () => void;
-    setError: typeof notify;
-    setMessage: (message: Record<string, unknown>) => unknown;
-    setState: React.Dispatch<React.SetStateAction<IApiaApiHandlerState>>;
-    state: IApiaApiHandlerState;
-    setValue: (name: string, value: string) => void;
-};
-interface IModalConfig {
-    modalTitle?: string;
-    onClose?: () => void;
-    onMessage?: (message: Record<string, unknown>) => unknown;
-    onMessageClose?: () => unknown;
-    onSubmitted?: (handler: TApiaApiMethodHandler, response: AxiosResponse<Record<string, unknown> | null> | null) => unknown;
-}
-type THandleConfiguration = Partial<Pick<IApiaApiRequestConfig<unknown>, 'modalConfiguration' | 'methodsPath'>>;
-interface IApiaApiHandlerState {
-    disabled: boolean;
-    isLoading: boolean;
-    isMultipart: boolean;
-    progress: number;
-    errors: Record<string, string>;
-    windowIndex: number;
-}
-
-interface TColors {
-    exception?: string;
-    alert?: string;
-    message?: string;
-}
-interface IApiaApiConsoleConfig {
-    colors?: TColors;
-    debug?: boolean;
-}
-interface IApiaApiRequestConfig<DataType> extends IApiaApiConsoleConfig {
-    axiosConfig?: AxiosRequestConfig;
-    modalConfiguration?: IModalConfig;
-    handleLoad?: boolean;
-    /**
-     * Algunas veces las funciones llamadas por una acción en el servidor
-     * tienen el mismo nombre siendo en realidad funciones distintas. Para
-     * corregir este problema es posible pasar un path relativo al directorio
-     * apiaApi/methods
-     */
-    methodsPath?: string;
-    notificationsCategory?: string;
-    queryData?: string | Record<string, unknown>;
-    stringifyOptions?: QueryString.IStringifyOptions;
-    validateResponse?: (response: AxiosResponse<DataType | null>) => Promise<boolean | string> | boolean | string;
-}
-declare global {
-    interface Window {
-        [key: string]: string;
-    }
-}
 
 declare function getConfig<LoadType>(outerBehaveConfig?: IApiaApiRequestConfig<LoadType>): IApiaApiRequestConfig<unknown> & IApiaApiRequestConfig<LoadType> & Partial<IApiaApiRequestConfig<unknown>>;
 type TApiaApiAxiosResponse<LoadType> = AxiosResponse<LoadType | null> & {
@@ -123,11 +64,11 @@ declare function post<LoadType extends Record<string, unknown> = Record<string,
 }>, config?: TModify<IApiaApiRequestConfig<LoadType>, {
     postData?: DataType;
     postDataTreatement?: 'stringify';
-}>): Promise<TApiaApiAxiosResponse<(LoadType & TNotificationMessage) | null> | null>;
+}>): TApiaApiResult<LoadType>;
 declare function post<LoadType extends Record<string, unknown> = Record<string, unknown>, DataType = unknown>(config: TModify<IApiaApiRequestConfig<LoadType>, {
     postData?: DataType;
     postDataTreatement?: 'stringify';
-}>): Promise<TApiaApiAxiosResponse<(LoadType & TNotificationMessage) | null> | null>;
+}>): TApiaApiResult<LoadType>;
 /**
  * IMPORTANTE!! El ApiaApi está programado bajo la consigna de que
  * **no debe tirar núnca una excepción**. **Los errores** provenientes
@@ -172,8 +113,8 @@ declare function post<LoadType extends Record<string, unknown> = Record<string,
   }
  * @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>): Promise<TApiaApiAxiosResponse<(LoadType & TNotificationMessage) | null> | null>;
-declare function get<LoadType extends Record<string, unknown> = Record<string, unknown>>(config: IApiaApiRequestConfig<LoadType>): Promise<TApiaApiAxiosResponse<(LoadType & TNotificationMessage) | null> | 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;
@@ -206,4 +147,79 @@ declare function makeApiaUrl(props?: {
     [key: string]: unknown;
 }): string;
 
-export { ApiaApi, makeApiaUrl };
+interface TColors {
+    exception?: string;
+    alert?: string;
+    message?: string;
+}
+type TApiaApiResult<LoadType> = Promise<TApiaApiAxiosResponse<(LoadType & TNotificationMessage) | null> | null>;
+interface IApiaApiConsoleConfig {
+    colors?: TColors;
+    debug?: boolean;
+}
+interface IApiaApiRequestConfig<DataType> extends IApiaApiConsoleConfig {
+    axiosConfig?: AxiosRequestConfig;
+    modalConfiguration?: IModalConfig;
+    handleLoad?: boolean;
+    /**
+     * Algunas veces las funciones llamadas por una acción en el servidor
+     * tienen el mismo nombre siendo en realidad funciones distintas. Para
+     * corregir este problema es posible pasar un path relativo al directorio
+     * apiaApi/methods
+     */
+    methodsPath?: string;
+    notificationsCategory?: string;
+    queryData?: string | Record<string, unknown>;
+    stringifyOptions?: QueryString.IStringifyOptions;
+    validateResponse?: (response: AxiosResponse<DataType | null>) => Promise<boolean | string> | boolean | string;
+}
+
+type TMethod = {
+    name: string;
+    props: {
+        attributes?: Record<string, unknown>;
+        currentUrl?: string;
+        funCall?: string;
+        inlineArguments?: string[];
+        messages?: unknown;
+    };
+};
+type TApiaApiMethodHandler = {
+    alert: typeof notify;
+    close: () => void;
+    configuration?: THandleConfiguration;
+    formDefinition: TApiaLoad;
+    reset: () => void;
+    setError: typeof notify;
+    setMessage: (message: Record<string, unknown>) => unknown;
+    setState: React.Dispatch<React.SetStateAction<IApiaApiHandlerState>>;
+    state: IApiaApiHandlerState;
+    setValue: (name: string, value: string) => void;
+};
+type TApiaApiMethod = (handler: TApiaApiMethodHandler, props: TMethod['props']) => Promise<void> | void;
+interface IModalConfig {
+    modalTitle?: string;
+    onClose?: () => void;
+    onMessage?: (message: Record<string, unknown>) => unknown;
+    onMessageClose?: () => unknown;
+    onSubmitted?: (handler: TApiaApiMethodHandler, response: AxiosResponse<Record<string, unknown> | null> | null) => unknown;
+}
+type THandleConfiguration = Partial<Pick<IApiaApiRequestConfig<unknown>, 'modalConfiguration' | 'methodsPath'>>;
+interface IApiaApiHandlerState {
+    disabled: boolean;
+    isLoading: boolean;
+    isMultipart: boolean;
+    progress: number;
+    errors: Record<string, string>;
+    windowIndex: number;
+}
+declare const ApiaApiHandler: React.MemoExoticComponent<() => theme_ui_jsx_runtime.JSX.Element>;
+
+declare global {
+    interface Window {
+        [key: string]: string;
+    }
+}
+
+export { ApiaApi, ApiaApiHandler, TApiaApiMethod, TApiaApiResult, makeApiaUrl };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

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