chore: move shared types around

TODO.md

@@ -1,5 +1,5 @@
 * Remove anything that can be done with plain JS now
-* Aim for no useless imports (avoid the lodash problem)
+* Minimize extraneous imports (avoid the lodash problem)
 * Get high test coverage:
     * Unit tests (https://github.com/nodejs/help/issues/3902)
     * Minimal `any` and `ts-expect-error`

package.json

@@ -49,7 +49,7 @@
     "node": ">=21.0.0"
   },
   "devDependencies": {
-    "@types/node": "20.10.6",
+    "@types/node": "20.10.7",
     "eslint": "8.56.0",
     "eslint-config-standard-with-typescript": "43.0.0",
     "npm-run-all": "4.1.5",

src/collect-by.ts

@@ -1,3 +1,5 @@
+import { type AnyMap } from './types'
+
 /**
  * Collect an an array of objects by string key
  * cred: gh:uniqname
@@ -7,7 +9,7 @@
  */
 
 export const collectBy = (p: string) =>
-  (a: any[]): Record<string, any> =>
+  (a: any[]): AnyMap =>
     a.reduce((c, i) => ({
       ...c, [i[p]]: i,
     }), {})

src/count-items-in-array.ts

@@ -1,11 +1,13 @@
+type R = Record<string, number>
+
 /**
  * Get an object of items in an array with count
  * @example
  * countItemsInArray([ 1, 1, 2, 3, 4 ]) // => { '1': 2, '2': 1, '3': 1, '4': 1 }
  */
 
-export const countItemsInArray = <T>(arr: T[]): Record<string, number> =>
-  arr.reduce((a: Record<string, number>, c: any): Record<string, number> => {
+export const countItemsInArray = <T>(arr: T[]): R =>
+  arr.reduce((a: R, c: any): R => {
     if (a[c.toString()]) {
       a[c.toString()]++
     } else {

src/each.ts

@@ -1,4 +1,5 @@
 import { isArrayLike } from './is-array-like'
+import { type AnyMap } from './types'
 
 const iterateArray = <T>(
   arr: T[],
@@ -7,7 +8,6 @@ const iterateArray = <T>(
   return arr.map((x: T, i: number) => fn(x, i.toString()))
 }
 
-type AnyMap = Record<string, any>
 type IOFn <T> = (a: T, b: string) => AnyMap
 const iterateObject = <T>(
   obj: AnyMap,

src/filter.ts

@@ -1,6 +1,7 @@
 import { each } from './each'
+import { type AnyMap } from './types'
 
-type AnyMapOrArr = Record<string, any> | any[]
+type AnyMapOrArr = AnyMap | any[]
 
 /**
  * `filter` for array and object
@@ -12,7 +13,7 @@ type AnyMapOrArr = Record<string, any> | any[]
 
 export const filter = <T>(
   fn: (x: T, y: string | number) => boolean,
-  list: T[] | string | Record<string, any>,
+  list: T[] | string | AnyMap,
 ): Record<string, T> | T[] => {
   const isArr = Array.isArray(list)
   const filtered: AnyMapOrArr = isArr ? [] : {}

src/get-key-by-value.ts

@@ -1,3 +1,5 @@
+import { type AnyMap } from './types'
+
 /**
  * Get the key for a value
  * @example
@@ -6,6 +8,6 @@
 
 export const getKeyByValue = (
   value: any,
-  object: Record<string, any>,
+  object: AnyMap,
 ): string | undefined =>
   Object.keys(object).find((key: string) => object[key] === value)

src/group-by.ts

@@ -1,3 +1,5 @@
+import { type AnyMap } from './types'
+
 /**
  * Collect an an array of objects by string key
  * @example
@@ -6,7 +8,7 @@
  */
 
 export const groupBy = (p: string) =>
-  (a: any[]): Record<string, any> =>
+  (a: any[]): AnyMap =>
     a.reduce((c, i) => ({
       ...c, [i[p]]: i,
     }), {})

src/has.ts

@@ -1,8 +1,10 @@
+import { type AnyMap } from './types'
+
 /**
  * See if an object has a property
  * @example
  * has('a' { b: 'c' }) // => false
  */
 
-export const has = (p: string, o: Record<string, any>): boolean =>
+export const has = (p: string, o: AnyMap): boolean =>
   Object.prototype.hasOwnProperty.call(o, p)

src/index.ts

@@ -160,6 +160,7 @@ export * from './touch'
 export * from './truncate'
 export * from './try-json'
 export * from './type-of'
+export * from './types'
 export * from './union'
 export * from './uniq'
 export * from './uniq-by'

src/keep.ts

@@ -1,6 +1,7 @@
 import { filter } from './filter'
+import { type AnyMap } from './types'
 
-type R = string | any[] | Record<string, any>
+type R = string | any[] | AnyMap
 
 /**
  * Returns an array or object with all falsey values removed

src/map-object.ts

@@ -1,3 +1,5 @@
+import { type AnyMap } from './types'
+
 /**
  * Map for objects
  * @example
@@ -8,10 +10,10 @@
 
 export const mapObject = (
   f: (a: any, b: string, c: any) => any,
-  o: Record<string, any>,
+  o: AnyMap,
   ctx: any = this,
-): Record<string, any> => {
-  const res: Record<string, any> = {}
+): AnyMap => {
+  const res: AnyMap = {}
   Object.keys(o).forEach((k): void => {
     res[k] = f.call(ctx, o[k], k, o)
   })

src/pick.ts

@@ -1,3 +1,5 @@
+import { type AnyMap } from './types'
+
 /**
  * `pick`
  * as it is in rambda (not ramda)
@@ -8,9 +10,9 @@
 
 export const pick = (
   ks: string | string[],
-  o: Record<string, any>,
-): Record<string, any> => {
-  const r: Record<string, any> = {}
+  o: AnyMap,
+): AnyMap => {
+  const r: AnyMap = {}
   let c: number = 0
   while (c < ks.length) {
     if (ks[c] in o) {

src/read-json.ts

@@ -1,6 +1,6 @@
 import { readFile } from 'node:fs/promises'
+import { type AnyMap } from './types'
 
-type AnyMap = Record<string, any>
 type AnyJson = AnyMap | any[]
 
 /**

src/safe-get.ts

@@ -1,4 +1,5 @@
 import { id } from './id'
+import { type AnyMap } from './types'
 
 /**
  * Like `_.get`: takes an access string and an optional fallback,
@@ -10,7 +11,7 @@ import { id } from './id'
  */
 
 export const safeGet = <A>(path: string, fallback?: A) => (
-  obj: Record<string, any>,
+  obj: AnyMap,
 ): A | null | undefined =>
   (path
     .split(/[.[\]]/)

src/sort-object.ts

@@ -1,13 +1,12 @@
 import { isObject } from './is-object'
+import { type AnyMap } from './types'
 
 /**
  * Sort an object (recursively)
  * @example
  * sortObject({ b: 'c', a: 'd' }) // => { a: 'd', b: 'c' }
  */
 
-type AnyMap = Record<string, any>
-
 export const sortObject = (o: AnyMap): AnyMap => {
   if (!isObject(o)) throw new Error('Expected an object')
   const ks = Object.keys(o)