@apia/api 0.1.1 → 0.2.2

package/LICENSE.md

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) [year] [fullname]
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+MIT License
+
+Copyright (c) [year] [fullname]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.

package/README.md

@@ -1,26 +1,26 @@
-# Initiator
-
-Este package se creó con la única utilidad de copiarlo entero y pegarlo a la hora de crear un nuevo package.
-
-Este iniciador permite crear un paquete que compila typescript y puede ser importado desde otros packages.
-
-## IMPORTANTE
-
-Los archivos **tsconfig.json** y **tsup.config.ts** no son archivos únicos sino symlinks a archivos de configuración comunes a todos los packages. En caso de que sea necesario modificar alguno de ellos **que en la gran mayoría de los casos no sería necesario**, es necesario eliminar el archivo a modificar y crear uno nuevo.
-
-## Procedimiento
-
- - Copiar la carpeta initiator y pegarla con otro nombre dentro de packages.
- - Modificar el package.json:
-   - Eliminar la línea ```private: true```.
-   - Cambiar la ocurrencia `initiator` por el nombre del nuevo paquete. 
-   - Agregar los scripts convenientes: dev, build, etc.
- - Ejecutar el comando lerna bootstrap desde la carpeta raíz.
-
-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 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.
-
-**Importante 2**: lerna no permite instalar de a varias dependencias a la vez como lo hace npm, por lo tanto, si se desea agregar varias dependencias se debe ejecutar el comando anterior tantas veces como dependencias se quiera agregar.
+# Initiator
+
+Este package se creó con la única utilidad de copiarlo entero y pegarlo a la hora de crear un nuevo package.
+
+Este iniciador permite crear un paquete que compila typescript y puede ser importado desde otros packages.
+
+## IMPORTANTE
+
+Los archivos **tsconfig.json** y **tsup.config.ts** no son archivos únicos sino symlinks a archivos de configuración comunes a todos los packages. En caso de que sea necesario modificar alguno de ellos **que en la gran mayoría de los casos no sería necesario**, es necesario eliminar el archivo a modificar y crear uno nuevo.
+
+## Procedimiento
+
+ - Copiar la carpeta initiator y pegarla con otro nombre dentro de packages.
+ - Modificar el package.json:
+   - Eliminar la línea ```private: true```.
+   - Cambiar la ocurrencia `initiator` por el nombre del nuevo paquete. 
+   - Agregar los scripts convenientes: dev, build, etc.
+ - Ejecutar el comando lerna bootstrap desde la carpeta raíz.
+
+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 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.
+
+**Importante 2**: lerna no permite instalar de a varias dependencias a la vez como lo hace npm, por lo tanto, si se desea agregar varias dependencias se debe ejecutar el comando anterior tantas veces como dependencias se quiera agregar.

package/dist/index.d.ts

@@ -1,8 +1,8 @@
-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 { TModal } from '@apia/components';
 import QueryString from 'qs';
 
 declare function getConfig<LoadType>(outerBehaveConfig?: IApiaApiRequestConfig<LoadType>): IApiaApiRequestConfig<unknown> & IApiaApiRequestConfig<LoadType> & Partial<IApiaApiRequestConfig<unknown>>;
@@ -145,7 +145,14 @@ declare function makeApiaUrl(props?: {
     preventAsXmlParameter?: boolean;
     avoidTabId?: boolean;
     [key: string]: unknown;
-}): string;
+}): string;
+declare global {
+    interface Window {
+        TAB_ID_REQUEST: string;
+        CONTEXT: string;
+        URL_REQUEST_AJAX: string;
+    }
+}
 
 interface TColors {
     exception?: string;
@@ -157,10 +164,12 @@ interface IApiaApiConsoleConfig {
     colors?: TColors;
     debug?: boolean;
 }
+type TSetModalProps = (configuration: THandleConfiguration, formDefinition?: TApiaLoad) => TModal | null;
 interface IApiaApiRequestConfig<DataType> extends IApiaApiConsoleConfig {
     axiosConfig?: AxiosRequestConfig;
     modalConfiguration?: IModalConfig;
     handleLoad?: boolean;
+    setModalProps?: TSetModalProps;
     /**
      * Algunas veces las funciones llamadas por una acción en el servidor
      * tienen el mismo nombre siendo en realidad funciones distintas. Para
@@ -189,6 +198,7 @@ type TApiaApiMethodHandler = {
     close: () => void;
     configuration?: THandleConfiguration;
     formDefinition: TApiaLoad;
+    setModalProps?: (configuration: THandleConfiguration, formDefinition?: TApiaLoad) => TModal | null;
     reset: () => void;
     setError: typeof notify;
     setMessage: (message: Record<string, unknown>) => unknown;
@@ -204,7 +214,7 @@ interface IModalConfig {
     onMessageClose?: () => unknown;
     onSubmitted?: (handler: TApiaApiMethodHandler, response: AxiosResponse<Record<string, unknown> | null> | null) => unknown;
 }
-type THandleConfiguration = Partial<Pick<IApiaApiRequestConfig<unknown>, 'modalConfiguration' | 'methodsPath'>>;
+type THandleConfiguration = Partial<Pick<IApiaApiRequestConfig<unknown>, 'modalConfiguration' | 'methodsPath' | 'setModalProps'>>;
 interface IApiaApiHandlerState {
     disabled: boolean;
     isLoading: boolean;
@@ -213,13 +223,6 @@ interface IApiaApiHandlerState {
     errors: Record<string, string>;
     windowIndex: number;
 }
-declare const ApiaApiHandler: React.MemoExoticComponent<() => theme_ui_jsx_runtime.JSX.Element>;
-
-declare global {
-    interface Window {
-        [key: string]: string;
-    }
-}
+declare const ApiaApiHandler: React.MemoExoticComponent<() => React.JSX.Element>;
 
-export { ApiaApi, ApiaApiHandler, TApiaApiMethod, TApiaApiResult, makeApiaUrl };
-//# sourceMappingURL=index.d.ts.map
+export { ApiaApi, ApiaApiHandler, IApiaApiRequestConfig, TApiaApiAxiosResponse, TApiaApiMethod, TApiaApiResult, makeApiaUrl };