@alessiofrittoli/type-utils 1.1.0 → 1.3.0

package/README.md

@@ -1,6 +1,6 @@
 # Type Utils ❇️
 
-Version 1.1.0
+Version 1.3.0
 
 ## Lightweight TypeScript types utilities
 
@@ -41,21 +41,23 @@ pnpm i @alessiofrittoli/type-utils
 ```
 
 This tiny library defines some global types which are not imported in your IDE by default.\
-After installation a `postinstall` script 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`.
+After installation a `postinstall` script is executed to create the `alessiofrittoli-env.d.ts` file at the root of your project.
+This script will try to update your `tsconfig.json` file.
+
+If that fail, please, make sure to add `alessiofrittoli-env.d.ts` in the array of the "include" property in your `tsconfig.json`.
 
 ```json
 {
 	"compilerOptions": {
 		...
 	},
-	"include": [ ..., "type-utils.d.ts" ],
+	"include": [ ..., "alessiofrittoli-env.d.ts" ],
 }
 ```
 
 You can skip this process if `*.ts` is already in your "include" array.
 
-⚠️ If the `type-utils.d.ts` file creation fails you run the following command to manually execute the script:
+⚠️ If the `alessiofrittoli-env.d.ts` file creation fails you can run the following command to manually execute the script:
 
 ```bash
 node node_modules/@alessiofrittoli/type-utils/scripts/postinstall/index.js

package/dist/index.d.mts

@@ -60,6 +60,51 @@ declare global {
     type NonNullableFields<T> = {
         [P in keyof T]: NonNullable<T[P]>;
     };
+    /**
+     * Get the type of the value of merged enums.
+     *
+     * @example
+     *
+     * ```ts
+     * enum Mammals {
+     * 	Humans,
+     * 	Bats,
+     * 	Dolphins
+     * }
+     *
+     * enum Reptiles {
+     * 	Snakes,
+     * 	Alligators,
+     * 	Lizards
+     * }
+     *
+     * // merged enums.
+     * const Animals = { Mammals, Reptiles }
+     * type Animals = typeof Animals
+     *
+     * type Animal = MergedEnumValueType<typeof Animals>
+     *
+     * const testAnimal: Animal = 0 as any
+     *
+     * switch ( testAnimal ) {
+     * 	case Animals.Mammals.Humans:
+     * 	case Animals.Mammals.Bats:
+     * 	case Animals.Mammals.Dolphins:
+     * 	case Animals.Reptiles.Snakes:
+     * 	case Animals.Reptiles.Alligators:
+     * 	case Animals.Reptiles.Lizards:
+     * 		break
+     * 	default: {
+     * 		const invalid = testAnimal // `testAnimal` is type of never
+     * 	}
+     * }
+     * ```
+     */
+    type MergedEnumValue<T> = {
+        [K in keyof T]: {
+            [K2 in keyof T[K]]: T[K][K2];
+        }[keyof T[K]];
+    }[keyof T];
 }
 
 type DoNotUse = never;

package/dist/index.d.ts

@@ -60,6 +60,51 @@ declare global {
     type NonNullableFields<T> = {
         [P in keyof T]: NonNullable<T[P]>;
     };
+    /**
+     * Get the type of the value of merged enums.
+     *
+     * @example
+     *
+     * ```ts
+     * enum Mammals {
+     * 	Humans,
+     * 	Bats,
+     * 	Dolphins
+     * }
+     *
+     * enum Reptiles {
+     * 	Snakes,
+     * 	Alligators,
+     * 	Lizards
+     * }
+     *
+     * // merged enums.
+     * const Animals = { Mammals, Reptiles }
+     * type Animals = typeof Animals
+     *
+     * type Animal = MergedEnumValueType<typeof Animals>
+     *
+     * const testAnimal: Animal = 0 as any
+     *
+     * switch ( testAnimal ) {
+     * 	case Animals.Mammals.Humans:
+     * 	case Animals.Mammals.Bats:
+     * 	case Animals.Mammals.Dolphins:
+     * 	case Animals.Reptiles.Snakes:
+     * 	case Animals.Reptiles.Alligators:
+     * 	case Animals.Reptiles.Lizards:
+     * 		break
+     * 	default: {
+     * 		const invalid = testAnimal // `testAnimal` is type of never
+     * 	}
+     * }
+     * ```
+     */
+    type MergedEnumValue<T> = {
+        [K in keyof T]: {
+            [K2 in keyof T[K]]: T[K][K2];
+        }[keyof T[K]];
+    }[keyof T];
 }
 
 type DoNotUse = never;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@alessiofrittoli/type-utils",
-	"version": "1.1.0",
+	"version": "1.3.0",
 	"description": "Lightweight TypeScript types utilities",
 	"author": {
 		"name": "Alessio Frittoli",
@@ -23,10 +23,11 @@
 	"main": "./dist/index.js",
 	"types": "./dist/index.d.ts",
 	"files": [
-		"dist", "scripts"
+		"dist",
+		"scripts"
 	],
 	"scripts": {
-		"build": "eslint && tsup",
+		"build": "pnpm lint && tsup",
 		"lint": "eslint",
 		"postinstall": "node scripts/postinstall/index.js"
 	},
@@ -38,5 +39,9 @@
 		"tsup": "^8.3.5",
 		"typescript": "^5.7.2",
 		"typescript-eslint": "^8.18.1"
+	},
+	"dependencies": {
+		"@alessiofrittoli/chain-functions": "^1.0.1",
+		"@alessiofrittoli/post-install-scripts": "0.2.0"
 	}
 }

package/scripts/postinstall/index.js

@@ -1,12 +1,14 @@
-const tsSetup = require( './ts-setup.js' )
+const Chain		= require( '@alessiofrittoli/chain-functions' )
+const tsSetup	= require( './ts-setup.js' )
 
-/** @type {(() => void | Promise<void>)[]} */
-const scripts = [ tsSetup ]
-
-const executePostInstall = async () => {
-	await Promise.all( scripts.map( async script => {
-		await script()
-	} ) )
+/** @type {import( '@alessiofrittoli/chain-functions/types' ).LastChainLink<() => void | Promise<void>>} */
+const lastChainLink = () => () => {
+	console.log( 'Post-install done.' )
 }
 
-executePostInstall()
+/** @type {import( '@alessiofrittoli/chain-functions/types' ).ChainFactory<() => void | Promise<void>>} */
+const chain = [ tsSetup, lastChainLink ]
+
+;( async () => {
+	await Chain.functions( chain )()
+} )()

package/scripts/postinstall/ts-setup.js

@@ -1,39 +1,17 @@
-const fs		= require( 'fs' )
-const path		= require( 'path' )
-const project	= require( '../../package.json' )
+const project = require( '../../package.json' )
+const { addTypesReference } = require( '@alessiofrittoli/post-install-scripts' )
 
 
-const tsSetup = () => {
-
-	const projectName	= project.name.replace( '@alessiofrittoli/', '' )
-	const projectRoot	= process.env.INIT_CWD || process.cwd()
-	const typesFilename	= `${ projectName }.d.ts`
-
-	if ( projectRoot.endsWith( projectName ) ) {
-		console.log( `Skip "postinstall" script. Running in ${ project.name }` )
-		return
-	}
-	if ( ! projectRoot ) {
-		console.error( 'INIT_CWD is not set. This script must be run during pnpm install.' )
-		process.exit( 1 )
-	}
-
-	const tsconfigPath = path.resolve( projectRoot, typesFilename )
-
-	const data = [
-		`/// <reference types="${ project.name }" />`,
-		'// NOTE: This file should not be edited'
-	].join( '\n\n' )
-
-	try {
-		fs.writeFileSync( tsconfigPath, data )
-		console.log( `"${ typesFilename }" has been created at the root of your project.` )
-		console.log( 'Please update your tsconfig.json to add this file in your "include" property of your tsconfig.json file.' )
-	} catch ( error ) {
-		console.error( `An error occured while creating "${ typesFilename }" at the root of your project. Some global types may not working as expect.`, error )
-		process.exit( 1 )
+/** @type {import( '@alessiofrittoli/chain-functions/types' ).ChainLink<() => void | Promise<void>>} */
+const tsSetup = next => () => {
+	
+	/** @type {import( '@alessiofrittoli/post-install-scripts/types' ).AddTypesReferenceOptions} */
+	const options = {
+		projectName: project.name,
 	}
+	addTypesReference( options )
 
+	return next()
 }
 
 module.exports = tsSetup