@augment-vir/core 31.43.0 → 31.43.2

package/dist/augments/type/branded-type.d.ts

@@ -1,15 +1,21 @@
 /**
- * A symbol used for {@link Branded}.
+ * Property key used to mark {@link Branded}.
  *
  * @category Internal
  */
-export declare const brandedTypeTag: unique symbol;
+export type BrandedTypeTag = '$_brand_$';
+/**
+ * Applies a branding to types for {@link Branded}.
+ *
+ * @category Internal
+ */
+export type Brand<BrandKey extends PropertyKey> = Readonly<Record<BrandedTypeTag, Record<BrandKey, never>>>;
 /**
  * Brand any type so that it is no longer assignable to itself. For example, brand a database id
  * `string` type so that standard strings cannot be assigned to it.
  *
  * Largely inspired by the `Tagged` type from the `type-fest` package at
- * https://github.com/sindresorhus/type-fest/tree/687a89d94c4403d93ac5cb969ac7f492cee006cb/source
+ * https://github.com/sindresorhus/type-fest/blob/687a89d94c4403d93ac5cb969ac7f492cee006cb/source/tagged.d.ts
  *
  * @category Type
  * @example
@@ -22,21 +28,33 @@ export declare const brandedTypeTag: unique symbol;
  */
 export type Branded<OriginalType, 
 /** The key for this brand. Two branded types with the same key will be assignable to each other. */
-BrandKey extends PropertyKey> = OriginalType & Readonly<{
-    [brandedTypeTag]: Record<BrandKey, never>;
-}>;
+BrandKey extends PropertyKey> = OriginalType & Brand<BrandKey>;
 /**
  * Unwrap a type brand applied via {@link Branded}.
  *
  * Largely inspired by the `Tagged` type from the `type-fest` package at
- * https://github.com/sindresorhus/type-fest/tree/687a89d94c4403d93ac5cb969ac7f492cee006cb/source
+ * https://github.com/sindresorhus/type-fest/blob/687a89d94c4403d93ac5cb969ac7f492cee006cb/source/tagged.d.ts
  *
  * @category Type
  */
-export type UnwrapBrand<BrandedType extends Branded<any, any>> = BrandedType extends Branded<infer OriginalType, any> ? OriginalType : BrandedType;
+export type UnwrapBrand<BrandedType extends Branded<any, any>> = RemoveAllBranding<BrandedType>;
+/**
+ * Removes all branding for {@link UnwrapBrand}.
+ *
+ * Largely inspired by the `RemoveAllTags` type from the `type-fest` package at
+ * https://github.com/sindresorhus/type-fest/blob/687a89d94c4403d93ac5cb969ac7f492cee006cb/source/tagged.d.ts
+ *
+ * @category Internal
+ */
+export type RemoveAllBranding<T> = T extends Brand<any> ? {
+    [ThisBrand in keyof T[BrandedTypeTag]]: T extends Branded<infer OriginalType, ThisBrand> ? RemoveAllBranding<OriginalType> : never;
+}[keyof T[BrandedTypeTag]] : T;
 /**
  * Wrap a value in a brand that matches its original type.
  *
  * @category Type
  */
-export declare function applyBrand<Brand extends Branded<any, any>>(value: UnwrapBrand<Brand>): Brand;
+export declare function applyBrand<const NewBrand extends Branded<any, any> = never>(value: string): NewBrand;
+export declare function applyBrand<const NewBrand extends Branded<any, any> = never>(value: string | undefined): NewBrand | undefined;
+export declare function applyBrand<const NewBrand extends Branded<any, any> = never>(value: string | null): NewBrand | null;
+export declare function applyBrand<const NewBrand extends Branded<any, any> = never>(value: string | undefined | null): NewBrand | undefined | null;

package/dist/augments/type/branded-type.js

@@ -1,14 +1,3 @@
-/**
- * A symbol used for {@link Branded}.
- *
- * @category Internal
- */
-export const brandedTypeTag = Symbol.for('augment-vir-core-branded-type-tag');
-/**
- * Wrap a value in a brand that matches its original type.
- *
- * @category Type
- */
 export function applyBrand(value) {
     return value;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/core",
-    "version": "31.43.0",
+    "version": "31.43.2",
     "description": "Core augment-vir augments. Use @augment-vir/common instead.",
     "homepage": "https://github.com/electrovir/augment-vir",
     "bugs": {