@edenred-falcon/shared v1.3.8

@edenred-falcon/shared

A library that implements business validation rules of Edenred's Falcon project.

Install the NPM module

To install this package, please run the following command-line within a terminal inside your project.

npm install @edenred-falcon/shared

Using the library

Email validation

Printed Card validation rules

Examples of Use

const companyName = "New Company Ltd.";
const isValid = isCardPrintedCompanyLengthValid(companyName);

if (isValid) {
    // The company name has a valid length
} else {
    // ERROR: The company name exceed the maximum length
}

Validation patterns

Validate Pattern

To validate an input string using validation patterns, you have to use helper function validatePattern. The validatePattern(input, patternName, countryCode?) function get three parameters input (the input string to validate), patternName (see the list bellow) and countryCode (optional).

The country code parameter make the pattern more restrictive regarding the country specific rules.

Get Pattern To get validation pattern, you have to use helper function getPattern. The getPattern(patternName, countryCode?) function get two parameters patternName (see the list bellow) and countryCode (optional).

The country code parameter make the pattern more restrictive regarding the country specific rules.

Available patterns

Examples of Use

let ibanPattern: RegExp;

// Get a generic regex pattern to validate iban (permissive mode)
ibanPattern = getPattern('iban');

// Or, get a country specific regex pattern to validate iban (restrictive mode)
ibanPattern = getPattern('iban', 'de');

// Then use the regular expression as in vanilla JavaScript
const isIbanValid: boolean = ibanPattern.test('DE021894367439832');

Angular Modules

Internationalization (i18n)

This module relies on the NgxTranslate package

Examples of Use

Import the TranslateModule

import { TranslateModule } from '@edenred-falcon/shared/angular/i18n';

@NgModule({
    imports: [
        TranslateModule.forRoot({
            defaultLanguage: 'en',
            supportedLocales: ['en-EN', 'de-DE']
        }),
    ]
})
export class AppModule {
}

import { TranslateModule } from '@edenred-falcon/shared/angular/i18n';

@NgModule({
    imports: [
        TranslateModule
    ]
})
export class FeatureModule {
}

Use it in your templates:

{{ 'greetings' | translate }}

{{ 'greetings.with.number.of.cards' | translate: { number_of_cards: 3 } }}

Your translations will be loaded from /assets/i18n/lang.json

LocaleService

TranslateService

POEditor CLI

Import your POEditor translations into your project

Generate the configuration file

npx -p @edenred-falcon/shared poeditor init .

Run import

npx -p @edenred-falcon/shared poeditor import ./poeditor.config.json

Help

npx -p @edenred-falcon/shared poeditor <command> --help