migrate helpers index to ts and AvatarHelper

Author: ethanshar

generatedTypes/helpers/AvatarHelper.d.ts

@@ -0,0 +1,6 @@
+export declare function getAvatarColors(): string[];
+export declare function getColorById(id: string, avatarColors?: string[]): string;
+export declare function getInitials(name: string): string;
+export declare function isGravatarUrl(url: string): any;
+export declare function isBlankGravatarUrl(url: string): boolean;
+export declare function patchGravatarUrl(gravatarUrl: string): any;

generatedTypes/helpers/index.d.ts

@@ -0,0 +1,3 @@
+import * as AvatarHelper from './AvatarHelper';
+export { default as Constants } from './Constants';
+export { AvatarHelper };

generatedTypes/index.d.ts

@@ -55,7 +55,6 @@ export {
   forwardRef,
   AvatarHelper,
   Constants,
-  DocsGenerator,
   LogService,
   LoaderScreen,
   Modal,

src/commons/baseComponent.js

@@ -3,7 +3,6 @@ import React from 'react';
 import {StyleSheet} from 'react-native';
 import _ from 'lodash';
 import {Colors} from '../style';
-import {DocsGenerator} from '../helpers';
 import * as Modifiers from './modifiers';
 
 export default function baseComponent(usePure) {
@@ -35,7 +34,7 @@ export default function baseComponent(usePure) {
 
     // TODO: stop using this and remove it
     getSnippet() {
-      return DocsGenerator.generateSnippet(DocsGenerator.extractComponentInfo(this));
+      return null;
     }
 
     generateStyles() {

src/helpers/AvatarHelper.js renamed to src/helpers/AvatarHelper.ts

@@ -1,8 +1,9 @@
 import _ from 'lodash';
+// @ts-ignore
 import URL from 'url-parse';
 import Colors from '../style/colors';
 
-function hashStringToNumber(str) {
+function hashStringToNumber(str: string) {
   let hash = 5381;
   for (let i = 0; i < str.length; i++) {
     const char = str.charCodeAt(i);
@@ -16,7 +17,7 @@ export function getAvatarColors() {
     Colors.orange20, Colors.red20, Colors.purple20, Colors.violet20];
 }
 
-export function getColorById(id, avatarColors = getAvatarColors()) {
+export function getColorById(id: string, avatarColors = getAvatarColors()) {
   if (!id) {
     return avatarColors[0];
   }
@@ -26,7 +27,7 @@ export function getColorById(id, avatarColors = getAvatarColors()) {
   return avatarColors[colorIndex];
 }
 
-export function getInitials(name) {
+export function getInitials(name: string) {
   let initials = '';
   if (name && _.isString(name)) {
     const nameSplitted = _.chain(name)
@@ -42,16 +43,16 @@ export function getInitials(name) {
   return _.toUpper(initials);
 }
 
-export function isGravatarUrl(url) {
+export function isGravatarUrl(url: string) {
   const {hostname, pathname} = new URL(url);
   return _.split(hostname, '.').includes('gravatar') && pathname.startsWith('/avatar/');
 }
 
-export function isBlankGravatarUrl(url) {
+export function isBlankGravatarUrl(url: string) {
   return isGravatarUrl(url) && _.endsWith(url, '?d=blank');
 }
 
-export function patchGravatarUrl(gravatarUrl) {
+export function patchGravatarUrl(gravatarUrl: string) {
   const url = new URL(gravatarUrl, true);
   const {query} = url;
   query.d = '404';

src/helpers/__tests__/DocsGenerator.spec.js

@@ -0,0 +1,4 @@
+import * as AvatarHelper from './AvatarHelper';
+
+export {default as Constants} from './Constants';
+export {AvatarHelper};

src/helpers/index.js

@@ -20,6 +20,5 @@ export {
   FeatureHighlight, Hint, BaseInput, TextArea, TextField, MaskedInput, ListItem, PageControl, PanningProvider,
   PanGestureView, PanListenerView, PanDismissibleView, PanResponderView, Picker, ProgressBar, Slider, GradientSlider,
   ColorSliderGroup, Stepper, TabBar, TagsInput, SharedTransition, StackAggregator, Toast,
-  WheelPickerDialog, Assets, BaseComponent, PureBaseComponent, UIComponent, forwardRef, AvatarHelper, Constants,
-  DocsGenerator, LogService, LoaderScreen, Modal, StateScreen, WheelPicker, Incubator, ColorPicker
+  WheelPickerDialog, Assets, BaseComponent, PureBaseComponent, UIComponent, forwardRef, AvatarHelper, Constants, LogService, LoaderScreen, Modal, StateScreen, WheelPicker, Incubator, ColorPicker
 } from '../typings';

src/helpers/index.ts

@@ -1,4 +1,3 @@
 
 export * from './AvatarHelper';
 export * from './Constants';
-export * from './DocsGenerator';