@zayne-labs/toolkit-type-helpers 0.8.56 → 0.8.58

package/dist/esm/index.d.ts

@@ -44,29 +44,33 @@ type Writeable<TObject, TVariant extends WriteableVariantUnion = "shallow"> = TO
     -readonly [Key in keyof TObject]: TVariant extends "shallow" ? TObject[Key] : TVariant extends "deep" ? TObject[Key] extends object ? Writeable<TObject[Key], TVariant> : TObject[Key] : never;
 } : TObject;
 
-type AllowOnlyFirst<TFirstType, TSecondType, TExclusionValue = never> = Prettify<TFirstType & Partial<Record<keyof Omit<TSecondType, keyof TFirstType>, TExclusionValue>>>;
-type AllowOnlyFirstRequired<TFirstType, TSecondType, TExclusionValue = never> = Prettify<TFirstType & Record<keyof Omit<TSecondType, keyof TFirstType>, TExclusionValue>>;
+/**
+ * Type utility that takes two types and allows only the properties of the first type. The properties of the second will be disallowed (typed as `never` by default or a custom message).
+ *
+ * @template TFirstType The first type. Properties of this type will be required.
+ * @template TSecondType The second type. Properties of this type will be disallowed.
+ * @template TErrorMessages An object of custom messages to display on the properties of the second type that are disallowed.
+ */
+type AllowOnlyFirst<TFirstType, TSecondType, TErrorMessages extends Record<string, unknown> = never> = Prettify<TFirstType & {
+    [Key in keyof Omit<TSecondType, keyof TFirstType>]?: Key extends keyof TErrorMessages ? TErrorMessages[Key] : never;
+}>;
+/**
+ * Merges all types in an array of types into one type.
+ *
+ * @template TArrayOfTypes Array of types to merge
+ * @template TAccumulator Accumulator for the resulting merged type
+ */
 type MergeTypes<TArrayOfTypes extends unknown[], TAccumulator = NonNullable<unknown>> = TArrayOfTypes extends [infer TFirstType, ...infer TRest] ? MergeTypes<TRest, TAccumulator & TFirstType> : TAccumulator;
 /**
  * Type utility that extracts discriminated properties from a union of types.
  * Takes an array of types and returns a union of types where each type has unique properties.
  *
  * @template TArrayOfTypes Array of types to process
- * @template TExclusionValue Value to exclude from the resulting union
+ * @template TErrorMessages An object of custom messages to display on the properties that are disallowed.
  * @template TAccumulator Accumulator for the resulting union
  * @template TMergedProperties Merged properties from all types
  */
-type UnionDiscriminator<TArrayOfTypes extends unknown[], TExclusionValue = never, TAccumulator = never, TMergedProperties = MergeTypes<TArrayOfTypes>> = TArrayOfTypes extends [infer TFirstType, ...infer TRest] ? UnionDiscriminator<TRest, TExclusionValue, TAccumulator | AllowOnlyFirst<TFirstType, TMergedProperties, TExclusionValue>, TMergedProperties> : TAccumulator;
-/**
- * Type utility that extracts discriminated properties from a union of types.
- * Takes an array of types and returns a union of types where each type has unique properties.
- *
- * @template TArrayOfTypes - Array of types to process
- * @template TExclusionValue - Value to exclude from the resulting union
- * @template TAccumulator - Accumulator for the resulting union
- * @template TMergedProperties - Merged properties from all types
- */
-type UnionDiscriminatorRequired<TArrayOfTypes extends unknown[], TExclusionValue = never, TAccumulator = never, TMergedProperties = MergeTypes<TArrayOfTypes>> = TArrayOfTypes extends [infer TFirstType, ...infer TRest] ? UnionDiscriminatorRequired<TRest, TExclusionValue, TAccumulator | AllowOnlyFirstRequired<TFirstType, TMergedProperties, TExclusionValue>, TMergedProperties> : TAccumulator;
+type UnionDiscriminator<TArrayOfTypes extends unknown[], TErrorMessages extends Record<string, unknown> = never, TAccumulator = never, TMergedProperties = MergeTypes<TArrayOfTypes>> = TArrayOfTypes extends [infer TFirstType, ...infer TRest] ? UnionDiscriminator<TRest, TErrorMessages, TAccumulator | AllowOnlyFirst<TFirstType, TMergedProperties, TErrorMessages>, TMergedProperties> : TAccumulator;
 type ExtractUnion<TObject, TVariant extends "keys" | "values" = "values"> = TObject extends Array<infer TUnion> | ReadonlyArray<infer TUnion> | Set<infer TUnion> ? TUnion : TObject extends Record<infer TKeys, infer TValues> ? TVariant extends "keys" ? TKeys : Prettify<Writeable<TValues, "deep">> : never;
 
 declare const isString: (value: unknown) => value is string;
@@ -105,4 +109,4 @@ declare const assert: AssertFn;
 
 declare const defineEnum: <TVariant extends WriteableVariantUnion = "shallow", const TValue = NonNullable<unknown>>(value: TValue) => Prettify<Writeable<TValue, TVariant>>;
 
-export { type AnyAsyncFunction, type AnyFunction, type AnyNumber, type AnyObject, type AnyString, AssertionError, type CallbackFn, type ExtractUnion, type LiteralUnion, type NonEmptyArray, type NonFalsy, type Prettify, type PrettyOmit, type PrettyPick, type SelectorFn, type UnionDiscriminator, type UnionDiscriminatorRequired, type UnknownObject, type UnknownObjectWithAnyKey, type UnmaskType, type Writeable, type WriteableVariantUnion, assert, assertDefined, assertENV, defineEnum, hasObjectPrototype, isArray, isAsyncFunction, isBoolean, isFile, isFormData, isFunction, isIterable, isNumber, isObject, isObjectAndNotArray, isPlainObject, isString, isSymbol };
+export { type AnyAsyncFunction, type AnyFunction, type AnyNumber, type AnyObject, type AnyString, AssertionError, type CallbackFn, type ExtractUnion, type LiteralUnion, type NonEmptyArray, type NonFalsy, type Prettify, type PrettyOmit, type PrettyPick, type SelectorFn, type UnionDiscriminator, type UnknownObject, type UnknownObjectWithAnyKey, type UnmaskType, type Writeable, type WriteableVariantUnion, assert, assertDefined, assertENV, defineEnum, hasObjectPrototype, isArray, isAsyncFunction, isBoolean, isFile, isFormData, isFunction, isIterable, isNumber, isObject, isObjectAndNotArray, isPlainObject, isString, isSymbol };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zayne-labs/toolkit-type-helpers",
   "type": "module",
-  "version": "0.8.56",
+  "version": "0.8.58",
   "description": "A collection of utility functions, types and composables used by my other projects. Nothing too fancy but can be useful.",
   "author": "Ryan Zayne",
   "license": "MIT",
@@ -67,6 +67,9 @@
     "build:test": "concurrently --prefix-colors \"yellow.bold,#7da4f8.bold,magenta\" --names PUBLINT,TSUP 'pnpm:lint:publint' 'pnpm:build:dev'",
     "dev": "pnpm build:dev --watch",
     "lint:attw": "attw --pack . --ignore-rules=cjs-resolves-to-esm",
+    "lint:eslint": "eslint . --max-warnings 0",
+    "lint:eslint:interactive": "pnpx eslint-interactive@latest . --max-warnings 0 --fix",
+    "lint:format": "prettier --write .",
     "lint:publint": "publint --strict .",
     "lint:size": "size-limit",
     "lint:type-check": "tsc --pretty  -p tsconfig.json",