feat: support env display

salesforcecli · Aug 30, 2021 · 446af15 · 446af15
1 parent 9703aa3
commit 446af15
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 9 deletions.
diff --git a/src/exported.ts b/src/exported.ts
@@ -9,3 +9,4 @@ export { generateTableChoices } from './util';
 export { Deployable, Deployer } from './deployer';
 export { Prompter } from './prompter';
 export { runHook, SfHook } from './hooks';
+export { JsonObject, TableObject } from './types';
diff --git a/src/hooks.ts b/src/hooks.ts
@@ -10,11 +10,11 @@ import { Hook, Hooks } from '@oclif/core/lib/interfaces/hooks';
 import { cli } from 'cli-ux';
 import { Duration, env } from '@salesforce/kit';
 import { Deployer } from './deployer';
-import { EnvList, EnvDisplay, DataObject, Deploy, Login } from './types';
+import { EnvList, EnvDisplay, JsonObject, Deploy, Login, TableObject } from './types';
 
 interface SfHooks<T = unknown> extends Hooks {
-  'sf:env:list': EnvList.HookMeta<T & DataObject>;
-  'sf:env:display': EnvDisplay.HookMeta<T & DataObject>;
+  'sf:env:list': EnvList.HookMeta<T & TableObject>;
+  'sf:env:display': EnvDisplay.HookMeta<T & JsonObject>;
   'sf:deploy': Deploy.HookMeta<T & Deployer>;
   'sf:login': Login.HookMeta;
 }

diff --git a/src/types/index.ts b/src/types/index.ts
@@ -7,19 +7,27 @@
 
 import { Deployer } from '../deployer';
 
-export type DataObject = {
-  [key: string]: string | boolean;
+export type JsonObject = {
+  [key: string]: string | string[] | number | number[] | boolean | boolean[] | null | undefined;
+};
+
+/**
+ * Describes an object that is intended to be rendered in a table, which requires
+ * that no value is an array.
+ */
+export type TableObject = {
+  [key: string]: string | number | boolean | null | undefined;
 };
 
 export namespace EnvDisplay {
-  export type HookMeta<T extends DataObject> = {
-    options: {};
+  export type HookMeta<T extends JsonObject> = {
+    options: { targetEnv: string };
     return: T;
   };
 }
 
 export namespace EnvList {
-  type Table<T extends DataObject> = {
+  type Table<T extends TableObject> = {
     data: T[];
     columns: Array<keyof T>;
     title: string;
@@ -29,7 +37,7 @@ export namespace EnvList {
     all: boolean;
   };
 
-  export type HookMeta<T extends DataObject> = {
+  export type HookMeta<T extends TableObject> = {
     options: Options;
     return: Array<Table<T>>;
   };