mv Format index to Utils

src/model/Scraper/Format/Utils.ts

@@ -1,6 +1,12 @@
 // Copyright 2024 @polkadot-cloud/polkadot-developer-console authors & contributors
 // SPDX-License-Identifier: GPL-3.0-only
 
+import type { AnyJson } from '@w3ux/types';
+
+// ------------------------------------------------------
+// Labels.
+// ------------------------------------------------------
+
 // Gets a short label from a label input.
 export const getShortLabel = (
   input: string | { long: string; short: string }
@@ -19,3 +25,47 @@ export const verifyOption = (
   shortLabel === 'Option' &&
   variant?.[0]?.name === 'None' &&
   variant?.[1]?.name === 'Some';
+
+// ------------------------------------------------------
+// Type paths and params.
+// ------------------------------------------------------
+
+// Format a string representation of the type using its path and params.
+//
+// E.g. BalanceOf<T>, where BalanceOf is the path and <T> is its param.
+export const typeToString = (path: string[], params: string[]): string => {
+  const paramsStr = paramsToString(params);
+  const pathStr = pathToString(path);
+
+  let label = `${pathStr}`;
+  if (paramsStr) {
+    label += `${paramsStr}`;
+  }
+  return label;
+};
+
+// Format a type's params into a string.
+//
+// E.g. <param1>, <param2>, etc...
+export const paramsToString = (params: AnyJson): string =>
+  params.reduce(
+    (formatted: string, { name }: { name: string }, index: number) => {
+      let str = index === 0 ? `<${name}` : `, ${name}`;
+      if (index === params.length - 1) {
+        str += `>`;
+      }
+      return (formatted += str);
+    },
+    ''
+  );
+
+// Format a type's path into a string.
+//
+// E.g. <path>::<path>::<path>
+export const pathToString = (path: string[]): string =>
+  path.reduce((formatted: string, item: string, index: number) => {
+    if (index === 0) {
+      return item;
+    }
+    return index === 0 ? item : `${formatted}::${item}`;
+  }, '');

src/model/Scraper/Types/BitSequence.ts

@@ -5,7 +5,7 @@ import type { LookupItem } from '../Lookup/types';
 import type { MetadataScraper } from '..';
 import type { TrailParam } from '../types';
 import type { BitSequenceType, MetadataType } from './types';
-import { Format } from '../Format';
+import { typeToString } from '../Format/Utils';
 
 // Class to hold a bit sequence type.
 export class BitSequence implements MetadataType {
@@ -26,7 +26,7 @@ export class BitSequence implements MetadataType {
   label() {
     const { path, params } = this.lookup.type;
     return {
-      long: Format.typeToString(path, params),
+      long: typeToString(path, params),
       short: path[path.length - 1],
     };
   }

src/model/Scraper/Types/Composite.ts

@@ -5,7 +5,7 @@ import type { LookupItem } from '../Lookup/types';
 import type { MetadataScraper } from '..';
 import type { TrailParam } from '../types';
 import type { CompositeField, CompositeType, MetadataType } from './types';
-import { Format } from '../Format';
+import { typeToString } from '../Format/Utils';
 
 // Class to hold a composite type.
 export class Composite implements MetadataType {
@@ -26,7 +26,7 @@ export class Composite implements MetadataType {
   label() {
     const { path, params } = this.lookup.type;
     return {
-      long: Format.typeToString(path, params),
+      long: typeToString(path, params),
       short: path[path.length - 1],
     };
   }

src/model/Scraper/Types/Variant.ts

@@ -5,7 +5,7 @@ import type { LookupItem } from '../Lookup/types';
 import type { MetadataScraper } from '..';
 import type { MetadataType, VariantItem } from './types';
 import type { TrailParam } from '../types';
-import { Format } from '../Format';
+import { typeToString } from '../Format/Utils';
 
 // Class to hold a variant type.
 export class Variant implements MetadataType {
@@ -26,7 +26,7 @@ export class Variant implements MetadataType {
   label() {
     const { path, params } = this.lookup.type;
     return {
-      long: Format.typeToString(path, params),
+      long: typeToString(path, params),
       short: path[path.length - 1],
     };
   }