codify-plugin-lib 1.0.166 → 1.0.168

package/dist/messages/handlers.js

@@ -4,7 +4,7 @@ import { ApplyRequestDataSchema, ApplyResponseDataSchema, GetResourceInfoRequest
 import { SudoError } from '../errors.js';
 const SupportedRequests = {
     'initialize': {
-        handler: async (plugin) => plugin.initialize(),
+        handler: async (plugin, data) => plugin.initialize(data),
         requestValidator: InitializeRequestDataSchema,
         responseValidator: InitializeResponseDataSchema
     },

package/dist/plugin/plugin.d.ts

@@ -1,4 +1,4 @@
-import { ApplyRequestData, GetResourceInfoRequestData, GetResourceInfoResponseData, ImportRequestData, ImportResponseData, InitializeResponseData, MatchRequestData, MatchResponseData, PlanRequestData, PlanResponseData, ResourceConfig, ResourceJson, ValidateRequestData, ValidateResponseData } from 'codify-schemas';
+import { ApplyRequestData, GetResourceInfoRequestData, GetResourceInfoResponseData, ImportRequestData, ImportResponseData, InitializeRequestData, InitializeResponseData, MatchRequestData, MatchResponseData, PlanRequestData, PlanResponseData, ResourceConfig, ResourceJson, ValidateRequestData, ValidateResponseData } from 'codify-schemas';
 import { Plan } from '../plan/plan.js';
 import { BackgroundPty } from '../pty/background-pty.js';
 import { Resource } from '../resource/resource.js';
@@ -10,7 +10,7 @@ export declare class Plugin {
     planPty: BackgroundPty;
     constructor(name: string, resourceControllers: Map<string, ResourceController<ResourceConfig>>);
     static create(name: string, resources: Resource<any>[]): Plugin;
-    initialize(): Promise<InitializeResponseData>;
+    initialize(data: InitializeRequestData): Promise<InitializeResponseData>;
     getResourceInfo(data: GetResourceInfoRequestData): Promise<GetResourceInfoResponseData>;
     match(data: MatchRequestData): Promise<MatchResponseData>;
     import(data: ImportRequestData): Promise<ImportResponseData>;

package/dist/plugin/plugin.js

@@ -4,6 +4,7 @@ import { BackgroundPty } from '../pty/background-pty.js';
 import { getPty } from '../pty/index.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 {
     name;
     resourceControllers;
@@ -20,7 +21,10 @@ export class Plugin {
         const controllersMap = new Map(controllers.map((r) => [r.typeId, r]));
         return new Plugin(name, controllersMap);
     }
-    async initialize() {
+    async initialize(data) {
+        if (data.verbosityLevel) {
+            VerbosityLevel.set(data.verbosityLevel);
+        }
         for (const controller of this.resourceControllers.values()) {
             await controller.initialize();
         }
@@ -69,13 +73,13 @@ export class Plugin {
         return { match };
     }
     async import(data) {
-        const { core, parameters } = data;
+        const { core, parameters, autoSearchAll } = data;
         if (!this.resourceControllers.has(core.type)) {
             throw new Error(`Cannot get info for resource ${core.type}, resource doesn't exist`);
         }
         const result = await ptyLocalStorage.run(this.planPty, () => this.resourceControllers
             .get(core.type)
-            ?.import(core, parameters));
+            ?.import(core, parameters, autoSearchAll));
         return {
             request: data,
             result: result ?? [],

package/dist/pty/background-pty.js

@@ -5,6 +5,7 @@ import { EventEmitter } from 'node:events';
 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 { SpawnError } from './index.js';
 import { PromiseQueue } from './promise-queue.js';
 EventEmitter.defaultMaxListeners = 1000;
@@ -62,7 +63,10 @@ export class BackgroundPty {
                     });
                 }
                 else {
-                    process.stdout.write(data);
+                    // Print to stdout if the verbosity level is above 0
+                    if (VerbosityLevel.get() > 0) {
+                        process.stdout.write(data);
+                    }
                 }
             });
             this.promiseQueue.run(async () => new Promise((resolve) => {

package/dist/resource/resource-controller.d.ts

@@ -19,7 +19,7 @@ export declare class ResourceController<T extends StringIndexedObject> {
     plan(core: ResourceConfig, desired: Partial<T> | null, state: Partial<T> | null, isStateful?: boolean): Promise<Plan<T>>;
     planDestroy(core: ResourceConfig, parameters: Partial<T>): Promise<Plan<T>>;
     apply(plan: Plan<T>): Promise<void>;
-    import(core: ResourceConfig, parameters: Partial<T>): Promise<Array<ResourceJson> | null>;
+    import(core: ResourceConfig, parameters: Partial<T>, autoSearchAll?: boolean): Promise<Array<ResourceJson> | null>;
     private applyCreate;
     private applyModify;
     private applyDestroy;

package/dist/resource/resource-controller.js

@@ -181,7 +181,7 @@ export class ResourceController {
             }
         }
     }
-    async import(core, parameters) {
+    async import(core, parameters, autoSearchAll = false) {
         if (this.settings.importAndDestroy?.preventImport) {
             throw new Error(`Type: ${this.typeId} cannot be imported`);
         }
@@ -190,6 +190,16 @@ export class ResourceController {
             isStateful: true,
             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).catch(() => null)));
+            return results.filter(Boolean).flat();
+        }
         this.addDefaultValues(parameters);
         await this.applyTransformParameters(parameters);
         // Use refresh parameters if specified, otherwise try to refresh as many parameters as possible here

package/dist/resource/resource-settings.d.ts

@@ -44,6 +44,12 @@ export interface ResourceSettings<T extends StringIndexedObject> {
          * @return The matched resource.
          */
         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;
     /**
      * If true, {@link StatefulParameter} remove() will be called before resource destruction. This is useful

package/dist/utils/utils.d.ts

@@ -1,4 +1,9 @@
 import { ResourceConfig, StringIndexedObject } from 'codify-schemas';
+export declare const VerbosityLevel: {
+    level: number;
+    get(): number;
+    set(level: number): void;
+};
 export declare function isDebug(): boolean;
 export declare function splitUserConfig<T extends StringIndexedObject>(config: ResourceConfig & T): {
     parameters: T;

package/dist/utils/utils.js

@@ -1,5 +1,14 @@
 import os from 'node:os';
 import path from 'node:path';
+export const VerbosityLevel = new class {
+    level = 0;
+    get() {
+        return this.level;
+    }
+    set(level) {
+        this.level = level;
+    }
+};
 export function isDebug() {
     return process.env.DEBUG != null && process.env.DEBUG.includes('codify'); // TODO: replace with debug library
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codify-plugin-lib",
-  "version": "1.0.166",
+  "version": "1.0.168",
   "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/src/messages/handlers.ts

@@ -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
   },

package/src/plugin/plugin.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();
     }
@@ -107,7 +113,7 @@ export class Plugin {
   }
 
   async import(data: ImportRequestData): Promise<ImportResponseData> {
-    const { core, parameters } = data;
+    const { core, parameters, autoSearchAll } = data;
 
     if (!this.resourceControllers.has(core.type)) {
       throw new Error(`Cannot get info for resource ${core.type}, resource doesn't exist`);
@@ -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, autoSearchAll)
     )
 
     return {

package/src/pty/background-pty.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);
+          }
         }
       })
 

package/src/resource/resource-controller.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,20 @@ 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).catch(() => null))
+      );
+      return results.filter(Boolean).flat() as ResourceJson[];
+    }
+
     this.addDefaultValues(parameters);
     await this.applyTransformParameters(parameters);
 

package/src/resource/resource-settings.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
 
   /**

package/src/utils/utils.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 {
+  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
 }