@veeroute/lss-packer-angular 7.21.2852 → 7.22.2904

package/README.md

@@ -1,162 +1,163 @@
-# @veeroute/lss-packer-angular@7.21.2852
+# @veeroute/lss-packer-angular@7.22.2904
 
-## General usage
+Veeroute Packer API.  # Description  The service is designed to calculate the placement of goods inside given packages.  ## Types of packages  ### Pallet  ![pallet](../images/packer_pallet.svg)  *Mono-pallet*  If the pallet is fully equipped with the same product, then such a pallet is called **mono-pallet**, such a pallet has the following loading rules:  1. The maximum allowable height of the pallet with the goods laid on it is taken into account. 1. The maximum allowable weight of the loaded pallet is taken into account. 1. Goods packages can only be stacked parallel to the walls of the pallet. 1. It is allowed to rotate packages around the vertical Z-axis and only at a right angle. 1. In order to equalize the height between the positions (to place another pallet on top), empty spaces can be added to the stacking by layers.  *Zone tray*  After the formation of mono-pallets, the remaining part of the goods of the same article is placed on the next pallet, which is divided into zones by means of a cardboard partition in such a way that only one item of goods is placed in each zone, while the zones have the following restrictions:  1. The zones are rectangular. 1. The ratio between the sides of the zones can be any. 1. One of the sides of any zone is always in contact with the edge of the pallet. 1. Permissible number of zones on a pallet: from 2 to 6. 1. Each zone is filled according to the rules for filling a mono-pallet. 1. The stacking height of all goods does not exceed 50 mm, so that another pallet can be placed on top of such a pallet. 1. It is allowed to form pallets with different stacking heights for different positions (height difference is more than 50 mm), if these are the top pallets in the stack.  ### Mixbox  ![mixbox](../images/packer_mixbox.svg)  If the above steps fail to place the item in this way, so that the pallet is of the required height or weight, mixboxes are used:  1. Mixbox can only be placed in one layer. 1. Different goods can be placed in one mixbox, in this case it is divided by partitions similarly to a pallet (the only difference is that the height of the packed goods is not aligned). 1. Mixboxes can be mixed with items on the same pallet. 1. One product can be packed in different mixboxes.  ### Slot  ![slot](../images/packer_slot.svg)  The loaded pallets are stacked on top of each other, the slot is where the stack of pallets is placed. The slot has no physical body - so the dimensions of the `body` of the slot are zero.  ## Coordinate system  ![coordinates](../images/packer_coordinates.svg)  To indicate the location of packages and goods, a local coordinate system is used, in which the coordinates of a particular object are indicated relative to the near left lower corner of the parent object, while:  * Horizontal plane - axes **X**, **Y** * Vertical - **Z** axis  The ratio of the axes of goods and packages:  * Width - **X** * Length - **Y** * Height - **Z**  ## Entity diagram  ![erd](../uml/packer.svg)
 
-In your Angular project:
+The version of the OpenAPI document: 7.22.2904
 
+## Building
 
-```
-// without configuring providers
-import { LssPackerApiModule } from '@veeroute/lss-packer-angular';
-import { HttpClientModule } from '@angular/common/http';
+To install the required dependencies and to build the typescript sources run:
 
-@NgModule({
-    imports: [
-        LssPackerApiModule,
-        // 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 { LssPackerApiModule, Configuration, ConfigurationParameters } from '@veeroute/lss-packer-angular';
-
-export function apiConfigFactory (): Configuration {
-  const params: ConfigurationParameters = {
-    // set configuration parameters here.
-  }
-  return new Configuration(params);
-}
-
-@NgModule({
-    imports: [ LssPackerApiModule.forRoot(apiConfigFactory) ],
-    declarations: [ AppComponent ],
-    providers: [],
-    bootstrap: [ AppComponent ]
-})
-export class AppModule {}
-```
+## Publishing
 
-```typescript
-// configuring providers with an authentication service that manages your access tokens
-import { LssPackerApiModule, Configuration } from '@veeroute/lss-packer-angular';
+First build the package then run `npm publish dist` (don't forget to specify the `dist` folder!)
 
-@NgModule({
-    imports: [ LssPackerApiModule ],
-    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-packer-angular@7.22.2904 --save
 ```
 
-```typescript
-import { DefaultApi } from '@veeroute/lss-packer-angular';
+_without publishing (not recommended):_
 
-export class AppComponent {
-    constructor(private apiGateway: DefaultApi) { }
-}
+```console
+npm install PATH_TO_GENERATED_PACKAGE/dist.tgz --save
 ```
 
-Note: The LssPackerApiModule 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 / LssPackerApiModules
+_using `npm link`:_
 
-In order to use multiple `LssPackerApiModules` 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 { LssPackerApiModule } from 'my-api-path';
-import { LssPackerApiModule as OtherApiModule } from 'my-other-api-path';
-import { HttpClientModule } from '@angular/common/http';
+```console
+npm link
+```
 
-@NgModule({
-  imports: [
-    LssPackerApiModule,
-    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-packer-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-packer-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-packer-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 { LssPackerApiModule } from '@veeroute/lss-packer-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-packer-angular';
+import { ApplicationConfig } from '@angular/core';
+import { provideHttpClient } from '@angular/common/http';
+import { provideApi } from '@veeroute/lss-packer-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-packer-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-packer-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-packer-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/packService.d.ts

@@ -1,21 +1,16 @@
-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 { CalculationAsyncResultPacker } from '../model/calculationAsyncResult';
 import { CalculationStatePacker } from '../model/calculationState';
 import { PackResultPacker } from '../model/packResult';
 import { ValidateResultPacker } from '../model/validateResult';
 import { Configuration } from '../configuration';
+import { BaseService } from '../api.base.service';
 import { PackServiceInterface, CancelPackCalculationRequestParams, DeletePackResultRequestParams, ReadPackResultRequestParams, ReadPackStateRequestParams, RunPackCalculationRequestParams, RunPackCalculationAsyncRequestParams, RunPackValidationRequestParams } from './packServiceInterface';
 import * as i0 from "@angular/core";
-export declare class PackService implements PackServiceInterface {
+export declare class PackService extends BaseService implements PackServiceInterface {
     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/packServiceInterface.d.ts

@@ -1,7 +1,7 @@
 /**
  * VRt.Packer [PC]
  *
- * 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 { CheckResultPacker } from '../model/checkResult';
 import { VersionResultPacker } 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.Packer [PC]
  *
- * 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.Packer [PC]
+ *
+ * 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;
 }