feat(types): add types, set deprecated types

add:
- TupleHead
- TupleTail
- TupleLast
- TupleRemoveLast
- TupleUnshift
- TuplePush
- TupleConcat

deprecated:
- Head
- Tail
- Unshift
- Last
- Push
- Concat

Author: waitingsong

packages/types/src/lib/common.ts

@@ -3,11 +3,23 @@
 // ref: https://zhuanlan.zhihu.com/p/38687656
 // original ref: https://github.com/microsoft/typescript/pull/24897
 // dependencies typescript >= 3.1
+/**
+ * @deprecated use `TupleHead` instead
+ */
 export type Head<Tuple extends any[]> = Tuple extends [infer H, ...any[]] ? H : never
+/**
+ * @deprecated use `TupleTail` instead
+ */
 export type Tail<Tuple extends any[]> = ((...x: Tuple) => void) extends ((h: any, ...rest: infer R) => void) ? R : never
+/**
+ * @deprecated use `TupleUnshift` instead
+ */
 export type Unshift<
   Tuple extends any[],
   Element> = ((h: Element, ...tuple: Tuple) => void) extends (...x: infer R) => void ? R : never
+/**
+ * @deprecated use `TupleLast` instead
+ */
 export type Last<Tuple extends any[]> = {
   1: Tuple[0],
   0: Last<Tail<Tuple>>,
@@ -20,18 +32,23 @@ type Reverse_<Tuple extends any[], Result extends any[]> = {
 }[Tuple extends [] ? 1 : 0]
 
 export type ToTuple<T> = T extends any[] ? T : any[]
+/**
+ * @deprecated use `TuplePush` instead
+ */
 export type Push<
   Tuple extends any[],
   Element,
   R = Reverse<Tuple>,
   T extends any[] = ToTuple<R>
 > = Reverse<Unshift<T, Element>>
 
+/**
+ * @deprecated use `TupleConcat` instead
+ */
 export type Concat<
   Tuple1 extends any[],
   Tuple2 extends any[],
   R = Reverse<Tuple1>, T extends any[] = ToTuple<R>> = Concat_<T, Tuple2>
-
 type Concat_<Tuple1 extends any[], Tuple2 extends any[]> = {
   1: Reverse<Tuple1>,
   0: Concat_<Unshift<Tuple1, Head<Tuple2>>, Tail<Tuple2>>,
@@ -79,3 +96,4 @@ export type Invert<T extends Record<PropertyKey, PropertyKey>> = {
 export type Equals<X, Y> = (<T>() => T extends X ? 1 : 2) extends (<T>() => T extends Y ? 1 : 2)
   ? true
   : false
+

packages/types/src/lib/index.ts

@@ -4,4 +4,5 @@ export * from './common'
 export * from './data'
 export * from './npm-pkg'
 export * from './union2tuple'
+export * from './tuple'
 

packages/types/src/lib/tuple.ts

@@ -0,0 +1,33 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+// ref: https://zhuanlan.zhihu.com/p/38687656
+
+/** Get the first element */
+export type TupleHead<T extends any[]> = T[0]
+
+/** Remove the first element */
+export type TupleTail<T extends any[]> = ((...t: T) => void) extends (x: any, ...t: infer R) => void ? R : never
+
+/** Get the last element */
+export type TupleLast<T extends any[]> = T[TupleTail<T>['length']]
+
+/** Remove the last element */
+export type TupleRemoveLast<T extends any[]> = TypeAssert<Overwrite<TupleTail<T>, T>, any[]>
+
+/** Insert element at first */
+export type TupleUnshift<T extends any[], X> = ((x: X, ...t: T) => void) extends (...t: infer R) => void ? R : never
+
+/** Append element at last */
+export type TuplePush<T extends any[], X> = TypeAssert<Overwrite<TupleUnshift<T, any>, T & { [x: string]: X }>, any[]>
+
+/** Concat two tuples */
+export type TupleConcat<A extends any[], B extends any[]> = {
+  1: A,
+  0: TupleConcat<TuplePush<A, B[0]>, TupleTail<B>>,
+}[B extends [] ? 1 : 0]
+
+// 用到的 helper 类型，简化代码和解决某些情况下的类型错误
+export type TypeAssert<T, A> = T extends A ? T : never
+// @ts-expect-error
+export type Overwrite<T, S extends any> = { [P in keyof T]: S[P] }
+

packages/types/test/10.tuple.test.ts

@@ -0,0 +1,240 @@
+/* eslint-disable node/no-extraneous-import */
+import {
+  basename,
+  join,
+} from '@waiting/shared-core'
+import * as assert from 'power-assert'
+
+import {
+  Equals,
+  TupleHead,
+  TupleTail,
+  TupleLast,
+  TupleRemoveLast,
+  TupleUnshift,
+  TuplePush,
+  TupleConcat,
+} from '../src/index'
+
+
+const filename = basename(__filename)
+
+describe(filename, () => {
+
+  describe('should TupleHead works', () => {
+    it('normal', () => {
+      type Foo = [string, number, string]
+      type T1 = TupleHead<Foo>
+      type ExpectType = string
+      const ret: Equals<T1, ExpectType> = true
+    })
+    it('empty', () => {
+      type Foo = []
+      type T1 = TupleHead<Foo>
+      type ExpectType = undefined
+      const ret: Equals<T1, ExpectType> = true
+    })
+    it('unknown', () => {
+      type Foo = [unknown]
+      type T1 = TupleHead<Foo>
+      type ExpectType = unknown
+      const ret: Equals<T1, ExpectType> = true
+    })
+    it('any', () => {
+      type Foo = [any]
+      type T1 = TupleHead<Foo>
+      type ExpectType = any
+      const ret: Equals<T1, ExpectType> = true
+    })
+  })
+
+  describe('should TupleTail works', () => {
+    it('normal', () => {
+      type Foo = [string, number, string]
+      type T1 = TupleTail<Foo>
+      type ExpectType = [number, string]
+      const ret: Equals<T1, ExpectType> = true
+    })
+    it('empty', () => {
+      type Foo = []
+      type T1 = TupleTail<Foo>
+      type ExpectType = []
+      const ret: Equals<T1, ExpectType> = true
+    })
+    it('unknown[]', () => {
+      type Foo = unknown[]
+      type T1 = TupleTail<Foo>
+      type ExpectType = unknown[]
+      const ret: Equals<T1, ExpectType> = true
+    })
+    it('any', () => {
+      type Foo = [any]
+      type T1 = TupleTail<Foo>
+      type ExpectType = []
+      const ret: Equals<T1, ExpectType> = true
+    })
+    it('any[]', () => {
+      type Foo = any[]
+      type T1 = TupleTail<Foo>
+      type ExpectType = any[]
+      const ret: Equals<T1, ExpectType> = true
+    })
+  })
+
+  describe('should TupleLast works', () => {
+    it('normal', () => {
+      type Foo = [string, number, string]
+      type T1 = TupleLast<Foo>
+      type ExpectType = string
+      const ret: Equals<T1, ExpectType> = true
+    })
+    it('empty', () => {
+      type Foo = []
+      type T1 = TupleLast<Foo>
+      type ExpectType = undefined
+      const ret: Equals<T1, ExpectType> = true
+    })
+    it('unknown', () => {
+      type Foo = [unknown]
+      type T1 = TupleLast<Foo>
+      type ExpectType = unknown
+      const ret: Equals<T1, ExpectType> = true
+    })
+    it('any', () => {
+      type Foo = [any]
+      type T1 = TupleLast<Foo>
+      type ExpectType = any
+      const ret: Equals<T1, ExpectType> = true
+    })
+  })
+
+  describe('should TupleRemoveLast works', () => {
+    it('normal', () => {
+      type Foo = [string, number, string]
+      type T1 = TupleRemoveLast<Foo>
+      type ExpectType = [string, number]
+      const ret: Equals<T1, ExpectType> = true
+    })
+    it('empty', () => {
+      type Foo = []
+      type T1 = TupleRemoveLast<Foo>
+      type ExpectType = []
+      const ret: Equals<T1, ExpectType> = true
+    })
+    it('unknown', () => {
+      type Foo = [unknown]
+      type T1 = TupleRemoveLast<Foo>
+      type ExpectType = []
+      const ret: Equals<T1, ExpectType> = true
+    })
+    it('any', () => {
+      type Foo = [any]
+      type T1 = TupleRemoveLast<Foo>
+      type ExpectType = []
+      const ret: Equals<T1, ExpectType> = true
+    })
+  })
+
+
+  describe('should TupleUnshift works', () => {
+    it('normal', () => {
+      type Foo = [string, number, string]
+      type T1 = TupleUnshift<Foo, bigint>
+      type ExpectType = [bigint, string, number, string]
+      const ret: Equals<T1, ExpectType> = true
+    })
+    it('empty', () => {
+      type Foo = []
+      type T1 = TupleUnshift<Foo, bigint>
+      type ExpectType = [bigint]
+      const ret: Equals<T1, ExpectType> = true
+    })
+    it('unknown', () => {
+      type Foo = [unknown]
+      type T1 = TupleUnshift<Foo, bigint>
+      type ExpectType = [bigint, unknown]
+      const ret: Equals<T1, ExpectType> = true
+    })
+    it('any', () => {
+      type Foo = [any]
+      type T1 = TupleUnshift<Foo, bigint>
+      type ExpectType = [bigint, any]
+      const ret: Equals<T1, ExpectType> = true
+    })
+    it('mixed', () => {
+      type Foo = [1, 2, 'foo']
+      type T1 = TupleUnshift<Foo, 3>
+      type ExpectType = [3, 1, 2, 'foo']
+      const ret: Equals<T1, ExpectType> = true
+    })
+  })
+
+  describe('should TuplePush works', () => {
+    it('normal', () => {
+      type Foo = [string, number, string]
+      type T1 = TuplePush<Foo, bigint>
+      type ExpectType = [string, number, string, bigint]
+      const ret: Equals<T1, ExpectType> = true
+    })
+    it('empty', () => {
+      type Foo = []
+      type T1 = TuplePush<Foo, bigint>
+      type ExpectType = [bigint]
+      const ret: Equals<T1, ExpectType> = true
+    })
+    it('unknown', () => {
+      type Foo = [unknown]
+      type T1 = TuplePush<Foo, bigint>
+      type ExpectType = [unknown, bigint]
+      const ret: Equals<T1, ExpectType> = true
+    })
+    it('any', () => {
+      type Foo = [any]
+      type T1 = TuplePush<Foo, bigint>
+      type ExpectType = [any, bigint]
+      const ret: Equals<T1, ExpectType> = true
+    })
+    it('mixed', () => {
+      type Foo = [1, 2, 'foo']
+      type T1 = TuplePush<Foo, 3>
+      type ExpectType = [1, 2, 'foo', 3]
+      const ret: Equals<T1, ExpectType> = true
+    })
+  })
+
+  describe('should TupleConcat works', () => {
+    it('normal', () => {
+      type Foo = [string, number, string]
+      type T1 = TupleConcat<Foo, [bigint]>
+      type ExpectType = [string, number, string, bigint]
+      const ret: Equals<T1, ExpectType> = true
+    })
+    it('empty', () => {
+      type Foo = []
+      type T1 = TupleConcat<Foo, [bigint]>
+      type ExpectType = [bigint]
+      const ret: Equals<T1, ExpectType> = true
+    })
+    it('unknown', () => {
+      type Foo = [unknown]
+      type T1 = TupleConcat<Foo, [bigint]>
+      type ExpectType = [unknown, bigint]
+      const ret: Equals<T1, ExpectType> = true
+    })
+    it('any', () => {
+      type Foo = [any]
+      type T1 = TupleConcat<Foo, [bigint]>
+      type ExpectType = [any, bigint]
+      const ret: Equals<T1, ExpectType> = true
+    })
+    it('mixed', () => {
+      type Foo = [1, 2, 'foo']
+      type T1 = TupleConcat<Foo, [3, 'bar', 'foo']>
+      type ExpectType = [1, 2, 'foo', 3, 'bar', 'foo']
+      const ret: Equals<T1, ExpectType> = true
+    })
+  })
+
+
+})
+