@smartpartner/postdirekt-autocomplete v2.0.1

Smartpartner Autocomplete

this is a branch of netresearch/postdirekt-autocomplete-monorepo which supports building (house number) selection when country, zip, city and street is selected

SDK Developer and Contribution Workflow

Prerequisites

Node.js

Before you can start working on the Autocomplete monorepo, you need to have Node.js installed on your machine. The currently supported versions are 10.0.0 or greater.

To download Node.js visit https://nodejs.org/en/download/.

NOTE: You can use a tool like NVM or N to install and manage multiple node versions

Yarn

In addition to Node.js we use yarn to facilitate multi package development.

To install yarn follow the instructions listed on their website: https://yarnpkg.com/en/docs/install

Verify Prerequisites

You can verify your setup by running the following commands in your terminal:

$ node -v
$ yarn -v

Your Node.js version should be 10.0.0 or greater, your yarn version should be 1.0.0 or greater,

Install Dependencies

Once you have Node.js and yarn installed on your machine and have validated that you are running the proper version, you can set up the development environment by running the following at the root of the repo:

$ yarn

Once you have installed all the dependencies, you can build both packages by running the following command the root of the repo:

$ yarn build

Packages

packages/autocomplete-sdk

This folder contains modified @netresearch/postdirekt-autocomplete-sdk, responsible for abstracting away the Deutsche Post Direkt Autocomplete 2.0 API.

See Readme.

packages/autocomplete-library

This folder contains modified _@netresearch/postdirekt-autocomplete-library, responsible for registering input listeners on given input fields (street address, city, postcode and house number) and fetching address suggestions from the Autocomplete API via the autocomplete-sdk package.

See Readme.

    postDirekt = postdirektAutocompleteLib.init(
        document.getElementById('street'),
        document.getElementById('city'),
        document.getElementById('postcode'),
        document.getElementById('house_nr'),
        document.getElementById('country'),
        'DE',
        '_hash_'            
    );

Testing the packages

Running the Tests

You can run the tests with the command

$ yarn test

To run the linter, do

$ yarn lint

Building the packages

You can build ES2017 compatible artifacts (this is what's published on npm) with

$ yarn build

You can also build ES5 compatible artifacts (output in <rootDir>/dist) with

$ yarn build:es5