Tagged: Add metadata support (#723)

Author: ethanresnick

index.d.ts

@@ -31,7 +31,7 @@ export type {UndefinedOnPartialDeep} from './source/undefined-on-partial-deep';
 export type {ReadonlyDeep} from './source/readonly-deep';
 export type {LiteralUnion} from './source/literal-union';
 export type {Promisable} from './source/promisable';
-export type {Opaque, UnwrapOpaque, Tagged, UnwrapTagged} from './source/opaque';
+export type {Opaque, UnwrapOpaque, Tagged, GetTagMetadata, UnwrapTagged} from './source/opaque';
 export type {InvariantOf} from './source/invariant-of';
 export type {SetOptional} from './source/set-optional';
 export type {SetReadonly} from './source/set-readonly';

source/opaque.d.ts

@@ -4,9 +4,7 @@ export type TagContainer<Token> = {
 	readonly [tag]: Token;
 };
 
-type MultiTagContainer<Token extends PropertyKey> = {
-	readonly [tag]: {[K in Token]: void};
-};
+type Tag<Token extends PropertyKey, TagMetadata> = TagContainer<{[K in Token]: TagMetadata}>;
 
 /**
 Attach a "tag" to an arbitrary type. This allows you to create distinct types, that aren't assignable to one another, for runtime values that would otherwise have the same type. (See examples.)
@@ -113,19 +111,26 @@ type WillWork = UnwrapOpaque<Tagged<number, 'AccountNumber'>>; // number
 @category Type
 */
 export type UnwrapOpaque<OpaqueType extends TagContainer<unknown>> =
-	OpaqueType extends MultiTagContainer<string | number | symbol>
+	OpaqueType extends Tag<PropertyKey, any>
 		? RemoveAllTags<OpaqueType>
 		: OpaqueType extends Opaque<infer Type, OpaqueType[typeof tag]>
 			? Type
 			: OpaqueType;
 
 /**
-Attach a "tag" to an arbitrary type. This allows you to create distinct types, that aren't assignable to one another, for runtime values that would otherwise have the same type. (See examples.)
+Attach a "tag" to an arbitrary type. This allows you to create distinct types, that aren't assignable to one another, for distinct concepts in your program that should not be interchangeable, even if their runtime values have the same type. (See examples.)
 
 A type returned by `Tagged` can be passed to `Tagged` again, to create a type with multiple tags.
 
 [Read more about tagged types.](https://medium.com/@KevinBGreene/surviving-the-typescript-ecosystem-branding-and-type-tagging-6cf6e516523d)
 
+A tag's name is usually a string (and must be a string, number, or symbol), but each application of a tag can also contain an arbitrary type as its "metadata". See {@link GetTagMetadata} for examples and explanation.
+
+A type `A` returned by `Tagged` is assignable to another type `B` returned by `Tagged` if and only if:
+  - the underlying (untagged) type of `A` is assignable to the underlying type of `B`;
+	- `A` contains at least all the tags `B` has;
+	- and the metadata type for each of `A`'s tags is assignable to the metadata type of `B`'s corresponding tag.
+
 There have been several discussions about adding similar features to TypeScript. Unfortunately, nothing has (yet) moved forward:
 	- [Microsoft/TypeScript#202](https://github.com/microsoft/TypeScript/issues/202)
 	- [Microsoft/TypeScript#4895](https://github.com/microsoft/TypeScript/issues/4895)
@@ -151,21 +156,62 @@ function getMoneyForAccount(accountNumber: AccountNumber): AccountBalance {
 getMoneyForAccount(createAccountNumber());
 
 // But this won't, because it has to be explicitly passed as an `AccountNumber` type!
+// Critically, you could not accidentally use an `AccountBalance` as an `AccountNumber`.
 getMoneyForAccount(2);
 
-// You can use opaque values like they aren't opaque too.
-const accountNumber = createAccountNumber();
+// You can also use tagged values like their underlying, untagged type.
+// I.e., this will compile successfully because an `AccountNumber` can be used as a regular `number`.
+// In this sense, the underlying base type is not hidden, which differentiates tagged types from opaque types in other languages.
+const accountNumber = createAccountNumber() + 2;
+```
 
-// This will compile successfully.
-const newAccountNumber = accountNumber + 2;
+@example
+```
+import type {Tagged} from 'type-fest';
+
+// You can apply multiple tags to a type by using `Tagged` repeatedly.
+type Url = Tagged<string, 'URL'>;
+type SpecialCacheKey = Tagged<Url, 'SpecialCacheKey'>;
+
+// You can also pass a union of tag names, so this is equivalent to the above, although it doesn't give you the ability to assign distinct metadata to each tag.
+type SpecialCacheKey2 = Tagged<string, 'URL' | 'SpecialCacheKey'>;
+```
+
+@category Type
+*/
+export type Tagged<Type, TagName extends PropertyKey, TagMetadata = never> = Type & Tag<TagName, TagMetadata>;
+
+/**
+Given a type and a tag name, returns the metadata associated with that tag on that type.
+
+In the example below, one could use `Tagged<string, 'JSON'>` to represent "a string that is valid JSON". That type might be useful -- for instance, it communicates that the value can be safely passed to `JSON.parse` without it throwing an exception. However, it doesn't indicate what type of value will be produced on parse (which is sometimes known). `JsonOf<T>` solves this; it represents "a string that is valid JSON and that, if parsed, would produce a value of type T". The type T is held in the metadata associated with the `'JSON'` tag.
+
+This article explains more about [how tag metadata works and when it can be useful](https://medium.com/@ethanresnick/advanced-typescript-tagged-types-improved-with-type-level-metadata-5072fc125fcf).
+
+@example
+```
+import type {Tagged} from 'type-fest';
+
+type JsonOf<T> = Tagged<string, 'JSON', T>;
+
+function stringify<T>(it: T) {
+  return JSON.stringify(it) as JsonOf<T>;
+}
+
+function parse<T extends JsonOf<unknown>>(it: T) {
+  return JSON.parse(it) as GetTagMetadata<T, 'JSON'>;
+}
+
+const x = stringify({ hello: 'world' });
+const parsed = parse(x); // The type of `parsed` is { hello: string }
 ```
 
 @category Type
 */
-export type Tagged<Type, Tag extends PropertyKey> = Type & MultiTagContainer<Tag>;
+export type GetTagMetadata<Type extends Tag<TagName, unknown>, TagName extends PropertyKey> = Type[typeof tag][TagName];
 
 /**
-Revert a tagged type back to its original type by removing the readonly `[tag]`.
+Revert a tagged type back to its original type by removing all tags.
 
 Why is this necessary?
 
@@ -192,14 +238,13 @@ type WontWork = UnwrapTagged<string>;
 
 @category Type
 */
-export type UnwrapTagged<TaggedType extends MultiTagContainer<PropertyKey>> =
+export type UnwrapTagged<TaggedType extends Tag<PropertyKey, any>> =
 RemoveAllTags<TaggedType>;
 
-type RemoveAllTags<T> = T extends MultiTagContainer<infer ExistingTags>
+type RemoveAllTags<T> = T extends Tag<PropertyKey, any>
 	? {
-		[ThisTag in ExistingTags]:
-		T extends Tagged<infer Type, ThisTag>
+		[ThisTag in keyof T[typeof tag]]: T extends Tagged<infer Type, ThisTag, T[typeof tag][ThisTag]>
 			? RemoveAllTags<Type>
 			: never
-	}[ExistingTags]
+	}[keyof T[typeof tag]]
 	: T;

test-d/opaque.ts

@@ -1,5 +1,5 @@
-import {expectAssignable, expectNotAssignable, expectNotType, expectType} from 'tsd';
-import type {Opaque, UnwrapOpaque, Tagged, UnwrapTagged, SnakeCasedPropertiesDeep} from '../index';
+import {expectAssignable, expectError, expectNotAssignable, expectNotType, expectType} from 'tsd';
+import type {Opaque, UnwrapOpaque, Tagged, GetTagMetadata, UnwrapTagged, InvariantOf,	SnakeCasedPropertiesDeep} from '../index';
 
 type Value = Opaque<number, 'Value'>;
 
@@ -113,6 +113,34 @@ const unwrapped2 = 123 as PlainValueUnwrapTagged;
 expectType<number>(unwrapped1);
 expectType<number>(unwrapped2);
 
+// UnwrapTagged/UnwrapOpaque should work on types with multiple tags.
+const unwrapped3 = '' as UnwrapTagged<NormalizedAbsolutePath>;
+const unwrapped4 = '' as UnwrapOpaque<NormalizedAbsolutePath>;
+expectType<string>(unwrapped3);
+expectType<string>(unwrapped4);
+
+// Tags have no metadata by default
+expectType<never>(undefined as unknown as GetTagMetadata<UrlString, 'URL'>);
+
+// Metadata can be accurately recovered
+type JsonOf<T> = Tagged<string, 'JSON', T>;
+expectType<number>(JSON.parse('43') as GetTagMetadata<JsonOf<number>, 'JSON'>);
+
+// It's a type error to try to get the metadata for a tag that doesn't exist on a type.
+expectError('' as GetTagMetadata<UrlString, 'NonExistentTag'>);
+
+// Tagged types should be covariant in their metadata type
+expectAssignable<JsonOf<number>>('' as JsonOf<42>);
+expectAssignable<JsonOf<number>>('' as JsonOf<number>);
+expectNotAssignable<JsonOf<number>>('' as JsonOf<number | string>);
+
+// InvariantOf should work with tag metadata.
+expectNotAssignable<JsonOf<InvariantOf<number>>>('' as JsonOf<string | number>);
+expectNotAssignable<JsonOf<InvariantOf<number>>>('' as JsonOf<42>);
+expectAssignable<JsonOf<InvariantOf<number>>>(
+	'' as JsonOf<InvariantOf<number>>,
+);
+
 // Test for issue https://github.com/sindresorhus/type-fest/issues/643
 type IdType = Opaque<number, 'test'>;
 type TestSnakeObject = SnakeCasedPropertiesDeep<{testId: IdType}>;