@veeroute/[email protected]

Software interface for Veeroute Packer. # Description This service is designed to calculate the placement of goods within specified packages. ## Package Types ### Slot Loaded pallets are stacked on top of each other; a slot is the location where the pallet stack is placed. A slot has no physical body, so the dimensions of its body are zero. ### Pallet If a pallet is completely filled with identical goods, it is called a mono-pallet. Such a pallet has the following loading rules: 1. The maximum permissible height of the pallet with the goods placed on it is taken into account. 1. The maximum permissible weight of the loaded pallet is taken into account. 1. Product packages may only be stacked parallel to the pallet walls. 1. Rotating packages around the vertical Z axis is permitted, but only at right angles. 1. To equalize the height between positions (to accommodate another pallet on top), empty spaces may be added to the stacking layer. After forming a single-panel pallet, the remaining products of the same SKU are placed on the next pallet. Such a pallet is divided into zones using a cardboard divider so that each zone contains only one product SKU. The zones have the following restrictions: 1. The zones are rectangular. 1. The ratio between the sides of the zones may be any. 1. One side of any zone always touches the edge of the pallet. 1. The permitted number of zones on a pallet is from 2 to 6. 1. Each zone is filled according to the rules for filling a single-panel pallet. 1. The stacking height of all products must not exceed 50 mm, allowing for another pallet to be placed on top of the pallet. 1. Pallets with different stacking heights for different items (height differences greater than 50 mm) are permitted, provided they are the top pallets in the stack. ### Mixbox If the steps described above do not allow the product to be stacked so that the pallet reaches the required height or weight, mixboxes are used: 1. Mixboxes can only be stacked in a single layer. 1. A single mixbox can contain different products; in this case, it is divided by dividers similar to a pallet (the only difference is that the height of the packed product is not aligned). 1. Mixboxes can be mixed with product items on the same pallet. 1. The same product can be packed in different mixboxes. ## Coordinate System A local coordinate system is used to indicate the location of packages and products. In this system, the coordinates of a specific object are specified relative to the lower-left corner of the parent object, as follows: * Horizontal plane - X, Y axes * Vertical plane - Z axis Product and package axes ratio: * Width - X axis * Length - Y axis * Height - Z axis ## Entity Diagram

The version of the OpenAPI document: 7.35.3290

Building

To install the required dependencies and to build the typescript sources run:

npm install
npm run build

Publishing

First build the package then run npm publish dist (don't forget to specify the dist folder!)

Consuming

Navigate to the folder of your consuming project and run one of next commands.

published:

npm install @veeroute/[email protected] --save

without publishing (not recommended):

npm install PATH_TO_GENERATED_PACKAGE/dist.tgz --save

It's important to take the tgz file, otherwise you'll get trouble with links on windows

using npm link:

In PATH_TO_GENERATED_PACKAGE/dist:

npm link

In your project:

npm link @veeroute/lss-packer-angular

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

In your Angular project:

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()
    ],
};

NOTE If you're still using AppModule and haven't migrated yet, you can still import an Angular module:

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.

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('http://localhost:9999')
    ],
};

// with a custom configuration
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({
            withCredentials: true,
            username: 'user',
            password: 'password'
        })
    ],
};

// 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
        }
    ],
};

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:

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';

export const appConfig: ApplicationConfig = {
    providers: [
        // ...
        provideHttpClient(),
        provideUserApi(environment.basePath),
        provideAdminApi(environment.basePath),
    ],
};

Customizing path parameter encoding

Without further customization, only path-parameters of style 'simple' and Dates for format 'date-time' are encoded correctly.

Other styles (e.g. "matrix") are not that easy to encode and thus are best delegated to other libraries (e.g.: @honoluluhenk/http-param-expander).

To implement your own parameter encoding (or call another library), pass an arrow-function or method-reference to the encodeParam property of the Configuration-object (see General Usage above).

Example value for use in your Configuration-Provider:

new Configuration({
    encodeParam: (param: Param) => myFancyParamEncoder(param),
})