@augment-vir/core 31.43.1 → 31.43.3

package/dist/augments/diff/pretty-diff.js

@@ -1,4 +1,5 @@
 import { diffLines, diffWords } from 'diff';
+import { sortObject } from '../object/object-sort.js';
 import { stringify } from '../object/stringify.js';
 import { isRuntimeEnv, RuntimeEnv } from '../runtime-env.js';
 export function prettyDiff(actual, expected) {
@@ -7,22 +8,26 @@ export function prettyDiff(actual, expected) {
     const diffFunction = (useLines ? diffLines : diffWords);
     const expectedString = [
         bothStrings ? '' : '\n',
-        stringify(expected, 4),
+        stringify(!!expected && typeof expected === 'object' && !Array.isArray(expected)
+            ? sortObject(expected)
+            : expected, 4),
         '\n',
     ].join('');
     const actualString = [
         bothStrings ? '' : '\n',
-        stringify(actual, 4),
+        stringify(!!actual && typeof actual === 'object' && !Array.isArray(actual)
+            ? sortObject(actual)
+            : actual, 4),
         '\n',
     ].join('');
-    const changes = addDiffColors(useLines, diffFunction(expectedString, actualString));
+    const changes = addDiffColors(useLines, diffFunction(actualString, expectedString));
     const useColor = isRuntimeEnv(RuntimeEnv.Node);
     /* node:coverage ignore next 7: currently only tested in node */
     const explanationLine = [
         useColor ? NodeColor.Green : '',
-        ' +added',
+        ' +added (unexpected, added in actual)',
         useColor ? NodeColor.Red : '',
-        ' -missing',
+        ' -missing (expected, missing from actual)',
         useColor ? NodeColor.Reset : '',
     ].join('');
     return [

package/dist/augments/object/object-sort.d.ts

@@ -0,0 +1,9 @@
+import { type AnyObject } from './generic-object-type.js';
+/**
+ * Creates as new sorted object copied from the the original given object.
+ *
+ * @category Object
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export declare function sortObject<const T extends AnyObject>(original: Readonly<T>): T;

package/dist/augments/object/object-sort.js

@@ -0,0 +1,10 @@
+/**
+ * Creates as new sorted object copied from the the original given object.
+ *
+ * @category Object
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export function sortObject(original) {
+    return Object.fromEntries(Object.entries(original).sort((a, b) => a[0].localeCompare(b[0])));
+}

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

@@ -4,12 +4,18 @@
  * @category Internal
  */
 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,19 +28,33 @@ export type BrandedTypeTag = '$_brand_$';
  */
 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<Record<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,8 +1,3 @@
-/**
- * Wrap a value in a brand that matches its original type.
- *
- * @category Type
- */
 export function applyBrand(value) {
     return value;
 }

package/dist/index.d.ts

@@ -15,6 +15,7 @@ export * from './augments/min-max.js';
 export * from './augments/narrow-type.js';
 export * from './augments/object/generic-object-type.js';
 export * from './augments/object/object-keys.js';
+export * from './augments/object/object-sort.js';
 export * from './augments/object/object-value-types.js';
 export * from './augments/object/required-keys.js';
 export * from './augments/object/stringify.js';

package/dist/index.js

@@ -15,6 +15,7 @@ export * from './augments/min-max.js';
 export * from './augments/narrow-type.js';
 export * from './augments/object/generic-object-type.js';
 export * from './augments/object/object-keys.js';
+export * from './augments/object/object-sort.js';
 export * from './augments/object/object-value-types.js';
 export * from './augments/object/required-keys.js';
 export * from './augments/object/stringify.js';

package/package.json

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