uom-types 4.1.1 → 5.0.0

package/CHANGELOG.md

@@ -1,6 +1,25 @@
 # Changelog
 All notable changes to this project will be documented in this file. Dates are displayed in UTC.
 
+# [5.0.0](https://github.com/RebeccaStevens/uom-types/compare/v4.1.2...v5.0.0) (2024-11-27)
+
+
+### Features
+
+* drop support for node 16 ([c701cf3](https://github.com/RebeccaStevens/uom-types/commit/c701cf37a8b433bf5daa3269a6c5c00a66f8361a))
+
+
+### BREAKING CHANGES
+
+* drop support for node 16
+
+## [4.1.2](https://github.com/RebeccaStevens/uom-types/compare/v4.1.1...v4.1.2) (2024-10-18)
+
+
+### Bug Fixes
+
+* extend branding interface to unit-keys-value ([165603c](https://github.com/RebeccaStevens/uom-types/commit/165603c1fe9beaf2c523218e78778ee152fc7c87))
+
 ## [4.1.1](https://github.com/RebeccaStevens/uom-types/compare/v4.1.0...v4.1.1) (2024-10-18)
 
 

package/dist/index.d.cts

@@ -70,6 +70,15 @@ export type BrandUnitClassType = Brand & {
 		unitClassType: true;
 	};
 };
+/**
+ * Brand with the unit keys and value.
+ */
+export type BrandUnitKeyValues<K, V> = Brand & Readonly<{
+	__uom_types: {
+		keys: K;
+		value: V;
+	};
+}>;
 /**
  * Remove all key from the object that are `never`.
  */
@@ -192,14 +201,14 @@ export type UnknownUnitClass = UnknownUnitKeyValues & BrandUnitClassType;
 export type UnknownUnitMeta = UnknownUnitKeyValues & Readonly<{
 	__uno_types__unit_meta_type: true;
 }>;
-export type UnitKeyValues<T extends UnitSubvalues> = Readonly<{
-	__uom_types__keys: keyof ExcludeUnitZeroSubvalues<T> extends string ? keyof ExcludeUnitZeroSubvalues<T> : never;
-	__uom_types__value: RemoveNeverValues<T>;
-}>;
-export type UnknownUnitKeyValues = Readonly<{
-	__uom_types__keys: string;
-	__uom_types__value: {};
-}>;
+/**
+ * @internal
+ */
+export type UnitKeyValues<T extends UnitSubvalues> = BrandUnitKeyValues<keyof ExcludeUnitZeroSubvalues<T> extends string ? keyof ExcludeUnitZeroSubvalues<T> : never, RemoveNeverValues<T>>;
+/**
+ * @internal
+ */
+export type UnknownUnitKeyValues = BrandUnitKeyValues<string, {}>;
 /**
  * A mapping of subvalue of a unit its magnitude.
  *
@@ -300,9 +309,7 @@ export type SiUnitKeys = "Second" | "Meter" | "Kilogram" | "Mole" | "Ampere" | "
  * @group Unit Classes
  */
 export type BaseUnitClass<T extends Exactify<SiUnitConfig, T>> = UnitClass<T>;
-export type SiUnitConfig = {
-	[K in SiUnitKeys]?: Exponent;
-};
+export type SiUnitConfig = Partial<Record<SiUnitKeys, Exponent>>;
 /**
  * @group Unit Classes
  * @category Angle (Plane)
@@ -1231,7 +1238,7 @@ export type HenryPerMeter = MagneticPermeabilityUnit<{}>;
  * @see {@link Pow}
  * @see {@link Cubic}
  */
-export type Square<T extends UnknownUnit | UnknownAbstractUnit | UnknownUnitConversionRate | UnknownUnitClass | UnknownUnitMeta> = T extends number ? Pow<T, 2> : T extends UnknownUnitClass ? UnitClass<PowUnitSubvalues<T["__uom_types__value"], 2>> : T extends UnknownUnitMeta ? UnitMeta<PowUnitSubvalues<T["__uom_types__value"], 2>> : never;
+export type Square<T extends UnknownUnit | UnknownAbstractUnit | UnknownUnitConversionRate | UnknownUnitClass | UnknownUnitMeta> = T extends number ? Pow<T, 2> : T extends UnknownUnitClass ? UnitClass<PowUnitSubvalues<T["__uom_types"]["value"], 2>> : T extends UnknownUnitMeta ? UnitMeta<PowUnitSubvalues<T["__uom_types"]["value"], 2>> : never;
 /**
  * Put the given {@link Unit} to the power of 3.
  *
@@ -1240,7 +1247,7 @@ export type Square<T extends UnknownUnit | UnknownAbstractUnit | UnknownUnitConv
  * @see {@link Pow}
  * @see {@link Square}
  */
-export type Cubic<T extends UnknownUnit | UnknownAbstractUnit | UnknownUnitConversionRate | UnknownUnitClass | UnknownUnitMeta> = T extends number ? Pow<T, 3> : T extends UnknownUnitClass ? UnitClass<PowUnitSubvalues<T["__uom_types__value"], 3>> : T extends UnknownUnitMeta ? UnitMeta<PowUnitSubvalues<T["__uom_types__value"], 3>> : never;
+export type Cubic<T extends UnknownUnit | UnknownAbstractUnit | UnknownUnitConversionRate | UnknownUnitClass | UnknownUnitMeta> = T extends number ? Pow<T, 3> : T extends UnknownUnitClass ? UnitClass<PowUnitSubvalues<T["__uom_types"]["value"], 3>> : T extends UnknownUnitMeta ? UnitMeta<PowUnitSubvalues<T["__uom_types"]["value"], 3>> : never;
 /**
  * Binary prefix denoting an order of magnitude of 10^1.
  *
@@ -1355,7 +1362,7 @@ export type Pico<T extends UnknownUnit> = Multiply<T, UnitConversionRate<{
  * @group Modifiers
  * @category General
  */
-export type Reciprocal<T extends UnknownUnit | UnknownAbstractUnit | UnknownUnitConversionRate | UnknownUnitClass | UnknownUnitMeta> = T extends number ? Inverse<T> : T extends UnknownUnitClass ? UnitClass<InverseUnitSubvalues<T["__uom_types__value"]>> : T extends UnknownUnitMeta ? UnitMeta<InverseUnitSubvalues<T["__uom_types__value"]>> : never;
+export type Reciprocal<T extends UnknownUnit | UnknownAbstractUnit | UnknownUnitConversionRate | UnknownUnitClass | UnknownUnitMeta> = T extends number ? Inverse<T> : T extends UnknownUnitClass ? UnitClass<InverseUnitSubvalues<T["__uom_types"]["value"]>> : T extends UnknownUnitMeta ? UnitMeta<InverseUnitSubvalues<T["__uom_types"]["value"]>> : never;
 /**
  * @group Unit Classes
  * @category Electromagnetic

package/dist/index.d.mts

@@ -70,6 +70,15 @@ export type BrandUnitClassType = Brand & {
 		unitClassType: true;
 	};
 };
+/**
+ * Brand with the unit keys and value.
+ */
+export type BrandUnitKeyValues<K, V> = Brand & Readonly<{
+	__uom_types: {
+		keys: K;
+		value: V;
+	};
+}>;
 /**
  * Remove all key from the object that are `never`.
  */
@@ -192,14 +201,14 @@ export type UnknownUnitClass = UnknownUnitKeyValues & BrandUnitClassType;
 export type UnknownUnitMeta = UnknownUnitKeyValues & Readonly<{
 	__uno_types__unit_meta_type: true;
 }>;
-export type UnitKeyValues<T extends UnitSubvalues> = Readonly<{
-	__uom_types__keys: keyof ExcludeUnitZeroSubvalues<T> extends string ? keyof ExcludeUnitZeroSubvalues<T> : never;
-	__uom_types__value: RemoveNeverValues<T>;
-}>;
-export type UnknownUnitKeyValues = Readonly<{
-	__uom_types__keys: string;
-	__uom_types__value: {};
-}>;
+/**
+ * @internal
+ */
+export type UnitKeyValues<T extends UnitSubvalues> = BrandUnitKeyValues<keyof ExcludeUnitZeroSubvalues<T> extends string ? keyof ExcludeUnitZeroSubvalues<T> : never, RemoveNeverValues<T>>;
+/**
+ * @internal
+ */
+export type UnknownUnitKeyValues = BrandUnitKeyValues<string, {}>;
 /**
  * A mapping of subvalue of a unit its magnitude.
  *
@@ -300,9 +309,7 @@ export type SiUnitKeys = "Second" | "Meter" | "Kilogram" | "Mole" | "Ampere" | "
  * @group Unit Classes
  */
 export type BaseUnitClass<T extends Exactify<SiUnitConfig, T>> = UnitClass<T>;
-export type SiUnitConfig = {
-	[K in SiUnitKeys]?: Exponent;
-};
+export type SiUnitConfig = Partial<Record<SiUnitKeys, Exponent>>;
 /**
  * @group Unit Classes
  * @category Angle (Plane)
@@ -1231,7 +1238,7 @@ export type HenryPerMeter = MagneticPermeabilityUnit<{}>;
  * @see {@link Pow}
  * @see {@link Cubic}
  */
-export type Square<T extends UnknownUnit | UnknownAbstractUnit | UnknownUnitConversionRate | UnknownUnitClass | UnknownUnitMeta> = T extends number ? Pow<T, 2> : T extends UnknownUnitClass ? UnitClass<PowUnitSubvalues<T["__uom_types__value"], 2>> : T extends UnknownUnitMeta ? UnitMeta<PowUnitSubvalues<T["__uom_types__value"], 2>> : never;
+export type Square<T extends UnknownUnit | UnknownAbstractUnit | UnknownUnitConversionRate | UnknownUnitClass | UnknownUnitMeta> = T extends number ? Pow<T, 2> : T extends UnknownUnitClass ? UnitClass<PowUnitSubvalues<T["__uom_types"]["value"], 2>> : T extends UnknownUnitMeta ? UnitMeta<PowUnitSubvalues<T["__uom_types"]["value"], 2>> : never;
 /**
  * Put the given {@link Unit} to the power of 3.
  *
@@ -1240,7 +1247,7 @@ export type Square<T extends UnknownUnit | UnknownAbstractUnit | UnknownUnitConv
  * @see {@link Pow}
  * @see {@link Square}
  */
-export type Cubic<T extends UnknownUnit | UnknownAbstractUnit | UnknownUnitConversionRate | UnknownUnitClass | UnknownUnitMeta> = T extends number ? Pow<T, 3> : T extends UnknownUnitClass ? UnitClass<PowUnitSubvalues<T["__uom_types__value"], 3>> : T extends UnknownUnitMeta ? UnitMeta<PowUnitSubvalues<T["__uom_types__value"], 3>> : never;
+export type Cubic<T extends UnknownUnit | UnknownAbstractUnit | UnknownUnitConversionRate | UnknownUnitClass | UnknownUnitMeta> = T extends number ? Pow<T, 3> : T extends UnknownUnitClass ? UnitClass<PowUnitSubvalues<T["__uom_types"]["value"], 3>> : T extends UnknownUnitMeta ? UnitMeta<PowUnitSubvalues<T["__uom_types"]["value"], 3>> : never;
 /**
  * Binary prefix denoting an order of magnitude of 10^1.
  *
@@ -1355,7 +1362,7 @@ export type Pico<T extends UnknownUnit> = Multiply<T, UnitConversionRate<{
  * @group Modifiers
  * @category General
  */
-export type Reciprocal<T extends UnknownUnit | UnknownAbstractUnit | UnknownUnitConversionRate | UnknownUnitClass | UnknownUnitMeta> = T extends number ? Inverse<T> : T extends UnknownUnitClass ? UnitClass<InverseUnitSubvalues<T["__uom_types__value"]>> : T extends UnknownUnitMeta ? UnitMeta<InverseUnitSubvalues<T["__uom_types__value"]>> : never;
+export type Reciprocal<T extends UnknownUnit | UnknownAbstractUnit | UnknownUnitConversionRate | UnknownUnitClass | UnknownUnitMeta> = T extends number ? Inverse<T> : T extends UnknownUnitClass ? UnitClass<InverseUnitSubvalues<T["__uom_types"]["value"]>> : T extends UnknownUnitMeta ? UnitMeta<InverseUnitSubvalues<T["__uom_types"]["value"]>> : never;
 /**
  * @group Unit Classes
  * @category Electromagnetic

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "uom-types",
-  "version": "4.1.1",
+  "version": "5.0.0",
   "description": "Typesafe units with no runtime overhead.",
   "keywords": [
     "uom",
@@ -77,83 +77,79 @@
     "test": "pnpm run test:js-run && pnpm run test:types",
     "test:js": "vitest --coverage",
     "test:js-run": "vitest run --coverage",
-    "test:types": "pnpm run test:types-pre && tsd -t './dist/index.d.mts' -f 'tests/**/*.test-d.ts'",
+    "test:types": "pnpm run test:types-pre && tsd -t './dist/index.d.mts' -f 'src/**/*.test-d.ts'",
     "test:types-pre": "pnpm run build",
     "typecheck": "tsc -p tsconfig.build.json --noEmit"
   },
-  "resolutions": {
-    "dts-bundle-generator": "9.5.1"
-  },
   "devDependencies": {
-    "@commitlint/cli": "19.5.0",
-    "@commitlint/config-conventional": "19.5.0",
+    "@commitlint/cli": "19.6.0",
+    "@commitlint/config-conventional": "19.6.0",
     "@cspell/dict-cryptocurrencies": "5.0.3",
-    "@eslint/compat": "1.2.0",
-    "@rebeccastevens/eslint-config": "3.3.2",
-    "@rollup/plugin-replace": "6.0.1",
-    "@rollup/plugin-typescript": "12.1.0",
-    "@sebbo2002/semantic-release-jsr": "2.0.1",
+    "@eslint/compat": "1.2.3",
+    "@rebeccastevens/eslint-config": "3.3.3",
+    "@rollup/plugin-typescript": "12.1.1",
+    "@sebbo2002/semantic-release-jsr": "2.0.2",
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/commit-analyzer": "13.0.0",
     "@semantic-release/git": "10.0.1",
-    "@semantic-release/github": "11.0.0",
+    "@semantic-release/github": "11.0.1",
     "@semantic-release/npm": "12.0.1",
     "@semantic-release/release-notes-generator": "14.0.1",
-    "@stylistic/eslint-plugin": "2.9.0",
-    "@types/node": "16.18.113",
-    "@typescript-eslint/eslint-plugin": "8.9.0",
-    "@typescript-eslint/parser": "8.9.0",
-    "@vitest/coverage-v8": "2.1.2",
-    "@vitest/eslint-plugin": "1.1.7",
+    "@stylistic/eslint-plugin": "2.11.0",
+    "@types/node": "18.19.66",
+    "@typescript-eslint/eslint-plugin": "8.16.0",
+    "@typescript-eslint/parser": "8.16.0",
+    "@vitest/coverage-v8": "2.1.6",
+    "@vitest/eslint-plugin": "1.1.11",
     "commitizen": "4.3.1",
-    "cspell": "8.15.3",
+    "cspell": "8.16.1",
     "cz-conventional-changelog": "3.3.0",
-    "eslint": "9.12.0",
+    "eslint": "9.15.0",
     "eslint-config-prettier": "9.1.0",
     "eslint-flat-config-utils": "0.4.0",
     "eslint-import-resolver-typescript": "3.6.3",
     "eslint-merge-processors": "0.1.0",
     "eslint-plugin-eslint-comments": "3.2.0",
     "eslint-plugin-format": "0.1.2",
-    "eslint-plugin-functional": "7.0.2",
-    "eslint-plugin-import-x": "4.3.1",
-    "eslint-plugin-jsdoc": "50.4.1",
-    "eslint-plugin-jsonc": "2.16.0",
+    "eslint-plugin-functional": "7.1.0",
+    "eslint-plugin-import-x": "4.4.3",
+    "eslint-plugin-jsdoc": "50.6.0",
+    "eslint-plugin-jsonc": "2.18.2",
     "eslint-plugin-markdown": "5.1.0",
-    "eslint-plugin-n": "17.11.1",
+    "eslint-plugin-n": "17.14.0",
     "eslint-plugin-no-only-tests": "3.3.0",
     "eslint-plugin-optimize-regex": "1.2.1",
     "eslint-plugin-prettier": "5.2.1",
-    "eslint-plugin-promise": "7.1.0",
-    "eslint-plugin-regexp": "2.6.0",
-    "eslint-plugin-sonarjs": "2.0.3",
-    "eslint-plugin-unicorn": "56.0.0",
-    "eslint-plugin-yml": "1.14.0",
+    "eslint-plugin-promise": "7.2.1",
+    "eslint-plugin-regexp": "2.7.0",
+    "eslint-plugin-sonarjs": "2.0.4",
+    "eslint-plugin-unicorn": "56.0.1",
+    "eslint-plugin-yml": "1.15.0",
     "http-serve": "1.0.1",
-    "husky": "9.1.6",
+    "husky": "9.1.7",
     "jsonc-eslint-parser": "2.4.0",
-    "knip": "5.33.3",
+    "knip": "5.38.1",
     "lint-staged": "15.2.10",
-    "markdownlint-cli2": "0.14.0",
-    "prettier": "3.3.3",
+    "markdownlint-cli2": "0.15.0",
+    "prettier": "3.4.1",
     "rimraf": "6.0.1",
-    "rollup": "4.24.0",
+    "rollup": "4.27.4",
     "rollup-plugin-deassert": "1.3.0",
-    "rollup-plugin-dts-bundle-generator": "1.4.0",
-    "semantic-release": "24.1.2",
-    "tsafe": "1.7.5",
+    "rollup-plugin-dts-bundle-generator-2": "1.0.2",
+    "semantic-release": "24.2.0",
+    "tsafe": "1.8.5",
     "tsc-files": "1.1.4",
     "tsd": "0.31.2",
-    "tsx": "4.19.1",
-    "typedoc": "0.26.9",
-    "typedoc-plugin-coverage": "3.3.0",
-    "typescript": "5.6.3",
-    "vite-tsconfig-paths": "5.0.1",
-    "vitest": "2.1.2",
+    "tsx": "4.19.2",
+    "typedoc": "0.26.11",
+    "typedoc-plugin-coverage": "3.4.0",
+    "typescript": "5.7.2",
+    "vite-tsconfig-paths": "5.1.3",
+    "vitest": "2.1.6",
     "yaml-eslint-parser": "1.2.3"
   },
-  "packageManager": "pnpm@9.12.1",
+  "packageManager": "pnpm@9.14.2",
   "engines": {
-    "node": ">=16.0.0"
+    "node": ">=18.0.0"
   }
 }