@alessiofrittoli/type-utils 0.1.0-alpha.1

package/README.md

@@ -0,0 +1,101 @@
+# Type Utils ❇️
+
+Version 0.1.0-alpha.1
+
+## Lightweight TypeScript types utilities
+
+### Table of Contents
+
+- [Getting started](#gettingstarted)
+- [Utility types](https://github.com/alessiofrittoli/type-utils/blob/master/docs/utils/README.md)
+	- [ValueOf](https://github.com/alessiofrittoli/type-utils/blob/master/docs/utils/README.md#valueof)
+	- [ValueOfKey](https://github.com/alessiofrittoli/type-utils/blob/master/docs/utils/README.md#valueofkey)
+	- [OptionalKey](https://github.com/alessiofrittoli/type-utils/blob/master/docs/utils/README.md#optionalkey)
+	- [Writeable](https://github.com/alessiofrittoli/type-utils/blob/master/docs/utils/README.md#writeable)
+	- [RenameKey](https://github.com/alessiofrittoli/type-utils/blob/master/docs/utils/README.md#renamekey)
+	- [ArgumentTypes](https://github.com/alessiofrittoli/type-utils/blob/master/docs/utils/README.md#argumenttypes)
+- [Extenders types](https://github.com/alessiofrittoli/type-utils/blob/master/docs/extenders/README.md)
+	- [JSON](https://github.com/alessiofrittoli/type-utils/blob/master/docs/extenders/README.md#json)
+		- [JSON.stringify\<T\>()](https://github.com/alessiofrittoli/type-utils/blob/master/docs/extenders/README.md#jsonstringifyt)
+		- [JSON.parse\<T\>()](https://github.com/alessiofrittoli/type-utils/blob/master/docs/extenders/README.md#jsonparset)
+	- [Body](https://github.com/alessiofrittoli/type-utils/blob/master/docs/extenders/README.md#body)
+		- [Body.json\<T\>()](https://github.com/alessiofrittoli/type-utils/blob/master/docs/extenders/README.md#bodyjsont)
+- [ESLint](#eslint)
+- [Security](#security)
+- [Credits](#made-with-)
+
+---
+
+### Getting started
+
+Run the following command to start using `type-utils` in your projects:
+
+```bash
+npm i -D @alessiofrittoli/type-utils
+```
+
+or using `pnpm`
+
+```bash
+pnpm i -D @alessiofrittoli/type-utils
+```
+
+This tiny library defines some global types which are not imported in your IDE by default.\
+After installation a `postinstall` scritp is executed to create the `type-utils.d.ts` file at the root of your project.
+Please make sure to add it in the array of the "include" property in your `tsconfig.json`.
+
+```json
+{
+	"compilerOptions": {
+		...
+	},
+	"include": [ ..., "type-utils.d.ts" ],
+}
+```
+
+You can skip this process if `*.ts` is already in your "include" array.
+
+---
+
+### [ESLint](https://www.npmjs.com/package/eslint)
+
+warnings / errors check.
+
+```bash
+pnpm lint
+```
+
+### Security
+
+If you believe you have found a security vulnerability, we encourage you to **_responsibly disclose this and NOT open a public issue_**. We will investigate all legitimate reports. Email `security@alessiofrittoli.it` to disclose any security vulnerabilities.
+
+### Made with ☕
+
+<table style='display:flex;gap:20px;'>
+	<tbody>
+		<tr>
+			<td>
+				<img src='https://avatars.githubusercontent.com/u/35973186' style='width:60px;border-radius:50%;object-fit:contain;'>
+			</td>
+			<td>
+				<table style='display:flex;gap:2px;flex-direction:column;'>
+					<tbody>
+						<tr>
+							<td>
+								<a href='https://github.com/alessiofrittoli' target='_blank' rel='noopener'>Alessio Frittoli</a>
+							</td>
+						</tr>
+						<tr>
+							<td>
+								<small>
+									<a href='https://alessiofrittoli.it' target='_blank' rel='noopener'>https://alessiofrittoli.it</a> |
+									<a href='mailto:info@alessiofrittoli.it' target='_blank' rel='noopener'>info@alessiofrittoli.it</a>
+								</small>
+							</td>
+						</tr>
+					</tbody>
+				</table>
+			</td>
+		</tr>
+	</tbody>
+</table>

package/dist/index.d.mts

@@ -0,0 +1,46 @@
+declare class Stringified<T> extends String {
+    private ___stringified;
+}
+declare global {
+    interface JSON {
+        stringify<T>(value: T, replacer?: (key: string, value: any) => any, space?: string | number): string & Stringified<T>;
+        parse<T>(text: string | Stringified<T>, reviver?: (key: any, value: any) => any): T;
+        parse(text: string, reviver?: (key: any, value: any) => any): any;
+    }
+    interface Body {
+        json<T = any>(): Promise<T>;
+    }
+}
+
+declare global {
+    /**
+     * Get the Type of the Value of a object/array property.
+     */
+    type ValueOf<T> = T[keyof T];
+    /**
+     * Get the Type of the Value of object/array specific property.
+     */
+    type ValueOfKey<T, P extends keyof T> = T[P];
+    /**
+     * Make a specific property optional.
+     */
+    type OptionalKey<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
+    /**
+     * Make read-only properties of an object recursively writeable.
+     */
+    type Writeable<T> = {
+        -readonly [P in keyof T]: Writeable<T[P]>;
+    };
+    /**
+     * Renames a property while inheriting its type.
+     */
+    type RenameKey<T, K extends keyof T, R extends PropertyKey> = Omit<T, K> & {
+        [P in R]: T[K];
+    };
+    /** Get the Type of a function arguments. */
+    type ArgumentTypes<F extends Function> = F extends (...args: infer A) => any ? A : never;
+}
+
+type DoNotUse = never;
+
+export type { DoNotUse };

package/dist/index.d.ts

@@ -0,0 +1,46 @@
+declare class Stringified<T> extends String {
+    private ___stringified;
+}
+declare global {
+    interface JSON {
+        stringify<T>(value: T, replacer?: (key: string, value: any) => any, space?: string | number): string & Stringified<T>;
+        parse<T>(text: string | Stringified<T>, reviver?: (key: any, value: any) => any): T;
+        parse(text: string, reviver?: (key: any, value: any) => any): any;
+    }
+    interface Body {
+        json<T = any>(): Promise<T>;
+    }
+}
+
+declare global {
+    /**
+     * Get the Type of the Value of a object/array property.
+     */
+    type ValueOf<T> = T[keyof T];
+    /**
+     * Get the Type of the Value of object/array specific property.
+     */
+    type ValueOfKey<T, P extends keyof T> = T[P];
+    /**
+     * Make a specific property optional.
+     */
+    type OptionalKey<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
+    /**
+     * Make read-only properties of an object recursively writeable.
+     */
+    type Writeable<T> = {
+        -readonly [P in keyof T]: Writeable<T[P]>;
+    };
+    /**
+     * Renames a property while inheriting its type.
+     */
+    type RenameKey<T, K extends keyof T, R extends PropertyKey> = Omit<T, K> & {
+        [P in R]: T[K];
+    };
+    /** Get the Type of a function arguments. */
+    type ArgumentTypes<F extends Function> = F extends (...args: infer A) => any ? A : never;
+}
+
+type DoNotUse = never;
+
+export type { DoNotUse };

package/dist/index.js

@@ -0,0 +1 @@
+'use strict';

package/license.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Alessio Frittoli.
+
+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/package.json

@@ -0,0 +1,42 @@
+{
+	"name": "@alessiofrittoli/type-utils",
+	"version": "0.1.0-alpha.1",
+	"description": "Lightweight TypeScript types utilities",
+	"author": {
+		"name": "Alessio Frittoli",
+		"email": "info@alessiofrittoli.it",
+		"url": "https://alessiofrittoli.it"
+	},
+	"license": "MIT",
+	"keywords": [
+		"typescript"
+	],
+	"homepage": "https://github.com/alessiofrittoli/type-utils#readme",
+	"bugs": {
+		"url": "https://github.com/alessiofrittoli/type-utils/issues",
+		"email": "info@alessiofrittoli.it"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/alessiofrittoli/type-utils.git"
+	},
+	"main": "./dist/index.js",
+	"types": "./dist/index.d.ts",
+	"files": [
+		"dist"
+	],
+	"scripts": {
+		"build": "eslint && tsup",
+		"lint": "eslint",
+		"postinstall": "node scripts/postinstall.js"
+	},
+	"devDependencies": {
+		"@eslint/js": "^9.15.0",
+		"@types/node": "^22.9.3",
+		"eslint": "^9.15.0",
+		"globals": "^15.12.0",
+		"tsup": "^8.3.5",
+		"typescript": "^5.6.3",
+		"typescript-eslint": "^8.15.0"
+	}
+}