refactor: get rid of json map

Author: peternhale

src/commands/commandreference/generate.ts

@@ -12,7 +12,7 @@ import * as path from 'path';
 import { SfCommand } from '@salesforce/sf-plugins-core';
 import { Command, Flags, Interfaces } from '@oclif/core';
 import { Messages, SfError } from '@salesforce/core';
-import { AnyJson, ensure, ensureString, JsonMap } from '@salesforce/ts-types';
+import { AnyJson, ensure, ensureString } from '@salesforce/ts-types';
 import chalk = require('chalk');
 import { parseJsonMap } from '@salesforce/kit';
 import { Ditamap } from '../../ditamap/ditamap';
@@ -167,9 +167,9 @@ export default class CommandReferenceGenerate extends SfCommand<AnyJson> {
     return this.config.plugins.find((info) => info.name === pluginName);
   }
 
-  private async loadTopicMetadata(): Promise<JsonMap> {
-    const plugins: JsonMap = {};
-    const topicsMeta: JsonMap = {};
+  private async loadTopicMetadata(): Promise<Record<string, unknown>> {
+    const plugins: Record<string, unknown> = {};
+    const topicsMeta: Record<string, unknown> = {};
 
     for (const cmd of this.config.commands) {
       // Only load topics for each plugin once
@@ -224,7 +224,7 @@ export default class CommandReferenceGenerate extends SfCommand<AnyJson> {
     return command.load.constructor.name === 'AsyncFunction' ? await command.load() : command.load();
   }
 
-  private loadCliMeta(): JsonMap {
+  private loadCliMeta(): Record<string, unknown> {
     return {
       binary: this.config.pjson.oclif.bin ?? 'sfdx',
       topicSeparator: this.config.pjson.oclif.topicSeparator,

src/ditamap/command.ts

@@ -6,7 +6,7 @@
  */
 
 import { join } from 'path';
-import { asString, Dictionary, ensureObject, ensureString, JsonMap } from '@salesforce/ts-types';
+import { asString, Dictionary, ensureObject, ensureString } from '@salesforce/ts-types';
 import { CommandClass, punctuate } from '../utils';
 import { Ditamap } from './ditamap';
 
@@ -110,7 +110,7 @@ export class Command extends Ditamap {
       isBetaCommand: state === 'beta',
       trailblazerCommunityUrl,
       trailblazerCommunityName,
-    }) as JsonMap;
+    }) as Record<string, unknown>;
 
     this.destination = join(Ditamap.outputDir, topic, filename);
   }

src/ditamap/ditamap.ts

@@ -7,7 +7,6 @@
 
 import { dirname, join } from 'path';
 import * as fs from 'fs/promises';
-import { JsonMap } from '@salesforce/ts-types';
 import * as debugCreator from 'debug';
 import * as hb from 'handlebars';
 import { HelperOptions } from 'handlebars';
@@ -59,7 +58,7 @@ export abstract class Ditamap {
 
   private readonly source: string;
 
-  public constructor(private filename: string, protected data: JsonMap) {
+  public constructor(private filename: string, protected data: Record<string, unknown>) {
     this.source = join(Ditamap.templatesDir, this.getTemplateFileName());
     this.destination = join(Ditamap.outputDir, filename);
   }

src/ditamap/main-topic-intro.ts

@@ -6,18 +6,21 @@
  */
 
 import { join } from 'path';
-import { asString, ensureJsonMap, JsonMap } from '@salesforce/ts-types';
+import { asString, ensureObject } from '@salesforce/ts-types';
 import { punctuate } from '../utils';
 import { Ditamap } from './ditamap';
 
 export class MainTopicIntro extends Ditamap {
-  public constructor(topic: string, subtopic: string, subTopicMeta: JsonMap) {
+  public constructor(topic: string, subtopic: string, subTopicMeta: Record<string, unknown>) {
     const filename = Ditamap.file(`cli_reference_${topic}_${subtopic}`, 'xml');
 
     let trailblazerCommunityUrl: string | undefined;
     let trailblazerCommunityName: string | undefined;
     if (subTopicMeta.trailblazerCommunityLink) {
-      const community = ensureJsonMap(subTopicMeta.trailblazerCommunityLink) as { url: string; name: string };
+      const community = ensureObject<Record<string, unknown>>(subTopicMeta.trailblazerCommunityLink) as {
+        url: string;
+        name: string;
+      };
       trailblazerCommunityUrl = community.url ?? 'unknown';
       trailblazerCommunityName = community.name ?? 'unknown';
     }

src/ditamap/topic-commands.ts

@@ -6,11 +6,10 @@
  */
 
 import { join } from 'path';
-import { JsonMap } from '@salesforce/ts-types';
 import { Ditamap } from './ditamap';
 
 export class TopicCommands extends Ditamap {
-  public constructor(topic: string, topicMeta: JsonMap) {
+  public constructor(topic: string, topicMeta: Record<string, unknown>) {
     const filename = Ditamap.file(`cli_reference_${topic}_commands`, 'xml');
     // Set the data of topic and filenames
     super(filename, topicMeta);

src/docs.ts

@@ -12,11 +12,9 @@ import {
   Dictionary,
   ensure,
   ensureArray,
-  ensureJsonMap,
   ensureObject,
   ensureString,
   isArray,
-  JsonMap,
 } from '@salesforce/ts-types';
 import * as chalk from 'chalk';
 import { BaseDitamap } from './ditamap/base-ditamap';
@@ -57,7 +55,7 @@ export class Docs {
       throw new Error(`No topic meta for ${topic} - add this topic to the oclif section of the package.json.`);
     }
 
-    const topicMeta: JsonMap = (this.topicMeta[topic] ?? {}) as JsonMap;
+    const topicMeta: Record<string, unknown> = (this.topicMeta[topic] ?? {}) as Record<string, unknown>;
 
     let description = asString(topicMeta.description);
     if (!description && !topicMeta.external) {
@@ -93,7 +91,7 @@ export class Docs {
           continue;
         }
 
-        const subTopicsMeta = ensureJsonMap(topicMeta.subtopics);
+        const subTopicsMeta = ensureObject<Record<string, unknown>>(topicMeta.subtopics);
 
         if (!subTopicsMeta[subtopic]) {
           emitNoTopicMetadataWarning(`${topic}:${subtopic}`);