uni-types 1.0.0-beta.0 → 1.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 saqqdy <saqqdy@qq.com>
+
+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,274 @@
+<div align="center">
+
+# uni-types
+
+**Universal TypeScript Type Utilities**
+
+A comprehensive collection of type helpers for TypeScript development
+
+[![NPM version][npm-image]][npm-url]
+[![NPM downloads][download-image]][download-url]
+![TypeScript][typescript-url]
+[![Codecov][codecov-image]][codecov-url]
+[![License][license-image]][license-url]
+
+[**Documentation**](https://saqqdy.github.io/uni-types/) · [**中文文档**](./README_CN.md)
+
+</div>
+
+## Features
+
+- 🎯 **100+ Type Utilities** - Comprehensive type helpers for every use case
+- 🔒 **Type Safe** - Full TypeScript support with strict type checking
+- 📦 **Zero Dependencies** - Lightweight and tree-shakeable
+- 🚀 **TypeScript 5.x** - Built with the latest TypeScript features
+- 🌍 **Bilingual Docs** - Documentation in English and Chinese
+
+## Installation
+
+```bash
+# pnpm
+pnpm add uni-types
+
+# yarn
+yarn add uni-types
+
+# npm
+npm install uni-types
+```
+
+## Quick Start
+
+```typescript
+import type {
+  PickRequired,
+  DeepPartial,
+  IsArray,
+  Brand,
+  If,
+  Paths
+} from 'uni-types'
+
+// Core: Make specific properties required
+interface User {
+  name?: string
+  age?: number
+  email: string
+}
+
+type RequiredUser = PickRequired<User, 'name' | 'age'>
+// { name: string; age: number; email: string }
+
+// Deep: Make all nested properties optional
+interface Config {
+  database: {
+    host: string
+    port: number
+  }
+}
+
+type PartialConfig = DeepPartial<Config>
+// { database?: { host?: string; port?: number } }
+
+// Brand: Create nominal types
+type UserId = Brand<string, 'UserId'>
+type OrderId = Brand<string, 'OrderId'>
+// UserId and OrderId are not interchangeable!
+
+// Conditional: Type-level logic
+type Result = If<true, 'success', 'error'> // 'success'
+```
+
+## API Reference
+
+### Core Operations
+
+| Type | Description |
+|------|-------------|
+| `PickRequired<T, K>` | Make specified properties required |
+| `OmitRequired<T, K>` | Make properties except specified ones required |
+| `PickPartial<T, K>` | Make specified properties optional |
+| `OmitPartial<T, K>` | Make properties except specified ones optional |
+
+### Tuple Operations
+
+| Type | Description |
+|------|-------------|
+| `Head<T>` | Get first element of tuple |
+| `Last<T>` | Get last element of tuple |
+| `Tail<T>` | Get all elements except first |
+| `Init<T>` | Get all elements except last |
+| `Reverse<T>` | Reverse a tuple |
+| `Flatten<T>` | Flatten nested tuples |
+| `TupleLength<T>` | Get tuple length |
+| `IsEmptyTuple<T>` | Check if tuple is empty |
+
+### Deep Operations
+
+| Type | Description |
+|------|-------------|
+| `DeepPartial<T>` | Make all nested properties optional |
+| `DeepRequired<T>` | Make all nested properties required |
+| `DeepReadonly<T>` | Make all nested properties readonly |
+| `DeepMutable<T>` | Make all nested properties mutable |
+| `DeepOmit<T, P>` | Omit properties by path |
+| `DeepPick<T, P>` | Pick properties by path |
+
+### Type Guards
+
+| Type | Description |
+|------|-------------|
+| `IsArray<T>` | Check if type is an array |
+| `IsTuple<T>` | Check if type is a tuple |
+| `IsEqual<X, Y>` | Check if two types are equal |
+| `IsAny<T>` | Check if type is `any` |
+| `IsNever<T>` | Check if type is `never` |
+| `IsUnknown<T>` | Check if type is `unknown` |
+| `IsFunction<T>` | Check if type is a function |
+| `IsAsyncFunction<T>` | Check if type is an async function |
+
+### Conditional Types *(v1.1.0)*
+
+| Type | Description |
+|------|-------------|
+| `If<C, T, F>` | Type-level if-then-else |
+| `Not<B>` | Logical NOT for boolean types |
+| `And<A, B>` | Logical AND for boolean types |
+| `Or<A, B>` | Logical OR for boolean types |
+| `Assert<T, U>` | Type constraint assertion |
+
+### Brand Types *(v1.1.0)*
+
+| Type | Description |
+|------|-------------|
+| `Brand<T, B>` | Create a branded type for nominal typing |
+| `Unbrand<T>` | Extract underlying type from branded type |
+
+### Function Utilities *(v1.1.0)*
+
+| Type | Description |
+|------|-------------|
+| `Parameters<T>` | Get function parameters as tuple |
+| `ReturnType<T>` | Get function return type |
+| `NthParameter<T, N>` | Get Nth parameter type |
+| `AsyncReturnType<T>` | Extract async function return type |
+| `ThisParameterType<T>` | Get `this` parameter type |
+| `OmitThisParameter<T>` | Omit `this` parameter from function |
+
+### Template Literal Utilities *(v1.1.0)*
+
+| Type | Description |
+|------|-------------|
+| `ReplaceAll<S, From, To>` | Replace all occurrences |
+| `Replace<S, From, To>` | Replace first occurrence |
+| `Trim<S>` | Trim whitespace |
+| `StringToArray<S>` | Convert string to array |
+| `CapitalizeAll<S>` | Capitalize all words |
+| `StartsWith<S, P>` | Check if string starts with prefix |
+| `EndsWith<S, P>` | Check if string ends with suffix |
+| `StringLength<S>` | Get string length |
+
+### Numeric Utilities *(v1.1.0)*
+
+| Type | Description |
+|------|-------------|
+| `Inc<N>` | Increment number |
+| `Dec<N>` | Decrement number |
+| `Add<A, B>` | Add two numbers |
+| `Subtract<A, B>` | Subtract two numbers |
+| `GreaterThan<A, B>` | Check if A > B |
+| `LessThan<A, B>` | Check if A < B |
+| `Max<A, B>` | Maximum of two numbers |
+| `Min<A, B>` | Minimum of two numbers |
+
+### Path Types
+
+| Type | Description |
+|------|-------------|
+| `Paths<T>` | Get all nested property paths |
+| `PathValue<T, P>` | Get value type at path |
+| `ValidPath<T, P>` | Check if path is valid |
+| `ArrayPaths<T>` | Get paths including array indices |
+| `LeafPaths<T>` | Get paths to primitive values |
+
+### Key Utilities *(v1.1.0)*
+
+| Type | Description |
+|------|-------------|
+| `Keys<T>` | Get all keys |
+| `RenameKeys<T, M>` | Rename keys based on mapping |
+| `PrefixKeys<T, P>` | Add prefix to all keys |
+| `SuffixKeys<T, S>` | Add suffix to all keys |
+| `KeysByValueType<T, V>` | Get keys by value type |
+
+### Record Utilities *(v1.1.0)*
+
+| Type | Description |
+|------|-------------|
+| `DeepNullable<T>` | Make all properties nullable |
+| `DeepOptional<T>` | Make all properties optional |
+| `Immutable<T>` | Make all properties readonly |
+| `Mutable<T>` | Make all properties mutable |
+| `DeepNonNullable<T>` | Remove null/undefined from all properties |
+| `Exact<T, Shape>` | Ensure exact shape match |
+
+## Examples
+
+```typescript
+import type {
+  SnakeCase,
+  CamelCaseKeys,
+  UnionToIntersection,
+  AtLeastOne
+} from 'uni-types'
+
+// String case conversion
+SnakeCase<'XMLParser'>  // 'xml_parser'
+CamelCaseKeys<{ user_name: string, user_age: number }>
+// { userName: string, userAge: number }
+
+// Union to intersection
+UnionToIntersection<{ a: string } | { b: number }>
+// { a: string } & { b: number }
+
+// Require at least one property
+type Options = AtLeastOne<{ a?: string; b?: number; c?: boolean }>
+// Must have at least one of a, b, or c
+```
+
+## Development
+
+```bash
+# Install dependencies
+pnpm install
+
+# Run tests
+pnpm test
+
+# Build
+pnpm build
+
+# Type check
+pnpm typecheck
+
+# Start docs dev server
+pnpm docs:dev
+```
+
+## Contributing
+
+Contributions are welcome! Please read our [Contributing Guide](./CONTRIBUTING.md) for details.
+
+## License
+
+[MIT](LICENSE) © [saqqdy](https://github.com/saqqdy)
+
+[npm-image]: https://img.shields.io/npm/v/uni-types.svg?style=flat-square
+[npm-url]: https://npmjs.org/package/uni-types
+[typescript-url]: https://img.shields.io/badge/TypeScript-5.x-3178c6?style=flat-square&logo=typescript&logoColor=white
+[codecov-image]: https://img.shields.io/codecov/c/github/saqqdy/uni-types.svg?style=flat-square
+[codecov-url]: https://codecov.io/github/saqqdy/uni-types
+[download-image]: https://img.shields.io/npm/dm/uni-types.svg?style=flat-square
+[download-url]: https://npmjs.org/package/uni-types
+[license-image]: https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square
+[license-url]: LICENSE