@superdispatch/phones 0.21.13 → 0.21.18

package/src/phone-service/PhoneService.spec.ts

@@ -1,277 +0,0 @@
-import AwesomePhoneNumber from 'awesome-phonenumber';
-import { CountryISO } from '../country-code-metadata/CountryCodeMetadata';
-import {
-  PhoneNumberFormat,
-  PhoneService,
-  PhoneValidationRules,
-} from '../phone-service/PhoneService';
-
-test.each([
-  ['', 'US', ''],
-  ['5', 'US', '5'],
-  ['50', 'US', '50'],
-  ['506', 'US', '506'],
-  ['506', 'US', '506'],
-  ['506', 'US', '506'],
-  ['5062', 'US', '5062'],
-  ['50623', 'US', '50623'],
-  ['506234', 'US', '506234'],
-  ['5062345', 'US', '5062345'],
-  ['50623456', 'US', '50623456'],
-  ['506234567', 'US', '506234567'],
-  ['5062345678', 'US', '506-234-5678'],
-  ['50623456789', 'US', '50623456789'],
-  ['506234567890', 'US', '506234567890'],
-
-  ['1', 'US', '1'],
-  ['15', 'US', '15'],
-  ['150', 'US', '150'],
-  ['1506', 'US', '1506'],
-  ['15062', 'US', '15062'],
-  ['150623', 'US', '150623'],
-  ['1506234', 'US', '1506234'],
-  ['15062345', 'US', '15062345'],
-  ['150623456', 'US', '150623456'],
-  ['1506234567', 'US', '1506234567'],
-  ['15062345678', 'US', '506-234-5678'],
-  ['150623456789', 'US', '50623456789'],
-  ['1506234567890', 'US', '506234567890'],
-
-  ['+', 'US', ''],
-  ['+1', 'US', ''],
-  ['+15', 'US', '5'],
-  ['+150', 'US', '50'],
-  ['+1506', 'US', '506'],
-  ['+15062', 'US', '5062'],
-  ['+150623', 'US', '50623'],
-  ['+1506234', 'US', '506234'],
-  ['+15062345', 'US', '5062345'],
-  ['+150623456', 'US', '50623456'],
-  ['+1506234567', 'US', '506234567'],
-  ['+15062345678', 'CA', '506-234-5678'],
-  ['+150623456789', 'US', '50623456789'],
-  ['+1506234567890', 'US', '506234567890'],
-  ['+15062345678,+15062345679,+15062345680', 'CA', '506-234-5678'],
-])(
-  '#getInfo(%p): { country: %p, nationalNumber: %p }',
-  (input, country, nationalNumber) => {
-    expect(new PhoneService(AwesomePhoneNumber).getInfo(input)).toEqual({
-      country,
-      nationalNumber,
-    });
-  },
-);
-
-test.each<
-  [
-    input: string,
-    format: undefined | PhoneNumberFormat,
-    country: undefined | CountryISO,
-    expected: string,
-  ]
->([
-  // Normalizes national number
-  ['!+@1#1$', undefined, undefined, '+11'],
-  ['!+@6#4$1', undefined, undefined, '+641'],
-
-  // Uses `e164` by default
-  ['', undefined, undefined, ''],
-  ['5', undefined, undefined, '+15'],
-  ['50', undefined, undefined, '+150'],
-  ['506', undefined, undefined, '+1506'],
-  ['506', undefined, undefined, '+1506'],
-  ['5062', undefined, undefined, '+15062'],
-  ['50623', undefined, undefined, '+150623'],
-  ['506234', undefined, undefined, '+1506234'],
-  ['5062345', undefined, undefined, '+15062345'],
-  ['50623456', undefined, undefined, '+150623456'],
-  ['506234567', undefined, undefined, '+1506234567'],
-  ['5062345678', undefined, undefined, '+15062345678'],
-  ['50623456789', undefined, undefined, '+150623456789'],
-  ['506234567890', undefined, undefined, '+1506234567890'],
-
-  // Formats national with default country
-  ['', undefined, undefined, ''],
-  ['5', undefined, undefined, '+15'],
-  ['50', undefined, undefined, '+150'],
-  ['506', undefined, undefined, '+1506'],
-  ['5062', undefined, undefined, '+15062'],
-  ['50623', undefined, undefined, '+150623'],
-  ['506234', undefined, undefined, '+1506234'],
-  ['5062345', undefined, undefined, '+15062345'],
-  ['50623456', undefined, undefined, '+150623456'],
-  ['506234567', undefined, undefined, '+1506234567'],
-  ['5062345678', undefined, undefined, '+15062345678'],
-  ['50623456789', undefined, undefined, '+150623456789'],
-  ['506234567890', undefined, undefined, '+1506234567890'],
-
-  // Formats national with provided country
-  ['', undefined, 'NZ', ''],
-  ['5', undefined, 'NZ', '+645'],
-  ['50', undefined, 'NZ', '+6450'],
-  ['506', undefined, 'NZ', '+64506'],
-  ['5062', undefined, 'NZ', '+645062'],
-  ['50623', undefined, 'NZ', '+6450623'],
-  ['506234', undefined, 'NZ', '+64506234'],
-  ['5062345', undefined, 'NZ', '+645062345'],
-  ['50623456', undefined, 'NZ', '+6450623456'],
-  ['506234567', undefined, 'NZ', '+64506234567'],
-  ['5062345678', undefined, 'NZ', '+645062345678'],
-  ['50623456789', undefined, 'NZ', '+6450623456789'],
-  ['506234567890', undefined, 'NZ', '+64506234567890'],
-
-  ['', 'e164', undefined, ''],
-  ['+', 'e164', undefined, ''],
-  ['+1', 'e164', undefined, '+1'],
-  ['+15', 'e164', undefined, '+15'],
-  ['+150', 'e164', undefined, '+150'],
-  ['+1506', 'e164', undefined, '+1506'],
-  ['+1506', 'e164', undefined, '+1506'],
-  ['+15062', 'e164', undefined, '+15062'],
-  ['+150623', 'e164', undefined, '+150623'],
-  ['+1506234', 'e164', undefined, '+1506234'],
-  ['+15062345', 'e164', undefined, '+15062345'],
-  ['+150623456', 'e164', undefined, '+150623456'],
-  ['+1506234567', 'e164', undefined, '+1506234567'],
-  ['+15062345678', 'e164', undefined, '+15062345678'],
-  ['+150623456789', 'e164', undefined, '+150623456789'],
-  ['+1506234567890', 'e164', undefined, '+1506234567890'],
-
-  ['', 'rfc3966', undefined, ''],
-  ['+', 'rfc3966', undefined, ''],
-  ['+1', 'rfc3966', undefined, 'tel:+1'],
-  ['+15', 'rfc3966', undefined, 'tel:+1-5'],
-  ['+150', 'rfc3966', undefined, 'tel:+1-50'],
-  ['+1506', 'rfc3966', undefined, 'tel:+1-506'],
-  ['+1506', 'rfc3966', undefined, 'tel:+1-506'],
-  ['+15062', 'rfc3966', undefined, 'tel:+1-5062'],
-  ['+150623', 'rfc3966', undefined, 'tel:+1-50623'],
-  ['+1506234', 'rfc3966', undefined, 'tel:+1-506234'],
-  ['+15062345', 'rfc3966', undefined, 'tel:+1-5062345'],
-  ['+150623456', 'rfc3966', undefined, 'tel:+1-50623456'],
-  ['+1506234567', 'rfc3966', undefined, 'tel:+1-506234567'],
-  ['+15062345678', 'rfc3966', undefined, 'tel:+1-506-234-5678'],
-  ['+150623456789', 'rfc3966', undefined, 'tel:+1-50623456789'],
-  ['+1506234567890', 'rfc3966', undefined, 'tel:+1-506234567890'],
-
-  ['', 'national', undefined, ''],
-  ['+', 'national', undefined, ''],
-  ['+1', 'national', undefined, ''],
-  ['+15', 'national', undefined, '5'],
-  ['+150', 'national', undefined, '50'],
-  ['+1506', 'national', undefined, '506'],
-  ['+15062', 'national', undefined, '5062'],
-  ['+150623', 'national', undefined, '50623'],
-  ['+1506234', 'national', undefined, '506234'],
-  ['+15062345', 'national', undefined, '5062345'],
-  ['+150623456', 'national', undefined, '50623456'],
-  ['+1506234567', 'national', undefined, '506234567'],
-  ['+15062345678', 'national', undefined, '506-234-5678'],
-  ['+150623456789', 'national', undefined, '50623456789'],
-  ['+1506234567890', 'national', undefined, '506234567890'],
-
-  ['', 'international', undefined, ''],
-  ['+', 'international', undefined, ''],
-  ['+1', 'international', undefined, '+1'],
-  ['+15', 'international', undefined, '+1 5'],
-  ['+150', 'international', undefined, '+1 50'],
-  ['+1506', 'international', undefined, '+1 506'],
-  ['+15062', 'international', undefined, '+1 5062'],
-  ['+150623', 'international', undefined, '+1 50623'],
-  ['+1506234', 'international', undefined, '+1 506234'],
-  ['+15062345', 'international', undefined, '+1 5062345'],
-  ['+150623456', 'international', undefined, '+1 50623456'],
-  ['+1506234567', 'international', undefined, '+1 506234567'],
-  ['+15062345678', 'international', undefined, '+1 506-234-5678'],
-  ['+150623456789', 'international', undefined, '+1 50623456789'],
-  ['+1506234567890', 'international', undefined, '+1 506234567890'],
-])('formatPhoneNumber(%p, %p): %p', (input, format, country, phone) => {
-  expect(
-    new PhoneService(AwesomePhoneNumber).format(
-      input,
-      !format && !country ? undefined : { format, country },
-    ),
-  ).toBe(phone);
-});
-
-test.each([
-  ['', 'unknown'],
-  ['6', 'unknown'],
-  ['61', 'too-short'],
-  ['615-9', 'too-short'],
-  ['615-99', 'too-short'],
-  ['615-994', 'too-short'],
-  ['615-994-3', 'invalid-number'],
-  ['615-994-33', 'too-short'],
-  ['615-994-330', 'too-short'],
-  ['615-994-3300', 'is-possible'],
-  ['615-994-33001', 'too-long'],
-  ['1 6', 'unknown'],
-  ['1 61', 'too-short'],
-  ['1 615-9', 'too-short'],
-  ['1 615-99', 'too-short'],
-  ['1 615-994', 'invalid-number'],
-  ['1 615-994-3', 'too-short'],
-  ['1 615-994-33', 'too-short'],
-  ['1 615-994-330', 'invalid-number'],
-  ['1 615-994-3300', 'is-possible'],
-  ['1 615-994-33001', 'too-long'],
-  ['+1 6', 'unknown'],
-  ['+1 61', 'too-short'],
-  ['+1 615-9', 'too-short'],
-  ['+1 615-99', 'too-short'],
-  ['+1 615-994', 'too-short'],
-  ['+1 615-994-3', 'invalid-number'],
-  ['+1 615-994-33', 'too-short'],
-  ['+1 615-994-330', 'too-short'],
-  ['+1 615-994-3300', 'is-possible'],
-  ['+1 615-994-33001', 'too-long'],
-
-  ['3242225555', 'invalid-number'],
-])('#checkPossibility(%p): %p', (input, expected) => {
-  expect(new PhoneService(AwesomePhoneNumber).checkPossibility(input)).toBe(
-    expected,
-  );
-});
-
-test.each<
-  [
-    input: unknown,
-    rules: undefined | PhoneValidationRules,
-    expectedMessage: string | undefined,
-  ]
->([
-  [' ', undefined, undefined],
-  [null, undefined, undefined],
-  [undefined, undefined, undefined],
-
-  ['615-994-3300', undefined, undefined],
-  ['+1 615-994-3300', undefined, undefined],
-
-  [' ', { required: true }, 'This field is required'],
-  [null, { required: true }, 'This field is required'],
-  [undefined, { required: true }, 'This field is required'],
-  [undefined, { required: true, requiredMessage: 'Required.' }, 'Required.'],
-
-  [
-    'Phone: (585) 617-5555 (Home) | (585) 489-6666 (Cell)',
-    undefined,
-    'Invalid phone number',
-  ],
-  ['+1', undefined, 'Invalid phone number'],
-  ['+1', { invalidMessage: 'Invalid.' }, 'Invalid.'],
-
-  ['615', undefined, 'Phone number is too short'],
-  ['+1 615', undefined, 'Phone number is too short'],
-  ['+1 615', { tooShortMessage: 'Too short.' }, 'Too short.'],
-
-  ['615-994-3300 00', undefined, 'Phone number is too long'],
-  ['+1 615-994-3300 00', undefined, 'Phone number is too long'],
-  ['+1 615-994-3300 00', { tooLongMessage: 'Too long.' }, 'Too long.'],
-
-  ['3242225555', undefined, 'Invalid phone number'],
-])('#validate(%p, %j): %p', (input, rules, expected) => {
-  expect(new PhoneService(AwesomePhoneNumber).validate(input, rules)).toBe(
-    expected,
-  );
-});

package/src/phone-service/PhoneService.ts

@@ -1,287 +0,0 @@
-import { useMemo } from 'react';
-import { APNStatic, APNType, getAPN, loadAPN } from '../apn/APN';
-import {
-  CountryISO,
-  DEFAULT_COUNTRY,
-  getCountryCode,
-  toCountryISO,
-} from '../country-code-metadata/CountryCodeMetadata';
-
-const PLUS_SIGN = '+';
-const NON_PHONE_SYMBOLS_PATTERN = /[^+\d]/g;
-const PHONE_PATTERN = /^\+?\d+/g;
-
-function getPrefix(country: CountryISO): string {
-  return PLUS_SIGN + String(getCountryCode(toCountryISO(country)));
-}
-
-function trim(input: unknown): string | undefined {
-  return typeof input == 'string' ? input.trim() : undefined;
-}
-
-function normalize(input: unknown): string {
-  if (typeof input == 'string') {
-    const matches = input
-      .replace(NON_PHONE_SYMBOLS_PATTERN, '')
-      .match(PHONE_PATTERN);
-    if (matches?.[0]) return matches[0];
-  }
-
-  return '';
-}
-
-function normalizeNationalNumber(country: CountryISO, input: unknown): string {
-  const phone = normalize(input);
-  const prefix = getPrefix(country);
-
-  if (phone.startsWith(PLUS_SIGN)) {
-    return phone.slice(prefix.length);
-  }
-
-  return phone;
-}
-
-export type PhoneNumberPossibility =
-  | 'is-possible'
-  | 'invalid-country-code'
-  | 'invalid-number'
-  | 'too-long'
-  | 'too-short'
-  | 'unknown';
-
-interface PhoneNumberJSON {
-  valid: boolean;
-  possible: boolean;
-  possibility: PhoneNumberPossibility;
-
-  regionCode: CountryISO;
-  number: {
-    input: string;
-    international?: string;
-  };
-}
-
-export interface PhoneNumberInfo {
-  country: CountryISO;
-  nationalNumber: string;
-}
-
-export type PhoneNumberFormat =
-  | 'e164'
-  | 'international'
-  | 'national'
-  | 'rfc3966';
-
-export interface PhoneValidationRules {
-  required?: boolean;
-  requiredMessage?: string;
-  tooShortMessage?: string;
-  tooLongMessage?: string;
-  invalidMessage?: string;
-}
-
-export interface PhoneFormatOptions {
-  fallback?: string;
-  country?: CountryISO;
-  format?: PhoneNumberFormat;
-}
-
-export class PhoneService {
-  static load(): Promise<PhoneService> {
-    return loadAPN().then((APN) => new PhoneService(APN));
-  }
-
-  static checkPossibility(input: unknown): Promise<PhoneNumberPossibility> {
-    return this.load().then((phoneService) =>
-      phoneService.checkPossibility(input),
-    );
-  }
-
-  static validate(
-    input: unknown,
-    rules?: PhoneValidationRules,
-  ): Promise<string | undefined> {
-    return this.load().then((phoneService) =>
-      phoneService.validate(input, rules),
-    );
-  }
-
-  readonly APN;
-
-  constructor(APN: APNStatic) {
-    this.APN = APN;
-  }
-
-  createAPN(phone: string, country?: CountryISO): APNType {
-    const asYouType = this.APN.getAsYouType(toCountryISO(country));
-
-    asYouType.reset(normalize(phone));
-
-    return asYouType.getPhoneNumber();
-  }
-
-  getJSON(phone: string, country?: CountryISO): PhoneNumberJSON {
-    return this.createAPN(phone, country).toJSON() as PhoneNumberJSON;
-  }
-
-  checkPossibility(input: unknown): PhoneNumberPossibility {
-    const phone = trim(input);
-
-    if (!phone) {
-      return 'unknown';
-    }
-
-    const apn = phone.startsWith(PLUS_SIGN)
-      ? new this.APN(phone)
-      : new this.APN(phone, DEFAULT_COUNTRY);
-    const { valid, possible, possibility } = apn.toJSON() as PhoneNumberJSON;
-
-    // Avoid false positive short phone numbers.
-    if (!valid && possible) {
-      return 'invalid-number';
-    }
-
-    return possibility;
-  }
-
-  validate(
-    input: unknown,
-    {
-      required,
-      requiredMessage = 'This field is required',
-      invalidMessage = 'Invalid phone number',
-      tooLongMessage = 'Phone number is too long',
-      tooShortMessage = 'Phone number is too short',
-    }: PhoneValidationRules = {},
-  ): string | undefined {
-    const phone = trim(input);
-
-    if (!phone) {
-      if (required) {
-        return requiredMessage;
-      }
-
-      return undefined;
-    }
-
-    switch (this.checkPossibility(phone)) {
-      case 'is-possible':
-        return undefined;
-      case 'too-long':
-        return tooLongMessage;
-      case 'too-short':
-        return tooShortMessage;
-    }
-
-    return invalidMessage;
-  }
-
-  deletePrefix(phone: string, country: CountryISO): string {
-    const prefix = getPrefix(country);
-
-    if (phone.startsWith(PLUS_SIGN)) {
-      const subNumber = phone.slice(prefix.length);
-      return trim(subNumber) as string;
-    }
-
-    return phone;
-  }
-
-  getInfo(phone: string): PhoneNumberInfo {
-    let {
-      regionCode,
-      number: { input, international: internationalNumber },
-    } = this.getJSON(phone);
-
-    let nationalNumber = '';
-    const country = toCountryISO(regionCode);
-
-    if (!internationalNumber) {
-      nationalNumber = normalizeNationalNumber(country, input);
-    } else {
-      nationalNumber = this.deletePrefix(internationalNumber, country);
-    }
-
-    return { country, nationalNumber };
-  }
-
-  format(
-    input: unknown,
-    {
-      fallback = '',
-      format = 'e164',
-      country: countryOption,
-    }: PhoneFormatOptions = {},
-  ): string {
-    const phone = normalize(input);
-
-    if (!phone) {
-      return fallback;
-    }
-
-    const apn = this.createAPN(phone, countryOption);
-    const country = countryOption || toCountryISO(apn.getRegionCode());
-
-    const formatted =
-      format === 'national'
-        ? this.formatNationalNumber(apn, country)
-        : apn.getNumber(format);
-
-    if (!formatted) {
-      return this.customFormat(apn, phone, format);
-    }
-
-    return formatted;
-  }
-
-  formatNationalNumber(apn: APNType, country: CountryISO): string | undefined {
-    const internationalNumber = apn.getNumber('international');
-
-    if (!internationalNumber) {
-      return undefined;
-    }
-
-    return this.deletePrefix(internationalNumber, country);
-  }
-
-  private customFormat(
-    apn: APNType,
-    phone: string,
-    format: PhoneNumberFormat,
-  ): string {
-    let formatted = '';
-    const country = toCountryISO(apn.getRegionCode());
-
-    const nationalNumber = normalizeNationalNumber(country, phone);
-
-    if (format === 'national') {
-      return nationalNumber;
-    }
-
-    let prefix = '';
-    let separator = '';
-
-    if (format === 'rfc3966') {
-      prefix = 'tel:';
-      separator = '-';
-    }
-
-    if (format === 'international') {
-      separator = ' ';
-    }
-
-    formatted = prefix + getPrefix(country);
-
-    if (nationalNumber) {
-      formatted += separator + nationalNumber;
-    }
-
-    return formatted;
-  }
-}
-
-export function usePhoneService(): PhoneService {
-  const APN = getAPN();
-
-  return useMemo(() => new PhoneService(APN), [APN]);
-}

package/src/phone-text/PhoneText.spec.tsx

@@ -1,65 +0,0 @@
-import { renderComponent } from '@superdispatch/ui-testutils';
-import { screen, waitFor } from '@testing-library/react';
-import { PhoneText } from './PhoneText';
-
-test('basic', async () => {
-  const view = renderComponent(<PhoneText phone="+12015550123" />);
-
-  await screen.findByText(/201/);
-
-  expect(view.container).toMatchInlineSnapshot(`
-    <div>
-      +1 201-555-0123
-    </div>
-  `);
-});
-
-test('format', async () => {
-  const view = renderComponent(
-    <PhoneText phone="+12015550123" format="national" />,
-  );
-
-  await screen.findByText(/201/);
-
-  expect(view.container).toMatchInlineSnapshot(`
-    <div>
-      201-555-0123
-    </div>
-  `);
-});
-
-test('country', async () => {
-  const view = renderComponent(<PhoneText phone="2015550123" country="NZ" />);
-
-  await screen.findByText(/64/);
-
-  expect(view.container).toMatchInlineSnapshot(`
-    <div>
-      +64 20 1555 0123
-    </div>
-  `);
-});
-
-test('invalid', async () => {
-  const view = renderComponent(<PhoneText phone="noop" />);
-
-  await waitFor(() => {
-    expect(screen.queryByText('Suspended…')).toBeNull();
-  });
-
-  expect(view.container).toMatchInlineSnapshot(`<div />`);
-});
-
-test('fallback', async () => {
-  const view = renderComponent(<PhoneText phone="noop" fallback="Invalid." />);
-
-  await waitFor(() => {
-    expect(screen.queryByText('Suspended…')).toBeNull();
-  });
-
-  expect(view.container).toMatchInlineSnapshot(`
-    <div>
-      Invalid.
-    </div>
-  `);
-});

package/src/phone-text/PhoneText.stories.tsx

@@ -1,9 +0,0 @@
-import { Meta } from '@storybook/react';
-import { PhoneText } from './PhoneText';
-
-export default { title: 'Phones/PhoneText', component: PhoneText } as Meta;
-
-export const basic = () => <PhoneText phone="+12015550123" />;
-export const fallback = () => (
-  <PhoneText phone="noop" fallback="Invalid Phone Number" />
-);

package/src/phone-text/PhoneText.tsx

@@ -1,38 +0,0 @@
-import { renderChildren } from '@superdispatch/ui';
-import { ReactElement, ReactNode, Suspense } from 'react';
-import { CountryISO } from '../country-code-metadata/CountryCodeMetadata';
-import { useFormattedPhoneNumber } from '../formatted-phone-number/FormattedPhoneNumber';
-import { PhoneNumberFormat } from '../phone-service/PhoneService';
-
-export interface PhoneTextProps {
-  phone: unknown;
-  fallback?: ReactNode;
-  country?: CountryISO;
-  format?: PhoneNumberFormat;
-}
-
-export function PhoneText({
-  phone,
-  country,
-  fallback,
-  format = 'international',
-}: PhoneTextProps): null | ReactElement {
-  const children = useFormattedPhoneNumber(phone, { format, country });
-
-  return renderChildren(children || fallback);
-}
-
-export interface SuspendedPhoneTextProps extends PhoneTextProps {
-  suspenseFallback?: ReactNode;
-}
-
-export function SuspendedPhoneText({
-  suspenseFallback = null,
-  ...props
-}: SuspendedPhoneTextProps): ReactElement {
-  return (
-    <Suspense fallback={suspenseFallback}>
-      <PhoneText {...props} />
-    </Suspense>
-  );
-}

package/tsconfig.json

@@ -1,19 +0,0 @@
-{
-  "extends": "../../tsconfig.build",
-  "exclude": [
-    "pkg",
-    "playroom.ts",
-    "**/*.spec.*",
-    "**/*.stories.*",
-    "**/*.playroom.*",
-    "**/__tests__/**",
-    "**/__testutils__/**"
-  ],
-  "references": [{ "path": "../ui" }, { "path": "../__testutils__" }],
-  "compilerOptions": {
-    "composite": true,
-    "rootDir": "src",
-    "outDir": "pkg/dist-types",
-    "tsBuildInfoFile": "pkg/dist-types/.tsbuildinfo"
-  }
-}