Implement hidden property for Cfgu declaration with ExportCommand `…

…filter` callback (#379)
configu · Mar 10, 2024 · 02ce5e2 · 02ce5e2
1 parent 7844cda
commit 02ce5e2
Show file tree

Hide file tree

Showing 4 changed files with 49 additions and 9 deletions.
diff --git a/ts/packages/ts/src/commands/ExportCommand.ts b/ts/packages/ts/src/commands/ExportCommand.ts
@@ -10,6 +10,7 @@ export type ExportCommandReturn = {
 export type ExportCommandParameters = {
   pipe: EvalCommandReturn;
   keys?: (key: string) => string;
+  filter?: ({ context, result }: EvalCommandReturn['string']) => boolean;
 };
 
 export class ExportCommand extends Command<ExportCommandReturn> {
@@ -37,9 +38,18 @@ export class ExportCommand extends Command<ExportCommandReturn> {
     });
   }
 
+  private filterPipe(pipe: EvalCommandReturn) {
+    const { filter } = this.parameters;
+    if (!filter) {
+      return _.pickBy(pipe, ({ context }) => !context.cfgu.hidden);
+    }
+    return _.pickBy(pipe, filter);
+  }
+
   async run() {
     const { pipe } = this.parameters;
-    const configDict = _.mapValues(pipe, (current) => current.result.value);
+    const filteredPipe = this.filterPipe(pipe);
+    const configDict = _.mapValues(filteredPipe, (current) => current.result.value);
     const keyMutatedConfigDict = this.mutateKeys(configDict);
     return keyMutatedConfigDict;
   }

diff --git a/ts/packages/ts/src/commands/commands.test.ts b/ts/packages/ts/src/commands/commands.test.ts
@@ -377,24 +377,49 @@ describe(`commands`, () => {
     });
   });
   describe(`ExportCommand`, () => {
-    const getEvalResult = async () => {
+    const getEvalResult = async (schema?: ConfigSchema) => {
       return new EvalCommand({
         store: store1,
         set: set1,
-        schema: new ConfigSchema('mutate', {
+        schema:
+          schema ||
+          new ConfigSchema('mutate', {
+            KEY0: {
+              type: 'String',
+            },
+            KEY1: {
+              type: 'String',
+            },
+          }),
+        configs: {
+          KEY0: 'KEY0',
+          KEY1: 'KEY1',
+        },
+      }).run();
+    };
+    test('Export with filter', async () => {
+      const evalResult = await getEvalResult();
+      const exportedConfigs = await new ExportCommand({
+        pipe: evalResult,
+        filter: ({ context, result }) => result.value !== 'KEY0',
+      }).run();
+      expect(exportedConfigs).toStrictEqual({ KEY1: 'KEY1' });
+    });
+    test('Export with hidden configs', async () => {
+      const evalResult = await getEvalResult(
+        new ConfigSchema('mutate', {
           KEY0: {
             type: 'String',
           },
           KEY1: {
             type: 'String',
+            hidden: true,
           },
         }),
-        configs: {
-          KEY0: 'KEY0',
-          KEY1: 'KEY1',
-        },
-      }).run();
-    };
+      );
+      const exportedConfigs = await new ExportCommand({ pipe: evalResult }).run();
+      expect(exportedConfigs).toStrictEqual({ KEY0: 'KEY0' });
+    });
     describe(`Keys Mutation Callback`, () => {
       test('Export without keys mutation callback', async () => {
         const evalResult = await getEvalResult();

diff --git a/ts/packages/ts/src/types/generated.ts b/ts/packages/ts/src/types/generated.ts
@@ -26,6 +26,7 @@ export interface Cfgu {
     default?:     string;
     depends?:     string[];
     description?: string;
+    hidden?:      boolean;
     labels?:      string[];
     lazy?:        boolean;
     options?:     string[];
@@ -63,6 +64,7 @@ export interface ConfigSchemaContents {
     default?:     string;
     depends?:     string[];
     description?: string;
+    hidden?:      boolean;
     labels?:      string[];
     lazy?:        boolean;
     options?:     string[];
@@ -351,6 +353,7 @@ const typeMap: any = {
         { json: "default", js: "default", typ: u(undefined, "") },
         { json: "depends", js: "depends", typ: u(undefined, a("")) },
         { json: "description", js: "description", typ: u(undefined, "") },
+        { json: "hidden", js: "hidden", typ: u(undefined, true) },
         { json: "labels", js: "labels", typ: u(undefined, a("")) },
         { json: "lazy", js: "lazy", typ: u(undefined, true) },
         { json: "options", js: "options", typ: u(undefined, a("")) },
@@ -373,6 +376,7 @@ const typeMap: any = {
         { json: "default", js: "default", typ: u(undefined, "") },
         { json: "depends", js: "depends", typ: u(undefined, a("")) },
         { json: "description", js: "description", typ: u(undefined, "") },
+        { json: "hidden", js: "hidden", typ: u(undefined, true) },
         { json: "labels", js: "labels", typ: u(undefined, a("")) },
         { json: "lazy", js: "lazy", typ: u(undefined, true) },
         { json: "options", js: "options", typ: u(undefined, a("")) },

diff --git a/types/Cfgu.ts b/types/Cfgu.ts
@@ -52,4 +52,5 @@ export interface Cfgu {
   options?: string[];
   lazy?: boolean;
   labels?: string[];
+  hidden?: boolean;
 }