codify-plugin-lib 1.0.151 → 1.0.153

package/dist/plugin/plugin.js

@@ -39,6 +39,7 @@ export class Plugin {
         const resource = this.resourceControllers.get(data.type);
         const schema = resource.settings.schema;
         const requiredPropertyNames = (resource.settings.importAndDestroy?.requiredParameters
+            ?? (typeof resource.settings.allowMultiple === 'object' ? resource.settings.allowMultiple.identifyingParameters : null)
             ?? schema?.required
             ?? undefined);
         const allowMultiple = resource.settings.allowMultiple !== undefined
@@ -64,22 +65,7 @@ export class Plugin {
         if (!resource) {
             throw new Error(`Resource of type ${resourceConfig.core.type} could not be found for match`);
         }
-        if (!resource.settings.allowMultiple) {
-            return { match: array.find((r) => r.core.type === resourceConfig.core.type) };
-        }
-        const parameterMatcher = resource?.parsedSettings.matcher;
-        const match = array.find((r) => {
-            if (resourceConfig.core.type !== r.core.type) {
-                return false;
-            }
-            // If the user specifies the same name for the resource and it's not auto-generated (a number) then it's the same resource
-            if (resourceConfig.core.name === r.core.name
-                && resourceConfig.core.name
-                && Number.isInteger(Number.parseInt(resourceConfig.core.name, 10))) {
-                return true;
-            }
-            return parameterMatcher(resourceConfig.parameters, r.parameters);
-        });
+        const match = await resource.match(resourceConfig, array);
         return { match };
     }
     async import(data) {

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

@@ -15,6 +15,7 @@ export declare class ResourceController<T extends StringIndexedObject> {
     constructor(resource: Resource<T>);
     initialize(): Promise<void>;
     validate(core: ResourceConfig, parameters: Partial<T>): Promise<ValidateResponseData['resourceValidations'][0]>;
+    match(resource: ResourceJson, array: Array<ResourceJson>): Promise<ResourceJson | undefined>;
     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>;

package/dist/resource/resource-controller.js

@@ -71,6 +71,37 @@ export class ResourceController {
             schemaValidationErrors: [],
         };
     }
+    async match(resource, array) {
+        if (resource.core.type !== this.typeId) {
+            throw new Error(`Unknown type passed into match method: ${resource.core.type} for ${this.typeId}`);
+        }
+        if (!this.parsedSettings.allowMultiple) {
+            return array.find((r) => r.core.type === resource.core.type);
+        }
+        const { name, type } = resource.core;
+        const parameterMatcher = this.parsedSettings.matcher;
+        for (const resourceToMatch of array) {
+            if (type !== resourceToMatch.core.type) {
+                return undefined;
+            }
+            // If the user specifies the same name for the resource and it's not auto-generated (a number) then it's the same resource
+            if (name === resourceToMatch.core.name
+                && name
+                && Number.isInteger(Number.parseInt(name, 10))) {
+                return resourceToMatch;
+            }
+            const originalParams = structuredClone(resource.parameters);
+            const paramsToMatch = structuredClone(resourceToMatch.parameters);
+            this.addDefaultValues(originalParams);
+            await this.applyTransformParameters(originalParams);
+            this.addDefaultValues(paramsToMatch);
+            await this.applyTransformParameters(paramsToMatch);
+            const match = parameterMatcher(originalParams, paramsToMatch);
+            if (match) {
+                return resourceToMatch;
+            }
+        }
+    }
     async plan(core, desired, state, isStateful = false) {
         this.validatePlanInputs(core, desired, state, isStateful);
         this.addDefaultValues(desired);

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

@@ -96,7 +96,7 @@ export interface ResourceSettings<T extends StringIndexedObject> {
         preventImport?: boolean;
         /**
          * Customize the required parameters needed to import this resource. By default, the `requiredParameters` are taken
-         * from the JSON schema. The `requiredParameters` parameter must be declared if a complex required is declared in
+         * from the identifyingParameters for allowMultiple. The `requiredParameters` parameter must be declared if a complex required is declared in
          * the schema (contains `oneOf`, `anyOf`, `allOf`, `if`, `then`, `else`).
          * <br>
          * The user will be prompted for the required parameters before the import starts. This is done because for most resources

package/dist/resource/resource-settings.js

@@ -1,9 +1,14 @@
 import isObjectsEqual from 'lodash.isequal';
 import path from 'node:path';
-import { areArraysEqual, tildify, untildify } from '../utils/utils.js';
+import { areArraysEqual, tildify, unhome, untildify } from '../utils/utils.js';
 const ParameterEqualsDefaults = {
     'boolean': (a, b) => Boolean(a) === Boolean(b),
-    'directory': (a, b) => path.resolve(untildify(String(a))) === path.resolve(untildify(String(b))),
+    'directory': (a, b) => {
+        const notCaseSensitive = process.platform === 'darwin';
+        const transformedA = path.resolve(unhome(untildify(notCaseSensitive ? String(a).toLowerCase() : String(a))));
+        const transformedB = path.resolve(unhome(untildify(notCaseSensitive ? String(b).toLowerCase() : String(b))));
+        return transformedA === transformedB;
+    },
     'number': (a, b) => Number(a) === Number(b),
     'string': (a, b) => String(a) === String(b),
     'version': (desired, current) => String(current).includes(String(desired)),
@@ -48,7 +53,7 @@ export function resolveFnFromEqualsFnOrString(fnOrString) {
 }
 const ParameterTransformationDefaults = {
     'directory': {
-        to: (a) => path.resolve(untildify(String(a))),
+        to: (a) => path.resolve(unhome(untildify(String(a)))),
         from: (a) => tildify(String(a)),
     },
     'string': {

package/dist/utils/utils.d.ts

@@ -7,4 +7,5 @@ export declare function splitUserConfig<T extends StringIndexedObject>(config: R
 export declare function setsEqual(set1: Set<unknown>, set2: Set<unknown>): boolean;
 export declare function untildify(pathWithTilde: string): string;
 export declare function tildify(pathWithTilde: string): string;
+export declare function unhome(pathWithHome: string): string;
 export declare function areArraysEqual(isElementEqual: ((desired: unknown, current: unknown) => boolean) | undefined, desired: unknown, current: unknown): boolean;

package/dist/utils/utils.js

@@ -25,6 +25,9 @@ export function untildify(pathWithTilde) {
 export function tildify(pathWithTilde) {
     return homeDirectory ? pathWithTilde.replace(homeDirectory, '~') : pathWithTilde;
 }
+export function unhome(pathWithHome) {
+    return pathWithHome.includes('$HOME') ? pathWithHome.replaceAll('$HOME', os.homedir()) : pathWithHome;
+}
 export function areArraysEqual(isElementEqual, desired, current) {
     if (!desired || !current) {
         return false;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codify-plugin-lib",
-  "version": "1.0.151",
+  "version": "1.0.153",
   "description": "Library plugin library",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",

package/src/plugin/plugin.ts

@@ -70,6 +70,7 @@ export class Plugin {
     const schema = resource.settings.schema as JSONSchemaType<any> | undefined;
     const requiredPropertyNames = (
       resource.settings.importAndDestroy?.requiredParameters
+      ?? (typeof resource.settings.allowMultiple === 'object' ? resource.settings.allowMultiple.identifyingParameters : null)
       ?? schema?.required
       ?? undefined
     ) as any;
@@ -101,27 +102,7 @@ export class Plugin {
       throw new Error(`Resource of type ${resourceConfig.core.type} could not be found for match`);
     }
 
-    if (!resource.settings.allowMultiple) {
-      return { match: array.find((r) => r.core.type === resourceConfig.core.type) }
-    }
-
-    const parameterMatcher = resource?.parsedSettings.matcher;
-    const match = array.find((r) => {
-      if (resourceConfig.core.type !== r.core.type) {
-        return false;
-      }
-
-      // If the user specifies the same name for the resource and it's not auto-generated (a number) then it's the same resource
-      if (resourceConfig.core.name === r.core.name
-        && resourceConfig.core.name
-        && Number.isInteger(Number.parseInt(resourceConfig.core.name, 10))
-      ) {
-        return true;
-      }
-
-      return parameterMatcher(resourceConfig.parameters, r.parameters);
-    });
-
+    const match = await resource.match(resourceConfig, array);
     return { match }
   }
 

package/src/resource/resource-controller.ts

@@ -102,6 +102,48 @@ export class ResourceController<T extends StringIndexedObject> {
     }
   }
 
+  async match(resource: ResourceJson, array: Array<ResourceJson>): Promise<ResourceJson | undefined> {
+    if (resource.core.type !== this.typeId) {
+      throw new Error(`Unknown type passed into match method: ${resource.core.type} for ${this.typeId}`);
+    }
+
+    if (!this.parsedSettings.allowMultiple) {
+      return array.find((r) => r.core.type === resource.core.type)
+    }
+
+
+    const { name, type } = resource.core;
+    const parameterMatcher = this.parsedSettings.matcher;
+
+    for (const resourceToMatch of array) {
+      if (type !== resourceToMatch.core.type) {
+        return undefined;
+      }
+
+      // If the user specifies the same name for the resource and it's not auto-generated (a number) then it's the same resource
+      if (name === resourceToMatch.core.name
+        && name
+        && Number.isInteger(Number.parseInt(name, 10))
+      ) {
+        return resourceToMatch;
+      }
+
+      const originalParams = structuredClone(resource.parameters) as Partial<T>;
+      const paramsToMatch = structuredClone(resourceToMatch.parameters) as Partial<T>;
+
+      this.addDefaultValues(originalParams);
+      await this.applyTransformParameters(originalParams);
+
+      this.addDefaultValues(paramsToMatch);
+      await this.applyTransformParameters(paramsToMatch);
+
+      const match = parameterMatcher(originalParams, paramsToMatch);
+      if (match) {
+        return resourceToMatch;
+      }
+    }
+  }
+
   async plan(
     core: ResourceConfig,
     desired: Partial<T> | null,

package/src/resource/resource-settings.ts

@@ -4,7 +4,7 @@ import isObjectsEqual from 'lodash.isequal'
 import path from 'node:path';
 
 import { ArrayStatefulParameter, StatefulParameter } from '../stateful-parameter/stateful-parameter.js';
-import { areArraysEqual, tildify, untildify } from '../utils/utils.js';
+import { areArraysEqual, tildify, unhome, untildify } from '../utils/utils.js';
 
 export interface InputTransformation {
   to: (input: any) => Promise<any> | any;
@@ -113,7 +113,7 @@ export interface ResourceSettings<T extends StringIndexedObject> {
 
     /**
      * Customize the required parameters needed to import this resource. By default, the `requiredParameters` are taken
-     * from the JSON schema. The `requiredParameters` parameter must be declared if a complex required is declared in
+     * from the identifyingParameters for allowMultiple. The `requiredParameters` parameter must be declared if a complex required is declared in
      * the schema (contains `oneOf`, `anyOf`, `allOf`, `if`, `then`, `else`).
      * <br>
      * The user will be prompted for the required parameters before the import starts. This is done because for most resources
@@ -302,7 +302,13 @@ export interface StatefulParameterSetting extends DefaultParameterSetting {
 
 const ParameterEqualsDefaults: Partial<Record<ParameterSettingType, (a: unknown, b: unknown) => boolean>> = {
   'boolean': (a: unknown, b: unknown) => Boolean(a) === Boolean(b),
-  'directory': (a: unknown, b: unknown) => path.resolve(untildify(String(a))) === path.resolve(untildify(String(b))),
+  'directory': (a: unknown, b: unknown) => {
+    const notCaseSensitive = process.platform === 'darwin';
+    const transformedA = path.resolve(unhome(untildify(notCaseSensitive ? String(a).toLowerCase() : String(a))))
+    const transformedB = path.resolve(unhome(untildify(notCaseSensitive ? String(b).toLowerCase() : String(b))))
+
+    return transformedA === transformedB;
+  },
   'number': (a: unknown, b: unknown) => Number(a) === Number(b),
   'string': (a: unknown, b: unknown) => String(a) === String(b),
   'version': (desired: unknown, current: unknown) => String(current).includes(String(desired)),
@@ -362,7 +368,7 @@ export function resolveFnFromEqualsFnOrString(
 
 const ParameterTransformationDefaults: Partial<Record<ParameterSettingType, InputTransformation>> = {
   'directory': {
-    to: (a: unknown) => path.resolve(untildify(String(a))),
+    to: (a: unknown) => path.resolve(unhome(untildify(String(a)))),
     from: (a: unknown) => tildify(String(a)),
   },
   'string': {

package/src/utils/utils.ts

@@ -37,6 +37,10 @@ export function tildify(pathWithTilde: string) {
   return homeDirectory ? pathWithTilde.replace(homeDirectory, '~') : pathWithTilde;
 }
 
+export function unhome(pathWithHome: string): string {
+  return pathWithHome.includes('$HOME') ? pathWithHome.replaceAll('$HOME', os.homedir()) : pathWithHome;
+}
+
 export function areArraysEqual(
   isElementEqual: ((desired: unknown, current: unknown) => boolean) | undefined,
   desired: unknown,