feat: add CaipAssetTypeOrId struct (#229)

This new type allows to use either a `CaipAssetType` or `CaipAssetId`
without using `superstruct.union`. Resulting in better error messages.

Author: ccharly

src/caip-types.ts

@@ -27,6 +27,9 @@ export const CAIP_ASSET_TYPE_REGEX =
 export const CAIP_ASSET_ID_REGEX =
   /^(?<chainId>(?<namespace>[-a-z0-9]{3,8}):(?<reference>[-_a-zA-Z0-9]{1,32}))\/(?<assetNamespace>[-a-z0-9]{3,8}):(?<assetReference>[-.%a-zA-Z0-9]{1,128})\/(?<tokenId>[-.%a-zA-Z0-9]{1,78})$/u;
 
+const CAIP_ASSET_TYPE_OR_ID_REGEX =
+  /^(?<chainId>(?<namespace>[-a-z0-9]{3,8}):(?<reference>[-_a-zA-Z0-9]{1,32}))\/(?<assetNamespace>[-a-z0-9]{3,8}):(?<assetReference>[-.%a-zA-Z0-9]{1,128})(\/(?<tokenId>[-.%a-zA-Z0-9]{1,78}))?$/u;
+
 /**
  * A CAIP-2 chain ID, i.e., a human-readable namespace and reference.
  */
@@ -120,6 +123,14 @@ export const CaipAssetIdStruct =
   );
 export type CaipAssetId = Infer<typeof CaipAssetIdStruct>;
 
+/**
+ * A CAIP-19 asset type or asset ID identifier, i.e., a human-readable type of asset identifier.
+ */
+export const CaipAssetTypeOrIdStruct = definePattern<
+  CaipAssetType | CaipAssetId
+>('CaipAssetTypeOrId', CAIP_ASSET_TYPE_OR_ID_REGEX);
+export type CaipAssetTypeOrId = Infer<typeof CaipAssetTypeOrIdStruct>;
+
 /** Known CAIP namespaces. */
 export enum KnownCaipNamespace {
   /** BIP-122 (Bitcoin) compatible chains. */

src/index.test.ts

@@ -20,6 +20,7 @@ describe('index', () => {
         "CaipAssetIdStruct",
         "CaipAssetNamespaceStruct",
         "CaipAssetReferenceStruct",
+        "CaipAssetTypeOrIdStruct",
         "CaipAssetTypeStruct",
         "CaipChainIdStruct",
         "CaipNamespaceStruct",

src/node.test.ts

@@ -20,6 +20,7 @@ describe('node', () => {
         "CaipAssetIdStruct",
         "CaipAssetNamespaceStruct",
         "CaipAssetReferenceStruct",
+        "CaipAssetTypeOrIdStruct",
         "CaipAssetTypeStruct",
         "CaipChainIdStruct",
         "CaipNamespaceStruct",