diff --git a/_data/menu_descriptions.yml b/_data/menu_descriptions.yml index 6dc272541..8c8e09c92 100644 --- a/_data/menu_descriptions.yml +++ b/_data/menu_descriptions.yml @@ -347,7 +347,7 @@ sections: description: "Section that resolves common questions about Ontimize Web" - url: "/versions/" title: "Releases" - description: "Tables of all the Onitimze Web releases and its compatibilities" + description: "Tables of all the Ontimize Web releases and its compatibilities" - url: "/migrations/" title: "Migration guides" description: "Download page of our version migration guides" diff --git a/docs/aditional-information/19-migrations.md b/docs/aditional-information/19-migrations.md index dc3178448..c166fc492 100644 --- a/docs/aditional-information/19-migrations.md +++ b/docs/aditional-information/19-migrations.md @@ -1,7 +1,9 @@ --- layout: default -title: "Migration guides" +title: "Migration guide to version 15" permalink: /migration-8-to-15/ +parent: Migration guides +grandParent: Aditional information nav_exclude: true --- {% include base_path %} diff --git a/docs/aditional-information/20-migrations-to-15.6.0.md b/docs/aditional-information/20-migrations-to-15.6.0.md new file mode 100644 index 000000000..e8f482b40 --- /dev/null +++ b/docs/aditional-information/20-migrations-to-15.6.0.md @@ -0,0 +1,97 @@ +--- +layout: default +title: "Migration Guide: Upgrading from 15.x.x to 15.6.0" +permalink: /migration-15.x.x-to-15.6.0/ +parent: Migration guides +grandParent: Aditional information +nav_exclude: true +--- +{% include base_path %} +{% include toc %} + +## **Proceso de Migración de Ontimize Web 15.x.x a la versión 15.6.0** + +Este proceso cubre **exclusivamente los cambios incompatibles** (*breaking changes*) introducidos en la versión 15.6.0 de Ontimize Web. Úsalo para asegurar una migración completa y segura. + +**Importante:** Al migrar a `ontimize-web-ngx@15.6.0`, los siguientes addons oficiales **también deben actualizarse** para mantener la compatibilidad: + - `ontimize-web-ngx-chart@15.1.0` + - `ontimize-web-ngx-report@15.2.0` + - `ontimize-web-ngx-filemanager@15.1.0` + + +### 1. Cambio de tipo en `servicesConfiguration` en app.config.ts + +* Cambiar la declaración de: + + ```ts + servicesConfiguration?: Object; + ``` + + a: + + ```ts + servicesConfiguration?: OntimizeServiceConfig | JSONAPIServiceConfig; + ``` +* Importar `OntimizeServiceConfig` o `JSONAPIServiceConfig` desde `ontimize-web-ngx`. +* Incluir el tipo de servicio explícitamente si es necesario: + + +### 2. Reemplazo de `OntimizeBaseService` + +* Buscar todas las clases que extienden `OntimizeBaseService` y reemplazarlas por uno de los siguientes servicios, según el caso: + - `OntimizeService` (uso estándar) + - `OntimizeEEService` (para Enterprise Edition) + - `JSONApiService` (para backends JSON:API) + +* Verificar que el constructor use `super(injector)`. + + +### 3. Cambio en el método `getQueryArguments` + +* Actualizar la firma en llamadas al método: + + * `ovrrArgs` ahora es de tipo `OQueryDataArgs`. + * El método ahora devuelve un `OQueryParams`, no un `any[]`. + +* Antes: + +```ts +getQueryArguments(filter: object, ovrrArgs?: any): any[] +``` + +* Después: + +```ts +getQueryArguments(filter: object, ovrrArgs?: OQueryDataArgs): OQueryParams +``` + +### 4. Cambio de nombre OntimizeQueryArgumentsAdapter + +* Renombrar `OntimizeQueryArgumentsAdapter` por `OntimizeRequestArgumentsAdapter` + +### 5. Cambio de interfaz en adaptadores de respuesta + +* Buscar clases que implementan `ServiceResponseAdapter`. + * Reemplazar por `IServiceResponseAdapter`. + * Verificar que implementen el método `adaptResponse()` correctamente. + +* Antes: + +```ts +export class MyAdapter implements ServiceResponseAdapter { + adaptResponse(resp: any): BaseServiceResponse { ... } +} +``` + +* Después: + +```ts +export class MyAdapter implements IServiceResponseAdapter { + adaptResponse(resp: any): BaseServiceResponse { ... } +} +``` + + + + + diff --git a/docs/aditional-information/migration-page.md b/docs/aditional-information/migration-page.md index d7c6f8227..8257ad742 100644 --- a/docs/aditional-information/migration-page.md +++ b/docs/aditional-information/migration-page.md @@ -12,4 +12,5 @@ nav_order: 3 In this page you can view migration guides for specific versions where additional steps are need. -* Migration guide from ontimize web 8 to ontimize web 15 \ No newline at end of file +* Migration guide from ontimize web 8 to ontimize web 15 +* Migration guide from ontimize web 15.x.x to ontimize web 15.6.0 \ No newline at end of file