typescript-builtins-extended 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Hayden
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,15 @@
+# Typescript Utilities
+
+English | [简体中文](README.zh-CN.md)
+
+Provides a globally-scoped type conversion tool for typescript. Unlike other tools, `typescript-builtins-extended` does not provide any js code and focuses on typescript type conversion. And it can be used directly like using built-in utility types such as `Omit` `Pick` without additional import.
+
+Utility types and implementation methods come from [type-challenges](https://github.com/type-challenges/type-challenges.git)
+
+## Usage
+
+Add the following code to the `d.ts` declaration file
+
+```ts
+/// <reference types="typescript-builtins-extended" />
+```

package/README.zh-CN.md

@@ -0,0 +1,15 @@
+# Typescript Utilities
+
+[English](README.md) | 简体中文
+
+为 typescript 提供全局范围的类型转换工具，与其他工具不同，`typescript-builtins-extended` 不提供任何 js 代码，专注于 typescript 的类型转换。并且可以像使用 `Omit` `Pick` 等内置实用程序类型一样直接使用，无需额外导入。
+
+实用程序类型与其实现方式来源于 [type-challenges](https://github.com/type-challenges/type-challenges.git)
+
+## 使用
+
+将下面的代码添加到 `d.ts` 声明文件中
+
+```ts
+/// <reference types="typescript-builtins-extended" />
+```

package/index.d.ts

@@ -0,0 +1,27 @@
+export { }
+
+declare global {
+  export type { GetReadonlyKeys } from './src/00005-extreme-readonly-keys'
+  import('./src/00005-extreme-readonly-keys')
+
+  export type { DeepReadonly } from './src/00009-medium-deep-readonly'
+  import('./src/00009-medium-deep-readonly')
+
+  export type { TupleToUnion } from './src/00010-medium-tuple-to-union'
+  import('./src/00010-medium-tuple-to-union')
+
+  export type { TupleToObject } from './src/00011-easy-tuple-to-object'
+  import('./src/00011-easy-tuple-to-object')
+
+  export type { First } from './src/00014-easy-first'
+  import('./src/00014-easy-first')
+
+  export type { Last } from './src/00015-medium-last'
+  import('./src/00015-medium-last')
+
+  export type { Pop } from './src/00016-medium-pop'
+  import('./src/00016-medium-pop')
+
+  export type { UnionToTuple } from './src/00730-hard-union-to-tuple'
+  import('./src/00730-hard-union-to-tuple')
+}

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "typescript-builtins-extended",
+  "version": "0.0.1",
+  "description": "Collection of TypeScript Utility Types.",
+  "keywords": [
+    "typescript",
+    "utilities",
+    "Utility",
+    "types"
+  ],
+  "bugs": {
+    "url": "https://github.com/hayden-fr/typescript-builtins-extended/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/hayden-fr/typescript-builtins-extended.git"
+  },
+  "files": [
+    "src",
+    "index.d.ts",
+    "tsconfig.json"
+  ],
+  "types": "index.d.ts",
+  "author": "hayden <hayden.mike.zhang@gmail.com>",
+  "devDependencies": {
+    "typescript": "^5.9.2"
+  },
+  "scripts": {
+    "test": "tsc --noEmit"
+  }
+}

package/src/00005-extreme-readonly-keys.ts

@@ -0,0 +1,34 @@
+// ============= Test Cases =============
+import type { Equal, Expect } from './test-utils'
+
+type cases = [
+  Expect<Equal<'title', GetReadonlyKeys<Todo1>>>,
+  Expect<Equal<'title' | 'description', GetReadonlyKeys<Todo2>>>,
+]
+
+interface Todo1 {
+  readonly title: string
+  description: string
+  completed: boolean
+}
+
+interface Todo2 {
+  readonly title: string
+  readonly description: string
+  completed?: boolean
+}
+
+
+// ============= Your Code Here =============
+// Implemented by https://github.com/type-challenges/type-challenges/issues/139
+
+/**
+ * Implement a generic `GetReadonlyKeys<T>` that returns a union of the readonly keys of an Object.
+ *
+ * 实现泛型 `GetReadonlyKeys<T>`，`GetReadonlyKeys<T>` 返回由对象 T 所有只读属性的键组成的联合类型。
+ */
+export type GetReadonlyKeys<
+  T,
+  U extends Readonly<T> = Readonly<T>,
+  K extends keyof T = keyof T
+> = K extends keyof T ? Equal<Pick<T, K>, Pick<U, K>> extends true ? K : never : never;

package/src/00009-medium-deep-readonly.ts

@@ -0,0 +1,69 @@
+// ============= Test Cases =============
+import type { Equal, Expect } from './test-utils'
+
+type cases = [
+  Expect<Equal<DeepReadonly<X1>, Expected1>>,
+  Expect<Equal<DeepReadonly<X2>, Expected2>>,
+]
+
+type X1 = {
+  a: () => 22
+  b: string
+  c: {
+    d: boolean
+    e: {
+      g: {
+        h: {
+          i: true
+          j: 'string'
+        }
+        k: 'hello'
+      }
+      l: [
+        'hi',
+        {
+          m: ['hey']
+        },
+      ]
+    }
+  }
+}
+
+type X2 = { a: string } | { b: number }
+
+type Expected1 = {
+  readonly a: () => 22
+  readonly b: string
+  readonly c: {
+    readonly d: boolean
+    readonly e: {
+      readonly g: {
+        readonly h: {
+          readonly i: true
+          readonly j: 'string'
+        }
+        readonly k: 'hello'
+      }
+      readonly l: readonly [
+        'hi',
+        {
+          readonly m: readonly ['hey']
+        },
+      ]
+    }
+  }
+}
+
+type Expected2 = { readonly a: string } | { readonly b: number }
+
+// ============= Your Code Here =============
+// Implemented by https://github.com/type-challenges/type-challenges/issues/13716
+
+/**
+ * Implement a generic `DeepReadonly<T>` which make every parameter of an object - and its sub-objects recursively - readonly.
+ *
+ * 实现一个泛型 `DeepReadonly<T>`，它将对象的每个参数及其子对象递归地设为只读。
+ */
+export type DeepReadonly<T> = {
+  readonly [P in keyof T]: keyof T[P] extends never ? T[P] : DeepReadonly<T[P]>
+}

package/src/00010-medium-tuple-to-union.ts

@@ -0,0 +1,18 @@
+// ============= Test Cases =============
+import type { Equal, Expect } from './test-utils'
+
+type cases = [
+  Expect<Equal<TupleToUnion<[123, '456', true]>, 123 | '456' | true>>,
+  Expect<Equal<TupleToUnion<[123]>, 123>>,
+]
+
+
+// ============= Your Code Here =============
+// Implemented by https://github.com/type-challenges/type-challenges/issues/7
+
+/**
+ * Implement a generic `TupleToUnion<T>` which covers the values of a tuple to its values union.
+ *
+ * 实现泛型 `TupleToUnion<T>`，它返回元组所有值的合集。
+ */
+export type TupleToUnion<T> = T extends Array<infer ITEMS> ? ITEMS : never

package/src/00011-easy-tuple-to-object.ts

@@ -0,0 +1,32 @@
+// ============= Test Cases =============
+import type { Equal, Expect } from './test-utils'
+
+const tuple = ['tesla', 'model 3', 'model X', 'model Y'] as const
+const tupleNumber = [1, 2, 3, 4] as const
+const sym1 = Symbol(1)
+const sym2 = Symbol(2)
+const tupleSymbol = [sym1, sym2] as const
+const tupleMix = [1, '2', 3, '4', sym1] as const
+
+type cases = [
+  Expect<Equal<TupleToObject<typeof tuple>, { 'tesla': 'tesla', 'model 3': 'model 3', 'model X': 'model X', 'model Y': 'model Y' }>>,
+  Expect<Equal<TupleToObject<typeof tupleNumber>, { 1: 1, 2: 2, 3: 3, 4: 4 }>>,
+  Expect<Equal<TupleToObject<typeof tupleSymbol>, { [sym1]: typeof sym1, [sym2]: typeof sym2 }>>,
+  Expect<Equal<TupleToObject<typeof tupleMix>, { 1: 1, '2': '2', 3: 3, '4': '4', [sym1]: typeof sym1 }>>,
+]
+
+// @ts-expect-error
+type error = TupleToObject<[[1, 2], {}]>
+
+
+// ============= Your Code Here =============
+// Implemented by https://github.com/type-challenges/type-challenges/issues/5896
+
+/**
+ * Given an array, transform it into an object type and the key/value must be in the provided array.
+ *
+ * 将一个元组类型转换为对象类型，这个对象类型的键/值和元组中的元素对应。
+ */
+export type TupleToObject<T extends readonly (string | symbol | number)[]> = {
+  [P in T[number]]: P
+}

package/src/00014-easy-first.ts

@@ -0,0 +1,27 @@
+// ============= Test Cases =============
+import type { Equal, Expect } from './test-utils'
+
+type cases = [
+  Expect<Equal<First<[3, 2, 1]>, 3>>,
+  Expect<Equal<First<[() => 123, { a: string }]>, () => 123>>,
+  Expect<Equal<First<[]>, never>>,
+  Expect<Equal<First<[undefined]>, undefined>>,
+]
+
+type errors = [
+  // @ts-expect-error
+  First<'notArray'>,
+  // @ts-expect-error
+  First<{ 0: 'arrayLike' }>,
+]
+
+
+// ============= Your Code Here =============
+// Implemented by https://github.com/type-challenges/type-challenges/issues/16315
+
+/**
+ * Implement a generic `First<T>` that takes an Array T and returns its first element's type.
+ *
+ * 实现一个 `First<T>` 泛型，它接受一个数组T并返回它的第一个元素的类型。
+ */
+export type First<T extends any[]> = T extends [] ? never : T[0]

package/src/00015-medium-last.ts

@@ -0,0 +1,20 @@
+// ============= Test Cases =============
+import type { Equal, Expect } from './test-utils'
+
+type cases = [
+  Expect<Equal<Last<[]>, never>>,
+  Expect<Equal<Last<[2]>, 2>>,
+  Expect<Equal<Last<[3, 2, 1]>, 1>>,
+  Expect<Equal<Last<[() => 123, { a: string }]>, { a: string }>>,
+]
+
+
+// ============= Your Code Here =============
+// Implemented by https://github.com/type-challenges/type-challenges/issues/38
+
+/**
+ * Implement a generic `Last<T>` that takes an Array T and returns its last element.
+ *
+ * 实现一个 `Last<T>` 泛型，它接受一个数组T并返回其最后一个元素的类型。
+ */
+export type Last<T extends any[]> = T extends [...infer _, infer L] ? L : never

package/src/00016-medium-pop.ts

@@ -0,0 +1,22 @@
+// ============= Test Cases =============
+import type { Equal, Expect } from './test-utils'
+
+type cases = [
+  Expect<Equal<Pop<[3, 2, 1]>, [3, 2]>>,
+  Expect<Equal<Pop<['a', 'b', 'c', 'd']>, ['a', 'b', 'c']>>,
+  Expect<Equal<Pop<[]>, []>>,
+]
+
+// ============= Your Code Here =============
+// Implemented by https://github.com/type-challenges/type-challenges/issues/37295
+
+/**
+ * Implement a generic `Pop<T>` that takes an Array T and returns an Array without it's last element.
+ *
+ * 实现一个泛型 `Pop<T>`，它接受一个数组T，并返回一个由数组T的前 N-1 项（N 为数组T的长度）以相同的顺序组成的数组。
+ */
+export type Pop<T extends any[]> = T extends []
+  ? []
+  : T extends [...infer R, infer _]
+  ? R
+  : never

package/src/00730-hard-union-to-tuple.ts

@@ -0,0 +1,52 @@
+// ============= Test Cases =============
+import type { Equal, Expect } from './test-utils'
+
+type ExtractValuesOfTuple<T extends any[]> = T[keyof T & number]
+
+type cases = [
+  Expect<Equal<UnionToTuple<'a' | 'b'>['length'], 2>>,
+  Expect<Equal<ExtractValuesOfTuple<UnionToTuple<'a' | 'b'>>, 'a' | 'b'>>,
+  Expect<Equal<ExtractValuesOfTuple<UnionToTuple<'a'>>, 'a'>>,
+  Expect<Equal<ExtractValuesOfTuple<UnionToTuple<any>>, any>>,
+  Expect<Equal<ExtractValuesOfTuple<UnionToTuple<undefined | void | 1>>, void | 1>>,
+  Expect<Equal<ExtractValuesOfTuple<UnionToTuple<any | 1>>, any | 1>>,
+  Expect<Equal<ExtractValuesOfTuple<UnionToTuple<any | 1>>, any>>,
+  Expect<Equal<ExtractValuesOfTuple<UnionToTuple<'d' | 'f' | 1 | never>>, 'f' | 'd' | 1>>,
+  Expect<Equal<ExtractValuesOfTuple<UnionToTuple<[{ a: 1 }] | 1>>, [{ a: 1 }] | 1>>,
+  Expect<Equal<ExtractValuesOfTuple<UnionToTuple<never>>, never>>,
+  Expect<Equal<ExtractValuesOfTuple<UnionToTuple<'a' | 'b' | 'c' | 1 | 2 | 'd' | 'e' | 'f' | 'g'>>, 'f' | 'e' | 1 | 2 | 'g' | 'c' | 'd' | 'a' | 'b'>>,
+]
+
+
+// ============= Your Code Here =============
+// Implemented by https://github.com/type-challenges/type-challenges/issues/737
+
+/**
+ * UnionToIntersection<{ foo: string } | { bar: string }> =
+ *  { foo: string } & { bar: string }.
+ */
+type UnionToIntersection<U> = (
+  U extends unknown ? (arg: U) => 0 : never
+) extends (arg: infer I) => 0
+  ? I
+  : never;
+
+/**
+ * LastInUnion<1 | 2> = 2.
+ */
+type LastInUnion<U> = UnionToIntersection<
+  U extends unknown ? (x: U) => 0 : never
+> extends (x: infer L) => 0
+  ? L
+  : never;
+
+/**
+ * Implement a type, UnionToTuple, that converts a union to a tuple.
+ *
+ * 将联合转换为元组的类型。
+ *
+ * UnionToTuple<1 | 2> = [1, 2].
+ */
+export type UnionToTuple<U, Last = LastInUnion<U>> = [U] extends [never]
+  ? []
+  : [...UnionToTuple<Exclude<U, Last>>, Last];

package/src/test-utils.ts

@@ -0,0 +1,31 @@
+export type Expect<T extends true> = T
+export type ExpectTrue<T extends true> = T
+export type ExpectFalse<T extends false> = T
+export type IsTrue<T extends true> = T
+export type IsFalse<T extends false> = T
+
+export type Equal<X, Y> = (<T>() => T extends X ? 1 : 2) extends <T>() => T extends Y ? 1 : 2
+  ? true
+  : false
+export type NotEqual<X, Y> = true extends Equal<X, Y> ? false : true
+
+// https://stackoverflow.com/questions/49927523/disallow-call-with-any/49928360#49928360
+export type IsAny<T> = 0 extends 1 & T ? true : false
+export type NotAny<T> = true extends IsAny<T> ? false : true
+
+export type Debug<T> = { [K in keyof T]: T[K] }
+export type MergeInsertions<T> = T extends object ? { [K in keyof T]: MergeInsertions<T[K]> } : T
+
+export type Alike<X, Y> = Equal<MergeInsertions<X>, MergeInsertions<Y>>
+
+export type ExpectExtends<VALUE, EXPECTED> = EXPECTED extends VALUE ? true : false
+export type ExpectValidArgs<
+  FUNC extends (...args: any[]) => any,
+  ARGS extends any[]
+> = ARGS extends Parameters<FUNC> ? true : false
+
+export type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (
+  k: infer I
+) => void
+  ? I
+  : never

package/tsconfig.json

@@ -0,0 +1,40 @@
+{
+  "compilerOptions": {
+    // https://www.typescriptlang.org/tsconfig/#rootDir-and-baseUrl
+    "rootDir": ".",
+    "baseUrl": ".",
+
+    // Most non-library projects don't need to emit declarations.
+    // So we add this option by default to make the config more friendly to most users.
+    "noEmit": true,
+
+    // As long as you are using a build tool, we recommend you to author and ship in ES modules.
+    // Even if you are targeting Node.js, because
+    //  - `CommonJS` is too outdated
+    //  - the ecosystem hasn't fully caught up with `Node16`/`NodeNext`
+    // This recommendation includes environments like Vitest, Vite Config File, Vite SSR, etc.
+    "module": "ESNext",
+
+    // We expect users to use bundlers.
+    // So here we enable some resolution features that are only available in bundlers.
+    "moduleResolution": "Bundler",
+    "resolveJsonModule": true,
+    "allowImportingTsExtensions": true,
+    // Even files without `import` or `export` are treated as modules.
+    // It helps to avoid mysterious errors such as `Cannot redeclare block-scoped variable 'name`.
+    // https://www.totaltypescript.com/cannot-redeclare-block-scoped-variable#solution-3-your-module-isnt-a-module
+    "moduleDetection": "force",
+
+    // `"noImplicitThis": true` is part of `strict`
+    // Added again here in case some users decide to disable `strict`.
+    // This enables stricter inference for data properties on `this`.
+    "noImplicitThis": true,
+    "strict": true,
+
+    // supports ES2016+
+    "target": "ESNext",
+
+    // Recommended
+    "skipLibCheck": true,
+  }
+}