@augment-vir/core 31.41.0 → 31.43.0

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

@@ -0,0 +1,42 @@
+/**
+ * A symbol used for {@link Branded}.
+ *
+ * @category Internal
+ */
+export declare const brandedTypeTag: unique symbol;
+/**
+ * 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
+ *
+ * @category Type
+ * @example
+ *
+ * ```ts
+ * import {Branded, createBrander} from '@augment-vir/common';
+ *
+ * type MyId = Branded<string, 'my-database-id-type'>;
+ * ```
+ */
+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>;
+}>;
+/**
+ * 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
+ *
+ * @category Type
+ */
+export type UnwrapBrand<BrandedType extends Branded<any, any>> = BrandedType extends Branded<infer OriginalType, any> ? OriginalType : BrandedType;
+/**
+ * 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;

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

@@ -0,0 +1,14 @@
+/**
+ * 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/dist/index.d.ts

@@ -33,3 +33,4 @@ export * from './augments/string/match.js';
 export * from './augments/string/punctuation.js';
 export * from './augments/string/remove-duplicate-characters.js';
 export * from './augments/string/uuid.js';
+export * from './augments/type/branded-type.js';

package/dist/index.js

@@ -33,3 +33,4 @@ export * from './augments/string/match.js';
 export * from './augments/string/punctuation.js';
 export * from './augments/string/remove-duplicate-characters.js';
 export * from './augments/string/uuid.js';
+export * from './augments/type/branded-type.js';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/core",
-    "version": "31.41.0",
+    "version": "31.43.0",
     "description": "Core augment-vir augments. Use @augment-vir/common instead.",
     "homepage": "https://github.com/electrovir/augment-vir",
     "bugs": {
@@ -28,14 +28,14 @@
         "test:update": "npm test update"
     },
     "dependencies": {
-        "@date-vir/duration": "^7.4.3",
+        "@date-vir/duration": "^8.0.0",
         "browser-or-node": "^3.0.0",
         "diff": "^8.0.2",
         "json5": "^2.2.3",
         "type-fest": "^5.1.0"
     },
     "devDependencies": {
-        "@types/node": "^24.7.2",
+        "@types/node": "^24.9.1",
         "c8": "^10.1.3",
         "istanbul-smart-text-reporter": "^1.1.5",
         "typescript": "^5.9.3"