Social Links

Social Links is helping to detect, validate and sanitize social (desktop & mobile) links

Install

1npm i @teamteanpm2024/tempore-non-vitae --save

Demo

• https://awesome-web-tools.web.app/@teamteanpm2024/tempore-non-vitae - Example use case
• https://gkucmierz.github.io/@teamteanpm2024/tempore-non-vitae-app - Detect profile demo (v1.7.0)

Using

1import { SocialLinks, TYPE_MOBILE } from '@teamteanpm2024/tempore-non-vitae';
2const socialLinks = new SocialLinks();
3
4const link = 'http://www.linkedin.com/in/gkucmierz';
5const profileName = socialLinks.detectProfile(link); // 'linkedin'
6
7console.log(socialLinks.isValid(profileName, link)); // true
8console.log(socialLinks.sanitize(profileName, link)); // 'https://linkedin.com/in/gkucmierz'
9console.log(socialLinks.sanitize(profileName, link, TYPE_MOBILE)); // 'https://linkedin.com/mwlite/in/gkucmierz'

Above examples works based on predefined linkedin profile:

1import { Profile } from '@teamteanpm2024/tempore-non-vitae';
2const linkedinProfile: Profile =
3{ name: 'linkedin',
4    matches: [
5      {
6        match: '(https?://)?(www.)?linkedin.com/in/({PROFILE_ID})', group: 3, type: TYPE_DESKTOP,
7        pattern: 'https://linkedin.com/in/{PROFILE_ID}'
8      },
9      {
10        match: '(https?://)?(www.)?linkedin.com/mwlite/in/({PROFILE_ID})', group: 3, type: TYPE_MOBILE,
11        pattern: 'https://linkedin.com/mwlite/in/{PROFILE_ID}'
12      },
13      { match: '({PROFILE_ID})', group: 1 },
14    ]
15};

Add new profile

1import { SocialLinks, Profile } from '@teamteanpm2024/tempore-non-vitae';
2
3const socialLinks = new SocialLinks();
4const profileMatches: ProfileMatch[] = [ ... ];
5
6socialLinks.addProfile('profileName', profileMatches);

Configuration

1import { SocialLinks, Config } from '@teamteanpm2024/tempore-non-vitae';
2
3const config: Config = {
4  usePredefinedProfiles: true,
5  trimInput: true,
6  allowQueryParams: false,
7};
8const socialLinks = new SocialLinks(config);

Build

Watch, tsc build

1npm run start

Tests

Just jest tests

1npm run test

or

1npm run test:watch

Contributing

CONTRIBUTING.md