@veeroute/lss-agro-angular 7.21.2852 → 7.22.2904

package/README.md

@@ -1,162 +1,163 @@
-# @veeroute/lss-agro-angular@7.21.2852
+# @veeroute/lss-agro-angular@7.22.2904
 
-## General usage
+Veeroute Agro API.  # Description  The service is designed to calculate the work plan of production facilities.  ## Objects overview  ![objects](../images/agro_objects.svg)  ### Field  - produces a certain crop of a certain moisture content - products from the field can only be moved to the Elevator or Factory  ### Elevator  - consists of Gates, Dryers, short-term and long-term storage areas - dries the grain (if the moisture content of the crop is more than acceptable) - stores dry grain in short-term storage places (warehouses), while unloading and loading grain is allowed within one day - stores dry grain in long-term storage places (sleeves, trenches, mounds) - when stored in one storage, only one type of culture can be located - sells surplus grain to the Market - production processes inside the facility: drying, loading / unloading to a storage location, storage  ### Factory  - consists of Gates, Dryers, Bunkers, Consumers - [if drying is present] dries the grain (if the moisture content of the crop is more than allowed) - stores dry grain in Bunkers (short-term storage tied to a specific crop) - maintains a minimum supply of grain for consumption in the Bunkers - Consumes grain from Bunkers - buys the missing grain from the Market - production processes inside the facility: drying, loading / unloading to a storage location, storage, consumption  ### Market  - buys grain from elevators - sells grain to factories  ## Project  The project reflects the planned sequence of operations on agricultural crops, the types of operations are described below.  ### HARVEST  Crop harvesting:  - between production facilities (Field and Elevator or Field) - the operation takes place within one day - on the Field there is a determination of grain moisture  |             | Object (target_key) | Subobject (target_detail_key) | |-------------|---------------------|-------------------------------| | Source      | Field               | -                             | | Destination | Elevator or Factory | Gate                          |  ### DRY  Drying culture:  - inside the production facility (Elevator or Field) - duration of the operation - days - during the drying process, the mass and type of humidity changes (WET -> DRY) - the source indicates the mass of raw culture - in the appointment, the resulting mass of dry culture is indicated  |             | Object (target_key) | Subobject (target_detail_key) | |-------------|---------------------|-------------------------------| | Source      | Elevator or Factory | Gate                          | | Destination | Elevator or Factory | Dryer                         |  ### LOAD  Loading culture from the Gate to the Storage Location (long-term, short-term, silo):  - between parts of one production facility (Elevator or Field) - the operation takes place within one day  |             | Object (target_key) | Subobject (target_detail_key)                    | |-------------|---------------------|--------------------------------------------------| | Source      | Elevator or Factory | Gate or Dryer                                    | | Destination | Elevator or Factory | Storage location (long-term, short-term, bunker) |  ### UNLOAD  Unloading the culture from the storage place to the gate:  - between parts of one production facility (Elevator) - the operation takes place within one day  |             | Object (target_key) | Subobject (target_detail_key)                    | |-------------|---------------------|--------------------------------------------------| | Source      | Elevator            | Storage location (long-term, short-term, bunker) | | Destination | Elevator            | Gate                                             |  ### STORE  Culture storage:  - the operation takes place within one day - storage location does not change  |             | Object (target_key) | Subobject (target_detail_key)                    | |-------------|---------------------|--------------------------------------------------| | Source      | Elevator or Factory | Storage location (long-term, short-term, bunker) | | Destination | Elevator or Factory | The same storage location                        |  ### RELOCATE  Transportation between production facilities:  - between production facilities (Elevator and Field) - the operation takes place within one day  |             | Object (target_key) | Subobject (target_detail_key) | |-------------|---------------------|-------------------------------| | Source      | Elevator            | Gate                          | | Destination | Factory             | Gate                          |  ### CONSUMPTION  Field crop consumption:  - between parts of one production facility (Field) - the operation takes place within one day - consumption comes from the Bunker - in addition, we can consume directly from the Gate or Dryer without laying in the Bunker  |             | Object (target_key) | Subobject (target_detail_key) | |-------------|---------------------|-------------------------------| | Source      | Factory             | Hopper or Gate or Dryer       | | Destination | Factory             | Consumer                      |  ### SELL  Sale of culture:  - between production facilities (Elevator and Market) - the operation takes place within one day  |             | Object (target_key) | Subobject (target_detail_key) | |-------------|---------------------|-------------------------------| | Source      | Elevator            | Gate                          | | Destination | Market              | Contract                      |  ### BUY  Buying culture:  - between production facilities (Market and Factory) - the operation takes place within one day  |             | Object (target_key) | Subobject (target_detail_key) | |-------------|---------------------|-------------------------------| | Source      | Market              | Contract                      | | Destination | Factory             | Gate                          |  ## Entity relationship diagram  ![erd](../uml/agro.svg) 
 
-In your Angular project:
+The version of the OpenAPI document: 7.22.2904
 
+## Building
 
-```
-// without configuring providers
-import { LssAgroApiModule } from '@veeroute/lss-agro-angular';
-import { HttpClientModule } from '@angular/common/http';
+To install the required dependencies and to build the typescript sources run:
 
-@NgModule({
-    imports: [
-        LssAgroApiModule,
-        // make sure to import the HttpClientModule in the AppModule only,
-        // see https://github.com/angular/angular/issues/20575
-        HttpClientModule
-    ],
-    declarations: [ AppComponent ],
-    providers: [],
-    bootstrap: [ AppComponent ]
-})
-export class AppModule {}
+```console
+npm install
+npm run build
 ```
 
-```typescript
-// configuring providers
-import { LssAgroApiModule, Configuration, ConfigurationParameters } from '@veeroute/lss-agro-angular';
-
-export function apiConfigFactory (): Configuration {
-  const params: ConfigurationParameters = {
-    // set configuration parameters here.
-  }
-  return new Configuration(params);
-}
-
-@NgModule({
-    imports: [ LssAgroApiModule.forRoot(apiConfigFactory) ],
-    declarations: [ AppComponent ],
-    providers: [],
-    bootstrap: [ AppComponent ]
-})
-export class AppModule {}
-```
+## Publishing
 
-```typescript
-// configuring providers with an authentication service that manages your access tokens
-import { LssAgroApiModule, Configuration } from '@veeroute/lss-agro-angular';
+First build the package then run `npm publish dist` (don't forget to specify the `dist` folder!)
 
-@NgModule({
-    imports: [ LssAgroApiModule ],
-    declarations: [ AppComponent ],
-    providers: [
-      {
-        provide: Configuration,
-        useFactory: (authService: AuthService) => new Configuration(
-          {
-            basePath: environment.apiUrl,
-            accessToken: authService.getAccessToken.bind(authService)
-          }
-        ),
-        deps: [AuthService],
-        multi: false
-      }
-    ],
-    bootstrap: [ AppComponent ]
-})
-export class AppModule {}
+## Consuming
+
+Navigate to the folder of your consuming project and run one of next commands.
+
+_published:_
+
+```console
+npm install @veeroute/lss-agro-angular@7.22.2904 --save
 ```
 
-```typescript
-import { DefaultApi } from '@veeroute/lss-agro-angular';
+_without publishing (not recommended):_
 
-export class AppComponent {
-    constructor(private apiGateway: DefaultApi) { }
-}
+```console
+npm install PATH_TO_GENERATED_PACKAGE/dist.tgz --save
 ```
 
-Note: The LssAgroApiModule is restricted to being instantiated once app wide.
-This is to ensure that all services are treated as singletons.
+_It's important to take the tgz file, otherwise you'll get trouble with links on windows_
 
-### Using multiple OpenAPI files / APIs / LssAgroApiModules
+_using `npm link`:_
 
-In order to use multiple `LssAgroApiModules` generated from different OpenAPI files,
-you can create an alias name when importing the modules
-in order to avoid naming conflicts:
+In PATH_TO_GENERATED_PACKAGE/dist:
 
-```typescript
-import { LssAgroApiModule } from 'my-api-path';
-import { LssAgroApiModule as OtherApiModule } from 'my-other-api-path';
-import { HttpClientModule } from '@angular/common/http';
+```console
+npm link
+```
 
-@NgModule({
-  imports: [
-    LssAgroApiModule,
-    OtherApiModule,
-    // make sure to import the HttpClientModule in the AppModule only,
-    // see https://github.com/angular/angular/issues/20575
-    HttpClientModule
-  ]
-})
-export class AppModule {
+In your project:
 
-}
+```console
+npm link @veeroute/lss-agro-angular
 ```
 
-### Set service base path
+__Note for Windows users:__ The Angular CLI has troubles to use linked npm packages.
+Please refer to this issue <https://github.com/angular/angular-cli/issues/8284> for a solution / workaround.
+Published packages are not effected by this issue.
+
+### General usage
 
-If different than the generated base path, during app bootstrap, you can provide the base path to your service.
+In your Angular project:
 
 ```typescript
-import { BASE_PATH } from '@veeroute/lss-agro-angular';
 
-bootstrap(AppComponent, [
-    { provide: BASE_PATH, useValue: 'https://your-web-service.com' },
-]);
+import { ApplicationConfig } from '@angular/core';
+import { provideHttpClient } from '@angular/common/http';
+import { provideApi } from '@veeroute/lss-agro-angular';
+
+export const appConfig: ApplicationConfig = {
+    providers: [
+        // ...
+        provideHttpClient(),
+        provideApi()
+    ],
+};
 ```
 
-or
+**NOTE**
+If you're still using `AppModule` and haven't [migrated](https://angular.dev/reference/migrations/standalone) yet, you can still import an Angular module:
+```typescript
+import { LssAgroApiModule } from '@veeroute/lss-agro-angular';
+```
+
+If different from the generated base path, during app bootstrap, you can provide the base path to your service.
 
 ```typescript
-import { BASE_PATH } from '@veeroute/lss-agro-angular';
+import { ApplicationConfig } from '@angular/core';
+import { provideHttpClient } from '@angular/common/http';
+import { provideApi } from '@veeroute/lss-agro-angular';
 
-@NgModule({
-    imports: [],
-    declarations: [ AppComponent ],
-    providers: [ provide: BASE_PATH, useValue: 'https://your-web-service.com' ],
-    bootstrap: [ AppComponent ]
-})
-export class AppModule {}
+export const appConfig: ApplicationConfig = {
+    providers: [
+        // ...
+        provideHttpClient(),
+        provideApi('http://localhost:9999')
+    ],
+};
 ```
 
-### Using @angular/cli
+```typescript
+// with a custom configuration
+import { ApplicationConfig } from '@angular/core';
+import { provideHttpClient } from '@angular/common/http';
+import { provideApi } from '@veeroute/lss-agro-angular';
 
-First extend your `src/environments/*.ts` files by adding the corresponding base path:
+export const appConfig: ApplicationConfig = {
+    providers: [
+        // ...
+        provideHttpClient(),
+        provideApi({
+            withCredentials: true,
+            username: 'user',
+            password: 'password'
+        })
+    ],
+};
+```
 
 ```typescript
-export const environment = {
-  production: false,
-  API_BASE_PATH: 'http://127.0.0.1:8080'
+// with factory building a custom configuration
+import { ApplicationConfig } from '@angular/core';
+import { provideHttpClient } from '@angular/common/http';
+import { provideApi, Configuration } from '@veeroute/lss-agro-angular';
+
+export const appConfig: ApplicationConfig = {
+    providers: [
+        // ...
+        provideHttpClient(),
+        {
+            provide: Configuration,
+            useFactory: (authService: AuthService) => new Configuration({
+                    basePath: 'http://localhost:9999',
+                    withCredentials: true,
+                    username: authService.getUsername(),
+                    password: authService.getPassword(),
+            }),
+            deps: [AuthService],
+            multi: false
+        }
+    ],
 };
 ```
 
-In the src/app/app.module.ts:
+### Using multiple OpenAPI files / APIs
+
+In order to use multiple APIs generated from different OpenAPI files,
+you can create an alias name when importing the modules
+in order to avoid naming conflicts:
 
 ```typescript
-import { BASE_PATH } from '@veeroute/lss-agro-angular';
+import { provideApi as provideUserApi } from 'my-user-api-path';
+import { provideApi as provideAdminApi } from 'my-admin-api-path';
+import { HttpClientModule } from '@angular/common/http';
 import { environment } from '../environments/environment';
 
-@NgModule({
-  declarations: [
-    AppComponent
-  ],
-  imports: [ ],
-  providers: [{ provide: BASE_PATH, useValue: environment.API_BASE_PATH }],
-  bootstrap: [ AppComponent ]
-})
-export class AppModule { }
+export const appConfig: ApplicationConfig = {
+    providers: [
+        // ...
+        provideHttpClient(),
+        provideUserApi(environment.basePath),
+        provideAdminApi(environment.basePath),
+    ],
+};
 ```
 
 ### Customizing path parameter encoding

package/api/planService.d.ts

@@ -1,4 +1,4 @@
-import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
+import { HttpClient, HttpResponse, HttpEvent, HttpContext } from '@angular/common/http';
 import { Observable } from 'rxjs';
 import { CalculationAsyncResultAgro } from '../model/calculationAsyncResult';
 import { CalculationStateAgro } from '../model/calculationState';
@@ -6,17 +6,12 @@ import { PlanResultAgro } from '../model/planResult';
 import { PlanTaskAgro } from '../model/planTask';
 import { ValidateResultAgro } from '../model/validateResult';
 import { Configuration } from '../configuration';
+import { BaseService } from '../api.base.service';
 import { PlanServiceInterface, CancelPlanCalculationRequestParams, DeletePlanResultRequestParams, ReadPlanResultRequestParams, ReadPlanStateRequestParams, RunPlanCalculationRequestParams, RunPlanCalculationAsyncRequestParams, RunPlanClipRequestParams, RunPlanValidationRequestParams } from './planServiceInterface';
 import * as i0 from "@angular/core";
-export declare class PlanService implements PlanServiceInterface {
+export declare class PlanService extends BaseService implements PlanServiceInterface {
     protected httpClient: HttpClient;
-    protected basePath: string;
-    defaultHeaders: HttpHeaders;
-    configuration: Configuration;
-    encoder: HttpParameterCodec;
-    constructor(httpClient: HttpClient, basePath: string | string[], configuration: Configuration);
-    private addToHttpParams;
-    private addToHttpParamsRecursive;
+    constructor(httpClient: HttpClient, basePath: string | string[], configuration?: Configuration);
     /**
      * Cancel calculation
      * Cancel calculation process by the calculation identifier.

package/api/planServiceInterface.d.ts

@@ -1,7 +1,7 @@
 /**
  * VRt.Agro [AG]
  *
- * The version of the OpenAPI document: 7.21.2852
+ * The version of the OpenAPI document: 7.22.2904
  * Contact: servicedesk@veeroute.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator.

package/api/systemService.d.ts

@@ -1,19 +1,14 @@
-import { HttpClient, HttpHeaders, HttpResponse, HttpEvent, HttpParameterCodec, HttpContext } from '@angular/common/http';
+import { HttpClient, HttpResponse, HttpEvent, HttpContext } from '@angular/common/http';
 import { Observable } from 'rxjs';
 import { CheckResultAgro } from '../model/checkResult';
 import { VersionResultAgro } from '../model/versionResult';
 import { Configuration } from '../configuration';
+import { BaseService } from '../api.base.service';
 import { SystemServiceInterface, FileRequestParams } from './systemServiceInterface';
 import * as i0 from "@angular/core";
-export declare class SystemService implements SystemServiceInterface {
+export declare class SystemService extends BaseService implements SystemServiceInterface {
     protected httpClient: HttpClient;
-    protected basePath: string;
-    defaultHeaders: HttpHeaders;
-    configuration: Configuration;
-    encoder: HttpParameterCodec;
-    constructor(httpClient: HttpClient, basePath: string | string[], configuration: Configuration);
-    private addToHttpParams;
-    private addToHttpParamsRecursive;
+    constructor(httpClient: HttpClient, basePath: string | string[], configuration?: Configuration);
     /**
      * Checking the availability
      * Checking the service availability.

package/api/systemServiceInterface.d.ts

@@ -1,7 +1,7 @@
 /**
  * VRt.Agro [AG]
  *
- * The version of the OpenAPI document: 7.21.2852
+ * The version of the OpenAPI document: 7.22.2904
  * Contact: servicedesk@veeroute.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator.

package/api.base.service.d.ts

@@ -0,0 +1,21 @@
+/**
+ * VRt.Agro [AG]
+ *
+ * The version of the OpenAPI document: 7.22.2904
+ * Contact: servicedesk@veeroute.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator.
+ * Do not edit the class manually.
+ */
+import { HttpHeaders, HttpParams, HttpParameterCodec } from '@angular/common/http';
+import { Configuration } from './configuration';
+export declare class BaseService {
+    protected basePath: string;
+    defaultHeaders: HttpHeaders;
+    configuration: Configuration;
+    encoder: HttpParameterCodec;
+    constructor(basePath?: string | string[], configuration?: Configuration);
+    protected canConsumeForm(consumes: string[]): boolean;
+    protected addToHttpParams(httpParams: HttpParams, value: any, key?: string, isDeep?: boolean): HttpParams;
+    protected addToHttpParamsRecursive(httpParams: HttpParams, value?: any, key?: string, isDeep?: boolean): HttpParams;
+}

package/configuration.d.ts

@@ -1,4 +1,4 @@
-import { HttpParameterCodec } from '@angular/common/http';
+import { HttpHeaders, HttpParams, HttpParameterCodec } from '@angular/common/http';
 import { Param } from './param';
 export interface ConfigurationParameters {
     /**
@@ -71,7 +71,7 @@ export declare class Configuration {
     credentials: {
         [key: string]: string | (() => string | undefined);
     };
-    constructor(configurationParameters?: ConfigurationParameters);
+    constructor({ accessToken, apiKeys, basePath, credentials, encodeParam, encoder, password, username, withCredentials }?: ConfigurationParameters);
     /**
      * Select the correct content-type to use for a request.
      * Uses {@link Configuration#isJsonMime} to determine the correct content-type.
@@ -100,5 +100,7 @@ export declare class Configuration {
      */
     isJsonMime(mime: string): boolean;
     lookupCredential(key: string): string | undefined;
+    addCredentialToHeaders(credentialKey: string, headerName: string, headers: HttpHeaders, prefix?: string): HttpHeaders;
+    addCredentialToQuery(credentialKey: string, paramName: string, query: HttpParams): HttpParams;
     private defaultEncodeParam;
 }