@codeleap/types 4.3.0

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "@codeleap/types",
+  "version": "4.3.0",
+  "main": "src/index.ts",
+  "license": "UNLICENSED",
+  "repository": {
+    "url": "https://github.com/codeleap-uk/internal-libs-monorepo.git",
+    "type": "git",
+    "directory": "packages/types"
+  },
+  "devDependencies": {
+    "@codeleap/config": "4.3.0",
+    "ts-node-dev": "1.1.8"
+  },
+  "scripts": {
+    "build": "echo 'No build needed'"
+  },
+  "peerDependencies": {
+    "typescript": "5.0.4",
+    "react": "18.1.0"
+  }
+}

package/package.json.bak

@@ -0,0 +1,22 @@
+{
+  "name": "@codeleap/types",
+  "version": "4.3.0",
+  "main": "src/index.ts",
+  "license": "UNLICENSED",
+  "repository": {
+    "url": "https://github.com/codeleap-uk/internal-libs-monorepo.git",
+    "type": "git",
+    "directory": "packages/types"
+  },
+  "devDependencies": {
+    "@codeleap/config": "workspace:*",
+    "ts-node-dev": "1.1.8"
+  },
+  "scripts": {
+    "build": "echo 'No build needed'"
+  },
+  "peerDependencies": {
+    "typescript": "5.0.4",
+    "react": "18.1.0"
+  }
+}

package/src/appSettings.ts

@@ -0,0 +1,102 @@
+import { DeepPartial, Matcher, LogType } from '.'
+
+export type AppSettings = DeepPartial<{
+  AppName: string
+  
+  CompanyName: string
+
+  CompanySuffix: string
+
+  Description: string
+
+  Environment: {
+    IsDev: boolean
+    Type: 'production' | 'development'
+    InitTime: any
+  }
+
+  Application: {
+    IsBrowser: boolean
+  }
+
+  BaseURL: string
+
+  Sentry: {
+    enable: boolean
+    dsn: string
+    provider: any
+    debug?: boolean
+    initArgs?: any
+    beforeBreadcrumb?: any
+  }
+
+  PerformanceInspector: {
+    enable: boolean
+    maxRenders: number
+    blacklist?: string[]
+  }
+
+  Logger: {
+    Level: LogType | LogType[]
+    DeviceIdentifier?: string
+    IgnoreWarnings?: string[]
+    StringifyObjects?: boolean
+    isMain?: boolean
+    inspect?: any
+    alwaysSendToSentry?: boolean
+    Obfuscate: {
+      keys: Matcher<'key'>[]
+      values: Matcher<'value'>[]
+    }
+  }
+
+  Vars: {
+    GooglePlayURL: string
+    AppStoreURL: string
+    WebsiteURL: string
+    PrivacyPolicy: string
+  }
+
+  Fetch: {
+    ProductionURL: string
+    DevelopmentURL: string
+  }
+
+  Social: {
+    FaceURL: string
+    LinkedinURL: string
+  }
+
+  ContactINFO: {
+    Website: string
+    TermsAndPrivacy: string
+    SupportEMAIL: string
+    ContactEMAIL: string
+    ContactPHONE: string
+  }
+
+  ApiCredentials: {
+    GoogleSignin: {
+      WebClientId: string
+    }
+    FacebookSDK: {
+      AppId: string
+    }
+  }
+
+  Slack: {
+    echo: {
+      channel?: string
+      icon: string
+      token: string
+      baseURL?: string
+      enabled?: boolean
+      options?: Record<string, any>
+    }
+  }
+}>
+
+export type ConfigurableSettings = Pick<
+  AppSettings,
+  'Fetch' | 'Logger' | 'ApiCredentials'
+>

package/src/common.ts

@@ -0,0 +1,23 @@
+export type CancellablePromise<T> = Promise<T> & { abort?: () => void }
+
+export type WebInputFile = {
+  file: File
+  preview: string
+}
+
+type MobileFileBase = {
+  fileCopyUri?: string
+  name: string
+  size: number
+  type: string
+  uri: string
+}
+
+export type MobileFile<Extra = {}> = Omit<MobileFileBase, keyof Extra> & Partial<Extra>
+
+export type FileWithPreview<Extra = {}> = {
+  file: MobileFile<Extra>
+  preview: string
+}
+
+export type MobileInputFile<Extra = {}> = FileWithPreview<Extra> | MobileFile<Extra>

package/src/google-places.ts

@@ -0,0 +1,96 @@
+export type AddressComponent = {
+  long_name: string
+  short_name: string
+  types: string[]
+}
+
+export type LatLng = {
+  lat: number
+  lng: number
+}
+
+export type GeometryBounds = {
+  northeast: LatLng
+  southwest: LatLng
+}
+
+export type Geometry = {
+  location: LatLng
+  location_type: string
+  viewport: GeometryBounds
+}
+
+export type PlusCode = {
+  compound_code: string
+  global_code: string
+}
+
+export type MatchedSubstring = {
+  length: number
+  offset: number
+}
+
+export type Term = {
+  offset: number
+  value: string
+}
+
+export type Photo = {
+  height: number
+  html_attributions: string[]
+  photo_reference: string
+  width: number
+}
+
+export type PlaceDetails = {
+  address_components: AddressComponent[]
+  adr_address: string
+  formatted_address: string
+  geometry: Geometry
+  icon: string
+  icon_background_color: string
+  icon_mask_base_uri: string
+  name: string
+  place_id: string
+  reference: string
+  types: string[]
+  url: string
+  utc_offset: number
+  vicinity: string
+
+  // NOTE - some places return photos when details is true
+  // e.g Toronto, Canada
+  photos?: Photo[]
+  website?: string
+}
+
+export type PlaceLatLngDetails = PlaceDetails & {
+  plus_code: PlusCode
+}
+
+export type PlaceAddress = {
+  description: string
+  matched_substrings: MatchedSubstring[]
+  place_id: string
+  reference: string
+  structured_formatting: {
+    main_text: string
+    main_text_matched_substrings: MatchedSubstring[]
+    secondary_text: string
+  }
+  terms: Term[]
+  types: string[]
+
+  details?: PlaceDetails
+}
+
+export type PlaceLatLng = {
+  address_components: AddressComponent[]
+  formatted_address: string
+  geometry: Geometry
+  place_id: string
+  plus_code: PlusCode
+  types: string[]
+
+  details?: PlaceLatLngDetails
+}

package/src/index.ts

@@ -0,0 +1,7 @@
+export * from './google-places'
+export * from './pathMapping'
+export * from './utility'
+export * from './common'
+export * as TypeGuards from './typeGuards'
+export * from './appSettings'
+export * as RNMaskedTextTypes from './react-native-masked-text'

package/src/pathMapping.ts

@@ -0,0 +1,52 @@
+export type Prev = [
+  never,
+  0,
+  1,
+  2,
+  3,
+  4,
+  5,
+  6,
+  7,
+  8,
+  9,
+  10,
+  11,
+  12,
+  13,
+  14,
+  15,
+  16,
+  17,
+  18,
+  19,
+  20,
+  ...0[]
+]
+
+export type Join<K, P> = K extends string | number
+  ? P extends string | number
+    ? `${K}${'' extends P ? '' : '.'}${P}`
+    : never
+  : never
+
+export type Paths<T, D extends number = 2> = [D] extends [never]
+  ? never
+  : (T extends Date
+    ? ''
+      : (T extends object
+        ? {
+            [K in keyof T]-?: K extends string | number
+              ? `${K}` | Join<K, Paths<T[K], Prev[D]>>
+              : never;
+          }[keyof T]
+        : '')
+    )
+
+export type ExtractPath<T> = T extends object
+  ? {
+    [K in keyof T & (string | number)]: T[K] extends object
+      ? `${K}` | `${K}.${ExtractPath<T[K]>}`
+      : `${K}`
+  }[keyof T & (string | number)]
+  : never

package/src/react-native-masked-text.ts

@@ -0,0 +1,51 @@
+// Type prop of TextInputMask.
+export type TextInputMaskTypeProp =
+    | 'credit-card'
+    | 'cpf'
+    | 'cnpj'
+    | 'zip-code'
+    | 'only-numbers'
+    | 'money'
+    | 'cel-phone'
+    | 'datetime'
+    | 'custom'
+
+// Option prop of TextInputMask.
+export interface TextInputMaskOptionProp {
+    // Money type.
+    precision?: number
+    separator?: string
+    delimiter?: string
+    unit?: string
+    suffixUnit?: string
+    zeroCents?: boolean
+
+    // Phone type.
+    withDDD?: boolean
+    dddMask?: string
+    maskType?: 'BRL' | 'INTERNATIONAL'
+
+    // Datetime type.
+    format?: string
+
+    // Credit card type.
+    obfuscated?: boolean
+    issuer?: 'visa-or-mastercard' | 'diners' | 'amex'
+
+    // Custom type.
+    mask?: string
+    validator?: (value: string, settings: TextInputMaskOptionProp) => boolean
+    getRawValue?: (value: string, settings: TextInputMaskOptionProp) => any
+    translation?: { [s: string]: (val: string) => string | null | undefined }
+}
+
+// TextInputMask Props
+export interface TextInputMaskProps {
+    type: TextInputMaskTypeProp
+    options?: TextInputMaskOptionProp
+    checkText?: (previous: string, next: string) => boolean
+    customTextInput?: any
+    customTextInputProps?: Object
+    includeRawValueInChangeText?: boolean
+}
+

package/src/typeGuards.ts

@@ -0,0 +1,57 @@
+import { AnyFunction } from './utility'
+import React from 'react'
+
+export function isNumber(x): x is number {
+  return typeof x === 'number'
+}
+
+export function isString(x): x is string {
+  return typeof x === 'string'
+}
+export function isObject(x): x is object {
+  return typeof x === 'object'
+}
+export function isBoolean(x): x is boolean {
+  return typeof x === 'boolean'
+}
+export function isFunction(x): x is (AnyFunction) {
+  return typeof x === 'function'
+}
+
+export function isConstructor(x): x is (new (...args) => any) {
+  return typeof x === 'function'
+}
+export function isArray(x): x is any[] {
+  return Array.isArray(x)
+}
+export function isUndefined(x): x is undefined {
+  return typeof x === 'undefined'
+}
+
+export function isNull(x): x is null {
+  return x === null
+}
+
+export function isNil(x): x is null | undefined {
+  return isNull(x) || isUndefined(x)
+}
+
+export function is<T >(x, Enum: T[]): x is T {
+  return Enum.includes(x)
+}
+type Abstract<T> = Function & {prototype: T}
+
+type Constructor<T> = new (...args: any[]) => T
+type Class<T = any> = Abstract<T> | Constructor<T>
+
+export function isInstance<T extends Class, X = T extends Class<infer X> ? X : never>(x, cls: T): x is X {
+  return x instanceof cls
+}
+
+export function isElement(x): x is React.ReactElement {
+  return React.isValidElement(x)
+}
+
+export function isComponentOrElement<P>(x: any): x is React.ComponentType<P> | React.ReactElement {
+  return isFunction(x) || isElement(x)
+}

package/src/utility.ts

@@ -0,0 +1,118 @@
+import { Prev } from './pathMapping'
+/* eslint-disable no-unused-vars */
+export type AnyFunction = (...args: any[]) => any
+
+export type AnyRecord = Record<string, any>
+
+export type ReadOnly<T> = {
+  readonly [Property in keyof T]: T[Property];
+}
+
+export type NestedKeys<T> = {
+  [K in keyof T]: T[K] extends Record<any, any> ? keyof T[K] : never;
+}[keyof T]
+
+export type FunctionType<Args extends any[], Return> = (
+  ...args: Args
+) => Return
+
+export type DeepPartial<T> = Partial<{
+  [Property in keyof T]: T[Property] extends Record<string, any>
+    ? T[Property] extends null|RegExp
+      ? any
+      : DeepPartial<T[Property]>
+    : T[Property] extends null|RegExp
+      ? any
+      : Partial<T[Property]>;
+}>
+
+type PrependNextNum<A extends Array<unknown>> = A['length'] extends infer T
+  ? ((t: T, ...a: A) => void) extends (...x: infer X) => void
+    ? X
+    : never
+  : never
+
+type EnumerateInternal<A extends Array<unknown>, N extends number> = {
+  0: A
+  1: EnumerateInternal<PrependNextNum<A>, N>
+}[N extends A['length'] ? 0 : 1]
+
+export type Enumerate<N extends number> = EnumerateInternal<
+  [],
+  N
+> extends (infer E)[]
+  ? E
+  : never
+
+export type Range<FROM extends number, TO extends number> = Exclude<
+  Enumerate<TO>,
+  Enumerate<FROM>
+>
+
+export type StylesOf<
+  C extends string | number | symbol = any,
+  CSS = any
+> = Partial<Record<C, CSS>>
+
+type IsDict<T> = T extends AnyFunction
+  ? false
+  : T extends Record<string, any>
+  ? true
+  : false
+
+export type ReplaceRecursive<T, Replace, With, D extends number = 10> = [D] extends [never] ? never : {
+  [Property in keyof T]: T[Property] extends Replace
+    ? With
+    : IsDict<T[Property]> extends true
+    ? ReplaceRecursive<T[Property], Replace, With, Prev[D]>
+    : T[Property];
+}
+export type SmartOmit<T, K extends keyof T> = {
+  [Property in Exclude<keyof T, K>]: T[Property];
+}
+
+export type PropsOf<T, Exclude extends string = ''> = T extends React.ComponentType<infer P> ? Omit<P, Exclude> : any
+
+export type Hashmap<T> = {
+  [key: string]: T
+}
+
+export type UnwrapPromise<T> = T extends Promise<infer U> ? U : T
+
+export type AsyncReturnType<T> = T extends (...args: any[]) => Promise<infer U> ? U : never
+
+export type VariantsOf<T> =T extends ((props: {variants: infer V}) => any) ?
+  (V extends (string | string[]) ? V : (string[]))
+
+  : (string[])
+
+export type VariantList<T> = Exclude<T, string>
+
+export type GetRefType<T> = T extends React.Ref<infer U> ? U : never
+
+export type FilterKeys<T, Filter = any> = Exclude<{
+  [P in keyof T]: T[P] extends Filter ? P : '__never__'
+}[keyof T], '__never__'>
+
+export type ReactState<T = any> = [
+  T,
+  React.Dispatch<React.SetStateAction<T>>
+]
+
+export type ReactStateProps<Name extends string, T = any, State extends ReactState<T> = ReactState<T>> = {
+  [P in Name as `set${Capitalize<Name>}`]: State[1]
+} & {
+  [P in Name ]: State[0]
+}
+
+export type AnyRef<T> = React.Ref<T> | React.MutableRefObject<T> | ((instance: T | null) => void) | null | React.ForwardedRef<T> | React.LegacyRef<T>
+
+export type Indices<T extends readonly any[]> = Exclude<Partial<T>['length'], T['length']>
+
+export type Replace<Object, Keys extends keyof Object, With = any> = Omit<Object, Keys> & {
+  [P in Keys]: With
+}
+
+export type Matcher<T> = string | Partial<RegExp> | FunctionType<[valueOrKey: any, type: T], boolean>
+
+export type LogType = 'info' | 'debug' | 'warn' | 'error' | 'log' | 'silent'