feat: Added verbosity level and automatic required parameter generation for inits

Author: kevinwang5658

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "codify-plugin-lib",
-  "version": "1.0.166",
+  "version": "1.0.167",
   "description": "Library plugin library",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -16,7 +16,7 @@
   "dependencies": {
     "ajv": "^8.12.0",
     "ajv-formats": "^2.1.1",
-    "codify-schemas": "1.0.73",
+    "codify-schemas": "1.0.74",
     "@npmcli/promise-spawn": "^7.0.1",
     "@homebridge/node-pty-prebuilt-multiarch": "^0.12.0-beta.5",
     "uuid": "^10.0.0",

package.json

@@ -28,7 +28,7 @@ import { Plugin } from '../plugin/plugin.js';
 
 const SupportedRequests: Record<string, { handler: (plugin: Plugin, data: any) => Promise<unknown>; requestValidator: SchemaObject; responseValidator: SchemaObject }> = {
   'initialize': {
-    handler: async (plugin: Plugin) => plugin.initialize(),
+    handler: async (plugin: Plugin, data: any) => plugin.initialize(data),
     requestValidator: InitializeRequestDataSchema,
     responseValidator: InitializeResponseDataSchema
   },

src/messages/handlers.ts

@@ -5,6 +5,7 @@ import {
   GetResourceInfoResponseData,
   ImportRequestData,
   ImportResponseData,
+  InitializeRequestData,
   InitializeResponseData,
   MatchRequestData,
   MatchResponseData,
@@ -23,6 +24,7 @@ import { getPty } from '../pty/index.js';
 import { Resource } from '../resource/resource.js';
 import { ResourceController } from '../resource/resource-controller.js';
 import { ptyLocalStorage } from '../utils/pty-local-storage.js';
+import { VerbosityLevel } from '../utils/utils.js';
 
 export class Plugin {
   planStorage: Map<string, Plan<any>>;
@@ -46,7 +48,11 @@ export class Plugin {
     return new Plugin(name, controllersMap);
   }
 
-  async initialize(): Promise<InitializeResponseData> {
+  async initialize(data: InitializeRequestData): Promise<InitializeResponseData> {
+    if (data.verbosityLevel) {
+      VerbosityLevel.set(data.verbosityLevel);
+    }
+
     for (const controller of this.resourceControllers.values()) {
       await controller.initialize();
     }
@@ -116,7 +122,7 @@ export class Plugin {
     const result = await ptyLocalStorage.run(this.planPty, () =>
       this.resourceControllers
         .get(core.type!)
-        ?.import(core, parameters)
+        ?.import(core, parameters, data.autoSearchAll)
     )
 
     return {

src/plugin/plugin.ts

@@ -6,6 +6,7 @@ import * as fs from 'node:fs/promises';
 import stripAnsi from 'strip-ansi';
 
 import { debugLog } from '../utils/debug.js';
+import { VerbosityLevel } from '../utils/utils.js';
 import { IPty, SpawnError, SpawnOptions, SpawnResult } from './index.js';
 import { PromiseQueue } from './promise-queue.js';
 
@@ -76,7 +77,10 @@ export class BackgroundPty implements IPty {
             data: strippedData,
           });
         } else {
-          process.stdout.write(data);
+          // Print to stdout if the verbosity level is above 0
+          if (VerbosityLevel.get() > 0) {
+            process.stdout.write(data);
+          }
         }
       })
 

src/pty/background-pty.ts

@@ -258,7 +258,8 @@ export class ResourceController<T extends StringIndexedObject> {
 
   async import(
     core: ResourceConfig,
-    parameters: Partial<T>
+    parameters: Partial<T>,
+    autoSearchAll = false,
   ): Promise<Array<ResourceJson> | null> {
     if (this.settings.importAndDestroy?.preventImport) {
       throw new Error(`Type: ${this.typeId} cannot be imported`);
@@ -270,6 +271,18 @@ export class ResourceController<T extends StringIndexedObject> {
       originalDesiredConfig: structuredClone(parameters),
     };
 
+    // Auto search means that no required parameters will be provided. We will try to generate it ourselves or return an
+    // empty array if they can't be.
+    if (autoSearchAll && this.settings.allowMultiple) {
+      if (this.settings.allowMultiple === true || !this.settings.allowMultiple.findAllParameters?.()) {
+        return [];
+      }
+
+      const parametersToImport = await this.settings.allowMultiple.findAllParameters?.();
+      const results = await Promise.all(parametersToImport.map((p) => this.import(core, p)));
+      return results.filter(Boolean).flat() as ResourceJson[];
+    }
+
     this.addDefaultValues(parameters);
     await this.applyTransformParameters(parameters);
 

src/resource/resource-controller.ts

@@ -43,7 +43,7 @@ export interface ResourceSettings<T extends StringIndexedObject> {
      * If paramA is required, then if resource1.paramA === resource2.paramA then are the same resource.
      * If resource1.paramA !== resource1.paramA, then they are different.
      */
-    identifyingParameters?: string[]
+    identifyingParameters?: string[];
 
     /**
      * If multiple copies are allowed then a matcher must be defined to match the desired
@@ -54,7 +54,14 @@ export interface ResourceSettings<T extends StringIndexedObject> {
      *
      * @return The matched resource.
      */
-    matcher?: (desired: Partial<T>, current: Partial<T>) => boolean
+    matcher?: (desired: Partial<T>, current: Partial<T>) => boolean;
+
+    /**
+     * This method if supported by the resource returns an array of parameters that represent all of the possible
+     * instances of a resource on the system. An example of this is for the git-repository resource, this method returns
+     * a list of directories which are git repositories.
+     */
+    findAllParameters?: () => Promise<Array<Partial<T>>>
   } | boolean
 
   /**

src/resource/resource-settings.ts

@@ -2,6 +2,18 @@ import { ResourceConfig, StringIndexedObject } from 'codify-schemas';
 import os from 'node:os';
 import path from 'node:path';
 
+export const VerbosityLevel = new class {
+  private level = 0;
+
+  get() {
+    return this.level;
+  }
+
+  set(level: number) {
+    this.level = level;
+  }
+}
+
 export function isDebug(): boolean {
   return process.env.DEBUG != null && process.env.DEBUG.includes('codify'); // TODO: replace with debug library
 }